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 static Lisp_Object Qwindow_text_change_functions
;
322 static Lisp_Object Qredisplay_end_trigger_functions
;
323 Lisp_Object Qinhibit_point_motion_hooks
;
324 static Lisp_Object QCeval
, QCpropertize
;
325 Lisp_Object QCfile
, QCdata
;
326 static Lisp_Object Qfontified
;
327 static Lisp_Object Qgrow_only
;
328 static Lisp_Object Qinhibit_eval_during_redisplay
;
329 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
330 static Lisp_Object Qright_to_left
, Qleft_to_right
;
333 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
336 static Lisp_Object Qarrow
, Qhand
;
339 /* Holds the list (error). */
340 static Lisp_Object list_of_error
;
342 static Lisp_Object Qfontification_functions
;
344 static Lisp_Object Qwrap_prefix
;
345 static Lisp_Object Qline_prefix
;
347 /* Non-nil means don't actually do any redisplay. */
349 Lisp_Object Qinhibit_redisplay
;
351 /* Names of text properties relevant for redisplay. */
353 Lisp_Object Qdisplay
;
355 Lisp_Object Qspace
, QCalign_to
;
356 static Lisp_Object QCrelative_width
, QCrelative_height
;
357 Lisp_Object Qleft_margin
, Qright_margin
;
358 static Lisp_Object Qspace_width
, Qraise
;
359 static Lisp_Object Qslice
;
361 static Lisp_Object Qmargin
, Qpointer
;
362 static Lisp_Object Qline_height
;
364 #ifdef HAVE_WINDOW_SYSTEM
366 /* Test if overflow newline into fringe. Called with iterator IT
367 at or past right window margin, and with IT->current_x set. */
369 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
370 (!NILP (Voverflow_newline_into_fringe) \
371 && FRAME_WINDOW_P ((IT)->f) \
372 && ((IT)->bidi_it.paragraph_dir == R2L \
373 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
374 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
375 && (IT)->current_x == (IT)->last_visible_x \
376 && (IT)->line_wrap != WORD_WRAP)
378 #else /* !HAVE_WINDOW_SYSTEM */
379 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
380 #endif /* HAVE_WINDOW_SYSTEM */
382 /* Test if the display element loaded in IT is a space or tab
383 character. This is used to determine word wrapping. */
385 #define IT_DISPLAYING_WHITESPACE(it) \
386 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
388 /* Name of the face used to highlight trailing whitespace. */
390 static Lisp_Object Qtrailing_whitespace
;
392 /* Name and number of the face used to highlight escape glyphs. */
394 static Lisp_Object Qescape_glyph
;
396 /* Name and number of the face used to highlight non-breaking spaces. */
398 static Lisp_Object Qnobreak_space
;
400 /* The symbol `image' which is the car of the lists used to represent
401 images in Lisp. Also a tool bar style. */
405 /* The image map types. */
407 static Lisp_Object QCpointer
;
408 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
410 /* Tool bar styles */
411 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
413 /* Non-zero means print newline to stdout before next mini-buffer
416 int noninteractive_need_newline
;
418 /* Non-zero means print newline to message log before next message. */
420 static int message_log_need_newline
;
422 /* Three markers that message_dolog uses.
423 It could allocate them itself, but that causes trouble
424 in handling memory-full errors. */
425 static Lisp_Object message_dolog_marker1
;
426 static Lisp_Object message_dolog_marker2
;
427 static Lisp_Object message_dolog_marker3
;
429 /* The buffer position of the first character appearing entirely or
430 partially on the line of the selected window which contains the
431 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
432 redisplay optimization in redisplay_internal. */
434 static struct text_pos this_line_start_pos
;
436 /* Number of characters past the end of the line above, including the
437 terminating newline. */
439 static struct text_pos this_line_end_pos
;
441 /* The vertical positions and the height of this line. */
443 static int this_line_vpos
;
444 static int this_line_y
;
445 static int this_line_pixel_height
;
447 /* X position at which this display line starts. Usually zero;
448 negative if first character is partially visible. */
450 static int this_line_start_x
;
452 /* The smallest character position seen by move_it_* functions as they
453 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
454 hscrolled lines, see display_line. */
456 static struct text_pos this_line_min_pos
;
458 /* Buffer that this_line_.* variables are referring to. */
460 static struct buffer
*this_line_buffer
;
463 /* Values of those variables at last redisplay are stored as
464 properties on `overlay-arrow-position' symbol. However, if
465 Voverlay_arrow_position is a marker, last-arrow-position is its
466 numerical position. */
468 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
470 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
471 properties on a symbol in overlay-arrow-variable-list. */
473 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
475 Lisp_Object Qmenu_bar_update_hook
;
477 /* Nonzero if an overlay arrow has been displayed in this window. */
479 static int overlay_arrow_seen
;
481 /* Number of windows showing the buffer of the selected window (or
482 another buffer with the same base buffer). keyboard.c refers to
487 /* Vector containing glyphs for an ellipsis `...'. */
489 static Lisp_Object default_invis_vector
[3];
491 /* This is the window where the echo area message was displayed. It
492 is always a mini-buffer window, but it may not be the same window
493 currently active as a mini-buffer. */
495 Lisp_Object echo_area_window
;
497 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
498 pushes the current message and the value of
499 message_enable_multibyte on the stack, the function restore_message
500 pops the stack and displays MESSAGE again. */
502 static Lisp_Object Vmessage_stack
;
504 /* Nonzero means multibyte characters were enabled when the echo area
505 message was specified. */
507 static int message_enable_multibyte
;
509 /* Nonzero if we should redraw the mode lines on the next redisplay. */
511 int update_mode_lines
;
513 /* Nonzero if window sizes or contents have changed since last
514 redisplay that finished. */
516 int windows_or_buffers_changed
;
518 /* Nonzero means a frame's cursor type has been changed. */
520 int cursor_type_changed
;
522 /* Nonzero after display_mode_line if %l was used and it displayed a
525 static int line_number_displayed
;
527 /* The name of the *Messages* buffer, a string. */
529 static Lisp_Object Vmessages_buffer_name
;
531 /* Current, index 0, and last displayed echo area message. Either
532 buffers from echo_buffers, or nil to indicate no message. */
534 Lisp_Object echo_area_buffer
[2];
536 /* The buffers referenced from echo_area_buffer. */
538 static Lisp_Object echo_buffer
[2];
540 /* A vector saved used in with_area_buffer to reduce consing. */
542 static Lisp_Object Vwith_echo_area_save_vector
;
544 /* Non-zero means display_echo_area should display the last echo area
545 message again. Set by redisplay_preserve_echo_area. */
547 static int display_last_displayed_message_p
;
549 /* Nonzero if echo area is being used by print; zero if being used by
552 static int message_buf_print
;
554 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
556 static Lisp_Object Qinhibit_menubar_update
;
557 static Lisp_Object Qmessage_truncate_lines
;
559 /* Set to 1 in clear_message to make redisplay_internal aware
560 of an emptied echo area. */
562 static int message_cleared_p
;
564 /* A scratch glyph row with contents used for generating truncation
565 glyphs. Also used in direct_output_for_insert. */
567 #define MAX_SCRATCH_GLYPHS 100
568 static struct glyph_row scratch_glyph_row
;
569 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
571 /* Ascent and height of the last line processed by move_it_to. */
573 static int last_max_ascent
, last_height
;
575 /* Non-zero if there's a help-echo in the echo area. */
577 int help_echo_showing_p
;
579 /* If >= 0, computed, exact values of mode-line and header-line height
580 to use in the macros CURRENT_MODE_LINE_HEIGHT and
581 CURRENT_HEADER_LINE_HEIGHT. */
583 int current_mode_line_height
, current_header_line_height
;
585 /* The maximum distance to look ahead for text properties. Values
586 that are too small let us call compute_char_face and similar
587 functions too often which is expensive. Values that are too large
588 let us call compute_char_face and alike too often because we
589 might not be interested in text properties that far away. */
591 #define TEXT_PROP_DISTANCE_LIMIT 100
595 /* Non-zero means print traces of redisplay if compiled with
598 int trace_redisplay_p
;
600 #endif /* GLYPH_DEBUG */
602 #ifdef DEBUG_TRACE_MOVE
603 /* Non-zero means trace with TRACE_MOVE to stderr. */
606 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
608 #define TRACE_MOVE(x) (void) 0
611 static Lisp_Object Qauto_hscroll_mode
;
613 /* Buffer being redisplayed -- for redisplay_window_error. */
615 static struct buffer
*displayed_buffer
;
617 /* Value returned from text property handlers (see below). */
622 HANDLED_RECOMPUTE_PROPS
,
623 HANDLED_OVERLAY_STRING_CONSUMED
,
627 /* A description of text properties that redisplay is interested
632 /* The name of the property. */
635 /* A unique index for the property. */
638 /* A handler function called to set up iterator IT from the property
639 at IT's current position. Value is used to steer handle_stop. */
640 enum prop_handled (*handler
) (struct it
*it
);
643 static enum prop_handled
handle_face_prop (struct it
*);
644 static enum prop_handled
handle_invisible_prop (struct it
*);
645 static enum prop_handled
handle_display_prop (struct it
*);
646 static enum prop_handled
handle_composition_prop (struct it
*);
647 static enum prop_handled
handle_overlay_change (struct it
*);
648 static enum prop_handled
handle_fontified_prop (struct it
*);
650 /* Properties handled by iterators. */
652 static struct props it_props
[] =
654 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
655 /* Handle `face' before `display' because some sub-properties of
656 `display' need to know the face. */
657 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
658 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
659 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
660 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
664 /* Value is the position described by X. If X is a marker, value is
665 the marker_position of X. Otherwise, value is X. */
667 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
669 /* Enumeration returned by some move_it_.* functions internally. */
673 /* Not used. Undefined value. */
676 /* Move ended at the requested buffer position or ZV. */
677 MOVE_POS_MATCH_OR_ZV
,
679 /* Move ended at the requested X pixel position. */
682 /* Move within a line ended at the end of a line that must be
686 /* Move within a line ended at the end of a line that would
687 be displayed truncated. */
690 /* Move within a line ended at a line end. */
694 /* This counter is used to clear the face cache every once in a while
695 in redisplay_internal. It is incremented for each redisplay.
696 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
699 #define CLEAR_FACE_CACHE_COUNT 500
700 static int clear_face_cache_count
;
702 /* Similarly for the image cache. */
704 #ifdef HAVE_WINDOW_SYSTEM
705 #define CLEAR_IMAGE_CACHE_COUNT 101
706 static int clear_image_cache_count
;
708 /* Null glyph slice */
709 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
712 /* Non-zero while redisplay_internal is in progress. */
716 static Lisp_Object Qinhibit_free_realized_faces
;
718 /* If a string, XTread_socket generates an event to display that string.
719 (The display is done in read_char.) */
721 Lisp_Object help_echo_string
;
722 Lisp_Object help_echo_window
;
723 Lisp_Object help_echo_object
;
724 EMACS_INT help_echo_pos
;
726 /* Temporary variable for XTread_socket. */
728 Lisp_Object previous_help_echo_string
;
730 /* Platform-independent portion of hourglass implementation. */
732 /* Non-zero means an hourglass cursor is currently shown. */
733 int hourglass_shown_p
;
735 /* If non-null, an asynchronous timer that, when it expires, displays
736 an hourglass cursor on all frames. */
737 struct atimer
*hourglass_atimer
;
739 /* Name of the face used to display glyphless characters. */
740 Lisp_Object Qglyphless_char
;
742 /* Symbol for the purpose of Vglyphless_char_display. */
743 static Lisp_Object Qglyphless_char_display
;
745 /* Method symbols for Vglyphless_char_display. */
746 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
748 /* Default pixel width of `thin-space' display method. */
749 #define THIN_SPACE_WIDTH 1
751 /* Default number of seconds to wait before displaying an hourglass
753 #define DEFAULT_HOURGLASS_DELAY 1
756 /* Function prototypes. */
758 static void setup_for_ellipsis (struct it
*, int);
759 static void set_iterator_to_next (struct it
*, int);
760 static void mark_window_display_accurate_1 (struct window
*, int);
761 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
762 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
763 static int cursor_row_p (struct glyph_row
*);
764 static int redisplay_mode_lines (Lisp_Object
, int);
765 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
767 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
769 static void handle_line_prefix (struct it
*);
771 static void pint2str (char *, int, EMACS_INT
);
772 static void pint2hrstr (char *, int, EMACS_INT
);
773 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
775 static void reconsider_clip_changes (struct window
*, struct buffer
*);
776 static int text_outside_line_unchanged_p (struct window
*,
777 EMACS_INT
, EMACS_INT
);
778 static void store_mode_line_noprop_char (char);
779 static int store_mode_line_noprop (const char *, int, int);
780 static void handle_stop (struct it
*);
781 static void handle_stop_backwards (struct it
*, EMACS_INT
);
782 static int single_display_spec_intangible_p (Lisp_Object
);
783 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
784 static void ensure_echo_area_buffers (void);
785 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
786 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
787 static int with_echo_area_buffer (struct window
*, int,
788 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
789 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
790 static void clear_garbaged_frames (void);
791 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
792 static void pop_message (void);
793 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
794 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
795 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
796 static int display_echo_area (struct window
*);
797 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
798 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
799 static Lisp_Object
unwind_redisplay (Lisp_Object
);
800 static int string_char_and_length (const unsigned char *, int *);
801 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
803 static int compute_window_start_on_continuation_line (struct window
*);
804 static Lisp_Object
safe_eval_handler (Lisp_Object
);
805 static void insert_left_trunc_glyphs (struct it
*);
806 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
808 static void extend_face_to_end_of_line (struct it
*);
809 static int append_space_for_newline (struct it
*, int);
810 static int cursor_row_fully_visible_p (struct window
*, int, int);
811 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
812 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
813 static int trailing_whitespace_p (EMACS_INT
);
814 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
815 static void push_it (struct it
*, struct text_pos
*);
816 static void pop_it (struct it
*);
817 static void sync_frame_with_window_matrix_rows (struct window
*);
818 static void select_frame_for_redisplay (Lisp_Object
);
819 static void redisplay_internal (void);
820 static int echo_area_display (int);
821 static void redisplay_windows (Lisp_Object
);
822 static void redisplay_window (Lisp_Object
, int);
823 static Lisp_Object
redisplay_window_error (Lisp_Object
);
824 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
825 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
826 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
827 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
829 static int update_menu_bar (struct frame
*, int, int);
830 static int try_window_reusing_current_matrix (struct window
*);
831 static int try_window_id (struct window
*);
832 static int display_line (struct it
*);
833 static int display_mode_lines (struct window
*);
834 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
835 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
836 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
837 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
838 static void display_menu_bar (struct window
*);
839 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
841 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
842 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
843 static void compute_line_metrics (struct it
*);
844 static void run_redisplay_end_trigger_hook (struct it
*);
845 static int get_overlay_strings (struct it
*, EMACS_INT
);
846 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
847 static void next_overlay_string (struct it
*);
848 static void reseat (struct it
*, struct text_pos
, int);
849 static void reseat_1 (struct it
*, struct text_pos
, int);
850 static void back_to_previous_visible_line_start (struct it
*);
851 void reseat_at_previous_visible_line_start (struct it
*);
852 static void reseat_at_next_visible_line_start (struct it
*, int);
853 static int next_element_from_ellipsis (struct it
*);
854 static int next_element_from_display_vector (struct it
*);
855 static int next_element_from_string (struct it
*);
856 static int next_element_from_c_string (struct it
*);
857 static int next_element_from_buffer (struct it
*);
858 static int next_element_from_composition (struct it
*);
859 static int next_element_from_image (struct it
*);
860 static int next_element_from_stretch (struct it
*);
861 static void load_overlay_strings (struct it
*, EMACS_INT
);
862 static int init_from_display_pos (struct it
*, struct window
*,
863 struct display_pos
*);
864 static void reseat_to_string (struct it
*, const char *,
865 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
866 static int get_next_display_element (struct it
*);
867 static enum move_it_result
868 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
869 enum move_operation_enum
);
870 void move_it_vertically_backward (struct it
*, int);
871 static void init_to_row_start (struct it
*, struct window
*,
873 static int init_to_row_end (struct it
*, struct window
*,
875 static void back_to_previous_line_start (struct it
*);
876 static int forward_to_next_line_start (struct it
*, int *);
877 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
878 Lisp_Object
, EMACS_INT
);
879 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
880 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
881 static EMACS_INT
number_of_chars (const char *, int);
882 static void compute_stop_pos (struct it
*);
883 static void compute_string_pos (struct text_pos
*, struct text_pos
,
885 static int face_before_or_after_it_pos (struct it
*, int);
886 static EMACS_INT
next_overlay_change (EMACS_INT
);
887 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
888 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
889 static int handle_single_display_spec (struct it
*, Lisp_Object
,
890 Lisp_Object
, Lisp_Object
,
891 struct text_pos
*, EMACS_INT
, int, int);
892 static int underlying_face_id (struct it
*);
893 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
896 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
897 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
899 #ifdef HAVE_WINDOW_SYSTEM
901 static void x_consider_frame_title (Lisp_Object
);
902 static int tool_bar_lines_needed (struct frame
*, int *);
903 static void update_tool_bar (struct frame
*, int);
904 static void build_desired_tool_bar_string (struct frame
*f
);
905 static int redisplay_tool_bar (struct frame
*);
906 static void display_tool_bar_line (struct it
*, int);
907 static void notice_overwritten_cursor (struct window
*,
910 static void append_stretch_glyph (struct it
*, Lisp_Object
,
914 #endif /* HAVE_WINDOW_SYSTEM */
916 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
917 static int coords_in_mouse_face_p (struct window
*, int, int);
921 /***********************************************************************
922 Window display dimensions
923 ***********************************************************************/
925 /* Return the bottom boundary y-position for text lines in window W.
926 This is the first y position at which a line cannot start.
927 It is relative to the top of the window.
929 This is the height of W minus the height of a mode line, if any. */
932 window_text_bottom_y (struct window
*w
)
934 int height
= WINDOW_TOTAL_HEIGHT (w
);
936 if (WINDOW_WANTS_MODELINE_P (w
))
937 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
941 /* Return the pixel width of display area AREA of window W. AREA < 0
942 means return the total width of W, not including fringes to
943 the left and right of the window. */
946 window_box_width (struct window
*w
, int area
)
948 int cols
= XFASTINT (w
->total_cols
);
951 if (!w
->pseudo_window_p
)
953 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
955 if (area
== TEXT_AREA
)
957 if (INTEGERP (w
->left_margin_cols
))
958 cols
-= XFASTINT (w
->left_margin_cols
);
959 if (INTEGERP (w
->right_margin_cols
))
960 cols
-= XFASTINT (w
->right_margin_cols
);
961 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
963 else if (area
== LEFT_MARGIN_AREA
)
965 cols
= (INTEGERP (w
->left_margin_cols
)
966 ? XFASTINT (w
->left_margin_cols
) : 0);
969 else if (area
== RIGHT_MARGIN_AREA
)
971 cols
= (INTEGERP (w
->right_margin_cols
)
972 ? XFASTINT (w
->right_margin_cols
) : 0);
977 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
981 /* Return the pixel height of the display area of window W, not
982 including mode lines of W, if any. */
985 window_box_height (struct window
*w
)
987 struct frame
*f
= XFRAME (w
->frame
);
988 int height
= WINDOW_TOTAL_HEIGHT (w
);
990 xassert (height
>= 0);
992 /* Note: the code below that determines the mode-line/header-line
993 height is essentially the same as that contained in the macro
994 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
995 the appropriate glyph row has its `mode_line_p' flag set,
996 and if it doesn't, uses estimate_mode_line_height instead. */
998 if (WINDOW_WANTS_MODELINE_P (w
))
1000 struct glyph_row
*ml_row
1001 = (w
->current_matrix
&& w
->current_matrix
->rows
1002 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1004 if (ml_row
&& ml_row
->mode_line_p
)
1005 height
-= ml_row
->height
;
1007 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1010 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1012 struct glyph_row
*hl_row
1013 = (w
->current_matrix
&& w
->current_matrix
->rows
1014 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1016 if (hl_row
&& hl_row
->mode_line_p
)
1017 height
-= hl_row
->height
;
1019 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1022 /* With a very small font and a mode-line that's taller than
1023 default, we might end up with a negative height. */
1024 return max (0, height
);
1027 /* Return the window-relative coordinate of the left edge of display
1028 area AREA of window W. AREA < 0 means return the left edge of the
1029 whole window, to the right of the left fringe of W. */
1032 window_box_left_offset (struct window
*w
, int area
)
1036 if (w
->pseudo_window_p
)
1039 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1041 if (area
== TEXT_AREA
)
1042 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1043 + window_box_width (w
, LEFT_MARGIN_AREA
));
1044 else if (area
== RIGHT_MARGIN_AREA
)
1045 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1046 + window_box_width (w
, LEFT_MARGIN_AREA
)
1047 + window_box_width (w
, TEXT_AREA
)
1048 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1050 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1051 else if (area
== LEFT_MARGIN_AREA
1052 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1053 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1059 /* Return the window-relative coordinate of the right edge of display
1060 area AREA of window W. AREA < 0 means return the right edge of the
1061 whole window, to the left of the right fringe of W. */
1064 window_box_right_offset (struct window
*w
, int area
)
1066 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1069 /* Return the frame-relative coordinate of the left edge of display
1070 area AREA of window W. AREA < 0 means return the left edge of the
1071 whole window, to the right of the left fringe of W. */
1074 window_box_left (struct window
*w
, int area
)
1076 struct frame
*f
= XFRAME (w
->frame
);
1079 if (w
->pseudo_window_p
)
1080 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1082 x
= (WINDOW_LEFT_EDGE_X (w
)
1083 + window_box_left_offset (w
, area
));
1089 /* Return the frame-relative coordinate of the right edge of display
1090 area AREA of window W. AREA < 0 means return the right edge of the
1091 whole window, to the left of the right fringe of W. */
1094 window_box_right (struct window
*w
, int area
)
1096 return window_box_left (w
, area
) + window_box_width (w
, area
);
1099 /* Get the bounding box of the display area AREA of window W, without
1100 mode lines, in frame-relative coordinates. AREA < 0 means the
1101 whole window, not including the left and right fringes of
1102 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1103 coordinates of the upper-left corner of the box. Return in
1104 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1107 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1108 int *box_width
, int *box_height
)
1111 *box_width
= window_box_width (w
, area
);
1113 *box_height
= window_box_height (w
);
1115 *box_x
= window_box_left (w
, area
);
1118 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1119 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1120 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines. AREA < 0 means the whole window, not including the
1127 left and right fringe of the window. Return in *TOP_LEFT_X
1128 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1129 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1130 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1134 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1135 int *bottom_right_x
, int *bottom_right_y
)
1137 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1139 *bottom_right_x
+= *top_left_x
;
1140 *bottom_right_y
+= *top_left_y
;
1145 /***********************************************************************
1147 ***********************************************************************/
1149 /* Return the bottom y-position of the line the iterator IT is in.
1150 This can modify IT's settings. */
1153 line_bottom_y (struct it
*it
)
1155 int line_height
= it
->max_ascent
+ it
->max_descent
;
1156 int line_top_y
= it
->current_y
;
1158 if (line_height
== 0)
1161 line_height
= last_height
;
1162 else if (IT_CHARPOS (*it
) < ZV
)
1164 move_it_by_lines (it
, 1);
1165 line_height
= (it
->max_ascent
|| it
->max_descent
1166 ? it
->max_ascent
+ it
->max_descent
1171 struct glyph_row
*row
= it
->glyph_row
;
1173 /* Use the default character height. */
1174 it
->glyph_row
= NULL
;
1175 it
->what
= IT_CHARACTER
;
1178 PRODUCE_GLYPHS (it
);
1179 line_height
= it
->ascent
+ it
->descent
;
1180 it
->glyph_row
= row
;
1184 return line_top_y
+ line_height
;
1188 /* Return 1 if position CHARPOS is visible in window W.
1189 CHARPOS < 0 means return info about WINDOW_END position.
1190 If visible, set *X and *Y to pixel coordinates of top left corner.
1191 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1192 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1195 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1196 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1199 struct text_pos top
;
1201 struct buffer
*old_buffer
= NULL
;
1203 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1206 if (XBUFFER (w
->buffer
) != current_buffer
)
1208 old_buffer
= current_buffer
;
1209 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1212 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1214 /* Compute exact mode line heights. */
1215 if (WINDOW_WANTS_MODELINE_P (w
))
1216 current_mode_line_height
1217 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1218 BVAR (current_buffer
, mode_line_format
));
1220 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1221 current_header_line_height
1222 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1223 BVAR (current_buffer
, header_line_format
));
1225 start_display (&it
, w
, top
);
1226 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1227 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1229 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1231 /* We have reached CHARPOS, or passed it. How the call to
1232 move_it_to can overshoot: (i) If CHARPOS is on invisible
1233 text, move_it_to stops at the end of the invisible text,
1234 after CHARPOS. (ii) If CHARPOS is in a display vector,
1235 move_it_to stops on its last glyph. */
1236 int top_x
= it
.current_x
;
1237 int top_y
= it
.current_y
;
1238 enum it_method it_method
= it
.method
;
1239 /* Calling line_bottom_y may change it.method, it.position, etc. */
1240 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1241 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1243 if (top_y
< window_top_y
)
1244 visible_p
= bottom_y
> window_top_y
;
1245 else if (top_y
< it
.last_visible_y
)
1249 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1251 /* We stopped on the last glyph of a display vector.
1252 Try and recompute. Hack alert! */
1253 if (charpos
< 2 || top
.charpos
>= charpos
)
1254 top_x
= it
.glyph_row
->x
;
1258 start_display (&it2
, w
, top
);
1259 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1260 get_next_display_element (&it2
);
1261 PRODUCE_GLYPHS (&it2
);
1262 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1263 || it2
.current_x
> it2
.last_visible_x
)
1264 top_x
= it
.glyph_row
->x
;
1267 top_x
= it2
.current_x
;
1268 top_y
= it2
.current_y
;
1274 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1275 *rtop
= max (0, window_top_y
- top_y
);
1276 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1277 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1278 - max (top_y
, window_top_y
)));
1287 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1288 move_it_by_lines (&it
, 1);
1289 if (charpos
< IT_CHARPOS (it
)
1290 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1293 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1295 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1296 *rtop
= max (0, -it2
.current_y
);
1297 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1298 - it
.last_visible_y
));
1299 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1301 - max (it2
.current_y
,
1302 WINDOW_HEADER_LINE_HEIGHT (w
))));
1308 set_buffer_internal_1 (old_buffer
);
1310 current_header_line_height
= current_mode_line_height
= -1;
1312 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1313 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1316 /* Debugging code. */
1318 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1319 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1321 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1328 /* Return the next character from STR. Return in *LEN the length of
1329 the character. This is like STRING_CHAR_AND_LENGTH but never
1330 returns an invalid character. If we find one, we return a `?', but
1331 with the length of the invalid character. */
1334 string_char_and_length (const unsigned char *str
, int *len
)
1338 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1339 if (!CHAR_VALID_P (c
, 1))
1340 /* We may not change the length here because other places in Emacs
1341 don't use this function, i.e. they silently accept invalid
1350 /* Given a position POS containing a valid character and byte position
1351 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1353 static struct text_pos
1354 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1356 xassert (STRINGP (string
) && nchars
>= 0);
1358 if (STRING_MULTIBYTE (string
))
1360 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1365 string_char_and_length (p
, &len
);
1368 BYTEPOS (pos
) += len
;
1372 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1378 /* Value is the text position, i.e. character and byte position,
1379 for character position CHARPOS in STRING. */
1381 static INLINE
struct text_pos
1382 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1384 struct text_pos pos
;
1385 xassert (STRINGP (string
));
1386 xassert (charpos
>= 0);
1387 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1392 /* Value is a text position, i.e. character and byte position, for
1393 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1394 means recognize multibyte characters. */
1396 static struct text_pos
1397 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1399 struct text_pos pos
;
1401 xassert (s
!= NULL
);
1402 xassert (charpos
>= 0);
1408 SET_TEXT_POS (pos
, 0, 0);
1411 string_char_and_length ((const unsigned char *) s
, &len
);
1414 BYTEPOS (pos
) += len
;
1418 SET_TEXT_POS (pos
, charpos
, charpos
);
1424 /* Value is the number of characters in C string S. MULTIBYTE_P
1425 non-zero means recognize multibyte characters. */
1428 number_of_chars (const char *s
, int multibyte_p
)
1434 EMACS_INT rest
= strlen (s
);
1436 const unsigned char *p
= (const unsigned char *) s
;
1438 for (nchars
= 0; rest
> 0; ++nchars
)
1440 string_char_and_length (p
, &len
);
1441 rest
-= len
, p
+= len
;
1445 nchars
= strlen (s
);
1451 /* Compute byte position NEWPOS->bytepos corresponding to
1452 NEWPOS->charpos. POS is a known position in string STRING.
1453 NEWPOS->charpos must be >= POS.charpos. */
1456 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1458 xassert (STRINGP (string
));
1459 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1461 if (STRING_MULTIBYTE (string
))
1462 *newpos
= string_pos_nchars_ahead (pos
, string
,
1463 CHARPOS (*newpos
) - CHARPOS (pos
));
1465 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1469 Return an estimation of the pixel height of mode or header lines on
1470 frame F. FACE_ID specifies what line's height to estimate. */
1473 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1475 #ifdef HAVE_WINDOW_SYSTEM
1476 if (FRAME_WINDOW_P (f
))
1478 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1480 /* This function is called so early when Emacs starts that the face
1481 cache and mode line face are not yet initialized. */
1482 if (FRAME_FACE_CACHE (f
))
1484 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1488 height
= FONT_HEIGHT (face
->font
);
1489 if (face
->box_line_width
> 0)
1490 height
+= 2 * face
->box_line_width
;
1501 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1502 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1503 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1504 not force the value into range. */
1507 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1508 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1511 #ifdef HAVE_WINDOW_SYSTEM
1512 if (FRAME_WINDOW_P (f
))
1514 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1515 even for negative values. */
1517 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1519 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1521 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1522 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1525 STORE_NATIVE_RECT (*bounds
,
1526 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1527 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1528 FRAME_COLUMN_WIDTH (f
) - 1,
1529 FRAME_LINE_HEIGHT (f
) - 1);
1535 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1536 pix_x
= FRAME_TOTAL_COLS (f
);
1540 else if (pix_y
> FRAME_LINES (f
))
1541 pix_y
= FRAME_LINES (f
);
1551 /* Find the glyph under window-relative coordinates X/Y in window W.
1552 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1553 strings. Return in *HPOS and *VPOS the row and column number of
1554 the glyph found. Return in *AREA the glyph area containing X.
1555 Value is a pointer to the glyph found or null if X/Y is not on
1556 text, or we can't tell because W's current matrix is not up to
1561 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1562 int *dx
, int *dy
, int *area
)
1564 struct glyph
*glyph
, *end
;
1565 struct glyph_row
*row
= NULL
;
1568 /* Find row containing Y. Give up if some row is not enabled. */
1569 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1571 row
= MATRIX_ROW (w
->current_matrix
, i
);
1572 if (!row
->enabled_p
)
1574 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1581 /* Give up if Y is not in the window. */
1582 if (i
== w
->current_matrix
->nrows
)
1585 /* Get the glyph area containing X. */
1586 if (w
->pseudo_window_p
)
1593 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1595 *area
= LEFT_MARGIN_AREA
;
1596 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1598 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1601 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1605 *area
= RIGHT_MARGIN_AREA
;
1606 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1610 /* Find glyph containing X. */
1611 glyph
= row
->glyphs
[*area
];
1612 end
= glyph
+ row
->used
[*area
];
1614 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1616 x
-= glyph
->pixel_width
;
1626 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1629 *hpos
= glyph
- row
->glyphs
[*area
];
1633 /* Convert frame-relative x/y to coordinates relative to window W.
1634 Takes pseudo-windows into account. */
1637 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1639 if (w
->pseudo_window_p
)
1641 /* A pseudo-window is always full-width, and starts at the
1642 left edge of the frame, plus a frame border. */
1643 struct frame
*f
= XFRAME (w
->frame
);
1644 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1645 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1649 *x
-= WINDOW_LEFT_EDGE_X (w
);
1650 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1654 #ifdef HAVE_WINDOW_SYSTEM
1657 Return in RECTS[] at most N clipping rectangles for glyph string S.
1658 Return the number of stored rectangles. */
1661 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1668 if (s
->row
->full_width_p
)
1670 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1671 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1672 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1674 /* Unless displaying a mode or menu bar line, which are always
1675 fully visible, clip to the visible part of the row. */
1676 if (s
->w
->pseudo_window_p
)
1677 r
.height
= s
->row
->visible_height
;
1679 r
.height
= s
->height
;
1683 /* This is a text line that may be partially visible. */
1684 r
.x
= window_box_left (s
->w
, s
->area
);
1685 r
.width
= window_box_width (s
->w
, s
->area
);
1686 r
.height
= s
->row
->visible_height
;
1690 if (r
.x
< s
->clip_head
->x
)
1692 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1693 r
.width
-= s
->clip_head
->x
- r
.x
;
1696 r
.x
= s
->clip_head
->x
;
1699 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1701 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1702 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1707 /* If S draws overlapping rows, it's sufficient to use the top and
1708 bottom of the window for clipping because this glyph string
1709 intentionally draws over other lines. */
1710 if (s
->for_overlaps
)
1712 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1713 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1715 /* Alas, the above simple strategy does not work for the
1716 environments with anti-aliased text: if the same text is
1717 drawn onto the same place multiple times, it gets thicker.
1718 If the overlap we are processing is for the erased cursor, we
1719 take the intersection with the rectagle of the cursor. */
1720 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1722 XRectangle rc
, r_save
= r
;
1724 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1725 rc
.y
= s
->w
->phys_cursor
.y
;
1726 rc
.width
= s
->w
->phys_cursor_width
;
1727 rc
.height
= s
->w
->phys_cursor_height
;
1729 x_intersect_rectangles (&r_save
, &rc
, &r
);
1734 /* Don't use S->y for clipping because it doesn't take partially
1735 visible lines into account. For example, it can be negative for
1736 partially visible lines at the top of a window. */
1737 if (!s
->row
->full_width_p
1738 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1739 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1741 r
.y
= max (0, s
->row
->y
);
1744 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1746 /* If drawing the cursor, don't let glyph draw outside its
1747 advertised boundaries. Cleartype does this under some circumstances. */
1748 if (s
->hl
== DRAW_CURSOR
)
1750 struct glyph
*glyph
= s
->first_glyph
;
1755 r
.width
-= s
->x
- r
.x
;
1758 r
.width
= min (r
.width
, glyph
->pixel_width
);
1760 /* If r.y is below window bottom, ensure that we still see a cursor. */
1761 height
= min (glyph
->ascent
+ glyph
->descent
,
1762 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1763 max_y
= window_text_bottom_y (s
->w
) - height
;
1764 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1765 if (s
->ybase
- glyph
->ascent
> max_y
)
1772 /* Don't draw cursor glyph taller than our actual glyph. */
1773 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1774 if (height
< r
.height
)
1776 max_y
= r
.y
+ r
.height
;
1777 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1778 r
.height
= min (max_y
- r
.y
, height
);
1785 XRectangle r_save
= r
;
1787 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1791 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1792 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1794 #ifdef CONVERT_FROM_XRECT
1795 CONVERT_FROM_XRECT (r
, *rects
);
1803 /* If we are processing overlapping and allowed to return
1804 multiple clipping rectangles, we exclude the row of the glyph
1805 string from the clipping rectangle. This is to avoid drawing
1806 the same text on the environment with anti-aliasing. */
1807 #ifdef CONVERT_FROM_XRECT
1810 XRectangle
*rs
= rects
;
1812 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1814 if (s
->for_overlaps
& OVERLAPS_PRED
)
1817 if (r
.y
+ r
.height
> row_y
)
1820 rs
[i
].height
= row_y
- r
.y
;
1826 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1829 if (r
.y
< row_y
+ s
->row
->visible_height
)
1831 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1833 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1834 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1843 #ifdef CONVERT_FROM_XRECT
1844 for (i
= 0; i
< n
; i
++)
1845 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1852 Return in *NR the clipping rectangle for glyph string S. */
1855 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1857 get_glyph_string_clip_rects (s
, nr
, 1);
1862 Return the position and height of the phys cursor in window W.
1863 Set w->phys_cursor_width to width of phys cursor.
1867 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1868 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1870 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1871 int x
, y
, wd
, h
, h0
, y0
;
1873 /* Compute the width of the rectangle to draw. If on a stretch
1874 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1875 rectangle as wide as the glyph, but use a canonical character
1877 wd
= glyph
->pixel_width
- 1;
1878 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1882 x
= w
->phys_cursor
.x
;
1889 if (glyph
->type
== STRETCH_GLYPH
1890 && !x_stretch_cursor_p
)
1891 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1892 w
->phys_cursor_width
= wd
;
1894 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1896 /* If y is below window bottom, ensure that we still see a cursor. */
1897 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1899 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1900 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1902 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1905 h
= max (h
- (y0
- y
) + 1, h0
);
1910 y0
= window_text_bottom_y (w
) - h0
;
1918 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1919 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1924 * Remember which glyph the mouse is over.
1928 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1932 struct glyph_row
*r
, *gr
, *end_row
;
1933 enum window_part part
;
1934 enum glyph_row_area area
;
1935 int x
, y
, width
, height
;
1937 /* Try to determine frame pixel position and size of the glyph under
1938 frame pixel coordinates X/Y on frame F. */
1940 if (!f
->glyphs_initialized_p
1941 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1944 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1945 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1949 w
= XWINDOW (window
);
1950 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1951 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1953 x
= window_relative_x_coord (w
, part
, gx
);
1954 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1956 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1957 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1959 if (w
->pseudo_window_p
)
1962 part
= ON_MODE_LINE
; /* Don't adjust margin. */
1968 case ON_LEFT_MARGIN
:
1969 area
= LEFT_MARGIN_AREA
;
1972 case ON_RIGHT_MARGIN
:
1973 area
= RIGHT_MARGIN_AREA
;
1976 case ON_HEADER_LINE
:
1978 gr
= (part
== ON_HEADER_LINE
1979 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1980 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
1983 goto text_glyph_row_found
;
1990 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
1991 if (r
->y
+ r
->height
> y
)
1997 text_glyph_row_found
:
2000 struct glyph
*g
= gr
->glyphs
[area
];
2001 struct glyph
*end
= g
+ gr
->used
[area
];
2003 height
= gr
->height
;
2004 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2005 if (gx
+ g
->pixel_width
> x
)
2010 if (g
->type
== IMAGE_GLYPH
)
2012 /* Don't remember when mouse is over image, as
2013 image may have hot-spots. */
2014 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2017 width
= g
->pixel_width
;
2021 /* Use nominal char spacing at end of line. */
2023 gx
+= (x
/ width
) * width
;
2026 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2027 gx
+= window_box_left_offset (w
, area
);
2031 /* Use nominal line height at end of window. */
2032 gx
= (x
/ width
) * width
;
2034 gy
+= (y
/ height
) * height
;
2038 case ON_LEFT_FRINGE
:
2039 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2040 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2041 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2042 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2045 case ON_RIGHT_FRINGE
:
2046 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2047 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2048 : window_box_right_offset (w
, TEXT_AREA
));
2049 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2053 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2055 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2056 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2057 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2059 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2063 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2064 if (r
->y
+ r
->height
> y
)
2071 height
= gr
->height
;
2074 /* Use nominal line height at end of window. */
2076 gy
+= (y
/ height
) * height
;
2083 /* If there is no glyph under the mouse, then we divide the screen
2084 into a grid of the smallest glyph in the frame, and use that
2087 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2088 round down even for negative values. */
2094 gx
= (gx
/ width
) * width
;
2095 gy
= (gy
/ height
) * height
;
2100 gx
+= WINDOW_LEFT_EDGE_X (w
);
2101 gy
+= WINDOW_TOP_EDGE_Y (w
);
2104 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2106 /* Visible feedback for debugging. */
2109 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2110 f
->output_data
.x
->normal_gc
,
2111 gx
, gy
, width
, height
);
2117 #endif /* HAVE_WINDOW_SYSTEM */
2120 /***********************************************************************
2121 Lisp form evaluation
2122 ***********************************************************************/
2124 /* Error handler for safe_eval and safe_call. */
2127 safe_eval_handler (Lisp_Object arg
)
2129 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2134 /* Evaluate SEXPR and return the result, or nil if something went
2135 wrong. Prevent redisplay during the evaluation. */
2137 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2138 Return the result, or nil if something went wrong. Prevent
2139 redisplay during the evaluation. */
2142 safe_call (size_t nargs
, Lisp_Object
*args
)
2146 if (inhibit_eval_during_redisplay
)
2150 int count
= SPECPDL_INDEX ();
2151 struct gcpro gcpro1
;
2154 gcpro1
.nvars
= nargs
;
2155 specbind (Qinhibit_redisplay
, Qt
);
2156 /* Use Qt to ensure debugger does not run,
2157 so there is no possibility of wanting to redisplay. */
2158 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2161 val
= unbind_to (count
, val
);
2168 /* Call function FN with one argument ARG.
2169 Return the result, or nil if something went wrong. */
2172 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2174 Lisp_Object args
[2];
2177 return safe_call (2, args
);
2180 static Lisp_Object Qeval
;
2183 safe_eval (Lisp_Object sexpr
)
2185 return safe_call1 (Qeval
, sexpr
);
2188 /* Call function FN with one argument ARG.
2189 Return the result, or nil if something went wrong. */
2192 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2194 Lisp_Object args
[3];
2198 return safe_call (3, args
);
2203 /***********************************************************************
2205 ***********************************************************************/
2209 /* Define CHECK_IT to perform sanity checks on iterators.
2210 This is for debugging. It is too slow to do unconditionally. */
2216 if (it
->method
== GET_FROM_STRING
)
2218 xassert (STRINGP (it
->string
));
2219 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2223 xassert (IT_STRING_CHARPOS (*it
) < 0);
2224 if (it
->method
== GET_FROM_BUFFER
)
2226 /* Check that character and byte positions agree. */
2227 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2232 xassert (it
->current
.dpvec_index
>= 0);
2234 xassert (it
->current
.dpvec_index
< 0);
2237 #define CHECK_IT(IT) check_it ((IT))
2241 #define CHECK_IT(IT) (void) 0
2248 /* Check that the window end of window W is what we expect it
2249 to be---the last row in the current matrix displaying text. */
2252 check_window_end (w
)
2255 if (!MINI_WINDOW_P (w
)
2256 && !NILP (w
->window_end_valid
))
2258 struct glyph_row
*row
;
2259 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2260 XFASTINT (w
->window_end_vpos
)),
2262 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2263 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2267 #define CHECK_WINDOW_END(W) check_window_end ((W))
2269 #else /* not GLYPH_DEBUG */
2271 #define CHECK_WINDOW_END(W) (void) 0
2273 #endif /* not GLYPH_DEBUG */
2277 /***********************************************************************
2278 Iterator initialization
2279 ***********************************************************************/
2281 /* Initialize IT for displaying current_buffer in window W, starting
2282 at character position CHARPOS. CHARPOS < 0 means that no buffer
2283 position is specified which is useful when the iterator is assigned
2284 a position later. BYTEPOS is the byte position corresponding to
2285 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2287 If ROW is not null, calls to produce_glyphs with IT as parameter
2288 will produce glyphs in that row.
2290 BASE_FACE_ID is the id of a base face to use. It must be one of
2291 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2292 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2293 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2295 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2296 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2297 will be initialized to use the corresponding mode line glyph row of
2298 the desired matrix of W. */
2301 init_iterator (struct it
*it
, struct window
*w
,
2302 EMACS_INT charpos
, EMACS_INT bytepos
,
2303 struct glyph_row
*row
, enum face_id base_face_id
)
2305 int highlight_region_p
;
2306 enum face_id remapped_base_face_id
= base_face_id
;
2308 /* Some precondition checks. */
2309 xassert (w
!= NULL
&& it
!= NULL
);
2310 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2313 /* If face attributes have been changed since the last redisplay,
2314 free realized faces now because they depend on face definitions
2315 that might have changed. Don't free faces while there might be
2316 desired matrices pending which reference these faces. */
2317 if (face_change_count
&& !inhibit_free_realized_faces
)
2319 face_change_count
= 0;
2320 free_all_realized_faces (Qnil
);
2323 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2324 if (! NILP (Vface_remapping_alist
))
2325 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2327 /* Use one of the mode line rows of W's desired matrix if
2331 if (base_face_id
== MODE_LINE_FACE_ID
2332 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2333 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2334 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2335 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2339 memset (it
, 0, sizeof *it
);
2340 it
->current
.overlay_string_index
= -1;
2341 it
->current
.dpvec_index
= -1;
2342 it
->base_face_id
= remapped_base_face_id
;
2344 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2346 /* The window in which we iterate over current_buffer: */
2347 XSETWINDOW (it
->window
, w
);
2349 it
->f
= XFRAME (w
->frame
);
2353 /* Extra space between lines (on window systems only). */
2354 if (base_face_id
== DEFAULT_FACE_ID
2355 && FRAME_WINDOW_P (it
->f
))
2357 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2358 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2359 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2360 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2361 * FRAME_LINE_HEIGHT (it
->f
));
2362 else if (it
->f
->extra_line_spacing
> 0)
2363 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2364 it
->max_extra_line_spacing
= 0;
2367 /* If realized faces have been removed, e.g. because of face
2368 attribute changes of named faces, recompute them. When running
2369 in batch mode, the face cache of the initial frame is null. If
2370 we happen to get called, make a dummy face cache. */
2371 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2372 init_frame_faces (it
->f
);
2373 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2374 recompute_basic_faces (it
->f
);
2376 /* Current value of the `slice', `space-width', and 'height' properties. */
2377 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2378 it
->space_width
= Qnil
;
2379 it
->font_height
= Qnil
;
2380 it
->override_ascent
= -1;
2382 /* Are control characters displayed as `^C'? */
2383 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2385 /* -1 means everything between a CR and the following line end
2386 is invisible. >0 means lines indented more than this value are
2388 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2389 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2390 : (!NILP (BVAR (current_buffer
, selective_display
))
2392 it
->selective_display_ellipsis_p
2393 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2395 /* Display table to use. */
2396 it
->dp
= window_display_table (w
);
2398 /* Are multibyte characters enabled in current_buffer? */
2399 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2401 /* Do we need to reorder bidirectional text? Not if this is a
2402 unibyte buffer: by definition, none of the single-byte characters
2403 are strong R2L, so no reordering is needed. And bidi.c doesn't
2404 support unibyte buffers anyway. */
2406 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2408 /* Non-zero if we should highlight the region. */
2410 = (!NILP (Vtransient_mark_mode
)
2411 && !NILP (BVAR (current_buffer
, mark_active
))
2412 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2414 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2415 start and end of a visible region in window IT->w. Set both to
2416 -1 to indicate no region. */
2417 if (highlight_region_p
2418 /* Maybe highlight only in selected window. */
2419 && (/* Either show region everywhere. */
2420 highlight_nonselected_windows
2421 /* Or show region in the selected window. */
2422 || w
== XWINDOW (selected_window
)
2423 /* Or show the region if we are in the mini-buffer and W is
2424 the window the mini-buffer refers to. */
2425 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2426 && WINDOWP (minibuf_selected_window
)
2427 && w
== XWINDOW (minibuf_selected_window
))))
2429 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2430 it
->region_beg_charpos
= min (PT
, markpos
);
2431 it
->region_end_charpos
= max (PT
, markpos
);
2434 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2436 /* Get the position at which the redisplay_end_trigger hook should
2437 be run, if it is to be run at all. */
2438 if (MARKERP (w
->redisplay_end_trigger
)
2439 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2440 it
->redisplay_end_trigger_charpos
2441 = marker_position (w
->redisplay_end_trigger
);
2442 else if (INTEGERP (w
->redisplay_end_trigger
))
2443 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2445 /* Correct bogus values of tab_width. */
2446 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2447 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2450 /* Are lines in the display truncated? */
2451 if (base_face_id
!= DEFAULT_FACE_ID
2452 || XINT (it
->w
->hscroll
)
2453 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2454 && ((!NILP (Vtruncate_partial_width_windows
)
2455 && !INTEGERP (Vtruncate_partial_width_windows
))
2456 || (INTEGERP (Vtruncate_partial_width_windows
)
2457 && (WINDOW_TOTAL_COLS (it
->w
)
2458 < XINT (Vtruncate_partial_width_windows
))))))
2459 it
->line_wrap
= TRUNCATE
;
2460 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2461 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2462 ? WINDOW_WRAP
: WORD_WRAP
;
2464 it
->line_wrap
= TRUNCATE
;
2466 /* Get dimensions of truncation and continuation glyphs. These are
2467 displayed as fringe bitmaps under X, so we don't need them for such
2469 if (!FRAME_WINDOW_P (it
->f
))
2471 if (it
->line_wrap
== TRUNCATE
)
2473 /* We will need the truncation glyph. */
2474 xassert (it
->glyph_row
== NULL
);
2475 produce_special_glyphs (it
, IT_TRUNCATION
);
2476 it
->truncation_pixel_width
= it
->pixel_width
;
2480 /* We will need the continuation glyph. */
2481 xassert (it
->glyph_row
== NULL
);
2482 produce_special_glyphs (it
, IT_CONTINUATION
);
2483 it
->continuation_pixel_width
= it
->pixel_width
;
2486 /* Reset these values to zero because the produce_special_glyphs
2487 above has changed them. */
2488 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2489 it
->phys_ascent
= it
->phys_descent
= 0;
2492 /* Set this after getting the dimensions of truncation and
2493 continuation glyphs, so that we don't produce glyphs when calling
2494 produce_special_glyphs, above. */
2495 it
->glyph_row
= row
;
2496 it
->area
= TEXT_AREA
;
2498 /* Forget any previous info about this row being reversed. */
2500 it
->glyph_row
->reversed_p
= 0;
2502 /* Get the dimensions of the display area. The display area
2503 consists of the visible window area plus a horizontally scrolled
2504 part to the left of the window. All x-values are relative to the
2505 start of this total display area. */
2506 if (base_face_id
!= DEFAULT_FACE_ID
)
2508 /* Mode lines, menu bar in terminal frames. */
2509 it
->first_visible_x
= 0;
2510 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2515 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2516 it
->last_visible_x
= (it
->first_visible_x
2517 + window_box_width (w
, TEXT_AREA
));
2519 /* If we truncate lines, leave room for the truncator glyph(s) at
2520 the right margin. Otherwise, leave room for the continuation
2521 glyph(s). Truncation and continuation glyphs are not inserted
2522 for window-based redisplay. */
2523 if (!FRAME_WINDOW_P (it
->f
))
2525 if (it
->line_wrap
== TRUNCATE
)
2526 it
->last_visible_x
-= it
->truncation_pixel_width
;
2528 it
->last_visible_x
-= it
->continuation_pixel_width
;
2531 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2532 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2535 /* Leave room for a border glyph. */
2536 if (!FRAME_WINDOW_P (it
->f
)
2537 && !WINDOW_RIGHTMOST_P (it
->w
))
2538 it
->last_visible_x
-= 1;
2540 it
->last_visible_y
= window_text_bottom_y (w
);
2542 /* For mode lines and alike, arrange for the first glyph having a
2543 left box line if the face specifies a box. */
2544 if (base_face_id
!= DEFAULT_FACE_ID
)
2548 it
->face_id
= remapped_base_face_id
;
2550 /* If we have a boxed mode line, make the first character appear
2551 with a left box line. */
2552 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2553 if (face
->box
!= FACE_NO_BOX
)
2554 it
->start_of_box_run_p
= 1;
2557 /* If we are to reorder bidirectional text, init the bidi
2561 /* Note the paragraph direction that this buffer wants to
2563 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2564 it
->paragraph_embedding
= L2R
;
2565 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2566 it
->paragraph_embedding
= R2L
;
2568 it
->paragraph_embedding
= NEUTRAL_DIR
;
2569 bidi_init_it (charpos
, bytepos
, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
2572 /* If a buffer position was specified, set the iterator there,
2573 getting overlays and face properties from that position. */
2574 if (charpos
>= BUF_BEG (current_buffer
))
2576 it
->end_charpos
= ZV
;
2578 IT_CHARPOS (*it
) = charpos
;
2580 /* Compute byte position if not specified. */
2581 if (bytepos
< charpos
)
2582 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2584 IT_BYTEPOS (*it
) = bytepos
;
2586 it
->start
= it
->current
;
2588 /* Compute faces etc. */
2589 reseat (it
, it
->current
.pos
, 1);
2596 /* Initialize IT for the display of window W with window start POS. */
2599 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2601 struct glyph_row
*row
;
2602 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2604 row
= w
->desired_matrix
->rows
+ first_vpos
;
2605 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2606 it
->first_vpos
= first_vpos
;
2608 /* Don't reseat to previous visible line start if current start
2609 position is in a string or image. */
2610 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2612 int start_at_line_beg_p
;
2613 int first_y
= it
->current_y
;
2615 /* If window start is not at a line start, skip forward to POS to
2616 get the correct continuation lines width. */
2617 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2618 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2619 if (!start_at_line_beg_p
)
2623 reseat_at_previous_visible_line_start (it
);
2624 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2626 new_x
= it
->current_x
+ it
->pixel_width
;
2628 /* If lines are continued, this line may end in the middle
2629 of a multi-glyph character (e.g. a control character
2630 displayed as \003, or in the middle of an overlay
2631 string). In this case move_it_to above will not have
2632 taken us to the start of the continuation line but to the
2633 end of the continued line. */
2634 if (it
->current_x
> 0
2635 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2636 && (/* And glyph doesn't fit on the line. */
2637 new_x
> it
->last_visible_x
2638 /* Or it fits exactly and we're on a window
2640 || (new_x
== it
->last_visible_x
2641 && FRAME_WINDOW_P (it
->f
))))
2643 if (it
->current
.dpvec_index
>= 0
2644 || it
->current
.overlay_string_index
>= 0)
2646 set_iterator_to_next (it
, 1);
2647 move_it_in_display_line_to (it
, -1, -1, 0);
2650 it
->continuation_lines_width
+= it
->current_x
;
2653 /* We're starting a new display line, not affected by the
2654 height of the continued line, so clear the appropriate
2655 fields in the iterator structure. */
2656 it
->max_ascent
= it
->max_descent
= 0;
2657 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2659 it
->current_y
= first_y
;
2661 it
->current_x
= it
->hpos
= 0;
2667 /* Return 1 if POS is a position in ellipses displayed for invisible
2668 text. W is the window we display, for text property lookup. */
2671 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2673 Lisp_Object prop
, window
;
2675 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2677 /* If POS specifies a position in a display vector, this might
2678 be for an ellipsis displayed for invisible text. We won't
2679 get the iterator set up for delivering that ellipsis unless
2680 we make sure that it gets aware of the invisible text. */
2681 if (pos
->dpvec_index
>= 0
2682 && pos
->overlay_string_index
< 0
2683 && CHARPOS (pos
->string_pos
) < 0
2685 && (XSETWINDOW (window
, w
),
2686 prop
= Fget_char_property (make_number (charpos
),
2687 Qinvisible
, window
),
2688 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2690 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2692 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2699 /* Initialize IT for stepping through current_buffer in window W,
2700 starting at position POS that includes overlay string and display
2701 vector/ control character translation position information. Value
2702 is zero if there are overlay strings with newlines at POS. */
2705 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2707 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2708 int i
, overlay_strings_with_newlines
= 0;
2710 /* If POS specifies a position in a display vector, this might
2711 be for an ellipsis displayed for invisible text. We won't
2712 get the iterator set up for delivering that ellipsis unless
2713 we make sure that it gets aware of the invisible text. */
2714 if (in_ellipses_for_invisible_text_p (pos
, w
))
2720 /* Keep in mind: the call to reseat in init_iterator skips invisible
2721 text, so we might end up at a position different from POS. This
2722 is only a problem when POS is a row start after a newline and an
2723 overlay starts there with an after-string, and the overlay has an
2724 invisible property. Since we don't skip invisible text in
2725 display_line and elsewhere immediately after consuming the
2726 newline before the row start, such a POS will not be in a string,
2727 but the call to init_iterator below will move us to the
2729 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2731 /* This only scans the current chunk -- it should scan all chunks.
2732 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2733 to 16 in 22.1 to make this a lesser problem. */
2734 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2736 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2737 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2739 while (s
< e
&& *s
!= '\n')
2744 overlay_strings_with_newlines
= 1;
2749 /* If position is within an overlay string, set up IT to the right
2751 if (pos
->overlay_string_index
>= 0)
2755 /* If the first overlay string happens to have a `display'
2756 property for an image, the iterator will be set up for that
2757 image, and we have to undo that setup first before we can
2758 correct the overlay string index. */
2759 if (it
->method
== GET_FROM_IMAGE
)
2762 /* We already have the first chunk of overlay strings in
2763 IT->overlay_strings. Load more until the one for
2764 pos->overlay_string_index is in IT->overlay_strings. */
2765 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2767 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2768 it
->current
.overlay_string_index
= 0;
2771 load_overlay_strings (it
, 0);
2772 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2776 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2777 relative_index
= (it
->current
.overlay_string_index
2778 % OVERLAY_STRING_CHUNK_SIZE
);
2779 it
->string
= it
->overlay_strings
[relative_index
];
2780 xassert (STRINGP (it
->string
));
2781 it
->current
.string_pos
= pos
->string_pos
;
2782 it
->method
= GET_FROM_STRING
;
2785 if (CHARPOS (pos
->string_pos
) >= 0)
2787 /* Recorded position is not in an overlay string, but in another
2788 string. This can only be a string from a `display' property.
2789 IT should already be filled with that string. */
2790 it
->current
.string_pos
= pos
->string_pos
;
2791 xassert (STRINGP (it
->string
));
2794 /* Restore position in display vector translations, control
2795 character translations or ellipses. */
2796 if (pos
->dpvec_index
>= 0)
2798 if (it
->dpvec
== NULL
)
2799 get_next_display_element (it
);
2800 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2801 it
->current
.dpvec_index
= pos
->dpvec_index
;
2805 return !overlay_strings_with_newlines
;
2809 /* Initialize IT for stepping through current_buffer in window W
2810 starting at ROW->start. */
2813 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2815 init_from_display_pos (it
, w
, &row
->start
);
2816 it
->start
= row
->start
;
2817 it
->continuation_lines_width
= row
->continuation_lines_width
;
2822 /* Initialize IT for stepping through current_buffer in window W
2823 starting in the line following ROW, i.e. starting at ROW->end.
2824 Value is zero if there are overlay strings with newlines at ROW's
2828 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2832 if (init_from_display_pos (it
, w
, &row
->end
))
2834 if (row
->continued_p
)
2835 it
->continuation_lines_width
2836 = row
->continuation_lines_width
+ row
->pixel_width
;
2847 /***********************************************************************
2849 ***********************************************************************/
2851 /* Called when IT reaches IT->stop_charpos. Handle text property and
2852 overlay changes. Set IT->stop_charpos to the next position where
2856 handle_stop (struct it
*it
)
2858 enum prop_handled handled
;
2859 int handle_overlay_change_p
;
2863 it
->current
.dpvec_index
= -1;
2864 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2865 it
->ignore_overlay_strings_at_pos_p
= 0;
2868 /* Use face of preceding text for ellipsis (if invisible) */
2869 if (it
->selective_display_ellipsis_p
)
2870 it
->saved_face_id
= it
->face_id
;
2874 handled
= HANDLED_NORMALLY
;
2876 /* Call text property handlers. */
2877 for (p
= it_props
; p
->handler
; ++p
)
2879 handled
= p
->handler (it
);
2881 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2883 else if (handled
== HANDLED_RETURN
)
2885 /* We still want to show before and after strings from
2886 overlays even if the actual buffer text is replaced. */
2887 if (!handle_overlay_change_p
2889 || !get_overlay_strings_1 (it
, 0, 0))
2892 setup_for_ellipsis (it
, 0);
2893 /* When handling a display spec, we might load an
2894 empty string. In that case, discard it here. We
2895 used to discard it in handle_single_display_spec,
2896 but that causes get_overlay_strings_1, above, to
2897 ignore overlay strings that we must check. */
2898 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2902 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2906 it
->ignore_overlay_strings_at_pos_p
= 1;
2907 it
->string_from_display_prop_p
= 0;
2908 handle_overlay_change_p
= 0;
2910 handled
= HANDLED_RECOMPUTE_PROPS
;
2913 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2914 handle_overlay_change_p
= 0;
2917 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2919 /* Don't check for overlay strings below when set to deliver
2920 characters from a display vector. */
2921 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2922 handle_overlay_change_p
= 0;
2924 /* Handle overlay changes.
2925 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2926 if it finds overlays. */
2927 if (handle_overlay_change_p
)
2928 handled
= handle_overlay_change (it
);
2933 setup_for_ellipsis (it
, 0);
2937 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2939 /* Determine where to stop next. */
2940 if (handled
== HANDLED_NORMALLY
)
2941 compute_stop_pos (it
);
2945 /* Compute IT->stop_charpos from text property and overlay change
2946 information for IT's current position. */
2949 compute_stop_pos (struct it
*it
)
2951 register INTERVAL iv
, next_iv
;
2952 Lisp_Object object
, limit
, position
;
2953 EMACS_INT charpos
, bytepos
;
2955 /* If nowhere else, stop at the end. */
2956 it
->stop_charpos
= it
->end_charpos
;
2958 if (STRINGP (it
->string
))
2960 /* Strings are usually short, so don't limit the search for
2962 object
= it
->string
;
2964 charpos
= IT_STRING_CHARPOS (*it
);
2965 bytepos
= IT_STRING_BYTEPOS (*it
);
2971 /* If next overlay change is in front of the current stop pos
2972 (which is IT->end_charpos), stop there. Note: value of
2973 next_overlay_change is point-max if no overlay change
2975 charpos
= IT_CHARPOS (*it
);
2976 bytepos
= IT_BYTEPOS (*it
);
2977 pos
= next_overlay_change (charpos
);
2978 if (pos
< it
->stop_charpos
)
2979 it
->stop_charpos
= pos
;
2981 /* If showing the region, we have to stop at the region
2982 start or end because the face might change there. */
2983 if (it
->region_beg_charpos
> 0)
2985 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2986 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2987 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2988 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
2991 /* Set up variables for computing the stop position from text
2992 property changes. */
2993 XSETBUFFER (object
, current_buffer
);
2994 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
2997 /* Get the interval containing IT's position. Value is a null
2998 interval if there isn't such an interval. */
2999 position
= make_number (charpos
);
3000 iv
= validate_interval_range (object
, &position
, &position
, 0);
3001 if (!NULL_INTERVAL_P (iv
))
3003 Lisp_Object values_here
[LAST_PROP_IDX
];
3006 /* Get properties here. */
3007 for (p
= it_props
; p
->handler
; ++p
)
3008 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3010 /* Look for an interval following iv that has different
3012 for (next_iv
= next_interval (iv
);
3013 (!NULL_INTERVAL_P (next_iv
)
3015 || XFASTINT (limit
) > next_iv
->position
));
3016 next_iv
= next_interval (next_iv
))
3018 for (p
= it_props
; p
->handler
; ++p
)
3020 Lisp_Object new_value
;
3022 new_value
= textget (next_iv
->plist
, *p
->name
);
3023 if (!EQ (values_here
[p
->idx
], new_value
))
3031 if (!NULL_INTERVAL_P (next_iv
))
3033 if (INTEGERP (limit
)
3034 && next_iv
->position
>= XFASTINT (limit
))
3035 /* No text property change up to limit. */
3036 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3038 /* Text properties change in next_iv. */
3039 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3043 if (it
->cmp_it
.id
< 0)
3045 EMACS_INT stoppos
= it
->end_charpos
;
3047 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3049 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3050 stoppos
, it
->string
);
3053 xassert (STRINGP (it
->string
)
3054 || (it
->stop_charpos
>= BEGV
3055 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3059 /* Return the position of the next overlay change after POS in
3060 current_buffer. Value is point-max if no overlay change
3061 follows. This is like `next-overlay-change' but doesn't use
3065 next_overlay_change (EMACS_INT pos
)
3069 Lisp_Object
*overlays
;
3072 /* Get all overlays at the given position. */
3073 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3075 /* If any of these overlays ends before endpos,
3076 use its ending point instead. */
3077 for (i
= 0; i
< noverlays
; ++i
)
3082 oend
= OVERLAY_END (overlays
[i
]);
3083 oendpos
= OVERLAY_POSITION (oend
);
3084 endpos
= min (endpos
, oendpos
);
3090 /* Return the character position of a display string at or after CHARPOS.
3091 If no display string exists at or after CHARPOS, return ZV. A
3092 display string is either an overlay with `display' property whose
3093 value is a string, or a `display' text property whose value is a
3094 string. FRAME_WINDOW_P is non-zero when we are displaying a window
3097 compute_display_string_pos (EMACS_INT charpos
, int frame_window_p
)
3099 /* FIXME: Support display properties on strings (object = Qnil means
3101 Lisp_Object object
= Qnil
;
3102 Lisp_Object pos
, spec
;
3103 struct text_pos position
;
3109 /* If the character at CHARPOS is where the display string begins,
3111 pos
= make_number (charpos
);
3112 CHARPOS (position
) = charpos
;
3113 BYTEPOS (position
) = CHAR_TO_BYTE (charpos
);
3114 bufpos
= charpos
; /* FIXME! support strings as well */
3115 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3117 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3120 && handle_display_spec (NULL
, spec
, object
, Qnil
, &position
, bufpos
,
3124 /* Look forward for the first character with a `display' property
3125 that will replace the underlying text when displayed. */
3127 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3128 CHARPOS (position
) = XFASTINT (pos
);
3129 BYTEPOS (position
) = CHAR_TO_BYTE (CHARPOS (position
));
3130 if (CHARPOS (position
) >= ZV
)
3132 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3133 bufpos
= CHARPOS (position
); /* FIXME! support strings as well */
3134 } while (NILP (spec
)
3135 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &position
, bufpos
,
3138 return CHARPOS (position
);
3141 /* Return the character position of the end of the display string that
3142 started at CHARPOS. A display string is either an overlay with
3143 `display' property whose value is a string or a `display' text
3144 property whose value is a string. */
3146 compute_display_string_end (EMACS_INT charpos
)
3148 /* FIXME: Support display properties on strings (object = Qnil means
3150 Lisp_Object object
= Qnil
;
3151 Lisp_Object pos
= make_number (charpos
);
3156 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3159 /* Look forward for the first character where the `display' property
3161 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3163 return XFASTINT (pos
);
3168 /***********************************************************************
3170 ***********************************************************************/
3172 /* Handle changes in the `fontified' property of the current buffer by
3173 calling hook functions from Qfontification_functions to fontify
3176 static enum prop_handled
3177 handle_fontified_prop (struct it
*it
)
3179 Lisp_Object prop
, pos
;
3180 enum prop_handled handled
= HANDLED_NORMALLY
;
3182 if (!NILP (Vmemory_full
))
3185 /* Get the value of the `fontified' property at IT's current buffer
3186 position. (The `fontified' property doesn't have a special
3187 meaning in strings.) If the value is nil, call functions from
3188 Qfontification_functions. */
3189 if (!STRINGP (it
->string
)
3191 && !NILP (Vfontification_functions
)
3192 && !NILP (Vrun_hooks
)
3193 && (pos
= make_number (IT_CHARPOS (*it
)),
3194 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3195 /* Ignore the special cased nil value always present at EOB since
3196 no amount of fontifying will be able to change it. */
3197 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3199 int count
= SPECPDL_INDEX ();
3201 struct buffer
*obuf
= current_buffer
;
3202 int begv
= BEGV
, zv
= ZV
;
3203 int old_clip_changed
= current_buffer
->clip_changed
;
3205 val
= Vfontification_functions
;
3206 specbind (Qfontification_functions
, Qnil
);
3208 xassert (it
->end_charpos
== ZV
);
3210 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3211 safe_call1 (val
, pos
);
3214 Lisp_Object fns
, fn
;
3215 struct gcpro gcpro1
, gcpro2
;
3220 for (; CONSP (val
); val
= XCDR (val
))
3226 /* A value of t indicates this hook has a local
3227 binding; it means to run the global binding too.
3228 In a global value, t should not occur. If it
3229 does, we must ignore it to avoid an endless
3231 for (fns
= Fdefault_value (Qfontification_functions
);
3237 safe_call1 (fn
, pos
);
3241 safe_call1 (fn
, pos
);
3247 unbind_to (count
, Qnil
);
3249 /* Fontification functions routinely call `save-restriction'.
3250 Normally, this tags clip_changed, which can confuse redisplay
3251 (see discussion in Bug#6671). Since we don't perform any
3252 special handling of fontification changes in the case where
3253 `save-restriction' isn't called, there's no point doing so in
3254 this case either. So, if the buffer's restrictions are
3255 actually left unchanged, reset clip_changed. */
3256 if (obuf
== current_buffer
)
3258 if (begv
== BEGV
&& zv
== ZV
)
3259 current_buffer
->clip_changed
= old_clip_changed
;
3261 /* There isn't much we can reasonably do to protect against
3262 misbehaving fontification, but here's a fig leaf. */
3263 else if (!NILP (BVAR (obuf
, name
)))
3264 set_buffer_internal_1 (obuf
);
3266 /* The fontification code may have added/removed text.
3267 It could do even a lot worse, but let's at least protect against
3268 the most obvious case where only the text past `pos' gets changed',
3269 as is/was done in grep.el where some escapes sequences are turned
3270 into face properties (bug#7876). */
3271 it
->end_charpos
= ZV
;
3273 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3274 something. This avoids an endless loop if they failed to
3275 fontify the text for which reason ever. */
3276 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3277 handled
= HANDLED_RECOMPUTE_PROPS
;
3285 /***********************************************************************
3287 ***********************************************************************/
3289 /* Set up iterator IT from face properties at its current position.
3290 Called from handle_stop. */
3292 static enum prop_handled
3293 handle_face_prop (struct it
*it
)
3296 EMACS_INT next_stop
;
3298 if (!STRINGP (it
->string
))
3301 = face_at_buffer_position (it
->w
,
3303 it
->region_beg_charpos
,
3304 it
->region_end_charpos
,
3307 + TEXT_PROP_DISTANCE_LIMIT
),
3308 0, it
->base_face_id
);
3310 /* Is this a start of a run of characters with box face?
3311 Caveat: this can be called for a freshly initialized
3312 iterator; face_id is -1 in this case. We know that the new
3313 face will not change until limit, i.e. if the new face has a
3314 box, all characters up to limit will have one. But, as
3315 usual, we don't know whether limit is really the end. */
3316 if (new_face_id
!= it
->face_id
)
3318 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3320 /* If new face has a box but old face has not, this is
3321 the start of a run of characters with box, i.e. it has
3322 a shadow on the left side. The value of face_id of the
3323 iterator will be -1 if this is the initial call that gets
3324 the face. In this case, we have to look in front of IT's
3325 position and see whether there is a face != new_face_id. */
3326 it
->start_of_box_run_p
3327 = (new_face
->box
!= FACE_NO_BOX
3328 && (it
->face_id
>= 0
3329 || IT_CHARPOS (*it
) == BEG
3330 || new_face_id
!= face_before_it_pos (it
)));
3331 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3339 Lisp_Object from_overlay
3340 = (it
->current
.overlay_string_index
>= 0
3341 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3344 /* See if we got to this string directly or indirectly from
3345 an overlay property. That includes the before-string or
3346 after-string of an overlay, strings in display properties
3347 provided by an overlay, their text properties, etc.
3349 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3350 if (! NILP (from_overlay
))
3351 for (i
= it
->sp
- 1; i
>= 0; i
--)
3353 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3355 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3356 else if (! NILP (it
->stack
[i
].from_overlay
))
3357 from_overlay
= it
->stack
[i
].from_overlay
;
3359 if (!NILP (from_overlay
))
3363 if (! NILP (from_overlay
))
3365 bufpos
= IT_CHARPOS (*it
);
3366 /* For a string from an overlay, the base face depends
3367 only on text properties and ignores overlays. */
3369 = face_for_overlay_string (it
->w
,
3371 it
->region_beg_charpos
,
3372 it
->region_end_charpos
,
3375 + TEXT_PROP_DISTANCE_LIMIT
),
3383 /* For strings from a `display' property, use the face at
3384 IT's current buffer position as the base face to merge
3385 with, so that overlay strings appear in the same face as
3386 surrounding text, unless they specify their own
3388 base_face_id
= underlying_face_id (it
);
3391 new_face_id
= face_at_string_position (it
->w
,
3393 IT_STRING_CHARPOS (*it
),
3395 it
->region_beg_charpos
,
3396 it
->region_end_charpos
,
3400 /* Is this a start of a run of characters with box? Caveat:
3401 this can be called for a freshly allocated iterator; face_id
3402 is -1 is this case. We know that the new face will not
3403 change until the next check pos, i.e. if the new face has a
3404 box, all characters up to that position will have a
3405 box. But, as usual, we don't know whether that position
3406 is really the end. */
3407 if (new_face_id
!= it
->face_id
)
3409 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3410 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3412 /* If new face has a box but old face hasn't, this is the
3413 start of a run of characters with box, i.e. it has a
3414 shadow on the left side. */
3415 it
->start_of_box_run_p
3416 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3417 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3421 it
->face_id
= new_face_id
;
3422 return HANDLED_NORMALLY
;
3426 /* Return the ID of the face ``underlying'' IT's current position,
3427 which is in a string. If the iterator is associated with a
3428 buffer, return the face at IT's current buffer position.
3429 Otherwise, use the iterator's base_face_id. */
3432 underlying_face_id (struct it
*it
)
3434 int face_id
= it
->base_face_id
, i
;
3436 xassert (STRINGP (it
->string
));
3438 for (i
= it
->sp
- 1; i
>= 0; --i
)
3439 if (NILP (it
->stack
[i
].string
))
3440 face_id
= it
->stack
[i
].face_id
;
3446 /* Compute the face one character before or after the current position
3447 of IT. BEFORE_P non-zero means get the face in front of IT's
3448 position. Value is the id of the face. */
3451 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3454 EMACS_INT next_check_charpos
;
3455 struct text_pos pos
;
3457 xassert (it
->s
== NULL
);
3459 if (STRINGP (it
->string
))
3464 /* No face change past the end of the string (for the case
3465 we are padding with spaces). No face change before the
3467 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3468 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3471 /* Set pos to the position before or after IT's current position. */
3473 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3475 /* For composition, we must check the character after the
3477 pos
= (it
->what
== IT_COMPOSITION
3478 ? string_pos (IT_STRING_CHARPOS (*it
)
3479 + it
->cmp_it
.nchars
, it
->string
)
3480 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3482 if (it
->current
.overlay_string_index
>= 0)
3483 bufpos
= IT_CHARPOS (*it
);
3487 base_face_id
= underlying_face_id (it
);
3489 /* Get the face for ASCII, or unibyte. */
3490 face_id
= face_at_string_position (it
->w
,
3494 it
->region_beg_charpos
,
3495 it
->region_end_charpos
,
3496 &next_check_charpos
,
3499 /* Correct the face for charsets different from ASCII. Do it
3500 for the multibyte case only. The face returned above is
3501 suitable for unibyte text if IT->string is unibyte. */
3502 if (STRING_MULTIBYTE (it
->string
))
3504 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3506 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3508 c
= string_char_and_length (p
, &len
);
3509 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3514 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3515 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3518 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3519 pos
= it
->current
.pos
;
3522 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3525 if (it
->what
== IT_COMPOSITION
)
3526 /* For composition, we must check the position after the
3528 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3530 INC_TEXT_POS (pos
, it
->multibyte_p
);
3533 /* Determine face for CHARSET_ASCII, or unibyte. */
3534 face_id
= face_at_buffer_position (it
->w
,
3536 it
->region_beg_charpos
,
3537 it
->region_end_charpos
,
3538 &next_check_charpos
,
3541 /* Correct the face for charsets different from ASCII. Do it
3542 for the multibyte case only. The face returned above is
3543 suitable for unibyte text if current_buffer is unibyte. */
3544 if (it
->multibyte_p
)
3546 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3547 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3548 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3557 /***********************************************************************
3559 ***********************************************************************/
3561 /* Set up iterator IT from invisible properties at its current
3562 position. Called from handle_stop. */
3564 static enum prop_handled
3565 handle_invisible_prop (struct it
*it
)
3567 enum prop_handled handled
= HANDLED_NORMALLY
;
3569 if (STRINGP (it
->string
))
3571 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3573 /* Get the value of the invisible text property at the
3574 current position. Value will be nil if there is no such
3576 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3577 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3580 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3582 handled
= HANDLED_RECOMPUTE_PROPS
;
3584 /* Get the position at which the next change of the
3585 invisible text property can be found in IT->string.
3586 Value will be nil if the property value is the same for
3587 all the rest of IT->string. */
3588 XSETINT (limit
, SCHARS (it
->string
));
3589 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3592 /* Text at current position is invisible. The next
3593 change in the property is at position end_charpos.
3594 Move IT's current position to that position. */
3595 if (INTEGERP (end_charpos
)
3596 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3598 struct text_pos old
;
3599 old
= it
->current
.string_pos
;
3600 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3601 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3605 /* The rest of the string is invisible. If this is an
3606 overlay string, proceed with the next overlay string
3607 or whatever comes and return a character from there. */
3608 if (it
->current
.overlay_string_index
>= 0)
3610 next_overlay_string (it
);
3611 /* Don't check for overlay strings when we just
3612 finished processing them. */
3613 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3617 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3618 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3626 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3627 Lisp_Object pos
, prop
, overlay
;
3629 /* First of all, is there invisible text at this position? */
3630 tem
= start_charpos
= IT_CHARPOS (*it
);
3631 pos
= make_number (tem
);
3632 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3634 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3636 /* If we are on invisible text, skip over it. */
3637 if (invis_p
&& start_charpos
< it
->end_charpos
)
3639 /* Record whether we have to display an ellipsis for the
3641 int display_ellipsis_p
= invis_p
== 2;
3643 handled
= HANDLED_RECOMPUTE_PROPS
;
3645 /* Loop skipping over invisible text. The loop is left at
3646 ZV or with IT on the first char being visible again. */
3649 /* Try to skip some invisible text. Return value is the
3650 position reached which can be equal to where we start
3651 if there is nothing invisible there. This skips both
3652 over invisible text properties and overlays with
3653 invisible property. */
3654 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3656 /* If we skipped nothing at all we weren't at invisible
3657 text in the first place. If everything to the end of
3658 the buffer was skipped, end the loop. */
3659 if (newpos
== tem
|| newpos
>= ZV
)
3663 /* We skipped some characters but not necessarily
3664 all there are. Check if we ended up on visible
3665 text. Fget_char_property returns the property of
3666 the char before the given position, i.e. if we
3667 get invis_p = 0, this means that the char at
3668 newpos is visible. */
3669 pos
= make_number (newpos
);
3670 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3671 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3674 /* If we ended up on invisible text, proceed to
3675 skip starting with next_stop. */
3679 /* If there are adjacent invisible texts, don't lose the
3680 second one's ellipsis. */
3682 display_ellipsis_p
= 1;
3686 /* The position newpos is now either ZV or on visible text. */
3687 if (it
->bidi_p
&& newpos
< ZV
)
3689 /* With bidi iteration, the region of invisible text
3690 could start and/or end in the middle of a non-base
3691 embedding level. Therefore, we need to skip
3692 invisible text using the bidi iterator, starting at
3693 IT's current position, until we find ourselves
3694 outside the invisible text. Skipping invisible text
3695 _after_ bidi iteration avoids affecting the visual
3696 order of the displayed text when invisible properties
3697 are added or removed. */
3698 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3700 /* If we were `reseat'ed to a new paragraph,
3701 determine the paragraph base direction. We need
3702 to do it now because next_element_from_buffer may
3703 not have a chance to do it, if we are going to
3704 skip any text at the beginning, which resets the
3706 bidi_paragraph_init (it
->paragraph_embedding
,
3711 bidi_move_to_visually_next (&it
->bidi_it
);
3713 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3714 && it
->bidi_it
.charpos
< newpos
);
3715 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3716 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3717 /* If we overstepped NEWPOS, record its position in the
3718 iterator, so that we skip invisible text if later the
3719 bidi iteration lands us in the invisible region
3721 if (IT_CHARPOS (*it
) >= newpos
)
3722 it
->prev_stop
= newpos
;
3726 IT_CHARPOS (*it
) = newpos
;
3727 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3730 /* If there are before-strings at the start of invisible
3731 text, and the text is invisible because of a text
3732 property, arrange to show before-strings because 20.x did
3733 it that way. (If the text is invisible because of an
3734 overlay property instead of a text property, this is
3735 already handled in the overlay code.) */
3737 && get_overlay_strings (it
, it
->stop_charpos
))
3739 handled
= HANDLED_RECOMPUTE_PROPS
;
3740 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3742 else if (display_ellipsis_p
)
3744 /* Make sure that the glyphs of the ellipsis will get
3745 correct `charpos' values. If we would not update
3746 it->position here, the glyphs would belong to the
3747 last visible character _before_ the invisible
3748 text, which confuses `set_cursor_from_row'.
3750 We use the last invisible position instead of the
3751 first because this way the cursor is always drawn on
3752 the first "." of the ellipsis, whenever PT is inside
3753 the invisible text. Otherwise the cursor would be
3754 placed _after_ the ellipsis when the point is after the
3755 first invisible character. */
3756 if (!STRINGP (it
->object
))
3758 it
->position
.charpos
= newpos
- 1;
3759 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3762 /* Let the ellipsis display before
3763 considering any properties of the following char.
3764 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3765 handled
= HANDLED_RETURN
;
3774 /* Make iterator IT return `...' next.
3775 Replaces LEN characters from buffer. */
3778 setup_for_ellipsis (struct it
*it
, int len
)
3780 /* Use the display table definition for `...'. Invalid glyphs
3781 will be handled by the method returning elements from dpvec. */
3782 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3784 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3785 it
->dpvec
= v
->contents
;
3786 it
->dpend
= v
->contents
+ v
->header
.size
;
3790 /* Default `...'. */
3791 it
->dpvec
= default_invis_vector
;
3792 it
->dpend
= default_invis_vector
+ 3;
3795 it
->dpvec_char_len
= len
;
3796 it
->current
.dpvec_index
= 0;
3797 it
->dpvec_face_id
= -1;
3799 /* Remember the current face id in case glyphs specify faces.
3800 IT's face is restored in set_iterator_to_next.
3801 saved_face_id was set to preceding char's face in handle_stop. */
3802 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3803 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3805 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3811 /***********************************************************************
3813 ***********************************************************************/
3815 /* Set up iterator IT from `display' property at its current position.
3816 Called from handle_stop.
3817 We return HANDLED_RETURN if some part of the display property
3818 overrides the display of the buffer text itself.
3819 Otherwise we return HANDLED_NORMALLY. */
3821 static enum prop_handled
3822 handle_display_prop (struct it
*it
)
3824 Lisp_Object propval
, object
, overlay
;
3825 struct text_pos
*position
;
3827 /* Nonzero if some property replaces the display of the text itself. */
3828 int display_replaced_p
= 0;
3830 if (STRINGP (it
->string
))
3832 object
= it
->string
;
3833 position
= &it
->current
.string_pos
;
3834 bufpos
= CHARPOS (it
->current
.pos
);
3838 XSETWINDOW (object
, it
->w
);
3839 position
= &it
->current
.pos
;
3840 bufpos
= CHARPOS (*position
);
3843 /* Reset those iterator values set from display property values. */
3844 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3845 it
->space_width
= Qnil
;
3846 it
->font_height
= Qnil
;
3849 /* We don't support recursive `display' properties, i.e. string
3850 values that have a string `display' property, that have a string
3851 `display' property etc. */
3852 if (!it
->string_from_display_prop_p
)
3853 it
->area
= TEXT_AREA
;
3855 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
3856 Qdisplay
, object
, &overlay
);
3858 return HANDLED_NORMALLY
;
3859 /* Now OVERLAY is the overlay that gave us this property, or nil
3860 if it was a text property. */
3862 if (!STRINGP (it
->string
))
3863 object
= it
->w
->buffer
;
3865 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
3867 FRAME_WINDOW_P (it
->f
));
3869 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3872 /* Subroutine of handle_display_prop. Returns non-zero if the display
3873 specification in SPEC is a replacing specification, i.e. it would
3874 replace the text covered by `display' property with something else,
3875 such as an image or a display string.
3877 See handle_single_display_spec for documentation of arguments.
3878 frame_window_p is non-zero if the window being redisplayed is on a
3879 GUI frame; this argument is used only if IT is NULL, see below.
3881 IT can be NULL, if this is called by the bidi reordering code
3882 through compute_display_string_pos, which see. In that case, this
3883 function only examines SPEC, but does not otherwise "handle" it, in
3884 the sense that it doesn't set up members of IT from the display
3887 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3888 Lisp_Object overlay
, struct text_pos
*position
,
3889 EMACS_INT bufpos
, int frame_window_p
)
3891 int replacing_p
= 0;
3894 /* Simple specerties. */
3895 && !EQ (XCAR (spec
), Qimage
)
3896 && !EQ (XCAR (spec
), Qspace
)
3897 && !EQ (XCAR (spec
), Qwhen
)
3898 && !EQ (XCAR (spec
), Qslice
)
3899 && !EQ (XCAR (spec
), Qspace_width
)
3900 && !EQ (XCAR (spec
), Qheight
)
3901 && !EQ (XCAR (spec
), Qraise
)
3902 /* Marginal area specifications. */
3903 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
3904 && !EQ (XCAR (spec
), Qleft_fringe
)
3905 && !EQ (XCAR (spec
), Qright_fringe
)
3906 && !NILP (XCAR (spec
)))
3908 for (; CONSP (spec
); spec
= XCDR (spec
))
3910 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
3911 position
, bufpos
, replacing_p
,
3915 /* If some text in a string is replaced, `position' no
3916 longer points to the position of `object'. */
3917 if (!it
|| STRINGP (object
))
3922 else if (VECTORP (spec
))
3925 for (i
= 0; i
< ASIZE (spec
); ++i
)
3926 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
3927 position
, bufpos
, replacing_p
,
3931 /* If some text in a string is replaced, `position' no
3932 longer points to the position of `object'. */
3933 if (!it
|| STRINGP (object
))
3939 if (handle_single_display_spec (it
, spec
, object
, overlay
,
3940 position
, bufpos
, 0, frame_window_p
))
3947 /* Value is the position of the end of the `display' property starting
3948 at START_POS in OBJECT. */
3950 static struct text_pos
3951 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3954 struct text_pos end_pos
;
3956 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3957 Qdisplay
, object
, Qnil
);
3958 CHARPOS (end_pos
) = XFASTINT (end
);
3959 if (STRINGP (object
))
3960 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3962 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3968 /* Set up IT from a single `display' property specification SPEC. OBJECT
3969 is the object in which the `display' property was found. *POSITION
3970 is the position in OBJECT at which the `display' property was found.
3971 BUFPOS is the buffer position of OBJECT (different from POSITION if
3972 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
3973 previously saw a display specification which already replaced text
3974 display with something else, for example an image; we ignore such
3975 properties after the first one has been processed.
3977 OVERLAY is the overlay this `display' property came from,
3978 or nil if it was a text property.
3980 If SPEC is a `space' or `image' specification, and in some other
3981 cases too, set *POSITION to the position where the `display'
3984 If IT is NULL, only examine the property specification in SPEC, but
3985 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
3986 is intended to be displayed in a window on a GUI frame.
3988 Value is non-zero if something was found which replaces the display
3989 of buffer or string text. */
3992 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3993 Lisp_Object overlay
, struct text_pos
*position
,
3994 EMACS_INT bufpos
, int display_replaced_p
,
3998 Lisp_Object location
, value
;
3999 struct text_pos start_pos
= *position
;
4002 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4003 If the result is non-nil, use VALUE instead of SPEC. */
4005 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4014 if (!NILP (form
) && !EQ (form
, Qt
))
4016 int count
= SPECPDL_INDEX ();
4017 struct gcpro gcpro1
;
4019 /* Bind `object' to the object having the `display' property, a
4020 buffer or string. Bind `position' to the position in the
4021 object where the property was found, and `buffer-position'
4022 to the current position in the buffer. */
4025 XSETBUFFER (object
, current_buffer
);
4026 specbind (Qobject
, object
);
4027 specbind (Qposition
, make_number (CHARPOS (*position
)));
4028 specbind (Qbuffer_position
, make_number (bufpos
));
4030 form
= safe_eval (form
);
4032 unbind_to (count
, Qnil
);
4038 /* Handle `(height HEIGHT)' specifications. */
4040 && EQ (XCAR (spec
), Qheight
)
4041 && CONSP (XCDR (spec
)))
4045 if (!FRAME_WINDOW_P (it
->f
))
4048 it
->font_height
= XCAR (XCDR (spec
));
4049 if (!NILP (it
->font_height
))
4051 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4052 int new_height
= -1;
4054 if (CONSP (it
->font_height
)
4055 && (EQ (XCAR (it
->font_height
), Qplus
)
4056 || EQ (XCAR (it
->font_height
), Qminus
))
4057 && CONSP (XCDR (it
->font_height
))
4058 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4060 /* `(+ N)' or `(- N)' where N is an integer. */
4061 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4062 if (EQ (XCAR (it
->font_height
), Qplus
))
4064 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4066 else if (FUNCTIONP (it
->font_height
))
4068 /* Call function with current height as argument.
4069 Value is the new height. */
4071 height
= safe_call1 (it
->font_height
,
4072 face
->lface
[LFACE_HEIGHT_INDEX
]);
4073 if (NUMBERP (height
))
4074 new_height
= XFLOATINT (height
);
4076 else if (NUMBERP (it
->font_height
))
4078 /* Value is a multiple of the canonical char height. */
4081 f
= FACE_FROM_ID (it
->f
,
4082 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4083 new_height
= (XFLOATINT (it
->font_height
)
4084 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4088 /* Evaluate IT->font_height with `height' bound to the
4089 current specified height to get the new height. */
4090 int count
= SPECPDL_INDEX ();
4092 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4093 value
= safe_eval (it
->font_height
);
4094 unbind_to (count
, Qnil
);
4096 if (NUMBERP (value
))
4097 new_height
= XFLOATINT (value
);
4101 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4108 /* Handle `(space-width WIDTH)'. */
4110 && EQ (XCAR (spec
), Qspace_width
)
4111 && CONSP (XCDR (spec
)))
4115 if (!FRAME_WINDOW_P (it
->f
))
4118 value
= XCAR (XCDR (spec
));
4119 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4120 it
->space_width
= value
;
4126 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4128 && EQ (XCAR (spec
), Qslice
))
4134 if (!FRAME_WINDOW_P (it
->f
))
4137 if (tem
= XCDR (spec
), CONSP (tem
))
4139 it
->slice
.x
= XCAR (tem
);
4140 if (tem
= XCDR (tem
), CONSP (tem
))
4142 it
->slice
.y
= XCAR (tem
);
4143 if (tem
= XCDR (tem
), CONSP (tem
))
4145 it
->slice
.width
= XCAR (tem
);
4146 if (tem
= XCDR (tem
), CONSP (tem
))
4147 it
->slice
.height
= XCAR (tem
);
4156 /* Handle `(raise FACTOR)'. */
4158 && EQ (XCAR (spec
), Qraise
)
4159 && CONSP (XCDR (spec
)))
4163 if (!FRAME_WINDOW_P (it
->f
))
4166 #ifdef HAVE_WINDOW_SYSTEM
4167 value
= XCAR (XCDR (spec
));
4168 if (NUMBERP (value
))
4170 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4171 it
->voffset
= - (XFLOATINT (value
)
4172 * (FONT_HEIGHT (face
->font
)));
4174 #endif /* HAVE_WINDOW_SYSTEM */
4180 /* Don't handle the other kinds of display specifications
4181 inside a string that we got from a `display' property. */
4182 if (it
&& it
->string_from_display_prop_p
)
4185 /* Characters having this form of property are not displayed, so
4186 we have to find the end of the property. */
4189 start_pos
= *position
;
4190 *position
= display_prop_end (it
, object
, start_pos
);
4194 /* Stop the scan at that end position--we assume that all
4195 text properties change there. */
4197 it
->stop_charpos
= position
->charpos
;
4199 /* Handle `(left-fringe BITMAP [FACE])'
4200 and `(right-fringe BITMAP [FACE])'. */
4202 && (EQ (XCAR (spec
), Qleft_fringe
)
4203 || EQ (XCAR (spec
), Qright_fringe
))
4204 && CONSP (XCDR (spec
)))
4210 if (!FRAME_WINDOW_P (it
->f
))
4211 /* If we return here, POSITION has been advanced
4212 across the text with this property. */
4215 else if (!frame_window_p
)
4218 #ifdef HAVE_WINDOW_SYSTEM
4219 value
= XCAR (XCDR (spec
));
4220 if (!SYMBOLP (value
)
4221 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4222 /* If we return here, POSITION has been advanced
4223 across the text with this property. */
4228 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4230 if (CONSP (XCDR (XCDR (spec
))))
4232 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4233 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4239 /* Save current settings of IT so that we can restore them
4240 when we are finished with the glyph property value. */
4241 push_it (it
, position
);
4243 it
->area
= TEXT_AREA
;
4244 it
->what
= IT_IMAGE
;
4245 it
->image_id
= -1; /* no image */
4246 it
->position
= start_pos
;
4247 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4248 it
->method
= GET_FROM_IMAGE
;
4249 it
->from_overlay
= Qnil
;
4250 it
->face_id
= face_id
;
4252 /* Say that we haven't consumed the characters with
4253 `display' property yet. The call to pop_it in
4254 set_iterator_to_next will clean this up. */
4255 *position
= start_pos
;
4257 if (EQ (XCAR (spec
), Qleft_fringe
))
4259 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4260 it
->left_user_fringe_face_id
= face_id
;
4264 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4265 it
->right_user_fringe_face_id
= face_id
;
4268 #endif /* HAVE_WINDOW_SYSTEM */
4272 /* Prepare to handle `((margin left-margin) ...)',
4273 `((margin right-margin) ...)' and `((margin nil) ...)'
4274 prefixes for display specifications. */
4275 location
= Qunbound
;
4276 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4280 value
= XCDR (spec
);
4282 value
= XCAR (value
);
4285 if (EQ (XCAR (tem
), Qmargin
)
4286 && (tem
= XCDR (tem
),
4287 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4289 || EQ (tem
, Qleft_margin
)
4290 || EQ (tem
, Qright_margin
))))
4294 if (EQ (location
, Qunbound
))
4300 /* After this point, VALUE is the property after any
4301 margin prefix has been stripped. It must be a string,
4302 an image specification, or `(space ...)'.
4304 LOCATION specifies where to display: `left-margin',
4305 `right-margin' or nil. */
4307 valid_p
= (STRINGP (value
)
4308 #ifdef HAVE_WINDOW_SYSTEM
4309 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4310 && valid_image_p (value
))
4311 #endif /* not HAVE_WINDOW_SYSTEM */
4312 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4314 if (valid_p
&& !display_replaced_p
)
4319 /* Save current settings of IT so that we can restore them
4320 when we are finished with the glyph property value. */
4321 push_it (it
, position
);
4322 it
->from_overlay
= overlay
;
4324 if (NILP (location
))
4325 it
->area
= TEXT_AREA
;
4326 else if (EQ (location
, Qleft_margin
))
4327 it
->area
= LEFT_MARGIN_AREA
;
4329 it
->area
= RIGHT_MARGIN_AREA
;
4331 if (STRINGP (value
))
4334 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4335 it
->current
.overlay_string_index
= -1;
4336 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4337 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4338 it
->method
= GET_FROM_STRING
;
4339 it
->stop_charpos
= 0;
4340 it
->string_from_display_prop_p
= 1;
4341 /* Say that we haven't consumed the characters with
4342 `display' property yet. The call to pop_it in
4343 set_iterator_to_next will clean this up. */
4344 if (BUFFERP (object
))
4345 *position
= start_pos
;
4347 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4349 it
->method
= GET_FROM_STRETCH
;
4351 *position
= it
->position
= start_pos
;
4353 #ifdef HAVE_WINDOW_SYSTEM
4356 it
->what
= IT_IMAGE
;
4357 it
->image_id
= lookup_image (it
->f
, value
);
4358 it
->position
= start_pos
;
4359 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4360 it
->method
= GET_FROM_IMAGE
;
4362 /* Say that we haven't consumed the characters with
4363 `display' property yet. The call to pop_it in
4364 set_iterator_to_next will clean this up. */
4365 *position
= start_pos
;
4367 #endif /* HAVE_WINDOW_SYSTEM */
4372 /* Invalid property or property not supported. Restore
4373 POSITION to what it was before. */
4374 *position
= start_pos
;
4378 /* Check if PROP is a display property value whose text should be
4379 treated as intangible. OVERLAY is the overlay from which PROP
4380 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4381 specify the buffer position covered by PROP. */
4384 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4385 EMACS_INT charpos
, EMACS_INT bytepos
)
4387 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4388 struct text_pos position
;
4390 SET_TEXT_POS (position
, charpos
, bytepos
);
4391 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4392 &position
, charpos
, frame_window_p
);
4396 /* Return 1 if PROP is a display sub-property value containing STRING.
4398 Implementation note: this and the following function are really
4399 special cases of handle_display_spec and
4400 handle_single_display_spec, and should ideally use the same code.
4401 Until they do, these two pairs must be consistent and must be
4402 modified in sync. */
4405 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4407 if (EQ (string
, prop
))
4410 /* Skip over `when FORM'. */
4411 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4416 /* FIXME: We should eval the condition following `when', like
4417 handle_single_display_spec does, and retrun zero if it
4418 evaluates to nil. */
4423 /* Skip over `margin LOCATION'. */
4424 if (EQ (XCAR (prop
), Qmargin
))
4435 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4439 /* Return 1 if STRING appears in the `display' property PROP. */
4442 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4445 && !EQ (XCAR (prop
), Qwhen
)
4446 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4448 /* A list of sub-properties. */
4449 while (CONSP (prop
))
4451 if (single_display_spec_string_p (XCAR (prop
), string
))
4456 else if (VECTORP (prop
))
4458 /* A vector of sub-properties. */
4460 for (i
= 0; i
< ASIZE (prop
); ++i
)
4461 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4465 return single_display_spec_string_p (prop
, string
);
4470 /* Look for STRING in overlays and text properties in the current
4471 buffer, between character positions FROM and TO (excluding TO).
4472 BACK_P non-zero means look back (in this case, TO is supposed to be
4474 Value is the first character position where STRING was found, or
4475 zero if it wasn't found before hitting TO.
4477 This function may only use code that doesn't eval because it is
4478 called asynchronously from note_mouse_highlight. */
4481 string_buffer_position_lim (Lisp_Object string
,
4482 EMACS_INT from
, EMACS_INT to
, int back_p
)
4484 Lisp_Object limit
, prop
, pos
;
4487 pos
= make_number (from
);
4489 if (!back_p
) /* looking forward */
4491 limit
= make_number (min (to
, ZV
));
4492 while (!found
&& !EQ (pos
, limit
))
4494 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4495 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4498 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4502 else /* looking back */
4504 limit
= make_number (max (to
, BEGV
));
4505 while (!found
&& !EQ (pos
, limit
))
4507 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4508 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4511 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4516 return found
? XINT (pos
) : 0;
4519 /* Determine which buffer position in current buffer STRING comes from.
4520 AROUND_CHARPOS is an approximate position where it could come from.
4521 Value is the buffer position or 0 if it couldn't be determined.
4523 This function is necessary because we don't record buffer positions
4524 in glyphs generated from strings (to keep struct glyph small).
4525 This function may only use code that doesn't eval because it is
4526 called asynchronously from note_mouse_highlight. */
4529 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4531 const int MAX_DISTANCE
= 1000;
4532 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4533 around_charpos
+ MAX_DISTANCE
,
4537 found
= string_buffer_position_lim (string
, around_charpos
,
4538 around_charpos
- MAX_DISTANCE
, 1);
4544 /***********************************************************************
4545 `composition' property
4546 ***********************************************************************/
4548 /* Set up iterator IT from `composition' property at its current
4549 position. Called from handle_stop. */
4551 static enum prop_handled
4552 handle_composition_prop (struct it
*it
)
4554 Lisp_Object prop
, string
;
4555 EMACS_INT pos
, pos_byte
, start
, end
;
4557 if (STRINGP (it
->string
))
4561 pos
= IT_STRING_CHARPOS (*it
);
4562 pos_byte
= IT_STRING_BYTEPOS (*it
);
4563 string
= it
->string
;
4564 s
= SDATA (string
) + pos_byte
;
4565 it
->c
= STRING_CHAR (s
);
4569 pos
= IT_CHARPOS (*it
);
4570 pos_byte
= IT_BYTEPOS (*it
);
4572 it
->c
= FETCH_CHAR (pos_byte
);
4575 /* If there's a valid composition and point is not inside of the
4576 composition (in the case that the composition is from the current
4577 buffer), draw a glyph composed from the composition components. */
4578 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4579 && COMPOSITION_VALID_P (start
, end
, prop
)
4580 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4584 if (STRINGP (it
->string
))
4585 pos_byte
= string_char_to_byte (it
->string
, start
);
4587 pos_byte
= CHAR_TO_BYTE (start
);
4589 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4592 if (it
->cmp_it
.id
>= 0)
4595 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4596 it
->cmp_it
.nglyphs
= -1;
4600 return HANDLED_NORMALLY
;
4605 /***********************************************************************
4607 ***********************************************************************/
4609 /* The following structure is used to record overlay strings for
4610 later sorting in load_overlay_strings. */
4612 struct overlay_entry
4614 Lisp_Object overlay
;
4621 /* Set up iterator IT from overlay strings at its current position.
4622 Called from handle_stop. */
4624 static enum prop_handled
4625 handle_overlay_change (struct it
*it
)
4627 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4628 return HANDLED_RECOMPUTE_PROPS
;
4630 return HANDLED_NORMALLY
;
4634 /* Set up the next overlay string for delivery by IT, if there is an
4635 overlay string to deliver. Called by set_iterator_to_next when the
4636 end of the current overlay string is reached. If there are more
4637 overlay strings to display, IT->string and
4638 IT->current.overlay_string_index are set appropriately here.
4639 Otherwise IT->string is set to nil. */
4642 next_overlay_string (struct it
*it
)
4644 ++it
->current
.overlay_string_index
;
4645 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4647 /* No more overlay strings. Restore IT's settings to what
4648 they were before overlay strings were processed, and
4649 continue to deliver from current_buffer. */
4651 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4654 || (NILP (it
->string
)
4655 && it
->method
== GET_FROM_BUFFER
4656 && it
->stop_charpos
>= BEGV
4657 && it
->stop_charpos
<= it
->end_charpos
));
4658 it
->current
.overlay_string_index
= -1;
4659 it
->n_overlay_strings
= 0;
4660 it
->overlay_strings_charpos
= -1;
4662 /* If we're at the end of the buffer, record that we have
4663 processed the overlay strings there already, so that
4664 next_element_from_buffer doesn't try it again. */
4665 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4666 it
->overlay_strings_at_end_processed_p
= 1;
4670 /* There are more overlay strings to process. If
4671 IT->current.overlay_string_index has advanced to a position
4672 where we must load IT->overlay_strings with more strings, do
4673 it. We must load at the IT->overlay_strings_charpos where
4674 IT->n_overlay_strings was originally computed; when invisible
4675 text is present, this might not be IT_CHARPOS (Bug#7016). */
4676 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4678 if (it
->current
.overlay_string_index
&& i
== 0)
4679 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4681 /* Initialize IT to deliver display elements from the overlay
4683 it
->string
= it
->overlay_strings
[i
];
4684 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4685 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4686 it
->method
= GET_FROM_STRING
;
4687 it
->stop_charpos
= 0;
4688 if (it
->cmp_it
.stop_pos
>= 0)
4689 it
->cmp_it
.stop_pos
= 0;
4696 /* Compare two overlay_entry structures E1 and E2. Used as a
4697 comparison function for qsort in load_overlay_strings. Overlay
4698 strings for the same position are sorted so that
4700 1. All after-strings come in front of before-strings, except
4701 when they come from the same overlay.
4703 2. Within after-strings, strings are sorted so that overlay strings
4704 from overlays with higher priorities come first.
4706 2. Within before-strings, strings are sorted so that overlay
4707 strings from overlays with higher priorities come last.
4709 Value is analogous to strcmp. */
4713 compare_overlay_entries (const void *e1
, const void *e2
)
4715 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4716 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4719 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4721 /* Let after-strings appear in front of before-strings if
4722 they come from different overlays. */
4723 if (EQ (entry1
->overlay
, entry2
->overlay
))
4724 result
= entry1
->after_string_p
? 1 : -1;
4726 result
= entry1
->after_string_p
? -1 : 1;
4728 else if (entry1
->after_string_p
)
4729 /* After-strings sorted in order of decreasing priority. */
4730 result
= entry2
->priority
- entry1
->priority
;
4732 /* Before-strings sorted in order of increasing priority. */
4733 result
= entry1
->priority
- entry2
->priority
;
4739 /* Load the vector IT->overlay_strings with overlay strings from IT's
4740 current buffer position, or from CHARPOS if that is > 0. Set
4741 IT->n_overlays to the total number of overlay strings found.
4743 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4744 a time. On entry into load_overlay_strings,
4745 IT->current.overlay_string_index gives the number of overlay
4746 strings that have already been loaded by previous calls to this
4749 IT->add_overlay_start contains an additional overlay start
4750 position to consider for taking overlay strings from, if non-zero.
4751 This position comes into play when the overlay has an `invisible'
4752 property, and both before and after-strings. When we've skipped to
4753 the end of the overlay, because of its `invisible' property, we
4754 nevertheless want its before-string to appear.
4755 IT->add_overlay_start will contain the overlay start position
4758 Overlay strings are sorted so that after-string strings come in
4759 front of before-string strings. Within before and after-strings,
4760 strings are sorted by overlay priority. See also function
4761 compare_overlay_entries. */
4764 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4766 Lisp_Object overlay
, window
, str
, invisible
;
4767 struct Lisp_Overlay
*ov
;
4768 EMACS_INT start
, end
;
4770 int n
= 0, i
, j
, invis_p
;
4771 struct overlay_entry
*entries
4772 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4775 charpos
= IT_CHARPOS (*it
);
4777 /* Append the overlay string STRING of overlay OVERLAY to vector
4778 `entries' which has size `size' and currently contains `n'
4779 elements. AFTER_P non-zero means STRING is an after-string of
4781 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4784 Lisp_Object priority; \
4788 int new_size = 2 * size; \
4789 struct overlay_entry *old = entries; \
4791 (struct overlay_entry *) alloca (new_size \
4792 * sizeof *entries); \
4793 memcpy (entries, old, size * sizeof *entries); \
4797 entries[n].string = (STRING); \
4798 entries[n].overlay = (OVERLAY); \
4799 priority = Foverlay_get ((OVERLAY), Qpriority); \
4800 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4801 entries[n].after_string_p = (AFTER_P); \
4806 /* Process overlay before the overlay center. */
4807 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4809 XSETMISC (overlay
, ov
);
4810 xassert (OVERLAYP (overlay
));
4811 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4812 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4817 /* Skip this overlay if it doesn't start or end at IT's current
4819 if (end
!= charpos
&& start
!= charpos
)
4822 /* Skip this overlay if it doesn't apply to IT->w. */
4823 window
= Foverlay_get (overlay
, Qwindow
);
4824 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4827 /* If the text ``under'' the overlay is invisible, both before-
4828 and after-strings from this overlay are visible; start and
4829 end position are indistinguishable. */
4830 invisible
= Foverlay_get (overlay
, Qinvisible
);
4831 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4833 /* If overlay has a non-empty before-string, record it. */
4834 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4835 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4837 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4839 /* If overlay has a non-empty after-string, record it. */
4840 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4841 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4843 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4846 /* Process overlays after the overlay center. */
4847 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4849 XSETMISC (overlay
, ov
);
4850 xassert (OVERLAYP (overlay
));
4851 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4852 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4854 if (start
> charpos
)
4857 /* Skip this overlay if it doesn't start or end at IT's current
4859 if (end
!= charpos
&& start
!= charpos
)
4862 /* Skip this overlay if it doesn't apply to IT->w. */
4863 window
= Foverlay_get (overlay
, Qwindow
);
4864 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4867 /* If the text ``under'' the overlay is invisible, it has a zero
4868 dimension, and both before- and after-strings apply. */
4869 invisible
= Foverlay_get (overlay
, Qinvisible
);
4870 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4872 /* If overlay has a non-empty before-string, record it. */
4873 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4874 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4876 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4878 /* If overlay has a non-empty after-string, record it. */
4879 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4880 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4882 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4885 #undef RECORD_OVERLAY_STRING
4889 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4891 /* Record number of overlay strings, and where we computed it. */
4892 it
->n_overlay_strings
= n
;
4893 it
->overlay_strings_charpos
= charpos
;
4895 /* IT->current.overlay_string_index is the number of overlay strings
4896 that have already been consumed by IT. Copy some of the
4897 remaining overlay strings to IT->overlay_strings. */
4899 j
= it
->current
.overlay_string_index
;
4900 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4902 it
->overlay_strings
[i
] = entries
[j
].string
;
4903 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4910 /* Get the first chunk of overlay strings at IT's current buffer
4911 position, or at CHARPOS if that is > 0. Value is non-zero if at
4912 least one overlay string was found. */
4915 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4917 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4918 process. This fills IT->overlay_strings with strings, and sets
4919 IT->n_overlay_strings to the total number of strings to process.
4920 IT->pos.overlay_string_index has to be set temporarily to zero
4921 because load_overlay_strings needs this; it must be set to -1
4922 when no overlay strings are found because a zero value would
4923 indicate a position in the first overlay string. */
4924 it
->current
.overlay_string_index
= 0;
4925 load_overlay_strings (it
, charpos
);
4927 /* If we found overlay strings, set up IT to deliver display
4928 elements from the first one. Otherwise set up IT to deliver
4929 from current_buffer. */
4930 if (it
->n_overlay_strings
)
4932 /* Make sure we know settings in current_buffer, so that we can
4933 restore meaningful values when we're done with the overlay
4936 compute_stop_pos (it
);
4937 xassert (it
->face_id
>= 0);
4939 /* Save IT's settings. They are restored after all overlay
4940 strings have been processed. */
4941 xassert (!compute_stop_p
|| it
->sp
== 0);
4943 /* When called from handle_stop, there might be an empty display
4944 string loaded. In that case, don't bother saving it. */
4945 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4948 /* Set up IT to deliver display elements from the first overlay
4950 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4951 it
->string
= it
->overlay_strings
[0];
4952 it
->from_overlay
= Qnil
;
4953 it
->stop_charpos
= 0;
4954 xassert (STRINGP (it
->string
));
4955 it
->end_charpos
= SCHARS (it
->string
);
4956 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4957 it
->method
= GET_FROM_STRING
;
4961 it
->current
.overlay_string_index
= -1;
4966 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4969 it
->method
= GET_FROM_BUFFER
;
4971 (void) get_overlay_strings_1 (it
, charpos
, 1);
4975 /* Value is non-zero if we found at least one overlay string. */
4976 return STRINGP (it
->string
);
4981 /***********************************************************************
4982 Saving and restoring state
4983 ***********************************************************************/
4985 /* Save current settings of IT on IT->stack. Called, for example,
4986 before setting up IT for an overlay string, to be able to restore
4987 IT's settings to what they were after the overlay string has been
4988 processed. If POSITION is non-NULL, it is the position to save on
4989 the stack instead of IT->position. */
4992 push_it (struct it
*it
, struct text_pos
*position
)
4994 struct iterator_stack_entry
*p
;
4996 xassert (it
->sp
< IT_STACK_SIZE
);
4997 p
= it
->stack
+ it
->sp
;
4999 p
->stop_charpos
= it
->stop_charpos
;
5000 p
->prev_stop
= it
->prev_stop
;
5001 p
->base_level_stop
= it
->base_level_stop
;
5002 p
->cmp_it
= it
->cmp_it
;
5003 xassert (it
->face_id
>= 0);
5004 p
->face_id
= it
->face_id
;
5005 p
->string
= it
->string
;
5006 p
->method
= it
->method
;
5007 p
->from_overlay
= it
->from_overlay
;
5010 case GET_FROM_IMAGE
:
5011 p
->u
.image
.object
= it
->object
;
5012 p
->u
.image
.image_id
= it
->image_id
;
5013 p
->u
.image
.slice
= it
->slice
;
5015 case GET_FROM_STRETCH
:
5016 p
->u
.stretch
.object
= it
->object
;
5019 p
->position
= position
? *position
: it
->position
;
5020 p
->current
= it
->current
;
5021 p
->end_charpos
= it
->end_charpos
;
5022 p
->string_nchars
= it
->string_nchars
;
5024 p
->multibyte_p
= it
->multibyte_p
;
5025 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5026 p
->space_width
= it
->space_width
;
5027 p
->font_height
= it
->font_height
;
5028 p
->voffset
= it
->voffset
;
5029 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5030 p
->display_ellipsis_p
= 0;
5031 p
->line_wrap
= it
->line_wrap
;
5036 iterate_out_of_display_property (struct it
*it
)
5038 /* Maybe initialize paragraph direction. If we are at the beginning
5039 of a new paragraph, next_element_from_buffer may not have a
5040 chance to do that. */
5041 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5042 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5043 /* prev_stop can be zero, so check against BEGV as well. */
5044 while (it
->bidi_it
.charpos
>= BEGV
5045 && it
->prev_stop
<= it
->bidi_it
.charpos
5046 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5047 bidi_move_to_visually_next (&it
->bidi_it
);
5048 /* Record the stop_pos we just crossed, for when we cross it
5050 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5051 it
->prev_stop
= CHARPOS (it
->position
);
5052 /* If we ended up not where pop_it put us, resync IT's
5053 positional members with the bidi iterator. */
5054 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5056 SET_TEXT_POS (it
->position
,
5057 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5058 it
->current
.pos
= it
->position
;
5062 /* Restore IT's settings from IT->stack. Called, for example, when no
5063 more overlay strings must be processed, and we return to delivering
5064 display elements from a buffer, or when the end of a string from a
5065 `display' property is reached and we return to delivering display
5066 elements from an overlay string, or from a buffer. */
5069 pop_it (struct it
*it
)
5071 struct iterator_stack_entry
*p
;
5073 xassert (it
->sp
> 0);
5075 p
= it
->stack
+ it
->sp
;
5076 it
->stop_charpos
= p
->stop_charpos
;
5077 it
->prev_stop
= p
->prev_stop
;
5078 it
->base_level_stop
= p
->base_level_stop
;
5079 it
->cmp_it
= p
->cmp_it
;
5080 it
->face_id
= p
->face_id
;
5081 it
->current
= p
->current
;
5082 it
->position
= p
->position
;
5083 it
->string
= p
->string
;
5084 it
->from_overlay
= p
->from_overlay
;
5085 if (NILP (it
->string
))
5086 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5087 it
->method
= p
->method
;
5090 case GET_FROM_IMAGE
:
5091 it
->image_id
= p
->u
.image
.image_id
;
5092 it
->object
= p
->u
.image
.object
;
5093 it
->slice
= p
->u
.image
.slice
;
5095 case GET_FROM_STRETCH
:
5096 it
->object
= p
->u
.comp
.object
;
5098 case GET_FROM_BUFFER
:
5099 it
->object
= it
->w
->buffer
;
5102 /* Bidi-iterate until we get out of the portion of text, if
5103 any, covered by a `display' text property or an overlay
5104 with `display' property. (We cannot just jump there,
5105 because the internal coherency of the bidi iterator state
5106 can not be preserved across such jumps.) We also must
5107 determine the paragraph base direction if the overlay we
5108 just processed is at the beginning of a new
5110 iterate_out_of_display_property (it
);
5113 case GET_FROM_STRING
:
5114 it
->object
= it
->string
;
5116 case GET_FROM_DISPLAY_VECTOR
:
5118 it
->method
= GET_FROM_C_STRING
;
5119 else if (STRINGP (it
->string
))
5120 it
->method
= GET_FROM_STRING
;
5123 it
->method
= GET_FROM_BUFFER
;
5124 it
->object
= it
->w
->buffer
;
5127 it
->end_charpos
= p
->end_charpos
;
5128 it
->string_nchars
= p
->string_nchars
;
5130 it
->multibyte_p
= p
->multibyte_p
;
5131 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5132 it
->space_width
= p
->space_width
;
5133 it
->font_height
= p
->font_height
;
5134 it
->voffset
= p
->voffset
;
5135 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5136 it
->line_wrap
= p
->line_wrap
;
5141 /***********************************************************************
5143 ***********************************************************************/
5145 /* Set IT's current position to the previous line start. */
5148 back_to_previous_line_start (struct it
*it
)
5150 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5151 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5155 /* Move IT to the next line start.
5157 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5158 we skipped over part of the text (as opposed to moving the iterator
5159 continuously over the text). Otherwise, don't change the value
5162 Newlines may come from buffer text, overlay strings, or strings
5163 displayed via the `display' property. That's the reason we can't
5164 simply use find_next_newline_no_quit.
5166 Note that this function may not skip over invisible text that is so
5167 because of text properties and immediately follows a newline. If
5168 it would, function reseat_at_next_visible_line_start, when called
5169 from set_iterator_to_next, would effectively make invisible
5170 characters following a newline part of the wrong glyph row, which
5171 leads to wrong cursor motion. */
5174 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5176 int old_selective
, newline_found_p
, n
;
5177 const int MAX_NEWLINE_DISTANCE
= 500;
5179 /* If already on a newline, just consume it to avoid unintended
5180 skipping over invisible text below. */
5181 if (it
->what
== IT_CHARACTER
5183 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5185 set_iterator_to_next (it
, 0);
5190 /* Don't handle selective display in the following. It's (a)
5191 unnecessary because it's done by the caller, and (b) leads to an
5192 infinite recursion because next_element_from_ellipsis indirectly
5193 calls this function. */
5194 old_selective
= it
->selective
;
5197 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5198 from buffer text. */
5199 for (n
= newline_found_p
= 0;
5200 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5201 n
+= STRINGP (it
->string
) ? 0 : 1)
5203 if (!get_next_display_element (it
))
5205 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5206 set_iterator_to_next (it
, 0);
5209 /* If we didn't find a newline near enough, see if we can use a
5211 if (!newline_found_p
)
5213 EMACS_INT start
= IT_CHARPOS (*it
);
5214 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5217 xassert (!STRINGP (it
->string
));
5219 /* If there isn't any `display' property in sight, and no
5220 overlays, we can just use the position of the newline in
5222 if (it
->stop_charpos
>= limit
5223 || ((pos
= Fnext_single_property_change (make_number (start
),
5225 Qnil
, make_number (limit
)),
5227 && next_overlay_change (start
) == ZV
))
5229 IT_CHARPOS (*it
) = limit
;
5230 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5231 *skipped_p
= newline_found_p
= 1;
5235 while (get_next_display_element (it
)
5236 && !newline_found_p
)
5238 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5239 set_iterator_to_next (it
, 0);
5244 it
->selective
= old_selective
;
5245 return newline_found_p
;
5249 /* Set IT's current position to the previous visible line start. Skip
5250 invisible text that is so either due to text properties or due to
5251 selective display. Caution: this does not change IT->current_x and
5255 back_to_previous_visible_line_start (struct it
*it
)
5257 while (IT_CHARPOS (*it
) > BEGV
)
5259 back_to_previous_line_start (it
);
5261 if (IT_CHARPOS (*it
) <= BEGV
)
5264 /* If selective > 0, then lines indented more than its value are
5266 if (it
->selective
> 0
5267 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5268 (double) it
->selective
)) /* iftc */
5271 /* Check the newline before point for invisibility. */
5274 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5275 Qinvisible
, it
->window
);
5276 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5280 if (IT_CHARPOS (*it
) <= BEGV
)
5287 Lisp_Object val
, overlay
;
5289 /* If newline is part of a composition, continue from start of composition */
5290 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5291 && beg
< IT_CHARPOS (*it
))
5294 /* If newline is replaced by a display property, find start of overlay
5295 or interval and continue search from that point. */
5297 pos
= --IT_CHARPOS (it2
);
5300 it2
.string_from_display_prop_p
= 0;
5301 if (handle_display_prop (&it2
) == HANDLED_RETURN
5302 && !NILP (val
= get_char_property_and_overlay
5303 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5304 && (OVERLAYP (overlay
)
5305 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5306 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5309 /* Newline is not replaced by anything -- so we are done. */
5315 IT_CHARPOS (*it
) = beg
;
5316 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5320 it
->continuation_lines_width
= 0;
5322 xassert (IT_CHARPOS (*it
) >= BEGV
);
5323 xassert (IT_CHARPOS (*it
) == BEGV
5324 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5329 /* Reseat iterator IT at the previous visible line start. Skip
5330 invisible text that is so either due to text properties or due to
5331 selective display. At the end, update IT's overlay information,
5332 face information etc. */
5335 reseat_at_previous_visible_line_start (struct it
*it
)
5337 back_to_previous_visible_line_start (it
);
5338 reseat (it
, it
->current
.pos
, 1);
5343 /* Reseat iterator IT on the next visible line start in the current
5344 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5345 preceding the line start. Skip over invisible text that is so
5346 because of selective display. Compute faces, overlays etc at the
5347 new position. Note that this function does not skip over text that
5348 is invisible because of text properties. */
5351 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5353 int newline_found_p
, skipped_p
= 0;
5355 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5357 /* Skip over lines that are invisible because they are indented
5358 more than the value of IT->selective. */
5359 if (it
->selective
> 0)
5360 while (IT_CHARPOS (*it
) < ZV
5361 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5362 (double) it
->selective
)) /* iftc */
5364 xassert (IT_BYTEPOS (*it
) == BEGV
5365 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5366 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5369 /* Position on the newline if that's what's requested. */
5370 if (on_newline_p
&& newline_found_p
)
5372 if (STRINGP (it
->string
))
5374 if (IT_STRING_CHARPOS (*it
) > 0)
5376 --IT_STRING_CHARPOS (*it
);
5377 --IT_STRING_BYTEPOS (*it
);
5380 else if (IT_CHARPOS (*it
) > BEGV
)
5384 reseat (it
, it
->current
.pos
, 0);
5388 reseat (it
, it
->current
.pos
, 0);
5395 /***********************************************************************
5396 Changing an iterator's position
5397 ***********************************************************************/
5399 /* Change IT's current position to POS in current_buffer. If FORCE_P
5400 is non-zero, always check for text properties at the new position.
5401 Otherwise, text properties are only looked up if POS >=
5402 IT->check_charpos of a property. */
5405 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5407 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5409 reseat_1 (it
, pos
, 0);
5411 /* Determine where to check text properties. Avoid doing it
5412 where possible because text property lookup is very expensive. */
5414 || CHARPOS (pos
) > it
->stop_charpos
5415 || CHARPOS (pos
) < original_pos
)
5419 /* For bidi iteration, we need to prime prev_stop and
5420 base_level_stop with our best estimations. */
5421 if (CHARPOS (pos
) < it
->prev_stop
)
5423 handle_stop_backwards (it
, BEGV
);
5424 if (CHARPOS (pos
) < it
->base_level_stop
)
5425 it
->base_level_stop
= 0;
5427 else if (CHARPOS (pos
) > it
->stop_charpos
5428 && it
->stop_charpos
>= BEGV
)
5429 handle_stop_backwards (it
, it
->stop_charpos
);
5436 it
->prev_stop
= it
->base_level_stop
= 0;
5445 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5446 IT->stop_pos to POS, also. */
5449 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5451 /* Don't call this function when scanning a C string. */
5452 xassert (it
->s
== NULL
);
5454 /* POS must be a reasonable value. */
5455 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5457 it
->current
.pos
= it
->position
= pos
;
5458 it
->end_charpos
= ZV
;
5460 it
->current
.dpvec_index
= -1;
5461 it
->current
.overlay_string_index
= -1;
5462 IT_STRING_CHARPOS (*it
) = -1;
5463 IT_STRING_BYTEPOS (*it
) = -1;
5465 it
->string_from_display_prop_p
= 0;
5466 it
->method
= GET_FROM_BUFFER
;
5467 it
->object
= it
->w
->buffer
;
5468 it
->area
= TEXT_AREA
;
5469 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5471 it
->string_from_display_prop_p
= 0;
5472 it
->face_before_selective_p
= 0;
5475 it
->bidi_it
.first_elt
= 1;
5476 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5477 it
->bidi_it
.disp_pos
= -1;
5482 it
->stop_charpos
= CHARPOS (pos
);
5483 it
->base_level_stop
= CHARPOS (pos
);
5488 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5489 If S is non-null, it is a C string to iterate over. Otherwise,
5490 STRING gives a Lisp string to iterate over.
5492 If PRECISION > 0, don't return more then PRECISION number of
5493 characters from the string.
5495 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5496 characters have been returned. FIELD_WIDTH < 0 means an infinite
5499 MULTIBYTE = 0 means disable processing of multibyte characters,
5500 MULTIBYTE > 0 means enable it,
5501 MULTIBYTE < 0 means use IT->multibyte_p.
5503 IT must be initialized via a prior call to init_iterator before
5504 calling this function. */
5507 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5508 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5511 /* No region in strings. */
5512 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5514 /* No text property checks performed by default, but see below. */
5515 it
->stop_charpos
= -1;
5517 /* Set iterator position and end position. */
5518 memset (&it
->current
, 0, sizeof it
->current
);
5519 it
->current
.overlay_string_index
= -1;
5520 it
->current
.dpvec_index
= -1;
5521 xassert (charpos
>= 0);
5523 /* If STRING is specified, use its multibyteness, otherwise use the
5524 setting of MULTIBYTE, if specified. */
5526 it
->multibyte_p
= multibyte
> 0;
5530 xassert (STRINGP (string
));
5531 it
->string
= string
;
5533 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5534 it
->method
= GET_FROM_STRING
;
5535 it
->current
.string_pos
= string_pos (charpos
, string
);
5539 it
->s
= (const unsigned char *) s
;
5542 /* Note that we use IT->current.pos, not it->current.string_pos,
5543 for displaying C strings. */
5544 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5545 if (it
->multibyte_p
)
5547 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5548 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5552 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5553 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5556 it
->method
= GET_FROM_C_STRING
;
5559 /* PRECISION > 0 means don't return more than PRECISION characters
5561 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5562 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5564 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5565 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5566 FIELD_WIDTH < 0 means infinite field width. This is useful for
5567 padding with `-' at the end of a mode line. */
5568 if (field_width
< 0)
5569 field_width
= INFINITY
;
5570 if (field_width
> it
->end_charpos
- charpos
)
5571 it
->end_charpos
= charpos
+ field_width
;
5573 /* Use the standard display table for displaying strings. */
5574 if (DISP_TABLE_P (Vstandard_display_table
))
5575 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5577 it
->stop_charpos
= charpos
;
5578 if (s
== NULL
&& it
->multibyte_p
)
5580 EMACS_INT endpos
= SCHARS (it
->string
);
5581 if (endpos
> it
->end_charpos
)
5582 endpos
= it
->end_charpos
;
5583 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5591 /***********************************************************************
5593 ***********************************************************************/
5595 /* Map enum it_method value to corresponding next_element_from_* function. */
5597 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5599 next_element_from_buffer
,
5600 next_element_from_display_vector
,
5601 next_element_from_string
,
5602 next_element_from_c_string
,
5603 next_element_from_image
,
5604 next_element_from_stretch
5607 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5610 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5611 (possibly with the following characters). */
5613 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5614 ((IT)->cmp_it.id >= 0 \
5615 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5616 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5617 END_CHARPOS, (IT)->w, \
5618 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5622 /* Lookup the char-table Vglyphless_char_display for character C (-1
5623 if we want information for no-font case), and return the display
5624 method symbol. By side-effect, update it->what and
5625 it->glyphless_method. This function is called from
5626 get_next_display_element for each character element, and from
5627 x_produce_glyphs when no suitable font was found. */
5630 lookup_glyphless_char_display (int c
, struct it
*it
)
5632 Lisp_Object glyphless_method
= Qnil
;
5634 if (CHAR_TABLE_P (Vglyphless_char_display
)
5635 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5639 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
5640 if (CONSP (glyphless_method
))
5641 glyphless_method
= FRAME_WINDOW_P (it
->f
)
5642 ? XCAR (glyphless_method
)
5643 : XCDR (glyphless_method
);
5646 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
5650 if (NILP (glyphless_method
))
5653 /* The default is to display the character by a proper font. */
5655 /* The default for the no-font case is to display an empty box. */
5656 glyphless_method
= Qempty_box
;
5658 if (EQ (glyphless_method
, Qzero_width
))
5661 return glyphless_method
;
5662 /* This method can't be used for the no-font case. */
5663 glyphless_method
= Qempty_box
;
5665 if (EQ (glyphless_method
, Qthin_space
))
5666 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5667 else if (EQ (glyphless_method
, Qempty_box
))
5668 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5669 else if (EQ (glyphless_method
, Qhex_code
))
5670 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5671 else if (STRINGP (glyphless_method
))
5672 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5675 /* Invalid value. We use the default method. */
5676 glyphless_method
= Qnil
;
5679 it
->what
= IT_GLYPHLESS
;
5680 return glyphless_method
;
5683 /* Load IT's display element fields with information about the next
5684 display element from the current position of IT. Value is zero if
5685 end of buffer (or C string) is reached. */
5687 static struct frame
*last_escape_glyph_frame
= NULL
;
5688 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5689 static int last_escape_glyph_merged_face_id
= 0;
5691 struct frame
*last_glyphless_glyph_frame
= NULL
;
5692 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5693 int last_glyphless_glyph_merged_face_id
= 0;
5696 get_next_display_element (struct it
*it
)
5698 /* Non-zero means that we found a display element. Zero means that
5699 we hit the end of what we iterate over. Performance note: the
5700 function pointer `method' used here turns out to be faster than
5701 using a sequence of if-statements. */
5705 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5707 if (it
->what
== IT_CHARACTER
)
5709 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5710 and only if (a) the resolved directionality of that character
5712 /* FIXME: Do we need an exception for characters from display
5714 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5715 it
->c
= bidi_mirror_char (it
->c
);
5716 /* Map via display table or translate control characters.
5717 IT->c, IT->len etc. have been set to the next character by
5718 the function call above. If we have a display table, and it
5719 contains an entry for IT->c, translate it. Don't do this if
5720 IT->c itself comes from a display table, otherwise we could
5721 end up in an infinite recursion. (An alternative could be to
5722 count the recursion depth of this function and signal an
5723 error when a certain maximum depth is reached.) Is it worth
5725 if (success_p
&& it
->dpvec
== NULL
)
5728 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5729 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5730 nbsp_or_shy
= char_is_other
;
5731 int c
= it
->c
; /* This is the character to display. */
5733 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5735 xassert (SINGLE_BYTE_CHAR_P (c
));
5736 if (unibyte_display_via_language_environment
)
5738 c
= DECODE_CHAR (unibyte
, c
);
5740 c
= BYTE8_TO_CHAR (it
->c
);
5743 c
= BYTE8_TO_CHAR (it
->c
);
5747 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5750 struct Lisp_Vector
*v
= XVECTOR (dv
);
5752 /* Return the first character from the display table
5753 entry, if not empty. If empty, don't display the
5754 current character. */
5757 it
->dpvec_char_len
= it
->len
;
5758 it
->dpvec
= v
->contents
;
5759 it
->dpend
= v
->contents
+ v
->header
.size
;
5760 it
->current
.dpvec_index
= 0;
5761 it
->dpvec_face_id
= -1;
5762 it
->saved_face_id
= it
->face_id
;
5763 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5768 set_iterator_to_next (it
, 0);
5773 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5775 if (it
->what
== IT_GLYPHLESS
)
5777 /* Don't display this character. */
5778 set_iterator_to_next (it
, 0);
5782 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5783 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5784 : c
== 0xAD ? char_is_soft_hyphen
5787 /* Translate control characters into `\003' or `^C' form.
5788 Control characters coming from a display table entry are
5789 currently not translated because we use IT->dpvec to hold
5790 the translation. This could easily be changed but I
5791 don't believe that it is worth doing.
5793 NBSP and SOFT-HYPEN are property translated too.
5795 Non-printable characters and raw-byte characters are also
5796 translated to octal form. */
5797 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5798 ? (it
->area
!= TEXT_AREA
5799 /* In mode line, treat \n, \t like other crl chars. */
5802 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5803 || (c
!= '\n' && c
!= '\t'))
5806 || ! CHAR_PRINTABLE_P (c
))))
5808 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5809 or a non-printable character which must be displayed
5810 either as '\003' or as `^C' where the '\\' and '^'
5811 can be defined in the display table. Fill
5812 IT->ctl_chars with glyphs for what we have to
5813 display. Then, set IT->dpvec to these glyphs. */
5816 int face_id
, lface_id
= 0 ;
5819 /* Handle control characters with ^. */
5821 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5825 g
= '^'; /* default glyph for Control */
5826 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5828 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5829 && GLYPH_CODE_CHAR_VALID_P (gc
))
5831 g
= GLYPH_CODE_CHAR (gc
);
5832 lface_id
= GLYPH_CODE_FACE (gc
);
5836 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5838 else if (it
->f
== last_escape_glyph_frame
5839 && it
->face_id
== last_escape_glyph_face_id
)
5841 face_id
= last_escape_glyph_merged_face_id
;
5845 /* Merge the escape-glyph face into the current face. */
5846 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5848 last_escape_glyph_frame
= it
->f
;
5849 last_escape_glyph_face_id
= it
->face_id
;
5850 last_escape_glyph_merged_face_id
= face_id
;
5853 XSETINT (it
->ctl_chars
[0], g
);
5854 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5856 goto display_control
;
5859 /* Handle non-break space in the mode where it only gets
5862 if (EQ (Vnobreak_char_display
, Qt
)
5863 && nbsp_or_shy
== char_is_nbsp
)
5865 /* Merge the no-break-space face into the current face. */
5866 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5870 XSETINT (it
->ctl_chars
[0], ' ');
5872 goto display_control
;
5875 /* Handle sequences that start with the "escape glyph". */
5877 /* the default escape glyph is \. */
5878 escape_glyph
= '\\';
5881 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5882 && GLYPH_CODE_CHAR_VALID_P (gc
))
5884 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5885 lface_id
= GLYPH_CODE_FACE (gc
);
5889 /* The display table specified a face.
5890 Merge it into face_id and also into escape_glyph. */
5891 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5894 else if (it
->f
== last_escape_glyph_frame
5895 && it
->face_id
== last_escape_glyph_face_id
)
5897 face_id
= last_escape_glyph_merged_face_id
;
5901 /* Merge the escape-glyph face into the current face. */
5902 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5904 last_escape_glyph_frame
= it
->f
;
5905 last_escape_glyph_face_id
= it
->face_id
;
5906 last_escape_glyph_merged_face_id
= face_id
;
5909 /* Handle soft hyphens in the mode where they only get
5912 if (EQ (Vnobreak_char_display
, Qt
)
5913 && nbsp_or_shy
== char_is_soft_hyphen
)
5915 XSETINT (it
->ctl_chars
[0], '-');
5917 goto display_control
;
5920 /* Handle non-break space and soft hyphen
5921 with the escape glyph. */
5925 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5926 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5927 XSETINT (it
->ctl_chars
[1], c
);
5929 goto display_control
;
5936 if (CHAR_BYTE8_P (c
))
5937 /* Display \200 instead of \17777600. */
5938 c
= CHAR_TO_BYTE8 (c
);
5939 len
= sprintf (str
, "%03o", c
);
5941 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5942 for (i
= 0; i
< len
; i
++)
5943 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5948 /* Set up IT->dpvec and return first character from it. */
5949 it
->dpvec_char_len
= it
->len
;
5950 it
->dpvec
= it
->ctl_chars
;
5951 it
->dpend
= it
->dpvec
+ ctl_len
;
5952 it
->current
.dpvec_index
= 0;
5953 it
->dpvec_face_id
= face_id
;
5954 it
->saved_face_id
= it
->face_id
;
5955 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5959 it
->char_to_display
= c
;
5963 it
->char_to_display
= it
->c
;
5967 /* Adjust face id for a multibyte character. There are no multibyte
5968 character in unibyte text. */
5969 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5972 && FRAME_WINDOW_P (it
->f
))
5974 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5976 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5978 /* Automatic composition with glyph-string. */
5979 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5981 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5985 EMACS_INT pos
= (it
->s
? -1
5986 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5987 : IT_CHARPOS (*it
));
5989 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5995 /* Is this character the last one of a run of characters with
5996 box? If yes, set IT->end_of_box_run_p to 1. */
6000 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6002 int face_id
= underlying_face_id (it
);
6003 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6007 if (face
->box
== FACE_NO_BOX
)
6009 /* If the box comes from face properties in a
6010 display string, check faces in that string. */
6011 int string_face_id
= face_after_it_pos (it
);
6012 it
->end_of_box_run_p
6013 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6016 /* Otherwise, the box comes from the underlying face.
6017 If this is the last string character displayed, check
6018 the next buffer location. */
6019 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6020 && (it
->current
.overlay_string_index
6021 == it
->n_overlay_strings
- 1))
6025 struct text_pos pos
= it
->current
.pos
;
6026 INC_TEXT_POS (pos
, it
->multibyte_p
);
6028 next_face_id
= face_at_buffer_position
6029 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6030 it
->region_end_charpos
, &ignore
,
6031 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6033 it
->end_of_box_run_p
6034 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6041 int face_id
= face_after_it_pos (it
);
6042 it
->end_of_box_run_p
6043 = (face_id
!= it
->face_id
6044 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6048 /* Value is 0 if end of buffer or string reached. */
6053 /* Move IT to the next display element.
6055 RESEAT_P non-zero means if called on a newline in buffer text,
6056 skip to the next visible line start.
6058 Functions get_next_display_element and set_iterator_to_next are
6059 separate because I find this arrangement easier to handle than a
6060 get_next_display_element function that also increments IT's
6061 position. The way it is we can first look at an iterator's current
6062 display element, decide whether it fits on a line, and if it does,
6063 increment the iterator position. The other way around we probably
6064 would either need a flag indicating whether the iterator has to be
6065 incremented the next time, or we would have to implement a
6066 decrement position function which would not be easy to write. */
6069 set_iterator_to_next (struct it
*it
, int reseat_p
)
6071 /* Reset flags indicating start and end of a sequence of characters
6072 with box. Reset them at the start of this function because
6073 moving the iterator to a new position might set them. */
6074 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6078 case GET_FROM_BUFFER
:
6079 /* The current display element of IT is a character from
6080 current_buffer. Advance in the buffer, and maybe skip over
6081 invisible lines that are so because of selective display. */
6082 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6083 reseat_at_next_visible_line_start (it
, 0);
6084 else if (it
->cmp_it
.id
>= 0)
6086 /* We are currently getting glyphs from a composition. */
6091 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6092 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6093 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6095 it
->cmp_it
.from
= it
->cmp_it
.to
;
6100 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6102 it
->end_charpos
, Qnil
);
6105 else if (! it
->cmp_it
.reversed_p
)
6107 /* Composition created while scanning forward. */
6108 /* Update IT's char/byte positions to point to the first
6109 character of the next grapheme cluster, or to the
6110 character visually after the current composition. */
6111 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6112 bidi_move_to_visually_next (&it
->bidi_it
);
6113 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6114 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6116 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6118 /* Proceed to the next grapheme cluster. */
6119 it
->cmp_it
.from
= it
->cmp_it
.to
;
6123 /* No more grapheme clusters in this composition.
6124 Find the next stop position. */
6125 EMACS_INT stop
= it
->end_charpos
;
6126 if (it
->bidi_it
.scan_dir
< 0)
6127 /* Now we are scanning backward and don't know
6130 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6131 IT_BYTEPOS (*it
), stop
, Qnil
);
6136 /* Composition created while scanning backward. */
6137 /* Update IT's char/byte positions to point to the last
6138 character of the previous grapheme cluster, or the
6139 character visually after the current composition. */
6140 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6141 bidi_move_to_visually_next (&it
->bidi_it
);
6142 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6143 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6144 if (it
->cmp_it
.from
> 0)
6146 /* Proceed to the previous grapheme cluster. */
6147 it
->cmp_it
.to
= it
->cmp_it
.from
;
6151 /* No more grapheme clusters in this composition.
6152 Find the next stop position. */
6153 EMACS_INT stop
= it
->end_charpos
;
6154 if (it
->bidi_it
.scan_dir
< 0)
6155 /* Now we are scanning backward and don't know
6158 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6159 IT_BYTEPOS (*it
), stop
, Qnil
);
6165 xassert (it
->len
!= 0);
6169 IT_BYTEPOS (*it
) += it
->len
;
6170 IT_CHARPOS (*it
) += 1;
6174 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6175 /* If this is a new paragraph, determine its base
6176 direction (a.k.a. its base embedding level). */
6177 if (it
->bidi_it
.new_paragraph
)
6178 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6179 bidi_move_to_visually_next (&it
->bidi_it
);
6180 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6181 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6182 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6184 /* As the scan direction was changed, we must
6185 re-compute the stop position for composition. */
6186 EMACS_INT stop
= it
->end_charpos
;
6187 if (it
->bidi_it
.scan_dir
< 0)
6189 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6190 IT_BYTEPOS (*it
), stop
, Qnil
);
6193 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6197 case GET_FROM_C_STRING
:
6198 /* Current display element of IT is from a C string. */
6199 IT_BYTEPOS (*it
) += it
->len
;
6200 IT_CHARPOS (*it
) += 1;
6203 case GET_FROM_DISPLAY_VECTOR
:
6204 /* Current display element of IT is from a display table entry.
6205 Advance in the display table definition. Reset it to null if
6206 end reached, and continue with characters from buffers/
6208 ++it
->current
.dpvec_index
;
6210 /* Restore face of the iterator to what they were before the
6211 display vector entry (these entries may contain faces). */
6212 it
->face_id
= it
->saved_face_id
;
6214 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6216 int recheck_faces
= it
->ellipsis_p
;
6219 it
->method
= GET_FROM_C_STRING
;
6220 else if (STRINGP (it
->string
))
6221 it
->method
= GET_FROM_STRING
;
6224 it
->method
= GET_FROM_BUFFER
;
6225 it
->object
= it
->w
->buffer
;
6229 it
->current
.dpvec_index
= -1;
6231 /* Skip over characters which were displayed via IT->dpvec. */
6232 if (it
->dpvec_char_len
< 0)
6233 reseat_at_next_visible_line_start (it
, 1);
6234 else if (it
->dpvec_char_len
> 0)
6236 if (it
->method
== GET_FROM_STRING
6237 && it
->n_overlay_strings
> 0)
6238 it
->ignore_overlay_strings_at_pos_p
= 1;
6239 it
->len
= it
->dpvec_char_len
;
6240 set_iterator_to_next (it
, reseat_p
);
6243 /* Maybe recheck faces after display vector */
6245 it
->stop_charpos
= IT_CHARPOS (*it
);
6249 case GET_FROM_STRING
:
6250 /* Current display element is a character from a Lisp string. */
6251 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6252 if (it
->cmp_it
.id
>= 0)
6254 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6255 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6256 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6257 it
->cmp_it
.from
= it
->cmp_it
.to
;
6261 composition_compute_stop_pos (&it
->cmp_it
,
6262 IT_STRING_CHARPOS (*it
),
6263 IT_STRING_BYTEPOS (*it
),
6264 it
->end_charpos
, it
->string
);
6269 IT_STRING_BYTEPOS (*it
) += it
->len
;
6270 IT_STRING_CHARPOS (*it
) += 1;
6273 consider_string_end
:
6275 if (it
->current
.overlay_string_index
>= 0)
6277 /* IT->string is an overlay string. Advance to the
6278 next, if there is one. */
6279 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6282 next_overlay_string (it
);
6284 setup_for_ellipsis (it
, 0);
6289 /* IT->string is not an overlay string. If we reached
6290 its end, and there is something on IT->stack, proceed
6291 with what is on the stack. This can be either another
6292 string, this time an overlay string, or a buffer. */
6293 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6297 if (it
->method
== GET_FROM_STRING
)
6298 goto consider_string_end
;
6303 case GET_FROM_IMAGE
:
6304 case GET_FROM_STRETCH
:
6305 /* The position etc with which we have to proceed are on
6306 the stack. The position may be at the end of a string,
6307 if the `display' property takes up the whole string. */
6308 xassert (it
->sp
> 0);
6310 if (it
->method
== GET_FROM_STRING
)
6311 goto consider_string_end
;
6315 /* There are no other methods defined, so this should be a bug. */
6319 xassert (it
->method
!= GET_FROM_STRING
6320 || (STRINGP (it
->string
)
6321 && IT_STRING_CHARPOS (*it
) >= 0));
6324 /* Load IT's display element fields with information about the next
6325 display element which comes from a display table entry or from the
6326 result of translating a control character to one of the forms `^C'
6329 IT->dpvec holds the glyphs to return as characters.
6330 IT->saved_face_id holds the face id before the display vector--it
6331 is restored into IT->face_id in set_iterator_to_next. */
6334 next_element_from_display_vector (struct it
*it
)
6339 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6341 it
->face_id
= it
->saved_face_id
;
6343 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6344 That seemed totally bogus - so I changed it... */
6345 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6347 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6349 it
->c
= GLYPH_CODE_CHAR (gc
);
6350 it
->len
= CHAR_BYTES (it
->c
);
6352 /* The entry may contain a face id to use. Such a face id is
6353 the id of a Lisp face, not a realized face. A face id of
6354 zero means no face is specified. */
6355 if (it
->dpvec_face_id
>= 0)
6356 it
->face_id
= it
->dpvec_face_id
;
6359 int lface_id
= GLYPH_CODE_FACE (gc
);
6361 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6366 /* Display table entry is invalid. Return a space. */
6367 it
->c
= ' ', it
->len
= 1;
6369 /* Don't change position and object of the iterator here. They are
6370 still the values of the character that had this display table
6371 entry or was translated, and that's what we want. */
6372 it
->what
= IT_CHARACTER
;
6377 /* Load IT with the next display element from Lisp string IT->string.
6378 IT->current.string_pos is the current position within the string.
6379 If IT->current.overlay_string_index >= 0, the Lisp string is an
6383 next_element_from_string (struct it
*it
)
6385 struct text_pos position
;
6387 xassert (STRINGP (it
->string
));
6388 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6389 position
= it
->current
.string_pos
;
6391 /* Time to check for invisible text? */
6392 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6393 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6397 /* Since a handler may have changed IT->method, we must
6399 return GET_NEXT_DISPLAY_ELEMENT (it
);
6402 if (it
->current
.overlay_string_index
>= 0)
6404 /* Get the next character from an overlay string. In overlay
6405 strings, There is no field width or padding with spaces to
6407 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6412 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6413 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6414 && next_element_from_composition (it
))
6418 else if (STRING_MULTIBYTE (it
->string
))
6420 const unsigned char *s
= (SDATA (it
->string
)
6421 + IT_STRING_BYTEPOS (*it
));
6422 it
->c
= string_char_and_length (s
, &it
->len
);
6426 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6432 /* Get the next character from a Lisp string that is not an
6433 overlay string. Such strings come from the mode line, for
6434 example. We may have to pad with spaces, or truncate the
6435 string. See also next_element_from_c_string. */
6436 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6441 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6443 /* Pad with spaces. */
6444 it
->c
= ' ', it
->len
= 1;
6445 CHARPOS (position
) = BYTEPOS (position
) = -1;
6447 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6448 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6449 && next_element_from_composition (it
))
6453 else if (STRING_MULTIBYTE (it
->string
))
6455 const unsigned char *s
= (SDATA (it
->string
)
6456 + IT_STRING_BYTEPOS (*it
));
6457 it
->c
= string_char_and_length (s
, &it
->len
);
6461 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6466 /* Record what we have and where it came from. */
6467 it
->what
= IT_CHARACTER
;
6468 it
->object
= it
->string
;
6469 it
->position
= position
;
6474 /* Load IT with next display element from C string IT->s.
6475 IT->string_nchars is the maximum number of characters to return
6476 from the string. IT->end_charpos may be greater than
6477 IT->string_nchars when this function is called, in which case we
6478 may have to return padding spaces. Value is zero if end of string
6479 reached, including padding spaces. */
6482 next_element_from_c_string (struct it
*it
)
6487 it
->what
= IT_CHARACTER
;
6488 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6491 /* IT's position can be greater IT->string_nchars in case a field
6492 width or precision has been specified when the iterator was
6494 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6496 /* End of the game. */
6500 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6502 /* Pad with spaces. */
6503 it
->c
= ' ', it
->len
= 1;
6504 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6506 else if (it
->multibyte_p
)
6507 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6509 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6515 /* Set up IT to return characters from an ellipsis, if appropriate.
6516 The definition of the ellipsis glyphs may come from a display table
6517 entry. This function fills IT with the first glyph from the
6518 ellipsis if an ellipsis is to be displayed. */
6521 next_element_from_ellipsis (struct it
*it
)
6523 if (it
->selective_display_ellipsis_p
)
6524 setup_for_ellipsis (it
, it
->len
);
6527 /* The face at the current position may be different from the
6528 face we find after the invisible text. Remember what it
6529 was in IT->saved_face_id, and signal that it's there by
6530 setting face_before_selective_p. */
6531 it
->saved_face_id
= it
->face_id
;
6532 it
->method
= GET_FROM_BUFFER
;
6533 it
->object
= it
->w
->buffer
;
6534 reseat_at_next_visible_line_start (it
, 1);
6535 it
->face_before_selective_p
= 1;
6538 return GET_NEXT_DISPLAY_ELEMENT (it
);
6542 /* Deliver an image display element. The iterator IT is already
6543 filled with image information (done in handle_display_prop). Value
6548 next_element_from_image (struct it
*it
)
6550 it
->what
= IT_IMAGE
;
6551 it
->ignore_overlay_strings_at_pos_p
= 0;
6556 /* Fill iterator IT with next display element from a stretch glyph
6557 property. IT->object is the value of the text property. Value is
6561 next_element_from_stretch (struct it
*it
)
6563 it
->what
= IT_STRETCH
;
6567 /* Scan forward from CHARPOS in the current buffer, until we find a
6568 stop position > current IT's position. Then handle the stop
6569 position before that. This is called when we bump into a stop
6570 position while reordering bidirectional text. CHARPOS should be
6571 the last previously processed stop_pos (or BEGV, if none were
6572 processed yet) whose position is less that IT's current
6576 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6578 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6579 struct display_pos save_current
= it
->current
;
6580 struct text_pos save_position
= it
->position
;
6581 struct text_pos pos1
;
6582 EMACS_INT next_stop
;
6584 /* Scan in strict logical order. */
6588 it
->prev_stop
= charpos
;
6589 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6590 reseat_1 (it
, pos1
, 0);
6591 compute_stop_pos (it
);
6592 /* We must advance forward, right? */
6593 if (it
->stop_charpos
<= it
->prev_stop
)
6595 charpos
= it
->stop_charpos
;
6597 while (charpos
<= where_we_are
);
6599 next_stop
= it
->stop_charpos
;
6600 it
->stop_charpos
= it
->prev_stop
;
6602 it
->current
= save_current
;
6603 it
->position
= save_position
;
6605 it
->stop_charpos
= next_stop
;
6608 /* Load IT with the next display element from current_buffer. Value
6609 is zero if end of buffer reached. IT->stop_charpos is the next
6610 position at which to stop and check for text properties or buffer
6614 next_element_from_buffer (struct it
*it
)
6618 xassert (IT_CHARPOS (*it
) >= BEGV
);
6620 /* With bidi reordering, the character to display might not be the
6621 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6622 we were reseat()ed to a new buffer position, which is potentially
6623 a different paragraph. */
6624 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6626 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6627 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6628 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6630 /* Nothing to do, but reset the FIRST_ELT flag, like
6631 bidi_paragraph_init does, because we are not going to
6633 it
->bidi_it
.first_elt
= 0;
6635 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6636 /* FIXME: Should support all Unicode line separators. */
6637 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6638 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6640 /* If we are at the beginning of a line, we can produce the
6641 next element right away. */
6642 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6643 bidi_move_to_visually_next (&it
->bidi_it
);
6647 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6649 /* We need to prime the bidi iterator starting at the line's
6650 beginning, before we will be able to produce the next
6652 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6653 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6654 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6655 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6656 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6659 /* Now return to buffer position where we were asked to
6660 get the next display element, and produce that. */
6661 bidi_move_to_visually_next (&it
->bidi_it
);
6663 while (it
->bidi_it
.bytepos
!= orig_bytepos
6664 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6667 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6668 /* Adjust IT's position information to where we ended up. */
6669 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6670 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6671 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6673 EMACS_INT stop
= it
->end_charpos
;
6674 if (it
->bidi_it
.scan_dir
< 0)
6676 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6677 IT_BYTEPOS (*it
), stop
, Qnil
);
6681 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6683 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6685 int overlay_strings_follow_p
;
6687 /* End of the game, except when overlay strings follow that
6688 haven't been returned yet. */
6689 if (it
->overlay_strings_at_end_processed_p
)
6690 overlay_strings_follow_p
= 0;
6693 it
->overlay_strings_at_end_processed_p
= 1;
6694 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6697 if (overlay_strings_follow_p
)
6698 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6702 it
->position
= it
->current
.pos
;
6706 else if (!(!it
->bidi_p
6707 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6708 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6710 /* With bidi non-linear iteration, we could find ourselves
6711 far beyond the last computed stop_charpos, with several
6712 other stop positions in between that we missed. Scan
6713 them all now, in buffer's logical order, until we find
6714 and handle the last stop_charpos that precedes our
6715 current position. */
6716 handle_stop_backwards (it
, it
->stop_charpos
);
6717 return GET_NEXT_DISPLAY_ELEMENT (it
);
6723 /* Take note of the stop position we just moved across,
6724 for when we will move back across it. */
6725 it
->prev_stop
= it
->stop_charpos
;
6726 /* If we are at base paragraph embedding level, take
6727 note of the last stop position seen at this
6729 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6730 it
->base_level_stop
= it
->stop_charpos
;
6733 return GET_NEXT_DISPLAY_ELEMENT (it
);
6737 /* We can sometimes back up for reasons that have nothing
6738 to do with bidi reordering. E.g., compositions. The
6739 code below is only needed when we are above the base
6740 embedding level, so test for that explicitly. */
6741 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6742 && IT_CHARPOS (*it
) < it
->prev_stop
)
6744 if (it
->base_level_stop
<= 0)
6745 it
->base_level_stop
= BEGV
;
6746 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6748 handle_stop_backwards (it
, it
->base_level_stop
);
6749 return GET_NEXT_DISPLAY_ELEMENT (it
);
6753 /* No face changes, overlays etc. in sight, so just return a
6754 character from current_buffer. */
6758 /* Maybe run the redisplay end trigger hook. Performance note:
6759 This doesn't seem to cost measurable time. */
6760 if (it
->redisplay_end_trigger_charpos
6762 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6763 run_redisplay_end_trigger_hook (it
);
6765 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6766 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6768 && next_element_from_composition (it
))
6773 /* Get the next character, maybe multibyte. */
6774 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6775 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6776 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6778 it
->c
= *p
, it
->len
= 1;
6780 /* Record what we have and where it came from. */
6781 it
->what
= IT_CHARACTER
;
6782 it
->object
= it
->w
->buffer
;
6783 it
->position
= it
->current
.pos
;
6785 /* Normally we return the character found above, except when we
6786 really want to return an ellipsis for selective display. */
6791 /* A value of selective > 0 means hide lines indented more
6792 than that number of columns. */
6793 if (it
->selective
> 0
6794 && IT_CHARPOS (*it
) + 1 < ZV
6795 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6796 IT_BYTEPOS (*it
) + 1,
6797 (double) it
->selective
)) /* iftc */
6799 success_p
= next_element_from_ellipsis (it
);
6800 it
->dpvec_char_len
= -1;
6803 else if (it
->c
== '\r' && it
->selective
== -1)
6805 /* A value of selective == -1 means that everything from the
6806 CR to the end of the line is invisible, with maybe an
6807 ellipsis displayed for it. */
6808 success_p
= next_element_from_ellipsis (it
);
6809 it
->dpvec_char_len
= -1;
6814 /* Value is zero if end of buffer reached. */
6815 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6820 /* Run the redisplay end trigger hook for IT. */
6823 run_redisplay_end_trigger_hook (struct it
*it
)
6825 Lisp_Object args
[3];
6827 /* IT->glyph_row should be non-null, i.e. we should be actually
6828 displaying something, or otherwise we should not run the hook. */
6829 xassert (it
->glyph_row
);
6831 /* Set up hook arguments. */
6832 args
[0] = Qredisplay_end_trigger_functions
;
6833 args
[1] = it
->window
;
6834 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6835 it
->redisplay_end_trigger_charpos
= 0;
6837 /* Since we are *trying* to run these functions, don't try to run
6838 them again, even if they get an error. */
6839 it
->w
->redisplay_end_trigger
= Qnil
;
6840 Frun_hook_with_args (3, args
);
6842 /* Notice if it changed the face of the character we are on. */
6843 handle_face_prop (it
);
6847 /* Deliver a composition display element. Unlike the other
6848 next_element_from_XXX, this function is not registered in the array
6849 get_next_element[]. It is called from next_element_from_buffer and
6850 next_element_from_string when necessary. */
6853 next_element_from_composition (struct it
*it
)
6855 it
->what
= IT_COMPOSITION
;
6856 it
->len
= it
->cmp_it
.nbytes
;
6857 if (STRINGP (it
->string
))
6861 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6862 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6865 it
->position
= it
->current
.string_pos
;
6866 it
->object
= it
->string
;
6867 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6868 IT_STRING_BYTEPOS (*it
), it
->string
);
6874 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6875 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6878 if (it
->bidi_it
.new_paragraph
)
6879 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6880 /* Resync the bidi iterator with IT's new position.
6881 FIXME: this doesn't support bidirectional text. */
6882 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6883 bidi_move_to_visually_next (&it
->bidi_it
);
6887 it
->position
= it
->current
.pos
;
6888 it
->object
= it
->w
->buffer
;
6889 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6890 IT_BYTEPOS (*it
), Qnil
);
6897 /***********************************************************************
6898 Moving an iterator without producing glyphs
6899 ***********************************************************************/
6901 /* Check if iterator is at a position corresponding to a valid buffer
6902 position after some move_it_ call. */
6904 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6905 ((it)->method == GET_FROM_STRING \
6906 ? IT_STRING_CHARPOS (*it) == 0 \
6910 /* Move iterator IT to a specified buffer or X position within one
6911 line on the display without producing glyphs.
6913 OP should be a bit mask including some or all of these bits:
6914 MOVE_TO_X: Stop upon reaching x-position TO_X.
6915 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6916 Regardless of OP's value, stop upon reaching the end of the display line.
6918 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6919 This means, in particular, that TO_X includes window's horizontal
6922 The return value has several possible values that
6923 say what condition caused the scan to stop:
6925 MOVE_POS_MATCH_OR_ZV
6926 - when TO_POS or ZV was reached.
6929 -when TO_X was reached before TO_POS or ZV were reached.
6932 - when we reached the end of the display area and the line must
6936 - when we reached the end of the display area and the line is
6940 - when we stopped at a line end, i.e. a newline or a CR and selective
6943 static enum move_it_result
6944 move_it_in_display_line_to (struct it
*it
,
6945 EMACS_INT to_charpos
, int to_x
,
6946 enum move_operation_enum op
)
6948 enum move_it_result result
= MOVE_UNDEFINED
;
6949 struct glyph_row
*saved_glyph_row
;
6950 struct it wrap_it
, atpos_it
, atx_it
;
6952 enum it_method prev_method
= it
->method
;
6953 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6955 /* Don't produce glyphs in produce_glyphs. */
6956 saved_glyph_row
= it
->glyph_row
;
6957 it
->glyph_row
= NULL
;
6959 /* Use wrap_it to save a copy of IT wherever a word wrap could
6960 occur. Use atpos_it to save a copy of IT at the desired buffer
6961 position, if found, so that we can scan ahead and check if the
6962 word later overshoots the window edge. Use atx_it similarly, for
6968 #define BUFFER_POS_REACHED_P() \
6969 ((op & MOVE_TO_POS) != 0 \
6970 && BUFFERP (it->object) \
6971 && (IT_CHARPOS (*it) == to_charpos \
6972 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6973 && (it->method == GET_FROM_BUFFER \
6974 || (it->method == GET_FROM_DISPLAY_VECTOR \
6975 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6977 /* If there's a line-/wrap-prefix, handle it. */
6978 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6979 && it
->current_y
< it
->last_visible_y
)
6980 handle_line_prefix (it
);
6982 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
6983 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6987 int x
, i
, ascent
= 0, descent
= 0;
6989 /* Utility macro to reset an iterator with x, ascent, and descent. */
6990 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6991 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6992 (IT)->max_descent = descent)
6994 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6996 if ((op
& MOVE_TO_POS
) != 0
6997 && BUFFERP (it
->object
)
6998 && it
->method
== GET_FROM_BUFFER
6999 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7001 && (prev_method
== GET_FROM_IMAGE
7002 || prev_method
== GET_FROM_STRETCH
)
7003 /* Passed TO_CHARPOS from left to right. */
7004 && ((prev_pos
< to_charpos
7005 && IT_CHARPOS (*it
) > to_charpos
)
7006 /* Passed TO_CHARPOS from right to left. */
7007 || (prev_pos
> to_charpos
7008 && IT_CHARPOS (*it
) < to_charpos
)))))
7010 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7012 result
= MOVE_POS_MATCH_OR_ZV
;
7015 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7016 /* If wrap_it is valid, the current position might be in a
7017 word that is wrapped. So, save the iterator in
7018 atpos_it and continue to see if wrapping happens. */
7022 prev_method
= it
->method
;
7023 if (it
->method
== GET_FROM_BUFFER
)
7024 prev_pos
= IT_CHARPOS (*it
);
7025 /* Stop when ZV reached.
7026 We used to stop here when TO_CHARPOS reached as well, but that is
7027 too soon if this glyph does not fit on this line. So we handle it
7028 explicitly below. */
7029 if (!get_next_display_element (it
))
7031 result
= MOVE_POS_MATCH_OR_ZV
;
7035 if (it
->line_wrap
== TRUNCATE
)
7037 if (BUFFER_POS_REACHED_P ())
7039 result
= MOVE_POS_MATCH_OR_ZV
;
7045 if (it
->line_wrap
== WORD_WRAP
)
7047 if (IT_DISPLAYING_WHITESPACE (it
))
7051 /* We have reached a glyph that follows one or more
7052 whitespace characters. If the position is
7053 already found, we are done. */
7054 if (atpos_it
.sp
>= 0)
7057 result
= MOVE_POS_MATCH_OR_ZV
;
7063 result
= MOVE_X_REACHED
;
7066 /* Otherwise, we can wrap here. */
7073 /* Remember the line height for the current line, in case
7074 the next element doesn't fit on the line. */
7075 ascent
= it
->max_ascent
;
7076 descent
= it
->max_descent
;
7078 /* The call to produce_glyphs will get the metrics of the
7079 display element IT is loaded with. Record the x-position
7080 before this display element, in case it doesn't fit on the
7084 PRODUCE_GLYPHS (it
);
7086 if (it
->area
!= TEXT_AREA
)
7088 set_iterator_to_next (it
, 1);
7089 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7090 SET_TEXT_POS (this_line_min_pos
,
7091 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7095 /* The number of glyphs we get back in IT->nglyphs will normally
7096 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7097 character on a terminal frame, or (iii) a line end. For the
7098 second case, IT->nglyphs - 1 padding glyphs will be present.
7099 (On X frames, there is only one glyph produced for a
7100 composite character.)
7102 The behavior implemented below means, for continuation lines,
7103 that as many spaces of a TAB as fit on the current line are
7104 displayed there. For terminal frames, as many glyphs of a
7105 multi-glyph character are displayed in the current line, too.
7106 This is what the old redisplay code did, and we keep it that
7107 way. Under X, the whole shape of a complex character must
7108 fit on the line or it will be completely displayed in the
7111 Note that both for tabs and padding glyphs, all glyphs have
7115 /* More than one glyph or glyph doesn't fit on line. All
7116 glyphs have the same width. */
7117 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7119 int x_before_this_char
= x
;
7120 int hpos_before_this_char
= it
->hpos
;
7122 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7124 new_x
= x
+ single_glyph_width
;
7126 /* We want to leave anything reaching TO_X to the caller. */
7127 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7129 if (BUFFER_POS_REACHED_P ())
7131 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7132 goto buffer_pos_reached
;
7133 if (atpos_it
.sp
< 0)
7136 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7141 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7144 result
= MOVE_X_REACHED
;
7150 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7155 if (/* Lines are continued. */
7156 it
->line_wrap
!= TRUNCATE
7157 && (/* And glyph doesn't fit on the line. */
7158 new_x
> it
->last_visible_x
7159 /* Or it fits exactly and we're on a window
7161 || (new_x
== it
->last_visible_x
7162 && FRAME_WINDOW_P (it
->f
))))
7164 if (/* IT->hpos == 0 means the very first glyph
7165 doesn't fit on the line, e.g. a wide image. */
7167 || (new_x
== it
->last_visible_x
7168 && FRAME_WINDOW_P (it
->f
)))
7171 it
->current_x
= new_x
;
7173 /* The character's last glyph just barely fits
7175 if (i
== it
->nglyphs
- 1)
7177 /* If this is the destination position,
7178 return a position *before* it in this row,
7179 now that we know it fits in this row. */
7180 if (BUFFER_POS_REACHED_P ())
7182 if (it
->line_wrap
!= WORD_WRAP
7185 it
->hpos
= hpos_before_this_char
;
7186 it
->current_x
= x_before_this_char
;
7187 result
= MOVE_POS_MATCH_OR_ZV
;
7190 if (it
->line_wrap
== WORD_WRAP
7194 atpos_it
.current_x
= x_before_this_char
;
7195 atpos_it
.hpos
= hpos_before_this_char
;
7199 set_iterator_to_next (it
, 1);
7200 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7201 SET_TEXT_POS (this_line_min_pos
,
7202 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7203 /* On graphical terminals, newlines may
7204 "overflow" into the fringe if
7205 overflow-newline-into-fringe is non-nil.
7206 On text-only terminals, newlines may
7207 overflow into the last glyph on the
7209 if (!FRAME_WINDOW_P (it
->f
)
7210 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7212 if (!get_next_display_element (it
))
7214 result
= MOVE_POS_MATCH_OR_ZV
;
7217 if (BUFFER_POS_REACHED_P ())
7219 if (ITERATOR_AT_END_OF_LINE_P (it
))
7220 result
= MOVE_POS_MATCH_OR_ZV
;
7222 result
= MOVE_LINE_CONTINUED
;
7225 if (ITERATOR_AT_END_OF_LINE_P (it
))
7227 result
= MOVE_NEWLINE_OR_CR
;
7234 IT_RESET_X_ASCENT_DESCENT (it
);
7236 if (wrap_it
.sp
>= 0)
7243 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7245 result
= MOVE_LINE_CONTINUED
;
7249 if (BUFFER_POS_REACHED_P ())
7251 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7252 goto buffer_pos_reached
;
7253 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7256 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7260 if (new_x
> it
->first_visible_x
)
7262 /* Glyph is visible. Increment number of glyphs that
7263 would be displayed. */
7268 if (result
!= MOVE_UNDEFINED
)
7271 else if (BUFFER_POS_REACHED_P ())
7274 IT_RESET_X_ASCENT_DESCENT (it
);
7275 result
= MOVE_POS_MATCH_OR_ZV
;
7278 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7280 /* Stop when TO_X specified and reached. This check is
7281 necessary here because of lines consisting of a line end,
7282 only. The line end will not produce any glyphs and we
7283 would never get MOVE_X_REACHED. */
7284 xassert (it
->nglyphs
== 0);
7285 result
= MOVE_X_REACHED
;
7289 /* Is this a line end? If yes, we're done. */
7290 if (ITERATOR_AT_END_OF_LINE_P (it
))
7292 result
= MOVE_NEWLINE_OR_CR
;
7296 if (it
->method
== GET_FROM_BUFFER
)
7297 prev_pos
= IT_CHARPOS (*it
);
7298 /* The current display element has been consumed. Advance
7300 set_iterator_to_next (it
, 1);
7301 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7302 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7304 /* Stop if lines are truncated and IT's current x-position is
7305 past the right edge of the window now. */
7306 if (it
->line_wrap
== TRUNCATE
7307 && it
->current_x
>= it
->last_visible_x
)
7309 if (!FRAME_WINDOW_P (it
->f
)
7310 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7312 if (!get_next_display_element (it
)
7313 || BUFFER_POS_REACHED_P ())
7315 result
= MOVE_POS_MATCH_OR_ZV
;
7318 if (ITERATOR_AT_END_OF_LINE_P (it
))
7320 result
= MOVE_NEWLINE_OR_CR
;
7324 result
= MOVE_LINE_TRUNCATED
;
7327 #undef IT_RESET_X_ASCENT_DESCENT
7330 #undef BUFFER_POS_REACHED_P
7332 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7333 restore the saved iterator. */
7334 if (atpos_it
.sp
>= 0)
7336 else if (atx_it
.sp
>= 0)
7341 /* Restore the iterator settings altered at the beginning of this
7343 it
->glyph_row
= saved_glyph_row
;
7347 /* For external use. */
7349 move_it_in_display_line (struct it
*it
,
7350 EMACS_INT to_charpos
, int to_x
,
7351 enum move_operation_enum op
)
7353 if (it
->line_wrap
== WORD_WRAP
7354 && (op
& MOVE_TO_X
))
7356 struct it save_it
= *it
;
7357 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7358 /* When word-wrap is on, TO_X may lie past the end
7359 of a wrapped line. Then it->current is the
7360 character on the next line, so backtrack to the
7361 space before the wrap point. */
7362 if (skip
== MOVE_LINE_CONTINUED
)
7364 int prev_x
= max (it
->current_x
- 1, 0);
7366 move_it_in_display_line_to
7367 (it
, -1, prev_x
, MOVE_TO_X
);
7371 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7375 /* Move IT forward until it satisfies one or more of the criteria in
7376 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7378 OP is a bit-mask that specifies where to stop, and in particular,
7379 which of those four position arguments makes a difference. See the
7380 description of enum move_operation_enum.
7382 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7383 screen line, this function will set IT to the next position >
7387 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7389 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7390 int line_height
, line_start_x
= 0, reached
= 0;
7394 if (op
& MOVE_TO_VPOS
)
7396 /* If no TO_CHARPOS and no TO_X specified, stop at the
7397 start of the line TO_VPOS. */
7398 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7400 if (it
->vpos
== to_vpos
)
7406 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7410 /* TO_VPOS >= 0 means stop at TO_X in the line at
7411 TO_VPOS, or at TO_POS, whichever comes first. */
7412 if (it
->vpos
== to_vpos
)
7418 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7420 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7425 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7427 /* We have reached TO_X but not in the line we want. */
7428 skip
= move_it_in_display_line_to (it
, to_charpos
,
7430 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7438 else if (op
& MOVE_TO_Y
)
7440 struct it it_backup
;
7442 if (it
->line_wrap
== WORD_WRAP
)
7445 /* TO_Y specified means stop at TO_X in the line containing
7446 TO_Y---or at TO_CHARPOS if this is reached first. The
7447 problem is that we can't really tell whether the line
7448 contains TO_Y before we have completely scanned it, and
7449 this may skip past TO_X. What we do is to first scan to
7452 If TO_X is not specified, use a TO_X of zero. The reason
7453 is to make the outcome of this function more predictable.
7454 If we didn't use TO_X == 0, we would stop at the end of
7455 the line which is probably not what a caller would expect
7457 skip
= move_it_in_display_line_to
7458 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7459 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7461 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7462 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7464 else if (skip
== MOVE_X_REACHED
)
7466 /* If TO_X was reached, we want to know whether TO_Y is
7467 in the line. We know this is the case if the already
7468 scanned glyphs make the line tall enough. Otherwise,
7469 we must check by scanning the rest of the line. */
7470 line_height
= it
->max_ascent
+ it
->max_descent
;
7471 if (to_y
>= it
->current_y
7472 && to_y
< it
->current_y
+ line_height
)
7478 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7479 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7481 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7482 line_height
= it
->max_ascent
+ it
->max_descent
;
7483 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7485 if (to_y
>= it
->current_y
7486 && to_y
< it
->current_y
+ line_height
)
7488 /* If TO_Y is in this line and TO_X was reached
7489 above, we scanned too far. We have to restore
7490 IT's settings to the ones before skipping. */
7497 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7503 /* Check whether TO_Y is in this line. */
7504 line_height
= it
->max_ascent
+ it
->max_descent
;
7505 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7507 if (to_y
>= it
->current_y
7508 && to_y
< it
->current_y
+ line_height
)
7510 /* When word-wrap is on, TO_X may lie past the end
7511 of a wrapped line. Then it->current is the
7512 character on the next line, so backtrack to the
7513 space before the wrap point. */
7514 if (skip
== MOVE_LINE_CONTINUED
7515 && it
->line_wrap
== WORD_WRAP
)
7517 int prev_x
= max (it
->current_x
- 1, 0);
7519 skip
= move_it_in_display_line_to
7520 (it
, -1, prev_x
, MOVE_TO_X
);
7529 else if (BUFFERP (it
->object
)
7530 && (it
->method
== GET_FROM_BUFFER
7531 || it
->method
== GET_FROM_STRETCH
)
7532 && IT_CHARPOS (*it
) >= to_charpos
)
7533 skip
= MOVE_POS_MATCH_OR_ZV
;
7535 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7539 case MOVE_POS_MATCH_OR_ZV
:
7543 case MOVE_NEWLINE_OR_CR
:
7544 set_iterator_to_next (it
, 1);
7545 it
->continuation_lines_width
= 0;
7548 case MOVE_LINE_TRUNCATED
:
7549 it
->continuation_lines_width
= 0;
7550 reseat_at_next_visible_line_start (it
, 0);
7551 if ((op
& MOVE_TO_POS
) != 0
7552 && IT_CHARPOS (*it
) > to_charpos
)
7559 case MOVE_LINE_CONTINUED
:
7560 /* For continued lines ending in a tab, some of the glyphs
7561 associated with the tab are displayed on the current
7562 line. Since it->current_x does not include these glyphs,
7563 we use it->last_visible_x instead. */
7566 it
->continuation_lines_width
+= it
->last_visible_x
;
7567 /* When moving by vpos, ensure that the iterator really
7568 advances to the next line (bug#847, bug#969). Fixme:
7569 do we need to do this in other circumstances? */
7570 if (it
->current_x
!= it
->last_visible_x
7571 && (op
& MOVE_TO_VPOS
)
7572 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7574 line_start_x
= it
->current_x
+ it
->pixel_width
7575 - it
->last_visible_x
;
7576 set_iterator_to_next (it
, 0);
7580 it
->continuation_lines_width
+= it
->current_x
;
7587 /* Reset/increment for the next run. */
7588 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7589 it
->current_x
= line_start_x
;
7592 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7594 last_height
= it
->max_ascent
+ it
->max_descent
;
7595 last_max_ascent
= it
->max_ascent
;
7596 it
->max_ascent
= it
->max_descent
= 0;
7601 /* On text terminals, we may stop at the end of a line in the middle
7602 of a multi-character glyph. If the glyph itself is continued,
7603 i.e. it is actually displayed on the next line, don't treat this
7604 stopping point as valid; move to the next line instead (unless
7605 that brings us offscreen). */
7606 if (!FRAME_WINDOW_P (it
->f
)
7608 && IT_CHARPOS (*it
) == to_charpos
7609 && it
->what
== IT_CHARACTER
7611 && it
->line_wrap
== WINDOW_WRAP
7612 && it
->current_x
== it
->last_visible_x
- 1
7615 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7617 it
->continuation_lines_width
+= it
->current_x
;
7618 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7619 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7621 last_height
= it
->max_ascent
+ it
->max_descent
;
7622 last_max_ascent
= it
->max_ascent
;
7625 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7629 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7631 If DY > 0, move IT backward at least that many pixels. DY = 0
7632 means move IT backward to the preceding line start or BEGV. This
7633 function may move over more than DY pixels if IT->current_y - DY
7634 ends up in the middle of a line; in this case IT->current_y will be
7635 set to the top of the line moved to. */
7638 move_it_vertically_backward (struct it
*it
, int dy
)
7642 EMACS_INT start_pos
;
7647 start_pos
= IT_CHARPOS (*it
);
7649 /* Estimate how many newlines we must move back. */
7650 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7652 /* Set the iterator's position that many lines back. */
7653 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7654 back_to_previous_visible_line_start (it
);
7656 /* Reseat the iterator here. When moving backward, we don't want
7657 reseat to skip forward over invisible text, set up the iterator
7658 to deliver from overlay strings at the new position etc. So,
7659 use reseat_1 here. */
7660 reseat_1 (it
, it
->current
.pos
, 1);
7662 /* We are now surely at a line start. */
7663 it
->current_x
= it
->hpos
= 0;
7664 it
->continuation_lines_width
= 0;
7666 /* Move forward and see what y-distance we moved. First move to the
7667 start of the next line so that we get its height. We need this
7668 height to be able to tell whether we reached the specified
7671 it2
.max_ascent
= it2
.max_descent
= 0;
7674 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7675 MOVE_TO_POS
| MOVE_TO_VPOS
);
7677 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7678 xassert (IT_CHARPOS (*it
) >= BEGV
);
7681 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7682 xassert (IT_CHARPOS (*it
) >= BEGV
);
7683 /* H is the actual vertical distance from the position in *IT
7684 and the starting position. */
7685 h
= it2
.current_y
- it
->current_y
;
7686 /* NLINES is the distance in number of lines. */
7687 nlines
= it2
.vpos
- it
->vpos
;
7689 /* Correct IT's y and vpos position
7690 so that they are relative to the starting point. */
7696 /* DY == 0 means move to the start of the screen line. The
7697 value of nlines is > 0 if continuation lines were involved. */
7699 move_it_by_lines (it
, nlines
);
7703 /* The y-position we try to reach, relative to *IT.
7704 Note that H has been subtracted in front of the if-statement. */
7705 int target_y
= it
->current_y
+ h
- dy
;
7706 int y0
= it3
.current_y
;
7707 int y1
= line_bottom_y (&it3
);
7708 int line_height
= y1
- y0
;
7710 /* If we did not reach target_y, try to move further backward if
7711 we can. If we moved too far backward, try to move forward. */
7712 if (target_y
< it
->current_y
7713 /* This is heuristic. In a window that's 3 lines high, with
7714 a line height of 13 pixels each, recentering with point
7715 on the bottom line will try to move -39/2 = 19 pixels
7716 backward. Try to avoid moving into the first line. */
7717 && (it
->current_y
- target_y
7718 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7719 && IT_CHARPOS (*it
) > BEGV
)
7721 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7722 target_y
- it
->current_y
));
7723 dy
= it
->current_y
- target_y
;
7724 goto move_further_back
;
7726 else if (target_y
>= it
->current_y
+ line_height
7727 && IT_CHARPOS (*it
) < ZV
)
7729 /* Should move forward by at least one line, maybe more.
7731 Note: Calling move_it_by_lines can be expensive on
7732 terminal frames, where compute_motion is used (via
7733 vmotion) to do the job, when there are very long lines
7734 and truncate-lines is nil. That's the reason for
7735 treating terminal frames specially here. */
7737 if (!FRAME_WINDOW_P (it
->f
))
7738 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7743 move_it_by_lines (it
, 1);
7745 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7752 /* Move IT by a specified amount of pixel lines DY. DY negative means
7753 move backwards. DY = 0 means move to start of screen line. At the
7754 end, IT will be on the start of a screen line. */
7757 move_it_vertically (struct it
*it
, int dy
)
7760 move_it_vertically_backward (it
, -dy
);
7763 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7764 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7765 MOVE_TO_POS
| MOVE_TO_Y
);
7766 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7768 /* If buffer ends in ZV without a newline, move to the start of
7769 the line to satisfy the post-condition. */
7770 if (IT_CHARPOS (*it
) == ZV
7772 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7773 move_it_by_lines (it
, 0);
7778 /* Move iterator IT past the end of the text line it is in. */
7781 move_it_past_eol (struct it
*it
)
7783 enum move_it_result rc
;
7785 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7786 if (rc
== MOVE_NEWLINE_OR_CR
)
7787 set_iterator_to_next (it
, 0);
7791 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7792 negative means move up. DVPOS == 0 means move to the start of the
7795 Optimization idea: If we would know that IT->f doesn't use
7796 a face with proportional font, we could be faster for
7797 truncate-lines nil. */
7800 move_it_by_lines (struct it
*it
, int dvpos
)
7803 /* The commented-out optimization uses vmotion on terminals. This
7804 gives bad results, because elements like it->what, on which
7805 callers such as pos_visible_p rely, aren't updated. */
7806 /* struct position pos;
7807 if (!FRAME_WINDOW_P (it->f))
7809 struct text_pos textpos;
7811 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7812 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7813 reseat (it, textpos, 1);
7814 it->vpos += pos.vpos;
7815 it->current_y += pos.vpos;
7821 /* DVPOS == 0 means move to the start of the screen line. */
7822 move_it_vertically_backward (it
, 0);
7823 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7824 /* Let next call to line_bottom_y calculate real line height */
7829 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7830 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7831 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7836 EMACS_INT start_charpos
, i
;
7838 /* Start at the beginning of the screen line containing IT's
7839 position. This may actually move vertically backwards,
7840 in case of overlays, so adjust dvpos accordingly. */
7842 move_it_vertically_backward (it
, 0);
7845 /* Go back -DVPOS visible lines and reseat the iterator there. */
7846 start_charpos
= IT_CHARPOS (*it
);
7847 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7848 back_to_previous_visible_line_start (it
);
7849 reseat (it
, it
->current
.pos
, 1);
7851 /* Move further back if we end up in a string or an image. */
7852 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7854 /* First try to move to start of display line. */
7856 move_it_vertically_backward (it
, 0);
7858 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7860 /* If start of line is still in string or image,
7861 move further back. */
7862 back_to_previous_visible_line_start (it
);
7863 reseat (it
, it
->current
.pos
, 1);
7867 it
->current_x
= it
->hpos
= 0;
7869 /* Above call may have moved too far if continuation lines
7870 are involved. Scan forward and see if it did. */
7872 it2
.vpos
= it2
.current_y
= 0;
7873 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7874 it
->vpos
-= it2
.vpos
;
7875 it
->current_y
-= it2
.current_y
;
7876 it
->current_x
= it
->hpos
= 0;
7878 /* If we moved too far back, move IT some lines forward. */
7879 if (it2
.vpos
> -dvpos
)
7881 int delta
= it2
.vpos
+ dvpos
;
7883 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7884 /* Move back again if we got too far ahead. */
7885 if (IT_CHARPOS (*it
) >= start_charpos
)
7891 /* Return 1 if IT points into the middle of a display vector. */
7894 in_display_vector_p (struct it
*it
)
7896 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7897 && it
->current
.dpvec_index
> 0
7898 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7902 /***********************************************************************
7904 ***********************************************************************/
7907 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7911 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7913 Lisp_Object args
[3];
7914 Lisp_Object msg
, fmt
;
7917 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7920 /* Do nothing if called asynchronously. Inserting text into
7921 a buffer may call after-change-functions and alike and
7922 that would means running Lisp asynchronously. */
7923 if (handling_signal
)
7927 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7929 args
[0] = fmt
= build_string (format
);
7932 msg
= Fformat (3, args
);
7934 len
= SBYTES (msg
) + 1;
7935 SAFE_ALLOCA (buffer
, char *, len
);
7936 memcpy (buffer
, SDATA (msg
), len
);
7938 message_dolog (buffer
, len
- 1, 1, 0);
7945 /* Output a newline in the *Messages* buffer if "needs" one. */
7948 message_log_maybe_newline (void)
7950 if (message_log_need_newline
)
7951 message_dolog ("", 0, 1, 0);
7955 /* Add a string M of length NBYTES to the message log, optionally
7956 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7957 nonzero, means interpret the contents of M as multibyte. This
7958 function calls low-level routines in order to bypass text property
7959 hooks, etc. which might not be safe to run.
7961 This may GC (insert may run before/after change hooks),
7962 so the buffer M must NOT point to a Lisp string. */
7965 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7967 const unsigned char *msg
= (const unsigned char *) m
;
7969 if (!NILP (Vmemory_full
))
7972 if (!NILP (Vmessage_log_max
))
7974 struct buffer
*oldbuf
;
7975 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7976 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7977 EMACS_INT point_at_end
= 0;
7978 EMACS_INT zv_at_end
= 0;
7979 Lisp_Object old_deactivate_mark
, tem
;
7980 struct gcpro gcpro1
;
7982 old_deactivate_mark
= Vdeactivate_mark
;
7983 oldbuf
= current_buffer
;
7984 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7985 BVAR (current_buffer
, undo_list
) = Qt
;
7987 oldpoint
= message_dolog_marker1
;
7988 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7989 oldbegv
= message_dolog_marker2
;
7990 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7991 oldzv
= message_dolog_marker3
;
7992 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7993 GCPRO1 (old_deactivate_mark
);
8001 BEGV_BYTE
= BEG_BYTE
;
8004 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8006 /* Insert the string--maybe converting multibyte to single byte
8007 or vice versa, so that all the text fits the buffer. */
8009 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8015 /* Convert a multibyte string to single-byte
8016 for the *Message* buffer. */
8017 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8019 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8020 work
[0] = (ASCII_CHAR_P (c
)
8022 : multibyte_char_to_unibyte (c
));
8023 insert_1_both (work
, 1, 1, 1, 0, 0);
8026 else if (! multibyte
8027 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8031 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8032 /* Convert a single-byte string to multibyte
8033 for the *Message* buffer. */
8034 for (i
= 0; i
< nbytes
; i
++)
8037 MAKE_CHAR_MULTIBYTE (c
);
8038 char_bytes
= CHAR_STRING (c
, str
);
8039 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8043 insert_1 (m
, nbytes
, 1, 0, 0);
8047 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8048 unsigned long int dups
;
8049 insert_1 ("\n", 1, 1, 0, 0);
8051 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8053 this_bol_byte
= PT_BYTE
;
8055 /* See if this line duplicates the previous one.
8056 If so, combine duplicates. */
8059 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8061 prev_bol_byte
= PT_BYTE
;
8063 dups
= message_log_check_duplicate (prev_bol_byte
,
8067 del_range_both (prev_bol
, prev_bol_byte
,
8068 this_bol
, this_bol_byte
, 0);
8074 /* If you change this format, don't forget to also
8075 change message_log_check_duplicate. */
8076 sprintf (dupstr
, " [%lu times]", dups
);
8077 duplen
= strlen (dupstr
);
8078 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8079 insert_1 (dupstr
, duplen
, 1, 0, 1);
8084 /* If we have more than the desired maximum number of lines
8085 in the *Messages* buffer now, delete the oldest ones.
8086 This is safe because we don't have undo in this buffer. */
8088 if (NATNUMP (Vmessage_log_max
))
8090 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8091 -XFASTINT (Vmessage_log_max
) - 1, 0);
8092 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8095 BEGV
= XMARKER (oldbegv
)->charpos
;
8096 BEGV_BYTE
= marker_byte_position (oldbegv
);
8105 ZV
= XMARKER (oldzv
)->charpos
;
8106 ZV_BYTE
= marker_byte_position (oldzv
);
8110 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8112 /* We can't do Fgoto_char (oldpoint) because it will run some
8114 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8115 XMARKER (oldpoint
)->bytepos
);
8118 unchain_marker (XMARKER (oldpoint
));
8119 unchain_marker (XMARKER (oldbegv
));
8120 unchain_marker (XMARKER (oldzv
));
8122 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8123 set_buffer_internal (oldbuf
);
8125 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8126 message_log_need_newline
= !nlflag
;
8127 Vdeactivate_mark
= old_deactivate_mark
;
8132 /* We are at the end of the buffer after just having inserted a newline.
8133 (Note: We depend on the fact we won't be crossing the gap.)
8134 Check to see if the most recent message looks a lot like the previous one.
8135 Return 0 if different, 1 if the new one should just replace it, or a
8136 value N > 1 if we should also append " [N times]". */
8138 static unsigned long int
8139 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8142 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8144 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8145 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8147 for (i
= 0; i
< len
; i
++)
8149 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8157 if (*p1
++ == ' ' && *p1
++ == '[')
8160 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8161 if (strncmp (pend
, " times]\n", 8) == 0)
8168 /* Display an echo area message M with a specified length of NBYTES
8169 bytes. The string may include null characters. If M is 0, clear
8170 out any existing message, and let the mini-buffer text show
8173 This may GC, so the buffer M must NOT point to a Lisp string. */
8176 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8178 /* First flush out any partial line written with print. */
8179 message_log_maybe_newline ();
8181 message_dolog (m
, nbytes
, 1, multibyte
);
8182 message2_nolog (m
, nbytes
, multibyte
);
8186 /* The non-logging counterpart of message2. */
8189 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8191 struct frame
*sf
= SELECTED_FRAME ();
8192 message_enable_multibyte
= multibyte
;
8194 if (FRAME_INITIAL_P (sf
))
8196 if (noninteractive_need_newline
)
8197 putc ('\n', stderr
);
8198 noninteractive_need_newline
= 0;
8200 fwrite (m
, nbytes
, 1, stderr
);
8201 if (cursor_in_echo_area
== 0)
8202 fprintf (stderr
, "\n");
8205 /* A null message buffer means that the frame hasn't really been
8206 initialized yet. Error messages get reported properly by
8207 cmd_error, so this must be just an informative message; toss it. */
8208 else if (INTERACTIVE
8209 && sf
->glyphs_initialized_p
8210 && FRAME_MESSAGE_BUF (sf
))
8212 Lisp_Object mini_window
;
8215 /* Get the frame containing the mini-buffer
8216 that the selected frame is using. */
8217 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8218 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8220 FRAME_SAMPLE_VISIBILITY (f
);
8221 if (FRAME_VISIBLE_P (sf
)
8222 && ! FRAME_VISIBLE_P (f
))
8223 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8227 set_message (m
, Qnil
, nbytes
, multibyte
);
8228 if (minibuffer_auto_raise
)
8229 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8232 clear_message (1, 1);
8234 do_pending_window_change (0);
8235 echo_area_display (1);
8236 do_pending_window_change (0);
8237 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8238 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8243 /* Display an echo area message M with a specified length of NBYTES
8244 bytes. The string may include null characters. If M is not a
8245 string, clear out any existing message, and let the mini-buffer
8248 This function cancels echoing. */
8251 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8253 struct gcpro gcpro1
;
8256 clear_message (1,1);
8259 /* First flush out any partial line written with print. */
8260 message_log_maybe_newline ();
8266 SAFE_ALLOCA (buffer
, char *, nbytes
);
8267 memcpy (buffer
, SDATA (m
), nbytes
);
8268 message_dolog (buffer
, nbytes
, 1, multibyte
);
8271 message3_nolog (m
, nbytes
, multibyte
);
8277 /* The non-logging version of message3.
8278 This does not cancel echoing, because it is used for echoing.
8279 Perhaps we need to make a separate function for echoing
8280 and make this cancel echoing. */
8283 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8285 struct frame
*sf
= SELECTED_FRAME ();
8286 message_enable_multibyte
= multibyte
;
8288 if (FRAME_INITIAL_P (sf
))
8290 if (noninteractive_need_newline
)
8291 putc ('\n', stderr
);
8292 noninteractive_need_newline
= 0;
8294 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8295 if (cursor_in_echo_area
== 0)
8296 fprintf (stderr
, "\n");
8299 /* A null message buffer means that the frame hasn't really been
8300 initialized yet. Error messages get reported properly by
8301 cmd_error, so this must be just an informative message; toss it. */
8302 else if (INTERACTIVE
8303 && sf
->glyphs_initialized_p
8304 && FRAME_MESSAGE_BUF (sf
))
8306 Lisp_Object mini_window
;
8310 /* Get the frame containing the mini-buffer
8311 that the selected frame is using. */
8312 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8313 frame
= XWINDOW (mini_window
)->frame
;
8316 FRAME_SAMPLE_VISIBILITY (f
);
8317 if (FRAME_VISIBLE_P (sf
)
8318 && !FRAME_VISIBLE_P (f
))
8319 Fmake_frame_visible (frame
);
8321 if (STRINGP (m
) && SCHARS (m
) > 0)
8323 set_message (NULL
, m
, nbytes
, multibyte
);
8324 if (minibuffer_auto_raise
)
8325 Fraise_frame (frame
);
8326 /* Assume we are not echoing.
8327 (If we are, echo_now will override this.) */
8328 echo_message_buffer
= Qnil
;
8331 clear_message (1, 1);
8333 do_pending_window_change (0);
8334 echo_area_display (1);
8335 do_pending_window_change (0);
8336 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8337 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8342 /* Display a null-terminated echo area message M. If M is 0, clear
8343 out any existing message, and let the mini-buffer text show through.
8345 The buffer M must continue to exist until after the echo area gets
8346 cleared or some other message gets displayed there. Do not pass
8347 text that is stored in a Lisp string. Do not pass text in a buffer
8348 that was alloca'd. */
8351 message1 (const char *m
)
8353 message2 (m
, (m
? strlen (m
) : 0), 0);
8357 /* The non-logging counterpart of message1. */
8360 message1_nolog (const char *m
)
8362 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8365 /* Display a message M which contains a single %s
8366 which gets replaced with STRING. */
8369 message_with_string (const char *m
, Lisp_Object string
, int log
)
8371 CHECK_STRING (string
);
8377 if (noninteractive_need_newline
)
8378 putc ('\n', stderr
);
8379 noninteractive_need_newline
= 0;
8380 fprintf (stderr
, m
, SDATA (string
));
8381 if (!cursor_in_echo_area
)
8382 fprintf (stderr
, "\n");
8386 else if (INTERACTIVE
)
8388 /* The frame whose minibuffer we're going to display the message on.
8389 It may be larger than the selected frame, so we need
8390 to use its buffer, not the selected frame's buffer. */
8391 Lisp_Object mini_window
;
8392 struct frame
*f
, *sf
= SELECTED_FRAME ();
8394 /* Get the frame containing the minibuffer
8395 that the selected frame is using. */
8396 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8397 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8399 /* A null message buffer means that the frame hasn't really been
8400 initialized yet. Error messages get reported properly by
8401 cmd_error, so this must be just an informative message; toss it. */
8402 if (FRAME_MESSAGE_BUF (f
))
8404 Lisp_Object args
[2], msg
;
8405 struct gcpro gcpro1
, gcpro2
;
8407 args
[0] = build_string (m
);
8408 args
[1] = msg
= string
;
8409 GCPRO2 (args
[0], msg
);
8412 msg
= Fformat (2, args
);
8415 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8417 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8421 /* Print should start at the beginning of the message
8422 buffer next time. */
8423 message_buf_print
= 0;
8429 /* Dump an informative message to the minibuf. If M is 0, clear out
8430 any existing message, and let the mini-buffer text show through. */
8433 vmessage (const char *m
, va_list ap
)
8439 if (noninteractive_need_newline
)
8440 putc ('\n', stderr
);
8441 noninteractive_need_newline
= 0;
8442 vfprintf (stderr
, m
, ap
);
8443 if (cursor_in_echo_area
== 0)
8444 fprintf (stderr
, "\n");
8448 else if (INTERACTIVE
)
8450 /* The frame whose mini-buffer we're going to display the message
8451 on. It may be larger than the selected frame, so we need to
8452 use its buffer, not the selected frame's buffer. */
8453 Lisp_Object mini_window
;
8454 struct frame
*f
, *sf
= SELECTED_FRAME ();
8456 /* Get the frame containing the mini-buffer
8457 that the selected frame is using. */
8458 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8459 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8461 /* A null message buffer means that the frame hasn't really been
8462 initialized yet. Error messages get reported properly by
8463 cmd_error, so this must be just an informative message; toss
8465 if (FRAME_MESSAGE_BUF (f
))
8471 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8472 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8474 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8479 /* Print should start at the beginning of the message
8480 buffer next time. */
8481 message_buf_print
= 0;
8487 message (const char *m
, ...)
8497 /* The non-logging version of message. */
8500 message_nolog (const char *m
, ...)
8502 Lisp_Object old_log_max
;
8505 old_log_max
= Vmessage_log_max
;
8506 Vmessage_log_max
= Qnil
;
8508 Vmessage_log_max
= old_log_max
;
8514 /* Display the current message in the current mini-buffer. This is
8515 only called from error handlers in process.c, and is not time
8519 update_echo_area (void)
8521 if (!NILP (echo_area_buffer
[0]))
8524 string
= Fcurrent_message ();
8525 message3 (string
, SBYTES (string
),
8526 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8531 /* Make sure echo area buffers in `echo_buffers' are live.
8532 If they aren't, make new ones. */
8535 ensure_echo_area_buffers (void)
8539 for (i
= 0; i
< 2; ++i
)
8540 if (!BUFFERP (echo_buffer
[i
])
8541 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8544 Lisp_Object old_buffer
;
8547 old_buffer
= echo_buffer
[i
];
8548 sprintf (name
, " *Echo Area %d*", i
);
8549 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8550 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8551 /* to force word wrap in echo area -
8552 it was decided to postpone this*/
8553 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8555 for (j
= 0; j
< 2; ++j
)
8556 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8557 echo_area_buffer
[j
] = echo_buffer
[i
];
8562 /* Call FN with args A1..A4 with either the current or last displayed
8563 echo_area_buffer as current buffer.
8565 WHICH zero means use the current message buffer
8566 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8567 from echo_buffer[] and clear it.
8569 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8570 suitable buffer from echo_buffer[] and clear it.
8572 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8573 that the current message becomes the last displayed one, make
8574 choose a suitable buffer for echo_area_buffer[0], and clear it.
8576 Value is what FN returns. */
8579 with_echo_area_buffer (struct window
*w
, int which
,
8580 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8581 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8584 int this_one
, the_other
, clear_buffer_p
, rc
;
8585 int count
= SPECPDL_INDEX ();
8587 /* If buffers aren't live, make new ones. */
8588 ensure_echo_area_buffers ();
8593 this_one
= 0, the_other
= 1;
8595 this_one
= 1, the_other
= 0;
8598 this_one
= 0, the_other
= 1;
8601 /* We need a fresh one in case the current echo buffer equals
8602 the one containing the last displayed echo area message. */
8603 if (!NILP (echo_area_buffer
[this_one
])
8604 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8605 echo_area_buffer
[this_one
] = Qnil
;
8608 /* Choose a suitable buffer from echo_buffer[] is we don't
8610 if (NILP (echo_area_buffer
[this_one
]))
8612 echo_area_buffer
[this_one
]
8613 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8614 ? echo_buffer
[the_other
]
8615 : echo_buffer
[this_one
]);
8619 buffer
= echo_area_buffer
[this_one
];
8621 /* Don't get confused by reusing the buffer used for echoing
8622 for a different purpose. */
8623 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8626 record_unwind_protect (unwind_with_echo_area_buffer
,
8627 with_echo_area_buffer_unwind_data (w
));
8629 /* Make the echo area buffer current. Note that for display
8630 purposes, it is not necessary that the displayed window's buffer
8631 == current_buffer, except for text property lookup. So, let's
8632 only set that buffer temporarily here without doing a full
8633 Fset_window_buffer. We must also change w->pointm, though,
8634 because otherwise an assertions in unshow_buffer fails, and Emacs
8636 set_buffer_internal_1 (XBUFFER (buffer
));
8640 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8643 BVAR (current_buffer
, undo_list
) = Qt
;
8644 BVAR (current_buffer
, read_only
) = Qnil
;
8645 specbind (Qinhibit_read_only
, Qt
);
8646 specbind (Qinhibit_modification_hooks
, Qt
);
8648 if (clear_buffer_p
&& Z
> BEG
)
8651 xassert (BEGV
>= BEG
);
8652 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8654 rc
= fn (a1
, a2
, a3
, a4
);
8656 xassert (BEGV
>= BEG
);
8657 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8659 unbind_to (count
, Qnil
);
8664 /* Save state that should be preserved around the call to the function
8665 FN called in with_echo_area_buffer. */
8668 with_echo_area_buffer_unwind_data (struct window
*w
)
8671 Lisp_Object vector
, tmp
;
8673 /* Reduce consing by keeping one vector in
8674 Vwith_echo_area_save_vector. */
8675 vector
= Vwith_echo_area_save_vector
;
8676 Vwith_echo_area_save_vector
= Qnil
;
8679 vector
= Fmake_vector (make_number (7), Qnil
);
8681 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8682 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8683 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8687 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8688 ASET (vector
, i
, w
->buffer
); ++i
;
8689 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8690 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8695 for (; i
< end
; ++i
)
8696 ASET (vector
, i
, Qnil
);
8699 xassert (i
== ASIZE (vector
));
8704 /* Restore global state from VECTOR which was created by
8705 with_echo_area_buffer_unwind_data. */
8708 unwind_with_echo_area_buffer (Lisp_Object vector
)
8710 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8711 Vdeactivate_mark
= AREF (vector
, 1);
8712 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8714 if (WINDOWP (AREF (vector
, 3)))
8717 Lisp_Object buffer
, charpos
, bytepos
;
8719 w
= XWINDOW (AREF (vector
, 3));
8720 buffer
= AREF (vector
, 4);
8721 charpos
= AREF (vector
, 5);
8722 bytepos
= AREF (vector
, 6);
8725 set_marker_both (w
->pointm
, buffer
,
8726 XFASTINT (charpos
), XFASTINT (bytepos
));
8729 Vwith_echo_area_save_vector
= vector
;
8734 /* Set up the echo area for use by print functions. MULTIBYTE_P
8735 non-zero means we will print multibyte. */
8738 setup_echo_area_for_printing (int multibyte_p
)
8740 /* If we can't find an echo area any more, exit. */
8741 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8744 ensure_echo_area_buffers ();
8746 if (!message_buf_print
)
8748 /* A message has been output since the last time we printed.
8749 Choose a fresh echo area buffer. */
8750 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8751 echo_area_buffer
[0] = echo_buffer
[1];
8753 echo_area_buffer
[0] = echo_buffer
[0];
8755 /* Switch to that buffer and clear it. */
8756 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8757 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8761 int count
= SPECPDL_INDEX ();
8762 specbind (Qinhibit_read_only
, Qt
);
8763 /* Note that undo recording is always disabled. */
8765 unbind_to (count
, Qnil
);
8767 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8769 /* Set up the buffer for the multibyteness we need. */
8771 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8772 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8774 /* Raise the frame containing the echo area. */
8775 if (minibuffer_auto_raise
)
8777 struct frame
*sf
= SELECTED_FRAME ();
8778 Lisp_Object mini_window
;
8779 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8780 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8783 message_log_maybe_newline ();
8784 message_buf_print
= 1;
8788 if (NILP (echo_area_buffer
[0]))
8790 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8791 echo_area_buffer
[0] = echo_buffer
[1];
8793 echo_area_buffer
[0] = echo_buffer
[0];
8796 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8798 /* Someone switched buffers between print requests. */
8799 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8800 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8806 /* Display an echo area message in window W. Value is non-zero if W's
8807 height is changed. If display_last_displayed_message_p is
8808 non-zero, display the message that was last displayed, otherwise
8809 display the current message. */
8812 display_echo_area (struct window
*w
)
8814 int i
, no_message_p
, window_height_changed_p
, count
;
8816 /* Temporarily disable garbage collections while displaying the echo
8817 area. This is done because a GC can print a message itself.
8818 That message would modify the echo area buffer's contents while a
8819 redisplay of the buffer is going on, and seriously confuse
8821 count
= inhibit_garbage_collection ();
8823 /* If there is no message, we must call display_echo_area_1
8824 nevertheless because it resizes the window. But we will have to
8825 reset the echo_area_buffer in question to nil at the end because
8826 with_echo_area_buffer will sets it to an empty buffer. */
8827 i
= display_last_displayed_message_p
? 1 : 0;
8828 no_message_p
= NILP (echo_area_buffer
[i
]);
8830 window_height_changed_p
8831 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8832 display_echo_area_1
,
8833 (intptr_t) w
, Qnil
, 0, 0);
8836 echo_area_buffer
[i
] = Qnil
;
8838 unbind_to (count
, Qnil
);
8839 return window_height_changed_p
;
8843 /* Helper for display_echo_area. Display the current buffer which
8844 contains the current echo area message in window W, a mini-window,
8845 a pointer to which is passed in A1. A2..A4 are currently not used.
8846 Change the height of W so that all of the message is displayed.
8847 Value is non-zero if height of W was changed. */
8850 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8853 struct window
*w
= (struct window
*) i1
;
8855 struct text_pos start
;
8856 int window_height_changed_p
= 0;
8858 /* Do this before displaying, so that we have a large enough glyph
8859 matrix for the display. If we can't get enough space for the
8860 whole text, display the last N lines. That works by setting w->start. */
8861 window_height_changed_p
= resize_mini_window (w
, 0);
8863 /* Use the starting position chosen by resize_mini_window. */
8864 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8867 clear_glyph_matrix (w
->desired_matrix
);
8868 XSETWINDOW (window
, w
);
8869 try_window (window
, start
, 0);
8871 return window_height_changed_p
;
8875 /* Resize the echo area window to exactly the size needed for the
8876 currently displayed message, if there is one. If a mini-buffer
8877 is active, don't shrink it. */
8880 resize_echo_area_exactly (void)
8882 if (BUFFERP (echo_area_buffer
[0])
8883 && WINDOWP (echo_area_window
))
8885 struct window
*w
= XWINDOW (echo_area_window
);
8887 Lisp_Object resize_exactly
;
8889 if (minibuf_level
== 0)
8890 resize_exactly
= Qt
;
8892 resize_exactly
= Qnil
;
8894 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8895 (intptr_t) w
, resize_exactly
,
8899 ++windows_or_buffers_changed
;
8900 ++update_mode_lines
;
8901 redisplay_internal ();
8907 /* Callback function for with_echo_area_buffer, when used from
8908 resize_echo_area_exactly. A1 contains a pointer to the window to
8909 resize, EXACTLY non-nil means resize the mini-window exactly to the
8910 size of the text displayed. A3 and A4 are not used. Value is what
8911 resize_mini_window returns. */
8914 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8917 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
8921 /* Resize mini-window W to fit the size of its contents. EXACT_P
8922 means size the window exactly to the size needed. Otherwise, it's
8923 only enlarged until W's buffer is empty.
8925 Set W->start to the right place to begin display. If the whole
8926 contents fit, start at the beginning. Otherwise, start so as
8927 to make the end of the contents appear. This is particularly
8928 important for y-or-n-p, but seems desirable generally.
8930 Value is non-zero if the window height has been changed. */
8933 resize_mini_window (struct window
*w
, int exact_p
)
8935 struct frame
*f
= XFRAME (w
->frame
);
8936 int window_height_changed_p
= 0;
8938 xassert (MINI_WINDOW_P (w
));
8940 /* By default, start display at the beginning. */
8941 set_marker_both (w
->start
, w
->buffer
,
8942 BUF_BEGV (XBUFFER (w
->buffer
)),
8943 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8945 /* Don't resize windows while redisplaying a window; it would
8946 confuse redisplay functions when the size of the window they are
8947 displaying changes from under them. Such a resizing can happen,
8948 for instance, when which-func prints a long message while
8949 we are running fontification-functions. We're running these
8950 functions with safe_call which binds inhibit-redisplay to t. */
8951 if (!NILP (Vinhibit_redisplay
))
8954 /* Nil means don't try to resize. */
8955 if (NILP (Vresize_mini_windows
)
8956 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8959 if (!FRAME_MINIBUF_ONLY_P (f
))
8962 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8963 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8964 int height
, max_height
;
8965 int unit
= FRAME_LINE_HEIGHT (f
);
8966 struct text_pos start
;
8967 struct buffer
*old_current_buffer
= NULL
;
8969 if (current_buffer
!= XBUFFER (w
->buffer
))
8971 old_current_buffer
= current_buffer
;
8972 set_buffer_internal (XBUFFER (w
->buffer
));
8975 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8977 /* Compute the max. number of lines specified by the user. */
8978 if (FLOATP (Vmax_mini_window_height
))
8979 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8980 else if (INTEGERP (Vmax_mini_window_height
))
8981 max_height
= XINT (Vmax_mini_window_height
);
8983 max_height
= total_height
/ 4;
8985 /* Correct that max. height if it's bogus. */
8986 max_height
= max (1, max_height
);
8987 max_height
= min (total_height
, max_height
);
8989 /* Find out the height of the text in the window. */
8990 if (it
.line_wrap
== TRUNCATE
)
8995 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8996 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8997 height
= it
.current_y
+ last_height
;
8999 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9000 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9001 height
= (height
+ unit
- 1) / unit
;
9004 /* Compute a suitable window start. */
9005 if (height
> max_height
)
9007 height
= max_height
;
9008 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9009 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9010 start
= it
.current
.pos
;
9013 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9014 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9016 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9018 /* Let it grow only, until we display an empty message, in which
9019 case the window shrinks again. */
9020 if (height
> WINDOW_TOTAL_LINES (w
))
9022 int old_height
= WINDOW_TOTAL_LINES (w
);
9023 freeze_window_starts (f
, 1);
9024 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9025 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9027 else if (height
< WINDOW_TOTAL_LINES (w
)
9028 && (exact_p
|| BEGV
== ZV
))
9030 int old_height
= WINDOW_TOTAL_LINES (w
);
9031 freeze_window_starts (f
, 0);
9032 shrink_mini_window (w
);
9033 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9038 /* Always resize to exact size needed. */
9039 if (height
> WINDOW_TOTAL_LINES (w
))
9041 int old_height
= WINDOW_TOTAL_LINES (w
);
9042 freeze_window_starts (f
, 1);
9043 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9044 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9046 else if (height
< WINDOW_TOTAL_LINES (w
))
9048 int old_height
= WINDOW_TOTAL_LINES (w
);
9049 freeze_window_starts (f
, 0);
9050 shrink_mini_window (w
);
9054 freeze_window_starts (f
, 1);
9055 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9058 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9062 if (old_current_buffer
)
9063 set_buffer_internal (old_current_buffer
);
9066 return window_height_changed_p
;
9070 /* Value is the current message, a string, or nil if there is no
9074 current_message (void)
9078 if (!BUFFERP (echo_area_buffer
[0]))
9082 with_echo_area_buffer (0, 0, current_message_1
,
9083 (intptr_t) &msg
, Qnil
, 0, 0);
9085 echo_area_buffer
[0] = Qnil
;
9093 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9096 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9099 *msg
= make_buffer_string (BEG
, Z
, 1);
9106 /* Push the current message on Vmessage_stack for later restauration
9107 by restore_message. Value is non-zero if the current message isn't
9108 empty. This is a relatively infrequent operation, so it's not
9109 worth optimizing. */
9115 msg
= current_message ();
9116 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9117 return STRINGP (msg
);
9121 /* Restore message display from the top of Vmessage_stack. */
9124 restore_message (void)
9128 xassert (CONSP (Vmessage_stack
));
9129 msg
= XCAR (Vmessage_stack
);
9131 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9133 message3_nolog (msg
, 0, 0);
9137 /* Handler for record_unwind_protect calling pop_message. */
9140 pop_message_unwind (Lisp_Object dummy
)
9146 /* Pop the top-most entry off Vmessage_stack. */
9151 xassert (CONSP (Vmessage_stack
));
9152 Vmessage_stack
= XCDR (Vmessage_stack
);
9156 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9157 exits. If the stack is not empty, we have a missing pop_message
9161 check_message_stack (void)
9163 if (!NILP (Vmessage_stack
))
9168 /* Truncate to NCHARS what will be displayed in the echo area the next
9169 time we display it---but don't redisplay it now. */
9172 truncate_echo_area (EMACS_INT nchars
)
9175 echo_area_buffer
[0] = Qnil
;
9176 /* A null message buffer means that the frame hasn't really been
9177 initialized yet. Error messages get reported properly by
9178 cmd_error, so this must be just an informative message; toss it. */
9179 else if (!noninteractive
9181 && !NILP (echo_area_buffer
[0]))
9183 struct frame
*sf
= SELECTED_FRAME ();
9184 if (FRAME_MESSAGE_BUF (sf
))
9185 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9190 /* Helper function for truncate_echo_area. Truncate the current
9191 message to at most NCHARS characters. */
9194 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9196 if (BEG
+ nchars
< Z
)
9197 del_range (BEG
+ nchars
, Z
);
9199 echo_area_buffer
[0] = Qnil
;
9204 /* Set the current message to a substring of S or STRING.
9206 If STRING is a Lisp string, set the message to the first NBYTES
9207 bytes from STRING. NBYTES zero means use the whole string. If
9208 STRING is multibyte, the message will be displayed multibyte.
9210 If S is not null, set the message to the first LEN bytes of S. LEN
9211 zero means use the whole string. MULTIBYTE_P non-zero means S is
9212 multibyte. Display the message multibyte in that case.
9214 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9215 to t before calling set_message_1 (which calls insert).
9219 set_message (const char *s
, Lisp_Object string
,
9220 EMACS_INT nbytes
, int multibyte_p
)
9222 message_enable_multibyte
9223 = ((s
&& multibyte_p
)
9224 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9226 with_echo_area_buffer (0, -1, set_message_1
,
9227 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9228 message_buf_print
= 0;
9229 help_echo_showing_p
= 0;
9233 /* Helper function for set_message. Arguments have the same meaning
9234 as there, with A1 corresponding to S and A2 corresponding to STRING
9235 This function is called with the echo area buffer being
9239 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9242 const char *s
= (const char *) i1
;
9243 const unsigned char *msg
= (const unsigned char *) s
;
9244 Lisp_Object string
= a2
;
9246 /* Change multibyteness of the echo buffer appropriately. */
9247 if (message_enable_multibyte
9248 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9249 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9251 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9252 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9253 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9255 /* Insert new message at BEG. */
9256 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9258 if (STRINGP (string
))
9263 nbytes
= SBYTES (string
);
9264 nchars
= string_byte_to_char (string
, nbytes
);
9266 /* This function takes care of single/multibyte conversion. We
9267 just have to ensure that the echo area buffer has the right
9268 setting of enable_multibyte_characters. */
9269 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9274 nbytes
= strlen (s
);
9276 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9278 /* Convert from multi-byte to single-byte. */
9283 /* Convert a multibyte string to single-byte. */
9284 for (i
= 0; i
< nbytes
; i
+= n
)
9286 c
= string_char_and_length (msg
+ i
, &n
);
9287 work
[0] = (ASCII_CHAR_P (c
)
9289 : multibyte_char_to_unibyte (c
));
9290 insert_1_both (work
, 1, 1, 1, 0, 0);
9293 else if (!multibyte_p
9294 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9296 /* Convert from single-byte to multi-byte. */
9299 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9301 /* Convert a single-byte string to multibyte. */
9302 for (i
= 0; i
< nbytes
; i
++)
9305 MAKE_CHAR_MULTIBYTE (c
);
9306 n
= CHAR_STRING (c
, str
);
9307 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9311 insert_1 (s
, nbytes
, 1, 0, 0);
9318 /* Clear messages. CURRENT_P non-zero means clear the current
9319 message. LAST_DISPLAYED_P non-zero means clear the message
9323 clear_message (int current_p
, int last_displayed_p
)
9327 echo_area_buffer
[0] = Qnil
;
9328 message_cleared_p
= 1;
9331 if (last_displayed_p
)
9332 echo_area_buffer
[1] = Qnil
;
9334 message_buf_print
= 0;
9337 /* Clear garbaged frames.
9339 This function is used where the old redisplay called
9340 redraw_garbaged_frames which in turn called redraw_frame which in
9341 turn called clear_frame. The call to clear_frame was a source of
9342 flickering. I believe a clear_frame is not necessary. It should
9343 suffice in the new redisplay to invalidate all current matrices,
9344 and ensure a complete redisplay of all windows. */
9347 clear_garbaged_frames (void)
9351 Lisp_Object tail
, frame
;
9352 int changed_count
= 0;
9354 FOR_EACH_FRAME (tail
, frame
)
9356 struct frame
*f
= XFRAME (frame
);
9358 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9362 Fredraw_frame (frame
);
9363 f
->force_flush_display_p
= 1;
9365 clear_current_matrices (f
);
9374 ++windows_or_buffers_changed
;
9379 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9380 is non-zero update selected_frame. Value is non-zero if the
9381 mini-windows height has been changed. */
9384 echo_area_display (int update_frame_p
)
9386 Lisp_Object mini_window
;
9389 int window_height_changed_p
= 0;
9390 struct frame
*sf
= SELECTED_FRAME ();
9392 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9393 w
= XWINDOW (mini_window
);
9394 f
= XFRAME (WINDOW_FRAME (w
));
9396 /* Don't display if frame is invisible or not yet initialized. */
9397 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9400 #ifdef HAVE_WINDOW_SYSTEM
9401 /* When Emacs starts, selected_frame may be the initial terminal
9402 frame. If we let this through, a message would be displayed on
9404 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9406 #endif /* HAVE_WINDOW_SYSTEM */
9408 /* Redraw garbaged frames. */
9410 clear_garbaged_frames ();
9412 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9414 echo_area_window
= mini_window
;
9415 window_height_changed_p
= display_echo_area (w
);
9416 w
->must_be_updated_p
= 1;
9418 /* Update the display, unless called from redisplay_internal.
9419 Also don't update the screen during redisplay itself. The
9420 update will happen at the end of redisplay, and an update
9421 here could cause confusion. */
9422 if (update_frame_p
&& !redisplaying_p
)
9426 /* If the display update has been interrupted by pending
9427 input, update mode lines in the frame. Due to the
9428 pending input, it might have been that redisplay hasn't
9429 been called, so that mode lines above the echo area are
9430 garbaged. This looks odd, so we prevent it here. */
9431 if (!display_completed
)
9432 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9434 if (window_height_changed_p
9435 /* Don't do this if Emacs is shutting down. Redisplay
9436 needs to run hooks. */
9437 && !NILP (Vrun_hooks
))
9439 /* Must update other windows. Likewise as in other
9440 cases, don't let this update be interrupted by
9442 int count
= SPECPDL_INDEX ();
9443 specbind (Qredisplay_dont_pause
, Qt
);
9444 windows_or_buffers_changed
= 1;
9445 redisplay_internal ();
9446 unbind_to (count
, Qnil
);
9448 else if (FRAME_WINDOW_P (f
) && n
== 0)
9450 /* Window configuration is the same as before.
9451 Can do with a display update of the echo area,
9452 unless we displayed some mode lines. */
9453 update_single_window (w
, 1);
9454 FRAME_RIF (f
)->flush_display (f
);
9457 update_frame (f
, 1, 1);
9459 /* If cursor is in the echo area, make sure that the next
9460 redisplay displays the minibuffer, so that the cursor will
9461 be replaced with what the minibuffer wants. */
9462 if (cursor_in_echo_area
)
9463 ++windows_or_buffers_changed
;
9466 else if (!EQ (mini_window
, selected_window
))
9467 windows_or_buffers_changed
++;
9469 /* Last displayed message is now the current message. */
9470 echo_area_buffer
[1] = echo_area_buffer
[0];
9471 /* Inform read_char that we're not echoing. */
9472 echo_message_buffer
= Qnil
;
9474 /* Prevent redisplay optimization in redisplay_internal by resetting
9475 this_line_start_pos. This is done because the mini-buffer now
9476 displays the message instead of its buffer text. */
9477 if (EQ (mini_window
, selected_window
))
9478 CHARPOS (this_line_start_pos
) = 0;
9480 return window_height_changed_p
;
9485 /***********************************************************************
9486 Mode Lines and Frame Titles
9487 ***********************************************************************/
9489 /* A buffer for constructing non-propertized mode-line strings and
9490 frame titles in it; allocated from the heap in init_xdisp and
9491 resized as needed in store_mode_line_noprop_char. */
9493 static char *mode_line_noprop_buf
;
9495 /* The buffer's end, and a current output position in it. */
9497 static char *mode_line_noprop_buf_end
;
9498 static char *mode_line_noprop_ptr
;
9500 #define MODE_LINE_NOPROP_LEN(start) \
9501 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9504 MODE_LINE_DISPLAY
= 0,
9510 /* Alist that caches the results of :propertize.
9511 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9512 static Lisp_Object mode_line_proptrans_alist
;
9514 /* List of strings making up the mode-line. */
9515 static Lisp_Object mode_line_string_list
;
9517 /* Base face property when building propertized mode line string. */
9518 static Lisp_Object mode_line_string_face
;
9519 static Lisp_Object mode_line_string_face_prop
;
9522 /* Unwind data for mode line strings */
9524 static Lisp_Object Vmode_line_unwind_vector
;
9527 format_mode_line_unwind_data (struct buffer
*obuf
,
9531 Lisp_Object vector
, tmp
;
9533 /* Reduce consing by keeping one vector in
9534 Vwith_echo_area_save_vector. */
9535 vector
= Vmode_line_unwind_vector
;
9536 Vmode_line_unwind_vector
= Qnil
;
9539 vector
= Fmake_vector (make_number (8), Qnil
);
9541 ASET (vector
, 0, make_number (mode_line_target
));
9542 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9543 ASET (vector
, 2, mode_line_string_list
);
9544 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9545 ASET (vector
, 4, mode_line_string_face
);
9546 ASET (vector
, 5, mode_line_string_face_prop
);
9549 XSETBUFFER (tmp
, obuf
);
9552 ASET (vector
, 6, tmp
);
9553 ASET (vector
, 7, owin
);
9559 unwind_format_mode_line (Lisp_Object vector
)
9561 mode_line_target
= XINT (AREF (vector
, 0));
9562 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9563 mode_line_string_list
= AREF (vector
, 2);
9564 if (! EQ (AREF (vector
, 3), Qt
))
9565 mode_line_proptrans_alist
= AREF (vector
, 3);
9566 mode_line_string_face
= AREF (vector
, 4);
9567 mode_line_string_face_prop
= AREF (vector
, 5);
9569 if (!NILP (AREF (vector
, 7)))
9570 /* Select window before buffer, since it may change the buffer. */
9571 Fselect_window (AREF (vector
, 7), Qt
);
9573 if (!NILP (AREF (vector
, 6)))
9575 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9576 ASET (vector
, 6, Qnil
);
9579 Vmode_line_unwind_vector
= vector
;
9584 /* Store a single character C for the frame title in mode_line_noprop_buf.
9585 Re-allocate mode_line_noprop_buf if necessary. */
9588 store_mode_line_noprop_char (char c
)
9590 /* If output position has reached the end of the allocated buffer,
9591 double the buffer's size. */
9592 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9594 int len
= MODE_LINE_NOPROP_LEN (0);
9595 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9596 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9597 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9598 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9601 *mode_line_noprop_ptr
++ = c
;
9605 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9606 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9607 characters that yield more columns than PRECISION; PRECISION <= 0
9608 means copy the whole string. Pad with spaces until FIELD_WIDTH
9609 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9610 pad. Called from display_mode_element when it is used to build a
9614 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9616 const unsigned char *str
= (const unsigned char *) string
;
9618 EMACS_INT dummy
, nbytes
;
9620 /* Copy at most PRECISION chars from STR. */
9621 nbytes
= strlen (string
);
9622 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9624 store_mode_line_noprop_char (*str
++);
9626 /* Fill up with spaces until FIELD_WIDTH reached. */
9627 while (field_width
> 0
9630 store_mode_line_noprop_char (' ');
9637 /***********************************************************************
9639 ***********************************************************************/
9641 #ifdef HAVE_WINDOW_SYSTEM
9643 /* Set the title of FRAME, if it has changed. The title format is
9644 Vicon_title_format if FRAME is iconified, otherwise it is
9645 frame_title_format. */
9648 x_consider_frame_title (Lisp_Object frame
)
9650 struct frame
*f
= XFRAME (frame
);
9652 if (FRAME_WINDOW_P (f
)
9653 || FRAME_MINIBUF_ONLY_P (f
)
9654 || f
->explicit_name
)
9656 /* Do we have more than one visible frame on this X display? */
9663 int count
= SPECPDL_INDEX ();
9665 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9667 Lisp_Object other_frame
= XCAR (tail
);
9668 struct frame
*tf
= XFRAME (other_frame
);
9671 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9672 && !FRAME_MINIBUF_ONLY_P (tf
)
9673 && !EQ (other_frame
, tip_frame
)
9674 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9678 /* Set global variable indicating that multiple frames exist. */
9679 multiple_frames
= CONSP (tail
);
9681 /* Switch to the buffer of selected window of the frame. Set up
9682 mode_line_target so that display_mode_element will output into
9683 mode_line_noprop_buf; then display the title. */
9684 record_unwind_protect (unwind_format_mode_line
,
9685 format_mode_line_unwind_data
9686 (current_buffer
, selected_window
, 0));
9688 Fselect_window (f
->selected_window
, Qt
);
9689 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9690 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9692 mode_line_target
= MODE_LINE_TITLE
;
9693 title_start
= MODE_LINE_NOPROP_LEN (0);
9694 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9695 NULL
, DEFAULT_FACE_ID
);
9696 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9697 len
= MODE_LINE_NOPROP_LEN (title_start
);
9698 title
= mode_line_noprop_buf
+ title_start
;
9699 unbind_to (count
, Qnil
);
9701 /* Set the title only if it's changed. This avoids consing in
9702 the common case where it hasn't. (If it turns out that we've
9703 already wasted too much time by walking through the list with
9704 display_mode_element, then we might need to optimize at a
9705 higher level than this.) */
9706 if (! STRINGP (f
->name
)
9707 || SBYTES (f
->name
) != len
9708 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9709 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9713 #endif /* not HAVE_WINDOW_SYSTEM */
9718 /***********************************************************************
9720 ***********************************************************************/
9723 /* Prepare for redisplay by updating menu-bar item lists when
9724 appropriate. This can call eval. */
9727 prepare_menu_bars (void)
9730 struct gcpro gcpro1
, gcpro2
;
9732 Lisp_Object tooltip_frame
;
9734 #ifdef HAVE_WINDOW_SYSTEM
9735 tooltip_frame
= tip_frame
;
9737 tooltip_frame
= Qnil
;
9740 /* Update all frame titles based on their buffer names, etc. We do
9741 this before the menu bars so that the buffer-menu will show the
9742 up-to-date frame titles. */
9743 #ifdef HAVE_WINDOW_SYSTEM
9744 if (windows_or_buffers_changed
|| update_mode_lines
)
9746 Lisp_Object tail
, frame
;
9748 FOR_EACH_FRAME (tail
, frame
)
9751 if (!EQ (frame
, tooltip_frame
)
9752 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9753 x_consider_frame_title (frame
);
9756 #endif /* HAVE_WINDOW_SYSTEM */
9758 /* Update the menu bar item lists, if appropriate. This has to be
9759 done before any actual redisplay or generation of display lines. */
9760 all_windows
= (update_mode_lines
9761 || buffer_shared
> 1
9762 || windows_or_buffers_changed
);
9765 Lisp_Object tail
, frame
;
9766 int count
= SPECPDL_INDEX ();
9767 /* 1 means that update_menu_bar has run its hooks
9768 so any further calls to update_menu_bar shouldn't do so again. */
9769 int menu_bar_hooks_run
= 0;
9771 record_unwind_save_match_data ();
9773 FOR_EACH_FRAME (tail
, frame
)
9777 /* Ignore tooltip frame. */
9778 if (EQ (frame
, tooltip_frame
))
9781 /* If a window on this frame changed size, report that to
9782 the user and clear the size-change flag. */
9783 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9785 Lisp_Object functions
;
9787 /* Clear flag first in case we get an error below. */
9788 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9789 functions
= Vwindow_size_change_functions
;
9790 GCPRO2 (tail
, functions
);
9792 while (CONSP (functions
))
9794 if (!EQ (XCAR (functions
), Qt
))
9795 call1 (XCAR (functions
), frame
);
9796 functions
= XCDR (functions
);
9802 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9803 #ifdef HAVE_WINDOW_SYSTEM
9804 update_tool_bar (f
, 0);
9807 if (windows_or_buffers_changed
9809 ns_set_doc_edited (f
, Fbuffer_modified_p
9810 (XWINDOW (f
->selected_window
)->buffer
));
9815 unbind_to (count
, Qnil
);
9819 struct frame
*sf
= SELECTED_FRAME ();
9820 update_menu_bar (sf
, 1, 0);
9821 #ifdef HAVE_WINDOW_SYSTEM
9822 update_tool_bar (sf
, 1);
9828 /* Update the menu bar item list for frame F. This has to be done
9829 before we start to fill in any display lines, because it can call
9832 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9834 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9835 already ran the menu bar hooks for this redisplay, so there
9836 is no need to run them again. The return value is the
9837 updated value of this flag, to pass to the next call. */
9840 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9843 register struct window
*w
;
9845 /* If called recursively during a menu update, do nothing. This can
9846 happen when, for instance, an activate-menubar-hook causes a
9848 if (inhibit_menubar_update
)
9851 window
= FRAME_SELECTED_WINDOW (f
);
9852 w
= XWINDOW (window
);
9854 if (FRAME_WINDOW_P (f
)
9856 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9857 || defined (HAVE_NS) || defined (USE_GTK)
9858 FRAME_EXTERNAL_MENU_BAR (f
)
9860 FRAME_MENU_BAR_LINES (f
) > 0
9862 : FRAME_MENU_BAR_LINES (f
) > 0)
9864 /* If the user has switched buffers or windows, we need to
9865 recompute to reflect the new bindings. But we'll
9866 recompute when update_mode_lines is set too; that means
9867 that people can use force-mode-line-update to request
9868 that the menu bar be recomputed. The adverse effect on
9869 the rest of the redisplay algorithm is about the same as
9870 windows_or_buffers_changed anyway. */
9871 if (windows_or_buffers_changed
9872 /* This used to test w->update_mode_line, but we believe
9873 there is no need to recompute the menu in that case. */
9874 || update_mode_lines
9875 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9876 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9877 != !NILP (w
->last_had_star
))
9878 || ((!NILP (Vtransient_mark_mode
)
9879 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9880 != !NILP (w
->region_showing
)))
9882 struct buffer
*prev
= current_buffer
;
9883 int count
= SPECPDL_INDEX ();
9885 specbind (Qinhibit_menubar_update
, Qt
);
9887 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9888 if (save_match_data
)
9889 record_unwind_save_match_data ();
9890 if (NILP (Voverriding_local_map_menu_flag
))
9892 specbind (Qoverriding_terminal_local_map
, Qnil
);
9893 specbind (Qoverriding_local_map
, Qnil
);
9898 /* Run the Lucid hook. */
9899 safe_run_hooks (Qactivate_menubar_hook
);
9901 /* If it has changed current-menubar from previous value,
9902 really recompute the menu-bar from the value. */
9903 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9904 call0 (Qrecompute_lucid_menubar
);
9906 safe_run_hooks (Qmenu_bar_update_hook
);
9911 XSETFRAME (Vmenu_updating_frame
, f
);
9912 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9914 /* Redisplay the menu bar in case we changed it. */
9915 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9916 || defined (HAVE_NS) || defined (USE_GTK)
9917 if (FRAME_WINDOW_P (f
))
9919 #if defined (HAVE_NS)
9920 /* All frames on Mac OS share the same menubar. So only
9921 the selected frame should be allowed to set it. */
9922 if (f
== SELECTED_FRAME ())
9924 set_frame_menubar (f
, 0, 0);
9927 /* On a terminal screen, the menu bar is an ordinary screen
9928 line, and this makes it get updated. */
9929 w
->update_mode_line
= Qt
;
9930 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9931 /* In the non-toolkit version, the menu bar is an ordinary screen
9932 line, and this makes it get updated. */
9933 w
->update_mode_line
= Qt
;
9934 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9936 unbind_to (count
, Qnil
);
9937 set_buffer_internal_1 (prev
);
9946 /***********************************************************************
9948 ***********************************************************************/
9950 #ifdef HAVE_WINDOW_SYSTEM
9953 Nominal cursor position -- where to draw output.
9954 HPOS and VPOS are window relative glyph matrix coordinates.
9955 X and Y are window relative pixel coordinates. */
9957 struct cursor_pos output_cursor
;
9961 Set the global variable output_cursor to CURSOR. All cursor
9962 positions are relative to updated_window. */
9965 set_output_cursor (struct cursor_pos
*cursor
)
9967 output_cursor
.hpos
= cursor
->hpos
;
9968 output_cursor
.vpos
= cursor
->vpos
;
9969 output_cursor
.x
= cursor
->x
;
9970 output_cursor
.y
= cursor
->y
;
9975 Set a nominal cursor position.
9977 HPOS and VPOS are column/row positions in a window glyph matrix. X
9978 and Y are window text area relative pixel positions.
9980 If this is done during an update, updated_window will contain the
9981 window that is being updated and the position is the future output
9982 cursor position for that window. If updated_window is null, use
9983 selected_window and display the cursor at the given position. */
9986 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
9990 /* If updated_window is not set, work on selected_window. */
9994 w
= XWINDOW (selected_window
);
9996 /* Set the output cursor. */
9997 output_cursor
.hpos
= hpos
;
9998 output_cursor
.vpos
= vpos
;
9999 output_cursor
.x
= x
;
10000 output_cursor
.y
= y
;
10002 /* If not called as part of an update, really display the cursor.
10003 This will also set the cursor position of W. */
10004 if (updated_window
== NULL
)
10007 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10008 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10009 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10014 #endif /* HAVE_WINDOW_SYSTEM */
10017 /***********************************************************************
10019 ***********************************************************************/
10021 #ifdef HAVE_WINDOW_SYSTEM
10023 /* Where the mouse was last time we reported a mouse event. */
10025 FRAME_PTR last_mouse_frame
;
10027 /* Tool-bar item index of the item on which a mouse button was pressed
10030 int last_tool_bar_item
;
10034 update_tool_bar_unwind (Lisp_Object frame
)
10036 selected_frame
= frame
;
10040 /* Update the tool-bar item list for frame F. This has to be done
10041 before we start to fill in any display lines. Called from
10042 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10043 and restore it here. */
10046 update_tool_bar (struct frame
*f
, int save_match_data
)
10048 #if defined (USE_GTK) || defined (HAVE_NS)
10049 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10051 int do_update
= WINDOWP (f
->tool_bar_window
)
10052 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10057 Lisp_Object window
;
10060 window
= FRAME_SELECTED_WINDOW (f
);
10061 w
= XWINDOW (window
);
10063 /* If the user has switched buffers or windows, we need to
10064 recompute to reflect the new bindings. But we'll
10065 recompute when update_mode_lines is set too; that means
10066 that people can use force-mode-line-update to request
10067 that the menu bar be recomputed. The adverse effect on
10068 the rest of the redisplay algorithm is about the same as
10069 windows_or_buffers_changed anyway. */
10070 if (windows_or_buffers_changed
10071 || !NILP (w
->update_mode_line
)
10072 || update_mode_lines
10073 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10074 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10075 != !NILP (w
->last_had_star
))
10076 || ((!NILP (Vtransient_mark_mode
)
10077 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10078 != !NILP (w
->region_showing
)))
10080 struct buffer
*prev
= current_buffer
;
10081 int count
= SPECPDL_INDEX ();
10082 Lisp_Object frame
, new_tool_bar
;
10083 int new_n_tool_bar
;
10084 struct gcpro gcpro1
;
10086 /* Set current_buffer to the buffer of the selected
10087 window of the frame, so that we get the right local
10089 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10091 /* Save match data, if we must. */
10092 if (save_match_data
)
10093 record_unwind_save_match_data ();
10095 /* Make sure that we don't accidentally use bogus keymaps. */
10096 if (NILP (Voverriding_local_map_menu_flag
))
10098 specbind (Qoverriding_terminal_local_map
, Qnil
);
10099 specbind (Qoverriding_local_map
, Qnil
);
10102 GCPRO1 (new_tool_bar
);
10104 /* We must temporarily set the selected frame to this frame
10105 before calling tool_bar_items, because the calculation of
10106 the tool-bar keymap uses the selected frame (see
10107 `tool-bar-make-keymap' in tool-bar.el). */
10108 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10109 XSETFRAME (frame
, f
);
10110 selected_frame
= frame
;
10112 /* Build desired tool-bar items from keymaps. */
10113 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10116 /* Redisplay the tool-bar if we changed it. */
10117 if (new_n_tool_bar
!= f
->n_tool_bar_items
10118 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10120 /* Redisplay that happens asynchronously due to an expose event
10121 may access f->tool_bar_items. Make sure we update both
10122 variables within BLOCK_INPUT so no such event interrupts. */
10124 f
->tool_bar_items
= new_tool_bar
;
10125 f
->n_tool_bar_items
= new_n_tool_bar
;
10126 w
->update_mode_line
= Qt
;
10132 unbind_to (count
, Qnil
);
10133 set_buffer_internal_1 (prev
);
10139 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10140 F's desired tool-bar contents. F->tool_bar_items must have
10141 been set up previously by calling prepare_menu_bars. */
10144 build_desired_tool_bar_string (struct frame
*f
)
10146 int i
, size
, size_needed
;
10147 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10148 Lisp_Object image
, plist
, props
;
10150 image
= plist
= props
= Qnil
;
10151 GCPRO3 (image
, plist
, props
);
10153 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10154 Otherwise, make a new string. */
10156 /* The size of the string we might be able to reuse. */
10157 size
= (STRINGP (f
->desired_tool_bar_string
)
10158 ? SCHARS (f
->desired_tool_bar_string
)
10161 /* We need one space in the string for each image. */
10162 size_needed
= f
->n_tool_bar_items
;
10164 /* Reuse f->desired_tool_bar_string, if possible. */
10165 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10166 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10167 make_number (' '));
10170 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10171 Fremove_text_properties (make_number (0), make_number (size
),
10172 props
, f
->desired_tool_bar_string
);
10175 /* Put a `display' property on the string for the images to display,
10176 put a `menu_item' property on tool-bar items with a value that
10177 is the index of the item in F's tool-bar item vector. */
10178 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10180 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10182 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10183 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10184 int hmargin
, vmargin
, relief
, idx
, end
;
10186 /* If image is a vector, choose the image according to the
10188 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10189 if (VECTORP (image
))
10193 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10194 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10197 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10198 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10200 xassert (ASIZE (image
) >= idx
);
10201 image
= AREF (image
, idx
);
10206 /* Ignore invalid image specifications. */
10207 if (!valid_image_p (image
))
10210 /* Display the tool-bar button pressed, or depressed. */
10211 plist
= Fcopy_sequence (XCDR (image
));
10213 /* Compute margin and relief to draw. */
10214 relief
= (tool_bar_button_relief
>= 0
10215 ? tool_bar_button_relief
10216 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10217 hmargin
= vmargin
= relief
;
10219 if (INTEGERP (Vtool_bar_button_margin
)
10220 && XINT (Vtool_bar_button_margin
) > 0)
10222 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10223 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10225 else if (CONSP (Vtool_bar_button_margin
))
10227 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10228 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10229 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10231 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10232 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10233 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10236 if (auto_raise_tool_bar_buttons_p
)
10238 /* Add a `:relief' property to the image spec if the item is
10242 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10249 /* If image is selected, display it pressed, i.e. with a
10250 negative relief. If it's not selected, display it with a
10252 plist
= Fplist_put (plist
, QCrelief
,
10254 ? make_number (-relief
)
10255 : make_number (relief
)));
10260 /* Put a margin around the image. */
10261 if (hmargin
|| vmargin
)
10263 if (hmargin
== vmargin
)
10264 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10266 plist
= Fplist_put (plist
, QCmargin
,
10267 Fcons (make_number (hmargin
),
10268 make_number (vmargin
)));
10271 /* If button is not enabled, and we don't have special images
10272 for the disabled state, make the image appear disabled by
10273 applying an appropriate algorithm to it. */
10274 if (!enabled_p
&& idx
< 0)
10275 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10277 /* Put a `display' text property on the string for the image to
10278 display. Put a `menu-item' property on the string that gives
10279 the start of this item's properties in the tool-bar items
10281 image
= Fcons (Qimage
, plist
);
10282 props
= list4 (Qdisplay
, image
,
10283 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10285 /* Let the last image hide all remaining spaces in the tool bar
10286 string. The string can be longer than needed when we reuse a
10287 previous string. */
10288 if (i
+ 1 == f
->n_tool_bar_items
)
10289 end
= SCHARS (f
->desired_tool_bar_string
);
10292 Fadd_text_properties (make_number (i
), make_number (end
),
10293 props
, f
->desired_tool_bar_string
);
10301 /* Display one line of the tool-bar of frame IT->f.
10303 HEIGHT specifies the desired height of the tool-bar line.
10304 If the actual height of the glyph row is less than HEIGHT, the
10305 row's height is increased to HEIGHT, and the icons are centered
10306 vertically in the new height.
10308 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10309 count a final empty row in case the tool-bar width exactly matches
10314 display_tool_bar_line (struct it
*it
, int height
)
10316 struct glyph_row
*row
= it
->glyph_row
;
10317 int max_x
= it
->last_visible_x
;
10318 struct glyph
*last
;
10320 prepare_desired_row (row
);
10321 row
->y
= it
->current_y
;
10323 /* Note that this isn't made use of if the face hasn't a box,
10324 so there's no need to check the face here. */
10325 it
->start_of_box_run_p
= 1;
10327 while (it
->current_x
< max_x
)
10329 int x
, n_glyphs_before
, i
, nglyphs
;
10330 struct it it_before
;
10332 /* Get the next display element. */
10333 if (!get_next_display_element (it
))
10335 /* Don't count empty row if we are counting needed tool-bar lines. */
10336 if (height
< 0 && !it
->hpos
)
10341 /* Produce glyphs. */
10342 n_glyphs_before
= row
->used
[TEXT_AREA
];
10345 PRODUCE_GLYPHS (it
);
10347 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10349 x
= it_before
.current_x
;
10350 while (i
< nglyphs
)
10352 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10354 if (x
+ glyph
->pixel_width
> max_x
)
10356 /* Glyph doesn't fit on line. Backtrack. */
10357 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10359 /* If this is the only glyph on this line, it will never fit on the
10360 tool-bar, so skip it. But ensure there is at least one glyph,
10361 so we don't accidentally disable the tool-bar. */
10362 if (n_glyphs_before
== 0
10363 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10369 x
+= glyph
->pixel_width
;
10373 /* Stop at line ends. */
10374 if (ITERATOR_AT_END_OF_LINE_P (it
))
10377 set_iterator_to_next (it
, 1);
10382 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10384 /* Use default face for the border below the tool bar.
10386 FIXME: When auto-resize-tool-bars is grow-only, there is
10387 no additional border below the possibly empty tool-bar lines.
10388 So to make the extra empty lines look "normal", we have to
10389 use the tool-bar face for the border too. */
10390 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10391 it
->face_id
= DEFAULT_FACE_ID
;
10393 extend_face_to_end_of_line (it
);
10394 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10395 last
->right_box_line_p
= 1;
10396 if (last
== row
->glyphs
[TEXT_AREA
])
10397 last
->left_box_line_p
= 1;
10399 /* Make line the desired height and center it vertically. */
10400 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10402 /* Don't add more than one line height. */
10403 height
%= FRAME_LINE_HEIGHT (it
->f
);
10404 it
->max_ascent
+= height
/ 2;
10405 it
->max_descent
+= (height
+ 1) / 2;
10408 compute_line_metrics (it
);
10410 /* If line is empty, make it occupy the rest of the tool-bar. */
10411 if (!row
->displays_text_p
)
10413 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10414 row
->visible_height
= row
->height
;
10415 row
->ascent
= row
->phys_ascent
= 0;
10416 row
->extra_line_spacing
= 0;
10419 row
->full_width_p
= 1;
10420 row
->continued_p
= 0;
10421 row
->truncated_on_left_p
= 0;
10422 row
->truncated_on_right_p
= 0;
10424 it
->current_x
= it
->hpos
= 0;
10425 it
->current_y
+= row
->height
;
10431 /* Max tool-bar height. */
10433 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10434 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10436 /* Value is the number of screen lines needed to make all tool-bar
10437 items of frame F visible. The number of actual rows needed is
10438 returned in *N_ROWS if non-NULL. */
10441 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10443 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10445 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10446 the desired matrix, so use (unused) mode-line row as temporary row to
10447 avoid destroying the first tool-bar row. */
10448 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10450 /* Initialize an iterator for iteration over
10451 F->desired_tool_bar_string in the tool-bar window of frame F. */
10452 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10453 it
.first_visible_x
= 0;
10454 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10455 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10457 while (!ITERATOR_AT_END_P (&it
))
10459 clear_glyph_row (temp_row
);
10460 it
.glyph_row
= temp_row
;
10461 display_tool_bar_line (&it
, -1);
10463 clear_glyph_row (temp_row
);
10465 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10467 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10469 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10473 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10475 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10476 (Lisp_Object frame
)
10483 frame
= selected_frame
;
10485 CHECK_FRAME (frame
);
10486 f
= XFRAME (frame
);
10488 if (WINDOWP (f
->tool_bar_window
)
10489 || (w
= XWINDOW (f
->tool_bar_window
),
10490 WINDOW_TOTAL_LINES (w
) > 0))
10492 update_tool_bar (f
, 1);
10493 if (f
->n_tool_bar_items
)
10495 build_desired_tool_bar_string (f
);
10496 nlines
= tool_bar_lines_needed (f
, NULL
);
10500 return make_number (nlines
);
10504 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10505 height should be changed. */
10508 redisplay_tool_bar (struct frame
*f
)
10512 struct glyph_row
*row
;
10514 #if defined (USE_GTK) || defined (HAVE_NS)
10515 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10516 update_frame_tool_bar (f
);
10520 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10521 do anything. This means you must start with tool-bar-lines
10522 non-zero to get the auto-sizing effect. Or in other words, you
10523 can turn off tool-bars by specifying tool-bar-lines zero. */
10524 if (!WINDOWP (f
->tool_bar_window
)
10525 || (w
= XWINDOW (f
->tool_bar_window
),
10526 WINDOW_TOTAL_LINES (w
) == 0))
10529 /* Set up an iterator for the tool-bar window. */
10530 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10531 it
.first_visible_x
= 0;
10532 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10533 row
= it
.glyph_row
;
10535 /* Build a string that represents the contents of the tool-bar. */
10536 build_desired_tool_bar_string (f
);
10537 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10539 if (f
->n_tool_bar_rows
== 0)
10543 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10544 nlines
!= WINDOW_TOTAL_LINES (w
)))
10547 int old_height
= WINDOW_TOTAL_LINES (w
);
10549 XSETFRAME (frame
, f
);
10550 Fmodify_frame_parameters (frame
,
10551 Fcons (Fcons (Qtool_bar_lines
,
10552 make_number (nlines
)),
10554 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10556 clear_glyph_matrix (w
->desired_matrix
);
10557 fonts_changed_p
= 1;
10563 /* Display as many lines as needed to display all tool-bar items. */
10565 if (f
->n_tool_bar_rows
> 0)
10567 int border
, rows
, height
, extra
;
10569 if (INTEGERP (Vtool_bar_border
))
10570 border
= XINT (Vtool_bar_border
);
10571 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10572 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10573 else if (EQ (Vtool_bar_border
, Qborder_width
))
10574 border
= f
->border_width
;
10580 rows
= f
->n_tool_bar_rows
;
10581 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10582 extra
= it
.last_visible_y
- border
- height
* rows
;
10584 while (it
.current_y
< it
.last_visible_y
)
10587 if (extra
> 0 && rows
-- > 0)
10589 h
= (extra
+ rows
- 1) / rows
;
10592 display_tool_bar_line (&it
, height
+ h
);
10597 while (it
.current_y
< it
.last_visible_y
)
10598 display_tool_bar_line (&it
, 0);
10601 /* It doesn't make much sense to try scrolling in the tool-bar
10602 window, so don't do it. */
10603 w
->desired_matrix
->no_scrolling_p
= 1;
10604 w
->must_be_updated_p
= 1;
10606 if (!NILP (Vauto_resize_tool_bars
))
10608 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10609 int change_height_p
= 0;
10611 /* If we couldn't display everything, change the tool-bar's
10612 height if there is room for more. */
10613 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10614 && it
.current_y
< max_tool_bar_height
)
10615 change_height_p
= 1;
10617 row
= it
.glyph_row
- 1;
10619 /* If there are blank lines at the end, except for a partially
10620 visible blank line at the end that is smaller than
10621 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10622 if (!row
->displays_text_p
10623 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10624 change_height_p
= 1;
10626 /* If row displays tool-bar items, but is partially visible,
10627 change the tool-bar's height. */
10628 if (row
->displays_text_p
10629 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10630 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10631 change_height_p
= 1;
10633 /* Resize windows as needed by changing the `tool-bar-lines'
10634 frame parameter. */
10635 if (change_height_p
)
10638 int old_height
= WINDOW_TOTAL_LINES (w
);
10640 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10642 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10643 && !f
->minimize_tool_bar_window_p
)
10644 ? (nlines
> old_height
)
10645 : (nlines
!= old_height
));
10646 f
->minimize_tool_bar_window_p
= 0;
10648 if (change_height_p
)
10650 XSETFRAME (frame
, f
);
10651 Fmodify_frame_parameters (frame
,
10652 Fcons (Fcons (Qtool_bar_lines
,
10653 make_number (nlines
)),
10655 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10657 clear_glyph_matrix (w
->desired_matrix
);
10658 f
->n_tool_bar_rows
= nrows
;
10659 fonts_changed_p
= 1;
10666 f
->minimize_tool_bar_window_p
= 0;
10671 /* Get information about the tool-bar item which is displayed in GLYPH
10672 on frame F. Return in *PROP_IDX the index where tool-bar item
10673 properties start in F->tool_bar_items. Value is zero if
10674 GLYPH doesn't display a tool-bar item. */
10677 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10683 /* This function can be called asynchronously, which means we must
10684 exclude any possibility that Fget_text_property signals an
10686 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10687 charpos
= max (0, charpos
);
10689 /* Get the text property `menu-item' at pos. The value of that
10690 property is the start index of this item's properties in
10691 F->tool_bar_items. */
10692 prop
= Fget_text_property (make_number (charpos
),
10693 Qmenu_item
, f
->current_tool_bar_string
);
10694 if (INTEGERP (prop
))
10696 *prop_idx
= XINT (prop
);
10706 /* Get information about the tool-bar item at position X/Y on frame F.
10707 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10708 the current matrix of the tool-bar window of F, or NULL if not
10709 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10710 item in F->tool_bar_items. Value is
10712 -1 if X/Y is not on a tool-bar item
10713 0 if X/Y is on the same item that was highlighted before.
10717 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10718 int *hpos
, int *vpos
, int *prop_idx
)
10720 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10721 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10724 /* Find the glyph under X/Y. */
10725 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10726 if (*glyph
== NULL
)
10729 /* Get the start of this tool-bar item's properties in
10730 f->tool_bar_items. */
10731 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10734 /* Is mouse on the highlighted item? */
10735 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10736 && *vpos
>= hlinfo
->mouse_face_beg_row
10737 && *vpos
<= hlinfo
->mouse_face_end_row
10738 && (*vpos
> hlinfo
->mouse_face_beg_row
10739 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10740 && (*vpos
< hlinfo
->mouse_face_end_row
10741 || *hpos
< hlinfo
->mouse_face_end_col
10742 || hlinfo
->mouse_face_past_end
))
10750 Handle mouse button event on the tool-bar of frame F, at
10751 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10752 0 for button release. MODIFIERS is event modifiers for button
10756 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10757 unsigned int modifiers
)
10759 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10760 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10761 int hpos
, vpos
, prop_idx
;
10762 struct glyph
*glyph
;
10763 Lisp_Object enabled_p
;
10765 /* If not on the highlighted tool-bar item, return. */
10766 frame_to_window_pixel_xy (w
, &x
, &y
);
10767 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10770 /* If item is disabled, do nothing. */
10771 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10772 if (NILP (enabled_p
))
10777 /* Show item in pressed state. */
10778 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10779 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10780 last_tool_bar_item
= prop_idx
;
10784 Lisp_Object key
, frame
;
10785 struct input_event event
;
10786 EVENT_INIT (event
);
10788 /* Show item in released state. */
10789 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10790 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10792 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10794 XSETFRAME (frame
, f
);
10795 event
.kind
= TOOL_BAR_EVENT
;
10796 event
.frame_or_window
= frame
;
10798 kbd_buffer_store_event (&event
);
10800 event
.kind
= TOOL_BAR_EVENT
;
10801 event
.frame_or_window
= frame
;
10803 event
.modifiers
= modifiers
;
10804 kbd_buffer_store_event (&event
);
10805 last_tool_bar_item
= -1;
10810 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10811 tool-bar window-relative coordinates X/Y. Called from
10812 note_mouse_highlight. */
10815 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10817 Lisp_Object window
= f
->tool_bar_window
;
10818 struct window
*w
= XWINDOW (window
);
10819 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10820 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10822 struct glyph
*glyph
;
10823 struct glyph_row
*row
;
10825 Lisp_Object enabled_p
;
10827 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10828 int mouse_down_p
, rc
;
10830 /* Function note_mouse_highlight is called with negative X/Y
10831 values when mouse moves outside of the frame. */
10832 if (x
<= 0 || y
<= 0)
10834 clear_mouse_face (hlinfo
);
10838 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10841 /* Not on tool-bar item. */
10842 clear_mouse_face (hlinfo
);
10846 /* On same tool-bar item as before. */
10847 goto set_help_echo
;
10849 clear_mouse_face (hlinfo
);
10851 /* Mouse is down, but on different tool-bar item? */
10852 mouse_down_p
= (dpyinfo
->grabbed
10853 && f
== last_mouse_frame
10854 && FRAME_LIVE_P (f
));
10856 && last_tool_bar_item
!= prop_idx
)
10859 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10860 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10862 /* If tool-bar item is not enabled, don't highlight it. */
10863 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10864 if (!NILP (enabled_p
))
10866 /* Compute the x-position of the glyph. In front and past the
10867 image is a space. We include this in the highlighted area. */
10868 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10869 for (i
= x
= 0; i
< hpos
; ++i
)
10870 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10872 /* Record this as the current active region. */
10873 hlinfo
->mouse_face_beg_col
= hpos
;
10874 hlinfo
->mouse_face_beg_row
= vpos
;
10875 hlinfo
->mouse_face_beg_x
= x
;
10876 hlinfo
->mouse_face_beg_y
= row
->y
;
10877 hlinfo
->mouse_face_past_end
= 0;
10879 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10880 hlinfo
->mouse_face_end_row
= vpos
;
10881 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10882 hlinfo
->mouse_face_end_y
= row
->y
;
10883 hlinfo
->mouse_face_window
= window
;
10884 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10886 /* Display it as active. */
10887 show_mouse_face (hlinfo
, draw
);
10888 hlinfo
->mouse_face_image_state
= draw
;
10893 /* Set help_echo_string to a help string to display for this tool-bar item.
10894 XTread_socket does the rest. */
10895 help_echo_object
= help_echo_window
= Qnil
;
10896 help_echo_pos
= -1;
10897 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10898 if (NILP (help_echo_string
))
10899 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10902 #endif /* HAVE_WINDOW_SYSTEM */
10906 /************************************************************************
10907 Horizontal scrolling
10908 ************************************************************************/
10910 static int hscroll_window_tree (Lisp_Object
);
10911 static int hscroll_windows (Lisp_Object
);
10913 /* For all leaf windows in the window tree rooted at WINDOW, set their
10914 hscroll value so that PT is (i) visible in the window, and (ii) so
10915 that it is not within a certain margin at the window's left and
10916 right border. Value is non-zero if any window's hscroll has been
10920 hscroll_window_tree (Lisp_Object window
)
10922 int hscrolled_p
= 0;
10923 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10924 int hscroll_step_abs
= 0;
10925 double hscroll_step_rel
= 0;
10927 if (hscroll_relative_p
)
10929 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10930 if (hscroll_step_rel
< 0)
10932 hscroll_relative_p
= 0;
10933 hscroll_step_abs
= 0;
10936 else if (INTEGERP (Vhscroll_step
))
10938 hscroll_step_abs
= XINT (Vhscroll_step
);
10939 if (hscroll_step_abs
< 0)
10940 hscroll_step_abs
= 0;
10943 hscroll_step_abs
= 0;
10945 while (WINDOWP (window
))
10947 struct window
*w
= XWINDOW (window
);
10949 if (WINDOWP (w
->hchild
))
10950 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10951 else if (WINDOWP (w
->vchild
))
10952 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10953 else if (w
->cursor
.vpos
>= 0)
10956 int text_area_width
;
10957 struct glyph_row
*current_cursor_row
10958 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10959 struct glyph_row
*desired_cursor_row
10960 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10961 struct glyph_row
*cursor_row
10962 = (desired_cursor_row
->enabled_p
10963 ? desired_cursor_row
10964 : current_cursor_row
);
10966 text_area_width
= window_box_width (w
, TEXT_AREA
);
10968 /* Scroll when cursor is inside this scroll margin. */
10969 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10971 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10972 && ((XFASTINT (w
->hscroll
)
10973 && w
->cursor
.x
<= h_margin
)
10974 || (cursor_row
->enabled_p
10975 && cursor_row
->truncated_on_right_p
10976 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10980 struct buffer
*saved_current_buffer
;
10984 /* Find point in a display of infinite width. */
10985 saved_current_buffer
= current_buffer
;
10986 current_buffer
= XBUFFER (w
->buffer
);
10988 if (w
== XWINDOW (selected_window
))
10992 pt
= marker_position (w
->pointm
);
10993 pt
= max (BEGV
, pt
);
10997 /* Move iterator to pt starting at cursor_row->start in
10998 a line with infinite width. */
10999 init_to_row_start (&it
, w
, cursor_row
);
11000 it
.last_visible_x
= INFINITY
;
11001 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11002 current_buffer
= saved_current_buffer
;
11004 /* Position cursor in window. */
11005 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11006 hscroll
= max (0, (it
.current_x
11007 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11008 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11009 : (text_area_width
/ 2))))
11010 / FRAME_COLUMN_WIDTH (it
.f
);
11011 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11013 if (hscroll_relative_p
)
11014 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11017 wanted_x
= text_area_width
11018 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11021 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11025 if (hscroll_relative_p
)
11026 wanted_x
= text_area_width
* hscroll_step_rel
11029 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11032 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11034 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11036 /* Don't call Fset_window_hscroll if value hasn't
11037 changed because it will prevent redisplay
11039 if (XFASTINT (w
->hscroll
) != hscroll
)
11041 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11042 w
->hscroll
= make_number (hscroll
);
11051 /* Value is non-zero if hscroll of any leaf window has been changed. */
11052 return hscrolled_p
;
11056 /* Set hscroll so that cursor is visible and not inside horizontal
11057 scroll margins for all windows in the tree rooted at WINDOW. See
11058 also hscroll_window_tree above. Value is non-zero if any window's
11059 hscroll has been changed. If it has, desired matrices on the frame
11060 of WINDOW are cleared. */
11063 hscroll_windows (Lisp_Object window
)
11065 int hscrolled_p
= hscroll_window_tree (window
);
11067 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11068 return hscrolled_p
;
11073 /************************************************************************
11075 ************************************************************************/
11077 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11078 to a non-zero value. This is sometimes handy to have in a debugger
11083 /* First and last unchanged row for try_window_id. */
11085 int debug_first_unchanged_at_end_vpos
;
11086 int debug_last_unchanged_at_beg_vpos
;
11088 /* Delta vpos and y. */
11090 int debug_dvpos
, debug_dy
;
11092 /* Delta in characters and bytes for try_window_id. */
11094 EMACS_INT debug_delta
, debug_delta_bytes
;
11096 /* Values of window_end_pos and window_end_vpos at the end of
11099 EMACS_INT debug_end_vpos
;
11101 /* Append a string to W->desired_matrix->method. FMT is a printf
11102 format string. A1...A9 are a supplement for a variable-length
11103 argument list. If trace_redisplay_p is non-zero also printf the
11104 resulting string to stderr. */
11107 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11110 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11113 char *method
= w
->desired_matrix
->method
;
11114 int len
= strlen (method
);
11115 int size
= sizeof w
->desired_matrix
->method
;
11116 int remaining
= size
- len
- 1;
11118 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11119 if (len
&& remaining
)
11122 --remaining
, ++len
;
11125 strncpy (method
+ len
, buffer
, remaining
);
11127 if (trace_redisplay_p
)
11128 fprintf (stderr
, "%p (%s): %s\n",
11130 ((BUFFERP (w
->buffer
)
11131 && STRINGP (XBUFFER (w
->buffer
)->name
))
11132 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11137 #endif /* GLYPH_DEBUG */
11140 /* Value is non-zero if all changes in window W, which displays
11141 current_buffer, are in the text between START and END. START is a
11142 buffer position, END is given as a distance from Z. Used in
11143 redisplay_internal for display optimization. */
11146 text_outside_line_unchanged_p (struct window
*w
,
11147 EMACS_INT start
, EMACS_INT end
)
11149 int unchanged_p
= 1;
11151 /* If text or overlays have changed, see where. */
11152 if (XFASTINT (w
->last_modified
) < MODIFF
11153 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11155 /* Gap in the line? */
11156 if (GPT
< start
|| Z
- GPT
< end
)
11159 /* Changes start in front of the line, or end after it? */
11161 && (BEG_UNCHANGED
< start
- 1
11162 || END_UNCHANGED
< end
))
11165 /* If selective display, can't optimize if changes start at the
11166 beginning of the line. */
11168 && INTEGERP (BVAR (current_buffer
, selective_display
))
11169 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11170 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11173 /* If there are overlays at the start or end of the line, these
11174 may have overlay strings with newlines in them. A change at
11175 START, for instance, may actually concern the display of such
11176 overlay strings as well, and they are displayed on different
11177 lines. So, quickly rule out this case. (For the future, it
11178 might be desirable to implement something more telling than
11179 just BEG/END_UNCHANGED.) */
11182 if (BEG
+ BEG_UNCHANGED
== start
11183 && overlay_touches_p (start
))
11185 if (END_UNCHANGED
== end
11186 && overlay_touches_p (Z
- end
))
11190 /* Under bidi reordering, adding or deleting a character in the
11191 beginning of a paragraph, before the first strong directional
11192 character, can change the base direction of the paragraph (unless
11193 the buffer specifies a fixed paragraph direction), which will
11194 require to redisplay the whole paragraph. It might be worthwhile
11195 to find the paragraph limits and widen the range of redisplayed
11196 lines to that, but for now just give up this optimization. */
11197 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11198 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11202 return unchanged_p
;
11206 /* Do a frame update, taking possible shortcuts into account. This is
11207 the main external entry point for redisplay.
11209 If the last redisplay displayed an echo area message and that message
11210 is no longer requested, we clear the echo area or bring back the
11211 mini-buffer if that is in use. */
11216 redisplay_internal ();
11221 overlay_arrow_string_or_property (Lisp_Object var
)
11225 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11228 return Voverlay_arrow_string
;
11231 /* Return 1 if there are any overlay-arrows in current_buffer. */
11233 overlay_arrow_in_current_buffer_p (void)
11237 for (vlist
= Voverlay_arrow_variable_list
;
11239 vlist
= XCDR (vlist
))
11241 Lisp_Object var
= XCAR (vlist
);
11244 if (!SYMBOLP (var
))
11246 val
= find_symbol_value (var
);
11248 && current_buffer
== XMARKER (val
)->buffer
)
11255 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11259 overlay_arrows_changed_p (void)
11263 for (vlist
= Voverlay_arrow_variable_list
;
11265 vlist
= XCDR (vlist
))
11267 Lisp_Object var
= XCAR (vlist
);
11268 Lisp_Object val
, pstr
;
11270 if (!SYMBOLP (var
))
11272 val
= find_symbol_value (var
);
11273 if (!MARKERP (val
))
11275 if (! EQ (COERCE_MARKER (val
),
11276 Fget (var
, Qlast_arrow_position
))
11277 || ! (pstr
= overlay_arrow_string_or_property (var
),
11278 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11284 /* Mark overlay arrows to be updated on next redisplay. */
11287 update_overlay_arrows (int up_to_date
)
11291 for (vlist
= Voverlay_arrow_variable_list
;
11293 vlist
= XCDR (vlist
))
11295 Lisp_Object var
= XCAR (vlist
);
11297 if (!SYMBOLP (var
))
11300 if (up_to_date
> 0)
11302 Lisp_Object val
= find_symbol_value (var
);
11303 Fput (var
, Qlast_arrow_position
,
11304 COERCE_MARKER (val
));
11305 Fput (var
, Qlast_arrow_string
,
11306 overlay_arrow_string_or_property (var
));
11308 else if (up_to_date
< 0
11309 || !NILP (Fget (var
, Qlast_arrow_position
)))
11311 Fput (var
, Qlast_arrow_position
, Qt
);
11312 Fput (var
, Qlast_arrow_string
, Qt
);
11318 /* Return overlay arrow string to display at row.
11319 Return integer (bitmap number) for arrow bitmap in left fringe.
11320 Return nil if no overlay arrow. */
11323 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11327 for (vlist
= Voverlay_arrow_variable_list
;
11329 vlist
= XCDR (vlist
))
11331 Lisp_Object var
= XCAR (vlist
);
11334 if (!SYMBOLP (var
))
11337 val
= find_symbol_value (var
);
11340 && current_buffer
== XMARKER (val
)->buffer
11341 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11343 if (FRAME_WINDOW_P (it
->f
)
11344 /* FIXME: if ROW->reversed_p is set, this should test
11345 the right fringe, not the left one. */
11346 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11348 #ifdef HAVE_WINDOW_SYSTEM
11349 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11352 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11353 return make_number (fringe_bitmap
);
11356 return make_number (-1); /* Use default arrow bitmap */
11358 return overlay_arrow_string_or_property (var
);
11365 /* Return 1 if point moved out of or into a composition. Otherwise
11366 return 0. PREV_BUF and PREV_PT are the last point buffer and
11367 position. BUF and PT are the current point buffer and position. */
11370 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11371 struct buffer
*buf
, EMACS_INT pt
)
11373 EMACS_INT start
, end
;
11375 Lisp_Object buffer
;
11377 XSETBUFFER (buffer
, buf
);
11378 /* Check a composition at the last point if point moved within the
11380 if (prev_buf
== buf
)
11383 /* Point didn't move. */
11386 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11387 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11388 && COMPOSITION_VALID_P (start
, end
, prop
)
11389 && start
< prev_pt
&& end
> prev_pt
)
11390 /* The last point was within the composition. Return 1 iff
11391 point moved out of the composition. */
11392 return (pt
<= start
|| pt
>= end
);
11395 /* Check a composition at the current point. */
11396 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11397 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11398 && COMPOSITION_VALID_P (start
, end
, prop
)
11399 && start
< pt
&& end
> pt
);
11403 /* Reconsider the setting of B->clip_changed which is displayed
11407 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11409 if (b
->clip_changed
11410 && !NILP (w
->window_end_valid
)
11411 && w
->current_matrix
->buffer
== b
11412 && w
->current_matrix
->zv
== BUF_ZV (b
)
11413 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11414 b
->clip_changed
= 0;
11416 /* If display wasn't paused, and W is not a tool bar window, see if
11417 point has been moved into or out of a composition. In that case,
11418 we set b->clip_changed to 1 to force updating the screen. If
11419 b->clip_changed has already been set to 1, we can skip this
11421 if (!b
->clip_changed
11422 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11426 if (w
== XWINDOW (selected_window
))
11429 pt
= marker_position (w
->pointm
);
11431 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11432 || pt
!= XINT (w
->last_point
))
11433 && check_point_in_composition (w
->current_matrix
->buffer
,
11434 XINT (w
->last_point
),
11435 XBUFFER (w
->buffer
), pt
))
11436 b
->clip_changed
= 1;
11441 /* Select FRAME to forward the values of frame-local variables into C
11442 variables so that the redisplay routines can access those values
11446 select_frame_for_redisplay (Lisp_Object frame
)
11448 Lisp_Object tail
, tem
;
11449 Lisp_Object old
= selected_frame
;
11450 struct Lisp_Symbol
*sym
;
11452 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11454 selected_frame
= frame
;
11457 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11458 if (CONSP (XCAR (tail
))
11459 && (tem
= XCAR (XCAR (tail
)),
11461 && (sym
= indirect_variable (XSYMBOL (tem
)),
11462 sym
->redirect
== SYMBOL_LOCALIZED
)
11463 && sym
->val
.blv
->frame_local
)
11464 /* Use find_symbol_value rather than Fsymbol_value
11465 to avoid an error if it is void. */
11466 find_symbol_value (tem
);
11467 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11471 #define STOP_POLLING \
11472 do { if (! polling_stopped_here) stop_polling (); \
11473 polling_stopped_here = 1; } while (0)
11475 #define RESUME_POLLING \
11476 do { if (polling_stopped_here) start_polling (); \
11477 polling_stopped_here = 0; } while (0)
11480 /* Perhaps in the future avoid recentering windows if it
11481 is not necessary; currently that causes some problems. */
11484 redisplay_internal (void)
11486 struct window
*w
= XWINDOW (selected_window
);
11490 int must_finish
= 0;
11491 struct text_pos tlbufpos
, tlendpos
;
11492 int number_of_visible_frames
;
11495 int polling_stopped_here
= 0;
11496 Lisp_Object old_frame
= selected_frame
;
11498 /* Non-zero means redisplay has to consider all windows on all
11499 frames. Zero means, only selected_window is considered. */
11500 int consider_all_windows_p
;
11502 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11504 /* No redisplay if running in batch mode or frame is not yet fully
11505 initialized, or redisplay is explicitly turned off by setting
11506 Vinhibit_redisplay. */
11507 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11508 || !NILP (Vinhibit_redisplay
))
11511 /* Don't examine these until after testing Vinhibit_redisplay.
11512 When Emacs is shutting down, perhaps because its connection to
11513 X has dropped, we should not look at them at all. */
11514 fr
= XFRAME (w
->frame
);
11515 sf
= SELECTED_FRAME ();
11517 if (!fr
->glyphs_initialized_p
)
11520 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11521 if (popup_activated ())
11525 /* I don't think this happens but let's be paranoid. */
11526 if (redisplaying_p
)
11529 /* Record a function that resets redisplaying_p to its old value
11530 when we leave this function. */
11531 count
= SPECPDL_INDEX ();
11532 record_unwind_protect (unwind_redisplay
,
11533 Fcons (make_number (redisplaying_p
), selected_frame
));
11535 specbind (Qinhibit_free_realized_faces
, Qnil
);
11538 Lisp_Object tail
, frame
;
11540 FOR_EACH_FRAME (tail
, frame
)
11542 struct frame
*f
= XFRAME (frame
);
11543 f
->already_hscrolled_p
= 0;
11548 /* Remember the currently selected window. */
11551 if (!EQ (old_frame
, selected_frame
)
11552 && FRAME_LIVE_P (XFRAME (old_frame
)))
11553 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11554 selected_frame and selected_window to be temporarily out-of-sync so
11555 when we come back here via `goto retry', we need to resync because we
11556 may need to run Elisp code (via prepare_menu_bars). */
11557 select_frame_for_redisplay (old_frame
);
11560 reconsider_clip_changes (w
, current_buffer
);
11561 last_escape_glyph_frame
= NULL
;
11562 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11563 last_glyphless_glyph_frame
= NULL
;
11564 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11566 /* If new fonts have been loaded that make a glyph matrix adjustment
11567 necessary, do it. */
11568 if (fonts_changed_p
)
11570 adjust_glyphs (NULL
);
11571 ++windows_or_buffers_changed
;
11572 fonts_changed_p
= 0;
11575 /* If face_change_count is non-zero, init_iterator will free all
11576 realized faces, which includes the faces referenced from current
11577 matrices. So, we can't reuse current matrices in this case. */
11578 if (face_change_count
)
11579 ++windows_or_buffers_changed
;
11581 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11582 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11584 /* Since frames on a single ASCII terminal share the same
11585 display area, displaying a different frame means redisplay
11586 the whole thing. */
11587 windows_or_buffers_changed
++;
11588 SET_FRAME_GARBAGED (sf
);
11590 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11592 FRAME_TTY (sf
)->previous_frame
= sf
;
11595 /* Set the visible flags for all frames. Do this before checking
11596 for resized or garbaged frames; they want to know if their frames
11597 are visible. See the comment in frame.h for
11598 FRAME_SAMPLE_VISIBILITY. */
11600 Lisp_Object tail
, frame
;
11602 number_of_visible_frames
= 0;
11604 FOR_EACH_FRAME (tail
, frame
)
11606 struct frame
*f
= XFRAME (frame
);
11608 FRAME_SAMPLE_VISIBILITY (f
);
11609 if (FRAME_VISIBLE_P (f
))
11610 ++number_of_visible_frames
;
11611 clear_desired_matrices (f
);
11615 /* Notice any pending interrupt request to change frame size. */
11616 do_pending_window_change (1);
11618 /* do_pending_window_change could change the selected_window due to
11619 frame resizing which makes the selected window too small. */
11620 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11623 reconsider_clip_changes (w
, current_buffer
);
11626 /* Clear frames marked as garbaged. */
11627 if (frame_garbaged
)
11628 clear_garbaged_frames ();
11630 /* Build menubar and tool-bar items. */
11631 if (NILP (Vmemory_full
))
11632 prepare_menu_bars ();
11634 if (windows_or_buffers_changed
)
11635 update_mode_lines
++;
11637 /* Detect case that we need to write or remove a star in the mode line. */
11638 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11640 w
->update_mode_line
= Qt
;
11641 if (buffer_shared
> 1)
11642 update_mode_lines
++;
11645 /* Avoid invocation of point motion hooks by `current_column' below. */
11646 count1
= SPECPDL_INDEX ();
11647 specbind (Qinhibit_point_motion_hooks
, Qt
);
11649 /* If %c is in the mode line, update it if needed. */
11650 if (!NILP (w
->column_number_displayed
)
11651 /* This alternative quickly identifies a common case
11652 where no change is needed. */
11653 && !(PT
== XFASTINT (w
->last_point
)
11654 && XFASTINT (w
->last_modified
) >= MODIFF
11655 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11656 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11657 w
->update_mode_line
= Qt
;
11659 unbind_to (count1
, Qnil
);
11661 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11663 /* The variable buffer_shared is set in redisplay_window and
11664 indicates that we redisplay a buffer in different windows. See
11666 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11667 || cursor_type_changed
);
11669 /* If specs for an arrow have changed, do thorough redisplay
11670 to ensure we remove any arrow that should no longer exist. */
11671 if (overlay_arrows_changed_p ())
11672 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11674 /* Normally the message* functions will have already displayed and
11675 updated the echo area, but the frame may have been trashed, or
11676 the update may have been preempted, so display the echo area
11677 again here. Checking message_cleared_p captures the case that
11678 the echo area should be cleared. */
11679 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11680 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11681 || (message_cleared_p
11682 && minibuf_level
== 0
11683 /* If the mini-window is currently selected, this means the
11684 echo-area doesn't show through. */
11685 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11687 int window_height_changed_p
= echo_area_display (0);
11690 /* If we don't display the current message, don't clear the
11691 message_cleared_p flag, because, if we did, we wouldn't clear
11692 the echo area in the next redisplay which doesn't preserve
11694 if (!display_last_displayed_message_p
)
11695 message_cleared_p
= 0;
11697 if (fonts_changed_p
)
11699 else if (window_height_changed_p
)
11701 consider_all_windows_p
= 1;
11702 ++update_mode_lines
;
11703 ++windows_or_buffers_changed
;
11705 /* If window configuration was changed, frames may have been
11706 marked garbaged. Clear them or we will experience
11707 surprises wrt scrolling. */
11708 if (frame_garbaged
)
11709 clear_garbaged_frames ();
11712 else if (EQ (selected_window
, minibuf_window
)
11713 && (current_buffer
->clip_changed
11714 || XFASTINT (w
->last_modified
) < MODIFF
11715 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11716 && resize_mini_window (w
, 0))
11718 /* Resized active mini-window to fit the size of what it is
11719 showing if its contents might have changed. */
11721 /* FIXME: this causes all frames to be updated, which seems unnecessary
11722 since only the current frame needs to be considered. This function needs
11723 to be rewritten with two variables, consider_all_windows and
11724 consider_all_frames. */
11725 consider_all_windows_p
= 1;
11726 ++windows_or_buffers_changed
;
11727 ++update_mode_lines
;
11729 /* If window configuration was changed, frames may have been
11730 marked garbaged. Clear them or we will experience
11731 surprises wrt scrolling. */
11732 if (frame_garbaged
)
11733 clear_garbaged_frames ();
11737 /* If showing the region, and mark has changed, we must redisplay
11738 the whole window. The assignment to this_line_start_pos prevents
11739 the optimization directly below this if-statement. */
11740 if (((!NILP (Vtransient_mark_mode
)
11741 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11742 != !NILP (w
->region_showing
))
11743 || (!NILP (w
->region_showing
)
11744 && !EQ (w
->region_showing
,
11745 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11746 CHARPOS (this_line_start_pos
) = 0;
11748 /* Optimize the case that only the line containing the cursor in the
11749 selected window has changed. Variables starting with this_ are
11750 set in display_line and record information about the line
11751 containing the cursor. */
11752 tlbufpos
= this_line_start_pos
;
11753 tlendpos
= this_line_end_pos
;
11754 if (!consider_all_windows_p
11755 && CHARPOS (tlbufpos
) > 0
11756 && NILP (w
->update_mode_line
)
11757 && !current_buffer
->clip_changed
11758 && !current_buffer
->prevent_redisplay_optimizations_p
11759 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11760 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11761 /* Make sure recorded data applies to current buffer, etc. */
11762 && this_line_buffer
== current_buffer
11763 && current_buffer
== XBUFFER (w
->buffer
)
11764 && NILP (w
->force_start
)
11765 && NILP (w
->optional_new_start
)
11766 /* Point must be on the line that we have info recorded about. */
11767 && PT
>= CHARPOS (tlbufpos
)
11768 && PT
<= Z
- CHARPOS (tlendpos
)
11769 /* All text outside that line, including its final newline,
11770 must be unchanged. */
11771 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11772 CHARPOS (tlendpos
)))
11774 if (CHARPOS (tlbufpos
) > BEGV
11775 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11776 && (CHARPOS (tlbufpos
) == ZV
11777 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11778 /* Former continuation line has disappeared by becoming empty. */
11780 else if (XFASTINT (w
->last_modified
) < MODIFF
11781 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11782 || MINI_WINDOW_P (w
))
11784 /* We have to handle the case of continuation around a
11785 wide-column character (see the comment in indent.c around
11788 For instance, in the following case:
11790 -------- Insert --------
11791 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11792 J_I_ ==> J_I_ `^^' are cursors.
11796 As we have to redraw the line above, we cannot use this
11800 int line_height_before
= this_line_pixel_height
;
11802 /* Note that start_display will handle the case that the
11803 line starting at tlbufpos is a continuation line. */
11804 start_display (&it
, w
, tlbufpos
);
11806 /* Implementation note: It this still necessary? */
11807 if (it
.current_x
!= this_line_start_x
)
11810 TRACE ((stderr
, "trying display optimization 1\n"));
11811 w
->cursor
.vpos
= -1;
11812 overlay_arrow_seen
= 0;
11813 it
.vpos
= this_line_vpos
;
11814 it
.current_y
= this_line_y
;
11815 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11816 display_line (&it
);
11818 /* If line contains point, is not continued,
11819 and ends at same distance from eob as before, we win. */
11820 if (w
->cursor
.vpos
>= 0
11821 /* Line is not continued, otherwise this_line_start_pos
11822 would have been set to 0 in display_line. */
11823 && CHARPOS (this_line_start_pos
)
11824 /* Line ends as before. */
11825 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11826 /* Line has same height as before. Otherwise other lines
11827 would have to be shifted up or down. */
11828 && this_line_pixel_height
== line_height_before
)
11830 /* If this is not the window's last line, we must adjust
11831 the charstarts of the lines below. */
11832 if (it
.current_y
< it
.last_visible_y
)
11834 struct glyph_row
*row
11835 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11836 EMACS_INT delta
, delta_bytes
;
11838 /* We used to distinguish between two cases here,
11839 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11840 when the line ends in a newline or the end of the
11841 buffer's accessible portion. But both cases did
11842 the same, so they were collapsed. */
11844 - CHARPOS (tlendpos
)
11845 - MATRIX_ROW_START_CHARPOS (row
));
11846 delta_bytes
= (Z_BYTE
11847 - BYTEPOS (tlendpos
)
11848 - MATRIX_ROW_START_BYTEPOS (row
));
11850 increment_matrix_positions (w
->current_matrix
,
11851 this_line_vpos
+ 1,
11852 w
->current_matrix
->nrows
,
11853 delta
, delta_bytes
);
11856 /* If this row displays text now but previously didn't,
11857 or vice versa, w->window_end_vpos may have to be
11859 if ((it
.glyph_row
- 1)->displays_text_p
)
11861 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11862 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11864 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11865 && this_line_vpos
> 0)
11866 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11867 w
->window_end_valid
= Qnil
;
11869 /* Update hint: No need to try to scroll in update_window. */
11870 w
->desired_matrix
->no_scrolling_p
= 1;
11873 *w
->desired_matrix
->method
= 0;
11874 debug_method_add (w
, "optimization 1");
11876 #ifdef HAVE_WINDOW_SYSTEM
11877 update_window_fringes (w
, 0);
11884 else if (/* Cursor position hasn't changed. */
11885 PT
== XFASTINT (w
->last_point
)
11886 /* Make sure the cursor was last displayed
11887 in this window. Otherwise we have to reposition it. */
11888 && 0 <= w
->cursor
.vpos
11889 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11893 do_pending_window_change (1);
11894 /* If selected_window changed, redisplay again. */
11895 if (WINDOWP (selected_window
)
11896 && (w
= XWINDOW (selected_window
)) != sw
)
11899 /* We used to always goto end_of_redisplay here, but this
11900 isn't enough if we have a blinking cursor. */
11901 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11902 goto end_of_redisplay
;
11906 /* If highlighting the region, or if the cursor is in the echo area,
11907 then we can't just move the cursor. */
11908 else if (! (!NILP (Vtransient_mark_mode
)
11909 && !NILP (BVAR (current_buffer
, mark_active
)))
11910 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11911 || highlight_nonselected_windows
)
11912 && NILP (w
->region_showing
)
11913 && NILP (Vshow_trailing_whitespace
)
11914 && !cursor_in_echo_area
)
11917 struct glyph_row
*row
;
11919 /* Skip from tlbufpos to PT and see where it is. Note that
11920 PT may be in invisible text. If so, we will end at the
11921 next visible position. */
11922 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11923 NULL
, DEFAULT_FACE_ID
);
11924 it
.current_x
= this_line_start_x
;
11925 it
.current_y
= this_line_y
;
11926 it
.vpos
= this_line_vpos
;
11928 /* The call to move_it_to stops in front of PT, but
11929 moves over before-strings. */
11930 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11932 if (it
.vpos
== this_line_vpos
11933 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11936 xassert (this_line_vpos
== it
.vpos
);
11937 xassert (this_line_y
== it
.current_y
);
11938 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11940 *w
->desired_matrix
->method
= 0;
11941 debug_method_add (w
, "optimization 3");
11950 /* Text changed drastically or point moved off of line. */
11951 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11954 CHARPOS (this_line_start_pos
) = 0;
11955 consider_all_windows_p
|= buffer_shared
> 1;
11956 ++clear_face_cache_count
;
11957 #ifdef HAVE_WINDOW_SYSTEM
11958 ++clear_image_cache_count
;
11961 /* Build desired matrices, and update the display. If
11962 consider_all_windows_p is non-zero, do it for all windows on all
11963 frames. Otherwise do it for selected_window, only. */
11965 if (consider_all_windows_p
)
11967 Lisp_Object tail
, frame
;
11969 FOR_EACH_FRAME (tail
, frame
)
11970 XFRAME (frame
)->updated_p
= 0;
11972 /* Recompute # windows showing selected buffer. This will be
11973 incremented each time such a window is displayed. */
11976 FOR_EACH_FRAME (tail
, frame
)
11978 struct frame
*f
= XFRAME (frame
);
11980 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11982 if (! EQ (frame
, selected_frame
))
11983 /* Select the frame, for the sake of frame-local
11985 select_frame_for_redisplay (frame
);
11987 /* Mark all the scroll bars to be removed; we'll redeem
11988 the ones we want when we redisplay their windows. */
11989 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11990 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11992 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11993 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11995 /* The X error handler may have deleted that frame. */
11996 if (!FRAME_LIVE_P (f
))
11999 /* Any scroll bars which redisplay_windows should have
12000 nuked should now go away. */
12001 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12002 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12004 /* If fonts changed, display again. */
12005 /* ??? rms: I suspect it is a mistake to jump all the way
12006 back to retry here. It should just retry this frame. */
12007 if (fonts_changed_p
)
12010 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12012 /* See if we have to hscroll. */
12013 if (!f
->already_hscrolled_p
)
12015 f
->already_hscrolled_p
= 1;
12016 if (hscroll_windows (f
->root_window
))
12020 /* Prevent various kinds of signals during display
12021 update. stdio is not robust about handling
12022 signals, which can cause an apparent I/O
12024 if (interrupt_input
)
12025 unrequest_sigio ();
12028 /* Update the display. */
12029 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12030 pending
|= update_frame (f
, 0, 0);
12036 if (!EQ (old_frame
, selected_frame
)
12037 && FRAME_LIVE_P (XFRAME (old_frame
)))
12038 /* We played a bit fast-and-loose above and allowed selected_frame
12039 and selected_window to be temporarily out-of-sync but let's make
12040 sure this stays contained. */
12041 select_frame_for_redisplay (old_frame
);
12042 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12046 /* Do the mark_window_display_accurate after all windows have
12047 been redisplayed because this call resets flags in buffers
12048 which are needed for proper redisplay. */
12049 FOR_EACH_FRAME (tail
, frame
)
12051 struct frame
*f
= XFRAME (frame
);
12054 mark_window_display_accurate (f
->root_window
, 1);
12055 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12056 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12061 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12063 Lisp_Object mini_window
;
12064 struct frame
*mini_frame
;
12066 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12067 /* Use list_of_error, not Qerror, so that
12068 we catch only errors and don't run the debugger. */
12069 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12071 redisplay_window_error
);
12073 /* Compare desired and current matrices, perform output. */
12076 /* If fonts changed, display again. */
12077 if (fonts_changed_p
)
12080 /* Prevent various kinds of signals during display update.
12081 stdio is not robust about handling signals,
12082 which can cause an apparent I/O error. */
12083 if (interrupt_input
)
12084 unrequest_sigio ();
12087 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12089 if (hscroll_windows (selected_window
))
12092 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12093 pending
= update_frame (sf
, 0, 0);
12096 /* We may have called echo_area_display at the top of this
12097 function. If the echo area is on another frame, that may
12098 have put text on a frame other than the selected one, so the
12099 above call to update_frame would not have caught it. Catch
12101 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12102 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12104 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12106 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12107 pending
|= update_frame (mini_frame
, 0, 0);
12108 if (!pending
&& hscroll_windows (mini_window
))
12113 /* If display was paused because of pending input, make sure we do a
12114 thorough update the next time. */
12117 /* Prevent the optimization at the beginning of
12118 redisplay_internal that tries a single-line update of the
12119 line containing the cursor in the selected window. */
12120 CHARPOS (this_line_start_pos
) = 0;
12122 /* Let the overlay arrow be updated the next time. */
12123 update_overlay_arrows (0);
12125 /* If we pause after scrolling, some rows in the current
12126 matrices of some windows are not valid. */
12127 if (!WINDOW_FULL_WIDTH_P (w
)
12128 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12129 update_mode_lines
= 1;
12133 if (!consider_all_windows_p
)
12135 /* This has already been done above if
12136 consider_all_windows_p is set. */
12137 mark_window_display_accurate_1 (w
, 1);
12139 /* Say overlay arrows are up to date. */
12140 update_overlay_arrows (1);
12142 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12143 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12146 update_mode_lines
= 0;
12147 windows_or_buffers_changed
= 0;
12148 cursor_type_changed
= 0;
12151 /* Start SIGIO interrupts coming again. Having them off during the
12152 code above makes it less likely one will discard output, but not
12153 impossible, since there might be stuff in the system buffer here.
12154 But it is much hairier to try to do anything about that. */
12155 if (interrupt_input
)
12159 /* If a frame has become visible which was not before, redisplay
12160 again, so that we display it. Expose events for such a frame
12161 (which it gets when becoming visible) don't call the parts of
12162 redisplay constructing glyphs, so simply exposing a frame won't
12163 display anything in this case. So, we have to display these
12164 frames here explicitly. */
12167 Lisp_Object tail
, frame
;
12170 FOR_EACH_FRAME (tail
, frame
)
12172 int this_is_visible
= 0;
12174 if (XFRAME (frame
)->visible
)
12175 this_is_visible
= 1;
12176 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12177 if (XFRAME (frame
)->visible
)
12178 this_is_visible
= 1;
12180 if (this_is_visible
)
12184 if (new_count
!= number_of_visible_frames
)
12185 windows_or_buffers_changed
++;
12188 /* Change frame size now if a change is pending. */
12189 do_pending_window_change (1);
12191 /* If we just did a pending size change, or have additional
12192 visible frames, or selected_window changed, redisplay again. */
12193 if ((windows_or_buffers_changed
&& !pending
)
12194 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12197 /* Clear the face and image caches.
12199 We used to do this only if consider_all_windows_p. But the cache
12200 needs to be cleared if a timer creates images in the current
12201 buffer (e.g. the test case in Bug#6230). */
12203 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12205 clear_face_cache (0);
12206 clear_face_cache_count
= 0;
12209 #ifdef HAVE_WINDOW_SYSTEM
12210 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12212 clear_image_caches (Qnil
);
12213 clear_image_cache_count
= 0;
12215 #endif /* HAVE_WINDOW_SYSTEM */
12218 unbind_to (count
, Qnil
);
12223 /* Redisplay, but leave alone any recent echo area message unless
12224 another message has been requested in its place.
12226 This is useful in situations where you need to redisplay but no
12227 user action has occurred, making it inappropriate for the message
12228 area to be cleared. See tracking_off and
12229 wait_reading_process_output for examples of these situations.
12231 FROM_WHERE is an integer saying from where this function was
12232 called. This is useful for debugging. */
12235 redisplay_preserve_echo_area (int from_where
)
12237 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12239 if (!NILP (echo_area_buffer
[1]))
12241 /* We have a previously displayed message, but no current
12242 message. Redisplay the previous message. */
12243 display_last_displayed_message_p
= 1;
12244 redisplay_internal ();
12245 display_last_displayed_message_p
= 0;
12248 redisplay_internal ();
12250 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12251 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12252 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12256 /* Function registered with record_unwind_protect in
12257 redisplay_internal. Reset redisplaying_p to the value it had
12258 before redisplay_internal was called, and clear
12259 prevent_freeing_realized_faces_p. It also selects the previously
12260 selected frame, unless it has been deleted (by an X connection
12261 failure during redisplay, for example). */
12264 unwind_redisplay (Lisp_Object val
)
12266 Lisp_Object old_redisplaying_p
, old_frame
;
12268 old_redisplaying_p
= XCAR (val
);
12269 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12270 old_frame
= XCDR (val
);
12271 if (! EQ (old_frame
, selected_frame
)
12272 && FRAME_LIVE_P (XFRAME (old_frame
)))
12273 select_frame_for_redisplay (old_frame
);
12278 /* Mark the display of window W as accurate or inaccurate. If
12279 ACCURATE_P is non-zero mark display of W as accurate. If
12280 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12281 redisplay_internal is called. */
12284 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12286 if (BUFFERP (w
->buffer
))
12288 struct buffer
*b
= XBUFFER (w
->buffer
);
12291 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12292 w
->last_overlay_modified
12293 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12295 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12299 b
->clip_changed
= 0;
12300 b
->prevent_redisplay_optimizations_p
= 0;
12302 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12303 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12304 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12305 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12307 w
->current_matrix
->buffer
= b
;
12308 w
->current_matrix
->begv
= BUF_BEGV (b
);
12309 w
->current_matrix
->zv
= BUF_ZV (b
);
12311 w
->last_cursor
= w
->cursor
;
12312 w
->last_cursor_off_p
= w
->cursor_off_p
;
12314 if (w
== XWINDOW (selected_window
))
12315 w
->last_point
= make_number (BUF_PT (b
));
12317 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12323 w
->window_end_valid
= w
->buffer
;
12324 w
->update_mode_line
= Qnil
;
12329 /* Mark the display of windows in the window tree rooted at WINDOW as
12330 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12331 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12332 be redisplayed the next time redisplay_internal is called. */
12335 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12339 for (; !NILP (window
); window
= w
->next
)
12341 w
= XWINDOW (window
);
12342 mark_window_display_accurate_1 (w
, accurate_p
);
12344 if (!NILP (w
->vchild
))
12345 mark_window_display_accurate (w
->vchild
, accurate_p
);
12346 if (!NILP (w
->hchild
))
12347 mark_window_display_accurate (w
->hchild
, accurate_p
);
12352 update_overlay_arrows (1);
12356 /* Force a thorough redisplay the next time by setting
12357 last_arrow_position and last_arrow_string to t, which is
12358 unequal to any useful value of Voverlay_arrow_... */
12359 update_overlay_arrows (-1);
12364 /* Return value in display table DP (Lisp_Char_Table *) for character
12365 C. Since a display table doesn't have any parent, we don't have to
12366 follow parent. Do not call this function directly but use the
12367 macro DISP_CHAR_VECTOR. */
12370 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12374 if (ASCII_CHAR_P (c
))
12377 if (SUB_CHAR_TABLE_P (val
))
12378 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12384 XSETCHAR_TABLE (table
, dp
);
12385 val
= char_table_ref (table
, c
);
12394 /***********************************************************************
12396 ***********************************************************************/
12398 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12401 redisplay_windows (Lisp_Object window
)
12403 while (!NILP (window
))
12405 struct window
*w
= XWINDOW (window
);
12407 if (!NILP (w
->hchild
))
12408 redisplay_windows (w
->hchild
);
12409 else if (!NILP (w
->vchild
))
12410 redisplay_windows (w
->vchild
);
12411 else if (!NILP (w
->buffer
))
12413 displayed_buffer
= XBUFFER (w
->buffer
);
12414 /* Use list_of_error, not Qerror, so that
12415 we catch only errors and don't run the debugger. */
12416 internal_condition_case_1 (redisplay_window_0
, window
,
12418 redisplay_window_error
);
12426 redisplay_window_error (Lisp_Object ignore
)
12428 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12433 redisplay_window_0 (Lisp_Object window
)
12435 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12436 redisplay_window (window
, 0);
12441 redisplay_window_1 (Lisp_Object window
)
12443 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12444 redisplay_window (window
, 1);
12449 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12450 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12451 which positions recorded in ROW differ from current buffer
12454 Return 0 if cursor is not on this row, 1 otherwise. */
12457 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12458 struct glyph_matrix
*matrix
,
12459 EMACS_INT delta
, EMACS_INT delta_bytes
,
12462 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12463 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12464 struct glyph
*cursor
= NULL
;
12465 /* The last known character position in row. */
12466 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12468 EMACS_INT pt_old
= PT
- delta
;
12469 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12470 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12471 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12472 /* A glyph beyond the edge of TEXT_AREA which we should never
12474 struct glyph
*glyphs_end
= end
;
12475 /* Non-zero means we've found a match for cursor position, but that
12476 glyph has the avoid_cursor_p flag set. */
12477 int match_with_avoid_cursor
= 0;
12478 /* Non-zero means we've seen at least one glyph that came from a
12480 int string_seen
= 0;
12481 /* Largest and smalles buffer positions seen so far during scan of
12483 EMACS_INT bpos_max
= pos_before
;
12484 EMACS_INT bpos_min
= pos_after
;
12485 /* Last buffer position covered by an overlay string with an integer
12486 `cursor' property. */
12487 EMACS_INT bpos_covered
= 0;
12489 /* Skip over glyphs not having an object at the start and the end of
12490 the row. These are special glyphs like truncation marks on
12491 terminal frames. */
12492 if (row
->displays_text_p
)
12494 if (!row
->reversed_p
)
12497 && INTEGERP (glyph
->object
)
12498 && glyph
->charpos
< 0)
12500 x
+= glyph
->pixel_width
;
12504 && INTEGERP ((end
- 1)->object
)
12505 /* CHARPOS is zero for blanks and stretch glyphs
12506 inserted by extend_face_to_end_of_line. */
12507 && (end
- 1)->charpos
<= 0)
12509 glyph_before
= glyph
- 1;
12516 /* If the glyph row is reversed, we need to process it from back
12517 to front, so swap the edge pointers. */
12518 glyphs_end
= end
= glyph
- 1;
12519 glyph
+= row
->used
[TEXT_AREA
] - 1;
12521 while (glyph
> end
+ 1
12522 && INTEGERP (glyph
->object
)
12523 && glyph
->charpos
< 0)
12526 x
-= glyph
->pixel_width
;
12528 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12530 /* By default, in reversed rows we put the cursor on the
12531 rightmost (first in the reading order) glyph. */
12532 for (g
= end
+ 1; g
< glyph
; g
++)
12533 x
+= g
->pixel_width
;
12535 && INTEGERP ((end
+ 1)->object
)
12536 && (end
+ 1)->charpos
<= 0)
12538 glyph_before
= glyph
+ 1;
12542 else if (row
->reversed_p
)
12544 /* In R2L rows that don't display text, put the cursor on the
12545 rightmost glyph. Case in point: an empty last line that is
12546 part of an R2L paragraph. */
12548 /* Avoid placing the cursor on the last glyph of the row, where
12549 on terminal frames we hold the vertical border between
12550 adjacent windows. */
12551 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12552 && !WINDOW_RIGHTMOST_P (w
)
12553 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12555 x
= -1; /* will be computed below, at label compute_x */
12558 /* Step 1: Try to find the glyph whose character position
12559 corresponds to point. If that's not possible, find 2 glyphs
12560 whose character positions are the closest to point, one before
12561 point, the other after it. */
12562 if (!row
->reversed_p
)
12563 while (/* not marched to end of glyph row */
12565 /* glyph was not inserted by redisplay for internal purposes */
12566 && !INTEGERP (glyph
->object
))
12568 if (BUFFERP (glyph
->object
))
12570 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12572 if (glyph
->charpos
> bpos_max
)
12573 bpos_max
= glyph
->charpos
;
12574 if (glyph
->charpos
< bpos_min
)
12575 bpos_min
= glyph
->charpos
;
12576 if (!glyph
->avoid_cursor_p
)
12578 /* If we hit point, we've found the glyph on which to
12579 display the cursor. */
12582 match_with_avoid_cursor
= 0;
12585 /* See if we've found a better approximation to
12586 POS_BEFORE or to POS_AFTER. Note that we want the
12587 first (leftmost) glyph of all those that are the
12588 closest from below, and the last (rightmost) of all
12589 those from above. */
12590 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12592 pos_before
= glyph
->charpos
;
12593 glyph_before
= glyph
;
12595 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12597 pos_after
= glyph
->charpos
;
12598 glyph_after
= glyph
;
12601 else if (dpos
== 0)
12602 match_with_avoid_cursor
= 1;
12604 else if (STRINGP (glyph
->object
))
12606 Lisp_Object chprop
;
12607 EMACS_INT glyph_pos
= glyph
->charpos
;
12609 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12611 if (INTEGERP (chprop
))
12613 bpos_covered
= bpos_max
+ XINT (chprop
);
12614 /* If the `cursor' property covers buffer positions up
12615 to and including point, we should display cursor on
12616 this glyph. Note that overlays and text properties
12617 with string values stop bidi reordering, so every
12618 buffer position to the left of the string is always
12619 smaller than any position to the right of the
12620 string. Therefore, if a `cursor' property on one
12621 of the string's characters has an integer value, we
12622 will break out of the loop below _before_ we get to
12623 the position match above. IOW, integer values of
12624 the `cursor' property override the "exact match for
12625 point" strategy of positioning the cursor. */
12626 /* Implementation note: bpos_max == pt_old when, e.g.,
12627 we are in an empty line, where bpos_max is set to
12628 MATRIX_ROW_START_CHARPOS, see above. */
12629 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12638 x
+= glyph
->pixel_width
;
12641 else if (glyph
> end
) /* row is reversed */
12642 while (!INTEGERP (glyph
->object
))
12644 if (BUFFERP (glyph
->object
))
12646 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12648 if (glyph
->charpos
> bpos_max
)
12649 bpos_max
= glyph
->charpos
;
12650 if (glyph
->charpos
< bpos_min
)
12651 bpos_min
= glyph
->charpos
;
12652 if (!glyph
->avoid_cursor_p
)
12656 match_with_avoid_cursor
= 0;
12659 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12661 pos_before
= glyph
->charpos
;
12662 glyph_before
= glyph
;
12664 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12666 pos_after
= glyph
->charpos
;
12667 glyph_after
= glyph
;
12670 else if (dpos
== 0)
12671 match_with_avoid_cursor
= 1;
12673 else if (STRINGP (glyph
->object
))
12675 Lisp_Object chprop
;
12676 EMACS_INT glyph_pos
= glyph
->charpos
;
12678 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12680 if (INTEGERP (chprop
))
12682 bpos_covered
= bpos_max
+ XINT (chprop
);
12683 /* If the `cursor' property covers buffer positions up
12684 to and including point, we should display cursor on
12686 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12695 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12697 x
--; /* can't use any pixel_width */
12700 x
-= glyph
->pixel_width
;
12703 /* Step 2: If we didn't find an exact match for point, we need to
12704 look for a proper place to put the cursor among glyphs between
12705 GLYPH_BEFORE and GLYPH_AFTER. */
12706 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12707 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12708 && bpos_covered
< pt_old
)
12710 /* An empty line has a single glyph whose OBJECT is zero and
12711 whose CHARPOS is the position of a newline on that line.
12712 Note that on a TTY, there are more glyphs after that, which
12713 were produced by extend_face_to_end_of_line, but their
12714 CHARPOS is zero or negative. */
12716 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12717 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12719 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12721 EMACS_INT ellipsis_pos
;
12723 /* Scan back over the ellipsis glyphs. */
12724 if (!row
->reversed_p
)
12726 ellipsis_pos
= (glyph
- 1)->charpos
;
12727 while (glyph
> row
->glyphs
[TEXT_AREA
]
12728 && (glyph
- 1)->charpos
== ellipsis_pos
)
12729 glyph
--, x
-= glyph
->pixel_width
;
12730 /* That loop always goes one position too far, including
12731 the glyph before the ellipsis. So scan forward over
12733 x
+= glyph
->pixel_width
;
12736 else /* row is reversed */
12738 ellipsis_pos
= (glyph
+ 1)->charpos
;
12739 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12740 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12741 glyph
++, x
+= glyph
->pixel_width
;
12742 x
-= glyph
->pixel_width
;
12746 else if (match_with_avoid_cursor
12747 /* A truncated row may not include PT among its
12748 character positions. Setting the cursor inside the
12749 scroll margin will trigger recalculation of hscroll
12750 in hscroll_window_tree. */
12751 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12752 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12753 /* Zero-width characters produce no glyphs. */
12756 && (row
->reversed_p
12757 ? glyph_after
> glyphs_end
12758 : glyph_after
< glyphs_end
)))
12760 cursor
= glyph_after
;
12763 else if (string_seen
)
12765 int incr
= row
->reversed_p
? -1 : +1;
12767 /* Need to find the glyph that came out of a string which is
12768 present at point. That glyph is somewhere between
12769 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12770 positioned between POS_BEFORE and POS_AFTER in the
12772 struct glyph
*start
, *stop
;
12773 EMACS_INT pos
= pos_before
;
12777 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
12778 correspond to POS_BEFORE and POS_AFTER, respectively. We
12779 need START and STOP in the order that corresponds to the
12780 row's direction as given by its reversed_p flag. If the
12781 directionality of characters between POS_BEFORE and
12782 POS_AFTER is the opposite of the row's base direction,
12783 these characters will have been reordered for display,
12784 and we need to reverse START and STOP. */
12785 if (!row
->reversed_p
)
12787 start
= min (glyph_before
, glyph_after
);
12788 stop
= max (glyph_before
, glyph_after
);
12792 start
= max (glyph_before
, glyph_after
);
12793 stop
= min (glyph_before
, glyph_after
);
12795 for (glyph
= start
+ incr
;
12796 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12799 /* Any glyphs that come from the buffer are here because
12800 of bidi reordering. Skip them, and only pay
12801 attention to glyphs that came from some string. */
12802 if (STRINGP (glyph
->object
))
12807 str
= glyph
->object
;
12808 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12809 if (tem
== 0 /* from overlay */
12812 /* If the string from which this glyph came is
12813 found in the buffer at point, then we've
12814 found the glyph we've been looking for. If
12815 it comes from an overlay (tem == 0), and it
12816 has the `cursor' property on one of its
12817 glyphs, record that glyph as a candidate for
12818 displaying the cursor. (As in the
12819 unidirectional version, we will display the
12820 cursor on the last candidate we find.) */
12821 if (tem
== 0 || tem
== pt_old
)
12823 /* The glyphs from this string could have
12824 been reordered. Find the one with the
12825 smallest string position. Or there could
12826 be a character in the string with the
12827 `cursor' property, which means display
12828 cursor on that character's glyph. */
12829 EMACS_INT strpos
= glyph
->charpos
;
12834 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12835 && EQ (glyph
->object
, str
);
12839 EMACS_INT gpos
= glyph
->charpos
;
12841 cprop
= Fget_char_property (make_number (gpos
),
12849 if (tem
&& glyph
->charpos
< strpos
)
12851 strpos
= glyph
->charpos
;
12860 pos
= tem
+ 1; /* don't find previous instances */
12862 /* This string is not what we want; skip all of the
12863 glyphs that came from it. */
12864 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12865 && EQ (glyph
->object
, str
))
12872 /* If we reached the end of the line, and END was from a string,
12873 the cursor is not on this line. */
12875 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12876 && STRINGP (end
->object
)
12877 && row
->continued_p
)
12883 if (cursor
!= NULL
)
12889 /* Need to compute x that corresponds to GLYPH. */
12890 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12892 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12894 x
+= g
->pixel_width
;
12898 /* ROW could be part of a continued line, which, under bidi
12899 reordering, might have other rows whose start and end charpos
12900 occlude point. Only set w->cursor if we found a better
12901 approximation to the cursor position than we have from previously
12902 examined candidate rows belonging to the same continued line. */
12903 if (/* we already have a candidate row */
12904 w
->cursor
.vpos
>= 0
12905 /* that candidate is not the row we are processing */
12906 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12907 /* the row we are processing is part of a continued line */
12908 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12909 /* Make sure cursor.vpos specifies a row whose start and end
12910 charpos occlude point. This is because some callers of this
12911 function leave cursor.vpos at the row where the cursor was
12912 displayed during the last redisplay cycle. */
12913 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12914 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12917 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12919 /* Don't consider glyphs that are outside TEXT_AREA. */
12920 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12922 /* Keep the candidate whose buffer position is the closest to
12924 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12925 w
->cursor
.hpos
>= 0
12926 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12927 && BUFFERP (g1
->object
)
12928 && (g1
->charpos
== pt_old
/* an exact match always wins */
12929 || (BUFFERP (glyph
->object
)
12930 && eabs (g1
->charpos
- pt_old
)
12931 < eabs (glyph
->charpos
- pt_old
))))
12933 /* If this candidate gives an exact match, use that. */
12934 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12935 /* Otherwise, keep the candidate that comes from a row
12936 spanning less buffer positions. This may win when one or
12937 both candidate positions are on glyphs that came from
12938 display strings, for which we cannot compare buffer
12940 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12941 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12942 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12945 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12947 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12948 w
->cursor
.y
= row
->y
+ dy
;
12950 if (w
== XWINDOW (selected_window
))
12952 if (!row
->continued_p
12953 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12956 this_line_buffer
= XBUFFER (w
->buffer
);
12958 CHARPOS (this_line_start_pos
)
12959 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12960 BYTEPOS (this_line_start_pos
)
12961 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12963 CHARPOS (this_line_end_pos
)
12964 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12965 BYTEPOS (this_line_end_pos
)
12966 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12968 this_line_y
= w
->cursor
.y
;
12969 this_line_pixel_height
= row
->height
;
12970 this_line_vpos
= w
->cursor
.vpos
;
12971 this_line_start_x
= row
->x
;
12974 CHARPOS (this_line_start_pos
) = 0;
12981 /* Run window scroll functions, if any, for WINDOW with new window
12982 start STARTP. Sets the window start of WINDOW to that position.
12984 We assume that the window's buffer is really current. */
12986 static INLINE
struct text_pos
12987 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12989 struct window
*w
= XWINDOW (window
);
12990 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12992 if (current_buffer
!= XBUFFER (w
->buffer
))
12995 if (!NILP (Vwindow_scroll_functions
))
12997 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12998 make_number (CHARPOS (startp
)));
12999 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13000 /* In case the hook functions switch buffers. */
13001 if (current_buffer
!= XBUFFER (w
->buffer
))
13002 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13009 /* Make sure the line containing the cursor is fully visible.
13010 A value of 1 means there is nothing to be done.
13011 (Either the line is fully visible, or it cannot be made so,
13012 or we cannot tell.)
13014 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13015 is higher than window.
13017 A value of 0 means the caller should do scrolling
13018 as if point had gone off the screen. */
13021 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13023 struct glyph_matrix
*matrix
;
13024 struct glyph_row
*row
;
13027 if (!make_cursor_line_fully_visible_p
)
13030 /* It's not always possible to find the cursor, e.g, when a window
13031 is full of overlay strings. Don't do anything in that case. */
13032 if (w
->cursor
.vpos
< 0)
13035 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13036 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13038 /* If the cursor row is not partially visible, there's nothing to do. */
13039 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13042 /* If the row the cursor is in is taller than the window's height,
13043 it's not clear what to do, so do nothing. */
13044 window_height
= window_box_height (w
);
13045 if (row
->height
>= window_height
)
13047 if (!force_p
|| MINI_WINDOW_P (w
)
13048 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13055 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13056 non-zero means only WINDOW is redisplayed in redisplay_internal.
13057 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13058 in redisplay_window to bring a partially visible line into view in
13059 the case that only the cursor has moved.
13061 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13062 last screen line's vertical height extends past the end of the screen.
13066 1 if scrolling succeeded
13068 0 if scrolling didn't find point.
13070 -1 if new fonts have been loaded so that we must interrupt
13071 redisplay, adjust glyph matrices, and try again. */
13077 SCROLLING_NEED_LARGER_MATRICES
13080 /* If scroll-conservatively is more than this, never recenter.
13082 If you change this, don't forget to update the doc string of
13083 `scroll-conservatively' and the Emacs manual. */
13084 #define SCROLL_LIMIT 100
13087 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13088 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13089 int temp_scroll_step
, int last_line_misfit
)
13091 struct window
*w
= XWINDOW (window
);
13092 struct frame
*f
= XFRAME (w
->frame
);
13093 struct text_pos pos
, startp
;
13095 int this_scroll_margin
, scroll_max
, rc
, height
;
13096 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13097 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13098 Lisp_Object aggressive
;
13099 /* We will never try scrolling more than this number of lines. */
13100 int scroll_limit
= SCROLL_LIMIT
;
13103 debug_method_add (w
, "try_scrolling");
13106 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13108 /* Compute scroll margin height in pixels. We scroll when point is
13109 within this distance from the top or bottom of the window. */
13110 if (scroll_margin
> 0)
13111 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13112 * FRAME_LINE_HEIGHT (f
);
13114 this_scroll_margin
= 0;
13116 /* Force arg_scroll_conservatively to have a reasonable value, to
13117 avoid scrolling too far away with slow move_it_* functions. Note
13118 that the user can supply scroll-conservatively equal to
13119 `most-positive-fixnum', which can be larger than INT_MAX. */
13120 if (arg_scroll_conservatively
> scroll_limit
)
13122 arg_scroll_conservatively
= scroll_limit
+ 1;
13123 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13125 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13126 /* Compute how much we should try to scroll maximally to bring
13127 point into view. */
13128 scroll_max
= (max (scroll_step
,
13129 max (arg_scroll_conservatively
, temp_scroll_step
))
13130 * FRAME_LINE_HEIGHT (f
));
13131 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13132 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13133 /* We're trying to scroll because of aggressive scrolling but no
13134 scroll_step is set. Choose an arbitrary one. */
13135 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13141 /* Decide whether to scroll down. */
13142 if (PT
> CHARPOS (startp
))
13144 int scroll_margin_y
;
13146 /* Compute the pixel ypos of the scroll margin, then move it to
13147 either that ypos or PT, whichever comes first. */
13148 start_display (&it
, w
, startp
);
13149 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13150 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13151 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13152 (MOVE_TO_POS
| MOVE_TO_Y
));
13154 if (PT
> CHARPOS (it
.current
.pos
))
13156 int y0
= line_bottom_y (&it
);
13157 /* Compute how many pixels below window bottom to stop searching
13158 for PT. This avoids costly search for PT that is far away if
13159 the user limited scrolling by a small number of lines, but
13160 always finds PT if scroll_conservatively is set to a large
13161 number, such as most-positive-fixnum. */
13162 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13163 int y_to_move
= it
.last_visible_y
+ slack
;
13165 /* Compute the distance from the scroll margin to PT or to
13166 the scroll limit, whichever comes first. This should
13167 include the height of the cursor line, to make that line
13169 move_it_to (&it
, PT
, -1, y_to_move
,
13170 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13171 dy
= line_bottom_y (&it
) - y0
;
13173 if (dy
> scroll_max
)
13174 return SCROLLING_FAILED
;
13182 /* Point is in or below the bottom scroll margin, so move the
13183 window start down. If scrolling conservatively, move it just
13184 enough down to make point visible. If scroll_step is set,
13185 move it down by scroll_step. */
13186 if (arg_scroll_conservatively
)
13188 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13189 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13190 else if (scroll_step
|| temp_scroll_step
)
13191 amount_to_scroll
= scroll_max
;
13194 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13195 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13196 if (NUMBERP (aggressive
))
13198 double float_amount
= XFLOATINT (aggressive
) * height
;
13199 amount_to_scroll
= float_amount
;
13200 if (amount_to_scroll
== 0 && float_amount
> 0)
13201 amount_to_scroll
= 1;
13202 /* Don't let point enter the scroll margin near top of
13204 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13205 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13209 if (amount_to_scroll
<= 0)
13210 return SCROLLING_FAILED
;
13212 start_display (&it
, w
, startp
);
13213 if (arg_scroll_conservatively
<= scroll_limit
)
13214 move_it_vertically (&it
, amount_to_scroll
);
13217 /* Extra precision for users who set scroll-conservatively
13218 to a large number: make sure the amount we scroll
13219 the window start is never less than amount_to_scroll,
13220 which was computed as distance from window bottom to
13221 point. This matters when lines at window top and lines
13222 below window bottom have different height. */
13223 struct it it1
= it
;
13224 /* We use a temporary it1 because line_bottom_y can modify
13225 its argument, if it moves one line down; see there. */
13226 int start_y
= line_bottom_y (&it1
);
13229 move_it_by_lines (&it
, 1);
13231 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13234 /* If STARTP is unchanged, move it down another screen line. */
13235 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13236 move_it_by_lines (&it
, 1);
13237 startp
= it
.current
.pos
;
13241 struct text_pos scroll_margin_pos
= startp
;
13243 /* See if point is inside the scroll margin at the top of the
13245 if (this_scroll_margin
)
13247 start_display (&it
, w
, startp
);
13248 move_it_vertically (&it
, this_scroll_margin
);
13249 scroll_margin_pos
= it
.current
.pos
;
13252 if (PT
< CHARPOS (scroll_margin_pos
))
13254 /* Point is in the scroll margin at the top of the window or
13255 above what is displayed in the window. */
13258 /* Compute the vertical distance from PT to the scroll
13259 margin position. Move as far as scroll_max allows, or
13260 one screenful, or 10 screen lines, whichever is largest.
13261 Give up if distance is greater than scroll_max. */
13262 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13263 start_display (&it
, w
, pos
);
13265 y_to_move
= max (it
.last_visible_y
,
13266 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13267 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13269 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13270 dy
= it
.current_y
- y0
;
13271 if (dy
> scroll_max
)
13272 return SCROLLING_FAILED
;
13274 /* Compute new window start. */
13275 start_display (&it
, w
, startp
);
13277 if (arg_scroll_conservatively
)
13278 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13279 max (scroll_step
, temp_scroll_step
));
13280 else if (scroll_step
|| temp_scroll_step
)
13281 amount_to_scroll
= scroll_max
;
13284 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13285 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13286 if (NUMBERP (aggressive
))
13288 double float_amount
= XFLOATINT (aggressive
) * height
;
13289 amount_to_scroll
= float_amount
;
13290 if (amount_to_scroll
== 0 && float_amount
> 0)
13291 amount_to_scroll
= 1;
13292 amount_to_scroll
-=
13293 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13294 /* Don't let point enter the scroll margin near
13295 bottom of the window. */
13296 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13297 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13301 if (amount_to_scroll
<= 0)
13302 return SCROLLING_FAILED
;
13304 move_it_vertically_backward (&it
, amount_to_scroll
);
13305 startp
= it
.current
.pos
;
13309 /* Run window scroll functions. */
13310 startp
= run_window_scroll_functions (window
, startp
);
13312 /* Display the window. Give up if new fonts are loaded, or if point
13314 if (!try_window (window
, startp
, 0))
13315 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13316 else if (w
->cursor
.vpos
< 0)
13318 clear_glyph_matrix (w
->desired_matrix
);
13319 rc
= SCROLLING_FAILED
;
13323 /* Maybe forget recorded base line for line number display. */
13324 if (!just_this_one_p
13325 || current_buffer
->clip_changed
13326 || BEG_UNCHANGED
< CHARPOS (startp
))
13327 w
->base_line_number
= Qnil
;
13329 /* If cursor ends up on a partially visible line,
13330 treat that as being off the bottom of the screen. */
13331 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13332 /* It's possible that the cursor is on the first line of the
13333 buffer, which is partially obscured due to a vscroll
13334 (Bug#7537). In that case, avoid looping forever . */
13335 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13337 clear_glyph_matrix (w
->desired_matrix
);
13338 ++extra_scroll_margin_lines
;
13341 rc
= SCROLLING_SUCCESS
;
13348 /* Compute a suitable window start for window W if display of W starts
13349 on a continuation line. Value is non-zero if a new window start
13352 The new window start will be computed, based on W's width, starting
13353 from the start of the continued line. It is the start of the
13354 screen line with the minimum distance from the old start W->start. */
13357 compute_window_start_on_continuation_line (struct window
*w
)
13359 struct text_pos pos
, start_pos
;
13360 int window_start_changed_p
= 0;
13362 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13364 /* If window start is on a continuation line... Window start may be
13365 < BEGV in case there's invisible text at the start of the
13366 buffer (M-x rmail, for example). */
13367 if (CHARPOS (start_pos
) > BEGV
13368 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13371 struct glyph_row
*row
;
13373 /* Handle the case that the window start is out of range. */
13374 if (CHARPOS (start_pos
) < BEGV
)
13375 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13376 else if (CHARPOS (start_pos
) > ZV
)
13377 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13379 /* Find the start of the continued line. This should be fast
13380 because scan_buffer is fast (newline cache). */
13381 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13382 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13383 row
, DEFAULT_FACE_ID
);
13384 reseat_at_previous_visible_line_start (&it
);
13386 /* If the line start is "too far" away from the window start,
13387 say it takes too much time to compute a new window start. */
13388 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13389 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13391 int min_distance
, distance
;
13393 /* Move forward by display lines to find the new window
13394 start. If window width was enlarged, the new start can
13395 be expected to be > the old start. If window width was
13396 decreased, the new window start will be < the old start.
13397 So, we're looking for the display line start with the
13398 minimum distance from the old window start. */
13399 pos
= it
.current
.pos
;
13400 min_distance
= INFINITY
;
13401 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13402 distance
< min_distance
)
13404 min_distance
= distance
;
13405 pos
= it
.current
.pos
;
13406 move_it_by_lines (&it
, 1);
13409 /* Set the window start there. */
13410 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13411 window_start_changed_p
= 1;
13415 return window_start_changed_p
;
13419 /* Try cursor movement in case text has not changed in window WINDOW,
13420 with window start STARTP. Value is
13422 CURSOR_MOVEMENT_SUCCESS if successful
13424 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13426 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13427 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13428 we want to scroll as if scroll-step were set to 1. See the code.
13430 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13431 which case we have to abort this redisplay, and adjust matrices
13436 CURSOR_MOVEMENT_SUCCESS
,
13437 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13438 CURSOR_MOVEMENT_MUST_SCROLL
,
13439 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13443 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13445 struct window
*w
= XWINDOW (window
);
13446 struct frame
*f
= XFRAME (w
->frame
);
13447 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13450 if (inhibit_try_cursor_movement
)
13454 /* Handle case where text has not changed, only point, and it has
13455 not moved off the frame. */
13456 if (/* Point may be in this window. */
13457 PT
>= CHARPOS (startp
)
13458 /* Selective display hasn't changed. */
13459 && !current_buffer
->clip_changed
13460 /* Function force-mode-line-update is used to force a thorough
13461 redisplay. It sets either windows_or_buffers_changed or
13462 update_mode_lines. So don't take a shortcut here for these
13464 && !update_mode_lines
13465 && !windows_or_buffers_changed
13466 && !cursor_type_changed
13467 /* Can't use this case if highlighting a region. When a
13468 region exists, cursor movement has to do more than just
13470 && !(!NILP (Vtransient_mark_mode
)
13471 && !NILP (BVAR (current_buffer
, mark_active
)))
13472 && NILP (w
->region_showing
)
13473 && NILP (Vshow_trailing_whitespace
)
13474 /* Right after splitting windows, last_point may be nil. */
13475 && INTEGERP (w
->last_point
)
13476 /* This code is not used for mini-buffer for the sake of the case
13477 of redisplaying to replace an echo area message; since in
13478 that case the mini-buffer contents per se are usually
13479 unchanged. This code is of no real use in the mini-buffer
13480 since the handling of this_line_start_pos, etc., in redisplay
13481 handles the same cases. */
13482 && !EQ (window
, minibuf_window
)
13483 /* When splitting windows or for new windows, it happens that
13484 redisplay is called with a nil window_end_vpos or one being
13485 larger than the window. This should really be fixed in
13486 window.c. I don't have this on my list, now, so we do
13487 approximately the same as the old redisplay code. --gerd. */
13488 && INTEGERP (w
->window_end_vpos
)
13489 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13490 && (FRAME_WINDOW_P (f
)
13491 || !overlay_arrow_in_current_buffer_p ()))
13493 int this_scroll_margin
, top_scroll_margin
;
13494 struct glyph_row
*row
= NULL
;
13497 debug_method_add (w
, "cursor movement");
13500 /* Scroll if point within this distance from the top or bottom
13501 of the window. This is a pixel value. */
13502 if (scroll_margin
> 0)
13504 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13505 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13508 this_scroll_margin
= 0;
13510 top_scroll_margin
= this_scroll_margin
;
13511 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13512 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13514 /* Start with the row the cursor was displayed during the last
13515 not paused redisplay. Give up if that row is not valid. */
13516 if (w
->last_cursor
.vpos
< 0
13517 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13518 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13521 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13522 if (row
->mode_line_p
)
13524 if (!row
->enabled_p
)
13525 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13528 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13530 int scroll_p
= 0, must_scroll
= 0;
13531 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13533 if (PT
> XFASTINT (w
->last_point
))
13535 /* Point has moved forward. */
13536 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13537 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13539 xassert (row
->enabled_p
);
13543 /* If the end position of a row equals the start
13544 position of the next row, and PT is at that position,
13545 we would rather display cursor in the next line. */
13546 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13547 && MATRIX_ROW_END_CHARPOS (row
) == PT
13548 && row
< w
->current_matrix
->rows
13549 + w
->current_matrix
->nrows
- 1
13550 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13551 && !cursor_row_p (row
))
13554 /* If within the scroll margin, scroll. Note that
13555 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13556 the next line would be drawn, and that
13557 this_scroll_margin can be zero. */
13558 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13559 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13560 /* Line is completely visible last line in window
13561 and PT is to be set in the next line. */
13562 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13563 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13564 && !row
->ends_at_zv_p
13565 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13568 else if (PT
< XFASTINT (w
->last_point
))
13570 /* Cursor has to be moved backward. Note that PT >=
13571 CHARPOS (startp) because of the outer if-statement. */
13572 while (!row
->mode_line_p
13573 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13574 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13575 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13576 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13577 row
> w
->current_matrix
->rows
13578 && (row
-1)->ends_in_newline_from_string_p
))))
13579 && (row
->y
> top_scroll_margin
13580 || CHARPOS (startp
) == BEGV
))
13582 xassert (row
->enabled_p
);
13586 /* Consider the following case: Window starts at BEGV,
13587 there is invisible, intangible text at BEGV, so that
13588 display starts at some point START > BEGV. It can
13589 happen that we are called with PT somewhere between
13590 BEGV and START. Try to handle that case. */
13591 if (row
< w
->current_matrix
->rows
13592 || row
->mode_line_p
)
13594 row
= w
->current_matrix
->rows
;
13595 if (row
->mode_line_p
)
13599 /* Due to newlines in overlay strings, we may have to
13600 skip forward over overlay strings. */
13601 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13602 && MATRIX_ROW_END_CHARPOS (row
) == PT
13603 && !cursor_row_p (row
))
13606 /* If within the scroll margin, scroll. */
13607 if (row
->y
< top_scroll_margin
13608 && CHARPOS (startp
) != BEGV
)
13613 /* Cursor did not move. So don't scroll even if cursor line
13614 is partially visible, as it was so before. */
13615 rc
= CURSOR_MOVEMENT_SUCCESS
;
13618 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13619 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13621 /* if PT is not in the glyph row, give up. */
13622 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13625 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13626 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13628 /* If rows are bidi-reordered and point moved, back up
13629 until we find a row that does not belong to a
13630 continuation line. This is because we must consider
13631 all rows of a continued line as candidates for the
13632 new cursor positioning, since row start and end
13633 positions change non-linearly with vertical position
13635 /* FIXME: Revisit this when glyph ``spilling'' in
13636 continuation lines' rows is implemented for
13637 bidi-reordered rows. */
13638 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13640 xassert (row
->enabled_p
);
13642 /* If we hit the beginning of the displayed portion
13643 without finding the first row of a continued
13645 if (row
<= w
->current_matrix
->rows
)
13647 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13655 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13656 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13657 && make_cursor_line_fully_visible_p
)
13659 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13660 && !row
->ends_at_zv_p
13661 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13662 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13663 else if (row
->height
> window_box_height (w
))
13665 /* If we end up in a partially visible line, let's
13666 make it fully visible, except when it's taller
13667 than the window, in which case we can't do much
13670 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13674 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13675 if (!cursor_row_fully_visible_p (w
, 0, 1))
13676 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13678 rc
= CURSOR_MOVEMENT_SUCCESS
;
13682 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13683 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13684 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13686 /* With bidi-reordered rows, there could be more than
13687 one candidate row whose start and end positions
13688 occlude point. We need to let set_cursor_from_row
13689 find the best candidate. */
13690 /* FIXME: Revisit this when glyph ``spilling'' in
13691 continuation lines' rows is implemented for
13692 bidi-reordered rows. */
13697 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13698 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13699 && cursor_row_p (row
))
13700 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13702 /* As soon as we've found the first suitable row
13703 whose ends_at_zv_p flag is set, we are done. */
13705 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13707 rc
= CURSOR_MOVEMENT_SUCCESS
;
13712 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13713 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13714 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13715 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13716 /* If we didn't find any candidate rows, or exited the
13717 loop before all the candidates were examined, signal
13718 to the caller that this method failed. */
13719 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13720 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13721 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13723 rc
= CURSOR_MOVEMENT_SUCCESS
;
13729 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13731 rc
= CURSOR_MOVEMENT_SUCCESS
;
13736 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13737 && MATRIX_ROW_START_CHARPOS (row
) == PT
13738 && cursor_row_p (row
));
13746 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
13750 set_vertical_scroll_bar (struct window
*w
)
13752 EMACS_INT start
, end
, whole
;
13754 /* Calculate the start and end positions for the current window.
13755 At some point, it would be nice to choose between scrollbars
13756 which reflect the whole buffer size, with special markers
13757 indicating narrowing, and scrollbars which reflect only the
13760 Note that mini-buffers sometimes aren't displaying any text. */
13761 if (!MINI_WINDOW_P (w
)
13762 || (w
== XWINDOW (minibuf_window
)
13763 && NILP (echo_area_buffer
[0])))
13765 struct buffer
*buf
= XBUFFER (w
->buffer
);
13766 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13767 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13768 /* I don't think this is guaranteed to be right. For the
13769 moment, we'll pretend it is. */
13770 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13774 if (whole
< (end
- start
))
13775 whole
= end
- start
;
13778 start
= end
= whole
= 0;
13780 /* Indicate what this scroll bar ought to be displaying now. */
13781 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13782 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13783 (w
, end
- start
, whole
, start
);
13787 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13788 selected_window is redisplayed.
13790 We can return without actually redisplaying the window if
13791 fonts_changed_p is nonzero. In that case, redisplay_internal will
13795 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13797 struct window
*w
= XWINDOW (window
);
13798 struct frame
*f
= XFRAME (w
->frame
);
13799 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13800 struct buffer
*old
= current_buffer
;
13801 struct text_pos lpoint
, opoint
, startp
;
13802 int update_mode_line
;
13805 /* Record it now because it's overwritten. */
13806 int current_matrix_up_to_date_p
= 0;
13807 int used_current_matrix_p
= 0;
13808 /* This is less strict than current_matrix_up_to_date_p.
13809 It indictes that the buffer contents and narrowing are unchanged. */
13810 int buffer_unchanged_p
= 0;
13811 int temp_scroll_step
= 0;
13812 int count
= SPECPDL_INDEX ();
13814 int centering_position
= -1;
13815 int last_line_misfit
= 0;
13816 EMACS_INT beg_unchanged
, end_unchanged
;
13818 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13821 /* W must be a leaf window here. */
13822 xassert (!NILP (w
->buffer
));
13824 *w
->desired_matrix
->method
= 0;
13828 reconsider_clip_changes (w
, buffer
);
13830 /* Has the mode line to be updated? */
13831 update_mode_line
= (!NILP (w
->update_mode_line
)
13832 || update_mode_lines
13833 || buffer
->clip_changed
13834 || buffer
->prevent_redisplay_optimizations_p
);
13836 if (MINI_WINDOW_P (w
))
13838 if (w
== XWINDOW (echo_area_window
)
13839 && !NILP (echo_area_buffer
[0]))
13841 if (update_mode_line
)
13842 /* We may have to update a tty frame's menu bar or a
13843 tool-bar. Example `M-x C-h C-h C-g'. */
13844 goto finish_menu_bars
;
13846 /* We've already displayed the echo area glyphs in this window. */
13847 goto finish_scroll_bars
;
13849 else if ((w
!= XWINDOW (minibuf_window
)
13850 || minibuf_level
== 0)
13851 /* When buffer is nonempty, redisplay window normally. */
13852 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13853 /* Quail displays non-mini buffers in minibuffer window.
13854 In that case, redisplay the window normally. */
13855 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13857 /* W is a mini-buffer window, but it's not active, so clear
13859 int yb
= window_text_bottom_y (w
);
13860 struct glyph_row
*row
;
13863 for (y
= 0, row
= w
->desired_matrix
->rows
;
13865 y
+= row
->height
, ++row
)
13866 blank_row (w
, row
, y
);
13867 goto finish_scroll_bars
;
13870 clear_glyph_matrix (w
->desired_matrix
);
13873 /* Otherwise set up data on this window; select its buffer and point
13875 /* Really select the buffer, for the sake of buffer-local
13877 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13879 current_matrix_up_to_date_p
13880 = (!NILP (w
->window_end_valid
)
13881 && !current_buffer
->clip_changed
13882 && !current_buffer
->prevent_redisplay_optimizations_p
13883 && XFASTINT (w
->last_modified
) >= MODIFF
13884 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13886 /* Run the window-bottom-change-functions
13887 if it is possible that the text on the screen has changed
13888 (either due to modification of the text, or any other reason). */
13889 if (!current_matrix_up_to_date_p
13890 && !NILP (Vwindow_text_change_functions
))
13892 safe_run_hooks (Qwindow_text_change_functions
);
13896 beg_unchanged
= BEG_UNCHANGED
;
13897 end_unchanged
= END_UNCHANGED
;
13899 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13901 specbind (Qinhibit_point_motion_hooks
, Qt
);
13904 = (!NILP (w
->window_end_valid
)
13905 && !current_buffer
->clip_changed
13906 && XFASTINT (w
->last_modified
) >= MODIFF
13907 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13909 /* When windows_or_buffers_changed is non-zero, we can't rely on
13910 the window end being valid, so set it to nil there. */
13911 if (windows_or_buffers_changed
)
13913 /* If window starts on a continuation line, maybe adjust the
13914 window start in case the window's width changed. */
13915 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13916 compute_window_start_on_continuation_line (w
);
13918 w
->window_end_valid
= Qnil
;
13921 /* Some sanity checks. */
13922 CHECK_WINDOW_END (w
);
13923 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13925 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13928 /* If %c is in mode line, update it if needed. */
13929 if (!NILP (w
->column_number_displayed
)
13930 /* This alternative quickly identifies a common case
13931 where no change is needed. */
13932 && !(PT
== XFASTINT (w
->last_point
)
13933 && XFASTINT (w
->last_modified
) >= MODIFF
13934 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13935 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13936 update_mode_line
= 1;
13938 /* Count number of windows showing the selected buffer. An indirect
13939 buffer counts as its base buffer. */
13940 if (!just_this_one_p
)
13942 struct buffer
*current_base
, *window_base
;
13943 current_base
= current_buffer
;
13944 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13945 if (current_base
->base_buffer
)
13946 current_base
= current_base
->base_buffer
;
13947 if (window_base
->base_buffer
)
13948 window_base
= window_base
->base_buffer
;
13949 if (current_base
== window_base
)
13953 /* Point refers normally to the selected window. For any other
13954 window, set up appropriate value. */
13955 if (!EQ (window
, selected_window
))
13957 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13958 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13962 new_pt_byte
= BEGV_BYTE
;
13963 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13965 else if (new_pt
> (ZV
- 1))
13968 new_pt_byte
= ZV_BYTE
;
13969 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13972 /* We don't use SET_PT so that the point-motion hooks don't run. */
13973 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13976 /* If any of the character widths specified in the display table
13977 have changed, invalidate the width run cache. It's true that
13978 this may be a bit late to catch such changes, but the rest of
13979 redisplay goes (non-fatally) haywire when the display table is
13980 changed, so why should we worry about doing any better? */
13981 if (current_buffer
->width_run_cache
)
13983 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13985 if (! disptab_matches_widthtab (disptab
,
13986 XVECTOR (BVAR (current_buffer
, width_table
))))
13988 invalidate_region_cache (current_buffer
,
13989 current_buffer
->width_run_cache
,
13991 recompute_width_table (current_buffer
, disptab
);
13995 /* If window-start is screwed up, choose a new one. */
13996 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13999 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14001 /* If someone specified a new starting point but did not insist,
14002 check whether it can be used. */
14003 if (!NILP (w
->optional_new_start
)
14004 && CHARPOS (startp
) >= BEGV
14005 && CHARPOS (startp
) <= ZV
)
14007 w
->optional_new_start
= Qnil
;
14008 start_display (&it
, w
, startp
);
14009 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14010 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14011 if (IT_CHARPOS (it
) == PT
)
14012 w
->force_start
= Qt
;
14013 /* IT may overshoot PT if text at PT is invisible. */
14014 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14015 w
->force_start
= Qt
;
14020 /* Handle case where place to start displaying has been specified,
14021 unless the specified location is outside the accessible range. */
14022 if (!NILP (w
->force_start
)
14023 || w
->frozen_window_start_p
)
14025 /* We set this later on if we have to adjust point. */
14028 w
->force_start
= Qnil
;
14030 w
->window_end_valid
= Qnil
;
14032 /* Forget any recorded base line for line number display. */
14033 if (!buffer_unchanged_p
)
14034 w
->base_line_number
= Qnil
;
14036 /* Redisplay the mode line. Select the buffer properly for that.
14037 Also, run the hook window-scroll-functions
14038 because we have scrolled. */
14039 /* Note, we do this after clearing force_start because
14040 if there's an error, it is better to forget about force_start
14041 than to get into an infinite loop calling the hook functions
14042 and having them get more errors. */
14043 if (!update_mode_line
14044 || ! NILP (Vwindow_scroll_functions
))
14046 update_mode_line
= 1;
14047 w
->update_mode_line
= Qt
;
14048 startp
= run_window_scroll_functions (window
, startp
);
14051 w
->last_modified
= make_number (0);
14052 w
->last_overlay_modified
= make_number (0);
14053 if (CHARPOS (startp
) < BEGV
)
14054 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14055 else if (CHARPOS (startp
) > ZV
)
14056 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14058 /* Redisplay, then check if cursor has been set during the
14059 redisplay. Give up if new fonts were loaded. */
14060 /* We used to issue a CHECK_MARGINS argument to try_window here,
14061 but this causes scrolling to fail when point begins inside
14062 the scroll margin (bug#148) -- cyd */
14063 if (!try_window (window
, startp
, 0))
14065 w
->force_start
= Qt
;
14066 clear_glyph_matrix (w
->desired_matrix
);
14067 goto need_larger_matrices
;
14070 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14072 /* If point does not appear, try to move point so it does
14073 appear. The desired matrix has been built above, so we
14074 can use it here. */
14075 new_vpos
= window_box_height (w
) / 2;
14078 if (!cursor_row_fully_visible_p (w
, 0, 0))
14080 /* Point does appear, but on a line partly visible at end of window.
14081 Move it back to a fully-visible line. */
14082 new_vpos
= window_box_height (w
);
14085 /* If we need to move point for either of the above reasons,
14086 now actually do it. */
14089 struct glyph_row
*row
;
14091 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14092 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14095 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14096 MATRIX_ROW_START_BYTEPOS (row
));
14098 if (w
!= XWINDOW (selected_window
))
14099 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14100 else if (current_buffer
== old
)
14101 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14103 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14105 /* If we are highlighting the region, then we just changed
14106 the region, so redisplay to show it. */
14107 if (!NILP (Vtransient_mark_mode
)
14108 && !NILP (BVAR (current_buffer
, mark_active
)))
14110 clear_glyph_matrix (w
->desired_matrix
);
14111 if (!try_window (window
, startp
, 0))
14112 goto need_larger_matrices
;
14117 debug_method_add (w
, "forced window start");
14122 /* Handle case where text has not changed, only point, and it has
14123 not moved off the frame, and we are not retrying after hscroll.
14124 (current_matrix_up_to_date_p is nonzero when retrying.) */
14125 if (current_matrix_up_to_date_p
14126 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14127 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14131 case CURSOR_MOVEMENT_SUCCESS
:
14132 used_current_matrix_p
= 1;
14135 case CURSOR_MOVEMENT_MUST_SCROLL
:
14136 goto try_to_scroll
;
14142 /* If current starting point was originally the beginning of a line
14143 but no longer is, find a new starting point. */
14144 else if (!NILP (w
->start_at_line_beg
)
14145 && !(CHARPOS (startp
) <= BEGV
14146 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14149 debug_method_add (w
, "recenter 1");
14154 /* Try scrolling with try_window_id. Value is > 0 if update has
14155 been done, it is -1 if we know that the same window start will
14156 not work. It is 0 if unsuccessful for some other reason. */
14157 else if ((tem
= try_window_id (w
)) != 0)
14160 debug_method_add (w
, "try_window_id %d", tem
);
14163 if (fonts_changed_p
)
14164 goto need_larger_matrices
;
14168 /* Otherwise try_window_id has returned -1 which means that we
14169 don't want the alternative below this comment to execute. */
14171 else if (CHARPOS (startp
) >= BEGV
14172 && CHARPOS (startp
) <= ZV
14173 && PT
>= CHARPOS (startp
)
14174 && (CHARPOS (startp
) < ZV
14175 /* Avoid starting at end of buffer. */
14176 || CHARPOS (startp
) == BEGV
14177 || (XFASTINT (w
->last_modified
) >= MODIFF
14178 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14181 /* If first window line is a continuation line, and window start
14182 is inside the modified region, but the first change is before
14183 current window start, we must select a new window start.
14185 However, if this is the result of a down-mouse event (e.g. by
14186 extending the mouse-drag-overlay), we don't want to select a
14187 new window start, since that would change the position under
14188 the mouse, resulting in an unwanted mouse-movement rather
14189 than a simple mouse-click. */
14190 if (NILP (w
->start_at_line_beg
)
14191 && NILP (do_mouse_tracking
)
14192 && CHARPOS (startp
) > BEGV
14193 && CHARPOS (startp
) > BEG
+ beg_unchanged
14194 && CHARPOS (startp
) <= Z
- end_unchanged
14195 /* Even if w->start_at_line_beg is nil, a new window may
14196 start at a line_beg, since that's how set_buffer_window
14197 sets it. So, we need to check the return value of
14198 compute_window_start_on_continuation_line. (See also
14200 && XMARKER (w
->start
)->buffer
== current_buffer
14201 && compute_window_start_on_continuation_line (w
))
14203 w
->force_start
= Qt
;
14204 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14209 debug_method_add (w
, "same window start");
14212 /* Try to redisplay starting at same place as before.
14213 If point has not moved off frame, accept the results. */
14214 if (!current_matrix_up_to_date_p
14215 /* Don't use try_window_reusing_current_matrix in this case
14216 because a window scroll function can have changed the
14218 || !NILP (Vwindow_scroll_functions
)
14219 || MINI_WINDOW_P (w
)
14220 || !(used_current_matrix_p
14221 = try_window_reusing_current_matrix (w
)))
14223 IF_DEBUG (debug_method_add (w
, "1"));
14224 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14225 /* -1 means we need to scroll.
14226 0 means we need new matrices, but fonts_changed_p
14227 is set in that case, so we will detect it below. */
14228 goto try_to_scroll
;
14231 if (fonts_changed_p
)
14232 goto need_larger_matrices
;
14234 if (w
->cursor
.vpos
>= 0)
14236 if (!just_this_one_p
14237 || current_buffer
->clip_changed
14238 || BEG_UNCHANGED
< CHARPOS (startp
))
14239 /* Forget any recorded base line for line number display. */
14240 w
->base_line_number
= Qnil
;
14242 if (!cursor_row_fully_visible_p (w
, 1, 0))
14244 clear_glyph_matrix (w
->desired_matrix
);
14245 last_line_misfit
= 1;
14247 /* Drop through and scroll. */
14252 clear_glyph_matrix (w
->desired_matrix
);
14257 w
->last_modified
= make_number (0);
14258 w
->last_overlay_modified
= make_number (0);
14260 /* Redisplay the mode line. Select the buffer properly for that. */
14261 if (!update_mode_line
)
14263 update_mode_line
= 1;
14264 w
->update_mode_line
= Qt
;
14267 /* Try to scroll by specified few lines. */
14268 if ((scroll_conservatively
14269 || emacs_scroll_step
14270 || temp_scroll_step
14271 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14272 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14273 && CHARPOS (startp
) >= BEGV
14274 && CHARPOS (startp
) <= ZV
)
14276 /* The function returns -1 if new fonts were loaded, 1 if
14277 successful, 0 if not successful. */
14278 int ss
= try_scrolling (window
, just_this_one_p
,
14279 scroll_conservatively
,
14281 temp_scroll_step
, last_line_misfit
);
14284 case SCROLLING_SUCCESS
:
14287 case SCROLLING_NEED_LARGER_MATRICES
:
14288 goto need_larger_matrices
;
14290 case SCROLLING_FAILED
:
14298 /* Finally, just choose a place to start which positions point
14299 according to user preferences. */
14304 debug_method_add (w
, "recenter");
14307 /* w->vscroll = 0; */
14309 /* Forget any previously recorded base line for line number display. */
14310 if (!buffer_unchanged_p
)
14311 w
->base_line_number
= Qnil
;
14313 /* Determine the window start relative to point. */
14314 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14315 it
.current_y
= it
.last_visible_y
;
14316 if (centering_position
< 0)
14320 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14322 EMACS_INT margin_pos
= CHARPOS (startp
);
14324 Lisp_Object aggressive
;
14326 /* If there is a scroll margin at the top of the window, find
14327 its character position. */
14329 /* Cannot call start_display if startp is not in the
14330 accessible region of the buffer. This can happen when we
14331 have just switched to a different buffer and/or changed
14332 its restriction. In that case, startp is initialized to
14333 the character position 1 (BEG) because we did not yet
14334 have chance to display the buffer even once. */
14335 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14339 start_display (&it1
, w
, startp
);
14340 move_it_vertically (&it1
, margin
);
14341 margin_pos
= IT_CHARPOS (it1
);
14343 scrolling_up
= PT
> margin_pos
;
14346 ? BVAR (current_buffer
, scroll_up_aggressively
)
14347 : BVAR (current_buffer
, scroll_down_aggressively
);
14349 if (!MINI_WINDOW_P (w
)
14350 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14354 /* Setting scroll-conservatively overrides
14355 scroll-*-aggressively. */
14356 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14358 double float_amount
= XFLOATINT (aggressive
);
14360 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14361 if (pt_offset
== 0 && float_amount
> 0)
14366 /* Compute how much to move the window start backward from
14367 point so that point will be displayed where the user
14371 centering_position
= it
.last_visible_y
;
14373 centering_position
-= pt_offset
;
14374 centering_position
-=
14375 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14376 /* Don't let point enter the scroll margin near top of
14378 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14379 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14382 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14385 /* Set the window start half the height of the window backward
14387 centering_position
= window_box_height (w
) / 2;
14389 move_it_vertically_backward (&it
, centering_position
);
14391 xassert (IT_CHARPOS (it
) >= BEGV
);
14393 /* The function move_it_vertically_backward may move over more
14394 than the specified y-distance. If it->w is small, e.g. a
14395 mini-buffer window, we may end up in front of the window's
14396 display area. Start displaying at the start of the line
14397 containing PT in this case. */
14398 if (it
.current_y
<= 0)
14400 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14401 move_it_vertically_backward (&it
, 0);
14405 it
.current_x
= it
.hpos
= 0;
14407 /* Set the window start position here explicitly, to avoid an
14408 infinite loop in case the functions in window-scroll-functions
14410 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14412 /* Run scroll hooks. */
14413 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14415 /* Redisplay the window. */
14416 if (!current_matrix_up_to_date_p
14417 || windows_or_buffers_changed
14418 || cursor_type_changed
14419 /* Don't use try_window_reusing_current_matrix in this case
14420 because it can have changed the buffer. */
14421 || !NILP (Vwindow_scroll_functions
)
14422 || !just_this_one_p
14423 || MINI_WINDOW_P (w
)
14424 || !(used_current_matrix_p
14425 = try_window_reusing_current_matrix (w
)))
14426 try_window (window
, startp
, 0);
14428 /* If new fonts have been loaded (due to fontsets), give up. We
14429 have to start a new redisplay since we need to re-adjust glyph
14431 if (fonts_changed_p
)
14432 goto need_larger_matrices
;
14434 /* If cursor did not appear assume that the middle of the window is
14435 in the first line of the window. Do it again with the next line.
14436 (Imagine a window of height 100, displaying two lines of height
14437 60. Moving back 50 from it->last_visible_y will end in the first
14439 if (w
->cursor
.vpos
< 0)
14441 if (!NILP (w
->window_end_valid
)
14442 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14444 clear_glyph_matrix (w
->desired_matrix
);
14445 move_it_by_lines (&it
, 1);
14446 try_window (window
, it
.current
.pos
, 0);
14448 else if (PT
< IT_CHARPOS (it
))
14450 clear_glyph_matrix (w
->desired_matrix
);
14451 move_it_by_lines (&it
, -1);
14452 try_window (window
, it
.current
.pos
, 0);
14456 /* Not much we can do about it. */
14460 /* Consider the following case: Window starts at BEGV, there is
14461 invisible, intangible text at BEGV, so that display starts at
14462 some point START > BEGV. It can happen that we are called with
14463 PT somewhere between BEGV and START. Try to handle that case. */
14464 if (w
->cursor
.vpos
< 0)
14466 struct glyph_row
*row
= w
->current_matrix
->rows
;
14467 if (row
->mode_line_p
)
14469 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14472 if (!cursor_row_fully_visible_p (w
, 0, 0))
14474 /* If vscroll is enabled, disable it and try again. */
14478 clear_glyph_matrix (w
->desired_matrix
);
14482 /* If centering point failed to make the whole line visible,
14483 put point at the top instead. That has to make the whole line
14484 visible, if it can be done. */
14485 if (centering_position
== 0)
14488 clear_glyph_matrix (w
->desired_matrix
);
14489 centering_position
= 0;
14495 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14496 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14497 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14500 /* Display the mode line, if we must. */
14501 if ((update_mode_line
14502 /* If window not full width, must redo its mode line
14503 if (a) the window to its side is being redone and
14504 (b) we do a frame-based redisplay. This is a consequence
14505 of how inverted lines are drawn in frame-based redisplay. */
14506 || (!just_this_one_p
14507 && !FRAME_WINDOW_P (f
)
14508 && !WINDOW_FULL_WIDTH_P (w
))
14509 /* Line number to display. */
14510 || INTEGERP (w
->base_line_pos
)
14511 /* Column number is displayed and different from the one displayed. */
14512 || (!NILP (w
->column_number_displayed
)
14513 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14514 /* This means that the window has a mode line. */
14515 && (WINDOW_WANTS_MODELINE_P (w
)
14516 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14518 display_mode_lines (w
);
14520 /* If mode line height has changed, arrange for a thorough
14521 immediate redisplay using the correct mode line height. */
14522 if (WINDOW_WANTS_MODELINE_P (w
)
14523 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14525 fonts_changed_p
= 1;
14526 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14527 = DESIRED_MODE_LINE_HEIGHT (w
);
14530 /* If header line height has changed, arrange for a thorough
14531 immediate redisplay using the correct header line height. */
14532 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14533 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14535 fonts_changed_p
= 1;
14536 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14537 = DESIRED_HEADER_LINE_HEIGHT (w
);
14540 if (fonts_changed_p
)
14541 goto need_larger_matrices
;
14544 if (!line_number_displayed
14545 && !BUFFERP (w
->base_line_pos
))
14547 w
->base_line_pos
= Qnil
;
14548 w
->base_line_number
= Qnil
;
14553 /* When we reach a frame's selected window, redo the frame's menu bar. */
14554 if (update_mode_line
14555 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14557 int redisplay_menu_p
= 0;
14559 if (FRAME_WINDOW_P (f
))
14561 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14562 || defined (HAVE_NS) || defined (USE_GTK)
14563 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14565 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14569 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14571 if (redisplay_menu_p
)
14572 display_menu_bar (w
);
14574 #ifdef HAVE_WINDOW_SYSTEM
14575 if (FRAME_WINDOW_P (f
))
14577 #if defined (USE_GTK) || defined (HAVE_NS)
14578 if (FRAME_EXTERNAL_TOOL_BAR (f
))
14579 redisplay_tool_bar (f
);
14581 if (WINDOWP (f
->tool_bar_window
)
14582 && (FRAME_TOOL_BAR_LINES (f
) > 0
14583 || !NILP (Vauto_resize_tool_bars
))
14584 && redisplay_tool_bar (f
))
14585 ignore_mouse_drag_p
= 1;
14591 #ifdef HAVE_WINDOW_SYSTEM
14592 if (FRAME_WINDOW_P (f
)
14593 && update_window_fringes (w
, (just_this_one_p
14594 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14595 || w
->pseudo_window_p
)))
14599 if (draw_window_fringes (w
, 1))
14600 x_draw_vertical_border (w
);
14604 #endif /* HAVE_WINDOW_SYSTEM */
14606 /* We go to this label, with fonts_changed_p nonzero,
14607 if it is necessary to try again using larger glyph matrices.
14608 We have to redeem the scroll bar even in this case,
14609 because the loop in redisplay_internal expects that. */
14610 need_larger_matrices
:
14612 finish_scroll_bars
:
14614 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14616 /* Set the thumb's position and size. */
14617 set_vertical_scroll_bar (w
);
14619 /* Note that we actually used the scroll bar attached to this
14620 window, so it shouldn't be deleted at the end of redisplay. */
14621 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14622 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14625 /* Restore current_buffer and value of point in it. The window
14626 update may have changed the buffer, so first make sure `opoint'
14627 is still valid (Bug#6177). */
14628 if (CHARPOS (opoint
) < BEGV
)
14629 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14630 else if (CHARPOS (opoint
) > ZV
)
14631 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14633 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14635 set_buffer_internal_1 (old
);
14636 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14637 shorter. This can be caused by log truncation in *Messages*. */
14638 if (CHARPOS (lpoint
) <= ZV
)
14639 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14641 unbind_to (count
, Qnil
);
14645 /* Build the complete desired matrix of WINDOW with a window start
14646 buffer position POS.
14648 Value is 1 if successful. It is zero if fonts were loaded during
14649 redisplay which makes re-adjusting glyph matrices necessary, and -1
14650 if point would appear in the scroll margins.
14651 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14652 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14656 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14658 struct window
*w
= XWINDOW (window
);
14660 struct glyph_row
*last_text_row
= NULL
;
14661 struct frame
*f
= XFRAME (w
->frame
);
14663 /* Make POS the new window start. */
14664 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14666 /* Mark cursor position as unknown. No overlay arrow seen. */
14667 w
->cursor
.vpos
= -1;
14668 overlay_arrow_seen
= 0;
14670 /* Initialize iterator and info to start at POS. */
14671 start_display (&it
, w
, pos
);
14673 /* Display all lines of W. */
14674 while (it
.current_y
< it
.last_visible_y
)
14676 if (display_line (&it
))
14677 last_text_row
= it
.glyph_row
- 1;
14678 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14682 /* Don't let the cursor end in the scroll margins. */
14683 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14684 && !MINI_WINDOW_P (w
))
14686 int this_scroll_margin
;
14688 if (scroll_margin
> 0)
14690 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14691 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14694 this_scroll_margin
= 0;
14696 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14697 && w
->cursor
.y
< this_scroll_margin
14698 && CHARPOS (pos
) > BEGV
14699 && IT_CHARPOS (it
) < ZV
)
14700 /* rms: considering make_cursor_line_fully_visible_p here
14701 seems to give wrong results. We don't want to recenter
14702 when the last line is partly visible, we want to allow
14703 that case to be handled in the usual way. */
14704 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14706 w
->cursor
.vpos
= -1;
14707 clear_glyph_matrix (w
->desired_matrix
);
14712 /* If bottom moved off end of frame, change mode line percentage. */
14713 if (XFASTINT (w
->window_end_pos
) <= 0
14714 && Z
!= IT_CHARPOS (it
))
14715 w
->update_mode_line
= Qt
;
14717 /* Set window_end_pos to the offset of the last character displayed
14718 on the window from the end of current_buffer. Set
14719 window_end_vpos to its row number. */
14722 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14723 w
->window_end_bytepos
14724 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14726 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14728 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14729 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14730 ->displays_text_p
);
14734 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14735 w
->window_end_pos
= make_number (Z
- ZV
);
14736 w
->window_end_vpos
= make_number (0);
14739 /* But that is not valid info until redisplay finishes. */
14740 w
->window_end_valid
= Qnil
;
14746 /************************************************************************
14747 Window redisplay reusing current matrix when buffer has not changed
14748 ************************************************************************/
14750 /* Try redisplay of window W showing an unchanged buffer with a
14751 different window start than the last time it was displayed by
14752 reusing its current matrix. Value is non-zero if successful.
14753 W->start is the new window start. */
14756 try_window_reusing_current_matrix (struct window
*w
)
14758 struct frame
*f
= XFRAME (w
->frame
);
14759 struct glyph_row
*bottom_row
;
14762 struct text_pos start
, new_start
;
14763 int nrows_scrolled
, i
;
14764 struct glyph_row
*last_text_row
;
14765 struct glyph_row
*last_reused_text_row
;
14766 struct glyph_row
*start_row
;
14767 int start_vpos
, min_y
, max_y
;
14770 if (inhibit_try_window_reusing
)
14774 if (/* This function doesn't handle terminal frames. */
14775 !FRAME_WINDOW_P (f
)
14776 /* Don't try to reuse the display if windows have been split
14778 || windows_or_buffers_changed
14779 || cursor_type_changed
)
14782 /* Can't do this if region may have changed. */
14783 if ((!NILP (Vtransient_mark_mode
)
14784 && !NILP (BVAR (current_buffer
, mark_active
)))
14785 || !NILP (w
->region_showing
)
14786 || !NILP (Vshow_trailing_whitespace
))
14789 /* If top-line visibility has changed, give up. */
14790 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14791 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14794 /* Give up if old or new display is scrolled vertically. We could
14795 make this function handle this, but right now it doesn't. */
14796 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14797 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14800 /* The variable new_start now holds the new window start. The old
14801 start `start' can be determined from the current matrix. */
14802 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14803 start
= start_row
->minpos
;
14804 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14806 /* Clear the desired matrix for the display below. */
14807 clear_glyph_matrix (w
->desired_matrix
);
14809 if (CHARPOS (new_start
) <= CHARPOS (start
))
14811 /* Don't use this method if the display starts with an ellipsis
14812 displayed for invisible text. It's not easy to handle that case
14813 below, and it's certainly not worth the effort since this is
14814 not a frequent case. */
14815 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14818 IF_DEBUG (debug_method_add (w
, "twu1"));
14820 /* Display up to a row that can be reused. The variable
14821 last_text_row is set to the last row displayed that displays
14822 text. Note that it.vpos == 0 if or if not there is a
14823 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14824 start_display (&it
, w
, new_start
);
14825 w
->cursor
.vpos
= -1;
14826 last_text_row
= last_reused_text_row
= NULL
;
14828 while (it
.current_y
< it
.last_visible_y
14829 && !fonts_changed_p
)
14831 /* If we have reached into the characters in the START row,
14832 that means the line boundaries have changed. So we
14833 can't start copying with the row START. Maybe it will
14834 work to start copying with the following row. */
14835 while (IT_CHARPOS (it
) > CHARPOS (start
))
14837 /* Advance to the next row as the "start". */
14839 start
= start_row
->minpos
;
14840 /* If there are no more rows to try, or just one, give up. */
14841 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14842 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14843 || CHARPOS (start
) == ZV
)
14845 clear_glyph_matrix (w
->desired_matrix
);
14849 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14851 /* If we have reached alignment,
14852 we can copy the rest of the rows. */
14853 if (IT_CHARPOS (it
) == CHARPOS (start
))
14856 if (display_line (&it
))
14857 last_text_row
= it
.glyph_row
- 1;
14860 /* A value of current_y < last_visible_y means that we stopped
14861 at the previous window start, which in turn means that we
14862 have at least one reusable row. */
14863 if (it
.current_y
< it
.last_visible_y
)
14865 struct glyph_row
*row
;
14867 /* IT.vpos always starts from 0; it counts text lines. */
14868 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14870 /* Find PT if not already found in the lines displayed. */
14871 if (w
->cursor
.vpos
< 0)
14873 int dy
= it
.current_y
- start_row
->y
;
14875 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14876 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14878 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14879 dy
, nrows_scrolled
);
14882 clear_glyph_matrix (w
->desired_matrix
);
14887 /* Scroll the display. Do it before the current matrix is
14888 changed. The problem here is that update has not yet
14889 run, i.e. part of the current matrix is not up to date.
14890 scroll_run_hook will clear the cursor, and use the
14891 current matrix to get the height of the row the cursor is
14893 run
.current_y
= start_row
->y
;
14894 run
.desired_y
= it
.current_y
;
14895 run
.height
= it
.last_visible_y
- it
.current_y
;
14897 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14900 FRAME_RIF (f
)->update_window_begin_hook (w
);
14901 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14902 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14903 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14907 /* Shift current matrix down by nrows_scrolled lines. */
14908 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14909 rotate_matrix (w
->current_matrix
,
14911 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14914 /* Disable lines that must be updated. */
14915 for (i
= 0; i
< nrows_scrolled
; ++i
)
14916 (start_row
+ i
)->enabled_p
= 0;
14918 /* Re-compute Y positions. */
14919 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14920 max_y
= it
.last_visible_y
;
14921 for (row
= start_row
+ nrows_scrolled
;
14925 row
->y
= it
.current_y
;
14926 row
->visible_height
= row
->height
;
14928 if (row
->y
< min_y
)
14929 row
->visible_height
-= min_y
- row
->y
;
14930 if (row
->y
+ row
->height
> max_y
)
14931 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14932 row
->redraw_fringe_bitmaps_p
= 1;
14934 it
.current_y
+= row
->height
;
14936 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14937 last_reused_text_row
= row
;
14938 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14942 /* Disable lines in the current matrix which are now
14943 below the window. */
14944 for (++row
; row
< bottom_row
; ++row
)
14945 row
->enabled_p
= row
->mode_line_p
= 0;
14948 /* Update window_end_pos etc.; last_reused_text_row is the last
14949 reused row from the current matrix containing text, if any.
14950 The value of last_text_row is the last displayed line
14951 containing text. */
14952 if (last_reused_text_row
)
14954 w
->window_end_bytepos
14955 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14957 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14959 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14960 w
->current_matrix
));
14962 else if (last_text_row
)
14964 w
->window_end_bytepos
14965 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14967 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14969 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14973 /* This window must be completely empty. */
14974 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14975 w
->window_end_pos
= make_number (Z
- ZV
);
14976 w
->window_end_vpos
= make_number (0);
14978 w
->window_end_valid
= Qnil
;
14980 /* Update hint: don't try scrolling again in update_window. */
14981 w
->desired_matrix
->no_scrolling_p
= 1;
14984 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14988 else if (CHARPOS (new_start
) > CHARPOS (start
))
14990 struct glyph_row
*pt_row
, *row
;
14991 struct glyph_row
*first_reusable_row
;
14992 struct glyph_row
*first_row_to_display
;
14994 int yb
= window_text_bottom_y (w
);
14996 /* Find the row starting at new_start, if there is one. Don't
14997 reuse a partially visible line at the end. */
14998 first_reusable_row
= start_row
;
14999 while (first_reusable_row
->enabled_p
15000 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15001 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15002 < CHARPOS (new_start
)))
15003 ++first_reusable_row
;
15005 /* Give up if there is no row to reuse. */
15006 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15007 || !first_reusable_row
->enabled_p
15008 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15009 != CHARPOS (new_start
)))
15012 /* We can reuse fully visible rows beginning with
15013 first_reusable_row to the end of the window. Set
15014 first_row_to_display to the first row that cannot be reused.
15015 Set pt_row to the row containing point, if there is any. */
15017 for (first_row_to_display
= first_reusable_row
;
15018 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15019 ++first_row_to_display
)
15021 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15022 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15023 pt_row
= first_row_to_display
;
15026 /* Start displaying at the start of first_row_to_display. */
15027 xassert (first_row_to_display
->y
< yb
);
15028 init_to_row_start (&it
, w
, first_row_to_display
);
15030 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15032 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15034 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15035 + WINDOW_HEADER_LINE_HEIGHT (w
));
15037 /* Display lines beginning with first_row_to_display in the
15038 desired matrix. Set last_text_row to the last row displayed
15039 that displays text. */
15040 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15041 if (pt_row
== NULL
)
15042 w
->cursor
.vpos
= -1;
15043 last_text_row
= NULL
;
15044 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15045 if (display_line (&it
))
15046 last_text_row
= it
.glyph_row
- 1;
15048 /* If point is in a reused row, adjust y and vpos of the cursor
15052 w
->cursor
.vpos
-= nrows_scrolled
;
15053 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15056 /* Give up if point isn't in a row displayed or reused. (This
15057 also handles the case where w->cursor.vpos < nrows_scrolled
15058 after the calls to display_line, which can happen with scroll
15059 margins. See bug#1295.) */
15060 if (w
->cursor
.vpos
< 0)
15062 clear_glyph_matrix (w
->desired_matrix
);
15066 /* Scroll the display. */
15067 run
.current_y
= first_reusable_row
->y
;
15068 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15069 run
.height
= it
.last_visible_y
- run
.current_y
;
15070 dy
= run
.current_y
- run
.desired_y
;
15075 FRAME_RIF (f
)->update_window_begin_hook (w
);
15076 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15077 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15078 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15082 /* Adjust Y positions of reused rows. */
15083 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15084 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15085 max_y
= it
.last_visible_y
;
15086 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15089 row
->visible_height
= row
->height
;
15090 if (row
->y
< min_y
)
15091 row
->visible_height
-= min_y
- row
->y
;
15092 if (row
->y
+ row
->height
> max_y
)
15093 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15094 row
->redraw_fringe_bitmaps_p
= 1;
15097 /* Scroll the current matrix. */
15098 xassert (nrows_scrolled
> 0);
15099 rotate_matrix (w
->current_matrix
,
15101 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15104 /* Disable rows not reused. */
15105 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15106 row
->enabled_p
= 0;
15108 /* Point may have moved to a different line, so we cannot assume that
15109 the previous cursor position is valid; locate the correct row. */
15112 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15113 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15117 w
->cursor
.y
= row
->y
;
15119 if (row
< bottom_row
)
15121 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15122 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15124 /* Can't use this optimization with bidi-reordered glyph
15125 rows, unless cursor is already at point. */
15126 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15128 if (!(w
->cursor
.hpos
>= 0
15129 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15130 && BUFFERP (glyph
->object
)
15131 && glyph
->charpos
== PT
))
15136 && (!BUFFERP (glyph
->object
)
15137 || glyph
->charpos
< PT
);
15141 w
->cursor
.x
+= glyph
->pixel_width
;
15146 /* Adjust window end. A null value of last_text_row means that
15147 the window end is in reused rows which in turn means that
15148 only its vpos can have changed. */
15151 w
->window_end_bytepos
15152 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15154 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15156 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15161 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15164 w
->window_end_valid
= Qnil
;
15165 w
->desired_matrix
->no_scrolling_p
= 1;
15168 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15178 /************************************************************************
15179 Window redisplay reusing current matrix when buffer has changed
15180 ************************************************************************/
15182 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15183 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15184 EMACS_INT
*, EMACS_INT
*);
15185 static struct glyph_row
*
15186 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15187 struct glyph_row
*);
15190 /* Return the last row in MATRIX displaying text. If row START is
15191 non-null, start searching with that row. IT gives the dimensions
15192 of the display. Value is null if matrix is empty; otherwise it is
15193 a pointer to the row found. */
15195 static struct glyph_row
*
15196 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15197 struct glyph_row
*start
)
15199 struct glyph_row
*row
, *row_found
;
15201 /* Set row_found to the last row in IT->w's current matrix
15202 displaying text. The loop looks funny but think of partially
15205 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15206 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15208 xassert (row
->enabled_p
);
15210 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15219 /* Return the last row in the current matrix of W that is not affected
15220 by changes at the start of current_buffer that occurred since W's
15221 current matrix was built. Value is null if no such row exists.
15223 BEG_UNCHANGED us the number of characters unchanged at the start of
15224 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15225 first changed character in current_buffer. Characters at positions <
15226 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15227 when the current matrix was built. */
15229 static struct glyph_row
*
15230 find_last_unchanged_at_beg_row (struct window
*w
)
15232 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15233 struct glyph_row
*row
;
15234 struct glyph_row
*row_found
= NULL
;
15235 int yb
= window_text_bottom_y (w
);
15237 /* Find the last row displaying unchanged text. */
15238 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15239 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15240 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15243 if (/* If row ends before first_changed_pos, it is unchanged,
15244 except in some case. */
15245 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15246 /* When row ends in ZV and we write at ZV it is not
15248 && !row
->ends_at_zv_p
15249 /* When first_changed_pos is the end of a continued line,
15250 row is not unchanged because it may be no longer
15252 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15253 && (row
->continued_p
15254 || row
->exact_window_width_line_p
)))
15257 /* Stop if last visible row. */
15258 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15266 /* Find the first glyph row in the current matrix of W that is not
15267 affected by changes at the end of current_buffer since the
15268 time W's current matrix was built.
15270 Return in *DELTA the number of chars by which buffer positions in
15271 unchanged text at the end of current_buffer must be adjusted.
15273 Return in *DELTA_BYTES the corresponding number of bytes.
15275 Value is null if no such row exists, i.e. all rows are affected by
15278 static struct glyph_row
*
15279 find_first_unchanged_at_end_row (struct window
*w
,
15280 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15282 struct glyph_row
*row
;
15283 struct glyph_row
*row_found
= NULL
;
15285 *delta
= *delta_bytes
= 0;
15287 /* Display must not have been paused, otherwise the current matrix
15288 is not up to date. */
15289 eassert (!NILP (w
->window_end_valid
));
15291 /* A value of window_end_pos >= END_UNCHANGED means that the window
15292 end is in the range of changed text. If so, there is no
15293 unchanged row at the end of W's current matrix. */
15294 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15297 /* Set row to the last row in W's current matrix displaying text. */
15298 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15300 /* If matrix is entirely empty, no unchanged row exists. */
15301 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15303 /* The value of row is the last glyph row in the matrix having a
15304 meaningful buffer position in it. The end position of row
15305 corresponds to window_end_pos. This allows us to translate
15306 buffer positions in the current matrix to current buffer
15307 positions for characters not in changed text. */
15309 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15310 EMACS_INT Z_BYTE_old
=
15311 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15312 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15313 struct glyph_row
*first_text_row
15314 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15316 *delta
= Z
- Z_old
;
15317 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15319 /* Set last_unchanged_pos to the buffer position of the last
15320 character in the buffer that has not been changed. Z is the
15321 index + 1 of the last character in current_buffer, i.e. by
15322 subtracting END_UNCHANGED we get the index of the last
15323 unchanged character, and we have to add BEG to get its buffer
15325 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15326 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15328 /* Search backward from ROW for a row displaying a line that
15329 starts at a minimum position >= last_unchanged_pos_old. */
15330 for (; row
> first_text_row
; --row
)
15332 /* This used to abort, but it can happen.
15333 It is ok to just stop the search instead here. KFS. */
15334 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15337 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15342 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15348 /* Make sure that glyph rows in the current matrix of window W
15349 reference the same glyph memory as corresponding rows in the
15350 frame's frame matrix. This function is called after scrolling W's
15351 current matrix on a terminal frame in try_window_id and
15352 try_window_reusing_current_matrix. */
15355 sync_frame_with_window_matrix_rows (struct window
*w
)
15357 struct frame
*f
= XFRAME (w
->frame
);
15358 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15360 /* Preconditions: W must be a leaf window and full-width. Its frame
15361 must have a frame matrix. */
15362 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15363 xassert (WINDOW_FULL_WIDTH_P (w
));
15364 xassert (!FRAME_WINDOW_P (f
));
15366 /* If W is a full-width window, glyph pointers in W's current matrix
15367 have, by definition, to be the same as glyph pointers in the
15368 corresponding frame matrix. Note that frame matrices have no
15369 marginal areas (see build_frame_matrix). */
15370 window_row
= w
->current_matrix
->rows
;
15371 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15372 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15373 while (window_row
< window_row_end
)
15375 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15376 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15378 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15379 frame_row
->glyphs
[TEXT_AREA
] = start
;
15380 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15381 frame_row
->glyphs
[LAST_AREA
] = end
;
15383 /* Disable frame rows whose corresponding window rows have
15384 been disabled in try_window_id. */
15385 if (!window_row
->enabled_p
)
15386 frame_row
->enabled_p
= 0;
15388 ++window_row
, ++frame_row
;
15393 /* Find the glyph row in window W containing CHARPOS. Consider all
15394 rows between START and END (not inclusive). END null means search
15395 all rows to the end of the display area of W. Value is the row
15396 containing CHARPOS or null. */
15399 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15400 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15402 struct glyph_row
*row
= start
;
15403 struct glyph_row
*best_row
= NULL
;
15404 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15407 /* If we happen to start on a header-line, skip that. */
15408 if (row
->mode_line_p
)
15411 if ((end
&& row
>= end
) || !row
->enabled_p
)
15414 last_y
= window_text_bottom_y (w
) - dy
;
15418 /* Give up if we have gone too far. */
15419 if (end
&& row
>= end
)
15421 /* This formerly returned if they were equal.
15422 I think that both quantities are of a "last plus one" type;
15423 if so, when they are equal, the row is within the screen. -- rms. */
15424 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15427 /* If it is in this row, return this row. */
15428 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15429 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15430 /* The end position of a row equals the start
15431 position of the next row. If CHARPOS is there, we
15432 would rather display it in the next line, except
15433 when this line ends in ZV. */
15434 && !row
->ends_at_zv_p
15435 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15436 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15440 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15441 || (!best_row
&& !row
->continued_p
))
15443 /* In bidi-reordered rows, there could be several rows
15444 occluding point, all of them belonging to the same
15445 continued line. We need to find the row which fits
15446 CHARPOS the best. */
15447 for (g
= row
->glyphs
[TEXT_AREA
];
15448 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15451 if (!STRINGP (g
->object
))
15453 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15455 mindif
= eabs (g
->charpos
- charpos
);
15457 /* Exact match always wins. */
15464 else if (best_row
&& !row
->continued_p
)
15471 /* Try to redisplay window W by reusing its existing display. W's
15472 current matrix must be up to date when this function is called,
15473 i.e. window_end_valid must not be nil.
15477 1 if display has been updated
15478 0 if otherwise unsuccessful
15479 -1 if redisplay with same window start is known not to succeed
15481 The following steps are performed:
15483 1. Find the last row in the current matrix of W that is not
15484 affected by changes at the start of current_buffer. If no such row
15487 2. Find the first row in W's current matrix that is not affected by
15488 changes at the end of current_buffer. Maybe there is no such row.
15490 3. Display lines beginning with the row + 1 found in step 1 to the
15491 row found in step 2 or, if step 2 didn't find a row, to the end of
15494 4. If cursor is not known to appear on the window, give up.
15496 5. If display stopped at the row found in step 2, scroll the
15497 display and current matrix as needed.
15499 6. Maybe display some lines at the end of W, if we must. This can
15500 happen under various circumstances, like a partially visible line
15501 becoming fully visible, or because newly displayed lines are displayed
15502 in smaller font sizes.
15504 7. Update W's window end information. */
15507 try_window_id (struct window
*w
)
15509 struct frame
*f
= XFRAME (w
->frame
);
15510 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15511 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15512 struct glyph_row
*last_unchanged_at_beg_row
;
15513 struct glyph_row
*first_unchanged_at_end_row
;
15514 struct glyph_row
*row
;
15515 struct glyph_row
*bottom_row
;
15518 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15520 struct text_pos start_pos
;
15522 int first_unchanged_at_end_vpos
= 0;
15523 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15524 struct text_pos start
;
15525 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15528 if (inhibit_try_window_id
)
15532 /* This is handy for debugging. */
15534 #define GIVE_UP(X) \
15536 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15540 #define GIVE_UP(X) return 0
15543 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15545 /* Don't use this for mini-windows because these can show
15546 messages and mini-buffers, and we don't handle that here. */
15547 if (MINI_WINDOW_P (w
))
15550 /* This flag is used to prevent redisplay optimizations. */
15551 if (windows_or_buffers_changed
|| cursor_type_changed
)
15554 /* Verify that narrowing has not changed.
15555 Also verify that we were not told to prevent redisplay optimizations.
15556 It would be nice to further
15557 reduce the number of cases where this prevents try_window_id. */
15558 if (current_buffer
->clip_changed
15559 || current_buffer
->prevent_redisplay_optimizations_p
)
15562 /* Window must either use window-based redisplay or be full width. */
15563 if (!FRAME_WINDOW_P (f
)
15564 && (!FRAME_LINE_INS_DEL_OK (f
)
15565 || !WINDOW_FULL_WIDTH_P (w
)))
15568 /* Give up if point is known NOT to appear in W. */
15569 if (PT
< CHARPOS (start
))
15572 /* Another way to prevent redisplay optimizations. */
15573 if (XFASTINT (w
->last_modified
) == 0)
15576 /* Verify that window is not hscrolled. */
15577 if (XFASTINT (w
->hscroll
) != 0)
15580 /* Verify that display wasn't paused. */
15581 if (NILP (w
->window_end_valid
))
15584 /* Can't use this if highlighting a region because a cursor movement
15585 will do more than just set the cursor. */
15586 if (!NILP (Vtransient_mark_mode
)
15587 && !NILP (BVAR (current_buffer
, mark_active
)))
15590 /* Likewise if highlighting trailing whitespace. */
15591 if (!NILP (Vshow_trailing_whitespace
))
15594 /* Likewise if showing a region. */
15595 if (!NILP (w
->region_showing
))
15598 /* Can't use this if overlay arrow position and/or string have
15600 if (overlay_arrows_changed_p ())
15603 /* When word-wrap is on, adding a space to the first word of a
15604 wrapped line can change the wrap position, altering the line
15605 above it. It might be worthwhile to handle this more
15606 intelligently, but for now just redisplay from scratch. */
15607 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15610 /* Under bidi reordering, adding or deleting a character in the
15611 beginning of a paragraph, before the first strong directional
15612 character, can change the base direction of the paragraph (unless
15613 the buffer specifies a fixed paragraph direction), which will
15614 require to redisplay the whole paragraph. It might be worthwhile
15615 to find the paragraph limits and widen the range of redisplayed
15616 lines to that, but for now just give up this optimization and
15617 redisplay from scratch. */
15618 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15619 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15622 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15623 only if buffer has really changed. The reason is that the gap is
15624 initially at Z for freshly visited files. The code below would
15625 set end_unchanged to 0 in that case. */
15626 if (MODIFF
> SAVE_MODIFF
15627 /* This seems to happen sometimes after saving a buffer. */
15628 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15630 if (GPT
- BEG
< BEG_UNCHANGED
)
15631 BEG_UNCHANGED
= GPT
- BEG
;
15632 if (Z
- GPT
< END_UNCHANGED
)
15633 END_UNCHANGED
= Z
- GPT
;
15636 /* The position of the first and last character that has been changed. */
15637 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15638 last_changed_charpos
= Z
- END_UNCHANGED
;
15640 /* If window starts after a line end, and the last change is in
15641 front of that newline, then changes don't affect the display.
15642 This case happens with stealth-fontification. Note that although
15643 the display is unchanged, glyph positions in the matrix have to
15644 be adjusted, of course. */
15645 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15646 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15647 && ((last_changed_charpos
< CHARPOS (start
)
15648 && CHARPOS (start
) == BEGV
)
15649 || (last_changed_charpos
< CHARPOS (start
) - 1
15650 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15652 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15653 struct glyph_row
*r0
;
15655 /* Compute how many chars/bytes have been added to or removed
15656 from the buffer. */
15657 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15658 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15659 Z_delta
= Z
- Z_old
;
15660 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15662 /* Give up if PT is not in the window. Note that it already has
15663 been checked at the start of try_window_id that PT is not in
15664 front of the window start. */
15665 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15668 /* If window start is unchanged, we can reuse the whole matrix
15669 as is, after adjusting glyph positions. No need to compute
15670 the window end again, since its offset from Z hasn't changed. */
15671 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15672 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15673 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15674 /* PT must not be in a partially visible line. */
15675 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15676 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15678 /* Adjust positions in the glyph matrix. */
15679 if (Z_delta
|| Z_delta_bytes
)
15681 struct glyph_row
*r1
15682 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15683 increment_matrix_positions (w
->current_matrix
,
15684 MATRIX_ROW_VPOS (r0
, current_matrix
),
15685 MATRIX_ROW_VPOS (r1
, current_matrix
),
15686 Z_delta
, Z_delta_bytes
);
15689 /* Set the cursor. */
15690 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15692 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15699 /* Handle the case that changes are all below what is displayed in
15700 the window, and that PT is in the window. This shortcut cannot
15701 be taken if ZV is visible in the window, and text has been added
15702 there that is visible in the window. */
15703 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15704 /* ZV is not visible in the window, or there are no
15705 changes at ZV, actually. */
15706 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15707 || first_changed_charpos
== last_changed_charpos
))
15709 struct glyph_row
*r0
;
15711 /* Give up if PT is not in the window. Note that it already has
15712 been checked at the start of try_window_id that PT is not in
15713 front of the window start. */
15714 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15717 /* If window start is unchanged, we can reuse the whole matrix
15718 as is, without changing glyph positions since no text has
15719 been added/removed in front of the window end. */
15720 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15721 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15722 /* PT must not be in a partially visible line. */
15723 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15724 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15726 /* We have to compute the window end anew since text
15727 could have been added/removed after it. */
15729 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15730 w
->window_end_bytepos
15731 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15733 /* Set the cursor. */
15734 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15736 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15743 /* Give up if window start is in the changed area.
15745 The condition used to read
15747 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15749 but why that was tested escapes me at the moment. */
15750 if (CHARPOS (start
) >= first_changed_charpos
15751 && CHARPOS (start
) <= last_changed_charpos
)
15754 /* Check that window start agrees with the start of the first glyph
15755 row in its current matrix. Check this after we know the window
15756 start is not in changed text, otherwise positions would not be
15758 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15759 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15762 /* Give up if the window ends in strings. Overlay strings
15763 at the end are difficult to handle, so don't try. */
15764 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15765 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15768 /* Compute the position at which we have to start displaying new
15769 lines. Some of the lines at the top of the window might be
15770 reusable because they are not displaying changed text. Find the
15771 last row in W's current matrix not affected by changes at the
15772 start of current_buffer. Value is null if changes start in the
15773 first line of window. */
15774 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15775 if (last_unchanged_at_beg_row
)
15777 /* Avoid starting to display in the moddle of a character, a TAB
15778 for instance. This is easier than to set up the iterator
15779 exactly, and it's not a frequent case, so the additional
15780 effort wouldn't really pay off. */
15781 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15782 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15783 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15784 --last_unchanged_at_beg_row
;
15786 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15789 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15791 start_pos
= it
.current
.pos
;
15793 /* Start displaying new lines in the desired matrix at the same
15794 vpos we would use in the current matrix, i.e. below
15795 last_unchanged_at_beg_row. */
15796 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15798 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15799 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15801 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15805 /* There are no reusable lines at the start of the window.
15806 Start displaying in the first text line. */
15807 start_display (&it
, w
, start
);
15808 it
.vpos
= it
.first_vpos
;
15809 start_pos
= it
.current
.pos
;
15812 /* Find the first row that is not affected by changes at the end of
15813 the buffer. Value will be null if there is no unchanged row, in
15814 which case we must redisplay to the end of the window. delta
15815 will be set to the value by which buffer positions beginning with
15816 first_unchanged_at_end_row have to be adjusted due to text
15818 first_unchanged_at_end_row
15819 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15820 IF_DEBUG (debug_delta
= delta
);
15821 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15823 /* Set stop_pos to the buffer position up to which we will have to
15824 display new lines. If first_unchanged_at_end_row != NULL, this
15825 is the buffer position of the start of the line displayed in that
15826 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15827 that we don't stop at a buffer position. */
15829 if (first_unchanged_at_end_row
)
15831 xassert (last_unchanged_at_beg_row
== NULL
15832 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15834 /* If this is a continuation line, move forward to the next one
15835 that isn't. Changes in lines above affect this line.
15836 Caution: this may move first_unchanged_at_end_row to a row
15837 not displaying text. */
15838 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15839 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15840 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15841 < it
.last_visible_y
))
15842 ++first_unchanged_at_end_row
;
15844 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15845 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15846 >= it
.last_visible_y
))
15847 first_unchanged_at_end_row
= NULL
;
15850 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15852 first_unchanged_at_end_vpos
15853 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15854 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15857 else if (last_unchanged_at_beg_row
== NULL
)
15863 /* Either there is no unchanged row at the end, or the one we have
15864 now displays text. This is a necessary condition for the window
15865 end pos calculation at the end of this function. */
15866 xassert (first_unchanged_at_end_row
== NULL
15867 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15869 debug_last_unchanged_at_beg_vpos
15870 = (last_unchanged_at_beg_row
15871 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15873 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15875 #endif /* GLYPH_DEBUG != 0 */
15878 /* Display new lines. Set last_text_row to the last new line
15879 displayed which has text on it, i.e. might end up as being the
15880 line where the window_end_vpos is. */
15881 w
->cursor
.vpos
= -1;
15882 last_text_row
= NULL
;
15883 overlay_arrow_seen
= 0;
15884 while (it
.current_y
< it
.last_visible_y
15885 && !fonts_changed_p
15886 && (first_unchanged_at_end_row
== NULL
15887 || IT_CHARPOS (it
) < stop_pos
))
15889 if (display_line (&it
))
15890 last_text_row
= it
.glyph_row
- 1;
15893 if (fonts_changed_p
)
15897 /* Compute differences in buffer positions, y-positions etc. for
15898 lines reused at the bottom of the window. Compute what we can
15900 if (first_unchanged_at_end_row
15901 /* No lines reused because we displayed everything up to the
15902 bottom of the window. */
15903 && it
.current_y
< it
.last_visible_y
)
15906 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15908 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15909 run
.current_y
= first_unchanged_at_end_row
->y
;
15910 run
.desired_y
= run
.current_y
+ dy
;
15911 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15915 delta
= delta_bytes
= dvpos
= dy
15916 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15917 first_unchanged_at_end_row
= NULL
;
15919 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15922 /* Find the cursor if not already found. We have to decide whether
15923 PT will appear on this window (it sometimes doesn't, but this is
15924 not a very frequent case.) This decision has to be made before
15925 the current matrix is altered. A value of cursor.vpos < 0 means
15926 that PT is either in one of the lines beginning at
15927 first_unchanged_at_end_row or below the window. Don't care for
15928 lines that might be displayed later at the window end; as
15929 mentioned, this is not a frequent case. */
15930 if (w
->cursor
.vpos
< 0)
15932 /* Cursor in unchanged rows at the top? */
15933 if (PT
< CHARPOS (start_pos
)
15934 && last_unchanged_at_beg_row
)
15936 row
= row_containing_pos (w
, PT
,
15937 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15938 last_unchanged_at_beg_row
+ 1, 0);
15940 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15943 /* Start from first_unchanged_at_end_row looking for PT. */
15944 else if (first_unchanged_at_end_row
)
15946 row
= row_containing_pos (w
, PT
- delta
,
15947 first_unchanged_at_end_row
, NULL
, 0);
15949 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15950 delta_bytes
, dy
, dvpos
);
15953 /* Give up if cursor was not found. */
15954 if (w
->cursor
.vpos
< 0)
15956 clear_glyph_matrix (w
->desired_matrix
);
15961 /* Don't let the cursor end in the scroll margins. */
15963 int this_scroll_margin
, cursor_height
;
15965 this_scroll_margin
= max (0, scroll_margin
);
15966 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15967 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15968 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15970 if ((w
->cursor
.y
< this_scroll_margin
15971 && CHARPOS (start
) > BEGV
)
15972 /* Old redisplay didn't take scroll margin into account at the bottom,
15973 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15974 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15975 ? cursor_height
+ this_scroll_margin
15976 : 1)) > it
.last_visible_y
)
15978 w
->cursor
.vpos
= -1;
15979 clear_glyph_matrix (w
->desired_matrix
);
15984 /* Scroll the display. Do it before changing the current matrix so
15985 that xterm.c doesn't get confused about where the cursor glyph is
15987 if (dy
&& run
.height
)
15991 if (FRAME_WINDOW_P (f
))
15993 FRAME_RIF (f
)->update_window_begin_hook (w
);
15994 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15995 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15996 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16000 /* Terminal frame. In this case, dvpos gives the number of
16001 lines to scroll by; dvpos < 0 means scroll up. */
16003 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16004 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16005 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16006 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16007 + window_internal_height (w
));
16009 #if defined (HAVE_GPM) || defined (MSDOS)
16010 x_clear_window_mouse_face (w
);
16012 /* Perform the operation on the screen. */
16015 /* Scroll last_unchanged_at_beg_row to the end of the
16016 window down dvpos lines. */
16017 set_terminal_window (f
, end
);
16019 /* On dumb terminals delete dvpos lines at the end
16020 before inserting dvpos empty lines. */
16021 if (!FRAME_SCROLL_REGION_OK (f
))
16022 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16024 /* Insert dvpos empty lines in front of
16025 last_unchanged_at_beg_row. */
16026 ins_del_lines (f
, from
, dvpos
);
16028 else if (dvpos
< 0)
16030 /* Scroll up last_unchanged_at_beg_vpos to the end of
16031 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16032 set_terminal_window (f
, end
);
16034 /* Delete dvpos lines in front of
16035 last_unchanged_at_beg_vpos. ins_del_lines will set
16036 the cursor to the given vpos and emit |dvpos| delete
16038 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16040 /* On a dumb terminal insert dvpos empty lines at the
16042 if (!FRAME_SCROLL_REGION_OK (f
))
16043 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16046 set_terminal_window (f
, 0);
16052 /* Shift reused rows of the current matrix to the right position.
16053 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16055 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16056 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16059 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16060 bottom_vpos
, dvpos
);
16061 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16064 else if (dvpos
> 0)
16066 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16067 bottom_vpos
, dvpos
);
16068 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16069 first_unchanged_at_end_vpos
+ dvpos
, 0);
16072 /* For frame-based redisplay, make sure that current frame and window
16073 matrix are in sync with respect to glyph memory. */
16074 if (!FRAME_WINDOW_P (f
))
16075 sync_frame_with_window_matrix_rows (w
);
16077 /* Adjust buffer positions in reused rows. */
16078 if (delta
|| delta_bytes
)
16079 increment_matrix_positions (current_matrix
,
16080 first_unchanged_at_end_vpos
+ dvpos
,
16081 bottom_vpos
, delta
, delta_bytes
);
16083 /* Adjust Y positions. */
16085 shift_glyph_matrix (w
, current_matrix
,
16086 first_unchanged_at_end_vpos
+ dvpos
,
16089 if (first_unchanged_at_end_row
)
16091 first_unchanged_at_end_row
+= dvpos
;
16092 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16093 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16094 first_unchanged_at_end_row
= NULL
;
16097 /* If scrolling up, there may be some lines to display at the end of
16099 last_text_row_at_end
= NULL
;
16102 /* Scrolling up can leave for example a partially visible line
16103 at the end of the window to be redisplayed. */
16104 /* Set last_row to the glyph row in the current matrix where the
16105 window end line is found. It has been moved up or down in
16106 the matrix by dvpos. */
16107 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16108 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16110 /* If last_row is the window end line, it should display text. */
16111 xassert (last_row
->displays_text_p
);
16113 /* If window end line was partially visible before, begin
16114 displaying at that line. Otherwise begin displaying with the
16115 line following it. */
16116 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16118 init_to_row_start (&it
, w
, last_row
);
16119 it
.vpos
= last_vpos
;
16120 it
.current_y
= last_row
->y
;
16124 init_to_row_end (&it
, w
, last_row
);
16125 it
.vpos
= 1 + last_vpos
;
16126 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16130 /* We may start in a continuation line. If so, we have to
16131 get the right continuation_lines_width and current_x. */
16132 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16133 it
.hpos
= it
.current_x
= 0;
16135 /* Display the rest of the lines at the window end. */
16136 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16137 while (it
.current_y
< it
.last_visible_y
16138 && !fonts_changed_p
)
16140 /* Is it always sure that the display agrees with lines in
16141 the current matrix? I don't think so, so we mark rows
16142 displayed invalid in the current matrix by setting their
16143 enabled_p flag to zero. */
16144 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16145 if (display_line (&it
))
16146 last_text_row_at_end
= it
.glyph_row
- 1;
16150 /* Update window_end_pos and window_end_vpos. */
16151 if (first_unchanged_at_end_row
16152 && !last_text_row_at_end
)
16154 /* Window end line if one of the preserved rows from the current
16155 matrix. Set row to the last row displaying text in current
16156 matrix starting at first_unchanged_at_end_row, after
16158 xassert (first_unchanged_at_end_row
->displays_text_p
);
16159 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16160 first_unchanged_at_end_row
);
16161 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16163 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16164 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16166 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16167 xassert (w
->window_end_bytepos
>= 0);
16168 IF_DEBUG (debug_method_add (w
, "A"));
16170 else if (last_text_row_at_end
)
16173 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16174 w
->window_end_bytepos
16175 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16177 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16178 xassert (w
->window_end_bytepos
>= 0);
16179 IF_DEBUG (debug_method_add (w
, "B"));
16181 else if (last_text_row
)
16183 /* We have displayed either to the end of the window or at the
16184 end of the window, i.e. the last row with text is to be found
16185 in the desired matrix. */
16187 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16188 w
->window_end_bytepos
16189 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16191 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16192 xassert (w
->window_end_bytepos
>= 0);
16194 else if (first_unchanged_at_end_row
== NULL
16195 && last_text_row
== NULL
16196 && last_text_row_at_end
== NULL
)
16198 /* Displayed to end of window, but no line containing text was
16199 displayed. Lines were deleted at the end of the window. */
16200 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16201 int vpos
= XFASTINT (w
->window_end_vpos
);
16202 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16203 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16206 row
== NULL
&& vpos
>= first_vpos
;
16207 --vpos
, --current_row
, --desired_row
)
16209 if (desired_row
->enabled_p
)
16211 if (desired_row
->displays_text_p
)
16214 else if (current_row
->displays_text_p
)
16218 xassert (row
!= NULL
);
16219 w
->window_end_vpos
= make_number (vpos
+ 1);
16220 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16221 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16222 xassert (w
->window_end_bytepos
>= 0);
16223 IF_DEBUG (debug_method_add (w
, "C"));
16228 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16229 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16231 /* Record that display has not been completed. */
16232 w
->window_end_valid
= Qnil
;
16233 w
->desired_matrix
->no_scrolling_p
= 1;
16241 /***********************************************************************
16242 More debugging support
16243 ***********************************************************************/
16247 void dump_glyph_row (struct glyph_row
*, int, int);
16248 void dump_glyph_matrix (struct glyph_matrix
*, int);
16249 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16252 /* Dump the contents of glyph matrix MATRIX on stderr.
16254 GLYPHS 0 means don't show glyph contents.
16255 GLYPHS 1 means show glyphs in short form
16256 GLYPHS > 1 means show glyphs in long form. */
16259 dump_glyph_matrix (matrix
, glyphs
)
16260 struct glyph_matrix
*matrix
;
16264 for (i
= 0; i
< matrix
->nrows
; ++i
)
16265 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16269 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16270 the glyph row and area where the glyph comes from. */
16273 dump_glyph (row
, glyph
, area
)
16274 struct glyph_row
*row
;
16275 struct glyph
*glyph
;
16278 if (glyph
->type
== CHAR_GLYPH
)
16281 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16282 glyph
- row
->glyphs
[TEXT_AREA
],
16285 (BUFFERP (glyph
->object
)
16287 : (STRINGP (glyph
->object
)
16290 glyph
->pixel_width
,
16292 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16296 glyph
->left_box_line_p
,
16297 glyph
->right_box_line_p
);
16299 else if (glyph
->type
== STRETCH_GLYPH
)
16302 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16303 glyph
- row
->glyphs
[TEXT_AREA
],
16306 (BUFFERP (glyph
->object
)
16308 : (STRINGP (glyph
->object
)
16311 glyph
->pixel_width
,
16315 glyph
->left_box_line_p
,
16316 glyph
->right_box_line_p
);
16318 else if (glyph
->type
== IMAGE_GLYPH
)
16321 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16322 glyph
- row
->glyphs
[TEXT_AREA
],
16325 (BUFFERP (glyph
->object
)
16327 : (STRINGP (glyph
->object
)
16330 glyph
->pixel_width
,
16334 glyph
->left_box_line_p
,
16335 glyph
->right_box_line_p
);
16337 else if (glyph
->type
== COMPOSITE_GLYPH
)
16340 " %5d %4c %6d %c %3d 0x%05x",
16341 glyph
- row
->glyphs
[TEXT_AREA
],
16344 (BUFFERP (glyph
->object
)
16346 : (STRINGP (glyph
->object
)
16349 glyph
->pixel_width
,
16351 if (glyph
->u
.cmp
.automatic
)
16354 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16355 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16357 glyph
->left_box_line_p
,
16358 glyph
->right_box_line_p
);
16363 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16364 GLYPHS 0 means don't show glyph contents.
16365 GLYPHS 1 means show glyphs in short form
16366 GLYPHS > 1 means show glyphs in long form. */
16369 dump_glyph_row (row
, vpos
, glyphs
)
16370 struct glyph_row
*row
;
16375 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16376 fprintf (stderr
, "======================================================================\n");
16378 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16379 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16381 MATRIX_ROW_START_CHARPOS (row
),
16382 MATRIX_ROW_END_CHARPOS (row
),
16383 row
->used
[TEXT_AREA
],
16384 row
->contains_overlapping_glyphs_p
,
16386 row
->truncated_on_left_p
,
16387 row
->truncated_on_right_p
,
16389 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16390 row
->displays_text_p
,
16393 row
->ends_in_middle_of_char_p
,
16394 row
->starts_in_middle_of_char_p
,
16400 row
->visible_height
,
16403 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16404 row
->end
.overlay_string_index
,
16405 row
->continuation_lines_width
);
16406 fprintf (stderr
, "%9d %5d\n",
16407 CHARPOS (row
->start
.string_pos
),
16408 CHARPOS (row
->end
.string_pos
));
16409 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16410 row
->end
.dpvec_index
);
16417 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16419 struct glyph
*glyph
= row
->glyphs
[area
];
16420 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16422 /* Glyph for a line end in text. */
16423 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16426 if (glyph
< glyph_end
)
16427 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16429 for (; glyph
< glyph_end
; ++glyph
)
16430 dump_glyph (row
, glyph
, area
);
16433 else if (glyphs
== 1)
16437 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16439 char *s
= (char *) alloca (row
->used
[area
] + 1);
16442 for (i
= 0; i
< row
->used
[area
]; ++i
)
16444 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16445 if (glyph
->type
== CHAR_GLYPH
16446 && glyph
->u
.ch
< 0x80
16447 && glyph
->u
.ch
>= ' ')
16448 s
[i
] = glyph
->u
.ch
;
16454 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16460 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16461 Sdump_glyph_matrix
, 0, 1, "p",
16462 doc
: /* Dump the current matrix of the selected window to stderr.
16463 Shows contents of glyph row structures. With non-nil
16464 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16465 glyphs in short form, otherwise show glyphs in long form. */)
16466 (Lisp_Object glyphs
)
16468 struct window
*w
= XWINDOW (selected_window
);
16469 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16471 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16472 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16473 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16474 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16475 fprintf (stderr
, "=============================================\n");
16476 dump_glyph_matrix (w
->current_matrix
,
16477 NILP (glyphs
) ? 0 : XINT (glyphs
));
16482 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16483 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16486 struct frame
*f
= XFRAME (selected_frame
);
16487 dump_glyph_matrix (f
->current_matrix
, 1);
16492 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16493 doc
: /* Dump glyph row ROW to stderr.
16494 GLYPH 0 means don't dump glyphs.
16495 GLYPH 1 means dump glyphs in short form.
16496 GLYPH > 1 or omitted means dump glyphs in long form. */)
16497 (Lisp_Object row
, Lisp_Object glyphs
)
16499 struct glyph_matrix
*matrix
;
16502 CHECK_NUMBER (row
);
16503 matrix
= XWINDOW (selected_window
)->current_matrix
;
16505 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16506 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16508 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16513 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16514 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16515 GLYPH 0 means don't dump glyphs.
16516 GLYPH 1 means dump glyphs in short form.
16517 GLYPH > 1 or omitted means dump glyphs in long form. */)
16518 (Lisp_Object row
, Lisp_Object glyphs
)
16520 struct frame
*sf
= SELECTED_FRAME ();
16521 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16524 CHECK_NUMBER (row
);
16526 if (vpos
>= 0 && vpos
< m
->nrows
)
16527 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16528 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16533 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16534 doc
: /* Toggle tracing of redisplay.
16535 With ARG, turn tracing on if and only if ARG is positive. */)
16539 trace_redisplay_p
= !trace_redisplay_p
;
16542 arg
= Fprefix_numeric_value (arg
);
16543 trace_redisplay_p
= XINT (arg
) > 0;
16550 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16551 doc
: /* Like `format', but print result to stderr.
16552 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16553 (size_t nargs
, Lisp_Object
*args
)
16555 Lisp_Object s
= Fformat (nargs
, args
);
16556 fprintf (stderr
, "%s", SDATA (s
));
16560 #endif /* GLYPH_DEBUG */
16564 /***********************************************************************
16565 Building Desired Matrix Rows
16566 ***********************************************************************/
16568 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16569 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16571 static struct glyph_row
*
16572 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16574 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16575 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16576 struct buffer
*old
= current_buffer
;
16577 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16578 int arrow_len
= SCHARS (overlay_arrow_string
);
16579 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16580 const unsigned char *p
;
16583 int n_glyphs_before
;
16585 set_buffer_temp (buffer
);
16586 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16587 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16588 SET_TEXT_POS (it
.position
, 0, 0);
16590 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16592 while (p
< arrow_end
)
16594 Lisp_Object face
, ilisp
;
16596 /* Get the next character. */
16598 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16601 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16602 if (! ASCII_CHAR_P (it
.c
))
16603 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16607 /* Get its face. */
16608 ilisp
= make_number (p
- arrow_string
);
16609 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16610 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16612 /* Compute its width, get its glyphs. */
16613 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16614 SET_TEXT_POS (it
.position
, -1, -1);
16615 PRODUCE_GLYPHS (&it
);
16617 /* If this character doesn't fit any more in the line, we have
16618 to remove some glyphs. */
16619 if (it
.current_x
> it
.last_visible_x
)
16621 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16626 set_buffer_temp (old
);
16627 return it
.glyph_row
;
16631 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16632 glyphs are only inserted for terminal frames since we can't really
16633 win with truncation glyphs when partially visible glyphs are
16634 involved. Which glyphs to insert is determined by
16635 produce_special_glyphs. */
16638 insert_left_trunc_glyphs (struct it
*it
)
16640 struct it truncate_it
;
16641 struct glyph
*from
, *end
, *to
, *toend
;
16643 xassert (!FRAME_WINDOW_P (it
->f
));
16645 /* Get the truncation glyphs. */
16647 truncate_it
.current_x
= 0;
16648 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16649 truncate_it
.glyph_row
= &scratch_glyph_row
;
16650 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16651 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16652 truncate_it
.object
= make_number (0);
16653 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16655 /* Overwrite glyphs from IT with truncation glyphs. */
16656 if (!it
->glyph_row
->reversed_p
)
16658 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16659 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16660 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16661 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16666 /* There may be padding glyphs left over. Overwrite them too. */
16667 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16669 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16675 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16679 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16680 that back to front. */
16681 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16682 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16683 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16684 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16686 while (from
>= end
&& to
>= toend
)
16688 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16691 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16692 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16693 while (from
>= end
&& to
>= toend
)
16698 /* Need to free some room before prepending additional
16700 int move_by
= from
- end
+ 1;
16701 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16702 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16704 for ( ; g
>= g0
; g
--)
16706 while (from
>= end
)
16708 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16714 /* Compute the pixel height and width of IT->glyph_row.
16716 Most of the time, ascent and height of a display line will be equal
16717 to the max_ascent and max_height values of the display iterator
16718 structure. This is not the case if
16720 1. We hit ZV without displaying anything. In this case, max_ascent
16721 and max_height will be zero.
16723 2. We have some glyphs that don't contribute to the line height.
16724 (The glyph row flag contributes_to_line_height_p is for future
16725 pixmap extensions).
16727 The first case is easily covered by using default values because in
16728 these cases, the line height does not really matter, except that it
16729 must not be zero. */
16732 compute_line_metrics (struct it
*it
)
16734 struct glyph_row
*row
= it
->glyph_row
;
16736 if (FRAME_WINDOW_P (it
->f
))
16738 int i
, min_y
, max_y
;
16740 /* The line may consist of one space only, that was added to
16741 place the cursor on it. If so, the row's height hasn't been
16743 if (row
->height
== 0)
16745 if (it
->max_ascent
+ it
->max_descent
== 0)
16746 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16747 row
->ascent
= it
->max_ascent
;
16748 row
->height
= it
->max_ascent
+ it
->max_descent
;
16749 row
->phys_ascent
= it
->max_phys_ascent
;
16750 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16751 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16754 /* Compute the width of this line. */
16755 row
->pixel_width
= row
->x
;
16756 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16757 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16759 xassert (row
->pixel_width
>= 0);
16760 xassert (row
->ascent
>= 0 && row
->height
> 0);
16762 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16763 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16765 /* If first line's physical ascent is larger than its logical
16766 ascent, use the physical ascent, and make the row taller.
16767 This makes accented characters fully visible. */
16768 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16769 && row
->phys_ascent
> row
->ascent
)
16771 row
->height
+= row
->phys_ascent
- row
->ascent
;
16772 row
->ascent
= row
->phys_ascent
;
16775 /* Compute how much of the line is visible. */
16776 row
->visible_height
= row
->height
;
16778 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16779 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16781 if (row
->y
< min_y
)
16782 row
->visible_height
-= min_y
- row
->y
;
16783 if (row
->y
+ row
->height
> max_y
)
16784 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16788 row
->pixel_width
= row
->used
[TEXT_AREA
];
16789 if (row
->continued_p
)
16790 row
->pixel_width
-= it
->continuation_pixel_width
;
16791 else if (row
->truncated_on_right_p
)
16792 row
->pixel_width
-= it
->truncation_pixel_width
;
16793 row
->ascent
= row
->phys_ascent
= 0;
16794 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16795 row
->extra_line_spacing
= 0;
16798 /* Compute a hash code for this row. */
16802 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16803 for (i
= 0; i
< row
->used
[area
]; ++i
)
16804 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16805 + row
->glyphs
[area
][i
].u
.val
16806 + row
->glyphs
[area
][i
].face_id
16807 + row
->glyphs
[area
][i
].padding_p
16808 + (row
->glyphs
[area
][i
].type
<< 2));
16811 it
->max_ascent
= it
->max_descent
= 0;
16812 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16816 /* Append one space to the glyph row of iterator IT if doing a
16817 window-based redisplay. The space has the same face as
16818 IT->face_id. Value is non-zero if a space was added.
16820 This function is called to make sure that there is always one glyph
16821 at the end of a glyph row that the cursor can be set on under
16822 window-systems. (If there weren't such a glyph we would not know
16823 how wide and tall a box cursor should be displayed).
16825 At the same time this space let's a nicely handle clearing to the
16826 end of the line if the row ends in italic text. */
16829 append_space_for_newline (struct it
*it
, int default_face_p
)
16831 if (FRAME_WINDOW_P (it
->f
))
16833 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16835 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16836 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16838 /* Save some values that must not be changed.
16839 Must save IT->c and IT->len because otherwise
16840 ITERATOR_AT_END_P wouldn't work anymore after
16841 append_space_for_newline has been called. */
16842 enum display_element_type saved_what
= it
->what
;
16843 int saved_c
= it
->c
, saved_len
= it
->len
;
16844 int saved_char_to_display
= it
->char_to_display
;
16845 int saved_x
= it
->current_x
;
16846 int saved_face_id
= it
->face_id
;
16847 struct text_pos saved_pos
;
16848 Lisp_Object saved_object
;
16851 saved_object
= it
->object
;
16852 saved_pos
= it
->position
;
16854 it
->what
= IT_CHARACTER
;
16855 memset (&it
->position
, 0, sizeof it
->position
);
16856 it
->object
= make_number (0);
16857 it
->c
= it
->char_to_display
= ' ';
16860 if (default_face_p
)
16861 it
->face_id
= DEFAULT_FACE_ID
;
16862 else if (it
->face_before_selective_p
)
16863 it
->face_id
= it
->saved_face_id
;
16864 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16865 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16867 PRODUCE_GLYPHS (it
);
16869 it
->override_ascent
= -1;
16870 it
->constrain_row_ascent_descent_p
= 0;
16871 it
->current_x
= saved_x
;
16872 it
->object
= saved_object
;
16873 it
->position
= saved_pos
;
16874 it
->what
= saved_what
;
16875 it
->face_id
= saved_face_id
;
16876 it
->len
= saved_len
;
16878 it
->char_to_display
= saved_char_to_display
;
16887 /* Extend the face of the last glyph in the text area of IT->glyph_row
16888 to the end of the display line. Called from display_line. If the
16889 glyph row is empty, add a space glyph to it so that we know the
16890 face to draw. Set the glyph row flag fill_line_p. If the glyph
16891 row is R2L, prepend a stretch glyph to cover the empty space to the
16892 left of the leftmost glyph. */
16895 extend_face_to_end_of_line (struct it
*it
)
16898 struct frame
*f
= it
->f
;
16900 /* If line is already filled, do nothing. Non window-system frames
16901 get a grace of one more ``pixel'' because their characters are
16902 1-``pixel'' wide, so they hit the equality too early. This grace
16903 is needed only for R2L rows that are not continued, to produce
16904 one extra blank where we could display the cursor. */
16905 if (it
->current_x
>= it
->last_visible_x
16906 + (!FRAME_WINDOW_P (f
)
16907 && it
->glyph_row
->reversed_p
16908 && !it
->glyph_row
->continued_p
))
16911 /* Face extension extends the background and box of IT->face_id
16912 to the end of the line. If the background equals the background
16913 of the frame, we don't have to do anything. */
16914 if (it
->face_before_selective_p
)
16915 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16917 face
= FACE_FROM_ID (f
, it
->face_id
);
16919 if (FRAME_WINDOW_P (f
)
16920 && it
->glyph_row
->displays_text_p
16921 && face
->box
== FACE_NO_BOX
16922 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16924 && !it
->glyph_row
->reversed_p
)
16927 /* Set the glyph row flag indicating that the face of the last glyph
16928 in the text area has to be drawn to the end of the text area. */
16929 it
->glyph_row
->fill_line_p
= 1;
16931 /* If current character of IT is not ASCII, make sure we have the
16932 ASCII face. This will be automatically undone the next time
16933 get_next_display_element returns a multibyte character. Note
16934 that the character will always be single byte in unibyte
16936 if (!ASCII_CHAR_P (it
->c
))
16938 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16941 if (FRAME_WINDOW_P (f
))
16943 /* If the row is empty, add a space with the current face of IT,
16944 so that we know which face to draw. */
16945 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16947 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16948 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16949 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16951 #ifdef HAVE_WINDOW_SYSTEM
16952 if (it
->glyph_row
->reversed_p
)
16954 /* Prepend a stretch glyph to the row, such that the
16955 rightmost glyph will be drawn flushed all the way to the
16956 right margin of the window. The stretch glyph that will
16957 occupy the empty space, if any, to the left of the
16959 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16960 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16961 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16963 int row_width
, stretch_ascent
, stretch_width
;
16964 struct text_pos saved_pos
;
16965 int saved_face_id
, saved_avoid_cursor
;
16967 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16968 row_width
+= g
->pixel_width
;
16969 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16970 if (stretch_width
> 0)
16973 (((it
->ascent
+ it
->descent
)
16974 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16975 saved_pos
= it
->position
;
16976 memset (&it
->position
, 0, sizeof it
->position
);
16977 saved_avoid_cursor
= it
->avoid_cursor_p
;
16978 it
->avoid_cursor_p
= 1;
16979 saved_face_id
= it
->face_id
;
16980 /* The last row's stretch glyph should get the default
16981 face, to avoid painting the rest of the window with
16982 the region face, if the region ends at ZV. */
16983 if (it
->glyph_row
->ends_at_zv_p
)
16984 it
->face_id
= DEFAULT_FACE_ID
;
16986 it
->face_id
= face
->id
;
16987 append_stretch_glyph (it
, make_number (0), stretch_width
,
16988 it
->ascent
+ it
->descent
, stretch_ascent
);
16989 it
->position
= saved_pos
;
16990 it
->avoid_cursor_p
= saved_avoid_cursor
;
16991 it
->face_id
= saved_face_id
;
16994 #endif /* HAVE_WINDOW_SYSTEM */
16998 /* Save some values that must not be changed. */
16999 int saved_x
= it
->current_x
;
17000 struct text_pos saved_pos
;
17001 Lisp_Object saved_object
;
17002 enum display_element_type saved_what
= it
->what
;
17003 int saved_face_id
= it
->face_id
;
17005 saved_object
= it
->object
;
17006 saved_pos
= it
->position
;
17008 it
->what
= IT_CHARACTER
;
17009 memset (&it
->position
, 0, sizeof it
->position
);
17010 it
->object
= make_number (0);
17011 it
->c
= it
->char_to_display
= ' ';
17013 /* The last row's blank glyphs should get the default face, to
17014 avoid painting the rest of the window with the region face,
17015 if the region ends at ZV. */
17016 if (it
->glyph_row
->ends_at_zv_p
)
17017 it
->face_id
= DEFAULT_FACE_ID
;
17019 it
->face_id
= face
->id
;
17021 PRODUCE_GLYPHS (it
);
17023 while (it
->current_x
<= it
->last_visible_x
)
17024 PRODUCE_GLYPHS (it
);
17026 /* Don't count these blanks really. It would let us insert a left
17027 truncation glyph below and make us set the cursor on them, maybe. */
17028 it
->current_x
= saved_x
;
17029 it
->object
= saved_object
;
17030 it
->position
= saved_pos
;
17031 it
->what
= saved_what
;
17032 it
->face_id
= saved_face_id
;
17037 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17038 trailing whitespace. */
17041 trailing_whitespace_p (EMACS_INT charpos
)
17043 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17046 while (bytepos
< ZV_BYTE
17047 && (c
= FETCH_CHAR (bytepos
),
17048 c
== ' ' || c
== '\t'))
17051 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17053 if (bytepos
!= PT_BYTE
)
17060 /* Highlight trailing whitespace, if any, in ROW. */
17063 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17065 int used
= row
->used
[TEXT_AREA
];
17069 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17070 struct glyph
*glyph
= start
+ used
- 1;
17072 if (row
->reversed_p
)
17074 /* Right-to-left rows need to be processed in the opposite
17075 direction, so swap the edge pointers. */
17077 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17080 /* Skip over glyphs inserted to display the cursor at the
17081 end of a line, for extending the face of the last glyph
17082 to the end of the line on terminals, and for truncation
17083 and continuation glyphs. */
17084 if (!row
->reversed_p
)
17086 while (glyph
>= start
17087 && glyph
->type
== CHAR_GLYPH
17088 && INTEGERP (glyph
->object
))
17093 while (glyph
<= start
17094 && glyph
->type
== CHAR_GLYPH
17095 && INTEGERP (glyph
->object
))
17099 /* If last glyph is a space or stretch, and it's trailing
17100 whitespace, set the face of all trailing whitespace glyphs in
17101 IT->glyph_row to `trailing-whitespace'. */
17102 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17103 && BUFFERP (glyph
->object
)
17104 && (glyph
->type
== STRETCH_GLYPH
17105 || (glyph
->type
== CHAR_GLYPH
17106 && glyph
->u
.ch
== ' '))
17107 && trailing_whitespace_p (glyph
->charpos
))
17109 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17113 if (!row
->reversed_p
)
17115 while (glyph
>= start
17116 && BUFFERP (glyph
->object
)
17117 && (glyph
->type
== STRETCH_GLYPH
17118 || (glyph
->type
== CHAR_GLYPH
17119 && glyph
->u
.ch
== ' ')))
17120 (glyph
--)->face_id
= face_id
;
17124 while (glyph
<= start
17125 && BUFFERP (glyph
->object
)
17126 && (glyph
->type
== STRETCH_GLYPH
17127 || (glyph
->type
== CHAR_GLYPH
17128 && glyph
->u
.ch
== ' ')))
17129 (glyph
++)->face_id
= face_id
;
17136 /* Value is non-zero if glyph row ROW should be
17137 used to hold the cursor. */
17140 cursor_row_p (struct glyph_row
*row
)
17144 if (PT
== CHARPOS (row
->end
.pos
))
17146 /* Suppose the row ends on a string.
17147 Unless the row is continued, that means it ends on a newline
17148 in the string. If it's anything other than a display string
17149 (e.g. a before-string from an overlay), we don't want the
17150 cursor there. (This heuristic seems to give the optimal
17151 behavior for the various types of multi-line strings.) */
17152 if (CHARPOS (row
->end
.string_pos
) >= 0)
17154 if (row
->continued_p
)
17158 /* Check for `display' property. */
17159 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17160 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17161 struct glyph
*glyph
;
17164 for (glyph
= end
; glyph
>= beg
; --glyph
)
17165 if (STRINGP (glyph
->object
))
17168 = Fget_char_property (make_number (PT
),
17172 && display_prop_string_p (prop
, glyph
->object
));
17177 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17179 /* If the row ends in middle of a real character,
17180 and the line is continued, we want the cursor here.
17181 That's because CHARPOS (ROW->end.pos) would equal
17182 PT if PT is before the character. */
17183 if (!row
->ends_in_ellipsis_p
)
17184 result
= row
->continued_p
;
17186 /* If the row ends in an ellipsis, then
17187 CHARPOS (ROW->end.pos) will equal point after the
17188 invisible text. We want that position to be displayed
17189 after the ellipsis. */
17192 /* If the row ends at ZV, display the cursor at the end of that
17193 row instead of at the start of the row below. */
17194 else if (row
->ends_at_zv_p
)
17205 /* Push the display property PROP so that it will be rendered at the
17206 current position in IT. Return 1 if PROP was successfully pushed,
17210 push_display_prop (struct it
*it
, Lisp_Object prop
)
17212 push_it (it
, NULL
);
17214 if (STRINGP (prop
))
17216 if (SCHARS (prop
) == 0)
17223 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17224 it
->current
.overlay_string_index
= -1;
17225 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17226 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17227 it
->method
= GET_FROM_STRING
;
17228 it
->stop_charpos
= 0;
17230 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17232 it
->method
= GET_FROM_STRETCH
;
17235 #ifdef HAVE_WINDOW_SYSTEM
17236 else if (IMAGEP (prop
))
17238 it
->what
= IT_IMAGE
;
17239 it
->image_id
= lookup_image (it
->f
, prop
);
17240 it
->method
= GET_FROM_IMAGE
;
17242 #endif /* HAVE_WINDOW_SYSTEM */
17245 pop_it (it
); /* bogus display property, give up */
17252 /* Return the character-property PROP at the current position in IT. */
17255 get_it_property (struct it
*it
, Lisp_Object prop
)
17257 Lisp_Object position
;
17259 if (STRINGP (it
->object
))
17260 position
= make_number (IT_STRING_CHARPOS (*it
));
17261 else if (BUFFERP (it
->object
))
17262 position
= make_number (IT_CHARPOS (*it
));
17266 return Fget_char_property (position
, prop
, it
->object
);
17269 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17272 handle_line_prefix (struct it
*it
)
17274 Lisp_Object prefix
;
17275 if (it
->continuation_lines_width
> 0)
17277 prefix
= get_it_property (it
, Qwrap_prefix
);
17279 prefix
= Vwrap_prefix
;
17283 prefix
= get_it_property (it
, Qline_prefix
);
17285 prefix
= Vline_prefix
;
17287 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17289 /* If the prefix is wider than the window, and we try to wrap
17290 it, it would acquire its own wrap prefix, and so on till the
17291 iterator stack overflows. So, don't wrap the prefix. */
17292 it
->line_wrap
= TRUNCATE
;
17293 it
->avoid_cursor_p
= 1;
17299 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17300 only for R2L lines from display_line, when it decides that too many
17301 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17304 unproduce_glyphs (struct it
*it
, int n
)
17306 struct glyph
*glyph
, *end
;
17308 xassert (it
->glyph_row
);
17309 xassert (it
->glyph_row
->reversed_p
);
17310 xassert (it
->area
== TEXT_AREA
);
17311 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17313 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17314 n
= it
->glyph_row
->used
[TEXT_AREA
];
17315 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17316 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17317 for ( ; glyph
< end
; glyph
++)
17318 glyph
[-n
] = *glyph
;
17321 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17322 and ROW->maxpos. */
17324 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17325 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17326 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17328 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17329 lines' rows is implemented for bidi-reordered rows. */
17331 /* ROW->minpos is the value of min_pos, the minimal buffer position
17334 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17336 /* We didn't find _any_ valid buffer positions in any of the
17337 glyphs, so we must trust the iterator's computed positions. */
17338 row
->minpos
= row
->start
.pos
;
17341 max_pos
= CHARPOS (it
->current
.pos
);
17342 max_bpos
= BYTEPOS (it
->current
.pos
);
17345 /* Here are the various use-cases for ending the row, and the
17346 corresponding values for ROW->maxpos:
17348 Line ends in a newline from buffer eol_pos + 1
17349 Line is continued from buffer max_pos + 1
17350 Line is truncated on right it->current.pos
17351 Line ends in a newline from string max_pos
17352 Line is continued from string max_pos
17353 Line is continued from display vector max_pos
17354 Line is entirely from a string min_pos == max_pos
17355 Line is entirely from a display vector min_pos == max_pos
17356 Line that ends at ZV ZV
17358 If you discover other use-cases, please add them here as
17360 if (row
->ends_at_zv_p
)
17361 row
->maxpos
= it
->current
.pos
;
17362 else if (row
->used
[TEXT_AREA
])
17364 if (row
->ends_in_newline_from_string_p
)
17365 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17366 else if (CHARPOS (it
->eol_pos
) > 0)
17367 SET_TEXT_POS (row
->maxpos
,
17368 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17369 else if (row
->continued_p
)
17371 /* If max_pos is different from IT's current position, it
17372 means IT->method does not belong to the display element
17373 at max_pos. However, it also means that the display
17374 element at max_pos was displayed in its entirety on this
17375 line, which is equivalent to saying that the next line
17376 starts at the next buffer position. */
17377 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17378 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17381 INC_BOTH (max_pos
, max_bpos
);
17382 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17385 else if (row
->truncated_on_right_p
)
17386 /* display_line already called reseat_at_next_visible_line_start,
17387 which puts the iterator at the beginning of the next line, in
17388 the logical order. */
17389 row
->maxpos
= it
->current
.pos
;
17390 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17391 /* A line that is entirely from a string/image/stretch... */
17392 row
->maxpos
= row
->minpos
;
17397 row
->maxpos
= it
->current
.pos
;
17400 /* Construct the glyph row IT->glyph_row in the desired matrix of
17401 IT->w from text at the current position of IT. See dispextern.h
17402 for an overview of struct it. Value is non-zero if
17403 IT->glyph_row displays text, as opposed to a line displaying ZV
17407 display_line (struct it
*it
)
17409 struct glyph_row
*row
= it
->glyph_row
;
17410 Lisp_Object overlay_arrow_string
;
17412 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17413 int wrap_row_used
= -1;
17414 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17415 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17416 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17417 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17418 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17420 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17421 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17423 /* We always start displaying at hpos zero even if hscrolled. */
17424 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17426 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17427 >= it
->w
->desired_matrix
->nrows
)
17429 it
->w
->nrows_scale_factor
++;
17430 fonts_changed_p
= 1;
17434 /* Is IT->w showing the region? */
17435 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17437 /* Clear the result glyph row and enable it. */
17438 prepare_desired_row (row
);
17440 row
->y
= it
->current_y
;
17441 row
->start
= it
->start
;
17442 row
->continuation_lines_width
= it
->continuation_lines_width
;
17443 row
->displays_text_p
= 1;
17444 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17445 it
->starts_in_middle_of_char_p
= 0;
17447 /* Arrange the overlays nicely for our purposes. Usually, we call
17448 display_line on only one line at a time, in which case this
17449 can't really hurt too much, or we call it on lines which appear
17450 one after another in the buffer, in which case all calls to
17451 recenter_overlay_lists but the first will be pretty cheap. */
17452 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17454 /* Move over display elements that are not visible because we are
17455 hscrolled. This may stop at an x-position < IT->first_visible_x
17456 if the first glyph is partially visible or if we hit a line end. */
17457 if (it
->current_x
< it
->first_visible_x
)
17459 this_line_min_pos
= row
->start
.pos
;
17460 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17461 MOVE_TO_POS
| MOVE_TO_X
);
17462 /* Record the smallest positions seen while we moved over
17463 display elements that are not visible. This is needed by
17464 redisplay_internal for optimizing the case where the cursor
17465 stays inside the same line. The rest of this function only
17466 considers positions that are actually displayed, so
17467 RECORD_MAX_MIN_POS will not otherwise record positions that
17468 are hscrolled to the left of the left edge of the window. */
17469 min_pos
= CHARPOS (this_line_min_pos
);
17470 min_bpos
= BYTEPOS (this_line_min_pos
);
17474 /* We only do this when not calling `move_it_in_display_line_to'
17475 above, because move_it_in_display_line_to calls
17476 handle_line_prefix itself. */
17477 handle_line_prefix (it
);
17480 /* Get the initial row height. This is either the height of the
17481 text hscrolled, if there is any, or zero. */
17482 row
->ascent
= it
->max_ascent
;
17483 row
->height
= it
->max_ascent
+ it
->max_descent
;
17484 row
->phys_ascent
= it
->max_phys_ascent
;
17485 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17486 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17488 /* Utility macro to record max and min buffer positions seen until now. */
17489 #define RECORD_MAX_MIN_POS(IT) \
17492 if (IT_CHARPOS (*(IT)) < min_pos) \
17494 min_pos = IT_CHARPOS (*(IT)); \
17495 min_bpos = IT_BYTEPOS (*(IT)); \
17497 if (IT_CHARPOS (*(IT)) > max_pos) \
17499 max_pos = IT_CHARPOS (*(IT)); \
17500 max_bpos = IT_BYTEPOS (*(IT)); \
17505 /* Loop generating characters. The loop is left with IT on the next
17506 character to display. */
17509 int n_glyphs_before
, hpos_before
, x_before
;
17511 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17513 /* Retrieve the next thing to display. Value is zero if end of
17515 if (!get_next_display_element (it
))
17517 /* Maybe add a space at the end of this line that is used to
17518 display the cursor there under X. Set the charpos of the
17519 first glyph of blank lines not corresponding to any text
17521 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17522 row
->exact_window_width_line_p
= 1;
17523 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17524 || row
->used
[TEXT_AREA
] == 0)
17526 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17527 row
->displays_text_p
= 0;
17529 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17530 && (!MINI_WINDOW_P (it
->w
)
17531 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17532 row
->indicate_empty_line_p
= 1;
17535 it
->continuation_lines_width
= 0;
17536 row
->ends_at_zv_p
= 1;
17537 /* A row that displays right-to-left text must always have
17538 its last face extended all the way to the end of line,
17539 even if this row ends in ZV, because we still write to
17540 the screen left to right. */
17541 if (row
->reversed_p
)
17542 extend_face_to_end_of_line (it
);
17546 /* Now, get the metrics of what we want to display. This also
17547 generates glyphs in `row' (which is IT->glyph_row). */
17548 n_glyphs_before
= row
->used
[TEXT_AREA
];
17551 /* Remember the line height so far in case the next element doesn't
17552 fit on the line. */
17553 if (it
->line_wrap
!= TRUNCATE
)
17555 ascent
= it
->max_ascent
;
17556 descent
= it
->max_descent
;
17557 phys_ascent
= it
->max_phys_ascent
;
17558 phys_descent
= it
->max_phys_descent
;
17560 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17562 if (IT_DISPLAYING_WHITESPACE (it
))
17568 wrap_row_used
= row
->used
[TEXT_AREA
];
17569 wrap_row_ascent
= row
->ascent
;
17570 wrap_row_height
= row
->height
;
17571 wrap_row_phys_ascent
= row
->phys_ascent
;
17572 wrap_row_phys_height
= row
->phys_height
;
17573 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17574 wrap_row_min_pos
= min_pos
;
17575 wrap_row_min_bpos
= min_bpos
;
17576 wrap_row_max_pos
= max_pos
;
17577 wrap_row_max_bpos
= max_bpos
;
17583 PRODUCE_GLYPHS (it
);
17585 /* If this display element was in marginal areas, continue with
17587 if (it
->area
!= TEXT_AREA
)
17589 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17590 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17591 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17592 row
->phys_height
= max (row
->phys_height
,
17593 it
->max_phys_ascent
+ it
->max_phys_descent
);
17594 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17595 it
->max_extra_line_spacing
);
17596 set_iterator_to_next (it
, 1);
17600 /* Does the display element fit on the line? If we truncate
17601 lines, we should draw past the right edge of the window. If
17602 we don't truncate, we want to stop so that we can display the
17603 continuation glyph before the right margin. If lines are
17604 continued, there are two possible strategies for characters
17605 resulting in more than 1 glyph (e.g. tabs): Display as many
17606 glyphs as possible in this line and leave the rest for the
17607 continuation line, or display the whole element in the next
17608 line. Original redisplay did the former, so we do it also. */
17609 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17610 hpos_before
= it
->hpos
;
17613 if (/* Not a newline. */
17615 /* Glyphs produced fit entirely in the line. */
17616 && it
->current_x
< it
->last_visible_x
)
17618 it
->hpos
+= nglyphs
;
17619 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17620 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17621 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17622 row
->phys_height
= max (row
->phys_height
,
17623 it
->max_phys_ascent
+ it
->max_phys_descent
);
17624 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17625 it
->max_extra_line_spacing
);
17626 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17627 row
->x
= x
- it
->first_visible_x
;
17628 /* Record the maximum and minimum buffer positions seen so
17629 far in glyphs that will be displayed by this row. */
17631 RECORD_MAX_MIN_POS (it
);
17636 struct glyph
*glyph
;
17638 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17640 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17641 new_x
= x
+ glyph
->pixel_width
;
17643 if (/* Lines are continued. */
17644 it
->line_wrap
!= TRUNCATE
17645 && (/* Glyph doesn't fit on the line. */
17646 new_x
> it
->last_visible_x
17647 /* Or it fits exactly on a window system frame. */
17648 || (new_x
== it
->last_visible_x
17649 && FRAME_WINDOW_P (it
->f
))))
17651 /* End of a continued line. */
17654 || (new_x
== it
->last_visible_x
17655 && FRAME_WINDOW_P (it
->f
)))
17657 /* Current glyph is the only one on the line or
17658 fits exactly on the line. We must continue
17659 the line because we can't draw the cursor
17660 after the glyph. */
17661 row
->continued_p
= 1;
17662 it
->current_x
= new_x
;
17663 it
->continuation_lines_width
+= new_x
;
17665 /* Record the maximum and minimum buffer
17666 positions seen so far in glyphs that will be
17667 displayed by this row. */
17669 RECORD_MAX_MIN_POS (it
);
17670 if (i
== nglyphs
- 1)
17672 /* If line-wrap is on, check if a previous
17673 wrap point was found. */
17674 if (wrap_row_used
> 0
17675 /* Even if there is a previous wrap
17676 point, continue the line here as
17677 usual, if (i) the previous character
17678 was a space or tab AND (ii) the
17679 current character is not. */
17681 || IT_DISPLAYING_WHITESPACE (it
)))
17684 set_iterator_to_next (it
, 1);
17685 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17687 if (!get_next_display_element (it
))
17689 row
->exact_window_width_line_p
= 1;
17690 it
->continuation_lines_width
= 0;
17691 row
->continued_p
= 0;
17692 row
->ends_at_zv_p
= 1;
17694 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17696 row
->continued_p
= 0;
17697 row
->exact_window_width_line_p
= 1;
17702 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17703 && !FRAME_WINDOW_P (it
->f
))
17705 /* A padding glyph that doesn't fit on this line.
17706 This means the whole character doesn't fit
17708 if (row
->reversed_p
)
17709 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17710 - n_glyphs_before
);
17711 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17713 /* Fill the rest of the row with continuation
17714 glyphs like in 20.x. */
17715 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17716 < row
->glyphs
[1 + TEXT_AREA
])
17717 produce_special_glyphs (it
, IT_CONTINUATION
);
17719 row
->continued_p
= 1;
17720 it
->current_x
= x_before
;
17721 it
->continuation_lines_width
+= x_before
;
17723 /* Restore the height to what it was before the
17724 element not fitting on the line. */
17725 it
->max_ascent
= ascent
;
17726 it
->max_descent
= descent
;
17727 it
->max_phys_ascent
= phys_ascent
;
17728 it
->max_phys_descent
= phys_descent
;
17730 else if (wrap_row_used
> 0)
17733 if (row
->reversed_p
)
17734 unproduce_glyphs (it
,
17735 row
->used
[TEXT_AREA
] - wrap_row_used
);
17737 it
->continuation_lines_width
+= wrap_x
;
17738 row
->used
[TEXT_AREA
] = wrap_row_used
;
17739 row
->ascent
= wrap_row_ascent
;
17740 row
->height
= wrap_row_height
;
17741 row
->phys_ascent
= wrap_row_phys_ascent
;
17742 row
->phys_height
= wrap_row_phys_height
;
17743 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17744 min_pos
= wrap_row_min_pos
;
17745 min_bpos
= wrap_row_min_bpos
;
17746 max_pos
= wrap_row_max_pos
;
17747 max_bpos
= wrap_row_max_bpos
;
17748 row
->continued_p
= 1;
17749 row
->ends_at_zv_p
= 0;
17750 row
->exact_window_width_line_p
= 0;
17751 it
->continuation_lines_width
+= x
;
17753 /* Make sure that a non-default face is extended
17754 up to the right margin of the window. */
17755 extend_face_to_end_of_line (it
);
17757 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17759 /* A TAB that extends past the right edge of the
17760 window. This produces a single glyph on
17761 window system frames. We leave the glyph in
17762 this row and let it fill the row, but don't
17763 consume the TAB. */
17764 it
->continuation_lines_width
+= it
->last_visible_x
;
17765 row
->ends_in_middle_of_char_p
= 1;
17766 row
->continued_p
= 1;
17767 glyph
->pixel_width
= it
->last_visible_x
- x
;
17768 it
->starts_in_middle_of_char_p
= 1;
17772 /* Something other than a TAB that draws past
17773 the right edge of the window. Restore
17774 positions to values before the element. */
17775 if (row
->reversed_p
)
17776 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17777 - (n_glyphs_before
+ i
));
17778 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17780 /* Display continuation glyphs. */
17781 if (!FRAME_WINDOW_P (it
->f
))
17782 produce_special_glyphs (it
, IT_CONTINUATION
);
17783 row
->continued_p
= 1;
17785 it
->current_x
= x_before
;
17786 it
->continuation_lines_width
+= x
;
17787 extend_face_to_end_of_line (it
);
17789 if (nglyphs
> 1 && i
> 0)
17791 row
->ends_in_middle_of_char_p
= 1;
17792 it
->starts_in_middle_of_char_p
= 1;
17795 /* Restore the height to what it was before the
17796 element not fitting on the line. */
17797 it
->max_ascent
= ascent
;
17798 it
->max_descent
= descent
;
17799 it
->max_phys_ascent
= phys_ascent
;
17800 it
->max_phys_descent
= phys_descent
;
17805 else if (new_x
> it
->first_visible_x
)
17807 /* Increment number of glyphs actually displayed. */
17810 /* Record the maximum and minimum buffer positions
17811 seen so far in glyphs that will be displayed by
17814 RECORD_MAX_MIN_POS (it
);
17816 if (x
< it
->first_visible_x
)
17817 /* Glyph is partially visible, i.e. row starts at
17818 negative X position. */
17819 row
->x
= x
- it
->first_visible_x
;
17823 /* Glyph is completely off the left margin of the
17824 window. This should not happen because of the
17825 move_it_in_display_line at the start of this
17826 function, unless the text display area of the
17827 window is empty. */
17828 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17832 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17833 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17834 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17835 row
->phys_height
= max (row
->phys_height
,
17836 it
->max_phys_ascent
+ it
->max_phys_descent
);
17837 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17838 it
->max_extra_line_spacing
);
17840 /* End of this display line if row is continued. */
17841 if (row
->continued_p
|| row
->ends_at_zv_p
)
17846 /* Is this a line end? If yes, we're also done, after making
17847 sure that a non-default face is extended up to the right
17848 margin of the window. */
17849 if (ITERATOR_AT_END_OF_LINE_P (it
))
17851 int used_before
= row
->used
[TEXT_AREA
];
17853 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17855 /* Add a space at the end of the line that is used to
17856 display the cursor there. */
17857 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17858 append_space_for_newline (it
, 0);
17860 /* Extend the face to the end of the line. */
17861 extend_face_to_end_of_line (it
);
17863 /* Make sure we have the position. */
17864 if (used_before
== 0)
17865 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17867 /* Record the position of the newline, for use in
17869 it
->eol_pos
= it
->current
.pos
;
17871 /* Consume the line end. This skips over invisible lines. */
17872 set_iterator_to_next (it
, 1);
17873 it
->continuation_lines_width
= 0;
17877 /* Proceed with next display element. Note that this skips
17878 over lines invisible because of selective display. */
17879 set_iterator_to_next (it
, 1);
17881 /* If we truncate lines, we are done when the last displayed
17882 glyphs reach past the right margin of the window. */
17883 if (it
->line_wrap
== TRUNCATE
17884 && (FRAME_WINDOW_P (it
->f
)
17885 ? (it
->current_x
>= it
->last_visible_x
)
17886 : (it
->current_x
> it
->last_visible_x
)))
17888 /* Maybe add truncation glyphs. */
17889 if (!FRAME_WINDOW_P (it
->f
))
17893 if (!row
->reversed_p
)
17895 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17896 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17901 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17902 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17904 /* Remove any padding glyphs at the front of ROW, to
17905 make room for the truncation glyphs we will be
17906 adding below. The loop below always inserts at
17907 least one truncation glyph, so also remove the
17908 last glyph added to ROW. */
17909 unproduce_glyphs (it
, i
+ 1);
17910 /* Adjust i for the loop below. */
17911 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17914 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17916 row
->used
[TEXT_AREA
] = i
;
17917 produce_special_glyphs (it
, IT_TRUNCATION
);
17920 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17922 /* Don't truncate if we can overflow newline into fringe. */
17923 if (!get_next_display_element (it
))
17925 it
->continuation_lines_width
= 0;
17926 row
->ends_at_zv_p
= 1;
17927 row
->exact_window_width_line_p
= 1;
17930 if (ITERATOR_AT_END_OF_LINE_P (it
))
17932 row
->exact_window_width_line_p
= 1;
17933 goto at_end_of_line
;
17937 row
->truncated_on_right_p
= 1;
17938 it
->continuation_lines_width
= 0;
17939 reseat_at_next_visible_line_start (it
, 0);
17940 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17941 it
->hpos
= hpos_before
;
17942 it
->current_x
= x_before
;
17947 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17948 at the left window margin. */
17949 if (it
->first_visible_x
17950 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17952 if (!FRAME_WINDOW_P (it
->f
))
17953 insert_left_trunc_glyphs (it
);
17954 row
->truncated_on_left_p
= 1;
17957 /* Remember the position at which this line ends.
17959 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17960 cannot be before the call to find_row_edges below, since that is
17961 where these positions are determined. */
17962 row
->end
= it
->current
;
17965 row
->minpos
= row
->start
.pos
;
17966 row
->maxpos
= row
->end
.pos
;
17970 /* ROW->minpos and ROW->maxpos must be the smallest and
17971 `1 + the largest' buffer positions in ROW. But if ROW was
17972 bidi-reordered, these two positions can be anywhere in the
17973 row, so we must determine them now. */
17974 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17977 /* If the start of this line is the overlay arrow-position, then
17978 mark this glyph row as the one containing the overlay arrow.
17979 This is clearly a mess with variable size fonts. It would be
17980 better to let it be displayed like cursors under X. */
17981 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17982 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17983 !NILP (overlay_arrow_string
)))
17985 /* Overlay arrow in window redisplay is a fringe bitmap. */
17986 if (STRINGP (overlay_arrow_string
))
17988 struct glyph_row
*arrow_row
17989 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17990 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17991 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17992 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17993 struct glyph
*p2
, *end
;
17995 /* Copy the arrow glyphs. */
17996 while (glyph
< arrow_end
)
17999 /* Throw away padding glyphs. */
18001 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18002 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18008 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18013 xassert (INTEGERP (overlay_arrow_string
));
18014 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18016 overlay_arrow_seen
= 1;
18019 /* Compute pixel dimensions of this line. */
18020 compute_line_metrics (it
);
18022 /* Record whether this row ends inside an ellipsis. */
18023 row
->ends_in_ellipsis_p
18024 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18025 && it
->ellipsis_p
);
18027 /* Save fringe bitmaps in this row. */
18028 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18029 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18030 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18031 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18033 it
->left_user_fringe_bitmap
= 0;
18034 it
->left_user_fringe_face_id
= 0;
18035 it
->right_user_fringe_bitmap
= 0;
18036 it
->right_user_fringe_face_id
= 0;
18038 /* Maybe set the cursor. */
18039 cvpos
= it
->w
->cursor
.vpos
;
18041 /* In bidi-reordered rows, keep checking for proper cursor
18042 position even if one has been found already, because buffer
18043 positions in such rows change non-linearly with ROW->VPOS,
18044 when a line is continued. One exception: when we are at ZV,
18045 display cursor on the first suitable glyph row, since all
18046 the empty rows after that also have their position set to ZV. */
18047 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18048 lines' rows is implemented for bidi-reordered rows. */
18050 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18051 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18052 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18053 && cursor_row_p (row
))
18054 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18056 /* Highlight trailing whitespace. */
18057 if (!NILP (Vshow_trailing_whitespace
))
18058 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18060 /* Prepare for the next line. This line starts horizontally at (X
18061 HPOS) = (0 0). Vertical positions are incremented. As a
18062 convenience for the caller, IT->glyph_row is set to the next
18064 it
->current_x
= it
->hpos
= 0;
18065 it
->current_y
+= row
->height
;
18066 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18069 /* The next row should by default use the same value of the
18070 reversed_p flag as this one. set_iterator_to_next decides when
18071 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18072 the flag accordingly. */
18073 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18074 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18075 it
->start
= row
->end
;
18076 return row
->displays_text_p
;
18078 #undef RECORD_MAX_MIN_POS
18081 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18082 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18083 doc
: /* Return paragraph direction at point in BUFFER.
18084 Value is either `left-to-right' or `right-to-left'.
18085 If BUFFER is omitted or nil, it defaults to the current buffer.
18087 Paragraph direction determines how the text in the paragraph is displayed.
18088 In left-to-right paragraphs, text begins at the left margin of the window
18089 and the reading direction is generally left to right. In right-to-left
18090 paragraphs, text begins at the right margin and is read from right to left.
18092 See also `bidi-paragraph-direction'. */)
18093 (Lisp_Object buffer
)
18095 struct buffer
*buf
= current_buffer
;
18096 struct buffer
*old
= buf
;
18098 if (! NILP (buffer
))
18100 CHECK_BUFFER (buffer
);
18101 buf
= XBUFFER (buffer
);
18104 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18105 return Qleft_to_right
;
18106 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18107 return BVAR (buf
, bidi_paragraph_direction
);
18110 /* Determine the direction from buffer text. We could try to
18111 use current_matrix if it is up to date, but this seems fast
18112 enough as it is. */
18113 struct bidi_it itb
;
18114 EMACS_INT pos
= BUF_PT (buf
);
18115 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18118 set_buffer_temp (buf
);
18119 /* bidi_paragraph_init finds the base direction of the paragraph
18120 by searching forward from paragraph start. We need the base
18121 direction of the current or _previous_ paragraph, so we need
18122 to make sure we are within that paragraph. To that end, find
18123 the previous non-empty line. */
18124 if (pos
>= ZV
&& pos
> BEGV
)
18127 bytepos
= CHAR_TO_BYTE (pos
);
18129 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18130 || c
== ' ' || c
== '\t' || c
== '\f')
18132 if (bytepos
<= BEGV_BYTE
)
18137 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18140 itb
.bytepos
= bytepos
;
18142 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18144 itb
.separator_limit
= -1;
18145 itb
.paragraph_dir
= NEUTRAL_DIR
;
18147 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18148 set_buffer_temp (old
);
18149 switch (itb
.paragraph_dir
)
18152 return Qleft_to_right
;
18155 return Qright_to_left
;
18165 /***********************************************************************
18167 ***********************************************************************/
18169 /* Redisplay the menu bar in the frame for window W.
18171 The menu bar of X frames that don't have X toolkit support is
18172 displayed in a special window W->frame->menu_bar_window.
18174 The menu bar of terminal frames is treated specially as far as
18175 glyph matrices are concerned. Menu bar lines are not part of
18176 windows, so the update is done directly on the frame matrix rows
18177 for the menu bar. */
18180 display_menu_bar (struct window
*w
)
18182 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18187 /* Don't do all this for graphical frames. */
18189 if (FRAME_W32_P (f
))
18192 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18198 if (FRAME_NS_P (f
))
18200 #endif /* HAVE_NS */
18202 #ifdef USE_X_TOOLKIT
18203 xassert (!FRAME_WINDOW_P (f
));
18204 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18205 it
.first_visible_x
= 0;
18206 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18207 #else /* not USE_X_TOOLKIT */
18208 if (FRAME_WINDOW_P (f
))
18210 /* Menu bar lines are displayed in the desired matrix of the
18211 dummy window menu_bar_window. */
18212 struct window
*menu_w
;
18213 xassert (WINDOWP (f
->menu_bar_window
));
18214 menu_w
= XWINDOW (f
->menu_bar_window
);
18215 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18217 it
.first_visible_x
= 0;
18218 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18222 /* This is a TTY frame, i.e. character hpos/vpos are used as
18224 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18226 it
.first_visible_x
= 0;
18227 it
.last_visible_x
= FRAME_COLS (f
);
18229 #endif /* not USE_X_TOOLKIT */
18231 if (! mode_line_inverse_video
)
18232 /* Force the menu-bar to be displayed in the default face. */
18233 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18235 /* Clear all rows of the menu bar. */
18236 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18238 struct glyph_row
*row
= it
.glyph_row
+ i
;
18239 clear_glyph_row (row
);
18240 row
->enabled_p
= 1;
18241 row
->full_width_p
= 1;
18244 /* Display all items of the menu bar. */
18245 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18246 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18248 Lisp_Object string
;
18250 /* Stop at nil string. */
18251 string
= AREF (items
, i
+ 1);
18255 /* Remember where item was displayed. */
18256 ASET (items
, i
+ 3, make_number (it
.hpos
));
18258 /* Display the item, pad with one space. */
18259 if (it
.current_x
< it
.last_visible_x
)
18260 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18261 SCHARS (string
) + 1, 0, 0, -1);
18264 /* Fill out the line with spaces. */
18265 if (it
.current_x
< it
.last_visible_x
)
18266 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18268 /* Compute the total height of the lines. */
18269 compute_line_metrics (&it
);
18274 /***********************************************************************
18276 ***********************************************************************/
18278 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18279 FORCE is non-zero, redisplay mode lines unconditionally.
18280 Otherwise, redisplay only mode lines that are garbaged. Value is
18281 the number of windows whose mode lines were redisplayed. */
18284 redisplay_mode_lines (Lisp_Object window
, int force
)
18288 while (!NILP (window
))
18290 struct window
*w
= XWINDOW (window
);
18292 if (WINDOWP (w
->hchild
))
18293 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18294 else if (WINDOWP (w
->vchild
))
18295 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18297 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18298 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18300 struct text_pos lpoint
;
18301 struct buffer
*old
= current_buffer
;
18303 /* Set the window's buffer for the mode line display. */
18304 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18305 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18307 /* Point refers normally to the selected window. For any
18308 other window, set up appropriate value. */
18309 if (!EQ (window
, selected_window
))
18311 struct text_pos pt
;
18313 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18314 if (CHARPOS (pt
) < BEGV
)
18315 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18316 else if (CHARPOS (pt
) > (ZV
- 1))
18317 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18319 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18322 /* Display mode lines. */
18323 clear_glyph_matrix (w
->desired_matrix
);
18324 if (display_mode_lines (w
))
18327 w
->must_be_updated_p
= 1;
18330 /* Restore old settings. */
18331 set_buffer_internal_1 (old
);
18332 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18342 /* Display the mode and/or header line of window W. Value is the
18343 sum number of mode lines and header lines displayed. */
18346 display_mode_lines (struct window
*w
)
18348 Lisp_Object old_selected_window
, old_selected_frame
;
18351 old_selected_frame
= selected_frame
;
18352 selected_frame
= w
->frame
;
18353 old_selected_window
= selected_window
;
18354 XSETWINDOW (selected_window
, w
);
18356 /* These will be set while the mode line specs are processed. */
18357 line_number_displayed
= 0;
18358 w
->column_number_displayed
= Qnil
;
18360 if (WINDOW_WANTS_MODELINE_P (w
))
18362 struct window
*sel_w
= XWINDOW (old_selected_window
);
18364 /* Select mode line face based on the real selected window. */
18365 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18366 BVAR (current_buffer
, mode_line_format
));
18370 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18372 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18373 BVAR (current_buffer
, header_line_format
));
18377 selected_frame
= old_selected_frame
;
18378 selected_window
= old_selected_window
;
18383 /* Display mode or header line of window W. FACE_ID specifies which
18384 line to display; it is either MODE_LINE_FACE_ID or
18385 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18386 display. Value is the pixel height of the mode/header line
18390 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18394 int count
= SPECPDL_INDEX ();
18396 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18397 /* Don't extend on a previously drawn mode-line.
18398 This may happen if called from pos_visible_p. */
18399 it
.glyph_row
->enabled_p
= 0;
18400 prepare_desired_row (it
.glyph_row
);
18402 it
.glyph_row
->mode_line_p
= 1;
18404 if (! mode_line_inverse_video
)
18405 /* Force the mode-line to be displayed in the default face. */
18406 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18408 record_unwind_protect (unwind_format_mode_line
,
18409 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18411 mode_line_target
= MODE_LINE_DISPLAY
;
18413 /* Temporarily make frame's keyboard the current kboard so that
18414 kboard-local variables in the mode_line_format will get the right
18416 push_kboard (FRAME_KBOARD (it
.f
));
18417 record_unwind_save_match_data ();
18418 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18421 unbind_to (count
, Qnil
);
18423 /* Fill up with spaces. */
18424 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18426 compute_line_metrics (&it
);
18427 it
.glyph_row
->full_width_p
= 1;
18428 it
.glyph_row
->continued_p
= 0;
18429 it
.glyph_row
->truncated_on_left_p
= 0;
18430 it
.glyph_row
->truncated_on_right_p
= 0;
18432 /* Make a 3D mode-line have a shadow at its right end. */
18433 face
= FACE_FROM_ID (it
.f
, face_id
);
18434 extend_face_to_end_of_line (&it
);
18435 if (face
->box
!= FACE_NO_BOX
)
18437 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18438 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18439 last
->right_box_line_p
= 1;
18442 return it
.glyph_row
->height
;
18445 /* Move element ELT in LIST to the front of LIST.
18446 Return the updated list. */
18449 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18451 register Lisp_Object tail
, prev
;
18452 register Lisp_Object tem
;
18456 while (CONSP (tail
))
18462 /* Splice out the link TAIL. */
18464 list
= XCDR (tail
);
18466 Fsetcdr (prev
, XCDR (tail
));
18468 /* Now make it the first. */
18469 Fsetcdr (tail
, list
);
18474 tail
= XCDR (tail
);
18478 /* Not found--return unchanged LIST. */
18482 /* Contribute ELT to the mode line for window IT->w. How it
18483 translates into text depends on its data type.
18485 IT describes the display environment in which we display, as usual.
18487 DEPTH is the depth in recursion. It is used to prevent
18488 infinite recursion here.
18490 FIELD_WIDTH is the number of characters the display of ELT should
18491 occupy in the mode line, and PRECISION is the maximum number of
18492 characters to display from ELT's representation. See
18493 display_string for details.
18495 Returns the hpos of the end of the text generated by ELT.
18497 PROPS is a property list to add to any string we encounter.
18499 If RISKY is nonzero, remove (disregard) any properties in any string
18500 we encounter, and ignore :eval and :propertize.
18502 The global variable `mode_line_target' determines whether the
18503 output is passed to `store_mode_line_noprop',
18504 `store_mode_line_string', or `display_string'. */
18507 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18508 Lisp_Object elt
, Lisp_Object props
, int risky
)
18510 int n
= 0, field
, prec
;
18515 elt
= build_string ("*too-deep*");
18519 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18523 /* A string: output it and check for %-constructs within it. */
18525 EMACS_INT offset
= 0;
18527 if (SCHARS (elt
) > 0
18528 && (!NILP (props
) || risky
))
18530 Lisp_Object oprops
, aelt
;
18531 oprops
= Ftext_properties_at (make_number (0), elt
);
18533 /* If the starting string's properties are not what
18534 we want, translate the string. Also, if the string
18535 is risky, do that anyway. */
18537 if (NILP (Fequal (props
, oprops
)) || risky
)
18539 /* If the starting string has properties,
18540 merge the specified ones onto the existing ones. */
18541 if (! NILP (oprops
) && !risky
)
18545 oprops
= Fcopy_sequence (oprops
);
18547 while (CONSP (tem
))
18549 oprops
= Fplist_put (oprops
, XCAR (tem
),
18550 XCAR (XCDR (tem
)));
18551 tem
= XCDR (XCDR (tem
));
18556 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18557 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18559 /* AELT is what we want. Move it to the front
18560 without consing. */
18562 mode_line_proptrans_alist
18563 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18569 /* If AELT has the wrong props, it is useless.
18570 so get rid of it. */
18572 mode_line_proptrans_alist
18573 = Fdelq (aelt
, mode_line_proptrans_alist
);
18575 elt
= Fcopy_sequence (elt
);
18576 Fset_text_properties (make_number (0), Flength (elt
),
18578 /* Add this item to mode_line_proptrans_alist. */
18579 mode_line_proptrans_alist
18580 = Fcons (Fcons (elt
, props
),
18581 mode_line_proptrans_alist
);
18582 /* Truncate mode_line_proptrans_alist
18583 to at most 50 elements. */
18584 tem
= Fnthcdr (make_number (50),
18585 mode_line_proptrans_alist
);
18587 XSETCDR (tem
, Qnil
);
18596 prec
= precision
- n
;
18597 switch (mode_line_target
)
18599 case MODE_LINE_NOPROP
:
18600 case MODE_LINE_TITLE
:
18601 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18603 case MODE_LINE_STRING
:
18604 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18606 case MODE_LINE_DISPLAY
:
18607 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18608 0, prec
, 0, STRING_MULTIBYTE (elt
));
18615 /* Handle the non-literal case. */
18617 while ((precision
<= 0 || n
< precision
)
18618 && SREF (elt
, offset
) != 0
18619 && (mode_line_target
!= MODE_LINE_DISPLAY
18620 || it
->current_x
< it
->last_visible_x
))
18622 EMACS_INT last_offset
= offset
;
18624 /* Advance to end of string or next format specifier. */
18625 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18628 if (offset
- 1 != last_offset
)
18630 EMACS_INT nchars
, nbytes
;
18632 /* Output to end of string or up to '%'. Field width
18633 is length of string. Don't output more than
18634 PRECISION allows us. */
18637 prec
= c_string_width (SDATA (elt
) + last_offset
,
18638 offset
- last_offset
, precision
- n
,
18641 switch (mode_line_target
)
18643 case MODE_LINE_NOPROP
:
18644 case MODE_LINE_TITLE
:
18645 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18647 case MODE_LINE_STRING
:
18649 EMACS_INT bytepos
= last_offset
;
18650 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18651 EMACS_INT endpos
= (precision
<= 0
18652 ? string_byte_to_char (elt
, offset
)
18653 : charpos
+ nchars
);
18655 n
+= store_mode_line_string (NULL
,
18656 Fsubstring (elt
, make_number (charpos
),
18657 make_number (endpos
)),
18661 case MODE_LINE_DISPLAY
:
18663 EMACS_INT bytepos
= last_offset
;
18664 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18666 if (precision
<= 0)
18667 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18668 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18670 STRING_MULTIBYTE (elt
));
18675 else /* c == '%' */
18677 EMACS_INT percent_position
= offset
;
18679 /* Get the specified minimum width. Zero means
18682 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18683 field
= field
* 10 + c
- '0';
18685 /* Don't pad beyond the total padding allowed. */
18686 if (field_width
- n
> 0 && field
> field_width
- n
)
18687 field
= field_width
- n
;
18689 /* Note that either PRECISION <= 0 or N < PRECISION. */
18690 prec
= precision
- n
;
18693 n
+= display_mode_element (it
, depth
, field
, prec
,
18694 Vglobal_mode_string
, props
,
18699 EMACS_INT bytepos
, charpos
;
18701 Lisp_Object string
;
18703 bytepos
= percent_position
;
18704 charpos
= (STRING_MULTIBYTE (elt
)
18705 ? string_byte_to_char (elt
, bytepos
)
18707 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18708 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18710 switch (mode_line_target
)
18712 case MODE_LINE_NOPROP
:
18713 case MODE_LINE_TITLE
:
18714 n
+= store_mode_line_noprop (spec
, field
, prec
);
18716 case MODE_LINE_STRING
:
18718 int len
= strlen (spec
);
18719 Lisp_Object tem
= make_string (spec
, len
);
18720 props
= Ftext_properties_at (make_number (charpos
), elt
);
18721 /* Should only keep face property in props */
18722 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18725 case MODE_LINE_DISPLAY
:
18727 int nglyphs_before
, nwritten
;
18729 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18730 nwritten
= display_string (spec
, string
, elt
,
18735 /* Assign to the glyphs written above the
18736 string where the `%x' came from, position
18740 struct glyph
*glyph
18741 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18745 for (i
= 0; i
< nwritten
; ++i
)
18747 glyph
[i
].object
= elt
;
18748 glyph
[i
].charpos
= charpos
;
18765 /* A symbol: process the value of the symbol recursively
18766 as if it appeared here directly. Avoid error if symbol void.
18767 Special case: if value of symbol is a string, output the string
18770 register Lisp_Object tem
;
18772 /* If the variable is not marked as risky to set
18773 then its contents are risky to use. */
18774 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18777 tem
= Fboundp (elt
);
18780 tem
= Fsymbol_value (elt
);
18781 /* If value is a string, output that string literally:
18782 don't check for % within it. */
18786 if (!EQ (tem
, elt
))
18788 /* Give up right away for nil or t. */
18798 register Lisp_Object car
, tem
;
18800 /* A cons cell: five distinct cases.
18801 If first element is :eval or :propertize, do something special.
18802 If first element is a string or a cons, process all the elements
18803 and effectively concatenate them.
18804 If first element is a negative number, truncate displaying cdr to
18805 at most that many characters. If positive, pad (with spaces)
18806 to at least that many characters.
18807 If first element is a symbol, process the cadr or caddr recursively
18808 according to whether the symbol's value is non-nil or nil. */
18810 if (EQ (car
, QCeval
))
18812 /* An element of the form (:eval FORM) means evaluate FORM
18813 and use the result as mode line elements. */
18818 if (CONSP (XCDR (elt
)))
18821 spec
= safe_eval (XCAR (XCDR (elt
)));
18822 n
+= display_mode_element (it
, depth
, field_width
- n
,
18823 precision
- n
, spec
, props
,
18827 else if (EQ (car
, QCpropertize
))
18829 /* An element of the form (:propertize ELT PROPS...)
18830 means display ELT but applying properties PROPS. */
18835 if (CONSP (XCDR (elt
)))
18836 n
+= display_mode_element (it
, depth
, field_width
- n
,
18837 precision
- n
, XCAR (XCDR (elt
)),
18838 XCDR (XCDR (elt
)), risky
);
18840 else if (SYMBOLP (car
))
18842 tem
= Fboundp (car
);
18846 /* elt is now the cdr, and we know it is a cons cell.
18847 Use its car if CAR has a non-nil value. */
18850 tem
= Fsymbol_value (car
);
18857 /* Symbol's value is nil (or symbol is unbound)
18858 Get the cddr of the original list
18859 and if possible find the caddr and use that. */
18863 else if (!CONSP (elt
))
18868 else if (INTEGERP (car
))
18870 register int lim
= XINT (car
);
18874 /* Negative int means reduce maximum width. */
18875 if (precision
<= 0)
18878 precision
= min (precision
, -lim
);
18882 /* Padding specified. Don't let it be more than
18883 current maximum. */
18885 lim
= min (precision
, lim
);
18887 /* If that's more padding than already wanted, queue it.
18888 But don't reduce padding already specified even if
18889 that is beyond the current truncation point. */
18890 field_width
= max (lim
, field_width
);
18894 else if (STRINGP (car
) || CONSP (car
))
18896 Lisp_Object halftail
= elt
;
18900 && (precision
<= 0 || n
< precision
))
18902 n
+= display_mode_element (it
, depth
,
18903 /* Do padding only after the last
18904 element in the list. */
18905 (! CONSP (XCDR (elt
))
18908 precision
- n
, XCAR (elt
),
18912 if ((len
& 1) == 0)
18913 halftail
= XCDR (halftail
);
18914 /* Check for cycle. */
18915 if (EQ (halftail
, elt
))
18924 elt
= build_string ("*invalid*");
18928 /* Pad to FIELD_WIDTH. */
18929 if (field_width
> 0 && n
< field_width
)
18931 switch (mode_line_target
)
18933 case MODE_LINE_NOPROP
:
18934 case MODE_LINE_TITLE
:
18935 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18937 case MODE_LINE_STRING
:
18938 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18940 case MODE_LINE_DISPLAY
:
18941 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18950 /* Store a mode-line string element in mode_line_string_list.
18952 If STRING is non-null, display that C string. Otherwise, the Lisp
18953 string LISP_STRING is displayed.
18955 FIELD_WIDTH is the minimum number of output glyphs to produce.
18956 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18957 with spaces. FIELD_WIDTH <= 0 means don't pad.
18959 PRECISION is the maximum number of characters to output from
18960 STRING. PRECISION <= 0 means don't truncate the string.
18962 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18963 properties to the string.
18965 PROPS are the properties to add to the string.
18966 The mode_line_string_face face property is always added to the string.
18970 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18971 int field_width
, int precision
, Lisp_Object props
)
18976 if (string
!= NULL
)
18978 len
= strlen (string
);
18979 if (precision
> 0 && len
> precision
)
18981 lisp_string
= make_string (string
, len
);
18983 props
= mode_line_string_face_prop
;
18984 else if (!NILP (mode_line_string_face
))
18986 Lisp_Object face
= Fplist_get (props
, Qface
);
18987 props
= Fcopy_sequence (props
);
18989 face
= mode_line_string_face
;
18991 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18992 props
= Fplist_put (props
, Qface
, face
);
18994 Fadd_text_properties (make_number (0), make_number (len
),
18995 props
, lisp_string
);
18999 len
= XFASTINT (Flength (lisp_string
));
19000 if (precision
> 0 && len
> precision
)
19003 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19006 if (!NILP (mode_line_string_face
))
19010 props
= Ftext_properties_at (make_number (0), lisp_string
);
19011 face
= Fplist_get (props
, Qface
);
19013 face
= mode_line_string_face
;
19015 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19016 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19018 lisp_string
= Fcopy_sequence (lisp_string
);
19021 Fadd_text_properties (make_number (0), make_number (len
),
19022 props
, lisp_string
);
19027 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19031 if (field_width
> len
)
19033 field_width
-= len
;
19034 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19036 Fadd_text_properties (make_number (0), make_number (field_width
),
19037 props
, lisp_string
);
19038 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19046 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19048 doc
: /* Format a string out of a mode line format specification.
19049 First arg FORMAT specifies the mode line format (see `mode-line-format'
19050 for details) to use.
19052 By default, the format is evaluated for the currently selected window.
19054 Optional second arg FACE specifies the face property to put on all
19055 characters for which no face is specified. The value nil means the
19056 default face. The value t means whatever face the window's mode line
19057 currently uses (either `mode-line' or `mode-line-inactive',
19058 depending on whether the window is the selected window or not).
19059 An integer value means the value string has no text
19062 Optional third and fourth args WINDOW and BUFFER specify the window
19063 and buffer to use as the context for the formatting (defaults
19064 are the selected window and the WINDOW's buffer). */)
19065 (Lisp_Object format
, Lisp_Object face
,
19066 Lisp_Object window
, Lisp_Object buffer
)
19071 struct buffer
*old_buffer
= NULL
;
19073 int no_props
= INTEGERP (face
);
19074 int count
= SPECPDL_INDEX ();
19076 int string_start
= 0;
19079 window
= selected_window
;
19080 CHECK_WINDOW (window
);
19081 w
= XWINDOW (window
);
19084 buffer
= w
->buffer
;
19085 CHECK_BUFFER (buffer
);
19087 /* Make formatting the modeline a non-op when noninteractive, otherwise
19088 there will be problems later caused by a partially initialized frame. */
19089 if (NILP (format
) || noninteractive
)
19090 return empty_unibyte_string
;
19095 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19096 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19097 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19098 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19099 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19100 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19101 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19104 if (XBUFFER (buffer
) != current_buffer
)
19105 old_buffer
= current_buffer
;
19107 /* Save things including mode_line_proptrans_alist,
19108 and set that to nil so that we don't alter the outer value. */
19109 record_unwind_protect (unwind_format_mode_line
,
19110 format_mode_line_unwind_data
19111 (old_buffer
, selected_window
, 1));
19112 mode_line_proptrans_alist
= Qnil
;
19114 Fselect_window (window
, Qt
);
19116 set_buffer_internal_1 (XBUFFER (buffer
));
19118 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19122 mode_line_target
= MODE_LINE_NOPROP
;
19123 mode_line_string_face_prop
= Qnil
;
19124 mode_line_string_list
= Qnil
;
19125 string_start
= MODE_LINE_NOPROP_LEN (0);
19129 mode_line_target
= MODE_LINE_STRING
;
19130 mode_line_string_list
= Qnil
;
19131 mode_line_string_face
= face
;
19132 mode_line_string_face_prop
19133 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19136 push_kboard (FRAME_KBOARD (it
.f
));
19137 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19142 len
= MODE_LINE_NOPROP_LEN (string_start
);
19143 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19147 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19148 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19149 empty_unibyte_string
);
19152 unbind_to (count
, Qnil
);
19156 /* Write a null-terminated, right justified decimal representation of
19157 the positive integer D to BUF using a minimal field width WIDTH. */
19160 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19162 register char *p
= buf
;
19170 *p
++ = d
% 10 + '0';
19175 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19186 /* Write a null-terminated, right justified decimal and "human
19187 readable" representation of the nonnegative integer D to BUF using
19188 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19190 static const char power_letter
[] =
19204 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19206 /* We aim to represent the nonnegative integer D as
19207 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19208 EMACS_INT quotient
= d
;
19210 /* -1 means: do not use TENTHS. */
19214 /* Length of QUOTIENT.TENTHS as a string. */
19220 if (1000 <= quotient
)
19222 /* Scale to the appropriate EXPONENT. */
19225 remainder
= quotient
% 1000;
19229 while (1000 <= quotient
);
19231 /* Round to nearest and decide whether to use TENTHS or not. */
19234 tenths
= remainder
/ 100;
19235 if (50 <= remainder
% 100)
19242 if (quotient
== 10)
19250 if (500 <= remainder
)
19252 if (quotient
< 999)
19263 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19264 if (tenths
== -1 && quotient
<= 99)
19271 p
= psuffix
= buf
+ max (width
, length
);
19273 /* Print EXPONENT. */
19274 *psuffix
++ = power_letter
[exponent
];
19277 /* Print TENTHS. */
19280 *--p
= '0' + tenths
;
19284 /* Print QUOTIENT. */
19287 int digit
= quotient
% 10;
19288 *--p
= '0' + digit
;
19290 while ((quotient
/= 10) != 0);
19292 /* Print leading spaces. */
19297 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19298 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19299 type of CODING_SYSTEM. Return updated pointer into BUF. */
19301 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19304 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19307 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19308 const unsigned char *eol_str
;
19310 /* The EOL conversion we are using. */
19311 Lisp_Object eoltype
;
19313 val
= CODING_SYSTEM_SPEC (coding_system
);
19316 if (!VECTORP (val
)) /* Not yet decided. */
19321 eoltype
= eol_mnemonic_undecided
;
19322 /* Don't mention EOL conversion if it isn't decided. */
19327 Lisp_Object eolvalue
;
19329 attrs
= AREF (val
, 0);
19330 eolvalue
= AREF (val
, 2);
19333 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19337 /* The EOL conversion that is normal on this system. */
19339 if (NILP (eolvalue
)) /* Not yet decided. */
19340 eoltype
= eol_mnemonic_undecided
;
19341 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19342 eoltype
= eol_mnemonic_undecided
;
19343 else /* eolvalue is Qunix, Qdos, or Qmac. */
19344 eoltype
= (EQ (eolvalue
, Qunix
)
19345 ? eol_mnemonic_unix
19346 : (EQ (eolvalue
, Qdos
) == 1
19347 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19353 /* Mention the EOL conversion if it is not the usual one. */
19354 if (STRINGP (eoltype
))
19356 eol_str
= SDATA (eoltype
);
19357 eol_str_len
= SBYTES (eoltype
);
19359 else if (CHARACTERP (eoltype
))
19361 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19362 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19367 eol_str
= invalid_eol_type
;
19368 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19370 memcpy (buf
, eol_str
, eol_str_len
);
19371 buf
+= eol_str_len
;
19377 /* Return a string for the output of a mode line %-spec for window W,
19378 generated by character C. FIELD_WIDTH > 0 means pad the string
19379 returned with spaces to that value. Return a Lisp string in
19380 *STRING if the resulting string is taken from that Lisp string.
19382 Note we operate on the current buffer for most purposes,
19383 the exception being w->base_line_pos. */
19385 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19387 static const char *
19388 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19389 Lisp_Object
*string
)
19392 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19393 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19394 struct buffer
*b
= current_buffer
;
19402 if (!NILP (BVAR (b
, read_only
)))
19404 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19409 /* This differs from %* only for a modified read-only buffer. */
19410 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19412 if (!NILP (BVAR (b
, read_only
)))
19417 /* This differs from %* in ignoring read-only-ness. */
19418 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19430 if (command_loop_level
> 5)
19432 p
= decode_mode_spec_buf
;
19433 for (i
= 0; i
< command_loop_level
; i
++)
19436 return decode_mode_spec_buf
;
19444 if (command_loop_level
> 5)
19446 p
= decode_mode_spec_buf
;
19447 for (i
= 0; i
< command_loop_level
; i
++)
19450 return decode_mode_spec_buf
;
19457 /* Let lots_of_dashes be a string of infinite length. */
19458 if (mode_line_target
== MODE_LINE_NOPROP
||
19459 mode_line_target
== MODE_LINE_STRING
)
19461 if (field_width
<= 0
19462 || field_width
> sizeof (lots_of_dashes
))
19464 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19465 decode_mode_spec_buf
[i
] = '-';
19466 decode_mode_spec_buf
[i
] = '\0';
19467 return decode_mode_spec_buf
;
19470 return lots_of_dashes
;
19474 obj
= BVAR (b
, name
);
19478 /* %c and %l are ignored in `frame-title-format'.
19479 (In redisplay_internal, the frame title is drawn _before_ the
19480 windows are updated, so the stuff which depends on actual
19481 window contents (such as %l) may fail to render properly, or
19482 even crash emacs.) */
19483 if (mode_line_target
== MODE_LINE_TITLE
)
19487 EMACS_INT col
= current_column ();
19488 w
->column_number_displayed
= make_number (col
);
19489 pint2str (decode_mode_spec_buf
, field_width
, col
);
19490 return decode_mode_spec_buf
;
19494 #ifndef SYSTEM_MALLOC
19496 if (NILP (Vmemory_full
))
19499 return "!MEM FULL! ";
19506 /* %F displays the frame name. */
19507 if (!NILP (f
->title
))
19508 return SSDATA (f
->title
);
19509 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19510 return SSDATA (f
->name
);
19514 obj
= BVAR (b
, filename
);
19519 EMACS_INT size
= ZV
- BEGV
;
19520 pint2str (decode_mode_spec_buf
, field_width
, size
);
19521 return decode_mode_spec_buf
;
19526 EMACS_INT size
= ZV
- BEGV
;
19527 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19528 return decode_mode_spec_buf
;
19533 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19534 EMACS_INT topline
, nlines
, height
;
19537 /* %c and %l are ignored in `frame-title-format'. */
19538 if (mode_line_target
== MODE_LINE_TITLE
)
19541 startpos
= XMARKER (w
->start
)->charpos
;
19542 startpos_byte
= marker_byte_position (w
->start
);
19543 height
= WINDOW_TOTAL_LINES (w
);
19545 /* If we decided that this buffer isn't suitable for line numbers,
19546 don't forget that too fast. */
19547 if (EQ (w
->base_line_pos
, w
->buffer
))
19549 /* But do forget it, if the window shows a different buffer now. */
19550 else if (BUFFERP (w
->base_line_pos
))
19551 w
->base_line_pos
= Qnil
;
19553 /* If the buffer is very big, don't waste time. */
19554 if (INTEGERP (Vline_number_display_limit
)
19555 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19557 w
->base_line_pos
= Qnil
;
19558 w
->base_line_number
= Qnil
;
19562 if (INTEGERP (w
->base_line_number
)
19563 && INTEGERP (w
->base_line_pos
)
19564 && XFASTINT (w
->base_line_pos
) <= startpos
)
19566 line
= XFASTINT (w
->base_line_number
);
19567 linepos
= XFASTINT (w
->base_line_pos
);
19568 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19573 linepos
= BUF_BEGV (b
);
19574 linepos_byte
= BUF_BEGV_BYTE (b
);
19577 /* Count lines from base line to window start position. */
19578 nlines
= display_count_lines (linepos_byte
,
19582 topline
= nlines
+ line
;
19584 /* Determine a new base line, if the old one is too close
19585 or too far away, or if we did not have one.
19586 "Too close" means it's plausible a scroll-down would
19587 go back past it. */
19588 if (startpos
== BUF_BEGV (b
))
19590 w
->base_line_number
= make_number (topline
);
19591 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19593 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19594 || linepos
== BUF_BEGV (b
))
19596 EMACS_INT limit
= BUF_BEGV (b
);
19597 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19598 EMACS_INT position
;
19599 EMACS_INT distance
=
19600 (height
* 2 + 30) * line_number_display_limit_width
;
19602 if (startpos
- distance
> limit
)
19604 limit
= startpos
- distance
;
19605 limit_byte
= CHAR_TO_BYTE (limit
);
19608 nlines
= display_count_lines (startpos_byte
,
19610 - (height
* 2 + 30),
19612 /* If we couldn't find the lines we wanted within
19613 line_number_display_limit_width chars per line,
19614 give up on line numbers for this window. */
19615 if (position
== limit_byte
&& limit
== startpos
- distance
)
19617 w
->base_line_pos
= w
->buffer
;
19618 w
->base_line_number
= Qnil
;
19622 w
->base_line_number
= make_number (topline
- nlines
);
19623 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19626 /* Now count lines from the start pos to point. */
19627 nlines
= display_count_lines (startpos_byte
,
19628 PT_BYTE
, PT
, &junk
);
19630 /* Record that we did display the line number. */
19631 line_number_displayed
= 1;
19633 /* Make the string to show. */
19634 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19635 return decode_mode_spec_buf
;
19638 char* p
= decode_mode_spec_buf
;
19639 int pad
= field_width
- 2;
19645 return decode_mode_spec_buf
;
19651 obj
= BVAR (b
, mode_name
);
19655 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19661 EMACS_INT pos
= marker_position (w
->start
);
19662 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19664 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19666 if (pos
<= BUF_BEGV (b
))
19671 else if (pos
<= BUF_BEGV (b
))
19675 if (total
> 1000000)
19676 /* Do it differently for a large value, to avoid overflow. */
19677 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19679 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19680 /* We can't normally display a 3-digit number,
19681 so get us a 2-digit number that is close. */
19684 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19685 return decode_mode_spec_buf
;
19689 /* Display percentage of size above the bottom of the screen. */
19692 EMACS_INT toppos
= marker_position (w
->start
);
19693 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19694 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19696 if (botpos
>= BUF_ZV (b
))
19698 if (toppos
<= BUF_BEGV (b
))
19705 if (total
> 1000000)
19706 /* Do it differently for a large value, to avoid overflow. */
19707 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19709 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19710 /* We can't normally display a 3-digit number,
19711 so get us a 2-digit number that is close. */
19714 if (toppos
<= BUF_BEGV (b
))
19715 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
19717 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19718 return decode_mode_spec_buf
;
19723 /* status of process */
19724 obj
= Fget_buffer_process (Fcurrent_buffer ());
19726 return "no process";
19728 obj
= Fsymbol_name (Fprocess_status (obj
));
19734 int count
= inhibit_garbage_collection ();
19735 Lisp_Object val
= call1 (intern ("file-remote-p"),
19736 BVAR (current_buffer
, directory
));
19737 unbind_to (count
, Qnil
);
19745 case 't': /* indicate TEXT or BINARY */
19749 /* coding-system (not including end-of-line format) */
19751 /* coding-system (including end-of-line type) */
19753 int eol_flag
= (c
== 'Z');
19754 char *p
= decode_mode_spec_buf
;
19756 if (! FRAME_WINDOW_P (f
))
19758 /* No need to mention EOL here--the terminal never needs
19759 to do EOL conversion. */
19760 p
= decode_mode_spec_coding (CODING_ID_NAME
19761 (FRAME_KEYBOARD_CODING (f
)->id
),
19763 p
= decode_mode_spec_coding (CODING_ID_NAME
19764 (FRAME_TERMINAL_CODING (f
)->id
),
19767 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19770 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19771 #ifdef subprocesses
19772 obj
= Fget_buffer_process (Fcurrent_buffer ());
19773 if (PROCESSP (obj
))
19775 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19777 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19780 #endif /* subprocesses */
19783 return decode_mode_spec_buf
;
19790 return SSDATA (obj
);
19797 /* Count up to COUNT lines starting from START_BYTE.
19798 But don't go beyond LIMIT_BYTE.
19799 Return the number of lines thus found (always nonnegative).
19801 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19804 display_count_lines (EMACS_INT start_byte
,
19805 EMACS_INT limit_byte
, EMACS_INT count
,
19806 EMACS_INT
*byte_pos_ptr
)
19808 register unsigned char *cursor
;
19809 unsigned char *base
;
19811 register EMACS_INT ceiling
;
19812 register unsigned char *ceiling_addr
;
19813 EMACS_INT orig_count
= count
;
19815 /* If we are not in selective display mode,
19816 check only for newlines. */
19817 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19818 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19822 while (start_byte
< limit_byte
)
19824 ceiling
= BUFFER_CEILING_OF (start_byte
);
19825 ceiling
= min (limit_byte
- 1, ceiling
);
19826 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19827 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19830 if (selective_display
)
19831 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19834 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19837 if (cursor
!= ceiling_addr
)
19841 start_byte
+= cursor
- base
+ 1;
19842 *byte_pos_ptr
= start_byte
;
19846 if (++cursor
== ceiling_addr
)
19852 start_byte
+= cursor
- base
;
19857 while (start_byte
> limit_byte
)
19859 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19860 ceiling
= max (limit_byte
, ceiling
);
19861 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19862 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19865 if (selective_display
)
19866 while (--cursor
!= ceiling_addr
19867 && *cursor
!= '\n' && *cursor
!= 015)
19870 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19873 if (cursor
!= ceiling_addr
)
19877 start_byte
+= cursor
- base
+ 1;
19878 *byte_pos_ptr
= start_byte
;
19879 /* When scanning backwards, we should
19880 not count the newline posterior to which we stop. */
19881 return - orig_count
- 1;
19887 /* Here we add 1 to compensate for the last decrement
19888 of CURSOR, which took it past the valid range. */
19889 start_byte
+= cursor
- base
+ 1;
19893 *byte_pos_ptr
= limit_byte
;
19896 return - orig_count
+ count
;
19897 return orig_count
- count
;
19903 /***********************************************************************
19905 ***********************************************************************/
19907 /* Display a NUL-terminated string, starting with index START.
19909 If STRING is non-null, display that C string. Otherwise, the Lisp
19910 string LISP_STRING is displayed. There's a case that STRING is
19911 non-null and LISP_STRING is not nil. It means STRING is a string
19912 data of LISP_STRING. In that case, we display LISP_STRING while
19913 ignoring its text properties.
19915 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19916 FACE_STRING. Display STRING or LISP_STRING with the face at
19917 FACE_STRING_POS in FACE_STRING:
19919 Display the string in the environment given by IT, but use the
19920 standard display table, temporarily.
19922 FIELD_WIDTH is the minimum number of output glyphs to produce.
19923 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19924 with spaces. If STRING has more characters, more than FIELD_WIDTH
19925 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19927 PRECISION is the maximum number of characters to output from
19928 STRING. PRECISION < 0 means don't truncate the string.
19930 This is roughly equivalent to printf format specifiers:
19932 FIELD_WIDTH PRECISION PRINTF
19933 ----------------------------------------
19939 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19940 display them, and < 0 means obey the current buffer's value of
19941 enable_multibyte_characters.
19943 Value is the number of columns displayed. */
19946 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19947 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19948 int field_width
, int precision
, int max_x
, int multibyte
)
19950 int hpos_at_start
= it
->hpos
;
19951 int saved_face_id
= it
->face_id
;
19952 struct glyph_row
*row
= it
->glyph_row
;
19954 /* Initialize the iterator IT for iteration over STRING beginning
19955 with index START. */
19956 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19957 precision
, field_width
, multibyte
);
19958 if (string
&& STRINGP (lisp_string
))
19959 /* LISP_STRING is the one returned by decode_mode_spec. We should
19960 ignore its text properties. */
19961 it
->stop_charpos
= -1;
19963 /* If displaying STRING, set up the face of the iterator
19964 from LISP_STRING, if that's given. */
19965 if (STRINGP (face_string
))
19971 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19972 0, it
->region_beg_charpos
,
19973 it
->region_end_charpos
,
19974 &endptr
, it
->base_face_id
, 0);
19975 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19976 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19979 /* Set max_x to the maximum allowed X position. Don't let it go
19980 beyond the right edge of the window. */
19982 max_x
= it
->last_visible_x
;
19984 max_x
= min (max_x
, it
->last_visible_x
);
19986 /* Skip over display elements that are not visible. because IT->w is
19988 if (it
->current_x
< it
->first_visible_x
)
19989 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19990 MOVE_TO_POS
| MOVE_TO_X
);
19992 row
->ascent
= it
->max_ascent
;
19993 row
->height
= it
->max_ascent
+ it
->max_descent
;
19994 row
->phys_ascent
= it
->max_phys_ascent
;
19995 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19996 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19998 /* This condition is for the case that we are called with current_x
19999 past last_visible_x. */
20000 while (it
->current_x
< max_x
)
20002 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20004 /* Get the next display element. */
20005 if (!get_next_display_element (it
))
20008 /* Produce glyphs. */
20009 x_before
= it
->current_x
;
20010 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20011 PRODUCE_GLYPHS (it
);
20013 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
20016 while (i
< nglyphs
)
20018 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20020 if (it
->line_wrap
!= TRUNCATE
20021 && x
+ glyph
->pixel_width
> max_x
)
20023 /* End of continued line or max_x reached. */
20024 if (CHAR_GLYPH_PADDING_P (*glyph
))
20026 /* A wide character is unbreakable. */
20027 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
20028 it
->current_x
= x_before
;
20032 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20037 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20039 /* Glyph is at least partially visible. */
20041 if (x
< it
->first_visible_x
)
20042 it
->glyph_row
->x
= x
- it
->first_visible_x
;
20046 /* Glyph is off the left margin of the display area.
20047 Should not happen. */
20051 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20052 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20053 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20054 row
->phys_height
= max (row
->phys_height
,
20055 it
->max_phys_ascent
+ it
->max_phys_descent
);
20056 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20057 it
->max_extra_line_spacing
);
20058 x
+= glyph
->pixel_width
;
20062 /* Stop if max_x reached. */
20066 /* Stop at line ends. */
20067 if (ITERATOR_AT_END_OF_LINE_P (it
))
20069 it
->continuation_lines_width
= 0;
20073 set_iterator_to_next (it
, 1);
20075 /* Stop if truncating at the right edge. */
20076 if (it
->line_wrap
== TRUNCATE
20077 && it
->current_x
>= it
->last_visible_x
)
20079 /* Add truncation mark, but don't do it if the line is
20080 truncated at a padding space. */
20081 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20083 if (!FRAME_WINDOW_P (it
->f
))
20087 if (it
->current_x
> it
->last_visible_x
)
20089 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20090 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20092 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20094 row
->used
[TEXT_AREA
] = ii
;
20095 produce_special_glyphs (it
, IT_TRUNCATION
);
20098 produce_special_glyphs (it
, IT_TRUNCATION
);
20100 it
->glyph_row
->truncated_on_right_p
= 1;
20106 /* Maybe insert a truncation at the left. */
20107 if (it
->first_visible_x
20108 && IT_CHARPOS (*it
) > 0)
20110 if (!FRAME_WINDOW_P (it
->f
))
20111 insert_left_trunc_glyphs (it
);
20112 it
->glyph_row
->truncated_on_left_p
= 1;
20115 it
->face_id
= saved_face_id
;
20117 /* Value is number of columns displayed. */
20118 return it
->hpos
- hpos_at_start
;
20123 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20124 appears as an element of LIST or as the car of an element of LIST.
20125 If PROPVAL is a list, compare each element against LIST in that
20126 way, and return 1/2 if any element of PROPVAL is found in LIST.
20127 Otherwise return 0. This function cannot quit.
20128 The return value is 2 if the text is invisible but with an ellipsis
20129 and 1 if it's invisible and without an ellipsis. */
20132 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20134 register Lisp_Object tail
, proptail
;
20136 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20138 register Lisp_Object tem
;
20140 if (EQ (propval
, tem
))
20142 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20143 return NILP (XCDR (tem
)) ? 1 : 2;
20146 if (CONSP (propval
))
20148 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20150 Lisp_Object propelt
;
20151 propelt
= XCAR (proptail
);
20152 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20154 register Lisp_Object tem
;
20156 if (EQ (propelt
, tem
))
20158 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20159 return NILP (XCDR (tem
)) ? 1 : 2;
20167 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20168 doc
: /* Non-nil if the property makes the text invisible.
20169 POS-OR-PROP can be a marker or number, in which case it is taken to be
20170 a position in the current buffer and the value of the `invisible' property
20171 is checked; or it can be some other value, which is then presumed to be the
20172 value of the `invisible' property of the text of interest.
20173 The non-nil value returned can be t for truly invisible text or something
20174 else if the text is replaced by an ellipsis. */)
20175 (Lisp_Object pos_or_prop
)
20178 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20179 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20181 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20182 return (invis
== 0 ? Qnil
20184 : make_number (invis
));
20187 /* Calculate a width or height in pixels from a specification using
20188 the following elements:
20191 NUM - a (fractional) multiple of the default font width/height
20192 (NUM) - specifies exactly NUM pixels
20193 UNIT - a fixed number of pixels, see below.
20194 ELEMENT - size of a display element in pixels, see below.
20195 (NUM . SPEC) - equals NUM * SPEC
20196 (+ SPEC SPEC ...) - add pixel values
20197 (- SPEC SPEC ...) - subtract pixel values
20198 (- SPEC) - negate pixel value
20201 INT or FLOAT - a number constant
20202 SYMBOL - use symbol's (buffer local) variable binding.
20205 in - pixels per inch *)
20206 mm - pixels per 1/1000 meter *)
20207 cm - pixels per 1/100 meter *)
20208 width - width of current font in pixels.
20209 height - height of current font in pixels.
20211 *) using the ratio(s) defined in display-pixels-per-inch.
20215 left-fringe - left fringe width in pixels
20216 right-fringe - right fringe width in pixels
20218 left-margin - left margin width in pixels
20219 right-margin - right margin width in pixels
20221 scroll-bar - scroll-bar area width in pixels
20225 Pixels corresponding to 5 inches:
20228 Total width of non-text areas on left side of window (if scroll-bar is on left):
20229 '(space :width (+ left-fringe left-margin scroll-bar))
20231 Align to first text column (in header line):
20232 '(space :align-to 0)
20234 Align to middle of text area minus half the width of variable `my-image'
20235 containing a loaded image:
20236 '(space :align-to (0.5 . (- text my-image)))
20238 Width of left margin minus width of 1 character in the default font:
20239 '(space :width (- left-margin 1))
20241 Width of left margin minus width of 2 characters in the current font:
20242 '(space :width (- left-margin (2 . width)))
20244 Center 1 character over left-margin (in header line):
20245 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20247 Different ways to express width of left fringe plus left margin minus one pixel:
20248 '(space :width (- (+ left-fringe left-margin) (1)))
20249 '(space :width (+ left-fringe left-margin (- (1))))
20250 '(space :width (+ left-fringe left-margin (-1)))
20254 #define NUMVAL(X) \
20255 ((INTEGERP (X) || FLOATP (X)) \
20260 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20261 struct font
*font
, int width_p
, int *align_to
)
20265 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20266 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20269 return OK_PIXELS (0);
20271 xassert (FRAME_LIVE_P (it
->f
));
20273 if (SYMBOLP (prop
))
20275 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20277 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20279 if (unit
[0] == 'i' && unit
[1] == 'n')
20281 else if (unit
[0] == 'm' && unit
[1] == 'm')
20283 else if (unit
[0] == 'c' && unit
[1] == 'm')
20290 #ifdef HAVE_WINDOW_SYSTEM
20291 if (FRAME_WINDOW_P (it
->f
)
20293 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20294 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20296 return OK_PIXELS (ppi
/ pixels
);
20299 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20300 || (CONSP (Vdisplay_pixels_per_inch
)
20302 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20303 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20305 return OK_PIXELS (ppi
/ pixels
);
20311 #ifdef HAVE_WINDOW_SYSTEM
20312 if (EQ (prop
, Qheight
))
20313 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20314 if (EQ (prop
, Qwidth
))
20315 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20317 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20318 return OK_PIXELS (1);
20321 if (EQ (prop
, Qtext
))
20322 return OK_PIXELS (width_p
20323 ? window_box_width (it
->w
, TEXT_AREA
)
20324 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20326 if (align_to
&& *align_to
< 0)
20329 if (EQ (prop
, Qleft
))
20330 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20331 if (EQ (prop
, Qright
))
20332 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20333 if (EQ (prop
, Qcenter
))
20334 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20335 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20336 if (EQ (prop
, Qleft_fringe
))
20337 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20338 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20339 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20340 if (EQ (prop
, Qright_fringe
))
20341 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20342 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20343 : window_box_right_offset (it
->w
, TEXT_AREA
));
20344 if (EQ (prop
, Qleft_margin
))
20345 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20346 if (EQ (prop
, Qright_margin
))
20347 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20348 if (EQ (prop
, Qscroll_bar
))
20349 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20351 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20352 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20353 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20358 if (EQ (prop
, Qleft_fringe
))
20359 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20360 if (EQ (prop
, Qright_fringe
))
20361 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20362 if (EQ (prop
, Qleft_margin
))
20363 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20364 if (EQ (prop
, Qright_margin
))
20365 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20366 if (EQ (prop
, Qscroll_bar
))
20367 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20370 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20373 if (INTEGERP (prop
) || FLOATP (prop
))
20375 int base_unit
= (width_p
20376 ? FRAME_COLUMN_WIDTH (it
->f
)
20377 : FRAME_LINE_HEIGHT (it
->f
));
20378 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20383 Lisp_Object car
= XCAR (prop
);
20384 Lisp_Object cdr
= XCDR (prop
);
20388 #ifdef HAVE_WINDOW_SYSTEM
20389 if (FRAME_WINDOW_P (it
->f
)
20390 && valid_image_p (prop
))
20392 int id
= lookup_image (it
->f
, prop
);
20393 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20395 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20398 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20404 while (CONSP (cdr
))
20406 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20407 font
, width_p
, align_to
))
20410 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20415 if (EQ (car
, Qminus
))
20417 return OK_PIXELS (pixels
);
20420 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20423 if (INTEGERP (car
) || FLOATP (car
))
20426 pixels
= XFLOATINT (car
);
20428 return OK_PIXELS (pixels
);
20429 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20430 font
, width_p
, align_to
))
20431 return OK_PIXELS (pixels
* fact
);
20442 /***********************************************************************
20444 ***********************************************************************/
20446 #ifdef HAVE_WINDOW_SYSTEM
20451 dump_glyph_string (s
)
20452 struct glyph_string
*s
;
20454 fprintf (stderr
, "glyph string\n");
20455 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20456 s
->x
, s
->y
, s
->width
, s
->height
);
20457 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20458 fprintf (stderr
, " hl = %d\n", s
->hl
);
20459 fprintf (stderr
, " left overhang = %d, right = %d\n",
20460 s
->left_overhang
, s
->right_overhang
);
20461 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20462 fprintf (stderr
, " extends to end of line = %d\n",
20463 s
->extends_to_end_of_line_p
);
20464 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20465 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20468 #endif /* GLYPH_DEBUG */
20470 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20471 of XChar2b structures for S; it can't be allocated in
20472 init_glyph_string because it must be allocated via `alloca'. W
20473 is the window on which S is drawn. ROW and AREA are the glyph row
20474 and area within the row from which S is constructed. START is the
20475 index of the first glyph structure covered by S. HL is a
20476 face-override for drawing S. */
20479 #define OPTIONAL_HDC(hdc) HDC hdc,
20480 #define DECLARE_HDC(hdc) HDC hdc;
20481 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20482 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20485 #ifndef OPTIONAL_HDC
20486 #define OPTIONAL_HDC(hdc)
20487 #define DECLARE_HDC(hdc)
20488 #define ALLOCATE_HDC(hdc, f)
20489 #define RELEASE_HDC(hdc, f)
20493 init_glyph_string (struct glyph_string
*s
,
20495 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20496 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20498 memset (s
, 0, sizeof *s
);
20500 s
->f
= XFRAME (w
->frame
);
20504 s
->display
= FRAME_X_DISPLAY (s
->f
);
20505 s
->window
= FRAME_X_WINDOW (s
->f
);
20506 s
->char2b
= char2b
;
20510 s
->first_glyph
= row
->glyphs
[area
] + start
;
20511 s
->height
= row
->height
;
20512 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20513 s
->ybase
= s
->y
+ row
->ascent
;
20517 /* Append the list of glyph strings with head H and tail T to the list
20518 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20521 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20522 struct glyph_string
*h
, struct glyph_string
*t
)
20536 /* Prepend the list of glyph strings with head H and tail T to the
20537 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20541 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20542 struct glyph_string
*h
, struct glyph_string
*t
)
20556 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20557 Set *HEAD and *TAIL to the resulting list. */
20560 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20561 struct glyph_string
*s
)
20563 s
->next
= s
->prev
= NULL
;
20564 append_glyph_string_lists (head
, tail
, s
, s
);
20568 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20569 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20570 make sure that X resources for the face returned are allocated.
20571 Value is a pointer to a realized face that is ready for display if
20572 DISPLAY_P is non-zero. */
20574 static INLINE
struct face
*
20575 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20576 XChar2b
*char2b
, int display_p
)
20578 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20582 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20584 if (code
!= FONT_INVALID_CODE
)
20585 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20587 STORE_XCHAR2B (char2b
, 0, 0);
20590 /* Make sure X resources of the face are allocated. */
20591 #ifdef HAVE_X_WINDOWS
20595 xassert (face
!= NULL
);
20596 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20603 /* Get face and two-byte form of character glyph GLYPH on frame F.
20604 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20605 a pointer to a realized face that is ready for display. */
20607 static INLINE
struct face
*
20608 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20609 XChar2b
*char2b
, int *two_byte_p
)
20613 xassert (glyph
->type
== CHAR_GLYPH
);
20614 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20623 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20624 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20626 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20628 if (code
!= FONT_INVALID_CODE
)
20629 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20631 STORE_XCHAR2B (char2b
, 0, 0);
20634 /* Make sure X resources of the face are allocated. */
20635 xassert (face
!= NULL
);
20636 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20641 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20642 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20645 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20649 if (CHAR_BYTE8_P (c
))
20650 code
= CHAR_TO_BYTE8 (c
);
20652 code
= font
->driver
->encode_char (font
, c
);
20654 if (code
== FONT_INVALID_CODE
)
20656 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20661 /* Fill glyph string S with composition components specified by S->cmp.
20663 BASE_FACE is the base face of the composition.
20664 S->cmp_from is the index of the first component for S.
20666 OVERLAPS non-zero means S should draw the foreground only, and use
20667 its physical height for clipping. See also draw_glyphs.
20669 Value is the index of a component not in S. */
20672 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20676 /* For all glyphs of this composition, starting at the offset
20677 S->cmp_from, until we reach the end of the definition or encounter a
20678 glyph that requires the different face, add it to S. */
20683 s
->for_overlaps
= overlaps
;
20686 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20688 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20692 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20695 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20702 s
->font
= s
->face
->font
;
20704 else if (s
->face
!= face
)
20712 /* All glyph strings for the same composition has the same width,
20713 i.e. the width set for the first component of the composition. */
20714 s
->width
= s
->first_glyph
->pixel_width
;
20716 /* If the specified font could not be loaded, use the frame's
20717 default font, but record the fact that we couldn't load it in
20718 the glyph string so that we can draw rectangles for the
20719 characters of the glyph string. */
20720 if (s
->font
== NULL
)
20722 s
->font_not_found_p
= 1;
20723 s
->font
= FRAME_FONT (s
->f
);
20726 /* Adjust base line for subscript/superscript text. */
20727 s
->ybase
+= s
->first_glyph
->voffset
;
20729 /* This glyph string must always be drawn with 16-bit functions. */
20736 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20737 int start
, int end
, int overlaps
)
20739 struct glyph
*glyph
, *last
;
20740 Lisp_Object lgstring
;
20743 s
->for_overlaps
= overlaps
;
20744 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20745 last
= s
->row
->glyphs
[s
->area
] + end
;
20746 s
->cmp_id
= glyph
->u
.cmp
.id
;
20747 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20748 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20749 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20750 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20751 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20753 while (glyph
< last
20754 && glyph
->u
.cmp
.automatic
20755 && glyph
->u
.cmp
.id
== s
->cmp_id
20756 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20757 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20759 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20761 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20762 unsigned code
= LGLYPH_CODE (lglyph
);
20764 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20766 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20767 return glyph
- s
->row
->glyphs
[s
->area
];
20771 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20772 See the comment of fill_glyph_string for arguments.
20773 Value is the index of the first glyph not in S. */
20777 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20778 int start
, int end
, int overlaps
)
20780 struct glyph
*glyph
, *last
;
20783 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20784 s
->for_overlaps
= overlaps
;
20785 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20786 last
= s
->row
->glyphs
[s
->area
] + end
;
20787 voffset
= glyph
->voffset
;
20788 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20789 s
->font
= s
->face
->font
;
20791 s
->width
= glyph
->pixel_width
;
20793 while (glyph
< last
20794 && glyph
->type
== GLYPHLESS_GLYPH
20795 && glyph
->voffset
== voffset
20796 && glyph
->face_id
== face_id
)
20799 s
->width
+= glyph
->pixel_width
;
20802 s
->ybase
+= voffset
;
20803 return glyph
- s
->row
->glyphs
[s
->area
];
20807 /* Fill glyph string S from a sequence of character glyphs.
20809 FACE_ID is the face id of the string. START is the index of the
20810 first glyph to consider, END is the index of the last + 1.
20811 OVERLAPS non-zero means S should draw the foreground only, and use
20812 its physical height for clipping. See also draw_glyphs.
20814 Value is the index of the first glyph not in S. */
20817 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20818 int start
, int end
, int overlaps
)
20820 struct glyph
*glyph
, *last
;
20822 int glyph_not_available_p
;
20824 xassert (s
->f
== XFRAME (s
->w
->frame
));
20825 xassert (s
->nchars
== 0);
20826 xassert (start
>= 0 && end
> start
);
20828 s
->for_overlaps
= overlaps
;
20829 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20830 last
= s
->row
->glyphs
[s
->area
] + end
;
20831 voffset
= glyph
->voffset
;
20832 s
->padding_p
= glyph
->padding_p
;
20833 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20835 while (glyph
< last
20836 && glyph
->type
== CHAR_GLYPH
20837 && glyph
->voffset
== voffset
20838 /* Same face id implies same font, nowadays. */
20839 && glyph
->face_id
== face_id
20840 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20844 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20845 s
->char2b
+ s
->nchars
,
20847 s
->two_byte_p
= two_byte_p
;
20849 xassert (s
->nchars
<= end
- start
);
20850 s
->width
+= glyph
->pixel_width
;
20851 if (glyph
++->padding_p
!= s
->padding_p
)
20855 s
->font
= s
->face
->font
;
20857 /* If the specified font could not be loaded, use the frame's font,
20858 but record the fact that we couldn't load it in
20859 S->font_not_found_p so that we can draw rectangles for the
20860 characters of the glyph string. */
20861 if (s
->font
== NULL
|| glyph_not_available_p
)
20863 s
->font_not_found_p
= 1;
20864 s
->font
= FRAME_FONT (s
->f
);
20867 /* Adjust base line for subscript/superscript text. */
20868 s
->ybase
+= voffset
;
20870 xassert (s
->face
&& s
->face
->gc
);
20871 return glyph
- s
->row
->glyphs
[s
->area
];
20875 /* Fill glyph string S from image glyph S->first_glyph. */
20878 fill_image_glyph_string (struct glyph_string
*s
)
20880 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20881 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20883 s
->slice
= s
->first_glyph
->slice
.img
;
20884 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20885 s
->font
= s
->face
->font
;
20886 s
->width
= s
->first_glyph
->pixel_width
;
20888 /* Adjust base line for subscript/superscript text. */
20889 s
->ybase
+= s
->first_glyph
->voffset
;
20893 /* Fill glyph string S from a sequence of stretch glyphs.
20895 START is the index of the first glyph to consider,
20896 END is the index of the last + 1.
20898 Value is the index of the first glyph not in S. */
20901 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20903 struct glyph
*glyph
, *last
;
20904 int voffset
, face_id
;
20906 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20908 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20909 last
= s
->row
->glyphs
[s
->area
] + end
;
20910 face_id
= glyph
->face_id
;
20911 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20912 s
->font
= s
->face
->font
;
20913 s
->width
= glyph
->pixel_width
;
20915 voffset
= glyph
->voffset
;
20919 && glyph
->type
== STRETCH_GLYPH
20920 && glyph
->voffset
== voffset
20921 && glyph
->face_id
== face_id
);
20923 s
->width
+= glyph
->pixel_width
;
20925 /* Adjust base line for subscript/superscript text. */
20926 s
->ybase
+= voffset
;
20928 /* The case that face->gc == 0 is handled when drawing the glyph
20929 string by calling PREPARE_FACE_FOR_DISPLAY. */
20931 return glyph
- s
->row
->glyphs
[s
->area
];
20934 static struct font_metrics
*
20935 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20937 static struct font_metrics metrics
;
20938 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20940 if (! font
|| code
== FONT_INVALID_CODE
)
20942 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20947 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20948 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20949 assumed to be zero. */
20952 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20954 *left
= *right
= 0;
20956 if (glyph
->type
== CHAR_GLYPH
)
20960 struct font_metrics
*pcm
;
20962 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20963 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20965 if (pcm
->rbearing
> pcm
->width
)
20966 *right
= pcm
->rbearing
- pcm
->width
;
20967 if (pcm
->lbearing
< 0)
20968 *left
= -pcm
->lbearing
;
20971 else if (glyph
->type
== COMPOSITE_GLYPH
)
20973 if (! glyph
->u
.cmp
.automatic
)
20975 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20977 if (cmp
->rbearing
> cmp
->pixel_width
)
20978 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20979 if (cmp
->lbearing
< 0)
20980 *left
= - cmp
->lbearing
;
20984 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20985 struct font_metrics metrics
;
20987 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20988 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20989 if (metrics
.rbearing
> metrics
.width
)
20990 *right
= metrics
.rbearing
- metrics
.width
;
20991 if (metrics
.lbearing
< 0)
20992 *left
= - metrics
.lbearing
;
20998 /* Return the index of the first glyph preceding glyph string S that
20999 is overwritten by S because of S's left overhang. Value is -1
21000 if no glyphs are overwritten. */
21003 left_overwritten (struct glyph_string
*s
)
21007 if (s
->left_overhang
)
21010 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21011 int first
= s
->first_glyph
- glyphs
;
21013 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21014 x
-= glyphs
[i
].pixel_width
;
21025 /* Return the index of the first glyph preceding glyph string S that
21026 is overwriting S because of its right overhang. Value is -1 if no
21027 glyph in front of S overwrites S. */
21030 left_overwriting (struct glyph_string
*s
)
21033 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21034 int first
= s
->first_glyph
- glyphs
;
21038 for (i
= first
- 1; i
>= 0; --i
)
21041 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21044 x
-= glyphs
[i
].pixel_width
;
21051 /* Return the index of the last glyph following glyph string S that is
21052 overwritten by S because of S's right overhang. Value is -1 if
21053 no such glyph is found. */
21056 right_overwritten (struct glyph_string
*s
)
21060 if (s
->right_overhang
)
21063 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21064 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21065 int end
= s
->row
->used
[s
->area
];
21067 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21068 x
+= glyphs
[i
].pixel_width
;
21077 /* Return the index of the last glyph following glyph string S that
21078 overwrites S because of its left overhang. Value is negative
21079 if no such glyph is found. */
21082 right_overwriting (struct glyph_string
*s
)
21085 int end
= s
->row
->used
[s
->area
];
21086 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21087 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21091 for (i
= first
; i
< end
; ++i
)
21094 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21097 x
+= glyphs
[i
].pixel_width
;
21104 /* Set background width of glyph string S. START is the index of the
21105 first glyph following S. LAST_X is the right-most x-position + 1
21106 in the drawing area. */
21109 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21111 /* If the face of this glyph string has to be drawn to the end of
21112 the drawing area, set S->extends_to_end_of_line_p. */
21114 if (start
== s
->row
->used
[s
->area
]
21115 && s
->area
== TEXT_AREA
21116 && ((s
->row
->fill_line_p
21117 && (s
->hl
== DRAW_NORMAL_TEXT
21118 || s
->hl
== DRAW_IMAGE_RAISED
21119 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21120 || s
->hl
== DRAW_MOUSE_FACE
))
21121 s
->extends_to_end_of_line_p
= 1;
21123 /* If S extends its face to the end of the line, set its
21124 background_width to the distance to the right edge of the drawing
21126 if (s
->extends_to_end_of_line_p
)
21127 s
->background_width
= last_x
- s
->x
+ 1;
21129 s
->background_width
= s
->width
;
21133 /* Compute overhangs and x-positions for glyph string S and its
21134 predecessors, or successors. X is the starting x-position for S.
21135 BACKWARD_P non-zero means process predecessors. */
21138 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21144 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21145 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21155 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21156 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21166 /* The following macros are only called from draw_glyphs below.
21167 They reference the following parameters of that function directly:
21168 `w', `row', `area', and `overlap_p'
21169 as well as the following local variables:
21170 `s', `f', and `hdc' (in W32) */
21173 /* On W32, silently add local `hdc' variable to argument list of
21174 init_glyph_string. */
21175 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21176 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21178 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21179 init_glyph_string (s, char2b, w, row, area, start, hl)
21182 /* Add a glyph string for a stretch glyph to the list of strings
21183 between HEAD and TAIL. START is the index of the stretch glyph in
21184 row area AREA of glyph row ROW. END is the index of the last glyph
21185 in that glyph row area. X is the current output position assigned
21186 to the new glyph string constructed. HL overrides that face of the
21187 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21188 is the right-most x-position of the drawing area. */
21190 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21191 and below -- keep them on one line. */
21192 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21195 s = (struct glyph_string *) alloca (sizeof *s); \
21196 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21197 START = fill_stretch_glyph_string (s, START, END); \
21198 append_glyph_string (&HEAD, &TAIL, s); \
21204 /* Add a glyph string for an image glyph to the list of strings
21205 between HEAD and TAIL. START is the index of the image glyph in
21206 row area AREA of glyph row ROW. END is the index of the last glyph
21207 in that glyph row area. X is the current output position assigned
21208 to the new glyph string constructed. HL overrides that face of the
21209 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21210 is the right-most x-position of the drawing area. */
21212 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21215 s = (struct glyph_string *) alloca (sizeof *s); \
21216 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21217 fill_image_glyph_string (s); \
21218 append_glyph_string (&HEAD, &TAIL, s); \
21225 /* Add a glyph string for a sequence of character glyphs to the list
21226 of strings between HEAD and TAIL. START is the index of the first
21227 glyph in row area AREA of glyph row ROW that is part of the new
21228 glyph string. END is the index of the last glyph in that glyph row
21229 area. X is the current output position assigned to the new glyph
21230 string constructed. HL overrides that face of the glyph; e.g. it
21231 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21232 right-most x-position of the drawing area. */
21234 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21240 face_id = (row)->glyphs[area][START].face_id; \
21242 s = (struct glyph_string *) alloca (sizeof *s); \
21243 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21244 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21245 append_glyph_string (&HEAD, &TAIL, s); \
21247 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21252 /* Add a glyph string for a composite sequence to the list of strings
21253 between HEAD and TAIL. START is the index of the first glyph in
21254 row area AREA of glyph row ROW that is part of the new glyph
21255 string. END is the index of the last glyph in that glyph row area.
21256 X is the current output position assigned to the new glyph string
21257 constructed. HL overrides that face of the glyph; e.g. it is
21258 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21259 x-position of the drawing area. */
21261 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21263 int face_id = (row)->glyphs[area][START].face_id; \
21264 struct face *base_face = FACE_FROM_ID (f, face_id); \
21265 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21266 struct composition *cmp = composition_table[cmp_id]; \
21268 struct glyph_string *first_s IF_LINT (= NULL); \
21271 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21273 /* Make glyph_strings for each glyph sequence that is drawable by \
21274 the same face, and append them to HEAD/TAIL. */ \
21275 for (n = 0; n < cmp->glyph_len;) \
21277 s = (struct glyph_string *) alloca (sizeof *s); \
21278 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21279 append_glyph_string (&(HEAD), &(TAIL), s); \
21285 n = fill_composite_glyph_string (s, base_face, overlaps); \
21293 /* Add a glyph string for a glyph-string sequence to the list of strings
21294 between HEAD and TAIL. */
21296 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21300 Lisp_Object gstring; \
21302 face_id = (row)->glyphs[area][START].face_id; \
21303 gstring = (composition_gstring_from_id \
21304 ((row)->glyphs[area][START].u.cmp.id)); \
21305 s = (struct glyph_string *) alloca (sizeof *s); \
21306 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21307 * LGSTRING_GLYPH_LEN (gstring)); \
21308 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21309 append_glyph_string (&(HEAD), &(TAIL), s); \
21311 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21315 /* Add a glyph string for a sequence of glyphless character's glyphs
21316 to the list of strings between HEAD and TAIL. The meanings of
21317 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21319 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21324 face_id = (row)->glyphs[area][START].face_id; \
21326 s = (struct glyph_string *) alloca (sizeof *s); \
21327 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21328 append_glyph_string (&HEAD, &TAIL, s); \
21330 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21336 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21337 of AREA of glyph row ROW on window W between indices START and END.
21338 HL overrides the face for drawing glyph strings, e.g. it is
21339 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21340 x-positions of the drawing area.
21342 This is an ugly monster macro construct because we must use alloca
21343 to allocate glyph strings (because draw_glyphs can be called
21344 asynchronously). */
21346 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21349 HEAD = TAIL = NULL; \
21350 while (START < END) \
21352 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21353 switch (first_glyph->type) \
21356 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21360 case COMPOSITE_GLYPH: \
21361 if (first_glyph->u.cmp.automatic) \
21362 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21365 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21369 case STRETCH_GLYPH: \
21370 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21374 case IMAGE_GLYPH: \
21375 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21379 case GLYPHLESS_GLYPH: \
21380 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21390 set_glyph_string_background_width (s, START, LAST_X); \
21397 /* Draw glyphs between START and END in AREA of ROW on window W,
21398 starting at x-position X. X is relative to AREA in W. HL is a
21399 face-override with the following meaning:
21401 DRAW_NORMAL_TEXT draw normally
21402 DRAW_CURSOR draw in cursor face
21403 DRAW_MOUSE_FACE draw in mouse face.
21404 DRAW_INVERSE_VIDEO draw in mode line face
21405 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21406 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21408 If OVERLAPS is non-zero, draw only the foreground of characters and
21409 clip to the physical height of ROW. Non-zero value also defines
21410 the overlapping part to be drawn:
21412 OVERLAPS_PRED overlap with preceding rows
21413 OVERLAPS_SUCC overlap with succeeding rows
21414 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21415 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21417 Value is the x-position reached, relative to AREA of W. */
21420 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21421 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21422 enum draw_glyphs_face hl
, int overlaps
)
21424 struct glyph_string
*head
, *tail
;
21425 struct glyph_string
*s
;
21426 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21427 int i
, j
, x_reached
, last_x
, area_left
= 0;
21428 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21431 ALLOCATE_HDC (hdc
, f
);
21433 /* Let's rather be paranoid than getting a SEGV. */
21434 end
= min (end
, row
->used
[area
]);
21435 start
= max (0, start
);
21436 start
= min (end
, start
);
21438 /* Translate X to frame coordinates. Set last_x to the right
21439 end of the drawing area. */
21440 if (row
->full_width_p
)
21442 /* X is relative to the left edge of W, without scroll bars
21444 area_left
= WINDOW_LEFT_EDGE_X (w
);
21445 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21449 area_left
= window_box_left (w
, area
);
21450 last_x
= area_left
+ window_box_width (w
, area
);
21454 /* Build a doubly-linked list of glyph_string structures between
21455 head and tail from what we have to draw. Note that the macro
21456 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21457 the reason we use a separate variable `i'. */
21459 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21461 x_reached
= tail
->x
+ tail
->background_width
;
21465 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21466 the row, redraw some glyphs in front or following the glyph
21467 strings built above. */
21468 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21470 struct glyph_string
*h
, *t
;
21471 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21472 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21473 int check_mouse_face
= 0;
21476 /* If mouse highlighting is on, we may need to draw adjacent
21477 glyphs using mouse-face highlighting. */
21478 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21480 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21482 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21483 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21485 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21487 check_mouse_face
= 1;
21488 mouse_beg_col
= (row
== mouse_beg_row
)
21489 ? hlinfo
->mouse_face_beg_col
: 0;
21490 mouse_end_col
= (row
== mouse_end_row
)
21491 ? hlinfo
->mouse_face_end_col
21492 : row
->used
[TEXT_AREA
];
21496 /* Compute overhangs for all glyph strings. */
21497 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21498 for (s
= head
; s
; s
= s
->next
)
21499 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21501 /* Prepend glyph strings for glyphs in front of the first glyph
21502 string that are overwritten because of the first glyph
21503 string's left overhang. The background of all strings
21504 prepended must be drawn because the first glyph string
21506 i
= left_overwritten (head
);
21509 enum draw_glyphs_face overlap_hl
;
21511 /* If this row contains mouse highlighting, attempt to draw
21512 the overlapped glyphs with the correct highlight. This
21513 code fails if the overlap encompasses more than one glyph
21514 and mouse-highlight spans only some of these glyphs.
21515 However, making it work perfectly involves a lot more
21516 code, and I don't know if the pathological case occurs in
21517 practice, so we'll stick to this for now. --- cyd */
21518 if (check_mouse_face
21519 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21520 overlap_hl
= DRAW_MOUSE_FACE
;
21522 overlap_hl
= DRAW_NORMAL_TEXT
;
21525 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21526 overlap_hl
, dummy_x
, last_x
);
21528 compute_overhangs_and_x (t
, head
->x
, 1);
21529 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21533 /* Prepend glyph strings for glyphs in front of the first glyph
21534 string that overwrite that glyph string because of their
21535 right overhang. For these strings, only the foreground must
21536 be drawn, because it draws over the glyph string at `head'.
21537 The background must not be drawn because this would overwrite
21538 right overhangs of preceding glyphs for which no glyph
21540 i
= left_overwriting (head
);
21543 enum draw_glyphs_face overlap_hl
;
21545 if (check_mouse_face
21546 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21547 overlap_hl
= DRAW_MOUSE_FACE
;
21549 overlap_hl
= DRAW_NORMAL_TEXT
;
21552 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21553 overlap_hl
, dummy_x
, last_x
);
21554 for (s
= h
; s
; s
= s
->next
)
21555 s
->background_filled_p
= 1;
21556 compute_overhangs_and_x (t
, head
->x
, 1);
21557 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21560 /* Append glyphs strings for glyphs following the last glyph
21561 string tail that are overwritten by tail. The background of
21562 these strings has to be drawn because tail's foreground draws
21564 i
= right_overwritten (tail
);
21567 enum draw_glyphs_face overlap_hl
;
21569 if (check_mouse_face
21570 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21571 overlap_hl
= DRAW_MOUSE_FACE
;
21573 overlap_hl
= DRAW_NORMAL_TEXT
;
21575 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21576 overlap_hl
, x
, last_x
);
21577 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21578 we don't have `end = i;' here. */
21579 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21580 append_glyph_string_lists (&head
, &tail
, h
, t
);
21584 /* Append glyph strings for glyphs following the last glyph
21585 string tail that overwrite tail. The foreground of such
21586 glyphs has to be drawn because it writes into the background
21587 of tail. The background must not be drawn because it could
21588 paint over the foreground of following glyphs. */
21589 i
= right_overwriting (tail
);
21592 enum draw_glyphs_face overlap_hl
;
21593 if (check_mouse_face
21594 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21595 overlap_hl
= DRAW_MOUSE_FACE
;
21597 overlap_hl
= DRAW_NORMAL_TEXT
;
21600 i
++; /* We must include the Ith glyph. */
21601 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21602 overlap_hl
, x
, last_x
);
21603 for (s
= h
; s
; s
= s
->next
)
21604 s
->background_filled_p
= 1;
21605 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21606 append_glyph_string_lists (&head
, &tail
, h
, t
);
21608 if (clip_head
|| clip_tail
)
21609 for (s
= head
; s
; s
= s
->next
)
21611 s
->clip_head
= clip_head
;
21612 s
->clip_tail
= clip_tail
;
21616 /* Draw all strings. */
21617 for (s
= head
; s
; s
= s
->next
)
21618 FRAME_RIF (f
)->draw_glyph_string (s
);
21621 /* When focus a sole frame and move horizontally, this sets on_p to 0
21622 causing a failure to erase prev cursor position. */
21623 if (area
== TEXT_AREA
21624 && !row
->full_width_p
21625 /* When drawing overlapping rows, only the glyph strings'
21626 foreground is drawn, which doesn't erase a cursor
21630 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21631 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21632 : (tail
? tail
->x
+ tail
->background_width
: x
));
21636 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21637 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21641 /* Value is the x-position up to which drawn, relative to AREA of W.
21642 This doesn't include parts drawn because of overhangs. */
21643 if (row
->full_width_p
)
21644 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21646 x_reached
-= area_left
;
21648 RELEASE_HDC (hdc
, f
);
21653 /* Expand row matrix if too narrow. Don't expand if area
21656 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21658 if (!fonts_changed_p \
21659 && (it->glyph_row->glyphs[area] \
21660 < it->glyph_row->glyphs[area + 1])) \
21662 it->w->ncols_scale_factor++; \
21663 fonts_changed_p = 1; \
21667 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21668 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21671 append_glyph (struct it
*it
)
21673 struct glyph
*glyph
;
21674 enum glyph_row_area area
= it
->area
;
21676 xassert (it
->glyph_row
);
21677 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21679 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21680 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21682 /* If the glyph row is reversed, we need to prepend the glyph
21683 rather than append it. */
21684 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21688 /* Make room for the additional glyph. */
21689 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21691 glyph
= it
->glyph_row
->glyphs
[area
];
21693 glyph
->charpos
= CHARPOS (it
->position
);
21694 glyph
->object
= it
->object
;
21695 if (it
->pixel_width
> 0)
21697 glyph
->pixel_width
= it
->pixel_width
;
21698 glyph
->padding_p
= 0;
21702 /* Assure at least 1-pixel width. Otherwise, cursor can't
21703 be displayed correctly. */
21704 glyph
->pixel_width
= 1;
21705 glyph
->padding_p
= 1;
21707 glyph
->ascent
= it
->ascent
;
21708 glyph
->descent
= it
->descent
;
21709 glyph
->voffset
= it
->voffset
;
21710 glyph
->type
= CHAR_GLYPH
;
21711 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21712 glyph
->multibyte_p
= it
->multibyte_p
;
21713 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21714 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21715 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21716 || it
->phys_descent
> it
->descent
);
21717 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21718 glyph
->face_id
= it
->face_id
;
21719 glyph
->u
.ch
= it
->char_to_display
;
21720 glyph
->slice
.img
= null_glyph_slice
;
21721 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21724 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21725 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21727 glyph
->bidi_type
= it
->bidi_it
.type
;
21731 glyph
->resolved_level
= 0;
21732 glyph
->bidi_type
= UNKNOWN_BT
;
21734 ++it
->glyph_row
->used
[area
];
21737 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21740 /* Store one glyph for the composition IT->cmp_it.id in
21741 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21745 append_composite_glyph (struct it
*it
)
21747 struct glyph
*glyph
;
21748 enum glyph_row_area area
= it
->area
;
21750 xassert (it
->glyph_row
);
21752 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21753 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21755 /* If the glyph row is reversed, we need to prepend the glyph
21756 rather than append it. */
21757 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21761 /* Make room for the new glyph. */
21762 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21764 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21766 glyph
->charpos
= it
->cmp_it
.charpos
;
21767 glyph
->object
= it
->object
;
21768 glyph
->pixel_width
= it
->pixel_width
;
21769 glyph
->ascent
= it
->ascent
;
21770 glyph
->descent
= it
->descent
;
21771 glyph
->voffset
= it
->voffset
;
21772 glyph
->type
= COMPOSITE_GLYPH
;
21773 if (it
->cmp_it
.ch
< 0)
21775 glyph
->u
.cmp
.automatic
= 0;
21776 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21777 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21781 glyph
->u
.cmp
.automatic
= 1;
21782 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21783 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21784 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21786 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21787 glyph
->multibyte_p
= it
->multibyte_p
;
21788 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21789 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21790 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21791 || it
->phys_descent
> it
->descent
);
21792 glyph
->padding_p
= 0;
21793 glyph
->glyph_not_available_p
= 0;
21794 glyph
->face_id
= it
->face_id
;
21795 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21798 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21799 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21801 glyph
->bidi_type
= it
->bidi_it
.type
;
21803 ++it
->glyph_row
->used
[area
];
21806 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21810 /* Change IT->ascent and IT->height according to the setting of
21814 take_vertical_position_into_account (struct it
*it
)
21818 if (it
->voffset
< 0)
21819 /* Increase the ascent so that we can display the text higher
21821 it
->ascent
-= it
->voffset
;
21823 /* Increase the descent so that we can display the text lower
21825 it
->descent
+= it
->voffset
;
21830 /* Produce glyphs/get display metrics for the image IT is loaded with.
21831 See the description of struct display_iterator in dispextern.h for
21832 an overview of struct display_iterator. */
21835 produce_image_glyph (struct it
*it
)
21839 int glyph_ascent
, crop
;
21840 struct glyph_slice slice
;
21842 xassert (it
->what
== IT_IMAGE
);
21844 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21846 /* Make sure X resources of the face is loaded. */
21847 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21849 if (it
->image_id
< 0)
21851 /* Fringe bitmap. */
21852 it
->ascent
= it
->phys_ascent
= 0;
21853 it
->descent
= it
->phys_descent
= 0;
21854 it
->pixel_width
= 0;
21859 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21861 /* Make sure X resources of the image is loaded. */
21862 prepare_image_for_display (it
->f
, img
);
21864 slice
.x
= slice
.y
= 0;
21865 slice
.width
= img
->width
;
21866 slice
.height
= img
->height
;
21868 if (INTEGERP (it
->slice
.x
))
21869 slice
.x
= XINT (it
->slice
.x
);
21870 else if (FLOATP (it
->slice
.x
))
21871 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21873 if (INTEGERP (it
->slice
.y
))
21874 slice
.y
= XINT (it
->slice
.y
);
21875 else if (FLOATP (it
->slice
.y
))
21876 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21878 if (INTEGERP (it
->slice
.width
))
21879 slice
.width
= XINT (it
->slice
.width
);
21880 else if (FLOATP (it
->slice
.width
))
21881 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21883 if (INTEGERP (it
->slice
.height
))
21884 slice
.height
= XINT (it
->slice
.height
);
21885 else if (FLOATP (it
->slice
.height
))
21886 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21888 if (slice
.x
>= img
->width
)
21889 slice
.x
= img
->width
;
21890 if (slice
.y
>= img
->height
)
21891 slice
.y
= img
->height
;
21892 if (slice
.x
+ slice
.width
>= img
->width
)
21893 slice
.width
= img
->width
- slice
.x
;
21894 if (slice
.y
+ slice
.height
> img
->height
)
21895 slice
.height
= img
->height
- slice
.y
;
21897 if (slice
.width
== 0 || slice
.height
== 0)
21900 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21902 it
->descent
= slice
.height
- glyph_ascent
;
21904 it
->descent
+= img
->vmargin
;
21905 if (slice
.y
+ slice
.height
== img
->height
)
21906 it
->descent
+= img
->vmargin
;
21907 it
->phys_descent
= it
->descent
;
21909 it
->pixel_width
= slice
.width
;
21911 it
->pixel_width
+= img
->hmargin
;
21912 if (slice
.x
+ slice
.width
== img
->width
)
21913 it
->pixel_width
+= img
->hmargin
;
21915 /* It's quite possible for images to have an ascent greater than
21916 their height, so don't get confused in that case. */
21917 if (it
->descent
< 0)
21922 if (face
->box
!= FACE_NO_BOX
)
21924 if (face
->box_line_width
> 0)
21927 it
->ascent
+= face
->box_line_width
;
21928 if (slice
.y
+ slice
.height
== img
->height
)
21929 it
->descent
+= face
->box_line_width
;
21932 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21933 it
->pixel_width
+= eabs (face
->box_line_width
);
21934 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21935 it
->pixel_width
+= eabs (face
->box_line_width
);
21938 take_vertical_position_into_account (it
);
21940 /* Automatically crop wide image glyphs at right edge so we can
21941 draw the cursor on same display row. */
21942 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21943 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21945 it
->pixel_width
-= crop
;
21946 slice
.width
-= crop
;
21951 struct glyph
*glyph
;
21952 enum glyph_row_area area
= it
->area
;
21954 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21955 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21957 glyph
->charpos
= CHARPOS (it
->position
);
21958 glyph
->object
= it
->object
;
21959 glyph
->pixel_width
= it
->pixel_width
;
21960 glyph
->ascent
= glyph_ascent
;
21961 glyph
->descent
= it
->descent
;
21962 glyph
->voffset
= it
->voffset
;
21963 glyph
->type
= IMAGE_GLYPH
;
21964 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21965 glyph
->multibyte_p
= it
->multibyte_p
;
21966 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21967 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21968 glyph
->overlaps_vertically_p
= 0;
21969 glyph
->padding_p
= 0;
21970 glyph
->glyph_not_available_p
= 0;
21971 glyph
->face_id
= it
->face_id
;
21972 glyph
->u
.img_id
= img
->id
;
21973 glyph
->slice
.img
= slice
;
21974 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21977 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21978 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21980 glyph
->bidi_type
= it
->bidi_it
.type
;
21982 ++it
->glyph_row
->used
[area
];
21985 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21990 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21991 of the glyph, WIDTH and HEIGHT are the width and height of the
21992 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21995 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21996 int width
, int height
, int ascent
)
21998 struct glyph
*glyph
;
21999 enum glyph_row_area area
= it
->area
;
22001 xassert (ascent
>= 0 && ascent
<= height
);
22003 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22004 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22006 /* If the glyph row is reversed, we need to prepend the glyph
22007 rather than append it. */
22008 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22012 /* Make room for the additional glyph. */
22013 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22015 glyph
= it
->glyph_row
->glyphs
[area
];
22017 glyph
->charpos
= CHARPOS (it
->position
);
22018 glyph
->object
= object
;
22019 glyph
->pixel_width
= width
;
22020 glyph
->ascent
= ascent
;
22021 glyph
->descent
= height
- ascent
;
22022 glyph
->voffset
= it
->voffset
;
22023 glyph
->type
= STRETCH_GLYPH
;
22024 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22025 glyph
->multibyte_p
= it
->multibyte_p
;
22026 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22027 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22028 glyph
->overlaps_vertically_p
= 0;
22029 glyph
->padding_p
= 0;
22030 glyph
->glyph_not_available_p
= 0;
22031 glyph
->face_id
= it
->face_id
;
22032 glyph
->u
.stretch
.ascent
= ascent
;
22033 glyph
->u
.stretch
.height
= height
;
22034 glyph
->slice
.img
= null_glyph_slice
;
22035 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22038 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22039 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22041 glyph
->bidi_type
= it
->bidi_it
.type
;
22045 glyph
->resolved_level
= 0;
22046 glyph
->bidi_type
= UNKNOWN_BT
;
22048 ++it
->glyph_row
->used
[area
];
22051 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22055 /* Produce a stretch glyph for iterator IT. IT->object is the value
22056 of the glyph property displayed. The value must be a list
22057 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22060 1. `:width WIDTH' specifies that the space should be WIDTH *
22061 canonical char width wide. WIDTH may be an integer or floating
22064 2. `:relative-width FACTOR' specifies that the width of the stretch
22065 should be computed from the width of the first character having the
22066 `glyph' property, and should be FACTOR times that width.
22068 3. `:align-to HPOS' specifies that the space should be wide enough
22069 to reach HPOS, a value in canonical character units.
22071 Exactly one of the above pairs must be present.
22073 4. `:height HEIGHT' specifies that the height of the stretch produced
22074 should be HEIGHT, measured in canonical character units.
22076 5. `:relative-height FACTOR' specifies that the height of the
22077 stretch should be FACTOR times the height of the characters having
22078 the glyph property.
22080 Either none or exactly one of 4 or 5 must be present.
22082 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22083 of the stretch should be used for the ascent of the stretch.
22084 ASCENT must be in the range 0 <= ASCENT <= 100. */
22087 produce_stretch_glyph (struct it
*it
)
22089 /* (space :width WIDTH :height HEIGHT ...) */
22090 Lisp_Object prop
, plist
;
22091 int width
= 0, height
= 0, align_to
= -1;
22092 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22095 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22096 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22098 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22100 /* List should start with `space'. */
22101 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22102 plist
= XCDR (it
->object
);
22104 /* Compute the width of the stretch. */
22105 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22106 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22108 /* Absolute width `:width WIDTH' specified and valid. */
22109 zero_width_ok_p
= 1;
22112 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22115 /* Relative width `:relative-width FACTOR' specified and valid.
22116 Compute the width of the characters having the `glyph'
22119 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22122 if (it
->multibyte_p
)
22123 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22126 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22127 if (! ASCII_CHAR_P (it2
.c
))
22128 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22131 it2
.glyph_row
= NULL
;
22132 it2
.what
= IT_CHARACTER
;
22133 x_produce_glyphs (&it2
);
22134 width
= NUMVAL (prop
) * it2
.pixel_width
;
22136 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22137 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22139 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22140 align_to
= (align_to
< 0
22142 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22143 else if (align_to
< 0)
22144 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22145 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22146 zero_width_ok_p
= 1;
22149 /* Nothing specified -> width defaults to canonical char width. */
22150 width
= FRAME_COLUMN_WIDTH (it
->f
);
22152 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22155 /* Compute height. */
22156 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22157 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22160 zero_height_ok_p
= 1;
22162 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22164 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22166 height
= FONT_HEIGHT (font
);
22168 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22171 /* Compute percentage of height used for ascent. If
22172 `:ascent ASCENT' is present and valid, use that. Otherwise,
22173 derive the ascent from the font in use. */
22174 if (prop
= Fplist_get (plist
, QCascent
),
22175 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22176 ascent
= height
* NUMVAL (prop
) / 100.0;
22177 else if (!NILP (prop
)
22178 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22179 ascent
= min (max (0, (int)tem
), height
);
22181 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22183 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22184 && it
->current_x
+ width
> it
->last_visible_x
)
22185 width
= it
->last_visible_x
- it
->current_x
- 1;
22187 if (width
> 0 && height
> 0 && it
->glyph_row
)
22189 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22190 if (!STRINGP (object
))
22191 object
= it
->w
->buffer
;
22192 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22195 it
->pixel_width
= width
;
22196 it
->ascent
= it
->phys_ascent
= ascent
;
22197 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22198 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22200 take_vertical_position_into_account (it
);
22203 /* Calculate line-height and line-spacing properties.
22204 An integer value specifies explicit pixel value.
22205 A float value specifies relative value to current face height.
22206 A cons (float . face-name) specifies relative value to
22207 height of specified face font.
22209 Returns height in pixels, or nil. */
22213 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22214 int boff
, int override
)
22216 Lisp_Object face_name
= Qnil
;
22217 int ascent
, descent
, height
;
22219 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22224 face_name
= XCAR (val
);
22226 if (!NUMBERP (val
))
22227 val
= make_number (1);
22228 if (NILP (face_name
))
22230 height
= it
->ascent
+ it
->descent
;
22235 if (NILP (face_name
))
22237 font
= FRAME_FONT (it
->f
);
22238 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22240 else if (EQ (face_name
, Qt
))
22249 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22251 return make_number (-1);
22253 face
= FACE_FROM_ID (it
->f
, face_id
);
22256 return make_number (-1);
22257 boff
= font
->baseline_offset
;
22258 if (font
->vertical_centering
)
22259 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22262 ascent
= FONT_BASE (font
) + boff
;
22263 descent
= FONT_DESCENT (font
) - boff
;
22267 it
->override_ascent
= ascent
;
22268 it
->override_descent
= descent
;
22269 it
->override_boff
= boff
;
22272 height
= ascent
+ descent
;
22276 height
= (int)(XFLOAT_DATA (val
) * height
);
22277 else if (INTEGERP (val
))
22278 height
*= XINT (val
);
22280 return make_number (height
);
22284 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22285 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22286 and only if this is for a character for which no font was found.
22288 If the display method (it->glyphless_method) is
22289 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22290 length of the acronym or the hexadecimal string, UPPER_XOFF and
22291 UPPER_YOFF are pixel offsets for the upper part of the string,
22292 LOWER_XOFF and LOWER_YOFF are for the lower part.
22294 For the other display methods, LEN through LOWER_YOFF are zero. */
22297 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22298 short upper_xoff
, short upper_yoff
,
22299 short lower_xoff
, short lower_yoff
)
22301 struct glyph
*glyph
;
22302 enum glyph_row_area area
= it
->area
;
22304 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22305 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22307 /* If the glyph row is reversed, we need to prepend the glyph
22308 rather than append it. */
22309 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22313 /* Make room for the additional glyph. */
22314 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22316 glyph
= it
->glyph_row
->glyphs
[area
];
22318 glyph
->charpos
= CHARPOS (it
->position
);
22319 glyph
->object
= it
->object
;
22320 glyph
->pixel_width
= it
->pixel_width
;
22321 glyph
->ascent
= it
->ascent
;
22322 glyph
->descent
= it
->descent
;
22323 glyph
->voffset
= it
->voffset
;
22324 glyph
->type
= GLYPHLESS_GLYPH
;
22325 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22326 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22327 glyph
->u
.glyphless
.len
= len
;
22328 glyph
->u
.glyphless
.ch
= it
->c
;
22329 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22330 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22331 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22332 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22333 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22334 glyph
->multibyte_p
= it
->multibyte_p
;
22335 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22336 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22337 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22338 || it
->phys_descent
> it
->descent
);
22339 glyph
->padding_p
= 0;
22340 glyph
->glyph_not_available_p
= 0;
22341 glyph
->face_id
= face_id
;
22342 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22345 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22346 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22348 glyph
->bidi_type
= it
->bidi_it
.type
;
22350 ++it
->glyph_row
->used
[area
];
22353 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22357 /* Produce a glyph for a glyphless character for iterator IT.
22358 IT->glyphless_method specifies which method to use for displaying
22359 the character. See the description of enum
22360 glyphless_display_method in dispextern.h for the detail.
22362 FOR_NO_FONT is nonzero if and only if this is for a character for
22363 which no font was found. ACRONYM, if non-nil, is an acronym string
22364 for the character. */
22367 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22372 int base_width
, base_height
, width
, height
;
22373 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22376 /* Get the metrics of the base font. We always refer to the current
22378 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22379 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22380 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22381 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22382 base_height
= it
->ascent
+ it
->descent
;
22383 base_width
= font
->average_width
;
22385 /* Get a face ID for the glyph by utilizing a cache (the same way as
22386 doen for `escape-glyph' in get_next_display_element). */
22387 if (it
->f
== last_glyphless_glyph_frame
22388 && it
->face_id
== last_glyphless_glyph_face_id
)
22390 face_id
= last_glyphless_glyph_merged_face_id
;
22394 /* Merge the `glyphless-char' face into the current face. */
22395 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22396 last_glyphless_glyph_frame
= it
->f
;
22397 last_glyphless_glyph_face_id
= it
->face_id
;
22398 last_glyphless_glyph_merged_face_id
= face_id
;
22401 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22403 it
->pixel_width
= THIN_SPACE_WIDTH
;
22405 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22407 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22409 width
= CHAR_WIDTH (it
->c
);
22412 else if (width
> 4)
22414 it
->pixel_width
= base_width
* width
;
22416 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22422 unsigned int code
[6];
22424 int ascent
, descent
;
22425 struct font_metrics metrics_upper
, metrics_lower
;
22427 face
= FACE_FROM_ID (it
->f
, face_id
);
22428 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22429 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22431 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22433 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22434 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22435 if (CONSP (acronym
))
22436 acronym
= XCAR (acronym
);
22437 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22441 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22442 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22445 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22446 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22447 upper_len
= (len
+ 1) / 2;
22448 font
->driver
->text_extents (font
, code
, upper_len
,
22450 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22455 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22456 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22457 upper_xoff
= upper_yoff
= 2; /* the typical case */
22458 if (base_width
>= width
)
22460 /* Align the upper to the left, the lower to the right. */
22461 it
->pixel_width
= base_width
;
22462 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22466 /* Center the shorter one. */
22467 it
->pixel_width
= width
;
22468 if (metrics_upper
.width
>= metrics_lower
.width
)
22469 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22472 /* FIXME: This code doesn't look right. It formerly was
22473 missing the "lower_xoff = 0;", which couldn't have
22474 been right since it left lower_xoff uninitialized. */
22476 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22480 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22481 top, bottom, and between upper and lower strings. */
22482 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22483 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22484 /* Center vertically.
22485 H:base_height, D:base_descent
22486 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22488 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22489 descent = D - H/2 + h/2;
22490 lower_yoff = descent - 2 - ld;
22491 upper_yoff = lower_yoff - la - 1 - ud; */
22492 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22493 descent
= it
->descent
- (base_height
- height
) / 2;
22494 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22495 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22496 - metrics_upper
.descent
);
22497 /* Don't make the height shorter than the base height. */
22498 if (height
> base_height
)
22500 it
->ascent
= ascent
;
22501 it
->descent
= descent
;
22505 it
->phys_ascent
= it
->ascent
;
22506 it
->phys_descent
= it
->descent
;
22508 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22509 upper_xoff
, upper_yoff
,
22510 lower_xoff
, lower_yoff
);
22512 take_vertical_position_into_account (it
);
22517 Produce glyphs/get display metrics for the display element IT is
22518 loaded with. See the description of struct it in dispextern.h
22519 for an overview of struct it. */
22522 x_produce_glyphs (struct it
*it
)
22524 int extra_line_spacing
= it
->extra_line_spacing
;
22526 it
->glyph_not_available_p
= 0;
22528 if (it
->what
== IT_CHARACTER
)
22531 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22532 struct font
*font
= face
->font
;
22533 struct font_metrics
*pcm
= NULL
;
22534 int boff
; /* baseline offset */
22538 /* When no suitable font is found, display this character by
22539 the method specified in the first extra slot of
22540 Vglyphless_char_display. */
22541 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22543 xassert (it
->what
== IT_GLYPHLESS
);
22544 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22548 boff
= font
->baseline_offset
;
22549 if (font
->vertical_centering
)
22550 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22552 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22558 if (it
->override_ascent
>= 0)
22560 it
->ascent
= it
->override_ascent
;
22561 it
->descent
= it
->override_descent
;
22562 boff
= it
->override_boff
;
22566 it
->ascent
= FONT_BASE (font
) + boff
;
22567 it
->descent
= FONT_DESCENT (font
) - boff
;
22570 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22572 pcm
= get_per_char_metric (font
, &char2b
);
22573 if (pcm
->width
== 0
22574 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22580 it
->phys_ascent
= pcm
->ascent
+ boff
;
22581 it
->phys_descent
= pcm
->descent
- boff
;
22582 it
->pixel_width
= pcm
->width
;
22586 it
->glyph_not_available_p
= 1;
22587 it
->phys_ascent
= it
->ascent
;
22588 it
->phys_descent
= it
->descent
;
22589 it
->pixel_width
= font
->space_width
;
22592 if (it
->constrain_row_ascent_descent_p
)
22594 if (it
->descent
> it
->max_descent
)
22596 it
->ascent
+= it
->descent
- it
->max_descent
;
22597 it
->descent
= it
->max_descent
;
22599 if (it
->ascent
> it
->max_ascent
)
22601 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22602 it
->ascent
= it
->max_ascent
;
22604 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22605 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22606 extra_line_spacing
= 0;
22609 /* If this is a space inside a region of text with
22610 `space-width' property, change its width. */
22611 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22613 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22615 /* If face has a box, add the box thickness to the character
22616 height. If character has a box line to the left and/or
22617 right, add the box line width to the character's width. */
22618 if (face
->box
!= FACE_NO_BOX
)
22620 int thick
= face
->box_line_width
;
22624 it
->ascent
+= thick
;
22625 it
->descent
+= thick
;
22630 if (it
->start_of_box_run_p
)
22631 it
->pixel_width
+= thick
;
22632 if (it
->end_of_box_run_p
)
22633 it
->pixel_width
+= thick
;
22636 /* If face has an overline, add the height of the overline
22637 (1 pixel) and a 1 pixel margin to the character height. */
22638 if (face
->overline_p
)
22639 it
->ascent
+= overline_margin
;
22641 if (it
->constrain_row_ascent_descent_p
)
22643 if (it
->ascent
> it
->max_ascent
)
22644 it
->ascent
= it
->max_ascent
;
22645 if (it
->descent
> it
->max_descent
)
22646 it
->descent
= it
->max_descent
;
22649 take_vertical_position_into_account (it
);
22651 /* If we have to actually produce glyphs, do it. */
22656 /* Translate a space with a `space-width' property
22657 into a stretch glyph. */
22658 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22659 / FONT_HEIGHT (font
));
22660 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22661 it
->ascent
+ it
->descent
, ascent
);
22666 /* If characters with lbearing or rbearing are displayed
22667 in this line, record that fact in a flag of the
22668 glyph row. This is used to optimize X output code. */
22669 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22670 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22672 if (! stretched_p
&& it
->pixel_width
== 0)
22673 /* We assure that all visible glyphs have at least 1-pixel
22675 it
->pixel_width
= 1;
22677 else if (it
->char_to_display
== '\n')
22679 /* A newline has no width, but we need the height of the
22680 line. But if previous part of the line sets a height,
22681 don't increase that height */
22683 Lisp_Object height
;
22684 Lisp_Object total_height
= Qnil
;
22686 it
->override_ascent
= -1;
22687 it
->pixel_width
= 0;
22690 height
= get_it_property (it
, Qline_height
);
22691 /* Split (line-height total-height) list */
22693 && CONSP (XCDR (height
))
22694 && NILP (XCDR (XCDR (height
))))
22696 total_height
= XCAR (XCDR (height
));
22697 height
= XCAR (height
);
22699 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22701 if (it
->override_ascent
>= 0)
22703 it
->ascent
= it
->override_ascent
;
22704 it
->descent
= it
->override_descent
;
22705 boff
= it
->override_boff
;
22709 it
->ascent
= FONT_BASE (font
) + boff
;
22710 it
->descent
= FONT_DESCENT (font
) - boff
;
22713 if (EQ (height
, Qt
))
22715 if (it
->descent
> it
->max_descent
)
22717 it
->ascent
+= it
->descent
- it
->max_descent
;
22718 it
->descent
= it
->max_descent
;
22720 if (it
->ascent
> it
->max_ascent
)
22722 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22723 it
->ascent
= it
->max_ascent
;
22725 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22726 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22727 it
->constrain_row_ascent_descent_p
= 1;
22728 extra_line_spacing
= 0;
22732 Lisp_Object spacing
;
22734 it
->phys_ascent
= it
->ascent
;
22735 it
->phys_descent
= it
->descent
;
22737 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22738 && face
->box
!= FACE_NO_BOX
22739 && face
->box_line_width
> 0)
22741 it
->ascent
+= face
->box_line_width
;
22742 it
->descent
+= face
->box_line_width
;
22745 && XINT (height
) > it
->ascent
+ it
->descent
)
22746 it
->ascent
= XINT (height
) - it
->descent
;
22748 if (!NILP (total_height
))
22749 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22752 spacing
= get_it_property (it
, Qline_spacing
);
22753 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22755 if (INTEGERP (spacing
))
22757 extra_line_spacing
= XINT (spacing
);
22758 if (!NILP (total_height
))
22759 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22763 else /* i.e. (it->char_to_display == '\t') */
22765 if (font
->space_width
> 0)
22767 int tab_width
= it
->tab_width
* font
->space_width
;
22768 int x
= it
->current_x
+ it
->continuation_lines_width
;
22769 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22771 /* If the distance from the current position to the next tab
22772 stop is less than a space character width, use the
22773 tab stop after that. */
22774 if (next_tab_x
- x
< font
->space_width
)
22775 next_tab_x
+= tab_width
;
22777 it
->pixel_width
= next_tab_x
- x
;
22779 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22780 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22784 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22785 it
->ascent
+ it
->descent
, it
->ascent
);
22790 it
->pixel_width
= 0;
22795 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22797 /* A static composition.
22799 Note: A composition is represented as one glyph in the
22800 glyph matrix. There are no padding glyphs.
22802 Important note: pixel_width, ascent, and descent are the
22803 values of what is drawn by draw_glyphs (i.e. the values of
22804 the overall glyphs composed). */
22805 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22806 int boff
; /* baseline offset */
22807 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22808 int glyph_len
= cmp
->glyph_len
;
22809 struct font
*font
= face
->font
;
22813 /* If we have not yet calculated pixel size data of glyphs of
22814 the composition for the current face font, calculate them
22815 now. Theoretically, we have to check all fonts for the
22816 glyphs, but that requires much time and memory space. So,
22817 here we check only the font of the first glyph. This may
22818 lead to incorrect display, but it's very rare, and C-l
22819 (recenter-top-bottom) can correct the display anyway. */
22820 if (! cmp
->font
|| cmp
->font
!= font
)
22822 /* Ascent and descent of the font of the first character
22823 of this composition (adjusted by baseline offset).
22824 Ascent and descent of overall glyphs should not be less
22825 than these, respectively. */
22826 int font_ascent
, font_descent
, font_height
;
22827 /* Bounding box of the overall glyphs. */
22828 int leftmost
, rightmost
, lowest
, highest
;
22829 int lbearing
, rbearing
;
22830 int i
, width
, ascent
, descent
;
22831 int left_padded
= 0, right_padded
= 0;
22832 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
22834 struct font_metrics
*pcm
;
22835 int font_not_found_p
;
22838 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22839 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22841 if (glyph_len
< cmp
->glyph_len
)
22843 for (i
= 0; i
< glyph_len
; i
++)
22845 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22847 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22852 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22853 : IT_CHARPOS (*it
));
22854 /* If no suitable font is found, use the default font. */
22855 font_not_found_p
= font
== NULL
;
22856 if (font_not_found_p
)
22858 face
= face
->ascii_face
;
22861 boff
= font
->baseline_offset
;
22862 if (font
->vertical_centering
)
22863 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22864 font_ascent
= FONT_BASE (font
) + boff
;
22865 font_descent
= FONT_DESCENT (font
) - boff
;
22866 font_height
= FONT_HEIGHT (font
);
22868 cmp
->font
= (void *) font
;
22871 if (! font_not_found_p
)
22873 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22875 pcm
= get_per_char_metric (font
, &char2b
);
22878 /* Initialize the bounding box. */
22881 width
= pcm
->width
;
22882 ascent
= pcm
->ascent
;
22883 descent
= pcm
->descent
;
22884 lbearing
= pcm
->lbearing
;
22885 rbearing
= pcm
->rbearing
;
22889 width
= font
->space_width
;
22890 ascent
= FONT_BASE (font
);
22891 descent
= FONT_DESCENT (font
);
22898 lowest
= - descent
+ boff
;
22899 highest
= ascent
+ boff
;
22901 if (! font_not_found_p
22902 && font
->default_ascent
22903 && CHAR_TABLE_P (Vuse_default_ascent
)
22904 && !NILP (Faref (Vuse_default_ascent
,
22905 make_number (it
->char_to_display
))))
22906 highest
= font
->default_ascent
+ boff
;
22908 /* Draw the first glyph at the normal position. It may be
22909 shifted to right later if some other glyphs are drawn
22911 cmp
->offsets
[i
* 2] = 0;
22912 cmp
->offsets
[i
* 2 + 1] = boff
;
22913 cmp
->lbearing
= lbearing
;
22914 cmp
->rbearing
= rbearing
;
22916 /* Set cmp->offsets for the remaining glyphs. */
22917 for (i
++; i
< glyph_len
; i
++)
22919 int left
, right
, btm
, top
;
22920 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22922 struct face
*this_face
;
22926 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22927 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22928 font
= this_face
->font
;
22934 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22936 pcm
= get_per_char_metric (font
, &char2b
);
22939 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22942 width
= pcm
->width
;
22943 ascent
= pcm
->ascent
;
22944 descent
= pcm
->descent
;
22945 lbearing
= pcm
->lbearing
;
22946 rbearing
= pcm
->rbearing
;
22947 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22949 /* Relative composition with or without
22950 alternate chars. */
22951 left
= (leftmost
+ rightmost
- width
) / 2;
22952 btm
= - descent
+ boff
;
22953 if (font
->relative_compose
22954 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22955 || NILP (Faref (Vignore_relative_composition
,
22956 make_number (ch
)))))
22959 if (- descent
>= font
->relative_compose
)
22960 /* One extra pixel between two glyphs. */
22962 else if (ascent
<= 0)
22963 /* One extra pixel between two glyphs. */
22964 btm
= lowest
- 1 - ascent
- descent
;
22969 /* A composition rule is specified by an integer
22970 value that encodes global and new reference
22971 points (GREF and NREF). GREF and NREF are
22972 specified by numbers as below:
22974 0---1---2 -- ascent
22978 9--10--11 -- center
22980 ---3---4---5--- baseline
22982 6---7---8 -- descent
22984 int rule
= COMPOSITION_RULE (cmp
, i
);
22985 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22987 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22988 grefx
= gref
% 3, nrefx
= nref
% 3;
22989 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22991 xoff
= font_height
* (xoff
- 128) / 256;
22993 yoff
= font_height
* (yoff
- 128) / 256;
22996 + grefx
* (rightmost
- leftmost
) / 2
22997 - nrefx
* width
/ 2
23000 btm
= ((grefy
== 0 ? highest
23002 : grefy
== 2 ? lowest
23003 : (highest
+ lowest
) / 2)
23004 - (nrefy
== 0 ? ascent
+ descent
23005 : nrefy
== 1 ? descent
- boff
23007 : (ascent
+ descent
) / 2)
23011 cmp
->offsets
[i
* 2] = left
;
23012 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23014 /* Update the bounding box of the overall glyphs. */
23017 right
= left
+ width
;
23018 if (left
< leftmost
)
23020 if (right
> rightmost
)
23023 top
= btm
+ descent
+ ascent
;
23029 if (cmp
->lbearing
> left
+ lbearing
)
23030 cmp
->lbearing
= left
+ lbearing
;
23031 if (cmp
->rbearing
< left
+ rbearing
)
23032 cmp
->rbearing
= left
+ rbearing
;
23036 /* If there are glyphs whose x-offsets are negative,
23037 shift all glyphs to the right and make all x-offsets
23041 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23042 cmp
->offsets
[i
* 2] -= leftmost
;
23043 rightmost
-= leftmost
;
23044 cmp
->lbearing
-= leftmost
;
23045 cmp
->rbearing
-= leftmost
;
23048 if (left_padded
&& cmp
->lbearing
< 0)
23050 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23051 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23052 rightmost
-= cmp
->lbearing
;
23053 cmp
->rbearing
-= cmp
->lbearing
;
23056 if (right_padded
&& rightmost
< cmp
->rbearing
)
23058 rightmost
= cmp
->rbearing
;
23061 cmp
->pixel_width
= rightmost
;
23062 cmp
->ascent
= highest
;
23063 cmp
->descent
= - lowest
;
23064 if (cmp
->ascent
< font_ascent
)
23065 cmp
->ascent
= font_ascent
;
23066 if (cmp
->descent
< font_descent
)
23067 cmp
->descent
= font_descent
;
23071 && (cmp
->lbearing
< 0
23072 || cmp
->rbearing
> cmp
->pixel_width
))
23073 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23075 it
->pixel_width
= cmp
->pixel_width
;
23076 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23077 it
->descent
= it
->phys_descent
= cmp
->descent
;
23078 if (face
->box
!= FACE_NO_BOX
)
23080 int thick
= face
->box_line_width
;
23084 it
->ascent
+= thick
;
23085 it
->descent
+= thick
;
23090 if (it
->start_of_box_run_p
)
23091 it
->pixel_width
+= thick
;
23092 if (it
->end_of_box_run_p
)
23093 it
->pixel_width
+= thick
;
23096 /* If face has an overline, add the height of the overline
23097 (1 pixel) and a 1 pixel margin to the character height. */
23098 if (face
->overline_p
)
23099 it
->ascent
+= overline_margin
;
23101 take_vertical_position_into_account (it
);
23102 if (it
->ascent
< 0)
23104 if (it
->descent
< 0)
23108 append_composite_glyph (it
);
23110 else if (it
->what
== IT_COMPOSITION
)
23112 /* A dynamic (automatic) composition. */
23113 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23114 Lisp_Object gstring
;
23115 struct font_metrics metrics
;
23117 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23119 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23122 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23123 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23124 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23125 it
->descent
= it
->phys_descent
= metrics
.descent
;
23126 if (face
->box
!= FACE_NO_BOX
)
23128 int thick
= face
->box_line_width
;
23132 it
->ascent
+= thick
;
23133 it
->descent
+= thick
;
23138 if (it
->start_of_box_run_p
)
23139 it
->pixel_width
+= thick
;
23140 if (it
->end_of_box_run_p
)
23141 it
->pixel_width
+= thick
;
23143 /* If face has an overline, add the height of the overline
23144 (1 pixel) and a 1 pixel margin to the character height. */
23145 if (face
->overline_p
)
23146 it
->ascent
+= overline_margin
;
23147 take_vertical_position_into_account (it
);
23148 if (it
->ascent
< 0)
23150 if (it
->descent
< 0)
23154 append_composite_glyph (it
);
23156 else if (it
->what
== IT_GLYPHLESS
)
23157 produce_glyphless_glyph (it
, 0, Qnil
);
23158 else if (it
->what
== IT_IMAGE
)
23159 produce_image_glyph (it
);
23160 else if (it
->what
== IT_STRETCH
)
23161 produce_stretch_glyph (it
);
23164 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23165 because this isn't true for images with `:ascent 100'. */
23166 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23167 if (it
->area
== TEXT_AREA
)
23168 it
->current_x
+= it
->pixel_width
;
23170 if (extra_line_spacing
> 0)
23172 it
->descent
+= extra_line_spacing
;
23173 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23174 it
->max_extra_line_spacing
= extra_line_spacing
;
23177 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23178 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23179 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23180 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23184 Output LEN glyphs starting at START at the nominal cursor position.
23185 Advance the nominal cursor over the text. The global variable
23186 updated_window contains the window being updated, updated_row is
23187 the glyph row being updated, and updated_area is the area of that
23188 row being updated. */
23191 x_write_glyphs (struct glyph
*start
, int len
)
23195 xassert (updated_window
&& updated_row
);
23198 /* Write glyphs. */
23200 hpos
= start
- updated_row
->glyphs
[updated_area
];
23201 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23202 updated_row
, updated_area
,
23204 DRAW_NORMAL_TEXT
, 0);
23206 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23207 if (updated_area
== TEXT_AREA
23208 && updated_window
->phys_cursor_on_p
23209 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23210 && updated_window
->phys_cursor
.hpos
>= hpos
23211 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23212 updated_window
->phys_cursor_on_p
= 0;
23216 /* Advance the output cursor. */
23217 output_cursor
.hpos
+= len
;
23218 output_cursor
.x
= x
;
23223 Insert LEN glyphs from START at the nominal cursor position. */
23226 x_insert_glyphs (struct glyph
*start
, int len
)
23230 int line_height
, shift_by_width
, shifted_region_width
;
23231 struct glyph_row
*row
;
23232 struct glyph
*glyph
;
23233 int frame_x
, frame_y
;
23236 xassert (updated_window
&& updated_row
);
23238 w
= updated_window
;
23239 f
= XFRAME (WINDOW_FRAME (w
));
23241 /* Get the height of the line we are in. */
23243 line_height
= row
->height
;
23245 /* Get the width of the glyphs to insert. */
23246 shift_by_width
= 0;
23247 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23248 shift_by_width
+= glyph
->pixel_width
;
23250 /* Get the width of the region to shift right. */
23251 shifted_region_width
= (window_box_width (w
, updated_area
)
23256 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23257 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23259 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23260 line_height
, shift_by_width
);
23262 /* Write the glyphs. */
23263 hpos
= start
- row
->glyphs
[updated_area
];
23264 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23266 DRAW_NORMAL_TEXT
, 0);
23268 /* Advance the output cursor. */
23269 output_cursor
.hpos
+= len
;
23270 output_cursor
.x
+= shift_by_width
;
23276 Erase the current text line from the nominal cursor position
23277 (inclusive) to pixel column TO_X (exclusive). The idea is that
23278 everything from TO_X onward is already erased.
23280 TO_X is a pixel position relative to updated_area of
23281 updated_window. TO_X == -1 means clear to the end of this area. */
23284 x_clear_end_of_line (int to_x
)
23287 struct window
*w
= updated_window
;
23288 int max_x
, min_y
, max_y
;
23289 int from_x
, from_y
, to_y
;
23291 xassert (updated_window
&& updated_row
);
23292 f
= XFRAME (w
->frame
);
23294 if (updated_row
->full_width_p
)
23295 max_x
= WINDOW_TOTAL_WIDTH (w
);
23297 max_x
= window_box_width (w
, updated_area
);
23298 max_y
= window_text_bottom_y (w
);
23300 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23301 of window. For TO_X > 0, truncate to end of drawing area. */
23307 to_x
= min (to_x
, max_x
);
23309 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23311 /* Notice if the cursor will be cleared by this operation. */
23312 if (!updated_row
->full_width_p
)
23313 notice_overwritten_cursor (w
, updated_area
,
23314 output_cursor
.x
, -1,
23316 MATRIX_ROW_BOTTOM_Y (updated_row
));
23318 from_x
= output_cursor
.x
;
23320 /* Translate to frame coordinates. */
23321 if (updated_row
->full_width_p
)
23323 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23324 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23328 int area_left
= window_box_left (w
, updated_area
);
23329 from_x
+= area_left
;
23333 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23334 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23335 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23337 /* Prevent inadvertently clearing to end of the X window. */
23338 if (to_x
> from_x
&& to_y
> from_y
)
23341 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23342 to_x
- from_x
, to_y
- from_y
);
23347 #endif /* HAVE_WINDOW_SYSTEM */
23351 /***********************************************************************
23353 ***********************************************************************/
23355 /* Value is the internal representation of the specified cursor type
23356 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23357 of the bar cursor. */
23359 static enum text_cursor_kinds
23360 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23362 enum text_cursor_kinds type
;
23367 if (EQ (arg
, Qbox
))
23368 return FILLED_BOX_CURSOR
;
23370 if (EQ (arg
, Qhollow
))
23371 return HOLLOW_BOX_CURSOR
;
23373 if (EQ (arg
, Qbar
))
23380 && EQ (XCAR (arg
), Qbar
)
23381 && INTEGERP (XCDR (arg
))
23382 && XINT (XCDR (arg
)) >= 0)
23384 *width
= XINT (XCDR (arg
));
23388 if (EQ (arg
, Qhbar
))
23391 return HBAR_CURSOR
;
23395 && EQ (XCAR (arg
), Qhbar
)
23396 && INTEGERP (XCDR (arg
))
23397 && XINT (XCDR (arg
)) >= 0)
23399 *width
= XINT (XCDR (arg
));
23400 return HBAR_CURSOR
;
23403 /* Treat anything unknown as "hollow box cursor".
23404 It was bad to signal an error; people have trouble fixing
23405 .Xdefaults with Emacs, when it has something bad in it. */
23406 type
= HOLLOW_BOX_CURSOR
;
23411 /* Set the default cursor types for specified frame. */
23413 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23418 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23419 FRAME_CURSOR_WIDTH (f
) = width
;
23421 /* By default, set up the blink-off state depending on the on-state. */
23423 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23426 FRAME_BLINK_OFF_CURSOR (f
)
23427 = get_specified_cursor_type (XCDR (tem
), &width
);
23428 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23431 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23435 #ifdef HAVE_WINDOW_SYSTEM
23437 /* Return the cursor we want to be displayed in window W. Return
23438 width of bar/hbar cursor through WIDTH arg. Return with
23439 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23440 (i.e. if the `system caret' should track this cursor).
23442 In a mini-buffer window, we want the cursor only to appear if we
23443 are reading input from this window. For the selected window, we
23444 want the cursor type given by the frame parameter or buffer local
23445 setting of cursor-type. If explicitly marked off, draw no cursor.
23446 In all other cases, we want a hollow box cursor. */
23448 static enum text_cursor_kinds
23449 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23450 int *active_cursor
)
23452 struct frame
*f
= XFRAME (w
->frame
);
23453 struct buffer
*b
= XBUFFER (w
->buffer
);
23454 int cursor_type
= DEFAULT_CURSOR
;
23455 Lisp_Object alt_cursor
;
23456 int non_selected
= 0;
23458 *active_cursor
= 1;
23461 if (cursor_in_echo_area
23462 && FRAME_HAS_MINIBUF_P (f
)
23463 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23465 if (w
== XWINDOW (echo_area_window
))
23467 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23469 *width
= FRAME_CURSOR_WIDTH (f
);
23470 return FRAME_DESIRED_CURSOR (f
);
23473 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23476 *active_cursor
= 0;
23480 /* Detect a nonselected window or nonselected frame. */
23481 else if (w
!= XWINDOW (f
->selected_window
)
23482 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23484 *active_cursor
= 0;
23486 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23492 /* Never display a cursor in a window in which cursor-type is nil. */
23493 if (NILP (BVAR (b
, cursor_type
)))
23496 /* Get the normal cursor type for this window. */
23497 if (EQ (BVAR (b
, cursor_type
), Qt
))
23499 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23500 *width
= FRAME_CURSOR_WIDTH (f
);
23503 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23505 /* Use cursor-in-non-selected-windows instead
23506 for non-selected window or frame. */
23509 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23510 if (!EQ (Qt
, alt_cursor
))
23511 return get_specified_cursor_type (alt_cursor
, width
);
23512 /* t means modify the normal cursor type. */
23513 if (cursor_type
== FILLED_BOX_CURSOR
)
23514 cursor_type
= HOLLOW_BOX_CURSOR
;
23515 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23517 return cursor_type
;
23520 /* Use normal cursor if not blinked off. */
23521 if (!w
->cursor_off_p
)
23523 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23525 if (cursor_type
== FILLED_BOX_CURSOR
)
23527 /* Using a block cursor on large images can be very annoying.
23528 So use a hollow cursor for "large" images.
23529 If image is not transparent (no mask), also use hollow cursor. */
23530 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23531 if (img
!= NULL
&& IMAGEP (img
->spec
))
23533 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23534 where N = size of default frame font size.
23535 This should cover most of the "tiny" icons people may use. */
23537 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23538 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23539 cursor_type
= HOLLOW_BOX_CURSOR
;
23542 else if (cursor_type
!= NO_CURSOR
)
23544 /* Display current only supports BOX and HOLLOW cursors for images.
23545 So for now, unconditionally use a HOLLOW cursor when cursor is
23546 not a solid box cursor. */
23547 cursor_type
= HOLLOW_BOX_CURSOR
;
23550 return cursor_type
;
23553 /* Cursor is blinked off, so determine how to "toggle" it. */
23555 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23556 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23557 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23559 /* Then see if frame has specified a specific blink off cursor type. */
23560 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23562 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23563 return FRAME_BLINK_OFF_CURSOR (f
);
23567 /* Some people liked having a permanently visible blinking cursor,
23568 while others had very strong opinions against it. So it was
23569 decided to remove it. KFS 2003-09-03 */
23571 /* Finally perform built-in cursor blinking:
23572 filled box <-> hollow box
23573 wide [h]bar <-> narrow [h]bar
23574 narrow [h]bar <-> no cursor
23575 other type <-> no cursor */
23577 if (cursor_type
== FILLED_BOX_CURSOR
)
23578 return HOLLOW_BOX_CURSOR
;
23580 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23583 return cursor_type
;
23591 /* Notice when the text cursor of window W has been completely
23592 overwritten by a drawing operation that outputs glyphs in AREA
23593 starting at X0 and ending at X1 in the line starting at Y0 and
23594 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23595 the rest of the line after X0 has been written. Y coordinates
23596 are window-relative. */
23599 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23600 int x0
, int x1
, int y0
, int y1
)
23602 int cx0
, cx1
, cy0
, cy1
;
23603 struct glyph_row
*row
;
23605 if (!w
->phys_cursor_on_p
)
23607 if (area
!= TEXT_AREA
)
23610 if (w
->phys_cursor
.vpos
< 0
23611 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23612 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23613 !(row
->enabled_p
&& row
->displays_text_p
)))
23616 if (row
->cursor_in_fringe_p
)
23618 row
->cursor_in_fringe_p
= 0;
23619 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23620 w
->phys_cursor_on_p
= 0;
23624 cx0
= w
->phys_cursor
.x
;
23625 cx1
= cx0
+ w
->phys_cursor_width
;
23626 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23629 /* The cursor image will be completely removed from the
23630 screen if the output area intersects the cursor area in
23631 y-direction. When we draw in [y0 y1[, and some part of
23632 the cursor is at y < y0, that part must have been drawn
23633 before. When scrolling, the cursor is erased before
23634 actually scrolling, so we don't come here. When not
23635 scrolling, the rows above the old cursor row must have
23636 changed, and in this case these rows must have written
23637 over the cursor image.
23639 Likewise if part of the cursor is below y1, with the
23640 exception of the cursor being in the first blank row at
23641 the buffer and window end because update_text_area
23642 doesn't draw that row. (Except when it does, but
23643 that's handled in update_text_area.) */
23645 cy0
= w
->phys_cursor
.y
;
23646 cy1
= cy0
+ w
->phys_cursor_height
;
23647 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23650 w
->phys_cursor_on_p
= 0;
23653 #endif /* HAVE_WINDOW_SYSTEM */
23656 /************************************************************************
23658 ************************************************************************/
23660 #ifdef HAVE_WINDOW_SYSTEM
23663 Fix the display of area AREA of overlapping row ROW in window W
23664 with respect to the overlapping part OVERLAPS. */
23667 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23668 enum glyph_row_area area
, int overlaps
)
23675 for (i
= 0; i
< row
->used
[area
];)
23677 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23679 int start
= i
, start_x
= x
;
23683 x
+= row
->glyphs
[area
][i
].pixel_width
;
23686 while (i
< row
->used
[area
]
23687 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23689 draw_glyphs (w
, start_x
, row
, area
,
23691 DRAW_NORMAL_TEXT
, overlaps
);
23695 x
+= row
->glyphs
[area
][i
].pixel_width
;
23705 Draw the cursor glyph of window W in glyph row ROW. See the
23706 comment of draw_glyphs for the meaning of HL. */
23709 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23710 enum draw_glyphs_face hl
)
23712 /* If cursor hpos is out of bounds, don't draw garbage. This can
23713 happen in mini-buffer windows when switching between echo area
23714 glyphs and mini-buffer. */
23715 if ((row
->reversed_p
23716 ? (w
->phys_cursor
.hpos
>= 0)
23717 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23719 int on_p
= w
->phys_cursor_on_p
;
23721 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23722 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23724 w
->phys_cursor_on_p
= on_p
;
23726 if (hl
== DRAW_CURSOR
)
23727 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23728 /* When we erase the cursor, and ROW is overlapped by other
23729 rows, make sure that these overlapping parts of other rows
23731 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23733 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23735 if (row
> w
->current_matrix
->rows
23736 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23737 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23738 OVERLAPS_ERASED_CURSOR
);
23740 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23741 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23742 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23743 OVERLAPS_ERASED_CURSOR
);
23750 Erase the image of a cursor of window W from the screen. */
23753 erase_phys_cursor (struct window
*w
)
23755 struct frame
*f
= XFRAME (w
->frame
);
23756 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23757 int hpos
= w
->phys_cursor
.hpos
;
23758 int vpos
= w
->phys_cursor
.vpos
;
23759 int mouse_face_here_p
= 0;
23760 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23761 struct glyph_row
*cursor_row
;
23762 struct glyph
*cursor_glyph
;
23763 enum draw_glyphs_face hl
;
23765 /* No cursor displayed or row invalidated => nothing to do on the
23767 if (w
->phys_cursor_type
== NO_CURSOR
)
23768 goto mark_cursor_off
;
23770 /* VPOS >= active_glyphs->nrows means that window has been resized.
23771 Don't bother to erase the cursor. */
23772 if (vpos
>= active_glyphs
->nrows
)
23773 goto mark_cursor_off
;
23775 /* If row containing cursor is marked invalid, there is nothing we
23777 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23778 if (!cursor_row
->enabled_p
)
23779 goto mark_cursor_off
;
23781 /* If line spacing is > 0, old cursor may only be partially visible in
23782 window after split-window. So adjust visible height. */
23783 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23784 window_text_bottom_y (w
) - cursor_row
->y
);
23786 /* If row is completely invisible, don't attempt to delete a cursor which
23787 isn't there. This can happen if cursor is at top of a window, and
23788 we switch to a buffer with a header line in that window. */
23789 if (cursor_row
->visible_height
<= 0)
23790 goto mark_cursor_off
;
23792 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23793 if (cursor_row
->cursor_in_fringe_p
)
23795 cursor_row
->cursor_in_fringe_p
= 0;
23796 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23797 goto mark_cursor_off
;
23800 /* This can happen when the new row is shorter than the old one.
23801 In this case, either draw_glyphs or clear_end_of_line
23802 should have cleared the cursor. Note that we wouldn't be
23803 able to erase the cursor in this case because we don't have a
23804 cursor glyph at hand. */
23805 if ((cursor_row
->reversed_p
23806 ? (w
->phys_cursor
.hpos
< 0)
23807 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23808 goto mark_cursor_off
;
23810 /* If the cursor is in the mouse face area, redisplay that when
23811 we clear the cursor. */
23812 if (! NILP (hlinfo
->mouse_face_window
)
23813 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23814 /* Don't redraw the cursor's spot in mouse face if it is at the
23815 end of a line (on a newline). The cursor appears there, but
23816 mouse highlighting does not. */
23817 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23818 mouse_face_here_p
= 1;
23820 /* Maybe clear the display under the cursor. */
23821 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23824 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23827 cursor_glyph
= get_phys_cursor_glyph (w
);
23828 if (cursor_glyph
== NULL
)
23829 goto mark_cursor_off
;
23831 width
= cursor_glyph
->pixel_width
;
23832 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23833 x
= w
->phys_cursor
.x
;
23835 width
-= left_x
- x
;
23836 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23837 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23838 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23841 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23844 /* Erase the cursor by redrawing the character underneath it. */
23845 if (mouse_face_here_p
)
23846 hl
= DRAW_MOUSE_FACE
;
23848 hl
= DRAW_NORMAL_TEXT
;
23849 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23852 w
->phys_cursor_on_p
= 0;
23853 w
->phys_cursor_type
= NO_CURSOR
;
23858 Display or clear cursor of window W. If ON is zero, clear the
23859 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23860 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23863 display_and_set_cursor (struct window
*w
, int on
,
23864 int hpos
, int vpos
, int x
, int y
)
23866 struct frame
*f
= XFRAME (w
->frame
);
23867 int new_cursor_type
;
23868 int new_cursor_width
;
23870 struct glyph_row
*glyph_row
;
23871 struct glyph
*glyph
;
23873 /* This is pointless on invisible frames, and dangerous on garbaged
23874 windows and frames; in the latter case, the frame or window may
23875 be in the midst of changing its size, and x and y may be off the
23877 if (! FRAME_VISIBLE_P (f
)
23878 || FRAME_GARBAGED_P (f
)
23879 || vpos
>= w
->current_matrix
->nrows
23880 || hpos
>= w
->current_matrix
->matrix_w
)
23883 /* If cursor is off and we want it off, return quickly. */
23884 if (!on
&& !w
->phys_cursor_on_p
)
23887 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23888 /* If cursor row is not enabled, we don't really know where to
23889 display the cursor. */
23890 if (!glyph_row
->enabled_p
)
23892 w
->phys_cursor_on_p
= 0;
23897 if (!glyph_row
->exact_window_width_line_p
23898 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23899 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23901 xassert (interrupt_input_blocked
);
23903 /* Set new_cursor_type to the cursor we want to be displayed. */
23904 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23905 &new_cursor_width
, &active_cursor
);
23907 /* If cursor is currently being shown and we don't want it to be or
23908 it is in the wrong place, or the cursor type is not what we want,
23910 if (w
->phys_cursor_on_p
23912 || w
->phys_cursor
.x
!= x
23913 || w
->phys_cursor
.y
!= y
23914 || new_cursor_type
!= w
->phys_cursor_type
23915 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23916 && new_cursor_width
!= w
->phys_cursor_width
)))
23917 erase_phys_cursor (w
);
23919 /* Don't check phys_cursor_on_p here because that flag is only set
23920 to zero in some cases where we know that the cursor has been
23921 completely erased, to avoid the extra work of erasing the cursor
23922 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23923 still not be visible, or it has only been partly erased. */
23926 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23927 w
->phys_cursor_height
= glyph_row
->height
;
23929 /* Set phys_cursor_.* before x_draw_.* is called because some
23930 of them may need the information. */
23931 w
->phys_cursor
.x
= x
;
23932 w
->phys_cursor
.y
= glyph_row
->y
;
23933 w
->phys_cursor
.hpos
= hpos
;
23934 w
->phys_cursor
.vpos
= vpos
;
23937 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23938 new_cursor_type
, new_cursor_width
,
23939 on
, active_cursor
);
23943 /* Switch the display of W's cursor on or off, according to the value
23947 update_window_cursor (struct window
*w
, int on
)
23949 /* Don't update cursor in windows whose frame is in the process
23950 of being deleted. */
23951 if (w
->current_matrix
)
23954 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23955 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23961 /* Call update_window_cursor with parameter ON_P on all leaf windows
23962 in the window tree rooted at W. */
23965 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23969 if (!NILP (w
->hchild
))
23970 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23971 else if (!NILP (w
->vchild
))
23972 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23974 update_window_cursor (w
, on_p
);
23976 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23982 Display the cursor on window W, or clear it, according to ON_P.
23983 Don't change the cursor's position. */
23986 x_update_cursor (struct frame
*f
, int on_p
)
23988 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23993 Clear the cursor of window W to background color, and mark the
23994 cursor as not shown. This is used when the text where the cursor
23995 is about to be rewritten. */
23998 x_clear_cursor (struct window
*w
)
24000 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24001 update_window_cursor (w
, 0);
24004 #endif /* HAVE_WINDOW_SYSTEM */
24006 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24009 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24010 int start_hpos
, int end_hpos
,
24011 enum draw_glyphs_face draw
)
24013 #ifdef HAVE_WINDOW_SYSTEM
24014 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24016 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24020 #if defined (HAVE_GPM) || defined (MSDOS)
24021 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24025 /* Display the active region described by mouse_face_* according to DRAW. */
24028 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24030 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24031 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24033 if (/* If window is in the process of being destroyed, don't bother
24035 w
->current_matrix
!= NULL
24036 /* Don't update mouse highlight if hidden */
24037 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24038 /* Recognize when we are called to operate on rows that don't exist
24039 anymore. This can happen when a window is split. */
24040 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24042 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24043 struct glyph_row
*row
, *first
, *last
;
24045 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24046 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24048 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24050 int start_hpos
, end_hpos
, start_x
;
24052 /* For all but the first row, the highlight starts at column 0. */
24055 /* R2L rows have BEG and END in reversed order, but the
24056 screen drawing geometry is always left to right. So
24057 we need to mirror the beginning and end of the
24058 highlighted area in R2L rows. */
24059 if (!row
->reversed_p
)
24061 start_hpos
= hlinfo
->mouse_face_beg_col
;
24062 start_x
= hlinfo
->mouse_face_beg_x
;
24064 else if (row
== last
)
24066 start_hpos
= hlinfo
->mouse_face_end_col
;
24067 start_x
= hlinfo
->mouse_face_end_x
;
24075 else if (row
->reversed_p
&& row
== last
)
24077 start_hpos
= hlinfo
->mouse_face_end_col
;
24078 start_x
= hlinfo
->mouse_face_end_x
;
24088 if (!row
->reversed_p
)
24089 end_hpos
= hlinfo
->mouse_face_end_col
;
24090 else if (row
== first
)
24091 end_hpos
= hlinfo
->mouse_face_beg_col
;
24094 end_hpos
= row
->used
[TEXT_AREA
];
24095 if (draw
== DRAW_NORMAL_TEXT
)
24096 row
->fill_line_p
= 1; /* Clear to end of line */
24099 else if (row
->reversed_p
&& row
== first
)
24100 end_hpos
= hlinfo
->mouse_face_beg_col
;
24103 end_hpos
= row
->used
[TEXT_AREA
];
24104 if (draw
== DRAW_NORMAL_TEXT
)
24105 row
->fill_line_p
= 1; /* Clear to end of line */
24108 if (end_hpos
> start_hpos
)
24110 draw_row_with_mouse_face (w
, start_x
, row
,
24111 start_hpos
, end_hpos
, draw
);
24114 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24118 #ifdef HAVE_WINDOW_SYSTEM
24119 /* When we've written over the cursor, arrange for it to
24120 be displayed again. */
24121 if (FRAME_WINDOW_P (f
)
24122 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24125 display_and_set_cursor (w
, 1,
24126 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24127 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24130 #endif /* HAVE_WINDOW_SYSTEM */
24133 #ifdef HAVE_WINDOW_SYSTEM
24134 /* Change the mouse cursor. */
24135 if (FRAME_WINDOW_P (f
))
24137 if (draw
== DRAW_NORMAL_TEXT
24138 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24139 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24140 else if (draw
== DRAW_MOUSE_FACE
)
24141 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24143 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24145 #endif /* HAVE_WINDOW_SYSTEM */
24149 Clear out the mouse-highlighted active region.
24150 Redraw it un-highlighted first. Value is non-zero if mouse
24151 face was actually drawn unhighlighted. */
24154 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24158 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24160 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24164 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24165 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24166 hlinfo
->mouse_face_window
= Qnil
;
24167 hlinfo
->mouse_face_overlay
= Qnil
;
24171 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24172 within the mouse face on that window. */
24174 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24176 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24178 /* Quickly resolve the easy cases. */
24179 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24180 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24182 if (vpos
< hlinfo
->mouse_face_beg_row
24183 || vpos
> hlinfo
->mouse_face_end_row
)
24185 if (vpos
> hlinfo
->mouse_face_beg_row
24186 && vpos
< hlinfo
->mouse_face_end_row
)
24189 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24191 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24193 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24196 else if ((vpos
== hlinfo
->mouse_face_beg_row
24197 && hpos
>= hlinfo
->mouse_face_beg_col
)
24198 || (vpos
== hlinfo
->mouse_face_end_row
24199 && hpos
< hlinfo
->mouse_face_end_col
))
24204 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24206 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24209 else if ((vpos
== hlinfo
->mouse_face_beg_row
24210 && hpos
<= hlinfo
->mouse_face_beg_col
)
24211 || (vpos
== hlinfo
->mouse_face_end_row
24212 && hpos
> hlinfo
->mouse_face_end_col
))
24220 Non-zero if physical cursor of window W is within mouse face. */
24223 cursor_in_mouse_face_p (struct window
*w
)
24225 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24230 /* Find the glyph rows START_ROW and END_ROW of window W that display
24231 characters between buffer positions START_CHARPOS and END_CHARPOS
24232 (excluding END_CHARPOS). This is similar to row_containing_pos,
24233 but is more accurate when bidi reordering makes buffer positions
24234 change non-linearly with glyph rows. */
24236 rows_from_pos_range (struct window
*w
,
24237 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24238 struct glyph_row
**start
, struct glyph_row
**end
)
24240 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24241 int last_y
= window_text_bottom_y (w
);
24242 struct glyph_row
*row
;
24247 while (!first
->enabled_p
24248 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24251 /* Find the START row. */
24253 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24256 /* A row can potentially be the START row if the range of the
24257 characters it displays intersects the range
24258 [START_CHARPOS..END_CHARPOS). */
24259 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24260 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24261 /* See the commentary in row_containing_pos, for the
24262 explanation of the complicated way to check whether
24263 some position is beyond the end of the characters
24264 displayed by a row. */
24265 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24266 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24267 && !row
->ends_at_zv_p
24268 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24269 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24270 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24271 && !row
->ends_at_zv_p
24272 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24274 /* Found a candidate row. Now make sure at least one of the
24275 glyphs it displays has a charpos from the range
24276 [START_CHARPOS..END_CHARPOS).
24278 This is not obvious because bidi reordering could make
24279 buffer positions of a row be 1,2,3,102,101,100, and if we
24280 want to highlight characters in [50..60), we don't want
24281 this row, even though [50..60) does intersect [1..103),
24282 the range of character positions given by the row's start
24283 and end positions. */
24284 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24285 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24289 if (BUFFERP (g
->object
)
24290 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24299 /* Find the END row. */
24301 /* If the last row is partially visible, start looking for END
24302 from that row, instead of starting from FIRST. */
24303 && !(row
->enabled_p
24304 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24306 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24308 struct glyph_row
*next
= row
+ 1;
24310 if (!next
->enabled_p
24311 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24312 /* The first row >= START whose range of displayed characters
24313 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24314 is the row END + 1. */
24315 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24316 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24317 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24318 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24319 && !next
->ends_at_zv_p
24320 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24321 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24322 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24323 && !next
->ends_at_zv_p
24324 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24331 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24332 but none of the characters it displays are in the range, it is
24334 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24335 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24339 if (BUFFERP (g
->object
)
24340 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24353 /* This function sets the mouse_face_* elements of HLINFO, assuming
24354 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24355 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24356 for the overlay or run of text properties specifying the mouse
24357 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24358 before-string and after-string that must also be highlighted.
24359 COVER_STRING, if non-nil, is a display string that may cover some
24360 or all of the highlighted text. */
24363 mouse_face_from_buffer_pos (Lisp_Object window
,
24364 Mouse_HLInfo
*hlinfo
,
24365 EMACS_INT mouse_charpos
,
24366 EMACS_INT start_charpos
,
24367 EMACS_INT end_charpos
,
24368 Lisp_Object before_string
,
24369 Lisp_Object after_string
,
24370 Lisp_Object cover_string
)
24372 struct window
*w
= XWINDOW (window
);
24373 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24374 struct glyph_row
*r1
, *r2
;
24375 struct glyph
*glyph
, *end
;
24376 EMACS_INT ignore
, pos
;
24379 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24380 xassert (NILP (before_string
) || STRINGP (before_string
));
24381 xassert (NILP (after_string
) || STRINGP (after_string
));
24383 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24384 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24386 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24387 /* If the before-string or display-string contains newlines,
24388 rows_from_pos_range skips to its last row. Move back. */
24389 if (!NILP (before_string
) || !NILP (cover_string
))
24391 struct glyph_row
*prev
;
24392 while ((prev
= r1
- 1, prev
>= first
)
24393 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24394 && prev
->used
[TEXT_AREA
] > 0)
24396 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24397 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24398 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24400 || !(EQ (glyph
->object
, before_string
)
24401 || EQ (glyph
->object
, cover_string
)))
24408 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24409 hlinfo
->mouse_face_past_end
= 1;
24411 else if (!NILP (after_string
))
24413 /* If the after-string has newlines, advance to its last row. */
24414 struct glyph_row
*next
;
24415 struct glyph_row
*last
24416 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24418 for (next
= r2
+ 1;
24420 && next
->used
[TEXT_AREA
] > 0
24421 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24425 /* The rest of the display engine assumes that mouse_face_beg_row is
24426 either above below mouse_face_end_row or identical to it. But
24427 with bidi-reordered continued lines, the row for START_CHARPOS
24428 could be below the row for END_CHARPOS. If so, swap the rows and
24429 store them in correct order. */
24432 struct glyph_row
*tem
= r2
;
24438 hlinfo
->mouse_face_beg_y
= r1
->y
;
24439 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24440 hlinfo
->mouse_face_end_y
= r2
->y
;
24441 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24443 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24444 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24445 could be anywhere in the row and in any order. The strategy
24446 below is to find the leftmost and the rightmost glyph that
24447 belongs to either of these 3 strings, or whose position is
24448 between START_CHARPOS and END_CHARPOS, and highlight all the
24449 glyphs between those two. This may cover more than just the text
24450 between START_CHARPOS and END_CHARPOS if the range of characters
24451 strides the bidi level boundary, e.g. if the beginning is in R2L
24452 text while the end is in L2R text or vice versa. */
24453 if (!r1
->reversed_p
)
24455 /* This row is in a left to right paragraph. Scan it left to
24457 glyph
= r1
->glyphs
[TEXT_AREA
];
24458 end
= glyph
+ r1
->used
[TEXT_AREA
];
24461 /* Skip truncation glyphs at the start of the glyph row. */
24462 if (r1
->displays_text_p
)
24464 && INTEGERP (glyph
->object
)
24465 && glyph
->charpos
< 0;
24467 x
+= glyph
->pixel_width
;
24469 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24470 or COVER_STRING, and the first glyph from buffer whose
24471 position is between START_CHARPOS and END_CHARPOS. */
24473 && !INTEGERP (glyph
->object
)
24474 && !EQ (glyph
->object
, cover_string
)
24475 && !(BUFFERP (glyph
->object
)
24476 && (glyph
->charpos
>= start_charpos
24477 && glyph
->charpos
< end_charpos
));
24480 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24481 are present at buffer positions between START_CHARPOS and
24482 END_CHARPOS, or if they come from an overlay. */
24483 if (EQ (glyph
->object
, before_string
))
24485 pos
= string_buffer_position (before_string
,
24487 /* If pos == 0, it means before_string came from an
24488 overlay, not from a buffer position. */
24489 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24492 else if (EQ (glyph
->object
, after_string
))
24494 pos
= string_buffer_position (after_string
, end_charpos
);
24495 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24498 x
+= glyph
->pixel_width
;
24500 hlinfo
->mouse_face_beg_x
= x
;
24501 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24505 /* This row is in a right to left paragraph. Scan it right to
24509 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24510 glyph
= end
+ r1
->used
[TEXT_AREA
];
24512 /* Skip truncation glyphs at the start of the glyph row. */
24513 if (r1
->displays_text_p
)
24515 && INTEGERP (glyph
->object
)
24516 && glyph
->charpos
< 0;
24520 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24521 or COVER_STRING, and the first glyph from buffer whose
24522 position is between START_CHARPOS and END_CHARPOS. */
24524 && !INTEGERP (glyph
->object
)
24525 && !EQ (glyph
->object
, cover_string
)
24526 && !(BUFFERP (glyph
->object
)
24527 && (glyph
->charpos
>= start_charpos
24528 && glyph
->charpos
< end_charpos
));
24531 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24532 are present at buffer positions between START_CHARPOS and
24533 END_CHARPOS, or if they come from an overlay. */
24534 if (EQ (glyph
->object
, before_string
))
24536 pos
= string_buffer_position (before_string
, start_charpos
);
24537 /* If pos == 0, it means before_string came from an
24538 overlay, not from a buffer position. */
24539 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24542 else if (EQ (glyph
->object
, after_string
))
24544 pos
= string_buffer_position (after_string
, end_charpos
);
24545 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24550 glyph
++; /* first glyph to the right of the highlighted area */
24551 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24552 x
+= g
->pixel_width
;
24553 hlinfo
->mouse_face_beg_x
= x
;
24554 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24557 /* If the highlight ends in a different row, compute GLYPH and END
24558 for the end row. Otherwise, reuse the values computed above for
24559 the row where the highlight begins. */
24562 if (!r2
->reversed_p
)
24564 glyph
= r2
->glyphs
[TEXT_AREA
];
24565 end
= glyph
+ r2
->used
[TEXT_AREA
];
24570 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24571 glyph
= end
+ r2
->used
[TEXT_AREA
];
24575 if (!r2
->reversed_p
)
24577 /* Skip truncation and continuation glyphs near the end of the
24578 row, and also blanks and stretch glyphs inserted by
24579 extend_face_to_end_of_line. */
24581 && INTEGERP ((end
- 1)->object
)
24582 && (end
- 1)->charpos
<= 0)
24584 /* Scan the rest of the glyph row from the end, looking for the
24585 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24586 COVER_STRING, or whose position is between START_CHARPOS
24590 && !INTEGERP (end
->object
)
24591 && !EQ (end
->object
, cover_string
)
24592 && !(BUFFERP (end
->object
)
24593 && (end
->charpos
>= start_charpos
24594 && end
->charpos
< end_charpos
));
24597 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24598 are present at buffer positions between START_CHARPOS and
24599 END_CHARPOS, or if they come from an overlay. */
24600 if (EQ (end
->object
, before_string
))
24602 pos
= string_buffer_position (before_string
, start_charpos
);
24603 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24606 else if (EQ (end
->object
, after_string
))
24608 pos
= string_buffer_position (after_string
, end_charpos
);
24609 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24613 /* Find the X coordinate of the last glyph to be highlighted. */
24614 for (; glyph
<= end
; ++glyph
)
24615 x
+= glyph
->pixel_width
;
24617 hlinfo
->mouse_face_end_x
= x
;
24618 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24622 /* Skip truncation and continuation glyphs near the end of the
24623 row, and also blanks and stretch glyphs inserted by
24624 extend_face_to_end_of_line. */
24628 && INTEGERP (end
->object
)
24629 && end
->charpos
<= 0)
24631 x
+= end
->pixel_width
;
24634 /* Scan the rest of the glyph row from the end, looking for the
24635 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24636 COVER_STRING, or whose position is between START_CHARPOS
24640 && !INTEGERP (end
->object
)
24641 && !EQ (end
->object
, cover_string
)
24642 && !(BUFFERP (end
->object
)
24643 && (end
->charpos
>= start_charpos
24644 && end
->charpos
< end_charpos
));
24647 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24648 are present at buffer positions between START_CHARPOS and
24649 END_CHARPOS, or if they come from an overlay. */
24650 if (EQ (end
->object
, before_string
))
24652 pos
= string_buffer_position (before_string
, start_charpos
);
24653 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24656 else if (EQ (end
->object
, after_string
))
24658 pos
= string_buffer_position (after_string
, end_charpos
);
24659 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24662 x
+= end
->pixel_width
;
24664 hlinfo
->mouse_face_end_x
= x
;
24665 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24668 hlinfo
->mouse_face_window
= window
;
24669 hlinfo
->mouse_face_face_id
24670 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24672 !hlinfo
->mouse_face_hidden
, -1);
24673 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24676 /* The following function is not used anymore (replaced with
24677 mouse_face_from_string_pos), but I leave it here for the time
24678 being, in case someone would. */
24680 #if 0 /* not used */
24682 /* Find the position of the glyph for position POS in OBJECT in
24683 window W's current matrix, and return in *X, *Y the pixel
24684 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24686 RIGHT_P non-zero means return the position of the right edge of the
24687 glyph, RIGHT_P zero means return the left edge position.
24689 If no glyph for POS exists in the matrix, return the position of
24690 the glyph with the next smaller position that is in the matrix, if
24691 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24692 exists in the matrix, return the position of the glyph with the
24693 next larger position in OBJECT.
24695 Value is non-zero if a glyph was found. */
24698 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24699 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24701 int yb
= window_text_bottom_y (w
);
24702 struct glyph_row
*r
;
24703 struct glyph
*best_glyph
= NULL
;
24704 struct glyph_row
*best_row
= NULL
;
24707 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24708 r
->enabled_p
&& r
->y
< yb
;
24711 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24712 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24715 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24716 if (EQ (g
->object
, object
))
24718 if (g
->charpos
== pos
)
24725 else if (best_glyph
== NULL
24726 || ((eabs (g
->charpos
- pos
)
24727 < eabs (best_glyph
->charpos
- pos
))
24730 : g
->charpos
> pos
)))
24744 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24748 *x
+= best_glyph
->pixel_width
;
24753 *vpos
= best_row
- w
->current_matrix
->rows
;
24756 return best_glyph
!= NULL
;
24758 #endif /* not used */
24760 /* Find the positions of the first and the last glyphs in window W's
24761 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24762 (assumed to be a string), and return in HLINFO's mouse_face_*
24763 members the pixel and column/row coordinates of those glyphs. */
24766 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24767 Lisp_Object object
,
24768 EMACS_INT startpos
, EMACS_INT endpos
)
24770 int yb
= window_text_bottom_y (w
);
24771 struct glyph_row
*r
;
24772 struct glyph
*g
, *e
;
24776 /* Find the glyph row with at least one position in the range
24777 [STARTPOS..ENDPOS], and the first glyph in that row whose
24778 position belongs to that range. */
24779 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24780 r
->enabled_p
&& r
->y
< yb
;
24783 if (!r
->reversed_p
)
24785 g
= r
->glyphs
[TEXT_AREA
];
24786 e
= g
+ r
->used
[TEXT_AREA
];
24787 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24788 if (EQ (g
->object
, object
)
24789 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24791 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24792 hlinfo
->mouse_face_beg_y
= r
->y
;
24793 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24794 hlinfo
->mouse_face_beg_x
= gx
;
24803 e
= r
->glyphs
[TEXT_AREA
];
24804 g
= e
+ r
->used
[TEXT_AREA
];
24805 for ( ; g
> e
; --g
)
24806 if (EQ ((g
-1)->object
, object
)
24807 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24809 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24810 hlinfo
->mouse_face_beg_y
= r
->y
;
24811 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24812 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24813 gx
+= g1
->pixel_width
;
24814 hlinfo
->mouse_face_beg_x
= gx
;
24826 /* Starting with the next row, look for the first row which does NOT
24827 include any glyphs whose positions are in the range. */
24828 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24830 g
= r
->glyphs
[TEXT_AREA
];
24831 e
= g
+ r
->used
[TEXT_AREA
];
24833 for ( ; g
< e
; ++g
)
24834 if (EQ (g
->object
, object
)
24835 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24844 /* The highlighted region ends on the previous row. */
24847 /* Set the end row and its vertical pixel coordinate. */
24848 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24849 hlinfo
->mouse_face_end_y
= r
->y
;
24851 /* Compute and set the end column and the end column's horizontal
24852 pixel coordinate. */
24853 if (!r
->reversed_p
)
24855 g
= r
->glyphs
[TEXT_AREA
];
24856 e
= g
+ r
->used
[TEXT_AREA
];
24857 for ( ; e
> g
; --e
)
24858 if (EQ ((e
-1)->object
, object
)
24859 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24861 hlinfo
->mouse_face_end_col
= e
- g
;
24863 for (gx
= r
->x
; g
< e
; ++g
)
24864 gx
+= g
->pixel_width
;
24865 hlinfo
->mouse_face_end_x
= gx
;
24869 e
= r
->glyphs
[TEXT_AREA
];
24870 g
= e
+ r
->used
[TEXT_AREA
];
24871 for (gx
= r
->x
; e
< g
; ++e
)
24873 if (EQ (e
->object
, object
)
24874 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24876 gx
+= e
->pixel_width
;
24878 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24879 hlinfo
->mouse_face_end_x
= gx
;
24883 #ifdef HAVE_WINDOW_SYSTEM
24885 /* See if position X, Y is within a hot-spot of an image. */
24888 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24890 if (!CONSP (hot_spot
))
24893 if (EQ (XCAR (hot_spot
), Qrect
))
24895 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24896 Lisp_Object rect
= XCDR (hot_spot
);
24900 if (!CONSP (XCAR (rect
)))
24902 if (!CONSP (XCDR (rect
)))
24904 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24906 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24908 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24910 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24914 else if (EQ (XCAR (hot_spot
), Qcircle
))
24916 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24917 Lisp_Object circ
= XCDR (hot_spot
);
24918 Lisp_Object lr
, lx0
, ly0
;
24920 && CONSP (XCAR (circ
))
24921 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24922 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24923 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24925 double r
= XFLOATINT (lr
);
24926 double dx
= XINT (lx0
) - x
;
24927 double dy
= XINT (ly0
) - y
;
24928 return (dx
* dx
+ dy
* dy
<= r
* r
);
24931 else if (EQ (XCAR (hot_spot
), Qpoly
))
24933 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24934 if (VECTORP (XCDR (hot_spot
)))
24936 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24937 Lisp_Object
*poly
= v
->contents
;
24938 int n
= v
->header
.size
;
24941 Lisp_Object lx
, ly
;
24944 /* Need an even number of coordinates, and at least 3 edges. */
24945 if (n
< 6 || n
& 1)
24948 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24949 If count is odd, we are inside polygon. Pixels on edges
24950 may or may not be included depending on actual geometry of the
24952 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24953 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24955 x0
= XINT (lx
), y0
= XINT (ly
);
24956 for (i
= 0; i
< n
; i
+= 2)
24958 int x1
= x0
, y1
= y0
;
24959 if ((lx
= poly
[i
], !INTEGERP (lx
))
24960 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24962 x0
= XINT (lx
), y0
= XINT (ly
);
24964 /* Does this segment cross the X line? */
24972 if (y
> y0
&& y
> y1
)
24974 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24984 find_hot_spot (Lisp_Object map
, int x
, int y
)
24986 while (CONSP (map
))
24988 if (CONSP (XCAR (map
))
24989 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24997 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24999 doc
: /* Lookup in image map MAP coordinates X and Y.
25000 An image map is an alist where each element has the format (AREA ID PLIST).
25001 An AREA is specified as either a rectangle, a circle, or a polygon:
25002 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25003 pixel coordinates of the upper left and bottom right corners.
25004 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25005 and the radius of the circle; r may be a float or integer.
25006 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25007 vector describes one corner in the polygon.
25008 Returns the alist element for the first matching AREA in MAP. */)
25009 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25017 return find_hot_spot (map
, XINT (x
), XINT (y
));
25021 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25023 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25025 /* Do not change cursor shape while dragging mouse. */
25026 if (!NILP (do_mouse_tracking
))
25029 if (!NILP (pointer
))
25031 if (EQ (pointer
, Qarrow
))
25032 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25033 else if (EQ (pointer
, Qhand
))
25034 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25035 else if (EQ (pointer
, Qtext
))
25036 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25037 else if (EQ (pointer
, intern ("hdrag")))
25038 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25039 #ifdef HAVE_X_WINDOWS
25040 else if (EQ (pointer
, intern ("vdrag")))
25041 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25043 else if (EQ (pointer
, intern ("hourglass")))
25044 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25045 else if (EQ (pointer
, Qmodeline
))
25046 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25048 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25051 if (cursor
!= No_Cursor
)
25052 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25055 #endif /* HAVE_WINDOW_SYSTEM */
25057 /* Take proper action when mouse has moved to the mode or header line
25058 or marginal area AREA of window W, x-position X and y-position Y.
25059 X is relative to the start of the text display area of W, so the
25060 width of bitmap areas and scroll bars must be subtracted to get a
25061 position relative to the start of the mode line. */
25064 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25065 enum window_part area
)
25067 struct window
*w
= XWINDOW (window
);
25068 struct frame
*f
= XFRAME (w
->frame
);
25069 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25070 #ifdef HAVE_WINDOW_SYSTEM
25071 Display_Info
*dpyinfo
;
25073 Cursor cursor
= No_Cursor
;
25074 Lisp_Object pointer
= Qnil
;
25075 int dx
, dy
, width
, height
;
25077 Lisp_Object string
, object
= Qnil
;
25078 Lisp_Object pos
, help
;
25080 Lisp_Object mouse_face
;
25081 int original_x_pixel
= x
;
25082 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25083 struct glyph_row
*row
;
25085 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25090 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25091 returns them in row/column units! */
25092 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25093 &object
, &dx
, &dy
, &width
, &height
);
25095 row
= (area
== ON_MODE_LINE
25096 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25097 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25099 /* Find the glyph under the mouse pointer. */
25100 if (row
->mode_line_p
&& row
->enabled_p
)
25102 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25103 end
= glyph
+ row
->used
[TEXT_AREA
];
25105 for (x0
= original_x_pixel
;
25106 glyph
< end
&& x0
>= glyph
->pixel_width
;
25108 x0
-= glyph
->pixel_width
;
25116 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25117 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25118 returns them in row/column units! */
25119 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25120 &object
, &dx
, &dy
, &width
, &height
);
25125 #ifdef HAVE_WINDOW_SYSTEM
25126 if (IMAGEP (object
))
25128 Lisp_Object image_map
, hotspot
;
25129 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25131 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25133 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25137 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25138 If so, we could look for mouse-enter, mouse-leave
25139 properties in PLIST (and do something...). */
25140 hotspot
= XCDR (hotspot
);
25141 if (CONSP (hotspot
)
25142 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25144 pointer
= Fplist_get (plist
, Qpointer
);
25145 if (NILP (pointer
))
25147 help
= Fplist_get (plist
, Qhelp_echo
);
25150 help_echo_string
= help
;
25151 /* Is this correct? ++kfs */
25152 XSETWINDOW (help_echo_window
, w
);
25153 help_echo_object
= w
->buffer
;
25154 help_echo_pos
= charpos
;
25158 if (NILP (pointer
))
25159 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25161 #endif /* HAVE_WINDOW_SYSTEM */
25163 if (STRINGP (string
))
25165 pos
= make_number (charpos
);
25166 /* If we're on a string with `help-echo' text property, arrange
25167 for the help to be displayed. This is done by setting the
25168 global variable help_echo_string to the help string. */
25171 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25174 help_echo_string
= help
;
25175 XSETWINDOW (help_echo_window
, w
);
25176 help_echo_object
= string
;
25177 help_echo_pos
= charpos
;
25181 #ifdef HAVE_WINDOW_SYSTEM
25182 if (FRAME_WINDOW_P (f
))
25184 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25185 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25186 if (NILP (pointer
))
25187 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25189 /* Change the mouse pointer according to what is under X/Y. */
25191 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25194 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25195 if (!KEYMAPP (map
))
25196 map
= Fget_text_property (pos
, Qkeymap
, string
);
25197 if (!KEYMAPP (map
))
25198 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25203 /* Change the mouse face according to what is under X/Y. */
25204 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25205 if (!NILP (mouse_face
)
25206 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25211 struct glyph
* tmp_glyph
;
25215 int total_pixel_width
;
25216 EMACS_INT begpos
, endpos
, ignore
;
25220 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25221 Qmouse_face
, string
, Qnil
);
25227 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25229 endpos
= SCHARS (string
);
25233 /* Calculate the glyph position GPOS of GLYPH in the
25234 displayed string, relative to the beginning of the
25235 highlighted part of the string.
25237 Note: GPOS is different from CHARPOS. CHARPOS is the
25238 position of GLYPH in the internal string object. A mode
25239 line string format has structures which are converted to
25240 a flattened string by the Emacs Lisp interpreter. The
25241 internal string is an element of those structures. The
25242 displayed string is the flattened string. */
25243 tmp_glyph
= row_start_glyph
;
25244 while (tmp_glyph
< glyph
25245 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25246 && begpos
<= tmp_glyph
->charpos
25247 && tmp_glyph
->charpos
< endpos
)))
25249 gpos
= glyph
- tmp_glyph
;
25251 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25252 the highlighted part of the displayed string to which
25253 GLYPH belongs. Note: GSEQ_LENGTH is different from
25254 SCHARS (STRING), because the latter returns the length of
25255 the internal string. */
25256 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25258 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25259 && begpos
<= tmp_glyph
->charpos
25260 && tmp_glyph
->charpos
< endpos
));
25263 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25265 /* Calculate the total pixel width of all the glyphs between
25266 the beginning of the highlighted area and GLYPH. */
25267 total_pixel_width
= 0;
25268 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25269 total_pixel_width
+= tmp_glyph
->pixel_width
;
25271 /* Pre calculation of re-rendering position. Note: X is in
25272 column units here, after the call to mode_line_string or
25273 marginal_area_string. */
25275 vpos
= (area
== ON_MODE_LINE
25276 ? (w
->current_matrix
)->nrows
- 1
25279 /* If GLYPH's position is included in the region that is
25280 already drawn in mouse face, we have nothing to do. */
25281 if ( EQ (window
, hlinfo
->mouse_face_window
)
25282 && (!row
->reversed_p
25283 ? (hlinfo
->mouse_face_beg_col
<= hpos
25284 && hpos
< hlinfo
->mouse_face_end_col
)
25285 /* In R2L rows we swap BEG and END, see below. */
25286 : (hlinfo
->mouse_face_end_col
<= hpos
25287 && hpos
< hlinfo
->mouse_face_beg_col
))
25288 && hlinfo
->mouse_face_beg_row
== vpos
)
25291 if (clear_mouse_face (hlinfo
))
25292 cursor
= No_Cursor
;
25294 if (!row
->reversed_p
)
25296 hlinfo
->mouse_face_beg_col
= hpos
;
25297 hlinfo
->mouse_face_beg_x
= original_x_pixel
25298 - (total_pixel_width
+ dx
);
25299 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25300 hlinfo
->mouse_face_end_x
= 0;
25304 /* In R2L rows, show_mouse_face expects BEG and END
25305 coordinates to be swapped. */
25306 hlinfo
->mouse_face_end_col
= hpos
;
25307 hlinfo
->mouse_face_end_x
= original_x_pixel
25308 - (total_pixel_width
+ dx
);
25309 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25310 hlinfo
->mouse_face_beg_x
= 0;
25313 hlinfo
->mouse_face_beg_row
= vpos
;
25314 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25315 hlinfo
->mouse_face_beg_y
= 0;
25316 hlinfo
->mouse_face_end_y
= 0;
25317 hlinfo
->mouse_face_past_end
= 0;
25318 hlinfo
->mouse_face_window
= window
;
25320 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25326 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25328 if (NILP (pointer
))
25331 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25332 clear_mouse_face (hlinfo
);
25334 #ifdef HAVE_WINDOW_SYSTEM
25335 if (FRAME_WINDOW_P (f
))
25336 define_frame_cursor1 (f
, cursor
, pointer
);
25342 Take proper action when the mouse has moved to position X, Y on
25343 frame F as regards highlighting characters that have mouse-face
25344 properties. Also de-highlighting chars where the mouse was before.
25345 X and Y can be negative or out of range. */
25348 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25350 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25351 enum window_part part
;
25352 Lisp_Object window
;
25354 Cursor cursor
= No_Cursor
;
25355 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25358 /* When a menu is active, don't highlight because this looks odd. */
25359 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25360 if (popup_activated ())
25364 if (NILP (Vmouse_highlight
)
25365 || !f
->glyphs_initialized_p
25366 || f
->pointer_invisible
)
25369 hlinfo
->mouse_face_mouse_x
= x
;
25370 hlinfo
->mouse_face_mouse_y
= y
;
25371 hlinfo
->mouse_face_mouse_frame
= f
;
25373 if (hlinfo
->mouse_face_defer
)
25376 if (gc_in_progress
)
25378 hlinfo
->mouse_face_deferred_gc
= 1;
25382 /* Which window is that in? */
25383 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25385 /* If we were displaying active text in another window, clear that.
25386 Also clear if we move out of text area in same window. */
25387 if (! EQ (window
, hlinfo
->mouse_face_window
)
25388 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25389 && !NILP (hlinfo
->mouse_face_window
)))
25390 clear_mouse_face (hlinfo
);
25392 /* Not on a window -> return. */
25393 if (!WINDOWP (window
))
25396 /* Reset help_echo_string. It will get recomputed below. */
25397 help_echo_string
= Qnil
;
25399 /* Convert to window-relative pixel coordinates. */
25400 w
= XWINDOW (window
);
25401 frame_to_window_pixel_xy (w
, &x
, &y
);
25403 #ifdef HAVE_WINDOW_SYSTEM
25404 /* Handle tool-bar window differently since it doesn't display a
25406 if (EQ (window
, f
->tool_bar_window
))
25408 note_tool_bar_highlight (f
, x
, y
);
25413 /* Mouse is on the mode, header line or margin? */
25414 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25415 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25417 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25421 #ifdef HAVE_WINDOW_SYSTEM
25422 if (part
== ON_VERTICAL_BORDER
)
25424 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25425 help_echo_string
= build_string ("drag-mouse-1: resize");
25427 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25428 || part
== ON_SCROLL_BAR
)
25429 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25431 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25434 /* Are we in a window whose display is up to date?
25435 And verify the buffer's text has not changed. */
25436 b
= XBUFFER (w
->buffer
);
25437 if (part
== ON_TEXT
25438 && EQ (w
->window_end_valid
, w
->buffer
)
25439 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25440 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25442 int hpos
, vpos
, i
, dx
, dy
, area
;
25444 struct glyph
*glyph
;
25445 Lisp_Object object
;
25446 Lisp_Object mouse_face
= Qnil
, position
;
25447 Lisp_Object
*overlay_vec
= NULL
;
25449 struct buffer
*obuf
;
25450 EMACS_INT obegv
, ozv
;
25453 /* Find the glyph under X/Y. */
25454 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25456 #ifdef HAVE_WINDOW_SYSTEM
25457 /* Look for :pointer property on image. */
25458 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25460 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25461 if (img
!= NULL
&& IMAGEP (img
->spec
))
25463 Lisp_Object image_map
, hotspot
;
25464 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25466 && (hotspot
= find_hot_spot (image_map
,
25467 glyph
->slice
.img
.x
+ dx
,
25468 glyph
->slice
.img
.y
+ dy
),
25470 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25474 /* Could check XCAR (hotspot) to see if we enter/leave
25476 If so, we could look for mouse-enter, mouse-leave
25477 properties in PLIST (and do something...). */
25478 hotspot
= XCDR (hotspot
);
25479 if (CONSP (hotspot
)
25480 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25482 pointer
= Fplist_get (plist
, Qpointer
);
25483 if (NILP (pointer
))
25485 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25486 if (!NILP (help_echo_string
))
25488 help_echo_window
= window
;
25489 help_echo_object
= glyph
->object
;
25490 help_echo_pos
= glyph
->charpos
;
25494 if (NILP (pointer
))
25495 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25498 #endif /* HAVE_WINDOW_SYSTEM */
25500 /* Clear mouse face if X/Y not over text. */
25502 || area
!= TEXT_AREA
25503 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25504 /* Glyph's OBJECT is an integer for glyphs inserted by the
25505 display engine for its internal purposes, like truncation
25506 and continuation glyphs and blanks beyond the end of
25507 line's text on text terminals. If we are over such a
25508 glyph, we are not over any text. */
25509 || INTEGERP (glyph
->object
)
25510 /* R2L rows have a stretch glyph at their front, which
25511 stands for no text, whereas L2R rows have no glyphs at
25512 all beyond the end of text. Treat such stretch glyphs
25513 like we do with NULL glyphs in L2R rows. */
25514 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25515 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25516 && glyph
->type
== STRETCH_GLYPH
25517 && glyph
->avoid_cursor_p
))
25519 if (clear_mouse_face (hlinfo
))
25520 cursor
= No_Cursor
;
25521 #ifdef HAVE_WINDOW_SYSTEM
25522 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25524 if (area
!= TEXT_AREA
)
25525 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25527 pointer
= Vvoid_text_area_pointer
;
25533 pos
= glyph
->charpos
;
25534 object
= glyph
->object
;
25535 if (!STRINGP (object
) && !BUFFERP (object
))
25538 /* If we get an out-of-range value, return now; avoid an error. */
25539 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25542 /* Make the window's buffer temporarily current for
25543 overlays_at and compute_char_face. */
25544 obuf
= current_buffer
;
25545 current_buffer
= b
;
25551 /* Is this char mouse-active or does it have help-echo? */
25552 position
= make_number (pos
);
25554 if (BUFFERP (object
))
25556 /* Put all the overlays we want in a vector in overlay_vec. */
25557 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25558 /* Sort overlays into increasing priority order. */
25559 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25564 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25567 cursor
= No_Cursor
;
25569 /* Check mouse-face highlighting. */
25571 /* If there exists an overlay with mouse-face overlapping
25572 the one we are currently highlighting, we have to
25573 check if we enter the overlapping overlay, and then
25574 highlight only that. */
25575 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25576 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25578 /* Find the highest priority overlay with a mouse-face. */
25579 Lisp_Object overlay
= Qnil
;
25580 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25582 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25583 if (!NILP (mouse_face
))
25584 overlay
= overlay_vec
[i
];
25587 /* If we're highlighting the same overlay as before, there's
25588 no need to do that again. */
25589 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25590 goto check_help_echo
;
25591 hlinfo
->mouse_face_overlay
= overlay
;
25593 /* Clear the display of the old active region, if any. */
25594 if (clear_mouse_face (hlinfo
))
25595 cursor
= No_Cursor
;
25597 /* If no overlay applies, get a text property. */
25598 if (NILP (overlay
))
25599 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25601 /* Next, compute the bounds of the mouse highlighting and
25603 if (!NILP (mouse_face
) && STRINGP (object
))
25605 /* The mouse-highlighting comes from a display string
25606 with a mouse-face. */
25610 s
= Fprevious_single_property_change
25611 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25612 e
= Fnext_single_property_change
25613 (position
, Qmouse_face
, object
, Qnil
);
25615 s
= make_number (0);
25617 e
= make_number (SCHARS (object
) - 1);
25618 mouse_face_from_string_pos (w
, hlinfo
, object
,
25619 XINT (s
), XINT (e
));
25620 hlinfo
->mouse_face_past_end
= 0;
25621 hlinfo
->mouse_face_window
= window
;
25622 hlinfo
->mouse_face_face_id
25623 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25624 glyph
->face_id
, 1);
25625 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25626 cursor
= No_Cursor
;
25630 /* The mouse-highlighting, if any, comes from an overlay
25631 or text property in the buffer. */
25632 Lisp_Object buffer
IF_LINT (= Qnil
);
25633 Lisp_Object cover_string
IF_LINT (= Qnil
);
25635 if (STRINGP (object
))
25637 /* If we are on a display string with no mouse-face,
25638 check if the text under it has one. */
25639 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25640 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25641 pos
= string_buffer_position (object
, start
);
25644 mouse_face
= get_char_property_and_overlay
25645 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25646 buffer
= w
->buffer
;
25647 cover_string
= object
;
25653 cover_string
= Qnil
;
25656 if (!NILP (mouse_face
))
25658 Lisp_Object before
, after
;
25659 Lisp_Object before_string
, after_string
;
25660 /* To correctly find the limits of mouse highlight
25661 in a bidi-reordered buffer, we must not use the
25662 optimization of limiting the search in
25663 previous-single-property-change and
25664 next-single-property-change, because
25665 rows_from_pos_range needs the real start and end
25666 positions to DTRT in this case. That's because
25667 the first row visible in a window does not
25668 necessarily display the character whose position
25669 is the smallest. */
25671 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25672 ? Fmarker_position (w
->start
)
25675 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25676 ? make_number (BUF_Z (XBUFFER (buffer
))
25677 - XFASTINT (w
->window_end_pos
))
25680 if (NILP (overlay
))
25682 /* Handle the text property case. */
25683 before
= Fprevious_single_property_change
25684 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25685 after
= Fnext_single_property_change
25686 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25687 before_string
= after_string
= Qnil
;
25691 /* Handle the overlay case. */
25692 before
= Foverlay_start (overlay
);
25693 after
= Foverlay_end (overlay
);
25694 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25695 after_string
= Foverlay_get (overlay
, Qafter_string
);
25697 if (!STRINGP (before_string
)) before_string
= Qnil
;
25698 if (!STRINGP (after_string
)) after_string
= Qnil
;
25701 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25704 before_string
, after_string
,
25706 cursor
= No_Cursor
;
25713 /* Look for a `help-echo' property. */
25714 if (NILP (help_echo_string
)) {
25715 Lisp_Object help
, overlay
;
25717 /* Check overlays first. */
25718 help
= overlay
= Qnil
;
25719 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25721 overlay
= overlay_vec
[i
];
25722 help
= Foverlay_get (overlay
, Qhelp_echo
);
25727 help_echo_string
= help
;
25728 help_echo_window
= window
;
25729 help_echo_object
= overlay
;
25730 help_echo_pos
= pos
;
25734 Lisp_Object obj
= glyph
->object
;
25735 EMACS_INT charpos
= glyph
->charpos
;
25737 /* Try text properties. */
25740 && charpos
< SCHARS (obj
))
25742 help
= Fget_text_property (make_number (charpos
),
25746 /* If the string itself doesn't specify a help-echo,
25747 see if the buffer text ``under'' it does. */
25748 struct glyph_row
*r
25749 = MATRIX_ROW (w
->current_matrix
, vpos
);
25750 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25751 EMACS_INT p
= string_buffer_position (obj
, start
);
25754 help
= Fget_char_property (make_number (p
),
25755 Qhelp_echo
, w
->buffer
);
25764 else if (BUFFERP (obj
)
25767 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25772 help_echo_string
= help
;
25773 help_echo_window
= window
;
25774 help_echo_object
= obj
;
25775 help_echo_pos
= charpos
;
25780 #ifdef HAVE_WINDOW_SYSTEM
25781 /* Look for a `pointer' property. */
25782 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25784 /* Check overlays first. */
25785 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25786 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25788 if (NILP (pointer
))
25790 Lisp_Object obj
= glyph
->object
;
25791 EMACS_INT charpos
= glyph
->charpos
;
25793 /* Try text properties. */
25796 && charpos
< SCHARS (obj
))
25798 pointer
= Fget_text_property (make_number (charpos
),
25800 if (NILP (pointer
))
25802 /* If the string itself doesn't specify a pointer,
25803 see if the buffer text ``under'' it does. */
25804 struct glyph_row
*r
25805 = MATRIX_ROW (w
->current_matrix
, vpos
);
25806 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25807 EMACS_INT p
= string_buffer_position (obj
, start
);
25809 pointer
= Fget_char_property (make_number (p
),
25810 Qpointer
, w
->buffer
);
25813 else if (BUFFERP (obj
)
25816 pointer
= Fget_text_property (make_number (charpos
),
25820 #endif /* HAVE_WINDOW_SYSTEM */
25824 current_buffer
= obuf
;
25829 #ifdef HAVE_WINDOW_SYSTEM
25830 if (FRAME_WINDOW_P (f
))
25831 define_frame_cursor1 (f
, cursor
, pointer
);
25833 /* This is here to prevent a compiler error, about "label at end of
25834 compound statement". */
25841 Clear any mouse-face on window W. This function is part of the
25842 redisplay interface, and is called from try_window_id and similar
25843 functions to ensure the mouse-highlight is off. */
25846 x_clear_window_mouse_face (struct window
*w
)
25848 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25849 Lisp_Object window
;
25852 XSETWINDOW (window
, w
);
25853 if (EQ (window
, hlinfo
->mouse_face_window
))
25854 clear_mouse_face (hlinfo
);
25860 Just discard the mouse face information for frame F, if any.
25861 This is used when the size of F is changed. */
25864 cancel_mouse_face (struct frame
*f
)
25866 Lisp_Object window
;
25867 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25869 window
= hlinfo
->mouse_face_window
;
25870 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25872 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25873 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25874 hlinfo
->mouse_face_window
= Qnil
;
25880 /***********************************************************************
25882 ***********************************************************************/
25884 #ifdef HAVE_WINDOW_SYSTEM
25886 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25887 which intersects rectangle R. R is in window-relative coordinates. */
25890 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25891 enum glyph_row_area area
)
25893 struct glyph
*first
= row
->glyphs
[area
];
25894 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25895 struct glyph
*last
;
25896 int first_x
, start_x
, x
;
25898 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25899 /* If row extends face to end of line write the whole line. */
25900 draw_glyphs (w
, 0, row
, area
,
25901 0, row
->used
[area
],
25902 DRAW_NORMAL_TEXT
, 0);
25905 /* Set START_X to the window-relative start position for drawing glyphs of
25906 AREA. The first glyph of the text area can be partially visible.
25907 The first glyphs of other areas cannot. */
25908 start_x
= window_box_left_offset (w
, area
);
25910 if (area
== TEXT_AREA
)
25913 /* Find the first glyph that must be redrawn. */
25915 && x
+ first
->pixel_width
< r
->x
)
25917 x
+= first
->pixel_width
;
25921 /* Find the last one. */
25925 && x
< r
->x
+ r
->width
)
25927 x
+= last
->pixel_width
;
25933 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25934 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25935 DRAW_NORMAL_TEXT
, 0);
25940 /* Redraw the parts of the glyph row ROW on window W intersecting
25941 rectangle R. R is in window-relative coordinates. Value is
25942 non-zero if mouse-face was overwritten. */
25945 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25947 xassert (row
->enabled_p
);
25949 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25950 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25951 0, row
->used
[TEXT_AREA
],
25952 DRAW_NORMAL_TEXT
, 0);
25955 if (row
->used
[LEFT_MARGIN_AREA
])
25956 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25957 if (row
->used
[TEXT_AREA
])
25958 expose_area (w
, row
, r
, TEXT_AREA
);
25959 if (row
->used
[RIGHT_MARGIN_AREA
])
25960 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25961 draw_row_fringe_bitmaps (w
, row
);
25964 return row
->mouse_face_p
;
25968 /* Redraw those parts of glyphs rows during expose event handling that
25969 overlap other rows. Redrawing of an exposed line writes over parts
25970 of lines overlapping that exposed line; this function fixes that.
25972 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25973 row in W's current matrix that is exposed and overlaps other rows.
25974 LAST_OVERLAPPING_ROW is the last such row. */
25977 expose_overlaps (struct window
*w
,
25978 struct glyph_row
*first_overlapping_row
,
25979 struct glyph_row
*last_overlapping_row
,
25982 struct glyph_row
*row
;
25984 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25985 if (row
->overlapping_p
)
25987 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25990 if (row
->used
[LEFT_MARGIN_AREA
])
25991 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25993 if (row
->used
[TEXT_AREA
])
25994 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25996 if (row
->used
[RIGHT_MARGIN_AREA
])
25997 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26003 /* Return non-zero if W's cursor intersects rectangle R. */
26006 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26008 XRectangle cr
, result
;
26009 struct glyph
*cursor_glyph
;
26010 struct glyph_row
*row
;
26012 if (w
->phys_cursor
.vpos
>= 0
26013 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26014 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26016 && row
->cursor_in_fringe_p
)
26018 /* Cursor is in the fringe. */
26019 cr
.x
= window_box_right_offset (w
,
26020 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26021 ? RIGHT_MARGIN_AREA
26024 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26025 cr
.height
= row
->height
;
26026 return x_intersect_rectangles (&cr
, r
, &result
);
26029 cursor_glyph
= get_phys_cursor_glyph (w
);
26032 /* r is relative to W's box, but w->phys_cursor.x is relative
26033 to left edge of W's TEXT area. Adjust it. */
26034 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26035 cr
.y
= w
->phys_cursor
.y
;
26036 cr
.width
= cursor_glyph
->pixel_width
;
26037 cr
.height
= w
->phys_cursor_height
;
26038 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26039 I assume the effect is the same -- and this is portable. */
26040 return x_intersect_rectangles (&cr
, r
, &result
);
26042 /* If we don't understand the format, pretend we're not in the hot-spot. */
26048 Draw a vertical window border to the right of window W if W doesn't
26049 have vertical scroll bars. */
26052 x_draw_vertical_border (struct window
*w
)
26054 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26056 /* We could do better, if we knew what type of scroll-bar the adjacent
26057 windows (on either side) have... But we don't :-(
26058 However, I think this works ok. ++KFS 2003-04-25 */
26060 /* Redraw borders between horizontally adjacent windows. Don't
26061 do it for frames with vertical scroll bars because either the
26062 right scroll bar of a window, or the left scroll bar of its
26063 neighbor will suffice as a border. */
26064 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26067 if (!WINDOW_RIGHTMOST_P (w
)
26068 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26070 int x0
, x1
, y0
, y1
;
26072 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26075 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26078 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26080 else if (!WINDOW_LEFTMOST_P (w
)
26081 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26083 int x0
, x1
, y0
, y1
;
26085 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26088 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26091 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26096 /* Redraw the part of window W intersection rectangle FR. Pixel
26097 coordinates in FR are frame-relative. Call this function with
26098 input blocked. Value is non-zero if the exposure overwrites
26102 expose_window (struct window
*w
, XRectangle
*fr
)
26104 struct frame
*f
= XFRAME (w
->frame
);
26106 int mouse_face_overwritten_p
= 0;
26108 /* If window is not yet fully initialized, do nothing. This can
26109 happen when toolkit scroll bars are used and a window is split.
26110 Reconfiguring the scroll bar will generate an expose for a newly
26112 if (w
->current_matrix
== NULL
)
26115 /* When we're currently updating the window, display and current
26116 matrix usually don't agree. Arrange for a thorough display
26118 if (w
== updated_window
)
26120 SET_FRAME_GARBAGED (f
);
26124 /* Frame-relative pixel rectangle of W. */
26125 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26126 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26127 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26128 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26130 if (x_intersect_rectangles (fr
, &wr
, &r
))
26132 int yb
= window_text_bottom_y (w
);
26133 struct glyph_row
*row
;
26134 int cursor_cleared_p
;
26135 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26137 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26138 r
.x
, r
.y
, r
.width
, r
.height
));
26140 /* Convert to window coordinates. */
26141 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26142 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26144 /* Turn off the cursor. */
26145 if (!w
->pseudo_window_p
26146 && phys_cursor_in_rect_p (w
, &r
))
26148 x_clear_cursor (w
);
26149 cursor_cleared_p
= 1;
26152 cursor_cleared_p
= 0;
26154 /* Update lines intersecting rectangle R. */
26155 first_overlapping_row
= last_overlapping_row
= NULL
;
26156 for (row
= w
->current_matrix
->rows
;
26161 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26163 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26164 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26165 || (r
.y
>= y0
&& r
.y
< y1
)
26166 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26168 /* A header line may be overlapping, but there is no need
26169 to fix overlapping areas for them. KFS 2005-02-12 */
26170 if (row
->overlapping_p
&& !row
->mode_line_p
)
26172 if (first_overlapping_row
== NULL
)
26173 first_overlapping_row
= row
;
26174 last_overlapping_row
= row
;
26178 if (expose_line (w
, row
, &r
))
26179 mouse_face_overwritten_p
= 1;
26182 else if (row
->overlapping_p
)
26184 /* We must redraw a row overlapping the exposed area. */
26186 ? y0
+ row
->phys_height
> r
.y
26187 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26189 if (first_overlapping_row
== NULL
)
26190 first_overlapping_row
= row
;
26191 last_overlapping_row
= row
;
26199 /* Display the mode line if there is one. */
26200 if (WINDOW_WANTS_MODELINE_P (w
)
26201 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26203 && row
->y
< r
.y
+ r
.height
)
26205 if (expose_line (w
, row
, &r
))
26206 mouse_face_overwritten_p
= 1;
26209 if (!w
->pseudo_window_p
)
26211 /* Fix the display of overlapping rows. */
26212 if (first_overlapping_row
)
26213 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26216 /* Draw border between windows. */
26217 x_draw_vertical_border (w
);
26219 /* Turn the cursor on again. */
26220 if (cursor_cleared_p
)
26221 update_window_cursor (w
, 1);
26225 return mouse_face_overwritten_p
;
26230 /* Redraw (parts) of all windows in the window tree rooted at W that
26231 intersect R. R contains frame pixel coordinates. Value is
26232 non-zero if the exposure overwrites mouse-face. */
26235 expose_window_tree (struct window
*w
, XRectangle
*r
)
26237 struct frame
*f
= XFRAME (w
->frame
);
26238 int mouse_face_overwritten_p
= 0;
26240 while (w
&& !FRAME_GARBAGED_P (f
))
26242 if (!NILP (w
->hchild
))
26243 mouse_face_overwritten_p
26244 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26245 else if (!NILP (w
->vchild
))
26246 mouse_face_overwritten_p
26247 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26249 mouse_face_overwritten_p
|= expose_window (w
, r
);
26251 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26254 return mouse_face_overwritten_p
;
26259 Redisplay an exposed area of frame F. X and Y are the upper-left
26260 corner of the exposed rectangle. W and H are width and height of
26261 the exposed area. All are pixel values. W or H zero means redraw
26262 the entire frame. */
26265 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26268 int mouse_face_overwritten_p
= 0;
26270 TRACE ((stderr
, "expose_frame "));
26272 /* No need to redraw if frame will be redrawn soon. */
26273 if (FRAME_GARBAGED_P (f
))
26275 TRACE ((stderr
, " garbaged\n"));
26279 /* If basic faces haven't been realized yet, there is no point in
26280 trying to redraw anything. This can happen when we get an expose
26281 event while Emacs is starting, e.g. by moving another window. */
26282 if (FRAME_FACE_CACHE (f
) == NULL
26283 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26285 TRACE ((stderr
, " no faces\n"));
26289 if (w
== 0 || h
== 0)
26292 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26293 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26303 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26304 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26306 if (WINDOWP (f
->tool_bar_window
))
26307 mouse_face_overwritten_p
26308 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26310 #ifdef HAVE_X_WINDOWS
26312 #ifndef USE_X_TOOLKIT
26313 if (WINDOWP (f
->menu_bar_window
))
26314 mouse_face_overwritten_p
26315 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26316 #endif /* not USE_X_TOOLKIT */
26320 /* Some window managers support a focus-follows-mouse style with
26321 delayed raising of frames. Imagine a partially obscured frame,
26322 and moving the mouse into partially obscured mouse-face on that
26323 frame. The visible part of the mouse-face will be highlighted,
26324 then the WM raises the obscured frame. With at least one WM, KDE
26325 2.1, Emacs is not getting any event for the raising of the frame
26326 (even tried with SubstructureRedirectMask), only Expose events.
26327 These expose events will draw text normally, i.e. not
26328 highlighted. Which means we must redo the highlight here.
26329 Subsume it under ``we love X''. --gerd 2001-08-15 */
26330 /* Included in Windows version because Windows most likely does not
26331 do the right thing if any third party tool offers
26332 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26333 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26335 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26336 if (f
== hlinfo
->mouse_face_mouse_frame
)
26338 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26339 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26340 clear_mouse_face (hlinfo
);
26341 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26348 Determine the intersection of two rectangles R1 and R2. Return
26349 the intersection in *RESULT. Value is non-zero if RESULT is not
26353 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26355 XRectangle
*left
, *right
;
26356 XRectangle
*upper
, *lower
;
26357 int intersection_p
= 0;
26359 /* Rearrange so that R1 is the left-most rectangle. */
26361 left
= r1
, right
= r2
;
26363 left
= r2
, right
= r1
;
26365 /* X0 of the intersection is right.x0, if this is inside R1,
26366 otherwise there is no intersection. */
26367 if (right
->x
<= left
->x
+ left
->width
)
26369 result
->x
= right
->x
;
26371 /* The right end of the intersection is the minimum of the
26372 the right ends of left and right. */
26373 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26376 /* Same game for Y. */
26378 upper
= r1
, lower
= r2
;
26380 upper
= r2
, lower
= r1
;
26382 /* The upper end of the intersection is lower.y0, if this is inside
26383 of upper. Otherwise, there is no intersection. */
26384 if (lower
->y
<= upper
->y
+ upper
->height
)
26386 result
->y
= lower
->y
;
26388 /* The lower end of the intersection is the minimum of the lower
26389 ends of upper and lower. */
26390 result
->height
= (min (lower
->y
+ lower
->height
,
26391 upper
->y
+ upper
->height
)
26393 intersection_p
= 1;
26397 return intersection_p
;
26400 #endif /* HAVE_WINDOW_SYSTEM */
26403 /***********************************************************************
26405 ***********************************************************************/
26408 syms_of_xdisp (void)
26410 Vwith_echo_area_save_vector
= Qnil
;
26411 staticpro (&Vwith_echo_area_save_vector
);
26413 Vmessage_stack
= Qnil
;
26414 staticpro (&Vmessage_stack
);
26416 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26417 staticpro (&Qinhibit_redisplay
);
26419 message_dolog_marker1
= Fmake_marker ();
26420 staticpro (&message_dolog_marker1
);
26421 message_dolog_marker2
= Fmake_marker ();
26422 staticpro (&message_dolog_marker2
);
26423 message_dolog_marker3
= Fmake_marker ();
26424 staticpro (&message_dolog_marker3
);
26427 defsubr (&Sdump_frame_glyph_matrix
);
26428 defsubr (&Sdump_glyph_matrix
);
26429 defsubr (&Sdump_glyph_row
);
26430 defsubr (&Sdump_tool_bar_row
);
26431 defsubr (&Strace_redisplay
);
26432 defsubr (&Strace_to_stderr
);
26434 #ifdef HAVE_WINDOW_SYSTEM
26435 defsubr (&Stool_bar_lines_needed
);
26436 defsubr (&Slookup_image_map
);
26438 defsubr (&Sformat_mode_line
);
26439 defsubr (&Sinvisible_p
);
26440 defsubr (&Scurrent_bidi_paragraph_direction
);
26442 staticpro (&Qmenu_bar_update_hook
);
26443 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26445 staticpro (&Qoverriding_terminal_local_map
);
26446 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26448 staticpro (&Qoverriding_local_map
);
26449 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26451 staticpro (&Qwindow_scroll_functions
);
26452 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26454 staticpro (&Qwindow_text_change_functions
);
26455 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26457 staticpro (&Qredisplay_end_trigger_functions
);
26458 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26460 staticpro (&Qinhibit_point_motion_hooks
);
26461 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26463 Qeval
= intern_c_string ("eval");
26464 staticpro (&Qeval
);
26466 QCdata
= intern_c_string (":data");
26467 staticpro (&QCdata
);
26468 Qdisplay
= intern_c_string ("display");
26469 staticpro (&Qdisplay
);
26470 Qspace_width
= intern_c_string ("space-width");
26471 staticpro (&Qspace_width
);
26472 Qraise
= intern_c_string ("raise");
26473 staticpro (&Qraise
);
26474 Qslice
= intern_c_string ("slice");
26475 staticpro (&Qslice
);
26476 Qspace
= intern_c_string ("space");
26477 staticpro (&Qspace
);
26478 Qmargin
= intern_c_string ("margin");
26479 staticpro (&Qmargin
);
26480 Qpointer
= intern_c_string ("pointer");
26481 staticpro (&Qpointer
);
26482 Qleft_margin
= intern_c_string ("left-margin");
26483 staticpro (&Qleft_margin
);
26484 Qright_margin
= intern_c_string ("right-margin");
26485 staticpro (&Qright_margin
);
26486 Qcenter
= intern_c_string ("center");
26487 staticpro (&Qcenter
);
26488 Qline_height
= intern_c_string ("line-height");
26489 staticpro (&Qline_height
);
26490 QCalign_to
= intern_c_string (":align-to");
26491 staticpro (&QCalign_to
);
26492 QCrelative_width
= intern_c_string (":relative-width");
26493 staticpro (&QCrelative_width
);
26494 QCrelative_height
= intern_c_string (":relative-height");
26495 staticpro (&QCrelative_height
);
26496 QCeval
= intern_c_string (":eval");
26497 staticpro (&QCeval
);
26498 QCpropertize
= intern_c_string (":propertize");
26499 staticpro (&QCpropertize
);
26500 QCfile
= intern_c_string (":file");
26501 staticpro (&QCfile
);
26502 Qfontified
= intern_c_string ("fontified");
26503 staticpro (&Qfontified
);
26504 Qfontification_functions
= intern_c_string ("fontification-functions");
26505 staticpro (&Qfontification_functions
);
26506 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26507 staticpro (&Qtrailing_whitespace
);
26508 Qescape_glyph
= intern_c_string ("escape-glyph");
26509 staticpro (&Qescape_glyph
);
26510 Qnobreak_space
= intern_c_string ("nobreak-space");
26511 staticpro (&Qnobreak_space
);
26512 Qimage
= intern_c_string ("image");
26513 staticpro (&Qimage
);
26514 Qtext
= intern_c_string ("text");
26515 staticpro (&Qtext
);
26516 Qboth
= intern_c_string ("both");
26517 staticpro (&Qboth
);
26518 Qboth_horiz
= intern_c_string ("both-horiz");
26519 staticpro (&Qboth_horiz
);
26520 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26521 staticpro (&Qtext_image_horiz
);
26522 QCmap
= intern_c_string (":map");
26523 staticpro (&QCmap
);
26524 QCpointer
= intern_c_string (":pointer");
26525 staticpro (&QCpointer
);
26526 Qrect
= intern_c_string ("rect");
26527 staticpro (&Qrect
);
26528 Qcircle
= intern_c_string ("circle");
26529 staticpro (&Qcircle
);
26530 Qpoly
= intern_c_string ("poly");
26531 staticpro (&Qpoly
);
26532 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26533 staticpro (&Qmessage_truncate_lines
);
26534 Qgrow_only
= intern_c_string ("grow-only");
26535 staticpro (&Qgrow_only
);
26536 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26537 staticpro (&Qinhibit_menubar_update
);
26538 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26539 staticpro (&Qinhibit_eval_during_redisplay
);
26540 Qposition
= intern_c_string ("position");
26541 staticpro (&Qposition
);
26542 Qbuffer_position
= intern_c_string ("buffer-position");
26543 staticpro (&Qbuffer_position
);
26544 Qobject
= intern_c_string ("object");
26545 staticpro (&Qobject
);
26546 Qbar
= intern_c_string ("bar");
26548 Qhbar
= intern_c_string ("hbar");
26549 staticpro (&Qhbar
);
26550 Qbox
= intern_c_string ("box");
26552 Qhollow
= intern_c_string ("hollow");
26553 staticpro (&Qhollow
);
26554 Qhand
= intern_c_string ("hand");
26555 staticpro (&Qhand
);
26556 Qarrow
= intern_c_string ("arrow");
26557 staticpro (&Qarrow
);
26558 Qtext
= intern_c_string ("text");
26559 staticpro (&Qtext
);
26560 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26561 staticpro (&Qinhibit_free_realized_faces
);
26563 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26564 Fcons (intern_c_string ("void-variable"), Qnil
)),
26566 staticpro (&list_of_error
);
26568 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26569 staticpro (&Qlast_arrow_position
);
26570 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26571 staticpro (&Qlast_arrow_string
);
26573 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26574 staticpro (&Qoverlay_arrow_string
);
26575 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26576 staticpro (&Qoverlay_arrow_bitmap
);
26578 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26579 staticpro (&echo_buffer
[0]);
26580 staticpro (&echo_buffer
[1]);
26582 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26583 staticpro (&echo_area_buffer
[0]);
26584 staticpro (&echo_area_buffer
[1]);
26586 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26587 staticpro (&Vmessages_buffer_name
);
26589 mode_line_proptrans_alist
= Qnil
;
26590 staticpro (&mode_line_proptrans_alist
);
26591 mode_line_string_list
= Qnil
;
26592 staticpro (&mode_line_string_list
);
26593 mode_line_string_face
= Qnil
;
26594 staticpro (&mode_line_string_face
);
26595 mode_line_string_face_prop
= Qnil
;
26596 staticpro (&mode_line_string_face_prop
);
26597 Vmode_line_unwind_vector
= Qnil
;
26598 staticpro (&Vmode_line_unwind_vector
);
26600 help_echo_string
= Qnil
;
26601 staticpro (&help_echo_string
);
26602 help_echo_object
= Qnil
;
26603 staticpro (&help_echo_object
);
26604 help_echo_window
= Qnil
;
26605 staticpro (&help_echo_window
);
26606 previous_help_echo_string
= Qnil
;
26607 staticpro (&previous_help_echo_string
);
26608 help_echo_pos
= -1;
26610 Qright_to_left
= intern_c_string ("right-to-left");
26611 staticpro (&Qright_to_left
);
26612 Qleft_to_right
= intern_c_string ("left-to-right");
26613 staticpro (&Qleft_to_right
);
26615 #ifdef HAVE_WINDOW_SYSTEM
26616 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26617 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26618 For example, if a block cursor is over a tab, it will be drawn as
26619 wide as that tab on the display. */);
26620 x_stretch_cursor_p
= 0;
26623 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26624 doc
: /* *Non-nil means highlight trailing whitespace.
26625 The face used for trailing whitespace is `trailing-whitespace'. */);
26626 Vshow_trailing_whitespace
= Qnil
;
26628 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26629 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26630 A value of t means highlight the character itself (for nobreak space,
26631 use face `nobreak-space').
26632 A value of nil means no highlighting.
26633 Other values mean display the escape glyph followed by an ordinary
26634 space or ordinary hyphen. */);
26635 Vnobreak_char_display
= Qt
;
26637 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26638 doc
: /* *The pointer shape to show in void text areas.
26639 A value of nil means to show the text pointer. Other options are `arrow',
26640 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26641 Vvoid_text_area_pointer
= Qarrow
;
26643 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26644 doc
: /* Non-nil means don't actually do any redisplay.
26645 This is used for internal purposes. */);
26646 Vinhibit_redisplay
= Qnil
;
26648 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26649 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26650 Vglobal_mode_string
= Qnil
;
26652 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26653 doc
: /* Marker for where to display an arrow on top of the buffer text.
26654 This must be the beginning of a line in order to work.
26655 See also `overlay-arrow-string'. */);
26656 Voverlay_arrow_position
= Qnil
;
26658 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26659 doc
: /* String to display as an arrow in non-window frames.
26660 See also `overlay-arrow-position'. */);
26661 Voverlay_arrow_string
= make_pure_c_string ("=>");
26663 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26664 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26665 The symbols on this list are examined during redisplay to determine
26666 where to display overlay arrows. */);
26667 Voverlay_arrow_variable_list
26668 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26670 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26671 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26672 If that fails to bring point back on frame, point is centered instead.
26673 If this is zero, point is always centered after it moves off frame.
26674 If you want scrolling to always be a line at a time, you should set
26675 `scroll-conservatively' to a large value rather than set this to 1. */);
26677 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26678 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26679 If point moves off-screen, redisplay will scroll by up to
26680 `scroll-conservatively' lines in order to bring point just barely
26681 onto the screen again. If that cannot be done, then redisplay
26682 recenters point as usual.
26684 If the value is greater than 100, redisplay will never recenter point,
26685 but will always scroll just enough text to bring point into view, even
26686 if you move far away.
26688 A value of zero means always recenter point if it moves off screen. */);
26689 scroll_conservatively
= 0;
26691 DEFVAR_INT ("scroll-margin", scroll_margin
,
26692 doc
: /* *Number of lines of margin at the top and bottom of a window.
26693 Recenter the window whenever point gets within this many lines
26694 of the top or bottom of the window. */);
26697 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26698 doc
: /* Pixels per inch value for non-window system displays.
26699 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26700 Vdisplay_pixels_per_inch
= make_float (72.0);
26703 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26706 DEFVAR_LISP ("truncate-partial-width-windows",
26707 Vtruncate_partial_width_windows
,
26708 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26709 For an integer value, truncate lines in each window narrower than the
26710 full frame width, provided the window width is less than that integer;
26711 otherwise, respect the value of `truncate-lines'.
26713 For any other non-nil value, truncate lines in all windows that do
26714 not span the full frame width.
26716 A value of nil means to respect the value of `truncate-lines'.
26718 If `word-wrap' is enabled, you might want to reduce this. */);
26719 Vtruncate_partial_width_windows
= make_number (50);
26721 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26722 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26723 Any other value means to use the appropriate face, `mode-line',
26724 `header-line', or `menu' respectively. */);
26725 mode_line_inverse_video
= 1;
26727 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26728 doc
: /* *Maximum buffer size for which line number should be displayed.
26729 If the buffer is bigger than this, the line number does not appear
26730 in the mode line. A value of nil means no limit. */);
26731 Vline_number_display_limit
= Qnil
;
26733 DEFVAR_INT ("line-number-display-limit-width",
26734 line_number_display_limit_width
,
26735 doc
: /* *Maximum line width (in characters) for line number display.
26736 If the average length of the lines near point is bigger than this, then the
26737 line number may be omitted from the mode line. */);
26738 line_number_display_limit_width
= 200;
26740 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26741 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26742 highlight_nonselected_windows
= 0;
26744 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26745 doc
: /* Non-nil if more than one frame is visible on this display.
26746 Minibuffer-only frames don't count, but iconified frames do.
26747 This variable is not guaranteed to be accurate except while processing
26748 `frame-title-format' and `icon-title-format'. */);
26750 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26751 doc
: /* Template for displaying the title bar of visible frames.
26752 \(Assuming the window manager supports this feature.)
26754 This variable has the same structure as `mode-line-format', except that
26755 the %c and %l constructs are ignored. It is used only on frames for
26756 which no explicit name has been set \(see `modify-frame-parameters'). */);
26758 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26759 doc
: /* Template for displaying the title bar of an iconified frame.
26760 \(Assuming the window manager supports this feature.)
26761 This variable has the same structure as `mode-line-format' (which see),
26762 and is used only on frames for which no explicit name has been set
26763 \(see `modify-frame-parameters'). */);
26765 = Vframe_title_format
26766 = pure_cons (intern_c_string ("multiple-frames"),
26767 pure_cons (make_pure_c_string ("%b"),
26768 pure_cons (pure_cons (empty_unibyte_string
,
26769 pure_cons (intern_c_string ("invocation-name"),
26770 pure_cons (make_pure_c_string ("@"),
26771 pure_cons (intern_c_string ("system-name"),
26775 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26776 doc
: /* Maximum number of lines to keep in the message log buffer.
26777 If nil, disable message logging. If t, log messages but don't truncate
26778 the buffer when it becomes large. */);
26779 Vmessage_log_max
= make_number (100);
26781 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26782 doc
: /* Functions called before redisplay, if window sizes have changed.
26783 The value should be a list of functions that take one argument.
26784 Just before redisplay, for each frame, if any of its windows have changed
26785 size since the last redisplay, or have been split or deleted,
26786 all the functions in the list are called, with the frame as argument. */);
26787 Vwindow_size_change_functions
= Qnil
;
26789 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26790 doc
: /* List of functions to call before redisplaying a window with scrolling.
26791 Each function is called with two arguments, the window and its new
26792 display-start position. Note that these functions are also called by
26793 `set-window-buffer'. Also note that the value of `window-end' is not
26794 valid when these functions are called. */);
26795 Vwindow_scroll_functions
= Qnil
;
26797 DEFVAR_LISP ("window-text-change-functions",
26798 Vwindow_text_change_functions
,
26799 doc
: /* Functions to call in redisplay when text in the window might change. */);
26800 Vwindow_text_change_functions
= Qnil
;
26802 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26803 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26804 Each function is called with two arguments, the window and the end trigger value.
26805 See `set-window-redisplay-end-trigger'. */);
26806 Vredisplay_end_trigger_functions
= Qnil
;
26808 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26809 doc
: /* *Non-nil means autoselect window with mouse pointer.
26810 If nil, do not autoselect windows.
26811 A positive number means delay autoselection by that many seconds: a
26812 window is autoselected only after the mouse has remained in that
26813 window for the duration of the delay.
26814 A negative number has a similar effect, but causes windows to be
26815 autoselected only after the mouse has stopped moving. \(Because of
26816 the way Emacs compares mouse events, you will occasionally wait twice
26817 that time before the window gets selected.\)
26818 Any other value means to autoselect window instantaneously when the
26819 mouse pointer enters it.
26821 Autoselection selects the minibuffer only if it is active, and never
26822 unselects the minibuffer if it is active.
26824 When customizing this variable make sure that the actual value of
26825 `focus-follows-mouse' matches the behavior of your window manager. */);
26826 Vmouse_autoselect_window
= Qnil
;
26828 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26829 doc
: /* *Non-nil means automatically resize tool-bars.
26830 This dynamically changes the tool-bar's height to the minimum height
26831 that is needed to make all tool-bar items visible.
26832 If value is `grow-only', the tool-bar's height is only increased
26833 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26834 Vauto_resize_tool_bars
= Qt
;
26836 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26837 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26838 auto_raise_tool_bar_buttons_p
= 1;
26840 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26841 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26842 make_cursor_line_fully_visible_p
= 1;
26844 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26845 doc
: /* *Border below tool-bar in pixels.
26846 If an integer, use it as the height of the border.
26847 If it is one of `internal-border-width' or `border-width', use the
26848 value of the corresponding frame parameter.
26849 Otherwise, no border is added below the tool-bar. */);
26850 Vtool_bar_border
= Qinternal_border_width
;
26852 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26853 doc
: /* *Margin around tool-bar buttons in pixels.
26854 If an integer, use that for both horizontal and vertical margins.
26855 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26856 HORZ specifying the horizontal margin, and VERT specifying the
26857 vertical margin. */);
26858 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26860 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26861 doc
: /* *Relief thickness of tool-bar buttons. */);
26862 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26864 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26865 doc
: /* Tool bar style to use.
26867 image - show images only
26868 text - show text only
26869 both - show both, text below image
26870 both-horiz - show text to the right of the image
26871 text-image-horiz - show text to the left of the image
26872 any other - use system default or image if no system default. */);
26873 Vtool_bar_style
= Qnil
;
26875 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26876 doc
: /* *Maximum number of characters a label can have to be shown.
26877 The tool bar style must also show labels for this to have any effect, see
26878 `tool-bar-style'. */);
26879 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26881 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26882 doc
: /* List of functions to call to fontify regions of text.
26883 Each function is called with one argument POS. Functions must
26884 fontify a region starting at POS in the current buffer, and give
26885 fontified regions the property `fontified'. */);
26886 Vfontification_functions
= Qnil
;
26887 Fmake_variable_buffer_local (Qfontification_functions
);
26889 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26890 unibyte_display_via_language_environment
,
26891 doc
: /* *Non-nil means display unibyte text according to language environment.
26892 Specifically, this means that raw bytes in the range 160-255 decimal
26893 are displayed by converting them to the equivalent multibyte characters
26894 according to the current language environment. As a result, they are
26895 displayed according to the current fontset.
26897 Note that this variable affects only how these bytes are displayed,
26898 but does not change the fact they are interpreted as raw bytes. */);
26899 unibyte_display_via_language_environment
= 0;
26901 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26902 doc
: /* *Maximum height for resizing mini-windows.
26903 If a float, it specifies a fraction of the mini-window frame's height.
26904 If an integer, it specifies a number of lines. */);
26905 Vmax_mini_window_height
= make_float (0.25);
26907 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26908 doc
: /* *How to resize mini-windows.
26909 A value of nil means don't automatically resize mini-windows.
26910 A value of t means resize them to fit the text displayed in them.
26911 A value of `grow-only', the default, means let mini-windows grow
26912 only, until their display becomes empty, at which point the windows
26913 go back to their normal size. */);
26914 Vresize_mini_windows
= Qgrow_only
;
26916 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26917 doc
: /* Alist specifying how to blink the cursor off.
26918 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26919 `cursor-type' frame-parameter or variable equals ON-STATE,
26920 comparing using `equal', Emacs uses OFF-STATE to specify
26921 how to blink it off. ON-STATE and OFF-STATE are values for
26922 the `cursor-type' frame parameter.
26924 If a frame's ON-STATE has no entry in this list,
26925 the frame's other specifications determine how to blink the cursor off. */);
26926 Vblink_cursor_alist
= Qnil
;
26928 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26929 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26930 If non-nil, windows are automatically scrolled horizontally to make
26931 point visible. */);
26932 automatic_hscrolling_p
= 1;
26933 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26934 staticpro (&Qauto_hscroll_mode
);
26936 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26937 doc
: /* *How many columns away from the window edge point is allowed to get
26938 before automatic hscrolling will horizontally scroll the window. */);
26939 hscroll_margin
= 5;
26941 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26942 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26943 When point is less than `hscroll-margin' columns from the window
26944 edge, automatic hscrolling will scroll the window by the amount of columns
26945 determined by this variable. If its value is a positive integer, scroll that
26946 many columns. If it's a positive floating-point number, it specifies the
26947 fraction of the window's width to scroll. If it's nil or zero, point will be
26948 centered horizontally after the scroll. Any other value, including negative
26949 numbers, are treated as if the value were zero.
26951 Automatic hscrolling always moves point outside the scroll margin, so if
26952 point was more than scroll step columns inside the margin, the window will
26953 scroll more than the value given by the scroll step.
26955 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26956 and `scroll-right' overrides this variable's effect. */);
26957 Vhscroll_step
= make_number (0);
26959 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26960 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26961 Bind this around calls to `message' to let it take effect. */);
26962 message_truncate_lines
= 0;
26964 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26965 doc
: /* Normal hook run to update the menu bar definitions.
26966 Redisplay runs this hook before it redisplays the menu bar.
26967 This is used to update submenus such as Buffers,
26968 whose contents depend on various data. */);
26969 Vmenu_bar_update_hook
= Qnil
;
26971 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26972 doc
: /* Frame for which we are updating a menu.
26973 The enable predicate for a menu binding should check this variable. */);
26974 Vmenu_updating_frame
= Qnil
;
26976 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26977 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26978 inhibit_menubar_update
= 0;
26980 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26981 doc
: /* Prefix prepended to all continuation lines at display time.
26982 The value may be a string, an image, or a stretch-glyph; it is
26983 interpreted in the same way as the value of a `display' text property.
26985 This variable is overridden by any `wrap-prefix' text or overlay
26988 To add a prefix to non-continuation lines, use `line-prefix'. */);
26989 Vwrap_prefix
= Qnil
;
26990 staticpro (&Qwrap_prefix
);
26991 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26992 Fmake_variable_buffer_local (Qwrap_prefix
);
26994 DEFVAR_LISP ("line-prefix", Vline_prefix
,
26995 doc
: /* Prefix prepended to all non-continuation lines at display time.
26996 The value may be a string, an image, or a stretch-glyph; it is
26997 interpreted in the same way as the value of a `display' text property.
26999 This variable is overridden by any `line-prefix' text or overlay
27002 To add a prefix to continuation lines, use `wrap-prefix'. */);
27003 Vline_prefix
= Qnil
;
27004 staticpro (&Qline_prefix
);
27005 Qline_prefix
= intern_c_string ("line-prefix");
27006 Fmake_variable_buffer_local (Qline_prefix
);
27008 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27009 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27010 inhibit_eval_during_redisplay
= 0;
27012 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27013 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27014 inhibit_free_realized_faces
= 0;
27017 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27018 doc
: /* Inhibit try_window_id display optimization. */);
27019 inhibit_try_window_id
= 0;
27021 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27022 doc
: /* Inhibit try_window_reusing display optimization. */);
27023 inhibit_try_window_reusing
= 0;
27025 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27026 doc
: /* Inhibit try_cursor_movement display optimization. */);
27027 inhibit_try_cursor_movement
= 0;
27028 #endif /* GLYPH_DEBUG */
27030 DEFVAR_INT ("overline-margin", overline_margin
,
27031 doc
: /* *Space between overline and text, in pixels.
27032 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27033 margin to the caracter height. */);
27034 overline_margin
= 2;
27036 DEFVAR_INT ("underline-minimum-offset",
27037 underline_minimum_offset
,
27038 doc
: /* Minimum distance between baseline and underline.
27039 This can improve legibility of underlined text at small font sizes,
27040 particularly when using variable `x-use-underline-position-properties'
27041 with fonts that specify an UNDERLINE_POSITION relatively close to the
27042 baseline. The default value is 1. */);
27043 underline_minimum_offset
= 1;
27045 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27046 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27047 This feature only works when on a window system that can change
27048 cursor shapes. */);
27049 display_hourglass_p
= 1;
27051 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27052 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27053 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27055 hourglass_atimer
= NULL
;
27056 hourglass_shown_p
= 0;
27058 DEFSYM (Qglyphless_char
, "glyphless-char");
27059 DEFSYM (Qhex_code
, "hex-code");
27060 DEFSYM (Qempty_box
, "empty-box");
27061 DEFSYM (Qthin_space
, "thin-space");
27062 DEFSYM (Qzero_width
, "zero-width");
27064 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27065 /* Intern this now in case it isn't already done.
27066 Setting this variable twice is harmless.
27067 But don't staticpro it here--that is done in alloc.c. */
27068 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27069 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27071 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27072 doc
: /* Char-table defining glyphless characters.
27073 Each element, if non-nil, should be one of the following:
27074 an ASCII acronym string: display this string in a box
27075 `hex-code': display the hexadecimal code of a character in a box
27076 `empty-box': display as an empty box
27077 `thin-space': display as 1-pixel width space
27078 `zero-width': don't display
27079 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27080 display method for graphical terminals and text terminals respectively.
27081 GRAPHICAL and TEXT should each have one of the values listed above.
27083 The char-table has one extra slot to control the display of a character for
27084 which no font is found. This slot only takes effect on graphical terminals.
27085 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27086 `thin-space'. The default is `empty-box'. */);
27087 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27088 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27093 /* Initialize this module when Emacs starts. */
27098 Lisp_Object root_window
;
27099 struct window
*mini_w
;
27101 current_header_line_height
= current_mode_line_height
= -1;
27103 CHARPOS (this_line_start_pos
) = 0;
27105 mini_w
= XWINDOW (minibuf_window
);
27106 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27107 echo_area_window
= minibuf_window
;
27109 if (!noninteractive
)
27111 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27114 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27115 set_window_height (root_window
,
27116 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27118 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27119 set_window_height (minibuf_window
, 1, 0);
27121 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27122 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27124 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27125 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27126 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27128 /* The default ellipsis glyphs `...'. */
27129 for (i
= 0; i
< 3; ++i
)
27130 default_invis_vector
[i
] = make_number ('.');
27134 /* Allocate the buffer for frame titles.
27135 Also used for `format-mode-line'. */
27137 mode_line_noprop_buf
= (char *) xmalloc (size
);
27138 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27139 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27140 mode_line_target
= MODE_LINE_DISPLAY
;
27143 help_echo_showing_p
= 0;
27146 /* Since w32 does not support atimers, it defines its own implementation of
27147 the following three functions in w32fns.c. */
27150 /* Platform-independent portion of hourglass implementation. */
27152 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27154 hourglass_started (void)
27156 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27159 /* Cancel a currently active hourglass timer, and start a new one. */
27161 start_hourglass (void)
27163 #if defined (HAVE_WINDOW_SYSTEM)
27165 int secs
, usecs
= 0;
27167 cancel_hourglass ();
27169 if (INTEGERP (Vhourglass_delay
)
27170 && XINT (Vhourglass_delay
) > 0)
27171 secs
= XFASTINT (Vhourglass_delay
);
27172 else if (FLOATP (Vhourglass_delay
)
27173 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27176 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27177 secs
= XFASTINT (tem
);
27178 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27181 secs
= DEFAULT_HOURGLASS_DELAY
;
27183 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27184 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27185 show_hourglass
, NULL
);
27190 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27193 cancel_hourglass (void)
27195 #if defined (HAVE_WINDOW_SYSTEM)
27196 if (hourglass_atimer
)
27198 cancel_atimer (hourglass_atimer
);
27199 hourglass_atimer
= NULL
;
27202 if (hourglass_shown_p
)
27206 #endif /* ! WINDOWSNT */