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 Calls to get_next_display_element fill the iterator structure with
134 relevant information about the next thing to display. Calls to
135 set_iterator_to_next move the iterator to the next thing.
137 Besides this, an iterator also contains information about the
138 display environment in which glyphs for display elements are to be
139 produced. It has fields for the width and height of the display,
140 the information whether long lines are truncated or continued, a
141 current X and Y position, and lots of other stuff you can better
144 Glyphs in a desired matrix are normally constructed in a loop
145 calling get_next_display_element and then PRODUCE_GLYPHS. The call
146 to PRODUCE_GLYPHS will fill the iterator structure with pixel
147 information about the element being displayed and at the same time
148 produce glyphs for it. If the display element fits on the line
149 being displayed, set_iterator_to_next is called next, otherwise the
150 glyphs produced are discarded. The function display_line is the
151 workhorse of filling glyph rows in the desired matrix with glyphs.
152 In addition to producing glyphs, it also handles line truncation
153 and continuation, word wrap, and cursor positioning (for the
154 latter, see also set_cursor_from_row).
158 That just couldn't be all, could it? What about terminal types not
159 supporting operations on sub-windows of the screen? To update the
160 display on such a terminal, window-based glyph matrices are not
161 well suited. To be able to reuse part of the display (scrolling
162 lines up and down), we must instead have a view of the whole
163 screen. This is what `frame matrices' are for. They are a trick.
165 Frames on terminals like above have a glyph pool. Windows on such
166 a frame sub-allocate their glyph memory from their frame's glyph
167 pool. The frame itself is given its own glyph matrices. By
168 coincidence---or maybe something else---rows in window glyph
169 matrices are slices of corresponding rows in frame matrices. Thus
170 writing to window matrices implicitly updates a frame matrix which
171 provides us with the view of the whole screen that we originally
172 wanted to have without having to move many bytes around. To be
173 honest, there is a little bit more done, but not much more. If you
174 plan to extend that code, take a look at dispnew.c. The function
175 build_frame_matrix is a good starting point.
177 Bidirectional display.
179 Bidirectional display adds quite some hair to this already complex
180 design. The good news are that a large portion of that hairy stuff
181 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
182 reordering engine which is called by set_iterator_to_next and
183 returns the next character to display in the visual order. See
184 commentary on bidi.c for more details. As far as redisplay is
185 concerned, the effect of calling bidi_move_to_visually_next, the
186 main interface of the reordering engine, is that the iterator gets
187 magically placed on the buffer or string position that is to be
188 displayed next. In other words, a linear iteration through the
189 buffer/string is replaced with a non-linear one. All the rest of
190 the redisplay is oblivious to the bidi reordering.
192 Well, almost oblivious---there are still complications, most of
193 them due to the fact that buffer and string positions no longer
194 change monotonously with glyph indices in a glyph row. Moreover,
195 for continued lines, the buffer positions may not even be
196 monotonously changing with vertical positions. Also, accounting
197 for face changes, overlays, etc. becomes more complex because
198 non-linear iteration could potentially skip many positions with
199 changes, and then cross them again on the way back...
201 One other prominent effect of bidirectional display is that some
202 paragraphs of text need to be displayed starting at the right
203 margin of the window---the so-called right-to-left, or R2L
204 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
205 which have their reversed_p flag set. The bidi reordering engine
206 produces characters in such rows starting from the character which
207 should be the rightmost on display. PRODUCE_GLYPHS then reverses
208 the order, when it fills up the glyph row whose reversed_p flag is
209 set, by prepending each new glyph to what is already there, instead
210 of appending it. When the glyph row is complete, the function
211 extend_face_to_end_of_line fills the empty space to the left of the
212 leftmost character with special glyphs, which will display as,
213 well, empty. On text terminals, these special glyphs are simply
214 blank characters. On graphics terminals, there's a single stretch
215 glyph of a suitably computed width. Both the blanks and the
216 stretch glyph are given the face of the background of the line.
217 This way, the terminal-specific back-end can still draw the glyphs
218 left to right, even for R2L lines.
220 Bidirectional display and character compositions
222 Some scripts cannot be displayed by drawing each character
223 individually, because adjacent characters change each other's shape
224 on display. For example, Arabic and Indic scripts belong to this
227 Emacs display supports this by providing "character compositions",
228 most of which is implemented in composite.c. During the buffer
229 scan that delivers characters to PRODUCE_GLYPHS, if the next
230 character to be delivered is a composed character, the iteration
231 calls composition_reseat_it and next_element_from_composition. If
232 they succeed to compose the character with one or more of the
233 following characters, the whole sequence of characters that where
234 composed is recorded in the `struct composition_it' object that is
235 part of the buffer iterator. The composed sequence could produce
236 one or more font glyphs (called "grapheme clusters") on the screen.
237 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
238 in the direction corresponding to the current bidi scan direction
239 (recorded in the scan_dir member of the `struct bidi_it' object
240 that is part of the buffer iterator). In particular, if the bidi
241 iterator currently scans the buffer backwards, the grapheme
242 clusters are delivered back to front. This reorders the grapheme
243 clusters as appropriate for the current bidi context. Note that
244 this means that the grapheme clusters are always stored in the
245 LGSTRING object (see composite.c) in the logical order.
247 Moving an iterator in bidirectional text
248 without producing glyphs
250 Note one important detail mentioned above: that the bidi reordering
251 engine, driven by the iterator, produces characters in R2L rows
252 starting at the character that will be the rightmost on display.
253 As far as the iterator is concerned, the geometry of such rows is
254 still left to right, i.e. the iterator "thinks" the first character
255 is at the leftmost pixel position. The iterator does not know that
256 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
257 delivers. This is important when functions from the the move_it_*
258 family are used to get to certain screen position or to match
259 screen coordinates with buffer coordinates: these functions use the
260 iterator geometry, which is left to right even in R2L paragraphs.
261 This works well with most callers of move_it_*, because they need
262 to get to a specific column, and columns are still numbered in the
263 reading order, i.e. the rightmost character in a R2L paragraph is
264 still column zero. But some callers do not get well with this; a
265 notable example is mouse clicks that need to find the character
266 that corresponds to certain pixel coordinates. See
267 buffer_posn_from_coords in dispnew.c for how this is handled. */
275 #include "keyboard.h"
278 #include "termchar.h"
279 #include "dispextern.h"
281 #include "character.h"
284 #include "commands.h"
288 #include "termhooks.h"
289 #include "termopts.h"
290 #include "intervals.h"
293 #include "region-cache.h"
296 #include "blockinput.h"
298 #ifdef HAVE_X_WINDOWS
313 #ifndef FRAME_X_OUTPUT
314 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
317 #define INFINITY 10000000
319 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
320 Lisp_Object Qwindow_scroll_functions
;
321 Lisp_Object Qwindow_text_change_functions
;
322 Lisp_Object Qredisplay_end_trigger_functions
;
323 Lisp_Object Qinhibit_point_motion_hooks
;
324 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
325 Lisp_Object Qfontified
;
326 Lisp_Object Qgrow_only
;
327 Lisp_Object Qinhibit_eval_during_redisplay
;
328 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
329 Lisp_Object Qright_to_left
, Qleft_to_right
;
332 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
335 Lisp_Object Qarrow
, Qhand
, Qtext
;
337 /* Holds the list (error). */
338 Lisp_Object list_of_error
;
340 Lisp_Object Qfontification_functions
;
342 Lisp_Object Qwrap_prefix
;
343 Lisp_Object Qline_prefix
;
345 /* Non-nil means don't actually do any redisplay. */
347 Lisp_Object Qinhibit_redisplay
;
349 /* Names of text properties relevant for redisplay. */
351 Lisp_Object Qdisplay
;
353 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
354 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
357 Lisp_Object Qmargin
, Qpointer
;
358 Lisp_Object Qline_height
;
360 #ifdef HAVE_WINDOW_SYSTEM
362 /* Test if overflow newline into fringe. Called with iterator IT
363 at or past right window margin, and with IT->current_x set. */
365 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
366 (!NILP (Voverflow_newline_into_fringe) \
367 && FRAME_WINDOW_P ((IT)->f) \
368 && ((IT)->bidi_it.paragraph_dir == R2L \
369 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
370 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
371 && (IT)->current_x == (IT)->last_visible_x \
372 && (IT)->line_wrap != WORD_WRAP)
374 #else /* !HAVE_WINDOW_SYSTEM */
375 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
376 #endif /* HAVE_WINDOW_SYSTEM */
378 /* Test if the display element loaded in IT is a space or tab
379 character. This is used to determine word wrapping. */
381 #define IT_DISPLAYING_WHITESPACE(it) \
382 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
384 /* Name of the face used to highlight trailing whitespace. */
386 Lisp_Object Qtrailing_whitespace
;
388 /* Name and number of the face used to highlight escape glyphs. */
390 Lisp_Object Qescape_glyph
;
392 /* Name and number of the face used to highlight non-breaking spaces. */
394 Lisp_Object Qnobreak_space
;
396 /* The symbol `image' which is the car of the lists used to represent
397 images in Lisp. Also a tool bar style. */
401 /* The image map types. */
402 Lisp_Object QCmap
, QCpointer
;
403 Lisp_Object Qrect
, Qcircle
, Qpoly
;
405 /* Tool bar styles */
406 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
408 /* Non-zero means print newline to stdout before next mini-buffer
411 int noninteractive_need_newline
;
413 /* Non-zero means print newline to message log before next message. */
415 static int message_log_need_newline
;
417 /* Three markers that message_dolog uses.
418 It could allocate them itself, but that causes trouble
419 in handling memory-full errors. */
420 static Lisp_Object message_dolog_marker1
;
421 static Lisp_Object message_dolog_marker2
;
422 static Lisp_Object message_dolog_marker3
;
424 /* The buffer position of the first character appearing entirely or
425 partially on the line of the selected window which contains the
426 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
427 redisplay optimization in redisplay_internal. */
429 static struct text_pos this_line_start_pos
;
431 /* Number of characters past the end of the line above, including the
432 terminating newline. */
434 static struct text_pos this_line_end_pos
;
436 /* The vertical positions and the height of this line. */
438 static int this_line_vpos
;
439 static int this_line_y
;
440 static int this_line_pixel_height
;
442 /* X position at which this display line starts. Usually zero;
443 negative if first character is partially visible. */
445 static int this_line_start_x
;
447 /* Buffer that this_line_.* variables are referring to. */
449 static struct buffer
*this_line_buffer
;
452 /* Values of those variables at last redisplay are stored as
453 properties on `overlay-arrow-position' symbol. However, if
454 Voverlay_arrow_position is a marker, last-arrow-position is its
455 numerical position. */
457 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
459 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
460 properties on a symbol in overlay-arrow-variable-list. */
462 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
464 Lisp_Object Qmenu_bar_update_hook
;
466 /* Nonzero if an overlay arrow has been displayed in this window. */
468 static int overlay_arrow_seen
;
470 /* Number of windows showing the buffer of the selected window (or
471 another buffer with the same base buffer). keyboard.c refers to
476 /* Vector containing glyphs for an ellipsis `...'. */
478 static Lisp_Object default_invis_vector
[3];
480 /* Prompt to display in front of the mini-buffer contents. */
482 Lisp_Object minibuf_prompt
;
484 /* Width of current mini-buffer prompt. Only set after display_line
485 of the line that contains the prompt. */
487 int minibuf_prompt_width
;
489 /* This is the window where the echo area message was displayed. It
490 is always a mini-buffer window, but it may not be the same window
491 currently active as a mini-buffer. */
493 Lisp_Object echo_area_window
;
495 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
496 pushes the current message and the value of
497 message_enable_multibyte on the stack, the function restore_message
498 pops the stack and displays MESSAGE again. */
500 Lisp_Object Vmessage_stack
;
502 /* Nonzero means multibyte characters were enabled when the echo area
503 message was specified. */
505 int message_enable_multibyte
;
507 /* Nonzero if we should redraw the mode lines on the next redisplay. */
509 int update_mode_lines
;
511 /* Nonzero if window sizes or contents have changed since last
512 redisplay that finished. */
514 int windows_or_buffers_changed
;
516 /* Nonzero means a frame's cursor type has been changed. */
518 int cursor_type_changed
;
520 /* Nonzero after display_mode_line if %l was used and it displayed a
523 int line_number_displayed
;
525 /* The name of the *Messages* buffer, a string. */
527 static Lisp_Object Vmessages_buffer_name
;
529 /* Current, index 0, and last displayed echo area message. Either
530 buffers from echo_buffers, or nil to indicate no message. */
532 Lisp_Object echo_area_buffer
[2];
534 /* The buffers referenced from echo_area_buffer. */
536 static Lisp_Object echo_buffer
[2];
538 /* A vector saved used in with_area_buffer to reduce consing. */
540 static Lisp_Object Vwith_echo_area_save_vector
;
542 /* Non-zero means display_echo_area should display the last echo area
543 message again. Set by redisplay_preserve_echo_area. */
545 static int display_last_displayed_message_p
;
547 /* Nonzero if echo area is being used by print; zero if being used by
550 int message_buf_print
;
552 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
554 Lisp_Object Qinhibit_menubar_update
;
555 Lisp_Object Qmessage_truncate_lines
;
557 /* Set to 1 in clear_message to make redisplay_internal aware
558 of an emptied echo area. */
560 static int message_cleared_p
;
562 /* A scratch glyph row with contents used for generating truncation
563 glyphs. Also used in direct_output_for_insert. */
565 #define MAX_SCRATCH_GLYPHS 100
566 struct glyph_row scratch_glyph_row
;
567 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
569 /* Ascent and height of the last line processed by move_it_to. */
571 static int last_max_ascent
, last_height
;
573 /* Non-zero if there's a help-echo in the echo area. */
575 int help_echo_showing_p
;
577 /* If >= 0, computed, exact values of mode-line and header-line height
578 to use in the macros CURRENT_MODE_LINE_HEIGHT and
579 CURRENT_HEADER_LINE_HEIGHT. */
581 int current_mode_line_height
, current_header_line_height
;
583 /* The maximum distance to look ahead for text properties. Values
584 that are too small let us call compute_char_face and similar
585 functions too often which is expensive. Values that are too large
586 let us call compute_char_face and alike too often because we
587 might not be interested in text properties that far away. */
589 #define TEXT_PROP_DISTANCE_LIMIT 100
593 /* Non-zero means print traces of redisplay if compiled with
596 int trace_redisplay_p
;
598 #endif /* GLYPH_DEBUG */
600 #ifdef DEBUG_TRACE_MOVE
601 /* Non-zero means trace with TRACE_MOVE to stderr. */
604 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
606 #define TRACE_MOVE(x) (void) 0
609 Lisp_Object Qauto_hscroll_mode
;
611 /* Buffer being redisplayed -- for redisplay_window_error. */
613 struct buffer
*displayed_buffer
;
615 /* Value returned from text property handlers (see below). */
620 HANDLED_RECOMPUTE_PROPS
,
621 HANDLED_OVERLAY_STRING_CONSUMED
,
625 /* A description of text properties that redisplay is interested
630 /* The name of the property. */
633 /* A unique index for the property. */
636 /* A handler function called to set up iterator IT from the property
637 at IT's current position. Value is used to steer handle_stop. */
638 enum prop_handled (*handler
) (struct it
*it
);
641 static enum prop_handled
handle_face_prop (struct it
*);
642 static enum prop_handled
handle_invisible_prop (struct it
*);
643 static enum prop_handled
handle_display_prop (struct it
*);
644 static enum prop_handled
handle_composition_prop (struct it
*);
645 static enum prop_handled
handle_overlay_change (struct it
*);
646 static enum prop_handled
handle_fontified_prop (struct it
*);
648 /* Properties handled by iterators. */
650 static struct props it_props
[] =
652 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
653 /* Handle `face' before `display' because some sub-properties of
654 `display' need to know the face. */
655 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
656 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
657 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
658 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
662 /* Value is the position described by X. If X is a marker, value is
663 the marker_position of X. Otherwise, value is X. */
665 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
667 /* Enumeration returned by some move_it_.* functions internally. */
671 /* Not used. Undefined value. */
674 /* Move ended at the requested buffer position or ZV. */
675 MOVE_POS_MATCH_OR_ZV
,
677 /* Move ended at the requested X pixel position. */
680 /* Move within a line ended at the end of a line that must be
684 /* Move within a line ended at the end of a line that would
685 be displayed truncated. */
688 /* Move within a line ended at a line end. */
692 /* This counter is used to clear the face cache every once in a while
693 in redisplay_internal. It is incremented for each redisplay.
694 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
697 #define CLEAR_FACE_CACHE_COUNT 500
698 static int clear_face_cache_count
;
700 /* Similarly for the image cache. */
702 #ifdef HAVE_WINDOW_SYSTEM
703 #define CLEAR_IMAGE_CACHE_COUNT 101
704 static int clear_image_cache_count
;
706 /* Null glyph slice */
707 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
710 /* Non-zero while redisplay_internal is in progress. */
714 Lisp_Object Qinhibit_free_realized_faces
;
716 /* If a string, XTread_socket generates an event to display that string.
717 (The display is done in read_char.) */
719 Lisp_Object help_echo_string
;
720 Lisp_Object help_echo_window
;
721 Lisp_Object help_echo_object
;
722 EMACS_INT help_echo_pos
;
724 /* Temporary variable for XTread_socket. */
726 Lisp_Object previous_help_echo_string
;
728 /* Platform-independent portion of hourglass implementation. */
730 /* Non-zero means an hourglass cursor is currently shown. */
731 int hourglass_shown_p
;
733 /* If non-null, an asynchronous timer that, when it expires, displays
734 an hourglass cursor on all frames. */
735 struct atimer
*hourglass_atimer
;
737 /* Name of the face used to display glyphless characters. */
738 Lisp_Object Qglyphless_char
;
740 /* Symbol for the purpose of Vglyphless_char_display. */
741 Lisp_Object Qglyphless_char_display
;
743 /* Method symbols for Vglyphless_char_display. */
744 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
746 /* Default pixel width of `thin-space' display method. */
747 #define THIN_SPACE_WIDTH 1
749 /* Default number of seconds to wait before displaying an hourglass
751 #define DEFAULT_HOURGLASS_DELAY 1
754 /* Function prototypes. */
756 static void setup_for_ellipsis (struct it
*, int);
757 static void mark_window_display_accurate_1 (struct window
*, int);
758 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
759 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
760 static int cursor_row_p (struct window
*, struct glyph_row
*);
761 static int redisplay_mode_lines (Lisp_Object
, int);
762 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
764 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
766 static void handle_line_prefix (struct it
*);
768 static void pint2str (char *, int, int);
769 static void pint2hrstr (char *, int, int);
770 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
772 static void reconsider_clip_changes (struct window
*, struct buffer
*);
773 static int text_outside_line_unchanged_p (struct window
*,
774 EMACS_INT
, EMACS_INT
);
775 static void store_mode_line_noprop_char (char);
776 static int store_mode_line_noprop (const char *, int, int);
777 static void handle_stop (struct it
*);
778 static void handle_stop_backwards (struct it
*, EMACS_INT
);
779 static int single_display_spec_intangible_p (Lisp_Object
);
780 static void ensure_echo_area_buffers (void);
781 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
782 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
783 static int with_echo_area_buffer (struct window
*, int,
784 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
785 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
786 static void clear_garbaged_frames (void);
787 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
788 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
789 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static int display_echo_area (struct window
*);
791 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
792 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
793 static Lisp_Object
unwind_redisplay (Lisp_Object
);
794 static int string_char_and_length (const unsigned char *, int *);
795 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
797 static int compute_window_start_on_continuation_line (struct window
*);
798 static Lisp_Object
safe_eval_handler (Lisp_Object
);
799 static void insert_left_trunc_glyphs (struct it
*);
800 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
802 static void extend_face_to_end_of_line (struct it
*);
803 static int append_space_for_newline (struct it
*, int);
804 static int cursor_row_fully_visible_p (struct window
*, int, int);
805 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
806 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
807 static int trailing_whitespace_p (EMACS_INT
);
808 static int message_log_check_duplicate (EMACS_INT
, EMACS_INT
,
809 EMACS_INT
, EMACS_INT
);
810 static void push_it (struct it
*);
811 static void pop_it (struct it
*);
812 static void sync_frame_with_window_matrix_rows (struct window
*);
813 static void select_frame_for_redisplay (Lisp_Object
);
814 static void redisplay_internal (int);
815 static int echo_area_display (int);
816 static void redisplay_windows (Lisp_Object
);
817 static void redisplay_window (Lisp_Object
, int);
818 static Lisp_Object
redisplay_window_error (Lisp_Object
);
819 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
820 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
821 static int update_menu_bar (struct frame
*, int, int);
822 static int try_window_reusing_current_matrix (struct window
*);
823 static int try_window_id (struct window
*);
824 static int display_line (struct it
*);
825 static int display_mode_lines (struct window
*);
826 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
827 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
828 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
829 static const char *decode_mode_spec (struct window
*, int, int, int,
831 static void display_menu_bar (struct window
*);
832 static int display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
, int,
834 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
835 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
836 static void compute_line_metrics (struct it
*);
837 static void run_redisplay_end_trigger_hook (struct it
*);
838 static int get_overlay_strings (struct it
*, EMACS_INT
);
839 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
840 static void next_overlay_string (struct it
*);
841 static void reseat (struct it
*, struct text_pos
, int);
842 static void reseat_1 (struct it
*, struct text_pos
, int);
843 static void back_to_previous_visible_line_start (struct it
*);
844 void reseat_at_previous_visible_line_start (struct it
*);
845 static void reseat_at_next_visible_line_start (struct it
*, int);
846 static int next_element_from_ellipsis (struct it
*);
847 static int next_element_from_display_vector (struct it
*);
848 static int next_element_from_string (struct it
*);
849 static int next_element_from_c_string (struct it
*);
850 static int next_element_from_buffer (struct it
*);
851 static int next_element_from_composition (struct it
*);
852 static int next_element_from_image (struct it
*);
853 static int next_element_from_stretch (struct it
*);
854 static void load_overlay_strings (struct it
*, EMACS_INT
);
855 static int init_from_display_pos (struct it
*, struct window
*,
856 struct display_pos
*);
857 static void reseat_to_string (struct it
*, const char *,
858 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
859 static enum move_it_result
860 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
861 enum move_operation_enum
);
862 void move_it_vertically_backward (struct it
*, int);
863 static void init_to_row_start (struct it
*, struct window
*,
865 static int init_to_row_end (struct it
*, struct window
*,
867 static void back_to_previous_line_start (struct it
*);
868 static int forward_to_next_line_start (struct it
*, int *);
869 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
870 Lisp_Object
, EMACS_INT
);
871 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
872 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
873 static EMACS_INT
number_of_chars (const char *, int);
874 static void compute_stop_pos (struct it
*);
875 static void compute_string_pos (struct text_pos
*, struct text_pos
,
877 static int face_before_or_after_it_pos (struct it
*, int);
878 static EMACS_INT
next_overlay_change (EMACS_INT
);
879 static int handle_single_display_spec (struct it
*, Lisp_Object
,
880 Lisp_Object
, Lisp_Object
,
881 struct text_pos
*, int);
882 static int underlying_face_id (struct it
*);
883 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
886 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
887 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
889 #ifdef HAVE_WINDOW_SYSTEM
891 static void x_consider_frame_title (Lisp_Object
);
892 static int tool_bar_lines_needed (struct frame
*, int *);
893 static void update_tool_bar (struct frame
*, int);
894 static void build_desired_tool_bar_string (struct frame
*f
);
895 static int redisplay_tool_bar (struct frame
*);
896 static void display_tool_bar_line (struct it
*, int);
897 static void notice_overwritten_cursor (struct window
*,
900 static void append_stretch_glyph (struct it
*, Lisp_Object
,
904 #endif /* HAVE_WINDOW_SYSTEM */
906 static int coords_in_mouse_face_p (struct window
*, int, int);
910 /***********************************************************************
911 Window display dimensions
912 ***********************************************************************/
914 /* Return the bottom boundary y-position for text lines in window W.
915 This is the first y position at which a line cannot start.
916 It is relative to the top of the window.
918 This is the height of W minus the height of a mode line, if any. */
921 window_text_bottom_y (struct window
*w
)
923 int height
= WINDOW_TOTAL_HEIGHT (w
);
925 if (WINDOW_WANTS_MODELINE_P (w
))
926 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
930 /* Return the pixel width of display area AREA of window W. AREA < 0
931 means return the total width of W, not including fringes to
932 the left and right of the window. */
935 window_box_width (struct window
*w
, int area
)
937 int cols
= XFASTINT (w
->total_cols
);
940 if (!w
->pseudo_window_p
)
942 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
944 if (area
== TEXT_AREA
)
946 if (INTEGERP (w
->left_margin_cols
))
947 cols
-= XFASTINT (w
->left_margin_cols
);
948 if (INTEGERP (w
->right_margin_cols
))
949 cols
-= XFASTINT (w
->right_margin_cols
);
950 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
952 else if (area
== LEFT_MARGIN_AREA
)
954 cols
= (INTEGERP (w
->left_margin_cols
)
955 ? XFASTINT (w
->left_margin_cols
) : 0);
958 else if (area
== RIGHT_MARGIN_AREA
)
960 cols
= (INTEGERP (w
->right_margin_cols
)
961 ? XFASTINT (w
->right_margin_cols
) : 0);
966 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
970 /* Return the pixel height of the display area of window W, not
971 including mode lines of W, if any. */
974 window_box_height (struct window
*w
)
976 struct frame
*f
= XFRAME (w
->frame
);
977 int height
= WINDOW_TOTAL_HEIGHT (w
);
979 xassert (height
>= 0);
981 /* Note: the code below that determines the mode-line/header-line
982 height is essentially the same as that contained in the macro
983 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
984 the appropriate glyph row has its `mode_line_p' flag set,
985 and if it doesn't, uses estimate_mode_line_height instead. */
987 if (WINDOW_WANTS_MODELINE_P (w
))
989 struct glyph_row
*ml_row
990 = (w
->current_matrix
&& w
->current_matrix
->rows
991 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
993 if (ml_row
&& ml_row
->mode_line_p
)
994 height
-= ml_row
->height
;
996 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
999 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1001 struct glyph_row
*hl_row
1002 = (w
->current_matrix
&& w
->current_matrix
->rows
1003 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1005 if (hl_row
&& hl_row
->mode_line_p
)
1006 height
-= hl_row
->height
;
1008 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1011 /* With a very small font and a mode-line that's taller than
1012 default, we might end up with a negative height. */
1013 return max (0, height
);
1016 /* Return the window-relative coordinate of the left edge of display
1017 area AREA of window W. AREA < 0 means return the left edge of the
1018 whole window, to the right of the left fringe of W. */
1021 window_box_left_offset (struct window
*w
, int area
)
1025 if (w
->pseudo_window_p
)
1028 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1030 if (area
== TEXT_AREA
)
1031 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1032 + window_box_width (w
, LEFT_MARGIN_AREA
));
1033 else if (area
== RIGHT_MARGIN_AREA
)
1034 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1035 + window_box_width (w
, LEFT_MARGIN_AREA
)
1036 + window_box_width (w
, TEXT_AREA
)
1037 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1039 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1040 else if (area
== LEFT_MARGIN_AREA
1041 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1042 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1048 /* Return the window-relative coordinate of the right edge of display
1049 area AREA of window W. AREA < 0 means return the right edge of the
1050 whole window, to the left of the right fringe of W. */
1053 window_box_right_offset (struct window
*w
, int area
)
1055 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1058 /* Return the frame-relative coordinate of the left edge of display
1059 area AREA of window W. AREA < 0 means return the left edge of the
1060 whole window, to the right of the left fringe of W. */
1063 window_box_left (struct window
*w
, int area
)
1065 struct frame
*f
= XFRAME (w
->frame
);
1068 if (w
->pseudo_window_p
)
1069 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1071 x
= (WINDOW_LEFT_EDGE_X (w
)
1072 + window_box_left_offset (w
, area
));
1078 /* Return the frame-relative coordinate of the right edge of display
1079 area AREA of window W. AREA < 0 means return the right edge of the
1080 whole window, to the left of the right fringe of W. */
1083 window_box_right (struct window
*w
, int area
)
1085 return window_box_left (w
, area
) + window_box_width (w
, area
);
1088 /* Get the bounding box of the display area AREA of window W, without
1089 mode lines, in frame-relative coordinates. AREA < 0 means the
1090 whole window, not including the left and right fringes of
1091 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1092 coordinates of the upper-left corner of the box. Return in
1093 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1096 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1097 int *box_width
, int *box_height
)
1100 *box_width
= window_box_width (w
, area
);
1102 *box_height
= window_box_height (w
);
1104 *box_x
= window_box_left (w
, area
);
1107 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1108 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1109 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1114 /* Get the bounding box of the display area AREA of window W, without
1115 mode lines. AREA < 0 means the whole window, not including the
1116 left and right fringe of the window. Return in *TOP_LEFT_X
1117 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1118 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1119 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1123 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1124 int *bottom_right_x
, int *bottom_right_y
)
1126 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1128 *bottom_right_x
+= *top_left_x
;
1129 *bottom_right_y
+= *top_left_y
;
1134 /***********************************************************************
1136 ***********************************************************************/
1138 /* Return the bottom y-position of the line the iterator IT is in.
1139 This can modify IT's settings. */
1142 line_bottom_y (struct it
*it
)
1144 int line_height
= it
->max_ascent
+ it
->max_descent
;
1145 int line_top_y
= it
->current_y
;
1147 if (line_height
== 0)
1150 line_height
= last_height
;
1151 else if (IT_CHARPOS (*it
) < ZV
)
1153 move_it_by_lines (it
, 1, 1);
1154 line_height
= (it
->max_ascent
|| it
->max_descent
1155 ? it
->max_ascent
+ it
->max_descent
1160 struct glyph_row
*row
= it
->glyph_row
;
1162 /* Use the default character height. */
1163 it
->glyph_row
= NULL
;
1164 it
->what
= IT_CHARACTER
;
1167 PRODUCE_GLYPHS (it
);
1168 line_height
= it
->ascent
+ it
->descent
;
1169 it
->glyph_row
= row
;
1173 return line_top_y
+ line_height
;
1177 /* Return 1 if position CHARPOS is visible in window W.
1178 CHARPOS < 0 means return info about WINDOW_END position.
1179 If visible, set *X and *Y to pixel coordinates of top left corner.
1180 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1181 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1184 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1185 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1188 struct text_pos top
;
1190 struct buffer
*old_buffer
= NULL
;
1192 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1195 if (XBUFFER (w
->buffer
) != current_buffer
)
1197 old_buffer
= current_buffer
;
1198 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1201 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1203 /* Compute exact mode line heights. */
1204 if (WINDOW_WANTS_MODELINE_P (w
))
1205 current_mode_line_height
1206 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1207 current_buffer
->mode_line_format
);
1209 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1210 current_header_line_height
1211 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1212 current_buffer
->header_line_format
);
1214 start_display (&it
, w
, top
);
1215 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1216 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1218 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1220 /* We have reached CHARPOS, or passed it. How the call to
1221 move_it_to can overshoot: (i) If CHARPOS is on invisible
1222 text, move_it_to stops at the end of the invisible text,
1223 after CHARPOS. (ii) If CHARPOS is in a display vector,
1224 move_it_to stops on its last glyph. */
1225 int top_x
= it
.current_x
;
1226 int top_y
= it
.current_y
;
1227 enum it_method it_method
= it
.method
;
1228 /* Calling line_bottom_y may change it.method, it.position, etc. */
1229 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1230 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1232 if (top_y
< window_top_y
)
1233 visible_p
= bottom_y
> window_top_y
;
1234 else if (top_y
< it
.last_visible_y
)
1238 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1240 /* We stopped on the last glyph of a display vector.
1241 Try and recompute. Hack alert! */
1242 if (charpos
< 2 || top
.charpos
>= charpos
)
1243 top_x
= it
.glyph_row
->x
;
1247 start_display (&it2
, w
, top
);
1248 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1249 get_next_display_element (&it2
);
1250 PRODUCE_GLYPHS (&it2
);
1251 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1252 || it2
.current_x
> it2
.last_visible_x
)
1253 top_x
= it
.glyph_row
->x
;
1256 top_x
= it2
.current_x
;
1257 top_y
= it2
.current_y
;
1263 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1264 *rtop
= max (0, window_top_y
- top_y
);
1265 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1266 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1267 - max (top_y
, window_top_y
)));
1276 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1277 move_it_by_lines (&it
, 1, 0);
1278 if (charpos
< IT_CHARPOS (it
)
1279 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1282 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1284 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1285 *rtop
= max (0, -it2
.current_y
);
1286 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1287 - it
.last_visible_y
));
1288 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1290 - max (it2
.current_y
,
1291 WINDOW_HEADER_LINE_HEIGHT (w
))));
1297 set_buffer_internal_1 (old_buffer
);
1299 current_header_line_height
= current_mode_line_height
= -1;
1301 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1302 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1305 /* Debugging code. */
1307 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1308 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1310 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1317 /* Return the next character from STR. Return in *LEN the length of
1318 the character. This is like STRING_CHAR_AND_LENGTH but never
1319 returns an invalid character. If we find one, we return a `?', but
1320 with the length of the invalid character. */
1323 string_char_and_length (const unsigned char *str
, int *len
)
1327 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1328 if (!CHAR_VALID_P (c
, 1))
1329 /* We may not change the length here because other places in Emacs
1330 don't use this function, i.e. they silently accept invalid
1339 /* Given a position POS containing a valid character and byte position
1340 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1342 static struct text_pos
1343 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1345 xassert (STRINGP (string
) && nchars
>= 0);
1347 if (STRING_MULTIBYTE (string
))
1349 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1354 string_char_and_length (p
, &len
);
1357 BYTEPOS (pos
) += len
;
1361 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1367 /* Value is the text position, i.e. character and byte position,
1368 for character position CHARPOS in STRING. */
1370 static INLINE
struct text_pos
1371 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1373 struct text_pos pos
;
1374 xassert (STRINGP (string
));
1375 xassert (charpos
>= 0);
1376 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1381 /* Value is a text position, i.e. character and byte position, for
1382 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1383 means recognize multibyte characters. */
1385 static struct text_pos
1386 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1388 struct text_pos pos
;
1390 xassert (s
!= NULL
);
1391 xassert (charpos
>= 0);
1397 SET_TEXT_POS (pos
, 0, 0);
1400 string_char_and_length ((const unsigned char *) s
, &len
);
1403 BYTEPOS (pos
) += len
;
1407 SET_TEXT_POS (pos
, charpos
, charpos
);
1413 /* Value is the number of characters in C string S. MULTIBYTE_P
1414 non-zero means recognize multibyte characters. */
1417 number_of_chars (const char *s
, int multibyte_p
)
1423 EMACS_INT rest
= strlen (s
);
1425 const unsigned char *p
= (const unsigned char *) s
;
1427 for (nchars
= 0; rest
> 0; ++nchars
)
1429 string_char_and_length (p
, &len
);
1430 rest
-= len
, p
+= len
;
1434 nchars
= strlen (s
);
1440 /* Compute byte position NEWPOS->bytepos corresponding to
1441 NEWPOS->charpos. POS is a known position in string STRING.
1442 NEWPOS->charpos must be >= POS.charpos. */
1445 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1447 xassert (STRINGP (string
));
1448 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1450 if (STRING_MULTIBYTE (string
))
1451 *newpos
= string_pos_nchars_ahead (pos
, string
,
1452 CHARPOS (*newpos
) - CHARPOS (pos
));
1454 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1458 Return an estimation of the pixel height of mode or header lines on
1459 frame F. FACE_ID specifies what line's height to estimate. */
1462 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1464 #ifdef HAVE_WINDOW_SYSTEM
1465 if (FRAME_WINDOW_P (f
))
1467 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1469 /* This function is called so early when Emacs starts that the face
1470 cache and mode line face are not yet initialized. */
1471 if (FRAME_FACE_CACHE (f
))
1473 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1477 height
= FONT_HEIGHT (face
->font
);
1478 if (face
->box_line_width
> 0)
1479 height
+= 2 * face
->box_line_width
;
1490 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1491 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1492 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1493 not force the value into range. */
1496 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1497 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1500 #ifdef HAVE_WINDOW_SYSTEM
1501 if (FRAME_WINDOW_P (f
))
1503 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1504 even for negative values. */
1506 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1508 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1510 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1511 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1514 STORE_NATIVE_RECT (*bounds
,
1515 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1516 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1517 FRAME_COLUMN_WIDTH (f
) - 1,
1518 FRAME_LINE_HEIGHT (f
) - 1);
1524 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1525 pix_x
= FRAME_TOTAL_COLS (f
);
1529 else if (pix_y
> FRAME_LINES (f
))
1530 pix_y
= FRAME_LINES (f
);
1540 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1541 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1542 can't tell the positions because W's display is not up to date,
1546 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1547 int *frame_x
, int *frame_y
)
1549 #ifdef HAVE_WINDOW_SYSTEM
1550 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1554 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1555 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1557 if (display_completed
)
1559 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1560 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1561 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1567 hpos
+= glyph
->pixel_width
;
1571 /* If first glyph is partially visible, its first visible position is still 0. */
1583 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1584 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1595 /* Find the glyph under window-relative coordinates X/Y in window W.
1596 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1597 strings. Return in *HPOS and *VPOS the row and column number of
1598 the glyph found. Return in *AREA the glyph area containing X.
1599 Value is a pointer to the glyph found or null if X/Y is not on
1600 text, or we can't tell because W's current matrix is not up to
1605 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1606 int *dx
, int *dy
, int *area
)
1608 struct glyph
*glyph
, *end
;
1609 struct glyph_row
*row
= NULL
;
1612 /* Find row containing Y. Give up if some row is not enabled. */
1613 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1615 row
= MATRIX_ROW (w
->current_matrix
, i
);
1616 if (!row
->enabled_p
)
1618 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1625 /* Give up if Y is not in the window. */
1626 if (i
== w
->current_matrix
->nrows
)
1629 /* Get the glyph area containing X. */
1630 if (w
->pseudo_window_p
)
1637 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1639 *area
= LEFT_MARGIN_AREA
;
1640 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1642 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1645 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1649 *area
= RIGHT_MARGIN_AREA
;
1650 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1654 /* Find glyph containing X. */
1655 glyph
= row
->glyphs
[*area
];
1656 end
= glyph
+ row
->used
[*area
];
1658 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1660 x
-= glyph
->pixel_width
;
1670 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1673 *hpos
= glyph
- row
->glyphs
[*area
];
1678 Convert frame-relative x/y to coordinates relative to window W.
1679 Takes pseudo-windows into account. */
1682 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1684 if (w
->pseudo_window_p
)
1686 /* A pseudo-window is always full-width, and starts at the
1687 left edge of the frame, plus a frame border. */
1688 struct frame
*f
= XFRAME (w
->frame
);
1689 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1690 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1694 *x
-= WINDOW_LEFT_EDGE_X (w
);
1695 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1699 #ifdef HAVE_WINDOW_SYSTEM
1702 Return in RECTS[] at most N clipping rectangles for glyph string S.
1703 Return the number of stored rectangles. */
1706 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1713 if (s
->row
->full_width_p
)
1715 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1716 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1717 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1719 /* Unless displaying a mode or menu bar line, which are always
1720 fully visible, clip to the visible part of the row. */
1721 if (s
->w
->pseudo_window_p
)
1722 r
.height
= s
->row
->visible_height
;
1724 r
.height
= s
->height
;
1728 /* This is a text line that may be partially visible. */
1729 r
.x
= window_box_left (s
->w
, s
->area
);
1730 r
.width
= window_box_width (s
->w
, s
->area
);
1731 r
.height
= s
->row
->visible_height
;
1735 if (r
.x
< s
->clip_head
->x
)
1737 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1738 r
.width
-= s
->clip_head
->x
- r
.x
;
1741 r
.x
= s
->clip_head
->x
;
1744 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1746 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1747 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1752 /* If S draws overlapping rows, it's sufficient to use the top and
1753 bottom of the window for clipping because this glyph string
1754 intentionally draws over other lines. */
1755 if (s
->for_overlaps
)
1757 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1758 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1760 /* Alas, the above simple strategy does not work for the
1761 environments with anti-aliased text: if the same text is
1762 drawn onto the same place multiple times, it gets thicker.
1763 If the overlap we are processing is for the erased cursor, we
1764 take the intersection with the rectagle of the cursor. */
1765 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1767 XRectangle rc
, r_save
= r
;
1769 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1770 rc
.y
= s
->w
->phys_cursor
.y
;
1771 rc
.width
= s
->w
->phys_cursor_width
;
1772 rc
.height
= s
->w
->phys_cursor_height
;
1774 x_intersect_rectangles (&r_save
, &rc
, &r
);
1779 /* Don't use S->y for clipping because it doesn't take partially
1780 visible lines into account. For example, it can be negative for
1781 partially visible lines at the top of a window. */
1782 if (!s
->row
->full_width_p
1783 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1784 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1786 r
.y
= max (0, s
->row
->y
);
1789 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1791 /* If drawing the cursor, don't let glyph draw outside its
1792 advertised boundaries. Cleartype does this under some circumstances. */
1793 if (s
->hl
== DRAW_CURSOR
)
1795 struct glyph
*glyph
= s
->first_glyph
;
1800 r
.width
-= s
->x
- r
.x
;
1803 r
.width
= min (r
.width
, glyph
->pixel_width
);
1805 /* If r.y is below window bottom, ensure that we still see a cursor. */
1806 height
= min (glyph
->ascent
+ glyph
->descent
,
1807 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1808 max_y
= window_text_bottom_y (s
->w
) - height
;
1809 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1810 if (s
->ybase
- glyph
->ascent
> max_y
)
1817 /* Don't draw cursor glyph taller than our actual glyph. */
1818 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1819 if (height
< r
.height
)
1821 max_y
= r
.y
+ r
.height
;
1822 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1823 r
.height
= min (max_y
- r
.y
, height
);
1830 XRectangle r_save
= r
;
1832 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1836 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1837 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1839 #ifdef CONVERT_FROM_XRECT
1840 CONVERT_FROM_XRECT (r
, *rects
);
1848 /* If we are processing overlapping and allowed to return
1849 multiple clipping rectangles, we exclude the row of the glyph
1850 string from the clipping rectangle. This is to avoid drawing
1851 the same text on the environment with anti-aliasing. */
1852 #ifdef CONVERT_FROM_XRECT
1855 XRectangle
*rs
= rects
;
1857 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1859 if (s
->for_overlaps
& OVERLAPS_PRED
)
1862 if (r
.y
+ r
.height
> row_y
)
1865 rs
[i
].height
= row_y
- r
.y
;
1871 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1874 if (r
.y
< row_y
+ s
->row
->visible_height
)
1876 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1878 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1879 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1888 #ifdef CONVERT_FROM_XRECT
1889 for (i
= 0; i
< n
; i
++)
1890 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1897 Return in *NR the clipping rectangle for glyph string S. */
1900 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1902 get_glyph_string_clip_rects (s
, nr
, 1);
1907 Return the position and height of the phys cursor in window W.
1908 Set w->phys_cursor_width to width of phys cursor.
1912 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1913 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1915 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1916 int x
, y
, wd
, h
, h0
, y0
;
1918 /* Compute the width of the rectangle to draw. If on a stretch
1919 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1920 rectangle as wide as the glyph, but use a canonical character
1922 wd
= glyph
->pixel_width
- 1;
1923 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1927 x
= w
->phys_cursor
.x
;
1934 if (glyph
->type
== STRETCH_GLYPH
1935 && !x_stretch_cursor_p
)
1936 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1937 w
->phys_cursor_width
= wd
;
1939 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1941 /* If y is below window bottom, ensure that we still see a cursor. */
1942 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1944 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1945 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1947 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1950 h
= max (h
- (y0
- y
) + 1, h0
);
1955 y0
= window_text_bottom_y (w
) - h0
;
1963 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1964 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1969 * Remember which glyph the mouse is over.
1973 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1977 struct glyph_row
*r
, *gr
, *end_row
;
1978 enum window_part part
;
1979 enum glyph_row_area area
;
1980 int x
, y
, width
, height
;
1982 /* Try to determine frame pixel position and size of the glyph under
1983 frame pixel coordinates X/Y on frame F. */
1985 if (!f
->glyphs_initialized_p
1986 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1989 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1990 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1994 w
= XWINDOW (window
);
1995 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1996 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1998 x
= window_relative_x_coord (w
, part
, gx
);
1999 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2001 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2002 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2004 if (w
->pseudo_window_p
)
2007 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2013 case ON_LEFT_MARGIN
:
2014 area
= LEFT_MARGIN_AREA
;
2017 case ON_RIGHT_MARGIN
:
2018 area
= RIGHT_MARGIN_AREA
;
2021 case ON_HEADER_LINE
:
2023 gr
= (part
== ON_HEADER_LINE
2024 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2025 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2028 goto text_glyph_row_found
;
2035 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2036 if (r
->y
+ r
->height
> y
)
2042 text_glyph_row_found
:
2045 struct glyph
*g
= gr
->glyphs
[area
];
2046 struct glyph
*end
= g
+ gr
->used
[area
];
2048 height
= gr
->height
;
2049 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2050 if (gx
+ g
->pixel_width
> x
)
2055 if (g
->type
== IMAGE_GLYPH
)
2057 /* Don't remember when mouse is over image, as
2058 image may have hot-spots. */
2059 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2062 width
= g
->pixel_width
;
2066 /* Use nominal char spacing at end of line. */
2068 gx
+= (x
/ width
) * width
;
2071 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2072 gx
+= window_box_left_offset (w
, area
);
2076 /* Use nominal line height at end of window. */
2077 gx
= (x
/ width
) * width
;
2079 gy
+= (y
/ height
) * height
;
2083 case ON_LEFT_FRINGE
:
2084 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2085 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2086 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2087 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2090 case ON_RIGHT_FRINGE
:
2091 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2092 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2093 : window_box_right_offset (w
, TEXT_AREA
));
2094 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2098 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2100 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2101 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2102 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2104 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2108 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2109 if (r
->y
+ r
->height
> y
)
2116 height
= gr
->height
;
2119 /* Use nominal line height at end of window. */
2121 gy
+= (y
/ height
) * height
;
2128 /* If there is no glyph under the mouse, then we divide the screen
2129 into a grid of the smallest glyph in the frame, and use that
2132 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2133 round down even for negative values. */
2139 gx
= (gx
/ width
) * width
;
2140 gy
= (gy
/ height
) * height
;
2145 gx
+= WINDOW_LEFT_EDGE_X (w
);
2146 gy
+= WINDOW_TOP_EDGE_Y (w
);
2149 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2151 /* Visible feedback for debugging. */
2154 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2155 f
->output_data
.x
->normal_gc
,
2156 gx
, gy
, width
, height
);
2162 #endif /* HAVE_WINDOW_SYSTEM */
2165 /***********************************************************************
2166 Lisp form evaluation
2167 ***********************************************************************/
2169 /* Error handler for safe_eval and safe_call. */
2172 safe_eval_handler (Lisp_Object arg
)
2174 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2179 /* Evaluate SEXPR and return the result, or nil if something went
2180 wrong. Prevent redisplay during the evaluation. */
2182 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2183 Return the result, or nil if something went wrong. Prevent
2184 redisplay during the evaluation. */
2187 safe_call (int nargs
, Lisp_Object
*args
)
2191 if (inhibit_eval_during_redisplay
)
2195 int count
= SPECPDL_INDEX ();
2196 struct gcpro gcpro1
;
2199 gcpro1
.nvars
= nargs
;
2200 specbind (Qinhibit_redisplay
, Qt
);
2201 /* Use Qt to ensure debugger does not run,
2202 so there is no possibility of wanting to redisplay. */
2203 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2206 val
= unbind_to (count
, val
);
2213 /* Call function FN with one argument ARG.
2214 Return the result, or nil if something went wrong. */
2217 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2219 Lisp_Object args
[2];
2222 return safe_call (2, args
);
2225 static Lisp_Object Qeval
;
2228 safe_eval (Lisp_Object sexpr
)
2230 return safe_call1 (Qeval
, sexpr
);
2233 /* Call function FN with one argument ARG.
2234 Return the result, or nil if something went wrong. */
2237 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2239 Lisp_Object args
[3];
2243 return safe_call (3, args
);
2248 /***********************************************************************
2250 ***********************************************************************/
2254 /* Define CHECK_IT to perform sanity checks on iterators.
2255 This is for debugging. It is too slow to do unconditionally. */
2261 if (it
->method
== GET_FROM_STRING
)
2263 xassert (STRINGP (it
->string
));
2264 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2268 xassert (IT_STRING_CHARPOS (*it
) < 0);
2269 if (it
->method
== GET_FROM_BUFFER
)
2271 /* Check that character and byte positions agree. */
2272 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2277 xassert (it
->current
.dpvec_index
>= 0);
2279 xassert (it
->current
.dpvec_index
< 0);
2282 #define CHECK_IT(IT) check_it ((IT))
2286 #define CHECK_IT(IT) (void) 0
2293 /* Check that the window end of window W is what we expect it
2294 to be---the last row in the current matrix displaying text. */
2297 check_window_end (w
)
2300 if (!MINI_WINDOW_P (w
)
2301 && !NILP (w
->window_end_valid
))
2303 struct glyph_row
*row
;
2304 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2305 XFASTINT (w
->window_end_vpos
)),
2307 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2308 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2312 #define CHECK_WINDOW_END(W) check_window_end ((W))
2314 #else /* not GLYPH_DEBUG */
2316 #define CHECK_WINDOW_END(W) (void) 0
2318 #endif /* not GLYPH_DEBUG */
2322 /***********************************************************************
2323 Iterator initialization
2324 ***********************************************************************/
2326 /* Initialize IT for displaying current_buffer in window W, starting
2327 at character position CHARPOS. CHARPOS < 0 means that no buffer
2328 position is specified which is useful when the iterator is assigned
2329 a position later. BYTEPOS is the byte position corresponding to
2330 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2332 If ROW is not null, calls to produce_glyphs with IT as parameter
2333 will produce glyphs in that row.
2335 BASE_FACE_ID is the id of a base face to use. It must be one of
2336 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2337 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2338 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2340 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2341 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2342 will be initialized to use the corresponding mode line glyph row of
2343 the desired matrix of W. */
2346 init_iterator (struct it
*it
, struct window
*w
,
2347 EMACS_INT charpos
, EMACS_INT bytepos
,
2348 struct glyph_row
*row
, enum face_id base_face_id
)
2350 int highlight_region_p
;
2351 enum face_id remapped_base_face_id
= base_face_id
;
2353 /* Some precondition checks. */
2354 xassert (w
!= NULL
&& it
!= NULL
);
2355 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2358 /* If face attributes have been changed since the last redisplay,
2359 free realized faces now because they depend on face definitions
2360 that might have changed. Don't free faces while there might be
2361 desired matrices pending which reference these faces. */
2362 if (face_change_count
&& !inhibit_free_realized_faces
)
2364 face_change_count
= 0;
2365 free_all_realized_faces (Qnil
);
2368 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2369 if (! NILP (Vface_remapping_alist
))
2370 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2372 /* Use one of the mode line rows of W's desired matrix if
2376 if (base_face_id
== MODE_LINE_FACE_ID
2377 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2378 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2379 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2380 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2384 memset (it
, 0, sizeof *it
);
2385 it
->current
.overlay_string_index
= -1;
2386 it
->current
.dpvec_index
= -1;
2387 it
->base_face_id
= remapped_base_face_id
;
2389 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2391 /* The window in which we iterate over current_buffer: */
2392 XSETWINDOW (it
->window
, w
);
2394 it
->f
= XFRAME (w
->frame
);
2398 /* Extra space between lines (on window systems only). */
2399 if (base_face_id
== DEFAULT_FACE_ID
2400 && FRAME_WINDOW_P (it
->f
))
2402 if (NATNUMP (current_buffer
->extra_line_spacing
))
2403 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2404 else if (FLOATP (current_buffer
->extra_line_spacing
))
2405 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2406 * FRAME_LINE_HEIGHT (it
->f
));
2407 else if (it
->f
->extra_line_spacing
> 0)
2408 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2409 it
->max_extra_line_spacing
= 0;
2412 /* If realized faces have been removed, e.g. because of face
2413 attribute changes of named faces, recompute them. When running
2414 in batch mode, the face cache of the initial frame is null. If
2415 we happen to get called, make a dummy face cache. */
2416 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2417 init_frame_faces (it
->f
);
2418 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2419 recompute_basic_faces (it
->f
);
2421 /* Current value of the `slice', `space-width', and 'height' properties. */
2422 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2423 it
->space_width
= Qnil
;
2424 it
->font_height
= Qnil
;
2425 it
->override_ascent
= -1;
2427 /* Are control characters displayed as `^C'? */
2428 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2430 /* -1 means everything between a CR and the following line end
2431 is invisible. >0 means lines indented more than this value are
2433 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2434 ? XFASTINT (current_buffer
->selective_display
)
2435 : (!NILP (current_buffer
->selective_display
)
2437 it
->selective_display_ellipsis_p
2438 = !NILP (current_buffer
->selective_display_ellipses
);
2440 /* Display table to use. */
2441 it
->dp
= window_display_table (w
);
2443 /* Are multibyte characters enabled in current_buffer? */
2444 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2446 /* Do we need to reorder bidirectional text? Not if this is a
2447 unibyte buffer: by definition, none of the single-byte characters
2448 are strong R2L, so no reordering is needed. And bidi.c doesn't
2449 support unibyte buffers anyway. */
2451 = !NILP (current_buffer
->bidi_display_reordering
) && it
->multibyte_p
;
2453 /* Non-zero if we should highlight the region. */
2455 = (!NILP (Vtransient_mark_mode
)
2456 && !NILP (current_buffer
->mark_active
)
2457 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2459 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2460 start and end of a visible region in window IT->w. Set both to
2461 -1 to indicate no region. */
2462 if (highlight_region_p
2463 /* Maybe highlight only in selected window. */
2464 && (/* Either show region everywhere. */
2465 highlight_nonselected_windows
2466 /* Or show region in the selected window. */
2467 || w
== XWINDOW (selected_window
)
2468 /* Or show the region if we are in the mini-buffer and W is
2469 the window the mini-buffer refers to. */
2470 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2471 && WINDOWP (minibuf_selected_window
)
2472 && w
== XWINDOW (minibuf_selected_window
))))
2474 EMACS_INT charpos
= marker_position (current_buffer
->mark
);
2475 it
->region_beg_charpos
= min (PT
, charpos
);
2476 it
->region_end_charpos
= max (PT
, charpos
);
2479 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2481 /* Get the position at which the redisplay_end_trigger hook should
2482 be run, if it is to be run at all. */
2483 if (MARKERP (w
->redisplay_end_trigger
)
2484 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2485 it
->redisplay_end_trigger_charpos
2486 = marker_position (w
->redisplay_end_trigger
);
2487 else if (INTEGERP (w
->redisplay_end_trigger
))
2488 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2490 /* Correct bogus values of tab_width. */
2491 it
->tab_width
= XINT (current_buffer
->tab_width
);
2492 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2495 /* Are lines in the display truncated? */
2496 if (base_face_id
!= DEFAULT_FACE_ID
2497 || XINT (it
->w
->hscroll
)
2498 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2499 && ((!NILP (Vtruncate_partial_width_windows
)
2500 && !INTEGERP (Vtruncate_partial_width_windows
))
2501 || (INTEGERP (Vtruncate_partial_width_windows
)
2502 && (WINDOW_TOTAL_COLS (it
->w
)
2503 < XINT (Vtruncate_partial_width_windows
))))))
2504 it
->line_wrap
= TRUNCATE
;
2505 else if (NILP (current_buffer
->truncate_lines
))
2506 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2507 ? WINDOW_WRAP
: WORD_WRAP
;
2509 it
->line_wrap
= TRUNCATE
;
2511 /* Get dimensions of truncation and continuation glyphs. These are
2512 displayed as fringe bitmaps under X, so we don't need them for such
2514 if (!FRAME_WINDOW_P (it
->f
))
2516 if (it
->line_wrap
== TRUNCATE
)
2518 /* We will need the truncation glyph. */
2519 xassert (it
->glyph_row
== NULL
);
2520 produce_special_glyphs (it
, IT_TRUNCATION
);
2521 it
->truncation_pixel_width
= it
->pixel_width
;
2525 /* We will need the continuation glyph. */
2526 xassert (it
->glyph_row
== NULL
);
2527 produce_special_glyphs (it
, IT_CONTINUATION
);
2528 it
->continuation_pixel_width
= it
->pixel_width
;
2531 /* Reset these values to zero because the produce_special_glyphs
2532 above has changed them. */
2533 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2534 it
->phys_ascent
= it
->phys_descent
= 0;
2537 /* Set this after getting the dimensions of truncation and
2538 continuation glyphs, so that we don't produce glyphs when calling
2539 produce_special_glyphs, above. */
2540 it
->glyph_row
= row
;
2541 it
->area
= TEXT_AREA
;
2543 /* Forget any previous info about this row being reversed. */
2545 it
->glyph_row
->reversed_p
= 0;
2547 /* Get the dimensions of the display area. The display area
2548 consists of the visible window area plus a horizontally scrolled
2549 part to the left of the window. All x-values are relative to the
2550 start of this total display area. */
2551 if (base_face_id
!= DEFAULT_FACE_ID
)
2553 /* Mode lines, menu bar in terminal frames. */
2554 it
->first_visible_x
= 0;
2555 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2560 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2561 it
->last_visible_x
= (it
->first_visible_x
2562 + window_box_width (w
, TEXT_AREA
));
2564 /* If we truncate lines, leave room for the truncator glyph(s) at
2565 the right margin. Otherwise, leave room for the continuation
2566 glyph(s). Truncation and continuation glyphs are not inserted
2567 for window-based redisplay. */
2568 if (!FRAME_WINDOW_P (it
->f
))
2570 if (it
->line_wrap
== TRUNCATE
)
2571 it
->last_visible_x
-= it
->truncation_pixel_width
;
2573 it
->last_visible_x
-= it
->continuation_pixel_width
;
2576 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2577 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2580 /* Leave room for a border glyph. */
2581 if (!FRAME_WINDOW_P (it
->f
)
2582 && !WINDOW_RIGHTMOST_P (it
->w
))
2583 it
->last_visible_x
-= 1;
2585 it
->last_visible_y
= window_text_bottom_y (w
);
2587 /* For mode lines and alike, arrange for the first glyph having a
2588 left box line if the face specifies a box. */
2589 if (base_face_id
!= DEFAULT_FACE_ID
)
2593 it
->face_id
= remapped_base_face_id
;
2595 /* If we have a boxed mode line, make the first character appear
2596 with a left box line. */
2597 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2598 if (face
->box
!= FACE_NO_BOX
)
2599 it
->start_of_box_run_p
= 1;
2602 /* If we are to reorder bidirectional text, init the bidi
2606 /* Note the paragraph direction that this buffer wants to
2608 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2609 it
->paragraph_embedding
= L2R
;
2610 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2611 it
->paragraph_embedding
= R2L
;
2613 it
->paragraph_embedding
= NEUTRAL_DIR
;
2614 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2617 /* If a buffer position was specified, set the iterator there,
2618 getting overlays and face properties from that position. */
2619 if (charpos
>= BUF_BEG (current_buffer
))
2621 it
->end_charpos
= ZV
;
2623 IT_CHARPOS (*it
) = charpos
;
2625 /* Compute byte position if not specified. */
2626 if (bytepos
< charpos
)
2627 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2629 IT_BYTEPOS (*it
) = bytepos
;
2631 it
->start
= it
->current
;
2633 /* Compute faces etc. */
2634 reseat (it
, it
->current
.pos
, 1);
2641 /* Initialize IT for the display of window W with window start POS. */
2644 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2646 struct glyph_row
*row
;
2647 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2649 row
= w
->desired_matrix
->rows
+ first_vpos
;
2650 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2651 it
->first_vpos
= first_vpos
;
2653 /* Don't reseat to previous visible line start if current start
2654 position is in a string or image. */
2655 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2657 int start_at_line_beg_p
;
2658 int first_y
= it
->current_y
;
2660 /* If window start is not at a line start, skip forward to POS to
2661 get the correct continuation lines width. */
2662 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2663 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2664 if (!start_at_line_beg_p
)
2668 reseat_at_previous_visible_line_start (it
);
2669 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2671 new_x
= it
->current_x
+ it
->pixel_width
;
2673 /* If lines are continued, this line may end in the middle
2674 of a multi-glyph character (e.g. a control character
2675 displayed as \003, or in the middle of an overlay
2676 string). In this case move_it_to above will not have
2677 taken us to the start of the continuation line but to the
2678 end of the continued line. */
2679 if (it
->current_x
> 0
2680 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2681 && (/* And glyph doesn't fit on the line. */
2682 new_x
> it
->last_visible_x
2683 /* Or it fits exactly and we're on a window
2685 || (new_x
== it
->last_visible_x
2686 && FRAME_WINDOW_P (it
->f
))))
2688 if (it
->current
.dpvec_index
>= 0
2689 || it
->current
.overlay_string_index
>= 0)
2691 set_iterator_to_next (it
, 1);
2692 move_it_in_display_line_to (it
, -1, -1, 0);
2695 it
->continuation_lines_width
+= it
->current_x
;
2698 /* We're starting a new display line, not affected by the
2699 height of the continued line, so clear the appropriate
2700 fields in the iterator structure. */
2701 it
->max_ascent
= it
->max_descent
= 0;
2702 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2704 it
->current_y
= first_y
;
2706 it
->current_x
= it
->hpos
= 0;
2712 /* Return 1 if POS is a position in ellipses displayed for invisible
2713 text. W is the window we display, for text property lookup. */
2716 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2718 Lisp_Object prop
, window
;
2720 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2722 /* If POS specifies a position in a display vector, this might
2723 be for an ellipsis displayed for invisible text. We won't
2724 get the iterator set up for delivering that ellipsis unless
2725 we make sure that it gets aware of the invisible text. */
2726 if (pos
->dpvec_index
>= 0
2727 && pos
->overlay_string_index
< 0
2728 && CHARPOS (pos
->string_pos
) < 0
2730 && (XSETWINDOW (window
, w
),
2731 prop
= Fget_char_property (make_number (charpos
),
2732 Qinvisible
, window
),
2733 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2735 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2737 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2744 /* Initialize IT for stepping through current_buffer in window W,
2745 starting at position POS that includes overlay string and display
2746 vector/ control character translation position information. Value
2747 is zero if there are overlay strings with newlines at POS. */
2750 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2752 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2753 int i
, overlay_strings_with_newlines
= 0;
2755 /* If POS specifies a position in a display vector, this might
2756 be for an ellipsis displayed for invisible text. We won't
2757 get the iterator set up for delivering that ellipsis unless
2758 we make sure that it gets aware of the invisible text. */
2759 if (in_ellipses_for_invisible_text_p (pos
, w
))
2765 /* Keep in mind: the call to reseat in init_iterator skips invisible
2766 text, so we might end up at a position different from POS. This
2767 is only a problem when POS is a row start after a newline and an
2768 overlay starts there with an after-string, and the overlay has an
2769 invisible property. Since we don't skip invisible text in
2770 display_line and elsewhere immediately after consuming the
2771 newline before the row start, such a POS will not be in a string,
2772 but the call to init_iterator below will move us to the
2774 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2776 /* This only scans the current chunk -- it should scan all chunks.
2777 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2778 to 16 in 22.1 to make this a lesser problem. */
2779 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2781 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2782 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2784 while (s
< e
&& *s
!= '\n')
2789 overlay_strings_with_newlines
= 1;
2794 /* If position is within an overlay string, set up IT to the right
2796 if (pos
->overlay_string_index
>= 0)
2800 /* If the first overlay string happens to have a `display'
2801 property for an image, the iterator will be set up for that
2802 image, and we have to undo that setup first before we can
2803 correct the overlay string index. */
2804 if (it
->method
== GET_FROM_IMAGE
)
2807 /* We already have the first chunk of overlay strings in
2808 IT->overlay_strings. Load more until the one for
2809 pos->overlay_string_index is in IT->overlay_strings. */
2810 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2812 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2813 it
->current
.overlay_string_index
= 0;
2816 load_overlay_strings (it
, 0);
2817 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2821 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2822 relative_index
= (it
->current
.overlay_string_index
2823 % OVERLAY_STRING_CHUNK_SIZE
);
2824 it
->string
= it
->overlay_strings
[relative_index
];
2825 xassert (STRINGP (it
->string
));
2826 it
->current
.string_pos
= pos
->string_pos
;
2827 it
->method
= GET_FROM_STRING
;
2830 if (CHARPOS (pos
->string_pos
) >= 0)
2832 /* Recorded position is not in an overlay string, but in another
2833 string. This can only be a string from a `display' property.
2834 IT should already be filled with that string. */
2835 it
->current
.string_pos
= pos
->string_pos
;
2836 xassert (STRINGP (it
->string
));
2839 /* Restore position in display vector translations, control
2840 character translations or ellipses. */
2841 if (pos
->dpvec_index
>= 0)
2843 if (it
->dpvec
== NULL
)
2844 get_next_display_element (it
);
2845 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2846 it
->current
.dpvec_index
= pos
->dpvec_index
;
2850 return !overlay_strings_with_newlines
;
2854 /* Initialize IT for stepping through current_buffer in window W
2855 starting at ROW->start. */
2858 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2860 init_from_display_pos (it
, w
, &row
->start
);
2861 it
->start
= row
->start
;
2862 it
->continuation_lines_width
= row
->continuation_lines_width
;
2867 /* Initialize IT for stepping through current_buffer in window W
2868 starting in the line following ROW, i.e. starting at ROW->end.
2869 Value is zero if there are overlay strings with newlines at ROW's
2873 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2877 if (init_from_display_pos (it
, w
, &row
->end
))
2879 if (row
->continued_p
)
2880 it
->continuation_lines_width
2881 = row
->continuation_lines_width
+ row
->pixel_width
;
2892 /***********************************************************************
2894 ***********************************************************************/
2896 /* Called when IT reaches IT->stop_charpos. Handle text property and
2897 overlay changes. Set IT->stop_charpos to the next position where
2901 handle_stop (struct it
*it
)
2903 enum prop_handled handled
;
2904 int handle_overlay_change_p
;
2908 it
->current
.dpvec_index
= -1;
2909 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2910 it
->ignore_overlay_strings_at_pos_p
= 0;
2913 /* Use face of preceding text for ellipsis (if invisible) */
2914 if (it
->selective_display_ellipsis_p
)
2915 it
->saved_face_id
= it
->face_id
;
2919 handled
= HANDLED_NORMALLY
;
2921 /* Call text property handlers. */
2922 for (p
= it_props
; p
->handler
; ++p
)
2924 handled
= p
->handler (it
);
2926 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2928 else if (handled
== HANDLED_RETURN
)
2930 /* We still want to show before and after strings from
2931 overlays even if the actual buffer text is replaced. */
2932 if (!handle_overlay_change_p
2934 || !get_overlay_strings_1 (it
, 0, 0))
2937 setup_for_ellipsis (it
, 0);
2938 /* When handling a display spec, we might load an
2939 empty string. In that case, discard it here. We
2940 used to discard it in handle_single_display_spec,
2941 but that causes get_overlay_strings_1, above, to
2942 ignore overlay strings that we must check. */
2943 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2947 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2951 it
->ignore_overlay_strings_at_pos_p
= 1;
2952 it
->string_from_display_prop_p
= 0;
2953 handle_overlay_change_p
= 0;
2955 handled
= HANDLED_RECOMPUTE_PROPS
;
2958 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2959 handle_overlay_change_p
= 0;
2962 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2964 /* Don't check for overlay strings below when set to deliver
2965 characters from a display vector. */
2966 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2967 handle_overlay_change_p
= 0;
2969 /* Handle overlay changes.
2970 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2971 if it finds overlays. */
2972 if (handle_overlay_change_p
)
2973 handled
= handle_overlay_change (it
);
2978 setup_for_ellipsis (it
, 0);
2982 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2984 /* Determine where to stop next. */
2985 if (handled
== HANDLED_NORMALLY
)
2986 compute_stop_pos (it
);
2990 /* Compute IT->stop_charpos from text property and overlay change
2991 information for IT's current position. */
2994 compute_stop_pos (struct it
*it
)
2996 register INTERVAL iv
, next_iv
;
2997 Lisp_Object object
, limit
, position
;
2998 EMACS_INT charpos
, bytepos
;
3000 /* If nowhere else, stop at the end. */
3001 it
->stop_charpos
= it
->end_charpos
;
3003 if (STRINGP (it
->string
))
3005 /* Strings are usually short, so don't limit the search for
3007 object
= it
->string
;
3009 charpos
= IT_STRING_CHARPOS (*it
);
3010 bytepos
= IT_STRING_BYTEPOS (*it
);
3016 /* If next overlay change is in front of the current stop pos
3017 (which is IT->end_charpos), stop there. Note: value of
3018 next_overlay_change is point-max if no overlay change
3020 charpos
= IT_CHARPOS (*it
);
3021 bytepos
= IT_BYTEPOS (*it
);
3022 pos
= next_overlay_change (charpos
);
3023 if (pos
< it
->stop_charpos
)
3024 it
->stop_charpos
= pos
;
3026 /* If showing the region, we have to stop at the region
3027 start or end because the face might change there. */
3028 if (it
->region_beg_charpos
> 0)
3030 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3031 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3032 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3033 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3036 /* Set up variables for computing the stop position from text
3037 property changes. */
3038 XSETBUFFER (object
, current_buffer
);
3039 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3042 /* Get the interval containing IT's position. Value is a null
3043 interval if there isn't such an interval. */
3044 position
= make_number (charpos
);
3045 iv
= validate_interval_range (object
, &position
, &position
, 0);
3046 if (!NULL_INTERVAL_P (iv
))
3048 Lisp_Object values_here
[LAST_PROP_IDX
];
3051 /* Get properties here. */
3052 for (p
= it_props
; p
->handler
; ++p
)
3053 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3055 /* Look for an interval following iv that has different
3057 for (next_iv
= next_interval (iv
);
3058 (!NULL_INTERVAL_P (next_iv
)
3060 || XFASTINT (limit
) > next_iv
->position
));
3061 next_iv
= next_interval (next_iv
))
3063 for (p
= it_props
; p
->handler
; ++p
)
3065 Lisp_Object new_value
;
3067 new_value
= textget (next_iv
->plist
, *p
->name
);
3068 if (!EQ (values_here
[p
->idx
], new_value
))
3076 if (!NULL_INTERVAL_P (next_iv
))
3078 if (INTEGERP (limit
)
3079 && next_iv
->position
>= XFASTINT (limit
))
3080 /* No text property change up to limit. */
3081 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3083 /* Text properties change in next_iv. */
3084 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3088 if (it
->cmp_it
.id
< 0)
3090 EMACS_INT stoppos
= it
->end_charpos
;
3092 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3094 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3095 stoppos
, it
->string
);
3098 xassert (STRINGP (it
->string
)
3099 || (it
->stop_charpos
>= BEGV
3100 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3104 /* Return the position of the next overlay change after POS in
3105 current_buffer. Value is point-max if no overlay change
3106 follows. This is like `next-overlay-change' but doesn't use
3110 next_overlay_change (EMACS_INT pos
)
3114 Lisp_Object
*overlays
;
3117 /* Get all overlays at the given position. */
3118 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3120 /* If any of these overlays ends before endpos,
3121 use its ending point instead. */
3122 for (i
= 0; i
< noverlays
; ++i
)
3127 oend
= OVERLAY_END (overlays
[i
]);
3128 oendpos
= OVERLAY_POSITION (oend
);
3129 endpos
= min (endpos
, oendpos
);
3137 /***********************************************************************
3139 ***********************************************************************/
3141 /* Handle changes in the `fontified' property of the current buffer by
3142 calling hook functions from Qfontification_functions to fontify
3145 static enum prop_handled
3146 handle_fontified_prop (struct it
*it
)
3148 Lisp_Object prop
, pos
;
3149 enum prop_handled handled
= HANDLED_NORMALLY
;
3151 if (!NILP (Vmemory_full
))
3154 /* Get the value of the `fontified' property at IT's current buffer
3155 position. (The `fontified' property doesn't have a special
3156 meaning in strings.) If the value is nil, call functions from
3157 Qfontification_functions. */
3158 if (!STRINGP (it
->string
)
3160 && !NILP (Vfontification_functions
)
3161 && !NILP (Vrun_hooks
)
3162 && (pos
= make_number (IT_CHARPOS (*it
)),
3163 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3164 /* Ignore the special cased nil value always present at EOB since
3165 no amount of fontifying will be able to change it. */
3166 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3168 int count
= SPECPDL_INDEX ();
3171 val
= Vfontification_functions
;
3172 specbind (Qfontification_functions
, Qnil
);
3174 xassert (it
->end_charpos
== ZV
);
3176 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3177 safe_call1 (val
, pos
);
3180 Lisp_Object globals
, fn
;
3181 struct gcpro gcpro1
, gcpro2
;
3184 GCPRO2 (val
, globals
);
3186 for (; CONSP (val
); val
= XCDR (val
))
3192 /* A value of t indicates this hook has a local
3193 binding; it means to run the global binding too.
3194 In a global value, t should not occur. If it
3195 does, we must ignore it to avoid an endless
3197 for (globals
= Fdefault_value (Qfontification_functions
);
3199 globals
= XCDR (globals
))
3201 fn
= XCAR (globals
);
3203 safe_call1 (fn
, pos
);
3207 safe_call1 (fn
, pos
);
3213 unbind_to (count
, Qnil
);
3215 /* The fontification code may have added/removed text.
3216 It could do even a lot worse, but let's at least protect against
3217 the most obvious case where only the text past `pos' gets changed',
3218 as is/was done in grep.el where some escapes sequences are turned
3219 into face properties (bug#7876). */
3220 it
->end_charpos
= ZV
;
3222 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3223 something. This avoids an endless loop if they failed to
3224 fontify the text for which reason ever. */
3225 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3226 handled
= HANDLED_RECOMPUTE_PROPS
;
3234 /***********************************************************************
3236 ***********************************************************************/
3238 /* Set up iterator IT from face properties at its current position.
3239 Called from handle_stop. */
3241 static enum prop_handled
3242 handle_face_prop (struct it
*it
)
3245 EMACS_INT next_stop
;
3247 if (!STRINGP (it
->string
))
3250 = face_at_buffer_position (it
->w
,
3252 it
->region_beg_charpos
,
3253 it
->region_end_charpos
,
3256 + TEXT_PROP_DISTANCE_LIMIT
),
3257 0, it
->base_face_id
);
3259 /* Is this a start of a run of characters with box face?
3260 Caveat: this can be called for a freshly initialized
3261 iterator; face_id is -1 in this case. We know that the new
3262 face will not change until limit, i.e. if the new face has a
3263 box, all characters up to limit will have one. But, as
3264 usual, we don't know whether limit is really the end. */
3265 if (new_face_id
!= it
->face_id
)
3267 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3269 /* If new face has a box but old face has not, this is
3270 the start of a run of characters with box, i.e. it has
3271 a shadow on the left side. The value of face_id of the
3272 iterator will be -1 if this is the initial call that gets
3273 the face. In this case, we have to look in front of IT's
3274 position and see whether there is a face != new_face_id. */
3275 it
->start_of_box_run_p
3276 = (new_face
->box
!= FACE_NO_BOX
3277 && (it
->face_id
>= 0
3278 || IT_CHARPOS (*it
) == BEG
3279 || new_face_id
!= face_before_it_pos (it
)));
3280 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3288 Lisp_Object from_overlay
3289 = (it
->current
.overlay_string_index
>= 0
3290 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3293 /* See if we got to this string directly or indirectly from
3294 an overlay property. That includes the before-string or
3295 after-string of an overlay, strings in display properties
3296 provided by an overlay, their text properties, etc.
3298 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3299 if (! NILP (from_overlay
))
3300 for (i
= it
->sp
- 1; i
>= 0; i
--)
3302 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3304 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3305 else if (! NILP (it
->stack
[i
].from_overlay
))
3306 from_overlay
= it
->stack
[i
].from_overlay
;
3308 if (!NILP (from_overlay
))
3312 if (! NILP (from_overlay
))
3314 bufpos
= IT_CHARPOS (*it
);
3315 /* For a string from an overlay, the base face depends
3316 only on text properties and ignores overlays. */
3318 = face_for_overlay_string (it
->w
,
3320 it
->region_beg_charpos
,
3321 it
->region_end_charpos
,
3324 + TEXT_PROP_DISTANCE_LIMIT
),
3332 /* For strings from a `display' property, use the face at
3333 IT's current buffer position as the base face to merge
3334 with, so that overlay strings appear in the same face as
3335 surrounding text, unless they specify their own
3337 base_face_id
= underlying_face_id (it
);
3340 new_face_id
= face_at_string_position (it
->w
,
3342 IT_STRING_CHARPOS (*it
),
3344 it
->region_beg_charpos
,
3345 it
->region_end_charpos
,
3349 /* Is this a start of a run of characters with box? Caveat:
3350 this can be called for a freshly allocated iterator; face_id
3351 is -1 is this case. We know that the new face will not
3352 change until the next check pos, i.e. if the new face has a
3353 box, all characters up to that position will have a
3354 box. But, as usual, we don't know whether that position
3355 is really the end. */
3356 if (new_face_id
!= it
->face_id
)
3358 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3359 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3361 /* If new face has a box but old face hasn't, this is the
3362 start of a run of characters with box, i.e. it has a
3363 shadow on the left side. */
3364 it
->start_of_box_run_p
3365 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3366 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3370 it
->face_id
= new_face_id
;
3371 return HANDLED_NORMALLY
;
3375 /* Return the ID of the face ``underlying'' IT's current position,
3376 which is in a string. If the iterator is associated with a
3377 buffer, return the face at IT's current buffer position.
3378 Otherwise, use the iterator's base_face_id. */
3381 underlying_face_id (struct it
*it
)
3383 int face_id
= it
->base_face_id
, i
;
3385 xassert (STRINGP (it
->string
));
3387 for (i
= it
->sp
- 1; i
>= 0; --i
)
3388 if (NILP (it
->stack
[i
].string
))
3389 face_id
= it
->stack
[i
].face_id
;
3395 /* Compute the face one character before or after the current position
3396 of IT. BEFORE_P non-zero means get the face in front of IT's
3397 position. Value is the id of the face. */
3400 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3403 EMACS_INT next_check_charpos
;
3404 struct text_pos pos
;
3406 xassert (it
->s
== NULL
);
3408 if (STRINGP (it
->string
))
3413 /* No face change past the end of the string (for the case
3414 we are padding with spaces). No face change before the
3416 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3417 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3420 /* Set pos to the position before or after IT's current position. */
3422 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3424 /* For composition, we must check the character after the
3426 pos
= (it
->what
== IT_COMPOSITION
3427 ? string_pos (IT_STRING_CHARPOS (*it
)
3428 + it
->cmp_it
.nchars
, it
->string
)
3429 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3431 if (it
->current
.overlay_string_index
>= 0)
3432 bufpos
= IT_CHARPOS (*it
);
3436 base_face_id
= underlying_face_id (it
);
3438 /* Get the face for ASCII, or unibyte. */
3439 face_id
= face_at_string_position (it
->w
,
3443 it
->region_beg_charpos
,
3444 it
->region_end_charpos
,
3445 &next_check_charpos
,
3448 /* Correct the face for charsets different from ASCII. Do it
3449 for the multibyte case only. The face returned above is
3450 suitable for unibyte text if IT->string is unibyte. */
3451 if (STRING_MULTIBYTE (it
->string
))
3453 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3455 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3457 c
= string_char_and_length (p
, &len
);
3458 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3463 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3464 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3467 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3468 pos
= it
->current
.pos
;
3471 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3474 if (it
->what
== IT_COMPOSITION
)
3475 /* For composition, we must check the position after the
3477 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3479 INC_TEXT_POS (pos
, it
->multibyte_p
);
3482 /* Determine face for CHARSET_ASCII, or unibyte. */
3483 face_id
= face_at_buffer_position (it
->w
,
3485 it
->region_beg_charpos
,
3486 it
->region_end_charpos
,
3487 &next_check_charpos
,
3490 /* Correct the face for charsets different from ASCII. Do it
3491 for the multibyte case only. The face returned above is
3492 suitable for unibyte text if current_buffer is unibyte. */
3493 if (it
->multibyte_p
)
3495 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3496 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3497 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3506 /***********************************************************************
3508 ***********************************************************************/
3510 /* Set up iterator IT from invisible properties at its current
3511 position. Called from handle_stop. */
3513 static enum prop_handled
3514 handle_invisible_prop (struct it
*it
)
3516 enum prop_handled handled
= HANDLED_NORMALLY
;
3518 if (STRINGP (it
->string
))
3520 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3522 /* Get the value of the invisible text property at the
3523 current position. Value will be nil if there is no such
3525 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3526 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3529 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3531 handled
= HANDLED_RECOMPUTE_PROPS
;
3533 /* Get the position at which the next change of the
3534 invisible text property can be found in IT->string.
3535 Value will be nil if the property value is the same for
3536 all the rest of IT->string. */
3537 XSETINT (limit
, SCHARS (it
->string
));
3538 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3541 /* Text at current position is invisible. The next
3542 change in the property is at position end_charpos.
3543 Move IT's current position to that position. */
3544 if (INTEGERP (end_charpos
)
3545 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3547 struct text_pos old
;
3548 old
= it
->current
.string_pos
;
3549 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3550 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3554 /* The rest of the string is invisible. If this is an
3555 overlay string, proceed with the next overlay string
3556 or whatever comes and return a character from there. */
3557 if (it
->current
.overlay_string_index
>= 0)
3559 next_overlay_string (it
);
3560 /* Don't check for overlay strings when we just
3561 finished processing them. */
3562 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3566 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3567 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3575 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3576 Lisp_Object pos
, prop
, overlay
;
3578 /* First of all, is there invisible text at this position? */
3579 tem
= start_charpos
= IT_CHARPOS (*it
);
3580 pos
= make_number (tem
);
3581 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3583 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3585 /* If we are on invisible text, skip over it. */
3586 if (invis_p
&& start_charpos
< it
->end_charpos
)
3588 /* Record whether we have to display an ellipsis for the
3590 int display_ellipsis_p
= invis_p
== 2;
3592 handled
= HANDLED_RECOMPUTE_PROPS
;
3594 /* Loop skipping over invisible text. The loop is left at
3595 ZV or with IT on the first char being visible again. */
3598 /* Try to skip some invisible text. Return value is the
3599 position reached which can be equal to where we start
3600 if there is nothing invisible there. This skips both
3601 over invisible text properties and overlays with
3602 invisible property. */
3603 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3605 /* If we skipped nothing at all we weren't at invisible
3606 text in the first place. If everything to the end of
3607 the buffer was skipped, end the loop. */
3608 if (newpos
== tem
|| newpos
>= ZV
)
3612 /* We skipped some characters but not necessarily
3613 all there are. Check if we ended up on visible
3614 text. Fget_char_property returns the property of
3615 the char before the given position, i.e. if we
3616 get invis_p = 0, this means that the char at
3617 newpos is visible. */
3618 pos
= make_number (newpos
);
3619 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3620 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3623 /* If we ended up on invisible text, proceed to
3624 skip starting with next_stop. */
3628 /* If there are adjacent invisible texts, don't lose the
3629 second one's ellipsis. */
3631 display_ellipsis_p
= 1;
3635 /* The position newpos is now either ZV or on visible text. */
3636 if (it
->bidi_p
&& newpos
< ZV
)
3638 /* With bidi iteration, the region of invisible text
3639 could start and/or end in the middle of a non-base
3640 embedding level. Therefore, we need to skip
3641 invisible text using the bidi iterator, starting at
3642 IT's current position, until we find ourselves
3643 outside the invisible text. Skipping invisible text
3644 _after_ bidi iteration avoids affecting the visual
3645 order of the displayed text when invisible properties
3646 are added or removed. */
3647 if (it
->bidi_it
.first_elt
)
3649 /* If we were `reseat'ed to a new paragraph,
3650 determine the paragraph base direction. We need
3651 to do it now because next_element_from_buffer may
3652 not have a chance to do it, if we are going to
3653 skip any text at the beginning, which resets the
3655 bidi_paragraph_init (it
->paragraph_embedding
,
3660 bidi_move_to_visually_next (&it
->bidi_it
);
3662 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3663 && it
->bidi_it
.charpos
< newpos
);
3664 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3665 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3666 /* If we overstepped NEWPOS, record its position in the
3667 iterator, so that we skip invisible text if later the
3668 bidi iteration lands us in the invisible region
3670 if (IT_CHARPOS (*it
) >= newpos
)
3671 it
->prev_stop
= newpos
;
3675 IT_CHARPOS (*it
) = newpos
;
3676 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3679 /* If there are before-strings at the start of invisible
3680 text, and the text is invisible because of a text
3681 property, arrange to show before-strings because 20.x did
3682 it that way. (If the text is invisible because of an
3683 overlay property instead of a text property, this is
3684 already handled in the overlay code.) */
3686 && get_overlay_strings (it
, it
->stop_charpos
))
3688 handled
= HANDLED_RECOMPUTE_PROPS
;
3689 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3691 else if (display_ellipsis_p
)
3693 /* Make sure that the glyphs of the ellipsis will get
3694 correct `charpos' values. If we would not update
3695 it->position here, the glyphs would belong to the
3696 last visible character _before_ the invisible
3697 text, which confuses `set_cursor_from_row'.
3699 We use the last invisible position instead of the
3700 first because this way the cursor is always drawn on
3701 the first "." of the ellipsis, whenever PT is inside
3702 the invisible text. Otherwise the cursor would be
3703 placed _after_ the ellipsis when the point is after the
3704 first invisible character. */
3705 if (!STRINGP (it
->object
))
3707 it
->position
.charpos
= newpos
- 1;
3708 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3711 /* Let the ellipsis display before
3712 considering any properties of the following char.
3713 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3714 handled
= HANDLED_RETURN
;
3723 /* Make iterator IT return `...' next.
3724 Replaces LEN characters from buffer. */
3727 setup_for_ellipsis (struct it
*it
, int len
)
3729 /* Use the display table definition for `...'. Invalid glyphs
3730 will be handled by the method returning elements from dpvec. */
3731 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3733 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3734 it
->dpvec
= v
->contents
;
3735 it
->dpend
= v
->contents
+ v
->size
;
3739 /* Default `...'. */
3740 it
->dpvec
= default_invis_vector
;
3741 it
->dpend
= default_invis_vector
+ 3;
3744 it
->dpvec_char_len
= len
;
3745 it
->current
.dpvec_index
= 0;
3746 it
->dpvec_face_id
= -1;
3748 /* Remember the current face id in case glyphs specify faces.
3749 IT's face is restored in set_iterator_to_next.
3750 saved_face_id was set to preceding char's face in handle_stop. */
3751 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3752 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3754 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3760 /***********************************************************************
3762 ***********************************************************************/
3764 /* Set up iterator IT from `display' property at its current position.
3765 Called from handle_stop.
3766 We return HANDLED_RETURN if some part of the display property
3767 overrides the display of the buffer text itself.
3768 Otherwise we return HANDLED_NORMALLY. */
3770 static enum prop_handled
3771 handle_display_prop (struct it
*it
)
3773 Lisp_Object prop
, object
, overlay
;
3774 struct text_pos
*position
;
3775 /* Nonzero if some property replaces the display of the text itself. */
3776 int display_replaced_p
= 0;
3778 if (STRINGP (it
->string
))
3780 object
= it
->string
;
3781 position
= &it
->current
.string_pos
;
3785 XSETWINDOW (object
, it
->w
);
3786 position
= &it
->current
.pos
;
3789 /* Reset those iterator values set from display property values. */
3790 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3791 it
->space_width
= Qnil
;
3792 it
->font_height
= Qnil
;
3795 /* We don't support recursive `display' properties, i.e. string
3796 values that have a string `display' property, that have a string
3797 `display' property etc. */
3798 if (!it
->string_from_display_prop_p
)
3799 it
->area
= TEXT_AREA
;
3801 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3802 Qdisplay
, object
, &overlay
);
3804 return HANDLED_NORMALLY
;
3805 /* Now OVERLAY is the overlay that gave us this property, or nil
3806 if it was a text property. */
3808 if (!STRINGP (it
->string
))
3809 object
= it
->w
->buffer
;
3812 /* Simple properties. */
3813 && !EQ (XCAR (prop
), Qimage
)
3814 && !EQ (XCAR (prop
), Qspace
)
3815 && !EQ (XCAR (prop
), Qwhen
)
3816 && !EQ (XCAR (prop
), Qslice
)
3817 && !EQ (XCAR (prop
), Qspace_width
)
3818 && !EQ (XCAR (prop
), Qheight
)
3819 && !EQ (XCAR (prop
), Qraise
)
3820 /* Marginal area specifications. */
3821 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3822 && !EQ (XCAR (prop
), Qleft_fringe
)
3823 && !EQ (XCAR (prop
), Qright_fringe
)
3824 && !NILP (XCAR (prop
)))
3826 for (; CONSP (prop
); prop
= XCDR (prop
))
3828 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3829 position
, display_replaced_p
))
3831 display_replaced_p
= 1;
3832 /* If some text in a string is replaced, `position' no
3833 longer points to the position of `object'. */
3834 if (STRINGP (object
))
3839 else if (VECTORP (prop
))
3842 for (i
= 0; i
< ASIZE (prop
); ++i
)
3843 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3844 position
, display_replaced_p
))
3846 display_replaced_p
= 1;
3847 /* If some text in a string is replaced, `position' no
3848 longer points to the position of `object'. */
3849 if (STRINGP (object
))
3855 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3857 display_replaced_p
= 1;
3860 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3864 /* Value is the position of the end of the `display' property starting
3865 at START_POS in OBJECT. */
3867 static struct text_pos
3868 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3871 struct text_pos end_pos
;
3873 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3874 Qdisplay
, object
, Qnil
);
3875 CHARPOS (end_pos
) = XFASTINT (end
);
3876 if (STRINGP (object
))
3877 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3879 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3885 /* Set up IT from a single `display' specification PROP. OBJECT
3886 is the object in which the `display' property was found. *POSITION
3887 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3888 means that we previously saw a display specification which already
3889 replaced text display with something else, for example an image;
3890 we ignore such properties after the first one has been processed.
3892 OVERLAY is the overlay this `display' property came from,
3893 or nil if it was a text property.
3895 If PROP is a `space' or `image' specification, and in some other
3896 cases too, set *POSITION to the position where the `display'
3899 Value is non-zero if something was found which replaces the display
3900 of buffer or string text. */
3903 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3904 Lisp_Object overlay
, struct text_pos
*position
,
3905 int display_replaced_before_p
)
3908 Lisp_Object location
, value
;
3909 struct text_pos start_pos
, save_pos
;
3912 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3913 If the result is non-nil, use VALUE instead of SPEC. */
3915 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3924 if (!NILP (form
) && !EQ (form
, Qt
))
3926 int count
= SPECPDL_INDEX ();
3927 struct gcpro gcpro1
;
3929 /* Bind `object' to the object having the `display' property, a
3930 buffer or string. Bind `position' to the position in the
3931 object where the property was found, and `buffer-position'
3932 to the current position in the buffer. */
3933 specbind (Qobject
, object
);
3934 specbind (Qposition
, make_number (CHARPOS (*position
)));
3935 specbind (Qbuffer_position
,
3936 make_number (STRINGP (object
)
3937 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3939 form
= safe_eval (form
);
3941 unbind_to (count
, Qnil
);
3947 /* Handle `(height HEIGHT)' specifications. */
3949 && EQ (XCAR (spec
), Qheight
)
3950 && CONSP (XCDR (spec
)))
3952 if (!FRAME_WINDOW_P (it
->f
))
3955 it
->font_height
= XCAR (XCDR (spec
));
3956 if (!NILP (it
->font_height
))
3958 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3959 int new_height
= -1;
3961 if (CONSP (it
->font_height
)
3962 && (EQ (XCAR (it
->font_height
), Qplus
)
3963 || EQ (XCAR (it
->font_height
), Qminus
))
3964 && CONSP (XCDR (it
->font_height
))
3965 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3967 /* `(+ N)' or `(- N)' where N is an integer. */
3968 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3969 if (EQ (XCAR (it
->font_height
), Qplus
))
3971 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3973 else if (FUNCTIONP (it
->font_height
))
3975 /* Call function with current height as argument.
3976 Value is the new height. */
3978 height
= safe_call1 (it
->font_height
,
3979 face
->lface
[LFACE_HEIGHT_INDEX
]);
3980 if (NUMBERP (height
))
3981 new_height
= XFLOATINT (height
);
3983 else if (NUMBERP (it
->font_height
))
3985 /* Value is a multiple of the canonical char height. */
3988 face
= FACE_FROM_ID (it
->f
,
3989 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
3990 new_height
= (XFLOATINT (it
->font_height
)
3991 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
3995 /* Evaluate IT->font_height with `height' bound to the
3996 current specified height to get the new height. */
3997 int count
= SPECPDL_INDEX ();
3999 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4000 value
= safe_eval (it
->font_height
);
4001 unbind_to (count
, Qnil
);
4003 if (NUMBERP (value
))
4004 new_height
= XFLOATINT (value
);
4008 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4014 /* Handle `(space-width WIDTH)'. */
4016 && EQ (XCAR (spec
), Qspace_width
)
4017 && CONSP (XCDR (spec
)))
4019 if (!FRAME_WINDOW_P (it
->f
))
4022 value
= XCAR (XCDR (spec
));
4023 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4024 it
->space_width
= value
;
4029 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4031 && EQ (XCAR (spec
), Qslice
))
4035 if (!FRAME_WINDOW_P (it
->f
))
4038 if (tem
= XCDR (spec
), CONSP (tem
))
4040 it
->slice
.x
= XCAR (tem
);
4041 if (tem
= XCDR (tem
), CONSP (tem
))
4043 it
->slice
.y
= XCAR (tem
);
4044 if (tem
= XCDR (tem
), CONSP (tem
))
4046 it
->slice
.width
= XCAR (tem
);
4047 if (tem
= XCDR (tem
), CONSP (tem
))
4048 it
->slice
.height
= XCAR (tem
);
4056 /* Handle `(raise FACTOR)'. */
4058 && EQ (XCAR (spec
), Qraise
)
4059 && CONSP (XCDR (spec
)))
4061 if (!FRAME_WINDOW_P (it
->f
))
4064 #ifdef HAVE_WINDOW_SYSTEM
4065 value
= XCAR (XCDR (spec
));
4066 if (NUMBERP (value
))
4068 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4069 it
->voffset
= - (XFLOATINT (value
)
4070 * (FONT_HEIGHT (face
->font
)));
4072 #endif /* HAVE_WINDOW_SYSTEM */
4077 /* Don't handle the other kinds of display specifications
4078 inside a string that we got from a `display' property. */
4079 if (it
->string_from_display_prop_p
)
4082 /* Characters having this form of property are not displayed, so
4083 we have to find the end of the property. */
4084 start_pos
= *position
;
4085 *position
= display_prop_end (it
, object
, start_pos
);
4088 /* Stop the scan at that end position--we assume that all
4089 text properties change there. */
4090 it
->stop_charpos
= position
->charpos
;
4092 /* Handle `(left-fringe BITMAP [FACE])'
4093 and `(right-fringe BITMAP [FACE])'. */
4095 && (EQ (XCAR (spec
), Qleft_fringe
)
4096 || EQ (XCAR (spec
), Qright_fringe
))
4097 && CONSP (XCDR (spec
)))
4099 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4102 if (!FRAME_WINDOW_P (it
->f
))
4103 /* If we return here, POSITION has been advanced
4104 across the text with this property. */
4107 #ifdef HAVE_WINDOW_SYSTEM
4108 value
= XCAR (XCDR (spec
));
4109 if (!SYMBOLP (value
)
4110 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4111 /* If we return here, POSITION has been advanced
4112 across the text with this property. */
4115 if (CONSP (XCDR (XCDR (spec
))))
4117 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4118 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4124 /* Save current settings of IT so that we can restore them
4125 when we are finished with the glyph property value. */
4127 save_pos
= it
->position
;
4128 it
->position
= *position
;
4130 it
->position
= save_pos
;
4132 it
->area
= TEXT_AREA
;
4133 it
->what
= IT_IMAGE
;
4134 it
->image_id
= -1; /* no image */
4135 it
->position
= start_pos
;
4136 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4137 it
->method
= GET_FROM_IMAGE
;
4138 it
->from_overlay
= Qnil
;
4139 it
->face_id
= face_id
;
4141 /* Say that we haven't consumed the characters with
4142 `display' property yet. The call to pop_it in
4143 set_iterator_to_next will clean this up. */
4144 *position
= start_pos
;
4146 if (EQ (XCAR (spec
), Qleft_fringe
))
4148 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4149 it
->left_user_fringe_face_id
= face_id
;
4153 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4154 it
->right_user_fringe_face_id
= face_id
;
4156 #endif /* HAVE_WINDOW_SYSTEM */
4160 /* Prepare to handle `((margin left-margin) ...)',
4161 `((margin right-margin) ...)' and `((margin nil) ...)'
4162 prefixes for display specifications. */
4163 location
= Qunbound
;
4164 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4168 value
= XCDR (spec
);
4170 value
= XCAR (value
);
4173 if (EQ (XCAR (tem
), Qmargin
)
4174 && (tem
= XCDR (tem
),
4175 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4177 || EQ (tem
, Qleft_margin
)
4178 || EQ (tem
, Qright_margin
))))
4182 if (EQ (location
, Qunbound
))
4188 /* After this point, VALUE is the property after any
4189 margin prefix has been stripped. It must be a string,
4190 an image specification, or `(space ...)'.
4192 LOCATION specifies where to display: `left-margin',
4193 `right-margin' or nil. */
4195 valid_p
= (STRINGP (value
)
4196 #ifdef HAVE_WINDOW_SYSTEM
4197 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4198 #endif /* not HAVE_WINDOW_SYSTEM */
4199 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4201 if (valid_p
&& !display_replaced_before_p
)
4203 /* Save current settings of IT so that we can restore them
4204 when we are finished with the glyph property value. */
4205 save_pos
= it
->position
;
4206 it
->position
= *position
;
4208 it
->position
= save_pos
;
4209 it
->from_overlay
= overlay
;
4211 if (NILP (location
))
4212 it
->area
= TEXT_AREA
;
4213 else if (EQ (location
, Qleft_margin
))
4214 it
->area
= LEFT_MARGIN_AREA
;
4216 it
->area
= RIGHT_MARGIN_AREA
;
4218 if (STRINGP (value
))
4221 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4222 it
->current
.overlay_string_index
= -1;
4223 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4224 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4225 it
->method
= GET_FROM_STRING
;
4226 it
->stop_charpos
= 0;
4227 it
->string_from_display_prop_p
= 1;
4228 /* Say that we haven't consumed the characters with
4229 `display' property yet. The call to pop_it in
4230 set_iterator_to_next will clean this up. */
4231 if (BUFFERP (object
))
4232 *position
= start_pos
;
4234 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4236 it
->method
= GET_FROM_STRETCH
;
4238 *position
= it
->position
= start_pos
;
4240 #ifdef HAVE_WINDOW_SYSTEM
4243 it
->what
= IT_IMAGE
;
4244 it
->image_id
= lookup_image (it
->f
, value
);
4245 it
->position
= start_pos
;
4246 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4247 it
->method
= GET_FROM_IMAGE
;
4249 /* Say that we haven't consumed the characters with
4250 `display' property yet. The call to pop_it in
4251 set_iterator_to_next will clean this up. */
4252 *position
= start_pos
;
4254 #endif /* HAVE_WINDOW_SYSTEM */
4259 /* Invalid property or property not supported. Restore
4260 POSITION to what it was before. */
4261 *position
= start_pos
;
4266 /* Check if SPEC is a display sub-property value whose text should be
4267 treated as intangible. */
4270 single_display_spec_intangible_p (Lisp_Object prop
)
4272 /* Skip over `when FORM'. */
4273 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4287 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4288 we don't need to treat text as intangible. */
4289 if (EQ (XCAR (prop
), Qmargin
))
4297 || EQ (XCAR (prop
), Qleft_margin
)
4298 || EQ (XCAR (prop
), Qright_margin
))
4302 return (CONSP (prop
)
4303 && (EQ (XCAR (prop
), Qimage
)
4304 || EQ (XCAR (prop
), Qspace
)));
4308 /* Check if PROP is a display property value whose text should be
4309 treated as intangible. */
4312 display_prop_intangible_p (Lisp_Object prop
)
4315 && CONSP (XCAR (prop
))
4316 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4318 /* A list of sub-properties. */
4319 while (CONSP (prop
))
4321 if (single_display_spec_intangible_p (XCAR (prop
)))
4326 else if (VECTORP (prop
))
4328 /* A vector of sub-properties. */
4330 for (i
= 0; i
< ASIZE (prop
); ++i
)
4331 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4335 return single_display_spec_intangible_p (prop
);
4341 /* Return 1 if PROP is a display sub-property value containing STRING. */
4344 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4346 if (EQ (string
, prop
))
4349 /* Skip over `when FORM'. */
4350 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4359 /* Skip over `margin LOCATION'. */
4360 if (EQ (XCAR (prop
), Qmargin
))
4371 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4375 /* Return 1 if STRING appears in the `display' property PROP. */
4378 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4381 && CONSP (XCAR (prop
))
4382 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4384 /* A list of sub-properties. */
4385 while (CONSP (prop
))
4387 if (single_display_spec_string_p (XCAR (prop
), string
))
4392 else if (VECTORP (prop
))
4394 /* A vector of sub-properties. */
4396 for (i
= 0; i
< ASIZE (prop
); ++i
)
4397 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4401 return single_display_spec_string_p (prop
, string
);
4406 /* Look for STRING in overlays and text properties in W's buffer,
4407 between character positions FROM and TO (excluding TO).
4408 BACK_P non-zero means look back (in this case, TO is supposed to be
4410 Value is the first character position where STRING was found, or
4411 zero if it wasn't found before hitting TO.
4413 W's buffer must be current.
4415 This function may only use code that doesn't eval because it is
4416 called asynchronously from note_mouse_highlight. */
4419 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4420 EMACS_INT from
, EMACS_INT to
, int back_p
)
4422 Lisp_Object limit
, prop
, pos
;
4425 pos
= make_number (from
);
4427 if (!back_p
) /* looking forward */
4429 limit
= make_number (min (to
, ZV
));
4430 while (!found
&& !EQ (pos
, limit
))
4432 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4433 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4436 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4440 else /* looking back */
4442 limit
= make_number (max (to
, BEGV
));
4443 while (!found
&& !EQ (pos
, limit
))
4445 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4446 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4449 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4454 return found
? XINT (pos
) : 0;
4457 /* Determine which buffer position in W's buffer STRING comes from.
4458 AROUND_CHARPOS is an approximate position where it could come from.
4459 Value is the buffer position or 0 if it couldn't be determined.
4461 W's buffer must be current.
4463 This function is necessary because we don't record buffer positions
4464 in glyphs generated from strings (to keep struct glyph small).
4465 This function may only use code that doesn't eval because it is
4466 called asynchronously from note_mouse_highlight. */
4469 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4471 const int MAX_DISTANCE
= 1000;
4472 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4473 around_charpos
+ MAX_DISTANCE
,
4477 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4478 around_charpos
- MAX_DISTANCE
, 1);
4484 /***********************************************************************
4485 `composition' property
4486 ***********************************************************************/
4488 /* Set up iterator IT from `composition' property at its current
4489 position. Called from handle_stop. */
4491 static enum prop_handled
4492 handle_composition_prop (struct it
*it
)
4494 Lisp_Object prop
, string
;
4495 EMACS_INT pos
, pos_byte
, start
, end
;
4497 if (STRINGP (it
->string
))
4501 pos
= IT_STRING_CHARPOS (*it
);
4502 pos_byte
= IT_STRING_BYTEPOS (*it
);
4503 string
= it
->string
;
4504 s
= SDATA (string
) + pos_byte
;
4505 it
->c
= STRING_CHAR (s
);
4509 pos
= IT_CHARPOS (*it
);
4510 pos_byte
= IT_BYTEPOS (*it
);
4512 it
->c
= FETCH_CHAR (pos_byte
);
4515 /* If there's a valid composition and point is not inside of the
4516 composition (in the case that the composition is from the current
4517 buffer), draw a glyph composed from the composition components. */
4518 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4519 && COMPOSITION_VALID_P (start
, end
, prop
)
4520 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4524 if (STRINGP (it
->string
))
4525 pos_byte
= string_char_to_byte (it
->string
, start
);
4527 pos_byte
= CHAR_TO_BYTE (start
);
4529 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4532 if (it
->cmp_it
.id
>= 0)
4535 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4536 it
->cmp_it
.nglyphs
= -1;
4540 return HANDLED_NORMALLY
;
4545 /***********************************************************************
4547 ***********************************************************************/
4549 /* The following structure is used to record overlay strings for
4550 later sorting in load_overlay_strings. */
4552 struct overlay_entry
4554 Lisp_Object overlay
;
4561 /* Set up iterator IT from overlay strings at its current position.
4562 Called from handle_stop. */
4564 static enum prop_handled
4565 handle_overlay_change (struct it
*it
)
4567 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4568 return HANDLED_RECOMPUTE_PROPS
;
4570 return HANDLED_NORMALLY
;
4574 /* Set up the next overlay string for delivery by IT, if there is an
4575 overlay string to deliver. Called by set_iterator_to_next when the
4576 end of the current overlay string is reached. If there are more
4577 overlay strings to display, IT->string and
4578 IT->current.overlay_string_index are set appropriately here.
4579 Otherwise IT->string is set to nil. */
4582 next_overlay_string (struct it
*it
)
4584 ++it
->current
.overlay_string_index
;
4585 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4587 /* No more overlay strings. Restore IT's settings to what
4588 they were before overlay strings were processed, and
4589 continue to deliver from current_buffer. */
4591 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4594 || (NILP (it
->string
)
4595 && it
->method
== GET_FROM_BUFFER
4596 && it
->stop_charpos
>= BEGV
4597 && it
->stop_charpos
<= it
->end_charpos
));
4598 it
->current
.overlay_string_index
= -1;
4599 it
->n_overlay_strings
= 0;
4600 it
->overlay_strings_charpos
= -1;
4602 /* If we're at the end of the buffer, record that we have
4603 processed the overlay strings there already, so that
4604 next_element_from_buffer doesn't try it again. */
4605 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4606 it
->overlay_strings_at_end_processed_p
= 1;
4610 /* There are more overlay strings to process. If
4611 IT->current.overlay_string_index has advanced to a position
4612 where we must load IT->overlay_strings with more strings, do
4613 it. We must load at the IT->overlay_strings_charpos where
4614 IT->n_overlay_strings was originally computed; when invisible
4615 text is present, this might not be IT_CHARPOS (Bug#7016). */
4616 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4618 if (it
->current
.overlay_string_index
&& i
== 0)
4619 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4621 /* Initialize IT to deliver display elements from the overlay
4623 it
->string
= it
->overlay_strings
[i
];
4624 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4625 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4626 it
->method
= GET_FROM_STRING
;
4627 it
->stop_charpos
= 0;
4628 if (it
->cmp_it
.stop_pos
>= 0)
4629 it
->cmp_it
.stop_pos
= 0;
4636 /* Compare two overlay_entry structures E1 and E2. Used as a
4637 comparison function for qsort in load_overlay_strings. Overlay
4638 strings for the same position are sorted so that
4640 1. All after-strings come in front of before-strings, except
4641 when they come from the same overlay.
4643 2. Within after-strings, strings are sorted so that overlay strings
4644 from overlays with higher priorities come first.
4646 2. Within before-strings, strings are sorted so that overlay
4647 strings from overlays with higher priorities come last.
4649 Value is analogous to strcmp. */
4653 compare_overlay_entries (const void *e1
, const void *e2
)
4655 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4656 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4659 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4661 /* Let after-strings appear in front of before-strings if
4662 they come from different overlays. */
4663 if (EQ (entry1
->overlay
, entry2
->overlay
))
4664 result
= entry1
->after_string_p
? 1 : -1;
4666 result
= entry1
->after_string_p
? -1 : 1;
4668 else if (entry1
->after_string_p
)
4669 /* After-strings sorted in order of decreasing priority. */
4670 result
= entry2
->priority
- entry1
->priority
;
4672 /* Before-strings sorted in order of increasing priority. */
4673 result
= entry1
->priority
- entry2
->priority
;
4679 /* Load the vector IT->overlay_strings with overlay strings from IT's
4680 current buffer position, or from CHARPOS if that is > 0. Set
4681 IT->n_overlays to the total number of overlay strings found.
4683 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4684 a time. On entry into load_overlay_strings,
4685 IT->current.overlay_string_index gives the number of overlay
4686 strings that have already been loaded by previous calls to this
4689 IT->add_overlay_start contains an additional overlay start
4690 position to consider for taking overlay strings from, if non-zero.
4691 This position comes into play when the overlay has an `invisible'
4692 property, and both before and after-strings. When we've skipped to
4693 the end of the overlay, because of its `invisible' property, we
4694 nevertheless want its before-string to appear.
4695 IT->add_overlay_start will contain the overlay start position
4698 Overlay strings are sorted so that after-string strings come in
4699 front of before-string strings. Within before and after-strings,
4700 strings are sorted by overlay priority. See also function
4701 compare_overlay_entries. */
4704 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4706 Lisp_Object overlay
, window
, str
, invisible
;
4707 struct Lisp_Overlay
*ov
;
4708 EMACS_INT start
, end
;
4710 int n
= 0, i
, j
, invis_p
;
4711 struct overlay_entry
*entries
4712 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4715 charpos
= IT_CHARPOS (*it
);
4717 /* Append the overlay string STRING of overlay OVERLAY to vector
4718 `entries' which has size `size' and currently contains `n'
4719 elements. AFTER_P non-zero means STRING is an after-string of
4721 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4724 Lisp_Object priority; \
4728 int new_size = 2 * size; \
4729 struct overlay_entry *old = entries; \
4731 (struct overlay_entry *) alloca (new_size \
4732 * sizeof *entries); \
4733 memcpy (entries, old, size * sizeof *entries); \
4737 entries[n].string = (STRING); \
4738 entries[n].overlay = (OVERLAY); \
4739 priority = Foverlay_get ((OVERLAY), Qpriority); \
4740 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4741 entries[n].after_string_p = (AFTER_P); \
4746 /* Process overlay before the overlay center. */
4747 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4749 XSETMISC (overlay
, ov
);
4750 xassert (OVERLAYP (overlay
));
4751 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4752 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4757 /* Skip this overlay if it doesn't start or end at IT's current
4759 if (end
!= charpos
&& start
!= charpos
)
4762 /* Skip this overlay if it doesn't apply to IT->w. */
4763 window
= Foverlay_get (overlay
, Qwindow
);
4764 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4767 /* If the text ``under'' the overlay is invisible, both before-
4768 and after-strings from this overlay are visible; start and
4769 end position are indistinguishable. */
4770 invisible
= Foverlay_get (overlay
, Qinvisible
);
4771 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4773 /* If overlay has a non-empty before-string, record it. */
4774 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4775 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4777 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4779 /* If overlay has a non-empty after-string, record it. */
4780 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4781 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4783 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4786 /* Process overlays after the overlay center. */
4787 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4789 XSETMISC (overlay
, ov
);
4790 xassert (OVERLAYP (overlay
));
4791 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4792 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4794 if (start
> charpos
)
4797 /* Skip this overlay if it doesn't start or end at IT's current
4799 if (end
!= charpos
&& start
!= charpos
)
4802 /* Skip this overlay if it doesn't apply to IT->w. */
4803 window
= Foverlay_get (overlay
, Qwindow
);
4804 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4807 /* If the text ``under'' the overlay is invisible, it has a zero
4808 dimension, and both before- and after-strings apply. */
4809 invisible
= Foverlay_get (overlay
, Qinvisible
);
4810 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4812 /* If overlay has a non-empty before-string, record it. */
4813 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4814 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4816 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4818 /* If overlay has a non-empty after-string, record it. */
4819 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4820 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4822 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4825 #undef RECORD_OVERLAY_STRING
4829 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4831 /* Record number of overlay strings, and where we computed it. */
4832 it
->n_overlay_strings
= n
;
4833 it
->overlay_strings_charpos
= charpos
;
4835 /* IT->current.overlay_string_index is the number of overlay strings
4836 that have already been consumed by IT. Copy some of the
4837 remaining overlay strings to IT->overlay_strings. */
4839 j
= it
->current
.overlay_string_index
;
4840 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4842 it
->overlay_strings
[i
] = entries
[j
].string
;
4843 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4850 /* Get the first chunk of overlay strings at IT's current buffer
4851 position, or at CHARPOS if that is > 0. Value is non-zero if at
4852 least one overlay string was found. */
4855 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4857 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4858 process. This fills IT->overlay_strings with strings, and sets
4859 IT->n_overlay_strings to the total number of strings to process.
4860 IT->pos.overlay_string_index has to be set temporarily to zero
4861 because load_overlay_strings needs this; it must be set to -1
4862 when no overlay strings are found because a zero value would
4863 indicate a position in the first overlay string. */
4864 it
->current
.overlay_string_index
= 0;
4865 load_overlay_strings (it
, charpos
);
4867 /* If we found overlay strings, set up IT to deliver display
4868 elements from the first one. Otherwise set up IT to deliver
4869 from current_buffer. */
4870 if (it
->n_overlay_strings
)
4872 /* Make sure we know settings in current_buffer, so that we can
4873 restore meaningful values when we're done with the overlay
4876 compute_stop_pos (it
);
4877 xassert (it
->face_id
>= 0);
4879 /* Save IT's settings. They are restored after all overlay
4880 strings have been processed. */
4881 xassert (!compute_stop_p
|| it
->sp
== 0);
4883 /* When called from handle_stop, there might be an empty display
4884 string loaded. In that case, don't bother saving it. */
4885 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4888 /* Set up IT to deliver display elements from the first overlay
4890 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4891 it
->string
= it
->overlay_strings
[0];
4892 it
->from_overlay
= Qnil
;
4893 it
->stop_charpos
= 0;
4894 xassert (STRINGP (it
->string
));
4895 it
->end_charpos
= SCHARS (it
->string
);
4896 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4897 it
->method
= GET_FROM_STRING
;
4901 it
->current
.overlay_string_index
= -1;
4906 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4909 it
->method
= GET_FROM_BUFFER
;
4911 (void) get_overlay_strings_1 (it
, charpos
, 1);
4915 /* Value is non-zero if we found at least one overlay string. */
4916 return STRINGP (it
->string
);
4921 /***********************************************************************
4922 Saving and restoring state
4923 ***********************************************************************/
4925 /* Save current settings of IT on IT->stack. Called, for example,
4926 before setting up IT for an overlay string, to be able to restore
4927 IT's settings to what they were after the overlay string has been
4931 push_it (struct it
*it
)
4933 struct iterator_stack_entry
*p
;
4935 xassert (it
->sp
< IT_STACK_SIZE
);
4936 p
= it
->stack
+ it
->sp
;
4938 p
->stop_charpos
= it
->stop_charpos
;
4939 p
->prev_stop
= it
->prev_stop
;
4940 p
->base_level_stop
= it
->base_level_stop
;
4941 p
->cmp_it
= it
->cmp_it
;
4942 xassert (it
->face_id
>= 0);
4943 p
->face_id
= it
->face_id
;
4944 p
->string
= it
->string
;
4945 p
->method
= it
->method
;
4946 p
->from_overlay
= it
->from_overlay
;
4949 case GET_FROM_IMAGE
:
4950 p
->u
.image
.object
= it
->object
;
4951 p
->u
.image
.image_id
= it
->image_id
;
4952 p
->u
.image
.slice
= it
->slice
;
4954 case GET_FROM_STRETCH
:
4955 p
->u
.stretch
.object
= it
->object
;
4958 p
->position
= it
->position
;
4959 p
->current
= it
->current
;
4960 p
->end_charpos
= it
->end_charpos
;
4961 p
->string_nchars
= it
->string_nchars
;
4963 p
->multibyte_p
= it
->multibyte_p
;
4964 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
4965 p
->space_width
= it
->space_width
;
4966 p
->font_height
= it
->font_height
;
4967 p
->voffset
= it
->voffset
;
4968 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4969 p
->display_ellipsis_p
= 0;
4970 p
->line_wrap
= it
->line_wrap
;
4975 iterate_out_of_display_property (struct it
*it
)
4977 /* Maybe initialize paragraph direction. If we are at the beginning
4978 of a new paragraph, next_element_from_buffer may not have a
4979 chance to do that. */
4980 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4981 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
4982 /* prev_stop can be zero, so check against BEGV as well. */
4983 while (it
->bidi_it
.charpos
>= BEGV
4984 && it
->prev_stop
<= it
->bidi_it
.charpos
4985 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
4986 bidi_move_to_visually_next (&it
->bidi_it
);
4987 /* Record the stop_pos we just crossed, for when we cross it
4989 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
4990 it
->prev_stop
= CHARPOS (it
->position
);
4991 /* If we ended up not where pop_it put us, resync IT's
4992 positional members with the bidi iterator. */
4993 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
4995 SET_TEXT_POS (it
->position
,
4996 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
4997 it
->current
.pos
= it
->position
;
5001 /* Restore IT's settings from IT->stack. Called, for example, when no
5002 more overlay strings must be processed, and we return to delivering
5003 display elements from a buffer, or when the end of a string from a
5004 `display' property is reached and we return to delivering display
5005 elements from an overlay string, or from a buffer. */
5008 pop_it (struct it
*it
)
5010 struct iterator_stack_entry
*p
;
5012 xassert (it
->sp
> 0);
5014 p
= it
->stack
+ it
->sp
;
5015 it
->stop_charpos
= p
->stop_charpos
;
5016 it
->prev_stop
= p
->prev_stop
;
5017 it
->base_level_stop
= p
->base_level_stop
;
5018 it
->cmp_it
= p
->cmp_it
;
5019 it
->face_id
= p
->face_id
;
5020 it
->current
= p
->current
;
5021 it
->position
= p
->position
;
5022 it
->string
= p
->string
;
5023 it
->from_overlay
= p
->from_overlay
;
5024 if (NILP (it
->string
))
5025 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5026 it
->method
= p
->method
;
5029 case GET_FROM_IMAGE
:
5030 it
->image_id
= p
->u
.image
.image_id
;
5031 it
->object
= p
->u
.image
.object
;
5032 it
->slice
= p
->u
.image
.slice
;
5034 case GET_FROM_STRETCH
:
5035 it
->object
= p
->u
.comp
.object
;
5037 case GET_FROM_BUFFER
:
5038 it
->object
= it
->w
->buffer
;
5041 /* Bidi-iterate until we get out of the portion of text, if
5042 any, covered by a `display' text property or an overlay
5043 with `display' property. (We cannot just jump there,
5044 because the internal coherency of the bidi iterator state
5045 can not be preserved across such jumps.) We also must
5046 determine the paragraph base direction if the overlay we
5047 just processed is at the beginning of a new
5049 iterate_out_of_display_property (it
);
5052 case GET_FROM_STRING
:
5053 it
->object
= it
->string
;
5055 case GET_FROM_DISPLAY_VECTOR
:
5057 it
->method
= GET_FROM_C_STRING
;
5058 else if (STRINGP (it
->string
))
5059 it
->method
= GET_FROM_STRING
;
5062 it
->method
= GET_FROM_BUFFER
;
5063 it
->object
= it
->w
->buffer
;
5066 it
->end_charpos
= p
->end_charpos
;
5067 it
->string_nchars
= p
->string_nchars
;
5069 it
->multibyte_p
= p
->multibyte_p
;
5070 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5071 it
->space_width
= p
->space_width
;
5072 it
->font_height
= p
->font_height
;
5073 it
->voffset
= p
->voffset
;
5074 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5075 it
->line_wrap
= p
->line_wrap
;
5080 /***********************************************************************
5082 ***********************************************************************/
5084 /* Set IT's current position to the previous line start. */
5087 back_to_previous_line_start (struct it
*it
)
5089 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5090 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5094 /* Move IT to the next line start.
5096 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5097 we skipped over part of the text (as opposed to moving the iterator
5098 continuously over the text). Otherwise, don't change the value
5101 Newlines may come from buffer text, overlay strings, or strings
5102 displayed via the `display' property. That's the reason we can't
5103 simply use find_next_newline_no_quit.
5105 Note that this function may not skip over invisible text that is so
5106 because of text properties and immediately follows a newline. If
5107 it would, function reseat_at_next_visible_line_start, when called
5108 from set_iterator_to_next, would effectively make invisible
5109 characters following a newline part of the wrong glyph row, which
5110 leads to wrong cursor motion. */
5113 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5115 int old_selective
, newline_found_p
, n
;
5116 const int MAX_NEWLINE_DISTANCE
= 500;
5118 /* If already on a newline, just consume it to avoid unintended
5119 skipping over invisible text below. */
5120 if (it
->what
== IT_CHARACTER
5122 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5124 set_iterator_to_next (it
, 0);
5129 /* Don't handle selective display in the following. It's (a)
5130 unnecessary because it's done by the caller, and (b) leads to an
5131 infinite recursion because next_element_from_ellipsis indirectly
5132 calls this function. */
5133 old_selective
= it
->selective
;
5136 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5137 from buffer text. */
5138 for (n
= newline_found_p
= 0;
5139 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5140 n
+= STRINGP (it
->string
) ? 0 : 1)
5142 if (!get_next_display_element (it
))
5144 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5145 set_iterator_to_next (it
, 0);
5148 /* If we didn't find a newline near enough, see if we can use a
5150 if (!newline_found_p
)
5152 EMACS_INT start
= IT_CHARPOS (*it
);
5153 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5156 xassert (!STRINGP (it
->string
));
5158 /* If there isn't any `display' property in sight, and no
5159 overlays, we can just use the position of the newline in
5161 if (it
->stop_charpos
>= limit
5162 || ((pos
= Fnext_single_property_change (make_number (start
),
5164 Qnil
, make_number (limit
)),
5166 && next_overlay_change (start
) == ZV
))
5168 IT_CHARPOS (*it
) = limit
;
5169 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5170 *skipped_p
= newline_found_p
= 1;
5174 while (get_next_display_element (it
)
5175 && !newline_found_p
)
5177 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5178 set_iterator_to_next (it
, 0);
5183 it
->selective
= old_selective
;
5184 return newline_found_p
;
5188 /* Set IT's current position to the previous visible line start. Skip
5189 invisible text that is so either due to text properties or due to
5190 selective display. Caution: this does not change IT->current_x and
5194 back_to_previous_visible_line_start (struct it
*it
)
5196 while (IT_CHARPOS (*it
) > BEGV
)
5198 back_to_previous_line_start (it
);
5200 if (IT_CHARPOS (*it
) <= BEGV
)
5203 /* If selective > 0, then lines indented more than its value are
5205 if (it
->selective
> 0
5206 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5207 (double) it
->selective
)) /* iftc */
5210 /* Check the newline before point for invisibility. */
5213 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5214 Qinvisible
, it
->window
);
5215 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5219 if (IT_CHARPOS (*it
) <= BEGV
)
5226 Lisp_Object val
, overlay
;
5228 /* If newline is part of a composition, continue from start of composition */
5229 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5230 && beg
< IT_CHARPOS (*it
))
5233 /* If newline is replaced by a display property, find start of overlay
5234 or interval and continue search from that point. */
5236 pos
= --IT_CHARPOS (it2
);
5239 it2
.string_from_display_prop_p
= 0;
5240 if (handle_display_prop (&it2
) == HANDLED_RETURN
5241 && !NILP (val
= get_char_property_and_overlay
5242 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5243 && (OVERLAYP (overlay
)
5244 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5245 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5248 /* Newline is not replaced by anything -- so we are done. */
5254 IT_CHARPOS (*it
) = beg
;
5255 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5259 it
->continuation_lines_width
= 0;
5261 xassert (IT_CHARPOS (*it
) >= BEGV
);
5262 xassert (IT_CHARPOS (*it
) == BEGV
5263 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5268 /* Reseat iterator IT at the previous visible line start. Skip
5269 invisible text that is so either due to text properties or due to
5270 selective display. At the end, update IT's overlay information,
5271 face information etc. */
5274 reseat_at_previous_visible_line_start (struct it
*it
)
5276 back_to_previous_visible_line_start (it
);
5277 reseat (it
, it
->current
.pos
, 1);
5282 /* Reseat iterator IT on the next visible line start in the current
5283 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5284 preceding the line start. Skip over invisible text that is so
5285 because of selective display. Compute faces, overlays etc at the
5286 new position. Note that this function does not skip over text that
5287 is invisible because of text properties. */
5290 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5292 int newline_found_p
, skipped_p
= 0;
5294 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5296 /* Skip over lines that are invisible because they are indented
5297 more than the value of IT->selective. */
5298 if (it
->selective
> 0)
5299 while (IT_CHARPOS (*it
) < ZV
5300 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5301 (double) it
->selective
)) /* iftc */
5303 xassert (IT_BYTEPOS (*it
) == BEGV
5304 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5305 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5308 /* Position on the newline if that's what's requested. */
5309 if (on_newline_p
&& newline_found_p
)
5311 if (STRINGP (it
->string
))
5313 if (IT_STRING_CHARPOS (*it
) > 0)
5315 --IT_STRING_CHARPOS (*it
);
5316 --IT_STRING_BYTEPOS (*it
);
5319 else if (IT_CHARPOS (*it
) > BEGV
)
5323 reseat (it
, it
->current
.pos
, 0);
5327 reseat (it
, it
->current
.pos
, 0);
5334 /***********************************************************************
5335 Changing an iterator's position
5336 ***********************************************************************/
5338 /* Change IT's current position to POS in current_buffer. If FORCE_P
5339 is non-zero, always check for text properties at the new position.
5340 Otherwise, text properties are only looked up if POS >=
5341 IT->check_charpos of a property. */
5344 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5346 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5348 reseat_1 (it
, pos
, 0);
5350 /* Determine where to check text properties. Avoid doing it
5351 where possible because text property lookup is very expensive. */
5353 || CHARPOS (pos
) > it
->stop_charpos
5354 || CHARPOS (pos
) < original_pos
)
5358 /* For bidi iteration, we need to prime prev_stop and
5359 base_level_stop with our best estimations. */
5360 if (CHARPOS (pos
) < it
->prev_stop
)
5362 handle_stop_backwards (it
, BEGV
);
5363 if (CHARPOS (pos
) < it
->base_level_stop
)
5364 it
->base_level_stop
= 0;
5366 else if (CHARPOS (pos
) > it
->stop_charpos
5367 && it
->stop_charpos
>= BEGV
)
5368 handle_stop_backwards (it
, it
->stop_charpos
);
5375 it
->prev_stop
= it
->base_level_stop
= 0;
5384 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5385 IT->stop_pos to POS, also. */
5388 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5390 /* Don't call this function when scanning a C string. */
5391 xassert (it
->s
== NULL
);
5393 /* POS must be a reasonable value. */
5394 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5396 it
->current
.pos
= it
->position
= pos
;
5397 it
->end_charpos
= ZV
;
5399 it
->current
.dpvec_index
= -1;
5400 it
->current
.overlay_string_index
= -1;
5401 IT_STRING_CHARPOS (*it
) = -1;
5402 IT_STRING_BYTEPOS (*it
) = -1;
5404 it
->string_from_display_prop_p
= 0;
5405 it
->method
= GET_FROM_BUFFER
;
5406 it
->object
= it
->w
->buffer
;
5407 it
->area
= TEXT_AREA
;
5408 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5410 it
->string_from_display_prop_p
= 0;
5411 it
->face_before_selective_p
= 0;
5414 it
->bidi_it
.first_elt
= 1;
5415 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5420 it
->stop_charpos
= CHARPOS (pos
);
5421 it
->base_level_stop
= CHARPOS (pos
);
5426 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5427 If S is non-null, it is a C string to iterate over. Otherwise,
5428 STRING gives a Lisp string to iterate over.
5430 If PRECISION > 0, don't return more then PRECISION number of
5431 characters from the string.
5433 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5434 characters have been returned. FIELD_WIDTH < 0 means an infinite
5437 MULTIBYTE = 0 means disable processing of multibyte characters,
5438 MULTIBYTE > 0 means enable it,
5439 MULTIBYTE < 0 means use IT->multibyte_p.
5441 IT must be initialized via a prior call to init_iterator before
5442 calling this function. */
5445 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5446 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5449 /* No region in strings. */
5450 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5452 /* No text property checks performed by default, but see below. */
5453 it
->stop_charpos
= -1;
5455 /* Set iterator position and end position. */
5456 memset (&it
->current
, 0, sizeof it
->current
);
5457 it
->current
.overlay_string_index
= -1;
5458 it
->current
.dpvec_index
= -1;
5459 xassert (charpos
>= 0);
5461 /* If STRING is specified, use its multibyteness, otherwise use the
5462 setting of MULTIBYTE, if specified. */
5464 it
->multibyte_p
= multibyte
> 0;
5468 xassert (STRINGP (string
));
5469 it
->string
= string
;
5471 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5472 it
->method
= GET_FROM_STRING
;
5473 it
->current
.string_pos
= string_pos (charpos
, string
);
5477 it
->s
= (const unsigned char *) s
;
5480 /* Note that we use IT->current.pos, not it->current.string_pos,
5481 for displaying C strings. */
5482 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5483 if (it
->multibyte_p
)
5485 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5486 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5490 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5491 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5494 it
->method
= GET_FROM_C_STRING
;
5497 /* PRECISION > 0 means don't return more than PRECISION characters
5499 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5500 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5502 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5503 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5504 FIELD_WIDTH < 0 means infinite field width. This is useful for
5505 padding with `-' at the end of a mode line. */
5506 if (field_width
< 0)
5507 field_width
= INFINITY
;
5508 if (field_width
> it
->end_charpos
- charpos
)
5509 it
->end_charpos
= charpos
+ field_width
;
5511 /* Use the standard display table for displaying strings. */
5512 if (DISP_TABLE_P (Vstandard_display_table
))
5513 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5515 it
->stop_charpos
= charpos
;
5516 if (s
== NULL
&& it
->multibyte_p
)
5518 EMACS_INT endpos
= SCHARS (it
->string
);
5519 if (endpos
> it
->end_charpos
)
5520 endpos
= it
->end_charpos
;
5521 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5529 /***********************************************************************
5531 ***********************************************************************/
5533 /* Map enum it_method value to corresponding next_element_from_* function. */
5535 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5537 next_element_from_buffer
,
5538 next_element_from_display_vector
,
5539 next_element_from_string
,
5540 next_element_from_c_string
,
5541 next_element_from_image
,
5542 next_element_from_stretch
5545 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5548 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5549 (possibly with the following characters). */
5551 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5552 ((IT)->cmp_it.id >= 0 \
5553 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5554 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5555 END_CHARPOS, (IT)->w, \
5556 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5560 /* Lookup the char-table Vglyphless_char_display for character C (-1
5561 if we want information for no-font case), and return the display
5562 method symbol. By side-effect, update it->what and
5563 it->glyphless_method. This function is called from
5564 get_next_display_element for each character element, and from
5565 x_produce_glyphs when no suitable font was found. */
5568 lookup_glyphless_char_display (int c
, struct it
*it
)
5570 Lisp_Object glyphless_method
= Qnil
;
5572 if (CHAR_TABLE_P (Vglyphless_char_display
)
5573 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5574 glyphless_method
= (c
>= 0
5575 ? CHAR_TABLE_REF (Vglyphless_char_display
, c
)
5576 : XCHAR_TABLE (Vglyphless_char_display
)->extras
[0]);
5578 if (NILP (glyphless_method
))
5581 /* The default is to display the character by a proper font. */
5583 /* The default for the no-font case is to display an empty box. */
5584 glyphless_method
= Qempty_box
;
5586 if (EQ (glyphless_method
, Qzero_width
))
5589 return glyphless_method
;
5590 /* This method can't be used for the no-font case. */
5591 glyphless_method
= Qempty_box
;
5593 if (EQ (glyphless_method
, Qthin_space
))
5594 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5595 else if (EQ (glyphless_method
, Qempty_box
))
5596 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5597 else if (EQ (glyphless_method
, Qhex_code
))
5598 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5599 else if (STRINGP (glyphless_method
))
5600 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5603 /* Invalid value. We use the default method. */
5604 glyphless_method
= Qnil
;
5607 it
->what
= IT_GLYPHLESS
;
5608 return glyphless_method
;
5611 /* Load IT's display element fields with information about the next
5612 display element from the current position of IT. Value is zero if
5613 end of buffer (or C string) is reached. */
5615 static struct frame
*last_escape_glyph_frame
= NULL
;
5616 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5617 static int last_escape_glyph_merged_face_id
= 0;
5619 struct frame
*last_glyphless_glyph_frame
= NULL
;
5620 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5621 int last_glyphless_glyph_merged_face_id
= 0;
5624 get_next_display_element (struct it
*it
)
5626 /* Non-zero means that we found a display element. Zero means that
5627 we hit the end of what we iterate over. Performance note: the
5628 function pointer `method' used here turns out to be faster than
5629 using a sequence of if-statements. */
5633 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5635 if (it
->what
== IT_CHARACTER
)
5637 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5638 and only if (a) the resolved directionality of that character
5640 /* FIXME: Do we need an exception for characters from display
5642 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5643 it
->c
= bidi_mirror_char (it
->c
);
5644 /* Map via display table or translate control characters.
5645 IT->c, IT->len etc. have been set to the next character by
5646 the function call above. If we have a display table, and it
5647 contains an entry for IT->c, translate it. Don't do this if
5648 IT->c itself comes from a display table, otherwise we could
5649 end up in an infinite recursion. (An alternative could be to
5650 count the recursion depth of this function and signal an
5651 error when a certain maximum depth is reached.) Is it worth
5653 if (success_p
&& it
->dpvec
== NULL
)
5656 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5657 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5658 nbsp_or_shy
= char_is_other
;
5659 int c
= it
->c
; /* This is the character to display. */
5661 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5663 xassert (SINGLE_BYTE_CHAR_P (c
));
5664 if (unibyte_display_via_language_environment
)
5666 c
= DECODE_CHAR (unibyte
, c
);
5668 c
= BYTE8_TO_CHAR (it
->c
);
5671 c
= BYTE8_TO_CHAR (it
->c
);
5675 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5678 struct Lisp_Vector
*v
= XVECTOR (dv
);
5680 /* Return the first character from the display table
5681 entry, if not empty. If empty, don't display the
5682 current character. */
5685 it
->dpvec_char_len
= it
->len
;
5686 it
->dpvec
= v
->contents
;
5687 it
->dpend
= v
->contents
+ v
->size
;
5688 it
->current
.dpvec_index
= 0;
5689 it
->dpvec_face_id
= -1;
5690 it
->saved_face_id
= it
->face_id
;
5691 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5696 set_iterator_to_next (it
, 0);
5701 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5703 if (it
->what
== IT_GLYPHLESS
)
5705 /* Don't display this character. */
5706 set_iterator_to_next (it
, 0);
5710 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5711 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5712 : c
== 0xAD ? char_is_soft_hyphen
5715 /* Translate control characters into `\003' or `^C' form.
5716 Control characters coming from a display table entry are
5717 currently not translated because we use IT->dpvec to hold
5718 the translation. This could easily be changed but I
5719 don't believe that it is worth doing.
5721 NBSP and SOFT-HYPEN are property translated too.
5723 Non-printable characters and raw-byte characters are also
5724 translated to octal form. */
5725 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5726 ? (it
->area
!= TEXT_AREA
5727 /* In mode line, treat \n, \t like other crl chars. */
5730 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5731 || (c
!= '\n' && c
!= '\t'))
5734 || ! CHAR_PRINTABLE_P (c
))))
5736 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5737 or a non-printable character which must be displayed
5738 either as '\003' or as `^C' where the '\\' and '^'
5739 can be defined in the display table. Fill
5740 IT->ctl_chars with glyphs for what we have to
5741 display. Then, set IT->dpvec to these glyphs. */
5744 int face_id
, lface_id
= 0 ;
5747 /* Handle control characters with ^. */
5749 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5753 g
= '^'; /* default glyph for Control */
5754 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5756 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5757 && GLYPH_CODE_CHAR_VALID_P (gc
))
5759 g
= GLYPH_CODE_CHAR (gc
);
5760 lface_id
= GLYPH_CODE_FACE (gc
);
5764 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5766 else if (it
->f
== last_escape_glyph_frame
5767 && it
->face_id
== last_escape_glyph_face_id
)
5769 face_id
= last_escape_glyph_merged_face_id
;
5773 /* Merge the escape-glyph face into the current face. */
5774 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5776 last_escape_glyph_frame
= it
->f
;
5777 last_escape_glyph_face_id
= it
->face_id
;
5778 last_escape_glyph_merged_face_id
= face_id
;
5781 XSETINT (it
->ctl_chars
[0], g
);
5782 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5784 goto display_control
;
5787 /* Handle non-break space in the mode where it only gets
5790 if (EQ (Vnobreak_char_display
, Qt
)
5791 && nbsp_or_shy
== char_is_nbsp
)
5793 /* Merge the no-break-space face into the current face. */
5794 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5798 XSETINT (it
->ctl_chars
[0], ' ');
5800 goto display_control
;
5803 /* Handle sequences that start with the "escape glyph". */
5805 /* the default escape glyph is \. */
5806 escape_glyph
= '\\';
5809 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5810 && GLYPH_CODE_CHAR_VALID_P (gc
))
5812 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5813 lface_id
= GLYPH_CODE_FACE (gc
);
5817 /* The display table specified a face.
5818 Merge it into face_id and also into escape_glyph. */
5819 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5822 else if (it
->f
== last_escape_glyph_frame
5823 && it
->face_id
== last_escape_glyph_face_id
)
5825 face_id
= last_escape_glyph_merged_face_id
;
5829 /* Merge the escape-glyph face into the current face. */
5830 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5832 last_escape_glyph_frame
= it
->f
;
5833 last_escape_glyph_face_id
= it
->face_id
;
5834 last_escape_glyph_merged_face_id
= face_id
;
5837 /* Handle soft hyphens in the mode where they only get
5840 if (EQ (Vnobreak_char_display
, Qt
)
5841 && nbsp_or_shy
== char_is_soft_hyphen
)
5843 XSETINT (it
->ctl_chars
[0], '-');
5845 goto display_control
;
5848 /* Handle non-break space and soft hyphen
5849 with the escape glyph. */
5853 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5854 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5855 XSETINT (it
->ctl_chars
[1], c
);
5857 goto display_control
;
5864 if (CHAR_BYTE8_P (c
))
5865 /* Display \200 instead of \17777600. */
5866 c
= CHAR_TO_BYTE8 (c
);
5867 len
= sprintf (str
, "%03o", c
);
5869 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5870 for (i
= 0; i
< len
; i
++)
5871 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5876 /* Set up IT->dpvec and return first character from it. */
5877 it
->dpvec_char_len
= it
->len
;
5878 it
->dpvec
= it
->ctl_chars
;
5879 it
->dpend
= it
->dpvec
+ ctl_len
;
5880 it
->current
.dpvec_index
= 0;
5881 it
->dpvec_face_id
= face_id
;
5882 it
->saved_face_id
= it
->face_id
;
5883 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5887 it
->char_to_display
= c
;
5891 it
->char_to_display
= it
->c
;
5895 #ifdef HAVE_WINDOW_SYSTEM
5896 /* Adjust face id for a multibyte character. There are no multibyte
5897 character in unibyte text. */
5898 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5901 && FRAME_WINDOW_P (it
->f
))
5903 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5905 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5907 /* Automatic composition with glyph-string. */
5908 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5910 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5914 EMACS_INT pos
= (it
->s
? -1
5915 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5916 : IT_CHARPOS (*it
));
5918 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5925 /* Is this character the last one of a run of characters with
5926 box? If yes, set IT->end_of_box_run_p to 1. */
5930 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5932 int face_id
= underlying_face_id (it
);
5933 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5937 if (face
->box
== FACE_NO_BOX
)
5939 /* If the box comes from face properties in a
5940 display string, check faces in that string. */
5941 int string_face_id
= face_after_it_pos (it
);
5942 it
->end_of_box_run_p
5943 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5946 /* Otherwise, the box comes from the underlying face.
5947 If this is the last string character displayed, check
5948 the next buffer location. */
5949 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5950 && (it
->current
.overlay_string_index
5951 == it
->n_overlay_strings
- 1))
5955 struct text_pos pos
= it
->current
.pos
;
5956 INC_TEXT_POS (pos
, it
->multibyte_p
);
5958 next_face_id
= face_at_buffer_position
5959 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5960 it
->region_end_charpos
, &ignore
,
5961 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5963 it
->end_of_box_run_p
5964 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5971 int face_id
= face_after_it_pos (it
);
5972 it
->end_of_box_run_p
5973 = (face_id
!= it
->face_id
5974 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5978 /* Value is 0 if end of buffer or string reached. */
5983 /* Move IT to the next display element.
5985 RESEAT_P non-zero means if called on a newline in buffer text,
5986 skip to the next visible line start.
5988 Functions get_next_display_element and set_iterator_to_next are
5989 separate because I find this arrangement easier to handle than a
5990 get_next_display_element function that also increments IT's
5991 position. The way it is we can first look at an iterator's current
5992 display element, decide whether it fits on a line, and if it does,
5993 increment the iterator position. The other way around we probably
5994 would either need a flag indicating whether the iterator has to be
5995 incremented the next time, or we would have to implement a
5996 decrement position function which would not be easy to write. */
5999 set_iterator_to_next (struct it
*it
, int reseat_p
)
6001 /* Reset flags indicating start and end of a sequence of characters
6002 with box. Reset them at the start of this function because
6003 moving the iterator to a new position might set them. */
6004 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6008 case GET_FROM_BUFFER
:
6009 /* The current display element of IT is a character from
6010 current_buffer. Advance in the buffer, and maybe skip over
6011 invisible lines that are so because of selective display. */
6012 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6013 reseat_at_next_visible_line_start (it
, 0);
6014 else if (it
->cmp_it
.id
>= 0)
6016 /* We are currently getting glyphs from a composition. */
6021 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6022 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6023 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6025 it
->cmp_it
.from
= it
->cmp_it
.to
;
6030 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6032 it
->end_charpos
, Qnil
);
6035 else if (! it
->cmp_it
.reversed_p
)
6037 /* Composition created while scanning forward. */
6038 /* Update IT's char/byte positions to point to the first
6039 character of the next grapheme cluster, or to the
6040 character visually after the current composition. */
6041 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6042 bidi_move_to_visually_next (&it
->bidi_it
);
6043 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6044 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6046 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6048 /* Proceed to the next grapheme cluster. */
6049 it
->cmp_it
.from
= it
->cmp_it
.to
;
6053 /* No more grapheme clusters in this composition.
6054 Find the next stop position. */
6055 EMACS_INT stop
= it
->end_charpos
;
6056 if (it
->bidi_it
.scan_dir
< 0)
6057 /* Now we are scanning backward and don't know
6060 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6061 IT_BYTEPOS (*it
), stop
, Qnil
);
6066 /* Composition created while scanning backward. */
6067 /* Update IT's char/byte positions to point to the last
6068 character of the previous grapheme cluster, or the
6069 character visually after the current composition. */
6070 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6071 bidi_move_to_visually_next (&it
->bidi_it
);
6072 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6073 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6074 if (it
->cmp_it
.from
> 0)
6076 /* Proceed to the previous grapheme cluster. */
6077 it
->cmp_it
.to
= it
->cmp_it
.from
;
6081 /* No more grapheme clusters in this composition.
6082 Find the next stop position. */
6083 EMACS_INT stop
= it
->end_charpos
;
6084 if (it
->bidi_it
.scan_dir
< 0)
6085 /* Now we are scanning backward and don't know
6088 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6089 IT_BYTEPOS (*it
), stop
, Qnil
);
6095 xassert (it
->len
!= 0);
6099 IT_BYTEPOS (*it
) += it
->len
;
6100 IT_CHARPOS (*it
) += 1;
6104 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6105 /* If this is a new paragraph, determine its base
6106 direction (a.k.a. its base embedding level). */
6107 if (it
->bidi_it
.new_paragraph
)
6108 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6109 bidi_move_to_visually_next (&it
->bidi_it
);
6110 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6111 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6112 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6114 /* As the scan direction was changed, we must
6115 re-compute the stop position for composition. */
6116 EMACS_INT stop
= it
->end_charpos
;
6117 if (it
->bidi_it
.scan_dir
< 0)
6119 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6120 IT_BYTEPOS (*it
), stop
, Qnil
);
6123 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6127 case GET_FROM_C_STRING
:
6128 /* Current display element of IT is from a C string. */
6129 IT_BYTEPOS (*it
) += it
->len
;
6130 IT_CHARPOS (*it
) += 1;
6133 case GET_FROM_DISPLAY_VECTOR
:
6134 /* Current display element of IT is from a display table entry.
6135 Advance in the display table definition. Reset it to null if
6136 end reached, and continue with characters from buffers/
6138 ++it
->current
.dpvec_index
;
6140 /* Restore face of the iterator to what they were before the
6141 display vector entry (these entries may contain faces). */
6142 it
->face_id
= it
->saved_face_id
;
6144 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6146 int recheck_faces
= it
->ellipsis_p
;
6149 it
->method
= GET_FROM_C_STRING
;
6150 else if (STRINGP (it
->string
))
6151 it
->method
= GET_FROM_STRING
;
6154 it
->method
= GET_FROM_BUFFER
;
6155 it
->object
= it
->w
->buffer
;
6159 it
->current
.dpvec_index
= -1;
6161 /* Skip over characters which were displayed via IT->dpvec. */
6162 if (it
->dpvec_char_len
< 0)
6163 reseat_at_next_visible_line_start (it
, 1);
6164 else if (it
->dpvec_char_len
> 0)
6166 if (it
->method
== GET_FROM_STRING
6167 && it
->n_overlay_strings
> 0)
6168 it
->ignore_overlay_strings_at_pos_p
= 1;
6169 it
->len
= it
->dpvec_char_len
;
6170 set_iterator_to_next (it
, reseat_p
);
6173 /* Maybe recheck faces after display vector */
6175 it
->stop_charpos
= IT_CHARPOS (*it
);
6179 case GET_FROM_STRING
:
6180 /* Current display element is a character from a Lisp string. */
6181 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6182 if (it
->cmp_it
.id
>= 0)
6184 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6185 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6186 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6187 it
->cmp_it
.from
= it
->cmp_it
.to
;
6191 composition_compute_stop_pos (&it
->cmp_it
,
6192 IT_STRING_CHARPOS (*it
),
6193 IT_STRING_BYTEPOS (*it
),
6194 it
->end_charpos
, it
->string
);
6199 IT_STRING_BYTEPOS (*it
) += it
->len
;
6200 IT_STRING_CHARPOS (*it
) += 1;
6203 consider_string_end
:
6205 if (it
->current
.overlay_string_index
>= 0)
6207 /* IT->string is an overlay string. Advance to the
6208 next, if there is one. */
6209 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6212 next_overlay_string (it
);
6214 setup_for_ellipsis (it
, 0);
6219 /* IT->string is not an overlay string. If we reached
6220 its end, and there is something on IT->stack, proceed
6221 with what is on the stack. This can be either another
6222 string, this time an overlay string, or a buffer. */
6223 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6227 if (it
->method
== GET_FROM_STRING
)
6228 goto consider_string_end
;
6233 case GET_FROM_IMAGE
:
6234 case GET_FROM_STRETCH
:
6235 /* The position etc with which we have to proceed are on
6236 the stack. The position may be at the end of a string,
6237 if the `display' property takes up the whole string. */
6238 xassert (it
->sp
> 0);
6240 if (it
->method
== GET_FROM_STRING
)
6241 goto consider_string_end
;
6245 /* There are no other methods defined, so this should be a bug. */
6249 xassert (it
->method
!= GET_FROM_STRING
6250 || (STRINGP (it
->string
)
6251 && IT_STRING_CHARPOS (*it
) >= 0));
6254 /* Load IT's display element fields with information about the next
6255 display element which comes from a display table entry or from the
6256 result of translating a control character to one of the forms `^C'
6259 IT->dpvec holds the glyphs to return as characters.
6260 IT->saved_face_id holds the face id before the display vector--it
6261 is restored into IT->face_id in set_iterator_to_next. */
6264 next_element_from_display_vector (struct it
*it
)
6269 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6271 it
->face_id
= it
->saved_face_id
;
6273 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6274 That seemed totally bogus - so I changed it... */
6275 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6277 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6279 it
->c
= GLYPH_CODE_CHAR (gc
);
6280 it
->len
= CHAR_BYTES (it
->c
);
6282 /* The entry may contain a face id to use. Such a face id is
6283 the id of a Lisp face, not a realized face. A face id of
6284 zero means no face is specified. */
6285 if (it
->dpvec_face_id
>= 0)
6286 it
->face_id
= it
->dpvec_face_id
;
6289 int lface_id
= GLYPH_CODE_FACE (gc
);
6291 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6296 /* Display table entry is invalid. Return a space. */
6297 it
->c
= ' ', it
->len
= 1;
6299 /* Don't change position and object of the iterator here. They are
6300 still the values of the character that had this display table
6301 entry or was translated, and that's what we want. */
6302 it
->what
= IT_CHARACTER
;
6307 /* Load IT with the next display element from Lisp string IT->string.
6308 IT->current.string_pos is the current position within the string.
6309 If IT->current.overlay_string_index >= 0, the Lisp string is an
6313 next_element_from_string (struct it
*it
)
6315 struct text_pos position
;
6317 xassert (STRINGP (it
->string
));
6318 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6319 position
= it
->current
.string_pos
;
6321 /* Time to check for invisible text? */
6322 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6323 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6327 /* Since a handler may have changed IT->method, we must
6329 return GET_NEXT_DISPLAY_ELEMENT (it
);
6332 if (it
->current
.overlay_string_index
>= 0)
6334 /* Get the next character from an overlay string. In overlay
6335 strings, There is no field width or padding with spaces to
6337 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6342 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6343 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6344 && next_element_from_composition (it
))
6348 else if (STRING_MULTIBYTE (it
->string
))
6350 const unsigned char *s
= (SDATA (it
->string
)
6351 + IT_STRING_BYTEPOS (*it
));
6352 it
->c
= string_char_and_length (s
, &it
->len
);
6356 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6362 /* Get the next character from a Lisp string that is not an
6363 overlay string. Such strings come from the mode line, for
6364 example. We may have to pad with spaces, or truncate the
6365 string. See also next_element_from_c_string. */
6366 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6371 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6373 /* Pad with spaces. */
6374 it
->c
= ' ', it
->len
= 1;
6375 CHARPOS (position
) = BYTEPOS (position
) = -1;
6377 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6378 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6379 && next_element_from_composition (it
))
6383 else if (STRING_MULTIBYTE (it
->string
))
6385 const unsigned char *s
= (SDATA (it
->string
)
6386 + IT_STRING_BYTEPOS (*it
));
6387 it
->c
= string_char_and_length (s
, &it
->len
);
6391 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6396 /* Record what we have and where it came from. */
6397 it
->what
= IT_CHARACTER
;
6398 it
->object
= it
->string
;
6399 it
->position
= position
;
6404 /* Load IT with next display element from C string IT->s.
6405 IT->string_nchars is the maximum number of characters to return
6406 from the string. IT->end_charpos may be greater than
6407 IT->string_nchars when this function is called, in which case we
6408 may have to return padding spaces. Value is zero if end of string
6409 reached, including padding spaces. */
6412 next_element_from_c_string (struct it
*it
)
6417 it
->what
= IT_CHARACTER
;
6418 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6421 /* IT's position can be greater IT->string_nchars in case a field
6422 width or precision has been specified when the iterator was
6424 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6426 /* End of the game. */
6430 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6432 /* Pad with spaces. */
6433 it
->c
= ' ', it
->len
= 1;
6434 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6436 else if (it
->multibyte_p
)
6437 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6439 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6445 /* Set up IT to return characters from an ellipsis, if appropriate.
6446 The definition of the ellipsis glyphs may come from a display table
6447 entry. This function fills IT with the first glyph from the
6448 ellipsis if an ellipsis is to be displayed. */
6451 next_element_from_ellipsis (struct it
*it
)
6453 if (it
->selective_display_ellipsis_p
)
6454 setup_for_ellipsis (it
, it
->len
);
6457 /* The face at the current position may be different from the
6458 face we find after the invisible text. Remember what it
6459 was in IT->saved_face_id, and signal that it's there by
6460 setting face_before_selective_p. */
6461 it
->saved_face_id
= it
->face_id
;
6462 it
->method
= GET_FROM_BUFFER
;
6463 it
->object
= it
->w
->buffer
;
6464 reseat_at_next_visible_line_start (it
, 1);
6465 it
->face_before_selective_p
= 1;
6468 return GET_NEXT_DISPLAY_ELEMENT (it
);
6472 /* Deliver an image display element. The iterator IT is already
6473 filled with image information (done in handle_display_prop). Value
6478 next_element_from_image (struct it
*it
)
6480 it
->what
= IT_IMAGE
;
6481 it
->ignore_overlay_strings_at_pos_p
= 0;
6486 /* Fill iterator IT with next display element from a stretch glyph
6487 property. IT->object is the value of the text property. Value is
6491 next_element_from_stretch (struct it
*it
)
6493 it
->what
= IT_STRETCH
;
6497 /* Scan forward from CHARPOS in the current buffer, until we find a
6498 stop position > current IT's position. Then handle the stop
6499 position before that. This is called when we bump into a stop
6500 position while reordering bidirectional text. CHARPOS should be
6501 the last previously processed stop_pos (or BEGV, if none were
6502 processed yet) whose position is less that IT's current
6506 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6508 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6509 struct display_pos save_current
= it
->current
;
6510 struct text_pos save_position
= it
->position
;
6511 struct text_pos pos1
;
6512 EMACS_INT next_stop
;
6514 /* Scan in strict logical order. */
6518 it
->prev_stop
= charpos
;
6519 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6520 reseat_1 (it
, pos1
, 0);
6521 compute_stop_pos (it
);
6522 /* We must advance forward, right? */
6523 if (it
->stop_charpos
<= it
->prev_stop
)
6525 charpos
= it
->stop_charpos
;
6527 while (charpos
<= where_we_are
);
6529 next_stop
= it
->stop_charpos
;
6530 it
->stop_charpos
= it
->prev_stop
;
6532 it
->current
= save_current
;
6533 it
->position
= save_position
;
6535 it
->stop_charpos
= next_stop
;
6538 /* Load IT with the next display element from current_buffer. Value
6539 is zero if end of buffer reached. IT->stop_charpos is the next
6540 position at which to stop and check for text properties or buffer
6544 next_element_from_buffer (struct it
*it
)
6548 xassert (IT_CHARPOS (*it
) >= BEGV
);
6550 /* With bidi reordering, the character to display might not be the
6551 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6552 we were reseat()ed to a new buffer position, which is potentially
6553 a different paragraph. */
6554 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6556 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6557 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6558 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6560 /* Nothing to do, but reset the FIRST_ELT flag, like
6561 bidi_paragraph_init does, because we are not going to
6563 it
->bidi_it
.first_elt
= 0;
6565 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6566 /* FIXME: Should support all Unicode line separators. */
6567 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6568 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6570 /* If we are at the beginning of a line, we can produce the
6571 next element right away. */
6572 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6573 bidi_move_to_visually_next (&it
->bidi_it
);
6577 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6579 /* We need to prime the bidi iterator starting at the line's
6580 beginning, before we will be able to produce the next
6582 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6583 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6584 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6585 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6586 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6589 /* Now return to buffer position where we were asked to
6590 get the next display element, and produce that. */
6591 bidi_move_to_visually_next (&it
->bidi_it
);
6593 while (it
->bidi_it
.bytepos
!= orig_bytepos
6594 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6597 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6598 /* Adjust IT's position information to where we ended up. */
6599 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6600 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6601 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6603 EMACS_INT stop
= it
->end_charpos
;
6604 if (it
->bidi_it
.scan_dir
< 0)
6606 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6607 IT_BYTEPOS (*it
), stop
, Qnil
);
6611 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6613 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6615 int overlay_strings_follow_p
;
6617 /* End of the game, except when overlay strings follow that
6618 haven't been returned yet. */
6619 if (it
->overlay_strings_at_end_processed_p
)
6620 overlay_strings_follow_p
= 0;
6623 it
->overlay_strings_at_end_processed_p
= 1;
6624 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6627 if (overlay_strings_follow_p
)
6628 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6632 it
->position
= it
->current
.pos
;
6636 else if (!(!it
->bidi_p
6637 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6638 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6640 /* With bidi non-linear iteration, we could find ourselves
6641 far beyond the last computed stop_charpos, with several
6642 other stop positions in between that we missed. Scan
6643 them all now, in buffer's logical order, until we find
6644 and handle the last stop_charpos that precedes our
6645 current position. */
6646 handle_stop_backwards (it
, it
->stop_charpos
);
6647 return GET_NEXT_DISPLAY_ELEMENT (it
);
6653 /* Take note of the stop position we just moved across,
6654 for when we will move back across it. */
6655 it
->prev_stop
= it
->stop_charpos
;
6656 /* If we are at base paragraph embedding level, take
6657 note of the last stop position seen at this
6659 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6660 it
->base_level_stop
= it
->stop_charpos
;
6663 return GET_NEXT_DISPLAY_ELEMENT (it
);
6667 /* We can sometimes back up for reasons that have nothing
6668 to do with bidi reordering. E.g., compositions. The
6669 code below is only needed when we are above the base
6670 embedding level, so test for that explicitly. */
6671 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6672 && IT_CHARPOS (*it
) < it
->prev_stop
)
6674 if (it
->base_level_stop
<= 0)
6675 it
->base_level_stop
= BEGV
;
6676 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6678 handle_stop_backwards (it
, it
->base_level_stop
);
6679 return GET_NEXT_DISPLAY_ELEMENT (it
);
6683 /* No face changes, overlays etc. in sight, so just return a
6684 character from current_buffer. */
6688 /* Maybe run the redisplay end trigger hook. Performance note:
6689 This doesn't seem to cost measurable time. */
6690 if (it
->redisplay_end_trigger_charpos
6692 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6693 run_redisplay_end_trigger_hook (it
);
6695 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6696 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6698 && next_element_from_composition (it
))
6703 /* Get the next character, maybe multibyte. */
6704 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6705 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6706 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6708 it
->c
= *p
, it
->len
= 1;
6710 /* Record what we have and where it came from. */
6711 it
->what
= IT_CHARACTER
;
6712 it
->object
= it
->w
->buffer
;
6713 it
->position
= it
->current
.pos
;
6715 /* Normally we return the character found above, except when we
6716 really want to return an ellipsis for selective display. */
6721 /* A value of selective > 0 means hide lines indented more
6722 than that number of columns. */
6723 if (it
->selective
> 0
6724 && IT_CHARPOS (*it
) + 1 < ZV
6725 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6726 IT_BYTEPOS (*it
) + 1,
6727 (double) it
->selective
)) /* iftc */
6729 success_p
= next_element_from_ellipsis (it
);
6730 it
->dpvec_char_len
= -1;
6733 else if (it
->c
== '\r' && it
->selective
== -1)
6735 /* A value of selective == -1 means that everything from the
6736 CR to the end of the line is invisible, with maybe an
6737 ellipsis displayed for it. */
6738 success_p
= next_element_from_ellipsis (it
);
6739 it
->dpvec_char_len
= -1;
6744 /* Value is zero if end of buffer reached. */
6745 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6750 /* Run the redisplay end trigger hook for IT. */
6753 run_redisplay_end_trigger_hook (struct it
*it
)
6755 Lisp_Object args
[3];
6757 /* IT->glyph_row should be non-null, i.e. we should be actually
6758 displaying something, or otherwise we should not run the hook. */
6759 xassert (it
->glyph_row
);
6761 /* Set up hook arguments. */
6762 args
[0] = Qredisplay_end_trigger_functions
;
6763 args
[1] = it
->window
;
6764 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6765 it
->redisplay_end_trigger_charpos
= 0;
6767 /* Since we are *trying* to run these functions, don't try to run
6768 them again, even if they get an error. */
6769 it
->w
->redisplay_end_trigger
= Qnil
;
6770 Frun_hook_with_args (3, args
);
6772 /* Notice if it changed the face of the character we are on. */
6773 handle_face_prop (it
);
6777 /* Deliver a composition display element. Unlike the other
6778 next_element_from_XXX, this function is not registered in the array
6779 get_next_element[]. It is called from next_element_from_buffer and
6780 next_element_from_string when necessary. */
6783 next_element_from_composition (struct it
*it
)
6785 it
->what
= IT_COMPOSITION
;
6786 it
->len
= it
->cmp_it
.nbytes
;
6787 if (STRINGP (it
->string
))
6791 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6792 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6795 it
->position
= it
->current
.string_pos
;
6796 it
->object
= it
->string
;
6797 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6798 IT_STRING_BYTEPOS (*it
), it
->string
);
6804 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6805 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6808 if (it
->bidi_it
.new_paragraph
)
6809 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6810 /* Resync the bidi iterator with IT's new position.
6811 FIXME: this doesn't support bidirectional text. */
6812 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6813 bidi_move_to_visually_next (&it
->bidi_it
);
6817 it
->position
= it
->current
.pos
;
6818 it
->object
= it
->w
->buffer
;
6819 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6820 IT_BYTEPOS (*it
), Qnil
);
6827 /***********************************************************************
6828 Moving an iterator without producing glyphs
6829 ***********************************************************************/
6831 /* Check if iterator is at a position corresponding to a valid buffer
6832 position after some move_it_ call. */
6834 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6835 ((it)->method == GET_FROM_STRING \
6836 ? IT_STRING_CHARPOS (*it) == 0 \
6840 /* Move iterator IT to a specified buffer or X position within one
6841 line on the display without producing glyphs.
6843 OP should be a bit mask including some or all of these bits:
6844 MOVE_TO_X: Stop upon reaching x-position TO_X.
6845 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6846 Regardless of OP's value, stop upon reaching the end of the display line.
6848 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6849 This means, in particular, that TO_X includes window's horizontal
6852 The return value has several possible values that
6853 say what condition caused the scan to stop:
6855 MOVE_POS_MATCH_OR_ZV
6856 - when TO_POS or ZV was reached.
6859 -when TO_X was reached before TO_POS or ZV were reached.
6862 - when we reached the end of the display area and the line must
6866 - when we reached the end of the display area and the line is
6870 - when we stopped at a line end, i.e. a newline or a CR and selective
6873 static enum move_it_result
6874 move_it_in_display_line_to (struct it
*it
,
6875 EMACS_INT to_charpos
, int to_x
,
6876 enum move_operation_enum op
)
6878 enum move_it_result result
= MOVE_UNDEFINED
;
6879 struct glyph_row
*saved_glyph_row
;
6880 struct it wrap_it
, atpos_it
, atx_it
;
6882 enum it_method prev_method
= it
->method
;
6883 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6885 /* Don't produce glyphs in produce_glyphs. */
6886 saved_glyph_row
= it
->glyph_row
;
6887 it
->glyph_row
= NULL
;
6889 /* Use wrap_it to save a copy of IT wherever a word wrap could
6890 occur. Use atpos_it to save a copy of IT at the desired buffer
6891 position, if found, so that we can scan ahead and check if the
6892 word later overshoots the window edge. Use atx_it similarly, for
6898 #define BUFFER_POS_REACHED_P() \
6899 ((op & MOVE_TO_POS) != 0 \
6900 && BUFFERP (it->object) \
6901 && (IT_CHARPOS (*it) == to_charpos \
6902 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6903 && (it->method == GET_FROM_BUFFER \
6904 || (it->method == GET_FROM_DISPLAY_VECTOR \
6905 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6907 /* If there's a line-/wrap-prefix, handle it. */
6908 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6909 && it
->current_y
< it
->last_visible_y
)
6910 handle_line_prefix (it
);
6914 int x
, i
, ascent
= 0, descent
= 0;
6916 /* Utility macro to reset an iterator with x, ascent, and descent. */
6917 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6918 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6919 (IT)->max_descent = descent)
6921 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6923 if ((op
& MOVE_TO_POS
) != 0
6924 && BUFFERP (it
->object
)
6925 && it
->method
== GET_FROM_BUFFER
6926 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6928 && (prev_method
== GET_FROM_IMAGE
6929 || prev_method
== GET_FROM_STRETCH
)
6930 /* Passed TO_CHARPOS from left to right. */
6931 && ((prev_pos
< to_charpos
6932 && IT_CHARPOS (*it
) > to_charpos
)
6933 /* Passed TO_CHARPOS from right to left. */
6934 || (prev_pos
> to_charpos
6935 && IT_CHARPOS (*it
) < to_charpos
)))))
6937 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6939 result
= MOVE_POS_MATCH_OR_ZV
;
6942 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6943 /* If wrap_it is valid, the current position might be in a
6944 word that is wrapped. So, save the iterator in
6945 atpos_it and continue to see if wrapping happens. */
6949 prev_method
= it
->method
;
6950 if (it
->method
== GET_FROM_BUFFER
)
6951 prev_pos
= IT_CHARPOS (*it
);
6952 /* Stop when ZV reached.
6953 We used to stop here when TO_CHARPOS reached as well, but that is
6954 too soon if this glyph does not fit on this line. So we handle it
6955 explicitly below. */
6956 if (!get_next_display_element (it
))
6958 result
= MOVE_POS_MATCH_OR_ZV
;
6962 if (it
->line_wrap
== TRUNCATE
)
6964 if (BUFFER_POS_REACHED_P ())
6966 result
= MOVE_POS_MATCH_OR_ZV
;
6972 if (it
->line_wrap
== WORD_WRAP
)
6974 if (IT_DISPLAYING_WHITESPACE (it
))
6978 /* We have reached a glyph that follows one or more
6979 whitespace characters. If the position is
6980 already found, we are done. */
6981 if (atpos_it
.sp
>= 0)
6984 result
= MOVE_POS_MATCH_OR_ZV
;
6990 result
= MOVE_X_REACHED
;
6993 /* Otherwise, we can wrap here. */
7000 /* Remember the line height for the current line, in case
7001 the next element doesn't fit on the line. */
7002 ascent
= it
->max_ascent
;
7003 descent
= it
->max_descent
;
7005 /* The call to produce_glyphs will get the metrics of the
7006 display element IT is loaded with. Record the x-position
7007 before this display element, in case it doesn't fit on the
7011 PRODUCE_GLYPHS (it
);
7013 if (it
->area
!= TEXT_AREA
)
7015 set_iterator_to_next (it
, 1);
7019 /* The number of glyphs we get back in IT->nglyphs will normally
7020 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7021 character on a terminal frame, or (iii) a line end. For the
7022 second case, IT->nglyphs - 1 padding glyphs will be present.
7023 (On X frames, there is only one glyph produced for a
7024 composite character.)
7026 The behavior implemented below means, for continuation lines,
7027 that as many spaces of a TAB as fit on the current line are
7028 displayed there. For terminal frames, as many glyphs of a
7029 multi-glyph character are displayed in the current line, too.
7030 This is what the old redisplay code did, and we keep it that
7031 way. Under X, the whole shape of a complex character must
7032 fit on the line or it will be completely displayed in the
7035 Note that both for tabs and padding glyphs, all glyphs have
7039 /* More than one glyph or glyph doesn't fit on line. All
7040 glyphs have the same width. */
7041 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7043 int x_before_this_char
= x
;
7044 int hpos_before_this_char
= it
->hpos
;
7046 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7048 new_x
= x
+ single_glyph_width
;
7050 /* We want to leave anything reaching TO_X to the caller. */
7051 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7053 if (BUFFER_POS_REACHED_P ())
7055 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7056 goto buffer_pos_reached
;
7057 if (atpos_it
.sp
< 0)
7060 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7065 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7068 result
= MOVE_X_REACHED
;
7074 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7079 if (/* Lines are continued. */
7080 it
->line_wrap
!= TRUNCATE
7081 && (/* And glyph doesn't fit on the line. */
7082 new_x
> it
->last_visible_x
7083 /* Or it fits exactly and we're on a window
7085 || (new_x
== it
->last_visible_x
7086 && FRAME_WINDOW_P (it
->f
))))
7088 if (/* IT->hpos == 0 means the very first glyph
7089 doesn't fit on the line, e.g. a wide image. */
7091 || (new_x
== it
->last_visible_x
7092 && FRAME_WINDOW_P (it
->f
)))
7095 it
->current_x
= new_x
;
7097 /* The character's last glyph just barely fits
7099 if (i
== it
->nglyphs
- 1)
7101 /* If this is the destination position,
7102 return a position *before* it in this row,
7103 now that we know it fits in this row. */
7104 if (BUFFER_POS_REACHED_P ())
7106 if (it
->line_wrap
!= WORD_WRAP
7109 it
->hpos
= hpos_before_this_char
;
7110 it
->current_x
= x_before_this_char
;
7111 result
= MOVE_POS_MATCH_OR_ZV
;
7114 if (it
->line_wrap
== WORD_WRAP
7118 atpos_it
.current_x
= x_before_this_char
;
7119 atpos_it
.hpos
= hpos_before_this_char
;
7123 set_iterator_to_next (it
, 1);
7124 /* On graphical terminals, newlines may
7125 "overflow" into the fringe if
7126 overflow-newline-into-fringe is non-nil.
7127 On text-only terminals, newlines may
7128 overflow into the last glyph on the
7130 if (!FRAME_WINDOW_P (it
->f
)
7131 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7133 if (!get_next_display_element (it
))
7135 result
= MOVE_POS_MATCH_OR_ZV
;
7138 if (BUFFER_POS_REACHED_P ())
7140 if (ITERATOR_AT_END_OF_LINE_P (it
))
7141 result
= MOVE_POS_MATCH_OR_ZV
;
7143 result
= MOVE_LINE_CONTINUED
;
7146 if (ITERATOR_AT_END_OF_LINE_P (it
))
7148 result
= MOVE_NEWLINE_OR_CR
;
7155 IT_RESET_X_ASCENT_DESCENT (it
);
7157 if (wrap_it
.sp
>= 0)
7164 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7166 result
= MOVE_LINE_CONTINUED
;
7170 if (BUFFER_POS_REACHED_P ())
7172 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7173 goto buffer_pos_reached
;
7174 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7177 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7181 if (new_x
> it
->first_visible_x
)
7183 /* Glyph is visible. Increment number of glyphs that
7184 would be displayed. */
7189 if (result
!= MOVE_UNDEFINED
)
7192 else if (BUFFER_POS_REACHED_P ())
7195 IT_RESET_X_ASCENT_DESCENT (it
);
7196 result
= MOVE_POS_MATCH_OR_ZV
;
7199 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7201 /* Stop when TO_X specified and reached. This check is
7202 necessary here because of lines consisting of a line end,
7203 only. The line end will not produce any glyphs and we
7204 would never get MOVE_X_REACHED. */
7205 xassert (it
->nglyphs
== 0);
7206 result
= MOVE_X_REACHED
;
7210 /* Is this a line end? If yes, we're done. */
7211 if (ITERATOR_AT_END_OF_LINE_P (it
))
7213 result
= MOVE_NEWLINE_OR_CR
;
7217 if (it
->method
== GET_FROM_BUFFER
)
7218 prev_pos
= IT_CHARPOS (*it
);
7219 /* The current display element has been consumed. Advance
7221 set_iterator_to_next (it
, 1);
7223 /* Stop if lines are truncated and IT's current x-position is
7224 past the right edge of the window now. */
7225 if (it
->line_wrap
== TRUNCATE
7226 && it
->current_x
>= it
->last_visible_x
)
7228 if (!FRAME_WINDOW_P (it
->f
)
7229 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7231 if (!get_next_display_element (it
)
7232 || BUFFER_POS_REACHED_P ())
7234 result
= MOVE_POS_MATCH_OR_ZV
;
7237 if (ITERATOR_AT_END_OF_LINE_P (it
))
7239 result
= MOVE_NEWLINE_OR_CR
;
7243 result
= MOVE_LINE_TRUNCATED
;
7246 #undef IT_RESET_X_ASCENT_DESCENT
7249 #undef BUFFER_POS_REACHED_P
7251 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7252 restore the saved iterator. */
7253 if (atpos_it
.sp
>= 0)
7255 else if (atx_it
.sp
>= 0)
7260 /* Restore the iterator settings altered at the beginning of this
7262 it
->glyph_row
= saved_glyph_row
;
7266 /* For external use. */
7268 move_it_in_display_line (struct it
*it
,
7269 EMACS_INT to_charpos
, int to_x
,
7270 enum move_operation_enum op
)
7272 if (it
->line_wrap
== WORD_WRAP
7273 && (op
& MOVE_TO_X
))
7275 struct it save_it
= *it
;
7276 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7277 /* When word-wrap is on, TO_X may lie past the end
7278 of a wrapped line. Then it->current is the
7279 character on the next line, so backtrack to the
7280 space before the wrap point. */
7281 if (skip
== MOVE_LINE_CONTINUED
)
7283 int prev_x
= max (it
->current_x
- 1, 0);
7285 move_it_in_display_line_to
7286 (it
, -1, prev_x
, MOVE_TO_X
);
7290 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7294 /* Move IT forward until it satisfies one or more of the criteria in
7295 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7297 OP is a bit-mask that specifies where to stop, and in particular,
7298 which of those four position arguments makes a difference. See the
7299 description of enum move_operation_enum.
7301 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7302 screen line, this function will set IT to the next position >
7306 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7308 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7309 int line_height
, line_start_x
= 0, reached
= 0;
7313 if (op
& MOVE_TO_VPOS
)
7315 /* If no TO_CHARPOS and no TO_X specified, stop at the
7316 start of the line TO_VPOS. */
7317 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7319 if (it
->vpos
== to_vpos
)
7325 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7329 /* TO_VPOS >= 0 means stop at TO_X in the line at
7330 TO_VPOS, or at TO_POS, whichever comes first. */
7331 if (it
->vpos
== to_vpos
)
7337 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7339 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7344 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7346 /* We have reached TO_X but not in the line we want. */
7347 skip
= move_it_in_display_line_to (it
, to_charpos
,
7349 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7357 else if (op
& MOVE_TO_Y
)
7359 struct it it_backup
;
7361 if (it
->line_wrap
== WORD_WRAP
)
7364 /* TO_Y specified means stop at TO_X in the line containing
7365 TO_Y---or at TO_CHARPOS if this is reached first. The
7366 problem is that we can't really tell whether the line
7367 contains TO_Y before we have completely scanned it, and
7368 this may skip past TO_X. What we do is to first scan to
7371 If TO_X is not specified, use a TO_X of zero. The reason
7372 is to make the outcome of this function more predictable.
7373 If we didn't use TO_X == 0, we would stop at the end of
7374 the line which is probably not what a caller would expect
7376 skip
= move_it_in_display_line_to
7377 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7378 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7380 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7381 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7383 else if (skip
== MOVE_X_REACHED
)
7385 /* If TO_X was reached, we want to know whether TO_Y is
7386 in the line. We know this is the case if the already
7387 scanned glyphs make the line tall enough. Otherwise,
7388 we must check by scanning the rest of the line. */
7389 line_height
= it
->max_ascent
+ it
->max_descent
;
7390 if (to_y
>= it
->current_y
7391 && to_y
< it
->current_y
+ line_height
)
7397 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7398 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7400 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7401 line_height
= it
->max_ascent
+ it
->max_descent
;
7402 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7404 if (to_y
>= it
->current_y
7405 && to_y
< it
->current_y
+ line_height
)
7407 /* If TO_Y is in this line and TO_X was reached
7408 above, we scanned too far. We have to restore
7409 IT's settings to the ones before skipping. */
7416 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7422 /* Check whether TO_Y is in this line. */
7423 line_height
= it
->max_ascent
+ it
->max_descent
;
7424 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7426 if (to_y
>= it
->current_y
7427 && to_y
< it
->current_y
+ line_height
)
7429 /* When word-wrap is on, TO_X may lie past the end
7430 of a wrapped line. Then it->current is the
7431 character on the next line, so backtrack to the
7432 space before the wrap point. */
7433 if (skip
== MOVE_LINE_CONTINUED
7434 && it
->line_wrap
== WORD_WRAP
)
7436 int prev_x
= max (it
->current_x
- 1, 0);
7438 skip
= move_it_in_display_line_to
7439 (it
, -1, prev_x
, MOVE_TO_X
);
7448 else if (BUFFERP (it
->object
)
7449 && (it
->method
== GET_FROM_BUFFER
7450 || it
->method
== GET_FROM_STRETCH
)
7451 && IT_CHARPOS (*it
) >= to_charpos
)
7452 skip
= MOVE_POS_MATCH_OR_ZV
;
7454 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7458 case MOVE_POS_MATCH_OR_ZV
:
7462 case MOVE_NEWLINE_OR_CR
:
7463 set_iterator_to_next (it
, 1);
7464 it
->continuation_lines_width
= 0;
7467 case MOVE_LINE_TRUNCATED
:
7468 it
->continuation_lines_width
= 0;
7469 reseat_at_next_visible_line_start (it
, 0);
7470 if ((op
& MOVE_TO_POS
) != 0
7471 && IT_CHARPOS (*it
) > to_charpos
)
7478 case MOVE_LINE_CONTINUED
:
7479 /* For continued lines ending in a tab, some of the glyphs
7480 associated with the tab are displayed on the current
7481 line. Since it->current_x does not include these glyphs,
7482 we use it->last_visible_x instead. */
7485 it
->continuation_lines_width
+= it
->last_visible_x
;
7486 /* When moving by vpos, ensure that the iterator really
7487 advances to the next line (bug#847, bug#969). Fixme:
7488 do we need to do this in other circumstances? */
7489 if (it
->current_x
!= it
->last_visible_x
7490 && (op
& MOVE_TO_VPOS
)
7491 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7493 line_start_x
= it
->current_x
+ it
->pixel_width
7494 - it
->last_visible_x
;
7495 set_iterator_to_next (it
, 0);
7499 it
->continuation_lines_width
+= it
->current_x
;
7506 /* Reset/increment for the next run. */
7507 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7508 it
->current_x
= line_start_x
;
7511 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7513 last_height
= it
->max_ascent
+ it
->max_descent
;
7514 last_max_ascent
= it
->max_ascent
;
7515 it
->max_ascent
= it
->max_descent
= 0;
7520 /* On text terminals, we may stop at the end of a line in the middle
7521 of a multi-character glyph. If the glyph itself is continued,
7522 i.e. it is actually displayed on the next line, don't treat this
7523 stopping point as valid; move to the next line instead (unless
7524 that brings us offscreen). */
7525 if (!FRAME_WINDOW_P (it
->f
)
7527 && IT_CHARPOS (*it
) == to_charpos
7528 && it
->what
== IT_CHARACTER
7530 && it
->line_wrap
== WINDOW_WRAP
7531 && it
->current_x
== it
->last_visible_x
- 1
7534 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7536 it
->continuation_lines_width
+= it
->current_x
;
7537 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7538 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7540 last_height
= it
->max_ascent
+ it
->max_descent
;
7541 last_max_ascent
= it
->max_ascent
;
7544 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7548 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7550 If DY > 0, move IT backward at least that many pixels. DY = 0
7551 means move IT backward to the preceding line start or BEGV. This
7552 function may move over more than DY pixels if IT->current_y - DY
7553 ends up in the middle of a line; in this case IT->current_y will be
7554 set to the top of the line moved to. */
7557 move_it_vertically_backward (struct it
*it
, int dy
)
7561 EMACS_INT start_pos
;
7566 start_pos
= IT_CHARPOS (*it
);
7568 /* Estimate how many newlines we must move back. */
7569 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7571 /* Set the iterator's position that many lines back. */
7572 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7573 back_to_previous_visible_line_start (it
);
7575 /* Reseat the iterator here. When moving backward, we don't want
7576 reseat to skip forward over invisible text, set up the iterator
7577 to deliver from overlay strings at the new position etc. So,
7578 use reseat_1 here. */
7579 reseat_1 (it
, it
->current
.pos
, 1);
7581 /* We are now surely at a line start. */
7582 it
->current_x
= it
->hpos
= 0;
7583 it
->continuation_lines_width
= 0;
7585 /* Move forward and see what y-distance we moved. First move to the
7586 start of the next line so that we get its height. We need this
7587 height to be able to tell whether we reached the specified
7590 it2
.max_ascent
= it2
.max_descent
= 0;
7593 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7594 MOVE_TO_POS
| MOVE_TO_VPOS
);
7596 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7597 xassert (IT_CHARPOS (*it
) >= BEGV
);
7600 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7601 xassert (IT_CHARPOS (*it
) >= BEGV
);
7602 /* H is the actual vertical distance from the position in *IT
7603 and the starting position. */
7604 h
= it2
.current_y
- it
->current_y
;
7605 /* NLINES is the distance in number of lines. */
7606 nlines
= it2
.vpos
- it
->vpos
;
7608 /* Correct IT's y and vpos position
7609 so that they are relative to the starting point. */
7615 /* DY == 0 means move to the start of the screen line. The
7616 value of nlines is > 0 if continuation lines were involved. */
7618 move_it_by_lines (it
, nlines
, 1);
7622 /* The y-position we try to reach, relative to *IT.
7623 Note that H has been subtracted in front of the if-statement. */
7624 int target_y
= it
->current_y
+ h
- dy
;
7625 int y0
= it3
.current_y
;
7626 int y1
= line_bottom_y (&it3
);
7627 int line_height
= y1
- y0
;
7629 /* If we did not reach target_y, try to move further backward if
7630 we can. If we moved too far backward, try to move forward. */
7631 if (target_y
< it
->current_y
7632 /* This is heuristic. In a window that's 3 lines high, with
7633 a line height of 13 pixels each, recentering with point
7634 on the bottom line will try to move -39/2 = 19 pixels
7635 backward. Try to avoid moving into the first line. */
7636 && (it
->current_y
- target_y
7637 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7638 && IT_CHARPOS (*it
) > BEGV
)
7640 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7641 target_y
- it
->current_y
));
7642 dy
= it
->current_y
- target_y
;
7643 goto move_further_back
;
7645 else if (target_y
>= it
->current_y
+ line_height
7646 && IT_CHARPOS (*it
) < ZV
)
7648 /* Should move forward by at least one line, maybe more.
7650 Note: Calling move_it_by_lines can be expensive on
7651 terminal frames, where compute_motion is used (via
7652 vmotion) to do the job, when there are very long lines
7653 and truncate-lines is nil. That's the reason for
7654 treating terminal frames specially here. */
7656 if (!FRAME_WINDOW_P (it
->f
))
7657 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7662 move_it_by_lines (it
, 1, 1);
7664 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7671 /* Move IT by a specified amount of pixel lines DY. DY negative means
7672 move backwards. DY = 0 means move to start of screen line. At the
7673 end, IT will be on the start of a screen line. */
7676 move_it_vertically (struct it
*it
, int dy
)
7679 move_it_vertically_backward (it
, -dy
);
7682 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7683 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7684 MOVE_TO_POS
| MOVE_TO_Y
);
7685 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7687 /* If buffer ends in ZV without a newline, move to the start of
7688 the line to satisfy the post-condition. */
7689 if (IT_CHARPOS (*it
) == ZV
7691 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7692 move_it_by_lines (it
, 0, 0);
7697 /* Move iterator IT past the end of the text line it is in. */
7700 move_it_past_eol (struct it
*it
)
7702 enum move_it_result rc
;
7704 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7705 if (rc
== MOVE_NEWLINE_OR_CR
)
7706 set_iterator_to_next (it
, 0);
7710 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7711 negative means move up. DVPOS == 0 means move to the start of the
7712 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7713 NEED_Y_P is zero, IT->current_y will be left unchanged.
7715 Further optimization ideas: If we would know that IT->f doesn't use
7716 a face with proportional font, we could be faster for
7717 truncate-lines nil. */
7720 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7723 /* The commented-out optimization uses vmotion on terminals. This
7724 gives bad results, because elements like it->what, on which
7725 callers such as pos_visible_p rely, aren't updated. */
7726 /* struct position pos;
7727 if (!FRAME_WINDOW_P (it->f))
7729 struct text_pos textpos;
7731 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7732 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7733 reseat (it, textpos, 1);
7734 it->vpos += pos.vpos;
7735 it->current_y += pos.vpos;
7741 /* DVPOS == 0 means move to the start of the screen line. */
7742 move_it_vertically_backward (it
, 0);
7743 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7744 /* Let next call to line_bottom_y calculate real line height */
7749 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7750 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7751 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7756 EMACS_INT start_charpos
, i
;
7758 /* Start at the beginning of the screen line containing IT's
7759 position. This may actually move vertically backwards,
7760 in case of overlays, so adjust dvpos accordingly. */
7762 move_it_vertically_backward (it
, 0);
7765 /* Go back -DVPOS visible lines and reseat the iterator there. */
7766 start_charpos
= IT_CHARPOS (*it
);
7767 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7768 back_to_previous_visible_line_start (it
);
7769 reseat (it
, it
->current
.pos
, 1);
7771 /* Move further back if we end up in a string or an image. */
7772 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7774 /* First try to move to start of display line. */
7776 move_it_vertically_backward (it
, 0);
7778 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7780 /* If start of line is still in string or image,
7781 move further back. */
7782 back_to_previous_visible_line_start (it
);
7783 reseat (it
, it
->current
.pos
, 1);
7787 it
->current_x
= it
->hpos
= 0;
7789 /* Above call may have moved too far if continuation lines
7790 are involved. Scan forward and see if it did. */
7792 it2
.vpos
= it2
.current_y
= 0;
7793 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7794 it
->vpos
-= it2
.vpos
;
7795 it
->current_y
-= it2
.current_y
;
7796 it
->current_x
= it
->hpos
= 0;
7798 /* If we moved too far back, move IT some lines forward. */
7799 if (it2
.vpos
> -dvpos
)
7801 int delta
= it2
.vpos
+ dvpos
;
7803 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7804 /* Move back again if we got too far ahead. */
7805 if (IT_CHARPOS (*it
) >= start_charpos
)
7811 /* Return 1 if IT points into the middle of a display vector. */
7814 in_display_vector_p (struct it
*it
)
7816 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7817 && it
->current
.dpvec_index
> 0
7818 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7822 /***********************************************************************
7824 ***********************************************************************/
7827 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7831 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7833 Lisp_Object args
[3];
7834 Lisp_Object msg
, fmt
;
7837 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7840 /* Do nothing if called asynchronously. Inserting text into
7841 a buffer may call after-change-functions and alike and
7842 that would means running Lisp asynchronously. */
7843 if (handling_signal
)
7847 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7849 args
[0] = fmt
= build_string (format
);
7852 msg
= Fformat (3, args
);
7854 len
= SBYTES (msg
) + 1;
7855 SAFE_ALLOCA (buffer
, char *, len
);
7856 memcpy (buffer
, SDATA (msg
), len
);
7858 message_dolog (buffer
, len
- 1, 1, 0);
7865 /* Output a newline in the *Messages* buffer if "needs" one. */
7868 message_log_maybe_newline (void)
7870 if (message_log_need_newline
)
7871 message_dolog ("", 0, 1, 0);
7875 /* Add a string M of length NBYTES to the message log, optionally
7876 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7877 nonzero, means interpret the contents of M as multibyte. This
7878 function calls low-level routines in order to bypass text property
7879 hooks, etc. which might not be safe to run.
7881 This may GC (insert may run before/after change hooks),
7882 so the buffer M must NOT point to a Lisp string. */
7885 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7887 const unsigned char *msg
= (const unsigned char *) m
;
7889 if (!NILP (Vmemory_full
))
7892 if (!NILP (Vmessage_log_max
))
7894 struct buffer
*oldbuf
;
7895 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7896 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7897 EMACS_INT point_at_end
= 0;
7898 EMACS_INT zv_at_end
= 0;
7899 Lisp_Object old_deactivate_mark
, tem
;
7900 struct gcpro gcpro1
;
7902 old_deactivate_mark
= Vdeactivate_mark
;
7903 oldbuf
= current_buffer
;
7904 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7905 current_buffer
->undo_list
= Qt
;
7907 oldpoint
= message_dolog_marker1
;
7908 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7909 oldbegv
= message_dolog_marker2
;
7910 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7911 oldzv
= message_dolog_marker3
;
7912 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7913 GCPRO1 (old_deactivate_mark
);
7921 BEGV_BYTE
= BEG_BYTE
;
7924 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7926 /* Insert the string--maybe converting multibyte to single byte
7927 or vice versa, so that all the text fits the buffer. */
7929 && NILP (current_buffer
->enable_multibyte_characters
))
7935 /* Convert a multibyte string to single-byte
7936 for the *Message* buffer. */
7937 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7939 c
= string_char_and_length (msg
+ i
, &char_bytes
);
7940 work
[0] = (ASCII_CHAR_P (c
)
7942 : multibyte_char_to_unibyte (c
, Qnil
));
7943 insert_1_both (work
, 1, 1, 1, 0, 0);
7946 else if (! multibyte
7947 && ! NILP (current_buffer
->enable_multibyte_characters
))
7951 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7952 /* Convert a single-byte string to multibyte
7953 for the *Message* buffer. */
7954 for (i
= 0; i
< nbytes
; i
++)
7957 MAKE_CHAR_MULTIBYTE (c
);
7958 char_bytes
= CHAR_STRING (c
, str
);
7959 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
7963 insert_1 (m
, nbytes
, 1, 0, 0);
7967 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
7969 insert_1 ("\n", 1, 1, 0, 0);
7971 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7973 this_bol_byte
= PT_BYTE
;
7975 /* See if this line duplicates the previous one.
7976 If so, combine duplicates. */
7979 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7981 prev_bol_byte
= PT_BYTE
;
7983 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7984 this_bol
, this_bol_byte
);
7987 del_range_both (prev_bol
, prev_bol_byte
,
7988 this_bol
, this_bol_byte
, 0);
7994 /* If you change this format, don't forget to also
7995 change message_log_check_duplicate. */
7996 sprintf (dupstr
, " [%d times]", dup
);
7997 duplen
= strlen (dupstr
);
7998 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7999 insert_1 (dupstr
, duplen
, 1, 0, 1);
8004 /* If we have more than the desired maximum number of lines
8005 in the *Messages* buffer now, delete the oldest ones.
8006 This is safe because we don't have undo in this buffer. */
8008 if (NATNUMP (Vmessage_log_max
))
8010 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8011 -XFASTINT (Vmessage_log_max
) - 1, 0);
8012 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8015 BEGV
= XMARKER (oldbegv
)->charpos
;
8016 BEGV_BYTE
= marker_byte_position (oldbegv
);
8025 ZV
= XMARKER (oldzv
)->charpos
;
8026 ZV_BYTE
= marker_byte_position (oldzv
);
8030 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8032 /* We can't do Fgoto_char (oldpoint) because it will run some
8034 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8035 XMARKER (oldpoint
)->bytepos
);
8038 unchain_marker (XMARKER (oldpoint
));
8039 unchain_marker (XMARKER (oldbegv
));
8040 unchain_marker (XMARKER (oldzv
));
8042 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8043 set_buffer_internal (oldbuf
);
8045 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8046 message_log_need_newline
= !nlflag
;
8047 Vdeactivate_mark
= old_deactivate_mark
;
8052 /* We are at the end of the buffer after just having inserted a newline.
8053 (Note: We depend on the fact we won't be crossing the gap.)
8054 Check to see if the most recent message looks a lot like the previous one.
8055 Return 0 if different, 1 if the new one should just replace it, or a
8056 value N > 1 if we should also append " [N times]". */
8059 message_log_check_duplicate (EMACS_INT prev_bol
, EMACS_INT prev_bol_byte
,
8060 EMACS_INT this_bol
, EMACS_INT this_bol_byte
)
8063 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8065 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8066 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8068 for (i
= 0; i
< len
; i
++)
8070 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8078 if (*p1
++ == ' ' && *p1
++ == '[')
8081 while (*p1
>= '0' && *p1
<= '9')
8082 n
= n
* 10 + *p1
++ - '0';
8083 if (strncmp ((char *) p1
, " times]\n", 8) == 0)
8090 /* Display an echo area message M with a specified length of NBYTES
8091 bytes. The string may include null characters. If M is 0, clear
8092 out any existing message, and let the mini-buffer text show
8095 This may GC, so the buffer M must NOT point to a Lisp string. */
8098 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8100 /* First flush out any partial line written with print. */
8101 message_log_maybe_newline ();
8103 message_dolog (m
, nbytes
, 1, multibyte
);
8104 message2_nolog (m
, nbytes
, multibyte
);
8108 /* The non-logging counterpart of message2. */
8111 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8113 struct frame
*sf
= SELECTED_FRAME ();
8114 message_enable_multibyte
= multibyte
;
8116 if (FRAME_INITIAL_P (sf
))
8118 if (noninteractive_need_newline
)
8119 putc ('\n', stderr
);
8120 noninteractive_need_newline
= 0;
8122 fwrite (m
, nbytes
, 1, stderr
);
8123 if (cursor_in_echo_area
== 0)
8124 fprintf (stderr
, "\n");
8127 /* A null message buffer means that the frame hasn't really been
8128 initialized yet. Error messages get reported properly by
8129 cmd_error, so this must be just an informative message; toss it. */
8130 else if (INTERACTIVE
8131 && sf
->glyphs_initialized_p
8132 && FRAME_MESSAGE_BUF (sf
))
8134 Lisp_Object mini_window
;
8137 /* Get the frame containing the mini-buffer
8138 that the selected frame is using. */
8139 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8140 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8142 FRAME_SAMPLE_VISIBILITY (f
);
8143 if (FRAME_VISIBLE_P (sf
)
8144 && ! FRAME_VISIBLE_P (f
))
8145 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8149 set_message (m
, Qnil
, nbytes
, multibyte
);
8150 if (minibuffer_auto_raise
)
8151 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8154 clear_message (1, 1);
8156 do_pending_window_change (0);
8157 echo_area_display (1);
8158 do_pending_window_change (0);
8159 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8160 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8165 /* Display an echo area message M with a specified length of NBYTES
8166 bytes. The string may include null characters. If M is not a
8167 string, clear out any existing message, and let the mini-buffer
8170 This function cancels echoing. */
8173 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8175 struct gcpro gcpro1
;
8178 clear_message (1,1);
8181 /* First flush out any partial line written with print. */
8182 message_log_maybe_newline ();
8188 SAFE_ALLOCA (buffer
, char *, nbytes
);
8189 memcpy (buffer
, SDATA (m
), nbytes
);
8190 message_dolog (buffer
, nbytes
, 1, multibyte
);
8193 message3_nolog (m
, nbytes
, multibyte
);
8199 /* The non-logging version of message3.
8200 This does not cancel echoing, because it is used for echoing.
8201 Perhaps we need to make a separate function for echoing
8202 and make this cancel echoing. */
8205 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8207 struct frame
*sf
= SELECTED_FRAME ();
8208 message_enable_multibyte
= multibyte
;
8210 if (FRAME_INITIAL_P (sf
))
8212 if (noninteractive_need_newline
)
8213 putc ('\n', stderr
);
8214 noninteractive_need_newline
= 0;
8216 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8217 if (cursor_in_echo_area
== 0)
8218 fprintf (stderr
, "\n");
8221 /* A null message buffer means that the frame hasn't really been
8222 initialized yet. Error messages get reported properly by
8223 cmd_error, so this must be just an informative message; toss it. */
8224 else if (INTERACTIVE
8225 && sf
->glyphs_initialized_p
8226 && FRAME_MESSAGE_BUF (sf
))
8228 Lisp_Object mini_window
;
8232 /* Get the frame containing the mini-buffer
8233 that the selected frame is using. */
8234 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8235 frame
= XWINDOW (mini_window
)->frame
;
8238 FRAME_SAMPLE_VISIBILITY (f
);
8239 if (FRAME_VISIBLE_P (sf
)
8240 && !FRAME_VISIBLE_P (f
))
8241 Fmake_frame_visible (frame
);
8243 if (STRINGP (m
) && SCHARS (m
) > 0)
8245 set_message (NULL
, m
, nbytes
, multibyte
);
8246 if (minibuffer_auto_raise
)
8247 Fraise_frame (frame
);
8248 /* Assume we are not echoing.
8249 (If we are, echo_now will override this.) */
8250 echo_message_buffer
= Qnil
;
8253 clear_message (1, 1);
8255 do_pending_window_change (0);
8256 echo_area_display (1);
8257 do_pending_window_change (0);
8258 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8259 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8264 /* Display a null-terminated echo area message M. If M is 0, clear
8265 out any existing message, and let the mini-buffer text show through.
8267 The buffer M must continue to exist until after the echo area gets
8268 cleared or some other message gets displayed there. Do not pass
8269 text that is stored in a Lisp string. Do not pass text in a buffer
8270 that was alloca'd. */
8273 message1 (const char *m
)
8275 message2 (m
, (m
? strlen (m
) : 0), 0);
8279 /* The non-logging counterpart of message1. */
8282 message1_nolog (const char *m
)
8284 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8287 /* Display a message M which contains a single %s
8288 which gets replaced with STRING. */
8291 message_with_string (const char *m
, Lisp_Object string
, int log
)
8293 CHECK_STRING (string
);
8299 if (noninteractive_need_newline
)
8300 putc ('\n', stderr
);
8301 noninteractive_need_newline
= 0;
8302 fprintf (stderr
, m
, SDATA (string
));
8303 if (!cursor_in_echo_area
)
8304 fprintf (stderr
, "\n");
8308 else if (INTERACTIVE
)
8310 /* The frame whose minibuffer we're going to display the message on.
8311 It may be larger than the selected frame, so we need
8312 to use its buffer, not the selected frame's buffer. */
8313 Lisp_Object mini_window
;
8314 struct frame
*f
, *sf
= SELECTED_FRAME ();
8316 /* Get the frame containing the minibuffer
8317 that the selected frame is using. */
8318 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8319 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8321 /* A null message buffer means that the frame hasn't really been
8322 initialized yet. Error messages get reported properly by
8323 cmd_error, so this must be just an informative message; toss it. */
8324 if (FRAME_MESSAGE_BUF (f
))
8326 Lisp_Object args
[2], message
;
8327 struct gcpro gcpro1
, gcpro2
;
8329 args
[0] = build_string (m
);
8330 args
[1] = message
= string
;
8331 GCPRO2 (args
[0], message
);
8334 message
= Fformat (2, args
);
8337 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8339 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8343 /* Print should start at the beginning of the message
8344 buffer next time. */
8345 message_buf_print
= 0;
8351 /* Dump an informative message to the minibuf. If M is 0, clear out
8352 any existing message, and let the mini-buffer text show through. */
8355 vmessage (const char *m
, va_list ap
)
8361 if (noninteractive_need_newline
)
8362 putc ('\n', stderr
);
8363 noninteractive_need_newline
= 0;
8364 vfprintf (stderr
, m
, ap
);
8365 if (cursor_in_echo_area
== 0)
8366 fprintf (stderr
, "\n");
8370 else if (INTERACTIVE
)
8372 /* The frame whose mini-buffer we're going to display the message
8373 on. It may be larger than the selected frame, so we need to
8374 use its buffer, not the selected frame's buffer. */
8375 Lisp_Object mini_window
;
8376 struct frame
*f
, *sf
= SELECTED_FRAME ();
8378 /* Get the frame containing the mini-buffer
8379 that the selected frame is using. */
8380 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8381 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8383 /* A null message buffer means that the frame hasn't really been
8384 initialized yet. Error messages get reported properly by
8385 cmd_error, so this must be just an informative message; toss
8387 if (FRAME_MESSAGE_BUF (f
))
8393 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8394 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8396 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8401 /* Print should start at the beginning of the message
8402 buffer next time. */
8403 message_buf_print
= 0;
8409 message (const char *m
, ...)
8418 /* The non-logging version of message. */
8421 message_nolog (const char *m
, ...)
8423 Lisp_Object old_log_max
;
8426 old_log_max
= Vmessage_log_max
;
8427 Vmessage_log_max
= Qnil
;
8429 Vmessage_log_max
= old_log_max
;
8434 /* Display the current message in the current mini-buffer. This is
8435 only called from error handlers in process.c, and is not time
8439 update_echo_area (void)
8441 if (!NILP (echo_area_buffer
[0]))
8444 string
= Fcurrent_message ();
8445 message3 (string
, SBYTES (string
),
8446 !NILP (current_buffer
->enable_multibyte_characters
));
8451 /* Make sure echo area buffers in `echo_buffers' are live.
8452 If they aren't, make new ones. */
8455 ensure_echo_area_buffers (void)
8459 for (i
= 0; i
< 2; ++i
)
8460 if (!BUFFERP (echo_buffer
[i
])
8461 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8464 Lisp_Object old_buffer
;
8467 old_buffer
= echo_buffer
[i
];
8468 sprintf (name
, " *Echo Area %d*", i
);
8469 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8470 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8471 /* to force word wrap in echo area -
8472 it was decided to postpone this*/
8473 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8475 for (j
= 0; j
< 2; ++j
)
8476 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8477 echo_area_buffer
[j
] = echo_buffer
[i
];
8482 /* Call FN with args A1..A4 with either the current or last displayed
8483 echo_area_buffer as current buffer.
8485 WHICH zero means use the current message buffer
8486 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8487 from echo_buffer[] and clear it.
8489 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8490 suitable buffer from echo_buffer[] and clear it.
8492 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8493 that the current message becomes the last displayed one, make
8494 choose a suitable buffer for echo_area_buffer[0], and clear it.
8496 Value is what FN returns. */
8499 with_echo_area_buffer (struct window
*w
, int which
,
8500 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8501 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8504 int this_one
, the_other
, clear_buffer_p
, rc
;
8505 int count
= SPECPDL_INDEX ();
8507 /* If buffers aren't live, make new ones. */
8508 ensure_echo_area_buffers ();
8513 this_one
= 0, the_other
= 1;
8515 this_one
= 1, the_other
= 0;
8518 this_one
= 0, the_other
= 1;
8521 /* We need a fresh one in case the current echo buffer equals
8522 the one containing the last displayed echo area message. */
8523 if (!NILP (echo_area_buffer
[this_one
])
8524 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8525 echo_area_buffer
[this_one
] = Qnil
;
8528 /* Choose a suitable buffer from echo_buffer[] is we don't
8530 if (NILP (echo_area_buffer
[this_one
]))
8532 echo_area_buffer
[this_one
]
8533 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8534 ? echo_buffer
[the_other
]
8535 : echo_buffer
[this_one
]);
8539 buffer
= echo_area_buffer
[this_one
];
8541 /* Don't get confused by reusing the buffer used for echoing
8542 for a different purpose. */
8543 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8546 record_unwind_protect (unwind_with_echo_area_buffer
,
8547 with_echo_area_buffer_unwind_data (w
));
8549 /* Make the echo area buffer current. Note that for display
8550 purposes, it is not necessary that the displayed window's buffer
8551 == current_buffer, except for text property lookup. So, let's
8552 only set that buffer temporarily here without doing a full
8553 Fset_window_buffer. We must also change w->pointm, though,
8554 because otherwise an assertions in unshow_buffer fails, and Emacs
8556 set_buffer_internal_1 (XBUFFER (buffer
));
8560 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8563 current_buffer
->undo_list
= Qt
;
8564 current_buffer
->read_only
= Qnil
;
8565 specbind (Qinhibit_read_only
, Qt
);
8566 specbind (Qinhibit_modification_hooks
, Qt
);
8568 if (clear_buffer_p
&& Z
> BEG
)
8571 xassert (BEGV
>= BEG
);
8572 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8574 rc
= fn (a1
, a2
, a3
, a4
);
8576 xassert (BEGV
>= BEG
);
8577 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8579 unbind_to (count
, Qnil
);
8584 /* Save state that should be preserved around the call to the function
8585 FN called in with_echo_area_buffer. */
8588 with_echo_area_buffer_unwind_data (struct window
*w
)
8591 Lisp_Object vector
, tmp
;
8593 /* Reduce consing by keeping one vector in
8594 Vwith_echo_area_save_vector. */
8595 vector
= Vwith_echo_area_save_vector
;
8596 Vwith_echo_area_save_vector
= Qnil
;
8599 vector
= Fmake_vector (make_number (7), Qnil
);
8601 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8602 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8603 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8607 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8608 ASET (vector
, i
, w
->buffer
); ++i
;
8609 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8610 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8615 for (; i
< end
; ++i
)
8616 ASET (vector
, i
, Qnil
);
8619 xassert (i
== ASIZE (vector
));
8624 /* Restore global state from VECTOR which was created by
8625 with_echo_area_buffer_unwind_data. */
8628 unwind_with_echo_area_buffer (Lisp_Object vector
)
8630 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8631 Vdeactivate_mark
= AREF (vector
, 1);
8632 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8634 if (WINDOWP (AREF (vector
, 3)))
8637 Lisp_Object buffer
, charpos
, bytepos
;
8639 w
= XWINDOW (AREF (vector
, 3));
8640 buffer
= AREF (vector
, 4);
8641 charpos
= AREF (vector
, 5);
8642 bytepos
= AREF (vector
, 6);
8645 set_marker_both (w
->pointm
, buffer
,
8646 XFASTINT (charpos
), XFASTINT (bytepos
));
8649 Vwith_echo_area_save_vector
= vector
;
8654 /* Set up the echo area for use by print functions. MULTIBYTE_P
8655 non-zero means we will print multibyte. */
8658 setup_echo_area_for_printing (int multibyte_p
)
8660 /* If we can't find an echo area any more, exit. */
8661 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8664 ensure_echo_area_buffers ();
8666 if (!message_buf_print
)
8668 /* A message has been output since the last time we printed.
8669 Choose a fresh echo area buffer. */
8670 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8671 echo_area_buffer
[0] = echo_buffer
[1];
8673 echo_area_buffer
[0] = echo_buffer
[0];
8675 /* Switch to that buffer and clear it. */
8676 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8677 current_buffer
->truncate_lines
= Qnil
;
8681 int count
= SPECPDL_INDEX ();
8682 specbind (Qinhibit_read_only
, Qt
);
8683 /* Note that undo recording is always disabled. */
8685 unbind_to (count
, Qnil
);
8687 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8689 /* Set up the buffer for the multibyteness we need. */
8691 != !NILP (current_buffer
->enable_multibyte_characters
))
8692 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8694 /* Raise the frame containing the echo area. */
8695 if (minibuffer_auto_raise
)
8697 struct frame
*sf
= SELECTED_FRAME ();
8698 Lisp_Object mini_window
;
8699 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8700 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8703 message_log_maybe_newline ();
8704 message_buf_print
= 1;
8708 if (NILP (echo_area_buffer
[0]))
8710 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8711 echo_area_buffer
[0] = echo_buffer
[1];
8713 echo_area_buffer
[0] = echo_buffer
[0];
8716 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8718 /* Someone switched buffers between print requests. */
8719 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8720 current_buffer
->truncate_lines
= Qnil
;
8726 /* Display an echo area message in window W. Value is non-zero if W's
8727 height is changed. If display_last_displayed_message_p is
8728 non-zero, display the message that was last displayed, otherwise
8729 display the current message. */
8732 display_echo_area (struct window
*w
)
8734 int i
, no_message_p
, window_height_changed_p
, count
;
8736 /* Temporarily disable garbage collections while displaying the echo
8737 area. This is done because a GC can print a message itself.
8738 That message would modify the echo area buffer's contents while a
8739 redisplay of the buffer is going on, and seriously confuse
8741 count
= inhibit_garbage_collection ();
8743 /* If there is no message, we must call display_echo_area_1
8744 nevertheless because it resizes the window. But we will have to
8745 reset the echo_area_buffer in question to nil at the end because
8746 with_echo_area_buffer will sets it to an empty buffer. */
8747 i
= display_last_displayed_message_p
? 1 : 0;
8748 no_message_p
= NILP (echo_area_buffer
[i
]);
8750 window_height_changed_p
8751 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8752 display_echo_area_1
,
8753 (EMACS_INT
) w
, Qnil
, 0, 0);
8756 echo_area_buffer
[i
] = Qnil
;
8758 unbind_to (count
, Qnil
);
8759 return window_height_changed_p
;
8763 /* Helper for display_echo_area. Display the current buffer which
8764 contains the current echo area message in window W, a mini-window,
8765 a pointer to which is passed in A1. A2..A4 are currently not used.
8766 Change the height of W so that all of the message is displayed.
8767 Value is non-zero if height of W was changed. */
8770 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8772 struct window
*w
= (struct window
*) a1
;
8774 struct text_pos start
;
8775 int window_height_changed_p
= 0;
8777 /* Do this before displaying, so that we have a large enough glyph
8778 matrix for the display. If we can't get enough space for the
8779 whole text, display the last N lines. That works by setting w->start. */
8780 window_height_changed_p
= resize_mini_window (w
, 0);
8782 /* Use the starting position chosen by resize_mini_window. */
8783 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8786 clear_glyph_matrix (w
->desired_matrix
);
8787 XSETWINDOW (window
, w
);
8788 try_window (window
, start
, 0);
8790 return window_height_changed_p
;
8794 /* Resize the echo area window to exactly the size needed for the
8795 currently displayed message, if there is one. If a mini-buffer
8796 is active, don't shrink it. */
8799 resize_echo_area_exactly (void)
8801 if (BUFFERP (echo_area_buffer
[0])
8802 && WINDOWP (echo_area_window
))
8804 struct window
*w
= XWINDOW (echo_area_window
);
8806 Lisp_Object resize_exactly
;
8808 if (minibuf_level
== 0)
8809 resize_exactly
= Qt
;
8811 resize_exactly
= Qnil
;
8813 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8814 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8817 ++windows_or_buffers_changed
;
8818 ++update_mode_lines
;
8819 redisplay_internal (0);
8825 /* Callback function for with_echo_area_buffer, when used from
8826 resize_echo_area_exactly. A1 contains a pointer to the window to
8827 resize, EXACTLY non-nil means resize the mini-window exactly to the
8828 size of the text displayed. A3 and A4 are not used. Value is what
8829 resize_mini_window returns. */
8832 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8834 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8838 /* Resize mini-window W to fit the size of its contents. EXACT_P
8839 means size the window exactly to the size needed. Otherwise, it's
8840 only enlarged until W's buffer is empty.
8842 Set W->start to the right place to begin display. If the whole
8843 contents fit, start at the beginning. Otherwise, start so as
8844 to make the end of the contents appear. This is particularly
8845 important for y-or-n-p, but seems desirable generally.
8847 Value is non-zero if the window height has been changed. */
8850 resize_mini_window (struct window
*w
, int exact_p
)
8852 struct frame
*f
= XFRAME (w
->frame
);
8853 int window_height_changed_p
= 0;
8855 xassert (MINI_WINDOW_P (w
));
8857 /* By default, start display at the beginning. */
8858 set_marker_both (w
->start
, w
->buffer
,
8859 BUF_BEGV (XBUFFER (w
->buffer
)),
8860 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8862 /* Don't resize windows while redisplaying a window; it would
8863 confuse redisplay functions when the size of the window they are
8864 displaying changes from under them. Such a resizing can happen,
8865 for instance, when which-func prints a long message while
8866 we are running fontification-functions. We're running these
8867 functions with safe_call which binds inhibit-redisplay to t. */
8868 if (!NILP (Vinhibit_redisplay
))
8871 /* Nil means don't try to resize. */
8872 if (NILP (Vresize_mini_windows
)
8873 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8876 if (!FRAME_MINIBUF_ONLY_P (f
))
8879 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8880 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8881 int height
, max_height
;
8882 int unit
= FRAME_LINE_HEIGHT (f
);
8883 struct text_pos start
;
8884 struct buffer
*old_current_buffer
= NULL
;
8886 if (current_buffer
!= XBUFFER (w
->buffer
))
8888 old_current_buffer
= current_buffer
;
8889 set_buffer_internal (XBUFFER (w
->buffer
));
8892 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8894 /* Compute the max. number of lines specified by the user. */
8895 if (FLOATP (Vmax_mini_window_height
))
8896 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8897 else if (INTEGERP (Vmax_mini_window_height
))
8898 max_height
= XINT (Vmax_mini_window_height
);
8900 max_height
= total_height
/ 4;
8902 /* Correct that max. height if it's bogus. */
8903 max_height
= max (1, max_height
);
8904 max_height
= min (total_height
, max_height
);
8906 /* Find out the height of the text in the window. */
8907 if (it
.line_wrap
== TRUNCATE
)
8912 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8913 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8914 height
= it
.current_y
+ last_height
;
8916 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8917 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8918 height
= (height
+ unit
- 1) / unit
;
8921 /* Compute a suitable window start. */
8922 if (height
> max_height
)
8924 height
= max_height
;
8925 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8926 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8927 start
= it
.current
.pos
;
8930 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8931 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8933 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8935 /* Let it grow only, until we display an empty message, in which
8936 case the window shrinks again. */
8937 if (height
> WINDOW_TOTAL_LINES (w
))
8939 int old_height
= WINDOW_TOTAL_LINES (w
);
8940 freeze_window_starts (f
, 1);
8941 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8942 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8944 else if (height
< WINDOW_TOTAL_LINES (w
)
8945 && (exact_p
|| BEGV
== ZV
))
8947 int old_height
= WINDOW_TOTAL_LINES (w
);
8948 freeze_window_starts (f
, 0);
8949 shrink_mini_window (w
);
8950 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8955 /* Always resize to exact size needed. */
8956 if (height
> WINDOW_TOTAL_LINES (w
))
8958 int old_height
= WINDOW_TOTAL_LINES (w
);
8959 freeze_window_starts (f
, 1);
8960 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8961 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8963 else if (height
< WINDOW_TOTAL_LINES (w
))
8965 int old_height
= WINDOW_TOTAL_LINES (w
);
8966 freeze_window_starts (f
, 0);
8967 shrink_mini_window (w
);
8971 freeze_window_starts (f
, 1);
8972 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8975 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8979 if (old_current_buffer
)
8980 set_buffer_internal (old_current_buffer
);
8983 return window_height_changed_p
;
8987 /* Value is the current message, a string, or nil if there is no
8991 current_message (void)
8995 if (!BUFFERP (echo_area_buffer
[0]))
8999 with_echo_area_buffer (0, 0, current_message_1
,
9000 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9002 echo_area_buffer
[0] = Qnil
;
9010 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9012 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9015 *msg
= make_buffer_string (BEG
, Z
, 1);
9022 /* Push the current message on Vmessage_stack for later restauration
9023 by restore_message. Value is non-zero if the current message isn't
9024 empty. This is a relatively infrequent operation, so it's not
9025 worth optimizing. */
9031 msg
= current_message ();
9032 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9033 return STRINGP (msg
);
9037 /* Restore message display from the top of Vmessage_stack. */
9040 restore_message (void)
9044 xassert (CONSP (Vmessage_stack
));
9045 msg
= XCAR (Vmessage_stack
);
9047 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9049 message3_nolog (msg
, 0, 0);
9053 /* Handler for record_unwind_protect calling pop_message. */
9056 pop_message_unwind (Lisp_Object dummy
)
9062 /* Pop the top-most entry off Vmessage_stack. */
9067 xassert (CONSP (Vmessage_stack
));
9068 Vmessage_stack
= XCDR (Vmessage_stack
);
9072 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9073 exits. If the stack is not empty, we have a missing pop_message
9077 check_message_stack (void)
9079 if (!NILP (Vmessage_stack
))
9084 /* Truncate to NCHARS what will be displayed in the echo area the next
9085 time we display it---but don't redisplay it now. */
9088 truncate_echo_area (EMACS_INT nchars
)
9091 echo_area_buffer
[0] = Qnil
;
9092 /* A null message buffer means that the frame hasn't really been
9093 initialized yet. Error messages get reported properly by
9094 cmd_error, so this must be just an informative message; toss it. */
9095 else if (!noninteractive
9097 && !NILP (echo_area_buffer
[0]))
9099 struct frame
*sf
= SELECTED_FRAME ();
9100 if (FRAME_MESSAGE_BUF (sf
))
9101 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9106 /* Helper function for truncate_echo_area. Truncate the current
9107 message to at most NCHARS characters. */
9110 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9112 if (BEG
+ nchars
< Z
)
9113 del_range (BEG
+ nchars
, Z
);
9115 echo_area_buffer
[0] = Qnil
;
9120 /* Set the current message to a substring of S or STRING.
9122 If STRING is a Lisp string, set the message to the first NBYTES
9123 bytes from STRING. NBYTES zero means use the whole string. If
9124 STRING is multibyte, the message will be displayed multibyte.
9126 If S is not null, set the message to the first LEN bytes of S. LEN
9127 zero means use the whole string. MULTIBYTE_P non-zero means S is
9128 multibyte. Display the message multibyte in that case.
9130 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9131 to t before calling set_message_1 (which calls insert).
9135 set_message (const char *s
, Lisp_Object string
,
9136 EMACS_INT nbytes
, int multibyte_p
)
9138 message_enable_multibyte
9139 = ((s
&& multibyte_p
)
9140 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9142 with_echo_area_buffer (0, -1, set_message_1
,
9143 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9144 message_buf_print
= 0;
9145 help_echo_showing_p
= 0;
9149 /* Helper function for set_message. Arguments have the same meaning
9150 as there, with A1 corresponding to S and A2 corresponding to STRING
9151 This function is called with the echo area buffer being
9155 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9157 const char *s
= (const char *) a1
;
9158 const unsigned char *msg
= (const unsigned char *) s
;
9159 Lisp_Object string
= a2
;
9161 /* Change multibyteness of the echo buffer appropriately. */
9162 if (message_enable_multibyte
9163 != !NILP (current_buffer
->enable_multibyte_characters
))
9164 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9166 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9167 if (!NILP (current_buffer
->bidi_display_reordering
))
9168 current_buffer
->bidi_paragraph_direction
= Qleft_to_right
;
9170 /* Insert new message at BEG. */
9171 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9173 if (STRINGP (string
))
9178 nbytes
= SBYTES (string
);
9179 nchars
= string_byte_to_char (string
, nbytes
);
9181 /* This function takes care of single/multibyte conversion. We
9182 just have to ensure that the echo area buffer has the right
9183 setting of enable_multibyte_characters. */
9184 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9189 nbytes
= strlen (s
);
9191 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9193 /* Convert from multi-byte to single-byte. */
9198 /* Convert a multibyte string to single-byte. */
9199 for (i
= 0; i
< nbytes
; i
+= n
)
9201 c
= string_char_and_length (msg
+ i
, &n
);
9202 work
[0] = (ASCII_CHAR_P (c
)
9204 : multibyte_char_to_unibyte (c
, Qnil
));
9205 insert_1_both (work
, 1, 1, 1, 0, 0);
9208 else if (!multibyte_p
9209 && !NILP (current_buffer
->enable_multibyte_characters
))
9211 /* Convert from single-byte to multi-byte. */
9214 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9216 /* Convert a single-byte string to multibyte. */
9217 for (i
= 0; i
< nbytes
; i
++)
9220 MAKE_CHAR_MULTIBYTE (c
);
9221 n
= CHAR_STRING (c
, str
);
9222 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9226 insert_1 (s
, nbytes
, 1, 0, 0);
9233 /* Clear messages. CURRENT_P non-zero means clear the current
9234 message. LAST_DISPLAYED_P non-zero means clear the message
9238 clear_message (int current_p
, int last_displayed_p
)
9242 echo_area_buffer
[0] = Qnil
;
9243 message_cleared_p
= 1;
9246 if (last_displayed_p
)
9247 echo_area_buffer
[1] = Qnil
;
9249 message_buf_print
= 0;
9252 /* Clear garbaged frames.
9254 This function is used where the old redisplay called
9255 redraw_garbaged_frames which in turn called redraw_frame which in
9256 turn called clear_frame. The call to clear_frame was a source of
9257 flickering. I believe a clear_frame is not necessary. It should
9258 suffice in the new redisplay to invalidate all current matrices,
9259 and ensure a complete redisplay of all windows. */
9262 clear_garbaged_frames (void)
9266 Lisp_Object tail
, frame
;
9267 int changed_count
= 0;
9269 FOR_EACH_FRAME (tail
, frame
)
9271 struct frame
*f
= XFRAME (frame
);
9273 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9277 Fredraw_frame (frame
);
9278 f
->force_flush_display_p
= 1;
9280 clear_current_matrices (f
);
9289 ++windows_or_buffers_changed
;
9294 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9295 is non-zero update selected_frame. Value is non-zero if the
9296 mini-windows height has been changed. */
9299 echo_area_display (int update_frame_p
)
9301 Lisp_Object mini_window
;
9304 int window_height_changed_p
= 0;
9305 struct frame
*sf
= SELECTED_FRAME ();
9307 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9308 w
= XWINDOW (mini_window
);
9309 f
= XFRAME (WINDOW_FRAME (w
));
9311 /* Don't display if frame is invisible or not yet initialized. */
9312 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9315 #ifdef HAVE_WINDOW_SYSTEM
9316 /* When Emacs starts, selected_frame may be the initial terminal
9317 frame. If we let this through, a message would be displayed on
9319 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9321 #endif /* HAVE_WINDOW_SYSTEM */
9323 /* Redraw garbaged frames. */
9325 clear_garbaged_frames ();
9327 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9329 echo_area_window
= mini_window
;
9330 window_height_changed_p
= display_echo_area (w
);
9331 w
->must_be_updated_p
= 1;
9333 /* Update the display, unless called from redisplay_internal.
9334 Also don't update the screen during redisplay itself. The
9335 update will happen at the end of redisplay, and an update
9336 here could cause confusion. */
9337 if (update_frame_p
&& !redisplaying_p
)
9341 /* If the display update has been interrupted by pending
9342 input, update mode lines in the frame. Due to the
9343 pending input, it might have been that redisplay hasn't
9344 been called, so that mode lines above the echo area are
9345 garbaged. This looks odd, so we prevent it here. */
9346 if (!display_completed
)
9347 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9349 if (window_height_changed_p
9350 /* Don't do this if Emacs is shutting down. Redisplay
9351 needs to run hooks. */
9352 && !NILP (Vrun_hooks
))
9354 /* Must update other windows. Likewise as in other
9355 cases, don't let this update be interrupted by
9357 int count
= SPECPDL_INDEX ();
9358 specbind (Qredisplay_dont_pause
, Qt
);
9359 windows_or_buffers_changed
= 1;
9360 redisplay_internal (0);
9361 unbind_to (count
, Qnil
);
9363 else if (FRAME_WINDOW_P (f
) && n
== 0)
9365 /* Window configuration is the same as before.
9366 Can do with a display update of the echo area,
9367 unless we displayed some mode lines. */
9368 update_single_window (w
, 1);
9369 FRAME_RIF (f
)->flush_display (f
);
9372 update_frame (f
, 1, 1);
9374 /* If cursor is in the echo area, make sure that the next
9375 redisplay displays the minibuffer, so that the cursor will
9376 be replaced with what the minibuffer wants. */
9377 if (cursor_in_echo_area
)
9378 ++windows_or_buffers_changed
;
9381 else if (!EQ (mini_window
, selected_window
))
9382 windows_or_buffers_changed
++;
9384 /* Last displayed message is now the current message. */
9385 echo_area_buffer
[1] = echo_area_buffer
[0];
9386 /* Inform read_char that we're not echoing. */
9387 echo_message_buffer
= Qnil
;
9389 /* Prevent redisplay optimization in redisplay_internal by resetting
9390 this_line_start_pos. This is done because the mini-buffer now
9391 displays the message instead of its buffer text. */
9392 if (EQ (mini_window
, selected_window
))
9393 CHARPOS (this_line_start_pos
) = 0;
9395 return window_height_changed_p
;
9400 /***********************************************************************
9401 Mode Lines and Frame Titles
9402 ***********************************************************************/
9404 /* A buffer for constructing non-propertized mode-line strings and
9405 frame titles in it; allocated from the heap in init_xdisp and
9406 resized as needed in store_mode_line_noprop_char. */
9408 static char *mode_line_noprop_buf
;
9410 /* The buffer's end, and a current output position in it. */
9412 static char *mode_line_noprop_buf_end
;
9413 static char *mode_line_noprop_ptr
;
9415 #define MODE_LINE_NOPROP_LEN(start) \
9416 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9419 MODE_LINE_DISPLAY
= 0,
9425 /* Alist that caches the results of :propertize.
9426 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9427 static Lisp_Object mode_line_proptrans_alist
;
9429 /* List of strings making up the mode-line. */
9430 static Lisp_Object mode_line_string_list
;
9432 /* Base face property when building propertized mode line string. */
9433 static Lisp_Object mode_line_string_face
;
9434 static Lisp_Object mode_line_string_face_prop
;
9437 /* Unwind data for mode line strings */
9439 static Lisp_Object Vmode_line_unwind_vector
;
9442 format_mode_line_unwind_data (struct buffer
*obuf
,
9446 Lisp_Object vector
, tmp
;
9448 /* Reduce consing by keeping one vector in
9449 Vwith_echo_area_save_vector. */
9450 vector
= Vmode_line_unwind_vector
;
9451 Vmode_line_unwind_vector
= Qnil
;
9454 vector
= Fmake_vector (make_number (8), Qnil
);
9456 ASET (vector
, 0, make_number (mode_line_target
));
9457 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9458 ASET (vector
, 2, mode_line_string_list
);
9459 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9460 ASET (vector
, 4, mode_line_string_face
);
9461 ASET (vector
, 5, mode_line_string_face_prop
);
9464 XSETBUFFER (tmp
, obuf
);
9467 ASET (vector
, 6, tmp
);
9468 ASET (vector
, 7, owin
);
9474 unwind_format_mode_line (Lisp_Object vector
)
9476 mode_line_target
= XINT (AREF (vector
, 0));
9477 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9478 mode_line_string_list
= AREF (vector
, 2);
9479 if (! EQ (AREF (vector
, 3), Qt
))
9480 mode_line_proptrans_alist
= AREF (vector
, 3);
9481 mode_line_string_face
= AREF (vector
, 4);
9482 mode_line_string_face_prop
= AREF (vector
, 5);
9484 if (!NILP (AREF (vector
, 7)))
9485 /* Select window before buffer, since it may change the buffer. */
9486 Fselect_window (AREF (vector
, 7), Qt
);
9488 if (!NILP (AREF (vector
, 6)))
9490 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9491 ASET (vector
, 6, Qnil
);
9494 Vmode_line_unwind_vector
= vector
;
9499 /* Store a single character C for the frame title in mode_line_noprop_buf.
9500 Re-allocate mode_line_noprop_buf if necessary. */
9503 store_mode_line_noprop_char (char c
)
9505 /* If output position has reached the end of the allocated buffer,
9506 double the buffer's size. */
9507 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9509 int len
= MODE_LINE_NOPROP_LEN (0);
9510 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9511 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9512 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9513 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9516 *mode_line_noprop_ptr
++ = c
;
9520 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9521 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9522 characters that yield more columns than PRECISION; PRECISION <= 0
9523 means copy the whole string. Pad with spaces until FIELD_WIDTH
9524 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9525 pad. Called from display_mode_element when it is used to build a
9529 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9531 const unsigned char *str
= (const unsigned char *) string
;
9533 EMACS_INT dummy
, nbytes
;
9535 /* Copy at most PRECISION chars from STR. */
9536 nbytes
= strlen (string
);
9537 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9539 store_mode_line_noprop_char (*str
++);
9541 /* Fill up with spaces until FIELD_WIDTH reached. */
9542 while (field_width
> 0
9545 store_mode_line_noprop_char (' ');
9552 /***********************************************************************
9554 ***********************************************************************/
9556 #ifdef HAVE_WINDOW_SYSTEM
9558 /* Set the title of FRAME, if it has changed. The title format is
9559 Vicon_title_format if FRAME is iconified, otherwise it is
9560 frame_title_format. */
9563 x_consider_frame_title (Lisp_Object frame
)
9565 struct frame
*f
= XFRAME (frame
);
9567 if (FRAME_WINDOW_P (f
)
9568 || FRAME_MINIBUF_ONLY_P (f
)
9569 || f
->explicit_name
)
9571 /* Do we have more than one visible frame on this X display? */
9578 int count
= SPECPDL_INDEX ();
9580 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9582 Lisp_Object other_frame
= XCAR (tail
);
9583 struct frame
*tf
= XFRAME (other_frame
);
9586 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9587 && !FRAME_MINIBUF_ONLY_P (tf
)
9588 && !EQ (other_frame
, tip_frame
)
9589 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9593 /* Set global variable indicating that multiple frames exist. */
9594 multiple_frames
= CONSP (tail
);
9596 /* Switch to the buffer of selected window of the frame. Set up
9597 mode_line_target so that display_mode_element will output into
9598 mode_line_noprop_buf; then display the title. */
9599 record_unwind_protect (unwind_format_mode_line
,
9600 format_mode_line_unwind_data
9601 (current_buffer
, selected_window
, 0));
9603 Fselect_window (f
->selected_window
, Qt
);
9604 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9605 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9607 mode_line_target
= MODE_LINE_TITLE
;
9608 title_start
= MODE_LINE_NOPROP_LEN (0);
9609 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9610 NULL
, DEFAULT_FACE_ID
);
9611 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9612 len
= MODE_LINE_NOPROP_LEN (title_start
);
9613 title
= mode_line_noprop_buf
+ title_start
;
9614 unbind_to (count
, Qnil
);
9616 /* Set the title only if it's changed. This avoids consing in
9617 the common case where it hasn't. (If it turns out that we've
9618 already wasted too much time by walking through the list with
9619 display_mode_element, then we might need to optimize at a
9620 higher level than this.) */
9621 if (! STRINGP (f
->name
)
9622 || SBYTES (f
->name
) != len
9623 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9624 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9628 #endif /* not HAVE_WINDOW_SYSTEM */
9633 /***********************************************************************
9635 ***********************************************************************/
9638 /* Prepare for redisplay by updating menu-bar item lists when
9639 appropriate. This can call eval. */
9642 prepare_menu_bars (void)
9645 struct gcpro gcpro1
, gcpro2
;
9647 Lisp_Object tooltip_frame
;
9649 #ifdef HAVE_WINDOW_SYSTEM
9650 tooltip_frame
= tip_frame
;
9652 tooltip_frame
= Qnil
;
9655 /* Update all frame titles based on their buffer names, etc. We do
9656 this before the menu bars so that the buffer-menu will show the
9657 up-to-date frame titles. */
9658 #ifdef HAVE_WINDOW_SYSTEM
9659 if (windows_or_buffers_changed
|| update_mode_lines
)
9661 Lisp_Object tail
, frame
;
9663 FOR_EACH_FRAME (tail
, frame
)
9666 if (!EQ (frame
, tooltip_frame
)
9667 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9668 x_consider_frame_title (frame
);
9671 #endif /* HAVE_WINDOW_SYSTEM */
9673 /* Update the menu bar item lists, if appropriate. This has to be
9674 done before any actual redisplay or generation of display lines. */
9675 all_windows
= (update_mode_lines
9676 || buffer_shared
> 1
9677 || windows_or_buffers_changed
);
9680 Lisp_Object tail
, frame
;
9681 int count
= SPECPDL_INDEX ();
9682 /* 1 means that update_menu_bar has run its hooks
9683 so any further calls to update_menu_bar shouldn't do so again. */
9684 int menu_bar_hooks_run
= 0;
9686 record_unwind_save_match_data ();
9688 FOR_EACH_FRAME (tail
, frame
)
9692 /* Ignore tooltip frame. */
9693 if (EQ (frame
, tooltip_frame
))
9696 /* If a window on this frame changed size, report that to
9697 the user and clear the size-change flag. */
9698 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9700 Lisp_Object functions
;
9702 /* Clear flag first in case we get an error below. */
9703 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9704 functions
= Vwindow_size_change_functions
;
9705 GCPRO2 (tail
, functions
);
9707 while (CONSP (functions
))
9709 if (!EQ (XCAR (functions
), Qt
))
9710 call1 (XCAR (functions
), frame
);
9711 functions
= XCDR (functions
);
9717 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9718 #ifdef HAVE_WINDOW_SYSTEM
9719 update_tool_bar (f
, 0);
9722 if (windows_or_buffers_changed
9724 ns_set_doc_edited (f
, Fbuffer_modified_p
9725 (XWINDOW (f
->selected_window
)->buffer
));
9730 unbind_to (count
, Qnil
);
9734 struct frame
*sf
= SELECTED_FRAME ();
9735 update_menu_bar (sf
, 1, 0);
9736 #ifdef HAVE_WINDOW_SYSTEM
9737 update_tool_bar (sf
, 1);
9743 /* Update the menu bar item list for frame F. This has to be done
9744 before we start to fill in any display lines, because it can call
9747 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9749 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9750 already ran the menu bar hooks for this redisplay, so there
9751 is no need to run them again. The return value is the
9752 updated value of this flag, to pass to the next call. */
9755 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9758 register struct window
*w
;
9760 /* If called recursively during a menu update, do nothing. This can
9761 happen when, for instance, an activate-menubar-hook causes a
9763 if (inhibit_menubar_update
)
9766 window
= FRAME_SELECTED_WINDOW (f
);
9767 w
= XWINDOW (window
);
9769 if (FRAME_WINDOW_P (f
)
9771 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9772 || defined (HAVE_NS) || defined (USE_GTK)
9773 FRAME_EXTERNAL_MENU_BAR (f
)
9775 FRAME_MENU_BAR_LINES (f
) > 0
9777 : FRAME_MENU_BAR_LINES (f
) > 0)
9779 /* If the user has switched buffers or windows, we need to
9780 recompute to reflect the new bindings. But we'll
9781 recompute when update_mode_lines is set too; that means
9782 that people can use force-mode-line-update to request
9783 that the menu bar be recomputed. The adverse effect on
9784 the rest of the redisplay algorithm is about the same as
9785 windows_or_buffers_changed anyway. */
9786 if (windows_or_buffers_changed
9787 /* This used to test w->update_mode_line, but we believe
9788 there is no need to recompute the menu in that case. */
9789 || update_mode_lines
9790 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9791 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9792 != !NILP (w
->last_had_star
))
9793 || ((!NILP (Vtransient_mark_mode
)
9794 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9795 != !NILP (w
->region_showing
)))
9797 struct buffer
*prev
= current_buffer
;
9798 int count
= SPECPDL_INDEX ();
9800 specbind (Qinhibit_menubar_update
, Qt
);
9802 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9803 if (save_match_data
)
9804 record_unwind_save_match_data ();
9805 if (NILP (Voverriding_local_map_menu_flag
))
9807 specbind (Qoverriding_terminal_local_map
, Qnil
);
9808 specbind (Qoverriding_local_map
, Qnil
);
9813 /* Run the Lucid hook. */
9814 safe_run_hooks (Qactivate_menubar_hook
);
9816 /* If it has changed current-menubar from previous value,
9817 really recompute the menu-bar from the value. */
9818 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9819 call0 (Qrecompute_lucid_menubar
);
9821 safe_run_hooks (Qmenu_bar_update_hook
);
9826 XSETFRAME (Vmenu_updating_frame
, f
);
9827 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9829 /* Redisplay the menu bar in case we changed it. */
9830 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9831 || defined (HAVE_NS) || defined (USE_GTK)
9832 if (FRAME_WINDOW_P (f
))
9834 #if defined (HAVE_NS)
9835 /* All frames on Mac OS share the same menubar. So only
9836 the selected frame should be allowed to set it. */
9837 if (f
== SELECTED_FRAME ())
9839 set_frame_menubar (f
, 0, 0);
9842 /* On a terminal screen, the menu bar is an ordinary screen
9843 line, and this makes it get updated. */
9844 w
->update_mode_line
= Qt
;
9845 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9846 /* In the non-toolkit version, the menu bar is an ordinary screen
9847 line, and this makes it get updated. */
9848 w
->update_mode_line
= Qt
;
9849 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9851 unbind_to (count
, Qnil
);
9852 set_buffer_internal_1 (prev
);
9861 /***********************************************************************
9863 ***********************************************************************/
9865 #ifdef HAVE_WINDOW_SYSTEM
9868 Nominal cursor position -- where to draw output.
9869 HPOS and VPOS are window relative glyph matrix coordinates.
9870 X and Y are window relative pixel coordinates. */
9872 struct cursor_pos output_cursor
;
9876 Set the global variable output_cursor to CURSOR. All cursor
9877 positions are relative to updated_window. */
9880 set_output_cursor (struct cursor_pos
*cursor
)
9882 output_cursor
.hpos
= cursor
->hpos
;
9883 output_cursor
.vpos
= cursor
->vpos
;
9884 output_cursor
.x
= cursor
->x
;
9885 output_cursor
.y
= cursor
->y
;
9890 Set a nominal cursor position.
9892 HPOS and VPOS are column/row positions in a window glyph matrix. X
9893 and Y are window text area relative pixel positions.
9895 If this is done during an update, updated_window will contain the
9896 window that is being updated and the position is the future output
9897 cursor position for that window. If updated_window is null, use
9898 selected_window and display the cursor at the given position. */
9901 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9905 /* If updated_window is not set, work on selected_window. */
9909 w
= XWINDOW (selected_window
);
9911 /* Set the output cursor. */
9912 output_cursor
.hpos
= hpos
;
9913 output_cursor
.vpos
= vpos
;
9914 output_cursor
.x
= x
;
9915 output_cursor
.y
= y
;
9917 /* If not called as part of an update, really display the cursor.
9918 This will also set the cursor position of W. */
9919 if (updated_window
== NULL
)
9922 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9923 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9924 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9929 #endif /* HAVE_WINDOW_SYSTEM */
9932 /***********************************************************************
9934 ***********************************************************************/
9936 #ifdef HAVE_WINDOW_SYSTEM
9938 /* Where the mouse was last time we reported a mouse event. */
9940 FRAME_PTR last_mouse_frame
;
9942 /* Tool-bar item index of the item on which a mouse button was pressed
9945 int last_tool_bar_item
;
9949 update_tool_bar_unwind (Lisp_Object frame
)
9951 selected_frame
= frame
;
9955 /* Update the tool-bar item list for frame F. This has to be done
9956 before we start to fill in any display lines. Called from
9957 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9958 and restore it here. */
9961 update_tool_bar (struct frame
*f
, int save_match_data
)
9963 #if defined (USE_GTK) || defined (HAVE_NS)
9964 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9966 int do_update
= WINDOWP (f
->tool_bar_window
)
9967 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9975 window
= FRAME_SELECTED_WINDOW (f
);
9976 w
= XWINDOW (window
);
9978 /* If the user has switched buffers or windows, we need to
9979 recompute to reflect the new bindings. But we'll
9980 recompute when update_mode_lines is set too; that means
9981 that people can use force-mode-line-update to request
9982 that the menu bar be recomputed. The adverse effect on
9983 the rest of the redisplay algorithm is about the same as
9984 windows_or_buffers_changed anyway. */
9985 if (windows_or_buffers_changed
9986 || !NILP (w
->update_mode_line
)
9987 || update_mode_lines
9988 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9989 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9990 != !NILP (w
->last_had_star
))
9991 || ((!NILP (Vtransient_mark_mode
)
9992 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9993 != !NILP (w
->region_showing
)))
9995 struct buffer
*prev
= current_buffer
;
9996 int count
= SPECPDL_INDEX ();
9997 Lisp_Object frame
, new_tool_bar
;
9999 struct gcpro gcpro1
;
10001 /* Set current_buffer to the buffer of the selected
10002 window of the frame, so that we get the right local
10004 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10006 /* Save match data, if we must. */
10007 if (save_match_data
)
10008 record_unwind_save_match_data ();
10010 /* Make sure that we don't accidentally use bogus keymaps. */
10011 if (NILP (Voverriding_local_map_menu_flag
))
10013 specbind (Qoverriding_terminal_local_map
, Qnil
);
10014 specbind (Qoverriding_local_map
, Qnil
);
10017 GCPRO1 (new_tool_bar
);
10019 /* We must temporarily set the selected frame to this frame
10020 before calling tool_bar_items, because the calculation of
10021 the tool-bar keymap uses the selected frame (see
10022 `tool-bar-make-keymap' in tool-bar.el). */
10023 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10024 XSETFRAME (frame
, f
);
10025 selected_frame
= frame
;
10027 /* Build desired tool-bar items from keymaps. */
10028 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10031 /* Redisplay the tool-bar if we changed it. */
10032 if (new_n_tool_bar
!= f
->n_tool_bar_items
10033 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10035 /* Redisplay that happens asynchronously due to an expose event
10036 may access f->tool_bar_items. Make sure we update both
10037 variables within BLOCK_INPUT so no such event interrupts. */
10039 f
->tool_bar_items
= new_tool_bar
;
10040 f
->n_tool_bar_items
= new_n_tool_bar
;
10041 w
->update_mode_line
= Qt
;
10047 unbind_to (count
, Qnil
);
10048 set_buffer_internal_1 (prev
);
10054 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10055 F's desired tool-bar contents. F->tool_bar_items must have
10056 been set up previously by calling prepare_menu_bars. */
10059 build_desired_tool_bar_string (struct frame
*f
)
10061 int i
, size
, size_needed
;
10062 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10063 Lisp_Object image
, plist
, props
;
10065 image
= plist
= props
= Qnil
;
10066 GCPRO3 (image
, plist
, props
);
10068 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10069 Otherwise, make a new string. */
10071 /* The size of the string we might be able to reuse. */
10072 size
= (STRINGP (f
->desired_tool_bar_string
)
10073 ? SCHARS (f
->desired_tool_bar_string
)
10076 /* We need one space in the string for each image. */
10077 size_needed
= f
->n_tool_bar_items
;
10079 /* Reuse f->desired_tool_bar_string, if possible. */
10080 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10081 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10082 make_number (' '));
10085 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10086 Fremove_text_properties (make_number (0), make_number (size
),
10087 props
, f
->desired_tool_bar_string
);
10090 /* Put a `display' property on the string for the images to display,
10091 put a `menu_item' property on tool-bar items with a value that
10092 is the index of the item in F's tool-bar item vector. */
10093 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10095 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10097 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10098 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10099 int hmargin
, vmargin
, relief
, idx
, end
;
10101 /* If image is a vector, choose the image according to the
10103 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10104 if (VECTORP (image
))
10108 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10109 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10112 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10113 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10115 xassert (ASIZE (image
) >= idx
);
10116 image
= AREF (image
, idx
);
10121 /* Ignore invalid image specifications. */
10122 if (!valid_image_p (image
))
10125 /* Display the tool-bar button pressed, or depressed. */
10126 plist
= Fcopy_sequence (XCDR (image
));
10128 /* Compute margin and relief to draw. */
10129 relief
= (tool_bar_button_relief
>= 0
10130 ? tool_bar_button_relief
10131 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10132 hmargin
= vmargin
= relief
;
10134 if (INTEGERP (Vtool_bar_button_margin
)
10135 && XINT (Vtool_bar_button_margin
) > 0)
10137 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10138 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10140 else if (CONSP (Vtool_bar_button_margin
))
10142 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10143 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10144 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10146 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10147 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10148 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10151 if (auto_raise_tool_bar_buttons_p
)
10153 /* Add a `:relief' property to the image spec if the item is
10157 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10164 /* If image is selected, display it pressed, i.e. with a
10165 negative relief. If it's not selected, display it with a
10167 plist
= Fplist_put (plist
, QCrelief
,
10169 ? make_number (-relief
)
10170 : make_number (relief
)));
10175 /* Put a margin around the image. */
10176 if (hmargin
|| vmargin
)
10178 if (hmargin
== vmargin
)
10179 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10181 plist
= Fplist_put (plist
, QCmargin
,
10182 Fcons (make_number (hmargin
),
10183 make_number (vmargin
)));
10186 /* If button is not enabled, and we don't have special images
10187 for the disabled state, make the image appear disabled by
10188 applying an appropriate algorithm to it. */
10189 if (!enabled_p
&& idx
< 0)
10190 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10192 /* Put a `display' text property on the string for the image to
10193 display. Put a `menu-item' property on the string that gives
10194 the start of this item's properties in the tool-bar items
10196 image
= Fcons (Qimage
, plist
);
10197 props
= list4 (Qdisplay
, image
,
10198 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10200 /* Let the last image hide all remaining spaces in the tool bar
10201 string. The string can be longer than needed when we reuse a
10202 previous string. */
10203 if (i
+ 1 == f
->n_tool_bar_items
)
10204 end
= SCHARS (f
->desired_tool_bar_string
);
10207 Fadd_text_properties (make_number (i
), make_number (end
),
10208 props
, f
->desired_tool_bar_string
);
10216 /* Display one line of the tool-bar of frame IT->f.
10218 HEIGHT specifies the desired height of the tool-bar line.
10219 If the actual height of the glyph row is less than HEIGHT, the
10220 row's height is increased to HEIGHT, and the icons are centered
10221 vertically in the new height.
10223 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10224 count a final empty row in case the tool-bar width exactly matches
10229 display_tool_bar_line (struct it
*it
, int height
)
10231 struct glyph_row
*row
= it
->glyph_row
;
10232 int max_x
= it
->last_visible_x
;
10233 struct glyph
*last
;
10235 prepare_desired_row (row
);
10236 row
->y
= it
->current_y
;
10238 /* Note that this isn't made use of if the face hasn't a box,
10239 so there's no need to check the face here. */
10240 it
->start_of_box_run_p
= 1;
10242 while (it
->current_x
< max_x
)
10244 int x
, n_glyphs_before
, i
, nglyphs
;
10245 struct it it_before
;
10247 /* Get the next display element. */
10248 if (!get_next_display_element (it
))
10250 /* Don't count empty row if we are counting needed tool-bar lines. */
10251 if (height
< 0 && !it
->hpos
)
10256 /* Produce glyphs. */
10257 n_glyphs_before
= row
->used
[TEXT_AREA
];
10260 PRODUCE_GLYPHS (it
);
10262 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10264 x
= it_before
.current_x
;
10265 while (i
< nglyphs
)
10267 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10269 if (x
+ glyph
->pixel_width
> max_x
)
10271 /* Glyph doesn't fit on line. Backtrack. */
10272 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10274 /* If this is the only glyph on this line, it will never fit on the
10275 tool-bar, so skip it. But ensure there is at least one glyph,
10276 so we don't accidentally disable the tool-bar. */
10277 if (n_glyphs_before
== 0
10278 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10284 x
+= glyph
->pixel_width
;
10288 /* Stop at line ends. */
10289 if (ITERATOR_AT_END_OF_LINE_P (it
))
10292 set_iterator_to_next (it
, 1);
10297 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10299 /* Use default face for the border below the tool bar.
10301 FIXME: When auto-resize-tool-bars is grow-only, there is
10302 no additional border below the possibly empty tool-bar lines.
10303 So to make the extra empty lines look "normal", we have to
10304 use the tool-bar face for the border too. */
10305 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10306 it
->face_id
= DEFAULT_FACE_ID
;
10308 extend_face_to_end_of_line (it
);
10309 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10310 last
->right_box_line_p
= 1;
10311 if (last
== row
->glyphs
[TEXT_AREA
])
10312 last
->left_box_line_p
= 1;
10314 /* Make line the desired height and center it vertically. */
10315 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10317 /* Don't add more than one line height. */
10318 height
%= FRAME_LINE_HEIGHT (it
->f
);
10319 it
->max_ascent
+= height
/ 2;
10320 it
->max_descent
+= (height
+ 1) / 2;
10323 compute_line_metrics (it
);
10325 /* If line is empty, make it occupy the rest of the tool-bar. */
10326 if (!row
->displays_text_p
)
10328 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10329 row
->visible_height
= row
->height
;
10330 row
->ascent
= row
->phys_ascent
= 0;
10331 row
->extra_line_spacing
= 0;
10334 row
->full_width_p
= 1;
10335 row
->continued_p
= 0;
10336 row
->truncated_on_left_p
= 0;
10337 row
->truncated_on_right_p
= 0;
10339 it
->current_x
= it
->hpos
= 0;
10340 it
->current_y
+= row
->height
;
10346 /* Max tool-bar height. */
10348 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10349 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10351 /* Value is the number of screen lines needed to make all tool-bar
10352 items of frame F visible. The number of actual rows needed is
10353 returned in *N_ROWS if non-NULL. */
10356 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10358 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10360 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10361 the desired matrix, so use (unused) mode-line row as temporary row to
10362 avoid destroying the first tool-bar row. */
10363 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10365 /* Initialize an iterator for iteration over
10366 F->desired_tool_bar_string in the tool-bar window of frame F. */
10367 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10368 it
.first_visible_x
= 0;
10369 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10370 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10372 while (!ITERATOR_AT_END_P (&it
))
10374 clear_glyph_row (temp_row
);
10375 it
.glyph_row
= temp_row
;
10376 display_tool_bar_line (&it
, -1);
10378 clear_glyph_row (temp_row
);
10380 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10382 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10384 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10388 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10390 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10391 (Lisp_Object frame
)
10398 frame
= selected_frame
;
10400 CHECK_FRAME (frame
);
10401 f
= XFRAME (frame
);
10403 if (WINDOWP (f
->tool_bar_window
)
10404 || (w
= XWINDOW (f
->tool_bar_window
),
10405 WINDOW_TOTAL_LINES (w
) > 0))
10407 update_tool_bar (f
, 1);
10408 if (f
->n_tool_bar_items
)
10410 build_desired_tool_bar_string (f
);
10411 nlines
= tool_bar_lines_needed (f
, NULL
);
10415 return make_number (nlines
);
10419 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10420 height should be changed. */
10423 redisplay_tool_bar (struct frame
*f
)
10427 struct glyph_row
*row
;
10429 #if defined (USE_GTK) || defined (HAVE_NS)
10430 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10431 update_frame_tool_bar (f
);
10435 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10436 do anything. This means you must start with tool-bar-lines
10437 non-zero to get the auto-sizing effect. Or in other words, you
10438 can turn off tool-bars by specifying tool-bar-lines zero. */
10439 if (!WINDOWP (f
->tool_bar_window
)
10440 || (w
= XWINDOW (f
->tool_bar_window
),
10441 WINDOW_TOTAL_LINES (w
) == 0))
10444 /* Set up an iterator for the tool-bar window. */
10445 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10446 it
.first_visible_x
= 0;
10447 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10448 row
= it
.glyph_row
;
10450 /* Build a string that represents the contents of the tool-bar. */
10451 build_desired_tool_bar_string (f
);
10452 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10454 if (f
->n_tool_bar_rows
== 0)
10458 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10459 nlines
!= WINDOW_TOTAL_LINES (w
)))
10462 int old_height
= WINDOW_TOTAL_LINES (w
);
10464 XSETFRAME (frame
, f
);
10465 Fmodify_frame_parameters (frame
,
10466 Fcons (Fcons (Qtool_bar_lines
,
10467 make_number (nlines
)),
10469 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10471 clear_glyph_matrix (w
->desired_matrix
);
10472 fonts_changed_p
= 1;
10478 /* Display as many lines as needed to display all tool-bar items. */
10480 if (f
->n_tool_bar_rows
> 0)
10482 int border
, rows
, height
, extra
;
10484 if (INTEGERP (Vtool_bar_border
))
10485 border
= XINT (Vtool_bar_border
);
10486 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10487 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10488 else if (EQ (Vtool_bar_border
, Qborder_width
))
10489 border
= f
->border_width
;
10495 rows
= f
->n_tool_bar_rows
;
10496 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10497 extra
= it
.last_visible_y
- border
- height
* rows
;
10499 while (it
.current_y
< it
.last_visible_y
)
10502 if (extra
> 0 && rows
-- > 0)
10504 h
= (extra
+ rows
- 1) / rows
;
10507 display_tool_bar_line (&it
, height
+ h
);
10512 while (it
.current_y
< it
.last_visible_y
)
10513 display_tool_bar_line (&it
, 0);
10516 /* It doesn't make much sense to try scrolling in the tool-bar
10517 window, so don't do it. */
10518 w
->desired_matrix
->no_scrolling_p
= 1;
10519 w
->must_be_updated_p
= 1;
10521 if (!NILP (Vauto_resize_tool_bars
))
10523 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10524 int change_height_p
= 0;
10526 /* If we couldn't display everything, change the tool-bar's
10527 height if there is room for more. */
10528 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10529 && it
.current_y
< max_tool_bar_height
)
10530 change_height_p
= 1;
10532 row
= it
.glyph_row
- 1;
10534 /* If there are blank lines at the end, except for a partially
10535 visible blank line at the end that is smaller than
10536 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10537 if (!row
->displays_text_p
10538 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10539 change_height_p
= 1;
10541 /* If row displays tool-bar items, but is partially visible,
10542 change the tool-bar's height. */
10543 if (row
->displays_text_p
10544 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10545 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10546 change_height_p
= 1;
10548 /* Resize windows as needed by changing the `tool-bar-lines'
10549 frame parameter. */
10550 if (change_height_p
)
10553 int old_height
= WINDOW_TOTAL_LINES (w
);
10555 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10557 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10558 && !f
->minimize_tool_bar_window_p
)
10559 ? (nlines
> old_height
)
10560 : (nlines
!= old_height
));
10561 f
->minimize_tool_bar_window_p
= 0;
10563 if (change_height_p
)
10565 XSETFRAME (frame
, f
);
10566 Fmodify_frame_parameters (frame
,
10567 Fcons (Fcons (Qtool_bar_lines
,
10568 make_number (nlines
)),
10570 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10572 clear_glyph_matrix (w
->desired_matrix
);
10573 f
->n_tool_bar_rows
= nrows
;
10574 fonts_changed_p
= 1;
10581 f
->minimize_tool_bar_window_p
= 0;
10586 /* Get information about the tool-bar item which is displayed in GLYPH
10587 on frame F. Return in *PROP_IDX the index where tool-bar item
10588 properties start in F->tool_bar_items. Value is zero if
10589 GLYPH doesn't display a tool-bar item. */
10592 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10598 /* This function can be called asynchronously, which means we must
10599 exclude any possibility that Fget_text_property signals an
10601 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10602 charpos
= max (0, charpos
);
10604 /* Get the text property `menu-item' at pos. The value of that
10605 property is the start index of this item's properties in
10606 F->tool_bar_items. */
10607 prop
= Fget_text_property (make_number (charpos
),
10608 Qmenu_item
, f
->current_tool_bar_string
);
10609 if (INTEGERP (prop
))
10611 *prop_idx
= XINT (prop
);
10621 /* Get information about the tool-bar item at position X/Y on frame F.
10622 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10623 the current matrix of the tool-bar window of F, or NULL if not
10624 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10625 item in F->tool_bar_items. Value is
10627 -1 if X/Y is not on a tool-bar item
10628 0 if X/Y is on the same item that was highlighted before.
10632 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10633 int *hpos
, int *vpos
, int *prop_idx
)
10635 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10636 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10639 /* Find the glyph under X/Y. */
10640 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10641 if (*glyph
== NULL
)
10644 /* Get the start of this tool-bar item's properties in
10645 f->tool_bar_items. */
10646 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10649 /* Is mouse on the highlighted item? */
10650 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10651 && *vpos
>= hlinfo
->mouse_face_beg_row
10652 && *vpos
<= hlinfo
->mouse_face_end_row
10653 && (*vpos
> hlinfo
->mouse_face_beg_row
10654 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10655 && (*vpos
< hlinfo
->mouse_face_end_row
10656 || *hpos
< hlinfo
->mouse_face_end_col
10657 || hlinfo
->mouse_face_past_end
))
10665 Handle mouse button event on the tool-bar of frame F, at
10666 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10667 0 for button release. MODIFIERS is event modifiers for button
10671 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10672 unsigned int modifiers
)
10674 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10675 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10676 int hpos
, vpos
, prop_idx
;
10677 struct glyph
*glyph
;
10678 Lisp_Object enabled_p
;
10680 /* If not on the highlighted tool-bar item, return. */
10681 frame_to_window_pixel_xy (w
, &x
, &y
);
10682 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10685 /* If item is disabled, do nothing. */
10686 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10687 if (NILP (enabled_p
))
10692 /* Show item in pressed state. */
10693 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10694 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10695 last_tool_bar_item
= prop_idx
;
10699 Lisp_Object key
, frame
;
10700 struct input_event event
;
10701 EVENT_INIT (event
);
10703 /* Show item in released state. */
10704 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10705 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10707 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10709 XSETFRAME (frame
, f
);
10710 event
.kind
= TOOL_BAR_EVENT
;
10711 event
.frame_or_window
= frame
;
10713 kbd_buffer_store_event (&event
);
10715 event
.kind
= TOOL_BAR_EVENT
;
10716 event
.frame_or_window
= frame
;
10718 event
.modifiers
= modifiers
;
10719 kbd_buffer_store_event (&event
);
10720 last_tool_bar_item
= -1;
10725 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10726 tool-bar window-relative coordinates X/Y. Called from
10727 note_mouse_highlight. */
10730 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10732 Lisp_Object window
= f
->tool_bar_window
;
10733 struct window
*w
= XWINDOW (window
);
10734 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10735 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10737 struct glyph
*glyph
;
10738 struct glyph_row
*row
;
10740 Lisp_Object enabled_p
;
10742 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10743 int mouse_down_p
, rc
;
10745 /* Function note_mouse_highlight is called with negative X/Y
10746 values when mouse moves outside of the frame. */
10747 if (x
<= 0 || y
<= 0)
10749 clear_mouse_face (hlinfo
);
10753 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10756 /* Not on tool-bar item. */
10757 clear_mouse_face (hlinfo
);
10761 /* On same tool-bar item as before. */
10762 goto set_help_echo
;
10764 clear_mouse_face (hlinfo
);
10766 /* Mouse is down, but on different tool-bar item? */
10767 mouse_down_p
= (dpyinfo
->grabbed
10768 && f
== last_mouse_frame
10769 && FRAME_LIVE_P (f
));
10771 && last_tool_bar_item
!= prop_idx
)
10774 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10775 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10777 /* If tool-bar item is not enabled, don't highlight it. */
10778 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10779 if (!NILP (enabled_p
))
10781 /* Compute the x-position of the glyph. In front and past the
10782 image is a space. We include this in the highlighted area. */
10783 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10784 for (i
= x
= 0; i
< hpos
; ++i
)
10785 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10787 /* Record this as the current active region. */
10788 hlinfo
->mouse_face_beg_col
= hpos
;
10789 hlinfo
->mouse_face_beg_row
= vpos
;
10790 hlinfo
->mouse_face_beg_x
= x
;
10791 hlinfo
->mouse_face_beg_y
= row
->y
;
10792 hlinfo
->mouse_face_past_end
= 0;
10794 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10795 hlinfo
->mouse_face_end_row
= vpos
;
10796 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10797 hlinfo
->mouse_face_end_y
= row
->y
;
10798 hlinfo
->mouse_face_window
= window
;
10799 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10801 /* Display it as active. */
10802 show_mouse_face (hlinfo
, draw
);
10803 hlinfo
->mouse_face_image_state
= draw
;
10808 /* Set help_echo_string to a help string to display for this tool-bar item.
10809 XTread_socket does the rest. */
10810 help_echo_object
= help_echo_window
= Qnil
;
10811 help_echo_pos
= -1;
10812 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10813 if (NILP (help_echo_string
))
10814 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10817 #endif /* HAVE_WINDOW_SYSTEM */
10821 /************************************************************************
10822 Horizontal scrolling
10823 ************************************************************************/
10825 static int hscroll_window_tree (Lisp_Object
);
10826 static int hscroll_windows (Lisp_Object
);
10828 /* For all leaf windows in the window tree rooted at WINDOW, set their
10829 hscroll value so that PT is (i) visible in the window, and (ii) so
10830 that it is not within a certain margin at the window's left and
10831 right border. Value is non-zero if any window's hscroll has been
10835 hscroll_window_tree (Lisp_Object window
)
10837 int hscrolled_p
= 0;
10838 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10839 int hscroll_step_abs
= 0;
10840 double hscroll_step_rel
= 0;
10842 if (hscroll_relative_p
)
10844 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10845 if (hscroll_step_rel
< 0)
10847 hscroll_relative_p
= 0;
10848 hscroll_step_abs
= 0;
10851 else if (INTEGERP (Vhscroll_step
))
10853 hscroll_step_abs
= XINT (Vhscroll_step
);
10854 if (hscroll_step_abs
< 0)
10855 hscroll_step_abs
= 0;
10858 hscroll_step_abs
= 0;
10860 while (WINDOWP (window
))
10862 struct window
*w
= XWINDOW (window
);
10864 if (WINDOWP (w
->hchild
))
10865 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10866 else if (WINDOWP (w
->vchild
))
10867 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10868 else if (w
->cursor
.vpos
>= 0)
10871 int text_area_width
;
10872 struct glyph_row
*current_cursor_row
10873 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10874 struct glyph_row
*desired_cursor_row
10875 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10876 struct glyph_row
*cursor_row
10877 = (desired_cursor_row
->enabled_p
10878 ? desired_cursor_row
10879 : current_cursor_row
);
10881 text_area_width
= window_box_width (w
, TEXT_AREA
);
10883 /* Scroll when cursor is inside this scroll margin. */
10884 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10886 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10887 && ((XFASTINT (w
->hscroll
)
10888 && w
->cursor
.x
<= h_margin
)
10889 || (cursor_row
->enabled_p
10890 && cursor_row
->truncated_on_right_p
10891 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10895 struct buffer
*saved_current_buffer
;
10899 /* Find point in a display of infinite width. */
10900 saved_current_buffer
= current_buffer
;
10901 current_buffer
= XBUFFER (w
->buffer
);
10903 if (w
== XWINDOW (selected_window
))
10904 pt
= BUF_PT (current_buffer
);
10907 pt
= marker_position (w
->pointm
);
10908 pt
= max (BEGV
, pt
);
10912 /* Move iterator to pt starting at cursor_row->start in
10913 a line with infinite width. */
10914 init_to_row_start (&it
, w
, cursor_row
);
10915 it
.last_visible_x
= INFINITY
;
10916 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10917 current_buffer
= saved_current_buffer
;
10919 /* Position cursor in window. */
10920 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10921 hscroll
= max (0, (it
.current_x
10922 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10923 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10924 : (text_area_width
/ 2))))
10925 / FRAME_COLUMN_WIDTH (it
.f
);
10926 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10928 if (hscroll_relative_p
)
10929 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10932 wanted_x
= text_area_width
10933 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10936 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10940 if (hscroll_relative_p
)
10941 wanted_x
= text_area_width
* hscroll_step_rel
10944 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10947 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10949 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10951 /* Don't call Fset_window_hscroll if value hasn't
10952 changed because it will prevent redisplay
10954 if (XFASTINT (w
->hscroll
) != hscroll
)
10956 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10957 w
->hscroll
= make_number (hscroll
);
10966 /* Value is non-zero if hscroll of any leaf window has been changed. */
10967 return hscrolled_p
;
10971 /* Set hscroll so that cursor is visible and not inside horizontal
10972 scroll margins for all windows in the tree rooted at WINDOW. See
10973 also hscroll_window_tree above. Value is non-zero if any window's
10974 hscroll has been changed. If it has, desired matrices on the frame
10975 of WINDOW are cleared. */
10978 hscroll_windows (Lisp_Object window
)
10980 int hscrolled_p
= hscroll_window_tree (window
);
10982 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10983 return hscrolled_p
;
10988 /************************************************************************
10990 ************************************************************************/
10992 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10993 to a non-zero value. This is sometimes handy to have in a debugger
10998 /* First and last unchanged row for try_window_id. */
11000 int debug_first_unchanged_at_end_vpos
;
11001 int debug_last_unchanged_at_beg_vpos
;
11003 /* Delta vpos and y. */
11005 int debug_dvpos
, debug_dy
;
11007 /* Delta in characters and bytes for try_window_id. */
11009 EMACS_INT debug_delta
, debug_delta_bytes
;
11011 /* Values of window_end_pos and window_end_vpos at the end of
11014 EMACS_INT debug_end_vpos
;
11016 /* Append a string to W->desired_matrix->method. FMT is a printf
11017 format string. A1...A9 are a supplement for a variable-length
11018 argument list. If trace_redisplay_p is non-zero also printf the
11019 resulting string to stderr. */
11022 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11025 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11028 char *method
= w
->desired_matrix
->method
;
11029 int len
= strlen (method
);
11030 int size
= sizeof w
->desired_matrix
->method
;
11031 int remaining
= size
- len
- 1;
11033 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11034 if (len
&& remaining
)
11037 --remaining
, ++len
;
11040 strncpy (method
+ len
, buffer
, remaining
);
11042 if (trace_redisplay_p
)
11043 fprintf (stderr
, "%p (%s): %s\n",
11045 ((BUFFERP (w
->buffer
)
11046 && STRINGP (XBUFFER (w
->buffer
)->name
))
11047 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11052 #endif /* GLYPH_DEBUG */
11055 /* Value is non-zero if all changes in window W, which displays
11056 current_buffer, are in the text between START and END. START is a
11057 buffer position, END is given as a distance from Z. Used in
11058 redisplay_internal for display optimization. */
11061 text_outside_line_unchanged_p (struct window
*w
,
11062 EMACS_INT start
, EMACS_INT end
)
11064 int unchanged_p
= 1;
11066 /* If text or overlays have changed, see where. */
11067 if (XFASTINT (w
->last_modified
) < MODIFF
11068 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11070 /* Gap in the line? */
11071 if (GPT
< start
|| Z
- GPT
< end
)
11074 /* Changes start in front of the line, or end after it? */
11076 && (BEG_UNCHANGED
< start
- 1
11077 || END_UNCHANGED
< end
))
11080 /* If selective display, can't optimize if changes start at the
11081 beginning of the line. */
11083 && INTEGERP (current_buffer
->selective_display
)
11084 && XINT (current_buffer
->selective_display
) > 0
11085 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11088 /* If there are overlays at the start or end of the line, these
11089 may have overlay strings with newlines in them. A change at
11090 START, for instance, may actually concern the display of such
11091 overlay strings as well, and they are displayed on different
11092 lines. So, quickly rule out this case. (For the future, it
11093 might be desirable to implement something more telling than
11094 just BEG/END_UNCHANGED.) */
11097 if (BEG
+ BEG_UNCHANGED
== start
11098 && overlay_touches_p (start
))
11100 if (END_UNCHANGED
== end
11101 && overlay_touches_p (Z
- end
))
11105 /* Under bidi reordering, adding or deleting a character in the
11106 beginning of a paragraph, before the first strong directional
11107 character, can change the base direction of the paragraph (unless
11108 the buffer specifies a fixed paragraph direction), which will
11109 require to redisplay the whole paragraph. It might be worthwhile
11110 to find the paragraph limits and widen the range of redisplayed
11111 lines to that, but for now just give up this optimization. */
11112 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11113 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11117 return unchanged_p
;
11121 /* Do a frame update, taking possible shortcuts into account. This is
11122 the main external entry point for redisplay.
11124 If the last redisplay displayed an echo area message and that message
11125 is no longer requested, we clear the echo area or bring back the
11126 mini-buffer if that is in use. */
11131 redisplay_internal (0);
11136 overlay_arrow_string_or_property (Lisp_Object var
)
11140 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11143 return Voverlay_arrow_string
;
11146 /* Return 1 if there are any overlay-arrows in current_buffer. */
11148 overlay_arrow_in_current_buffer_p (void)
11152 for (vlist
= Voverlay_arrow_variable_list
;
11154 vlist
= XCDR (vlist
))
11156 Lisp_Object var
= XCAR (vlist
);
11159 if (!SYMBOLP (var
))
11161 val
= find_symbol_value (var
);
11163 && current_buffer
== XMARKER (val
)->buffer
)
11170 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11174 overlay_arrows_changed_p (void)
11178 for (vlist
= Voverlay_arrow_variable_list
;
11180 vlist
= XCDR (vlist
))
11182 Lisp_Object var
= XCAR (vlist
);
11183 Lisp_Object val
, pstr
;
11185 if (!SYMBOLP (var
))
11187 val
= find_symbol_value (var
);
11188 if (!MARKERP (val
))
11190 if (! EQ (COERCE_MARKER (val
),
11191 Fget (var
, Qlast_arrow_position
))
11192 || ! (pstr
= overlay_arrow_string_or_property (var
),
11193 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11199 /* Mark overlay arrows to be updated on next redisplay. */
11202 update_overlay_arrows (int up_to_date
)
11206 for (vlist
= Voverlay_arrow_variable_list
;
11208 vlist
= XCDR (vlist
))
11210 Lisp_Object var
= XCAR (vlist
);
11212 if (!SYMBOLP (var
))
11215 if (up_to_date
> 0)
11217 Lisp_Object val
= find_symbol_value (var
);
11218 Fput (var
, Qlast_arrow_position
,
11219 COERCE_MARKER (val
));
11220 Fput (var
, Qlast_arrow_string
,
11221 overlay_arrow_string_or_property (var
));
11223 else if (up_to_date
< 0
11224 || !NILP (Fget (var
, Qlast_arrow_position
)))
11226 Fput (var
, Qlast_arrow_position
, Qt
);
11227 Fput (var
, Qlast_arrow_string
, Qt
);
11233 /* Return overlay arrow string to display at row.
11234 Return integer (bitmap number) for arrow bitmap in left fringe.
11235 Return nil if no overlay arrow. */
11238 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11242 for (vlist
= Voverlay_arrow_variable_list
;
11244 vlist
= XCDR (vlist
))
11246 Lisp_Object var
= XCAR (vlist
);
11249 if (!SYMBOLP (var
))
11252 val
= find_symbol_value (var
);
11255 && current_buffer
== XMARKER (val
)->buffer
11256 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11258 if (FRAME_WINDOW_P (it
->f
)
11259 /* FIXME: if ROW->reversed_p is set, this should test
11260 the right fringe, not the left one. */
11261 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11263 #ifdef HAVE_WINDOW_SYSTEM
11264 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11267 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11268 return make_number (fringe_bitmap
);
11271 return make_number (-1); /* Use default arrow bitmap */
11273 return overlay_arrow_string_or_property (var
);
11280 /* Return 1 if point moved out of or into a composition. Otherwise
11281 return 0. PREV_BUF and PREV_PT are the last point buffer and
11282 position. BUF and PT are the current point buffer and position. */
11285 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11286 struct buffer
*buf
, EMACS_INT pt
)
11288 EMACS_INT start
, end
;
11290 Lisp_Object buffer
;
11292 XSETBUFFER (buffer
, buf
);
11293 /* Check a composition at the last point if point moved within the
11295 if (prev_buf
== buf
)
11298 /* Point didn't move. */
11301 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11302 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11303 && COMPOSITION_VALID_P (start
, end
, prop
)
11304 && start
< prev_pt
&& end
> prev_pt
)
11305 /* The last point was within the composition. Return 1 iff
11306 point moved out of the composition. */
11307 return (pt
<= start
|| pt
>= end
);
11310 /* Check a composition at the current point. */
11311 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11312 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11313 && COMPOSITION_VALID_P (start
, end
, prop
)
11314 && start
< pt
&& end
> pt
);
11318 /* Reconsider the setting of B->clip_changed which is displayed
11322 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11324 if (b
->clip_changed
11325 && !NILP (w
->window_end_valid
)
11326 && w
->current_matrix
->buffer
== b
11327 && w
->current_matrix
->zv
== BUF_ZV (b
)
11328 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11329 b
->clip_changed
= 0;
11331 /* If display wasn't paused, and W is not a tool bar window, see if
11332 point has been moved into or out of a composition. In that case,
11333 we set b->clip_changed to 1 to force updating the screen. If
11334 b->clip_changed has already been set to 1, we can skip this
11336 if (!b
->clip_changed
11337 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11341 if (w
== XWINDOW (selected_window
))
11342 pt
= BUF_PT (current_buffer
);
11344 pt
= marker_position (w
->pointm
);
11346 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11347 || pt
!= XINT (w
->last_point
))
11348 && check_point_in_composition (w
->current_matrix
->buffer
,
11349 XINT (w
->last_point
),
11350 XBUFFER (w
->buffer
), pt
))
11351 b
->clip_changed
= 1;
11356 /* Select FRAME to forward the values of frame-local variables into C
11357 variables so that the redisplay routines can access those values
11361 select_frame_for_redisplay (Lisp_Object frame
)
11363 Lisp_Object tail
, tem
;
11364 Lisp_Object old
= selected_frame
;
11365 struct Lisp_Symbol
*sym
;
11367 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11369 selected_frame
= frame
;
11372 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11373 if (CONSP (XCAR (tail
))
11374 && (tem
= XCAR (XCAR (tail
)),
11376 && (sym
= indirect_variable (XSYMBOL (tem
)),
11377 sym
->redirect
== SYMBOL_LOCALIZED
)
11378 && sym
->val
.blv
->frame_local
)
11379 /* Use find_symbol_value rather than Fsymbol_value
11380 to avoid an error if it is void. */
11381 find_symbol_value (tem
);
11382 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11386 #define STOP_POLLING \
11387 do { if (! polling_stopped_here) stop_polling (); \
11388 polling_stopped_here = 1; } while (0)
11390 #define RESUME_POLLING \
11391 do { if (polling_stopped_here) start_polling (); \
11392 polling_stopped_here = 0; } while (0)
11395 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11396 response to any user action; therefore, we should preserve the echo
11397 area. (Actually, our caller does that job.) Perhaps in the future
11398 avoid recentering windows if it is not necessary; currently that
11399 causes some problems. */
11402 redisplay_internal (int preserve_echo_area
)
11404 struct window
*w
= XWINDOW (selected_window
);
11407 int must_finish
= 0;
11408 struct text_pos tlbufpos
, tlendpos
;
11409 int number_of_visible_frames
;
11412 int polling_stopped_here
= 0;
11413 Lisp_Object old_frame
= selected_frame
;
11415 /* Non-zero means redisplay has to consider all windows on all
11416 frames. Zero means, only selected_window is considered. */
11417 int consider_all_windows_p
;
11419 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11421 /* No redisplay if running in batch mode or frame is not yet fully
11422 initialized, or redisplay is explicitly turned off by setting
11423 Vinhibit_redisplay. */
11424 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11425 || !NILP (Vinhibit_redisplay
))
11428 /* Don't examine these until after testing Vinhibit_redisplay.
11429 When Emacs is shutting down, perhaps because its connection to
11430 X has dropped, we should not look at them at all. */
11431 f
= XFRAME (w
->frame
);
11432 sf
= SELECTED_FRAME ();
11434 if (!f
->glyphs_initialized_p
)
11437 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11438 if (popup_activated ())
11442 /* I don't think this happens but let's be paranoid. */
11443 if (redisplaying_p
)
11446 /* Record a function that resets redisplaying_p to its old value
11447 when we leave this function. */
11448 count
= SPECPDL_INDEX ();
11449 record_unwind_protect (unwind_redisplay
,
11450 Fcons (make_number (redisplaying_p
), selected_frame
));
11452 specbind (Qinhibit_free_realized_faces
, Qnil
);
11455 Lisp_Object tail
, frame
;
11457 FOR_EACH_FRAME (tail
, frame
)
11459 struct frame
*f
= XFRAME (frame
);
11460 f
->already_hscrolled_p
= 0;
11465 if (!EQ (old_frame
, selected_frame
)
11466 && FRAME_LIVE_P (XFRAME (old_frame
)))
11467 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11468 selected_frame and selected_window to be temporarily out-of-sync so
11469 when we come back here via `goto retry', we need to resync because we
11470 may need to run Elisp code (via prepare_menu_bars). */
11471 select_frame_for_redisplay (old_frame
);
11474 reconsider_clip_changes (w
, current_buffer
);
11475 last_escape_glyph_frame
= NULL
;
11476 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11477 last_glyphless_glyph_frame
= NULL
;
11478 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11480 /* If new fonts have been loaded that make a glyph matrix adjustment
11481 necessary, do it. */
11482 if (fonts_changed_p
)
11484 adjust_glyphs (NULL
);
11485 ++windows_or_buffers_changed
;
11486 fonts_changed_p
= 0;
11489 /* If face_change_count is non-zero, init_iterator will free all
11490 realized faces, which includes the faces referenced from current
11491 matrices. So, we can't reuse current matrices in this case. */
11492 if (face_change_count
)
11493 ++windows_or_buffers_changed
;
11495 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11496 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11498 /* Since frames on a single ASCII terminal share the same
11499 display area, displaying a different frame means redisplay
11500 the whole thing. */
11501 windows_or_buffers_changed
++;
11502 SET_FRAME_GARBAGED (sf
);
11504 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11506 FRAME_TTY (sf
)->previous_frame
= sf
;
11509 /* Set the visible flags for all frames. Do this before checking
11510 for resized or garbaged frames; they want to know if their frames
11511 are visible. See the comment in frame.h for
11512 FRAME_SAMPLE_VISIBILITY. */
11514 Lisp_Object tail
, frame
;
11516 number_of_visible_frames
= 0;
11518 FOR_EACH_FRAME (tail
, frame
)
11520 struct frame
*f
= XFRAME (frame
);
11522 FRAME_SAMPLE_VISIBILITY (f
);
11523 if (FRAME_VISIBLE_P (f
))
11524 ++number_of_visible_frames
;
11525 clear_desired_matrices (f
);
11529 /* Notice any pending interrupt request to change frame size. */
11530 do_pending_window_change (1);
11532 /* Clear frames marked as garbaged. */
11533 if (frame_garbaged
)
11534 clear_garbaged_frames ();
11536 /* Build menubar and tool-bar items. */
11537 if (NILP (Vmemory_full
))
11538 prepare_menu_bars ();
11540 if (windows_or_buffers_changed
)
11541 update_mode_lines
++;
11543 /* Detect case that we need to write or remove a star in the mode line. */
11544 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11546 w
->update_mode_line
= Qt
;
11547 if (buffer_shared
> 1)
11548 update_mode_lines
++;
11551 /* Avoid invocation of point motion hooks by `current_column' below. */
11552 count1
= SPECPDL_INDEX ();
11553 specbind (Qinhibit_point_motion_hooks
, Qt
);
11555 /* If %c is in the mode line, update it if needed. */
11556 if (!NILP (w
->column_number_displayed
)
11557 /* This alternative quickly identifies a common case
11558 where no change is needed. */
11559 && !(PT
== XFASTINT (w
->last_point
)
11560 && XFASTINT (w
->last_modified
) >= MODIFF
11561 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11562 && (XFASTINT (w
->column_number_displayed
)
11563 != (int) current_column ())) /* iftc */
11564 w
->update_mode_line
= Qt
;
11566 unbind_to (count1
, Qnil
);
11568 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11570 /* The variable buffer_shared is set in redisplay_window and
11571 indicates that we redisplay a buffer in different windows. See
11573 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11574 || cursor_type_changed
);
11576 /* If specs for an arrow have changed, do thorough redisplay
11577 to ensure we remove any arrow that should no longer exist. */
11578 if (overlay_arrows_changed_p ())
11579 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11581 /* Normally the message* functions will have already displayed and
11582 updated the echo area, but the frame may have been trashed, or
11583 the update may have been preempted, so display the echo area
11584 again here. Checking message_cleared_p captures the case that
11585 the echo area should be cleared. */
11586 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11587 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11588 || (message_cleared_p
11589 && minibuf_level
== 0
11590 /* If the mini-window is currently selected, this means the
11591 echo-area doesn't show through. */
11592 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11594 int window_height_changed_p
= echo_area_display (0);
11597 /* If we don't display the current message, don't clear the
11598 message_cleared_p flag, because, if we did, we wouldn't clear
11599 the echo area in the next redisplay which doesn't preserve
11601 if (!display_last_displayed_message_p
)
11602 message_cleared_p
= 0;
11604 if (fonts_changed_p
)
11606 else if (window_height_changed_p
)
11608 consider_all_windows_p
= 1;
11609 ++update_mode_lines
;
11610 ++windows_or_buffers_changed
;
11612 /* If window configuration was changed, frames may have been
11613 marked garbaged. Clear them or we will experience
11614 surprises wrt scrolling. */
11615 if (frame_garbaged
)
11616 clear_garbaged_frames ();
11619 else if (EQ (selected_window
, minibuf_window
)
11620 && (current_buffer
->clip_changed
11621 || XFASTINT (w
->last_modified
) < MODIFF
11622 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11623 && resize_mini_window (w
, 0))
11625 /* Resized active mini-window to fit the size of what it is
11626 showing if its contents might have changed. */
11628 /* FIXME: this causes all frames to be updated, which seems unnecessary
11629 since only the current frame needs to be considered. This function needs
11630 to be rewritten with two variables, consider_all_windows and
11631 consider_all_frames. */
11632 consider_all_windows_p
= 1;
11633 ++windows_or_buffers_changed
;
11634 ++update_mode_lines
;
11636 /* If window configuration was changed, frames may have been
11637 marked garbaged. Clear them or we will experience
11638 surprises wrt scrolling. */
11639 if (frame_garbaged
)
11640 clear_garbaged_frames ();
11644 /* If showing the region, and mark has changed, we must redisplay
11645 the whole window. The assignment to this_line_start_pos prevents
11646 the optimization directly below this if-statement. */
11647 if (((!NILP (Vtransient_mark_mode
)
11648 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11649 != !NILP (w
->region_showing
))
11650 || (!NILP (w
->region_showing
)
11651 && !EQ (w
->region_showing
,
11652 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11653 CHARPOS (this_line_start_pos
) = 0;
11655 /* Optimize the case that only the line containing the cursor in the
11656 selected window has changed. Variables starting with this_ are
11657 set in display_line and record information about the line
11658 containing the cursor. */
11659 tlbufpos
= this_line_start_pos
;
11660 tlendpos
= this_line_end_pos
;
11661 if (!consider_all_windows_p
11662 && CHARPOS (tlbufpos
) > 0
11663 && NILP (w
->update_mode_line
)
11664 && !current_buffer
->clip_changed
11665 && !current_buffer
->prevent_redisplay_optimizations_p
11666 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11667 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11668 /* Make sure recorded data applies to current buffer, etc. */
11669 && this_line_buffer
== current_buffer
11670 && current_buffer
== XBUFFER (w
->buffer
)
11671 && NILP (w
->force_start
)
11672 && NILP (w
->optional_new_start
)
11673 /* Point must be on the line that we have info recorded about. */
11674 && PT
>= CHARPOS (tlbufpos
)
11675 && PT
<= Z
- CHARPOS (tlendpos
)
11676 /* All text outside that line, including its final newline,
11677 must be unchanged. */
11678 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11679 CHARPOS (tlendpos
)))
11681 if (CHARPOS (tlbufpos
) > BEGV
11682 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11683 && (CHARPOS (tlbufpos
) == ZV
11684 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11685 /* Former continuation line has disappeared by becoming empty. */
11687 else if (XFASTINT (w
->last_modified
) < MODIFF
11688 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11689 || MINI_WINDOW_P (w
))
11691 /* We have to handle the case of continuation around a
11692 wide-column character (see the comment in indent.c around
11695 For instance, in the following case:
11697 -------- Insert --------
11698 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11699 J_I_ ==> J_I_ `^^' are cursors.
11703 As we have to redraw the line above, we cannot use this
11707 int line_height_before
= this_line_pixel_height
;
11709 /* Note that start_display will handle the case that the
11710 line starting at tlbufpos is a continuation line. */
11711 start_display (&it
, w
, tlbufpos
);
11713 /* Implementation note: It this still necessary? */
11714 if (it
.current_x
!= this_line_start_x
)
11717 TRACE ((stderr
, "trying display optimization 1\n"));
11718 w
->cursor
.vpos
= -1;
11719 overlay_arrow_seen
= 0;
11720 it
.vpos
= this_line_vpos
;
11721 it
.current_y
= this_line_y
;
11722 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11723 display_line (&it
);
11725 /* If line contains point, is not continued,
11726 and ends at same distance from eob as before, we win. */
11727 if (w
->cursor
.vpos
>= 0
11728 /* Line is not continued, otherwise this_line_start_pos
11729 would have been set to 0 in display_line. */
11730 && CHARPOS (this_line_start_pos
)
11731 /* Line ends as before. */
11732 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11733 /* Line has same height as before. Otherwise other lines
11734 would have to be shifted up or down. */
11735 && this_line_pixel_height
== line_height_before
)
11737 /* If this is not the window's last line, we must adjust
11738 the charstarts of the lines below. */
11739 if (it
.current_y
< it
.last_visible_y
)
11741 struct glyph_row
*row
11742 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11743 EMACS_INT delta
, delta_bytes
;
11745 /* We used to distinguish between two cases here,
11746 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11747 when the line ends in a newline or the end of the
11748 buffer's accessible portion. But both cases did
11749 the same, so they were collapsed. */
11751 - CHARPOS (tlendpos
)
11752 - MATRIX_ROW_START_CHARPOS (row
));
11753 delta_bytes
= (Z_BYTE
11754 - BYTEPOS (tlendpos
)
11755 - MATRIX_ROW_START_BYTEPOS (row
));
11757 increment_matrix_positions (w
->current_matrix
,
11758 this_line_vpos
+ 1,
11759 w
->current_matrix
->nrows
,
11760 delta
, delta_bytes
);
11763 /* If this row displays text now but previously didn't,
11764 or vice versa, w->window_end_vpos may have to be
11766 if ((it
.glyph_row
- 1)->displays_text_p
)
11768 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11769 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11771 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11772 && this_line_vpos
> 0)
11773 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11774 w
->window_end_valid
= Qnil
;
11776 /* Update hint: No need to try to scroll in update_window. */
11777 w
->desired_matrix
->no_scrolling_p
= 1;
11780 *w
->desired_matrix
->method
= 0;
11781 debug_method_add (w
, "optimization 1");
11783 #ifdef HAVE_WINDOW_SYSTEM
11784 update_window_fringes (w
, 0);
11791 else if (/* Cursor position hasn't changed. */
11792 PT
== XFASTINT (w
->last_point
)
11793 /* Make sure the cursor was last displayed
11794 in this window. Otherwise we have to reposition it. */
11795 && 0 <= w
->cursor
.vpos
11796 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11800 do_pending_window_change (1);
11802 /* We used to always goto end_of_redisplay here, but this
11803 isn't enough if we have a blinking cursor. */
11804 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11805 goto end_of_redisplay
;
11809 /* If highlighting the region, or if the cursor is in the echo area,
11810 then we can't just move the cursor. */
11811 else if (! (!NILP (Vtransient_mark_mode
)
11812 && !NILP (current_buffer
->mark_active
))
11813 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11814 || highlight_nonselected_windows
)
11815 && NILP (w
->region_showing
)
11816 && NILP (Vshow_trailing_whitespace
)
11817 && !cursor_in_echo_area
)
11820 struct glyph_row
*row
;
11822 /* Skip from tlbufpos to PT and see where it is. Note that
11823 PT may be in invisible text. If so, we will end at the
11824 next visible position. */
11825 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11826 NULL
, DEFAULT_FACE_ID
);
11827 it
.current_x
= this_line_start_x
;
11828 it
.current_y
= this_line_y
;
11829 it
.vpos
= this_line_vpos
;
11831 /* The call to move_it_to stops in front of PT, but
11832 moves over before-strings. */
11833 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11835 if (it
.vpos
== this_line_vpos
11836 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11839 xassert (this_line_vpos
== it
.vpos
);
11840 xassert (this_line_y
== it
.current_y
);
11841 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11843 *w
->desired_matrix
->method
= 0;
11844 debug_method_add (w
, "optimization 3");
11853 /* Text changed drastically or point moved off of line. */
11854 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11857 CHARPOS (this_line_start_pos
) = 0;
11858 consider_all_windows_p
|= buffer_shared
> 1;
11859 ++clear_face_cache_count
;
11860 #ifdef HAVE_WINDOW_SYSTEM
11861 ++clear_image_cache_count
;
11864 /* Build desired matrices, and update the display. If
11865 consider_all_windows_p is non-zero, do it for all windows on all
11866 frames. Otherwise do it for selected_window, only. */
11868 if (consider_all_windows_p
)
11870 Lisp_Object tail
, frame
;
11872 FOR_EACH_FRAME (tail
, frame
)
11873 XFRAME (frame
)->updated_p
= 0;
11875 /* Recompute # windows showing selected buffer. This will be
11876 incremented each time such a window is displayed. */
11879 FOR_EACH_FRAME (tail
, frame
)
11881 struct frame
*f
= XFRAME (frame
);
11883 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11885 if (! EQ (frame
, selected_frame
))
11886 /* Select the frame, for the sake of frame-local
11888 select_frame_for_redisplay (frame
);
11890 /* Mark all the scroll bars to be removed; we'll redeem
11891 the ones we want when we redisplay their windows. */
11892 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11893 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11895 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11896 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11898 /* The X error handler may have deleted that frame. */
11899 if (!FRAME_LIVE_P (f
))
11902 /* Any scroll bars which redisplay_windows should have
11903 nuked should now go away. */
11904 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11905 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11907 /* If fonts changed, display again. */
11908 /* ??? rms: I suspect it is a mistake to jump all the way
11909 back to retry here. It should just retry this frame. */
11910 if (fonts_changed_p
)
11913 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11915 /* See if we have to hscroll. */
11916 if (!f
->already_hscrolled_p
)
11918 f
->already_hscrolled_p
= 1;
11919 if (hscroll_windows (f
->root_window
))
11923 /* Prevent various kinds of signals during display
11924 update. stdio is not robust about handling
11925 signals, which can cause an apparent I/O
11927 if (interrupt_input
)
11928 unrequest_sigio ();
11931 /* Update the display. */
11932 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11933 pause
|= update_frame (f
, 0, 0);
11939 if (!EQ (old_frame
, selected_frame
)
11940 && FRAME_LIVE_P (XFRAME (old_frame
)))
11941 /* We played a bit fast-and-loose above and allowed selected_frame
11942 and selected_window to be temporarily out-of-sync but let's make
11943 sure this stays contained. */
11944 select_frame_for_redisplay (old_frame
);
11945 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11949 /* Do the mark_window_display_accurate after all windows have
11950 been redisplayed because this call resets flags in buffers
11951 which are needed for proper redisplay. */
11952 FOR_EACH_FRAME (tail
, frame
)
11954 struct frame
*f
= XFRAME (frame
);
11957 mark_window_display_accurate (f
->root_window
, 1);
11958 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11959 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11964 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11966 Lisp_Object mini_window
;
11967 struct frame
*mini_frame
;
11969 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11970 /* Use list_of_error, not Qerror, so that
11971 we catch only errors and don't run the debugger. */
11972 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11974 redisplay_window_error
);
11976 /* Compare desired and current matrices, perform output. */
11979 /* If fonts changed, display again. */
11980 if (fonts_changed_p
)
11983 /* Prevent various kinds of signals during display update.
11984 stdio is not robust about handling signals,
11985 which can cause an apparent I/O error. */
11986 if (interrupt_input
)
11987 unrequest_sigio ();
11990 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11992 if (hscroll_windows (selected_window
))
11995 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11996 pause
= update_frame (sf
, 0, 0);
11999 /* We may have called echo_area_display at the top of this
12000 function. If the echo area is on another frame, that may
12001 have put text on a frame other than the selected one, so the
12002 above call to update_frame would not have caught it. Catch
12004 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12005 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12007 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12009 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12010 pause
|= update_frame (mini_frame
, 0, 0);
12011 if (!pause
&& hscroll_windows (mini_window
))
12016 /* If display was paused because of pending input, make sure we do a
12017 thorough update the next time. */
12020 /* Prevent the optimization at the beginning of
12021 redisplay_internal that tries a single-line update of the
12022 line containing the cursor in the selected window. */
12023 CHARPOS (this_line_start_pos
) = 0;
12025 /* Let the overlay arrow be updated the next time. */
12026 update_overlay_arrows (0);
12028 /* If we pause after scrolling, some rows in the current
12029 matrices of some windows are not valid. */
12030 if (!WINDOW_FULL_WIDTH_P (w
)
12031 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12032 update_mode_lines
= 1;
12036 if (!consider_all_windows_p
)
12038 /* This has already been done above if
12039 consider_all_windows_p is set. */
12040 mark_window_display_accurate_1 (w
, 1);
12042 /* Say overlay arrows are up to date. */
12043 update_overlay_arrows (1);
12045 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12046 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12049 update_mode_lines
= 0;
12050 windows_or_buffers_changed
= 0;
12051 cursor_type_changed
= 0;
12054 /* Start SIGIO interrupts coming again. Having them off during the
12055 code above makes it less likely one will discard output, but not
12056 impossible, since there might be stuff in the system buffer here.
12057 But it is much hairier to try to do anything about that. */
12058 if (interrupt_input
)
12062 /* If a frame has become visible which was not before, redisplay
12063 again, so that we display it. Expose events for such a frame
12064 (which it gets when becoming visible) don't call the parts of
12065 redisplay constructing glyphs, so simply exposing a frame won't
12066 display anything in this case. So, we have to display these
12067 frames here explicitly. */
12070 Lisp_Object tail
, frame
;
12073 FOR_EACH_FRAME (tail
, frame
)
12075 int this_is_visible
= 0;
12077 if (XFRAME (frame
)->visible
)
12078 this_is_visible
= 1;
12079 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12080 if (XFRAME (frame
)->visible
)
12081 this_is_visible
= 1;
12083 if (this_is_visible
)
12087 if (new_count
!= number_of_visible_frames
)
12088 windows_or_buffers_changed
++;
12091 /* Change frame size now if a change is pending. */
12092 do_pending_window_change (1);
12094 /* If we just did a pending size change, or have additional
12095 visible frames, redisplay again. */
12096 if (windows_or_buffers_changed
&& !pause
)
12099 /* Clear the face and image caches.
12101 We used to do this only if consider_all_windows_p. But the cache
12102 needs to be cleared if a timer creates images in the current
12103 buffer (e.g. the test case in Bug#6230). */
12105 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12107 clear_face_cache (0);
12108 clear_face_cache_count
= 0;
12111 #ifdef HAVE_WINDOW_SYSTEM
12112 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12114 clear_image_caches (Qnil
);
12115 clear_image_cache_count
= 0;
12117 #endif /* HAVE_WINDOW_SYSTEM */
12120 unbind_to (count
, Qnil
);
12125 /* Redisplay, but leave alone any recent echo area message unless
12126 another message has been requested in its place.
12128 This is useful in situations where you need to redisplay but no
12129 user action has occurred, making it inappropriate for the message
12130 area to be cleared. See tracking_off and
12131 wait_reading_process_output for examples of these situations.
12133 FROM_WHERE is an integer saying from where this function was
12134 called. This is useful for debugging. */
12137 redisplay_preserve_echo_area (int from_where
)
12139 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12141 if (!NILP (echo_area_buffer
[1]))
12143 /* We have a previously displayed message, but no current
12144 message. Redisplay the previous message. */
12145 display_last_displayed_message_p
= 1;
12146 redisplay_internal (1);
12147 display_last_displayed_message_p
= 0;
12150 redisplay_internal (1);
12152 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12153 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12154 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12158 /* Function registered with record_unwind_protect in
12159 redisplay_internal. Reset redisplaying_p to the value it had
12160 before redisplay_internal was called, and clear
12161 prevent_freeing_realized_faces_p. It also selects the previously
12162 selected frame, unless it has been deleted (by an X connection
12163 failure during redisplay, for example). */
12166 unwind_redisplay (Lisp_Object val
)
12168 Lisp_Object old_redisplaying_p
, old_frame
;
12170 old_redisplaying_p
= XCAR (val
);
12171 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12172 old_frame
= XCDR (val
);
12173 if (! EQ (old_frame
, selected_frame
)
12174 && FRAME_LIVE_P (XFRAME (old_frame
)))
12175 select_frame_for_redisplay (old_frame
);
12180 /* Mark the display of window W as accurate or inaccurate. If
12181 ACCURATE_P is non-zero mark display of W as accurate. If
12182 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12183 redisplay_internal is called. */
12186 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12188 if (BUFFERP (w
->buffer
))
12190 struct buffer
*b
= XBUFFER (w
->buffer
);
12193 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12194 w
->last_overlay_modified
12195 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12197 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12201 b
->clip_changed
= 0;
12202 b
->prevent_redisplay_optimizations_p
= 0;
12204 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12205 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12206 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12207 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12209 w
->current_matrix
->buffer
= b
;
12210 w
->current_matrix
->begv
= BUF_BEGV (b
);
12211 w
->current_matrix
->zv
= BUF_ZV (b
);
12213 w
->last_cursor
= w
->cursor
;
12214 w
->last_cursor_off_p
= w
->cursor_off_p
;
12216 if (w
== XWINDOW (selected_window
))
12217 w
->last_point
= make_number (BUF_PT (b
));
12219 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12225 w
->window_end_valid
= w
->buffer
;
12226 w
->update_mode_line
= Qnil
;
12231 /* Mark the display of windows in the window tree rooted at WINDOW as
12232 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12233 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12234 be redisplayed the next time redisplay_internal is called. */
12237 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12241 for (; !NILP (window
); window
= w
->next
)
12243 w
= XWINDOW (window
);
12244 mark_window_display_accurate_1 (w
, accurate_p
);
12246 if (!NILP (w
->vchild
))
12247 mark_window_display_accurate (w
->vchild
, accurate_p
);
12248 if (!NILP (w
->hchild
))
12249 mark_window_display_accurate (w
->hchild
, accurate_p
);
12254 update_overlay_arrows (1);
12258 /* Force a thorough redisplay the next time by setting
12259 last_arrow_position and last_arrow_string to t, which is
12260 unequal to any useful value of Voverlay_arrow_... */
12261 update_overlay_arrows (-1);
12266 /* Return value in display table DP (Lisp_Char_Table *) for character
12267 C. Since a display table doesn't have any parent, we don't have to
12268 follow parent. Do not call this function directly but use the
12269 macro DISP_CHAR_VECTOR. */
12272 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12276 if (ASCII_CHAR_P (c
))
12279 if (SUB_CHAR_TABLE_P (val
))
12280 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12286 XSETCHAR_TABLE (table
, dp
);
12287 val
= char_table_ref (table
, c
);
12296 /***********************************************************************
12298 ***********************************************************************/
12300 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12303 redisplay_windows (Lisp_Object window
)
12305 while (!NILP (window
))
12307 struct window
*w
= XWINDOW (window
);
12309 if (!NILP (w
->hchild
))
12310 redisplay_windows (w
->hchild
);
12311 else if (!NILP (w
->vchild
))
12312 redisplay_windows (w
->vchild
);
12313 else if (!NILP (w
->buffer
))
12315 displayed_buffer
= XBUFFER (w
->buffer
);
12316 /* Use list_of_error, not Qerror, so that
12317 we catch only errors and don't run the debugger. */
12318 internal_condition_case_1 (redisplay_window_0
, window
,
12320 redisplay_window_error
);
12328 redisplay_window_error (Lisp_Object ignore
)
12330 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12335 redisplay_window_0 (Lisp_Object window
)
12337 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12338 redisplay_window (window
, 0);
12343 redisplay_window_1 (Lisp_Object window
)
12345 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12346 redisplay_window (window
, 1);
12351 /* Increment GLYPH until it reaches END or CONDITION fails while
12352 adding (GLYPH)->pixel_width to X. */
12354 #define SKIP_GLYPHS(glyph, end, x, condition) \
12357 (x) += (glyph)->pixel_width; \
12360 while ((glyph) < (end) && (condition))
12363 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12364 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12365 which positions recorded in ROW differ from current buffer
12368 Return 0 if cursor is not on this row, 1 otherwise. */
12371 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12372 struct glyph_matrix
*matrix
,
12373 EMACS_INT delta
, EMACS_INT delta_bytes
,
12376 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12377 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12378 struct glyph
*cursor
= NULL
;
12379 /* The last known character position in row. */
12380 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12382 EMACS_INT pt_old
= PT
- delta
;
12383 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12384 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12385 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12386 /* A glyph beyond the edge of TEXT_AREA which we should never
12388 struct glyph
*glyphs_end
= end
;
12389 /* Non-zero means we've found a match for cursor position, but that
12390 glyph has the avoid_cursor_p flag set. */
12391 int match_with_avoid_cursor
= 0;
12392 /* Non-zero means we've seen at least one glyph that came from a
12394 int string_seen
= 0;
12395 /* Largest and smalles buffer positions seen so far during scan of
12397 EMACS_INT bpos_max
= pos_before
;
12398 EMACS_INT bpos_min
= pos_after
;
12399 /* Last buffer position covered by an overlay string with an integer
12400 `cursor' property. */
12401 EMACS_INT bpos_covered
= 0;
12403 /* Skip over glyphs not having an object at the start and the end of
12404 the row. These are special glyphs like truncation marks on
12405 terminal frames. */
12406 if (row
->displays_text_p
)
12408 if (!row
->reversed_p
)
12411 && INTEGERP (glyph
->object
)
12412 && glyph
->charpos
< 0)
12414 x
+= glyph
->pixel_width
;
12418 && INTEGERP ((end
- 1)->object
)
12419 /* CHARPOS is zero for blanks and stretch glyphs
12420 inserted by extend_face_to_end_of_line. */
12421 && (end
- 1)->charpos
<= 0)
12423 glyph_before
= glyph
- 1;
12430 /* If the glyph row is reversed, we need to process it from back
12431 to front, so swap the edge pointers. */
12432 glyphs_end
= end
= glyph
- 1;
12433 glyph
+= row
->used
[TEXT_AREA
] - 1;
12435 while (glyph
> end
+ 1
12436 && INTEGERP (glyph
->object
)
12437 && glyph
->charpos
< 0)
12440 x
-= glyph
->pixel_width
;
12442 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12444 /* By default, in reversed rows we put the cursor on the
12445 rightmost (first in the reading order) glyph. */
12446 for (g
= end
+ 1; g
< glyph
; g
++)
12447 x
+= g
->pixel_width
;
12449 && INTEGERP ((end
+ 1)->object
)
12450 && (end
+ 1)->charpos
<= 0)
12452 glyph_before
= glyph
+ 1;
12456 else if (row
->reversed_p
)
12458 /* In R2L rows that don't display text, put the cursor on the
12459 rightmost glyph. Case in point: an empty last line that is
12460 part of an R2L paragraph. */
12462 /* Avoid placing the cursor on the last glyph of the row, where
12463 on terminal frames we hold the vertical border between
12464 adjacent windows. */
12465 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12466 && !WINDOW_RIGHTMOST_P (w
)
12467 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12469 x
= -1; /* will be computed below, at label compute_x */
12472 /* Step 1: Try to find the glyph whose character position
12473 corresponds to point. If that's not possible, find 2 glyphs
12474 whose character positions are the closest to point, one before
12475 point, the other after it. */
12476 if (!row
->reversed_p
)
12477 while (/* not marched to end of glyph row */
12479 /* glyph was not inserted by redisplay for internal purposes */
12480 && !INTEGERP (glyph
->object
))
12482 if (BUFFERP (glyph
->object
))
12484 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12486 if (glyph
->charpos
> bpos_max
)
12487 bpos_max
= glyph
->charpos
;
12488 if (glyph
->charpos
< bpos_min
)
12489 bpos_min
= glyph
->charpos
;
12490 if (!glyph
->avoid_cursor_p
)
12492 /* If we hit point, we've found the glyph on which to
12493 display the cursor. */
12496 match_with_avoid_cursor
= 0;
12499 /* See if we've found a better approximation to
12500 POS_BEFORE or to POS_AFTER. Note that we want the
12501 first (leftmost) glyph of all those that are the
12502 closest from below, and the last (rightmost) of all
12503 those from above. */
12504 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12506 pos_before
= glyph
->charpos
;
12507 glyph_before
= glyph
;
12509 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12511 pos_after
= glyph
->charpos
;
12512 glyph_after
= glyph
;
12515 else if (dpos
== 0)
12516 match_with_avoid_cursor
= 1;
12518 else if (STRINGP (glyph
->object
))
12520 Lisp_Object chprop
;
12521 EMACS_INT glyph_pos
= glyph
->charpos
;
12523 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12525 if (INTEGERP (chprop
))
12527 bpos_covered
= bpos_max
+ XINT (chprop
);
12528 /* If the `cursor' property covers buffer positions up
12529 to and including point, we should display cursor on
12530 this glyph. Note that overlays and text properties
12531 with string values stop bidi reordering, so every
12532 buffer position to the left of the string is always
12533 smaller than any position to the right of the
12534 string. Therefore, if a `cursor' property on one
12535 of the string's characters has an integer value, we
12536 will break out of the loop below _before_ we get to
12537 the position match above. IOW, integer values of
12538 the `cursor' property override the "exact match for
12539 point" strategy of positioning the cursor. */
12540 /* Implementation note: bpos_max == pt_old when, e.g.,
12541 we are in an empty line, where bpos_max is set to
12542 MATRIX_ROW_START_CHARPOS, see above. */
12543 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12552 x
+= glyph
->pixel_width
;
12555 else if (glyph
> end
) /* row is reversed */
12556 while (!INTEGERP (glyph
->object
))
12558 if (BUFFERP (glyph
->object
))
12560 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12562 if (glyph
->charpos
> bpos_max
)
12563 bpos_max
= glyph
->charpos
;
12564 if (glyph
->charpos
< bpos_min
)
12565 bpos_min
= glyph
->charpos
;
12566 if (!glyph
->avoid_cursor_p
)
12570 match_with_avoid_cursor
= 0;
12573 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12575 pos_before
= glyph
->charpos
;
12576 glyph_before
= glyph
;
12578 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12580 pos_after
= glyph
->charpos
;
12581 glyph_after
= glyph
;
12584 else if (dpos
== 0)
12585 match_with_avoid_cursor
= 1;
12587 else if (STRINGP (glyph
->object
))
12589 Lisp_Object chprop
;
12590 EMACS_INT glyph_pos
= glyph
->charpos
;
12592 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12594 if (INTEGERP (chprop
))
12596 bpos_covered
= bpos_max
+ XINT (chprop
);
12597 /* If the `cursor' property covers buffer positions up
12598 to and including point, we should display cursor on
12600 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12609 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12611 x
--; /* can't use any pixel_width */
12614 x
-= glyph
->pixel_width
;
12617 /* Step 2: If we didn't find an exact match for point, we need to
12618 look for a proper place to put the cursor among glyphs between
12619 GLYPH_BEFORE and GLYPH_AFTER. */
12620 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12621 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12622 && bpos_covered
< pt_old
)
12624 /* An empty line has a single glyph whose OBJECT is zero and
12625 whose CHARPOS is the position of a newline on that line.
12626 Note that on a TTY, there are more glyphs after that, which
12627 were produced by extend_face_to_end_of_line, but their
12628 CHARPOS is zero or negative. */
12630 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12631 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12633 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12635 EMACS_INT ellipsis_pos
;
12637 /* Scan back over the ellipsis glyphs. */
12638 if (!row
->reversed_p
)
12640 ellipsis_pos
= (glyph
- 1)->charpos
;
12641 while (glyph
> row
->glyphs
[TEXT_AREA
]
12642 && (glyph
- 1)->charpos
== ellipsis_pos
)
12643 glyph
--, x
-= glyph
->pixel_width
;
12644 /* That loop always goes one position too far, including
12645 the glyph before the ellipsis. So scan forward over
12647 x
+= glyph
->pixel_width
;
12650 else /* row is reversed */
12652 ellipsis_pos
= (glyph
+ 1)->charpos
;
12653 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12654 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12655 glyph
++, x
+= glyph
->pixel_width
;
12656 x
-= glyph
->pixel_width
;
12660 else if (match_with_avoid_cursor
12661 /* A truncated row may not include PT among its
12662 character positions. Setting the cursor inside the
12663 scroll margin will trigger recalculation of hscroll
12664 in hscroll_window_tree. */
12665 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12666 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12667 /* Zero-width characters produce no glyphs. */
12670 && (row
->reversed_p
12671 ? glyph_after
> glyphs_end
12672 : glyph_after
< glyphs_end
)))
12674 cursor
= glyph_after
;
12677 else if (string_seen
)
12679 int incr
= row
->reversed_p
? -1 : +1;
12681 /* Need to find the glyph that came out of a string which is
12682 present at point. That glyph is somewhere between
12683 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12684 positioned between POS_BEFORE and POS_AFTER in the
12686 struct glyph
*stop
= glyph_after
;
12687 EMACS_INT pos
= pos_before
;
12690 for (glyph
= glyph_before
+ incr
;
12691 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12694 /* Any glyphs that come from the buffer are here because
12695 of bidi reordering. Skip them, and only pay
12696 attention to glyphs that came from some string. */
12697 if (STRINGP (glyph
->object
))
12702 str
= glyph
->object
;
12703 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12704 if (tem
== 0 /* from overlay */
12707 /* If the string from which this glyph came is
12708 found in the buffer at point, then we've
12709 found the glyph we've been looking for. If
12710 it comes from an overlay (tem == 0), and it
12711 has the `cursor' property on one of its
12712 glyphs, record that glyph as a candidate for
12713 displaying the cursor. (As in the
12714 unidirectional version, we will display the
12715 cursor on the last candidate we find.) */
12716 if (tem
== 0 || tem
== pt_old
)
12718 /* The glyphs from this string could have
12719 been reordered. Find the one with the
12720 smallest string position. Or there could
12721 be a character in the string with the
12722 `cursor' property, which means display
12723 cursor on that character's glyph. */
12724 EMACS_INT strpos
= glyph
->charpos
;
12729 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12730 && EQ (glyph
->object
, str
);
12734 EMACS_INT gpos
= glyph
->charpos
;
12736 cprop
= Fget_char_property (make_number (gpos
),
12744 if (tem
&& glyph
->charpos
< strpos
)
12746 strpos
= glyph
->charpos
;
12755 pos
= tem
+ 1; /* don't find previous instances */
12757 /* This string is not what we want; skip all of the
12758 glyphs that came from it. */
12759 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12760 && EQ (glyph
->object
, str
))
12767 /* If we reached the end of the line, and END was from a string,
12768 the cursor is not on this line. */
12770 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12771 && STRINGP (end
->object
)
12772 && row
->continued_p
)
12778 if (cursor
!= NULL
)
12784 /* Need to compute x that corresponds to GLYPH. */
12785 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12787 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12789 x
+= g
->pixel_width
;
12793 /* ROW could be part of a continued line, which, under bidi
12794 reordering, might have other rows whose start and end charpos
12795 occlude point. Only set w->cursor if we found a better
12796 approximation to the cursor position than we have from previously
12797 examined candidate rows belonging to the same continued line. */
12798 if (/* we already have a candidate row */
12799 w
->cursor
.vpos
>= 0
12800 /* that candidate is not the row we are processing */
12801 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12802 /* the row we are processing is part of a continued line */
12803 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12804 /* Make sure cursor.vpos specifies a row whose start and end
12805 charpos occlude point. This is because some callers of this
12806 function leave cursor.vpos at the row where the cursor was
12807 displayed during the last redisplay cycle. */
12808 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12809 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12812 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12814 /* Don't consider glyphs that are outside TEXT_AREA. */
12815 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12817 /* Keep the candidate whose buffer position is the closest to
12819 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12820 w
->cursor
.hpos
>= 0
12821 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12822 && BUFFERP (g1
->object
)
12823 && (g1
->charpos
== pt_old
/* an exact match always wins */
12824 || (BUFFERP (glyph
->object
)
12825 && eabs (g1
->charpos
- pt_old
)
12826 < eabs (glyph
->charpos
- pt_old
))))
12828 /* If this candidate gives an exact match, use that. */
12829 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12830 /* Otherwise, keep the candidate that comes from a row
12831 spanning less buffer positions. This may win when one or
12832 both candidate positions are on glyphs that came from
12833 display strings, for which we cannot compare buffer
12835 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12836 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12837 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12840 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12842 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12843 w
->cursor
.y
= row
->y
+ dy
;
12845 if (w
== XWINDOW (selected_window
))
12847 if (!row
->continued_p
12848 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12851 this_line_buffer
= XBUFFER (w
->buffer
);
12853 CHARPOS (this_line_start_pos
)
12854 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12855 BYTEPOS (this_line_start_pos
)
12856 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12858 CHARPOS (this_line_end_pos
)
12859 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12860 BYTEPOS (this_line_end_pos
)
12861 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12863 this_line_y
= w
->cursor
.y
;
12864 this_line_pixel_height
= row
->height
;
12865 this_line_vpos
= w
->cursor
.vpos
;
12866 this_line_start_x
= row
->x
;
12869 CHARPOS (this_line_start_pos
) = 0;
12876 /* Run window scroll functions, if any, for WINDOW with new window
12877 start STARTP. Sets the window start of WINDOW to that position.
12879 We assume that the window's buffer is really current. */
12881 static INLINE
struct text_pos
12882 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12884 struct window
*w
= XWINDOW (window
);
12885 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12887 if (current_buffer
!= XBUFFER (w
->buffer
))
12890 if (!NILP (Vwindow_scroll_functions
))
12892 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12893 make_number (CHARPOS (startp
)));
12894 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12895 /* In case the hook functions switch buffers. */
12896 if (current_buffer
!= XBUFFER (w
->buffer
))
12897 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12904 /* Make sure the line containing the cursor is fully visible.
12905 A value of 1 means there is nothing to be done.
12906 (Either the line is fully visible, or it cannot be made so,
12907 or we cannot tell.)
12909 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12910 is higher than window.
12912 A value of 0 means the caller should do scrolling
12913 as if point had gone off the screen. */
12916 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12918 struct glyph_matrix
*matrix
;
12919 struct glyph_row
*row
;
12922 if (!make_cursor_line_fully_visible_p
)
12925 /* It's not always possible to find the cursor, e.g, when a window
12926 is full of overlay strings. Don't do anything in that case. */
12927 if (w
->cursor
.vpos
< 0)
12930 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12931 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12933 /* If the cursor row is not partially visible, there's nothing to do. */
12934 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12937 /* If the row the cursor is in is taller than the window's height,
12938 it's not clear what to do, so do nothing. */
12939 window_height
= window_box_height (w
);
12940 if (row
->height
>= window_height
)
12942 if (!force_p
|| MINI_WINDOW_P (w
)
12943 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12950 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12951 non-zero means only WINDOW is redisplayed in redisplay_internal.
12952 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
12953 in redisplay_window to bring a partially visible line into view in
12954 the case that only the cursor has moved.
12956 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12957 last screen line's vertical height extends past the end of the screen.
12961 1 if scrolling succeeded
12963 0 if scrolling didn't find point.
12965 -1 if new fonts have been loaded so that we must interrupt
12966 redisplay, adjust glyph matrices, and try again. */
12972 SCROLLING_NEED_LARGER_MATRICES
12976 try_scrolling (Lisp_Object window
, int just_this_one_p
,
12977 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
12978 int temp_scroll_step
, int last_line_misfit
)
12980 struct window
*w
= XWINDOW (window
);
12981 struct frame
*f
= XFRAME (w
->frame
);
12982 struct text_pos pos
, startp
;
12984 int this_scroll_margin
, scroll_max
, rc
, height
;
12985 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12986 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12987 Lisp_Object aggressive
;
12988 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12991 debug_method_add (w
, "try_scrolling");
12994 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12996 /* Compute scroll margin height in pixels. We scroll when point is
12997 within this distance from the top or bottom of the window. */
12998 if (scroll_margin
> 0)
12999 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13000 * FRAME_LINE_HEIGHT (f
);
13002 this_scroll_margin
= 0;
13004 /* Force arg_scroll_conservatively to have a reasonable value, to avoid
13005 overflow while computing how much to scroll. Note that the user
13006 can supply scroll-conservatively equal to `most-positive-fixnum',
13007 which can be larger than INT_MAX. */
13008 if (arg_scroll_conservatively
> scroll_limit
)
13010 arg_scroll_conservatively
= scroll_limit
;
13011 scroll_max
= INT_MAX
;
13013 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13014 /* Compute how much we should try to scroll maximally to bring
13015 point into view. */
13016 scroll_max
= (max (scroll_step
,
13017 max (arg_scroll_conservatively
, temp_scroll_step
))
13018 * FRAME_LINE_HEIGHT (f
));
13019 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13020 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13021 /* We're trying to scroll because of aggressive scrolling but no
13022 scroll_step is set. Choose an arbitrary one. */
13023 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13029 /* Decide whether to scroll down. */
13030 if (PT
> CHARPOS (startp
))
13032 int scroll_margin_y
;
13034 /* Compute the pixel ypos of the scroll margin, then move it to
13035 either that ypos or PT, whichever comes first. */
13036 start_display (&it
, w
, startp
);
13037 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13038 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13039 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13040 (MOVE_TO_POS
| MOVE_TO_Y
));
13042 if (PT
> CHARPOS (it
.current
.pos
))
13044 int y0
= line_bottom_y (&it
);
13045 /* Compute how many pixels below window bottom to stop searching
13046 for PT. This avoids costly search for PT that is far away if
13047 the user limited scrolling by a small number of lines, but
13048 always finds PT if arg_scroll_conservatively is set to a large
13049 number, such as most-positive-fixnum. */
13050 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13052 slack
>= INT_MAX
- it
.last_visible_y
13054 : it
.last_visible_y
+ slack
;
13056 /* Compute the distance from the scroll margin to PT or to
13057 the scroll limit, whichever comes first. This should
13058 include the height of the cursor line, to make that line
13060 move_it_to (&it
, PT
, -1, y_to_move
,
13061 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13062 dy
= line_bottom_y (&it
) - y0
;
13064 if (dy
> scroll_max
)
13065 return SCROLLING_FAILED
;
13073 /* Point is in or below the bottom scroll margin, so move the
13074 window start down. If scrolling conservatively, move it just
13075 enough down to make point visible. If scroll_step is set,
13076 move it down by scroll_step. */
13077 if (arg_scroll_conservatively
)
13079 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13080 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13081 else if (scroll_step
|| temp_scroll_step
)
13082 amount_to_scroll
= scroll_max
;
13085 aggressive
= current_buffer
->scroll_up_aggressively
;
13086 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13087 if (NUMBERP (aggressive
))
13089 double float_amount
= XFLOATINT (aggressive
) * height
;
13090 amount_to_scroll
= float_amount
;
13091 if (amount_to_scroll
== 0 && float_amount
> 0)
13092 amount_to_scroll
= 1;
13096 if (amount_to_scroll
<= 0)
13097 return SCROLLING_FAILED
;
13099 start_display (&it
, w
, startp
);
13100 if (scroll_max
< INT_MAX
)
13101 move_it_vertically (&it
, amount_to_scroll
);
13104 /* Extra precision for users who set scroll-conservatively
13105 to most-positive-fixnum: make sure the amount we scroll
13106 the window start is never less than amount_to_scroll,
13107 which was computed as distance from window bottom to
13108 point. This matters when lines at window top and lines
13109 below window bottom have different height. */
13110 struct it it1
= it
;
13111 /* We use a temporary it1 because line_bottom_y can modify
13112 its argument, if it moves one line down; see there. */
13113 int start_y
= line_bottom_y (&it1
);
13116 move_it_by_lines (&it
, 1, 1);
13118 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13121 /* If STARTP is unchanged, move it down another screen line. */
13122 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13123 move_it_by_lines (&it
, 1, 1);
13124 startp
= it
.current
.pos
;
13128 struct text_pos scroll_margin_pos
= startp
;
13130 /* See if point is inside the scroll margin at the top of the
13132 if (this_scroll_margin
)
13134 start_display (&it
, w
, startp
);
13135 move_it_vertically (&it
, this_scroll_margin
);
13136 scroll_margin_pos
= it
.current
.pos
;
13139 if (PT
< CHARPOS (scroll_margin_pos
))
13141 /* Point is in the scroll margin at the top of the window or
13142 above what is displayed in the window. */
13145 /* Compute the vertical distance from PT to the scroll
13146 margin position. Give up if distance is greater than
13148 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13149 start_display (&it
, w
, pos
);
13151 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13152 it
.last_visible_y
, -1,
13153 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13154 dy
= it
.current_y
- y0
;
13155 if (dy
> scroll_max
)
13156 return SCROLLING_FAILED
;
13158 /* Compute new window start. */
13159 start_display (&it
, w
, startp
);
13161 if (arg_scroll_conservatively
)
13163 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13164 else if (scroll_step
|| temp_scroll_step
)
13165 amount_to_scroll
= scroll_max
;
13168 aggressive
= current_buffer
->scroll_down_aggressively
;
13169 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13170 if (NUMBERP (aggressive
))
13172 double float_amount
= XFLOATINT (aggressive
) * height
;
13173 amount_to_scroll
= float_amount
;
13174 if (amount_to_scroll
== 0 && float_amount
> 0)
13175 amount_to_scroll
= 1;
13179 if (amount_to_scroll
<= 0)
13180 return SCROLLING_FAILED
;
13182 move_it_vertically_backward (&it
, amount_to_scroll
);
13183 startp
= it
.current
.pos
;
13187 /* Run window scroll functions. */
13188 startp
= run_window_scroll_functions (window
, startp
);
13190 /* Display the window. Give up if new fonts are loaded, or if point
13192 if (!try_window (window
, startp
, 0))
13193 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13194 else if (w
->cursor
.vpos
< 0)
13196 clear_glyph_matrix (w
->desired_matrix
);
13197 rc
= SCROLLING_FAILED
;
13201 /* Maybe forget recorded base line for line number display. */
13202 if (!just_this_one_p
13203 || current_buffer
->clip_changed
13204 || BEG_UNCHANGED
< CHARPOS (startp
))
13205 w
->base_line_number
= Qnil
;
13207 /* If cursor ends up on a partially visible line,
13208 treat that as being off the bottom of the screen. */
13209 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13210 /* It's possible that the cursor is on the first line of the
13211 buffer, which is partially obscured due to a vscroll
13212 (Bug#7537). In that case, avoid looping forever . */
13213 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13215 clear_glyph_matrix (w
->desired_matrix
);
13216 ++extra_scroll_margin_lines
;
13219 rc
= SCROLLING_SUCCESS
;
13226 /* Compute a suitable window start for window W if display of W starts
13227 on a continuation line. Value is non-zero if a new window start
13230 The new window start will be computed, based on W's width, starting
13231 from the start of the continued line. It is the start of the
13232 screen line with the minimum distance from the old start W->start. */
13235 compute_window_start_on_continuation_line (struct window
*w
)
13237 struct text_pos pos
, start_pos
;
13238 int window_start_changed_p
= 0;
13240 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13242 /* If window start is on a continuation line... Window start may be
13243 < BEGV in case there's invisible text at the start of the
13244 buffer (M-x rmail, for example). */
13245 if (CHARPOS (start_pos
) > BEGV
13246 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13249 struct glyph_row
*row
;
13251 /* Handle the case that the window start is out of range. */
13252 if (CHARPOS (start_pos
) < BEGV
)
13253 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13254 else if (CHARPOS (start_pos
) > ZV
)
13255 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13257 /* Find the start of the continued line. This should be fast
13258 because scan_buffer is fast (newline cache). */
13259 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13260 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13261 row
, DEFAULT_FACE_ID
);
13262 reseat_at_previous_visible_line_start (&it
);
13264 /* If the line start is "too far" away from the window start,
13265 say it takes too much time to compute a new window start. */
13266 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13267 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13269 int min_distance
, distance
;
13271 /* Move forward by display lines to find the new window
13272 start. If window width was enlarged, the new start can
13273 be expected to be > the old start. If window width was
13274 decreased, the new window start will be < the old start.
13275 So, we're looking for the display line start with the
13276 minimum distance from the old window start. */
13277 pos
= it
.current
.pos
;
13278 min_distance
= INFINITY
;
13279 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13280 distance
< min_distance
)
13282 min_distance
= distance
;
13283 pos
= it
.current
.pos
;
13284 move_it_by_lines (&it
, 1, 0);
13287 /* Set the window start there. */
13288 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13289 window_start_changed_p
= 1;
13293 return window_start_changed_p
;
13297 /* Try cursor movement in case text has not changed in window WINDOW,
13298 with window start STARTP. Value is
13300 CURSOR_MOVEMENT_SUCCESS if successful
13302 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13304 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13305 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13306 we want to scroll as if scroll-step were set to 1. See the code.
13308 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13309 which case we have to abort this redisplay, and adjust matrices
13314 CURSOR_MOVEMENT_SUCCESS
,
13315 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13316 CURSOR_MOVEMENT_MUST_SCROLL
,
13317 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13321 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13323 struct window
*w
= XWINDOW (window
);
13324 struct frame
*f
= XFRAME (w
->frame
);
13325 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13328 if (inhibit_try_cursor_movement
)
13332 /* Handle case where text has not changed, only point, and it has
13333 not moved off the frame. */
13334 if (/* Point may be in this window. */
13335 PT
>= CHARPOS (startp
)
13336 /* Selective display hasn't changed. */
13337 && !current_buffer
->clip_changed
13338 /* Function force-mode-line-update is used to force a thorough
13339 redisplay. It sets either windows_or_buffers_changed or
13340 update_mode_lines. So don't take a shortcut here for these
13342 && !update_mode_lines
13343 && !windows_or_buffers_changed
13344 && !cursor_type_changed
13345 /* Can't use this case if highlighting a region. When a
13346 region exists, cursor movement has to do more than just
13348 && !(!NILP (Vtransient_mark_mode
)
13349 && !NILP (current_buffer
->mark_active
))
13350 && NILP (w
->region_showing
)
13351 && NILP (Vshow_trailing_whitespace
)
13352 /* Right after splitting windows, last_point may be nil. */
13353 && INTEGERP (w
->last_point
)
13354 /* This code is not used for mini-buffer for the sake of the case
13355 of redisplaying to replace an echo area message; since in
13356 that case the mini-buffer contents per se are usually
13357 unchanged. This code is of no real use in the mini-buffer
13358 since the handling of this_line_start_pos, etc., in redisplay
13359 handles the same cases. */
13360 && !EQ (window
, minibuf_window
)
13361 /* When splitting windows or for new windows, it happens that
13362 redisplay is called with a nil window_end_vpos or one being
13363 larger than the window. This should really be fixed in
13364 window.c. I don't have this on my list, now, so we do
13365 approximately the same as the old redisplay code. --gerd. */
13366 && INTEGERP (w
->window_end_vpos
)
13367 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13368 && (FRAME_WINDOW_P (f
)
13369 || !overlay_arrow_in_current_buffer_p ()))
13371 int this_scroll_margin
, top_scroll_margin
;
13372 struct glyph_row
*row
= NULL
;
13375 debug_method_add (w
, "cursor movement");
13378 /* Scroll if point within this distance from the top or bottom
13379 of the window. This is a pixel value. */
13380 if (scroll_margin
> 0)
13382 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13383 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13386 this_scroll_margin
= 0;
13388 top_scroll_margin
= this_scroll_margin
;
13389 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13390 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13392 /* Start with the row the cursor was displayed during the last
13393 not paused redisplay. Give up if that row is not valid. */
13394 if (w
->last_cursor
.vpos
< 0
13395 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13396 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13399 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13400 if (row
->mode_line_p
)
13402 if (!row
->enabled_p
)
13403 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13406 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13408 int scroll_p
= 0, must_scroll
= 0;
13409 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13411 if (PT
> XFASTINT (w
->last_point
))
13413 /* Point has moved forward. */
13414 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13415 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13417 xassert (row
->enabled_p
);
13421 /* If the end position of a row equals the start
13422 position of the next row, and PT is at that position,
13423 we would rather display cursor in the next line. */
13424 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13425 && MATRIX_ROW_END_CHARPOS (row
) == PT
13426 && row
< w
->current_matrix
->rows
13427 + w
->current_matrix
->nrows
- 1
13428 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13429 && !cursor_row_p (w
, row
))
13432 /* If within the scroll margin, scroll. Note that
13433 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13434 the next line would be drawn, and that
13435 this_scroll_margin can be zero. */
13436 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13437 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13438 /* Line is completely visible last line in window
13439 and PT is to be set in the next line. */
13440 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13441 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13442 && !row
->ends_at_zv_p
13443 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13446 else if (PT
< XFASTINT (w
->last_point
))
13448 /* Cursor has to be moved backward. Note that PT >=
13449 CHARPOS (startp) because of the outer if-statement. */
13450 while (!row
->mode_line_p
13451 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13452 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13453 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13454 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13455 row
> w
->current_matrix
->rows
13456 && (row
-1)->ends_in_newline_from_string_p
))))
13457 && (row
->y
> top_scroll_margin
13458 || CHARPOS (startp
) == BEGV
))
13460 xassert (row
->enabled_p
);
13464 /* Consider the following case: Window starts at BEGV,
13465 there is invisible, intangible text at BEGV, so that
13466 display starts at some point START > BEGV. It can
13467 happen that we are called with PT somewhere between
13468 BEGV and START. Try to handle that case. */
13469 if (row
< w
->current_matrix
->rows
13470 || row
->mode_line_p
)
13472 row
= w
->current_matrix
->rows
;
13473 if (row
->mode_line_p
)
13477 /* Due to newlines in overlay strings, we may have to
13478 skip forward over overlay strings. */
13479 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13480 && MATRIX_ROW_END_CHARPOS (row
) == PT
13481 && !cursor_row_p (w
, row
))
13484 /* If within the scroll margin, scroll. */
13485 if (row
->y
< top_scroll_margin
13486 && CHARPOS (startp
) != BEGV
)
13491 /* Cursor did not move. So don't scroll even if cursor line
13492 is partially visible, as it was so before. */
13493 rc
= CURSOR_MOVEMENT_SUCCESS
;
13496 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13497 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13499 /* if PT is not in the glyph row, give up. */
13500 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13503 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13504 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13506 /* If rows are bidi-reordered and point moved, back up
13507 until we find a row that does not belong to a
13508 continuation line. This is because we must consider
13509 all rows of a continued line as candidates for the
13510 new cursor positioning, since row start and end
13511 positions change non-linearly with vertical position
13513 /* FIXME: Revisit this when glyph ``spilling'' in
13514 continuation lines' rows is implemented for
13515 bidi-reordered rows. */
13516 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13518 xassert (row
->enabled_p
);
13520 /* If we hit the beginning of the displayed portion
13521 without finding the first row of a continued
13523 if (row
<= w
->current_matrix
->rows
)
13525 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13533 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13534 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13535 && make_cursor_line_fully_visible_p
)
13537 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13538 && !row
->ends_at_zv_p
13539 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13540 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13541 else if (row
->height
> window_box_height (w
))
13543 /* If we end up in a partially visible line, let's
13544 make it fully visible, except when it's taller
13545 than the window, in which case we can't do much
13548 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13552 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13553 if (!cursor_row_fully_visible_p (w
, 0, 1))
13554 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13556 rc
= CURSOR_MOVEMENT_SUCCESS
;
13560 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13561 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13562 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13564 /* With bidi-reordered rows, there could be more than
13565 one candidate row whose start and end positions
13566 occlude point. We need to let set_cursor_from_row
13567 find the best candidate. */
13568 /* FIXME: Revisit this when glyph ``spilling'' in
13569 continuation lines' rows is implemented for
13570 bidi-reordered rows. */
13575 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13576 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13577 && cursor_row_p (w
, row
))
13578 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13580 /* As soon as we've found the first suitable row
13581 whose ends_at_zv_p flag is set, we are done. */
13583 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13585 rc
= CURSOR_MOVEMENT_SUCCESS
;
13590 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13591 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13592 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13593 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13594 /* If we didn't find any candidate rows, or exited the
13595 loop before all the candidates were examined, signal
13596 to the caller that this method failed. */
13597 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13598 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13599 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13601 rc
= CURSOR_MOVEMENT_SUCCESS
;
13607 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13609 rc
= CURSOR_MOVEMENT_SUCCESS
;
13614 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13615 && MATRIX_ROW_START_CHARPOS (row
) == PT
13616 && cursor_row_p (w
, row
));
13625 set_vertical_scroll_bar (struct window
*w
)
13627 EMACS_INT start
, end
, whole
;
13629 /* Calculate the start and end positions for the current window.
13630 At some point, it would be nice to choose between scrollbars
13631 which reflect the whole buffer size, with special markers
13632 indicating narrowing, and scrollbars which reflect only the
13635 Note that mini-buffers sometimes aren't displaying any text. */
13636 if (!MINI_WINDOW_P (w
)
13637 || (w
== XWINDOW (minibuf_window
)
13638 && NILP (echo_area_buffer
[0])))
13640 struct buffer
*buf
= XBUFFER (w
->buffer
);
13641 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13642 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13643 /* I don't think this is guaranteed to be right. For the
13644 moment, we'll pretend it is. */
13645 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13649 if (whole
< (end
- start
))
13650 whole
= end
- start
;
13653 start
= end
= whole
= 0;
13655 /* Indicate what this scroll bar ought to be displaying now. */
13656 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13657 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13658 (w
, end
- start
, whole
, start
);
13662 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13663 selected_window is redisplayed.
13665 We can return without actually redisplaying the window if
13666 fonts_changed_p is nonzero. In that case, redisplay_internal will
13670 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13672 struct window
*w
= XWINDOW (window
);
13673 struct frame
*f
= XFRAME (w
->frame
);
13674 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13675 struct buffer
*old
= current_buffer
;
13676 struct text_pos lpoint
, opoint
, startp
;
13677 int update_mode_line
;
13680 /* Record it now because it's overwritten. */
13681 int current_matrix_up_to_date_p
= 0;
13682 int used_current_matrix_p
= 0;
13683 /* This is less strict than current_matrix_up_to_date_p.
13684 It indictes that the buffer contents and narrowing are unchanged. */
13685 int buffer_unchanged_p
= 0;
13686 int temp_scroll_step
= 0;
13687 int count
= SPECPDL_INDEX ();
13689 int centering_position
= -1;
13690 int last_line_misfit
= 0;
13691 EMACS_INT beg_unchanged
, end_unchanged
;
13693 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13696 /* W must be a leaf window here. */
13697 xassert (!NILP (w
->buffer
));
13699 *w
->desired_matrix
->method
= 0;
13703 reconsider_clip_changes (w
, buffer
);
13705 /* Has the mode line to be updated? */
13706 update_mode_line
= (!NILP (w
->update_mode_line
)
13707 || update_mode_lines
13708 || buffer
->clip_changed
13709 || buffer
->prevent_redisplay_optimizations_p
);
13711 if (MINI_WINDOW_P (w
))
13713 if (w
== XWINDOW (echo_area_window
)
13714 && !NILP (echo_area_buffer
[0]))
13716 if (update_mode_line
)
13717 /* We may have to update a tty frame's menu bar or a
13718 tool-bar. Example `M-x C-h C-h C-g'. */
13719 goto finish_menu_bars
;
13721 /* We've already displayed the echo area glyphs in this window. */
13722 goto finish_scroll_bars
;
13724 else if ((w
!= XWINDOW (minibuf_window
)
13725 || minibuf_level
== 0)
13726 /* When buffer is nonempty, redisplay window normally. */
13727 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13728 /* Quail displays non-mini buffers in minibuffer window.
13729 In that case, redisplay the window normally. */
13730 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13732 /* W is a mini-buffer window, but it's not active, so clear
13734 int yb
= window_text_bottom_y (w
);
13735 struct glyph_row
*row
;
13738 for (y
= 0, row
= w
->desired_matrix
->rows
;
13740 y
+= row
->height
, ++row
)
13741 blank_row (w
, row
, y
);
13742 goto finish_scroll_bars
;
13745 clear_glyph_matrix (w
->desired_matrix
);
13748 /* Otherwise set up data on this window; select its buffer and point
13750 /* Really select the buffer, for the sake of buffer-local
13752 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13754 current_matrix_up_to_date_p
13755 = (!NILP (w
->window_end_valid
)
13756 && !current_buffer
->clip_changed
13757 && !current_buffer
->prevent_redisplay_optimizations_p
13758 && XFASTINT (w
->last_modified
) >= MODIFF
13759 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13761 /* Run the window-bottom-change-functions
13762 if it is possible that the text on the screen has changed
13763 (either due to modification of the text, or any other reason). */
13764 if (!current_matrix_up_to_date_p
13765 && !NILP (Vwindow_text_change_functions
))
13767 safe_run_hooks (Qwindow_text_change_functions
);
13771 beg_unchanged
= BEG_UNCHANGED
;
13772 end_unchanged
= END_UNCHANGED
;
13774 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13776 specbind (Qinhibit_point_motion_hooks
, Qt
);
13779 = (!NILP (w
->window_end_valid
)
13780 && !current_buffer
->clip_changed
13781 && XFASTINT (w
->last_modified
) >= MODIFF
13782 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13784 /* When windows_or_buffers_changed is non-zero, we can't rely on
13785 the window end being valid, so set it to nil there. */
13786 if (windows_or_buffers_changed
)
13788 /* If window starts on a continuation line, maybe adjust the
13789 window start in case the window's width changed. */
13790 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13791 compute_window_start_on_continuation_line (w
);
13793 w
->window_end_valid
= Qnil
;
13796 /* Some sanity checks. */
13797 CHECK_WINDOW_END (w
);
13798 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13800 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13803 /* If %c is in mode line, update it if needed. */
13804 if (!NILP (w
->column_number_displayed
)
13805 /* This alternative quickly identifies a common case
13806 where no change is needed. */
13807 && !(PT
== XFASTINT (w
->last_point
)
13808 && XFASTINT (w
->last_modified
) >= MODIFF
13809 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13810 && (XFASTINT (w
->column_number_displayed
)
13811 != (int) current_column ())) /* iftc */
13812 update_mode_line
= 1;
13814 /* Count number of windows showing the selected buffer. An indirect
13815 buffer counts as its base buffer. */
13816 if (!just_this_one_p
)
13818 struct buffer
*current_base
, *window_base
;
13819 current_base
= current_buffer
;
13820 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13821 if (current_base
->base_buffer
)
13822 current_base
= current_base
->base_buffer
;
13823 if (window_base
->base_buffer
)
13824 window_base
= window_base
->base_buffer
;
13825 if (current_base
== window_base
)
13829 /* Point refers normally to the selected window. For any other
13830 window, set up appropriate value. */
13831 if (!EQ (window
, selected_window
))
13833 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13834 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13838 new_pt_byte
= BEGV_BYTE
;
13839 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13841 else if (new_pt
> (ZV
- 1))
13844 new_pt_byte
= ZV_BYTE
;
13845 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13848 /* We don't use SET_PT so that the point-motion hooks don't run. */
13849 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13852 /* If any of the character widths specified in the display table
13853 have changed, invalidate the width run cache. It's true that
13854 this may be a bit late to catch such changes, but the rest of
13855 redisplay goes (non-fatally) haywire when the display table is
13856 changed, so why should we worry about doing any better? */
13857 if (current_buffer
->width_run_cache
)
13859 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13861 if (! disptab_matches_widthtab (disptab
,
13862 XVECTOR (current_buffer
->width_table
)))
13864 invalidate_region_cache (current_buffer
,
13865 current_buffer
->width_run_cache
,
13867 recompute_width_table (current_buffer
, disptab
);
13871 /* If window-start is screwed up, choose a new one. */
13872 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13875 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13877 /* If someone specified a new starting point but did not insist,
13878 check whether it can be used. */
13879 if (!NILP (w
->optional_new_start
)
13880 && CHARPOS (startp
) >= BEGV
13881 && CHARPOS (startp
) <= ZV
)
13883 w
->optional_new_start
= Qnil
;
13884 start_display (&it
, w
, startp
);
13885 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13886 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13887 if (IT_CHARPOS (it
) == PT
)
13888 w
->force_start
= Qt
;
13889 /* IT may overshoot PT if text at PT is invisible. */
13890 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13891 w
->force_start
= Qt
;
13896 /* Handle case where place to start displaying has been specified,
13897 unless the specified location is outside the accessible range. */
13898 if (!NILP (w
->force_start
)
13899 || w
->frozen_window_start_p
)
13901 /* We set this later on if we have to adjust point. */
13904 w
->force_start
= Qnil
;
13906 w
->window_end_valid
= Qnil
;
13908 /* Forget any recorded base line for line number display. */
13909 if (!buffer_unchanged_p
)
13910 w
->base_line_number
= Qnil
;
13912 /* Redisplay the mode line. Select the buffer properly for that.
13913 Also, run the hook window-scroll-functions
13914 because we have scrolled. */
13915 /* Note, we do this after clearing force_start because
13916 if there's an error, it is better to forget about force_start
13917 than to get into an infinite loop calling the hook functions
13918 and having them get more errors. */
13919 if (!update_mode_line
13920 || ! NILP (Vwindow_scroll_functions
))
13922 update_mode_line
= 1;
13923 w
->update_mode_line
= Qt
;
13924 startp
= run_window_scroll_functions (window
, startp
);
13927 w
->last_modified
= make_number (0);
13928 w
->last_overlay_modified
= make_number (0);
13929 if (CHARPOS (startp
) < BEGV
)
13930 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13931 else if (CHARPOS (startp
) > ZV
)
13932 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13934 /* Redisplay, then check if cursor has been set during the
13935 redisplay. Give up if new fonts were loaded. */
13936 /* We used to issue a CHECK_MARGINS argument to try_window here,
13937 but this causes scrolling to fail when point begins inside
13938 the scroll margin (bug#148) -- cyd */
13939 if (!try_window (window
, startp
, 0))
13941 w
->force_start
= Qt
;
13942 clear_glyph_matrix (w
->desired_matrix
);
13943 goto need_larger_matrices
;
13946 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13948 /* If point does not appear, try to move point so it does
13949 appear. The desired matrix has been built above, so we
13950 can use it here. */
13951 new_vpos
= window_box_height (w
) / 2;
13954 if (!cursor_row_fully_visible_p (w
, 0, 0))
13956 /* Point does appear, but on a line partly visible at end of window.
13957 Move it back to a fully-visible line. */
13958 new_vpos
= window_box_height (w
);
13961 /* If we need to move point for either of the above reasons,
13962 now actually do it. */
13965 struct glyph_row
*row
;
13967 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13968 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13971 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13972 MATRIX_ROW_START_BYTEPOS (row
));
13974 if (w
!= XWINDOW (selected_window
))
13975 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13976 else if (current_buffer
== old
)
13977 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13979 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13981 /* If we are highlighting the region, then we just changed
13982 the region, so redisplay to show it. */
13983 if (!NILP (Vtransient_mark_mode
)
13984 && !NILP (current_buffer
->mark_active
))
13986 clear_glyph_matrix (w
->desired_matrix
);
13987 if (!try_window (window
, startp
, 0))
13988 goto need_larger_matrices
;
13993 debug_method_add (w
, "forced window start");
13998 /* Handle case where text has not changed, only point, and it has
13999 not moved off the frame, and we are not retrying after hscroll.
14000 (current_matrix_up_to_date_p is nonzero when retrying.) */
14001 if (current_matrix_up_to_date_p
14002 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14003 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14007 case CURSOR_MOVEMENT_SUCCESS
:
14008 used_current_matrix_p
= 1;
14011 case CURSOR_MOVEMENT_MUST_SCROLL
:
14012 goto try_to_scroll
;
14018 /* If current starting point was originally the beginning of a line
14019 but no longer is, find a new starting point. */
14020 else if (!NILP (w
->start_at_line_beg
)
14021 && !(CHARPOS (startp
) <= BEGV
14022 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14025 debug_method_add (w
, "recenter 1");
14030 /* Try scrolling with try_window_id. Value is > 0 if update has
14031 been done, it is -1 if we know that the same window start will
14032 not work. It is 0 if unsuccessful for some other reason. */
14033 else if ((tem
= try_window_id (w
)) != 0)
14036 debug_method_add (w
, "try_window_id %d", tem
);
14039 if (fonts_changed_p
)
14040 goto need_larger_matrices
;
14044 /* Otherwise try_window_id has returned -1 which means that we
14045 don't want the alternative below this comment to execute. */
14047 else if (CHARPOS (startp
) >= BEGV
14048 && CHARPOS (startp
) <= ZV
14049 && PT
>= CHARPOS (startp
)
14050 && (CHARPOS (startp
) < ZV
14051 /* Avoid starting at end of buffer. */
14052 || CHARPOS (startp
) == BEGV
14053 || (XFASTINT (w
->last_modified
) >= MODIFF
14054 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14057 /* If first window line is a continuation line, and window start
14058 is inside the modified region, but the first change is before
14059 current window start, we must select a new window start.
14061 However, if this is the result of a down-mouse event (e.g. by
14062 extending the mouse-drag-overlay), we don't want to select a
14063 new window start, since that would change the position under
14064 the mouse, resulting in an unwanted mouse-movement rather
14065 than a simple mouse-click. */
14066 if (NILP (w
->start_at_line_beg
)
14067 && NILP (do_mouse_tracking
)
14068 && CHARPOS (startp
) > BEGV
14069 && CHARPOS (startp
) > BEG
+ beg_unchanged
14070 && CHARPOS (startp
) <= Z
- end_unchanged
14071 /* Even if w->start_at_line_beg is nil, a new window may
14072 start at a line_beg, since that's how set_buffer_window
14073 sets it. So, we need to check the return value of
14074 compute_window_start_on_continuation_line. (See also
14076 && XMARKER (w
->start
)->buffer
== current_buffer
14077 && compute_window_start_on_continuation_line (w
))
14079 w
->force_start
= Qt
;
14080 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14085 debug_method_add (w
, "same window start");
14088 /* Try to redisplay starting at same place as before.
14089 If point has not moved off frame, accept the results. */
14090 if (!current_matrix_up_to_date_p
14091 /* Don't use try_window_reusing_current_matrix in this case
14092 because a window scroll function can have changed the
14094 || !NILP (Vwindow_scroll_functions
)
14095 || MINI_WINDOW_P (w
)
14096 || !(used_current_matrix_p
14097 = try_window_reusing_current_matrix (w
)))
14099 IF_DEBUG (debug_method_add (w
, "1"));
14100 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14101 /* -1 means we need to scroll.
14102 0 means we need new matrices, but fonts_changed_p
14103 is set in that case, so we will detect it below. */
14104 goto try_to_scroll
;
14107 if (fonts_changed_p
)
14108 goto need_larger_matrices
;
14110 if (w
->cursor
.vpos
>= 0)
14112 if (!just_this_one_p
14113 || current_buffer
->clip_changed
14114 || BEG_UNCHANGED
< CHARPOS (startp
))
14115 /* Forget any recorded base line for line number display. */
14116 w
->base_line_number
= Qnil
;
14118 if (!cursor_row_fully_visible_p (w
, 1, 0))
14120 clear_glyph_matrix (w
->desired_matrix
);
14121 last_line_misfit
= 1;
14123 /* Drop through and scroll. */
14128 clear_glyph_matrix (w
->desired_matrix
);
14133 w
->last_modified
= make_number (0);
14134 w
->last_overlay_modified
= make_number (0);
14136 /* Redisplay the mode line. Select the buffer properly for that. */
14137 if (!update_mode_line
)
14139 update_mode_line
= 1;
14140 w
->update_mode_line
= Qt
;
14143 /* Try to scroll by specified few lines. */
14144 if ((scroll_conservatively
14145 || emacs_scroll_step
14146 || temp_scroll_step
14147 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14148 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14149 && !current_buffer
->clip_changed
14150 && CHARPOS (startp
) >= BEGV
14151 && CHARPOS (startp
) <= ZV
)
14153 /* The function returns -1 if new fonts were loaded, 1 if
14154 successful, 0 if not successful. */
14155 int rc
= try_scrolling (window
, just_this_one_p
,
14156 scroll_conservatively
,
14158 temp_scroll_step
, last_line_misfit
);
14161 case SCROLLING_SUCCESS
:
14164 case SCROLLING_NEED_LARGER_MATRICES
:
14165 goto need_larger_matrices
;
14167 case SCROLLING_FAILED
:
14175 /* Finally, just choose place to start which centers point */
14178 if (centering_position
< 0)
14179 centering_position
= window_box_height (w
) / 2;
14182 debug_method_add (w
, "recenter");
14185 /* w->vscroll = 0; */
14187 /* Forget any previously recorded base line for line number display. */
14188 if (!buffer_unchanged_p
)
14189 w
->base_line_number
= Qnil
;
14191 /* Move backward half the height of the window. */
14192 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14193 it
.current_y
= it
.last_visible_y
;
14194 move_it_vertically_backward (&it
, centering_position
);
14195 xassert (IT_CHARPOS (it
) >= BEGV
);
14197 /* The function move_it_vertically_backward may move over more
14198 than the specified y-distance. If it->w is small, e.g. a
14199 mini-buffer window, we may end up in front of the window's
14200 display area. Start displaying at the start of the line
14201 containing PT in this case. */
14202 if (it
.current_y
<= 0)
14204 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14205 move_it_vertically_backward (&it
, 0);
14209 it
.current_x
= it
.hpos
= 0;
14211 /* Set startp here explicitly in case that helps avoid an infinite loop
14212 in case the window-scroll-functions functions get errors. */
14213 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14215 /* Run scroll hooks. */
14216 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14218 /* Redisplay the window. */
14219 if (!current_matrix_up_to_date_p
14220 || windows_or_buffers_changed
14221 || cursor_type_changed
14222 /* Don't use try_window_reusing_current_matrix in this case
14223 because it can have changed the buffer. */
14224 || !NILP (Vwindow_scroll_functions
)
14225 || !just_this_one_p
14226 || MINI_WINDOW_P (w
)
14227 || !(used_current_matrix_p
14228 = try_window_reusing_current_matrix (w
)))
14229 try_window (window
, startp
, 0);
14231 /* If new fonts have been loaded (due to fontsets), give up. We
14232 have to start a new redisplay since we need to re-adjust glyph
14234 if (fonts_changed_p
)
14235 goto need_larger_matrices
;
14237 /* If cursor did not appear assume that the middle of the window is
14238 in the first line of the window. Do it again with the next line.
14239 (Imagine a window of height 100, displaying two lines of height
14240 60. Moving back 50 from it->last_visible_y will end in the first
14242 if (w
->cursor
.vpos
< 0)
14244 if (!NILP (w
->window_end_valid
)
14245 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14247 clear_glyph_matrix (w
->desired_matrix
);
14248 move_it_by_lines (&it
, 1, 0);
14249 try_window (window
, it
.current
.pos
, 0);
14251 else if (PT
< IT_CHARPOS (it
))
14253 clear_glyph_matrix (w
->desired_matrix
);
14254 move_it_by_lines (&it
, -1, 0);
14255 try_window (window
, it
.current
.pos
, 0);
14259 /* Not much we can do about it. */
14263 /* Consider the following case: Window starts at BEGV, there is
14264 invisible, intangible text at BEGV, so that display starts at
14265 some point START > BEGV. It can happen that we are called with
14266 PT somewhere between BEGV and START. Try to handle that case. */
14267 if (w
->cursor
.vpos
< 0)
14269 struct glyph_row
*row
= w
->current_matrix
->rows
;
14270 if (row
->mode_line_p
)
14272 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14275 if (!cursor_row_fully_visible_p (w
, 0, 0))
14277 /* If vscroll is enabled, disable it and try again. */
14281 clear_glyph_matrix (w
->desired_matrix
);
14285 /* If centering point failed to make the whole line visible,
14286 put point at the top instead. That has to make the whole line
14287 visible, if it can be done. */
14288 if (centering_position
== 0)
14291 clear_glyph_matrix (w
->desired_matrix
);
14292 centering_position
= 0;
14298 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14299 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14300 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14303 /* Display the mode line, if we must. */
14304 if ((update_mode_line
14305 /* If window not full width, must redo its mode line
14306 if (a) the window to its side is being redone and
14307 (b) we do a frame-based redisplay. This is a consequence
14308 of how inverted lines are drawn in frame-based redisplay. */
14309 || (!just_this_one_p
14310 && !FRAME_WINDOW_P (f
)
14311 && !WINDOW_FULL_WIDTH_P (w
))
14312 /* Line number to display. */
14313 || INTEGERP (w
->base_line_pos
)
14314 /* Column number is displayed and different from the one displayed. */
14315 || (!NILP (w
->column_number_displayed
)
14316 && (XFASTINT (w
->column_number_displayed
)
14317 != (int) current_column ()))) /* iftc */
14318 /* This means that the window has a mode line. */
14319 && (WINDOW_WANTS_MODELINE_P (w
)
14320 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14322 display_mode_lines (w
);
14324 /* If mode line height has changed, arrange for a thorough
14325 immediate redisplay using the correct mode line height. */
14326 if (WINDOW_WANTS_MODELINE_P (w
)
14327 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14329 fonts_changed_p
= 1;
14330 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14331 = DESIRED_MODE_LINE_HEIGHT (w
);
14334 /* If header line height has changed, arrange for a thorough
14335 immediate redisplay using the correct header line height. */
14336 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14337 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14339 fonts_changed_p
= 1;
14340 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14341 = DESIRED_HEADER_LINE_HEIGHT (w
);
14344 if (fonts_changed_p
)
14345 goto need_larger_matrices
;
14348 if (!line_number_displayed
14349 && !BUFFERP (w
->base_line_pos
))
14351 w
->base_line_pos
= Qnil
;
14352 w
->base_line_number
= Qnil
;
14357 /* When we reach a frame's selected window, redo the frame's menu bar. */
14358 if (update_mode_line
14359 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14361 int redisplay_menu_p
= 0;
14362 int redisplay_tool_bar_p
= 0;
14364 if (FRAME_WINDOW_P (f
))
14366 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14367 || defined (HAVE_NS) || defined (USE_GTK)
14368 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14370 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14374 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14376 if (redisplay_menu_p
)
14377 display_menu_bar (w
);
14379 #ifdef HAVE_WINDOW_SYSTEM
14380 if (FRAME_WINDOW_P (f
))
14382 #if defined (USE_GTK) || defined (HAVE_NS)
14383 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14385 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14386 && (FRAME_TOOL_BAR_LINES (f
) > 0
14387 || !NILP (Vauto_resize_tool_bars
));
14390 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14392 ignore_mouse_drag_p
= 1;
14398 #ifdef HAVE_WINDOW_SYSTEM
14399 if (FRAME_WINDOW_P (f
)
14400 && update_window_fringes (w
, (just_this_one_p
14401 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14402 || w
->pseudo_window_p
)))
14406 if (draw_window_fringes (w
, 1))
14407 x_draw_vertical_border (w
);
14411 #endif /* HAVE_WINDOW_SYSTEM */
14413 /* We go to this label, with fonts_changed_p nonzero,
14414 if it is necessary to try again using larger glyph matrices.
14415 We have to redeem the scroll bar even in this case,
14416 because the loop in redisplay_internal expects that. */
14417 need_larger_matrices
:
14419 finish_scroll_bars
:
14421 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14423 /* Set the thumb's position and size. */
14424 set_vertical_scroll_bar (w
);
14426 /* Note that we actually used the scroll bar attached to this
14427 window, so it shouldn't be deleted at the end of redisplay. */
14428 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14429 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14432 /* Restore current_buffer and value of point in it. The window
14433 update may have changed the buffer, so first make sure `opoint'
14434 is still valid (Bug#6177). */
14435 if (CHARPOS (opoint
) < BEGV
)
14436 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14437 else if (CHARPOS (opoint
) > ZV
)
14438 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14440 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14442 set_buffer_internal_1 (old
);
14443 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14444 shorter. This can be caused by log truncation in *Messages*. */
14445 if (CHARPOS (lpoint
) <= ZV
)
14446 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14448 unbind_to (count
, Qnil
);
14452 /* Build the complete desired matrix of WINDOW with a window start
14453 buffer position POS.
14455 Value is 1 if successful. It is zero if fonts were loaded during
14456 redisplay which makes re-adjusting glyph matrices necessary, and -1
14457 if point would appear in the scroll margins.
14458 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14459 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14463 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14465 struct window
*w
= XWINDOW (window
);
14467 struct glyph_row
*last_text_row
= NULL
;
14468 struct frame
*f
= XFRAME (w
->frame
);
14470 /* Make POS the new window start. */
14471 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14473 /* Mark cursor position as unknown. No overlay arrow seen. */
14474 w
->cursor
.vpos
= -1;
14475 overlay_arrow_seen
= 0;
14477 /* Initialize iterator and info to start at POS. */
14478 start_display (&it
, w
, pos
);
14480 /* Display all lines of W. */
14481 while (it
.current_y
< it
.last_visible_y
)
14483 if (display_line (&it
))
14484 last_text_row
= it
.glyph_row
- 1;
14485 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14489 /* Don't let the cursor end in the scroll margins. */
14490 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14491 && !MINI_WINDOW_P (w
))
14493 int this_scroll_margin
;
14495 if (scroll_margin
> 0)
14497 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14498 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14501 this_scroll_margin
= 0;
14503 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14504 && w
->cursor
.y
< this_scroll_margin
14505 && CHARPOS (pos
) > BEGV
14506 && IT_CHARPOS (it
) < ZV
)
14507 /* rms: considering make_cursor_line_fully_visible_p here
14508 seems to give wrong results. We don't want to recenter
14509 when the last line is partly visible, we want to allow
14510 that case to be handled in the usual way. */
14511 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14513 w
->cursor
.vpos
= -1;
14514 clear_glyph_matrix (w
->desired_matrix
);
14519 /* If bottom moved off end of frame, change mode line percentage. */
14520 if (XFASTINT (w
->window_end_pos
) <= 0
14521 && Z
!= IT_CHARPOS (it
))
14522 w
->update_mode_line
= Qt
;
14524 /* Set window_end_pos to the offset of the last character displayed
14525 on the window from the end of current_buffer. Set
14526 window_end_vpos to its row number. */
14529 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14530 w
->window_end_bytepos
14531 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14533 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14535 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14536 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14537 ->displays_text_p
);
14541 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14542 w
->window_end_pos
= make_number (Z
- ZV
);
14543 w
->window_end_vpos
= make_number (0);
14546 /* But that is not valid info until redisplay finishes. */
14547 w
->window_end_valid
= Qnil
;
14553 /************************************************************************
14554 Window redisplay reusing current matrix when buffer has not changed
14555 ************************************************************************/
14557 /* Try redisplay of window W showing an unchanged buffer with a
14558 different window start than the last time it was displayed by
14559 reusing its current matrix. Value is non-zero if successful.
14560 W->start is the new window start. */
14563 try_window_reusing_current_matrix (struct window
*w
)
14565 struct frame
*f
= XFRAME (w
->frame
);
14566 struct glyph_row
*row
, *bottom_row
;
14569 struct text_pos start
, new_start
;
14570 int nrows_scrolled
, i
;
14571 struct glyph_row
*last_text_row
;
14572 struct glyph_row
*last_reused_text_row
;
14573 struct glyph_row
*start_row
;
14574 int start_vpos
, min_y
, max_y
;
14577 if (inhibit_try_window_reusing
)
14581 if (/* This function doesn't handle terminal frames. */
14582 !FRAME_WINDOW_P (f
)
14583 /* Don't try to reuse the display if windows have been split
14585 || windows_or_buffers_changed
14586 || cursor_type_changed
)
14589 /* Can't do this if region may have changed. */
14590 if ((!NILP (Vtransient_mark_mode
)
14591 && !NILP (current_buffer
->mark_active
))
14592 || !NILP (w
->region_showing
)
14593 || !NILP (Vshow_trailing_whitespace
))
14596 /* If top-line visibility has changed, give up. */
14597 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14598 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14601 /* Give up if old or new display is scrolled vertically. We could
14602 make this function handle this, but right now it doesn't. */
14603 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14604 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14607 /* The variable new_start now holds the new window start. The old
14608 start `start' can be determined from the current matrix. */
14609 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14610 start
= start_row
->minpos
;
14611 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14613 /* Clear the desired matrix for the display below. */
14614 clear_glyph_matrix (w
->desired_matrix
);
14616 if (CHARPOS (new_start
) <= CHARPOS (start
))
14620 /* Don't use this method if the display starts with an ellipsis
14621 displayed for invisible text. It's not easy to handle that case
14622 below, and it's certainly not worth the effort since this is
14623 not a frequent case. */
14624 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14627 IF_DEBUG (debug_method_add (w
, "twu1"));
14629 /* Display up to a row that can be reused. The variable
14630 last_text_row is set to the last row displayed that displays
14631 text. Note that it.vpos == 0 if or if not there is a
14632 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14633 start_display (&it
, w
, new_start
);
14634 first_row_y
= it
.current_y
;
14635 w
->cursor
.vpos
= -1;
14636 last_text_row
= last_reused_text_row
= NULL
;
14638 while (it
.current_y
< it
.last_visible_y
14639 && !fonts_changed_p
)
14641 /* If we have reached into the characters in the START row,
14642 that means the line boundaries have changed. So we
14643 can't start copying with the row START. Maybe it will
14644 work to start copying with the following row. */
14645 while (IT_CHARPOS (it
) > CHARPOS (start
))
14647 /* Advance to the next row as the "start". */
14649 start
= start_row
->minpos
;
14650 /* If there are no more rows to try, or just one, give up. */
14651 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14652 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14653 || CHARPOS (start
) == ZV
)
14655 clear_glyph_matrix (w
->desired_matrix
);
14659 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14661 /* If we have reached alignment,
14662 we can copy the rest of the rows. */
14663 if (IT_CHARPOS (it
) == CHARPOS (start
))
14666 if (display_line (&it
))
14667 last_text_row
= it
.glyph_row
- 1;
14670 /* A value of current_y < last_visible_y means that we stopped
14671 at the previous window start, which in turn means that we
14672 have at least one reusable row. */
14673 if (it
.current_y
< it
.last_visible_y
)
14675 /* IT.vpos always starts from 0; it counts text lines. */
14676 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14678 /* Find PT if not already found in the lines displayed. */
14679 if (w
->cursor
.vpos
< 0)
14681 int dy
= it
.current_y
- start_row
->y
;
14683 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14684 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14686 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14687 dy
, nrows_scrolled
);
14690 clear_glyph_matrix (w
->desired_matrix
);
14695 /* Scroll the display. Do it before the current matrix is
14696 changed. The problem here is that update has not yet
14697 run, i.e. part of the current matrix is not up to date.
14698 scroll_run_hook will clear the cursor, and use the
14699 current matrix to get the height of the row the cursor is
14701 run
.current_y
= start_row
->y
;
14702 run
.desired_y
= it
.current_y
;
14703 run
.height
= it
.last_visible_y
- it
.current_y
;
14705 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14708 FRAME_RIF (f
)->update_window_begin_hook (w
);
14709 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14710 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14711 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14715 /* Shift current matrix down by nrows_scrolled lines. */
14716 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14717 rotate_matrix (w
->current_matrix
,
14719 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14722 /* Disable lines that must be updated. */
14723 for (i
= 0; i
< nrows_scrolled
; ++i
)
14724 (start_row
+ i
)->enabled_p
= 0;
14726 /* Re-compute Y positions. */
14727 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14728 max_y
= it
.last_visible_y
;
14729 for (row
= start_row
+ nrows_scrolled
;
14733 row
->y
= it
.current_y
;
14734 row
->visible_height
= row
->height
;
14736 if (row
->y
< min_y
)
14737 row
->visible_height
-= min_y
- row
->y
;
14738 if (row
->y
+ row
->height
> max_y
)
14739 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14740 row
->redraw_fringe_bitmaps_p
= 1;
14742 it
.current_y
+= row
->height
;
14744 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14745 last_reused_text_row
= row
;
14746 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14750 /* Disable lines in the current matrix which are now
14751 below the window. */
14752 for (++row
; row
< bottom_row
; ++row
)
14753 row
->enabled_p
= row
->mode_line_p
= 0;
14756 /* Update window_end_pos etc.; last_reused_text_row is the last
14757 reused row from the current matrix containing text, if any.
14758 The value of last_text_row is the last displayed line
14759 containing text. */
14760 if (last_reused_text_row
)
14762 w
->window_end_bytepos
14763 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14765 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14767 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14768 w
->current_matrix
));
14770 else if (last_text_row
)
14772 w
->window_end_bytepos
14773 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14775 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14777 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14781 /* This window must be completely empty. */
14782 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14783 w
->window_end_pos
= make_number (Z
- ZV
);
14784 w
->window_end_vpos
= make_number (0);
14786 w
->window_end_valid
= Qnil
;
14788 /* Update hint: don't try scrolling again in update_window. */
14789 w
->desired_matrix
->no_scrolling_p
= 1;
14792 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14796 else if (CHARPOS (new_start
) > CHARPOS (start
))
14798 struct glyph_row
*pt_row
, *row
;
14799 struct glyph_row
*first_reusable_row
;
14800 struct glyph_row
*first_row_to_display
;
14802 int yb
= window_text_bottom_y (w
);
14804 /* Find the row starting at new_start, if there is one. Don't
14805 reuse a partially visible line at the end. */
14806 first_reusable_row
= start_row
;
14807 while (first_reusable_row
->enabled_p
14808 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14809 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14810 < CHARPOS (new_start
)))
14811 ++first_reusable_row
;
14813 /* Give up if there is no row to reuse. */
14814 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14815 || !first_reusable_row
->enabled_p
14816 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14817 != CHARPOS (new_start
)))
14820 /* We can reuse fully visible rows beginning with
14821 first_reusable_row to the end of the window. Set
14822 first_row_to_display to the first row that cannot be reused.
14823 Set pt_row to the row containing point, if there is any. */
14825 for (first_row_to_display
= first_reusable_row
;
14826 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14827 ++first_row_to_display
)
14829 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14830 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14831 pt_row
= first_row_to_display
;
14834 /* Start displaying at the start of first_row_to_display. */
14835 xassert (first_row_to_display
->y
< yb
);
14836 init_to_row_start (&it
, w
, first_row_to_display
);
14838 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14840 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14842 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14843 + WINDOW_HEADER_LINE_HEIGHT (w
));
14845 /* Display lines beginning with first_row_to_display in the
14846 desired matrix. Set last_text_row to the last row displayed
14847 that displays text. */
14848 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14849 if (pt_row
== NULL
)
14850 w
->cursor
.vpos
= -1;
14851 last_text_row
= NULL
;
14852 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14853 if (display_line (&it
))
14854 last_text_row
= it
.glyph_row
- 1;
14856 /* If point is in a reused row, adjust y and vpos of the cursor
14860 w
->cursor
.vpos
-= nrows_scrolled
;
14861 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14864 /* Give up if point isn't in a row displayed or reused. (This
14865 also handles the case where w->cursor.vpos < nrows_scrolled
14866 after the calls to display_line, which can happen with scroll
14867 margins. See bug#1295.) */
14868 if (w
->cursor
.vpos
< 0)
14870 clear_glyph_matrix (w
->desired_matrix
);
14874 /* Scroll the display. */
14875 run
.current_y
= first_reusable_row
->y
;
14876 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14877 run
.height
= it
.last_visible_y
- run
.current_y
;
14878 dy
= run
.current_y
- run
.desired_y
;
14883 FRAME_RIF (f
)->update_window_begin_hook (w
);
14884 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14885 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14886 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14890 /* Adjust Y positions of reused rows. */
14891 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14892 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14893 max_y
= it
.last_visible_y
;
14894 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14897 row
->visible_height
= row
->height
;
14898 if (row
->y
< min_y
)
14899 row
->visible_height
-= min_y
- row
->y
;
14900 if (row
->y
+ row
->height
> max_y
)
14901 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14902 row
->redraw_fringe_bitmaps_p
= 1;
14905 /* Scroll the current matrix. */
14906 xassert (nrows_scrolled
> 0);
14907 rotate_matrix (w
->current_matrix
,
14909 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14912 /* Disable rows not reused. */
14913 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14914 row
->enabled_p
= 0;
14916 /* Point may have moved to a different line, so we cannot assume that
14917 the previous cursor position is valid; locate the correct row. */
14920 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14921 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14925 w
->cursor
.y
= row
->y
;
14927 if (row
< bottom_row
)
14929 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14930 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14932 /* Can't use this optimization with bidi-reordered glyph
14933 rows, unless cursor is already at point. */
14934 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
14936 if (!(w
->cursor
.hpos
>= 0
14937 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
14938 && BUFFERP (glyph
->object
)
14939 && glyph
->charpos
== PT
))
14944 && (!BUFFERP (glyph
->object
)
14945 || glyph
->charpos
< PT
);
14949 w
->cursor
.x
+= glyph
->pixel_width
;
14954 /* Adjust window end. A null value of last_text_row means that
14955 the window end is in reused rows which in turn means that
14956 only its vpos can have changed. */
14959 w
->window_end_bytepos
14960 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14962 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14964 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14969 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14972 w
->window_end_valid
= Qnil
;
14973 w
->desired_matrix
->no_scrolling_p
= 1;
14976 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14986 /************************************************************************
14987 Window redisplay reusing current matrix when buffer has changed
14988 ************************************************************************/
14990 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
14991 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
14992 EMACS_INT
*, EMACS_INT
*);
14993 static struct glyph_row
*
14994 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
14995 struct glyph_row
*);
14998 /* Return the last row in MATRIX displaying text. If row START is
14999 non-null, start searching with that row. IT gives the dimensions
15000 of the display. Value is null if matrix is empty; otherwise it is
15001 a pointer to the row found. */
15003 static struct glyph_row
*
15004 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15005 struct glyph_row
*start
)
15007 struct glyph_row
*row
, *row_found
;
15009 /* Set row_found to the last row in IT->w's current matrix
15010 displaying text. The loop looks funny but think of partially
15013 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15014 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15016 xassert (row
->enabled_p
);
15018 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15027 /* Return the last row in the current matrix of W that is not affected
15028 by changes at the start of current_buffer that occurred since W's
15029 current matrix was built. Value is null if no such row exists.
15031 BEG_UNCHANGED us the number of characters unchanged at the start of
15032 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15033 first changed character in current_buffer. Characters at positions <
15034 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15035 when the current matrix was built. */
15037 static struct glyph_row
*
15038 find_last_unchanged_at_beg_row (struct window
*w
)
15040 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15041 struct glyph_row
*row
;
15042 struct glyph_row
*row_found
= NULL
;
15043 int yb
= window_text_bottom_y (w
);
15045 /* Find the last row displaying unchanged text. */
15046 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15047 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15048 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15051 if (/* If row ends before first_changed_pos, it is unchanged,
15052 except in some case. */
15053 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15054 /* When row ends in ZV and we write at ZV it is not
15056 && !row
->ends_at_zv_p
15057 /* When first_changed_pos is the end of a continued line,
15058 row is not unchanged because it may be no longer
15060 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15061 && (row
->continued_p
15062 || row
->exact_window_width_line_p
)))
15065 /* Stop if last visible row. */
15066 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15074 /* Find the first glyph row in the current matrix of W that is not
15075 affected by changes at the end of current_buffer since the
15076 time W's current matrix was built.
15078 Return in *DELTA the number of chars by which buffer positions in
15079 unchanged text at the end of current_buffer must be adjusted.
15081 Return in *DELTA_BYTES the corresponding number of bytes.
15083 Value is null if no such row exists, i.e. all rows are affected by
15086 static struct glyph_row
*
15087 find_first_unchanged_at_end_row (struct window
*w
,
15088 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15090 struct glyph_row
*row
;
15091 struct glyph_row
*row_found
= NULL
;
15093 *delta
= *delta_bytes
= 0;
15095 /* Display must not have been paused, otherwise the current matrix
15096 is not up to date. */
15097 eassert (!NILP (w
->window_end_valid
));
15099 /* A value of window_end_pos >= END_UNCHANGED means that the window
15100 end is in the range of changed text. If so, there is no
15101 unchanged row at the end of W's current matrix. */
15102 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15105 /* Set row to the last row in W's current matrix displaying text. */
15106 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15108 /* If matrix is entirely empty, no unchanged row exists. */
15109 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15111 /* The value of row is the last glyph row in the matrix having a
15112 meaningful buffer position in it. The end position of row
15113 corresponds to window_end_pos. This allows us to translate
15114 buffer positions in the current matrix to current buffer
15115 positions for characters not in changed text. */
15117 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15118 EMACS_INT Z_BYTE_old
=
15119 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15120 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15121 struct glyph_row
*first_text_row
15122 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15124 *delta
= Z
- Z_old
;
15125 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15127 /* Set last_unchanged_pos to the buffer position of the last
15128 character in the buffer that has not been changed. Z is the
15129 index + 1 of the last character in current_buffer, i.e. by
15130 subtracting END_UNCHANGED we get the index of the last
15131 unchanged character, and we have to add BEG to get its buffer
15133 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15134 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15136 /* Search backward from ROW for a row displaying a line that
15137 starts at a minimum position >= last_unchanged_pos_old. */
15138 for (; row
> first_text_row
; --row
)
15140 /* This used to abort, but it can happen.
15141 It is ok to just stop the search instead here. KFS. */
15142 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15145 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15150 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15156 /* Make sure that glyph rows in the current matrix of window W
15157 reference the same glyph memory as corresponding rows in the
15158 frame's frame matrix. This function is called after scrolling W's
15159 current matrix on a terminal frame in try_window_id and
15160 try_window_reusing_current_matrix. */
15163 sync_frame_with_window_matrix_rows (struct window
*w
)
15165 struct frame
*f
= XFRAME (w
->frame
);
15166 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15168 /* Preconditions: W must be a leaf window and full-width. Its frame
15169 must have a frame matrix. */
15170 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15171 xassert (WINDOW_FULL_WIDTH_P (w
));
15172 xassert (!FRAME_WINDOW_P (f
));
15174 /* If W is a full-width window, glyph pointers in W's current matrix
15175 have, by definition, to be the same as glyph pointers in the
15176 corresponding frame matrix. Note that frame matrices have no
15177 marginal areas (see build_frame_matrix). */
15178 window_row
= w
->current_matrix
->rows
;
15179 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15180 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15181 while (window_row
< window_row_end
)
15183 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15184 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15186 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15187 frame_row
->glyphs
[TEXT_AREA
] = start
;
15188 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15189 frame_row
->glyphs
[LAST_AREA
] = end
;
15191 /* Disable frame rows whose corresponding window rows have
15192 been disabled in try_window_id. */
15193 if (!window_row
->enabled_p
)
15194 frame_row
->enabled_p
= 0;
15196 ++window_row
, ++frame_row
;
15201 /* Find the glyph row in window W containing CHARPOS. Consider all
15202 rows between START and END (not inclusive). END null means search
15203 all rows to the end of the display area of W. Value is the row
15204 containing CHARPOS or null. */
15207 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15208 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15210 struct glyph_row
*row
= start
;
15211 struct glyph_row
*best_row
= NULL
;
15212 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15215 /* If we happen to start on a header-line, skip that. */
15216 if (row
->mode_line_p
)
15219 if ((end
&& row
>= end
) || !row
->enabled_p
)
15222 last_y
= window_text_bottom_y (w
) - dy
;
15226 /* Give up if we have gone too far. */
15227 if (end
&& row
>= end
)
15229 /* This formerly returned if they were equal.
15230 I think that both quantities are of a "last plus one" type;
15231 if so, when they are equal, the row is within the screen. -- rms. */
15232 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15235 /* If it is in this row, return this row. */
15236 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15237 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15238 /* The end position of a row equals the start
15239 position of the next row. If CHARPOS is there, we
15240 would rather display it in the next line, except
15241 when this line ends in ZV. */
15242 && !row
->ends_at_zv_p
15243 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15244 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15248 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15249 || (!best_row
&& !row
->continued_p
))
15251 /* In bidi-reordered rows, there could be several rows
15252 occluding point, all of them belonging to the same
15253 continued line. We need to find the row which fits
15254 CHARPOS the best. */
15255 for (g
= row
->glyphs
[TEXT_AREA
];
15256 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15259 if (!STRINGP (g
->object
))
15261 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15263 mindif
= eabs (g
->charpos
- charpos
);
15265 /* Exact match always wins. */
15272 else if (best_row
&& !row
->continued_p
)
15279 /* Try to redisplay window W by reusing its existing display. W's
15280 current matrix must be up to date when this function is called,
15281 i.e. window_end_valid must not be nil.
15285 1 if display has been updated
15286 0 if otherwise unsuccessful
15287 -1 if redisplay with same window start is known not to succeed
15289 The following steps are performed:
15291 1. Find the last row in the current matrix of W that is not
15292 affected by changes at the start of current_buffer. If no such row
15295 2. Find the first row in W's current matrix that is not affected by
15296 changes at the end of current_buffer. Maybe there is no such row.
15298 3. Display lines beginning with the row + 1 found in step 1 to the
15299 row found in step 2 or, if step 2 didn't find a row, to the end of
15302 4. If cursor is not known to appear on the window, give up.
15304 5. If display stopped at the row found in step 2, scroll the
15305 display and current matrix as needed.
15307 6. Maybe display some lines at the end of W, if we must. This can
15308 happen under various circumstances, like a partially visible line
15309 becoming fully visible, or because newly displayed lines are displayed
15310 in smaller font sizes.
15312 7. Update W's window end information. */
15315 try_window_id (struct window
*w
)
15317 struct frame
*f
= XFRAME (w
->frame
);
15318 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15319 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15320 struct glyph_row
*last_unchanged_at_beg_row
;
15321 struct glyph_row
*first_unchanged_at_end_row
;
15322 struct glyph_row
*row
;
15323 struct glyph_row
*bottom_row
;
15326 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15328 struct text_pos start_pos
;
15330 int first_unchanged_at_end_vpos
= 0;
15331 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15332 struct text_pos start
;
15333 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15336 if (inhibit_try_window_id
)
15340 /* This is handy for debugging. */
15342 #define GIVE_UP(X) \
15344 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15348 #define GIVE_UP(X) return 0
15351 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15353 /* Don't use this for mini-windows because these can show
15354 messages and mini-buffers, and we don't handle that here. */
15355 if (MINI_WINDOW_P (w
))
15358 /* This flag is used to prevent redisplay optimizations. */
15359 if (windows_or_buffers_changed
|| cursor_type_changed
)
15362 /* Verify that narrowing has not changed.
15363 Also verify that we were not told to prevent redisplay optimizations.
15364 It would be nice to further
15365 reduce the number of cases where this prevents try_window_id. */
15366 if (current_buffer
->clip_changed
15367 || current_buffer
->prevent_redisplay_optimizations_p
)
15370 /* Window must either use window-based redisplay or be full width. */
15371 if (!FRAME_WINDOW_P (f
)
15372 && (!FRAME_LINE_INS_DEL_OK (f
)
15373 || !WINDOW_FULL_WIDTH_P (w
)))
15376 /* Give up if point is known NOT to appear in W. */
15377 if (PT
< CHARPOS (start
))
15380 /* Another way to prevent redisplay optimizations. */
15381 if (XFASTINT (w
->last_modified
) == 0)
15384 /* Verify that window is not hscrolled. */
15385 if (XFASTINT (w
->hscroll
) != 0)
15388 /* Verify that display wasn't paused. */
15389 if (NILP (w
->window_end_valid
))
15392 /* Can't use this if highlighting a region because a cursor movement
15393 will do more than just set the cursor. */
15394 if (!NILP (Vtransient_mark_mode
)
15395 && !NILP (current_buffer
->mark_active
))
15398 /* Likewise if highlighting trailing whitespace. */
15399 if (!NILP (Vshow_trailing_whitespace
))
15402 /* Likewise if showing a region. */
15403 if (!NILP (w
->region_showing
))
15406 /* Can't use this if overlay arrow position and/or string have
15408 if (overlay_arrows_changed_p ())
15411 /* When word-wrap is on, adding a space to the first word of a
15412 wrapped line can change the wrap position, altering the line
15413 above it. It might be worthwhile to handle this more
15414 intelligently, but for now just redisplay from scratch. */
15415 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15418 /* Under bidi reordering, adding or deleting a character in the
15419 beginning of a paragraph, before the first strong directional
15420 character, can change the base direction of the paragraph (unless
15421 the buffer specifies a fixed paragraph direction), which will
15422 require to redisplay the whole paragraph. It might be worthwhile
15423 to find the paragraph limits and widen the range of redisplayed
15424 lines to that, but for now just give up this optimization and
15425 redisplay from scratch. */
15426 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15427 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15430 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15431 only if buffer has really changed. The reason is that the gap is
15432 initially at Z for freshly visited files. The code below would
15433 set end_unchanged to 0 in that case. */
15434 if (MODIFF
> SAVE_MODIFF
15435 /* This seems to happen sometimes after saving a buffer. */
15436 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15438 if (GPT
- BEG
< BEG_UNCHANGED
)
15439 BEG_UNCHANGED
= GPT
- BEG
;
15440 if (Z
- GPT
< END_UNCHANGED
)
15441 END_UNCHANGED
= Z
- GPT
;
15444 /* The position of the first and last character that has been changed. */
15445 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15446 last_changed_charpos
= Z
- END_UNCHANGED
;
15448 /* If window starts after a line end, and the last change is in
15449 front of that newline, then changes don't affect the display.
15450 This case happens with stealth-fontification. Note that although
15451 the display is unchanged, glyph positions in the matrix have to
15452 be adjusted, of course. */
15453 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15454 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15455 && ((last_changed_charpos
< CHARPOS (start
)
15456 && CHARPOS (start
) == BEGV
)
15457 || (last_changed_charpos
< CHARPOS (start
) - 1
15458 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15460 EMACS_INT Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15461 struct glyph_row
*r0
;
15463 /* Compute how many chars/bytes have been added to or removed
15464 from the buffer. */
15465 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15466 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15468 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15470 /* Give up if PT is not in the window. Note that it already has
15471 been checked at the start of try_window_id that PT is not in
15472 front of the window start. */
15473 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15476 /* If window start is unchanged, we can reuse the whole matrix
15477 as is, after adjusting glyph positions. No need to compute
15478 the window end again, since its offset from Z hasn't changed. */
15479 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15480 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15481 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15482 /* PT must not be in a partially visible line. */
15483 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15484 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15486 /* Adjust positions in the glyph matrix. */
15487 if (delta
|| delta_bytes
)
15489 struct glyph_row
*r1
15490 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15491 increment_matrix_positions (w
->current_matrix
,
15492 MATRIX_ROW_VPOS (r0
, current_matrix
),
15493 MATRIX_ROW_VPOS (r1
, current_matrix
),
15494 delta
, delta_bytes
);
15497 /* Set the cursor. */
15498 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15500 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15507 /* Handle the case that changes are all below what is displayed in
15508 the window, and that PT is in the window. This shortcut cannot
15509 be taken if ZV is visible in the window, and text has been added
15510 there that is visible in the window. */
15511 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15512 /* ZV is not visible in the window, or there are no
15513 changes at ZV, actually. */
15514 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15515 || first_changed_charpos
== last_changed_charpos
))
15517 struct glyph_row
*r0
;
15519 /* Give up if PT is not in the window. Note that it already has
15520 been checked at the start of try_window_id that PT is not in
15521 front of the window start. */
15522 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15525 /* If window start is unchanged, we can reuse the whole matrix
15526 as is, without changing glyph positions since no text has
15527 been added/removed in front of the window end. */
15528 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15529 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15530 /* PT must not be in a partially visible line. */
15531 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15532 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15534 /* We have to compute the window end anew since text
15535 could have been added/removed after it. */
15537 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15538 w
->window_end_bytepos
15539 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15541 /* Set the cursor. */
15542 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15544 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15551 /* Give up if window start is in the changed area.
15553 The condition used to read
15555 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15557 but why that was tested escapes me at the moment. */
15558 if (CHARPOS (start
) >= first_changed_charpos
15559 && CHARPOS (start
) <= last_changed_charpos
)
15562 /* Check that window start agrees with the start of the first glyph
15563 row in its current matrix. Check this after we know the window
15564 start is not in changed text, otherwise positions would not be
15566 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15567 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15570 /* Give up if the window ends in strings. Overlay strings
15571 at the end are difficult to handle, so don't try. */
15572 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15573 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15576 /* Compute the position at which we have to start displaying new
15577 lines. Some of the lines at the top of the window might be
15578 reusable because they are not displaying changed text. Find the
15579 last row in W's current matrix not affected by changes at the
15580 start of current_buffer. Value is null if changes start in the
15581 first line of window. */
15582 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15583 if (last_unchanged_at_beg_row
)
15585 /* Avoid starting to display in the moddle of a character, a TAB
15586 for instance. This is easier than to set up the iterator
15587 exactly, and it's not a frequent case, so the additional
15588 effort wouldn't really pay off. */
15589 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15590 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15591 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15592 --last_unchanged_at_beg_row
;
15594 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15597 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15599 start_pos
= it
.current
.pos
;
15601 /* Start displaying new lines in the desired matrix at the same
15602 vpos we would use in the current matrix, i.e. below
15603 last_unchanged_at_beg_row. */
15604 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15606 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15607 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15609 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15613 /* There are no reusable lines at the start of the window.
15614 Start displaying in the first text line. */
15615 start_display (&it
, w
, start
);
15616 it
.vpos
= it
.first_vpos
;
15617 start_pos
= it
.current
.pos
;
15620 /* Find the first row that is not affected by changes at the end of
15621 the buffer. Value will be null if there is no unchanged row, in
15622 which case we must redisplay to the end of the window. delta
15623 will be set to the value by which buffer positions beginning with
15624 first_unchanged_at_end_row have to be adjusted due to text
15626 first_unchanged_at_end_row
15627 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15628 IF_DEBUG (debug_delta
= delta
);
15629 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15631 /* Set stop_pos to the buffer position up to which we will have to
15632 display new lines. If first_unchanged_at_end_row != NULL, this
15633 is the buffer position of the start of the line displayed in that
15634 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15635 that we don't stop at a buffer position. */
15637 if (first_unchanged_at_end_row
)
15639 xassert (last_unchanged_at_beg_row
== NULL
15640 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15642 /* If this is a continuation line, move forward to the next one
15643 that isn't. Changes in lines above affect this line.
15644 Caution: this may move first_unchanged_at_end_row to a row
15645 not displaying text. */
15646 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15647 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15648 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15649 < it
.last_visible_y
))
15650 ++first_unchanged_at_end_row
;
15652 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15653 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15654 >= it
.last_visible_y
))
15655 first_unchanged_at_end_row
= NULL
;
15658 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15660 first_unchanged_at_end_vpos
15661 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15662 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15665 else if (last_unchanged_at_beg_row
== NULL
)
15671 /* Either there is no unchanged row at the end, or the one we have
15672 now displays text. This is a necessary condition for the window
15673 end pos calculation at the end of this function. */
15674 xassert (first_unchanged_at_end_row
== NULL
15675 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15677 debug_last_unchanged_at_beg_vpos
15678 = (last_unchanged_at_beg_row
15679 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15681 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15683 #endif /* GLYPH_DEBUG != 0 */
15686 /* Display new lines. Set last_text_row to the last new line
15687 displayed which has text on it, i.e. might end up as being the
15688 line where the window_end_vpos is. */
15689 w
->cursor
.vpos
= -1;
15690 last_text_row
= NULL
;
15691 overlay_arrow_seen
= 0;
15692 while (it
.current_y
< it
.last_visible_y
15693 && !fonts_changed_p
15694 && (first_unchanged_at_end_row
== NULL
15695 || IT_CHARPOS (it
) < stop_pos
))
15697 if (display_line (&it
))
15698 last_text_row
= it
.glyph_row
- 1;
15701 if (fonts_changed_p
)
15705 /* Compute differences in buffer positions, y-positions etc. for
15706 lines reused at the bottom of the window. Compute what we can
15708 if (first_unchanged_at_end_row
15709 /* No lines reused because we displayed everything up to the
15710 bottom of the window. */
15711 && it
.current_y
< it
.last_visible_y
)
15714 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15716 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15717 run
.current_y
= first_unchanged_at_end_row
->y
;
15718 run
.desired_y
= run
.current_y
+ dy
;
15719 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15723 delta
= delta_bytes
= dvpos
= dy
15724 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15725 first_unchanged_at_end_row
= NULL
;
15727 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15730 /* Find the cursor if not already found. We have to decide whether
15731 PT will appear on this window (it sometimes doesn't, but this is
15732 not a very frequent case.) This decision has to be made before
15733 the current matrix is altered. A value of cursor.vpos < 0 means
15734 that PT is either in one of the lines beginning at
15735 first_unchanged_at_end_row or below the window. Don't care for
15736 lines that might be displayed later at the window end; as
15737 mentioned, this is not a frequent case. */
15738 if (w
->cursor
.vpos
< 0)
15740 /* Cursor in unchanged rows at the top? */
15741 if (PT
< CHARPOS (start_pos
)
15742 && last_unchanged_at_beg_row
)
15744 row
= row_containing_pos (w
, PT
,
15745 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15746 last_unchanged_at_beg_row
+ 1, 0);
15748 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15751 /* Start from first_unchanged_at_end_row looking for PT. */
15752 else if (first_unchanged_at_end_row
)
15754 row
= row_containing_pos (w
, PT
- delta
,
15755 first_unchanged_at_end_row
, NULL
, 0);
15757 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15758 delta_bytes
, dy
, dvpos
);
15761 /* Give up if cursor was not found. */
15762 if (w
->cursor
.vpos
< 0)
15764 clear_glyph_matrix (w
->desired_matrix
);
15769 /* Don't let the cursor end in the scroll margins. */
15771 int this_scroll_margin
, cursor_height
;
15773 this_scroll_margin
= max (0, scroll_margin
);
15774 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15775 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15776 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15778 if ((w
->cursor
.y
< this_scroll_margin
15779 && CHARPOS (start
) > BEGV
)
15780 /* Old redisplay didn't take scroll margin into account at the bottom,
15781 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15782 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15783 ? cursor_height
+ this_scroll_margin
15784 : 1)) > it
.last_visible_y
)
15786 w
->cursor
.vpos
= -1;
15787 clear_glyph_matrix (w
->desired_matrix
);
15792 /* Scroll the display. Do it before changing the current matrix so
15793 that xterm.c doesn't get confused about where the cursor glyph is
15795 if (dy
&& run
.height
)
15799 if (FRAME_WINDOW_P (f
))
15801 FRAME_RIF (f
)->update_window_begin_hook (w
);
15802 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15803 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15804 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15808 /* Terminal frame. In this case, dvpos gives the number of
15809 lines to scroll by; dvpos < 0 means scroll up. */
15810 int first_unchanged_at_end_vpos
15811 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15812 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15813 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15814 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15815 + window_internal_height (w
));
15817 #if defined (HAVE_GPM) || defined (MSDOS)
15818 x_clear_window_mouse_face (w
);
15820 /* Perform the operation on the screen. */
15823 /* Scroll last_unchanged_at_beg_row to the end of the
15824 window down dvpos lines. */
15825 set_terminal_window (f
, end
);
15827 /* On dumb terminals delete dvpos lines at the end
15828 before inserting dvpos empty lines. */
15829 if (!FRAME_SCROLL_REGION_OK (f
))
15830 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15832 /* Insert dvpos empty lines in front of
15833 last_unchanged_at_beg_row. */
15834 ins_del_lines (f
, from
, dvpos
);
15836 else if (dvpos
< 0)
15838 /* Scroll up last_unchanged_at_beg_vpos to the end of
15839 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15840 set_terminal_window (f
, end
);
15842 /* Delete dvpos lines in front of
15843 last_unchanged_at_beg_vpos. ins_del_lines will set
15844 the cursor to the given vpos and emit |dvpos| delete
15846 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15848 /* On a dumb terminal insert dvpos empty lines at the
15850 if (!FRAME_SCROLL_REGION_OK (f
))
15851 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15854 set_terminal_window (f
, 0);
15860 /* Shift reused rows of the current matrix to the right position.
15861 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15863 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15864 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15867 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15868 bottom_vpos
, dvpos
);
15869 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15872 else if (dvpos
> 0)
15874 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15875 bottom_vpos
, dvpos
);
15876 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15877 first_unchanged_at_end_vpos
+ dvpos
, 0);
15880 /* For frame-based redisplay, make sure that current frame and window
15881 matrix are in sync with respect to glyph memory. */
15882 if (!FRAME_WINDOW_P (f
))
15883 sync_frame_with_window_matrix_rows (w
);
15885 /* Adjust buffer positions in reused rows. */
15886 if (delta
|| delta_bytes
)
15887 increment_matrix_positions (current_matrix
,
15888 first_unchanged_at_end_vpos
+ dvpos
,
15889 bottom_vpos
, delta
, delta_bytes
);
15891 /* Adjust Y positions. */
15893 shift_glyph_matrix (w
, current_matrix
,
15894 first_unchanged_at_end_vpos
+ dvpos
,
15897 if (first_unchanged_at_end_row
)
15899 first_unchanged_at_end_row
+= dvpos
;
15900 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15901 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15902 first_unchanged_at_end_row
= NULL
;
15905 /* If scrolling up, there may be some lines to display at the end of
15907 last_text_row_at_end
= NULL
;
15910 /* Scrolling up can leave for example a partially visible line
15911 at the end of the window to be redisplayed. */
15912 /* Set last_row to the glyph row in the current matrix where the
15913 window end line is found. It has been moved up or down in
15914 the matrix by dvpos. */
15915 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15916 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15918 /* If last_row is the window end line, it should display text. */
15919 xassert (last_row
->displays_text_p
);
15921 /* If window end line was partially visible before, begin
15922 displaying at that line. Otherwise begin displaying with the
15923 line following it. */
15924 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15926 init_to_row_start (&it
, w
, last_row
);
15927 it
.vpos
= last_vpos
;
15928 it
.current_y
= last_row
->y
;
15932 init_to_row_end (&it
, w
, last_row
);
15933 it
.vpos
= 1 + last_vpos
;
15934 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15938 /* We may start in a continuation line. If so, we have to
15939 get the right continuation_lines_width and current_x. */
15940 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15941 it
.hpos
= it
.current_x
= 0;
15943 /* Display the rest of the lines at the window end. */
15944 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15945 while (it
.current_y
< it
.last_visible_y
15946 && !fonts_changed_p
)
15948 /* Is it always sure that the display agrees with lines in
15949 the current matrix? I don't think so, so we mark rows
15950 displayed invalid in the current matrix by setting their
15951 enabled_p flag to zero. */
15952 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15953 if (display_line (&it
))
15954 last_text_row_at_end
= it
.glyph_row
- 1;
15958 /* Update window_end_pos and window_end_vpos. */
15959 if (first_unchanged_at_end_row
15960 && !last_text_row_at_end
)
15962 /* Window end line if one of the preserved rows from the current
15963 matrix. Set row to the last row displaying text in current
15964 matrix starting at first_unchanged_at_end_row, after
15966 xassert (first_unchanged_at_end_row
->displays_text_p
);
15967 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15968 first_unchanged_at_end_row
);
15969 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15971 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15972 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15974 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15975 xassert (w
->window_end_bytepos
>= 0);
15976 IF_DEBUG (debug_method_add (w
, "A"));
15978 else if (last_text_row_at_end
)
15981 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15982 w
->window_end_bytepos
15983 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15985 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15986 xassert (w
->window_end_bytepos
>= 0);
15987 IF_DEBUG (debug_method_add (w
, "B"));
15989 else if (last_text_row
)
15991 /* We have displayed either to the end of the window or at the
15992 end of the window, i.e. the last row with text is to be found
15993 in the desired matrix. */
15995 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15996 w
->window_end_bytepos
15997 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15999 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16000 xassert (w
->window_end_bytepos
>= 0);
16002 else if (first_unchanged_at_end_row
== NULL
16003 && last_text_row
== NULL
16004 && last_text_row_at_end
== NULL
)
16006 /* Displayed to end of window, but no line containing text was
16007 displayed. Lines were deleted at the end of the window. */
16008 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16009 int vpos
= XFASTINT (w
->window_end_vpos
);
16010 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16011 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16014 row
== NULL
&& vpos
>= first_vpos
;
16015 --vpos
, --current_row
, --desired_row
)
16017 if (desired_row
->enabled_p
)
16019 if (desired_row
->displays_text_p
)
16022 else if (current_row
->displays_text_p
)
16026 xassert (row
!= NULL
);
16027 w
->window_end_vpos
= make_number (vpos
+ 1);
16028 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16029 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16030 xassert (w
->window_end_bytepos
>= 0);
16031 IF_DEBUG (debug_method_add (w
, "C"));
16036 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16037 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16039 /* Record that display has not been completed. */
16040 w
->window_end_valid
= Qnil
;
16041 w
->desired_matrix
->no_scrolling_p
= 1;
16049 /***********************************************************************
16050 More debugging support
16051 ***********************************************************************/
16055 void dump_glyph_row (struct glyph_row
*, int, int);
16056 void dump_glyph_matrix (struct glyph_matrix
*, int);
16057 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16060 /* Dump the contents of glyph matrix MATRIX on stderr.
16062 GLYPHS 0 means don't show glyph contents.
16063 GLYPHS 1 means show glyphs in short form
16064 GLYPHS > 1 means show glyphs in long form. */
16067 dump_glyph_matrix (matrix
, glyphs
)
16068 struct glyph_matrix
*matrix
;
16072 for (i
= 0; i
< matrix
->nrows
; ++i
)
16073 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16077 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16078 the glyph row and area where the glyph comes from. */
16081 dump_glyph (row
, glyph
, area
)
16082 struct glyph_row
*row
;
16083 struct glyph
*glyph
;
16086 if (glyph
->type
== CHAR_GLYPH
)
16089 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16090 glyph
- row
->glyphs
[TEXT_AREA
],
16093 (BUFFERP (glyph
->object
)
16095 : (STRINGP (glyph
->object
)
16098 glyph
->pixel_width
,
16100 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16104 glyph
->left_box_line_p
,
16105 glyph
->right_box_line_p
);
16107 else if (glyph
->type
== STRETCH_GLYPH
)
16110 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16111 glyph
- row
->glyphs
[TEXT_AREA
],
16114 (BUFFERP (glyph
->object
)
16116 : (STRINGP (glyph
->object
)
16119 glyph
->pixel_width
,
16123 glyph
->left_box_line_p
,
16124 glyph
->right_box_line_p
);
16126 else if (glyph
->type
== IMAGE_GLYPH
)
16129 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16130 glyph
- row
->glyphs
[TEXT_AREA
],
16133 (BUFFERP (glyph
->object
)
16135 : (STRINGP (glyph
->object
)
16138 glyph
->pixel_width
,
16142 glyph
->left_box_line_p
,
16143 glyph
->right_box_line_p
);
16145 else if (glyph
->type
== COMPOSITE_GLYPH
)
16148 " %5d %4c %6d %c %3d 0x%05x",
16149 glyph
- row
->glyphs
[TEXT_AREA
],
16152 (BUFFERP (glyph
->object
)
16154 : (STRINGP (glyph
->object
)
16157 glyph
->pixel_width
,
16159 if (glyph
->u
.cmp
.automatic
)
16162 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16163 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16165 glyph
->left_box_line_p
,
16166 glyph
->right_box_line_p
);
16171 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16172 GLYPHS 0 means don't show glyph contents.
16173 GLYPHS 1 means show glyphs in short form
16174 GLYPHS > 1 means show glyphs in long form. */
16177 dump_glyph_row (row
, vpos
, glyphs
)
16178 struct glyph_row
*row
;
16183 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16184 fprintf (stderr
, "======================================================================\n");
16186 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16187 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16189 MATRIX_ROW_START_CHARPOS (row
),
16190 MATRIX_ROW_END_CHARPOS (row
),
16191 row
->used
[TEXT_AREA
],
16192 row
->contains_overlapping_glyphs_p
,
16194 row
->truncated_on_left_p
,
16195 row
->truncated_on_right_p
,
16197 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16198 row
->displays_text_p
,
16201 row
->ends_in_middle_of_char_p
,
16202 row
->starts_in_middle_of_char_p
,
16208 row
->visible_height
,
16211 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16212 row
->end
.overlay_string_index
,
16213 row
->continuation_lines_width
);
16214 fprintf (stderr
, "%9d %5d\n",
16215 CHARPOS (row
->start
.string_pos
),
16216 CHARPOS (row
->end
.string_pos
));
16217 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16218 row
->end
.dpvec_index
);
16225 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16227 struct glyph
*glyph
= row
->glyphs
[area
];
16228 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16230 /* Glyph for a line end in text. */
16231 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16234 if (glyph
< glyph_end
)
16235 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16237 for (; glyph
< glyph_end
; ++glyph
)
16238 dump_glyph (row
, glyph
, area
);
16241 else if (glyphs
== 1)
16245 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16247 char *s
= (char *) alloca (row
->used
[area
] + 1);
16250 for (i
= 0; i
< row
->used
[area
]; ++i
)
16252 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16253 if (glyph
->type
== CHAR_GLYPH
16254 && glyph
->u
.ch
< 0x80
16255 && glyph
->u
.ch
>= ' ')
16256 s
[i
] = glyph
->u
.ch
;
16262 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16268 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16269 Sdump_glyph_matrix
, 0, 1, "p",
16270 doc
: /* Dump the current matrix of the selected window to stderr.
16271 Shows contents of glyph row structures. With non-nil
16272 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16273 glyphs in short form, otherwise show glyphs in long form. */)
16274 (Lisp_Object glyphs
)
16276 struct window
*w
= XWINDOW (selected_window
);
16277 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16279 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16280 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16281 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16282 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16283 fprintf (stderr
, "=============================================\n");
16284 dump_glyph_matrix (w
->current_matrix
,
16285 NILP (glyphs
) ? 0 : XINT (glyphs
));
16290 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16291 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16294 struct frame
*f
= XFRAME (selected_frame
);
16295 dump_glyph_matrix (f
->current_matrix
, 1);
16300 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16301 doc
: /* Dump glyph row ROW to stderr.
16302 GLYPH 0 means don't dump glyphs.
16303 GLYPH 1 means dump glyphs in short form.
16304 GLYPH > 1 or omitted means dump glyphs in long form. */)
16305 (Lisp_Object row
, Lisp_Object glyphs
)
16307 struct glyph_matrix
*matrix
;
16310 CHECK_NUMBER (row
);
16311 matrix
= XWINDOW (selected_window
)->current_matrix
;
16313 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16314 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16316 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16321 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16322 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16323 GLYPH 0 means don't dump glyphs.
16324 GLYPH 1 means dump glyphs in short form.
16325 GLYPH > 1 or omitted means dump glyphs in long form. */)
16326 (Lisp_Object row
, Lisp_Object glyphs
)
16328 struct frame
*sf
= SELECTED_FRAME ();
16329 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16332 CHECK_NUMBER (row
);
16334 if (vpos
>= 0 && vpos
< m
->nrows
)
16335 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16336 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16341 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16342 doc
: /* Toggle tracing of redisplay.
16343 With ARG, turn tracing on if and only if ARG is positive. */)
16347 trace_redisplay_p
= !trace_redisplay_p
;
16350 arg
= Fprefix_numeric_value (arg
);
16351 trace_redisplay_p
= XINT (arg
) > 0;
16358 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16359 doc
: /* Like `format', but print result to stderr.
16360 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16361 (int nargs
, Lisp_Object
*args
)
16363 Lisp_Object s
= Fformat (nargs
, args
);
16364 fprintf (stderr
, "%s", SDATA (s
));
16368 #endif /* GLYPH_DEBUG */
16372 /***********************************************************************
16373 Building Desired Matrix Rows
16374 ***********************************************************************/
16376 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16377 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16379 static struct glyph_row
*
16380 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16382 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16383 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16384 struct buffer
*old
= current_buffer
;
16385 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16386 int arrow_len
= SCHARS (overlay_arrow_string
);
16387 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16388 const unsigned char *p
;
16391 int n_glyphs_before
;
16393 set_buffer_temp (buffer
);
16394 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16395 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16396 SET_TEXT_POS (it
.position
, 0, 0);
16398 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16400 while (p
< arrow_end
)
16402 Lisp_Object face
, ilisp
;
16404 /* Get the next character. */
16406 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16409 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16410 if (! ASCII_CHAR_P (it
.c
))
16411 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16415 /* Get its face. */
16416 ilisp
= make_number (p
- arrow_string
);
16417 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16418 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16420 /* Compute its width, get its glyphs. */
16421 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16422 SET_TEXT_POS (it
.position
, -1, -1);
16423 PRODUCE_GLYPHS (&it
);
16425 /* If this character doesn't fit any more in the line, we have
16426 to remove some glyphs. */
16427 if (it
.current_x
> it
.last_visible_x
)
16429 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16434 set_buffer_temp (old
);
16435 return it
.glyph_row
;
16439 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16440 glyphs are only inserted for terminal frames since we can't really
16441 win with truncation glyphs when partially visible glyphs are
16442 involved. Which glyphs to insert is determined by
16443 produce_special_glyphs. */
16446 insert_left_trunc_glyphs (struct it
*it
)
16448 struct it truncate_it
;
16449 struct glyph
*from
, *end
, *to
, *toend
;
16451 xassert (!FRAME_WINDOW_P (it
->f
));
16453 /* Get the truncation glyphs. */
16455 truncate_it
.current_x
= 0;
16456 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16457 truncate_it
.glyph_row
= &scratch_glyph_row
;
16458 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16459 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16460 truncate_it
.object
= make_number (0);
16461 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16463 /* Overwrite glyphs from IT with truncation glyphs. */
16464 if (!it
->glyph_row
->reversed_p
)
16466 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16467 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16468 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16469 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16474 /* There may be padding glyphs left over. Overwrite them too. */
16475 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16477 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16483 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16487 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16488 that back to front. */
16489 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16490 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16491 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16492 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16494 while (from
>= end
&& to
>= toend
)
16496 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16499 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16500 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16501 while (from
>= end
&& to
>= toend
)
16506 /* Need to free some room before prepending additional
16508 int move_by
= from
- end
+ 1;
16509 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16510 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16512 for ( ; g
>= g0
; g
--)
16514 while (from
>= end
)
16516 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16522 /* Compute the pixel height and width of IT->glyph_row.
16524 Most of the time, ascent and height of a display line will be equal
16525 to the max_ascent and max_height values of the display iterator
16526 structure. This is not the case if
16528 1. We hit ZV without displaying anything. In this case, max_ascent
16529 and max_height will be zero.
16531 2. We have some glyphs that don't contribute to the line height.
16532 (The glyph row flag contributes_to_line_height_p is for future
16533 pixmap extensions).
16535 The first case is easily covered by using default values because in
16536 these cases, the line height does not really matter, except that it
16537 must not be zero. */
16540 compute_line_metrics (struct it
*it
)
16542 struct glyph_row
*row
= it
->glyph_row
;
16545 if (FRAME_WINDOW_P (it
->f
))
16547 int i
, min_y
, max_y
;
16549 /* The line may consist of one space only, that was added to
16550 place the cursor on it. If so, the row's height hasn't been
16552 if (row
->height
== 0)
16554 if (it
->max_ascent
+ it
->max_descent
== 0)
16555 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16556 row
->ascent
= it
->max_ascent
;
16557 row
->height
= it
->max_ascent
+ it
->max_descent
;
16558 row
->phys_ascent
= it
->max_phys_ascent
;
16559 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16560 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16563 /* Compute the width of this line. */
16564 row
->pixel_width
= row
->x
;
16565 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16566 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16568 xassert (row
->pixel_width
>= 0);
16569 xassert (row
->ascent
>= 0 && row
->height
> 0);
16571 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16572 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16574 /* If first line's physical ascent is larger than its logical
16575 ascent, use the physical ascent, and make the row taller.
16576 This makes accented characters fully visible. */
16577 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16578 && row
->phys_ascent
> row
->ascent
)
16580 row
->height
+= row
->phys_ascent
- row
->ascent
;
16581 row
->ascent
= row
->phys_ascent
;
16584 /* Compute how much of the line is visible. */
16585 row
->visible_height
= row
->height
;
16587 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16588 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16590 if (row
->y
< min_y
)
16591 row
->visible_height
-= min_y
- row
->y
;
16592 if (row
->y
+ row
->height
> max_y
)
16593 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16597 row
->pixel_width
= row
->used
[TEXT_AREA
];
16598 if (row
->continued_p
)
16599 row
->pixel_width
-= it
->continuation_pixel_width
;
16600 else if (row
->truncated_on_right_p
)
16601 row
->pixel_width
-= it
->truncation_pixel_width
;
16602 row
->ascent
= row
->phys_ascent
= 0;
16603 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16604 row
->extra_line_spacing
= 0;
16607 /* Compute a hash code for this row. */
16609 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16610 for (i
= 0; i
< row
->used
[area
]; ++i
)
16611 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16612 + row
->glyphs
[area
][i
].u
.val
16613 + row
->glyphs
[area
][i
].face_id
16614 + row
->glyphs
[area
][i
].padding_p
16615 + (row
->glyphs
[area
][i
].type
<< 2));
16617 it
->max_ascent
= it
->max_descent
= 0;
16618 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16622 /* Append one space to the glyph row of iterator IT if doing a
16623 window-based redisplay. The space has the same face as
16624 IT->face_id. Value is non-zero if a space was added.
16626 This function is called to make sure that there is always one glyph
16627 at the end of a glyph row that the cursor can be set on under
16628 window-systems. (If there weren't such a glyph we would not know
16629 how wide and tall a box cursor should be displayed).
16631 At the same time this space let's a nicely handle clearing to the
16632 end of the line if the row ends in italic text. */
16635 append_space_for_newline (struct it
*it
, int default_face_p
)
16637 if (FRAME_WINDOW_P (it
->f
))
16639 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16641 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16642 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16644 /* Save some values that must not be changed.
16645 Must save IT->c and IT->len because otherwise
16646 ITERATOR_AT_END_P wouldn't work anymore after
16647 append_space_for_newline has been called. */
16648 enum display_element_type saved_what
= it
->what
;
16649 int saved_c
= it
->c
, saved_len
= it
->len
;
16650 int saved_char_to_display
= it
->char_to_display
;
16651 int saved_x
= it
->current_x
;
16652 int saved_face_id
= it
->face_id
;
16653 struct text_pos saved_pos
;
16654 Lisp_Object saved_object
;
16657 saved_object
= it
->object
;
16658 saved_pos
= it
->position
;
16660 it
->what
= IT_CHARACTER
;
16661 memset (&it
->position
, 0, sizeof it
->position
);
16662 it
->object
= make_number (0);
16663 it
->c
= it
->char_to_display
= ' ';
16666 if (default_face_p
)
16667 it
->face_id
= DEFAULT_FACE_ID
;
16668 else if (it
->face_before_selective_p
)
16669 it
->face_id
= it
->saved_face_id
;
16670 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16671 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16673 PRODUCE_GLYPHS (it
);
16675 it
->override_ascent
= -1;
16676 it
->constrain_row_ascent_descent_p
= 0;
16677 it
->current_x
= saved_x
;
16678 it
->object
= saved_object
;
16679 it
->position
= saved_pos
;
16680 it
->what
= saved_what
;
16681 it
->face_id
= saved_face_id
;
16682 it
->len
= saved_len
;
16684 it
->char_to_display
= saved_char_to_display
;
16693 /* Extend the face of the last glyph in the text area of IT->glyph_row
16694 to the end of the display line. Called from display_line. If the
16695 glyph row is empty, add a space glyph to it so that we know the
16696 face to draw. Set the glyph row flag fill_line_p. If the glyph
16697 row is R2L, prepend a stretch glyph to cover the empty space to the
16698 left of the leftmost glyph. */
16701 extend_face_to_end_of_line (struct it
*it
)
16704 struct frame
*f
= it
->f
;
16706 /* If line is already filled, do nothing. Non window-system frames
16707 get a grace of one more ``pixel'' because their characters are
16708 1-``pixel'' wide, so they hit the equality too early. This grace
16709 is needed only for R2L rows that are not continued, to produce
16710 one extra blank where we could display the cursor. */
16711 if (it
->current_x
>= it
->last_visible_x
16712 + (!FRAME_WINDOW_P (f
)
16713 && it
->glyph_row
->reversed_p
16714 && !it
->glyph_row
->continued_p
))
16717 /* Face extension extends the background and box of IT->face_id
16718 to the end of the line. If the background equals the background
16719 of the frame, we don't have to do anything. */
16720 if (it
->face_before_selective_p
)
16721 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16723 face
= FACE_FROM_ID (f
, it
->face_id
);
16725 if (FRAME_WINDOW_P (f
)
16726 && it
->glyph_row
->displays_text_p
16727 && face
->box
== FACE_NO_BOX
16728 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16730 && !it
->glyph_row
->reversed_p
)
16733 /* Set the glyph row flag indicating that the face of the last glyph
16734 in the text area has to be drawn to the end of the text area. */
16735 it
->glyph_row
->fill_line_p
= 1;
16737 /* If current character of IT is not ASCII, make sure we have the
16738 ASCII face. This will be automatically undone the next time
16739 get_next_display_element returns a multibyte character. Note
16740 that the character will always be single byte in unibyte
16742 if (!ASCII_CHAR_P (it
->c
))
16744 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16747 if (FRAME_WINDOW_P (f
))
16749 /* If the row is empty, add a space with the current face of IT,
16750 so that we know which face to draw. */
16751 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16753 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16754 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16755 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16757 #ifdef HAVE_WINDOW_SYSTEM
16758 if (it
->glyph_row
->reversed_p
)
16760 /* Prepend a stretch glyph to the row, such that the
16761 rightmost glyph will be drawn flushed all the way to the
16762 right margin of the window. The stretch glyph that will
16763 occupy the empty space, if any, to the left of the
16765 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16766 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16767 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16769 int row_width
, stretch_ascent
, stretch_width
;
16770 struct text_pos saved_pos
;
16771 int saved_face_id
, saved_avoid_cursor
;
16773 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16774 row_width
+= g
->pixel_width
;
16775 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16776 if (stretch_width
> 0)
16779 (((it
->ascent
+ it
->descent
)
16780 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16781 saved_pos
= it
->position
;
16782 memset (&it
->position
, 0, sizeof it
->position
);
16783 saved_avoid_cursor
= it
->avoid_cursor_p
;
16784 it
->avoid_cursor_p
= 1;
16785 saved_face_id
= it
->face_id
;
16786 /* The last row's stretch glyph should get the default
16787 face, to avoid painting the rest of the window with
16788 the region face, if the region ends at ZV. */
16789 if (it
->glyph_row
->ends_at_zv_p
)
16790 it
->face_id
= DEFAULT_FACE_ID
;
16792 it
->face_id
= face
->id
;
16793 append_stretch_glyph (it
, make_number (0), stretch_width
,
16794 it
->ascent
+ it
->descent
, stretch_ascent
);
16795 it
->position
= saved_pos
;
16796 it
->avoid_cursor_p
= saved_avoid_cursor
;
16797 it
->face_id
= saved_face_id
;
16800 #endif /* HAVE_WINDOW_SYSTEM */
16804 /* Save some values that must not be changed. */
16805 int saved_x
= it
->current_x
;
16806 struct text_pos saved_pos
;
16807 Lisp_Object saved_object
;
16808 enum display_element_type saved_what
= it
->what
;
16809 int saved_face_id
= it
->face_id
;
16811 saved_object
= it
->object
;
16812 saved_pos
= it
->position
;
16814 it
->what
= IT_CHARACTER
;
16815 memset (&it
->position
, 0, sizeof it
->position
);
16816 it
->object
= make_number (0);
16817 it
->c
= it
->char_to_display
= ' ';
16819 /* The last row's blank glyphs should get the default face, to
16820 avoid painting the rest of the window with the region face,
16821 if the region ends at ZV. */
16822 if (it
->glyph_row
->ends_at_zv_p
)
16823 it
->face_id
= DEFAULT_FACE_ID
;
16825 it
->face_id
= face
->id
;
16827 PRODUCE_GLYPHS (it
);
16829 while (it
->current_x
<= it
->last_visible_x
)
16830 PRODUCE_GLYPHS (it
);
16832 /* Don't count these blanks really. It would let us insert a left
16833 truncation glyph below and make us set the cursor on them, maybe. */
16834 it
->current_x
= saved_x
;
16835 it
->object
= saved_object
;
16836 it
->position
= saved_pos
;
16837 it
->what
= saved_what
;
16838 it
->face_id
= saved_face_id
;
16843 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16844 trailing whitespace. */
16847 trailing_whitespace_p (EMACS_INT charpos
)
16849 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16852 while (bytepos
< ZV_BYTE
16853 && (c
= FETCH_CHAR (bytepos
),
16854 c
== ' ' || c
== '\t'))
16857 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16859 if (bytepos
!= PT_BYTE
)
16866 /* Highlight trailing whitespace, if any, in ROW. */
16869 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16871 int used
= row
->used
[TEXT_AREA
];
16875 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16876 struct glyph
*glyph
= start
+ used
- 1;
16878 if (row
->reversed_p
)
16880 /* Right-to-left rows need to be processed in the opposite
16881 direction, so swap the edge pointers. */
16883 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16886 /* Skip over glyphs inserted to display the cursor at the
16887 end of a line, for extending the face of the last glyph
16888 to the end of the line on terminals, and for truncation
16889 and continuation glyphs. */
16890 if (!row
->reversed_p
)
16892 while (glyph
>= start
16893 && glyph
->type
== CHAR_GLYPH
16894 && INTEGERP (glyph
->object
))
16899 while (glyph
<= start
16900 && glyph
->type
== CHAR_GLYPH
16901 && INTEGERP (glyph
->object
))
16905 /* If last glyph is a space or stretch, and it's trailing
16906 whitespace, set the face of all trailing whitespace glyphs in
16907 IT->glyph_row to `trailing-whitespace'. */
16908 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16909 && BUFFERP (glyph
->object
)
16910 && (glyph
->type
== STRETCH_GLYPH
16911 || (glyph
->type
== CHAR_GLYPH
16912 && glyph
->u
.ch
== ' '))
16913 && trailing_whitespace_p (glyph
->charpos
))
16915 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16919 if (!row
->reversed_p
)
16921 while (glyph
>= start
16922 && BUFFERP (glyph
->object
)
16923 && (glyph
->type
== STRETCH_GLYPH
16924 || (glyph
->type
== CHAR_GLYPH
16925 && glyph
->u
.ch
== ' ')))
16926 (glyph
--)->face_id
= face_id
;
16930 while (glyph
<= start
16931 && BUFFERP (glyph
->object
)
16932 && (glyph
->type
== STRETCH_GLYPH
16933 || (glyph
->type
== CHAR_GLYPH
16934 && glyph
->u
.ch
== ' ')))
16935 (glyph
++)->face_id
= face_id
;
16942 /* Value is non-zero if glyph row ROW in window W should be
16943 used to hold the cursor. */
16946 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
16948 int cursor_row_p
= 1;
16950 if (PT
== CHARPOS (row
->end
.pos
))
16952 /* Suppose the row ends on a string.
16953 Unless the row is continued, that means it ends on a newline
16954 in the string. If it's anything other than a display string
16955 (e.g. a before-string from an overlay), we don't want the
16956 cursor there. (This heuristic seems to give the optimal
16957 behavior for the various types of multi-line strings.) */
16958 if (CHARPOS (row
->end
.string_pos
) >= 0)
16960 if (row
->continued_p
)
16964 /* Check for `display' property. */
16965 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16966 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16967 struct glyph
*glyph
;
16970 for (glyph
= end
; glyph
>= beg
; --glyph
)
16971 if (STRINGP (glyph
->object
))
16974 = Fget_char_property (make_number (PT
),
16978 && display_prop_string_p (prop
, glyph
->object
));
16983 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16985 /* If the row ends in middle of a real character,
16986 and the line is continued, we want the cursor here.
16987 That's because CHARPOS (ROW->end.pos) would equal
16988 PT if PT is before the character. */
16989 if (!row
->ends_in_ellipsis_p
)
16990 cursor_row_p
= row
->continued_p
;
16992 /* If the row ends in an ellipsis, then
16993 CHARPOS (ROW->end.pos) will equal point after the
16994 invisible text. We want that position to be displayed
16995 after the ellipsis. */
16998 /* If the row ends at ZV, display the cursor at the end of that
16999 row instead of at the start of the row below. */
17000 else if (row
->ends_at_zv_p
)
17006 return cursor_row_p
;
17011 /* Push the display property PROP so that it will be rendered at the
17012 current position in IT. Return 1 if PROP was successfully pushed,
17016 push_display_prop (struct it
*it
, Lisp_Object prop
)
17020 if (STRINGP (prop
))
17022 if (SCHARS (prop
) == 0)
17029 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17030 it
->current
.overlay_string_index
= -1;
17031 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17032 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17033 it
->method
= GET_FROM_STRING
;
17034 it
->stop_charpos
= 0;
17036 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17038 it
->method
= GET_FROM_STRETCH
;
17041 #ifdef HAVE_WINDOW_SYSTEM
17042 else if (IMAGEP (prop
))
17044 it
->what
= IT_IMAGE
;
17045 it
->image_id
= lookup_image (it
->f
, prop
);
17046 it
->method
= GET_FROM_IMAGE
;
17048 #endif /* HAVE_WINDOW_SYSTEM */
17051 pop_it (it
); /* bogus display property, give up */
17058 /* Return the character-property PROP at the current position in IT. */
17061 get_it_property (struct it
*it
, Lisp_Object prop
)
17063 Lisp_Object position
;
17065 if (STRINGP (it
->object
))
17066 position
= make_number (IT_STRING_CHARPOS (*it
));
17067 else if (BUFFERP (it
->object
))
17068 position
= make_number (IT_CHARPOS (*it
));
17072 return Fget_char_property (position
, prop
, it
->object
);
17075 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17078 handle_line_prefix (struct it
*it
)
17080 Lisp_Object prefix
;
17081 if (it
->continuation_lines_width
> 0)
17083 prefix
= get_it_property (it
, Qwrap_prefix
);
17085 prefix
= Vwrap_prefix
;
17089 prefix
= get_it_property (it
, Qline_prefix
);
17091 prefix
= Vline_prefix
;
17093 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17095 /* If the prefix is wider than the window, and we try to wrap
17096 it, it would acquire its own wrap prefix, and so on till the
17097 iterator stack overflows. So, don't wrap the prefix. */
17098 it
->line_wrap
= TRUNCATE
;
17099 it
->avoid_cursor_p
= 1;
17105 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17106 only for R2L lines from display_line, when it decides that too many
17107 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17110 unproduce_glyphs (struct it
*it
, int n
)
17112 struct glyph
*glyph
, *end
;
17114 xassert (it
->glyph_row
);
17115 xassert (it
->glyph_row
->reversed_p
);
17116 xassert (it
->area
== TEXT_AREA
);
17117 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17119 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17120 n
= it
->glyph_row
->used
[TEXT_AREA
];
17121 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17122 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17123 for ( ; glyph
< end
; glyph
++)
17124 glyph
[-n
] = *glyph
;
17127 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17128 and ROW->maxpos. */
17130 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17131 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17132 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17134 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17135 lines' rows is implemented for bidi-reordered rows. */
17137 /* ROW->minpos is the value of min_pos, the minimal buffer position
17140 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17143 /* We didn't find _any_ valid buffer positions in any of the
17144 glyphs, so we must trust the iterator's computed
17146 row
->minpos
= row
->start
.pos
;
17147 max_pos
= CHARPOS (it
->current
.pos
);
17148 max_bpos
= BYTEPOS (it
->current
.pos
);
17154 /* Here are the various use-cases for ending the row, and the
17155 corresponding values for ROW->maxpos:
17157 Line ends in a newline from buffer eol_pos + 1
17158 Line is continued from buffer max_pos + 1
17159 Line is truncated on right it->current.pos
17160 Line ends in a newline from string max_pos
17161 Line is continued from string max_pos
17162 Line is continued from display vector max_pos
17163 Line is entirely from a string min_pos == max_pos
17164 Line is entirely from a display vector min_pos == max_pos
17165 Line that ends at ZV ZV
17167 If you discover other use-cases, please add them here as
17169 if (row
->ends_at_zv_p
)
17170 row
->maxpos
= it
->current
.pos
;
17171 else if (row
->used
[TEXT_AREA
])
17173 if (row
->ends_in_newline_from_string_p
)
17174 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17175 else if (CHARPOS (it
->eol_pos
) > 0)
17176 SET_TEXT_POS (row
->maxpos
,
17177 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17178 else if (row
->continued_p
)
17180 /* If max_pos is different from IT's current position, it
17181 means IT->method does not belong to the display element
17182 at max_pos. However, it also means that the display
17183 element at max_pos was displayed in its entirety on this
17184 line, which is equivalent to saying that the next line
17185 starts at the next buffer position. */
17186 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17187 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17190 INC_BOTH (max_pos
, max_bpos
);
17191 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17194 else if (row
->truncated_on_right_p
)
17195 /* display_line already called reseat_at_next_visible_line_start,
17196 which puts the iterator at the beginning of the next line, in
17197 the logical order. */
17198 row
->maxpos
= it
->current
.pos
;
17199 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17200 /* A line that is entirely from a string/image/stretch... */
17201 row
->maxpos
= row
->minpos
;
17206 row
->maxpos
= it
->current
.pos
;
17209 /* Construct the glyph row IT->glyph_row in the desired matrix of
17210 IT->w from text at the current position of IT. See dispextern.h
17211 for an overview of struct it. Value is non-zero if
17212 IT->glyph_row displays text, as opposed to a line displaying ZV
17216 display_line (struct it
*it
)
17218 struct glyph_row
*row
= it
->glyph_row
;
17219 Lisp_Object overlay_arrow_string
;
17221 int may_wrap
= 0, wrap_x
;
17222 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17223 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17224 int wrap_row_extra_line_spacing
;
17225 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17226 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17228 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17230 /* We always start displaying at hpos zero even if hscrolled. */
17231 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17233 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17234 >= it
->w
->desired_matrix
->nrows
)
17236 it
->w
->nrows_scale_factor
++;
17237 fonts_changed_p
= 1;
17241 /* Is IT->w showing the region? */
17242 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17244 /* Clear the result glyph row and enable it. */
17245 prepare_desired_row (row
);
17247 row
->y
= it
->current_y
;
17248 row
->start
= it
->start
;
17249 row
->continuation_lines_width
= it
->continuation_lines_width
;
17250 row
->displays_text_p
= 1;
17251 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17252 it
->starts_in_middle_of_char_p
= 0;
17254 /* Arrange the overlays nicely for our purposes. Usually, we call
17255 display_line on only one line at a time, in which case this
17256 can't really hurt too much, or we call it on lines which appear
17257 one after another in the buffer, in which case all calls to
17258 recenter_overlay_lists but the first will be pretty cheap. */
17259 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17261 /* Move over display elements that are not visible because we are
17262 hscrolled. This may stop at an x-position < IT->first_visible_x
17263 if the first glyph is partially visible or if we hit a line end. */
17264 if (it
->current_x
< it
->first_visible_x
)
17266 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17267 MOVE_TO_POS
| MOVE_TO_X
);
17271 /* We only do this when not calling `move_it_in_display_line_to'
17272 above, because move_it_in_display_line_to calls
17273 handle_line_prefix itself. */
17274 handle_line_prefix (it
);
17277 /* Get the initial row height. This is either the height of the
17278 text hscrolled, if there is any, or zero. */
17279 row
->ascent
= it
->max_ascent
;
17280 row
->height
= it
->max_ascent
+ it
->max_descent
;
17281 row
->phys_ascent
= it
->max_phys_ascent
;
17282 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17283 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17285 /* Utility macro to record max and min buffer positions seen until now. */
17286 #define RECORD_MAX_MIN_POS(IT) \
17289 if (IT_CHARPOS (*(IT)) < min_pos) \
17291 min_pos = IT_CHARPOS (*(IT)); \
17292 min_bpos = IT_BYTEPOS (*(IT)); \
17294 if (IT_CHARPOS (*(IT)) > max_pos) \
17296 max_pos = IT_CHARPOS (*(IT)); \
17297 max_bpos = IT_BYTEPOS (*(IT)); \
17302 /* Loop generating characters. The loop is left with IT on the next
17303 character to display. */
17306 int n_glyphs_before
, hpos_before
, x_before
;
17308 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17310 /* Retrieve the next thing to display. Value is zero if end of
17312 if (!get_next_display_element (it
))
17314 /* Maybe add a space at the end of this line that is used to
17315 display the cursor there under X. Set the charpos of the
17316 first glyph of blank lines not corresponding to any text
17318 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17319 row
->exact_window_width_line_p
= 1;
17320 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17321 || row
->used
[TEXT_AREA
] == 0)
17323 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17324 row
->displays_text_p
= 0;
17326 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17327 && (!MINI_WINDOW_P (it
->w
)
17328 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17329 row
->indicate_empty_line_p
= 1;
17332 it
->continuation_lines_width
= 0;
17333 row
->ends_at_zv_p
= 1;
17334 /* A row that displays right-to-left text must always have
17335 its last face extended all the way to the end of line,
17336 even if this row ends in ZV, because we still write to
17337 the screen left to right. */
17338 if (row
->reversed_p
)
17339 extend_face_to_end_of_line (it
);
17343 /* Now, get the metrics of what we want to display. This also
17344 generates glyphs in `row' (which is IT->glyph_row). */
17345 n_glyphs_before
= row
->used
[TEXT_AREA
];
17348 /* Remember the line height so far in case the next element doesn't
17349 fit on the line. */
17350 if (it
->line_wrap
!= TRUNCATE
)
17352 ascent
= it
->max_ascent
;
17353 descent
= it
->max_descent
;
17354 phys_ascent
= it
->max_phys_ascent
;
17355 phys_descent
= it
->max_phys_descent
;
17357 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17359 if (IT_DISPLAYING_WHITESPACE (it
))
17365 wrap_row_used
= row
->used
[TEXT_AREA
];
17366 wrap_row_ascent
= row
->ascent
;
17367 wrap_row_height
= row
->height
;
17368 wrap_row_phys_ascent
= row
->phys_ascent
;
17369 wrap_row_phys_height
= row
->phys_height
;
17370 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17371 wrap_row_min_pos
= min_pos
;
17372 wrap_row_min_bpos
= min_bpos
;
17373 wrap_row_max_pos
= max_pos
;
17374 wrap_row_max_bpos
= max_bpos
;
17380 PRODUCE_GLYPHS (it
);
17382 /* If this display element was in marginal areas, continue with
17384 if (it
->area
!= TEXT_AREA
)
17386 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17387 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17388 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17389 row
->phys_height
= max (row
->phys_height
,
17390 it
->max_phys_ascent
+ it
->max_phys_descent
);
17391 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17392 it
->max_extra_line_spacing
);
17393 set_iterator_to_next (it
, 1);
17397 /* Does the display element fit on the line? If we truncate
17398 lines, we should draw past the right edge of the window. If
17399 we don't truncate, we want to stop so that we can display the
17400 continuation glyph before the right margin. If lines are
17401 continued, there are two possible strategies for characters
17402 resulting in more than 1 glyph (e.g. tabs): Display as many
17403 glyphs as possible in this line and leave the rest for the
17404 continuation line, or display the whole element in the next
17405 line. Original redisplay did the former, so we do it also. */
17406 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17407 hpos_before
= it
->hpos
;
17410 if (/* Not a newline. */
17412 /* Glyphs produced fit entirely in the line. */
17413 && it
->current_x
< it
->last_visible_x
)
17415 it
->hpos
+= nglyphs
;
17416 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17417 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17418 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17419 row
->phys_height
= max (row
->phys_height
,
17420 it
->max_phys_ascent
+ it
->max_phys_descent
);
17421 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17422 it
->max_extra_line_spacing
);
17423 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17424 row
->x
= x
- it
->first_visible_x
;
17425 /* Record the maximum and minimum buffer positions seen so
17426 far in glyphs that will be displayed by this row. */
17428 RECORD_MAX_MIN_POS (it
);
17433 struct glyph
*glyph
;
17435 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17437 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17438 new_x
= x
+ glyph
->pixel_width
;
17440 if (/* Lines are continued. */
17441 it
->line_wrap
!= TRUNCATE
17442 && (/* Glyph doesn't fit on the line. */
17443 new_x
> it
->last_visible_x
17444 /* Or it fits exactly on a window system frame. */
17445 || (new_x
== it
->last_visible_x
17446 && FRAME_WINDOW_P (it
->f
))))
17448 /* End of a continued line. */
17451 || (new_x
== it
->last_visible_x
17452 && FRAME_WINDOW_P (it
->f
)))
17454 /* Current glyph is the only one on the line or
17455 fits exactly on the line. We must continue
17456 the line because we can't draw the cursor
17457 after the glyph. */
17458 row
->continued_p
= 1;
17459 it
->current_x
= new_x
;
17460 it
->continuation_lines_width
+= new_x
;
17462 /* Record the maximum and minimum buffer
17463 positions seen so far in glyphs that will be
17464 displayed by this row. */
17466 RECORD_MAX_MIN_POS (it
);
17467 if (i
== nglyphs
- 1)
17469 /* If line-wrap is on, check if a previous
17470 wrap point was found. */
17471 if (wrap_row_used
> 0
17472 /* Even if there is a previous wrap
17473 point, continue the line here as
17474 usual, if (i) the previous character
17475 was a space or tab AND (ii) the
17476 current character is not. */
17478 || IT_DISPLAYING_WHITESPACE (it
)))
17481 set_iterator_to_next (it
, 1);
17482 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17484 if (!get_next_display_element (it
))
17486 row
->exact_window_width_line_p
= 1;
17487 it
->continuation_lines_width
= 0;
17488 row
->continued_p
= 0;
17489 row
->ends_at_zv_p
= 1;
17491 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17493 row
->continued_p
= 0;
17494 row
->exact_window_width_line_p
= 1;
17499 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17500 && !FRAME_WINDOW_P (it
->f
))
17502 /* A padding glyph that doesn't fit on this line.
17503 This means the whole character doesn't fit
17505 if (row
->reversed_p
)
17506 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17507 - n_glyphs_before
);
17508 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17510 /* Fill the rest of the row with continuation
17511 glyphs like in 20.x. */
17512 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17513 < row
->glyphs
[1 + TEXT_AREA
])
17514 produce_special_glyphs (it
, IT_CONTINUATION
);
17516 row
->continued_p
= 1;
17517 it
->current_x
= x_before
;
17518 it
->continuation_lines_width
+= x_before
;
17520 /* Restore the height to what it was before the
17521 element not fitting on the line. */
17522 it
->max_ascent
= ascent
;
17523 it
->max_descent
= descent
;
17524 it
->max_phys_ascent
= phys_ascent
;
17525 it
->max_phys_descent
= phys_descent
;
17527 else if (wrap_row_used
> 0)
17530 if (row
->reversed_p
)
17531 unproduce_glyphs (it
,
17532 row
->used
[TEXT_AREA
] - wrap_row_used
);
17534 it
->continuation_lines_width
+= wrap_x
;
17535 row
->used
[TEXT_AREA
] = wrap_row_used
;
17536 row
->ascent
= wrap_row_ascent
;
17537 row
->height
= wrap_row_height
;
17538 row
->phys_ascent
= wrap_row_phys_ascent
;
17539 row
->phys_height
= wrap_row_phys_height
;
17540 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17541 min_pos
= wrap_row_min_pos
;
17542 min_bpos
= wrap_row_min_bpos
;
17543 max_pos
= wrap_row_max_pos
;
17544 max_bpos
= wrap_row_max_bpos
;
17545 row
->continued_p
= 1;
17546 row
->ends_at_zv_p
= 0;
17547 row
->exact_window_width_line_p
= 0;
17548 it
->continuation_lines_width
+= x
;
17550 /* Make sure that a non-default face is extended
17551 up to the right margin of the window. */
17552 extend_face_to_end_of_line (it
);
17554 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17556 /* A TAB that extends past the right edge of the
17557 window. This produces a single glyph on
17558 window system frames. We leave the glyph in
17559 this row and let it fill the row, but don't
17560 consume the TAB. */
17561 it
->continuation_lines_width
+= it
->last_visible_x
;
17562 row
->ends_in_middle_of_char_p
= 1;
17563 row
->continued_p
= 1;
17564 glyph
->pixel_width
= it
->last_visible_x
- x
;
17565 it
->starts_in_middle_of_char_p
= 1;
17569 /* Something other than a TAB that draws past
17570 the right edge of the window. Restore
17571 positions to values before the element. */
17572 if (row
->reversed_p
)
17573 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17574 - (n_glyphs_before
+ i
));
17575 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17577 /* Display continuation glyphs. */
17578 if (!FRAME_WINDOW_P (it
->f
))
17579 produce_special_glyphs (it
, IT_CONTINUATION
);
17580 row
->continued_p
= 1;
17582 it
->current_x
= x_before
;
17583 it
->continuation_lines_width
+= x
;
17584 extend_face_to_end_of_line (it
);
17586 if (nglyphs
> 1 && i
> 0)
17588 row
->ends_in_middle_of_char_p
= 1;
17589 it
->starts_in_middle_of_char_p
= 1;
17592 /* Restore the height to what it was before the
17593 element not fitting on the line. */
17594 it
->max_ascent
= ascent
;
17595 it
->max_descent
= descent
;
17596 it
->max_phys_ascent
= phys_ascent
;
17597 it
->max_phys_descent
= phys_descent
;
17602 else if (new_x
> it
->first_visible_x
)
17604 /* Increment number of glyphs actually displayed. */
17607 /* Record the maximum and minimum buffer positions
17608 seen so far in glyphs that will be displayed by
17611 RECORD_MAX_MIN_POS (it
);
17613 if (x
< it
->first_visible_x
)
17614 /* Glyph is partially visible, i.e. row starts at
17615 negative X position. */
17616 row
->x
= x
- it
->first_visible_x
;
17620 /* Glyph is completely off the left margin of the
17621 window. This should not happen because of the
17622 move_it_in_display_line at the start of this
17623 function, unless the text display area of the
17624 window is empty. */
17625 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17629 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17630 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17631 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17632 row
->phys_height
= max (row
->phys_height
,
17633 it
->max_phys_ascent
+ it
->max_phys_descent
);
17634 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17635 it
->max_extra_line_spacing
);
17637 /* End of this display line if row is continued. */
17638 if (row
->continued_p
|| row
->ends_at_zv_p
)
17643 /* Is this a line end? If yes, we're also done, after making
17644 sure that a non-default face is extended up to the right
17645 margin of the window. */
17646 if (ITERATOR_AT_END_OF_LINE_P (it
))
17648 int used_before
= row
->used
[TEXT_AREA
];
17650 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17652 /* Add a space at the end of the line that is used to
17653 display the cursor there. */
17654 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17655 append_space_for_newline (it
, 0);
17657 /* Extend the face to the end of the line. */
17658 extend_face_to_end_of_line (it
);
17660 /* Make sure we have the position. */
17661 if (used_before
== 0)
17662 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17664 /* Record the position of the newline, for use in
17666 it
->eol_pos
= it
->current
.pos
;
17668 /* Consume the line end. This skips over invisible lines. */
17669 set_iterator_to_next (it
, 1);
17670 it
->continuation_lines_width
= 0;
17674 /* Proceed with next display element. Note that this skips
17675 over lines invisible because of selective display. */
17676 set_iterator_to_next (it
, 1);
17678 /* If we truncate lines, we are done when the last displayed
17679 glyphs reach past the right margin of the window. */
17680 if (it
->line_wrap
== TRUNCATE
17681 && (FRAME_WINDOW_P (it
->f
)
17682 ? (it
->current_x
>= it
->last_visible_x
)
17683 : (it
->current_x
> it
->last_visible_x
)))
17685 /* Maybe add truncation glyphs. */
17686 if (!FRAME_WINDOW_P (it
->f
))
17690 if (!row
->reversed_p
)
17692 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17693 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17698 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17699 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17701 /* Remove any padding glyphs at the front of ROW, to
17702 make room for the truncation glyphs we will be
17703 adding below. The loop below always inserts at
17704 least one truncation glyph, so also remove the
17705 last glyph added to ROW. */
17706 unproduce_glyphs (it
, i
+ 1);
17707 /* Adjust i for the loop below. */
17708 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17711 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17713 row
->used
[TEXT_AREA
] = i
;
17714 produce_special_glyphs (it
, IT_TRUNCATION
);
17717 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17719 /* Don't truncate if we can overflow newline into fringe. */
17720 if (!get_next_display_element (it
))
17722 it
->continuation_lines_width
= 0;
17723 row
->ends_at_zv_p
= 1;
17724 row
->exact_window_width_line_p
= 1;
17727 if (ITERATOR_AT_END_OF_LINE_P (it
))
17729 row
->exact_window_width_line_p
= 1;
17730 goto at_end_of_line
;
17734 row
->truncated_on_right_p
= 1;
17735 it
->continuation_lines_width
= 0;
17736 reseat_at_next_visible_line_start (it
, 0);
17737 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17738 it
->hpos
= hpos_before
;
17739 it
->current_x
= x_before
;
17744 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17745 at the left window margin. */
17746 if (it
->first_visible_x
17747 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17749 if (!FRAME_WINDOW_P (it
->f
))
17750 insert_left_trunc_glyphs (it
);
17751 row
->truncated_on_left_p
= 1;
17754 /* Remember the position at which this line ends.
17756 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17757 cannot be before the call to find_row_edges below, since that is
17758 where these positions are determined. */
17759 row
->end
= it
->current
;
17762 row
->minpos
= row
->start
.pos
;
17763 row
->maxpos
= row
->end
.pos
;
17767 /* ROW->minpos and ROW->maxpos must be the smallest and
17768 `1 + the largest' buffer positions in ROW. But if ROW was
17769 bidi-reordered, these two positions can be anywhere in the
17770 row, so we must determine them now. */
17771 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17774 /* If the start of this line is the overlay arrow-position, then
17775 mark this glyph row as the one containing the overlay arrow.
17776 This is clearly a mess with variable size fonts. It would be
17777 better to let it be displayed like cursors under X. */
17778 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17779 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17780 !NILP (overlay_arrow_string
)))
17782 /* Overlay arrow in window redisplay is a fringe bitmap. */
17783 if (STRINGP (overlay_arrow_string
))
17785 struct glyph_row
*arrow_row
17786 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17787 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17788 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17789 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17790 struct glyph
*p2
, *end
;
17792 /* Copy the arrow glyphs. */
17793 while (glyph
< arrow_end
)
17796 /* Throw away padding glyphs. */
17798 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17799 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17805 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17810 xassert (INTEGERP (overlay_arrow_string
));
17811 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17813 overlay_arrow_seen
= 1;
17816 /* Compute pixel dimensions of this line. */
17817 compute_line_metrics (it
);
17819 /* Record whether this row ends inside an ellipsis. */
17820 row
->ends_in_ellipsis_p
17821 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17822 && it
->ellipsis_p
);
17824 /* Save fringe bitmaps in this row. */
17825 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17826 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17827 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17828 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17830 it
->left_user_fringe_bitmap
= 0;
17831 it
->left_user_fringe_face_id
= 0;
17832 it
->right_user_fringe_bitmap
= 0;
17833 it
->right_user_fringe_face_id
= 0;
17835 /* Maybe set the cursor. */
17836 cvpos
= it
->w
->cursor
.vpos
;
17838 /* In bidi-reordered rows, keep checking for proper cursor
17839 position even if one has been found already, because buffer
17840 positions in such rows change non-linearly with ROW->VPOS,
17841 when a line is continued. One exception: when we are at ZV,
17842 display cursor on the first suitable glyph row, since all
17843 the empty rows after that also have their position set to ZV. */
17844 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17845 lines' rows is implemented for bidi-reordered rows. */
17847 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17848 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17849 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17850 && cursor_row_p (it
->w
, row
))
17851 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17853 /* Highlight trailing whitespace. */
17854 if (!NILP (Vshow_trailing_whitespace
))
17855 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17857 /* Prepare for the next line. This line starts horizontally at (X
17858 HPOS) = (0 0). Vertical positions are incremented. As a
17859 convenience for the caller, IT->glyph_row is set to the next
17861 it
->current_x
= it
->hpos
= 0;
17862 it
->current_y
+= row
->height
;
17863 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17866 /* The next row should by default use the same value of the
17867 reversed_p flag as this one. set_iterator_to_next decides when
17868 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17869 the flag accordingly. */
17870 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17871 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17872 it
->start
= row
->end
;
17873 return row
->displays_text_p
;
17875 #undef RECORD_MAX_MIN_POS
17878 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17879 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17880 doc
: /* Return paragraph direction at point in BUFFER.
17881 Value is either `left-to-right' or `right-to-left'.
17882 If BUFFER is omitted or nil, it defaults to the current buffer.
17884 Paragraph direction determines how the text in the paragraph is displayed.
17885 In left-to-right paragraphs, text begins at the left margin of the window
17886 and the reading direction is generally left to right. In right-to-left
17887 paragraphs, text begins at the right margin and is read from right to left.
17889 See also `bidi-paragraph-direction'. */)
17890 (Lisp_Object buffer
)
17892 struct buffer
*buf
;
17893 struct buffer
*old
;
17896 buf
= current_buffer
;
17899 CHECK_BUFFER (buffer
);
17900 buf
= XBUFFER (buffer
);
17901 old
= current_buffer
;
17904 if (NILP (buf
->bidi_display_reordering
))
17905 return Qleft_to_right
;
17906 else if (!NILP (buf
->bidi_paragraph_direction
))
17907 return buf
->bidi_paragraph_direction
;
17910 /* Determine the direction from buffer text. We could try to
17911 use current_matrix if it is up to date, but this seems fast
17912 enough as it is. */
17913 struct bidi_it itb
;
17914 EMACS_INT pos
= BUF_PT (buf
);
17915 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17918 if (buf
!= current_buffer
)
17919 set_buffer_temp (buf
);
17920 /* bidi_paragraph_init finds the base direction of the paragraph
17921 by searching forward from paragraph start. We need the base
17922 direction of the current or _previous_ paragraph, so we need
17923 to make sure we are within that paragraph. To that end, find
17924 the previous non-empty line. */
17925 if (pos
>= ZV
&& pos
> BEGV
)
17928 bytepos
= CHAR_TO_BYTE (pos
);
17930 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
17931 || c
== ' ' || c
== '\t' || c
== '\f')
17933 if (bytepos
<= BEGV_BYTE
)
17938 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17941 itb
.bytepos
= bytepos
;
17943 itb
.separator_limit
= -1;
17944 itb
.paragraph_dir
= NEUTRAL_DIR
;
17946 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
17947 if (buf
!= current_buffer
)
17948 set_buffer_temp (old
);
17949 switch (itb
.paragraph_dir
)
17952 return Qleft_to_right
;
17955 return Qright_to_left
;
17965 /***********************************************************************
17967 ***********************************************************************/
17969 /* Redisplay the menu bar in the frame for window W.
17971 The menu bar of X frames that don't have X toolkit support is
17972 displayed in a special window W->frame->menu_bar_window.
17974 The menu bar of terminal frames is treated specially as far as
17975 glyph matrices are concerned. Menu bar lines are not part of
17976 windows, so the update is done directly on the frame matrix rows
17977 for the menu bar. */
17980 display_menu_bar (struct window
*w
)
17982 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17987 /* Don't do all this for graphical frames. */
17989 if (FRAME_W32_P (f
))
17992 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17998 if (FRAME_NS_P (f
))
18000 #endif /* HAVE_NS */
18002 #ifdef USE_X_TOOLKIT
18003 xassert (!FRAME_WINDOW_P (f
));
18004 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18005 it
.first_visible_x
= 0;
18006 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18007 #else /* not USE_X_TOOLKIT */
18008 if (FRAME_WINDOW_P (f
))
18010 /* Menu bar lines are displayed in the desired matrix of the
18011 dummy window menu_bar_window. */
18012 struct window
*menu_w
;
18013 xassert (WINDOWP (f
->menu_bar_window
));
18014 menu_w
= XWINDOW (f
->menu_bar_window
);
18015 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18017 it
.first_visible_x
= 0;
18018 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18022 /* This is a TTY frame, i.e. character hpos/vpos are used as
18024 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18026 it
.first_visible_x
= 0;
18027 it
.last_visible_x
= FRAME_COLS (f
);
18029 #endif /* not USE_X_TOOLKIT */
18031 if (! mode_line_inverse_video
)
18032 /* Force the menu-bar to be displayed in the default face. */
18033 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18035 /* Clear all rows of the menu bar. */
18036 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18038 struct glyph_row
*row
= it
.glyph_row
+ i
;
18039 clear_glyph_row (row
);
18040 row
->enabled_p
= 1;
18041 row
->full_width_p
= 1;
18044 /* Display all items of the menu bar. */
18045 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18046 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18048 Lisp_Object string
;
18050 /* Stop at nil string. */
18051 string
= AREF (items
, i
+ 1);
18055 /* Remember where item was displayed. */
18056 ASET (items
, i
+ 3, make_number (it
.hpos
));
18058 /* Display the item, pad with one space. */
18059 if (it
.current_x
< it
.last_visible_x
)
18060 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18061 SCHARS (string
) + 1, 0, 0, -1);
18064 /* Fill out the line with spaces. */
18065 if (it
.current_x
< it
.last_visible_x
)
18066 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18068 /* Compute the total height of the lines. */
18069 compute_line_metrics (&it
);
18074 /***********************************************************************
18076 ***********************************************************************/
18078 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18079 FORCE is non-zero, redisplay mode lines unconditionally.
18080 Otherwise, redisplay only mode lines that are garbaged. Value is
18081 the number of windows whose mode lines were redisplayed. */
18084 redisplay_mode_lines (Lisp_Object window
, int force
)
18088 while (!NILP (window
))
18090 struct window
*w
= XWINDOW (window
);
18092 if (WINDOWP (w
->hchild
))
18093 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18094 else if (WINDOWP (w
->vchild
))
18095 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18097 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18098 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18100 struct text_pos lpoint
;
18101 struct buffer
*old
= current_buffer
;
18103 /* Set the window's buffer for the mode line display. */
18104 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18105 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18107 /* Point refers normally to the selected window. For any
18108 other window, set up appropriate value. */
18109 if (!EQ (window
, selected_window
))
18111 struct text_pos pt
;
18113 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18114 if (CHARPOS (pt
) < BEGV
)
18115 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18116 else if (CHARPOS (pt
) > (ZV
- 1))
18117 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18119 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18122 /* Display mode lines. */
18123 clear_glyph_matrix (w
->desired_matrix
);
18124 if (display_mode_lines (w
))
18127 w
->must_be_updated_p
= 1;
18130 /* Restore old settings. */
18131 set_buffer_internal_1 (old
);
18132 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18142 /* Display the mode and/or header line of window W. Value is the
18143 sum number of mode lines and header lines displayed. */
18146 display_mode_lines (struct window
*w
)
18148 Lisp_Object old_selected_window
, old_selected_frame
;
18151 old_selected_frame
= selected_frame
;
18152 selected_frame
= w
->frame
;
18153 old_selected_window
= selected_window
;
18154 XSETWINDOW (selected_window
, w
);
18156 /* These will be set while the mode line specs are processed. */
18157 line_number_displayed
= 0;
18158 w
->column_number_displayed
= Qnil
;
18160 if (WINDOW_WANTS_MODELINE_P (w
))
18162 struct window
*sel_w
= XWINDOW (old_selected_window
);
18164 /* Select mode line face based on the real selected window. */
18165 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18166 current_buffer
->mode_line_format
);
18170 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18172 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18173 current_buffer
->header_line_format
);
18177 selected_frame
= old_selected_frame
;
18178 selected_window
= old_selected_window
;
18183 /* Display mode or header line of window W. FACE_ID specifies which
18184 line to display; it is either MODE_LINE_FACE_ID or
18185 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18186 display. Value is the pixel height of the mode/header line
18190 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18194 int count
= SPECPDL_INDEX ();
18196 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18197 /* Don't extend on a previously drawn mode-line.
18198 This may happen if called from pos_visible_p. */
18199 it
.glyph_row
->enabled_p
= 0;
18200 prepare_desired_row (it
.glyph_row
);
18202 it
.glyph_row
->mode_line_p
= 1;
18204 if (! mode_line_inverse_video
)
18205 /* Force the mode-line to be displayed in the default face. */
18206 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18208 record_unwind_protect (unwind_format_mode_line
,
18209 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18211 mode_line_target
= MODE_LINE_DISPLAY
;
18213 /* Temporarily make frame's keyboard the current kboard so that
18214 kboard-local variables in the mode_line_format will get the right
18216 push_kboard (FRAME_KBOARD (it
.f
));
18217 record_unwind_save_match_data ();
18218 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18221 unbind_to (count
, Qnil
);
18223 /* Fill up with spaces. */
18224 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18226 compute_line_metrics (&it
);
18227 it
.glyph_row
->full_width_p
= 1;
18228 it
.glyph_row
->continued_p
= 0;
18229 it
.glyph_row
->truncated_on_left_p
= 0;
18230 it
.glyph_row
->truncated_on_right_p
= 0;
18232 /* Make a 3D mode-line have a shadow at its right end. */
18233 face
= FACE_FROM_ID (it
.f
, face_id
);
18234 extend_face_to_end_of_line (&it
);
18235 if (face
->box
!= FACE_NO_BOX
)
18237 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18238 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18239 last
->right_box_line_p
= 1;
18242 return it
.glyph_row
->height
;
18245 /* Move element ELT in LIST to the front of LIST.
18246 Return the updated list. */
18249 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18251 register Lisp_Object tail
, prev
;
18252 register Lisp_Object tem
;
18256 while (CONSP (tail
))
18262 /* Splice out the link TAIL. */
18264 list
= XCDR (tail
);
18266 Fsetcdr (prev
, XCDR (tail
));
18268 /* Now make it the first. */
18269 Fsetcdr (tail
, list
);
18274 tail
= XCDR (tail
);
18278 /* Not found--return unchanged LIST. */
18282 /* Contribute ELT to the mode line for window IT->w. How it
18283 translates into text depends on its data type.
18285 IT describes the display environment in which we display, as usual.
18287 DEPTH is the depth in recursion. It is used to prevent
18288 infinite recursion here.
18290 FIELD_WIDTH is the number of characters the display of ELT should
18291 occupy in the mode line, and PRECISION is the maximum number of
18292 characters to display from ELT's representation. See
18293 display_string for details.
18295 Returns the hpos of the end of the text generated by ELT.
18297 PROPS is a property list to add to any string we encounter.
18299 If RISKY is nonzero, remove (disregard) any properties in any string
18300 we encounter, and ignore :eval and :propertize.
18302 The global variable `mode_line_target' determines whether the
18303 output is passed to `store_mode_line_noprop',
18304 `store_mode_line_string', or `display_string'. */
18307 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18308 Lisp_Object elt
, Lisp_Object props
, int risky
)
18310 int n
= 0, field
, prec
;
18315 elt
= build_string ("*too-deep*");
18319 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18323 /* A string: output it and check for %-constructs within it. */
18325 EMACS_INT offset
= 0;
18327 if (SCHARS (elt
) > 0
18328 && (!NILP (props
) || risky
))
18330 Lisp_Object oprops
, aelt
;
18331 oprops
= Ftext_properties_at (make_number (0), elt
);
18333 /* If the starting string's properties are not what
18334 we want, translate the string. Also, if the string
18335 is risky, do that anyway. */
18337 if (NILP (Fequal (props
, oprops
)) || risky
)
18339 /* If the starting string has properties,
18340 merge the specified ones onto the existing ones. */
18341 if (! NILP (oprops
) && !risky
)
18345 oprops
= Fcopy_sequence (oprops
);
18347 while (CONSP (tem
))
18349 oprops
= Fplist_put (oprops
, XCAR (tem
),
18350 XCAR (XCDR (tem
)));
18351 tem
= XCDR (XCDR (tem
));
18356 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18357 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18359 /* AELT is what we want. Move it to the front
18360 without consing. */
18362 mode_line_proptrans_alist
18363 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18369 /* If AELT has the wrong props, it is useless.
18370 so get rid of it. */
18372 mode_line_proptrans_alist
18373 = Fdelq (aelt
, mode_line_proptrans_alist
);
18375 elt
= Fcopy_sequence (elt
);
18376 Fset_text_properties (make_number (0), Flength (elt
),
18378 /* Add this item to mode_line_proptrans_alist. */
18379 mode_line_proptrans_alist
18380 = Fcons (Fcons (elt
, props
),
18381 mode_line_proptrans_alist
);
18382 /* Truncate mode_line_proptrans_alist
18383 to at most 50 elements. */
18384 tem
= Fnthcdr (make_number (50),
18385 mode_line_proptrans_alist
);
18387 XSETCDR (tem
, Qnil
);
18396 prec
= precision
- n
;
18397 switch (mode_line_target
)
18399 case MODE_LINE_NOPROP
:
18400 case MODE_LINE_TITLE
:
18401 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18403 case MODE_LINE_STRING
:
18404 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18406 case MODE_LINE_DISPLAY
:
18407 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18408 0, prec
, 0, STRING_MULTIBYTE (elt
));
18415 /* Handle the non-literal case. */
18417 while ((precision
<= 0 || n
< precision
)
18418 && SREF (elt
, offset
) != 0
18419 && (mode_line_target
!= MODE_LINE_DISPLAY
18420 || it
->current_x
< it
->last_visible_x
))
18422 EMACS_INT last_offset
= offset
;
18424 /* Advance to end of string or next format specifier. */
18425 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18428 if (offset
- 1 != last_offset
)
18430 EMACS_INT nchars
, nbytes
;
18432 /* Output to end of string or up to '%'. Field width
18433 is length of string. Don't output more than
18434 PRECISION allows us. */
18437 prec
= c_string_width (SDATA (elt
) + last_offset
,
18438 offset
- last_offset
, precision
- n
,
18441 switch (mode_line_target
)
18443 case MODE_LINE_NOPROP
:
18444 case MODE_LINE_TITLE
:
18445 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18447 case MODE_LINE_STRING
:
18449 EMACS_INT bytepos
= last_offset
;
18450 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18451 EMACS_INT endpos
= (precision
<= 0
18452 ? string_byte_to_char (elt
, offset
)
18453 : charpos
+ nchars
);
18455 n
+= store_mode_line_string (NULL
,
18456 Fsubstring (elt
, make_number (charpos
),
18457 make_number (endpos
)),
18461 case MODE_LINE_DISPLAY
:
18463 EMACS_INT bytepos
= last_offset
;
18464 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18466 if (precision
<= 0)
18467 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18468 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18470 STRING_MULTIBYTE (elt
));
18475 else /* c == '%' */
18477 EMACS_INT percent_position
= offset
;
18479 /* Get the specified minimum width. Zero means
18482 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18483 field
= field
* 10 + c
- '0';
18485 /* Don't pad beyond the total padding allowed. */
18486 if (field_width
- n
> 0 && field
> field_width
- n
)
18487 field
= field_width
- n
;
18489 /* Note that either PRECISION <= 0 or N < PRECISION. */
18490 prec
= precision
- n
;
18493 n
+= display_mode_element (it
, depth
, field
, prec
,
18494 Vglobal_mode_string
, props
,
18499 EMACS_INT bytepos
, charpos
;
18501 Lisp_Object string
;
18503 bytepos
= percent_position
;
18504 charpos
= (STRING_MULTIBYTE (elt
)
18505 ? string_byte_to_char (elt
, bytepos
)
18507 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18508 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18510 switch (mode_line_target
)
18512 case MODE_LINE_NOPROP
:
18513 case MODE_LINE_TITLE
:
18514 n
+= store_mode_line_noprop (spec
, field
, prec
);
18516 case MODE_LINE_STRING
:
18518 int len
= strlen (spec
);
18519 Lisp_Object tem
= make_string (spec
, len
);
18520 props
= Ftext_properties_at (make_number (charpos
), elt
);
18521 /* Should only keep face property in props */
18522 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18525 case MODE_LINE_DISPLAY
:
18527 int nglyphs_before
, nwritten
;
18529 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18530 nwritten
= display_string (spec
, string
, elt
,
18535 /* Assign to the glyphs written above the
18536 string where the `%x' came from, position
18540 struct glyph
*glyph
18541 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18545 for (i
= 0; i
< nwritten
; ++i
)
18547 glyph
[i
].object
= elt
;
18548 glyph
[i
].charpos
= charpos
;
18565 /* A symbol: process the value of the symbol recursively
18566 as if it appeared here directly. Avoid error if symbol void.
18567 Special case: if value of symbol is a string, output the string
18570 register Lisp_Object tem
;
18572 /* If the variable is not marked as risky to set
18573 then its contents are risky to use. */
18574 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18577 tem
= Fboundp (elt
);
18580 tem
= Fsymbol_value (elt
);
18581 /* If value is a string, output that string literally:
18582 don't check for % within it. */
18586 if (!EQ (tem
, elt
))
18588 /* Give up right away for nil or t. */
18598 register Lisp_Object car
, tem
;
18600 /* A cons cell: five distinct cases.
18601 If first element is :eval or :propertize, do something special.
18602 If first element is a string or a cons, process all the elements
18603 and effectively concatenate them.
18604 If first element is a negative number, truncate displaying cdr to
18605 at most that many characters. If positive, pad (with spaces)
18606 to at least that many characters.
18607 If first element is a symbol, process the cadr or caddr recursively
18608 according to whether the symbol's value is non-nil or nil. */
18610 if (EQ (car
, QCeval
))
18612 /* An element of the form (:eval FORM) means evaluate FORM
18613 and use the result as mode line elements. */
18618 if (CONSP (XCDR (elt
)))
18621 spec
= safe_eval (XCAR (XCDR (elt
)));
18622 n
+= display_mode_element (it
, depth
, field_width
- n
,
18623 precision
- n
, spec
, props
,
18627 else if (EQ (car
, QCpropertize
))
18629 /* An element of the form (:propertize ELT PROPS...)
18630 means display ELT but applying properties PROPS. */
18635 if (CONSP (XCDR (elt
)))
18636 n
+= display_mode_element (it
, depth
, field_width
- n
,
18637 precision
- n
, XCAR (XCDR (elt
)),
18638 XCDR (XCDR (elt
)), risky
);
18640 else if (SYMBOLP (car
))
18642 tem
= Fboundp (car
);
18646 /* elt is now the cdr, and we know it is a cons cell.
18647 Use its car if CAR has a non-nil value. */
18650 tem
= Fsymbol_value (car
);
18657 /* Symbol's value is nil (or symbol is unbound)
18658 Get the cddr of the original list
18659 and if possible find the caddr and use that. */
18663 else if (!CONSP (elt
))
18668 else if (INTEGERP (car
))
18670 register int lim
= XINT (car
);
18674 /* Negative int means reduce maximum width. */
18675 if (precision
<= 0)
18678 precision
= min (precision
, -lim
);
18682 /* Padding specified. Don't let it be more than
18683 current maximum. */
18685 lim
= min (precision
, lim
);
18687 /* If that's more padding than already wanted, queue it.
18688 But don't reduce padding already specified even if
18689 that is beyond the current truncation point. */
18690 field_width
= max (lim
, field_width
);
18694 else if (STRINGP (car
) || CONSP (car
))
18696 Lisp_Object halftail
= elt
;
18700 && (precision
<= 0 || n
< precision
))
18702 n
+= display_mode_element (it
, depth
,
18703 /* Do padding only after the last
18704 element in the list. */
18705 (! CONSP (XCDR (elt
))
18708 precision
- n
, XCAR (elt
),
18712 if ((len
& 1) == 0)
18713 halftail
= XCDR (halftail
);
18714 /* Check for cycle. */
18715 if (EQ (halftail
, elt
))
18724 elt
= build_string ("*invalid*");
18728 /* Pad to FIELD_WIDTH. */
18729 if (field_width
> 0 && n
< field_width
)
18731 switch (mode_line_target
)
18733 case MODE_LINE_NOPROP
:
18734 case MODE_LINE_TITLE
:
18735 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18737 case MODE_LINE_STRING
:
18738 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18740 case MODE_LINE_DISPLAY
:
18741 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18750 /* Store a mode-line string element in mode_line_string_list.
18752 If STRING is non-null, display that C string. Otherwise, the Lisp
18753 string LISP_STRING is displayed.
18755 FIELD_WIDTH is the minimum number of output glyphs to produce.
18756 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18757 with spaces. FIELD_WIDTH <= 0 means don't pad.
18759 PRECISION is the maximum number of characters to output from
18760 STRING. PRECISION <= 0 means don't truncate the string.
18762 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18763 properties to the string.
18765 PROPS are the properties to add to the string.
18766 The mode_line_string_face face property is always added to the string.
18770 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18771 int field_width
, int precision
, Lisp_Object props
)
18776 if (string
!= NULL
)
18778 len
= strlen (string
);
18779 if (precision
> 0 && len
> precision
)
18781 lisp_string
= make_string (string
, len
);
18783 props
= mode_line_string_face_prop
;
18784 else if (!NILP (mode_line_string_face
))
18786 Lisp_Object face
= Fplist_get (props
, Qface
);
18787 props
= Fcopy_sequence (props
);
18789 face
= mode_line_string_face
;
18791 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18792 props
= Fplist_put (props
, Qface
, face
);
18794 Fadd_text_properties (make_number (0), make_number (len
),
18795 props
, lisp_string
);
18799 len
= XFASTINT (Flength (lisp_string
));
18800 if (precision
> 0 && len
> precision
)
18803 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18806 if (!NILP (mode_line_string_face
))
18810 props
= Ftext_properties_at (make_number (0), lisp_string
);
18811 face
= Fplist_get (props
, Qface
);
18813 face
= mode_line_string_face
;
18815 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18816 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18818 lisp_string
= Fcopy_sequence (lisp_string
);
18821 Fadd_text_properties (make_number (0), make_number (len
),
18822 props
, lisp_string
);
18827 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18831 if (field_width
> len
)
18833 field_width
-= len
;
18834 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18836 Fadd_text_properties (make_number (0), make_number (field_width
),
18837 props
, lisp_string
);
18838 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18846 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18848 doc
: /* Format a string out of a mode line format specification.
18849 First arg FORMAT specifies the mode line format (see `mode-line-format'
18850 for details) to use.
18852 By default, the format is evaluated for the currently selected window.
18854 Optional second arg FACE specifies the face property to put on all
18855 characters for which no face is specified. The value nil means the
18856 default face. The value t means whatever face the window's mode line
18857 currently uses (either `mode-line' or `mode-line-inactive',
18858 depending on whether the window is the selected window or not).
18859 An integer value means the value string has no text
18862 Optional third and fourth args WINDOW and BUFFER specify the window
18863 and buffer to use as the context for the formatting (defaults
18864 are the selected window and the WINDOW's buffer). */)
18865 (Lisp_Object format
, Lisp_Object face
,
18866 Lisp_Object window
, Lisp_Object buffer
)
18871 struct buffer
*old_buffer
= NULL
;
18873 int no_props
= INTEGERP (face
);
18874 int count
= SPECPDL_INDEX ();
18876 int string_start
= 0;
18879 window
= selected_window
;
18880 CHECK_WINDOW (window
);
18881 w
= XWINDOW (window
);
18884 buffer
= w
->buffer
;
18885 CHECK_BUFFER (buffer
);
18887 /* Make formatting the modeline a non-op when noninteractive, otherwise
18888 there will be problems later caused by a partially initialized frame. */
18889 if (NILP (format
) || noninteractive
)
18890 return empty_unibyte_string
;
18895 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
18896 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
18897 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
18898 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
18899 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
18900 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
18901 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
18904 if (XBUFFER (buffer
) != current_buffer
)
18905 old_buffer
= current_buffer
;
18907 /* Save things including mode_line_proptrans_alist,
18908 and set that to nil so that we don't alter the outer value. */
18909 record_unwind_protect (unwind_format_mode_line
,
18910 format_mode_line_unwind_data
18911 (old_buffer
, selected_window
, 1));
18912 mode_line_proptrans_alist
= Qnil
;
18914 Fselect_window (window
, Qt
);
18916 set_buffer_internal_1 (XBUFFER (buffer
));
18918 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18922 mode_line_target
= MODE_LINE_NOPROP
;
18923 mode_line_string_face_prop
= Qnil
;
18924 mode_line_string_list
= Qnil
;
18925 string_start
= MODE_LINE_NOPROP_LEN (0);
18929 mode_line_target
= MODE_LINE_STRING
;
18930 mode_line_string_list
= Qnil
;
18931 mode_line_string_face
= face
;
18932 mode_line_string_face_prop
18933 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18936 push_kboard (FRAME_KBOARD (it
.f
));
18937 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18942 len
= MODE_LINE_NOPROP_LEN (string_start
);
18943 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18947 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18948 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18949 empty_unibyte_string
);
18952 unbind_to (count
, Qnil
);
18956 /* Write a null-terminated, right justified decimal representation of
18957 the positive integer D to BUF using a minimal field width WIDTH. */
18960 pint2str (register char *buf
, register int width
, register int d
)
18962 register char *p
= buf
;
18970 *p
++ = d
% 10 + '0';
18975 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18986 /* Write a null-terminated, right justified decimal and "human
18987 readable" representation of the nonnegative integer D to BUF using
18988 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18990 static const char power_letter
[] =
19004 pint2hrstr (char *buf
, int width
, int d
)
19006 /* We aim to represent the nonnegative integer D as
19007 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19010 /* -1 means: do not use TENTHS. */
19014 /* Length of QUOTIENT.TENTHS as a string. */
19020 if (1000 <= quotient
)
19022 /* Scale to the appropriate EXPONENT. */
19025 remainder
= quotient
% 1000;
19029 while (1000 <= quotient
);
19031 /* Round to nearest and decide whether to use TENTHS or not. */
19034 tenths
= remainder
/ 100;
19035 if (50 <= remainder
% 100)
19042 if (quotient
== 10)
19050 if (500 <= remainder
)
19052 if (quotient
< 999)
19063 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19064 if (tenths
== -1 && quotient
<= 99)
19071 p
= psuffix
= buf
+ max (width
, length
);
19073 /* Print EXPONENT. */
19075 *psuffix
++ = power_letter
[exponent
];
19078 /* Print TENTHS. */
19081 *--p
= '0' + tenths
;
19085 /* Print QUOTIENT. */
19088 int digit
= quotient
% 10;
19089 *--p
= '0' + digit
;
19091 while ((quotient
/= 10) != 0);
19093 /* Print leading spaces. */
19098 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19099 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19100 type of CODING_SYSTEM. Return updated pointer into BUF. */
19102 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19105 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19108 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19109 const unsigned char *eol_str
;
19111 /* The EOL conversion we are using. */
19112 Lisp_Object eoltype
;
19114 val
= CODING_SYSTEM_SPEC (coding_system
);
19117 if (!VECTORP (val
)) /* Not yet decided. */
19122 eoltype
= eol_mnemonic_undecided
;
19123 /* Don't mention EOL conversion if it isn't decided. */
19128 Lisp_Object eolvalue
;
19130 attrs
= AREF (val
, 0);
19131 eolvalue
= AREF (val
, 2);
19134 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19138 /* The EOL conversion that is normal on this system. */
19140 if (NILP (eolvalue
)) /* Not yet decided. */
19141 eoltype
= eol_mnemonic_undecided
;
19142 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19143 eoltype
= eol_mnemonic_undecided
;
19144 else /* eolvalue is Qunix, Qdos, or Qmac. */
19145 eoltype
= (EQ (eolvalue
, Qunix
)
19146 ? eol_mnemonic_unix
19147 : (EQ (eolvalue
, Qdos
) == 1
19148 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19154 /* Mention the EOL conversion if it is not the usual one. */
19155 if (STRINGP (eoltype
))
19157 eol_str
= SDATA (eoltype
);
19158 eol_str_len
= SBYTES (eoltype
);
19160 else if (CHARACTERP (eoltype
))
19162 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19163 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19168 eol_str
= invalid_eol_type
;
19169 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19171 memcpy (buf
, eol_str
, eol_str_len
);
19172 buf
+= eol_str_len
;
19178 /* Return a string for the output of a mode line %-spec for window W,
19179 generated by character C. PRECISION >= 0 means don't return a
19180 string longer than that value. FIELD_WIDTH > 0 means pad the
19181 string returned with spaces to that value. Return a Lisp string in
19182 *STRING if the resulting string is taken from that Lisp string.
19184 Note we operate on the current buffer for most purposes,
19185 the exception being w->base_line_pos. */
19187 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19189 static const char *
19190 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19191 int precision
, Lisp_Object
*string
)
19194 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19195 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19196 struct buffer
*b
= current_buffer
;
19204 if (!NILP (b
->read_only
))
19206 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19211 /* This differs from %* only for a modified read-only buffer. */
19212 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19214 if (!NILP (b
->read_only
))
19219 /* This differs from %* in ignoring read-only-ness. */
19220 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19232 if (command_loop_level
> 5)
19234 p
= decode_mode_spec_buf
;
19235 for (i
= 0; i
< command_loop_level
; i
++)
19238 return decode_mode_spec_buf
;
19246 if (command_loop_level
> 5)
19248 p
= decode_mode_spec_buf
;
19249 for (i
= 0; i
< command_loop_level
; i
++)
19252 return decode_mode_spec_buf
;
19259 /* Let lots_of_dashes be a string of infinite length. */
19260 if (mode_line_target
== MODE_LINE_NOPROP
||
19261 mode_line_target
== MODE_LINE_STRING
)
19263 if (field_width
<= 0
19264 || field_width
> sizeof (lots_of_dashes
))
19266 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19267 decode_mode_spec_buf
[i
] = '-';
19268 decode_mode_spec_buf
[i
] = '\0';
19269 return decode_mode_spec_buf
;
19272 return lots_of_dashes
;
19280 /* %c and %l are ignored in `frame-title-format'.
19281 (In redisplay_internal, the frame title is drawn _before_ the
19282 windows are updated, so the stuff which depends on actual
19283 window contents (such as %l) may fail to render properly, or
19284 even crash emacs.) */
19285 if (mode_line_target
== MODE_LINE_TITLE
)
19289 int col
= (int) current_column (); /* iftc */
19290 w
->column_number_displayed
= make_number (col
);
19291 pint2str (decode_mode_spec_buf
, field_width
, col
);
19292 return decode_mode_spec_buf
;
19296 #ifndef SYSTEM_MALLOC
19298 if (NILP (Vmemory_full
))
19301 return "!MEM FULL! ";
19308 /* %F displays the frame name. */
19309 if (!NILP (f
->title
))
19310 return SSDATA (f
->title
);
19311 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19312 return SSDATA (f
->name
);
19321 EMACS_INT size
= ZV
- BEGV
;
19322 pint2str (decode_mode_spec_buf
, field_width
, size
);
19323 return decode_mode_spec_buf
;
19328 EMACS_INT size
= ZV
- BEGV
;
19329 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19330 return decode_mode_spec_buf
;
19335 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19336 int topline
, nlines
, height
;
19339 /* %c and %l are ignored in `frame-title-format'. */
19340 if (mode_line_target
== MODE_LINE_TITLE
)
19343 startpos
= XMARKER (w
->start
)->charpos
;
19344 startpos_byte
= marker_byte_position (w
->start
);
19345 height
= WINDOW_TOTAL_LINES (w
);
19347 /* If we decided that this buffer isn't suitable for line numbers,
19348 don't forget that too fast. */
19349 if (EQ (w
->base_line_pos
, w
->buffer
))
19351 /* But do forget it, if the window shows a different buffer now. */
19352 else if (BUFFERP (w
->base_line_pos
))
19353 w
->base_line_pos
= Qnil
;
19355 /* If the buffer is very big, don't waste time. */
19356 if (INTEGERP (Vline_number_display_limit
)
19357 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19359 w
->base_line_pos
= Qnil
;
19360 w
->base_line_number
= Qnil
;
19364 if (INTEGERP (w
->base_line_number
)
19365 && INTEGERP (w
->base_line_pos
)
19366 && XFASTINT (w
->base_line_pos
) <= startpos
)
19368 line
= XFASTINT (w
->base_line_number
);
19369 linepos
= XFASTINT (w
->base_line_pos
);
19370 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19375 linepos
= BUF_BEGV (b
);
19376 linepos_byte
= BUF_BEGV_BYTE (b
);
19379 /* Count lines from base line to window start position. */
19380 nlines
= display_count_lines (linepos
, linepos_byte
,
19384 topline
= nlines
+ line
;
19386 /* Determine a new base line, if the old one is too close
19387 or too far away, or if we did not have one.
19388 "Too close" means it's plausible a scroll-down would
19389 go back past it. */
19390 if (startpos
== BUF_BEGV (b
))
19392 w
->base_line_number
= make_number (topline
);
19393 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19395 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19396 || linepos
== BUF_BEGV (b
))
19398 EMACS_INT limit
= BUF_BEGV (b
);
19399 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19400 EMACS_INT position
;
19401 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19403 if (startpos
- distance
> limit
)
19405 limit
= startpos
- distance
;
19406 limit_byte
= CHAR_TO_BYTE (limit
);
19409 nlines
= display_count_lines (startpos
, startpos_byte
,
19411 - (height
* 2 + 30),
19413 /* If we couldn't find the lines we wanted within
19414 line_number_display_limit_width chars per line,
19415 give up on line numbers for this window. */
19416 if (position
== limit_byte
&& limit
== startpos
- distance
)
19418 w
->base_line_pos
= w
->buffer
;
19419 w
->base_line_number
= Qnil
;
19423 w
->base_line_number
= make_number (topline
- nlines
);
19424 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19427 /* Now count lines from the start pos to point. */
19428 nlines
= display_count_lines (startpos
, startpos_byte
,
19429 PT_BYTE
, PT
, &junk
);
19431 /* Record that we did display the line number. */
19432 line_number_displayed
= 1;
19434 /* Make the string to show. */
19435 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19436 return decode_mode_spec_buf
;
19439 char* p
= decode_mode_spec_buf
;
19440 int pad
= field_width
- 2;
19446 return decode_mode_spec_buf
;
19452 obj
= b
->mode_name
;
19456 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19462 EMACS_INT pos
= marker_position (w
->start
);
19463 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19465 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19467 if (pos
<= BUF_BEGV (b
))
19472 else if (pos
<= BUF_BEGV (b
))
19476 if (total
> 1000000)
19477 /* Do it differently for a large value, to avoid overflow. */
19478 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19480 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19481 /* We can't normally display a 3-digit number,
19482 so get us a 2-digit number that is close. */
19485 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19486 return decode_mode_spec_buf
;
19490 /* Display percentage of size above the bottom of the screen. */
19493 EMACS_INT toppos
= marker_position (w
->start
);
19494 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19495 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19497 if (botpos
>= BUF_ZV (b
))
19499 if (toppos
<= BUF_BEGV (b
))
19506 if (total
> 1000000)
19507 /* Do it differently for a large value, to avoid overflow. */
19508 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19510 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19511 /* We can't normally display a 3-digit number,
19512 so get us a 2-digit number that is close. */
19515 if (toppos
<= BUF_BEGV (b
))
19516 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19518 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19519 return decode_mode_spec_buf
;
19524 /* status of process */
19525 obj
= Fget_buffer_process (Fcurrent_buffer ());
19527 return "no process";
19529 obj
= Fsymbol_name (Fprocess_status (obj
));
19535 int count
= inhibit_garbage_collection ();
19536 Lisp_Object val
= call1 (intern ("file-remote-p"),
19537 current_buffer
->directory
);
19538 unbind_to (count
, Qnil
);
19546 case 't': /* indicate TEXT or BINARY */
19547 #ifdef MODE_LINE_BINARY_TEXT
19548 return MODE_LINE_BINARY_TEXT (b
);
19554 /* coding-system (not including end-of-line format) */
19556 /* coding-system (including end-of-line type) */
19558 int eol_flag
= (c
== 'Z');
19559 char *p
= decode_mode_spec_buf
;
19561 if (! FRAME_WINDOW_P (f
))
19563 /* No need to mention EOL here--the terminal never needs
19564 to do EOL conversion. */
19565 p
= decode_mode_spec_coding (CODING_ID_NAME
19566 (FRAME_KEYBOARD_CODING (f
)->id
),
19568 p
= decode_mode_spec_coding (CODING_ID_NAME
19569 (FRAME_TERMINAL_CODING (f
)->id
),
19572 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19575 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19576 #ifdef subprocesses
19577 obj
= Fget_buffer_process (Fcurrent_buffer ());
19578 if (PROCESSP (obj
))
19580 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19582 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19585 #endif /* subprocesses */
19588 return decode_mode_spec_buf
;
19595 return SSDATA (obj
);
19602 /* Count up to COUNT lines starting from START / START_BYTE.
19603 But don't go beyond LIMIT_BYTE.
19604 Return the number of lines thus found (always nonnegative).
19606 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19609 display_count_lines (EMACS_INT start
, EMACS_INT start_byte
,
19610 EMACS_INT limit_byte
, int count
,
19611 EMACS_INT
*byte_pos_ptr
)
19613 register unsigned char *cursor
;
19614 unsigned char *base
;
19616 register int ceiling
;
19617 register unsigned char *ceiling_addr
;
19618 int orig_count
= count
;
19620 /* If we are not in selective display mode,
19621 check only for newlines. */
19622 int selective_display
= (!NILP (current_buffer
->selective_display
)
19623 && !INTEGERP (current_buffer
->selective_display
));
19627 while (start_byte
< limit_byte
)
19629 ceiling
= BUFFER_CEILING_OF (start_byte
);
19630 ceiling
= min (limit_byte
- 1, ceiling
);
19631 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19632 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19635 if (selective_display
)
19636 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19639 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19642 if (cursor
!= ceiling_addr
)
19646 start_byte
+= cursor
- base
+ 1;
19647 *byte_pos_ptr
= start_byte
;
19651 if (++cursor
== ceiling_addr
)
19657 start_byte
+= cursor
- base
;
19662 while (start_byte
> limit_byte
)
19664 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19665 ceiling
= max (limit_byte
, ceiling
);
19666 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19667 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19670 if (selective_display
)
19671 while (--cursor
!= ceiling_addr
19672 && *cursor
!= '\n' && *cursor
!= 015)
19675 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19678 if (cursor
!= ceiling_addr
)
19682 start_byte
+= cursor
- base
+ 1;
19683 *byte_pos_ptr
= start_byte
;
19684 /* When scanning backwards, we should
19685 not count the newline posterior to which we stop. */
19686 return - orig_count
- 1;
19692 /* Here we add 1 to compensate for the last decrement
19693 of CURSOR, which took it past the valid range. */
19694 start_byte
+= cursor
- base
+ 1;
19698 *byte_pos_ptr
= limit_byte
;
19701 return - orig_count
+ count
;
19702 return orig_count
- count
;
19708 /***********************************************************************
19710 ***********************************************************************/
19712 /* Display a NUL-terminated string, starting with index START.
19714 If STRING is non-null, display that C string. Otherwise, the Lisp
19715 string LISP_STRING is displayed. There's a case that STRING is
19716 non-null and LISP_STRING is not nil. It means STRING is a string
19717 data of LISP_STRING. In that case, we display LISP_STRING while
19718 ignoring its text properties.
19720 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19721 FACE_STRING. Display STRING or LISP_STRING with the face at
19722 FACE_STRING_POS in FACE_STRING:
19724 Display the string in the environment given by IT, but use the
19725 standard display table, temporarily.
19727 FIELD_WIDTH is the minimum number of output glyphs to produce.
19728 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19729 with spaces. If STRING has more characters, more than FIELD_WIDTH
19730 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19732 PRECISION is the maximum number of characters to output from
19733 STRING. PRECISION < 0 means don't truncate the string.
19735 This is roughly equivalent to printf format specifiers:
19737 FIELD_WIDTH PRECISION PRINTF
19738 ----------------------------------------
19744 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19745 display them, and < 0 means obey the current buffer's value of
19746 enable_multibyte_characters.
19748 Value is the number of columns displayed. */
19751 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19752 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19753 int field_width
, int precision
, int max_x
, int multibyte
)
19755 int hpos_at_start
= it
->hpos
;
19756 int saved_face_id
= it
->face_id
;
19757 struct glyph_row
*row
= it
->glyph_row
;
19759 /* Initialize the iterator IT for iteration over STRING beginning
19760 with index START. */
19761 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19762 precision
, field_width
, multibyte
);
19763 if (string
&& STRINGP (lisp_string
))
19764 /* LISP_STRING is the one returned by decode_mode_spec. We should
19765 ignore its text properties. */
19766 it
->stop_charpos
= -1;
19768 /* If displaying STRING, set up the face of the iterator
19769 from LISP_STRING, if that's given. */
19770 if (STRINGP (face_string
))
19776 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19777 0, it
->region_beg_charpos
,
19778 it
->region_end_charpos
,
19779 &endptr
, it
->base_face_id
, 0);
19780 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19781 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19784 /* Set max_x to the maximum allowed X position. Don't let it go
19785 beyond the right edge of the window. */
19787 max_x
= it
->last_visible_x
;
19789 max_x
= min (max_x
, it
->last_visible_x
);
19791 /* Skip over display elements that are not visible. because IT->w is
19793 if (it
->current_x
< it
->first_visible_x
)
19794 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19795 MOVE_TO_POS
| MOVE_TO_X
);
19797 row
->ascent
= it
->max_ascent
;
19798 row
->height
= it
->max_ascent
+ it
->max_descent
;
19799 row
->phys_ascent
= it
->max_phys_ascent
;
19800 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19801 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19803 /* This condition is for the case that we are called with current_x
19804 past last_visible_x. */
19805 while (it
->current_x
< max_x
)
19807 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19809 /* Get the next display element. */
19810 if (!get_next_display_element (it
))
19813 /* Produce glyphs. */
19814 x_before
= it
->current_x
;
19815 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19816 PRODUCE_GLYPHS (it
);
19818 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19821 while (i
< nglyphs
)
19823 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19825 if (it
->line_wrap
!= TRUNCATE
19826 && x
+ glyph
->pixel_width
> max_x
)
19828 /* End of continued line or max_x reached. */
19829 if (CHAR_GLYPH_PADDING_P (*glyph
))
19831 /* A wide character is unbreakable. */
19832 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19833 it
->current_x
= x_before
;
19837 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19842 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19844 /* Glyph is at least partially visible. */
19846 if (x
< it
->first_visible_x
)
19847 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19851 /* Glyph is off the left margin of the display area.
19852 Should not happen. */
19856 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19857 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19858 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19859 row
->phys_height
= max (row
->phys_height
,
19860 it
->max_phys_ascent
+ it
->max_phys_descent
);
19861 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19862 it
->max_extra_line_spacing
);
19863 x
+= glyph
->pixel_width
;
19867 /* Stop if max_x reached. */
19871 /* Stop at line ends. */
19872 if (ITERATOR_AT_END_OF_LINE_P (it
))
19874 it
->continuation_lines_width
= 0;
19878 set_iterator_to_next (it
, 1);
19880 /* Stop if truncating at the right edge. */
19881 if (it
->line_wrap
== TRUNCATE
19882 && it
->current_x
>= it
->last_visible_x
)
19884 /* Add truncation mark, but don't do it if the line is
19885 truncated at a padding space. */
19886 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19888 if (!FRAME_WINDOW_P (it
->f
))
19892 if (it
->current_x
> it
->last_visible_x
)
19894 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19895 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19897 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19899 row
->used
[TEXT_AREA
] = i
;
19900 produce_special_glyphs (it
, IT_TRUNCATION
);
19903 produce_special_glyphs (it
, IT_TRUNCATION
);
19905 it
->glyph_row
->truncated_on_right_p
= 1;
19911 /* Maybe insert a truncation at the left. */
19912 if (it
->first_visible_x
19913 && IT_CHARPOS (*it
) > 0)
19915 if (!FRAME_WINDOW_P (it
->f
))
19916 insert_left_trunc_glyphs (it
);
19917 it
->glyph_row
->truncated_on_left_p
= 1;
19920 it
->face_id
= saved_face_id
;
19922 /* Value is number of columns displayed. */
19923 return it
->hpos
- hpos_at_start
;
19928 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19929 appears as an element of LIST or as the car of an element of LIST.
19930 If PROPVAL is a list, compare each element against LIST in that
19931 way, and return 1/2 if any element of PROPVAL is found in LIST.
19932 Otherwise return 0. This function cannot quit.
19933 The return value is 2 if the text is invisible but with an ellipsis
19934 and 1 if it's invisible and without an ellipsis. */
19937 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19939 register Lisp_Object tail
, proptail
;
19941 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19943 register Lisp_Object tem
;
19945 if (EQ (propval
, tem
))
19947 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19948 return NILP (XCDR (tem
)) ? 1 : 2;
19951 if (CONSP (propval
))
19953 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19955 Lisp_Object propelt
;
19956 propelt
= XCAR (proptail
);
19957 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19959 register Lisp_Object tem
;
19961 if (EQ (propelt
, tem
))
19963 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19964 return NILP (XCDR (tem
)) ? 1 : 2;
19972 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19973 doc
: /* Non-nil if the property makes the text invisible.
19974 POS-OR-PROP can be a marker or number, in which case it is taken to be
19975 a position in the current buffer and the value of the `invisible' property
19976 is checked; or it can be some other value, which is then presumed to be the
19977 value of the `invisible' property of the text of interest.
19978 The non-nil value returned can be t for truly invisible text or something
19979 else if the text is replaced by an ellipsis. */)
19980 (Lisp_Object pos_or_prop
)
19983 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19984 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19986 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19987 return (invis
== 0 ? Qnil
19989 : make_number (invis
));
19992 /* Calculate a width or height in pixels from a specification using
19993 the following elements:
19996 NUM - a (fractional) multiple of the default font width/height
19997 (NUM) - specifies exactly NUM pixels
19998 UNIT - a fixed number of pixels, see below.
19999 ELEMENT - size of a display element in pixels, see below.
20000 (NUM . SPEC) - equals NUM * SPEC
20001 (+ SPEC SPEC ...) - add pixel values
20002 (- SPEC SPEC ...) - subtract pixel values
20003 (- SPEC) - negate pixel value
20006 INT or FLOAT - a number constant
20007 SYMBOL - use symbol's (buffer local) variable binding.
20010 in - pixels per inch *)
20011 mm - pixels per 1/1000 meter *)
20012 cm - pixels per 1/100 meter *)
20013 width - width of current font in pixels.
20014 height - height of current font in pixels.
20016 *) using the ratio(s) defined in display-pixels-per-inch.
20020 left-fringe - left fringe width in pixels
20021 right-fringe - right fringe width in pixels
20023 left-margin - left margin width in pixels
20024 right-margin - right margin width in pixels
20026 scroll-bar - scroll-bar area width in pixels
20030 Pixels corresponding to 5 inches:
20033 Total width of non-text areas on left side of window (if scroll-bar is on left):
20034 '(space :width (+ left-fringe left-margin scroll-bar))
20036 Align to first text column (in header line):
20037 '(space :align-to 0)
20039 Align to middle of text area minus half the width of variable `my-image'
20040 containing a loaded image:
20041 '(space :align-to (0.5 . (- text my-image)))
20043 Width of left margin minus width of 1 character in the default font:
20044 '(space :width (- left-margin 1))
20046 Width of left margin minus width of 2 characters in the current font:
20047 '(space :width (- left-margin (2 . width)))
20049 Center 1 character over left-margin (in header line):
20050 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20052 Different ways to express width of left fringe plus left margin minus one pixel:
20053 '(space :width (- (+ left-fringe left-margin) (1)))
20054 '(space :width (+ left-fringe left-margin (- (1))))
20055 '(space :width (+ left-fringe left-margin (-1)))
20059 #define NUMVAL(X) \
20060 ((INTEGERP (X) || FLOATP (X)) \
20065 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20066 struct font
*font
, int width_p
, int *align_to
)
20070 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20071 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20074 return OK_PIXELS (0);
20076 xassert (FRAME_LIVE_P (it
->f
));
20078 if (SYMBOLP (prop
))
20080 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20082 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20084 if (unit
[0] == 'i' && unit
[1] == 'n')
20086 else if (unit
[0] == 'm' && unit
[1] == 'm')
20088 else if (unit
[0] == 'c' && unit
[1] == 'm')
20095 #ifdef HAVE_WINDOW_SYSTEM
20096 if (FRAME_WINDOW_P (it
->f
)
20098 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20099 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20101 return OK_PIXELS (ppi
/ pixels
);
20104 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20105 || (CONSP (Vdisplay_pixels_per_inch
)
20107 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20108 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20110 return OK_PIXELS (ppi
/ pixels
);
20116 #ifdef HAVE_WINDOW_SYSTEM
20117 if (EQ (prop
, Qheight
))
20118 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20119 if (EQ (prop
, Qwidth
))
20120 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20122 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20123 return OK_PIXELS (1);
20126 if (EQ (prop
, Qtext
))
20127 return OK_PIXELS (width_p
20128 ? window_box_width (it
->w
, TEXT_AREA
)
20129 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20131 if (align_to
&& *align_to
< 0)
20134 if (EQ (prop
, Qleft
))
20135 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20136 if (EQ (prop
, Qright
))
20137 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20138 if (EQ (prop
, Qcenter
))
20139 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20140 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20141 if (EQ (prop
, Qleft_fringe
))
20142 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20143 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20144 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20145 if (EQ (prop
, Qright_fringe
))
20146 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20147 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20148 : window_box_right_offset (it
->w
, TEXT_AREA
));
20149 if (EQ (prop
, Qleft_margin
))
20150 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20151 if (EQ (prop
, Qright_margin
))
20152 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20153 if (EQ (prop
, Qscroll_bar
))
20154 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20156 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20157 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20158 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20163 if (EQ (prop
, Qleft_fringe
))
20164 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20165 if (EQ (prop
, Qright_fringe
))
20166 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20167 if (EQ (prop
, Qleft_margin
))
20168 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20169 if (EQ (prop
, Qright_margin
))
20170 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20171 if (EQ (prop
, Qscroll_bar
))
20172 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20175 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20178 if (INTEGERP (prop
) || FLOATP (prop
))
20180 int base_unit
= (width_p
20181 ? FRAME_COLUMN_WIDTH (it
->f
)
20182 : FRAME_LINE_HEIGHT (it
->f
));
20183 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20188 Lisp_Object car
= XCAR (prop
);
20189 Lisp_Object cdr
= XCDR (prop
);
20193 #ifdef HAVE_WINDOW_SYSTEM
20194 if (FRAME_WINDOW_P (it
->f
)
20195 && valid_image_p (prop
))
20197 int id
= lookup_image (it
->f
, prop
);
20198 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20200 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20203 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20209 while (CONSP (cdr
))
20211 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20212 font
, width_p
, align_to
))
20215 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20220 if (EQ (car
, Qminus
))
20222 return OK_PIXELS (pixels
);
20225 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20228 if (INTEGERP (car
) || FLOATP (car
))
20231 pixels
= XFLOATINT (car
);
20233 return OK_PIXELS (pixels
);
20234 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20235 font
, width_p
, align_to
))
20236 return OK_PIXELS (pixels
* fact
);
20247 /***********************************************************************
20249 ***********************************************************************/
20251 #ifdef HAVE_WINDOW_SYSTEM
20256 dump_glyph_string (s
)
20257 struct glyph_string
*s
;
20259 fprintf (stderr
, "glyph string\n");
20260 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20261 s
->x
, s
->y
, s
->width
, s
->height
);
20262 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20263 fprintf (stderr
, " hl = %d\n", s
->hl
);
20264 fprintf (stderr
, " left overhang = %d, right = %d\n",
20265 s
->left_overhang
, s
->right_overhang
);
20266 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20267 fprintf (stderr
, " extends to end of line = %d\n",
20268 s
->extends_to_end_of_line_p
);
20269 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20270 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20273 #endif /* GLYPH_DEBUG */
20275 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20276 of XChar2b structures for S; it can't be allocated in
20277 init_glyph_string because it must be allocated via `alloca'. W
20278 is the window on which S is drawn. ROW and AREA are the glyph row
20279 and area within the row from which S is constructed. START is the
20280 index of the first glyph structure covered by S. HL is a
20281 face-override for drawing S. */
20284 #define OPTIONAL_HDC(hdc) HDC hdc,
20285 #define DECLARE_HDC(hdc) HDC hdc;
20286 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20287 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20290 #ifndef OPTIONAL_HDC
20291 #define OPTIONAL_HDC(hdc)
20292 #define DECLARE_HDC(hdc)
20293 #define ALLOCATE_HDC(hdc, f)
20294 #define RELEASE_HDC(hdc, f)
20298 init_glyph_string (struct glyph_string
*s
,
20300 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20301 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20303 memset (s
, 0, sizeof *s
);
20305 s
->f
= XFRAME (w
->frame
);
20309 s
->display
= FRAME_X_DISPLAY (s
->f
);
20310 s
->window
= FRAME_X_WINDOW (s
->f
);
20311 s
->char2b
= char2b
;
20315 s
->first_glyph
= row
->glyphs
[area
] + start
;
20316 s
->height
= row
->height
;
20317 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20318 s
->ybase
= s
->y
+ row
->ascent
;
20322 /* Append the list of glyph strings with head H and tail T to the list
20323 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20326 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20327 struct glyph_string
*h
, struct glyph_string
*t
)
20341 /* Prepend the list of glyph strings with head H and tail T to the
20342 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20346 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20347 struct glyph_string
*h
, struct glyph_string
*t
)
20361 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20362 Set *HEAD and *TAIL to the resulting list. */
20365 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20366 struct glyph_string
*s
)
20368 s
->next
= s
->prev
= NULL
;
20369 append_glyph_string_lists (head
, tail
, s
, s
);
20373 /* Get face and two-byte form of character C in face FACE_ID on frame
20374 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20375 means we want to display multibyte text. DISPLAY_P non-zero means
20376 make sure that X resources for the face returned are allocated.
20377 Value is a pointer to a realized face that is ready for display if
20378 DISPLAY_P is non-zero. */
20380 static INLINE
struct face
*
20381 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20382 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20384 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20388 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20390 if (code
!= FONT_INVALID_CODE
)
20391 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20393 STORE_XCHAR2B (char2b
, 0, 0);
20396 /* Make sure X resources of the face are allocated. */
20397 #ifdef HAVE_X_WINDOWS
20401 xassert (face
!= NULL
);
20402 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20409 /* Get face and two-byte form of character glyph GLYPH on frame F.
20410 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20411 a pointer to a realized face that is ready for display. */
20413 static INLINE
struct face
*
20414 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20415 XChar2b
*char2b
, int *two_byte_p
)
20419 xassert (glyph
->type
== CHAR_GLYPH
);
20420 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20429 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20430 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20432 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20434 if (code
!= FONT_INVALID_CODE
)
20435 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20437 STORE_XCHAR2B (char2b
, 0, 0);
20440 /* Make sure X resources of the face are allocated. */
20441 xassert (face
!= NULL
);
20442 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20447 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20448 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20451 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20455 if (CHAR_BYTE8_P (c
))
20456 code
= CHAR_TO_BYTE8 (c
);
20458 code
= font
->driver
->encode_char (font
, c
);
20460 if (code
== FONT_INVALID_CODE
)
20462 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20467 /* Fill glyph string S with composition components specified by S->cmp.
20469 BASE_FACE is the base face of the composition.
20470 S->cmp_from is the index of the first component for S.
20472 OVERLAPS non-zero means S should draw the foreground only, and use
20473 its physical height for clipping. See also draw_glyphs.
20475 Value is the index of a component not in S. */
20478 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20482 /* For all glyphs of this composition, starting at the offset
20483 S->cmp_from, until we reach the end of the definition or encounter a
20484 glyph that requires the different face, add it to S. */
20489 s
->for_overlaps
= overlaps
;
20492 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20494 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20498 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20501 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20502 s
->char2b
+ i
, 1, 1);
20508 s
->font
= s
->face
->font
;
20510 else if (s
->face
!= face
)
20518 /* All glyph strings for the same composition has the same width,
20519 i.e. the width set for the first component of the composition. */
20520 s
->width
= s
->first_glyph
->pixel_width
;
20522 /* If the specified font could not be loaded, use the frame's
20523 default font, but record the fact that we couldn't load it in
20524 the glyph string so that we can draw rectangles for the
20525 characters of the glyph string. */
20526 if (s
->font
== NULL
)
20528 s
->font_not_found_p
= 1;
20529 s
->font
= FRAME_FONT (s
->f
);
20532 /* Adjust base line for subscript/superscript text. */
20533 s
->ybase
+= s
->first_glyph
->voffset
;
20535 /* This glyph string must always be drawn with 16-bit functions. */
20542 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20543 int start
, int end
, int overlaps
)
20545 struct glyph
*glyph
, *last
;
20546 Lisp_Object lgstring
;
20549 s
->for_overlaps
= overlaps
;
20550 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20551 last
= s
->row
->glyphs
[s
->area
] + end
;
20552 s
->cmp_id
= glyph
->u
.cmp
.id
;
20553 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20554 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20555 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20556 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20557 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20559 while (glyph
< last
20560 && glyph
->u
.cmp
.automatic
20561 && glyph
->u
.cmp
.id
== s
->cmp_id
20562 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20563 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20565 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20567 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20568 unsigned code
= LGLYPH_CODE (lglyph
);
20570 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20572 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20573 return glyph
- s
->row
->glyphs
[s
->area
];
20577 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20578 See the comment of fill_glyph_string for arguments.
20579 Value is the index of the first glyph not in S. */
20583 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20584 int start
, int end
, int overlaps
)
20586 struct glyph
*glyph
, *last
;
20589 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20590 s
->for_overlaps
= overlaps
;
20591 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20592 last
= s
->row
->glyphs
[s
->area
] + end
;
20593 voffset
= glyph
->voffset
;
20594 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20595 s
->font
= s
->face
->font
;
20597 s
->width
= glyph
->pixel_width
;
20599 while (glyph
< last
20600 && glyph
->type
== GLYPHLESS_GLYPH
20601 && glyph
->voffset
== voffset
20602 && glyph
->face_id
== face_id
)
20605 s
->width
+= glyph
->pixel_width
;
20608 s
->ybase
+= voffset
;
20609 return glyph
- s
->row
->glyphs
[s
->area
];
20613 /* Fill glyph string S from a sequence of character glyphs.
20615 FACE_ID is the face id of the string. START is the index of the
20616 first glyph to consider, END is the index of the last + 1.
20617 OVERLAPS non-zero means S should draw the foreground only, and use
20618 its physical height for clipping. See also draw_glyphs.
20620 Value is the index of the first glyph not in S. */
20623 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20624 int start
, int end
, int overlaps
)
20626 struct glyph
*glyph
, *last
;
20628 int glyph_not_available_p
;
20630 xassert (s
->f
== XFRAME (s
->w
->frame
));
20631 xassert (s
->nchars
== 0);
20632 xassert (start
>= 0 && end
> start
);
20634 s
->for_overlaps
= overlaps
;
20635 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20636 last
= s
->row
->glyphs
[s
->area
] + end
;
20637 voffset
= glyph
->voffset
;
20638 s
->padding_p
= glyph
->padding_p
;
20639 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20641 while (glyph
< last
20642 && glyph
->type
== CHAR_GLYPH
20643 && glyph
->voffset
== voffset
20644 /* Same face id implies same font, nowadays. */
20645 && glyph
->face_id
== face_id
20646 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20650 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20651 s
->char2b
+ s
->nchars
,
20653 s
->two_byte_p
= two_byte_p
;
20655 xassert (s
->nchars
<= end
- start
);
20656 s
->width
+= glyph
->pixel_width
;
20657 if (glyph
++->padding_p
!= s
->padding_p
)
20661 s
->font
= s
->face
->font
;
20663 /* If the specified font could not be loaded, use the frame's font,
20664 but record the fact that we couldn't load it in
20665 S->font_not_found_p so that we can draw rectangles for the
20666 characters of the glyph string. */
20667 if (s
->font
== NULL
|| glyph_not_available_p
)
20669 s
->font_not_found_p
= 1;
20670 s
->font
= FRAME_FONT (s
->f
);
20673 /* Adjust base line for subscript/superscript text. */
20674 s
->ybase
+= voffset
;
20676 xassert (s
->face
&& s
->face
->gc
);
20677 return glyph
- s
->row
->glyphs
[s
->area
];
20681 /* Fill glyph string S from image glyph S->first_glyph. */
20684 fill_image_glyph_string (struct glyph_string
*s
)
20686 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20687 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20689 s
->slice
= s
->first_glyph
->slice
.img
;
20690 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20691 s
->font
= s
->face
->font
;
20692 s
->width
= s
->first_glyph
->pixel_width
;
20694 /* Adjust base line for subscript/superscript text. */
20695 s
->ybase
+= s
->first_glyph
->voffset
;
20699 /* Fill glyph string S from a sequence of stretch glyphs.
20701 ROW is the glyph row in which the glyphs are found, AREA is the
20702 area within the row. START is the index of the first glyph to
20703 consider, END is the index of the last + 1.
20705 Value is the index of the first glyph not in S. */
20708 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20709 enum glyph_row_area area
, int start
, int end
)
20711 struct glyph
*glyph
, *last
;
20712 int voffset
, face_id
;
20714 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20716 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20717 last
= s
->row
->glyphs
[s
->area
] + end
;
20718 face_id
= glyph
->face_id
;
20719 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20720 s
->font
= s
->face
->font
;
20721 s
->width
= glyph
->pixel_width
;
20723 voffset
= glyph
->voffset
;
20727 && glyph
->type
== STRETCH_GLYPH
20728 && glyph
->voffset
== voffset
20729 && glyph
->face_id
== face_id
);
20731 s
->width
+= glyph
->pixel_width
;
20733 /* Adjust base line for subscript/superscript text. */
20734 s
->ybase
+= voffset
;
20736 /* The case that face->gc == 0 is handled when drawing the glyph
20737 string by calling PREPARE_FACE_FOR_DISPLAY. */
20739 return glyph
- s
->row
->glyphs
[s
->area
];
20742 static struct font_metrics
*
20743 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20745 static struct font_metrics metrics
;
20746 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20748 if (! font
|| code
== FONT_INVALID_CODE
)
20750 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20755 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20756 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20757 assumed to be zero. */
20760 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20762 *left
= *right
= 0;
20764 if (glyph
->type
== CHAR_GLYPH
)
20768 struct font_metrics
*pcm
;
20770 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20771 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20773 if (pcm
->rbearing
> pcm
->width
)
20774 *right
= pcm
->rbearing
- pcm
->width
;
20775 if (pcm
->lbearing
< 0)
20776 *left
= -pcm
->lbearing
;
20779 else if (glyph
->type
== COMPOSITE_GLYPH
)
20781 if (! glyph
->u
.cmp
.automatic
)
20783 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20785 if (cmp
->rbearing
> cmp
->pixel_width
)
20786 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20787 if (cmp
->lbearing
< 0)
20788 *left
= - cmp
->lbearing
;
20792 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20793 struct font_metrics metrics
;
20795 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20796 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20797 if (metrics
.rbearing
> metrics
.width
)
20798 *right
= metrics
.rbearing
- metrics
.width
;
20799 if (metrics
.lbearing
< 0)
20800 *left
= - metrics
.lbearing
;
20806 /* Return the index of the first glyph preceding glyph string S that
20807 is overwritten by S because of S's left overhang. Value is -1
20808 if no glyphs are overwritten. */
20811 left_overwritten (struct glyph_string
*s
)
20815 if (s
->left_overhang
)
20818 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20819 int first
= s
->first_glyph
- glyphs
;
20821 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20822 x
-= glyphs
[i
].pixel_width
;
20833 /* Return the index of the first glyph preceding glyph string S that
20834 is overwriting S because of its right overhang. Value is -1 if no
20835 glyph in front of S overwrites S. */
20838 left_overwriting (struct glyph_string
*s
)
20841 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20842 int first
= s
->first_glyph
- glyphs
;
20846 for (i
= first
- 1; i
>= 0; --i
)
20849 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20852 x
-= glyphs
[i
].pixel_width
;
20859 /* Return the index of the last glyph following glyph string S that is
20860 overwritten by S because of S's right overhang. Value is -1 if
20861 no such glyph is found. */
20864 right_overwritten (struct glyph_string
*s
)
20868 if (s
->right_overhang
)
20871 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20872 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20873 int end
= s
->row
->used
[s
->area
];
20875 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20876 x
+= glyphs
[i
].pixel_width
;
20885 /* Return the index of the last glyph following glyph string S that
20886 overwrites S because of its left overhang. Value is negative
20887 if no such glyph is found. */
20890 right_overwriting (struct glyph_string
*s
)
20893 int end
= s
->row
->used
[s
->area
];
20894 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20895 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20899 for (i
= first
; i
< end
; ++i
)
20902 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20905 x
+= glyphs
[i
].pixel_width
;
20912 /* Set background width of glyph string S. START is the index of the
20913 first glyph following S. LAST_X is the right-most x-position + 1
20914 in the drawing area. */
20917 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20919 /* If the face of this glyph string has to be drawn to the end of
20920 the drawing area, set S->extends_to_end_of_line_p. */
20922 if (start
== s
->row
->used
[s
->area
]
20923 && s
->area
== TEXT_AREA
20924 && ((s
->row
->fill_line_p
20925 && (s
->hl
== DRAW_NORMAL_TEXT
20926 || s
->hl
== DRAW_IMAGE_RAISED
20927 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20928 || s
->hl
== DRAW_MOUSE_FACE
))
20929 s
->extends_to_end_of_line_p
= 1;
20931 /* If S extends its face to the end of the line, set its
20932 background_width to the distance to the right edge of the drawing
20934 if (s
->extends_to_end_of_line_p
)
20935 s
->background_width
= last_x
- s
->x
+ 1;
20937 s
->background_width
= s
->width
;
20941 /* Compute overhangs and x-positions for glyph string S and its
20942 predecessors, or successors. X is the starting x-position for S.
20943 BACKWARD_P non-zero means process predecessors. */
20946 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20952 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20953 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20963 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20964 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20974 /* The following macros are only called from draw_glyphs below.
20975 They reference the following parameters of that function directly:
20976 `w', `row', `area', and `overlap_p'
20977 as well as the following local variables:
20978 `s', `f', and `hdc' (in W32) */
20981 /* On W32, silently add local `hdc' variable to argument list of
20982 init_glyph_string. */
20983 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20984 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20986 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20987 init_glyph_string (s, char2b, w, row, area, start, hl)
20990 /* Add a glyph string for a stretch glyph to the list of strings
20991 between HEAD and TAIL. START is the index of the stretch glyph in
20992 row area AREA of glyph row ROW. END is the index of the last glyph
20993 in that glyph row area. X is the current output position assigned
20994 to the new glyph string constructed. HL overrides that face of the
20995 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20996 is the right-most x-position of the drawing area. */
20998 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20999 and below -- keep them on one line. */
21000 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21003 s = (struct glyph_string *) alloca (sizeof *s); \
21004 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21005 START = fill_stretch_glyph_string (s, row, area, START, END); \
21006 append_glyph_string (&HEAD, &TAIL, s); \
21012 /* Add a glyph string for an image glyph to the list of strings
21013 between HEAD and TAIL. START is the index of the image glyph in
21014 row area AREA of glyph row ROW. END is the index of the last glyph
21015 in that glyph row area. X is the current output position assigned
21016 to the new glyph string constructed. HL overrides that face of the
21017 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21018 is the right-most x-position of the drawing area. */
21020 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21023 s = (struct glyph_string *) alloca (sizeof *s); \
21024 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21025 fill_image_glyph_string (s); \
21026 append_glyph_string (&HEAD, &TAIL, s); \
21033 /* Add a glyph string for a sequence of character glyphs to the list
21034 of strings between HEAD and TAIL. START is the index of the first
21035 glyph in row area AREA of glyph row ROW that is part of the new
21036 glyph string. END is the index of the last glyph in that glyph row
21037 area. X is the current output position assigned to the new glyph
21038 string constructed. HL overrides that face of the glyph; e.g. it
21039 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21040 right-most x-position of the drawing area. */
21042 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21048 face_id = (row)->glyphs[area][START].face_id; \
21050 s = (struct glyph_string *) alloca (sizeof *s); \
21051 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21052 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21053 append_glyph_string (&HEAD, &TAIL, s); \
21055 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21060 /* Add a glyph string for a composite sequence to the list of strings
21061 between HEAD and TAIL. START is the index of the first glyph in
21062 row area AREA of glyph row ROW that is part of the new glyph
21063 string. END is the index of the last glyph in that glyph row area.
21064 X is the current output position assigned to the new glyph string
21065 constructed. HL overrides that face of the glyph; e.g. it is
21066 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21067 x-position of the drawing area. */
21069 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21071 int face_id = (row)->glyphs[area][START].face_id; \
21072 struct face *base_face = FACE_FROM_ID (f, face_id); \
21073 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21074 struct composition *cmp = composition_table[cmp_id]; \
21076 struct glyph_string *first_s; \
21079 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21081 /* Make glyph_strings for each glyph sequence that is drawable by \
21082 the same face, and append them to HEAD/TAIL. */ \
21083 for (n = 0; n < cmp->glyph_len;) \
21085 s = (struct glyph_string *) alloca (sizeof *s); \
21086 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21087 append_glyph_string (&(HEAD), &(TAIL), s); \
21093 n = fill_composite_glyph_string (s, base_face, overlaps); \
21101 /* Add a glyph string for a glyph-string sequence to the list of strings
21102 between HEAD and TAIL. */
21104 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21108 Lisp_Object gstring; \
21110 face_id = (row)->glyphs[area][START].face_id; \
21111 gstring = (composition_gstring_from_id \
21112 ((row)->glyphs[area][START].u.cmp.id)); \
21113 s = (struct glyph_string *) alloca (sizeof *s); \
21114 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21115 * LGSTRING_GLYPH_LEN (gstring)); \
21116 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21117 append_glyph_string (&(HEAD), &(TAIL), s); \
21119 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21123 /* Add a glyph string for a sequence of glyphless character's glyphs
21124 to the list of strings between HEAD and TAIL. The meanings of
21125 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21127 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21133 face_id = (row)->glyphs[area][START].face_id; \
21135 s = (struct glyph_string *) alloca (sizeof *s); \
21136 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21137 append_glyph_string (&HEAD, &TAIL, s); \
21139 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21145 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21146 of AREA of glyph row ROW on window W between indices START and END.
21147 HL overrides the face for drawing glyph strings, e.g. it is
21148 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21149 x-positions of the drawing area.
21151 This is an ugly monster macro construct because we must use alloca
21152 to allocate glyph strings (because draw_glyphs can be called
21153 asynchronously). */
21155 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21158 HEAD = TAIL = NULL; \
21159 while (START < END) \
21161 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21162 switch (first_glyph->type) \
21165 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21169 case COMPOSITE_GLYPH: \
21170 if (first_glyph->u.cmp.automatic) \
21171 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21174 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21178 case STRETCH_GLYPH: \
21179 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21183 case IMAGE_GLYPH: \
21184 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21188 case GLYPHLESS_GLYPH: \
21189 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21199 set_glyph_string_background_width (s, START, LAST_X); \
21206 /* Draw glyphs between START and END in AREA of ROW on window W,
21207 starting at x-position X. X is relative to AREA in W. HL is a
21208 face-override with the following meaning:
21210 DRAW_NORMAL_TEXT draw normally
21211 DRAW_CURSOR draw in cursor face
21212 DRAW_MOUSE_FACE draw in mouse face.
21213 DRAW_INVERSE_VIDEO draw in mode line face
21214 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21215 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21217 If OVERLAPS is non-zero, draw only the foreground of characters and
21218 clip to the physical height of ROW. Non-zero value also defines
21219 the overlapping part to be drawn:
21221 OVERLAPS_PRED overlap with preceding rows
21222 OVERLAPS_SUCC overlap with succeeding rows
21223 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21224 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21226 Value is the x-position reached, relative to AREA of W. */
21229 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21230 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21231 enum draw_glyphs_face hl
, int overlaps
)
21233 struct glyph_string
*head
, *tail
;
21234 struct glyph_string
*s
;
21235 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21236 int i
, j
, x_reached
, last_x
, area_left
= 0;
21237 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21240 ALLOCATE_HDC (hdc
, f
);
21242 /* Let's rather be paranoid than getting a SEGV. */
21243 end
= min (end
, row
->used
[area
]);
21244 start
= max (0, start
);
21245 start
= min (end
, start
);
21247 /* Translate X to frame coordinates. Set last_x to the right
21248 end of the drawing area. */
21249 if (row
->full_width_p
)
21251 /* X is relative to the left edge of W, without scroll bars
21253 area_left
= WINDOW_LEFT_EDGE_X (w
);
21254 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21258 area_left
= window_box_left (w
, area
);
21259 last_x
= area_left
+ window_box_width (w
, area
);
21263 /* Build a doubly-linked list of glyph_string structures between
21264 head and tail from what we have to draw. Note that the macro
21265 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21266 the reason we use a separate variable `i'. */
21268 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21270 x_reached
= tail
->x
+ tail
->background_width
;
21274 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21275 the row, redraw some glyphs in front or following the glyph
21276 strings built above. */
21277 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21279 struct glyph_string
*h
, *t
;
21280 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21281 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21284 /* If mouse highlighting is on, we may need to draw adjacent
21285 glyphs using mouse-face highlighting. */
21286 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21288 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21290 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21291 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21293 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21295 check_mouse_face
= 1;
21296 mouse_beg_col
= (row
== mouse_beg_row
)
21297 ? hlinfo
->mouse_face_beg_col
: 0;
21298 mouse_end_col
= (row
== mouse_end_row
)
21299 ? hlinfo
->mouse_face_end_col
21300 : row
->used
[TEXT_AREA
];
21304 /* Compute overhangs for all glyph strings. */
21305 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21306 for (s
= head
; s
; s
= s
->next
)
21307 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21309 /* Prepend glyph strings for glyphs in front of the first glyph
21310 string that are overwritten because of the first glyph
21311 string's left overhang. The background of all strings
21312 prepended must be drawn because the first glyph string
21314 i
= left_overwritten (head
);
21317 enum draw_glyphs_face overlap_hl
;
21319 /* If this row contains mouse highlighting, attempt to draw
21320 the overlapped glyphs with the correct highlight. This
21321 code fails if the overlap encompasses more than one glyph
21322 and mouse-highlight spans only some of these glyphs.
21323 However, making it work perfectly involves a lot more
21324 code, and I don't know if the pathological case occurs in
21325 practice, so we'll stick to this for now. --- cyd */
21326 if (check_mouse_face
21327 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21328 overlap_hl
= DRAW_MOUSE_FACE
;
21330 overlap_hl
= DRAW_NORMAL_TEXT
;
21333 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21334 overlap_hl
, dummy_x
, last_x
);
21336 compute_overhangs_and_x (t
, head
->x
, 1);
21337 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21341 /* Prepend glyph strings for glyphs in front of the first glyph
21342 string that overwrite that glyph string because of their
21343 right overhang. For these strings, only the foreground must
21344 be drawn, because it draws over the glyph string at `head'.
21345 The background must not be drawn because this would overwrite
21346 right overhangs of preceding glyphs for which no glyph
21348 i
= left_overwriting (head
);
21351 enum draw_glyphs_face overlap_hl
;
21353 if (check_mouse_face
21354 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21355 overlap_hl
= DRAW_MOUSE_FACE
;
21357 overlap_hl
= DRAW_NORMAL_TEXT
;
21360 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21361 overlap_hl
, dummy_x
, last_x
);
21362 for (s
= h
; s
; s
= s
->next
)
21363 s
->background_filled_p
= 1;
21364 compute_overhangs_and_x (t
, head
->x
, 1);
21365 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21368 /* Append glyphs strings for glyphs following the last glyph
21369 string tail that are overwritten by tail. The background of
21370 these strings has to be drawn because tail's foreground draws
21372 i
= right_overwritten (tail
);
21375 enum draw_glyphs_face overlap_hl
;
21377 if (check_mouse_face
21378 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21379 overlap_hl
= DRAW_MOUSE_FACE
;
21381 overlap_hl
= DRAW_NORMAL_TEXT
;
21383 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21384 overlap_hl
, x
, last_x
);
21385 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21386 we don't have `end = i;' here. */
21387 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21388 append_glyph_string_lists (&head
, &tail
, h
, t
);
21392 /* Append glyph strings for glyphs following the last glyph
21393 string tail that overwrite tail. The foreground of such
21394 glyphs has to be drawn because it writes into the background
21395 of tail. The background must not be drawn because it could
21396 paint over the foreground of following glyphs. */
21397 i
= right_overwriting (tail
);
21400 enum draw_glyphs_face overlap_hl
;
21401 if (check_mouse_face
21402 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21403 overlap_hl
= DRAW_MOUSE_FACE
;
21405 overlap_hl
= DRAW_NORMAL_TEXT
;
21408 i
++; /* We must include the Ith glyph. */
21409 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21410 overlap_hl
, x
, last_x
);
21411 for (s
= h
; s
; s
= s
->next
)
21412 s
->background_filled_p
= 1;
21413 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21414 append_glyph_string_lists (&head
, &tail
, h
, t
);
21416 if (clip_head
|| clip_tail
)
21417 for (s
= head
; s
; s
= s
->next
)
21419 s
->clip_head
= clip_head
;
21420 s
->clip_tail
= clip_tail
;
21424 /* Draw all strings. */
21425 for (s
= head
; s
; s
= s
->next
)
21426 FRAME_RIF (f
)->draw_glyph_string (s
);
21429 /* When focus a sole frame and move horizontally, this sets on_p to 0
21430 causing a failure to erase prev cursor position. */
21431 if (area
== TEXT_AREA
21432 && !row
->full_width_p
21433 /* When drawing overlapping rows, only the glyph strings'
21434 foreground is drawn, which doesn't erase a cursor
21438 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21439 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21440 : (tail
? tail
->x
+ tail
->background_width
: x
));
21444 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21445 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21449 /* Value is the x-position up to which drawn, relative to AREA of W.
21450 This doesn't include parts drawn because of overhangs. */
21451 if (row
->full_width_p
)
21452 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21454 x_reached
-= area_left
;
21456 RELEASE_HDC (hdc
, f
);
21461 /* Expand row matrix if too narrow. Don't expand if area
21464 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21466 if (!fonts_changed_p \
21467 && (it->glyph_row->glyphs[area] \
21468 < it->glyph_row->glyphs[area + 1])) \
21470 it->w->ncols_scale_factor++; \
21471 fonts_changed_p = 1; \
21475 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21476 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21479 append_glyph (struct it
*it
)
21481 struct glyph
*glyph
;
21482 enum glyph_row_area area
= it
->area
;
21484 xassert (it
->glyph_row
);
21485 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21487 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21488 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21490 /* If the glyph row is reversed, we need to prepend the glyph
21491 rather than append it. */
21492 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21496 /* Make room for the additional glyph. */
21497 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21499 glyph
= it
->glyph_row
->glyphs
[area
];
21501 glyph
->charpos
= CHARPOS (it
->position
);
21502 glyph
->object
= it
->object
;
21503 if (it
->pixel_width
> 0)
21505 glyph
->pixel_width
= it
->pixel_width
;
21506 glyph
->padding_p
= 0;
21510 /* Assure at least 1-pixel width. Otherwise, cursor can't
21511 be displayed correctly. */
21512 glyph
->pixel_width
= 1;
21513 glyph
->padding_p
= 1;
21515 glyph
->ascent
= it
->ascent
;
21516 glyph
->descent
= it
->descent
;
21517 glyph
->voffset
= it
->voffset
;
21518 glyph
->type
= CHAR_GLYPH
;
21519 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21520 glyph
->multibyte_p
= it
->multibyte_p
;
21521 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21522 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21523 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21524 || it
->phys_descent
> it
->descent
);
21525 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21526 glyph
->face_id
= it
->face_id
;
21527 glyph
->u
.ch
= it
->char_to_display
;
21528 glyph
->slice
.img
= null_glyph_slice
;
21529 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21532 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21533 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21535 glyph
->bidi_type
= it
->bidi_it
.type
;
21539 glyph
->resolved_level
= 0;
21540 glyph
->bidi_type
= UNKNOWN_BT
;
21542 ++it
->glyph_row
->used
[area
];
21545 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21548 /* Store one glyph for the composition IT->cmp_it.id in
21549 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21553 append_composite_glyph (struct it
*it
)
21555 struct glyph
*glyph
;
21556 enum glyph_row_area area
= it
->area
;
21558 xassert (it
->glyph_row
);
21560 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21561 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21563 /* If the glyph row is reversed, we need to prepend the glyph
21564 rather than append it. */
21565 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21569 /* Make room for the new glyph. */
21570 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21572 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21574 glyph
->charpos
= it
->cmp_it
.charpos
;
21575 glyph
->object
= it
->object
;
21576 glyph
->pixel_width
= it
->pixel_width
;
21577 glyph
->ascent
= it
->ascent
;
21578 glyph
->descent
= it
->descent
;
21579 glyph
->voffset
= it
->voffset
;
21580 glyph
->type
= COMPOSITE_GLYPH
;
21581 if (it
->cmp_it
.ch
< 0)
21583 glyph
->u
.cmp
.automatic
= 0;
21584 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21585 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21589 glyph
->u
.cmp
.automatic
= 1;
21590 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21591 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21592 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21594 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21595 glyph
->multibyte_p
= it
->multibyte_p
;
21596 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21597 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21598 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21599 || it
->phys_descent
> it
->descent
);
21600 glyph
->padding_p
= 0;
21601 glyph
->glyph_not_available_p
= 0;
21602 glyph
->face_id
= it
->face_id
;
21603 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21606 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21607 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21609 glyph
->bidi_type
= it
->bidi_it
.type
;
21611 ++it
->glyph_row
->used
[area
];
21614 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21618 /* Change IT->ascent and IT->height according to the setting of
21622 take_vertical_position_into_account (struct it
*it
)
21626 if (it
->voffset
< 0)
21627 /* Increase the ascent so that we can display the text higher
21629 it
->ascent
-= it
->voffset
;
21631 /* Increase the descent so that we can display the text lower
21633 it
->descent
+= it
->voffset
;
21638 /* Produce glyphs/get display metrics for the image IT is loaded with.
21639 See the description of struct display_iterator in dispextern.h for
21640 an overview of struct display_iterator. */
21643 produce_image_glyph (struct it
*it
)
21647 int glyph_ascent
, crop
;
21648 struct glyph_slice slice
;
21650 xassert (it
->what
== IT_IMAGE
);
21652 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21654 /* Make sure X resources of the face is loaded. */
21655 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21657 if (it
->image_id
< 0)
21659 /* Fringe bitmap. */
21660 it
->ascent
= it
->phys_ascent
= 0;
21661 it
->descent
= it
->phys_descent
= 0;
21662 it
->pixel_width
= 0;
21667 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21669 /* Make sure X resources of the image is loaded. */
21670 prepare_image_for_display (it
->f
, img
);
21672 slice
.x
= slice
.y
= 0;
21673 slice
.width
= img
->width
;
21674 slice
.height
= img
->height
;
21676 if (INTEGERP (it
->slice
.x
))
21677 slice
.x
= XINT (it
->slice
.x
);
21678 else if (FLOATP (it
->slice
.x
))
21679 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21681 if (INTEGERP (it
->slice
.y
))
21682 slice
.y
= XINT (it
->slice
.y
);
21683 else if (FLOATP (it
->slice
.y
))
21684 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21686 if (INTEGERP (it
->slice
.width
))
21687 slice
.width
= XINT (it
->slice
.width
);
21688 else if (FLOATP (it
->slice
.width
))
21689 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21691 if (INTEGERP (it
->slice
.height
))
21692 slice
.height
= XINT (it
->slice
.height
);
21693 else if (FLOATP (it
->slice
.height
))
21694 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21696 if (slice
.x
>= img
->width
)
21697 slice
.x
= img
->width
;
21698 if (slice
.y
>= img
->height
)
21699 slice
.y
= img
->height
;
21700 if (slice
.x
+ slice
.width
>= img
->width
)
21701 slice
.width
= img
->width
- slice
.x
;
21702 if (slice
.y
+ slice
.height
> img
->height
)
21703 slice
.height
= img
->height
- slice
.y
;
21705 if (slice
.width
== 0 || slice
.height
== 0)
21708 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21710 it
->descent
= slice
.height
- glyph_ascent
;
21712 it
->descent
+= img
->vmargin
;
21713 if (slice
.y
+ slice
.height
== img
->height
)
21714 it
->descent
+= img
->vmargin
;
21715 it
->phys_descent
= it
->descent
;
21717 it
->pixel_width
= slice
.width
;
21719 it
->pixel_width
+= img
->hmargin
;
21720 if (slice
.x
+ slice
.width
== img
->width
)
21721 it
->pixel_width
+= img
->hmargin
;
21723 /* It's quite possible for images to have an ascent greater than
21724 their height, so don't get confused in that case. */
21725 if (it
->descent
< 0)
21730 if (face
->box
!= FACE_NO_BOX
)
21732 if (face
->box_line_width
> 0)
21735 it
->ascent
+= face
->box_line_width
;
21736 if (slice
.y
+ slice
.height
== img
->height
)
21737 it
->descent
+= face
->box_line_width
;
21740 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21741 it
->pixel_width
+= eabs (face
->box_line_width
);
21742 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21743 it
->pixel_width
+= eabs (face
->box_line_width
);
21746 take_vertical_position_into_account (it
);
21748 /* Automatically crop wide image glyphs at right edge so we can
21749 draw the cursor on same display row. */
21750 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21751 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21753 it
->pixel_width
-= crop
;
21754 slice
.width
-= crop
;
21759 struct glyph
*glyph
;
21760 enum glyph_row_area area
= it
->area
;
21762 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21763 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21765 glyph
->charpos
= CHARPOS (it
->position
);
21766 glyph
->object
= it
->object
;
21767 glyph
->pixel_width
= it
->pixel_width
;
21768 glyph
->ascent
= glyph_ascent
;
21769 glyph
->descent
= it
->descent
;
21770 glyph
->voffset
= it
->voffset
;
21771 glyph
->type
= IMAGE_GLYPH
;
21772 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21773 glyph
->multibyte_p
= it
->multibyte_p
;
21774 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21775 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21776 glyph
->overlaps_vertically_p
= 0;
21777 glyph
->padding_p
= 0;
21778 glyph
->glyph_not_available_p
= 0;
21779 glyph
->face_id
= it
->face_id
;
21780 glyph
->u
.img_id
= img
->id
;
21781 glyph
->slice
.img
= slice
;
21782 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21785 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21786 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21788 glyph
->bidi_type
= it
->bidi_it
.type
;
21790 ++it
->glyph_row
->used
[area
];
21793 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21798 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21799 of the glyph, WIDTH and HEIGHT are the width and height of the
21800 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21803 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21804 int width
, int height
, int ascent
)
21806 struct glyph
*glyph
;
21807 enum glyph_row_area area
= it
->area
;
21809 xassert (ascent
>= 0 && ascent
<= height
);
21811 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21812 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21814 /* If the glyph row is reversed, we need to prepend the glyph
21815 rather than append it. */
21816 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21820 /* Make room for the additional glyph. */
21821 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21823 glyph
= it
->glyph_row
->glyphs
[area
];
21825 glyph
->charpos
= CHARPOS (it
->position
);
21826 glyph
->object
= object
;
21827 glyph
->pixel_width
= width
;
21828 glyph
->ascent
= ascent
;
21829 glyph
->descent
= height
- ascent
;
21830 glyph
->voffset
= it
->voffset
;
21831 glyph
->type
= STRETCH_GLYPH
;
21832 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21833 glyph
->multibyte_p
= it
->multibyte_p
;
21834 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21835 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21836 glyph
->overlaps_vertically_p
= 0;
21837 glyph
->padding_p
= 0;
21838 glyph
->glyph_not_available_p
= 0;
21839 glyph
->face_id
= it
->face_id
;
21840 glyph
->u
.stretch
.ascent
= ascent
;
21841 glyph
->u
.stretch
.height
= height
;
21842 glyph
->slice
.img
= null_glyph_slice
;
21843 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21846 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21847 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21849 glyph
->bidi_type
= it
->bidi_it
.type
;
21853 glyph
->resolved_level
= 0;
21854 glyph
->bidi_type
= UNKNOWN_BT
;
21856 ++it
->glyph_row
->used
[area
];
21859 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21863 /* Produce a stretch glyph for iterator IT. IT->object is the value
21864 of the glyph property displayed. The value must be a list
21865 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21868 1. `:width WIDTH' specifies that the space should be WIDTH *
21869 canonical char width wide. WIDTH may be an integer or floating
21872 2. `:relative-width FACTOR' specifies that the width of the stretch
21873 should be computed from the width of the first character having the
21874 `glyph' property, and should be FACTOR times that width.
21876 3. `:align-to HPOS' specifies that the space should be wide enough
21877 to reach HPOS, a value in canonical character units.
21879 Exactly one of the above pairs must be present.
21881 4. `:height HEIGHT' specifies that the height of the stretch produced
21882 should be HEIGHT, measured in canonical character units.
21884 5. `:relative-height FACTOR' specifies that the height of the
21885 stretch should be FACTOR times the height of the characters having
21886 the glyph property.
21888 Either none or exactly one of 4 or 5 must be present.
21890 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21891 of the stretch should be used for the ascent of the stretch.
21892 ASCENT must be in the range 0 <= ASCENT <= 100. */
21895 produce_stretch_glyph (struct it
*it
)
21897 /* (space :width WIDTH :height HEIGHT ...) */
21898 Lisp_Object prop
, plist
;
21899 int width
= 0, height
= 0, align_to
= -1;
21900 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21903 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21904 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21906 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21908 /* List should start with `space'. */
21909 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21910 plist
= XCDR (it
->object
);
21912 /* Compute the width of the stretch. */
21913 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21914 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21916 /* Absolute width `:width WIDTH' specified and valid. */
21917 zero_width_ok_p
= 1;
21920 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21923 /* Relative width `:relative-width FACTOR' specified and valid.
21924 Compute the width of the characters having the `glyph'
21927 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21930 if (it
->multibyte_p
)
21931 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21934 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
21935 if (! ASCII_CHAR_P (it2
.c
))
21936 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
21939 it2
.glyph_row
= NULL
;
21940 it2
.what
= IT_CHARACTER
;
21941 x_produce_glyphs (&it2
);
21942 width
= NUMVAL (prop
) * it2
.pixel_width
;
21944 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21945 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21947 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21948 align_to
= (align_to
< 0
21950 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21951 else if (align_to
< 0)
21952 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21953 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21954 zero_width_ok_p
= 1;
21957 /* Nothing specified -> width defaults to canonical char width. */
21958 width
= FRAME_COLUMN_WIDTH (it
->f
);
21960 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21963 /* Compute height. */
21964 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21965 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21968 zero_height_ok_p
= 1;
21970 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21972 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21974 height
= FONT_HEIGHT (font
);
21976 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21979 /* Compute percentage of height used for ascent. If
21980 `:ascent ASCENT' is present and valid, use that. Otherwise,
21981 derive the ascent from the font in use. */
21982 if (prop
= Fplist_get (plist
, QCascent
),
21983 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21984 ascent
= height
* NUMVAL (prop
) / 100.0;
21985 else if (!NILP (prop
)
21986 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21987 ascent
= min (max (0, (int)tem
), height
);
21989 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21991 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21992 && it
->current_x
+ width
> it
->last_visible_x
)
21993 width
= it
->last_visible_x
- it
->current_x
- 1;
21995 if (width
> 0 && height
> 0 && it
->glyph_row
)
21997 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21998 if (!STRINGP (object
))
21999 object
= it
->w
->buffer
;
22000 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22003 it
->pixel_width
= width
;
22004 it
->ascent
= it
->phys_ascent
= ascent
;
22005 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22006 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22008 take_vertical_position_into_account (it
);
22011 /* Calculate line-height and line-spacing properties.
22012 An integer value specifies explicit pixel value.
22013 A float value specifies relative value to current face height.
22014 A cons (float . face-name) specifies relative value to
22015 height of specified face font.
22017 Returns height in pixels, or nil. */
22021 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22022 int boff
, int override
)
22024 Lisp_Object face_name
= Qnil
;
22025 int ascent
, descent
, height
;
22027 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22032 face_name
= XCAR (val
);
22034 if (!NUMBERP (val
))
22035 val
= make_number (1);
22036 if (NILP (face_name
))
22038 height
= it
->ascent
+ it
->descent
;
22043 if (NILP (face_name
))
22045 font
= FRAME_FONT (it
->f
);
22046 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22048 else if (EQ (face_name
, Qt
))
22057 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22059 return make_number (-1);
22061 face
= FACE_FROM_ID (it
->f
, face_id
);
22064 return make_number (-1);
22065 boff
= font
->baseline_offset
;
22066 if (font
->vertical_centering
)
22067 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22070 ascent
= FONT_BASE (font
) + boff
;
22071 descent
= FONT_DESCENT (font
) - boff
;
22075 it
->override_ascent
= ascent
;
22076 it
->override_descent
= descent
;
22077 it
->override_boff
= boff
;
22080 height
= ascent
+ descent
;
22084 height
= (int)(XFLOAT_DATA (val
) * height
);
22085 else if (INTEGERP (val
))
22086 height
*= XINT (val
);
22088 return make_number (height
);
22092 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22093 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22094 and only if this is for a character for which no font was found.
22096 If the display method (it->glyphless_method) is
22097 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22098 length of the acronym or the hexadecimal string, UPPER_XOFF and
22099 UPPER_YOFF are pixel offsets for the upper part of the string,
22100 LOWER_XOFF and LOWER_YOFF are for the lower part.
22102 For the other display methods, LEN through LOWER_YOFF are zero. */
22105 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22106 short upper_xoff
, short upper_yoff
,
22107 short lower_xoff
, short lower_yoff
)
22109 struct glyph
*glyph
;
22110 enum glyph_row_area area
= it
->area
;
22112 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22113 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22115 /* If the glyph row is reversed, we need to prepend the glyph
22116 rather than append it. */
22117 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22121 /* Make room for the additional glyph. */
22122 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22124 glyph
= it
->glyph_row
->glyphs
[area
];
22126 glyph
->charpos
= CHARPOS (it
->position
);
22127 glyph
->object
= it
->object
;
22128 glyph
->pixel_width
= it
->pixel_width
;
22129 glyph
->ascent
= it
->ascent
;
22130 glyph
->descent
= it
->descent
;
22131 glyph
->voffset
= it
->voffset
;
22132 glyph
->type
= GLYPHLESS_GLYPH
;
22133 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22134 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22135 glyph
->u
.glyphless
.len
= len
;
22136 glyph
->u
.glyphless
.ch
= it
->c
;
22137 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22138 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22139 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22140 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22141 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22142 glyph
->multibyte_p
= it
->multibyte_p
;
22143 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22144 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22145 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22146 || it
->phys_descent
> it
->descent
);
22147 glyph
->padding_p
= 0;
22148 glyph
->glyph_not_available_p
= 0;
22149 glyph
->face_id
= face_id
;
22150 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22153 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22154 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22156 glyph
->bidi_type
= it
->bidi_it
.type
;
22158 ++it
->glyph_row
->used
[area
];
22161 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22165 /* Produce a glyph for a glyphless character for iterator IT.
22166 IT->glyphless_method specifies which method to use for displaying
22167 the character. See the description of enum
22168 glyphless_display_method in dispextern.h for the detail.
22170 FOR_NO_FONT is nonzero if and only if this is for a character for
22171 which no font was found. ACRONYM, if non-nil, is an acronym string
22172 for the character. */
22175 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22180 int base_width
, base_height
, width
, height
;
22181 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22184 /* Get the metrics of the base font. We always refer to the current
22186 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22187 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22188 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22189 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22190 base_height
= it
->ascent
+ it
->descent
;
22191 base_width
= font
->average_width
;
22193 /* Get a face ID for the glyph by utilizing a cache (the same way as
22194 doen for `escape-glyph' in get_next_display_element). */
22195 if (it
->f
== last_glyphless_glyph_frame
22196 && it
->face_id
== last_glyphless_glyph_face_id
)
22198 face_id
= last_glyphless_glyph_merged_face_id
;
22202 /* Merge the `glyphless-char' face into the current face. */
22203 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22204 last_glyphless_glyph_frame
= it
->f
;
22205 last_glyphless_glyph_face_id
= it
->face_id
;
22206 last_glyphless_glyph_merged_face_id
= face_id
;
22209 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22211 it
->pixel_width
= THIN_SPACE_WIDTH
;
22213 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22215 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22217 width
= CHAR_WIDTH (it
->c
);
22220 else if (width
> 4)
22222 it
->pixel_width
= base_width
* width
;
22224 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22229 unsigned int code
[6];
22231 int ascent
, descent
;
22232 struct font_metrics metrics_upper
, metrics_lower
;
22234 face
= FACE_FROM_ID (it
->f
, face_id
);
22235 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22236 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22238 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22240 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22241 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22242 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22246 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22247 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22250 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22251 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22252 upper_len
= (len
+ 1) / 2;
22253 font
->driver
->text_extents (font
, code
, upper_len
,
22255 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22260 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22261 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22262 upper_xoff
= upper_yoff
= 2; /* the typical case */
22263 if (base_width
>= width
)
22265 /* Align the upper to the left, the lower to the right. */
22266 it
->pixel_width
= base_width
;
22267 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22271 /* Center the shorter one. */
22272 it
->pixel_width
= width
;
22273 if (metrics_upper
.width
>= metrics_lower
.width
)
22274 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22276 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22279 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22280 top, bottom, and between upper and lower strings. */
22281 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22282 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22283 /* Center vertically.
22284 H:base_height, D:base_descent
22285 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22287 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22288 descent = D - H/2 + h/2;
22289 lower_yoff = descent - 2 - ld;
22290 upper_yoff = lower_yoff - la - 1 - ud; */
22291 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22292 descent
= it
->descent
- (base_height
- height
) / 2;
22293 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22294 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22295 - metrics_upper
.descent
);
22296 /* Don't make the height shorter than the base height. */
22297 if (height
> base_height
)
22299 it
->ascent
= ascent
;
22300 it
->descent
= descent
;
22304 it
->phys_ascent
= it
->ascent
;
22305 it
->phys_descent
= it
->descent
;
22307 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22308 upper_xoff
, upper_yoff
,
22309 lower_xoff
, lower_yoff
);
22311 take_vertical_position_into_account (it
);
22316 Produce glyphs/get display metrics for the display element IT is
22317 loaded with. See the description of struct it in dispextern.h
22318 for an overview of struct it. */
22321 x_produce_glyphs (struct it
*it
)
22323 int extra_line_spacing
= it
->extra_line_spacing
;
22325 it
->glyph_not_available_p
= 0;
22327 if (it
->what
== IT_CHARACTER
)
22330 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22331 struct font
*font
= face
->font
;
22332 struct font_metrics
*pcm
= NULL
;
22333 int boff
; /* baseline offset */
22337 /* When no suitable font is found, display this character by
22338 the method specified in the first extra slot of
22339 Vglyphless_char_display. */
22340 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22342 xassert (it
->what
== IT_GLYPHLESS
);
22343 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22347 boff
= font
->baseline_offset
;
22348 if (font
->vertical_centering
)
22349 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22351 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22357 if (it
->override_ascent
>= 0)
22359 it
->ascent
= it
->override_ascent
;
22360 it
->descent
= it
->override_descent
;
22361 boff
= it
->override_boff
;
22365 it
->ascent
= FONT_BASE (font
) + boff
;
22366 it
->descent
= FONT_DESCENT (font
) - boff
;
22369 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22371 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22372 if (pcm
->width
== 0
22373 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22379 it
->phys_ascent
= pcm
->ascent
+ boff
;
22380 it
->phys_descent
= pcm
->descent
- boff
;
22381 it
->pixel_width
= pcm
->width
;
22385 it
->glyph_not_available_p
= 1;
22386 it
->phys_ascent
= it
->ascent
;
22387 it
->phys_descent
= it
->descent
;
22388 it
->pixel_width
= font
->space_width
;
22391 if (it
->constrain_row_ascent_descent_p
)
22393 if (it
->descent
> it
->max_descent
)
22395 it
->ascent
+= it
->descent
- it
->max_descent
;
22396 it
->descent
= it
->max_descent
;
22398 if (it
->ascent
> it
->max_ascent
)
22400 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22401 it
->ascent
= it
->max_ascent
;
22403 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22404 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22405 extra_line_spacing
= 0;
22408 /* If this is a space inside a region of text with
22409 `space-width' property, change its width. */
22410 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22412 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22414 /* If face has a box, add the box thickness to the character
22415 height. If character has a box line to the left and/or
22416 right, add the box line width to the character's width. */
22417 if (face
->box
!= FACE_NO_BOX
)
22419 int thick
= face
->box_line_width
;
22423 it
->ascent
+= thick
;
22424 it
->descent
+= thick
;
22429 if (it
->start_of_box_run_p
)
22430 it
->pixel_width
+= thick
;
22431 if (it
->end_of_box_run_p
)
22432 it
->pixel_width
+= thick
;
22435 /* If face has an overline, add the height of the overline
22436 (1 pixel) and a 1 pixel margin to the character height. */
22437 if (face
->overline_p
)
22438 it
->ascent
+= overline_margin
;
22440 if (it
->constrain_row_ascent_descent_p
)
22442 if (it
->ascent
> it
->max_ascent
)
22443 it
->ascent
= it
->max_ascent
;
22444 if (it
->descent
> it
->max_descent
)
22445 it
->descent
= it
->max_descent
;
22448 take_vertical_position_into_account (it
);
22450 /* If we have to actually produce glyphs, do it. */
22455 /* Translate a space with a `space-width' property
22456 into a stretch glyph. */
22457 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22458 / FONT_HEIGHT (font
));
22459 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22460 it
->ascent
+ it
->descent
, ascent
);
22465 /* If characters with lbearing or rbearing are displayed
22466 in this line, record that fact in a flag of the
22467 glyph row. This is used to optimize X output code. */
22468 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22469 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22471 if (! stretched_p
&& it
->pixel_width
== 0)
22472 /* We assure that all visible glyphs have at least 1-pixel
22474 it
->pixel_width
= 1;
22476 else if (it
->char_to_display
== '\n')
22478 /* A newline has no width, but we need the height of the
22479 line. But if previous part of the line sets a height,
22480 don't increase that height */
22482 Lisp_Object height
;
22483 Lisp_Object total_height
= Qnil
;
22485 it
->override_ascent
= -1;
22486 it
->pixel_width
= 0;
22489 height
= get_it_property (it
, Qline_height
);
22490 /* Split (line-height total-height) list */
22492 && CONSP (XCDR (height
))
22493 && NILP (XCDR (XCDR (height
))))
22495 total_height
= XCAR (XCDR (height
));
22496 height
= XCAR (height
);
22498 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22500 if (it
->override_ascent
>= 0)
22502 it
->ascent
= it
->override_ascent
;
22503 it
->descent
= it
->override_descent
;
22504 boff
= it
->override_boff
;
22508 it
->ascent
= FONT_BASE (font
) + boff
;
22509 it
->descent
= FONT_DESCENT (font
) - boff
;
22512 if (EQ (height
, Qt
))
22514 if (it
->descent
> it
->max_descent
)
22516 it
->ascent
+= it
->descent
- it
->max_descent
;
22517 it
->descent
= it
->max_descent
;
22519 if (it
->ascent
> it
->max_ascent
)
22521 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22522 it
->ascent
= it
->max_ascent
;
22524 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22525 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22526 it
->constrain_row_ascent_descent_p
= 1;
22527 extra_line_spacing
= 0;
22531 Lisp_Object spacing
;
22533 it
->phys_ascent
= it
->ascent
;
22534 it
->phys_descent
= it
->descent
;
22536 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22537 && face
->box
!= FACE_NO_BOX
22538 && face
->box_line_width
> 0)
22540 it
->ascent
+= face
->box_line_width
;
22541 it
->descent
+= face
->box_line_width
;
22544 && XINT (height
) > it
->ascent
+ it
->descent
)
22545 it
->ascent
= XINT (height
) - it
->descent
;
22547 if (!NILP (total_height
))
22548 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22551 spacing
= get_it_property (it
, Qline_spacing
);
22552 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22554 if (INTEGERP (spacing
))
22556 extra_line_spacing
= XINT (spacing
);
22557 if (!NILP (total_height
))
22558 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22562 else /* i.e. (it->char_to_display == '\t') */
22564 if (font
->space_width
> 0)
22566 int tab_width
= it
->tab_width
* font
->space_width
;
22567 int x
= it
->current_x
+ it
->continuation_lines_width
;
22568 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22570 /* If the distance from the current position to the next tab
22571 stop is less than a space character width, use the
22572 tab stop after that. */
22573 if (next_tab_x
- x
< font
->space_width
)
22574 next_tab_x
+= tab_width
;
22576 it
->pixel_width
= next_tab_x
- x
;
22578 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22579 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22583 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22584 it
->ascent
+ it
->descent
, it
->ascent
);
22589 it
->pixel_width
= 0;
22594 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22596 /* A static composition.
22598 Note: A composition is represented as one glyph in the
22599 glyph matrix. There are no padding glyphs.
22601 Important note: pixel_width, ascent, and descent are the
22602 values of what is drawn by draw_glyphs (i.e. the values of
22603 the overall glyphs composed). */
22604 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22605 int boff
; /* baseline offset */
22606 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22607 int glyph_len
= cmp
->glyph_len
;
22608 struct font
*font
= face
->font
;
22612 /* If we have not yet calculated pixel size data of glyphs of
22613 the composition for the current face font, calculate them
22614 now. Theoretically, we have to check all fonts for the
22615 glyphs, but that requires much time and memory space. So,
22616 here we check only the font of the first glyph. This may
22617 lead to incorrect display, but it's very rare, and C-l
22618 (recenter-top-bottom) can correct the display anyway. */
22619 if (! cmp
->font
|| cmp
->font
!= font
)
22621 /* Ascent and descent of the font of the first character
22622 of this composition (adjusted by baseline offset).
22623 Ascent and descent of overall glyphs should not be less
22624 than these, respectively. */
22625 int font_ascent
, font_descent
, font_height
;
22626 /* Bounding box of the overall glyphs. */
22627 int leftmost
, rightmost
, lowest
, highest
;
22628 int lbearing
, rbearing
;
22629 int i
, width
, ascent
, descent
;
22630 int left_padded
= 0, right_padded
= 0;
22633 struct font_metrics
*pcm
;
22634 int font_not_found_p
;
22637 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22638 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22640 if (glyph_len
< cmp
->glyph_len
)
22642 for (i
= 0; i
< glyph_len
; i
++)
22644 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22646 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22651 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22652 : IT_CHARPOS (*it
));
22653 /* If no suitable font is found, use the default font. */
22654 font_not_found_p
= font
== NULL
;
22655 if (font_not_found_p
)
22657 face
= face
->ascii_face
;
22660 boff
= font
->baseline_offset
;
22661 if (font
->vertical_centering
)
22662 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22663 font_ascent
= FONT_BASE (font
) + boff
;
22664 font_descent
= FONT_DESCENT (font
) - boff
;
22665 font_height
= FONT_HEIGHT (font
);
22667 cmp
->font
= (void *) font
;
22670 if (! font_not_found_p
)
22672 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22673 &char2b
, it
->multibyte_p
, 0);
22674 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22677 /* Initialize the bounding box. */
22680 width
= pcm
->width
;
22681 ascent
= pcm
->ascent
;
22682 descent
= pcm
->descent
;
22683 lbearing
= pcm
->lbearing
;
22684 rbearing
= pcm
->rbearing
;
22688 width
= font
->space_width
;
22689 ascent
= FONT_BASE (font
);
22690 descent
= FONT_DESCENT (font
);
22697 lowest
= - descent
+ boff
;
22698 highest
= ascent
+ boff
;
22700 if (! font_not_found_p
22701 && font
->default_ascent
22702 && CHAR_TABLE_P (Vuse_default_ascent
)
22703 && !NILP (Faref (Vuse_default_ascent
,
22704 make_number (it
->char_to_display
))))
22705 highest
= font
->default_ascent
+ boff
;
22707 /* Draw the first glyph at the normal position. It may be
22708 shifted to right later if some other glyphs are drawn
22710 cmp
->offsets
[i
* 2] = 0;
22711 cmp
->offsets
[i
* 2 + 1] = boff
;
22712 cmp
->lbearing
= lbearing
;
22713 cmp
->rbearing
= rbearing
;
22715 /* Set cmp->offsets for the remaining glyphs. */
22716 for (i
++; i
< glyph_len
; i
++)
22718 int left
, right
, btm
, top
;
22719 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22721 struct face
*this_face
;
22726 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22727 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22728 font
= this_face
->font
;
22734 this_boff
= font
->baseline_offset
;
22735 if (font
->vertical_centering
)
22736 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22737 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22738 &char2b
, it
->multibyte_p
, 0);
22739 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22742 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22745 width
= pcm
->width
;
22746 ascent
= pcm
->ascent
;
22747 descent
= pcm
->descent
;
22748 lbearing
= pcm
->lbearing
;
22749 rbearing
= pcm
->rbearing
;
22750 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22752 /* Relative composition with or without
22753 alternate chars. */
22754 left
= (leftmost
+ rightmost
- width
) / 2;
22755 btm
= - descent
+ boff
;
22756 if (font
->relative_compose
22757 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22758 || NILP (Faref (Vignore_relative_composition
,
22759 make_number (ch
)))))
22762 if (- descent
>= font
->relative_compose
)
22763 /* One extra pixel between two glyphs. */
22765 else if (ascent
<= 0)
22766 /* One extra pixel between two glyphs. */
22767 btm
= lowest
- 1 - ascent
- descent
;
22772 /* A composition rule is specified by an integer
22773 value that encodes global and new reference
22774 points (GREF and NREF). GREF and NREF are
22775 specified by numbers as below:
22777 0---1---2 -- ascent
22781 9--10--11 -- center
22783 ---3---4---5--- baseline
22785 6---7---8 -- descent
22787 int rule
= COMPOSITION_RULE (cmp
, i
);
22788 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22790 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22791 grefx
= gref
% 3, nrefx
= nref
% 3;
22792 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22794 xoff
= font_height
* (xoff
- 128) / 256;
22796 yoff
= font_height
* (yoff
- 128) / 256;
22799 + grefx
* (rightmost
- leftmost
) / 2
22800 - nrefx
* width
/ 2
22803 btm
= ((grefy
== 0 ? highest
22805 : grefy
== 2 ? lowest
22806 : (highest
+ lowest
) / 2)
22807 - (nrefy
== 0 ? ascent
+ descent
22808 : nrefy
== 1 ? descent
- boff
22810 : (ascent
+ descent
) / 2)
22814 cmp
->offsets
[i
* 2] = left
;
22815 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22817 /* Update the bounding box of the overall glyphs. */
22820 right
= left
+ width
;
22821 if (left
< leftmost
)
22823 if (right
> rightmost
)
22826 top
= btm
+ descent
+ ascent
;
22832 if (cmp
->lbearing
> left
+ lbearing
)
22833 cmp
->lbearing
= left
+ lbearing
;
22834 if (cmp
->rbearing
< left
+ rbearing
)
22835 cmp
->rbearing
= left
+ rbearing
;
22839 /* If there are glyphs whose x-offsets are negative,
22840 shift all glyphs to the right and make all x-offsets
22844 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22845 cmp
->offsets
[i
* 2] -= leftmost
;
22846 rightmost
-= leftmost
;
22847 cmp
->lbearing
-= leftmost
;
22848 cmp
->rbearing
-= leftmost
;
22851 if (left_padded
&& cmp
->lbearing
< 0)
22853 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22854 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22855 rightmost
-= cmp
->lbearing
;
22856 cmp
->rbearing
-= cmp
->lbearing
;
22859 if (right_padded
&& rightmost
< cmp
->rbearing
)
22861 rightmost
= cmp
->rbearing
;
22864 cmp
->pixel_width
= rightmost
;
22865 cmp
->ascent
= highest
;
22866 cmp
->descent
= - lowest
;
22867 if (cmp
->ascent
< font_ascent
)
22868 cmp
->ascent
= font_ascent
;
22869 if (cmp
->descent
< font_descent
)
22870 cmp
->descent
= font_descent
;
22874 && (cmp
->lbearing
< 0
22875 || cmp
->rbearing
> cmp
->pixel_width
))
22876 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22878 it
->pixel_width
= cmp
->pixel_width
;
22879 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22880 it
->descent
= it
->phys_descent
= cmp
->descent
;
22881 if (face
->box
!= FACE_NO_BOX
)
22883 int thick
= face
->box_line_width
;
22887 it
->ascent
+= thick
;
22888 it
->descent
+= thick
;
22893 if (it
->start_of_box_run_p
)
22894 it
->pixel_width
+= thick
;
22895 if (it
->end_of_box_run_p
)
22896 it
->pixel_width
+= thick
;
22899 /* If face has an overline, add the height of the overline
22900 (1 pixel) and a 1 pixel margin to the character height. */
22901 if (face
->overline_p
)
22902 it
->ascent
+= overline_margin
;
22904 take_vertical_position_into_account (it
);
22905 if (it
->ascent
< 0)
22907 if (it
->descent
< 0)
22911 append_composite_glyph (it
);
22913 else if (it
->what
== IT_COMPOSITION
)
22915 /* A dynamic (automatic) composition. */
22916 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22917 Lisp_Object gstring
;
22918 struct font_metrics metrics
;
22920 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22922 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22925 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22926 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22927 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22928 it
->descent
= it
->phys_descent
= metrics
.descent
;
22929 if (face
->box
!= FACE_NO_BOX
)
22931 int thick
= face
->box_line_width
;
22935 it
->ascent
+= thick
;
22936 it
->descent
+= thick
;
22941 if (it
->start_of_box_run_p
)
22942 it
->pixel_width
+= thick
;
22943 if (it
->end_of_box_run_p
)
22944 it
->pixel_width
+= thick
;
22946 /* If face has an overline, add the height of the overline
22947 (1 pixel) and a 1 pixel margin to the character height. */
22948 if (face
->overline_p
)
22949 it
->ascent
+= overline_margin
;
22950 take_vertical_position_into_account (it
);
22951 if (it
->ascent
< 0)
22953 if (it
->descent
< 0)
22957 append_composite_glyph (it
);
22959 else if (it
->what
== IT_GLYPHLESS
)
22960 produce_glyphless_glyph (it
, 0, Qnil
);
22961 else if (it
->what
== IT_IMAGE
)
22962 produce_image_glyph (it
);
22963 else if (it
->what
== IT_STRETCH
)
22964 produce_stretch_glyph (it
);
22967 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22968 because this isn't true for images with `:ascent 100'. */
22969 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22970 if (it
->area
== TEXT_AREA
)
22971 it
->current_x
+= it
->pixel_width
;
22973 if (extra_line_spacing
> 0)
22975 it
->descent
+= extra_line_spacing
;
22976 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22977 it
->max_extra_line_spacing
= extra_line_spacing
;
22980 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22981 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22982 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22983 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22987 Output LEN glyphs starting at START at the nominal cursor position.
22988 Advance the nominal cursor over the text. The global variable
22989 updated_window contains the window being updated, updated_row is
22990 the glyph row being updated, and updated_area is the area of that
22991 row being updated. */
22994 x_write_glyphs (struct glyph
*start
, int len
)
22998 xassert (updated_window
&& updated_row
);
23001 /* Write glyphs. */
23003 hpos
= start
- updated_row
->glyphs
[updated_area
];
23004 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23005 updated_row
, updated_area
,
23007 DRAW_NORMAL_TEXT
, 0);
23009 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23010 if (updated_area
== TEXT_AREA
23011 && updated_window
->phys_cursor_on_p
23012 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23013 && updated_window
->phys_cursor
.hpos
>= hpos
23014 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23015 updated_window
->phys_cursor_on_p
= 0;
23019 /* Advance the output cursor. */
23020 output_cursor
.hpos
+= len
;
23021 output_cursor
.x
= x
;
23026 Insert LEN glyphs from START at the nominal cursor position. */
23029 x_insert_glyphs (struct glyph
*start
, int len
)
23033 int line_height
, shift_by_width
, shifted_region_width
;
23034 struct glyph_row
*row
;
23035 struct glyph
*glyph
;
23036 int frame_x
, frame_y
;
23039 xassert (updated_window
&& updated_row
);
23041 w
= updated_window
;
23042 f
= XFRAME (WINDOW_FRAME (w
));
23044 /* Get the height of the line we are in. */
23046 line_height
= row
->height
;
23048 /* Get the width of the glyphs to insert. */
23049 shift_by_width
= 0;
23050 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23051 shift_by_width
+= glyph
->pixel_width
;
23053 /* Get the width of the region to shift right. */
23054 shifted_region_width
= (window_box_width (w
, updated_area
)
23059 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23060 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23062 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23063 line_height
, shift_by_width
);
23065 /* Write the glyphs. */
23066 hpos
= start
- row
->glyphs
[updated_area
];
23067 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23069 DRAW_NORMAL_TEXT
, 0);
23071 /* Advance the output cursor. */
23072 output_cursor
.hpos
+= len
;
23073 output_cursor
.x
+= shift_by_width
;
23079 Erase the current text line from the nominal cursor position
23080 (inclusive) to pixel column TO_X (exclusive). The idea is that
23081 everything from TO_X onward is already erased.
23083 TO_X is a pixel position relative to updated_area of
23084 updated_window. TO_X == -1 means clear to the end of this area. */
23087 x_clear_end_of_line (int to_x
)
23090 struct window
*w
= updated_window
;
23091 int max_x
, min_y
, max_y
;
23092 int from_x
, from_y
, to_y
;
23094 xassert (updated_window
&& updated_row
);
23095 f
= XFRAME (w
->frame
);
23097 if (updated_row
->full_width_p
)
23098 max_x
= WINDOW_TOTAL_WIDTH (w
);
23100 max_x
= window_box_width (w
, updated_area
);
23101 max_y
= window_text_bottom_y (w
);
23103 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23104 of window. For TO_X > 0, truncate to end of drawing area. */
23110 to_x
= min (to_x
, max_x
);
23112 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23114 /* Notice if the cursor will be cleared by this operation. */
23115 if (!updated_row
->full_width_p
)
23116 notice_overwritten_cursor (w
, updated_area
,
23117 output_cursor
.x
, -1,
23119 MATRIX_ROW_BOTTOM_Y (updated_row
));
23121 from_x
= output_cursor
.x
;
23123 /* Translate to frame coordinates. */
23124 if (updated_row
->full_width_p
)
23126 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23127 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23131 int area_left
= window_box_left (w
, updated_area
);
23132 from_x
+= area_left
;
23136 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23137 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23138 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23140 /* Prevent inadvertently clearing to end of the X window. */
23141 if (to_x
> from_x
&& to_y
> from_y
)
23144 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23145 to_x
- from_x
, to_y
- from_y
);
23150 #endif /* HAVE_WINDOW_SYSTEM */
23154 /***********************************************************************
23156 ***********************************************************************/
23158 /* Value is the internal representation of the specified cursor type
23159 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23160 of the bar cursor. */
23162 static enum text_cursor_kinds
23163 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23165 enum text_cursor_kinds type
;
23170 if (EQ (arg
, Qbox
))
23171 return FILLED_BOX_CURSOR
;
23173 if (EQ (arg
, Qhollow
))
23174 return HOLLOW_BOX_CURSOR
;
23176 if (EQ (arg
, Qbar
))
23183 && EQ (XCAR (arg
), Qbar
)
23184 && INTEGERP (XCDR (arg
))
23185 && XINT (XCDR (arg
)) >= 0)
23187 *width
= XINT (XCDR (arg
));
23191 if (EQ (arg
, Qhbar
))
23194 return HBAR_CURSOR
;
23198 && EQ (XCAR (arg
), Qhbar
)
23199 && INTEGERP (XCDR (arg
))
23200 && XINT (XCDR (arg
)) >= 0)
23202 *width
= XINT (XCDR (arg
));
23203 return HBAR_CURSOR
;
23206 /* Treat anything unknown as "hollow box cursor".
23207 It was bad to signal an error; people have trouble fixing
23208 .Xdefaults with Emacs, when it has something bad in it. */
23209 type
= HOLLOW_BOX_CURSOR
;
23214 /* Set the default cursor types for specified frame. */
23216 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23221 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23222 FRAME_CURSOR_WIDTH (f
) = width
;
23224 /* By default, set up the blink-off state depending on the on-state. */
23226 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23229 FRAME_BLINK_OFF_CURSOR (f
)
23230 = get_specified_cursor_type (XCDR (tem
), &width
);
23231 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23234 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23238 #ifdef HAVE_WINDOW_SYSTEM
23240 /* Return the cursor we want to be displayed in window W. Return
23241 width of bar/hbar cursor through WIDTH arg. Return with
23242 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23243 (i.e. if the `system caret' should track this cursor).
23245 In a mini-buffer window, we want the cursor only to appear if we
23246 are reading input from this window. For the selected window, we
23247 want the cursor type given by the frame parameter or buffer local
23248 setting of cursor-type. If explicitly marked off, draw no cursor.
23249 In all other cases, we want a hollow box cursor. */
23251 static enum text_cursor_kinds
23252 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23253 int *active_cursor
)
23255 struct frame
*f
= XFRAME (w
->frame
);
23256 struct buffer
*b
= XBUFFER (w
->buffer
);
23257 int cursor_type
= DEFAULT_CURSOR
;
23258 Lisp_Object alt_cursor
;
23259 int non_selected
= 0;
23261 *active_cursor
= 1;
23264 if (cursor_in_echo_area
23265 && FRAME_HAS_MINIBUF_P (f
)
23266 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23268 if (w
== XWINDOW (echo_area_window
))
23270 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23272 *width
= FRAME_CURSOR_WIDTH (f
);
23273 return FRAME_DESIRED_CURSOR (f
);
23276 return get_specified_cursor_type (b
->cursor_type
, width
);
23279 *active_cursor
= 0;
23283 /* Detect a nonselected window or nonselected frame. */
23284 else if (w
!= XWINDOW (f
->selected_window
)
23285 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23287 *active_cursor
= 0;
23289 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23295 /* Never display a cursor in a window in which cursor-type is nil. */
23296 if (NILP (b
->cursor_type
))
23299 /* Get the normal cursor type for this window. */
23300 if (EQ (b
->cursor_type
, Qt
))
23302 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23303 *width
= FRAME_CURSOR_WIDTH (f
);
23306 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23308 /* Use cursor-in-non-selected-windows instead
23309 for non-selected window or frame. */
23312 alt_cursor
= b
->cursor_in_non_selected_windows
;
23313 if (!EQ (Qt
, alt_cursor
))
23314 return get_specified_cursor_type (alt_cursor
, width
);
23315 /* t means modify the normal cursor type. */
23316 if (cursor_type
== FILLED_BOX_CURSOR
)
23317 cursor_type
= HOLLOW_BOX_CURSOR
;
23318 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23320 return cursor_type
;
23323 /* Use normal cursor if not blinked off. */
23324 if (!w
->cursor_off_p
)
23326 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23328 if (cursor_type
== FILLED_BOX_CURSOR
)
23330 /* Using a block cursor on large images can be very annoying.
23331 So use a hollow cursor for "large" images.
23332 If image is not transparent (no mask), also use hollow cursor. */
23333 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23334 if (img
!= NULL
&& IMAGEP (img
->spec
))
23336 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23337 where N = size of default frame font size.
23338 This should cover most of the "tiny" icons people may use. */
23340 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23341 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23342 cursor_type
= HOLLOW_BOX_CURSOR
;
23345 else if (cursor_type
!= NO_CURSOR
)
23347 /* Display current only supports BOX and HOLLOW cursors for images.
23348 So for now, unconditionally use a HOLLOW cursor when cursor is
23349 not a solid box cursor. */
23350 cursor_type
= HOLLOW_BOX_CURSOR
;
23353 return cursor_type
;
23356 /* Cursor is blinked off, so determine how to "toggle" it. */
23358 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23359 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23360 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23362 /* Then see if frame has specified a specific blink off cursor type. */
23363 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23365 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23366 return FRAME_BLINK_OFF_CURSOR (f
);
23370 /* Some people liked having a permanently visible blinking cursor,
23371 while others had very strong opinions against it. So it was
23372 decided to remove it. KFS 2003-09-03 */
23374 /* Finally perform built-in cursor blinking:
23375 filled box <-> hollow box
23376 wide [h]bar <-> narrow [h]bar
23377 narrow [h]bar <-> no cursor
23378 other type <-> no cursor */
23380 if (cursor_type
== FILLED_BOX_CURSOR
)
23381 return HOLLOW_BOX_CURSOR
;
23383 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23386 return cursor_type
;
23394 /* Notice when the text cursor of window W has been completely
23395 overwritten by a drawing operation that outputs glyphs in AREA
23396 starting at X0 and ending at X1 in the line starting at Y0 and
23397 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23398 the rest of the line after X0 has been written. Y coordinates
23399 are window-relative. */
23402 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23403 int x0
, int x1
, int y0
, int y1
)
23405 int cx0
, cx1
, cy0
, cy1
;
23406 struct glyph_row
*row
;
23408 if (!w
->phys_cursor_on_p
)
23410 if (area
!= TEXT_AREA
)
23413 if (w
->phys_cursor
.vpos
< 0
23414 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23415 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23416 !(row
->enabled_p
&& row
->displays_text_p
)))
23419 if (row
->cursor_in_fringe_p
)
23421 row
->cursor_in_fringe_p
= 0;
23422 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23423 w
->phys_cursor_on_p
= 0;
23427 cx0
= w
->phys_cursor
.x
;
23428 cx1
= cx0
+ w
->phys_cursor_width
;
23429 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23432 /* The cursor image will be completely removed from the
23433 screen if the output area intersects the cursor area in
23434 y-direction. When we draw in [y0 y1[, and some part of
23435 the cursor is at y < y0, that part must have been drawn
23436 before. When scrolling, the cursor is erased before
23437 actually scrolling, so we don't come here. When not
23438 scrolling, the rows above the old cursor row must have
23439 changed, and in this case these rows must have written
23440 over the cursor image.
23442 Likewise if part of the cursor is below y1, with the
23443 exception of the cursor being in the first blank row at
23444 the buffer and window end because update_text_area
23445 doesn't draw that row. (Except when it does, but
23446 that's handled in update_text_area.) */
23448 cy0
= w
->phys_cursor
.y
;
23449 cy1
= cy0
+ w
->phys_cursor_height
;
23450 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23453 w
->phys_cursor_on_p
= 0;
23456 #endif /* HAVE_WINDOW_SYSTEM */
23459 /************************************************************************
23461 ************************************************************************/
23463 #ifdef HAVE_WINDOW_SYSTEM
23466 Fix the display of area AREA of overlapping row ROW in window W
23467 with respect to the overlapping part OVERLAPS. */
23470 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23471 enum glyph_row_area area
, int overlaps
)
23478 for (i
= 0; i
< row
->used
[area
];)
23480 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23482 int start
= i
, start_x
= x
;
23486 x
+= row
->glyphs
[area
][i
].pixel_width
;
23489 while (i
< row
->used
[area
]
23490 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23492 draw_glyphs (w
, start_x
, row
, area
,
23494 DRAW_NORMAL_TEXT
, overlaps
);
23498 x
+= row
->glyphs
[area
][i
].pixel_width
;
23508 Draw the cursor glyph of window W in glyph row ROW. See the
23509 comment of draw_glyphs for the meaning of HL. */
23512 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23513 enum draw_glyphs_face hl
)
23515 /* If cursor hpos is out of bounds, don't draw garbage. This can
23516 happen in mini-buffer windows when switching between echo area
23517 glyphs and mini-buffer. */
23518 if ((row
->reversed_p
23519 ? (w
->phys_cursor
.hpos
>= 0)
23520 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23522 int on_p
= w
->phys_cursor_on_p
;
23524 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23525 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23527 w
->phys_cursor_on_p
= on_p
;
23529 if (hl
== DRAW_CURSOR
)
23530 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23531 /* When we erase the cursor, and ROW is overlapped by other
23532 rows, make sure that these overlapping parts of other rows
23534 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23536 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23538 if (row
> w
->current_matrix
->rows
23539 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23540 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23541 OVERLAPS_ERASED_CURSOR
);
23543 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23544 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23545 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23546 OVERLAPS_ERASED_CURSOR
);
23553 Erase the image of a cursor of window W from the screen. */
23556 erase_phys_cursor (struct window
*w
)
23558 struct frame
*f
= XFRAME (w
->frame
);
23559 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23560 int hpos
= w
->phys_cursor
.hpos
;
23561 int vpos
= w
->phys_cursor
.vpos
;
23562 int mouse_face_here_p
= 0;
23563 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23564 struct glyph_row
*cursor_row
;
23565 struct glyph
*cursor_glyph
;
23566 enum draw_glyphs_face hl
;
23568 /* No cursor displayed or row invalidated => nothing to do on the
23570 if (w
->phys_cursor_type
== NO_CURSOR
)
23571 goto mark_cursor_off
;
23573 /* VPOS >= active_glyphs->nrows means that window has been resized.
23574 Don't bother to erase the cursor. */
23575 if (vpos
>= active_glyphs
->nrows
)
23576 goto mark_cursor_off
;
23578 /* If row containing cursor is marked invalid, there is nothing we
23580 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23581 if (!cursor_row
->enabled_p
)
23582 goto mark_cursor_off
;
23584 /* If line spacing is > 0, old cursor may only be partially visible in
23585 window after split-window. So adjust visible height. */
23586 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23587 window_text_bottom_y (w
) - cursor_row
->y
);
23589 /* If row is completely invisible, don't attempt to delete a cursor which
23590 isn't there. This can happen if cursor is at top of a window, and
23591 we switch to a buffer with a header line in that window. */
23592 if (cursor_row
->visible_height
<= 0)
23593 goto mark_cursor_off
;
23595 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23596 if (cursor_row
->cursor_in_fringe_p
)
23598 cursor_row
->cursor_in_fringe_p
= 0;
23599 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23600 goto mark_cursor_off
;
23603 /* This can happen when the new row is shorter than the old one.
23604 In this case, either draw_glyphs or clear_end_of_line
23605 should have cleared the cursor. Note that we wouldn't be
23606 able to erase the cursor in this case because we don't have a
23607 cursor glyph at hand. */
23608 if ((cursor_row
->reversed_p
23609 ? (w
->phys_cursor
.hpos
< 0)
23610 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23611 goto mark_cursor_off
;
23613 /* If the cursor is in the mouse face area, redisplay that when
23614 we clear the cursor. */
23615 if (! NILP (hlinfo
->mouse_face_window
)
23616 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23617 /* Don't redraw the cursor's spot in mouse face if it is at the
23618 end of a line (on a newline). The cursor appears there, but
23619 mouse highlighting does not. */
23620 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23621 mouse_face_here_p
= 1;
23623 /* Maybe clear the display under the cursor. */
23624 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23627 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23630 cursor_glyph
= get_phys_cursor_glyph (w
);
23631 if (cursor_glyph
== NULL
)
23632 goto mark_cursor_off
;
23634 width
= cursor_glyph
->pixel_width
;
23635 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23636 x
= w
->phys_cursor
.x
;
23638 width
-= left_x
- x
;
23639 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23640 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23641 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23644 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23647 /* Erase the cursor by redrawing the character underneath it. */
23648 if (mouse_face_here_p
)
23649 hl
= DRAW_MOUSE_FACE
;
23651 hl
= DRAW_NORMAL_TEXT
;
23652 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23655 w
->phys_cursor_on_p
= 0;
23656 w
->phys_cursor_type
= NO_CURSOR
;
23661 Display or clear cursor of window W. If ON is zero, clear the
23662 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23663 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23666 display_and_set_cursor (struct window
*w
, int on
,
23667 int hpos
, int vpos
, int x
, int y
)
23669 struct frame
*f
= XFRAME (w
->frame
);
23670 int new_cursor_type
;
23671 int new_cursor_width
;
23673 struct glyph_row
*glyph_row
;
23674 struct glyph
*glyph
;
23676 /* This is pointless on invisible frames, and dangerous on garbaged
23677 windows and frames; in the latter case, the frame or window may
23678 be in the midst of changing its size, and x and y may be off the
23680 if (! FRAME_VISIBLE_P (f
)
23681 || FRAME_GARBAGED_P (f
)
23682 || vpos
>= w
->current_matrix
->nrows
23683 || hpos
>= w
->current_matrix
->matrix_w
)
23686 /* If cursor is off and we want it off, return quickly. */
23687 if (!on
&& !w
->phys_cursor_on_p
)
23690 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23691 /* If cursor row is not enabled, we don't really know where to
23692 display the cursor. */
23693 if (!glyph_row
->enabled_p
)
23695 w
->phys_cursor_on_p
= 0;
23700 if (!glyph_row
->exact_window_width_line_p
23701 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23702 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23704 xassert (interrupt_input_blocked
);
23706 /* Set new_cursor_type to the cursor we want to be displayed. */
23707 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23708 &new_cursor_width
, &active_cursor
);
23710 /* If cursor is currently being shown and we don't want it to be or
23711 it is in the wrong place, or the cursor type is not what we want,
23713 if (w
->phys_cursor_on_p
23715 || w
->phys_cursor
.x
!= x
23716 || w
->phys_cursor
.y
!= y
23717 || new_cursor_type
!= w
->phys_cursor_type
23718 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23719 && new_cursor_width
!= w
->phys_cursor_width
)))
23720 erase_phys_cursor (w
);
23722 /* Don't check phys_cursor_on_p here because that flag is only set
23723 to zero in some cases where we know that the cursor has been
23724 completely erased, to avoid the extra work of erasing the cursor
23725 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23726 still not be visible, or it has only been partly erased. */
23729 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23730 w
->phys_cursor_height
= glyph_row
->height
;
23732 /* Set phys_cursor_.* before x_draw_.* is called because some
23733 of them may need the information. */
23734 w
->phys_cursor
.x
= x
;
23735 w
->phys_cursor
.y
= glyph_row
->y
;
23736 w
->phys_cursor
.hpos
= hpos
;
23737 w
->phys_cursor
.vpos
= vpos
;
23740 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23741 new_cursor_type
, new_cursor_width
,
23742 on
, active_cursor
);
23746 /* Switch the display of W's cursor on or off, according to the value
23750 update_window_cursor (struct window
*w
, int on
)
23752 /* Don't update cursor in windows whose frame is in the process
23753 of being deleted. */
23754 if (w
->current_matrix
)
23757 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23758 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23764 /* Call update_window_cursor with parameter ON_P on all leaf windows
23765 in the window tree rooted at W. */
23768 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23772 if (!NILP (w
->hchild
))
23773 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23774 else if (!NILP (w
->vchild
))
23775 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23777 update_window_cursor (w
, on_p
);
23779 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23785 Display the cursor on window W, or clear it, according to ON_P.
23786 Don't change the cursor's position. */
23789 x_update_cursor (struct frame
*f
, int on_p
)
23791 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23796 Clear the cursor of window W to background color, and mark the
23797 cursor as not shown. This is used when the text where the cursor
23798 is about to be rewritten. */
23801 x_clear_cursor (struct window
*w
)
23803 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23804 update_window_cursor (w
, 0);
23807 #endif /* HAVE_WINDOW_SYSTEM */
23809 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
23812 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
23813 int start_hpos
, int end_hpos
,
23814 enum draw_glyphs_face draw
)
23816 #ifdef HAVE_WINDOW_SYSTEM
23817 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
23819 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
23823 #if defined (HAVE_GPM) || defined (MSDOS)
23824 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
23829 Display the active region described by mouse_face_* according to DRAW. */
23832 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
23834 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
23835 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23837 if (/* If window is in the process of being destroyed, don't bother
23839 w
->current_matrix
!= NULL
23840 /* Don't update mouse highlight if hidden */
23841 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
23842 /* Recognize when we are called to operate on rows that don't exist
23843 anymore. This can happen when a window is split. */
23844 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23846 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23847 struct glyph_row
*row
, *first
, *last
;
23849 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23850 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23852 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23854 int start_hpos
, end_hpos
, start_x
;
23856 /* For all but the first row, the highlight starts at column 0. */
23859 /* R2L rows have BEG and END in reversed order, but the
23860 screen drawing geometry is always left to right. So
23861 we need to mirror the beginning and end of the
23862 highlighted area in R2L rows. */
23863 if (!row
->reversed_p
)
23865 start_hpos
= hlinfo
->mouse_face_beg_col
;
23866 start_x
= hlinfo
->mouse_face_beg_x
;
23868 else if (row
== last
)
23870 start_hpos
= hlinfo
->mouse_face_end_col
;
23871 start_x
= hlinfo
->mouse_face_end_x
;
23879 else if (row
->reversed_p
&& row
== last
)
23881 start_hpos
= hlinfo
->mouse_face_end_col
;
23882 start_x
= hlinfo
->mouse_face_end_x
;
23892 if (!row
->reversed_p
)
23893 end_hpos
= hlinfo
->mouse_face_end_col
;
23894 else if (row
== first
)
23895 end_hpos
= hlinfo
->mouse_face_beg_col
;
23898 end_hpos
= row
->used
[TEXT_AREA
];
23899 if (draw
== DRAW_NORMAL_TEXT
)
23900 row
->fill_line_p
= 1; /* Clear to end of line */
23903 else if (row
->reversed_p
&& row
== first
)
23904 end_hpos
= hlinfo
->mouse_face_beg_col
;
23907 end_hpos
= row
->used
[TEXT_AREA
];
23908 if (draw
== DRAW_NORMAL_TEXT
)
23909 row
->fill_line_p
= 1; /* Clear to end of line */
23912 if (end_hpos
> start_hpos
)
23914 draw_row_with_mouse_face (w
, start_x
, row
,
23915 start_hpos
, end_hpos
, draw
);
23918 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23922 #ifdef HAVE_WINDOW_SYSTEM
23923 /* When we've written over the cursor, arrange for it to
23924 be displayed again. */
23925 if (FRAME_WINDOW_P (f
)
23926 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23929 display_and_set_cursor (w
, 1,
23930 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23931 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23934 #endif /* HAVE_WINDOW_SYSTEM */
23937 #ifdef HAVE_WINDOW_SYSTEM
23938 /* Change the mouse cursor. */
23939 if (FRAME_WINDOW_P (f
))
23941 if (draw
== DRAW_NORMAL_TEXT
23942 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
23943 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23944 else if (draw
== DRAW_MOUSE_FACE
)
23945 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23947 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23949 #endif /* HAVE_WINDOW_SYSTEM */
23953 Clear out the mouse-highlighted active region.
23954 Redraw it un-highlighted first. Value is non-zero if mouse
23955 face was actually drawn unhighlighted. */
23958 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
23962 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
23964 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
23968 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
23969 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
23970 hlinfo
->mouse_face_window
= Qnil
;
23971 hlinfo
->mouse_face_overlay
= Qnil
;
23975 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
23976 within the mouse face on that window. */
23978 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
23980 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
23982 /* Quickly resolve the easy cases. */
23983 if (!(WINDOWP (hlinfo
->mouse_face_window
)
23984 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
23986 if (vpos
< hlinfo
->mouse_face_beg_row
23987 || vpos
> hlinfo
->mouse_face_end_row
)
23989 if (vpos
> hlinfo
->mouse_face_beg_row
23990 && vpos
< hlinfo
->mouse_face_end_row
)
23993 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
23995 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
23997 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24000 else if ((vpos
== hlinfo
->mouse_face_beg_row
24001 && hpos
>= hlinfo
->mouse_face_beg_col
)
24002 || (vpos
== hlinfo
->mouse_face_end_row
24003 && hpos
< hlinfo
->mouse_face_end_col
))
24008 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24010 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24013 else if ((vpos
== hlinfo
->mouse_face_beg_row
24014 && hpos
<= hlinfo
->mouse_face_beg_col
)
24015 || (vpos
== hlinfo
->mouse_face_end_row
24016 && hpos
> hlinfo
->mouse_face_end_col
))
24024 Non-zero if physical cursor of window W is within mouse face. */
24027 cursor_in_mouse_face_p (struct window
*w
)
24029 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24034 /* Find the glyph rows START_ROW and END_ROW of window W that display
24035 characters between buffer positions START_CHARPOS and END_CHARPOS
24036 (excluding END_CHARPOS). This is similar to row_containing_pos,
24037 but is more accurate when bidi reordering makes buffer positions
24038 change non-linearly with glyph rows. */
24040 rows_from_pos_range (struct window
*w
,
24041 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24042 struct glyph_row
**start
, struct glyph_row
**end
)
24044 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24045 int last_y
= window_text_bottom_y (w
);
24046 struct glyph_row
*row
;
24051 while (!first
->enabled_p
24052 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24055 /* Find the START row. */
24057 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24060 /* A row can potentially be the START row if the range of the
24061 characters it displays intersects the range
24062 [START_CHARPOS..END_CHARPOS). */
24063 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24064 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24065 /* See the commentary in row_containing_pos, for the
24066 explanation of the complicated way to check whether
24067 some position is beyond the end of the characters
24068 displayed by a row. */
24069 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24070 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24071 && !row
->ends_at_zv_p
24072 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24073 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24074 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24075 && !row
->ends_at_zv_p
24076 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24078 /* Found a candidate row. Now make sure at least one of the
24079 glyphs it displays has a charpos from the range
24080 [START_CHARPOS..END_CHARPOS).
24082 This is not obvious because bidi reordering could make
24083 buffer positions of a row be 1,2,3,102,101,100, and if we
24084 want to highlight characters in [50..60), we don't want
24085 this row, even though [50..60) does intersect [1..103),
24086 the range of character positions given by the row's start
24087 and end positions. */
24088 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24089 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24093 if (BUFFERP (g
->object
)
24094 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24103 /* Find the END row. */
24105 /* If the last row is partially visible, start looking for END
24106 from that row, instead of starting from FIRST. */
24107 && !(row
->enabled_p
24108 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24110 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24112 struct glyph_row
*next
= row
+ 1;
24114 if (!next
->enabled_p
24115 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24116 /* The first row >= START whose range of displayed characters
24117 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24118 is the row END + 1. */
24119 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24120 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24121 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24122 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24123 && !next
->ends_at_zv_p
24124 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24125 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24126 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24127 && !next
->ends_at_zv_p
24128 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24135 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24136 but none of the characters it displays are in the range, it is
24138 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24139 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24143 if (BUFFERP (g
->object
)
24144 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24157 /* This function sets the mouse_face_* elements of HLINFO, assuming
24158 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24159 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24160 for the overlay or run of text properties specifying the mouse
24161 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24162 before-string and after-string that must also be highlighted.
24163 DISPLAY_STRING, if non-nil, is a display string that may cover some
24164 or all of the highlighted text. */
24167 mouse_face_from_buffer_pos (Lisp_Object window
,
24168 Mouse_HLInfo
*hlinfo
,
24169 EMACS_INT mouse_charpos
,
24170 EMACS_INT start_charpos
,
24171 EMACS_INT end_charpos
,
24172 Lisp_Object before_string
,
24173 Lisp_Object after_string
,
24174 Lisp_Object display_string
)
24176 struct window
*w
= XWINDOW (window
);
24177 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24178 struct glyph_row
*r1
, *r2
;
24179 struct glyph
*glyph
, *end
;
24180 EMACS_INT ignore
, pos
;
24183 xassert (NILP (display_string
) || STRINGP (display_string
));
24184 xassert (NILP (before_string
) || STRINGP (before_string
));
24185 xassert (NILP (after_string
) || STRINGP (after_string
));
24187 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24188 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24190 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24191 /* If the before-string or display-string contains newlines,
24192 rows_from_pos_range skips to its last row. Move back. */
24193 if (!NILP (before_string
) || !NILP (display_string
))
24195 struct glyph_row
*prev
;
24196 while ((prev
= r1
- 1, prev
>= first
)
24197 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24198 && prev
->used
[TEXT_AREA
] > 0)
24200 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24201 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24202 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24204 || !(EQ (glyph
->object
, before_string
)
24205 || EQ (glyph
->object
, display_string
)))
24212 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24213 hlinfo
->mouse_face_past_end
= 1;
24215 else if (!NILP (after_string
))
24217 /* If the after-string has newlines, advance to its last row. */
24218 struct glyph_row
*next
;
24219 struct glyph_row
*last
24220 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24222 for (next
= r2
+ 1;
24224 && next
->used
[TEXT_AREA
] > 0
24225 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24229 /* The rest of the display engine assumes that mouse_face_beg_row is
24230 either above below mouse_face_end_row or identical to it. But
24231 with bidi-reordered continued lines, the row for START_CHARPOS
24232 could be below the row for END_CHARPOS. If so, swap the rows and
24233 store them in correct order. */
24236 struct glyph_row
*tem
= r2
;
24242 hlinfo
->mouse_face_beg_y
= r1
->y
;
24243 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24244 hlinfo
->mouse_face_end_y
= r2
->y
;
24245 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24247 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24248 AFTER_STRING, DISPLAY_STRING, START_CHARPOS, and END_CHARPOS
24249 could be anywhere in the row and in any order. The strategy
24250 below is to find the leftmost and the rightmost glyph that
24251 belongs to either of these 3 strings, or whose position is
24252 between START_CHARPOS and END_CHARPOS, and highlight all the
24253 glyphs between those two. This may cover more than just the text
24254 between START_CHARPOS and END_CHARPOS if the range of characters
24255 strides the bidi level boundary, e.g. if the beginning is in R2L
24256 text while the end is in L2R text or vice versa. */
24257 if (!r1
->reversed_p
)
24259 /* This row is in a left to right paragraph. Scan it left to
24261 glyph
= r1
->glyphs
[TEXT_AREA
];
24262 end
= glyph
+ r1
->used
[TEXT_AREA
];
24265 /* Skip truncation glyphs at the start of the glyph row. */
24266 if (r1
->displays_text_p
)
24268 && INTEGERP (glyph
->object
)
24269 && glyph
->charpos
< 0;
24271 x
+= glyph
->pixel_width
;
24273 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24274 or DISPLAY_STRING, and the first glyph from buffer whose
24275 position is between START_CHARPOS and END_CHARPOS. */
24277 && !INTEGERP (glyph
->object
)
24278 && !EQ (glyph
->object
, display_string
)
24279 && !(BUFFERP (glyph
->object
)
24280 && (glyph
->charpos
>= start_charpos
24281 && glyph
->charpos
< end_charpos
));
24284 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24285 are present at buffer positions between START_CHARPOS and
24286 END_CHARPOS, or if they come from an overlay. */
24287 if (EQ (glyph
->object
, before_string
))
24289 pos
= string_buffer_position (w
, before_string
,
24291 /* If pos == 0, it means before_string came from an
24292 overlay, not from a buffer position. */
24293 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24296 else if (EQ (glyph
->object
, after_string
))
24298 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24299 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24302 x
+= glyph
->pixel_width
;
24304 hlinfo
->mouse_face_beg_x
= x
;
24305 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24309 /* This row is in a right to left paragraph. Scan it right to
24313 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24314 glyph
= end
+ r1
->used
[TEXT_AREA
];
24316 /* Skip truncation glyphs at the start of the glyph row. */
24317 if (r1
->displays_text_p
)
24319 && INTEGERP (glyph
->object
)
24320 && glyph
->charpos
< 0;
24324 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24325 or DISPLAY_STRING, and the first glyph from buffer whose
24326 position is between START_CHARPOS and END_CHARPOS. */
24328 && !INTEGERP (glyph
->object
)
24329 && !EQ (glyph
->object
, display_string
)
24330 && !(BUFFERP (glyph
->object
)
24331 && (glyph
->charpos
>= start_charpos
24332 && glyph
->charpos
< end_charpos
));
24335 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24336 are present at buffer positions between START_CHARPOS and
24337 END_CHARPOS, or if they come from an overlay. */
24338 if (EQ (glyph
->object
, before_string
))
24340 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24341 /* If pos == 0, it means before_string came from an
24342 overlay, not from a buffer position. */
24343 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24346 else if (EQ (glyph
->object
, after_string
))
24348 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24349 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24354 glyph
++; /* first glyph to the right of the highlighted area */
24355 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24356 x
+= g
->pixel_width
;
24357 hlinfo
->mouse_face_beg_x
= x
;
24358 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24361 /* If the highlight ends in a different row, compute GLYPH and END
24362 for the end row. Otherwise, reuse the values computed above for
24363 the row where the highlight begins. */
24366 if (!r2
->reversed_p
)
24368 glyph
= r2
->glyphs
[TEXT_AREA
];
24369 end
= glyph
+ r2
->used
[TEXT_AREA
];
24374 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24375 glyph
= end
+ r2
->used
[TEXT_AREA
];
24379 if (!r2
->reversed_p
)
24381 /* Skip truncation and continuation glyphs near the end of the
24382 row, and also blanks and stretch glyphs inserted by
24383 extend_face_to_end_of_line. */
24385 && INTEGERP ((end
- 1)->object
)
24386 && (end
- 1)->charpos
<= 0)
24388 /* Scan the rest of the glyph row from the end, looking for the
24389 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24390 DISPLAY_STRING, or whose position is between START_CHARPOS
24394 && !INTEGERP (end
->object
)
24395 && !EQ (end
->object
, display_string
)
24396 && !(BUFFERP (end
->object
)
24397 && (end
->charpos
>= start_charpos
24398 && end
->charpos
< end_charpos
));
24401 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24402 are present at buffer positions between START_CHARPOS and
24403 END_CHARPOS, or if they come from an overlay. */
24404 if (EQ (end
->object
, before_string
))
24406 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24407 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24410 else if (EQ (end
->object
, after_string
))
24412 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24413 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24417 /* Find the X coordinate of the last glyph to be highlighted. */
24418 for (; glyph
<= end
; ++glyph
)
24419 x
+= glyph
->pixel_width
;
24421 hlinfo
->mouse_face_end_x
= x
;
24422 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24426 /* Skip truncation and continuation glyphs near the end of the
24427 row, and also blanks and stretch glyphs inserted by
24428 extend_face_to_end_of_line. */
24432 && INTEGERP (end
->object
)
24433 && end
->charpos
<= 0)
24435 x
+= end
->pixel_width
;
24438 /* Scan the rest of the glyph row from the end, looking for the
24439 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24440 DISPLAY_STRING, or whose position is between START_CHARPOS
24444 && !INTEGERP (end
->object
)
24445 && !EQ (end
->object
, display_string
)
24446 && !(BUFFERP (end
->object
)
24447 && (end
->charpos
>= start_charpos
24448 && end
->charpos
< end_charpos
));
24451 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24452 are present at buffer positions between START_CHARPOS and
24453 END_CHARPOS, or if they come from an overlay. */
24454 if (EQ (end
->object
, before_string
))
24456 pos
= string_buffer_position (w
, before_string
, start_charpos
);
24457 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24460 else if (EQ (end
->object
, after_string
))
24462 pos
= string_buffer_position (w
, after_string
, end_charpos
);
24463 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24466 x
+= end
->pixel_width
;
24468 hlinfo
->mouse_face_end_x
= x
;
24469 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24472 hlinfo
->mouse_face_window
= window
;
24473 hlinfo
->mouse_face_face_id
24474 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24476 !hlinfo
->mouse_face_hidden
, -1);
24477 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24480 /* The following function is not used anymore (replaced with
24481 mouse_face_from_string_pos), but I leave it here for the time
24482 being, in case someone would. */
24484 #if 0 /* not used */
24486 /* Find the position of the glyph for position POS in OBJECT in
24487 window W's current matrix, and return in *X, *Y the pixel
24488 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24490 RIGHT_P non-zero means return the position of the right edge of the
24491 glyph, RIGHT_P zero means return the left edge position.
24493 If no glyph for POS exists in the matrix, return the position of
24494 the glyph with the next smaller position that is in the matrix, if
24495 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24496 exists in the matrix, return the position of the glyph with the
24497 next larger position in OBJECT.
24499 Value is non-zero if a glyph was found. */
24502 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24503 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24505 int yb
= window_text_bottom_y (w
);
24506 struct glyph_row
*r
;
24507 struct glyph
*best_glyph
= NULL
;
24508 struct glyph_row
*best_row
= NULL
;
24511 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24512 r
->enabled_p
&& r
->y
< yb
;
24515 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24516 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24519 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24520 if (EQ (g
->object
, object
))
24522 if (g
->charpos
== pos
)
24529 else if (best_glyph
== NULL
24530 || ((eabs (g
->charpos
- pos
)
24531 < eabs (best_glyph
->charpos
- pos
))
24534 : g
->charpos
> pos
)))
24548 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24552 *x
+= best_glyph
->pixel_width
;
24557 *vpos
= best_row
- w
->current_matrix
->rows
;
24560 return best_glyph
!= NULL
;
24562 #endif /* not used */
24564 /* Find the positions of the first and the last glyphs in window W's
24565 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24566 (assumed to be a string), and return in HLINFO's mouse_face_*
24567 members the pixel and column/row coordinates of those glyphs. */
24570 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24571 Lisp_Object object
,
24572 EMACS_INT startpos
, EMACS_INT endpos
)
24574 int yb
= window_text_bottom_y (w
);
24575 struct glyph_row
*r
;
24576 struct glyph
*g
, *e
;
24580 /* Find the glyph row with at least one position in the range
24581 [STARTPOS..ENDPOS], and the first glyph in that row whose
24582 position belongs to that range. */
24583 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24584 r
->enabled_p
&& r
->y
< yb
;
24587 if (!r
->reversed_p
)
24589 g
= r
->glyphs
[TEXT_AREA
];
24590 e
= g
+ r
->used
[TEXT_AREA
];
24591 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24592 if (EQ (g
->object
, object
)
24593 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24595 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24596 hlinfo
->mouse_face_beg_y
= r
->y
;
24597 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24598 hlinfo
->mouse_face_beg_x
= gx
;
24607 e
= r
->glyphs
[TEXT_AREA
];
24608 g
= e
+ r
->used
[TEXT_AREA
];
24609 for ( ; g
> e
; --g
)
24610 if (EQ ((g
-1)->object
, object
)
24611 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24613 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24614 hlinfo
->mouse_face_beg_y
= r
->y
;
24615 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24616 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24617 gx
+= g1
->pixel_width
;
24618 hlinfo
->mouse_face_beg_x
= gx
;
24630 /* Starting with the next row, look for the first row which does NOT
24631 include any glyphs whose positions are in the range. */
24632 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24634 g
= r
->glyphs
[TEXT_AREA
];
24635 e
= g
+ r
->used
[TEXT_AREA
];
24637 for ( ; g
< e
; ++g
)
24638 if (EQ (g
->object
, object
)
24639 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24648 /* The highlighted region ends on the previous row. */
24651 /* Set the end row and its vertical pixel coordinate. */
24652 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24653 hlinfo
->mouse_face_end_y
= r
->y
;
24655 /* Compute and set the end column and the end column's horizontal
24656 pixel coordinate. */
24657 if (!r
->reversed_p
)
24659 g
= r
->glyphs
[TEXT_AREA
];
24660 e
= g
+ r
->used
[TEXT_AREA
];
24661 for ( ; e
> g
; --e
)
24662 if (EQ ((e
-1)->object
, object
)
24663 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24665 hlinfo
->mouse_face_end_col
= e
- g
;
24667 for (gx
= r
->x
; g
< e
; ++g
)
24668 gx
+= g
->pixel_width
;
24669 hlinfo
->mouse_face_end_x
= gx
;
24673 e
= r
->glyphs
[TEXT_AREA
];
24674 g
= e
+ r
->used
[TEXT_AREA
];
24675 for (gx
= r
->x
; e
< g
; ++e
)
24677 if (EQ (e
->object
, object
)
24678 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24680 gx
+= e
->pixel_width
;
24682 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24683 hlinfo
->mouse_face_end_x
= gx
;
24687 #ifdef HAVE_WINDOW_SYSTEM
24689 /* See if position X, Y is within a hot-spot of an image. */
24692 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24694 if (!CONSP (hot_spot
))
24697 if (EQ (XCAR (hot_spot
), Qrect
))
24699 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24700 Lisp_Object rect
= XCDR (hot_spot
);
24704 if (!CONSP (XCAR (rect
)))
24706 if (!CONSP (XCDR (rect
)))
24708 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24710 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24712 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24714 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24718 else if (EQ (XCAR (hot_spot
), Qcircle
))
24720 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24721 Lisp_Object circ
= XCDR (hot_spot
);
24722 Lisp_Object lr
, lx0
, ly0
;
24724 && CONSP (XCAR (circ
))
24725 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24726 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24727 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24729 double r
= XFLOATINT (lr
);
24730 double dx
= XINT (lx0
) - x
;
24731 double dy
= XINT (ly0
) - y
;
24732 return (dx
* dx
+ dy
* dy
<= r
* r
);
24735 else if (EQ (XCAR (hot_spot
), Qpoly
))
24737 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24738 if (VECTORP (XCDR (hot_spot
)))
24740 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24741 Lisp_Object
*poly
= v
->contents
;
24745 Lisp_Object lx
, ly
;
24748 /* Need an even number of coordinates, and at least 3 edges. */
24749 if (n
< 6 || n
& 1)
24752 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24753 If count is odd, we are inside polygon. Pixels on edges
24754 may or may not be included depending on actual geometry of the
24756 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24757 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24759 x0
= XINT (lx
), y0
= XINT (ly
);
24760 for (i
= 0; i
< n
; i
+= 2)
24762 int x1
= x0
, y1
= y0
;
24763 if ((lx
= poly
[i
], !INTEGERP (lx
))
24764 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24766 x0
= XINT (lx
), y0
= XINT (ly
);
24768 /* Does this segment cross the X line? */
24776 if (y
> y0
&& y
> y1
)
24778 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24788 find_hot_spot (Lisp_Object map
, int x
, int y
)
24790 while (CONSP (map
))
24792 if (CONSP (XCAR (map
))
24793 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24801 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24803 doc
: /* Lookup in image map MAP coordinates X and Y.
24804 An image map is an alist where each element has the format (AREA ID PLIST).
24805 An AREA is specified as either a rectangle, a circle, or a polygon:
24806 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24807 pixel coordinates of the upper left and bottom right corners.
24808 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24809 and the radius of the circle; r may be a float or integer.
24810 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24811 vector describes one corner in the polygon.
24812 Returns the alist element for the first matching AREA in MAP. */)
24813 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24821 return find_hot_spot (map
, XINT (x
), XINT (y
));
24825 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24827 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24829 /* Do not change cursor shape while dragging mouse. */
24830 if (!NILP (do_mouse_tracking
))
24833 if (!NILP (pointer
))
24835 if (EQ (pointer
, Qarrow
))
24836 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24837 else if (EQ (pointer
, Qhand
))
24838 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24839 else if (EQ (pointer
, Qtext
))
24840 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24841 else if (EQ (pointer
, intern ("hdrag")))
24842 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24843 #ifdef HAVE_X_WINDOWS
24844 else if (EQ (pointer
, intern ("vdrag")))
24845 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24847 else if (EQ (pointer
, intern ("hourglass")))
24848 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24849 else if (EQ (pointer
, Qmodeline
))
24850 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24852 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24855 if (cursor
!= No_Cursor
)
24856 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24859 #endif /* HAVE_WINDOW_SYSTEM */
24861 /* Take proper action when mouse has moved to the mode or header line
24862 or marginal area AREA of window W, x-position X and y-position Y.
24863 X is relative to the start of the text display area of W, so the
24864 width of bitmap areas and scroll bars must be subtracted to get a
24865 position relative to the start of the mode line. */
24868 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24869 enum window_part area
)
24871 struct window
*w
= XWINDOW (window
);
24872 struct frame
*f
= XFRAME (w
->frame
);
24873 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24874 #ifdef HAVE_WINDOW_SYSTEM
24875 Display_Info
*dpyinfo
;
24877 Cursor cursor
= No_Cursor
;
24878 Lisp_Object pointer
= Qnil
;
24879 int dx
, dy
, width
, height
;
24881 Lisp_Object string
, object
= Qnil
;
24882 Lisp_Object pos
, help
;
24884 Lisp_Object mouse_face
;
24885 int original_x_pixel
= x
;
24886 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24887 struct glyph_row
*row
;
24889 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24894 /* Kludge alert: mode_line_string takes X/Y in pixels, but
24895 returns them in row/column units! */
24896 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24897 &object
, &dx
, &dy
, &width
, &height
);
24899 row
= (area
== ON_MODE_LINE
24900 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24901 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24903 /* Find the glyph under the mouse pointer. */
24904 if (row
->mode_line_p
&& row
->enabled_p
)
24906 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24907 end
= glyph
+ row
->used
[TEXT_AREA
];
24909 for (x0
= original_x_pixel
;
24910 glyph
< end
&& x0
>= glyph
->pixel_width
;
24912 x0
-= glyph
->pixel_width
;
24920 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24921 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
24922 returns them in row/column units! */
24923 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24924 &object
, &dx
, &dy
, &width
, &height
);
24929 #ifdef HAVE_WINDOW_SYSTEM
24930 if (IMAGEP (object
))
24932 Lisp_Object image_map
, hotspot
;
24933 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24935 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24937 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24939 Lisp_Object area_id
, plist
;
24941 area_id
= XCAR (hotspot
);
24942 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24943 If so, we could look for mouse-enter, mouse-leave
24944 properties in PLIST (and do something...). */
24945 hotspot
= XCDR (hotspot
);
24946 if (CONSP (hotspot
)
24947 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24949 pointer
= Fplist_get (plist
, Qpointer
);
24950 if (NILP (pointer
))
24952 help
= Fplist_get (plist
, Qhelp_echo
);
24955 help_echo_string
= help
;
24956 /* Is this correct? ++kfs */
24957 XSETWINDOW (help_echo_window
, w
);
24958 help_echo_object
= w
->buffer
;
24959 help_echo_pos
= charpos
;
24963 if (NILP (pointer
))
24964 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24966 #endif /* HAVE_WINDOW_SYSTEM */
24968 if (STRINGP (string
))
24970 pos
= make_number (charpos
);
24971 /* If we're on a string with `help-echo' text property, arrange
24972 for the help to be displayed. This is done by setting the
24973 global variable help_echo_string to the help string. */
24976 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24979 help_echo_string
= help
;
24980 XSETWINDOW (help_echo_window
, w
);
24981 help_echo_object
= string
;
24982 help_echo_pos
= charpos
;
24986 #ifdef HAVE_WINDOW_SYSTEM
24987 if (FRAME_WINDOW_P (f
))
24989 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24990 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24991 if (NILP (pointer
))
24992 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24994 /* Change the mouse pointer according to what is under X/Y. */
24996 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24999 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25000 if (!KEYMAPP (map
))
25001 map
= Fget_text_property (pos
, Qkeymap
, string
);
25002 if (!KEYMAPP (map
))
25003 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25008 /* Change the mouse face according to what is under X/Y. */
25009 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25010 if (!NILP (mouse_face
)
25011 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25016 struct glyph
* tmp_glyph
;
25020 int total_pixel_width
;
25021 EMACS_INT begpos
, endpos
, ignore
;
25025 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25026 Qmouse_face
, string
, Qnil
);
25032 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25034 endpos
= SCHARS (string
);
25038 /* Calculate the glyph position GPOS of GLYPH in the
25039 displayed string, relative to the beginning of the
25040 highlighted part of the string.
25042 Note: GPOS is different from CHARPOS. CHARPOS is the
25043 position of GLYPH in the internal string object. A mode
25044 line string format has structures which are converted to
25045 a flattened string by the Emacs Lisp interpreter. The
25046 internal string is an element of those structures. The
25047 displayed string is the flattened string. */
25048 tmp_glyph
= row_start_glyph
;
25049 while (tmp_glyph
< glyph
25050 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25051 && begpos
<= tmp_glyph
->charpos
25052 && tmp_glyph
->charpos
< endpos
)))
25054 gpos
= glyph
- tmp_glyph
;
25056 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25057 the highlighted part of the displayed string to which
25058 GLYPH belongs. Note: GSEQ_LENGTH is different from
25059 SCHARS (STRING), because the latter returns the length of
25060 the internal string. */
25061 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25063 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25064 && begpos
<= tmp_glyph
->charpos
25065 && tmp_glyph
->charpos
< endpos
));
25068 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25070 /* Calculate the total pixel width of all the glyphs between
25071 the beginning of the highlighted area and GLYPH. */
25072 total_pixel_width
= 0;
25073 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25074 total_pixel_width
+= tmp_glyph
->pixel_width
;
25076 /* Pre calculation of re-rendering position. Note: X is in
25077 column units here, after the call to mode_line_string or
25078 marginal_area_string. */
25080 vpos
= (area
== ON_MODE_LINE
25081 ? (w
->current_matrix
)->nrows
- 1
25084 /* If GLYPH's position is included in the region that is
25085 already drawn in mouse face, we have nothing to do. */
25086 if ( EQ (window
, hlinfo
->mouse_face_window
)
25087 && (!row
->reversed_p
25088 ? (hlinfo
->mouse_face_beg_col
<= hpos
25089 && hpos
< hlinfo
->mouse_face_end_col
)
25090 /* In R2L rows we swap BEG and END, see below. */
25091 : (hlinfo
->mouse_face_end_col
<= hpos
25092 && hpos
< hlinfo
->mouse_face_beg_col
))
25093 && hlinfo
->mouse_face_beg_row
== vpos
)
25096 if (clear_mouse_face (hlinfo
))
25097 cursor
= No_Cursor
;
25099 if (!row
->reversed_p
)
25101 hlinfo
->mouse_face_beg_col
= hpos
;
25102 hlinfo
->mouse_face_beg_x
= original_x_pixel
25103 - (total_pixel_width
+ dx
);
25104 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25105 hlinfo
->mouse_face_end_x
= 0;
25109 /* In R2L rows, show_mouse_face expects BEG and END
25110 coordinates to be swapped. */
25111 hlinfo
->mouse_face_end_col
= hpos
;
25112 hlinfo
->mouse_face_end_x
= original_x_pixel
25113 - (total_pixel_width
+ dx
);
25114 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25115 hlinfo
->mouse_face_beg_x
= 0;
25118 hlinfo
->mouse_face_beg_row
= vpos
;
25119 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25120 hlinfo
->mouse_face_beg_y
= 0;
25121 hlinfo
->mouse_face_end_y
= 0;
25122 hlinfo
->mouse_face_past_end
= 0;
25123 hlinfo
->mouse_face_window
= window
;
25125 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25131 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25133 if (NILP (pointer
))
25136 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25137 clear_mouse_face (hlinfo
);
25139 #ifdef HAVE_WINDOW_SYSTEM
25140 if (FRAME_WINDOW_P (f
))
25141 define_frame_cursor1 (f
, cursor
, pointer
);
25147 Take proper action when the mouse has moved to position X, Y on
25148 frame F as regards highlighting characters that have mouse-face
25149 properties. Also de-highlighting chars where the mouse was before.
25150 X and Y can be negative or out of range. */
25153 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25155 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25156 enum window_part part
;
25157 Lisp_Object window
;
25159 Cursor cursor
= No_Cursor
;
25160 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25163 /* When a menu is active, don't highlight because this looks odd. */
25164 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25165 if (popup_activated ())
25169 if (NILP (Vmouse_highlight
)
25170 || !f
->glyphs_initialized_p
25171 || f
->pointer_invisible
)
25174 hlinfo
->mouse_face_mouse_x
= x
;
25175 hlinfo
->mouse_face_mouse_y
= y
;
25176 hlinfo
->mouse_face_mouse_frame
= f
;
25178 if (hlinfo
->mouse_face_defer
)
25181 if (gc_in_progress
)
25183 hlinfo
->mouse_face_deferred_gc
= 1;
25187 /* Which window is that in? */
25188 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25190 /* If we were displaying active text in another window, clear that.
25191 Also clear if we move out of text area in same window. */
25192 if (! EQ (window
, hlinfo
->mouse_face_window
)
25193 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25194 && !NILP (hlinfo
->mouse_face_window
)))
25195 clear_mouse_face (hlinfo
);
25197 /* Not on a window -> return. */
25198 if (!WINDOWP (window
))
25201 /* Reset help_echo_string. It will get recomputed below. */
25202 help_echo_string
= Qnil
;
25204 /* Convert to window-relative pixel coordinates. */
25205 w
= XWINDOW (window
);
25206 frame_to_window_pixel_xy (w
, &x
, &y
);
25208 #ifdef HAVE_WINDOW_SYSTEM
25209 /* Handle tool-bar window differently since it doesn't display a
25211 if (EQ (window
, f
->tool_bar_window
))
25213 note_tool_bar_highlight (f
, x
, y
);
25218 /* Mouse is on the mode, header line or margin? */
25219 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25220 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25222 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25226 #ifdef HAVE_WINDOW_SYSTEM
25227 if (part
== ON_VERTICAL_BORDER
)
25229 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25230 help_echo_string
= build_string ("drag-mouse-1: resize");
25232 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25233 || part
== ON_SCROLL_BAR
)
25234 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25236 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25239 /* Are we in a window whose display is up to date?
25240 And verify the buffer's text has not changed. */
25241 b
= XBUFFER (w
->buffer
);
25242 if (part
== ON_TEXT
25243 && EQ (w
->window_end_valid
, w
->buffer
)
25244 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25245 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25247 int hpos
, vpos
, i
, dx
, dy
, area
;
25249 struct glyph
*glyph
;
25250 Lisp_Object object
;
25251 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
25252 Lisp_Object
*overlay_vec
= NULL
;
25254 struct buffer
*obuf
;
25255 EMACS_INT obegv
, ozv
;
25258 /* Find the glyph under X/Y. */
25259 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25261 #ifdef HAVE_WINDOW_SYSTEM
25262 /* Look for :pointer property on image. */
25263 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25265 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25266 if (img
!= NULL
&& IMAGEP (img
->spec
))
25268 Lisp_Object image_map
, hotspot
;
25269 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25271 && (hotspot
= find_hot_spot (image_map
,
25272 glyph
->slice
.img
.x
+ dx
,
25273 glyph
->slice
.img
.y
+ dy
),
25275 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25277 Lisp_Object area_id
, plist
;
25279 area_id
= XCAR (hotspot
);
25280 /* Could check AREA_ID to see if we enter/leave this hot-spot.
25281 If so, we could look for mouse-enter, mouse-leave
25282 properties in PLIST (and do something...). */
25283 hotspot
= XCDR (hotspot
);
25284 if (CONSP (hotspot
)
25285 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25287 pointer
= Fplist_get (plist
, Qpointer
);
25288 if (NILP (pointer
))
25290 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25291 if (!NILP (help_echo_string
))
25293 help_echo_window
= window
;
25294 help_echo_object
= glyph
->object
;
25295 help_echo_pos
= glyph
->charpos
;
25299 if (NILP (pointer
))
25300 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25303 #endif /* HAVE_WINDOW_SYSTEM */
25305 /* Clear mouse face if X/Y not over text. */
25307 || area
!= TEXT_AREA
25308 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25309 /* Glyph's OBJECT is an integer for glyphs inserted by the
25310 display engine for its internal purposes, like truncation
25311 and continuation glyphs and blanks beyond the end of
25312 line's text on text terminals. If we are over such a
25313 glyph, we are not over any text. */
25314 || INTEGERP (glyph
->object
)
25315 /* R2L rows have a stretch glyph at their front, which
25316 stands for no text, whereas L2R rows have no glyphs at
25317 all beyond the end of text. Treat such stretch glyphs
25318 like we do with NULL glyphs in L2R rows. */
25319 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25320 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25321 && glyph
->type
== STRETCH_GLYPH
25322 && glyph
->avoid_cursor_p
))
25324 if (clear_mouse_face (hlinfo
))
25325 cursor
= No_Cursor
;
25326 #ifdef HAVE_WINDOW_SYSTEM
25327 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25329 if (area
!= TEXT_AREA
)
25330 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25332 pointer
= Vvoid_text_area_pointer
;
25338 pos
= glyph
->charpos
;
25339 object
= glyph
->object
;
25340 if (!STRINGP (object
) && !BUFFERP (object
))
25343 /* If we get an out-of-range value, return now; avoid an error. */
25344 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25347 /* Make the window's buffer temporarily current for
25348 overlays_at and compute_char_face. */
25349 obuf
= current_buffer
;
25350 current_buffer
= b
;
25356 /* Is this char mouse-active or does it have help-echo? */
25357 position
= make_number (pos
);
25359 if (BUFFERP (object
))
25361 /* Put all the overlays we want in a vector in overlay_vec. */
25362 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25363 /* Sort overlays into increasing priority order. */
25364 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25369 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25372 cursor
= No_Cursor
;
25374 /* Check mouse-face highlighting. */
25376 /* If there exists an overlay with mouse-face overlapping
25377 the one we are currently highlighting, we have to
25378 check if we enter the overlapping overlay, and then
25379 highlight only that. */
25380 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25381 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25383 /* Find the highest priority overlay with a mouse-face. */
25385 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25387 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25388 if (!NILP (mouse_face
))
25389 overlay
= overlay_vec
[i
];
25392 /* If we're highlighting the same overlay as before, there's
25393 no need to do that again. */
25394 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25395 goto check_help_echo
;
25396 hlinfo
->mouse_face_overlay
= overlay
;
25398 /* Clear the display of the old active region, if any. */
25399 if (clear_mouse_face (hlinfo
))
25400 cursor
= No_Cursor
;
25402 /* If no overlay applies, get a text property. */
25403 if (NILP (overlay
))
25404 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25406 /* Next, compute the bounds of the mouse highlighting and
25408 if (!NILP (mouse_face
) && STRINGP (object
))
25410 /* The mouse-highlighting comes from a display string
25411 with a mouse-face. */
25415 b
= Fprevious_single_property_change
25416 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25417 e
= Fnext_single_property_change
25418 (position
, Qmouse_face
, object
, Qnil
);
25420 b
= make_number (0);
25422 e
= make_number (SCHARS (object
) - 1);
25423 mouse_face_from_string_pos (w
, hlinfo
, object
,
25424 XINT (b
), XINT (e
));
25425 hlinfo
->mouse_face_past_end
= 0;
25426 hlinfo
->mouse_face_window
= window
;
25427 hlinfo
->mouse_face_face_id
25428 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25429 glyph
->face_id
, 1);
25430 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25431 cursor
= No_Cursor
;
25435 /* The mouse-highlighting, if any, comes from an overlay
25436 or text property in the buffer. */
25437 Lisp_Object buffer
, display_string
;
25439 if (STRINGP (object
))
25441 /* If we are on a display string with no mouse-face,
25442 check if the text under it has one. */
25443 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25444 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25445 pos
= string_buffer_position (w
, object
, start
);
25448 mouse_face
= get_char_property_and_overlay
25449 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25450 buffer
= w
->buffer
;
25451 display_string
= object
;
25457 display_string
= Qnil
;
25460 if (!NILP (mouse_face
))
25462 Lisp_Object before
, after
;
25463 Lisp_Object before_string
, after_string
;
25464 /* To correctly find the limits of mouse highlight
25465 in a bidi-reordered buffer, we must not use the
25466 optimization of limiting the search in
25467 previous-single-property-change and
25468 next-single-property-change, because
25469 rows_from_pos_range needs the real start and end
25470 positions to DTRT in this case. That's because
25471 the first row visible in a window does not
25472 necessarily display the character whose position
25473 is the smallest. */
25475 NILP (XBUFFER (buffer
)->bidi_display_reordering
)
25476 ? Fmarker_position (w
->start
)
25479 NILP (XBUFFER (buffer
)->bidi_display_reordering
)
25480 ? make_number (BUF_Z (XBUFFER (buffer
))
25481 - XFASTINT (w
->window_end_pos
))
25484 if (NILP (overlay
))
25486 /* Handle the text property case. */
25487 before
= Fprevious_single_property_change
25488 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25489 after
= Fnext_single_property_change
25490 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25491 before_string
= after_string
= Qnil
;
25495 /* Handle the overlay case. */
25496 before
= Foverlay_start (overlay
);
25497 after
= Foverlay_end (overlay
);
25498 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25499 after_string
= Foverlay_get (overlay
, Qafter_string
);
25501 if (!STRINGP (before_string
)) before_string
= Qnil
;
25502 if (!STRINGP (after_string
)) after_string
= Qnil
;
25505 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25508 before_string
, after_string
,
25510 cursor
= No_Cursor
;
25517 /* Look for a `help-echo' property. */
25518 if (NILP (help_echo_string
)) {
25519 Lisp_Object help
, overlay
;
25521 /* Check overlays first. */
25522 help
= overlay
= Qnil
;
25523 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25525 overlay
= overlay_vec
[i
];
25526 help
= Foverlay_get (overlay
, Qhelp_echo
);
25531 help_echo_string
= help
;
25532 help_echo_window
= window
;
25533 help_echo_object
= overlay
;
25534 help_echo_pos
= pos
;
25538 Lisp_Object object
= glyph
->object
;
25539 EMACS_INT charpos
= glyph
->charpos
;
25541 /* Try text properties. */
25542 if (STRINGP (object
)
25544 && charpos
< SCHARS (object
))
25546 help
= Fget_text_property (make_number (charpos
),
25547 Qhelp_echo
, object
);
25550 /* If the string itself doesn't specify a help-echo,
25551 see if the buffer text ``under'' it does. */
25552 struct glyph_row
*r
25553 = MATRIX_ROW (w
->current_matrix
, vpos
);
25554 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25555 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
25558 help
= Fget_char_property (make_number (pos
),
25559 Qhelp_echo
, w
->buffer
);
25563 object
= w
->buffer
;
25568 else if (BUFFERP (object
)
25571 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25576 help_echo_string
= help
;
25577 help_echo_window
= window
;
25578 help_echo_object
= object
;
25579 help_echo_pos
= charpos
;
25584 #ifdef HAVE_WINDOW_SYSTEM
25585 /* Look for a `pointer' property. */
25586 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25588 /* Check overlays first. */
25589 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25590 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25592 if (NILP (pointer
))
25594 Lisp_Object object
= glyph
->object
;
25595 EMACS_INT charpos
= glyph
->charpos
;
25597 /* Try text properties. */
25598 if (STRINGP (object
)
25600 && charpos
< SCHARS (object
))
25602 pointer
= Fget_text_property (make_number (charpos
),
25604 if (NILP (pointer
))
25606 /* If the string itself doesn't specify a pointer,
25607 see if the buffer text ``under'' it does. */
25608 struct glyph_row
*r
25609 = MATRIX_ROW (w
->current_matrix
, vpos
);
25610 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25611 EMACS_INT pos
= string_buffer_position (w
, object
,
25614 pointer
= Fget_char_property (make_number (pos
),
25615 Qpointer
, w
->buffer
);
25618 else if (BUFFERP (object
)
25621 pointer
= Fget_text_property (make_number (charpos
),
25625 #endif /* HAVE_WINDOW_SYSTEM */
25629 current_buffer
= obuf
;
25634 #ifdef HAVE_WINDOW_SYSTEM
25635 if (FRAME_WINDOW_P (f
))
25636 define_frame_cursor1 (f
, cursor
, pointer
);
25638 /* This is here to prevent a compiler error, about "label at end of
25639 compound statement". */
25646 Clear any mouse-face on window W. This function is part of the
25647 redisplay interface, and is called from try_window_id and similar
25648 functions to ensure the mouse-highlight is off. */
25651 x_clear_window_mouse_face (struct window
*w
)
25653 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25654 Lisp_Object window
;
25657 XSETWINDOW (window
, w
);
25658 if (EQ (window
, hlinfo
->mouse_face_window
))
25659 clear_mouse_face (hlinfo
);
25665 Just discard the mouse face information for frame F, if any.
25666 This is used when the size of F is changed. */
25669 cancel_mouse_face (struct frame
*f
)
25671 Lisp_Object window
;
25672 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25674 window
= hlinfo
->mouse_face_window
;
25675 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25677 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25678 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25679 hlinfo
->mouse_face_window
= Qnil
;
25685 /***********************************************************************
25687 ***********************************************************************/
25689 #ifdef HAVE_WINDOW_SYSTEM
25691 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25692 which intersects rectangle R. R is in window-relative coordinates. */
25695 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25696 enum glyph_row_area area
)
25698 struct glyph
*first
= row
->glyphs
[area
];
25699 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25700 struct glyph
*last
;
25701 int first_x
, start_x
, x
;
25703 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25704 /* If row extends face to end of line write the whole line. */
25705 draw_glyphs (w
, 0, row
, area
,
25706 0, row
->used
[area
],
25707 DRAW_NORMAL_TEXT
, 0);
25710 /* Set START_X to the window-relative start position for drawing glyphs of
25711 AREA. The first glyph of the text area can be partially visible.
25712 The first glyphs of other areas cannot. */
25713 start_x
= window_box_left_offset (w
, area
);
25715 if (area
== TEXT_AREA
)
25718 /* Find the first glyph that must be redrawn. */
25720 && x
+ first
->pixel_width
< r
->x
)
25722 x
+= first
->pixel_width
;
25726 /* Find the last one. */
25730 && x
< r
->x
+ r
->width
)
25732 x
+= last
->pixel_width
;
25738 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25739 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25740 DRAW_NORMAL_TEXT
, 0);
25745 /* Redraw the parts of the glyph row ROW on window W intersecting
25746 rectangle R. R is in window-relative coordinates. Value is
25747 non-zero if mouse-face was overwritten. */
25750 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25752 xassert (row
->enabled_p
);
25754 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25755 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25756 0, row
->used
[TEXT_AREA
],
25757 DRAW_NORMAL_TEXT
, 0);
25760 if (row
->used
[LEFT_MARGIN_AREA
])
25761 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25762 if (row
->used
[TEXT_AREA
])
25763 expose_area (w
, row
, r
, TEXT_AREA
);
25764 if (row
->used
[RIGHT_MARGIN_AREA
])
25765 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25766 draw_row_fringe_bitmaps (w
, row
);
25769 return row
->mouse_face_p
;
25773 /* Redraw those parts of glyphs rows during expose event handling that
25774 overlap other rows. Redrawing of an exposed line writes over parts
25775 of lines overlapping that exposed line; this function fixes that.
25777 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25778 row in W's current matrix that is exposed and overlaps other rows.
25779 LAST_OVERLAPPING_ROW is the last such row. */
25782 expose_overlaps (struct window
*w
,
25783 struct glyph_row
*first_overlapping_row
,
25784 struct glyph_row
*last_overlapping_row
,
25787 struct glyph_row
*row
;
25789 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25790 if (row
->overlapping_p
)
25792 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25795 if (row
->used
[LEFT_MARGIN_AREA
])
25796 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25798 if (row
->used
[TEXT_AREA
])
25799 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25801 if (row
->used
[RIGHT_MARGIN_AREA
])
25802 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25808 /* Return non-zero if W's cursor intersects rectangle R. */
25811 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25813 XRectangle cr
, result
;
25814 struct glyph
*cursor_glyph
;
25815 struct glyph_row
*row
;
25817 if (w
->phys_cursor
.vpos
>= 0
25818 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25819 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25821 && row
->cursor_in_fringe_p
)
25823 /* Cursor is in the fringe. */
25824 cr
.x
= window_box_right_offset (w
,
25825 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25826 ? RIGHT_MARGIN_AREA
25829 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25830 cr
.height
= row
->height
;
25831 return x_intersect_rectangles (&cr
, r
, &result
);
25834 cursor_glyph
= get_phys_cursor_glyph (w
);
25837 /* r is relative to W's box, but w->phys_cursor.x is relative
25838 to left edge of W's TEXT area. Adjust it. */
25839 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25840 cr
.y
= w
->phys_cursor
.y
;
25841 cr
.width
= cursor_glyph
->pixel_width
;
25842 cr
.height
= w
->phys_cursor_height
;
25843 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25844 I assume the effect is the same -- and this is portable. */
25845 return x_intersect_rectangles (&cr
, r
, &result
);
25847 /* If we don't understand the format, pretend we're not in the hot-spot. */
25853 Draw a vertical window border to the right of window W if W doesn't
25854 have vertical scroll bars. */
25857 x_draw_vertical_border (struct window
*w
)
25859 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25861 /* We could do better, if we knew what type of scroll-bar the adjacent
25862 windows (on either side) have... But we don't :-(
25863 However, I think this works ok. ++KFS 2003-04-25 */
25865 /* Redraw borders between horizontally adjacent windows. Don't
25866 do it for frames with vertical scroll bars because either the
25867 right scroll bar of a window, or the left scroll bar of its
25868 neighbor will suffice as a border. */
25869 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25872 if (!WINDOW_RIGHTMOST_P (w
)
25873 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25875 int x0
, x1
, y0
, y1
;
25877 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25880 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25883 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25885 else if (!WINDOW_LEFTMOST_P (w
)
25886 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25888 int x0
, x1
, y0
, y1
;
25890 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25893 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25896 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25901 /* Redraw the part of window W intersection rectangle FR. Pixel
25902 coordinates in FR are frame-relative. Call this function with
25903 input blocked. Value is non-zero if the exposure overwrites
25907 expose_window (struct window
*w
, XRectangle
*fr
)
25909 struct frame
*f
= XFRAME (w
->frame
);
25911 int mouse_face_overwritten_p
= 0;
25913 /* If window is not yet fully initialized, do nothing. This can
25914 happen when toolkit scroll bars are used and a window is split.
25915 Reconfiguring the scroll bar will generate an expose for a newly
25917 if (w
->current_matrix
== NULL
)
25920 /* When we're currently updating the window, display and current
25921 matrix usually don't agree. Arrange for a thorough display
25923 if (w
== updated_window
)
25925 SET_FRAME_GARBAGED (f
);
25929 /* Frame-relative pixel rectangle of W. */
25930 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25931 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25932 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25933 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25935 if (x_intersect_rectangles (fr
, &wr
, &r
))
25937 int yb
= window_text_bottom_y (w
);
25938 struct glyph_row
*row
;
25939 int cursor_cleared_p
;
25940 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25942 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25943 r
.x
, r
.y
, r
.width
, r
.height
));
25945 /* Convert to window coordinates. */
25946 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25947 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25949 /* Turn off the cursor. */
25950 if (!w
->pseudo_window_p
25951 && phys_cursor_in_rect_p (w
, &r
))
25953 x_clear_cursor (w
);
25954 cursor_cleared_p
= 1;
25957 cursor_cleared_p
= 0;
25959 /* Update lines intersecting rectangle R. */
25960 first_overlapping_row
= last_overlapping_row
= NULL
;
25961 for (row
= w
->current_matrix
->rows
;
25966 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25968 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25969 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25970 || (r
.y
>= y0
&& r
.y
< y1
)
25971 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25973 /* A header line may be overlapping, but there is no need
25974 to fix overlapping areas for them. KFS 2005-02-12 */
25975 if (row
->overlapping_p
&& !row
->mode_line_p
)
25977 if (first_overlapping_row
== NULL
)
25978 first_overlapping_row
= row
;
25979 last_overlapping_row
= row
;
25983 if (expose_line (w
, row
, &r
))
25984 mouse_face_overwritten_p
= 1;
25987 else if (row
->overlapping_p
)
25989 /* We must redraw a row overlapping the exposed area. */
25991 ? y0
+ row
->phys_height
> r
.y
25992 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25994 if (first_overlapping_row
== NULL
)
25995 first_overlapping_row
= row
;
25996 last_overlapping_row
= row
;
26004 /* Display the mode line if there is one. */
26005 if (WINDOW_WANTS_MODELINE_P (w
)
26006 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26008 && row
->y
< r
.y
+ r
.height
)
26010 if (expose_line (w
, row
, &r
))
26011 mouse_face_overwritten_p
= 1;
26014 if (!w
->pseudo_window_p
)
26016 /* Fix the display of overlapping rows. */
26017 if (first_overlapping_row
)
26018 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26021 /* Draw border between windows. */
26022 x_draw_vertical_border (w
);
26024 /* Turn the cursor on again. */
26025 if (cursor_cleared_p
)
26026 update_window_cursor (w
, 1);
26030 return mouse_face_overwritten_p
;
26035 /* Redraw (parts) of all windows in the window tree rooted at W that
26036 intersect R. R contains frame pixel coordinates. Value is
26037 non-zero if the exposure overwrites mouse-face. */
26040 expose_window_tree (struct window
*w
, XRectangle
*r
)
26042 struct frame
*f
= XFRAME (w
->frame
);
26043 int mouse_face_overwritten_p
= 0;
26045 while (w
&& !FRAME_GARBAGED_P (f
))
26047 if (!NILP (w
->hchild
))
26048 mouse_face_overwritten_p
26049 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26050 else if (!NILP (w
->vchild
))
26051 mouse_face_overwritten_p
26052 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26054 mouse_face_overwritten_p
|= expose_window (w
, r
);
26056 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26059 return mouse_face_overwritten_p
;
26064 Redisplay an exposed area of frame F. X and Y are the upper-left
26065 corner of the exposed rectangle. W and H are width and height of
26066 the exposed area. All are pixel values. W or H zero means redraw
26067 the entire frame. */
26070 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26073 int mouse_face_overwritten_p
= 0;
26075 TRACE ((stderr
, "expose_frame "));
26077 /* No need to redraw if frame will be redrawn soon. */
26078 if (FRAME_GARBAGED_P (f
))
26080 TRACE ((stderr
, " garbaged\n"));
26084 /* If basic faces haven't been realized yet, there is no point in
26085 trying to redraw anything. This can happen when we get an expose
26086 event while Emacs is starting, e.g. by moving another window. */
26087 if (FRAME_FACE_CACHE (f
) == NULL
26088 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26090 TRACE ((stderr
, " no faces\n"));
26094 if (w
== 0 || h
== 0)
26097 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26098 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26108 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26109 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26111 if (WINDOWP (f
->tool_bar_window
))
26112 mouse_face_overwritten_p
26113 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26115 #ifdef HAVE_X_WINDOWS
26117 #ifndef USE_X_TOOLKIT
26118 if (WINDOWP (f
->menu_bar_window
))
26119 mouse_face_overwritten_p
26120 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26121 #endif /* not USE_X_TOOLKIT */
26125 /* Some window managers support a focus-follows-mouse style with
26126 delayed raising of frames. Imagine a partially obscured frame,
26127 and moving the mouse into partially obscured mouse-face on that
26128 frame. The visible part of the mouse-face will be highlighted,
26129 then the WM raises the obscured frame. With at least one WM, KDE
26130 2.1, Emacs is not getting any event for the raising of the frame
26131 (even tried with SubstructureRedirectMask), only Expose events.
26132 These expose events will draw text normally, i.e. not
26133 highlighted. Which means we must redo the highlight here.
26134 Subsume it under ``we love X''. --gerd 2001-08-15 */
26135 /* Included in Windows version because Windows most likely does not
26136 do the right thing if any third party tool offers
26137 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26138 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26140 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26141 if (f
== hlinfo
->mouse_face_mouse_frame
)
26143 int x
= hlinfo
->mouse_face_mouse_x
;
26144 int y
= hlinfo
->mouse_face_mouse_y
;
26145 clear_mouse_face (hlinfo
);
26146 note_mouse_highlight (f
, x
, y
);
26153 Determine the intersection of two rectangles R1 and R2. Return
26154 the intersection in *RESULT. Value is non-zero if RESULT is not
26158 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26160 XRectangle
*left
, *right
;
26161 XRectangle
*upper
, *lower
;
26162 int intersection_p
= 0;
26164 /* Rearrange so that R1 is the left-most rectangle. */
26166 left
= r1
, right
= r2
;
26168 left
= r2
, right
= r1
;
26170 /* X0 of the intersection is right.x0, if this is inside R1,
26171 otherwise there is no intersection. */
26172 if (right
->x
<= left
->x
+ left
->width
)
26174 result
->x
= right
->x
;
26176 /* The right end of the intersection is the minimum of the
26177 the right ends of left and right. */
26178 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26181 /* Same game for Y. */
26183 upper
= r1
, lower
= r2
;
26185 upper
= r2
, lower
= r1
;
26187 /* The upper end of the intersection is lower.y0, if this is inside
26188 of upper. Otherwise, there is no intersection. */
26189 if (lower
->y
<= upper
->y
+ upper
->height
)
26191 result
->y
= lower
->y
;
26193 /* The lower end of the intersection is the minimum of the lower
26194 ends of upper and lower. */
26195 result
->height
= (min (lower
->y
+ lower
->height
,
26196 upper
->y
+ upper
->height
)
26198 intersection_p
= 1;
26202 return intersection_p
;
26205 #endif /* HAVE_WINDOW_SYSTEM */
26208 /***********************************************************************
26210 ***********************************************************************/
26213 syms_of_xdisp (void)
26215 Vwith_echo_area_save_vector
= Qnil
;
26216 staticpro (&Vwith_echo_area_save_vector
);
26218 Vmessage_stack
= Qnil
;
26219 staticpro (&Vmessage_stack
);
26221 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26222 staticpro (&Qinhibit_redisplay
);
26224 message_dolog_marker1
= Fmake_marker ();
26225 staticpro (&message_dolog_marker1
);
26226 message_dolog_marker2
= Fmake_marker ();
26227 staticpro (&message_dolog_marker2
);
26228 message_dolog_marker3
= Fmake_marker ();
26229 staticpro (&message_dolog_marker3
);
26232 defsubr (&Sdump_frame_glyph_matrix
);
26233 defsubr (&Sdump_glyph_matrix
);
26234 defsubr (&Sdump_glyph_row
);
26235 defsubr (&Sdump_tool_bar_row
);
26236 defsubr (&Strace_redisplay
);
26237 defsubr (&Strace_to_stderr
);
26239 #ifdef HAVE_WINDOW_SYSTEM
26240 defsubr (&Stool_bar_lines_needed
);
26241 defsubr (&Slookup_image_map
);
26243 defsubr (&Sformat_mode_line
);
26244 defsubr (&Sinvisible_p
);
26245 defsubr (&Scurrent_bidi_paragraph_direction
);
26247 staticpro (&Qmenu_bar_update_hook
);
26248 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26250 staticpro (&Qoverriding_terminal_local_map
);
26251 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26253 staticpro (&Qoverriding_local_map
);
26254 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26256 staticpro (&Qwindow_scroll_functions
);
26257 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26259 staticpro (&Qwindow_text_change_functions
);
26260 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26262 staticpro (&Qredisplay_end_trigger_functions
);
26263 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26265 staticpro (&Qinhibit_point_motion_hooks
);
26266 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26268 Qeval
= intern_c_string ("eval");
26269 staticpro (&Qeval
);
26271 QCdata
= intern_c_string (":data");
26272 staticpro (&QCdata
);
26273 Qdisplay
= intern_c_string ("display");
26274 staticpro (&Qdisplay
);
26275 Qspace_width
= intern_c_string ("space-width");
26276 staticpro (&Qspace_width
);
26277 Qraise
= intern_c_string ("raise");
26278 staticpro (&Qraise
);
26279 Qslice
= intern_c_string ("slice");
26280 staticpro (&Qslice
);
26281 Qspace
= intern_c_string ("space");
26282 staticpro (&Qspace
);
26283 Qmargin
= intern_c_string ("margin");
26284 staticpro (&Qmargin
);
26285 Qpointer
= intern_c_string ("pointer");
26286 staticpro (&Qpointer
);
26287 Qleft_margin
= intern_c_string ("left-margin");
26288 staticpro (&Qleft_margin
);
26289 Qright_margin
= intern_c_string ("right-margin");
26290 staticpro (&Qright_margin
);
26291 Qcenter
= intern_c_string ("center");
26292 staticpro (&Qcenter
);
26293 Qline_height
= intern_c_string ("line-height");
26294 staticpro (&Qline_height
);
26295 QCalign_to
= intern_c_string (":align-to");
26296 staticpro (&QCalign_to
);
26297 QCrelative_width
= intern_c_string (":relative-width");
26298 staticpro (&QCrelative_width
);
26299 QCrelative_height
= intern_c_string (":relative-height");
26300 staticpro (&QCrelative_height
);
26301 QCeval
= intern_c_string (":eval");
26302 staticpro (&QCeval
);
26303 QCpropertize
= intern_c_string (":propertize");
26304 staticpro (&QCpropertize
);
26305 QCfile
= intern_c_string (":file");
26306 staticpro (&QCfile
);
26307 Qfontified
= intern_c_string ("fontified");
26308 staticpro (&Qfontified
);
26309 Qfontification_functions
= intern_c_string ("fontification-functions");
26310 staticpro (&Qfontification_functions
);
26311 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26312 staticpro (&Qtrailing_whitespace
);
26313 Qescape_glyph
= intern_c_string ("escape-glyph");
26314 staticpro (&Qescape_glyph
);
26315 Qnobreak_space
= intern_c_string ("nobreak-space");
26316 staticpro (&Qnobreak_space
);
26317 Qimage
= intern_c_string ("image");
26318 staticpro (&Qimage
);
26319 Qtext
= intern_c_string ("text");
26320 staticpro (&Qtext
);
26321 Qboth
= intern_c_string ("both");
26322 staticpro (&Qboth
);
26323 Qboth_horiz
= intern_c_string ("both-horiz");
26324 staticpro (&Qboth_horiz
);
26325 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26326 staticpro (&Qtext_image_horiz
);
26327 QCmap
= intern_c_string (":map");
26328 staticpro (&QCmap
);
26329 QCpointer
= intern_c_string (":pointer");
26330 staticpro (&QCpointer
);
26331 Qrect
= intern_c_string ("rect");
26332 staticpro (&Qrect
);
26333 Qcircle
= intern_c_string ("circle");
26334 staticpro (&Qcircle
);
26335 Qpoly
= intern_c_string ("poly");
26336 staticpro (&Qpoly
);
26337 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26338 staticpro (&Qmessage_truncate_lines
);
26339 Qgrow_only
= intern_c_string ("grow-only");
26340 staticpro (&Qgrow_only
);
26341 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26342 staticpro (&Qinhibit_menubar_update
);
26343 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26344 staticpro (&Qinhibit_eval_during_redisplay
);
26345 Qposition
= intern_c_string ("position");
26346 staticpro (&Qposition
);
26347 Qbuffer_position
= intern_c_string ("buffer-position");
26348 staticpro (&Qbuffer_position
);
26349 Qobject
= intern_c_string ("object");
26350 staticpro (&Qobject
);
26351 Qbar
= intern_c_string ("bar");
26353 Qhbar
= intern_c_string ("hbar");
26354 staticpro (&Qhbar
);
26355 Qbox
= intern_c_string ("box");
26357 Qhollow
= intern_c_string ("hollow");
26358 staticpro (&Qhollow
);
26359 Qhand
= intern_c_string ("hand");
26360 staticpro (&Qhand
);
26361 Qarrow
= intern_c_string ("arrow");
26362 staticpro (&Qarrow
);
26363 Qtext
= intern_c_string ("text");
26364 staticpro (&Qtext
);
26365 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26366 staticpro (&Qinhibit_free_realized_faces
);
26368 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26369 Fcons (intern_c_string ("void-variable"), Qnil
)),
26371 staticpro (&list_of_error
);
26373 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26374 staticpro (&Qlast_arrow_position
);
26375 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26376 staticpro (&Qlast_arrow_string
);
26378 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26379 staticpro (&Qoverlay_arrow_string
);
26380 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26381 staticpro (&Qoverlay_arrow_bitmap
);
26383 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26384 staticpro (&echo_buffer
[0]);
26385 staticpro (&echo_buffer
[1]);
26387 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26388 staticpro (&echo_area_buffer
[0]);
26389 staticpro (&echo_area_buffer
[1]);
26391 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26392 staticpro (&Vmessages_buffer_name
);
26394 mode_line_proptrans_alist
= Qnil
;
26395 staticpro (&mode_line_proptrans_alist
);
26396 mode_line_string_list
= Qnil
;
26397 staticpro (&mode_line_string_list
);
26398 mode_line_string_face
= Qnil
;
26399 staticpro (&mode_line_string_face
);
26400 mode_line_string_face_prop
= Qnil
;
26401 staticpro (&mode_line_string_face_prop
);
26402 Vmode_line_unwind_vector
= Qnil
;
26403 staticpro (&Vmode_line_unwind_vector
);
26405 help_echo_string
= Qnil
;
26406 staticpro (&help_echo_string
);
26407 help_echo_object
= Qnil
;
26408 staticpro (&help_echo_object
);
26409 help_echo_window
= Qnil
;
26410 staticpro (&help_echo_window
);
26411 previous_help_echo_string
= Qnil
;
26412 staticpro (&previous_help_echo_string
);
26413 help_echo_pos
= -1;
26415 Qright_to_left
= intern_c_string ("right-to-left");
26416 staticpro (&Qright_to_left
);
26417 Qleft_to_right
= intern_c_string ("left-to-right");
26418 staticpro (&Qleft_to_right
);
26420 #ifdef HAVE_WINDOW_SYSTEM
26421 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26422 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26423 For example, if a block cursor is over a tab, it will be drawn as
26424 wide as that tab on the display. */);
26425 x_stretch_cursor_p
= 0;
26428 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26429 doc
: /* *Non-nil means highlight trailing whitespace.
26430 The face used for trailing whitespace is `trailing-whitespace'. */);
26431 Vshow_trailing_whitespace
= Qnil
;
26433 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26434 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26435 A value of t means highlight the character itself (for nobreak space,
26436 use face `nobreak-space').
26437 A value of nil means no highlighting.
26438 Other values mean display the escape glyph followed by an ordinary
26439 space or ordinary hyphen. */);
26440 Vnobreak_char_display
= Qt
;
26442 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26443 doc
: /* *The pointer shape to show in void text areas.
26444 A value of nil means to show the text pointer. Other options are `arrow',
26445 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26446 Vvoid_text_area_pointer
= Qarrow
;
26448 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26449 doc
: /* Non-nil means don't actually do any redisplay.
26450 This is used for internal purposes. */);
26451 Vinhibit_redisplay
= Qnil
;
26453 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26454 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26455 Vglobal_mode_string
= Qnil
;
26457 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26458 doc
: /* Marker for where to display an arrow on top of the buffer text.
26459 This must be the beginning of a line in order to work.
26460 See also `overlay-arrow-string'. */);
26461 Voverlay_arrow_position
= Qnil
;
26463 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26464 doc
: /* String to display as an arrow in non-window frames.
26465 See also `overlay-arrow-position'. */);
26466 Voverlay_arrow_string
= make_pure_c_string ("=>");
26468 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26469 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26470 The symbols on this list are examined during redisplay to determine
26471 where to display overlay arrows. */);
26472 Voverlay_arrow_variable_list
26473 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26475 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26476 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26477 If that fails to bring point back on frame, point is centered instead.
26478 If this is zero, point is always centered after it moves off frame.
26479 If you want scrolling to always be a line at a time, you should set
26480 `scroll-conservatively' to a large value rather than set this to 1. */);
26482 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26483 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26484 If point moves off-screen, redisplay will scroll by up to
26485 `scroll-conservatively' lines in order to bring point just barely
26486 onto the screen again. If that cannot be done, then redisplay
26487 recenters point as usual.
26489 A value of zero means always recenter point if it moves off screen. */);
26490 scroll_conservatively
= 0;
26492 DEFVAR_INT ("scroll-margin", scroll_margin
,
26493 doc
: /* *Number of lines of margin at the top and bottom of a window.
26494 Recenter the window whenever point gets within this many lines
26495 of the top or bottom of the window. */);
26498 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26499 doc
: /* Pixels per inch value for non-window system displays.
26500 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26501 Vdisplay_pixels_per_inch
= make_float (72.0);
26504 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26507 DEFVAR_LISP ("truncate-partial-width-windows",
26508 Vtruncate_partial_width_windows
,
26509 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26510 For an integer value, truncate lines in each window narrower than the
26511 full frame width, provided the window width is less than that integer;
26512 otherwise, respect the value of `truncate-lines'.
26514 For any other non-nil value, truncate lines in all windows that do
26515 not span the full frame width.
26517 A value of nil means to respect the value of `truncate-lines'.
26519 If `word-wrap' is enabled, you might want to reduce this. */);
26520 Vtruncate_partial_width_windows
= make_number (50);
26522 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26523 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26524 Any other value means to use the appropriate face, `mode-line',
26525 `header-line', or `menu' respectively. */);
26526 mode_line_inverse_video
= 1;
26528 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26529 doc
: /* *Maximum buffer size for which line number should be displayed.
26530 If the buffer is bigger than this, the line number does not appear
26531 in the mode line. A value of nil means no limit. */);
26532 Vline_number_display_limit
= Qnil
;
26534 DEFVAR_INT ("line-number-display-limit-width",
26535 line_number_display_limit_width
,
26536 doc
: /* *Maximum line width (in characters) for line number display.
26537 If the average length of the lines near point is bigger than this, then the
26538 line number may be omitted from the mode line. */);
26539 line_number_display_limit_width
= 200;
26541 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26542 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26543 highlight_nonselected_windows
= 0;
26545 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26546 doc
: /* Non-nil if more than one frame is visible on this display.
26547 Minibuffer-only frames don't count, but iconified frames do.
26548 This variable is not guaranteed to be accurate except while processing
26549 `frame-title-format' and `icon-title-format'. */);
26551 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26552 doc
: /* Template for displaying the title bar of visible frames.
26553 \(Assuming the window manager supports this feature.)
26555 This variable has the same structure as `mode-line-format', except that
26556 the %c and %l constructs are ignored. It is used only on frames for
26557 which no explicit name has been set \(see `modify-frame-parameters'). */);
26559 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26560 doc
: /* Template for displaying the title bar of an iconified frame.
26561 \(Assuming the window manager supports this feature.)
26562 This variable has the same structure as `mode-line-format' (which see),
26563 and is used only on frames for which no explicit name has been set
26564 \(see `modify-frame-parameters'). */);
26566 = Vframe_title_format
26567 = pure_cons (intern_c_string ("multiple-frames"),
26568 pure_cons (make_pure_c_string ("%b"),
26569 pure_cons (pure_cons (empty_unibyte_string
,
26570 pure_cons (intern_c_string ("invocation-name"),
26571 pure_cons (make_pure_c_string ("@"),
26572 pure_cons (intern_c_string ("system-name"),
26576 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26577 doc
: /* Maximum number of lines to keep in the message log buffer.
26578 If nil, disable message logging. If t, log messages but don't truncate
26579 the buffer when it becomes large. */);
26580 Vmessage_log_max
= make_number (100);
26582 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26583 doc
: /* Functions called before redisplay, if window sizes have changed.
26584 The value should be a list of functions that take one argument.
26585 Just before redisplay, for each frame, if any of its windows have changed
26586 size since the last redisplay, or have been split or deleted,
26587 all the functions in the list are called, with the frame as argument. */);
26588 Vwindow_size_change_functions
= Qnil
;
26590 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26591 doc
: /* List of functions to call before redisplaying a window with scrolling.
26592 Each function is called with two arguments, the window and its new
26593 display-start position. Note that these functions are also called by
26594 `set-window-buffer'. Also note that the value of `window-end' is not
26595 valid when these functions are called. */);
26596 Vwindow_scroll_functions
= Qnil
;
26598 DEFVAR_LISP ("window-text-change-functions",
26599 Vwindow_text_change_functions
,
26600 doc
: /* Functions to call in redisplay when text in the window might change. */);
26601 Vwindow_text_change_functions
= Qnil
;
26603 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26604 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26605 Each function is called with two arguments, the window and the end trigger value.
26606 See `set-window-redisplay-end-trigger'. */);
26607 Vredisplay_end_trigger_functions
= Qnil
;
26609 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26610 doc
: /* *Non-nil means autoselect window with mouse pointer.
26611 If nil, do not autoselect windows.
26612 A positive number means delay autoselection by that many seconds: a
26613 window is autoselected only after the mouse has remained in that
26614 window for the duration of the delay.
26615 A negative number has a similar effect, but causes windows to be
26616 autoselected only after the mouse has stopped moving. \(Because of
26617 the way Emacs compares mouse events, you will occasionally wait twice
26618 that time before the window gets selected.\)
26619 Any other value means to autoselect window instantaneously when the
26620 mouse pointer enters it.
26622 Autoselection selects the minibuffer only if it is active, and never
26623 unselects the minibuffer if it is active.
26625 When customizing this variable make sure that the actual value of
26626 `focus-follows-mouse' matches the behavior of your window manager. */);
26627 Vmouse_autoselect_window
= Qnil
;
26629 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26630 doc
: /* *Non-nil means automatically resize tool-bars.
26631 This dynamically changes the tool-bar's height to the minimum height
26632 that is needed to make all tool-bar items visible.
26633 If value is `grow-only', the tool-bar's height is only increased
26634 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26635 Vauto_resize_tool_bars
= Qt
;
26637 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26638 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26639 auto_raise_tool_bar_buttons_p
= 1;
26641 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26642 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26643 make_cursor_line_fully_visible_p
= 1;
26645 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26646 doc
: /* *Border below tool-bar in pixels.
26647 If an integer, use it as the height of the border.
26648 If it is one of `internal-border-width' or `border-width', use the
26649 value of the corresponding frame parameter.
26650 Otherwise, no border is added below the tool-bar. */);
26651 Vtool_bar_border
= Qinternal_border_width
;
26653 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26654 doc
: /* *Margin around tool-bar buttons in pixels.
26655 If an integer, use that for both horizontal and vertical margins.
26656 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26657 HORZ specifying the horizontal margin, and VERT specifying the
26658 vertical margin. */);
26659 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26661 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26662 doc
: /* *Relief thickness of tool-bar buttons. */);
26663 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26665 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26666 doc
: /* Tool bar style to use.
26668 image - show images only
26669 text - show text only
26670 both - show both, text below image
26671 both-horiz - show text to the right of the image
26672 text-image-horiz - show text to the left of the image
26673 any other - use system default or image if no system default. */);
26674 Vtool_bar_style
= Qnil
;
26676 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26677 doc
: /* *Maximum number of characters a label can have to be shown.
26678 The tool bar style must also show labels for this to have any effect, see
26679 `tool-bar-style'. */);
26680 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26682 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26683 doc
: /* List of functions to call to fontify regions of text.
26684 Each function is called with one argument POS. Functions must
26685 fontify a region starting at POS in the current buffer, and give
26686 fontified regions the property `fontified'. */);
26687 Vfontification_functions
= Qnil
;
26688 Fmake_variable_buffer_local (Qfontification_functions
);
26690 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26691 unibyte_display_via_language_environment
,
26692 doc
: /* *Non-nil means display unibyte text according to language environment.
26693 Specifically, this means that raw bytes in the range 160-255 decimal
26694 are displayed by converting them to the equivalent multibyte characters
26695 according to the current language environment. As a result, they are
26696 displayed according to the current fontset.
26698 Note that this variable affects only how these bytes are displayed,
26699 but does not change the fact they are interpreted as raw bytes. */);
26700 unibyte_display_via_language_environment
= 0;
26702 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26703 doc
: /* *Maximum height for resizing mini-windows.
26704 If a float, it specifies a fraction of the mini-window frame's height.
26705 If an integer, it specifies a number of lines. */);
26706 Vmax_mini_window_height
= make_float (0.25);
26708 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26709 doc
: /* *How to resize mini-windows.
26710 A value of nil means don't automatically resize mini-windows.
26711 A value of t means resize them to fit the text displayed in them.
26712 A value of `grow-only', the default, means let mini-windows grow
26713 only, until their display becomes empty, at which point the windows
26714 go back to their normal size. */);
26715 Vresize_mini_windows
= Qgrow_only
;
26717 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26718 doc
: /* Alist specifying how to blink the cursor off.
26719 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26720 `cursor-type' frame-parameter or variable equals ON-STATE,
26721 comparing using `equal', Emacs uses OFF-STATE to specify
26722 how to blink it off. ON-STATE and OFF-STATE are values for
26723 the `cursor-type' frame parameter.
26725 If a frame's ON-STATE has no entry in this list,
26726 the frame's other specifications determine how to blink the cursor off. */);
26727 Vblink_cursor_alist
= Qnil
;
26729 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26730 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26731 If non-nil, windows are automatically scrolled horizontally to make
26732 point visible. */);
26733 automatic_hscrolling_p
= 1;
26734 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26735 staticpro (&Qauto_hscroll_mode
);
26737 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26738 doc
: /* *How many columns away from the window edge point is allowed to get
26739 before automatic hscrolling will horizontally scroll the window. */);
26740 hscroll_margin
= 5;
26742 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26743 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26744 When point is less than `hscroll-margin' columns from the window
26745 edge, automatic hscrolling will scroll the window by the amount of columns
26746 determined by this variable. If its value is a positive integer, scroll that
26747 many columns. If it's a positive floating-point number, it specifies the
26748 fraction of the window's width to scroll. If it's nil or zero, point will be
26749 centered horizontally after the scroll. Any other value, including negative
26750 numbers, are treated as if the value were zero.
26752 Automatic hscrolling always moves point outside the scroll margin, so if
26753 point was more than scroll step columns inside the margin, the window will
26754 scroll more than the value given by the scroll step.
26756 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26757 and `scroll-right' overrides this variable's effect. */);
26758 Vhscroll_step
= make_number (0);
26760 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26761 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26762 Bind this around calls to `message' to let it take effect. */);
26763 message_truncate_lines
= 0;
26765 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26766 doc
: /* Normal hook run to update the menu bar definitions.
26767 Redisplay runs this hook before it redisplays the menu bar.
26768 This is used to update submenus such as Buffers,
26769 whose contents depend on various data. */);
26770 Vmenu_bar_update_hook
= Qnil
;
26772 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26773 doc
: /* Frame for which we are updating a menu.
26774 The enable predicate for a menu binding should check this variable. */);
26775 Vmenu_updating_frame
= Qnil
;
26777 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26778 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26779 inhibit_menubar_update
= 0;
26781 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26782 doc
: /* Prefix prepended to all continuation lines at display time.
26783 The value may be a string, an image, or a stretch-glyph; it is
26784 interpreted in the same way as the value of a `display' text property.
26786 This variable is overridden by any `wrap-prefix' text or overlay
26789 To add a prefix to non-continuation lines, use `line-prefix'. */);
26790 Vwrap_prefix
= Qnil
;
26791 staticpro (&Qwrap_prefix
);
26792 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26793 Fmake_variable_buffer_local (Qwrap_prefix
);
26795 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26796 doc
: /* Prefix prepended to all non-continuation lines at display time.
26797 The value may be a string, an image, or a stretch-glyph; it is
26798 interpreted in the same way as the value of a `display' text property.
26800 This variable is overridden by any `line-prefix' text or overlay
26803 To add a prefix to continuation lines, use `wrap-prefix'. */);
26804 Vline_prefix
= Qnil
;
26805 staticpro (&Qline_prefix
);
26806 Qline_prefix
= intern_c_string ("line-prefix");
26807 Fmake_variable_buffer_local (Qline_prefix
);
26809 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
26810 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26811 inhibit_eval_during_redisplay
= 0;
26813 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
26814 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26815 inhibit_free_realized_faces
= 0;
26818 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
26819 doc
: /* Inhibit try_window_id display optimization. */);
26820 inhibit_try_window_id
= 0;
26822 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
26823 doc
: /* Inhibit try_window_reusing display optimization. */);
26824 inhibit_try_window_reusing
= 0;
26826 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
26827 doc
: /* Inhibit try_cursor_movement display optimization. */);
26828 inhibit_try_cursor_movement
= 0;
26829 #endif /* GLYPH_DEBUG */
26831 DEFVAR_INT ("overline-margin", overline_margin
,
26832 doc
: /* *Space between overline and text, in pixels.
26833 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26834 margin to the caracter height. */);
26835 overline_margin
= 2;
26837 DEFVAR_INT ("underline-minimum-offset",
26838 underline_minimum_offset
,
26839 doc
: /* Minimum distance between baseline and underline.
26840 This can improve legibility of underlined text at small font sizes,
26841 particularly when using variable `x-use-underline-position-properties'
26842 with fonts that specify an UNDERLINE_POSITION relatively close to the
26843 baseline. The default value is 1. */);
26844 underline_minimum_offset
= 1;
26846 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
26847 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
26848 This feature only works when on a window system that can change
26849 cursor shapes. */);
26850 display_hourglass_p
= 1;
26852 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
26853 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
26854 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26856 hourglass_atimer
= NULL
;
26857 hourglass_shown_p
= 0;
26859 DEFSYM (Qglyphless_char
, "glyphless-char");
26860 DEFSYM (Qhex_code
, "hex-code");
26861 DEFSYM (Qempty_box
, "empty-box");
26862 DEFSYM (Qthin_space
, "thin-space");
26863 DEFSYM (Qzero_width
, "zero-width");
26865 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
26866 /* Intern this now in case it isn't already done.
26867 Setting this variable twice is harmless.
26868 But don't staticpro it here--that is done in alloc.c. */
26869 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
26870 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
26872 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
26873 doc
: /* Char-table to control displaying of glyphless characters.
26874 Each element, if non-nil, is an ASCII acronym string (displayed in a box)
26875 or one of these symbols:
26876 hex-code: display the hexadecimal code of a character in a box
26877 empty-box: display as an empty box
26878 thin-space: display as 1-pixel width space
26879 zero-width: don't display
26881 It has one extra slot to control the display of a character for which
26882 no font is found. The value of the slot is `hex-code' or `empty-box'.
26883 The default is `empty-box'. */);
26884 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
26885 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
26890 /* Initialize this module when Emacs starts. */
26895 Lisp_Object root_window
;
26896 struct window
*mini_w
;
26898 current_header_line_height
= current_mode_line_height
= -1;
26900 CHARPOS (this_line_start_pos
) = 0;
26902 mini_w
= XWINDOW (minibuf_window
);
26903 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26905 if (!noninteractive
)
26907 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26910 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26911 set_window_height (root_window
,
26912 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26914 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26915 set_window_height (minibuf_window
, 1, 0);
26917 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26918 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26920 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26921 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26922 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26924 /* The default ellipsis glyphs `...'. */
26925 for (i
= 0; i
< 3; ++i
)
26926 default_invis_vector
[i
] = make_number ('.');
26930 /* Allocate the buffer for frame titles.
26931 Also used for `format-mode-line'. */
26933 mode_line_noprop_buf
= (char *) xmalloc (size
);
26934 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26935 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26936 mode_line_target
= MODE_LINE_DISPLAY
;
26939 help_echo_showing_p
= 0;
26942 /* Since w32 does not support atimers, it defines its own implementation of
26943 the following three functions in w32fns.c. */
26946 /* Platform-independent portion of hourglass implementation. */
26948 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26950 hourglass_started (void)
26952 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26955 /* Cancel a currently active hourglass timer, and start a new one. */
26957 start_hourglass (void)
26959 #if defined (HAVE_WINDOW_SYSTEM)
26961 int secs
, usecs
= 0;
26963 cancel_hourglass ();
26965 if (INTEGERP (Vhourglass_delay
)
26966 && XINT (Vhourglass_delay
) > 0)
26967 secs
= XFASTINT (Vhourglass_delay
);
26968 else if (FLOATP (Vhourglass_delay
)
26969 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26972 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26973 secs
= XFASTINT (tem
);
26974 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26977 secs
= DEFAULT_HOURGLASS_DELAY
;
26979 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26980 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26981 show_hourglass
, NULL
);
26986 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26989 cancel_hourglass (void)
26991 #if defined (HAVE_WINDOW_SYSTEM)
26992 if (hourglass_atimer
)
26994 cancel_atimer (hourglass_atimer
);
26995 hourglass_atimer
= NULL
;
26998 if (hourglass_shown_p
)
27002 #endif /* ! WINDOWSNT */