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 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 void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
783 static void ensure_echo_area_buffers (void);
784 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
785 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
786 static int with_echo_area_buffer (struct window
*, int,
787 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
788 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
789 static void clear_garbaged_frames (void);
790 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
791 static void pop_message (void);
792 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
793 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
794 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
795 static int display_echo_area (struct window
*);
796 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
797 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
798 static Lisp_Object
unwind_redisplay (Lisp_Object
);
799 static int string_char_and_length (const unsigned char *, int *);
800 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
802 static int compute_window_start_on_continuation_line (struct window
*);
803 static Lisp_Object
safe_eval_handler (Lisp_Object
);
804 static void insert_left_trunc_glyphs (struct it
*);
805 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
807 static void extend_face_to_end_of_line (struct it
*);
808 static int append_space_for_newline (struct it
*, int);
809 static int cursor_row_fully_visible_p (struct window
*, int, int);
810 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
811 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
812 static int trailing_whitespace_p (EMACS_INT
);
813 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
814 static void push_it (struct it
*, struct text_pos
*);
815 static void pop_it (struct it
*);
816 static void sync_frame_with_window_matrix_rows (struct window
*);
817 static void select_frame_for_redisplay (Lisp_Object
);
818 static void redisplay_internal (void);
819 static int echo_area_display (int);
820 static void redisplay_windows (Lisp_Object
);
821 static void redisplay_window (Lisp_Object
, int);
822 static Lisp_Object
redisplay_window_error (Lisp_Object
);
823 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
824 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
825 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
826 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
828 static int update_menu_bar (struct frame
*, int, int);
829 static int try_window_reusing_current_matrix (struct window
*);
830 static int try_window_id (struct window
*);
831 static int display_line (struct it
*);
832 static int display_mode_lines (struct window
*);
833 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
834 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
835 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
836 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
837 static void display_menu_bar (struct window
*);
838 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
840 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
841 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
842 static void compute_line_metrics (struct it
*);
843 static void run_redisplay_end_trigger_hook (struct it
*);
844 static int get_overlay_strings (struct it
*, EMACS_INT
);
845 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
846 static void next_overlay_string (struct it
*);
847 static void reseat (struct it
*, struct text_pos
, int);
848 static void reseat_1 (struct it
*, struct text_pos
, int);
849 static void back_to_previous_visible_line_start (struct it
*);
850 void reseat_at_previous_visible_line_start (struct it
*);
851 static void reseat_at_next_visible_line_start (struct it
*, int);
852 static int next_element_from_ellipsis (struct it
*);
853 static int next_element_from_display_vector (struct it
*);
854 static int next_element_from_string (struct it
*);
855 static int next_element_from_c_string (struct it
*);
856 static int next_element_from_buffer (struct it
*);
857 static int next_element_from_composition (struct it
*);
858 static int next_element_from_image (struct it
*);
859 static int next_element_from_stretch (struct it
*);
860 static void load_overlay_strings (struct it
*, EMACS_INT
);
861 static int init_from_display_pos (struct it
*, struct window
*,
862 struct display_pos
*);
863 static void reseat_to_string (struct it
*, const char *,
864 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
865 static int get_next_display_element (struct it
*);
866 static enum move_it_result
867 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
868 enum move_operation_enum
);
869 void move_it_vertically_backward (struct it
*, int);
870 static void init_to_row_start (struct it
*, struct window
*,
872 static int init_to_row_end (struct it
*, struct window
*,
874 static void back_to_previous_line_start (struct it
*);
875 static int forward_to_next_line_start (struct it
*, int *);
876 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
877 Lisp_Object
, EMACS_INT
);
878 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
879 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
880 static EMACS_INT
number_of_chars (const char *, int);
881 static void compute_stop_pos (struct it
*);
882 static void compute_string_pos (struct text_pos
*, struct text_pos
,
884 static int face_before_or_after_it_pos (struct it
*, int);
885 static EMACS_INT
next_overlay_change (EMACS_INT
);
886 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
887 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
888 static int handle_single_display_spec (struct it
*, Lisp_Object
,
889 Lisp_Object
, Lisp_Object
,
890 struct text_pos
*, EMACS_INT
, int, int);
891 static int underlying_face_id (struct it
*);
892 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
895 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
896 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
898 #ifdef HAVE_WINDOW_SYSTEM
900 static void x_consider_frame_title (Lisp_Object
);
901 static int tool_bar_lines_needed (struct frame
*, int *);
902 static void update_tool_bar (struct frame
*, int);
903 static void build_desired_tool_bar_string (struct frame
*f
);
904 static int redisplay_tool_bar (struct frame
*);
905 static void display_tool_bar_line (struct it
*, int);
906 static void notice_overwritten_cursor (struct window
*,
909 static void append_stretch_glyph (struct it
*, Lisp_Object
,
913 #endif /* HAVE_WINDOW_SYSTEM */
915 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
916 static int coords_in_mouse_face_p (struct window
*, int, int);
920 /***********************************************************************
921 Window display dimensions
922 ***********************************************************************/
924 /* Return the bottom boundary y-position for text lines in window W.
925 This is the first y position at which a line cannot start.
926 It is relative to the top of the window.
928 This is the height of W minus the height of a mode line, if any. */
931 window_text_bottom_y (struct window
*w
)
933 int height
= WINDOW_TOTAL_HEIGHT (w
);
935 if (WINDOW_WANTS_MODELINE_P (w
))
936 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
940 /* Return the pixel width of display area AREA of window W. AREA < 0
941 means return the total width of W, not including fringes to
942 the left and right of the window. */
945 window_box_width (struct window
*w
, int area
)
947 int cols
= XFASTINT (w
->total_cols
);
950 if (!w
->pseudo_window_p
)
952 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
954 if (area
== TEXT_AREA
)
956 if (INTEGERP (w
->left_margin_cols
))
957 cols
-= XFASTINT (w
->left_margin_cols
);
958 if (INTEGERP (w
->right_margin_cols
))
959 cols
-= XFASTINT (w
->right_margin_cols
);
960 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
962 else if (area
== LEFT_MARGIN_AREA
)
964 cols
= (INTEGERP (w
->left_margin_cols
)
965 ? XFASTINT (w
->left_margin_cols
) : 0);
968 else if (area
== RIGHT_MARGIN_AREA
)
970 cols
= (INTEGERP (w
->right_margin_cols
)
971 ? XFASTINT (w
->right_margin_cols
) : 0);
976 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
980 /* Return the pixel height of the display area of window W, not
981 including mode lines of W, if any. */
984 window_box_height (struct window
*w
)
986 struct frame
*f
= XFRAME (w
->frame
);
987 int height
= WINDOW_TOTAL_HEIGHT (w
);
989 xassert (height
>= 0);
991 /* Note: the code below that determines the mode-line/header-line
992 height is essentially the same as that contained in the macro
993 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
994 the appropriate glyph row has its `mode_line_p' flag set,
995 and if it doesn't, uses estimate_mode_line_height instead. */
997 if (WINDOW_WANTS_MODELINE_P (w
))
999 struct glyph_row
*ml_row
1000 = (w
->current_matrix
&& w
->current_matrix
->rows
1001 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1003 if (ml_row
&& ml_row
->mode_line_p
)
1004 height
-= ml_row
->height
;
1006 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1009 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1011 struct glyph_row
*hl_row
1012 = (w
->current_matrix
&& w
->current_matrix
->rows
1013 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1015 if (hl_row
&& hl_row
->mode_line_p
)
1016 height
-= hl_row
->height
;
1018 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1021 /* With a very small font and a mode-line that's taller than
1022 default, we might end up with a negative height. */
1023 return max (0, height
);
1026 /* Return the window-relative coordinate of the left edge of display
1027 area AREA of window W. AREA < 0 means return the left edge of the
1028 whole window, to the right of the left fringe of W. */
1031 window_box_left_offset (struct window
*w
, int area
)
1035 if (w
->pseudo_window_p
)
1038 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1040 if (area
== TEXT_AREA
)
1041 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1042 + window_box_width (w
, LEFT_MARGIN_AREA
));
1043 else if (area
== RIGHT_MARGIN_AREA
)
1044 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1045 + window_box_width (w
, LEFT_MARGIN_AREA
)
1046 + window_box_width (w
, TEXT_AREA
)
1047 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1049 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1050 else if (area
== LEFT_MARGIN_AREA
1051 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1052 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1058 /* Return the window-relative coordinate of the right edge of display
1059 area AREA of window W. AREA < 0 means return the right edge of the
1060 whole window, to the left of the right fringe of W. */
1063 window_box_right_offset (struct window
*w
, int area
)
1065 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1068 /* Return the frame-relative coordinate of the left edge of display
1069 area AREA of window W. AREA < 0 means return the left edge of the
1070 whole window, to the right of the left fringe of W. */
1073 window_box_left (struct window
*w
, int area
)
1075 struct frame
*f
= XFRAME (w
->frame
);
1078 if (w
->pseudo_window_p
)
1079 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1081 x
= (WINDOW_LEFT_EDGE_X (w
)
1082 + window_box_left_offset (w
, area
));
1088 /* Return the frame-relative coordinate of the right edge of display
1089 area AREA of window W. AREA < 0 means return the right edge of the
1090 whole window, to the left of the right fringe of W. */
1093 window_box_right (struct window
*w
, int area
)
1095 return window_box_left (w
, area
) + window_box_width (w
, area
);
1098 /* Get the bounding box of the display area AREA of window W, without
1099 mode lines, in frame-relative coordinates. AREA < 0 means the
1100 whole window, not including the left and right fringes of
1101 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1102 coordinates of the upper-left corner of the box. Return in
1103 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1106 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1107 int *box_width
, int *box_height
)
1110 *box_width
= window_box_width (w
, area
);
1112 *box_height
= window_box_height (w
);
1114 *box_x
= window_box_left (w
, area
);
1117 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1118 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1119 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1124 /* Get the bounding box of the display area AREA of window W, without
1125 mode lines. AREA < 0 means the whole window, not including the
1126 left and right fringe of the window. Return in *TOP_LEFT_X
1127 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1128 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1129 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1133 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1134 int *bottom_right_x
, int *bottom_right_y
)
1136 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1138 *bottom_right_x
+= *top_left_x
;
1139 *bottom_right_y
+= *top_left_y
;
1144 /***********************************************************************
1146 ***********************************************************************/
1148 /* Return the bottom y-position of the line the iterator IT is in.
1149 This can modify IT's settings. */
1152 line_bottom_y (struct it
*it
)
1154 int line_height
= it
->max_ascent
+ it
->max_descent
;
1155 int line_top_y
= it
->current_y
;
1157 if (line_height
== 0)
1160 line_height
= last_height
;
1161 else if (IT_CHARPOS (*it
) < ZV
)
1163 move_it_by_lines (it
, 1);
1164 line_height
= (it
->max_ascent
|| it
->max_descent
1165 ? it
->max_ascent
+ it
->max_descent
1170 struct glyph_row
*row
= it
->glyph_row
;
1172 /* Use the default character height. */
1173 it
->glyph_row
= NULL
;
1174 it
->what
= IT_CHARACTER
;
1177 PRODUCE_GLYPHS (it
);
1178 line_height
= it
->ascent
+ it
->descent
;
1179 it
->glyph_row
= row
;
1183 return line_top_y
+ line_height
;
1187 /* Return 1 if position CHARPOS is visible in window W.
1188 CHARPOS < 0 means return info about WINDOW_END position.
1189 If visible, set *X and *Y to pixel coordinates of top left corner.
1190 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1191 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1194 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1195 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1198 struct text_pos top
;
1200 struct buffer
*old_buffer
= NULL
;
1202 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1205 if (XBUFFER (w
->buffer
) != current_buffer
)
1207 old_buffer
= current_buffer
;
1208 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1211 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1213 /* Compute exact mode line heights. */
1214 if (WINDOW_WANTS_MODELINE_P (w
))
1215 current_mode_line_height
1216 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1217 BVAR (current_buffer
, mode_line_format
));
1219 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1220 current_header_line_height
1221 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1222 BVAR (current_buffer
, header_line_format
));
1224 start_display (&it
, w
, top
);
1225 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1226 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1228 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1230 /* We have reached CHARPOS, or passed it. How the call to
1231 move_it_to can overshoot: (i) If CHARPOS is on invisible
1232 text, move_it_to stops at the end of the invisible text,
1233 after CHARPOS. (ii) If CHARPOS is in a display vector,
1234 move_it_to stops on its last glyph. */
1235 int top_x
= it
.current_x
;
1236 int top_y
= it
.current_y
;
1237 enum it_method it_method
= it
.method
;
1238 /* Calling line_bottom_y may change it.method, it.position, etc. */
1239 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1240 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1242 if (top_y
< window_top_y
)
1243 visible_p
= bottom_y
> window_top_y
;
1244 else if (top_y
< it
.last_visible_y
)
1248 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1250 /* We stopped on the last glyph of a display vector.
1251 Try and recompute. Hack alert! */
1252 if (charpos
< 2 || top
.charpos
>= charpos
)
1253 top_x
= it
.glyph_row
->x
;
1257 start_display (&it2
, w
, top
);
1258 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1259 get_next_display_element (&it2
);
1260 PRODUCE_GLYPHS (&it2
);
1261 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1262 || it2
.current_x
> it2
.last_visible_x
)
1263 top_x
= it
.glyph_row
->x
;
1266 top_x
= it2
.current_x
;
1267 top_y
= it2
.current_y
;
1273 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1274 *rtop
= max (0, window_top_y
- top_y
);
1275 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1276 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1277 - max (top_y
, window_top_y
)));
1286 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1287 move_it_by_lines (&it
, 1);
1288 if (charpos
< IT_CHARPOS (it
)
1289 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1292 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1294 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1295 *rtop
= max (0, -it2
.current_y
);
1296 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1297 - it
.last_visible_y
));
1298 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1300 - max (it2
.current_y
,
1301 WINDOW_HEADER_LINE_HEIGHT (w
))));
1307 set_buffer_internal_1 (old_buffer
);
1309 current_header_line_height
= current_mode_line_height
= -1;
1311 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1312 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1315 /* Debugging code. */
1317 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1318 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1320 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1327 /* Return the next character from STR. Return in *LEN the length of
1328 the character. This is like STRING_CHAR_AND_LENGTH but never
1329 returns an invalid character. If we find one, we return a `?', but
1330 with the length of the invalid character. */
1333 string_char_and_length (const unsigned char *str
, int *len
)
1337 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1338 if (!CHAR_VALID_P (c
))
1339 /* We may not change the length here because other places in Emacs
1340 don't use this function, i.e. they silently accept invalid
1349 /* Given a position POS containing a valid character and byte position
1350 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1352 static struct text_pos
1353 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1355 xassert (STRINGP (string
) && nchars
>= 0);
1357 if (STRING_MULTIBYTE (string
))
1359 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1364 string_char_and_length (p
, &len
);
1367 BYTEPOS (pos
) += len
;
1371 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1377 /* Value is the text position, i.e. character and byte position,
1378 for character position CHARPOS in STRING. */
1380 static inline struct text_pos
1381 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1383 struct text_pos pos
;
1384 xassert (STRINGP (string
));
1385 xassert (charpos
>= 0);
1386 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1391 /* Value is a text position, i.e. character and byte position, for
1392 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1393 means recognize multibyte characters. */
1395 static struct text_pos
1396 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1398 struct text_pos pos
;
1400 xassert (s
!= NULL
);
1401 xassert (charpos
>= 0);
1407 SET_TEXT_POS (pos
, 0, 0);
1410 string_char_and_length ((const unsigned char *) s
, &len
);
1413 BYTEPOS (pos
) += len
;
1417 SET_TEXT_POS (pos
, charpos
, charpos
);
1423 /* Value is the number of characters in C string S. MULTIBYTE_P
1424 non-zero means recognize multibyte characters. */
1427 number_of_chars (const char *s
, int multibyte_p
)
1433 EMACS_INT rest
= strlen (s
);
1435 const unsigned char *p
= (const unsigned char *) s
;
1437 for (nchars
= 0; rest
> 0; ++nchars
)
1439 string_char_and_length (p
, &len
);
1440 rest
-= len
, p
+= len
;
1444 nchars
= strlen (s
);
1450 /* Compute byte position NEWPOS->bytepos corresponding to
1451 NEWPOS->charpos. POS is a known position in string STRING.
1452 NEWPOS->charpos must be >= POS.charpos. */
1455 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1457 xassert (STRINGP (string
));
1458 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1460 if (STRING_MULTIBYTE (string
))
1461 *newpos
= string_pos_nchars_ahead (pos
, string
,
1462 CHARPOS (*newpos
) - CHARPOS (pos
));
1464 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1468 Return an estimation of the pixel height of mode or header lines on
1469 frame F. FACE_ID specifies what line's height to estimate. */
1472 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1474 #ifdef HAVE_WINDOW_SYSTEM
1475 if (FRAME_WINDOW_P (f
))
1477 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1479 /* This function is called so early when Emacs starts that the face
1480 cache and mode line face are not yet initialized. */
1481 if (FRAME_FACE_CACHE (f
))
1483 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1487 height
= FONT_HEIGHT (face
->font
);
1488 if (face
->box_line_width
> 0)
1489 height
+= 2 * face
->box_line_width
;
1500 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1501 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1502 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1503 not force the value into range. */
1506 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1507 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1510 #ifdef HAVE_WINDOW_SYSTEM
1511 if (FRAME_WINDOW_P (f
))
1513 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1514 even for negative values. */
1516 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1518 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1520 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1521 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1524 STORE_NATIVE_RECT (*bounds
,
1525 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1526 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1527 FRAME_COLUMN_WIDTH (f
) - 1,
1528 FRAME_LINE_HEIGHT (f
) - 1);
1534 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1535 pix_x
= FRAME_TOTAL_COLS (f
);
1539 else if (pix_y
> FRAME_LINES (f
))
1540 pix_y
= FRAME_LINES (f
);
1550 /* Find the glyph under window-relative coordinates X/Y in window W.
1551 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1552 strings. Return in *HPOS and *VPOS the row and column number of
1553 the glyph found. Return in *AREA the glyph area containing X.
1554 Value is a pointer to the glyph found or null if X/Y is not on
1555 text, or we can't tell because W's current matrix is not up to
1560 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1561 int *dx
, int *dy
, int *area
)
1563 struct glyph
*glyph
, *end
;
1564 struct glyph_row
*row
= NULL
;
1567 /* Find row containing Y. Give up if some row is not enabled. */
1568 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1570 row
= MATRIX_ROW (w
->current_matrix
, i
);
1571 if (!row
->enabled_p
)
1573 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1580 /* Give up if Y is not in the window. */
1581 if (i
== w
->current_matrix
->nrows
)
1584 /* Get the glyph area containing X. */
1585 if (w
->pseudo_window_p
)
1592 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1594 *area
= LEFT_MARGIN_AREA
;
1595 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1597 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1600 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1604 *area
= RIGHT_MARGIN_AREA
;
1605 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1609 /* Find glyph containing X. */
1610 glyph
= row
->glyphs
[*area
];
1611 end
= glyph
+ row
->used
[*area
];
1613 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1615 x
-= glyph
->pixel_width
;
1625 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1628 *hpos
= glyph
- row
->glyphs
[*area
];
1632 /* Convert frame-relative x/y to coordinates relative to window W.
1633 Takes pseudo-windows into account. */
1636 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1638 if (w
->pseudo_window_p
)
1640 /* A pseudo-window is always full-width, and starts at the
1641 left edge of the frame, plus a frame border. */
1642 struct frame
*f
= XFRAME (w
->frame
);
1643 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1644 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1648 *x
-= WINDOW_LEFT_EDGE_X (w
);
1649 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1653 #ifdef HAVE_WINDOW_SYSTEM
1656 Return in RECTS[] at most N clipping rectangles for glyph string S.
1657 Return the number of stored rectangles. */
1660 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1667 if (s
->row
->full_width_p
)
1669 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1670 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1671 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1673 /* Unless displaying a mode or menu bar line, which are always
1674 fully visible, clip to the visible part of the row. */
1675 if (s
->w
->pseudo_window_p
)
1676 r
.height
= s
->row
->visible_height
;
1678 r
.height
= s
->height
;
1682 /* This is a text line that may be partially visible. */
1683 r
.x
= window_box_left (s
->w
, s
->area
);
1684 r
.width
= window_box_width (s
->w
, s
->area
);
1685 r
.height
= s
->row
->visible_height
;
1689 if (r
.x
< s
->clip_head
->x
)
1691 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1692 r
.width
-= s
->clip_head
->x
- r
.x
;
1695 r
.x
= s
->clip_head
->x
;
1698 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1700 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1701 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1706 /* If S draws overlapping rows, it's sufficient to use the top and
1707 bottom of the window for clipping because this glyph string
1708 intentionally draws over other lines. */
1709 if (s
->for_overlaps
)
1711 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1712 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1714 /* Alas, the above simple strategy does not work for the
1715 environments with anti-aliased text: if the same text is
1716 drawn onto the same place multiple times, it gets thicker.
1717 If the overlap we are processing is for the erased cursor, we
1718 take the intersection with the rectagle of the cursor. */
1719 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1721 XRectangle rc
, r_save
= r
;
1723 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1724 rc
.y
= s
->w
->phys_cursor
.y
;
1725 rc
.width
= s
->w
->phys_cursor_width
;
1726 rc
.height
= s
->w
->phys_cursor_height
;
1728 x_intersect_rectangles (&r_save
, &rc
, &r
);
1733 /* Don't use S->y for clipping because it doesn't take partially
1734 visible lines into account. For example, it can be negative for
1735 partially visible lines at the top of a window. */
1736 if (!s
->row
->full_width_p
1737 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1738 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1740 r
.y
= max (0, s
->row
->y
);
1743 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1745 /* If drawing the cursor, don't let glyph draw outside its
1746 advertised boundaries. Cleartype does this under some circumstances. */
1747 if (s
->hl
== DRAW_CURSOR
)
1749 struct glyph
*glyph
= s
->first_glyph
;
1754 r
.width
-= s
->x
- r
.x
;
1757 r
.width
= min (r
.width
, glyph
->pixel_width
);
1759 /* If r.y is below window bottom, ensure that we still see a cursor. */
1760 height
= min (glyph
->ascent
+ glyph
->descent
,
1761 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1762 max_y
= window_text_bottom_y (s
->w
) - height
;
1763 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1764 if (s
->ybase
- glyph
->ascent
> max_y
)
1771 /* Don't draw cursor glyph taller than our actual glyph. */
1772 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1773 if (height
< r
.height
)
1775 max_y
= r
.y
+ r
.height
;
1776 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1777 r
.height
= min (max_y
- r
.y
, height
);
1784 XRectangle r_save
= r
;
1786 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1790 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1791 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1793 #ifdef CONVERT_FROM_XRECT
1794 CONVERT_FROM_XRECT (r
, *rects
);
1802 /* If we are processing overlapping and allowed to return
1803 multiple clipping rectangles, we exclude the row of the glyph
1804 string from the clipping rectangle. This is to avoid drawing
1805 the same text on the environment with anti-aliasing. */
1806 #ifdef CONVERT_FROM_XRECT
1809 XRectangle
*rs
= rects
;
1811 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1813 if (s
->for_overlaps
& OVERLAPS_PRED
)
1816 if (r
.y
+ r
.height
> row_y
)
1819 rs
[i
].height
= row_y
- r
.y
;
1825 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1828 if (r
.y
< row_y
+ s
->row
->visible_height
)
1830 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1832 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1833 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1842 #ifdef CONVERT_FROM_XRECT
1843 for (i
= 0; i
< n
; i
++)
1844 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1851 Return in *NR the clipping rectangle for glyph string S. */
1854 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1856 get_glyph_string_clip_rects (s
, nr
, 1);
1861 Return the position and height of the phys cursor in window W.
1862 Set w->phys_cursor_width to width of phys cursor.
1866 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1867 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1869 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1870 int x
, y
, wd
, h
, h0
, y0
;
1872 /* Compute the width of the rectangle to draw. If on a stretch
1873 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1874 rectangle as wide as the glyph, but use a canonical character
1876 wd
= glyph
->pixel_width
- 1;
1877 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1881 x
= w
->phys_cursor
.x
;
1888 if (glyph
->type
== STRETCH_GLYPH
1889 && !x_stretch_cursor_p
)
1890 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1891 w
->phys_cursor_width
= wd
;
1893 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1895 /* If y is below window bottom, ensure that we still see a cursor. */
1896 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1898 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1899 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1901 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1904 h
= max (h
- (y0
- y
) + 1, h0
);
1909 y0
= window_text_bottom_y (w
) - h0
;
1917 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1918 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1923 * Remember which glyph the mouse is over.
1927 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1931 struct glyph_row
*r
, *gr
, *end_row
;
1932 enum window_part part
;
1933 enum glyph_row_area area
;
1934 int x
, y
, width
, height
;
1936 /* Try to determine frame pixel position and size of the glyph under
1937 frame pixel coordinates X/Y on frame F. */
1939 if (!f
->glyphs_initialized_p
1940 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1943 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1944 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1948 w
= XWINDOW (window
);
1949 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1950 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1952 x
= window_relative_x_coord (w
, part
, gx
);
1953 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1955 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1956 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1958 if (w
->pseudo_window_p
)
1961 part
= ON_MODE_LINE
; /* Don't adjust margin. */
1967 case ON_LEFT_MARGIN
:
1968 area
= LEFT_MARGIN_AREA
;
1971 case ON_RIGHT_MARGIN
:
1972 area
= RIGHT_MARGIN_AREA
;
1975 case ON_HEADER_LINE
:
1977 gr
= (part
== ON_HEADER_LINE
1978 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1979 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
1982 goto text_glyph_row_found
;
1989 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
1990 if (r
->y
+ r
->height
> y
)
1996 text_glyph_row_found
:
1999 struct glyph
*g
= gr
->glyphs
[area
];
2000 struct glyph
*end
= g
+ gr
->used
[area
];
2002 height
= gr
->height
;
2003 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2004 if (gx
+ g
->pixel_width
> x
)
2009 if (g
->type
== IMAGE_GLYPH
)
2011 /* Don't remember when mouse is over image, as
2012 image may have hot-spots. */
2013 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2016 width
= g
->pixel_width
;
2020 /* Use nominal char spacing at end of line. */
2022 gx
+= (x
/ width
) * width
;
2025 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2026 gx
+= window_box_left_offset (w
, area
);
2030 /* Use nominal line height at end of window. */
2031 gx
= (x
/ width
) * width
;
2033 gy
+= (y
/ height
) * height
;
2037 case ON_LEFT_FRINGE
:
2038 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2039 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2040 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2041 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2044 case ON_RIGHT_FRINGE
:
2045 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2046 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2047 : window_box_right_offset (w
, TEXT_AREA
));
2048 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2052 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2054 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2055 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2056 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2058 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2062 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2063 if (r
->y
+ r
->height
> y
)
2070 height
= gr
->height
;
2073 /* Use nominal line height at end of window. */
2075 gy
+= (y
/ height
) * height
;
2082 /* If there is no glyph under the mouse, then we divide the screen
2083 into a grid of the smallest glyph in the frame, and use that
2086 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2087 round down even for negative values. */
2093 gx
= (gx
/ width
) * width
;
2094 gy
= (gy
/ height
) * height
;
2099 gx
+= WINDOW_LEFT_EDGE_X (w
);
2100 gy
+= WINDOW_TOP_EDGE_Y (w
);
2103 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2105 /* Visible feedback for debugging. */
2108 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2109 f
->output_data
.x
->normal_gc
,
2110 gx
, gy
, width
, height
);
2116 #endif /* HAVE_WINDOW_SYSTEM */
2119 /***********************************************************************
2120 Lisp form evaluation
2121 ***********************************************************************/
2123 /* Error handler for safe_eval and safe_call. */
2126 safe_eval_handler (Lisp_Object arg
)
2128 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2133 /* Evaluate SEXPR and return the result, or nil if something went
2134 wrong. Prevent redisplay during the evaluation. */
2136 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2137 Return the result, or nil if something went wrong. Prevent
2138 redisplay during the evaluation. */
2141 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2145 if (inhibit_eval_during_redisplay
)
2149 int count
= SPECPDL_INDEX ();
2150 struct gcpro gcpro1
;
2153 gcpro1
.nvars
= nargs
;
2154 specbind (Qinhibit_redisplay
, Qt
);
2155 /* Use Qt to ensure debugger does not run,
2156 so there is no possibility of wanting to redisplay. */
2157 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2160 val
= unbind_to (count
, val
);
2167 /* Call function FN with one argument ARG.
2168 Return the result, or nil if something went wrong. */
2171 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2173 Lisp_Object args
[2];
2176 return safe_call (2, args
);
2179 static Lisp_Object Qeval
;
2182 safe_eval (Lisp_Object sexpr
)
2184 return safe_call1 (Qeval
, sexpr
);
2187 /* Call function FN with one argument ARG.
2188 Return the result, or nil if something went wrong. */
2191 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2193 Lisp_Object args
[3];
2197 return safe_call (3, args
);
2202 /***********************************************************************
2204 ***********************************************************************/
2208 /* Define CHECK_IT to perform sanity checks on iterators.
2209 This is for debugging. It is too slow to do unconditionally. */
2215 if (it
->method
== GET_FROM_STRING
)
2217 xassert (STRINGP (it
->string
));
2218 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2222 xassert (IT_STRING_CHARPOS (*it
) < 0);
2223 if (it
->method
== GET_FROM_BUFFER
)
2225 /* Check that character and byte positions agree. */
2226 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2231 xassert (it
->current
.dpvec_index
>= 0);
2233 xassert (it
->current
.dpvec_index
< 0);
2236 #define CHECK_IT(IT) check_it ((IT))
2240 #define CHECK_IT(IT) (void) 0
2247 /* Check that the window end of window W is what we expect it
2248 to be---the last row in the current matrix displaying text. */
2251 check_window_end (struct window
*w
)
2253 if (!MINI_WINDOW_P (w
)
2254 && !NILP (w
->window_end_valid
))
2256 struct glyph_row
*row
;
2257 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2258 XFASTINT (w
->window_end_vpos
)),
2260 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2261 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2265 #define CHECK_WINDOW_END(W) check_window_end ((W))
2267 #else /* not GLYPH_DEBUG */
2269 #define CHECK_WINDOW_END(W) (void) 0
2271 #endif /* not GLYPH_DEBUG */
2275 /***********************************************************************
2276 Iterator initialization
2277 ***********************************************************************/
2279 /* Initialize IT for displaying current_buffer in window W, starting
2280 at character position CHARPOS. CHARPOS < 0 means that no buffer
2281 position is specified which is useful when the iterator is assigned
2282 a position later. BYTEPOS is the byte position corresponding to
2283 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2285 If ROW is not null, calls to produce_glyphs with IT as parameter
2286 will produce glyphs in that row.
2288 BASE_FACE_ID is the id of a base face to use. It must be one of
2289 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2290 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2291 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2293 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2294 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2295 will be initialized to use the corresponding mode line glyph row of
2296 the desired matrix of W. */
2299 init_iterator (struct it
*it
, struct window
*w
,
2300 EMACS_INT charpos
, EMACS_INT bytepos
,
2301 struct glyph_row
*row
, enum face_id base_face_id
)
2303 int highlight_region_p
;
2304 enum face_id remapped_base_face_id
= base_face_id
;
2306 /* Some precondition checks. */
2307 xassert (w
!= NULL
&& it
!= NULL
);
2308 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2311 /* If face attributes have been changed since the last redisplay,
2312 free realized faces now because they depend on face definitions
2313 that might have changed. Don't free faces while there might be
2314 desired matrices pending which reference these faces. */
2315 if (face_change_count
&& !inhibit_free_realized_faces
)
2317 face_change_count
= 0;
2318 free_all_realized_faces (Qnil
);
2321 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2322 if (! NILP (Vface_remapping_alist
))
2323 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2325 /* Use one of the mode line rows of W's desired matrix if
2329 if (base_face_id
== MODE_LINE_FACE_ID
2330 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2331 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2332 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2333 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2337 memset (it
, 0, sizeof *it
);
2338 it
->current
.overlay_string_index
= -1;
2339 it
->current
.dpvec_index
= -1;
2340 it
->base_face_id
= remapped_base_face_id
;
2342 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2344 /* The window in which we iterate over current_buffer: */
2345 XSETWINDOW (it
->window
, w
);
2347 it
->f
= XFRAME (w
->frame
);
2351 /* Extra space between lines (on window systems only). */
2352 if (base_face_id
== DEFAULT_FACE_ID
2353 && FRAME_WINDOW_P (it
->f
))
2355 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2356 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2357 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2358 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2359 * FRAME_LINE_HEIGHT (it
->f
));
2360 else if (it
->f
->extra_line_spacing
> 0)
2361 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2362 it
->max_extra_line_spacing
= 0;
2365 /* If realized faces have been removed, e.g. because of face
2366 attribute changes of named faces, recompute them. When running
2367 in batch mode, the face cache of the initial frame is null. If
2368 we happen to get called, make a dummy face cache. */
2369 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2370 init_frame_faces (it
->f
);
2371 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2372 recompute_basic_faces (it
->f
);
2374 /* Current value of the `slice', `space-width', and 'height' properties. */
2375 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2376 it
->space_width
= Qnil
;
2377 it
->font_height
= Qnil
;
2378 it
->override_ascent
= -1;
2380 /* Are control characters displayed as `^C'? */
2381 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2383 /* -1 means everything between a CR and the following line end
2384 is invisible. >0 means lines indented more than this value are
2386 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2387 ? XINT (BVAR (current_buffer
, selective_display
))
2388 : (!NILP (BVAR (current_buffer
, selective_display
))
2390 it
->selective_display_ellipsis_p
2391 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2393 /* Display table to use. */
2394 it
->dp
= window_display_table (w
);
2396 /* Are multibyte characters enabled in current_buffer? */
2397 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2399 /* Do we need to reorder bidirectional text? Not if this is a
2400 unibyte buffer: by definition, none of the single-byte characters
2401 are strong R2L, so no reordering is needed. And bidi.c doesn't
2402 support unibyte buffers anyway. */
2404 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2406 /* Non-zero if we should highlight the region. */
2408 = (!NILP (Vtransient_mark_mode
)
2409 && !NILP (BVAR (current_buffer
, mark_active
))
2410 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2412 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2413 start and end of a visible region in window IT->w. Set both to
2414 -1 to indicate no region. */
2415 if (highlight_region_p
2416 /* Maybe highlight only in selected window. */
2417 && (/* Either show region everywhere. */
2418 highlight_nonselected_windows
2419 /* Or show region in the selected window. */
2420 || w
== XWINDOW (selected_window
)
2421 /* Or show the region if we are in the mini-buffer and W is
2422 the window the mini-buffer refers to. */
2423 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2424 && WINDOWP (minibuf_selected_window
)
2425 && w
== XWINDOW (minibuf_selected_window
))))
2427 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2428 it
->region_beg_charpos
= min (PT
, markpos
);
2429 it
->region_end_charpos
= max (PT
, markpos
);
2432 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2434 /* Get the position at which the redisplay_end_trigger hook should
2435 be run, if it is to be run at all. */
2436 if (MARKERP (w
->redisplay_end_trigger
)
2437 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2438 it
->redisplay_end_trigger_charpos
2439 = marker_position (w
->redisplay_end_trigger
);
2440 else if (INTEGERP (w
->redisplay_end_trigger
))
2441 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2443 /* Correct bogus values of tab_width. */
2444 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2445 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2448 /* Are lines in the display truncated? */
2449 if (base_face_id
!= DEFAULT_FACE_ID
2450 || XINT (it
->w
->hscroll
)
2451 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2452 && ((!NILP (Vtruncate_partial_width_windows
)
2453 && !INTEGERP (Vtruncate_partial_width_windows
))
2454 || (INTEGERP (Vtruncate_partial_width_windows
)
2455 && (WINDOW_TOTAL_COLS (it
->w
)
2456 < XINT (Vtruncate_partial_width_windows
))))))
2457 it
->line_wrap
= TRUNCATE
;
2458 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2459 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2460 ? WINDOW_WRAP
: WORD_WRAP
;
2462 it
->line_wrap
= TRUNCATE
;
2464 /* Get dimensions of truncation and continuation glyphs. These are
2465 displayed as fringe bitmaps under X, so we don't need them for such
2467 if (!FRAME_WINDOW_P (it
->f
))
2469 if (it
->line_wrap
== TRUNCATE
)
2471 /* We will need the truncation glyph. */
2472 xassert (it
->glyph_row
== NULL
);
2473 produce_special_glyphs (it
, IT_TRUNCATION
);
2474 it
->truncation_pixel_width
= it
->pixel_width
;
2478 /* We will need the continuation glyph. */
2479 xassert (it
->glyph_row
== NULL
);
2480 produce_special_glyphs (it
, IT_CONTINUATION
);
2481 it
->continuation_pixel_width
= it
->pixel_width
;
2484 /* Reset these values to zero because the produce_special_glyphs
2485 above has changed them. */
2486 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2487 it
->phys_ascent
= it
->phys_descent
= 0;
2490 /* Set this after getting the dimensions of truncation and
2491 continuation glyphs, so that we don't produce glyphs when calling
2492 produce_special_glyphs, above. */
2493 it
->glyph_row
= row
;
2494 it
->area
= TEXT_AREA
;
2496 /* Forget any previous info about this row being reversed. */
2498 it
->glyph_row
->reversed_p
= 0;
2500 /* Get the dimensions of the display area. The display area
2501 consists of the visible window area plus a horizontally scrolled
2502 part to the left of the window. All x-values are relative to the
2503 start of this total display area. */
2504 if (base_face_id
!= DEFAULT_FACE_ID
)
2506 /* Mode lines, menu bar in terminal frames. */
2507 it
->first_visible_x
= 0;
2508 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2513 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2514 it
->last_visible_x
= (it
->first_visible_x
2515 + window_box_width (w
, TEXT_AREA
));
2517 /* If we truncate lines, leave room for the truncator glyph(s) at
2518 the right margin. Otherwise, leave room for the continuation
2519 glyph(s). Truncation and continuation glyphs are not inserted
2520 for window-based redisplay. */
2521 if (!FRAME_WINDOW_P (it
->f
))
2523 if (it
->line_wrap
== TRUNCATE
)
2524 it
->last_visible_x
-= it
->truncation_pixel_width
;
2526 it
->last_visible_x
-= it
->continuation_pixel_width
;
2529 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2530 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2533 /* Leave room for a border glyph. */
2534 if (!FRAME_WINDOW_P (it
->f
)
2535 && !WINDOW_RIGHTMOST_P (it
->w
))
2536 it
->last_visible_x
-= 1;
2538 it
->last_visible_y
= window_text_bottom_y (w
);
2540 /* For mode lines and alike, arrange for the first glyph having a
2541 left box line if the face specifies a box. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2546 it
->face_id
= remapped_base_face_id
;
2548 /* If we have a boxed mode line, make the first character appear
2549 with a left box line. */
2550 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2551 if (face
->box
!= FACE_NO_BOX
)
2552 it
->start_of_box_run_p
= 1;
2555 /* If we are to reorder bidirectional text, init the bidi
2559 /* Note the paragraph direction that this buffer wants to
2561 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qleft_to_right
))
2562 it
->paragraph_embedding
= L2R
;
2563 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
), Qright_to_left
))
2564 it
->paragraph_embedding
= R2L
;
2566 it
->paragraph_embedding
= NEUTRAL_DIR
;
2567 bidi_init_it (charpos
, bytepos
, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
2570 /* If a buffer position was specified, set the iterator there,
2571 getting overlays and face properties from that position. */
2572 if (charpos
>= BUF_BEG (current_buffer
))
2574 it
->end_charpos
= ZV
;
2576 IT_CHARPOS (*it
) = charpos
;
2578 /* Compute byte position if not specified. */
2579 if (bytepos
< charpos
)
2580 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2582 IT_BYTEPOS (*it
) = bytepos
;
2584 it
->start
= it
->current
;
2586 /* Compute faces etc. */
2587 reseat (it
, it
->current
.pos
, 1);
2594 /* Initialize IT for the display of window W with window start POS. */
2597 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2599 struct glyph_row
*row
;
2600 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2602 row
= w
->desired_matrix
->rows
+ first_vpos
;
2603 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2604 it
->first_vpos
= first_vpos
;
2606 /* Don't reseat to previous visible line start if current start
2607 position is in a string or image. */
2608 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2610 int start_at_line_beg_p
;
2611 int first_y
= it
->current_y
;
2613 /* If window start is not at a line start, skip forward to POS to
2614 get the correct continuation lines width. */
2615 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2616 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2617 if (!start_at_line_beg_p
)
2621 reseat_at_previous_visible_line_start (it
);
2622 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2624 new_x
= it
->current_x
+ it
->pixel_width
;
2626 /* If lines are continued, this line may end in the middle
2627 of a multi-glyph character (e.g. a control character
2628 displayed as \003, or in the middle of an overlay
2629 string). In this case move_it_to above will not have
2630 taken us to the start of the continuation line but to the
2631 end of the continued line. */
2632 if (it
->current_x
> 0
2633 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2634 && (/* And glyph doesn't fit on the line. */
2635 new_x
> it
->last_visible_x
2636 /* Or it fits exactly and we're on a window
2638 || (new_x
== it
->last_visible_x
2639 && FRAME_WINDOW_P (it
->f
))))
2641 if (it
->current
.dpvec_index
>= 0
2642 || it
->current
.overlay_string_index
>= 0)
2644 set_iterator_to_next (it
, 1);
2645 move_it_in_display_line_to (it
, -1, -1, 0);
2648 it
->continuation_lines_width
+= it
->current_x
;
2651 /* We're starting a new display line, not affected by the
2652 height of the continued line, so clear the appropriate
2653 fields in the iterator structure. */
2654 it
->max_ascent
= it
->max_descent
= 0;
2655 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2657 it
->current_y
= first_y
;
2659 it
->current_x
= it
->hpos
= 0;
2665 /* Return 1 if POS is a position in ellipses displayed for invisible
2666 text. W is the window we display, for text property lookup. */
2669 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2671 Lisp_Object prop
, window
;
2673 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2675 /* If POS specifies a position in a display vector, this might
2676 be for an ellipsis displayed for invisible text. We won't
2677 get the iterator set up for delivering that ellipsis unless
2678 we make sure that it gets aware of the invisible text. */
2679 if (pos
->dpvec_index
>= 0
2680 && pos
->overlay_string_index
< 0
2681 && CHARPOS (pos
->string_pos
) < 0
2683 && (XSETWINDOW (window
, w
),
2684 prop
= Fget_char_property (make_number (charpos
),
2685 Qinvisible
, window
),
2686 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2688 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2690 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2697 /* Initialize IT for stepping through current_buffer in window W,
2698 starting at position POS that includes overlay string and display
2699 vector/ control character translation position information. Value
2700 is zero if there are overlay strings with newlines at POS. */
2703 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2705 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2706 int i
, overlay_strings_with_newlines
= 0;
2708 /* If POS specifies a position in a display vector, this might
2709 be for an ellipsis displayed for invisible text. We won't
2710 get the iterator set up for delivering that ellipsis unless
2711 we make sure that it gets aware of the invisible text. */
2712 if (in_ellipses_for_invisible_text_p (pos
, w
))
2718 /* Keep in mind: the call to reseat in init_iterator skips invisible
2719 text, so we might end up at a position different from POS. This
2720 is only a problem when POS is a row start after a newline and an
2721 overlay starts there with an after-string, and the overlay has an
2722 invisible property. Since we don't skip invisible text in
2723 display_line and elsewhere immediately after consuming the
2724 newline before the row start, such a POS will not be in a string,
2725 but the call to init_iterator below will move us to the
2727 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2729 /* This only scans the current chunk -- it should scan all chunks.
2730 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2731 to 16 in 22.1 to make this a lesser problem. */
2732 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2734 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2735 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2737 while (s
< e
&& *s
!= '\n')
2742 overlay_strings_with_newlines
= 1;
2747 /* If position is within an overlay string, set up IT to the right
2749 if (pos
->overlay_string_index
>= 0)
2753 /* If the first overlay string happens to have a `display'
2754 property for an image, the iterator will be set up for that
2755 image, and we have to undo that setup first before we can
2756 correct the overlay string index. */
2757 if (it
->method
== GET_FROM_IMAGE
)
2760 /* We already have the first chunk of overlay strings in
2761 IT->overlay_strings. Load more until the one for
2762 pos->overlay_string_index is in IT->overlay_strings. */
2763 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2765 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2766 it
->current
.overlay_string_index
= 0;
2769 load_overlay_strings (it
, 0);
2770 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2774 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2775 relative_index
= (it
->current
.overlay_string_index
2776 % OVERLAY_STRING_CHUNK_SIZE
);
2777 it
->string
= it
->overlay_strings
[relative_index
];
2778 xassert (STRINGP (it
->string
));
2779 it
->current
.string_pos
= pos
->string_pos
;
2780 it
->method
= GET_FROM_STRING
;
2783 if (CHARPOS (pos
->string_pos
) >= 0)
2785 /* Recorded position is not in an overlay string, but in another
2786 string. This can only be a string from a `display' property.
2787 IT should already be filled with that string. */
2788 it
->current
.string_pos
= pos
->string_pos
;
2789 xassert (STRINGP (it
->string
));
2792 /* Restore position in display vector translations, control
2793 character translations or ellipses. */
2794 if (pos
->dpvec_index
>= 0)
2796 if (it
->dpvec
== NULL
)
2797 get_next_display_element (it
);
2798 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2799 it
->current
.dpvec_index
= pos
->dpvec_index
;
2803 return !overlay_strings_with_newlines
;
2807 /* Initialize IT for stepping through current_buffer in window W
2808 starting at ROW->start. */
2811 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2813 init_from_display_pos (it
, w
, &row
->start
);
2814 it
->start
= row
->start
;
2815 it
->continuation_lines_width
= row
->continuation_lines_width
;
2820 /* Initialize IT for stepping through current_buffer in window W
2821 starting in the line following ROW, i.e. starting at ROW->end.
2822 Value is zero if there are overlay strings with newlines at ROW's
2826 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2830 if (init_from_display_pos (it
, w
, &row
->end
))
2832 if (row
->continued_p
)
2833 it
->continuation_lines_width
2834 = row
->continuation_lines_width
+ row
->pixel_width
;
2845 /***********************************************************************
2847 ***********************************************************************/
2849 /* Called when IT reaches IT->stop_charpos. Handle text property and
2850 overlay changes. Set IT->stop_charpos to the next position where
2854 handle_stop (struct it
*it
)
2856 enum prop_handled handled
;
2857 int handle_overlay_change_p
;
2861 it
->current
.dpvec_index
= -1;
2862 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2863 it
->ignore_overlay_strings_at_pos_p
= 0;
2866 /* Use face of preceding text for ellipsis (if invisible) */
2867 if (it
->selective_display_ellipsis_p
)
2868 it
->saved_face_id
= it
->face_id
;
2872 handled
= HANDLED_NORMALLY
;
2874 /* Call text property handlers. */
2875 for (p
= it_props
; p
->handler
; ++p
)
2877 handled
= p
->handler (it
);
2879 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2881 else if (handled
== HANDLED_RETURN
)
2883 /* We still want to show before and after strings from
2884 overlays even if the actual buffer text is replaced. */
2885 if (!handle_overlay_change_p
2887 || !get_overlay_strings_1 (it
, 0, 0))
2890 setup_for_ellipsis (it
, 0);
2891 /* When handling a display spec, we might load an
2892 empty string. In that case, discard it here. We
2893 used to discard it in handle_single_display_spec,
2894 but that causes get_overlay_strings_1, above, to
2895 ignore overlay strings that we must check. */
2896 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2900 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2904 it
->ignore_overlay_strings_at_pos_p
= 1;
2905 it
->string_from_display_prop_p
= 0;
2906 handle_overlay_change_p
= 0;
2908 handled
= HANDLED_RECOMPUTE_PROPS
;
2911 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2912 handle_overlay_change_p
= 0;
2915 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2917 /* Don't check for overlay strings below when set to deliver
2918 characters from a display vector. */
2919 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2920 handle_overlay_change_p
= 0;
2922 /* Handle overlay changes.
2923 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2924 if it finds overlays. */
2925 if (handle_overlay_change_p
)
2926 handled
= handle_overlay_change (it
);
2931 setup_for_ellipsis (it
, 0);
2935 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2937 /* Determine where to stop next. */
2938 if (handled
== HANDLED_NORMALLY
)
2939 compute_stop_pos (it
);
2943 /* Compute IT->stop_charpos from text property and overlay change
2944 information for IT's current position. */
2947 compute_stop_pos (struct it
*it
)
2949 register INTERVAL iv
, next_iv
;
2950 Lisp_Object object
, limit
, position
;
2951 EMACS_INT charpos
, bytepos
;
2953 /* If nowhere else, stop at the end. */
2954 it
->stop_charpos
= it
->end_charpos
;
2956 if (STRINGP (it
->string
))
2958 /* Strings are usually short, so don't limit the search for
2960 object
= it
->string
;
2962 charpos
= IT_STRING_CHARPOS (*it
);
2963 bytepos
= IT_STRING_BYTEPOS (*it
);
2969 /* If next overlay change is in front of the current stop pos
2970 (which is IT->end_charpos), stop there. Note: value of
2971 next_overlay_change is point-max if no overlay change
2973 charpos
= IT_CHARPOS (*it
);
2974 bytepos
= IT_BYTEPOS (*it
);
2975 pos
= next_overlay_change (charpos
);
2976 if (pos
< it
->stop_charpos
)
2977 it
->stop_charpos
= pos
;
2979 /* If showing the region, we have to stop at the region
2980 start or end because the face might change there. */
2981 if (it
->region_beg_charpos
> 0)
2983 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2984 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2985 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2986 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
2989 /* Set up variables for computing the stop position from text
2990 property changes. */
2991 XSETBUFFER (object
, current_buffer
);
2992 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
2995 /* Get the interval containing IT's position. Value is a null
2996 interval if there isn't such an interval. */
2997 position
= make_number (charpos
);
2998 iv
= validate_interval_range (object
, &position
, &position
, 0);
2999 if (!NULL_INTERVAL_P (iv
))
3001 Lisp_Object values_here
[LAST_PROP_IDX
];
3004 /* Get properties here. */
3005 for (p
= it_props
; p
->handler
; ++p
)
3006 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3008 /* Look for an interval following iv that has different
3010 for (next_iv
= next_interval (iv
);
3011 (!NULL_INTERVAL_P (next_iv
)
3013 || XFASTINT (limit
) > next_iv
->position
));
3014 next_iv
= next_interval (next_iv
))
3016 for (p
= it_props
; p
->handler
; ++p
)
3018 Lisp_Object new_value
;
3020 new_value
= textget (next_iv
->plist
, *p
->name
);
3021 if (!EQ (values_here
[p
->idx
], new_value
))
3029 if (!NULL_INTERVAL_P (next_iv
))
3031 if (INTEGERP (limit
)
3032 && next_iv
->position
>= XFASTINT (limit
))
3033 /* No text property change up to limit. */
3034 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3036 /* Text properties change in next_iv. */
3037 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3041 if (it
->cmp_it
.id
< 0)
3043 EMACS_INT stoppos
= it
->end_charpos
;
3045 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3047 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3048 stoppos
, it
->string
);
3051 xassert (STRINGP (it
->string
)
3052 || (it
->stop_charpos
>= BEGV
3053 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3057 /* Return the position of the next overlay change after POS in
3058 current_buffer. Value is point-max if no overlay change
3059 follows. This is like `next-overlay-change' but doesn't use
3063 next_overlay_change (EMACS_INT pos
)
3067 Lisp_Object
*overlays
;
3070 /* Get all overlays at the given position. */
3071 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3073 /* If any of these overlays ends before endpos,
3074 use its ending point instead. */
3075 for (i
= 0; i
< noverlays
; ++i
)
3080 oend
= OVERLAY_END (overlays
[i
]);
3081 oendpos
= OVERLAY_POSITION (oend
);
3082 endpos
= min (endpos
, oendpos
);
3088 /* Return the character position of a display string at or after CHARPOS.
3089 If no display string exists at or after CHARPOS, return ZV. A
3090 display string is either an overlay with `display' property whose
3091 value is a string, or a `display' text property whose value is a
3092 string. FRAME_WINDOW_P is non-zero when we are displaying a window
3095 compute_display_string_pos (EMACS_INT charpos
, int frame_window_p
)
3097 /* FIXME: Support display properties on strings (object = Qnil means
3099 Lisp_Object object
= Qnil
;
3100 Lisp_Object pos
, spec
;
3101 struct text_pos position
;
3107 /* If the character at CHARPOS is where the display string begins,
3109 pos
= make_number (charpos
);
3110 CHARPOS (position
) = charpos
;
3111 BYTEPOS (position
) = CHAR_TO_BYTE (charpos
);
3112 bufpos
= charpos
; /* FIXME! support strings as well */
3113 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3115 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3118 && handle_display_spec (NULL
, spec
, object
, Qnil
, &position
, bufpos
,
3122 /* Look forward for the first character with a `display' property
3123 that will replace the underlying text when displayed. */
3125 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3126 CHARPOS (position
) = XFASTINT (pos
);
3127 BYTEPOS (position
) = CHAR_TO_BYTE (CHARPOS (position
));
3128 if (CHARPOS (position
) >= ZV
)
3130 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3131 bufpos
= CHARPOS (position
); /* FIXME! support strings as well */
3132 } while (NILP (spec
)
3133 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &position
, bufpos
,
3136 return CHARPOS (position
);
3139 /* Return the character position of the end of the display string that
3140 started at CHARPOS. A display string is either an overlay with
3141 `display' property whose value is a string or a `display' text
3142 property whose value is a string. */
3144 compute_display_string_end (EMACS_INT charpos
)
3146 /* FIXME: Support display properties on strings (object = Qnil means
3148 Lisp_Object object
= Qnil
;
3149 Lisp_Object pos
= make_number (charpos
);
3154 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3157 /* Look forward for the first character where the `display' property
3159 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3161 return XFASTINT (pos
);
3166 /***********************************************************************
3168 ***********************************************************************/
3170 /* Handle changes in the `fontified' property of the current buffer by
3171 calling hook functions from Qfontification_functions to fontify
3174 static enum prop_handled
3175 handle_fontified_prop (struct it
*it
)
3177 Lisp_Object prop
, pos
;
3178 enum prop_handled handled
= HANDLED_NORMALLY
;
3180 if (!NILP (Vmemory_full
))
3183 /* Get the value of the `fontified' property at IT's current buffer
3184 position. (The `fontified' property doesn't have a special
3185 meaning in strings.) If the value is nil, call functions from
3186 Qfontification_functions. */
3187 if (!STRINGP (it
->string
)
3189 && !NILP (Vfontification_functions
)
3190 && !NILP (Vrun_hooks
)
3191 && (pos
= make_number (IT_CHARPOS (*it
)),
3192 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3193 /* Ignore the special cased nil value always present at EOB since
3194 no amount of fontifying will be able to change it. */
3195 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3197 int count
= SPECPDL_INDEX ();
3199 struct buffer
*obuf
= current_buffer
;
3200 int begv
= BEGV
, zv
= ZV
;
3201 int old_clip_changed
= current_buffer
->clip_changed
;
3203 val
= Vfontification_functions
;
3204 specbind (Qfontification_functions
, Qnil
);
3206 xassert (it
->end_charpos
== ZV
);
3208 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3209 safe_call1 (val
, pos
);
3212 Lisp_Object fns
, fn
;
3213 struct gcpro gcpro1
, gcpro2
;
3218 for (; CONSP (val
); val
= XCDR (val
))
3224 /* A value of t indicates this hook has a local
3225 binding; it means to run the global binding too.
3226 In a global value, t should not occur. If it
3227 does, we must ignore it to avoid an endless
3229 for (fns
= Fdefault_value (Qfontification_functions
);
3235 safe_call1 (fn
, pos
);
3239 safe_call1 (fn
, pos
);
3245 unbind_to (count
, Qnil
);
3247 /* Fontification functions routinely call `save-restriction'.
3248 Normally, this tags clip_changed, which can confuse redisplay
3249 (see discussion in Bug#6671). Since we don't perform any
3250 special handling of fontification changes in the case where
3251 `save-restriction' isn't called, there's no point doing so in
3252 this case either. So, if the buffer's restrictions are
3253 actually left unchanged, reset clip_changed. */
3254 if (obuf
== current_buffer
)
3256 if (begv
== BEGV
&& zv
== ZV
)
3257 current_buffer
->clip_changed
= old_clip_changed
;
3259 /* There isn't much we can reasonably do to protect against
3260 misbehaving fontification, but here's a fig leaf. */
3261 else if (!NILP (BVAR (obuf
, name
)))
3262 set_buffer_internal_1 (obuf
);
3264 /* The fontification code may have added/removed text.
3265 It could do even a lot worse, but let's at least protect against
3266 the most obvious case where only the text past `pos' gets changed',
3267 as is/was done in grep.el where some escapes sequences are turned
3268 into face properties (bug#7876). */
3269 it
->end_charpos
= ZV
;
3271 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3272 something. This avoids an endless loop if they failed to
3273 fontify the text for which reason ever. */
3274 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3275 handled
= HANDLED_RECOMPUTE_PROPS
;
3283 /***********************************************************************
3285 ***********************************************************************/
3287 /* Set up iterator IT from face properties at its current position.
3288 Called from handle_stop. */
3290 static enum prop_handled
3291 handle_face_prop (struct it
*it
)
3294 EMACS_INT next_stop
;
3296 if (!STRINGP (it
->string
))
3299 = face_at_buffer_position (it
->w
,
3301 it
->region_beg_charpos
,
3302 it
->region_end_charpos
,
3305 + TEXT_PROP_DISTANCE_LIMIT
),
3306 0, it
->base_face_id
);
3308 /* Is this a start of a run of characters with box face?
3309 Caveat: this can be called for a freshly initialized
3310 iterator; face_id is -1 in this case. We know that the new
3311 face will not change until limit, i.e. if the new face has a
3312 box, all characters up to limit will have one. But, as
3313 usual, we don't know whether limit is really the end. */
3314 if (new_face_id
!= it
->face_id
)
3316 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3318 /* If new face has a box but old face has not, this is
3319 the start of a run of characters with box, i.e. it has
3320 a shadow on the left side. The value of face_id of the
3321 iterator will be -1 if this is the initial call that gets
3322 the face. In this case, we have to look in front of IT's
3323 position and see whether there is a face != new_face_id. */
3324 it
->start_of_box_run_p
3325 = (new_face
->box
!= FACE_NO_BOX
3326 && (it
->face_id
>= 0
3327 || IT_CHARPOS (*it
) == BEG
3328 || new_face_id
!= face_before_it_pos (it
)));
3329 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3337 Lisp_Object from_overlay
3338 = (it
->current
.overlay_string_index
>= 0
3339 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3342 /* See if we got to this string directly or indirectly from
3343 an overlay property. That includes the before-string or
3344 after-string of an overlay, strings in display properties
3345 provided by an overlay, their text properties, etc.
3347 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3348 if (! NILP (from_overlay
))
3349 for (i
= it
->sp
- 1; i
>= 0; i
--)
3351 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3353 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3354 else if (! NILP (it
->stack
[i
].from_overlay
))
3355 from_overlay
= it
->stack
[i
].from_overlay
;
3357 if (!NILP (from_overlay
))
3361 if (! NILP (from_overlay
))
3363 bufpos
= IT_CHARPOS (*it
);
3364 /* For a string from an overlay, the base face depends
3365 only on text properties and ignores overlays. */
3367 = face_for_overlay_string (it
->w
,
3369 it
->region_beg_charpos
,
3370 it
->region_end_charpos
,
3373 + TEXT_PROP_DISTANCE_LIMIT
),
3381 /* For strings from a `display' property, use the face at
3382 IT's current buffer position as the base face to merge
3383 with, so that overlay strings appear in the same face as
3384 surrounding text, unless they specify their own
3386 base_face_id
= underlying_face_id (it
);
3389 new_face_id
= face_at_string_position (it
->w
,
3391 IT_STRING_CHARPOS (*it
),
3393 it
->region_beg_charpos
,
3394 it
->region_end_charpos
,
3398 /* Is this a start of a run of characters with box? Caveat:
3399 this can be called for a freshly allocated iterator; face_id
3400 is -1 is this case. We know that the new face will not
3401 change until the next check pos, i.e. if the new face has a
3402 box, all characters up to that position will have a
3403 box. But, as usual, we don't know whether that position
3404 is really the end. */
3405 if (new_face_id
!= it
->face_id
)
3407 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3408 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3410 /* If new face has a box but old face hasn't, this is the
3411 start of a run of characters with box, i.e. it has a
3412 shadow on the left side. */
3413 it
->start_of_box_run_p
3414 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3415 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3419 it
->face_id
= new_face_id
;
3420 return HANDLED_NORMALLY
;
3424 /* Return the ID of the face ``underlying'' IT's current position,
3425 which is in a string. If the iterator is associated with a
3426 buffer, return the face at IT's current buffer position.
3427 Otherwise, use the iterator's base_face_id. */
3430 underlying_face_id (struct it
*it
)
3432 int face_id
= it
->base_face_id
, i
;
3434 xassert (STRINGP (it
->string
));
3436 for (i
= it
->sp
- 1; i
>= 0; --i
)
3437 if (NILP (it
->stack
[i
].string
))
3438 face_id
= it
->stack
[i
].face_id
;
3444 /* Compute the face one character before or after the current position
3445 of IT. BEFORE_P non-zero means get the face in front of IT's
3446 position. Value is the id of the face. */
3449 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3452 EMACS_INT next_check_charpos
;
3453 struct text_pos pos
;
3455 xassert (it
->s
== NULL
);
3457 if (STRINGP (it
->string
))
3462 /* No face change past the end of the string (for the case
3463 we are padding with spaces). No face change before the
3465 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3466 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3469 /* Set pos to the position before or after IT's current position. */
3471 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3473 /* For composition, we must check the character after the
3475 pos
= (it
->what
== IT_COMPOSITION
3476 ? string_pos (IT_STRING_CHARPOS (*it
)
3477 + it
->cmp_it
.nchars
, it
->string
)
3478 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3480 if (it
->current
.overlay_string_index
>= 0)
3481 bufpos
= IT_CHARPOS (*it
);
3485 base_face_id
= underlying_face_id (it
);
3487 /* Get the face for ASCII, or unibyte. */
3488 face_id
= face_at_string_position (it
->w
,
3492 it
->region_beg_charpos
,
3493 it
->region_end_charpos
,
3494 &next_check_charpos
,
3497 /* Correct the face for charsets different from ASCII. Do it
3498 for the multibyte case only. The face returned above is
3499 suitable for unibyte text if IT->string is unibyte. */
3500 if (STRING_MULTIBYTE (it
->string
))
3502 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3504 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3506 c
= string_char_and_length (p
, &len
);
3507 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3512 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3513 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3516 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3517 pos
= it
->current
.pos
;
3520 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3523 if (it
->what
== IT_COMPOSITION
)
3524 /* For composition, we must check the position after the
3526 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3528 INC_TEXT_POS (pos
, it
->multibyte_p
);
3531 /* Determine face for CHARSET_ASCII, or unibyte. */
3532 face_id
= face_at_buffer_position (it
->w
,
3534 it
->region_beg_charpos
,
3535 it
->region_end_charpos
,
3536 &next_check_charpos
,
3539 /* Correct the face for charsets different from ASCII. Do it
3540 for the multibyte case only. The face returned above is
3541 suitable for unibyte text if current_buffer is unibyte. */
3542 if (it
->multibyte_p
)
3544 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3545 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3546 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3555 /***********************************************************************
3557 ***********************************************************************/
3559 /* Set up iterator IT from invisible properties at its current
3560 position. Called from handle_stop. */
3562 static enum prop_handled
3563 handle_invisible_prop (struct it
*it
)
3565 enum prop_handled handled
= HANDLED_NORMALLY
;
3567 if (STRINGP (it
->string
))
3569 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3571 /* Get the value of the invisible text property at the
3572 current position. Value will be nil if there is no such
3574 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3575 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3578 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3580 handled
= HANDLED_RECOMPUTE_PROPS
;
3582 /* Get the position at which the next change of the
3583 invisible text property can be found in IT->string.
3584 Value will be nil if the property value is the same for
3585 all the rest of IT->string. */
3586 XSETINT (limit
, SCHARS (it
->string
));
3587 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3590 /* Text at current position is invisible. The next
3591 change in the property is at position end_charpos.
3592 Move IT's current position to that position. */
3593 if (INTEGERP (end_charpos
)
3594 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3596 struct text_pos old
;
3597 old
= it
->current
.string_pos
;
3598 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3599 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3603 /* The rest of the string is invisible. If this is an
3604 overlay string, proceed with the next overlay string
3605 or whatever comes and return a character from there. */
3606 if (it
->current
.overlay_string_index
>= 0)
3608 next_overlay_string (it
);
3609 /* Don't check for overlay strings when we just
3610 finished processing them. */
3611 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3615 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3616 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3624 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3625 Lisp_Object pos
, prop
, overlay
;
3627 /* First of all, is there invisible text at this position? */
3628 tem
= start_charpos
= IT_CHARPOS (*it
);
3629 pos
= make_number (tem
);
3630 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3632 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3634 /* If we are on invisible text, skip over it. */
3635 if (invis_p
&& start_charpos
< it
->end_charpos
)
3637 /* Record whether we have to display an ellipsis for the
3639 int display_ellipsis_p
= invis_p
== 2;
3641 handled
= HANDLED_RECOMPUTE_PROPS
;
3643 /* Loop skipping over invisible text. The loop is left at
3644 ZV or with IT on the first char being visible again. */
3647 /* Try to skip some invisible text. Return value is the
3648 position reached which can be equal to where we start
3649 if there is nothing invisible there. This skips both
3650 over invisible text properties and overlays with
3651 invisible property. */
3652 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3654 /* If we skipped nothing at all we weren't at invisible
3655 text in the first place. If everything to the end of
3656 the buffer was skipped, end the loop. */
3657 if (newpos
== tem
|| newpos
>= ZV
)
3661 /* We skipped some characters but not necessarily
3662 all there are. Check if we ended up on visible
3663 text. Fget_char_property returns the property of
3664 the char before the given position, i.e. if we
3665 get invis_p = 0, this means that the char at
3666 newpos is visible. */
3667 pos
= make_number (newpos
);
3668 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3669 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3672 /* If we ended up on invisible text, proceed to
3673 skip starting with next_stop. */
3677 /* If there are adjacent invisible texts, don't lose the
3678 second one's ellipsis. */
3680 display_ellipsis_p
= 1;
3684 /* The position newpos is now either ZV or on visible text. */
3685 if (it
->bidi_p
&& newpos
< ZV
)
3687 /* With bidi iteration, the region of invisible text
3688 could start and/or end in the middle of a non-base
3689 embedding level. Therefore, we need to skip
3690 invisible text using the bidi iterator, starting at
3691 IT's current position, until we find ourselves
3692 outside the invisible text. Skipping invisible text
3693 _after_ bidi iteration avoids affecting the visual
3694 order of the displayed text when invisible properties
3695 are added or removed. */
3696 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3698 /* If we were `reseat'ed to a new paragraph,
3699 determine the paragraph base direction. We need
3700 to do it now because next_element_from_buffer may
3701 not have a chance to do it, if we are going to
3702 skip any text at the beginning, which resets the
3704 bidi_paragraph_init (it
->paragraph_embedding
,
3709 bidi_move_to_visually_next (&it
->bidi_it
);
3711 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3712 && it
->bidi_it
.charpos
< newpos
);
3713 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3714 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3715 /* If we overstepped NEWPOS, record its position in the
3716 iterator, so that we skip invisible text if later the
3717 bidi iteration lands us in the invisible region
3719 if (IT_CHARPOS (*it
) >= newpos
)
3720 it
->prev_stop
= newpos
;
3724 IT_CHARPOS (*it
) = newpos
;
3725 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3728 /* If there are before-strings at the start of invisible
3729 text, and the text is invisible because of a text
3730 property, arrange to show before-strings because 20.x did
3731 it that way. (If the text is invisible because of an
3732 overlay property instead of a text property, this is
3733 already handled in the overlay code.) */
3735 && get_overlay_strings (it
, it
->stop_charpos
))
3737 handled
= HANDLED_RECOMPUTE_PROPS
;
3738 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3740 else if (display_ellipsis_p
)
3742 /* Make sure that the glyphs of the ellipsis will get
3743 correct `charpos' values. If we would not update
3744 it->position here, the glyphs would belong to the
3745 last visible character _before_ the invisible
3746 text, which confuses `set_cursor_from_row'.
3748 We use the last invisible position instead of the
3749 first because this way the cursor is always drawn on
3750 the first "." of the ellipsis, whenever PT is inside
3751 the invisible text. Otherwise the cursor would be
3752 placed _after_ the ellipsis when the point is after the
3753 first invisible character. */
3754 if (!STRINGP (it
->object
))
3756 it
->position
.charpos
= newpos
- 1;
3757 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3760 /* Let the ellipsis display before
3761 considering any properties of the following char.
3762 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3763 handled
= HANDLED_RETURN
;
3772 /* Make iterator IT return `...' next.
3773 Replaces LEN characters from buffer. */
3776 setup_for_ellipsis (struct it
*it
, int len
)
3778 /* Use the display table definition for `...'. Invalid glyphs
3779 will be handled by the method returning elements from dpvec. */
3780 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3782 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3783 it
->dpvec
= v
->contents
;
3784 it
->dpend
= v
->contents
+ v
->header
.size
;
3788 /* Default `...'. */
3789 it
->dpvec
= default_invis_vector
;
3790 it
->dpend
= default_invis_vector
+ 3;
3793 it
->dpvec_char_len
= len
;
3794 it
->current
.dpvec_index
= 0;
3795 it
->dpvec_face_id
= -1;
3797 /* Remember the current face id in case glyphs specify faces.
3798 IT's face is restored in set_iterator_to_next.
3799 saved_face_id was set to preceding char's face in handle_stop. */
3800 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3801 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3803 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3809 /***********************************************************************
3811 ***********************************************************************/
3813 /* Set up iterator IT from `display' property at its current position.
3814 Called from handle_stop.
3815 We return HANDLED_RETURN if some part of the display property
3816 overrides the display of the buffer text itself.
3817 Otherwise we return HANDLED_NORMALLY. */
3819 static enum prop_handled
3820 handle_display_prop (struct it
*it
)
3822 Lisp_Object propval
, object
, overlay
;
3823 struct text_pos
*position
;
3825 /* Nonzero if some property replaces the display of the text itself. */
3826 int display_replaced_p
= 0;
3828 if (STRINGP (it
->string
))
3830 object
= it
->string
;
3831 position
= &it
->current
.string_pos
;
3832 bufpos
= CHARPOS (it
->current
.pos
);
3836 XSETWINDOW (object
, it
->w
);
3837 position
= &it
->current
.pos
;
3838 bufpos
= CHARPOS (*position
);
3841 /* Reset those iterator values set from display property values. */
3842 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3843 it
->space_width
= Qnil
;
3844 it
->font_height
= Qnil
;
3847 /* We don't support recursive `display' properties, i.e. string
3848 values that have a string `display' property, that have a string
3849 `display' property etc. */
3850 if (!it
->string_from_display_prop_p
)
3851 it
->area
= TEXT_AREA
;
3853 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
3854 Qdisplay
, object
, &overlay
);
3856 return HANDLED_NORMALLY
;
3857 /* Now OVERLAY is the overlay that gave us this property, or nil
3858 if it was a text property. */
3860 if (!STRINGP (it
->string
))
3861 object
= it
->w
->buffer
;
3863 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
3865 FRAME_WINDOW_P (it
->f
));
3867 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3870 /* Subroutine of handle_display_prop. Returns non-zero if the display
3871 specification in SPEC is a replacing specification, i.e. it would
3872 replace the text covered by `display' property with something else,
3873 such as an image or a display string.
3875 See handle_single_display_spec for documentation of arguments.
3876 frame_window_p is non-zero if the window being redisplayed is on a
3877 GUI frame; this argument is used only if IT is NULL, see below.
3879 IT can be NULL, if this is called by the bidi reordering code
3880 through compute_display_string_pos, which see. In that case, this
3881 function only examines SPEC, but does not otherwise "handle" it, in
3882 the sense that it doesn't set up members of IT from the display
3885 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3886 Lisp_Object overlay
, struct text_pos
*position
,
3887 EMACS_INT bufpos
, int frame_window_p
)
3889 int replacing_p
= 0;
3892 /* Simple specerties. */
3893 && !EQ (XCAR (spec
), Qimage
)
3894 && !EQ (XCAR (spec
), Qspace
)
3895 && !EQ (XCAR (spec
), Qwhen
)
3896 && !EQ (XCAR (spec
), Qslice
)
3897 && !EQ (XCAR (spec
), Qspace_width
)
3898 && !EQ (XCAR (spec
), Qheight
)
3899 && !EQ (XCAR (spec
), Qraise
)
3900 /* Marginal area specifications. */
3901 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
3902 && !EQ (XCAR (spec
), Qleft_fringe
)
3903 && !EQ (XCAR (spec
), Qright_fringe
)
3904 && !NILP (XCAR (spec
)))
3906 for (; CONSP (spec
); spec
= XCDR (spec
))
3908 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
3909 position
, bufpos
, replacing_p
,
3913 /* If some text in a string is replaced, `position' no
3914 longer points to the position of `object'. */
3915 if (!it
|| STRINGP (object
))
3920 else if (VECTORP (spec
))
3923 for (i
= 0; i
< ASIZE (spec
); ++i
)
3924 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
3925 position
, bufpos
, replacing_p
,
3929 /* If some text in a string is replaced, `position' no
3930 longer points to the position of `object'. */
3931 if (!it
|| STRINGP (object
))
3937 if (handle_single_display_spec (it
, spec
, object
, overlay
,
3938 position
, bufpos
, 0, frame_window_p
))
3945 /* Value is the position of the end of the `display' property starting
3946 at START_POS in OBJECT. */
3948 static struct text_pos
3949 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3952 struct text_pos end_pos
;
3954 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3955 Qdisplay
, object
, Qnil
);
3956 CHARPOS (end_pos
) = XFASTINT (end
);
3957 if (STRINGP (object
))
3958 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3960 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3966 /* Set up IT from a single `display' property specification SPEC. OBJECT
3967 is the object in which the `display' property was found. *POSITION
3968 is the position in OBJECT at which the `display' property was found.
3969 BUFPOS is the buffer position of OBJECT (different from POSITION if
3970 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
3971 previously saw a display specification which already replaced text
3972 display with something else, for example an image; we ignore such
3973 properties after the first one has been processed.
3975 OVERLAY is the overlay this `display' property came from,
3976 or nil if it was a text property.
3978 If SPEC is a `space' or `image' specification, and in some other
3979 cases too, set *POSITION to the position where the `display'
3982 If IT is NULL, only examine the property specification in SPEC, but
3983 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
3984 is intended to be displayed in a window on a GUI frame.
3986 Value is non-zero if something was found which replaces the display
3987 of buffer or string text. */
3990 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3991 Lisp_Object overlay
, struct text_pos
*position
,
3992 EMACS_INT bufpos
, int display_replaced_p
,
3996 Lisp_Object location
, value
;
3997 struct text_pos start_pos
= *position
;
4000 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4001 If the result is non-nil, use VALUE instead of SPEC. */
4003 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4012 if (!NILP (form
) && !EQ (form
, Qt
))
4014 int count
= SPECPDL_INDEX ();
4015 struct gcpro gcpro1
;
4017 /* Bind `object' to the object having the `display' property, a
4018 buffer or string. Bind `position' to the position in the
4019 object where the property was found, and `buffer-position'
4020 to the current position in the buffer. */
4023 XSETBUFFER (object
, current_buffer
);
4024 specbind (Qobject
, object
);
4025 specbind (Qposition
, make_number (CHARPOS (*position
)));
4026 specbind (Qbuffer_position
, make_number (bufpos
));
4028 form
= safe_eval (form
);
4030 unbind_to (count
, Qnil
);
4036 /* Handle `(height HEIGHT)' specifications. */
4038 && EQ (XCAR (spec
), Qheight
)
4039 && CONSP (XCDR (spec
)))
4043 if (!FRAME_WINDOW_P (it
->f
))
4046 it
->font_height
= XCAR (XCDR (spec
));
4047 if (!NILP (it
->font_height
))
4049 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4050 int new_height
= -1;
4052 if (CONSP (it
->font_height
)
4053 && (EQ (XCAR (it
->font_height
), Qplus
)
4054 || EQ (XCAR (it
->font_height
), Qminus
))
4055 && CONSP (XCDR (it
->font_height
))
4056 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4058 /* `(+ N)' or `(- N)' where N is an integer. */
4059 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4060 if (EQ (XCAR (it
->font_height
), Qplus
))
4062 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4064 else if (FUNCTIONP (it
->font_height
))
4066 /* Call function with current height as argument.
4067 Value is the new height. */
4069 height
= safe_call1 (it
->font_height
,
4070 face
->lface
[LFACE_HEIGHT_INDEX
]);
4071 if (NUMBERP (height
))
4072 new_height
= XFLOATINT (height
);
4074 else if (NUMBERP (it
->font_height
))
4076 /* Value is a multiple of the canonical char height. */
4079 f
= FACE_FROM_ID (it
->f
,
4080 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4081 new_height
= (XFLOATINT (it
->font_height
)
4082 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4086 /* Evaluate IT->font_height with `height' bound to the
4087 current specified height to get the new height. */
4088 int count
= SPECPDL_INDEX ();
4090 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4091 value
= safe_eval (it
->font_height
);
4092 unbind_to (count
, Qnil
);
4094 if (NUMBERP (value
))
4095 new_height
= XFLOATINT (value
);
4099 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4106 /* Handle `(space-width WIDTH)'. */
4108 && EQ (XCAR (spec
), Qspace_width
)
4109 && CONSP (XCDR (spec
)))
4113 if (!FRAME_WINDOW_P (it
->f
))
4116 value
= XCAR (XCDR (spec
));
4117 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4118 it
->space_width
= value
;
4124 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4126 && EQ (XCAR (spec
), Qslice
))
4132 if (!FRAME_WINDOW_P (it
->f
))
4135 if (tem
= XCDR (spec
), CONSP (tem
))
4137 it
->slice
.x
= XCAR (tem
);
4138 if (tem
= XCDR (tem
), CONSP (tem
))
4140 it
->slice
.y
= XCAR (tem
);
4141 if (tem
= XCDR (tem
), CONSP (tem
))
4143 it
->slice
.width
= XCAR (tem
);
4144 if (tem
= XCDR (tem
), CONSP (tem
))
4145 it
->slice
.height
= XCAR (tem
);
4154 /* Handle `(raise FACTOR)'. */
4156 && EQ (XCAR (spec
), Qraise
)
4157 && CONSP (XCDR (spec
)))
4161 if (!FRAME_WINDOW_P (it
->f
))
4164 #ifdef HAVE_WINDOW_SYSTEM
4165 value
= XCAR (XCDR (spec
));
4166 if (NUMBERP (value
))
4168 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4169 it
->voffset
= - (XFLOATINT (value
)
4170 * (FONT_HEIGHT (face
->font
)));
4172 #endif /* HAVE_WINDOW_SYSTEM */
4178 /* Don't handle the other kinds of display specifications
4179 inside a string that we got from a `display' property. */
4180 if (it
&& it
->string_from_display_prop_p
)
4183 /* Characters having this form of property are not displayed, so
4184 we have to find the end of the property. */
4187 start_pos
= *position
;
4188 *position
= display_prop_end (it
, object
, start_pos
);
4192 /* Stop the scan at that end position--we assume that all
4193 text properties change there. */
4195 it
->stop_charpos
= position
->charpos
;
4197 /* Handle `(left-fringe BITMAP [FACE])'
4198 and `(right-fringe BITMAP [FACE])'. */
4200 && (EQ (XCAR (spec
), Qleft_fringe
)
4201 || EQ (XCAR (spec
), Qright_fringe
))
4202 && CONSP (XCDR (spec
)))
4208 if (!FRAME_WINDOW_P (it
->f
))
4209 /* If we return here, POSITION has been advanced
4210 across the text with this property. */
4213 else if (!frame_window_p
)
4216 #ifdef HAVE_WINDOW_SYSTEM
4217 value
= XCAR (XCDR (spec
));
4218 if (!SYMBOLP (value
)
4219 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4220 /* If we return here, POSITION has been advanced
4221 across the text with this property. */
4226 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4228 if (CONSP (XCDR (XCDR (spec
))))
4230 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4231 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4237 /* Save current settings of IT so that we can restore them
4238 when we are finished with the glyph property value. */
4239 push_it (it
, position
);
4241 it
->area
= TEXT_AREA
;
4242 it
->what
= IT_IMAGE
;
4243 it
->image_id
= -1; /* no image */
4244 it
->position
= start_pos
;
4245 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4246 it
->method
= GET_FROM_IMAGE
;
4247 it
->from_overlay
= Qnil
;
4248 it
->face_id
= face_id
;
4250 /* Say that we haven't consumed the characters with
4251 `display' property yet. The call to pop_it in
4252 set_iterator_to_next will clean this up. */
4253 *position
= start_pos
;
4255 if (EQ (XCAR (spec
), Qleft_fringe
))
4257 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4258 it
->left_user_fringe_face_id
= face_id
;
4262 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4263 it
->right_user_fringe_face_id
= face_id
;
4266 #endif /* HAVE_WINDOW_SYSTEM */
4270 /* Prepare to handle `((margin left-margin) ...)',
4271 `((margin right-margin) ...)' and `((margin nil) ...)'
4272 prefixes for display specifications. */
4273 location
= Qunbound
;
4274 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4278 value
= XCDR (spec
);
4280 value
= XCAR (value
);
4283 if (EQ (XCAR (tem
), Qmargin
)
4284 && (tem
= XCDR (tem
),
4285 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4287 || EQ (tem
, Qleft_margin
)
4288 || EQ (tem
, Qright_margin
))))
4292 if (EQ (location
, Qunbound
))
4298 /* After this point, VALUE is the property after any
4299 margin prefix has been stripped. It must be a string,
4300 an image specification, or `(space ...)'.
4302 LOCATION specifies where to display: `left-margin',
4303 `right-margin' or nil. */
4305 valid_p
= (STRINGP (value
)
4306 #ifdef HAVE_WINDOW_SYSTEM
4307 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4308 && valid_image_p (value
))
4309 #endif /* not HAVE_WINDOW_SYSTEM */
4310 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4312 if (valid_p
&& !display_replaced_p
)
4317 /* Save current settings of IT so that we can restore them
4318 when we are finished with the glyph property value. */
4319 push_it (it
, position
);
4320 it
->from_overlay
= overlay
;
4322 if (NILP (location
))
4323 it
->area
= TEXT_AREA
;
4324 else if (EQ (location
, Qleft_margin
))
4325 it
->area
= LEFT_MARGIN_AREA
;
4327 it
->area
= RIGHT_MARGIN_AREA
;
4329 if (STRINGP (value
))
4332 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4333 it
->current
.overlay_string_index
= -1;
4334 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4335 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4336 it
->method
= GET_FROM_STRING
;
4337 it
->stop_charpos
= 0;
4338 it
->string_from_display_prop_p
= 1;
4339 /* Say that we haven't consumed the characters with
4340 `display' property yet. The call to pop_it in
4341 set_iterator_to_next will clean this up. */
4342 if (BUFFERP (object
))
4343 *position
= start_pos
;
4345 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4347 it
->method
= GET_FROM_STRETCH
;
4349 *position
= it
->position
= start_pos
;
4351 #ifdef HAVE_WINDOW_SYSTEM
4354 it
->what
= IT_IMAGE
;
4355 it
->image_id
= lookup_image (it
->f
, value
);
4356 it
->position
= start_pos
;
4357 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4358 it
->method
= GET_FROM_IMAGE
;
4360 /* Say that we haven't consumed the characters with
4361 `display' property yet. The call to pop_it in
4362 set_iterator_to_next will clean this up. */
4363 *position
= start_pos
;
4365 #endif /* HAVE_WINDOW_SYSTEM */
4370 /* Invalid property or property not supported. Restore
4371 POSITION to what it was before. */
4372 *position
= start_pos
;
4376 /* Check if PROP is a display property value whose text should be
4377 treated as intangible. OVERLAY is the overlay from which PROP
4378 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4379 specify the buffer position covered by PROP. */
4382 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4383 EMACS_INT charpos
, EMACS_INT bytepos
)
4385 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4386 struct text_pos position
;
4388 SET_TEXT_POS (position
, charpos
, bytepos
);
4389 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4390 &position
, charpos
, frame_window_p
);
4394 /* Return 1 if PROP is a display sub-property value containing STRING.
4396 Implementation note: this and the following function are really
4397 special cases of handle_display_spec and
4398 handle_single_display_spec, and should ideally use the same code.
4399 Until they do, these two pairs must be consistent and must be
4400 modified in sync. */
4403 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4405 if (EQ (string
, prop
))
4408 /* Skip over `when FORM'. */
4409 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4414 /* Actually, the condition following `when' should be eval'ed,
4415 like handle_single_display_spec does, and we should return
4416 zero if it evaluates to nil. However, this function is
4417 called only when the buffer was already displayed and some
4418 glyph in the glyph matrix was found to come from a display
4419 string. Therefore, the condition was already evaluated, and
4420 the result was non-nil, otherwise the display string wouldn't
4421 have been displayed and we would have never been called for
4422 this property. Thus, we can skip the evaluation and assume
4423 its result is non-nil. */
4428 /* Skip over `margin LOCATION'. */
4429 if (EQ (XCAR (prop
), Qmargin
))
4440 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4444 /* Return 1 if STRING appears in the `display' property PROP. */
4447 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4450 && !EQ (XCAR (prop
), Qwhen
)
4451 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4453 /* A list of sub-properties. */
4454 while (CONSP (prop
))
4456 if (single_display_spec_string_p (XCAR (prop
), string
))
4461 else if (VECTORP (prop
))
4463 /* A vector of sub-properties. */
4465 for (i
= 0; i
< ASIZE (prop
); ++i
)
4466 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4470 return single_display_spec_string_p (prop
, string
);
4475 /* Look for STRING in overlays and text properties in the current
4476 buffer, between character positions FROM and TO (excluding TO).
4477 BACK_P non-zero means look back (in this case, TO is supposed to be
4479 Value is the first character position where STRING was found, or
4480 zero if it wasn't found before hitting TO.
4482 This function may only use code that doesn't eval because it is
4483 called asynchronously from note_mouse_highlight. */
4486 string_buffer_position_lim (Lisp_Object string
,
4487 EMACS_INT from
, EMACS_INT to
, int back_p
)
4489 Lisp_Object limit
, prop
, pos
;
4492 pos
= make_number (from
);
4494 if (!back_p
) /* looking forward */
4496 limit
= make_number (min (to
, ZV
));
4497 while (!found
&& !EQ (pos
, limit
))
4499 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4500 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4503 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4507 else /* looking back */
4509 limit
= make_number (max (to
, BEGV
));
4510 while (!found
&& !EQ (pos
, limit
))
4512 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4513 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4516 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4521 return found
? XINT (pos
) : 0;
4524 /* Determine which buffer position in current buffer STRING comes from.
4525 AROUND_CHARPOS is an approximate position where it could come from.
4526 Value is the buffer position or 0 if it couldn't be determined.
4528 This function is necessary because we don't record buffer positions
4529 in glyphs generated from strings (to keep struct glyph small).
4530 This function may only use code that doesn't eval because it is
4531 called asynchronously from note_mouse_highlight. */
4534 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4536 const int MAX_DISTANCE
= 1000;
4537 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4538 around_charpos
+ MAX_DISTANCE
,
4542 found
= string_buffer_position_lim (string
, around_charpos
,
4543 around_charpos
- MAX_DISTANCE
, 1);
4549 /***********************************************************************
4550 `composition' property
4551 ***********************************************************************/
4553 /* Set up iterator IT from `composition' property at its current
4554 position. Called from handle_stop. */
4556 static enum prop_handled
4557 handle_composition_prop (struct it
*it
)
4559 Lisp_Object prop
, string
;
4560 EMACS_INT pos
, pos_byte
, start
, end
;
4562 if (STRINGP (it
->string
))
4566 pos
= IT_STRING_CHARPOS (*it
);
4567 pos_byte
= IT_STRING_BYTEPOS (*it
);
4568 string
= it
->string
;
4569 s
= SDATA (string
) + pos_byte
;
4570 it
->c
= STRING_CHAR (s
);
4574 pos
= IT_CHARPOS (*it
);
4575 pos_byte
= IT_BYTEPOS (*it
);
4577 it
->c
= FETCH_CHAR (pos_byte
);
4580 /* If there's a valid composition and point is not inside of the
4581 composition (in the case that the composition is from the current
4582 buffer), draw a glyph composed from the composition components. */
4583 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4584 && COMPOSITION_VALID_P (start
, end
, prop
)
4585 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4589 if (STRINGP (it
->string
))
4590 pos_byte
= string_char_to_byte (it
->string
, start
);
4592 pos_byte
= CHAR_TO_BYTE (start
);
4594 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4597 if (it
->cmp_it
.id
>= 0)
4600 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4601 it
->cmp_it
.nglyphs
= -1;
4605 return HANDLED_NORMALLY
;
4610 /***********************************************************************
4612 ***********************************************************************/
4614 /* The following structure is used to record overlay strings for
4615 later sorting in load_overlay_strings. */
4617 struct overlay_entry
4619 Lisp_Object overlay
;
4626 /* Set up iterator IT from overlay strings at its current position.
4627 Called from handle_stop. */
4629 static enum prop_handled
4630 handle_overlay_change (struct it
*it
)
4632 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4633 return HANDLED_RECOMPUTE_PROPS
;
4635 return HANDLED_NORMALLY
;
4639 /* Set up the next overlay string for delivery by IT, if there is an
4640 overlay string to deliver. Called by set_iterator_to_next when the
4641 end of the current overlay string is reached. If there are more
4642 overlay strings to display, IT->string and
4643 IT->current.overlay_string_index are set appropriately here.
4644 Otherwise IT->string is set to nil. */
4647 next_overlay_string (struct it
*it
)
4649 ++it
->current
.overlay_string_index
;
4650 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4652 /* No more overlay strings. Restore IT's settings to what
4653 they were before overlay strings were processed, and
4654 continue to deliver from current_buffer. */
4656 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4659 || (NILP (it
->string
)
4660 && it
->method
== GET_FROM_BUFFER
4661 && it
->stop_charpos
>= BEGV
4662 && it
->stop_charpos
<= it
->end_charpos
));
4663 it
->current
.overlay_string_index
= -1;
4664 it
->n_overlay_strings
= 0;
4665 it
->overlay_strings_charpos
= -1;
4667 /* If we're at the end of the buffer, record that we have
4668 processed the overlay strings there already, so that
4669 next_element_from_buffer doesn't try it again. */
4670 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4671 it
->overlay_strings_at_end_processed_p
= 1;
4675 /* There are more overlay strings to process. If
4676 IT->current.overlay_string_index has advanced to a position
4677 where we must load IT->overlay_strings with more strings, do
4678 it. We must load at the IT->overlay_strings_charpos where
4679 IT->n_overlay_strings was originally computed; when invisible
4680 text is present, this might not be IT_CHARPOS (Bug#7016). */
4681 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4683 if (it
->current
.overlay_string_index
&& i
== 0)
4684 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4686 /* Initialize IT to deliver display elements from the overlay
4688 it
->string
= it
->overlay_strings
[i
];
4689 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4690 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4691 it
->method
= GET_FROM_STRING
;
4692 it
->stop_charpos
= 0;
4693 if (it
->cmp_it
.stop_pos
>= 0)
4694 it
->cmp_it
.stop_pos
= 0;
4701 /* Compare two overlay_entry structures E1 and E2. Used as a
4702 comparison function for qsort in load_overlay_strings. Overlay
4703 strings for the same position are sorted so that
4705 1. All after-strings come in front of before-strings, except
4706 when they come from the same overlay.
4708 2. Within after-strings, strings are sorted so that overlay strings
4709 from overlays with higher priorities come first.
4711 2. Within before-strings, strings are sorted so that overlay
4712 strings from overlays with higher priorities come last.
4714 Value is analogous to strcmp. */
4718 compare_overlay_entries (const void *e1
, const void *e2
)
4720 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4721 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4724 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4726 /* Let after-strings appear in front of before-strings if
4727 they come from different overlays. */
4728 if (EQ (entry1
->overlay
, entry2
->overlay
))
4729 result
= entry1
->after_string_p
? 1 : -1;
4731 result
= entry1
->after_string_p
? -1 : 1;
4733 else if (entry1
->after_string_p
)
4734 /* After-strings sorted in order of decreasing priority. */
4735 result
= entry2
->priority
- entry1
->priority
;
4737 /* Before-strings sorted in order of increasing priority. */
4738 result
= entry1
->priority
- entry2
->priority
;
4744 /* Load the vector IT->overlay_strings with overlay strings from IT's
4745 current buffer position, or from CHARPOS if that is > 0. Set
4746 IT->n_overlays to the total number of overlay strings found.
4748 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4749 a time. On entry into load_overlay_strings,
4750 IT->current.overlay_string_index gives the number of overlay
4751 strings that have already been loaded by previous calls to this
4754 IT->add_overlay_start contains an additional overlay start
4755 position to consider for taking overlay strings from, if non-zero.
4756 This position comes into play when the overlay has an `invisible'
4757 property, and both before and after-strings. When we've skipped to
4758 the end of the overlay, because of its `invisible' property, we
4759 nevertheless want its before-string to appear.
4760 IT->add_overlay_start will contain the overlay start position
4763 Overlay strings are sorted so that after-string strings come in
4764 front of before-string strings. Within before and after-strings,
4765 strings are sorted by overlay priority. See also function
4766 compare_overlay_entries. */
4769 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4771 Lisp_Object overlay
, window
, str
, invisible
;
4772 struct Lisp_Overlay
*ov
;
4773 EMACS_INT start
, end
;
4775 int n
= 0, i
, j
, invis_p
;
4776 struct overlay_entry
*entries
4777 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4780 charpos
= IT_CHARPOS (*it
);
4782 /* Append the overlay string STRING of overlay OVERLAY to vector
4783 `entries' which has size `size' and currently contains `n'
4784 elements. AFTER_P non-zero means STRING is an after-string of
4786 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4789 Lisp_Object priority; \
4793 int new_size = 2 * size; \
4794 struct overlay_entry *old = entries; \
4796 (struct overlay_entry *) alloca (new_size \
4797 * sizeof *entries); \
4798 memcpy (entries, old, size * sizeof *entries); \
4802 entries[n].string = (STRING); \
4803 entries[n].overlay = (OVERLAY); \
4804 priority = Foverlay_get ((OVERLAY), Qpriority); \
4805 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4806 entries[n].after_string_p = (AFTER_P); \
4811 /* Process overlay before the overlay center. */
4812 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4814 XSETMISC (overlay
, ov
);
4815 xassert (OVERLAYP (overlay
));
4816 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4817 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4822 /* Skip this overlay if it doesn't start or end at IT's current
4824 if (end
!= charpos
&& start
!= charpos
)
4827 /* Skip this overlay if it doesn't apply to IT->w. */
4828 window
= Foverlay_get (overlay
, Qwindow
);
4829 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4832 /* If the text ``under'' the overlay is invisible, both before-
4833 and after-strings from this overlay are visible; start and
4834 end position are indistinguishable. */
4835 invisible
= Foverlay_get (overlay
, Qinvisible
);
4836 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4838 /* If overlay has a non-empty before-string, record it. */
4839 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4840 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4842 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4844 /* If overlay has a non-empty after-string, record it. */
4845 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4846 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4848 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4851 /* Process overlays after the overlay center. */
4852 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4854 XSETMISC (overlay
, ov
);
4855 xassert (OVERLAYP (overlay
));
4856 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4857 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4859 if (start
> charpos
)
4862 /* Skip this overlay if it doesn't start or end at IT's current
4864 if (end
!= charpos
&& start
!= charpos
)
4867 /* Skip this overlay if it doesn't apply to IT->w. */
4868 window
= Foverlay_get (overlay
, Qwindow
);
4869 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4872 /* If the text ``under'' the overlay is invisible, it has a zero
4873 dimension, and both before- and after-strings apply. */
4874 invisible
= Foverlay_get (overlay
, Qinvisible
);
4875 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4877 /* If overlay has a non-empty before-string, record it. */
4878 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4879 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4881 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4883 /* If overlay has a non-empty after-string, record it. */
4884 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4885 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4887 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4890 #undef RECORD_OVERLAY_STRING
4894 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4896 /* Record number of overlay strings, and where we computed it. */
4897 it
->n_overlay_strings
= n
;
4898 it
->overlay_strings_charpos
= charpos
;
4900 /* IT->current.overlay_string_index is the number of overlay strings
4901 that have already been consumed by IT. Copy some of the
4902 remaining overlay strings to IT->overlay_strings. */
4904 j
= it
->current
.overlay_string_index
;
4905 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4907 it
->overlay_strings
[i
] = entries
[j
].string
;
4908 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4915 /* Get the first chunk of overlay strings at IT's current buffer
4916 position, or at CHARPOS if that is > 0. Value is non-zero if at
4917 least one overlay string was found. */
4920 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4922 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4923 process. This fills IT->overlay_strings with strings, and sets
4924 IT->n_overlay_strings to the total number of strings to process.
4925 IT->pos.overlay_string_index has to be set temporarily to zero
4926 because load_overlay_strings needs this; it must be set to -1
4927 when no overlay strings are found because a zero value would
4928 indicate a position in the first overlay string. */
4929 it
->current
.overlay_string_index
= 0;
4930 load_overlay_strings (it
, charpos
);
4932 /* If we found overlay strings, set up IT to deliver display
4933 elements from the first one. Otherwise set up IT to deliver
4934 from current_buffer. */
4935 if (it
->n_overlay_strings
)
4937 /* Make sure we know settings in current_buffer, so that we can
4938 restore meaningful values when we're done with the overlay
4941 compute_stop_pos (it
);
4942 xassert (it
->face_id
>= 0);
4944 /* Save IT's settings. They are restored after all overlay
4945 strings have been processed. */
4946 xassert (!compute_stop_p
|| it
->sp
== 0);
4948 /* When called from handle_stop, there might be an empty display
4949 string loaded. In that case, don't bother saving it. */
4950 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4953 /* Set up IT to deliver display elements from the first overlay
4955 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4956 it
->string
= it
->overlay_strings
[0];
4957 it
->from_overlay
= Qnil
;
4958 it
->stop_charpos
= 0;
4959 xassert (STRINGP (it
->string
));
4960 it
->end_charpos
= SCHARS (it
->string
);
4961 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4962 it
->method
= GET_FROM_STRING
;
4966 it
->current
.overlay_string_index
= -1;
4971 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4974 it
->method
= GET_FROM_BUFFER
;
4976 (void) get_overlay_strings_1 (it
, charpos
, 1);
4980 /* Value is non-zero if we found at least one overlay string. */
4981 return STRINGP (it
->string
);
4986 /***********************************************************************
4987 Saving and restoring state
4988 ***********************************************************************/
4990 /* Save current settings of IT on IT->stack. Called, for example,
4991 before setting up IT for an overlay string, to be able to restore
4992 IT's settings to what they were after the overlay string has been
4993 processed. If POSITION is non-NULL, it is the position to save on
4994 the stack instead of IT->position. */
4997 push_it (struct it
*it
, struct text_pos
*position
)
4999 struct iterator_stack_entry
*p
;
5001 xassert (it
->sp
< IT_STACK_SIZE
);
5002 p
= it
->stack
+ it
->sp
;
5004 p
->stop_charpos
= it
->stop_charpos
;
5005 p
->prev_stop
= it
->prev_stop
;
5006 p
->base_level_stop
= it
->base_level_stop
;
5007 p
->cmp_it
= it
->cmp_it
;
5008 xassert (it
->face_id
>= 0);
5009 p
->face_id
= it
->face_id
;
5010 p
->string
= it
->string
;
5011 p
->method
= it
->method
;
5012 p
->from_overlay
= it
->from_overlay
;
5015 case GET_FROM_IMAGE
:
5016 p
->u
.image
.object
= it
->object
;
5017 p
->u
.image
.image_id
= it
->image_id
;
5018 p
->u
.image
.slice
= it
->slice
;
5020 case GET_FROM_STRETCH
:
5021 p
->u
.stretch
.object
= it
->object
;
5024 p
->position
= position
? *position
: it
->position
;
5025 p
->current
= it
->current
;
5026 p
->end_charpos
= it
->end_charpos
;
5027 p
->string_nchars
= it
->string_nchars
;
5029 p
->multibyte_p
= it
->multibyte_p
;
5030 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5031 p
->space_width
= it
->space_width
;
5032 p
->font_height
= it
->font_height
;
5033 p
->voffset
= it
->voffset
;
5034 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5035 p
->display_ellipsis_p
= 0;
5036 p
->line_wrap
= it
->line_wrap
;
5041 iterate_out_of_display_property (struct it
*it
)
5043 /* Maybe initialize paragraph direction. If we are at the beginning
5044 of a new paragraph, next_element_from_buffer may not have a
5045 chance to do that. */
5046 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5047 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5048 /* prev_stop can be zero, so check against BEGV as well. */
5049 while (it
->bidi_it
.charpos
>= BEGV
5050 && it
->prev_stop
<= it
->bidi_it
.charpos
5051 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5052 bidi_move_to_visually_next (&it
->bidi_it
);
5053 /* Record the stop_pos we just crossed, for when we cross it
5055 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5056 it
->prev_stop
= CHARPOS (it
->position
);
5057 /* If we ended up not where pop_it put us, resync IT's
5058 positional members with the bidi iterator. */
5059 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5061 SET_TEXT_POS (it
->position
,
5062 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5063 it
->current
.pos
= it
->position
;
5067 /* Restore IT's settings from IT->stack. Called, for example, when no
5068 more overlay strings must be processed, and we return to delivering
5069 display elements from a buffer, or when the end of a string from a
5070 `display' property is reached and we return to delivering display
5071 elements from an overlay string, or from a buffer. */
5074 pop_it (struct it
*it
)
5076 struct iterator_stack_entry
*p
;
5078 xassert (it
->sp
> 0);
5080 p
= it
->stack
+ it
->sp
;
5081 it
->stop_charpos
= p
->stop_charpos
;
5082 it
->prev_stop
= p
->prev_stop
;
5083 it
->base_level_stop
= p
->base_level_stop
;
5084 it
->cmp_it
= p
->cmp_it
;
5085 it
->face_id
= p
->face_id
;
5086 it
->current
= p
->current
;
5087 it
->position
= p
->position
;
5088 it
->string
= p
->string
;
5089 it
->from_overlay
= p
->from_overlay
;
5090 if (NILP (it
->string
))
5091 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5092 it
->method
= p
->method
;
5095 case GET_FROM_IMAGE
:
5096 it
->image_id
= p
->u
.image
.image_id
;
5097 it
->object
= p
->u
.image
.object
;
5098 it
->slice
= p
->u
.image
.slice
;
5100 case GET_FROM_STRETCH
:
5101 it
->object
= p
->u
.comp
.object
;
5103 case GET_FROM_BUFFER
:
5104 it
->object
= it
->w
->buffer
;
5107 /* Bidi-iterate until we get out of the portion of text, if
5108 any, covered by a `display' text property or an overlay
5109 with `display' property. (We cannot just jump there,
5110 because the internal coherency of the bidi iterator state
5111 can not be preserved across such jumps.) We also must
5112 determine the paragraph base direction if the overlay we
5113 just processed is at the beginning of a new
5115 iterate_out_of_display_property (it
);
5118 case GET_FROM_STRING
:
5119 it
->object
= it
->string
;
5121 case GET_FROM_DISPLAY_VECTOR
:
5123 it
->method
= GET_FROM_C_STRING
;
5124 else if (STRINGP (it
->string
))
5125 it
->method
= GET_FROM_STRING
;
5128 it
->method
= GET_FROM_BUFFER
;
5129 it
->object
= it
->w
->buffer
;
5132 it
->end_charpos
= p
->end_charpos
;
5133 it
->string_nchars
= p
->string_nchars
;
5135 it
->multibyte_p
= p
->multibyte_p
;
5136 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5137 it
->space_width
= p
->space_width
;
5138 it
->font_height
= p
->font_height
;
5139 it
->voffset
= p
->voffset
;
5140 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5141 it
->line_wrap
= p
->line_wrap
;
5146 /***********************************************************************
5148 ***********************************************************************/
5150 /* Set IT's current position to the previous line start. */
5153 back_to_previous_line_start (struct it
*it
)
5155 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5156 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5160 /* Move IT to the next line start.
5162 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5163 we skipped over part of the text (as opposed to moving the iterator
5164 continuously over the text). Otherwise, don't change the value
5167 Newlines may come from buffer text, overlay strings, or strings
5168 displayed via the `display' property. That's the reason we can't
5169 simply use find_next_newline_no_quit.
5171 Note that this function may not skip over invisible text that is so
5172 because of text properties and immediately follows a newline. If
5173 it would, function reseat_at_next_visible_line_start, when called
5174 from set_iterator_to_next, would effectively make invisible
5175 characters following a newline part of the wrong glyph row, which
5176 leads to wrong cursor motion. */
5179 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5181 EMACS_INT old_selective
;
5182 int newline_found_p
, n
;
5183 const int MAX_NEWLINE_DISTANCE
= 500;
5185 /* If already on a newline, just consume it to avoid unintended
5186 skipping over invisible text below. */
5187 if (it
->what
== IT_CHARACTER
5189 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5191 set_iterator_to_next (it
, 0);
5196 /* Don't handle selective display in the following. It's (a)
5197 unnecessary because it's done by the caller, and (b) leads to an
5198 infinite recursion because next_element_from_ellipsis indirectly
5199 calls this function. */
5200 old_selective
= it
->selective
;
5203 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5204 from buffer text. */
5205 for (n
= newline_found_p
= 0;
5206 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5207 n
+= STRINGP (it
->string
) ? 0 : 1)
5209 if (!get_next_display_element (it
))
5211 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5212 set_iterator_to_next (it
, 0);
5215 /* If we didn't find a newline near enough, see if we can use a
5217 if (!newline_found_p
)
5219 EMACS_INT start
= IT_CHARPOS (*it
);
5220 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5223 xassert (!STRINGP (it
->string
));
5225 /* If there isn't any `display' property in sight, and no
5226 overlays, we can just use the position of the newline in
5228 if (it
->stop_charpos
>= limit
5229 || ((pos
= Fnext_single_property_change (make_number (start
),
5231 Qnil
, make_number (limit
)),
5233 && next_overlay_change (start
) == ZV
))
5235 IT_CHARPOS (*it
) = limit
;
5236 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5237 *skipped_p
= newline_found_p
= 1;
5241 while (get_next_display_element (it
)
5242 && !newline_found_p
)
5244 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5245 set_iterator_to_next (it
, 0);
5250 it
->selective
= old_selective
;
5251 return newline_found_p
;
5255 /* Set IT's current position to the previous visible line start. Skip
5256 invisible text that is so either due to text properties or due to
5257 selective display. Caution: this does not change IT->current_x and
5261 back_to_previous_visible_line_start (struct it
*it
)
5263 while (IT_CHARPOS (*it
) > BEGV
)
5265 back_to_previous_line_start (it
);
5267 if (IT_CHARPOS (*it
) <= BEGV
)
5270 /* If selective > 0, then lines indented more than its value are
5272 if (it
->selective
> 0
5273 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5277 /* Check the newline before point for invisibility. */
5280 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5281 Qinvisible
, it
->window
);
5282 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5286 if (IT_CHARPOS (*it
) <= BEGV
)
5293 Lisp_Object val
, overlay
;
5295 /* If newline is part of a composition, continue from start of composition */
5296 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5297 && beg
< IT_CHARPOS (*it
))
5300 /* If newline is replaced by a display property, find start of overlay
5301 or interval and continue search from that point. */
5303 pos
= --IT_CHARPOS (it2
);
5306 it2
.string_from_display_prop_p
= 0;
5307 if (handle_display_prop (&it2
) == HANDLED_RETURN
5308 && !NILP (val
= get_char_property_and_overlay
5309 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5310 && (OVERLAYP (overlay
)
5311 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5312 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5315 /* Newline is not replaced by anything -- so we are done. */
5321 IT_CHARPOS (*it
) = beg
;
5322 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5326 it
->continuation_lines_width
= 0;
5328 xassert (IT_CHARPOS (*it
) >= BEGV
);
5329 xassert (IT_CHARPOS (*it
) == BEGV
5330 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5335 /* Reseat iterator IT at the previous visible line start. Skip
5336 invisible text that is so either due to text properties or due to
5337 selective display. At the end, update IT's overlay information,
5338 face information etc. */
5341 reseat_at_previous_visible_line_start (struct it
*it
)
5343 back_to_previous_visible_line_start (it
);
5344 reseat (it
, it
->current
.pos
, 1);
5349 /* Reseat iterator IT on the next visible line start in the current
5350 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5351 preceding the line start. Skip over invisible text that is so
5352 because of selective display. Compute faces, overlays etc at the
5353 new position. Note that this function does not skip over text that
5354 is invisible because of text properties. */
5357 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5359 int newline_found_p
, skipped_p
= 0;
5361 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5363 /* Skip over lines that are invisible because they are indented
5364 more than the value of IT->selective. */
5365 if (it
->selective
> 0)
5366 while (IT_CHARPOS (*it
) < ZV
5367 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5370 xassert (IT_BYTEPOS (*it
) == BEGV
5371 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5372 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5375 /* Position on the newline if that's what's requested. */
5376 if (on_newline_p
&& newline_found_p
)
5378 if (STRINGP (it
->string
))
5380 if (IT_STRING_CHARPOS (*it
) > 0)
5382 --IT_STRING_CHARPOS (*it
);
5383 --IT_STRING_BYTEPOS (*it
);
5386 else if (IT_CHARPOS (*it
) > BEGV
)
5390 reseat (it
, it
->current
.pos
, 0);
5394 reseat (it
, it
->current
.pos
, 0);
5401 /***********************************************************************
5402 Changing an iterator's position
5403 ***********************************************************************/
5405 /* Change IT's current position to POS in current_buffer. If FORCE_P
5406 is non-zero, always check for text properties at the new position.
5407 Otherwise, text properties are only looked up if POS >=
5408 IT->check_charpos of a property. */
5411 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5413 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5415 reseat_1 (it
, pos
, 0);
5417 /* Determine where to check text properties. Avoid doing it
5418 where possible because text property lookup is very expensive. */
5420 || CHARPOS (pos
) > it
->stop_charpos
5421 || CHARPOS (pos
) < original_pos
)
5425 /* For bidi iteration, we need to prime prev_stop and
5426 base_level_stop with our best estimations. */
5427 if (CHARPOS (pos
) < it
->prev_stop
)
5429 handle_stop_backwards (it
, BEGV
);
5430 if (CHARPOS (pos
) < it
->base_level_stop
)
5431 it
->base_level_stop
= 0;
5433 else if (CHARPOS (pos
) > it
->stop_charpos
5434 && it
->stop_charpos
>= BEGV
)
5435 handle_stop_backwards (it
, it
->stop_charpos
);
5442 it
->prev_stop
= it
->base_level_stop
= 0;
5451 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5452 IT->stop_pos to POS, also. */
5455 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5457 /* Don't call this function when scanning a C string. */
5458 xassert (it
->s
== NULL
);
5460 /* POS must be a reasonable value. */
5461 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5463 it
->current
.pos
= it
->position
= pos
;
5464 it
->end_charpos
= ZV
;
5466 it
->current
.dpvec_index
= -1;
5467 it
->current
.overlay_string_index
= -1;
5468 IT_STRING_CHARPOS (*it
) = -1;
5469 IT_STRING_BYTEPOS (*it
) = -1;
5471 it
->string_from_display_prop_p
= 0;
5472 it
->method
= GET_FROM_BUFFER
;
5473 it
->object
= it
->w
->buffer
;
5474 it
->area
= TEXT_AREA
;
5475 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5477 it
->string_from_display_prop_p
= 0;
5478 it
->face_before_selective_p
= 0;
5481 it
->bidi_it
.first_elt
= 1;
5482 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5483 it
->bidi_it
.disp_pos
= -1;
5488 it
->stop_charpos
= CHARPOS (pos
);
5489 it
->base_level_stop
= CHARPOS (pos
);
5494 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5495 If S is non-null, it is a C string to iterate over. Otherwise,
5496 STRING gives a Lisp string to iterate over.
5498 If PRECISION > 0, don't return more then PRECISION number of
5499 characters from the string.
5501 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5502 characters have been returned. FIELD_WIDTH < 0 means an infinite
5505 MULTIBYTE = 0 means disable processing of multibyte characters,
5506 MULTIBYTE > 0 means enable it,
5507 MULTIBYTE < 0 means use IT->multibyte_p.
5509 IT must be initialized via a prior call to init_iterator before
5510 calling this function. */
5513 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5514 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5517 /* No region in strings. */
5518 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5520 /* No text property checks performed by default, but see below. */
5521 it
->stop_charpos
= -1;
5523 /* Set iterator position and end position. */
5524 memset (&it
->current
, 0, sizeof it
->current
);
5525 it
->current
.overlay_string_index
= -1;
5526 it
->current
.dpvec_index
= -1;
5527 xassert (charpos
>= 0);
5529 /* If STRING is specified, use its multibyteness, otherwise use the
5530 setting of MULTIBYTE, if specified. */
5532 it
->multibyte_p
= multibyte
> 0;
5536 xassert (STRINGP (string
));
5537 it
->string
= string
;
5539 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5540 it
->method
= GET_FROM_STRING
;
5541 it
->current
.string_pos
= string_pos (charpos
, string
);
5545 it
->s
= (const unsigned char *) s
;
5548 /* Note that we use IT->current.pos, not it->current.string_pos,
5549 for displaying C strings. */
5550 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5551 if (it
->multibyte_p
)
5553 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5554 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5558 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5559 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5562 it
->method
= GET_FROM_C_STRING
;
5565 /* PRECISION > 0 means don't return more than PRECISION characters
5567 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5568 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5570 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5571 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5572 FIELD_WIDTH < 0 means infinite field width. This is useful for
5573 padding with `-' at the end of a mode line. */
5574 if (field_width
< 0)
5575 field_width
= INFINITY
;
5576 if (field_width
> it
->end_charpos
- charpos
)
5577 it
->end_charpos
= charpos
+ field_width
;
5579 /* Use the standard display table for displaying strings. */
5580 if (DISP_TABLE_P (Vstandard_display_table
))
5581 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5583 it
->stop_charpos
= charpos
;
5584 if (s
== NULL
&& it
->multibyte_p
)
5586 EMACS_INT endpos
= SCHARS (it
->string
);
5587 if (endpos
> it
->end_charpos
)
5588 endpos
= it
->end_charpos
;
5589 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5597 /***********************************************************************
5599 ***********************************************************************/
5601 /* Map enum it_method value to corresponding next_element_from_* function. */
5603 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5605 next_element_from_buffer
,
5606 next_element_from_display_vector
,
5607 next_element_from_string
,
5608 next_element_from_c_string
,
5609 next_element_from_image
,
5610 next_element_from_stretch
5613 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5616 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5617 (possibly with the following characters). */
5619 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5620 ((IT)->cmp_it.id >= 0 \
5621 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5622 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5623 END_CHARPOS, (IT)->w, \
5624 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5628 /* Lookup the char-table Vglyphless_char_display for character C (-1
5629 if we want information for no-font case), and return the display
5630 method symbol. By side-effect, update it->what and
5631 it->glyphless_method. This function is called from
5632 get_next_display_element for each character element, and from
5633 x_produce_glyphs when no suitable font was found. */
5636 lookup_glyphless_char_display (int c
, struct it
*it
)
5638 Lisp_Object glyphless_method
= Qnil
;
5640 if (CHAR_TABLE_P (Vglyphless_char_display
)
5641 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5645 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
5646 if (CONSP (glyphless_method
))
5647 glyphless_method
= FRAME_WINDOW_P (it
->f
)
5648 ? XCAR (glyphless_method
)
5649 : XCDR (glyphless_method
);
5652 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
5656 if (NILP (glyphless_method
))
5659 /* The default is to display the character by a proper font. */
5661 /* The default for the no-font case is to display an empty box. */
5662 glyphless_method
= Qempty_box
;
5664 if (EQ (glyphless_method
, Qzero_width
))
5667 return glyphless_method
;
5668 /* This method can't be used for the no-font case. */
5669 glyphless_method
= Qempty_box
;
5671 if (EQ (glyphless_method
, Qthin_space
))
5672 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5673 else if (EQ (glyphless_method
, Qempty_box
))
5674 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5675 else if (EQ (glyphless_method
, Qhex_code
))
5676 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5677 else if (STRINGP (glyphless_method
))
5678 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5681 /* Invalid value. We use the default method. */
5682 glyphless_method
= Qnil
;
5685 it
->what
= IT_GLYPHLESS
;
5686 return glyphless_method
;
5689 /* Load IT's display element fields with information about the next
5690 display element from the current position of IT. Value is zero if
5691 end of buffer (or C string) is reached. */
5693 static struct frame
*last_escape_glyph_frame
= NULL
;
5694 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5695 static int last_escape_glyph_merged_face_id
= 0;
5697 struct frame
*last_glyphless_glyph_frame
= NULL
;
5698 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5699 int last_glyphless_glyph_merged_face_id
= 0;
5702 get_next_display_element (struct it
*it
)
5704 /* Non-zero means that we found a display element. Zero means that
5705 we hit the end of what we iterate over. Performance note: the
5706 function pointer `method' used here turns out to be faster than
5707 using a sequence of if-statements. */
5711 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5713 if (it
->what
== IT_CHARACTER
)
5715 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5716 and only if (a) the resolved directionality of that character
5718 /* FIXME: Do we need an exception for characters from display
5720 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5721 it
->c
= bidi_mirror_char (it
->c
);
5722 /* Map via display table or translate control characters.
5723 IT->c, IT->len etc. have been set to the next character by
5724 the function call above. If we have a display table, and it
5725 contains an entry for IT->c, translate it. Don't do this if
5726 IT->c itself comes from a display table, otherwise we could
5727 end up in an infinite recursion. (An alternative could be to
5728 count the recursion depth of this function and signal an
5729 error when a certain maximum depth is reached.) Is it worth
5731 if (success_p
&& it
->dpvec
== NULL
)
5734 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5735 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5736 nbsp_or_shy
= char_is_other
;
5737 int c
= it
->c
; /* This is the character to display. */
5739 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5741 xassert (SINGLE_BYTE_CHAR_P (c
));
5742 if (unibyte_display_via_language_environment
)
5744 c
= DECODE_CHAR (unibyte
, c
);
5746 c
= BYTE8_TO_CHAR (it
->c
);
5749 c
= BYTE8_TO_CHAR (it
->c
);
5753 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5756 struct Lisp_Vector
*v
= XVECTOR (dv
);
5758 /* Return the first character from the display table
5759 entry, if not empty. If empty, don't display the
5760 current character. */
5763 it
->dpvec_char_len
= it
->len
;
5764 it
->dpvec
= v
->contents
;
5765 it
->dpend
= v
->contents
+ v
->header
.size
;
5766 it
->current
.dpvec_index
= 0;
5767 it
->dpvec_face_id
= -1;
5768 it
->saved_face_id
= it
->face_id
;
5769 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5774 set_iterator_to_next (it
, 0);
5779 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5781 if (it
->what
== IT_GLYPHLESS
)
5783 /* Don't display this character. */
5784 set_iterator_to_next (it
, 0);
5788 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5789 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5790 : c
== 0xAD ? char_is_soft_hyphen
5793 /* Translate control characters into `\003' or `^C' form.
5794 Control characters coming from a display table entry are
5795 currently not translated because we use IT->dpvec to hold
5796 the translation. This could easily be changed but I
5797 don't believe that it is worth doing.
5799 NBSP and SOFT-HYPEN are property translated too.
5801 Non-printable characters and raw-byte characters are also
5802 translated to octal form. */
5803 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5804 ? (it
->area
!= TEXT_AREA
5805 /* In mode line, treat \n, \t like other crl chars. */
5808 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5809 || (c
!= '\n' && c
!= '\t'))
5812 || ! CHAR_PRINTABLE_P (c
))))
5814 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5815 or a non-printable character which must be displayed
5816 either as '\003' or as `^C' where the '\\' and '^'
5817 can be defined in the display table. Fill
5818 IT->ctl_chars with glyphs for what we have to
5819 display. Then, set IT->dpvec to these glyphs. */
5823 EMACS_INT lface_id
= 0;
5826 /* Handle control characters with ^. */
5828 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5832 g
= '^'; /* default glyph for Control */
5833 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5835 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5836 && GLYPH_CODE_CHAR_VALID_P (gc
))
5838 g
= GLYPH_CODE_CHAR (gc
);
5839 lface_id
= GLYPH_CODE_FACE (gc
);
5843 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5845 else if (it
->f
== last_escape_glyph_frame
5846 && it
->face_id
== last_escape_glyph_face_id
)
5848 face_id
= last_escape_glyph_merged_face_id
;
5852 /* Merge the escape-glyph face into the current face. */
5853 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5855 last_escape_glyph_frame
= it
->f
;
5856 last_escape_glyph_face_id
= it
->face_id
;
5857 last_escape_glyph_merged_face_id
= face_id
;
5860 XSETINT (it
->ctl_chars
[0], g
);
5861 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5863 goto display_control
;
5866 /* Handle non-break space in the mode where it only gets
5869 if (EQ (Vnobreak_char_display
, Qt
)
5870 && nbsp_or_shy
== char_is_nbsp
)
5872 /* Merge the no-break-space face into the current face. */
5873 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5877 XSETINT (it
->ctl_chars
[0], ' ');
5879 goto display_control
;
5882 /* Handle sequences that start with the "escape glyph". */
5884 /* the default escape glyph is \. */
5885 escape_glyph
= '\\';
5888 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5889 && GLYPH_CODE_CHAR_VALID_P (gc
))
5891 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5892 lface_id
= GLYPH_CODE_FACE (gc
);
5896 /* The display table specified a face.
5897 Merge it into face_id and also into escape_glyph. */
5898 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5901 else if (it
->f
== last_escape_glyph_frame
5902 && it
->face_id
== last_escape_glyph_face_id
)
5904 face_id
= last_escape_glyph_merged_face_id
;
5908 /* Merge the escape-glyph face into the current face. */
5909 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5911 last_escape_glyph_frame
= it
->f
;
5912 last_escape_glyph_face_id
= it
->face_id
;
5913 last_escape_glyph_merged_face_id
= face_id
;
5916 /* Handle soft hyphens in the mode where they only get
5919 if (EQ (Vnobreak_char_display
, Qt
)
5920 && nbsp_or_shy
== char_is_soft_hyphen
)
5922 XSETINT (it
->ctl_chars
[0], '-');
5924 goto display_control
;
5927 /* Handle non-break space and soft hyphen
5928 with the escape glyph. */
5932 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5933 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5934 XSETINT (it
->ctl_chars
[1], c
);
5936 goto display_control
;
5943 if (CHAR_BYTE8_P (c
))
5944 /* Display \200 instead of \17777600. */
5945 c
= CHAR_TO_BYTE8 (c
);
5946 len
= sprintf (str
, "%03o", c
);
5948 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5949 for (i
= 0; i
< len
; i
++)
5950 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5955 /* Set up IT->dpvec and return first character from it. */
5956 it
->dpvec_char_len
= it
->len
;
5957 it
->dpvec
= it
->ctl_chars
;
5958 it
->dpend
= it
->dpvec
+ ctl_len
;
5959 it
->current
.dpvec_index
= 0;
5960 it
->dpvec_face_id
= face_id
;
5961 it
->saved_face_id
= it
->face_id
;
5962 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5966 it
->char_to_display
= c
;
5970 it
->char_to_display
= it
->c
;
5974 /* Adjust face id for a multibyte character. There are no multibyte
5975 character in unibyte text. */
5976 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5979 && FRAME_WINDOW_P (it
->f
))
5981 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5983 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5985 /* Automatic composition with glyph-string. */
5986 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5988 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5992 EMACS_INT pos
= (it
->s
? -1
5993 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5994 : IT_CHARPOS (*it
));
5997 if (it
->what
== IT_CHARACTER
)
5998 c
= it
->char_to_display
;
6001 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6005 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6006 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6009 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6014 /* Is this character the last one of a run of characters with
6015 box? If yes, set IT->end_of_box_run_p to 1. */
6019 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6021 int face_id
= underlying_face_id (it
);
6022 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6026 if (face
->box
== FACE_NO_BOX
)
6028 /* If the box comes from face properties in a
6029 display string, check faces in that string. */
6030 int string_face_id
= face_after_it_pos (it
);
6031 it
->end_of_box_run_p
6032 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6035 /* Otherwise, the box comes from the underlying face.
6036 If this is the last string character displayed, check
6037 the next buffer location. */
6038 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6039 && (it
->current
.overlay_string_index
6040 == it
->n_overlay_strings
- 1))
6044 struct text_pos pos
= it
->current
.pos
;
6045 INC_TEXT_POS (pos
, it
->multibyte_p
);
6047 next_face_id
= face_at_buffer_position
6048 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6049 it
->region_end_charpos
, &ignore
,
6050 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6052 it
->end_of_box_run_p
6053 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6060 int face_id
= face_after_it_pos (it
);
6061 it
->end_of_box_run_p
6062 = (face_id
!= it
->face_id
6063 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6067 /* Value is 0 if end of buffer or string reached. */
6072 /* Move IT to the next display element.
6074 RESEAT_P non-zero means if called on a newline in buffer text,
6075 skip to the next visible line start.
6077 Functions get_next_display_element and set_iterator_to_next are
6078 separate because I find this arrangement easier to handle than a
6079 get_next_display_element function that also increments IT's
6080 position. The way it is we can first look at an iterator's current
6081 display element, decide whether it fits on a line, and if it does,
6082 increment the iterator position. The other way around we probably
6083 would either need a flag indicating whether the iterator has to be
6084 incremented the next time, or we would have to implement a
6085 decrement position function which would not be easy to write. */
6088 set_iterator_to_next (struct it
*it
, int reseat_p
)
6090 /* Reset flags indicating start and end of a sequence of characters
6091 with box. Reset them at the start of this function because
6092 moving the iterator to a new position might set them. */
6093 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6097 case GET_FROM_BUFFER
:
6098 /* The current display element of IT is a character from
6099 current_buffer. Advance in the buffer, and maybe skip over
6100 invisible lines that are so because of selective display. */
6101 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6102 reseat_at_next_visible_line_start (it
, 0);
6103 else if (it
->cmp_it
.id
>= 0)
6105 /* We are currently getting glyphs from a composition. */
6110 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6111 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6112 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6114 it
->cmp_it
.from
= it
->cmp_it
.to
;
6119 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6121 it
->end_charpos
, Qnil
);
6124 else if (! it
->cmp_it
.reversed_p
)
6126 /* Composition created while scanning forward. */
6127 /* Update IT's char/byte positions to point to the first
6128 character of the next grapheme cluster, or to the
6129 character visually after the current composition. */
6130 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6131 bidi_move_to_visually_next (&it
->bidi_it
);
6132 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6133 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6135 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6137 /* Proceed to the next grapheme cluster. */
6138 it
->cmp_it
.from
= it
->cmp_it
.to
;
6142 /* No more grapheme clusters in this composition.
6143 Find the next stop position. */
6144 EMACS_INT stop
= it
->end_charpos
;
6145 if (it
->bidi_it
.scan_dir
< 0)
6146 /* Now we are scanning backward and don't know
6149 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6150 IT_BYTEPOS (*it
), stop
, Qnil
);
6155 /* Composition created while scanning backward. */
6156 /* Update IT's char/byte positions to point to the last
6157 character of the previous grapheme cluster, or the
6158 character visually after the current composition. */
6159 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6160 bidi_move_to_visually_next (&it
->bidi_it
);
6161 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6162 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6163 if (it
->cmp_it
.from
> 0)
6165 /* Proceed to the previous grapheme cluster. */
6166 it
->cmp_it
.to
= it
->cmp_it
.from
;
6170 /* No more grapheme clusters in this composition.
6171 Find the next stop position. */
6172 EMACS_INT stop
= it
->end_charpos
;
6173 if (it
->bidi_it
.scan_dir
< 0)
6174 /* Now we are scanning backward and don't know
6177 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6178 IT_BYTEPOS (*it
), stop
, Qnil
);
6184 xassert (it
->len
!= 0);
6188 IT_BYTEPOS (*it
) += it
->len
;
6189 IT_CHARPOS (*it
) += 1;
6193 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6194 /* If this is a new paragraph, determine its base
6195 direction (a.k.a. its base embedding level). */
6196 if (it
->bidi_it
.new_paragraph
)
6197 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6198 bidi_move_to_visually_next (&it
->bidi_it
);
6199 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6200 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6201 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6203 /* As the scan direction was changed, we must
6204 re-compute the stop position for composition. */
6205 EMACS_INT stop
= it
->end_charpos
;
6206 if (it
->bidi_it
.scan_dir
< 0)
6208 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6209 IT_BYTEPOS (*it
), stop
, Qnil
);
6212 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6216 case GET_FROM_C_STRING
:
6217 /* Current display element of IT is from a C string. */
6218 IT_BYTEPOS (*it
) += it
->len
;
6219 IT_CHARPOS (*it
) += 1;
6222 case GET_FROM_DISPLAY_VECTOR
:
6223 /* Current display element of IT is from a display table entry.
6224 Advance in the display table definition. Reset it to null if
6225 end reached, and continue with characters from buffers/
6227 ++it
->current
.dpvec_index
;
6229 /* Restore face of the iterator to what they were before the
6230 display vector entry (these entries may contain faces). */
6231 it
->face_id
= it
->saved_face_id
;
6233 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6235 int recheck_faces
= it
->ellipsis_p
;
6238 it
->method
= GET_FROM_C_STRING
;
6239 else if (STRINGP (it
->string
))
6240 it
->method
= GET_FROM_STRING
;
6243 it
->method
= GET_FROM_BUFFER
;
6244 it
->object
= it
->w
->buffer
;
6248 it
->current
.dpvec_index
= -1;
6250 /* Skip over characters which were displayed via IT->dpvec. */
6251 if (it
->dpvec_char_len
< 0)
6252 reseat_at_next_visible_line_start (it
, 1);
6253 else if (it
->dpvec_char_len
> 0)
6255 if (it
->method
== GET_FROM_STRING
6256 && it
->n_overlay_strings
> 0)
6257 it
->ignore_overlay_strings_at_pos_p
= 1;
6258 it
->len
= it
->dpvec_char_len
;
6259 set_iterator_to_next (it
, reseat_p
);
6262 /* Maybe recheck faces after display vector */
6264 it
->stop_charpos
= IT_CHARPOS (*it
);
6268 case GET_FROM_STRING
:
6269 /* Current display element is a character from a Lisp string. */
6270 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6271 if (it
->cmp_it
.id
>= 0)
6273 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6274 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6275 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6276 it
->cmp_it
.from
= it
->cmp_it
.to
;
6280 composition_compute_stop_pos (&it
->cmp_it
,
6281 IT_STRING_CHARPOS (*it
),
6282 IT_STRING_BYTEPOS (*it
),
6283 it
->end_charpos
, it
->string
);
6288 IT_STRING_BYTEPOS (*it
) += it
->len
;
6289 IT_STRING_CHARPOS (*it
) += 1;
6292 consider_string_end
:
6294 if (it
->current
.overlay_string_index
>= 0)
6296 /* IT->string is an overlay string. Advance to the
6297 next, if there is one. */
6298 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6301 next_overlay_string (it
);
6303 setup_for_ellipsis (it
, 0);
6308 /* IT->string is not an overlay string. If we reached
6309 its end, and there is something on IT->stack, proceed
6310 with what is on the stack. This can be either another
6311 string, this time an overlay string, or a buffer. */
6312 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6316 if (it
->method
== GET_FROM_STRING
)
6317 goto consider_string_end
;
6322 case GET_FROM_IMAGE
:
6323 case GET_FROM_STRETCH
:
6324 /* The position etc with which we have to proceed are on
6325 the stack. The position may be at the end of a string,
6326 if the `display' property takes up the whole string. */
6327 xassert (it
->sp
> 0);
6329 if (it
->method
== GET_FROM_STRING
)
6330 goto consider_string_end
;
6334 /* There are no other methods defined, so this should be a bug. */
6338 xassert (it
->method
!= GET_FROM_STRING
6339 || (STRINGP (it
->string
)
6340 && IT_STRING_CHARPOS (*it
) >= 0));
6343 /* Load IT's display element fields with information about the next
6344 display element which comes from a display table entry or from the
6345 result of translating a control character to one of the forms `^C'
6348 IT->dpvec holds the glyphs to return as characters.
6349 IT->saved_face_id holds the face id before the display vector--it
6350 is restored into IT->face_id in set_iterator_to_next. */
6353 next_element_from_display_vector (struct it
*it
)
6358 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6360 it
->face_id
= it
->saved_face_id
;
6362 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6363 That seemed totally bogus - so I changed it... */
6364 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6366 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6368 it
->c
= GLYPH_CODE_CHAR (gc
);
6369 it
->len
= CHAR_BYTES (it
->c
);
6371 /* The entry may contain a face id to use. Such a face id is
6372 the id of a Lisp face, not a realized face. A face id of
6373 zero means no face is specified. */
6374 if (it
->dpvec_face_id
>= 0)
6375 it
->face_id
= it
->dpvec_face_id
;
6378 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6380 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6385 /* Display table entry is invalid. Return a space. */
6386 it
->c
= ' ', it
->len
= 1;
6388 /* Don't change position and object of the iterator here. They are
6389 still the values of the character that had this display table
6390 entry or was translated, and that's what we want. */
6391 it
->what
= IT_CHARACTER
;
6396 /* Load IT with the next display element from Lisp string IT->string.
6397 IT->current.string_pos is the current position within the string.
6398 If IT->current.overlay_string_index >= 0, the Lisp string is an
6402 next_element_from_string (struct it
*it
)
6404 struct text_pos position
;
6406 xassert (STRINGP (it
->string
));
6407 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6408 position
= it
->current
.string_pos
;
6410 /* Time to check for invisible text? */
6411 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6412 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6416 /* Since a handler may have changed IT->method, we must
6418 return GET_NEXT_DISPLAY_ELEMENT (it
);
6421 if (it
->current
.overlay_string_index
>= 0)
6423 /* Get the next character from an overlay string. In overlay
6424 strings, There is no field width or padding with spaces to
6426 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6431 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6432 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6433 && next_element_from_composition (it
))
6437 else if (STRING_MULTIBYTE (it
->string
))
6439 const unsigned char *s
= (SDATA (it
->string
)
6440 + IT_STRING_BYTEPOS (*it
));
6441 it
->c
= string_char_and_length (s
, &it
->len
);
6445 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6451 /* Get the next character from a Lisp string that is not an
6452 overlay string. Such strings come from the mode line, for
6453 example. We may have to pad with spaces, or truncate the
6454 string. See also next_element_from_c_string. */
6455 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6460 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6462 /* Pad with spaces. */
6463 it
->c
= ' ', it
->len
= 1;
6464 CHARPOS (position
) = BYTEPOS (position
) = -1;
6466 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6467 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6468 && next_element_from_composition (it
))
6472 else if (STRING_MULTIBYTE (it
->string
))
6474 const unsigned char *s
= (SDATA (it
->string
)
6475 + IT_STRING_BYTEPOS (*it
));
6476 it
->c
= string_char_and_length (s
, &it
->len
);
6480 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6485 /* Record what we have and where it came from. */
6486 it
->what
= IT_CHARACTER
;
6487 it
->object
= it
->string
;
6488 it
->position
= position
;
6493 /* Load IT with next display element from C string IT->s.
6494 IT->string_nchars is the maximum number of characters to return
6495 from the string. IT->end_charpos may be greater than
6496 IT->string_nchars when this function is called, in which case we
6497 may have to return padding spaces. Value is zero if end of string
6498 reached, including padding spaces. */
6501 next_element_from_c_string (struct it
*it
)
6506 it
->what
= IT_CHARACTER
;
6507 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6510 /* IT's position can be greater IT->string_nchars in case a field
6511 width or precision has been specified when the iterator was
6513 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6515 /* End of the game. */
6519 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6521 /* Pad with spaces. */
6522 it
->c
= ' ', it
->len
= 1;
6523 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6525 else if (it
->multibyte_p
)
6526 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6528 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6534 /* Set up IT to return characters from an ellipsis, if appropriate.
6535 The definition of the ellipsis glyphs may come from a display table
6536 entry. This function fills IT with the first glyph from the
6537 ellipsis if an ellipsis is to be displayed. */
6540 next_element_from_ellipsis (struct it
*it
)
6542 if (it
->selective_display_ellipsis_p
)
6543 setup_for_ellipsis (it
, it
->len
);
6546 /* The face at the current position may be different from the
6547 face we find after the invisible text. Remember what it
6548 was in IT->saved_face_id, and signal that it's there by
6549 setting face_before_selective_p. */
6550 it
->saved_face_id
= it
->face_id
;
6551 it
->method
= GET_FROM_BUFFER
;
6552 it
->object
= it
->w
->buffer
;
6553 reseat_at_next_visible_line_start (it
, 1);
6554 it
->face_before_selective_p
= 1;
6557 return GET_NEXT_DISPLAY_ELEMENT (it
);
6561 /* Deliver an image display element. The iterator IT is already
6562 filled with image information (done in handle_display_prop). Value
6567 next_element_from_image (struct it
*it
)
6569 it
->what
= IT_IMAGE
;
6570 it
->ignore_overlay_strings_at_pos_p
= 0;
6575 /* Fill iterator IT with next display element from a stretch glyph
6576 property. IT->object is the value of the text property. Value is
6580 next_element_from_stretch (struct it
*it
)
6582 it
->what
= IT_STRETCH
;
6586 /* Scan forward from CHARPOS in the current buffer, until we find a
6587 stop position > current IT's position. Then handle the stop
6588 position before that. This is called when we bump into a stop
6589 position while reordering bidirectional text. CHARPOS should be
6590 the last previously processed stop_pos (or BEGV, if none were
6591 processed yet) whose position is less that IT's current
6595 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6597 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6598 struct display_pos save_current
= it
->current
;
6599 struct text_pos save_position
= it
->position
;
6600 struct text_pos pos1
;
6601 EMACS_INT next_stop
;
6603 /* Scan in strict logical order. */
6607 it
->prev_stop
= charpos
;
6608 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6609 reseat_1 (it
, pos1
, 0);
6610 compute_stop_pos (it
);
6611 /* We must advance forward, right? */
6612 if (it
->stop_charpos
<= it
->prev_stop
)
6614 charpos
= it
->stop_charpos
;
6616 while (charpos
<= where_we_are
);
6618 next_stop
= it
->stop_charpos
;
6619 it
->stop_charpos
= it
->prev_stop
;
6621 it
->current
= save_current
;
6622 it
->position
= save_position
;
6624 it
->stop_charpos
= next_stop
;
6627 /* Load IT with the next display element from current_buffer. Value
6628 is zero if end of buffer reached. IT->stop_charpos is the next
6629 position at which to stop and check for text properties or buffer
6633 next_element_from_buffer (struct it
*it
)
6637 xassert (IT_CHARPOS (*it
) >= BEGV
);
6639 /* With bidi reordering, the character to display might not be the
6640 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6641 we were reseat()ed to a new buffer position, which is potentially
6642 a different paragraph. */
6643 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6645 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6646 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6647 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6649 /* Nothing to do, but reset the FIRST_ELT flag, like
6650 bidi_paragraph_init does, because we are not going to
6652 it
->bidi_it
.first_elt
= 0;
6654 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6655 /* FIXME: Should support all Unicode line separators. */
6656 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6657 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6659 /* If we are at the beginning of a line, we can produce the
6660 next element right away. */
6661 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6662 bidi_move_to_visually_next (&it
->bidi_it
);
6666 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6668 /* We need to prime the bidi iterator starting at the line's
6669 beginning, before we will be able to produce the next
6671 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6672 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6673 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6674 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6675 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6678 /* Now return to buffer position where we were asked to
6679 get the next display element, and produce that. */
6680 bidi_move_to_visually_next (&it
->bidi_it
);
6682 while (it
->bidi_it
.bytepos
!= orig_bytepos
6683 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6686 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6687 /* Adjust IT's position information to where we ended up. */
6688 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6689 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6690 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6692 EMACS_INT stop
= it
->end_charpos
;
6693 if (it
->bidi_it
.scan_dir
< 0)
6695 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6696 IT_BYTEPOS (*it
), stop
, Qnil
);
6700 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6702 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6704 int overlay_strings_follow_p
;
6706 /* End of the game, except when overlay strings follow that
6707 haven't been returned yet. */
6708 if (it
->overlay_strings_at_end_processed_p
)
6709 overlay_strings_follow_p
= 0;
6712 it
->overlay_strings_at_end_processed_p
= 1;
6713 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6716 if (overlay_strings_follow_p
)
6717 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6721 it
->position
= it
->current
.pos
;
6725 else if (!(!it
->bidi_p
6726 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6727 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6729 /* With bidi non-linear iteration, we could find ourselves
6730 far beyond the last computed stop_charpos, with several
6731 other stop positions in between that we missed. Scan
6732 them all now, in buffer's logical order, until we find
6733 and handle the last stop_charpos that precedes our
6734 current position. */
6735 handle_stop_backwards (it
, it
->stop_charpos
);
6736 return GET_NEXT_DISPLAY_ELEMENT (it
);
6742 /* Take note of the stop position we just moved across,
6743 for when we will move back across it. */
6744 it
->prev_stop
= it
->stop_charpos
;
6745 /* If we are at base paragraph embedding level, take
6746 note of the last stop position seen at this
6748 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6749 it
->base_level_stop
= it
->stop_charpos
;
6752 return GET_NEXT_DISPLAY_ELEMENT (it
);
6756 /* We can sometimes back up for reasons that have nothing
6757 to do with bidi reordering. E.g., compositions. The
6758 code below is only needed when we are above the base
6759 embedding level, so test for that explicitly. */
6760 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6761 && IT_CHARPOS (*it
) < it
->prev_stop
)
6763 if (it
->base_level_stop
<= 0)
6764 it
->base_level_stop
= BEGV
;
6765 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6767 handle_stop_backwards (it
, it
->base_level_stop
);
6768 return GET_NEXT_DISPLAY_ELEMENT (it
);
6772 /* No face changes, overlays etc. in sight, so just return a
6773 character from current_buffer. */
6777 /* Maybe run the redisplay end trigger hook. Performance note:
6778 This doesn't seem to cost measurable time. */
6779 if (it
->redisplay_end_trigger_charpos
6781 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6782 run_redisplay_end_trigger_hook (it
);
6784 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6785 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6787 && next_element_from_composition (it
))
6792 /* Get the next character, maybe multibyte. */
6793 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6794 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6795 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6797 it
->c
= *p
, it
->len
= 1;
6799 /* Record what we have and where it came from. */
6800 it
->what
= IT_CHARACTER
;
6801 it
->object
= it
->w
->buffer
;
6802 it
->position
= it
->current
.pos
;
6804 /* Normally we return the character found above, except when we
6805 really want to return an ellipsis for selective display. */
6810 /* A value of selective > 0 means hide lines indented more
6811 than that number of columns. */
6812 if (it
->selective
> 0
6813 && IT_CHARPOS (*it
) + 1 < ZV
6814 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6815 IT_BYTEPOS (*it
) + 1,
6818 success_p
= next_element_from_ellipsis (it
);
6819 it
->dpvec_char_len
= -1;
6822 else if (it
->c
== '\r' && it
->selective
== -1)
6824 /* A value of selective == -1 means that everything from the
6825 CR to the end of the line is invisible, with maybe an
6826 ellipsis displayed for it. */
6827 success_p
= next_element_from_ellipsis (it
);
6828 it
->dpvec_char_len
= -1;
6833 /* Value is zero if end of buffer reached. */
6834 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6839 /* Run the redisplay end trigger hook for IT. */
6842 run_redisplay_end_trigger_hook (struct it
*it
)
6844 Lisp_Object args
[3];
6846 /* IT->glyph_row should be non-null, i.e. we should be actually
6847 displaying something, or otherwise we should not run the hook. */
6848 xassert (it
->glyph_row
);
6850 /* Set up hook arguments. */
6851 args
[0] = Qredisplay_end_trigger_functions
;
6852 args
[1] = it
->window
;
6853 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6854 it
->redisplay_end_trigger_charpos
= 0;
6856 /* Since we are *trying* to run these functions, don't try to run
6857 them again, even if they get an error. */
6858 it
->w
->redisplay_end_trigger
= Qnil
;
6859 Frun_hook_with_args (3, args
);
6861 /* Notice if it changed the face of the character we are on. */
6862 handle_face_prop (it
);
6866 /* Deliver a composition display element. Unlike the other
6867 next_element_from_XXX, this function is not registered in the array
6868 get_next_element[]. It is called from next_element_from_buffer and
6869 next_element_from_string when necessary. */
6872 next_element_from_composition (struct it
*it
)
6874 it
->what
= IT_COMPOSITION
;
6875 it
->len
= it
->cmp_it
.nbytes
;
6876 if (STRINGP (it
->string
))
6880 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6881 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6884 it
->position
= it
->current
.string_pos
;
6885 it
->object
= it
->string
;
6886 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6887 IT_STRING_BYTEPOS (*it
), it
->string
);
6893 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6894 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6897 if (it
->bidi_it
.new_paragraph
)
6898 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6899 /* Resync the bidi iterator with IT's new position.
6900 FIXME: this doesn't support bidirectional text. */
6901 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6902 bidi_move_to_visually_next (&it
->bidi_it
);
6906 it
->position
= it
->current
.pos
;
6907 it
->object
= it
->w
->buffer
;
6908 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6909 IT_BYTEPOS (*it
), Qnil
);
6916 /***********************************************************************
6917 Moving an iterator without producing glyphs
6918 ***********************************************************************/
6920 /* Check if iterator is at a position corresponding to a valid buffer
6921 position after some move_it_ call. */
6923 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6924 ((it)->method == GET_FROM_STRING \
6925 ? IT_STRING_CHARPOS (*it) == 0 \
6929 /* Move iterator IT to a specified buffer or X position within one
6930 line on the display without producing glyphs.
6932 OP should be a bit mask including some or all of these bits:
6933 MOVE_TO_X: Stop upon reaching x-position TO_X.
6934 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6935 Regardless of OP's value, stop upon reaching the end of the display line.
6937 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6938 This means, in particular, that TO_X includes window's horizontal
6941 The return value has several possible values that
6942 say what condition caused the scan to stop:
6944 MOVE_POS_MATCH_OR_ZV
6945 - when TO_POS or ZV was reached.
6948 -when TO_X was reached before TO_POS or ZV were reached.
6951 - when we reached the end of the display area and the line must
6955 - when we reached the end of the display area and the line is
6959 - when we stopped at a line end, i.e. a newline or a CR and selective
6962 static enum move_it_result
6963 move_it_in_display_line_to (struct it
*it
,
6964 EMACS_INT to_charpos
, int to_x
,
6965 enum move_operation_enum op
)
6967 enum move_it_result result
= MOVE_UNDEFINED
;
6968 struct glyph_row
*saved_glyph_row
;
6969 struct it wrap_it
, atpos_it
, atx_it
;
6971 enum it_method prev_method
= it
->method
;
6972 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6974 /* Don't produce glyphs in produce_glyphs. */
6975 saved_glyph_row
= it
->glyph_row
;
6976 it
->glyph_row
= NULL
;
6978 /* Use wrap_it to save a copy of IT wherever a word wrap could
6979 occur. Use atpos_it to save a copy of IT at the desired buffer
6980 position, if found, so that we can scan ahead and check if the
6981 word later overshoots the window edge. Use atx_it similarly, for
6987 #define BUFFER_POS_REACHED_P() \
6988 ((op & MOVE_TO_POS) != 0 \
6989 && BUFFERP (it->object) \
6990 && (IT_CHARPOS (*it) == to_charpos \
6991 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6992 && (it->method == GET_FROM_BUFFER \
6993 || (it->method == GET_FROM_DISPLAY_VECTOR \
6994 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6996 /* If there's a line-/wrap-prefix, handle it. */
6997 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6998 && it
->current_y
< it
->last_visible_y
)
6999 handle_line_prefix (it
);
7001 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7002 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7006 int x
, i
, ascent
= 0, descent
= 0;
7008 /* Utility macro to reset an iterator with x, ascent, and descent. */
7009 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7010 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7011 (IT)->max_descent = descent)
7013 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7015 if ((op
& MOVE_TO_POS
) != 0
7016 && BUFFERP (it
->object
)
7017 && it
->method
== GET_FROM_BUFFER
7018 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7020 && (prev_method
== GET_FROM_IMAGE
7021 || prev_method
== GET_FROM_STRETCH
)
7022 /* Passed TO_CHARPOS from left to right. */
7023 && ((prev_pos
< to_charpos
7024 && IT_CHARPOS (*it
) > to_charpos
)
7025 /* Passed TO_CHARPOS from right to left. */
7026 || (prev_pos
> to_charpos
7027 && IT_CHARPOS (*it
) < to_charpos
)))))
7029 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7031 result
= MOVE_POS_MATCH_OR_ZV
;
7034 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7035 /* If wrap_it is valid, the current position might be in a
7036 word that is wrapped. So, save the iterator in
7037 atpos_it and continue to see if wrapping happens. */
7041 prev_method
= it
->method
;
7042 if (it
->method
== GET_FROM_BUFFER
)
7043 prev_pos
= IT_CHARPOS (*it
);
7044 /* Stop when ZV reached.
7045 We used to stop here when TO_CHARPOS reached as well, but that is
7046 too soon if this glyph does not fit on this line. So we handle it
7047 explicitly below. */
7048 if (!get_next_display_element (it
))
7050 result
= MOVE_POS_MATCH_OR_ZV
;
7054 if (it
->line_wrap
== TRUNCATE
)
7056 if (BUFFER_POS_REACHED_P ())
7058 result
= MOVE_POS_MATCH_OR_ZV
;
7064 if (it
->line_wrap
== WORD_WRAP
)
7066 if (IT_DISPLAYING_WHITESPACE (it
))
7070 /* We have reached a glyph that follows one or more
7071 whitespace characters. If the position is
7072 already found, we are done. */
7073 if (atpos_it
.sp
>= 0)
7076 result
= MOVE_POS_MATCH_OR_ZV
;
7082 result
= MOVE_X_REACHED
;
7085 /* Otherwise, we can wrap here. */
7092 /* Remember the line height for the current line, in case
7093 the next element doesn't fit on the line. */
7094 ascent
= it
->max_ascent
;
7095 descent
= it
->max_descent
;
7097 /* The call to produce_glyphs will get the metrics of the
7098 display element IT is loaded with. Record the x-position
7099 before this display element, in case it doesn't fit on the
7103 PRODUCE_GLYPHS (it
);
7105 if (it
->area
!= TEXT_AREA
)
7107 set_iterator_to_next (it
, 1);
7108 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7109 SET_TEXT_POS (this_line_min_pos
,
7110 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7114 /* The number of glyphs we get back in IT->nglyphs will normally
7115 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7116 character on a terminal frame, or (iii) a line end. For the
7117 second case, IT->nglyphs - 1 padding glyphs will be present.
7118 (On X frames, there is only one glyph produced for a
7119 composite character.)
7121 The behavior implemented below means, for continuation lines,
7122 that as many spaces of a TAB as fit on the current line are
7123 displayed there. For terminal frames, as many glyphs of a
7124 multi-glyph character are displayed in the current line, too.
7125 This is what the old redisplay code did, and we keep it that
7126 way. Under X, the whole shape of a complex character must
7127 fit on the line or it will be completely displayed in the
7130 Note that both for tabs and padding glyphs, all glyphs have
7134 /* More than one glyph or glyph doesn't fit on line. All
7135 glyphs have the same width. */
7136 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7138 int x_before_this_char
= x
;
7139 int hpos_before_this_char
= it
->hpos
;
7141 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7143 new_x
= x
+ single_glyph_width
;
7145 /* We want to leave anything reaching TO_X to the caller. */
7146 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7148 if (BUFFER_POS_REACHED_P ())
7150 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7151 goto buffer_pos_reached
;
7152 if (atpos_it
.sp
< 0)
7155 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7160 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7163 result
= MOVE_X_REACHED
;
7169 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7174 if (/* Lines are continued. */
7175 it
->line_wrap
!= TRUNCATE
7176 && (/* And glyph doesn't fit on the line. */
7177 new_x
> it
->last_visible_x
7178 /* Or it fits exactly and we're on a window
7180 || (new_x
== it
->last_visible_x
7181 && FRAME_WINDOW_P (it
->f
))))
7183 if (/* IT->hpos == 0 means the very first glyph
7184 doesn't fit on the line, e.g. a wide image. */
7186 || (new_x
== it
->last_visible_x
7187 && FRAME_WINDOW_P (it
->f
)))
7190 it
->current_x
= new_x
;
7192 /* The character's last glyph just barely fits
7194 if (i
== it
->nglyphs
- 1)
7196 /* If this is the destination position,
7197 return a position *before* it in this row,
7198 now that we know it fits in this row. */
7199 if (BUFFER_POS_REACHED_P ())
7201 if (it
->line_wrap
!= WORD_WRAP
7204 it
->hpos
= hpos_before_this_char
;
7205 it
->current_x
= x_before_this_char
;
7206 result
= MOVE_POS_MATCH_OR_ZV
;
7209 if (it
->line_wrap
== WORD_WRAP
7213 atpos_it
.current_x
= x_before_this_char
;
7214 atpos_it
.hpos
= hpos_before_this_char
;
7218 set_iterator_to_next (it
, 1);
7219 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7220 SET_TEXT_POS (this_line_min_pos
,
7221 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7222 /* On graphical terminals, newlines may
7223 "overflow" into the fringe if
7224 overflow-newline-into-fringe is non-nil.
7225 On text-only terminals, newlines may
7226 overflow into the last glyph on the
7228 if (!FRAME_WINDOW_P (it
->f
)
7229 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7231 if (!get_next_display_element (it
))
7233 result
= MOVE_POS_MATCH_OR_ZV
;
7236 if (BUFFER_POS_REACHED_P ())
7238 if (ITERATOR_AT_END_OF_LINE_P (it
))
7239 result
= MOVE_POS_MATCH_OR_ZV
;
7241 result
= MOVE_LINE_CONTINUED
;
7244 if (ITERATOR_AT_END_OF_LINE_P (it
))
7246 result
= MOVE_NEWLINE_OR_CR
;
7253 IT_RESET_X_ASCENT_DESCENT (it
);
7255 if (wrap_it
.sp
>= 0)
7262 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7264 result
= MOVE_LINE_CONTINUED
;
7268 if (BUFFER_POS_REACHED_P ())
7270 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7271 goto buffer_pos_reached
;
7272 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7275 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7279 if (new_x
> it
->first_visible_x
)
7281 /* Glyph is visible. Increment number of glyphs that
7282 would be displayed. */
7287 if (result
!= MOVE_UNDEFINED
)
7290 else if (BUFFER_POS_REACHED_P ())
7293 IT_RESET_X_ASCENT_DESCENT (it
);
7294 result
= MOVE_POS_MATCH_OR_ZV
;
7297 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7299 /* Stop when TO_X specified and reached. This check is
7300 necessary here because of lines consisting of a line end,
7301 only. The line end will not produce any glyphs and we
7302 would never get MOVE_X_REACHED. */
7303 xassert (it
->nglyphs
== 0);
7304 result
= MOVE_X_REACHED
;
7308 /* Is this a line end? If yes, we're done. */
7309 if (ITERATOR_AT_END_OF_LINE_P (it
))
7311 result
= MOVE_NEWLINE_OR_CR
;
7315 if (it
->method
== GET_FROM_BUFFER
)
7316 prev_pos
= IT_CHARPOS (*it
);
7317 /* The current display element has been consumed. Advance
7319 set_iterator_to_next (it
, 1);
7320 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7321 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7323 /* Stop if lines are truncated and IT's current x-position is
7324 past the right edge of the window now. */
7325 if (it
->line_wrap
== TRUNCATE
7326 && it
->current_x
>= it
->last_visible_x
)
7328 if (!FRAME_WINDOW_P (it
->f
)
7329 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7331 if (!get_next_display_element (it
)
7332 || BUFFER_POS_REACHED_P ())
7334 result
= MOVE_POS_MATCH_OR_ZV
;
7337 if (ITERATOR_AT_END_OF_LINE_P (it
))
7339 result
= MOVE_NEWLINE_OR_CR
;
7343 result
= MOVE_LINE_TRUNCATED
;
7346 #undef IT_RESET_X_ASCENT_DESCENT
7349 #undef BUFFER_POS_REACHED_P
7351 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7352 restore the saved iterator. */
7353 if (atpos_it
.sp
>= 0)
7355 else if (atx_it
.sp
>= 0)
7360 /* Restore the iterator settings altered at the beginning of this
7362 it
->glyph_row
= saved_glyph_row
;
7366 /* For external use. */
7368 move_it_in_display_line (struct it
*it
,
7369 EMACS_INT to_charpos
, int to_x
,
7370 enum move_operation_enum op
)
7372 if (it
->line_wrap
== WORD_WRAP
7373 && (op
& MOVE_TO_X
))
7375 struct it save_it
= *it
;
7376 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7377 /* When word-wrap is on, TO_X may lie past the end
7378 of a wrapped line. Then it->current is the
7379 character on the next line, so backtrack to the
7380 space before the wrap point. */
7381 if (skip
== MOVE_LINE_CONTINUED
)
7383 int prev_x
= max (it
->current_x
- 1, 0);
7385 move_it_in_display_line_to
7386 (it
, -1, prev_x
, MOVE_TO_X
);
7390 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7394 /* Move IT forward until it satisfies one or more of the criteria in
7395 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7397 OP is a bit-mask that specifies where to stop, and in particular,
7398 which of those four position arguments makes a difference. See the
7399 description of enum move_operation_enum.
7401 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7402 screen line, this function will set IT to the next position >
7406 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7408 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7409 int line_height
, line_start_x
= 0, reached
= 0;
7413 if (op
& MOVE_TO_VPOS
)
7415 /* If no TO_CHARPOS and no TO_X specified, stop at the
7416 start of the line TO_VPOS. */
7417 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7419 if (it
->vpos
== to_vpos
)
7425 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7429 /* TO_VPOS >= 0 means stop at TO_X in the line at
7430 TO_VPOS, or at TO_POS, whichever comes first. */
7431 if (it
->vpos
== to_vpos
)
7437 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7439 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7444 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7446 /* We have reached TO_X but not in the line we want. */
7447 skip
= move_it_in_display_line_to (it
, to_charpos
,
7449 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7457 else if (op
& MOVE_TO_Y
)
7459 struct it it_backup
;
7461 if (it
->line_wrap
== WORD_WRAP
)
7464 /* TO_Y specified means stop at TO_X in the line containing
7465 TO_Y---or at TO_CHARPOS if this is reached first. The
7466 problem is that we can't really tell whether the line
7467 contains TO_Y before we have completely scanned it, and
7468 this may skip past TO_X. What we do is to first scan to
7471 If TO_X is not specified, use a TO_X of zero. The reason
7472 is to make the outcome of this function more predictable.
7473 If we didn't use TO_X == 0, we would stop at the end of
7474 the line which is probably not what a caller would expect
7476 skip
= move_it_in_display_line_to
7477 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7478 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7480 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7481 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7483 else if (skip
== MOVE_X_REACHED
)
7485 /* If TO_X was reached, we want to know whether TO_Y is
7486 in the line. We know this is the case if the already
7487 scanned glyphs make the line tall enough. Otherwise,
7488 we must check by scanning the rest of the line. */
7489 line_height
= it
->max_ascent
+ it
->max_descent
;
7490 if (to_y
>= it
->current_y
7491 && to_y
< it
->current_y
+ line_height
)
7497 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7498 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7500 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7501 line_height
= it
->max_ascent
+ it
->max_descent
;
7502 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7504 if (to_y
>= it
->current_y
7505 && to_y
< it
->current_y
+ line_height
)
7507 /* If TO_Y is in this line and TO_X was reached
7508 above, we scanned too far. We have to restore
7509 IT's settings to the ones before skipping. */
7516 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7522 /* Check whether TO_Y is in this line. */
7523 line_height
= it
->max_ascent
+ it
->max_descent
;
7524 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7526 if (to_y
>= it
->current_y
7527 && to_y
< it
->current_y
+ line_height
)
7529 /* When word-wrap is on, TO_X may lie past the end
7530 of a wrapped line. Then it->current is the
7531 character on the next line, so backtrack to the
7532 space before the wrap point. */
7533 if (skip
== MOVE_LINE_CONTINUED
7534 && it
->line_wrap
== WORD_WRAP
)
7536 int prev_x
= max (it
->current_x
- 1, 0);
7538 skip
= move_it_in_display_line_to
7539 (it
, -1, prev_x
, MOVE_TO_X
);
7548 else if (BUFFERP (it
->object
)
7549 && (it
->method
== GET_FROM_BUFFER
7550 || it
->method
== GET_FROM_STRETCH
)
7551 && IT_CHARPOS (*it
) >= to_charpos
)
7552 skip
= MOVE_POS_MATCH_OR_ZV
;
7554 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7558 case MOVE_POS_MATCH_OR_ZV
:
7562 case MOVE_NEWLINE_OR_CR
:
7563 set_iterator_to_next (it
, 1);
7564 it
->continuation_lines_width
= 0;
7567 case MOVE_LINE_TRUNCATED
:
7568 it
->continuation_lines_width
= 0;
7569 reseat_at_next_visible_line_start (it
, 0);
7570 if ((op
& MOVE_TO_POS
) != 0
7571 && IT_CHARPOS (*it
) > to_charpos
)
7578 case MOVE_LINE_CONTINUED
:
7579 /* For continued lines ending in a tab, some of the glyphs
7580 associated with the tab are displayed on the current
7581 line. Since it->current_x does not include these glyphs,
7582 we use it->last_visible_x instead. */
7585 it
->continuation_lines_width
+= it
->last_visible_x
;
7586 /* When moving by vpos, ensure that the iterator really
7587 advances to the next line (bug#847, bug#969). Fixme:
7588 do we need to do this in other circumstances? */
7589 if (it
->current_x
!= it
->last_visible_x
7590 && (op
& MOVE_TO_VPOS
)
7591 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7593 line_start_x
= it
->current_x
+ it
->pixel_width
7594 - it
->last_visible_x
;
7595 set_iterator_to_next (it
, 0);
7599 it
->continuation_lines_width
+= it
->current_x
;
7606 /* Reset/increment for the next run. */
7607 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7608 it
->current_x
= line_start_x
;
7611 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7613 last_height
= it
->max_ascent
+ it
->max_descent
;
7614 last_max_ascent
= it
->max_ascent
;
7615 it
->max_ascent
= it
->max_descent
= 0;
7620 /* On text terminals, we may stop at the end of a line in the middle
7621 of a multi-character glyph. If the glyph itself is continued,
7622 i.e. it is actually displayed on the next line, don't treat this
7623 stopping point as valid; move to the next line instead (unless
7624 that brings us offscreen). */
7625 if (!FRAME_WINDOW_P (it
->f
)
7627 && IT_CHARPOS (*it
) == to_charpos
7628 && it
->what
== IT_CHARACTER
7630 && it
->line_wrap
== WINDOW_WRAP
7631 && it
->current_x
== it
->last_visible_x
- 1
7634 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7636 it
->continuation_lines_width
+= it
->current_x
;
7637 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7638 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7640 last_height
= it
->max_ascent
+ it
->max_descent
;
7641 last_max_ascent
= it
->max_ascent
;
7644 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7648 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7650 If DY > 0, move IT backward at least that many pixels. DY = 0
7651 means move IT backward to the preceding line start or BEGV. This
7652 function may move over more than DY pixels if IT->current_y - DY
7653 ends up in the middle of a line; in this case IT->current_y will be
7654 set to the top of the line moved to. */
7657 move_it_vertically_backward (struct it
*it
, int dy
)
7661 EMACS_INT start_pos
;
7666 start_pos
= IT_CHARPOS (*it
);
7668 /* Estimate how many newlines we must move back. */
7669 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7671 /* Set the iterator's position that many lines back. */
7672 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7673 back_to_previous_visible_line_start (it
);
7675 /* Reseat the iterator here. When moving backward, we don't want
7676 reseat to skip forward over invisible text, set up the iterator
7677 to deliver from overlay strings at the new position etc. So,
7678 use reseat_1 here. */
7679 reseat_1 (it
, it
->current
.pos
, 1);
7681 /* We are now surely at a line start. */
7682 it
->current_x
= it
->hpos
= 0;
7683 it
->continuation_lines_width
= 0;
7685 /* Move forward and see what y-distance we moved. First move to the
7686 start of the next line so that we get its height. We need this
7687 height to be able to tell whether we reached the specified
7690 it2
.max_ascent
= it2
.max_descent
= 0;
7693 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7694 MOVE_TO_POS
| MOVE_TO_VPOS
);
7696 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7697 xassert (IT_CHARPOS (*it
) >= BEGV
);
7700 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7701 xassert (IT_CHARPOS (*it
) >= BEGV
);
7702 /* H is the actual vertical distance from the position in *IT
7703 and the starting position. */
7704 h
= it2
.current_y
- it
->current_y
;
7705 /* NLINES is the distance in number of lines. */
7706 nlines
= it2
.vpos
- it
->vpos
;
7708 /* Correct IT's y and vpos position
7709 so that they are relative to the starting point. */
7715 /* DY == 0 means move to the start of the screen line. The
7716 value of nlines is > 0 if continuation lines were involved. */
7718 move_it_by_lines (it
, nlines
);
7722 /* The y-position we try to reach, relative to *IT.
7723 Note that H has been subtracted in front of the if-statement. */
7724 int target_y
= it
->current_y
+ h
- dy
;
7725 int y0
= it3
.current_y
;
7726 int y1
= line_bottom_y (&it3
);
7727 int line_height
= y1
- y0
;
7729 /* If we did not reach target_y, try to move further backward if
7730 we can. If we moved too far backward, try to move forward. */
7731 if (target_y
< it
->current_y
7732 /* This is heuristic. In a window that's 3 lines high, with
7733 a line height of 13 pixels each, recentering with point
7734 on the bottom line will try to move -39/2 = 19 pixels
7735 backward. Try to avoid moving into the first line. */
7736 && (it
->current_y
- target_y
7737 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7738 && IT_CHARPOS (*it
) > BEGV
)
7740 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7741 target_y
- it
->current_y
));
7742 dy
= it
->current_y
- target_y
;
7743 goto move_further_back
;
7745 else if (target_y
>= it
->current_y
+ line_height
7746 && IT_CHARPOS (*it
) < ZV
)
7748 /* Should move forward by at least one line, maybe more.
7750 Note: Calling move_it_by_lines can be expensive on
7751 terminal frames, where compute_motion is used (via
7752 vmotion) to do the job, when there are very long lines
7753 and truncate-lines is nil. That's the reason for
7754 treating terminal frames specially here. */
7756 if (!FRAME_WINDOW_P (it
->f
))
7757 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7762 move_it_by_lines (it
, 1);
7764 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7771 /* Move IT by a specified amount of pixel lines DY. DY negative means
7772 move backwards. DY = 0 means move to start of screen line. At the
7773 end, IT will be on the start of a screen line. */
7776 move_it_vertically (struct it
*it
, int dy
)
7779 move_it_vertically_backward (it
, -dy
);
7782 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7783 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7784 MOVE_TO_POS
| MOVE_TO_Y
);
7785 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7787 /* If buffer ends in ZV without a newline, move to the start of
7788 the line to satisfy the post-condition. */
7789 if (IT_CHARPOS (*it
) == ZV
7791 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7792 move_it_by_lines (it
, 0);
7797 /* Move iterator IT past the end of the text line it is in. */
7800 move_it_past_eol (struct it
*it
)
7802 enum move_it_result rc
;
7804 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7805 if (rc
== MOVE_NEWLINE_OR_CR
)
7806 set_iterator_to_next (it
, 0);
7810 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7811 negative means move up. DVPOS == 0 means move to the start of the
7814 Optimization idea: If we would know that IT->f doesn't use
7815 a face with proportional font, we could be faster for
7816 truncate-lines nil. */
7819 move_it_by_lines (struct it
*it
, int dvpos
)
7822 /* The commented-out optimization uses vmotion on terminals. This
7823 gives bad results, because elements like it->what, on which
7824 callers such as pos_visible_p rely, aren't updated. */
7825 /* struct position pos;
7826 if (!FRAME_WINDOW_P (it->f))
7828 struct text_pos textpos;
7830 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7831 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7832 reseat (it, textpos, 1);
7833 it->vpos += pos.vpos;
7834 it->current_y += pos.vpos;
7840 /* DVPOS == 0 means move to the start of the screen line. */
7841 move_it_vertically_backward (it
, 0);
7842 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7843 /* Let next call to line_bottom_y calculate real line height */
7848 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7849 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7850 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7855 EMACS_INT start_charpos
, i
;
7857 /* Start at the beginning of the screen line containing IT's
7858 position. This may actually move vertically backwards,
7859 in case of overlays, so adjust dvpos accordingly. */
7861 move_it_vertically_backward (it
, 0);
7864 /* Go back -DVPOS visible lines and reseat the iterator there. */
7865 start_charpos
= IT_CHARPOS (*it
);
7866 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7867 back_to_previous_visible_line_start (it
);
7868 reseat (it
, it
->current
.pos
, 1);
7870 /* Move further back if we end up in a string or an image. */
7871 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7873 /* First try to move to start of display line. */
7875 move_it_vertically_backward (it
, 0);
7877 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7879 /* If start of line is still in string or image,
7880 move further back. */
7881 back_to_previous_visible_line_start (it
);
7882 reseat (it
, it
->current
.pos
, 1);
7886 it
->current_x
= it
->hpos
= 0;
7888 /* Above call may have moved too far if continuation lines
7889 are involved. Scan forward and see if it did. */
7891 it2
.vpos
= it2
.current_y
= 0;
7892 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7893 it
->vpos
-= it2
.vpos
;
7894 it
->current_y
-= it2
.current_y
;
7895 it
->current_x
= it
->hpos
= 0;
7897 /* If we moved too far back, move IT some lines forward. */
7898 if (it2
.vpos
> -dvpos
)
7900 int delta
= it2
.vpos
+ dvpos
;
7902 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7903 /* Move back again if we got too far ahead. */
7904 if (IT_CHARPOS (*it
) >= start_charpos
)
7910 /* Return 1 if IT points into the middle of a display vector. */
7913 in_display_vector_p (struct it
*it
)
7915 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7916 && it
->current
.dpvec_index
> 0
7917 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7921 /***********************************************************************
7923 ***********************************************************************/
7926 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7930 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7932 Lisp_Object args
[3];
7933 Lisp_Object msg
, fmt
;
7936 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7939 /* Do nothing if called asynchronously. Inserting text into
7940 a buffer may call after-change-functions and alike and
7941 that would means running Lisp asynchronously. */
7942 if (handling_signal
)
7946 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7948 args
[0] = fmt
= build_string (format
);
7951 msg
= Fformat (3, args
);
7953 len
= SBYTES (msg
) + 1;
7954 SAFE_ALLOCA (buffer
, char *, len
);
7955 memcpy (buffer
, SDATA (msg
), len
);
7957 message_dolog (buffer
, len
- 1, 1, 0);
7964 /* Output a newline in the *Messages* buffer if "needs" one. */
7967 message_log_maybe_newline (void)
7969 if (message_log_need_newline
)
7970 message_dolog ("", 0, 1, 0);
7974 /* Add a string M of length NBYTES to the message log, optionally
7975 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7976 nonzero, means interpret the contents of M as multibyte. This
7977 function calls low-level routines in order to bypass text property
7978 hooks, etc. which might not be safe to run.
7980 This may GC (insert may run before/after change hooks),
7981 so the buffer M must NOT point to a Lisp string. */
7984 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7986 const unsigned char *msg
= (const unsigned char *) m
;
7988 if (!NILP (Vmemory_full
))
7991 if (!NILP (Vmessage_log_max
))
7993 struct buffer
*oldbuf
;
7994 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7995 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7996 EMACS_INT point_at_end
= 0;
7997 EMACS_INT zv_at_end
= 0;
7998 Lisp_Object old_deactivate_mark
, tem
;
7999 struct gcpro gcpro1
;
8001 old_deactivate_mark
= Vdeactivate_mark
;
8002 oldbuf
= current_buffer
;
8003 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8004 BVAR (current_buffer
, undo_list
) = Qt
;
8006 oldpoint
= message_dolog_marker1
;
8007 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8008 oldbegv
= message_dolog_marker2
;
8009 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8010 oldzv
= message_dolog_marker3
;
8011 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8012 GCPRO1 (old_deactivate_mark
);
8020 BEGV_BYTE
= BEG_BYTE
;
8023 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8025 /* Insert the string--maybe converting multibyte to single byte
8026 or vice versa, so that all the text fits the buffer. */
8028 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8034 /* Convert a multibyte string to single-byte
8035 for the *Message* buffer. */
8036 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8038 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8039 work
[0] = (ASCII_CHAR_P (c
)
8041 : multibyte_char_to_unibyte (c
));
8042 insert_1_both (work
, 1, 1, 1, 0, 0);
8045 else if (! multibyte
8046 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8050 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8051 /* Convert a single-byte string to multibyte
8052 for the *Message* buffer. */
8053 for (i
= 0; i
< nbytes
; i
++)
8056 MAKE_CHAR_MULTIBYTE (c
);
8057 char_bytes
= CHAR_STRING (c
, str
);
8058 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8062 insert_1 (m
, nbytes
, 1, 0, 0);
8066 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8068 insert_1 ("\n", 1, 1, 0, 0);
8070 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8072 this_bol_byte
= PT_BYTE
;
8074 /* See if this line duplicates the previous one.
8075 If so, combine duplicates. */
8078 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8080 prev_bol_byte
= PT_BYTE
;
8082 dups
= message_log_check_duplicate (prev_bol_byte
,
8086 del_range_both (prev_bol
, prev_bol_byte
,
8087 this_bol
, this_bol_byte
, 0);
8090 char dupstr
[sizeof " [ times]"
8091 + INT_STRLEN_BOUND (intmax_t)];
8094 /* If you change this format, don't forget to also
8095 change message_log_check_duplicate. */
8096 sprintf (dupstr
, " [%"PRIdMAX
" times]", dups
);
8097 duplen
= strlen (dupstr
);
8098 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8099 insert_1 (dupstr
, duplen
, 1, 0, 1);
8104 /* If we have more than the desired maximum number of lines
8105 in the *Messages* buffer now, delete the oldest ones.
8106 This is safe because we don't have undo in this buffer. */
8108 if (NATNUMP (Vmessage_log_max
))
8110 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8111 -XFASTINT (Vmessage_log_max
) - 1, 0);
8112 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8115 BEGV
= XMARKER (oldbegv
)->charpos
;
8116 BEGV_BYTE
= marker_byte_position (oldbegv
);
8125 ZV
= XMARKER (oldzv
)->charpos
;
8126 ZV_BYTE
= marker_byte_position (oldzv
);
8130 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8132 /* We can't do Fgoto_char (oldpoint) because it will run some
8134 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8135 XMARKER (oldpoint
)->bytepos
);
8138 unchain_marker (XMARKER (oldpoint
));
8139 unchain_marker (XMARKER (oldbegv
));
8140 unchain_marker (XMARKER (oldzv
));
8142 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8143 set_buffer_internal (oldbuf
);
8145 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8146 message_log_need_newline
= !nlflag
;
8147 Vdeactivate_mark
= old_deactivate_mark
;
8152 /* We are at the end of the buffer after just having inserted a newline.
8153 (Note: We depend on the fact we won't be crossing the gap.)
8154 Check to see if the most recent message looks a lot like the previous one.
8155 Return 0 if different, 1 if the new one should just replace it, or a
8156 value N > 1 if we should also append " [N times]". */
8159 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8162 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8164 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8165 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8167 for (i
= 0; i
< len
; i
++)
8169 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8177 if (*p1
++ == ' ' && *p1
++ == '[')
8180 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8181 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8188 /* Display an echo area message M with a specified length of NBYTES
8189 bytes. The string may include null characters. If M is 0, clear
8190 out any existing message, and let the mini-buffer text show
8193 This may GC, so the buffer M must NOT point to a Lisp string. */
8196 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8198 /* First flush out any partial line written with print. */
8199 message_log_maybe_newline ();
8201 message_dolog (m
, nbytes
, 1, multibyte
);
8202 message2_nolog (m
, nbytes
, multibyte
);
8206 /* The non-logging counterpart of message2. */
8209 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8211 struct frame
*sf
= SELECTED_FRAME ();
8212 message_enable_multibyte
= multibyte
;
8214 if (FRAME_INITIAL_P (sf
))
8216 if (noninteractive_need_newline
)
8217 putc ('\n', stderr
);
8218 noninteractive_need_newline
= 0;
8220 fwrite (m
, nbytes
, 1, stderr
);
8221 if (cursor_in_echo_area
== 0)
8222 fprintf (stderr
, "\n");
8225 /* A null message buffer means that the frame hasn't really been
8226 initialized yet. Error messages get reported properly by
8227 cmd_error, so this must be just an informative message; toss it. */
8228 else if (INTERACTIVE
8229 && sf
->glyphs_initialized_p
8230 && FRAME_MESSAGE_BUF (sf
))
8232 Lisp_Object mini_window
;
8235 /* Get the frame containing the mini-buffer
8236 that the selected frame is using. */
8237 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8238 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8240 FRAME_SAMPLE_VISIBILITY (f
);
8241 if (FRAME_VISIBLE_P (sf
)
8242 && ! FRAME_VISIBLE_P (f
))
8243 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8247 set_message (m
, Qnil
, nbytes
, multibyte
);
8248 if (minibuffer_auto_raise
)
8249 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8252 clear_message (1, 1);
8254 do_pending_window_change (0);
8255 echo_area_display (1);
8256 do_pending_window_change (0);
8257 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8258 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8263 /* Display an echo area message M with a specified length of NBYTES
8264 bytes. The string may include null characters. If M is not a
8265 string, clear out any existing message, and let the mini-buffer
8268 This function cancels echoing. */
8271 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8273 struct gcpro gcpro1
;
8276 clear_message (1,1);
8279 /* First flush out any partial line written with print. */
8280 message_log_maybe_newline ();
8286 SAFE_ALLOCA (buffer
, char *, nbytes
);
8287 memcpy (buffer
, SDATA (m
), nbytes
);
8288 message_dolog (buffer
, nbytes
, 1, multibyte
);
8291 message3_nolog (m
, nbytes
, multibyte
);
8297 /* The non-logging version of message3.
8298 This does not cancel echoing, because it is used for echoing.
8299 Perhaps we need to make a separate function for echoing
8300 and make this cancel echoing. */
8303 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8305 struct frame
*sf
= SELECTED_FRAME ();
8306 message_enable_multibyte
= multibyte
;
8308 if (FRAME_INITIAL_P (sf
))
8310 if (noninteractive_need_newline
)
8311 putc ('\n', stderr
);
8312 noninteractive_need_newline
= 0;
8314 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8315 if (cursor_in_echo_area
== 0)
8316 fprintf (stderr
, "\n");
8319 /* A null message buffer means that the frame hasn't really been
8320 initialized yet. Error messages get reported properly by
8321 cmd_error, so this must be just an informative message; toss it. */
8322 else if (INTERACTIVE
8323 && sf
->glyphs_initialized_p
8324 && FRAME_MESSAGE_BUF (sf
))
8326 Lisp_Object mini_window
;
8330 /* Get the frame containing the mini-buffer
8331 that the selected frame is using. */
8332 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8333 frame
= XWINDOW (mini_window
)->frame
;
8336 FRAME_SAMPLE_VISIBILITY (f
);
8337 if (FRAME_VISIBLE_P (sf
)
8338 && !FRAME_VISIBLE_P (f
))
8339 Fmake_frame_visible (frame
);
8341 if (STRINGP (m
) && SCHARS (m
) > 0)
8343 set_message (NULL
, m
, nbytes
, multibyte
);
8344 if (minibuffer_auto_raise
)
8345 Fraise_frame (frame
);
8346 /* Assume we are not echoing.
8347 (If we are, echo_now will override this.) */
8348 echo_message_buffer
= Qnil
;
8351 clear_message (1, 1);
8353 do_pending_window_change (0);
8354 echo_area_display (1);
8355 do_pending_window_change (0);
8356 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8357 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8362 /* Display a null-terminated echo area message M. If M is 0, clear
8363 out any existing message, and let the mini-buffer text show through.
8365 The buffer M must continue to exist until after the echo area gets
8366 cleared or some other message gets displayed there. Do not pass
8367 text that is stored in a Lisp string. Do not pass text in a buffer
8368 that was alloca'd. */
8371 message1 (const char *m
)
8373 message2 (m
, (m
? strlen (m
) : 0), 0);
8377 /* The non-logging counterpart of message1. */
8380 message1_nolog (const char *m
)
8382 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8385 /* Display a message M which contains a single %s
8386 which gets replaced with STRING. */
8389 message_with_string (const char *m
, Lisp_Object string
, int log
)
8391 CHECK_STRING (string
);
8397 if (noninteractive_need_newline
)
8398 putc ('\n', stderr
);
8399 noninteractive_need_newline
= 0;
8400 fprintf (stderr
, m
, SDATA (string
));
8401 if (!cursor_in_echo_area
)
8402 fprintf (stderr
, "\n");
8406 else if (INTERACTIVE
)
8408 /* The frame whose minibuffer we're going to display the message on.
8409 It may be larger than the selected frame, so we need
8410 to use its buffer, not the selected frame's buffer. */
8411 Lisp_Object mini_window
;
8412 struct frame
*f
, *sf
= SELECTED_FRAME ();
8414 /* Get the frame containing the minibuffer
8415 that the selected frame is using. */
8416 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8417 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8419 /* A null message buffer means that the frame hasn't really been
8420 initialized yet. Error messages get reported properly by
8421 cmd_error, so this must be just an informative message; toss it. */
8422 if (FRAME_MESSAGE_BUF (f
))
8424 Lisp_Object args
[2], msg
;
8425 struct gcpro gcpro1
, gcpro2
;
8427 args
[0] = build_string (m
);
8428 args
[1] = msg
= string
;
8429 GCPRO2 (args
[0], msg
);
8432 msg
= Fformat (2, args
);
8435 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8437 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8441 /* Print should start at the beginning of the message
8442 buffer next time. */
8443 message_buf_print
= 0;
8449 /* Dump an informative message to the minibuf. If M is 0, clear out
8450 any existing message, and let the mini-buffer text show through. */
8453 vmessage (const char *m
, va_list ap
)
8459 if (noninteractive_need_newline
)
8460 putc ('\n', stderr
);
8461 noninteractive_need_newline
= 0;
8462 vfprintf (stderr
, m
, ap
);
8463 if (cursor_in_echo_area
== 0)
8464 fprintf (stderr
, "\n");
8468 else if (INTERACTIVE
)
8470 /* The frame whose mini-buffer we're going to display the message
8471 on. It may be larger than the selected frame, so we need to
8472 use its buffer, not the selected frame's buffer. */
8473 Lisp_Object mini_window
;
8474 struct frame
*f
, *sf
= SELECTED_FRAME ();
8476 /* Get the frame containing the mini-buffer
8477 that the selected frame is using. */
8478 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8479 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8481 /* A null message buffer means that the frame hasn't really been
8482 initialized yet. Error messages get reported properly by
8483 cmd_error, so this must be just an informative message; toss
8485 if (FRAME_MESSAGE_BUF (f
))
8491 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8492 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8494 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8499 /* Print should start at the beginning of the message
8500 buffer next time. */
8501 message_buf_print
= 0;
8507 message (const char *m
, ...)
8517 /* The non-logging version of message. */
8520 message_nolog (const char *m
, ...)
8522 Lisp_Object old_log_max
;
8525 old_log_max
= Vmessage_log_max
;
8526 Vmessage_log_max
= Qnil
;
8528 Vmessage_log_max
= old_log_max
;
8534 /* Display the current message in the current mini-buffer. This is
8535 only called from error handlers in process.c, and is not time
8539 update_echo_area (void)
8541 if (!NILP (echo_area_buffer
[0]))
8544 string
= Fcurrent_message ();
8545 message3 (string
, SBYTES (string
),
8546 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8551 /* Make sure echo area buffers in `echo_buffers' are live.
8552 If they aren't, make new ones. */
8555 ensure_echo_area_buffers (void)
8559 for (i
= 0; i
< 2; ++i
)
8560 if (!BUFFERP (echo_buffer
[i
])
8561 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8564 Lisp_Object old_buffer
;
8567 old_buffer
= echo_buffer
[i
];
8568 sprintf (name
, " *Echo Area %d*", i
);
8569 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8570 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8571 /* to force word wrap in echo area -
8572 it was decided to postpone this*/
8573 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8575 for (j
= 0; j
< 2; ++j
)
8576 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8577 echo_area_buffer
[j
] = echo_buffer
[i
];
8582 /* Call FN with args A1..A4 with either the current or last displayed
8583 echo_area_buffer as current buffer.
8585 WHICH zero means use the current message buffer
8586 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8587 from echo_buffer[] and clear it.
8589 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8590 suitable buffer from echo_buffer[] and clear it.
8592 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8593 that the current message becomes the last displayed one, make
8594 choose a suitable buffer for echo_area_buffer[0], and clear it.
8596 Value is what FN returns. */
8599 with_echo_area_buffer (struct window
*w
, int which
,
8600 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8601 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8604 int this_one
, the_other
, clear_buffer_p
, rc
;
8605 int count
= SPECPDL_INDEX ();
8607 /* If buffers aren't live, make new ones. */
8608 ensure_echo_area_buffers ();
8613 this_one
= 0, the_other
= 1;
8615 this_one
= 1, the_other
= 0;
8618 this_one
= 0, the_other
= 1;
8621 /* We need a fresh one in case the current echo buffer equals
8622 the one containing the last displayed echo area message. */
8623 if (!NILP (echo_area_buffer
[this_one
])
8624 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8625 echo_area_buffer
[this_one
] = Qnil
;
8628 /* Choose a suitable buffer from echo_buffer[] is we don't
8630 if (NILP (echo_area_buffer
[this_one
]))
8632 echo_area_buffer
[this_one
]
8633 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8634 ? echo_buffer
[the_other
]
8635 : echo_buffer
[this_one
]);
8639 buffer
= echo_area_buffer
[this_one
];
8641 /* Don't get confused by reusing the buffer used for echoing
8642 for a different purpose. */
8643 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8646 record_unwind_protect (unwind_with_echo_area_buffer
,
8647 with_echo_area_buffer_unwind_data (w
));
8649 /* Make the echo area buffer current. Note that for display
8650 purposes, it is not necessary that the displayed window's buffer
8651 == current_buffer, except for text property lookup. So, let's
8652 only set that buffer temporarily here without doing a full
8653 Fset_window_buffer. We must also change w->pointm, though,
8654 because otherwise an assertions in unshow_buffer fails, and Emacs
8656 set_buffer_internal_1 (XBUFFER (buffer
));
8660 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8663 BVAR (current_buffer
, undo_list
) = Qt
;
8664 BVAR (current_buffer
, read_only
) = Qnil
;
8665 specbind (Qinhibit_read_only
, Qt
);
8666 specbind (Qinhibit_modification_hooks
, Qt
);
8668 if (clear_buffer_p
&& Z
> BEG
)
8671 xassert (BEGV
>= BEG
);
8672 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8674 rc
= fn (a1
, a2
, a3
, a4
);
8676 xassert (BEGV
>= BEG
);
8677 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8679 unbind_to (count
, Qnil
);
8684 /* Save state that should be preserved around the call to the function
8685 FN called in with_echo_area_buffer. */
8688 with_echo_area_buffer_unwind_data (struct window
*w
)
8691 Lisp_Object vector
, tmp
;
8693 /* Reduce consing by keeping one vector in
8694 Vwith_echo_area_save_vector. */
8695 vector
= Vwith_echo_area_save_vector
;
8696 Vwith_echo_area_save_vector
= Qnil
;
8699 vector
= Fmake_vector (make_number (7), Qnil
);
8701 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8702 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8703 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8707 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8708 ASET (vector
, i
, w
->buffer
); ++i
;
8709 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8710 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8715 for (; i
< end
; ++i
)
8716 ASET (vector
, i
, Qnil
);
8719 xassert (i
== ASIZE (vector
));
8724 /* Restore global state from VECTOR which was created by
8725 with_echo_area_buffer_unwind_data. */
8728 unwind_with_echo_area_buffer (Lisp_Object vector
)
8730 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8731 Vdeactivate_mark
= AREF (vector
, 1);
8732 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8734 if (WINDOWP (AREF (vector
, 3)))
8737 Lisp_Object buffer
, charpos
, bytepos
;
8739 w
= XWINDOW (AREF (vector
, 3));
8740 buffer
= AREF (vector
, 4);
8741 charpos
= AREF (vector
, 5);
8742 bytepos
= AREF (vector
, 6);
8745 set_marker_both (w
->pointm
, buffer
,
8746 XFASTINT (charpos
), XFASTINT (bytepos
));
8749 Vwith_echo_area_save_vector
= vector
;
8754 /* Set up the echo area for use by print functions. MULTIBYTE_P
8755 non-zero means we will print multibyte. */
8758 setup_echo_area_for_printing (int multibyte_p
)
8760 /* If we can't find an echo area any more, exit. */
8761 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8764 ensure_echo_area_buffers ();
8766 if (!message_buf_print
)
8768 /* A message has been output since the last time we printed.
8769 Choose a fresh echo area buffer. */
8770 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8771 echo_area_buffer
[0] = echo_buffer
[1];
8773 echo_area_buffer
[0] = echo_buffer
[0];
8775 /* Switch to that buffer and clear it. */
8776 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8777 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8781 int count
= SPECPDL_INDEX ();
8782 specbind (Qinhibit_read_only
, Qt
);
8783 /* Note that undo recording is always disabled. */
8785 unbind_to (count
, Qnil
);
8787 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8789 /* Set up the buffer for the multibyteness we need. */
8791 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8792 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8794 /* Raise the frame containing the echo area. */
8795 if (minibuffer_auto_raise
)
8797 struct frame
*sf
= SELECTED_FRAME ();
8798 Lisp_Object mini_window
;
8799 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8800 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8803 message_log_maybe_newline ();
8804 message_buf_print
= 1;
8808 if (NILP (echo_area_buffer
[0]))
8810 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8811 echo_area_buffer
[0] = echo_buffer
[1];
8813 echo_area_buffer
[0] = echo_buffer
[0];
8816 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8818 /* Someone switched buffers between print requests. */
8819 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8820 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8826 /* Display an echo area message in window W. Value is non-zero if W's
8827 height is changed. If display_last_displayed_message_p is
8828 non-zero, display the message that was last displayed, otherwise
8829 display the current message. */
8832 display_echo_area (struct window
*w
)
8834 int i
, no_message_p
, window_height_changed_p
, count
;
8836 /* Temporarily disable garbage collections while displaying the echo
8837 area. This is done because a GC can print a message itself.
8838 That message would modify the echo area buffer's contents while a
8839 redisplay of the buffer is going on, and seriously confuse
8841 count
= inhibit_garbage_collection ();
8843 /* If there is no message, we must call display_echo_area_1
8844 nevertheless because it resizes the window. But we will have to
8845 reset the echo_area_buffer in question to nil at the end because
8846 with_echo_area_buffer will sets it to an empty buffer. */
8847 i
= display_last_displayed_message_p
? 1 : 0;
8848 no_message_p
= NILP (echo_area_buffer
[i
]);
8850 window_height_changed_p
8851 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8852 display_echo_area_1
,
8853 (intptr_t) w
, Qnil
, 0, 0);
8856 echo_area_buffer
[i
] = Qnil
;
8858 unbind_to (count
, Qnil
);
8859 return window_height_changed_p
;
8863 /* Helper for display_echo_area. Display the current buffer which
8864 contains the current echo area message in window W, a mini-window,
8865 a pointer to which is passed in A1. A2..A4 are currently not used.
8866 Change the height of W so that all of the message is displayed.
8867 Value is non-zero if height of W was changed. */
8870 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8873 struct window
*w
= (struct window
*) i1
;
8875 struct text_pos start
;
8876 int window_height_changed_p
= 0;
8878 /* Do this before displaying, so that we have a large enough glyph
8879 matrix for the display. If we can't get enough space for the
8880 whole text, display the last N lines. That works by setting w->start. */
8881 window_height_changed_p
= resize_mini_window (w
, 0);
8883 /* Use the starting position chosen by resize_mini_window. */
8884 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8887 clear_glyph_matrix (w
->desired_matrix
);
8888 XSETWINDOW (window
, w
);
8889 try_window (window
, start
, 0);
8891 return window_height_changed_p
;
8895 /* Resize the echo area window to exactly the size needed for the
8896 currently displayed message, if there is one. If a mini-buffer
8897 is active, don't shrink it. */
8900 resize_echo_area_exactly (void)
8902 if (BUFFERP (echo_area_buffer
[0])
8903 && WINDOWP (echo_area_window
))
8905 struct window
*w
= XWINDOW (echo_area_window
);
8907 Lisp_Object resize_exactly
;
8909 if (minibuf_level
== 0)
8910 resize_exactly
= Qt
;
8912 resize_exactly
= Qnil
;
8914 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8915 (intptr_t) w
, resize_exactly
,
8919 ++windows_or_buffers_changed
;
8920 ++update_mode_lines
;
8921 redisplay_internal ();
8927 /* Callback function for with_echo_area_buffer, when used from
8928 resize_echo_area_exactly. A1 contains a pointer to the window to
8929 resize, EXACTLY non-nil means resize the mini-window exactly to the
8930 size of the text displayed. A3 and A4 are not used. Value is what
8931 resize_mini_window returns. */
8934 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8937 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
8941 /* Resize mini-window W to fit the size of its contents. EXACT_P
8942 means size the window exactly to the size needed. Otherwise, it's
8943 only enlarged until W's buffer is empty.
8945 Set W->start to the right place to begin display. If the whole
8946 contents fit, start at the beginning. Otherwise, start so as
8947 to make the end of the contents appear. This is particularly
8948 important for y-or-n-p, but seems desirable generally.
8950 Value is non-zero if the window height has been changed. */
8953 resize_mini_window (struct window
*w
, int exact_p
)
8955 struct frame
*f
= XFRAME (w
->frame
);
8956 int window_height_changed_p
= 0;
8958 xassert (MINI_WINDOW_P (w
));
8960 /* By default, start display at the beginning. */
8961 set_marker_both (w
->start
, w
->buffer
,
8962 BUF_BEGV (XBUFFER (w
->buffer
)),
8963 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8965 /* Don't resize windows while redisplaying a window; it would
8966 confuse redisplay functions when the size of the window they are
8967 displaying changes from under them. Such a resizing can happen,
8968 for instance, when which-func prints a long message while
8969 we are running fontification-functions. We're running these
8970 functions with safe_call which binds inhibit-redisplay to t. */
8971 if (!NILP (Vinhibit_redisplay
))
8974 /* Nil means don't try to resize. */
8975 if (NILP (Vresize_mini_windows
)
8976 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8979 if (!FRAME_MINIBUF_ONLY_P (f
))
8982 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8983 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8984 int height
, max_height
;
8985 int unit
= FRAME_LINE_HEIGHT (f
);
8986 struct text_pos start
;
8987 struct buffer
*old_current_buffer
= NULL
;
8989 if (current_buffer
!= XBUFFER (w
->buffer
))
8991 old_current_buffer
= current_buffer
;
8992 set_buffer_internal (XBUFFER (w
->buffer
));
8995 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8997 /* Compute the max. number of lines specified by the user. */
8998 if (FLOATP (Vmax_mini_window_height
))
8999 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9000 else if (INTEGERP (Vmax_mini_window_height
))
9001 max_height
= XINT (Vmax_mini_window_height
);
9003 max_height
= total_height
/ 4;
9005 /* Correct that max. height if it's bogus. */
9006 max_height
= max (1, max_height
);
9007 max_height
= min (total_height
, max_height
);
9009 /* Find out the height of the text in the window. */
9010 if (it
.line_wrap
== TRUNCATE
)
9015 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9016 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9017 height
= it
.current_y
+ last_height
;
9019 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9020 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9021 height
= (height
+ unit
- 1) / unit
;
9024 /* Compute a suitable window start. */
9025 if (height
> max_height
)
9027 height
= max_height
;
9028 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9029 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9030 start
= it
.current
.pos
;
9033 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9034 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9036 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9038 /* Let it grow only, until we display an empty message, in which
9039 case the window shrinks again. */
9040 if (height
> WINDOW_TOTAL_LINES (w
))
9042 int old_height
= WINDOW_TOTAL_LINES (w
);
9043 freeze_window_starts (f
, 1);
9044 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9045 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9047 else if (height
< WINDOW_TOTAL_LINES (w
)
9048 && (exact_p
|| BEGV
== ZV
))
9050 int old_height
= WINDOW_TOTAL_LINES (w
);
9051 freeze_window_starts (f
, 0);
9052 shrink_mini_window (w
);
9053 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9058 /* Always resize to exact size needed. */
9059 if (height
> WINDOW_TOTAL_LINES (w
))
9061 int old_height
= WINDOW_TOTAL_LINES (w
);
9062 freeze_window_starts (f
, 1);
9063 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9064 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9066 else if (height
< WINDOW_TOTAL_LINES (w
))
9068 int old_height
= WINDOW_TOTAL_LINES (w
);
9069 freeze_window_starts (f
, 0);
9070 shrink_mini_window (w
);
9074 freeze_window_starts (f
, 1);
9075 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9078 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9082 if (old_current_buffer
)
9083 set_buffer_internal (old_current_buffer
);
9086 return window_height_changed_p
;
9090 /* Value is the current message, a string, or nil if there is no
9094 current_message (void)
9098 if (!BUFFERP (echo_area_buffer
[0]))
9102 with_echo_area_buffer (0, 0, current_message_1
,
9103 (intptr_t) &msg
, Qnil
, 0, 0);
9105 echo_area_buffer
[0] = Qnil
;
9113 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9116 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9119 *msg
= make_buffer_string (BEG
, Z
, 1);
9126 /* Push the current message on Vmessage_stack for later restauration
9127 by restore_message. Value is non-zero if the current message isn't
9128 empty. This is a relatively infrequent operation, so it's not
9129 worth optimizing. */
9135 msg
= current_message ();
9136 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9137 return STRINGP (msg
);
9141 /* Restore message display from the top of Vmessage_stack. */
9144 restore_message (void)
9148 xassert (CONSP (Vmessage_stack
));
9149 msg
= XCAR (Vmessage_stack
);
9151 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9153 message3_nolog (msg
, 0, 0);
9157 /* Handler for record_unwind_protect calling pop_message. */
9160 pop_message_unwind (Lisp_Object dummy
)
9166 /* Pop the top-most entry off Vmessage_stack. */
9171 xassert (CONSP (Vmessage_stack
));
9172 Vmessage_stack
= XCDR (Vmessage_stack
);
9176 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9177 exits. If the stack is not empty, we have a missing pop_message
9181 check_message_stack (void)
9183 if (!NILP (Vmessage_stack
))
9188 /* Truncate to NCHARS what will be displayed in the echo area the next
9189 time we display it---but don't redisplay it now. */
9192 truncate_echo_area (EMACS_INT nchars
)
9195 echo_area_buffer
[0] = Qnil
;
9196 /* A null message buffer means that the frame hasn't really been
9197 initialized yet. Error messages get reported properly by
9198 cmd_error, so this must be just an informative message; toss it. */
9199 else if (!noninteractive
9201 && !NILP (echo_area_buffer
[0]))
9203 struct frame
*sf
= SELECTED_FRAME ();
9204 if (FRAME_MESSAGE_BUF (sf
))
9205 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9210 /* Helper function for truncate_echo_area. Truncate the current
9211 message to at most NCHARS characters. */
9214 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9216 if (BEG
+ nchars
< Z
)
9217 del_range (BEG
+ nchars
, Z
);
9219 echo_area_buffer
[0] = Qnil
;
9224 /* Set the current message to a substring of S or STRING.
9226 If STRING is a Lisp string, set the message to the first NBYTES
9227 bytes from STRING. NBYTES zero means use the whole string. If
9228 STRING is multibyte, the message will be displayed multibyte.
9230 If S is not null, set the message to the first LEN bytes of S. LEN
9231 zero means use the whole string. MULTIBYTE_P non-zero means S is
9232 multibyte. Display the message multibyte in that case.
9234 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9235 to t before calling set_message_1 (which calls insert).
9239 set_message (const char *s
, Lisp_Object string
,
9240 EMACS_INT nbytes
, int multibyte_p
)
9242 message_enable_multibyte
9243 = ((s
&& multibyte_p
)
9244 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9246 with_echo_area_buffer (0, -1, set_message_1
,
9247 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9248 message_buf_print
= 0;
9249 help_echo_showing_p
= 0;
9253 /* Helper function for set_message. Arguments have the same meaning
9254 as there, with A1 corresponding to S and A2 corresponding to STRING
9255 This function is called with the echo area buffer being
9259 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9262 const char *s
= (const char *) i1
;
9263 const unsigned char *msg
= (const unsigned char *) s
;
9264 Lisp_Object string
= a2
;
9266 /* Change multibyteness of the echo buffer appropriately. */
9267 if (message_enable_multibyte
9268 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9269 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9271 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9272 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9273 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9275 /* Insert new message at BEG. */
9276 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9278 if (STRINGP (string
))
9283 nbytes
= SBYTES (string
);
9284 nchars
= string_byte_to_char (string
, nbytes
);
9286 /* This function takes care of single/multibyte conversion. We
9287 just have to ensure that the echo area buffer has the right
9288 setting of enable_multibyte_characters. */
9289 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9294 nbytes
= strlen (s
);
9296 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9298 /* Convert from multi-byte to single-byte. */
9303 /* Convert a multibyte string to single-byte. */
9304 for (i
= 0; i
< nbytes
; i
+= n
)
9306 c
= string_char_and_length (msg
+ i
, &n
);
9307 work
[0] = (ASCII_CHAR_P (c
)
9309 : multibyte_char_to_unibyte (c
));
9310 insert_1_both (work
, 1, 1, 1, 0, 0);
9313 else if (!multibyte_p
9314 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9316 /* Convert from single-byte to multi-byte. */
9319 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9321 /* Convert a single-byte string to multibyte. */
9322 for (i
= 0; i
< nbytes
; i
++)
9325 MAKE_CHAR_MULTIBYTE (c
);
9326 n
= CHAR_STRING (c
, str
);
9327 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9331 insert_1 (s
, nbytes
, 1, 0, 0);
9338 /* Clear messages. CURRENT_P non-zero means clear the current
9339 message. LAST_DISPLAYED_P non-zero means clear the message
9343 clear_message (int current_p
, int last_displayed_p
)
9347 echo_area_buffer
[0] = Qnil
;
9348 message_cleared_p
= 1;
9351 if (last_displayed_p
)
9352 echo_area_buffer
[1] = Qnil
;
9354 message_buf_print
= 0;
9357 /* Clear garbaged frames.
9359 This function is used where the old redisplay called
9360 redraw_garbaged_frames which in turn called redraw_frame which in
9361 turn called clear_frame. The call to clear_frame was a source of
9362 flickering. I believe a clear_frame is not necessary. It should
9363 suffice in the new redisplay to invalidate all current matrices,
9364 and ensure a complete redisplay of all windows. */
9367 clear_garbaged_frames (void)
9371 Lisp_Object tail
, frame
;
9372 int changed_count
= 0;
9374 FOR_EACH_FRAME (tail
, frame
)
9376 struct frame
*f
= XFRAME (frame
);
9378 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9382 Fredraw_frame (frame
);
9383 f
->force_flush_display_p
= 1;
9385 clear_current_matrices (f
);
9394 ++windows_or_buffers_changed
;
9399 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9400 is non-zero update selected_frame. Value is non-zero if the
9401 mini-windows height has been changed. */
9404 echo_area_display (int update_frame_p
)
9406 Lisp_Object mini_window
;
9409 int window_height_changed_p
= 0;
9410 struct frame
*sf
= SELECTED_FRAME ();
9412 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9413 w
= XWINDOW (mini_window
);
9414 f
= XFRAME (WINDOW_FRAME (w
));
9416 /* Don't display if frame is invisible or not yet initialized. */
9417 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9420 #ifdef HAVE_WINDOW_SYSTEM
9421 /* When Emacs starts, selected_frame may be the initial terminal
9422 frame. If we let this through, a message would be displayed on
9424 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9426 #endif /* HAVE_WINDOW_SYSTEM */
9428 /* Redraw garbaged frames. */
9430 clear_garbaged_frames ();
9432 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9434 echo_area_window
= mini_window
;
9435 window_height_changed_p
= display_echo_area (w
);
9436 w
->must_be_updated_p
= 1;
9438 /* Update the display, unless called from redisplay_internal.
9439 Also don't update the screen during redisplay itself. The
9440 update will happen at the end of redisplay, and an update
9441 here could cause confusion. */
9442 if (update_frame_p
&& !redisplaying_p
)
9446 /* If the display update has been interrupted by pending
9447 input, update mode lines in the frame. Due to the
9448 pending input, it might have been that redisplay hasn't
9449 been called, so that mode lines above the echo area are
9450 garbaged. This looks odd, so we prevent it here. */
9451 if (!display_completed
)
9452 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9454 if (window_height_changed_p
9455 /* Don't do this if Emacs is shutting down. Redisplay
9456 needs to run hooks. */
9457 && !NILP (Vrun_hooks
))
9459 /* Must update other windows. Likewise as in other
9460 cases, don't let this update be interrupted by
9462 int count
= SPECPDL_INDEX ();
9463 specbind (Qredisplay_dont_pause
, Qt
);
9464 windows_or_buffers_changed
= 1;
9465 redisplay_internal ();
9466 unbind_to (count
, Qnil
);
9468 else if (FRAME_WINDOW_P (f
) && n
== 0)
9470 /* Window configuration is the same as before.
9471 Can do with a display update of the echo area,
9472 unless we displayed some mode lines. */
9473 update_single_window (w
, 1);
9474 FRAME_RIF (f
)->flush_display (f
);
9477 update_frame (f
, 1, 1);
9479 /* If cursor is in the echo area, make sure that the next
9480 redisplay displays the minibuffer, so that the cursor will
9481 be replaced with what the minibuffer wants. */
9482 if (cursor_in_echo_area
)
9483 ++windows_or_buffers_changed
;
9486 else if (!EQ (mini_window
, selected_window
))
9487 windows_or_buffers_changed
++;
9489 /* Last displayed message is now the current message. */
9490 echo_area_buffer
[1] = echo_area_buffer
[0];
9491 /* Inform read_char that we're not echoing. */
9492 echo_message_buffer
= Qnil
;
9494 /* Prevent redisplay optimization in redisplay_internal by resetting
9495 this_line_start_pos. This is done because the mini-buffer now
9496 displays the message instead of its buffer text. */
9497 if (EQ (mini_window
, selected_window
))
9498 CHARPOS (this_line_start_pos
) = 0;
9500 return window_height_changed_p
;
9505 /***********************************************************************
9506 Mode Lines and Frame Titles
9507 ***********************************************************************/
9509 /* A buffer for constructing non-propertized mode-line strings and
9510 frame titles in it; allocated from the heap in init_xdisp and
9511 resized as needed in store_mode_line_noprop_char. */
9513 static char *mode_line_noprop_buf
;
9515 /* The buffer's end, and a current output position in it. */
9517 static char *mode_line_noprop_buf_end
;
9518 static char *mode_line_noprop_ptr
;
9520 #define MODE_LINE_NOPROP_LEN(start) \
9521 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9524 MODE_LINE_DISPLAY
= 0,
9530 /* Alist that caches the results of :propertize.
9531 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9532 static Lisp_Object mode_line_proptrans_alist
;
9534 /* List of strings making up the mode-line. */
9535 static Lisp_Object mode_line_string_list
;
9537 /* Base face property when building propertized mode line string. */
9538 static Lisp_Object mode_line_string_face
;
9539 static Lisp_Object mode_line_string_face_prop
;
9542 /* Unwind data for mode line strings */
9544 static Lisp_Object Vmode_line_unwind_vector
;
9547 format_mode_line_unwind_data (struct buffer
*obuf
,
9551 Lisp_Object vector
, tmp
;
9553 /* Reduce consing by keeping one vector in
9554 Vwith_echo_area_save_vector. */
9555 vector
= Vmode_line_unwind_vector
;
9556 Vmode_line_unwind_vector
= Qnil
;
9559 vector
= Fmake_vector (make_number (8), Qnil
);
9561 ASET (vector
, 0, make_number (mode_line_target
));
9562 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9563 ASET (vector
, 2, mode_line_string_list
);
9564 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9565 ASET (vector
, 4, mode_line_string_face
);
9566 ASET (vector
, 5, mode_line_string_face_prop
);
9569 XSETBUFFER (tmp
, obuf
);
9572 ASET (vector
, 6, tmp
);
9573 ASET (vector
, 7, owin
);
9579 unwind_format_mode_line (Lisp_Object vector
)
9581 mode_line_target
= XINT (AREF (vector
, 0));
9582 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9583 mode_line_string_list
= AREF (vector
, 2);
9584 if (! EQ (AREF (vector
, 3), Qt
))
9585 mode_line_proptrans_alist
= AREF (vector
, 3);
9586 mode_line_string_face
= AREF (vector
, 4);
9587 mode_line_string_face_prop
= AREF (vector
, 5);
9589 if (!NILP (AREF (vector
, 7)))
9590 /* Select window before buffer, since it may change the buffer. */
9591 Fselect_window (AREF (vector
, 7), Qt
);
9593 if (!NILP (AREF (vector
, 6)))
9595 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9596 ASET (vector
, 6, Qnil
);
9599 Vmode_line_unwind_vector
= vector
;
9604 /* Store a single character C for the frame title in mode_line_noprop_buf.
9605 Re-allocate mode_line_noprop_buf if necessary. */
9608 store_mode_line_noprop_char (char c
)
9610 /* If output position has reached the end of the allocated buffer,
9611 double the buffer's size. */
9612 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9614 int len
= MODE_LINE_NOPROP_LEN (0);
9615 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9616 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9617 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9618 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9621 *mode_line_noprop_ptr
++ = c
;
9625 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9626 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9627 characters that yield more columns than PRECISION; PRECISION <= 0
9628 means copy the whole string. Pad with spaces until FIELD_WIDTH
9629 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9630 pad. Called from display_mode_element when it is used to build a
9634 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9636 const unsigned char *str
= (const unsigned char *) string
;
9638 EMACS_INT dummy
, nbytes
;
9640 /* Copy at most PRECISION chars from STR. */
9641 nbytes
= strlen (string
);
9642 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9644 store_mode_line_noprop_char (*str
++);
9646 /* Fill up with spaces until FIELD_WIDTH reached. */
9647 while (field_width
> 0
9650 store_mode_line_noprop_char (' ');
9657 /***********************************************************************
9659 ***********************************************************************/
9661 #ifdef HAVE_WINDOW_SYSTEM
9663 /* Set the title of FRAME, if it has changed. The title format is
9664 Vicon_title_format if FRAME is iconified, otherwise it is
9665 frame_title_format. */
9668 x_consider_frame_title (Lisp_Object frame
)
9670 struct frame
*f
= XFRAME (frame
);
9672 if (FRAME_WINDOW_P (f
)
9673 || FRAME_MINIBUF_ONLY_P (f
)
9674 || f
->explicit_name
)
9676 /* Do we have more than one visible frame on this X display? */
9683 int count
= SPECPDL_INDEX ();
9685 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9687 Lisp_Object other_frame
= XCAR (tail
);
9688 struct frame
*tf
= XFRAME (other_frame
);
9691 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9692 && !FRAME_MINIBUF_ONLY_P (tf
)
9693 && !EQ (other_frame
, tip_frame
)
9694 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9698 /* Set global variable indicating that multiple frames exist. */
9699 multiple_frames
= CONSP (tail
);
9701 /* Switch to the buffer of selected window of the frame. Set up
9702 mode_line_target so that display_mode_element will output into
9703 mode_line_noprop_buf; then display the title. */
9704 record_unwind_protect (unwind_format_mode_line
,
9705 format_mode_line_unwind_data
9706 (current_buffer
, selected_window
, 0));
9708 Fselect_window (f
->selected_window
, Qt
);
9709 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9710 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9712 mode_line_target
= MODE_LINE_TITLE
;
9713 title_start
= MODE_LINE_NOPROP_LEN (0);
9714 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9715 NULL
, DEFAULT_FACE_ID
);
9716 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9717 len
= MODE_LINE_NOPROP_LEN (title_start
);
9718 title
= mode_line_noprop_buf
+ title_start
;
9719 unbind_to (count
, Qnil
);
9721 /* Set the title only if it's changed. This avoids consing in
9722 the common case where it hasn't. (If it turns out that we've
9723 already wasted too much time by walking through the list with
9724 display_mode_element, then we might need to optimize at a
9725 higher level than this.) */
9726 if (! STRINGP (f
->name
)
9727 || SBYTES (f
->name
) != len
9728 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9729 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9733 #endif /* not HAVE_WINDOW_SYSTEM */
9738 /***********************************************************************
9740 ***********************************************************************/
9743 /* Prepare for redisplay by updating menu-bar item lists when
9744 appropriate. This can call eval. */
9747 prepare_menu_bars (void)
9750 struct gcpro gcpro1
, gcpro2
;
9752 Lisp_Object tooltip_frame
;
9754 #ifdef HAVE_WINDOW_SYSTEM
9755 tooltip_frame
= tip_frame
;
9757 tooltip_frame
= Qnil
;
9760 /* Update all frame titles based on their buffer names, etc. We do
9761 this before the menu bars so that the buffer-menu will show the
9762 up-to-date frame titles. */
9763 #ifdef HAVE_WINDOW_SYSTEM
9764 if (windows_or_buffers_changed
|| update_mode_lines
)
9766 Lisp_Object tail
, frame
;
9768 FOR_EACH_FRAME (tail
, frame
)
9771 if (!EQ (frame
, tooltip_frame
)
9772 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9773 x_consider_frame_title (frame
);
9776 #endif /* HAVE_WINDOW_SYSTEM */
9778 /* Update the menu bar item lists, if appropriate. This has to be
9779 done before any actual redisplay or generation of display lines. */
9780 all_windows
= (update_mode_lines
9781 || buffer_shared
> 1
9782 || windows_or_buffers_changed
);
9785 Lisp_Object tail
, frame
;
9786 int count
= SPECPDL_INDEX ();
9787 /* 1 means that update_menu_bar has run its hooks
9788 so any further calls to update_menu_bar shouldn't do so again. */
9789 int menu_bar_hooks_run
= 0;
9791 record_unwind_save_match_data ();
9793 FOR_EACH_FRAME (tail
, frame
)
9797 /* Ignore tooltip frame. */
9798 if (EQ (frame
, tooltip_frame
))
9801 /* If a window on this frame changed size, report that to
9802 the user and clear the size-change flag. */
9803 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9805 Lisp_Object functions
;
9807 /* Clear flag first in case we get an error below. */
9808 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9809 functions
= Vwindow_size_change_functions
;
9810 GCPRO2 (tail
, functions
);
9812 while (CONSP (functions
))
9814 if (!EQ (XCAR (functions
), Qt
))
9815 call1 (XCAR (functions
), frame
);
9816 functions
= XCDR (functions
);
9822 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9823 #ifdef HAVE_WINDOW_SYSTEM
9824 update_tool_bar (f
, 0);
9827 if (windows_or_buffers_changed
9829 ns_set_doc_edited (f
, Fbuffer_modified_p
9830 (XWINDOW (f
->selected_window
)->buffer
));
9835 unbind_to (count
, Qnil
);
9839 struct frame
*sf
= SELECTED_FRAME ();
9840 update_menu_bar (sf
, 1, 0);
9841 #ifdef HAVE_WINDOW_SYSTEM
9842 update_tool_bar (sf
, 1);
9848 /* Update the menu bar item list for frame F. This has to be done
9849 before we start to fill in any display lines, because it can call
9852 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9854 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9855 already ran the menu bar hooks for this redisplay, so there
9856 is no need to run them again. The return value is the
9857 updated value of this flag, to pass to the next call. */
9860 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9863 register struct window
*w
;
9865 /* If called recursively during a menu update, do nothing. This can
9866 happen when, for instance, an activate-menubar-hook causes a
9868 if (inhibit_menubar_update
)
9871 window
= FRAME_SELECTED_WINDOW (f
);
9872 w
= XWINDOW (window
);
9874 if (FRAME_WINDOW_P (f
)
9876 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9877 || defined (HAVE_NS) || defined (USE_GTK)
9878 FRAME_EXTERNAL_MENU_BAR (f
)
9880 FRAME_MENU_BAR_LINES (f
) > 0
9882 : FRAME_MENU_BAR_LINES (f
) > 0)
9884 /* If the user has switched buffers or windows, we need to
9885 recompute to reflect the new bindings. But we'll
9886 recompute when update_mode_lines is set too; that means
9887 that people can use force-mode-line-update to request
9888 that the menu bar be recomputed. The adverse effect on
9889 the rest of the redisplay algorithm is about the same as
9890 windows_or_buffers_changed anyway. */
9891 if (windows_or_buffers_changed
9892 /* This used to test w->update_mode_line, but we believe
9893 there is no need to recompute the menu in that case. */
9894 || update_mode_lines
9895 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9896 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9897 != !NILP (w
->last_had_star
))
9898 || ((!NILP (Vtransient_mark_mode
)
9899 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9900 != !NILP (w
->region_showing
)))
9902 struct buffer
*prev
= current_buffer
;
9903 int count
= SPECPDL_INDEX ();
9905 specbind (Qinhibit_menubar_update
, Qt
);
9907 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9908 if (save_match_data
)
9909 record_unwind_save_match_data ();
9910 if (NILP (Voverriding_local_map_menu_flag
))
9912 specbind (Qoverriding_terminal_local_map
, Qnil
);
9913 specbind (Qoverriding_local_map
, Qnil
);
9918 /* Run the Lucid hook. */
9919 safe_run_hooks (Qactivate_menubar_hook
);
9921 /* If it has changed current-menubar from previous value,
9922 really recompute the menu-bar from the value. */
9923 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9924 call0 (Qrecompute_lucid_menubar
);
9926 safe_run_hooks (Qmenu_bar_update_hook
);
9931 XSETFRAME (Vmenu_updating_frame
, f
);
9932 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9934 /* Redisplay the menu bar in case we changed it. */
9935 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9936 || defined (HAVE_NS) || defined (USE_GTK)
9937 if (FRAME_WINDOW_P (f
))
9939 #if defined (HAVE_NS)
9940 /* All frames on Mac OS share the same menubar. So only
9941 the selected frame should be allowed to set it. */
9942 if (f
== SELECTED_FRAME ())
9944 set_frame_menubar (f
, 0, 0);
9947 /* On a terminal screen, the menu bar is an ordinary screen
9948 line, and this makes it get updated. */
9949 w
->update_mode_line
= Qt
;
9950 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9951 /* In the non-toolkit version, the menu bar is an ordinary screen
9952 line, and this makes it get updated. */
9953 w
->update_mode_line
= Qt
;
9954 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9956 unbind_to (count
, Qnil
);
9957 set_buffer_internal_1 (prev
);
9966 /***********************************************************************
9968 ***********************************************************************/
9970 #ifdef HAVE_WINDOW_SYSTEM
9973 Nominal cursor position -- where to draw output.
9974 HPOS and VPOS are window relative glyph matrix coordinates.
9975 X and Y are window relative pixel coordinates. */
9977 struct cursor_pos output_cursor
;
9981 Set the global variable output_cursor to CURSOR. All cursor
9982 positions are relative to updated_window. */
9985 set_output_cursor (struct cursor_pos
*cursor
)
9987 output_cursor
.hpos
= cursor
->hpos
;
9988 output_cursor
.vpos
= cursor
->vpos
;
9989 output_cursor
.x
= cursor
->x
;
9990 output_cursor
.y
= cursor
->y
;
9995 Set a nominal cursor position.
9997 HPOS and VPOS are column/row positions in a window glyph matrix. X
9998 and Y are window text area relative pixel positions.
10000 If this is done during an update, updated_window will contain the
10001 window that is being updated and the position is the future output
10002 cursor position for that window. If updated_window is null, use
10003 selected_window and display the cursor at the given position. */
10006 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10010 /* If updated_window is not set, work on selected_window. */
10011 if (updated_window
)
10012 w
= updated_window
;
10014 w
= XWINDOW (selected_window
);
10016 /* Set the output cursor. */
10017 output_cursor
.hpos
= hpos
;
10018 output_cursor
.vpos
= vpos
;
10019 output_cursor
.x
= x
;
10020 output_cursor
.y
= y
;
10022 /* If not called as part of an update, really display the cursor.
10023 This will also set the cursor position of W. */
10024 if (updated_window
== NULL
)
10027 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10028 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10029 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10034 #endif /* HAVE_WINDOW_SYSTEM */
10037 /***********************************************************************
10039 ***********************************************************************/
10041 #ifdef HAVE_WINDOW_SYSTEM
10043 /* Where the mouse was last time we reported a mouse event. */
10045 FRAME_PTR last_mouse_frame
;
10047 /* Tool-bar item index of the item on which a mouse button was pressed
10050 int last_tool_bar_item
;
10054 update_tool_bar_unwind (Lisp_Object frame
)
10056 selected_frame
= frame
;
10060 /* Update the tool-bar item list for frame F. This has to be done
10061 before we start to fill in any display lines. Called from
10062 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10063 and restore it here. */
10066 update_tool_bar (struct frame
*f
, int save_match_data
)
10068 #if defined (USE_GTK) || defined (HAVE_NS)
10069 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10071 int do_update
= WINDOWP (f
->tool_bar_window
)
10072 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10077 Lisp_Object window
;
10080 window
= FRAME_SELECTED_WINDOW (f
);
10081 w
= XWINDOW (window
);
10083 /* If the user has switched buffers or windows, we need to
10084 recompute to reflect the new bindings. But we'll
10085 recompute when update_mode_lines is set too; that means
10086 that people can use force-mode-line-update to request
10087 that the menu bar be recomputed. The adverse effect on
10088 the rest of the redisplay algorithm is about the same as
10089 windows_or_buffers_changed anyway. */
10090 if (windows_or_buffers_changed
10091 || !NILP (w
->update_mode_line
)
10092 || update_mode_lines
10093 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10094 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10095 != !NILP (w
->last_had_star
))
10096 || ((!NILP (Vtransient_mark_mode
)
10097 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10098 != !NILP (w
->region_showing
)))
10100 struct buffer
*prev
= current_buffer
;
10101 int count
= SPECPDL_INDEX ();
10102 Lisp_Object frame
, new_tool_bar
;
10103 int new_n_tool_bar
;
10104 struct gcpro gcpro1
;
10106 /* Set current_buffer to the buffer of the selected
10107 window of the frame, so that we get the right local
10109 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10111 /* Save match data, if we must. */
10112 if (save_match_data
)
10113 record_unwind_save_match_data ();
10115 /* Make sure that we don't accidentally use bogus keymaps. */
10116 if (NILP (Voverriding_local_map_menu_flag
))
10118 specbind (Qoverriding_terminal_local_map
, Qnil
);
10119 specbind (Qoverriding_local_map
, Qnil
);
10122 GCPRO1 (new_tool_bar
);
10124 /* We must temporarily set the selected frame to this frame
10125 before calling tool_bar_items, because the calculation of
10126 the tool-bar keymap uses the selected frame (see
10127 `tool-bar-make-keymap' in tool-bar.el). */
10128 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10129 XSETFRAME (frame
, f
);
10130 selected_frame
= frame
;
10132 /* Build desired tool-bar items from keymaps. */
10133 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10136 /* Redisplay the tool-bar if we changed it. */
10137 if (new_n_tool_bar
!= f
->n_tool_bar_items
10138 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10140 /* Redisplay that happens asynchronously due to an expose event
10141 may access f->tool_bar_items. Make sure we update both
10142 variables within BLOCK_INPUT so no such event interrupts. */
10144 f
->tool_bar_items
= new_tool_bar
;
10145 f
->n_tool_bar_items
= new_n_tool_bar
;
10146 w
->update_mode_line
= Qt
;
10152 unbind_to (count
, Qnil
);
10153 set_buffer_internal_1 (prev
);
10159 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10160 F's desired tool-bar contents. F->tool_bar_items must have
10161 been set up previously by calling prepare_menu_bars. */
10164 build_desired_tool_bar_string (struct frame
*f
)
10166 int i
, size
, size_needed
;
10167 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10168 Lisp_Object image
, plist
, props
;
10170 image
= plist
= props
= Qnil
;
10171 GCPRO3 (image
, plist
, props
);
10173 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10174 Otherwise, make a new string. */
10176 /* The size of the string we might be able to reuse. */
10177 size
= (STRINGP (f
->desired_tool_bar_string
)
10178 ? SCHARS (f
->desired_tool_bar_string
)
10181 /* We need one space in the string for each image. */
10182 size_needed
= f
->n_tool_bar_items
;
10184 /* Reuse f->desired_tool_bar_string, if possible. */
10185 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10186 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10187 make_number (' '));
10190 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10191 Fremove_text_properties (make_number (0), make_number (size
),
10192 props
, f
->desired_tool_bar_string
);
10195 /* Put a `display' property on the string for the images to display,
10196 put a `menu_item' property on tool-bar items with a value that
10197 is the index of the item in F's tool-bar item vector. */
10198 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10200 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10202 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10203 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10204 int hmargin
, vmargin
, relief
, idx
, end
;
10206 /* If image is a vector, choose the image according to the
10208 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10209 if (VECTORP (image
))
10213 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10214 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10217 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10218 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10220 xassert (ASIZE (image
) >= idx
);
10221 image
= AREF (image
, idx
);
10226 /* Ignore invalid image specifications. */
10227 if (!valid_image_p (image
))
10230 /* Display the tool-bar button pressed, or depressed. */
10231 plist
= Fcopy_sequence (XCDR (image
));
10233 /* Compute margin and relief to draw. */
10234 relief
= (tool_bar_button_relief
>= 0
10235 ? tool_bar_button_relief
10236 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10237 hmargin
= vmargin
= relief
;
10239 if (INTEGERP (Vtool_bar_button_margin
)
10240 && XINT (Vtool_bar_button_margin
) > 0)
10242 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10243 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10245 else if (CONSP (Vtool_bar_button_margin
))
10247 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10248 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10249 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10251 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10252 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10253 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10256 if (auto_raise_tool_bar_buttons_p
)
10258 /* Add a `:relief' property to the image spec if the item is
10262 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10269 /* If image is selected, display it pressed, i.e. with a
10270 negative relief. If it's not selected, display it with a
10272 plist
= Fplist_put (plist
, QCrelief
,
10274 ? make_number (-relief
)
10275 : make_number (relief
)));
10280 /* Put a margin around the image. */
10281 if (hmargin
|| vmargin
)
10283 if (hmargin
== vmargin
)
10284 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10286 plist
= Fplist_put (plist
, QCmargin
,
10287 Fcons (make_number (hmargin
),
10288 make_number (vmargin
)));
10291 /* If button is not enabled, and we don't have special images
10292 for the disabled state, make the image appear disabled by
10293 applying an appropriate algorithm to it. */
10294 if (!enabled_p
&& idx
< 0)
10295 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10297 /* Put a `display' text property on the string for the image to
10298 display. Put a `menu-item' property on the string that gives
10299 the start of this item's properties in the tool-bar items
10301 image
= Fcons (Qimage
, plist
);
10302 props
= list4 (Qdisplay
, image
,
10303 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10305 /* Let the last image hide all remaining spaces in the tool bar
10306 string. The string can be longer than needed when we reuse a
10307 previous string. */
10308 if (i
+ 1 == f
->n_tool_bar_items
)
10309 end
= SCHARS (f
->desired_tool_bar_string
);
10312 Fadd_text_properties (make_number (i
), make_number (end
),
10313 props
, f
->desired_tool_bar_string
);
10321 /* Display one line of the tool-bar of frame IT->f.
10323 HEIGHT specifies the desired height of the tool-bar line.
10324 If the actual height of the glyph row is less than HEIGHT, the
10325 row's height is increased to HEIGHT, and the icons are centered
10326 vertically in the new height.
10328 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10329 count a final empty row in case the tool-bar width exactly matches
10334 display_tool_bar_line (struct it
*it
, int height
)
10336 struct glyph_row
*row
= it
->glyph_row
;
10337 int max_x
= it
->last_visible_x
;
10338 struct glyph
*last
;
10340 prepare_desired_row (row
);
10341 row
->y
= it
->current_y
;
10343 /* Note that this isn't made use of if the face hasn't a box,
10344 so there's no need to check the face here. */
10345 it
->start_of_box_run_p
= 1;
10347 while (it
->current_x
< max_x
)
10349 int x
, n_glyphs_before
, i
, nglyphs
;
10350 struct it it_before
;
10352 /* Get the next display element. */
10353 if (!get_next_display_element (it
))
10355 /* Don't count empty row if we are counting needed tool-bar lines. */
10356 if (height
< 0 && !it
->hpos
)
10361 /* Produce glyphs. */
10362 n_glyphs_before
= row
->used
[TEXT_AREA
];
10365 PRODUCE_GLYPHS (it
);
10367 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10369 x
= it_before
.current_x
;
10370 while (i
< nglyphs
)
10372 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10374 if (x
+ glyph
->pixel_width
> max_x
)
10376 /* Glyph doesn't fit on line. Backtrack. */
10377 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10379 /* If this is the only glyph on this line, it will never fit on the
10380 tool-bar, so skip it. But ensure there is at least one glyph,
10381 so we don't accidentally disable the tool-bar. */
10382 if (n_glyphs_before
== 0
10383 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10389 x
+= glyph
->pixel_width
;
10393 /* Stop at line ends. */
10394 if (ITERATOR_AT_END_OF_LINE_P (it
))
10397 set_iterator_to_next (it
, 1);
10402 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10404 /* Use default face for the border below the tool bar.
10406 FIXME: When auto-resize-tool-bars is grow-only, there is
10407 no additional border below the possibly empty tool-bar lines.
10408 So to make the extra empty lines look "normal", we have to
10409 use the tool-bar face for the border too. */
10410 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10411 it
->face_id
= DEFAULT_FACE_ID
;
10413 extend_face_to_end_of_line (it
);
10414 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10415 last
->right_box_line_p
= 1;
10416 if (last
== row
->glyphs
[TEXT_AREA
])
10417 last
->left_box_line_p
= 1;
10419 /* Make line the desired height and center it vertically. */
10420 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10422 /* Don't add more than one line height. */
10423 height
%= FRAME_LINE_HEIGHT (it
->f
);
10424 it
->max_ascent
+= height
/ 2;
10425 it
->max_descent
+= (height
+ 1) / 2;
10428 compute_line_metrics (it
);
10430 /* If line is empty, make it occupy the rest of the tool-bar. */
10431 if (!row
->displays_text_p
)
10433 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10434 row
->visible_height
= row
->height
;
10435 row
->ascent
= row
->phys_ascent
= 0;
10436 row
->extra_line_spacing
= 0;
10439 row
->full_width_p
= 1;
10440 row
->continued_p
= 0;
10441 row
->truncated_on_left_p
= 0;
10442 row
->truncated_on_right_p
= 0;
10444 it
->current_x
= it
->hpos
= 0;
10445 it
->current_y
+= row
->height
;
10451 /* Max tool-bar height. */
10453 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10454 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10456 /* Value is the number of screen lines needed to make all tool-bar
10457 items of frame F visible. The number of actual rows needed is
10458 returned in *N_ROWS if non-NULL. */
10461 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10463 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10465 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10466 the desired matrix, so use (unused) mode-line row as temporary row to
10467 avoid destroying the first tool-bar row. */
10468 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10470 /* Initialize an iterator for iteration over
10471 F->desired_tool_bar_string in the tool-bar window of frame F. */
10472 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10473 it
.first_visible_x
= 0;
10474 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10475 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10477 while (!ITERATOR_AT_END_P (&it
))
10479 clear_glyph_row (temp_row
);
10480 it
.glyph_row
= temp_row
;
10481 display_tool_bar_line (&it
, -1);
10483 clear_glyph_row (temp_row
);
10485 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10487 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10489 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10493 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10495 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10496 (Lisp_Object frame
)
10503 frame
= selected_frame
;
10505 CHECK_FRAME (frame
);
10506 f
= XFRAME (frame
);
10508 if (WINDOWP (f
->tool_bar_window
)
10509 || (w
= XWINDOW (f
->tool_bar_window
),
10510 WINDOW_TOTAL_LINES (w
) > 0))
10512 update_tool_bar (f
, 1);
10513 if (f
->n_tool_bar_items
)
10515 build_desired_tool_bar_string (f
);
10516 nlines
= tool_bar_lines_needed (f
, NULL
);
10520 return make_number (nlines
);
10524 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10525 height should be changed. */
10528 redisplay_tool_bar (struct frame
*f
)
10532 struct glyph_row
*row
;
10534 #if defined (USE_GTK) || defined (HAVE_NS)
10535 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10536 update_frame_tool_bar (f
);
10540 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10541 do anything. This means you must start with tool-bar-lines
10542 non-zero to get the auto-sizing effect. Or in other words, you
10543 can turn off tool-bars by specifying tool-bar-lines zero. */
10544 if (!WINDOWP (f
->tool_bar_window
)
10545 || (w
= XWINDOW (f
->tool_bar_window
),
10546 WINDOW_TOTAL_LINES (w
) == 0))
10549 /* Set up an iterator for the tool-bar window. */
10550 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10551 it
.first_visible_x
= 0;
10552 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10553 row
= it
.glyph_row
;
10555 /* Build a string that represents the contents of the tool-bar. */
10556 build_desired_tool_bar_string (f
);
10557 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10559 if (f
->n_tool_bar_rows
== 0)
10563 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10564 nlines
!= WINDOW_TOTAL_LINES (w
)))
10567 int old_height
= WINDOW_TOTAL_LINES (w
);
10569 XSETFRAME (frame
, f
);
10570 Fmodify_frame_parameters (frame
,
10571 Fcons (Fcons (Qtool_bar_lines
,
10572 make_number (nlines
)),
10574 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10576 clear_glyph_matrix (w
->desired_matrix
);
10577 fonts_changed_p
= 1;
10583 /* Display as many lines as needed to display all tool-bar items. */
10585 if (f
->n_tool_bar_rows
> 0)
10587 int border
, rows
, height
, extra
;
10589 if (INTEGERP (Vtool_bar_border
))
10590 border
= XINT (Vtool_bar_border
);
10591 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10592 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10593 else if (EQ (Vtool_bar_border
, Qborder_width
))
10594 border
= f
->border_width
;
10600 rows
= f
->n_tool_bar_rows
;
10601 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10602 extra
= it
.last_visible_y
- border
- height
* rows
;
10604 while (it
.current_y
< it
.last_visible_y
)
10607 if (extra
> 0 && rows
-- > 0)
10609 h
= (extra
+ rows
- 1) / rows
;
10612 display_tool_bar_line (&it
, height
+ h
);
10617 while (it
.current_y
< it
.last_visible_y
)
10618 display_tool_bar_line (&it
, 0);
10621 /* It doesn't make much sense to try scrolling in the tool-bar
10622 window, so don't do it. */
10623 w
->desired_matrix
->no_scrolling_p
= 1;
10624 w
->must_be_updated_p
= 1;
10626 if (!NILP (Vauto_resize_tool_bars
))
10628 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10629 int change_height_p
= 0;
10631 /* If we couldn't display everything, change the tool-bar's
10632 height if there is room for more. */
10633 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10634 && it
.current_y
< max_tool_bar_height
)
10635 change_height_p
= 1;
10637 row
= it
.glyph_row
- 1;
10639 /* If there are blank lines at the end, except for a partially
10640 visible blank line at the end that is smaller than
10641 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10642 if (!row
->displays_text_p
10643 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10644 change_height_p
= 1;
10646 /* If row displays tool-bar items, but is partially visible,
10647 change the tool-bar's height. */
10648 if (row
->displays_text_p
10649 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10650 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10651 change_height_p
= 1;
10653 /* Resize windows as needed by changing the `tool-bar-lines'
10654 frame parameter. */
10655 if (change_height_p
)
10658 int old_height
= WINDOW_TOTAL_LINES (w
);
10660 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10662 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10663 && !f
->minimize_tool_bar_window_p
)
10664 ? (nlines
> old_height
)
10665 : (nlines
!= old_height
));
10666 f
->minimize_tool_bar_window_p
= 0;
10668 if (change_height_p
)
10670 XSETFRAME (frame
, f
);
10671 Fmodify_frame_parameters (frame
,
10672 Fcons (Fcons (Qtool_bar_lines
,
10673 make_number (nlines
)),
10675 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10677 clear_glyph_matrix (w
->desired_matrix
);
10678 f
->n_tool_bar_rows
= nrows
;
10679 fonts_changed_p
= 1;
10686 f
->minimize_tool_bar_window_p
= 0;
10691 /* Get information about the tool-bar item which is displayed in GLYPH
10692 on frame F. Return in *PROP_IDX the index where tool-bar item
10693 properties start in F->tool_bar_items. Value is zero if
10694 GLYPH doesn't display a tool-bar item. */
10697 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10703 /* This function can be called asynchronously, which means we must
10704 exclude any possibility that Fget_text_property signals an
10706 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10707 charpos
= max (0, charpos
);
10709 /* Get the text property `menu-item' at pos. The value of that
10710 property is the start index of this item's properties in
10711 F->tool_bar_items. */
10712 prop
= Fget_text_property (make_number (charpos
),
10713 Qmenu_item
, f
->current_tool_bar_string
);
10714 if (INTEGERP (prop
))
10716 *prop_idx
= XINT (prop
);
10726 /* Get information about the tool-bar item at position X/Y on frame F.
10727 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10728 the current matrix of the tool-bar window of F, or NULL if not
10729 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10730 item in F->tool_bar_items. Value is
10732 -1 if X/Y is not on a tool-bar item
10733 0 if X/Y is on the same item that was highlighted before.
10737 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10738 int *hpos
, int *vpos
, int *prop_idx
)
10740 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10741 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10744 /* Find the glyph under X/Y. */
10745 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10746 if (*glyph
== NULL
)
10749 /* Get the start of this tool-bar item's properties in
10750 f->tool_bar_items. */
10751 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10754 /* Is mouse on the highlighted item? */
10755 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10756 && *vpos
>= hlinfo
->mouse_face_beg_row
10757 && *vpos
<= hlinfo
->mouse_face_end_row
10758 && (*vpos
> hlinfo
->mouse_face_beg_row
10759 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10760 && (*vpos
< hlinfo
->mouse_face_end_row
10761 || *hpos
< hlinfo
->mouse_face_end_col
10762 || hlinfo
->mouse_face_past_end
))
10770 Handle mouse button event on the tool-bar of frame F, at
10771 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10772 0 for button release. MODIFIERS is event modifiers for button
10776 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10777 unsigned int modifiers
)
10779 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10780 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10781 int hpos
, vpos
, prop_idx
;
10782 struct glyph
*glyph
;
10783 Lisp_Object enabled_p
;
10785 /* If not on the highlighted tool-bar item, return. */
10786 frame_to_window_pixel_xy (w
, &x
, &y
);
10787 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10790 /* If item is disabled, do nothing. */
10791 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10792 if (NILP (enabled_p
))
10797 /* Show item in pressed state. */
10798 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10799 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10800 last_tool_bar_item
= prop_idx
;
10804 Lisp_Object key
, frame
;
10805 struct input_event event
;
10806 EVENT_INIT (event
);
10808 /* Show item in released state. */
10809 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10810 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10812 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10814 XSETFRAME (frame
, f
);
10815 event
.kind
= TOOL_BAR_EVENT
;
10816 event
.frame_or_window
= frame
;
10818 kbd_buffer_store_event (&event
);
10820 event
.kind
= TOOL_BAR_EVENT
;
10821 event
.frame_or_window
= frame
;
10823 event
.modifiers
= modifiers
;
10824 kbd_buffer_store_event (&event
);
10825 last_tool_bar_item
= -1;
10830 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10831 tool-bar window-relative coordinates X/Y. Called from
10832 note_mouse_highlight. */
10835 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10837 Lisp_Object window
= f
->tool_bar_window
;
10838 struct window
*w
= XWINDOW (window
);
10839 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10840 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10842 struct glyph
*glyph
;
10843 struct glyph_row
*row
;
10845 Lisp_Object enabled_p
;
10847 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10848 int mouse_down_p
, rc
;
10850 /* Function note_mouse_highlight is called with negative X/Y
10851 values when mouse moves outside of the frame. */
10852 if (x
<= 0 || y
<= 0)
10854 clear_mouse_face (hlinfo
);
10858 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10861 /* Not on tool-bar item. */
10862 clear_mouse_face (hlinfo
);
10866 /* On same tool-bar item as before. */
10867 goto set_help_echo
;
10869 clear_mouse_face (hlinfo
);
10871 /* Mouse is down, but on different tool-bar item? */
10872 mouse_down_p
= (dpyinfo
->grabbed
10873 && f
== last_mouse_frame
10874 && FRAME_LIVE_P (f
));
10876 && last_tool_bar_item
!= prop_idx
)
10879 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10880 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10882 /* If tool-bar item is not enabled, don't highlight it. */
10883 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10884 if (!NILP (enabled_p
))
10886 /* Compute the x-position of the glyph. In front and past the
10887 image is a space. We include this in the highlighted area. */
10888 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10889 for (i
= x
= 0; i
< hpos
; ++i
)
10890 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10892 /* Record this as the current active region. */
10893 hlinfo
->mouse_face_beg_col
= hpos
;
10894 hlinfo
->mouse_face_beg_row
= vpos
;
10895 hlinfo
->mouse_face_beg_x
= x
;
10896 hlinfo
->mouse_face_beg_y
= row
->y
;
10897 hlinfo
->mouse_face_past_end
= 0;
10899 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10900 hlinfo
->mouse_face_end_row
= vpos
;
10901 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10902 hlinfo
->mouse_face_end_y
= row
->y
;
10903 hlinfo
->mouse_face_window
= window
;
10904 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10906 /* Display it as active. */
10907 show_mouse_face (hlinfo
, draw
);
10908 hlinfo
->mouse_face_image_state
= draw
;
10913 /* Set help_echo_string to a help string to display for this tool-bar item.
10914 XTread_socket does the rest. */
10915 help_echo_object
= help_echo_window
= Qnil
;
10916 help_echo_pos
= -1;
10917 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10918 if (NILP (help_echo_string
))
10919 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10922 #endif /* HAVE_WINDOW_SYSTEM */
10926 /************************************************************************
10927 Horizontal scrolling
10928 ************************************************************************/
10930 static int hscroll_window_tree (Lisp_Object
);
10931 static int hscroll_windows (Lisp_Object
);
10933 /* For all leaf windows in the window tree rooted at WINDOW, set their
10934 hscroll value so that PT is (i) visible in the window, and (ii) so
10935 that it is not within a certain margin at the window's left and
10936 right border. Value is non-zero if any window's hscroll has been
10940 hscroll_window_tree (Lisp_Object window
)
10942 int hscrolled_p
= 0;
10943 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10944 int hscroll_step_abs
= 0;
10945 double hscroll_step_rel
= 0;
10947 if (hscroll_relative_p
)
10949 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10950 if (hscroll_step_rel
< 0)
10952 hscroll_relative_p
= 0;
10953 hscroll_step_abs
= 0;
10956 else if (INTEGERP (Vhscroll_step
))
10958 hscroll_step_abs
= XINT (Vhscroll_step
);
10959 if (hscroll_step_abs
< 0)
10960 hscroll_step_abs
= 0;
10963 hscroll_step_abs
= 0;
10965 while (WINDOWP (window
))
10967 struct window
*w
= XWINDOW (window
);
10969 if (WINDOWP (w
->hchild
))
10970 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10971 else if (WINDOWP (w
->vchild
))
10972 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10973 else if (w
->cursor
.vpos
>= 0)
10976 int text_area_width
;
10977 struct glyph_row
*current_cursor_row
10978 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10979 struct glyph_row
*desired_cursor_row
10980 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10981 struct glyph_row
*cursor_row
10982 = (desired_cursor_row
->enabled_p
10983 ? desired_cursor_row
10984 : current_cursor_row
);
10986 text_area_width
= window_box_width (w
, TEXT_AREA
);
10988 /* Scroll when cursor is inside this scroll margin. */
10989 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10991 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10992 && ((XFASTINT (w
->hscroll
)
10993 && w
->cursor
.x
<= h_margin
)
10994 || (cursor_row
->enabled_p
10995 && cursor_row
->truncated_on_right_p
10996 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11000 struct buffer
*saved_current_buffer
;
11004 /* Find point in a display of infinite width. */
11005 saved_current_buffer
= current_buffer
;
11006 current_buffer
= XBUFFER (w
->buffer
);
11008 if (w
== XWINDOW (selected_window
))
11012 pt
= marker_position (w
->pointm
);
11013 pt
= max (BEGV
, pt
);
11017 /* Move iterator to pt starting at cursor_row->start in
11018 a line with infinite width. */
11019 init_to_row_start (&it
, w
, cursor_row
);
11020 it
.last_visible_x
= INFINITY
;
11021 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11022 current_buffer
= saved_current_buffer
;
11024 /* Position cursor in window. */
11025 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11026 hscroll
= max (0, (it
.current_x
11027 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11028 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11029 : (text_area_width
/ 2))))
11030 / FRAME_COLUMN_WIDTH (it
.f
);
11031 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11033 if (hscroll_relative_p
)
11034 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11037 wanted_x
= text_area_width
11038 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11041 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11045 if (hscroll_relative_p
)
11046 wanted_x
= text_area_width
* hscroll_step_rel
11049 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11052 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11054 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11056 /* Don't call Fset_window_hscroll if value hasn't
11057 changed because it will prevent redisplay
11059 if (XFASTINT (w
->hscroll
) != hscroll
)
11061 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11062 w
->hscroll
= make_number (hscroll
);
11071 /* Value is non-zero if hscroll of any leaf window has been changed. */
11072 return hscrolled_p
;
11076 /* Set hscroll so that cursor is visible and not inside horizontal
11077 scroll margins for all windows in the tree rooted at WINDOW. See
11078 also hscroll_window_tree above. Value is non-zero if any window's
11079 hscroll has been changed. If it has, desired matrices on the frame
11080 of WINDOW are cleared. */
11083 hscroll_windows (Lisp_Object window
)
11085 int hscrolled_p
= hscroll_window_tree (window
);
11087 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11088 return hscrolled_p
;
11093 /************************************************************************
11095 ************************************************************************/
11097 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11098 to a non-zero value. This is sometimes handy to have in a debugger
11103 /* First and last unchanged row for try_window_id. */
11105 int debug_first_unchanged_at_end_vpos
;
11106 int debug_last_unchanged_at_beg_vpos
;
11108 /* Delta vpos and y. */
11110 int debug_dvpos
, debug_dy
;
11112 /* Delta in characters and bytes for try_window_id. */
11114 EMACS_INT debug_delta
, debug_delta_bytes
;
11116 /* Values of window_end_pos and window_end_vpos at the end of
11119 EMACS_INT debug_end_vpos
;
11121 /* Append a string to W->desired_matrix->method. FMT is a printf
11122 format string. A1...A9 are a supplement for a variable-length
11123 argument list. If trace_redisplay_p is non-zero also printf the
11124 resulting string to stderr. */
11127 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11130 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11133 char *method
= w
->desired_matrix
->method
;
11134 int len
= strlen (method
);
11135 int size
= sizeof w
->desired_matrix
->method
;
11136 int remaining
= size
- len
- 1;
11138 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11139 if (len
&& remaining
)
11142 --remaining
, ++len
;
11145 strncpy (method
+ len
, buffer
, remaining
);
11147 if (trace_redisplay_p
)
11148 fprintf (stderr
, "%p (%s): %s\n",
11150 ((BUFFERP (w
->buffer
)
11151 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11152 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11157 #endif /* GLYPH_DEBUG */
11160 /* Value is non-zero if all changes in window W, which displays
11161 current_buffer, are in the text between START and END. START is a
11162 buffer position, END is given as a distance from Z. Used in
11163 redisplay_internal for display optimization. */
11166 text_outside_line_unchanged_p (struct window
*w
,
11167 EMACS_INT start
, EMACS_INT end
)
11169 int unchanged_p
= 1;
11171 /* If text or overlays have changed, see where. */
11172 if (XFASTINT (w
->last_modified
) < MODIFF
11173 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11175 /* Gap in the line? */
11176 if (GPT
< start
|| Z
- GPT
< end
)
11179 /* Changes start in front of the line, or end after it? */
11181 && (BEG_UNCHANGED
< start
- 1
11182 || END_UNCHANGED
< end
))
11185 /* If selective display, can't optimize if changes start at the
11186 beginning of the line. */
11188 && INTEGERP (BVAR (current_buffer
, selective_display
))
11189 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11190 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11193 /* If there are overlays at the start or end of the line, these
11194 may have overlay strings with newlines in them. A change at
11195 START, for instance, may actually concern the display of such
11196 overlay strings as well, and they are displayed on different
11197 lines. So, quickly rule out this case. (For the future, it
11198 might be desirable to implement something more telling than
11199 just BEG/END_UNCHANGED.) */
11202 if (BEG
+ BEG_UNCHANGED
== start
11203 && overlay_touches_p (start
))
11205 if (END_UNCHANGED
== end
11206 && overlay_touches_p (Z
- end
))
11210 /* Under bidi reordering, adding or deleting a character in the
11211 beginning of a paragraph, before the first strong directional
11212 character, can change the base direction of the paragraph (unless
11213 the buffer specifies a fixed paragraph direction), which will
11214 require to redisplay the whole paragraph. It might be worthwhile
11215 to find the paragraph limits and widen the range of redisplayed
11216 lines to that, but for now just give up this optimization. */
11217 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11218 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11222 return unchanged_p
;
11226 /* Do a frame update, taking possible shortcuts into account. This is
11227 the main external entry point for redisplay.
11229 If the last redisplay displayed an echo area message and that message
11230 is no longer requested, we clear the echo area or bring back the
11231 mini-buffer if that is in use. */
11236 redisplay_internal ();
11241 overlay_arrow_string_or_property (Lisp_Object var
)
11245 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11248 return Voverlay_arrow_string
;
11251 /* Return 1 if there are any overlay-arrows in current_buffer. */
11253 overlay_arrow_in_current_buffer_p (void)
11257 for (vlist
= Voverlay_arrow_variable_list
;
11259 vlist
= XCDR (vlist
))
11261 Lisp_Object var
= XCAR (vlist
);
11264 if (!SYMBOLP (var
))
11266 val
= find_symbol_value (var
);
11268 && current_buffer
== XMARKER (val
)->buffer
)
11275 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11279 overlay_arrows_changed_p (void)
11283 for (vlist
= Voverlay_arrow_variable_list
;
11285 vlist
= XCDR (vlist
))
11287 Lisp_Object var
= XCAR (vlist
);
11288 Lisp_Object val
, pstr
;
11290 if (!SYMBOLP (var
))
11292 val
= find_symbol_value (var
);
11293 if (!MARKERP (val
))
11295 if (! EQ (COERCE_MARKER (val
),
11296 Fget (var
, Qlast_arrow_position
))
11297 || ! (pstr
= overlay_arrow_string_or_property (var
),
11298 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11304 /* Mark overlay arrows to be updated on next redisplay. */
11307 update_overlay_arrows (int up_to_date
)
11311 for (vlist
= Voverlay_arrow_variable_list
;
11313 vlist
= XCDR (vlist
))
11315 Lisp_Object var
= XCAR (vlist
);
11317 if (!SYMBOLP (var
))
11320 if (up_to_date
> 0)
11322 Lisp_Object val
= find_symbol_value (var
);
11323 Fput (var
, Qlast_arrow_position
,
11324 COERCE_MARKER (val
));
11325 Fput (var
, Qlast_arrow_string
,
11326 overlay_arrow_string_or_property (var
));
11328 else if (up_to_date
< 0
11329 || !NILP (Fget (var
, Qlast_arrow_position
)))
11331 Fput (var
, Qlast_arrow_position
, Qt
);
11332 Fput (var
, Qlast_arrow_string
, Qt
);
11338 /* Return overlay arrow string to display at row.
11339 Return integer (bitmap number) for arrow bitmap in left fringe.
11340 Return nil if no overlay arrow. */
11343 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11347 for (vlist
= Voverlay_arrow_variable_list
;
11349 vlist
= XCDR (vlist
))
11351 Lisp_Object var
= XCAR (vlist
);
11354 if (!SYMBOLP (var
))
11357 val
= find_symbol_value (var
);
11360 && current_buffer
== XMARKER (val
)->buffer
11361 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11363 if (FRAME_WINDOW_P (it
->f
)
11364 /* FIXME: if ROW->reversed_p is set, this should test
11365 the right fringe, not the left one. */
11366 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11368 #ifdef HAVE_WINDOW_SYSTEM
11369 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11372 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11373 return make_number (fringe_bitmap
);
11376 return make_number (-1); /* Use default arrow bitmap */
11378 return overlay_arrow_string_or_property (var
);
11385 /* Return 1 if point moved out of or into a composition. Otherwise
11386 return 0. PREV_BUF and PREV_PT are the last point buffer and
11387 position. BUF and PT are the current point buffer and position. */
11390 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11391 struct buffer
*buf
, EMACS_INT pt
)
11393 EMACS_INT start
, end
;
11395 Lisp_Object buffer
;
11397 XSETBUFFER (buffer
, buf
);
11398 /* Check a composition at the last point if point moved within the
11400 if (prev_buf
== buf
)
11403 /* Point didn't move. */
11406 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11407 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11408 && COMPOSITION_VALID_P (start
, end
, prop
)
11409 && start
< prev_pt
&& end
> prev_pt
)
11410 /* The last point was within the composition. Return 1 iff
11411 point moved out of the composition. */
11412 return (pt
<= start
|| pt
>= end
);
11415 /* Check a composition at the current point. */
11416 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11417 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11418 && COMPOSITION_VALID_P (start
, end
, prop
)
11419 && start
< pt
&& end
> pt
);
11423 /* Reconsider the setting of B->clip_changed which is displayed
11427 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11429 if (b
->clip_changed
11430 && !NILP (w
->window_end_valid
)
11431 && w
->current_matrix
->buffer
== b
11432 && w
->current_matrix
->zv
== BUF_ZV (b
)
11433 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11434 b
->clip_changed
= 0;
11436 /* If display wasn't paused, and W is not a tool bar window, see if
11437 point has been moved into or out of a composition. In that case,
11438 we set b->clip_changed to 1 to force updating the screen. If
11439 b->clip_changed has already been set to 1, we can skip this
11441 if (!b
->clip_changed
11442 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11446 if (w
== XWINDOW (selected_window
))
11449 pt
= marker_position (w
->pointm
);
11451 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11452 || pt
!= XINT (w
->last_point
))
11453 && check_point_in_composition (w
->current_matrix
->buffer
,
11454 XINT (w
->last_point
),
11455 XBUFFER (w
->buffer
), pt
))
11456 b
->clip_changed
= 1;
11461 /* Select FRAME to forward the values of frame-local variables into C
11462 variables so that the redisplay routines can access those values
11466 select_frame_for_redisplay (Lisp_Object frame
)
11468 Lisp_Object tail
, tem
;
11469 Lisp_Object old
= selected_frame
;
11470 struct Lisp_Symbol
*sym
;
11472 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11474 selected_frame
= frame
;
11477 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11478 if (CONSP (XCAR (tail
))
11479 && (tem
= XCAR (XCAR (tail
)),
11481 && (sym
= indirect_variable (XSYMBOL (tem
)),
11482 sym
->redirect
== SYMBOL_LOCALIZED
)
11483 && sym
->val
.blv
->frame_local
)
11484 /* Use find_symbol_value rather than Fsymbol_value
11485 to avoid an error if it is void. */
11486 find_symbol_value (tem
);
11487 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11491 #define STOP_POLLING \
11492 do { if (! polling_stopped_here) stop_polling (); \
11493 polling_stopped_here = 1; } while (0)
11495 #define RESUME_POLLING \
11496 do { if (polling_stopped_here) start_polling (); \
11497 polling_stopped_here = 0; } while (0)
11500 /* Perhaps in the future avoid recentering windows if it
11501 is not necessary; currently that causes some problems. */
11504 redisplay_internal (void)
11506 struct window
*w
= XWINDOW (selected_window
);
11510 int must_finish
= 0;
11511 struct text_pos tlbufpos
, tlendpos
;
11512 int number_of_visible_frames
;
11515 int polling_stopped_here
= 0;
11516 Lisp_Object old_frame
= selected_frame
;
11518 /* Non-zero means redisplay has to consider all windows on all
11519 frames. Zero means, only selected_window is considered. */
11520 int consider_all_windows_p
;
11522 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11524 /* No redisplay if running in batch mode or frame is not yet fully
11525 initialized, or redisplay is explicitly turned off by setting
11526 Vinhibit_redisplay. */
11527 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11528 || !NILP (Vinhibit_redisplay
))
11531 /* Don't examine these until after testing Vinhibit_redisplay.
11532 When Emacs is shutting down, perhaps because its connection to
11533 X has dropped, we should not look at them at all. */
11534 fr
= XFRAME (w
->frame
);
11535 sf
= SELECTED_FRAME ();
11537 if (!fr
->glyphs_initialized_p
)
11540 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11541 if (popup_activated ())
11545 /* I don't think this happens but let's be paranoid. */
11546 if (redisplaying_p
)
11549 /* Record a function that resets redisplaying_p to its old value
11550 when we leave this function. */
11551 count
= SPECPDL_INDEX ();
11552 record_unwind_protect (unwind_redisplay
,
11553 Fcons (make_number (redisplaying_p
), selected_frame
));
11555 specbind (Qinhibit_free_realized_faces
, Qnil
);
11558 Lisp_Object tail
, frame
;
11560 FOR_EACH_FRAME (tail
, frame
)
11562 struct frame
*f
= XFRAME (frame
);
11563 f
->already_hscrolled_p
= 0;
11568 /* Remember the currently selected window. */
11571 if (!EQ (old_frame
, selected_frame
)
11572 && FRAME_LIVE_P (XFRAME (old_frame
)))
11573 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11574 selected_frame and selected_window to be temporarily out-of-sync so
11575 when we come back here via `goto retry', we need to resync because we
11576 may need to run Elisp code (via prepare_menu_bars). */
11577 select_frame_for_redisplay (old_frame
);
11580 reconsider_clip_changes (w
, current_buffer
);
11581 last_escape_glyph_frame
= NULL
;
11582 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11583 last_glyphless_glyph_frame
= NULL
;
11584 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11586 /* If new fonts have been loaded that make a glyph matrix adjustment
11587 necessary, do it. */
11588 if (fonts_changed_p
)
11590 adjust_glyphs (NULL
);
11591 ++windows_or_buffers_changed
;
11592 fonts_changed_p
= 0;
11595 /* If face_change_count is non-zero, init_iterator will free all
11596 realized faces, which includes the faces referenced from current
11597 matrices. So, we can't reuse current matrices in this case. */
11598 if (face_change_count
)
11599 ++windows_or_buffers_changed
;
11601 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11602 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11604 /* Since frames on a single ASCII terminal share the same
11605 display area, displaying a different frame means redisplay
11606 the whole thing. */
11607 windows_or_buffers_changed
++;
11608 SET_FRAME_GARBAGED (sf
);
11610 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11612 FRAME_TTY (sf
)->previous_frame
= sf
;
11615 /* Set the visible flags for all frames. Do this before checking
11616 for resized or garbaged frames; they want to know if their frames
11617 are visible. See the comment in frame.h for
11618 FRAME_SAMPLE_VISIBILITY. */
11620 Lisp_Object tail
, frame
;
11622 number_of_visible_frames
= 0;
11624 FOR_EACH_FRAME (tail
, frame
)
11626 struct frame
*f
= XFRAME (frame
);
11628 FRAME_SAMPLE_VISIBILITY (f
);
11629 if (FRAME_VISIBLE_P (f
))
11630 ++number_of_visible_frames
;
11631 clear_desired_matrices (f
);
11635 /* Notice any pending interrupt request to change frame size. */
11636 do_pending_window_change (1);
11638 /* do_pending_window_change could change the selected_window due to
11639 frame resizing which makes the selected window too small. */
11640 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11643 reconsider_clip_changes (w
, current_buffer
);
11646 /* Clear frames marked as garbaged. */
11647 if (frame_garbaged
)
11648 clear_garbaged_frames ();
11650 /* Build menubar and tool-bar items. */
11651 if (NILP (Vmemory_full
))
11652 prepare_menu_bars ();
11654 if (windows_or_buffers_changed
)
11655 update_mode_lines
++;
11657 /* Detect case that we need to write or remove a star in the mode line. */
11658 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11660 w
->update_mode_line
= Qt
;
11661 if (buffer_shared
> 1)
11662 update_mode_lines
++;
11665 /* Avoid invocation of point motion hooks by `current_column' below. */
11666 count1
= SPECPDL_INDEX ();
11667 specbind (Qinhibit_point_motion_hooks
, Qt
);
11669 /* If %c is in the mode line, update it if needed. */
11670 if (!NILP (w
->column_number_displayed
)
11671 /* This alternative quickly identifies a common case
11672 where no change is needed. */
11673 && !(PT
== XFASTINT (w
->last_point
)
11674 && XFASTINT (w
->last_modified
) >= MODIFF
11675 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11676 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11677 w
->update_mode_line
= Qt
;
11679 unbind_to (count1
, Qnil
);
11681 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11683 /* The variable buffer_shared is set in redisplay_window and
11684 indicates that we redisplay a buffer in different windows. See
11686 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11687 || cursor_type_changed
);
11689 /* If specs for an arrow have changed, do thorough redisplay
11690 to ensure we remove any arrow that should no longer exist. */
11691 if (overlay_arrows_changed_p ())
11692 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11694 /* Normally the message* functions will have already displayed and
11695 updated the echo area, but the frame may have been trashed, or
11696 the update may have been preempted, so display the echo area
11697 again here. Checking message_cleared_p captures the case that
11698 the echo area should be cleared. */
11699 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11700 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11701 || (message_cleared_p
11702 && minibuf_level
== 0
11703 /* If the mini-window is currently selected, this means the
11704 echo-area doesn't show through. */
11705 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11707 int window_height_changed_p
= echo_area_display (0);
11710 /* If we don't display the current message, don't clear the
11711 message_cleared_p flag, because, if we did, we wouldn't clear
11712 the echo area in the next redisplay which doesn't preserve
11714 if (!display_last_displayed_message_p
)
11715 message_cleared_p
= 0;
11717 if (fonts_changed_p
)
11719 else if (window_height_changed_p
)
11721 consider_all_windows_p
= 1;
11722 ++update_mode_lines
;
11723 ++windows_or_buffers_changed
;
11725 /* If window configuration was changed, frames may have been
11726 marked garbaged. Clear them or we will experience
11727 surprises wrt scrolling. */
11728 if (frame_garbaged
)
11729 clear_garbaged_frames ();
11732 else if (EQ (selected_window
, minibuf_window
)
11733 && (current_buffer
->clip_changed
11734 || XFASTINT (w
->last_modified
) < MODIFF
11735 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11736 && resize_mini_window (w
, 0))
11738 /* Resized active mini-window to fit the size of what it is
11739 showing if its contents might have changed. */
11741 /* FIXME: this causes all frames to be updated, which seems unnecessary
11742 since only the current frame needs to be considered. This function needs
11743 to be rewritten with two variables, consider_all_windows and
11744 consider_all_frames. */
11745 consider_all_windows_p
= 1;
11746 ++windows_or_buffers_changed
;
11747 ++update_mode_lines
;
11749 /* If window configuration was changed, frames may have been
11750 marked garbaged. Clear them or we will experience
11751 surprises wrt scrolling. */
11752 if (frame_garbaged
)
11753 clear_garbaged_frames ();
11757 /* If showing the region, and mark has changed, we must redisplay
11758 the whole window. The assignment to this_line_start_pos prevents
11759 the optimization directly below this if-statement. */
11760 if (((!NILP (Vtransient_mark_mode
)
11761 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11762 != !NILP (w
->region_showing
))
11763 || (!NILP (w
->region_showing
)
11764 && !EQ (w
->region_showing
,
11765 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11766 CHARPOS (this_line_start_pos
) = 0;
11768 /* Optimize the case that only the line containing the cursor in the
11769 selected window has changed. Variables starting with this_ are
11770 set in display_line and record information about the line
11771 containing the cursor. */
11772 tlbufpos
= this_line_start_pos
;
11773 tlendpos
= this_line_end_pos
;
11774 if (!consider_all_windows_p
11775 && CHARPOS (tlbufpos
) > 0
11776 && NILP (w
->update_mode_line
)
11777 && !current_buffer
->clip_changed
11778 && !current_buffer
->prevent_redisplay_optimizations_p
11779 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11780 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11781 /* Make sure recorded data applies to current buffer, etc. */
11782 && this_line_buffer
== current_buffer
11783 && current_buffer
== XBUFFER (w
->buffer
)
11784 && NILP (w
->force_start
)
11785 && NILP (w
->optional_new_start
)
11786 /* Point must be on the line that we have info recorded about. */
11787 && PT
>= CHARPOS (tlbufpos
)
11788 && PT
<= Z
- CHARPOS (tlendpos
)
11789 /* All text outside that line, including its final newline,
11790 must be unchanged. */
11791 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11792 CHARPOS (tlendpos
)))
11794 if (CHARPOS (tlbufpos
) > BEGV
11795 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11796 && (CHARPOS (tlbufpos
) == ZV
11797 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11798 /* Former continuation line has disappeared by becoming empty. */
11800 else if (XFASTINT (w
->last_modified
) < MODIFF
11801 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11802 || MINI_WINDOW_P (w
))
11804 /* We have to handle the case of continuation around a
11805 wide-column character (see the comment in indent.c around
11808 For instance, in the following case:
11810 -------- Insert --------
11811 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11812 J_I_ ==> J_I_ `^^' are cursors.
11816 As we have to redraw the line above, we cannot use this
11820 int line_height_before
= this_line_pixel_height
;
11822 /* Note that start_display will handle the case that the
11823 line starting at tlbufpos is a continuation line. */
11824 start_display (&it
, w
, tlbufpos
);
11826 /* Implementation note: It this still necessary? */
11827 if (it
.current_x
!= this_line_start_x
)
11830 TRACE ((stderr
, "trying display optimization 1\n"));
11831 w
->cursor
.vpos
= -1;
11832 overlay_arrow_seen
= 0;
11833 it
.vpos
= this_line_vpos
;
11834 it
.current_y
= this_line_y
;
11835 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11836 display_line (&it
);
11838 /* If line contains point, is not continued,
11839 and ends at same distance from eob as before, we win. */
11840 if (w
->cursor
.vpos
>= 0
11841 /* Line is not continued, otherwise this_line_start_pos
11842 would have been set to 0 in display_line. */
11843 && CHARPOS (this_line_start_pos
)
11844 /* Line ends as before. */
11845 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11846 /* Line has same height as before. Otherwise other lines
11847 would have to be shifted up or down. */
11848 && this_line_pixel_height
== line_height_before
)
11850 /* If this is not the window's last line, we must adjust
11851 the charstarts of the lines below. */
11852 if (it
.current_y
< it
.last_visible_y
)
11854 struct glyph_row
*row
11855 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11856 EMACS_INT delta
, delta_bytes
;
11858 /* We used to distinguish between two cases here,
11859 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11860 when the line ends in a newline or the end of the
11861 buffer's accessible portion. But both cases did
11862 the same, so they were collapsed. */
11864 - CHARPOS (tlendpos
)
11865 - MATRIX_ROW_START_CHARPOS (row
));
11866 delta_bytes
= (Z_BYTE
11867 - BYTEPOS (tlendpos
)
11868 - MATRIX_ROW_START_BYTEPOS (row
));
11870 increment_matrix_positions (w
->current_matrix
,
11871 this_line_vpos
+ 1,
11872 w
->current_matrix
->nrows
,
11873 delta
, delta_bytes
);
11876 /* If this row displays text now but previously didn't,
11877 or vice versa, w->window_end_vpos may have to be
11879 if ((it
.glyph_row
- 1)->displays_text_p
)
11881 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11882 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11884 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11885 && this_line_vpos
> 0)
11886 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11887 w
->window_end_valid
= Qnil
;
11889 /* Update hint: No need to try to scroll in update_window. */
11890 w
->desired_matrix
->no_scrolling_p
= 1;
11893 *w
->desired_matrix
->method
= 0;
11894 debug_method_add (w
, "optimization 1");
11896 #ifdef HAVE_WINDOW_SYSTEM
11897 update_window_fringes (w
, 0);
11904 else if (/* Cursor position hasn't changed. */
11905 PT
== XFASTINT (w
->last_point
)
11906 /* Make sure the cursor was last displayed
11907 in this window. Otherwise we have to reposition it. */
11908 && 0 <= w
->cursor
.vpos
11909 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11913 do_pending_window_change (1);
11914 /* If selected_window changed, redisplay again. */
11915 if (WINDOWP (selected_window
)
11916 && (w
= XWINDOW (selected_window
)) != sw
)
11919 /* We used to always goto end_of_redisplay here, but this
11920 isn't enough if we have a blinking cursor. */
11921 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11922 goto end_of_redisplay
;
11926 /* If highlighting the region, or if the cursor is in the echo area,
11927 then we can't just move the cursor. */
11928 else if (! (!NILP (Vtransient_mark_mode
)
11929 && !NILP (BVAR (current_buffer
, mark_active
)))
11930 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11931 || highlight_nonselected_windows
)
11932 && NILP (w
->region_showing
)
11933 && NILP (Vshow_trailing_whitespace
)
11934 && !cursor_in_echo_area
)
11937 struct glyph_row
*row
;
11939 /* Skip from tlbufpos to PT and see where it is. Note that
11940 PT may be in invisible text. If so, we will end at the
11941 next visible position. */
11942 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11943 NULL
, DEFAULT_FACE_ID
);
11944 it
.current_x
= this_line_start_x
;
11945 it
.current_y
= this_line_y
;
11946 it
.vpos
= this_line_vpos
;
11948 /* The call to move_it_to stops in front of PT, but
11949 moves over before-strings. */
11950 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11952 if (it
.vpos
== this_line_vpos
11953 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11956 xassert (this_line_vpos
== it
.vpos
);
11957 xassert (this_line_y
== it
.current_y
);
11958 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11960 *w
->desired_matrix
->method
= 0;
11961 debug_method_add (w
, "optimization 3");
11970 /* Text changed drastically or point moved off of line. */
11971 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11974 CHARPOS (this_line_start_pos
) = 0;
11975 consider_all_windows_p
|= buffer_shared
> 1;
11976 ++clear_face_cache_count
;
11977 #ifdef HAVE_WINDOW_SYSTEM
11978 ++clear_image_cache_count
;
11981 /* Build desired matrices, and update the display. If
11982 consider_all_windows_p is non-zero, do it for all windows on all
11983 frames. Otherwise do it for selected_window, only. */
11985 if (consider_all_windows_p
)
11987 Lisp_Object tail
, frame
;
11989 FOR_EACH_FRAME (tail
, frame
)
11990 XFRAME (frame
)->updated_p
= 0;
11992 /* Recompute # windows showing selected buffer. This will be
11993 incremented each time such a window is displayed. */
11996 FOR_EACH_FRAME (tail
, frame
)
11998 struct frame
*f
= XFRAME (frame
);
12000 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12002 if (! EQ (frame
, selected_frame
))
12003 /* Select the frame, for the sake of frame-local
12005 select_frame_for_redisplay (frame
);
12007 /* Mark all the scroll bars to be removed; we'll redeem
12008 the ones we want when we redisplay their windows. */
12009 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12010 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12012 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12013 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12015 /* The X error handler may have deleted that frame. */
12016 if (!FRAME_LIVE_P (f
))
12019 /* Any scroll bars which redisplay_windows should have
12020 nuked should now go away. */
12021 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12022 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12024 /* If fonts changed, display again. */
12025 /* ??? rms: I suspect it is a mistake to jump all the way
12026 back to retry here. It should just retry this frame. */
12027 if (fonts_changed_p
)
12030 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12032 /* See if we have to hscroll. */
12033 if (!f
->already_hscrolled_p
)
12035 f
->already_hscrolled_p
= 1;
12036 if (hscroll_windows (f
->root_window
))
12040 /* Prevent various kinds of signals during display
12041 update. stdio is not robust about handling
12042 signals, which can cause an apparent I/O
12044 if (interrupt_input
)
12045 unrequest_sigio ();
12048 /* Update the display. */
12049 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12050 pending
|= update_frame (f
, 0, 0);
12056 if (!EQ (old_frame
, selected_frame
)
12057 && FRAME_LIVE_P (XFRAME (old_frame
)))
12058 /* We played a bit fast-and-loose above and allowed selected_frame
12059 and selected_window to be temporarily out-of-sync but let's make
12060 sure this stays contained. */
12061 select_frame_for_redisplay (old_frame
);
12062 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12066 /* Do the mark_window_display_accurate after all windows have
12067 been redisplayed because this call resets flags in buffers
12068 which are needed for proper redisplay. */
12069 FOR_EACH_FRAME (tail
, frame
)
12071 struct frame
*f
= XFRAME (frame
);
12074 mark_window_display_accurate (f
->root_window
, 1);
12075 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12076 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12081 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12083 Lisp_Object mini_window
;
12084 struct frame
*mini_frame
;
12086 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12087 /* Use list_of_error, not Qerror, so that
12088 we catch only errors and don't run the debugger. */
12089 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12091 redisplay_window_error
);
12093 /* Compare desired and current matrices, perform output. */
12096 /* If fonts changed, display again. */
12097 if (fonts_changed_p
)
12100 /* Prevent various kinds of signals during display update.
12101 stdio is not robust about handling signals,
12102 which can cause an apparent I/O error. */
12103 if (interrupt_input
)
12104 unrequest_sigio ();
12107 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12109 if (hscroll_windows (selected_window
))
12112 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12113 pending
= update_frame (sf
, 0, 0);
12116 /* We may have called echo_area_display at the top of this
12117 function. If the echo area is on another frame, that may
12118 have put text on a frame other than the selected one, so the
12119 above call to update_frame would not have caught it. Catch
12121 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12122 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12124 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12126 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12127 pending
|= update_frame (mini_frame
, 0, 0);
12128 if (!pending
&& hscroll_windows (mini_window
))
12133 /* If display was paused because of pending input, make sure we do a
12134 thorough update the next time. */
12137 /* Prevent the optimization at the beginning of
12138 redisplay_internal that tries a single-line update of the
12139 line containing the cursor in the selected window. */
12140 CHARPOS (this_line_start_pos
) = 0;
12142 /* Let the overlay arrow be updated the next time. */
12143 update_overlay_arrows (0);
12145 /* If we pause after scrolling, some rows in the current
12146 matrices of some windows are not valid. */
12147 if (!WINDOW_FULL_WIDTH_P (w
)
12148 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12149 update_mode_lines
= 1;
12153 if (!consider_all_windows_p
)
12155 /* This has already been done above if
12156 consider_all_windows_p is set. */
12157 mark_window_display_accurate_1 (w
, 1);
12159 /* Say overlay arrows are up to date. */
12160 update_overlay_arrows (1);
12162 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12163 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12166 update_mode_lines
= 0;
12167 windows_or_buffers_changed
= 0;
12168 cursor_type_changed
= 0;
12171 /* Start SIGIO interrupts coming again. Having them off during the
12172 code above makes it less likely one will discard output, but not
12173 impossible, since there might be stuff in the system buffer here.
12174 But it is much hairier to try to do anything about that. */
12175 if (interrupt_input
)
12179 /* If a frame has become visible which was not before, redisplay
12180 again, so that we display it. Expose events for such a frame
12181 (which it gets when becoming visible) don't call the parts of
12182 redisplay constructing glyphs, so simply exposing a frame won't
12183 display anything in this case. So, we have to display these
12184 frames here explicitly. */
12187 Lisp_Object tail
, frame
;
12190 FOR_EACH_FRAME (tail
, frame
)
12192 int this_is_visible
= 0;
12194 if (XFRAME (frame
)->visible
)
12195 this_is_visible
= 1;
12196 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12197 if (XFRAME (frame
)->visible
)
12198 this_is_visible
= 1;
12200 if (this_is_visible
)
12204 if (new_count
!= number_of_visible_frames
)
12205 windows_or_buffers_changed
++;
12208 /* Change frame size now if a change is pending. */
12209 do_pending_window_change (1);
12211 /* If we just did a pending size change, or have additional
12212 visible frames, or selected_window changed, redisplay again. */
12213 if ((windows_or_buffers_changed
&& !pending
)
12214 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12217 /* Clear the face and image caches.
12219 We used to do this only if consider_all_windows_p. But the cache
12220 needs to be cleared if a timer creates images in the current
12221 buffer (e.g. the test case in Bug#6230). */
12223 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12225 clear_face_cache (0);
12226 clear_face_cache_count
= 0;
12229 #ifdef HAVE_WINDOW_SYSTEM
12230 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12232 clear_image_caches (Qnil
);
12233 clear_image_cache_count
= 0;
12235 #endif /* HAVE_WINDOW_SYSTEM */
12238 unbind_to (count
, Qnil
);
12243 /* Redisplay, but leave alone any recent echo area message unless
12244 another message has been requested in its place.
12246 This is useful in situations where you need to redisplay but no
12247 user action has occurred, making it inappropriate for the message
12248 area to be cleared. See tracking_off and
12249 wait_reading_process_output for examples of these situations.
12251 FROM_WHERE is an integer saying from where this function was
12252 called. This is useful for debugging. */
12255 redisplay_preserve_echo_area (int from_where
)
12257 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12259 if (!NILP (echo_area_buffer
[1]))
12261 /* We have a previously displayed message, but no current
12262 message. Redisplay the previous message. */
12263 display_last_displayed_message_p
= 1;
12264 redisplay_internal ();
12265 display_last_displayed_message_p
= 0;
12268 redisplay_internal ();
12270 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12271 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12272 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12276 /* Function registered with record_unwind_protect in
12277 redisplay_internal. Reset redisplaying_p to the value it had
12278 before redisplay_internal was called, and clear
12279 prevent_freeing_realized_faces_p. It also selects the previously
12280 selected frame, unless it has been deleted (by an X connection
12281 failure during redisplay, for example). */
12284 unwind_redisplay (Lisp_Object val
)
12286 Lisp_Object old_redisplaying_p
, old_frame
;
12288 old_redisplaying_p
= XCAR (val
);
12289 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12290 old_frame
= XCDR (val
);
12291 if (! EQ (old_frame
, selected_frame
)
12292 && FRAME_LIVE_P (XFRAME (old_frame
)))
12293 select_frame_for_redisplay (old_frame
);
12298 /* Mark the display of window W as accurate or inaccurate. If
12299 ACCURATE_P is non-zero mark display of W as accurate. If
12300 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12301 redisplay_internal is called. */
12304 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12306 if (BUFFERP (w
->buffer
))
12308 struct buffer
*b
= XBUFFER (w
->buffer
);
12311 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12312 w
->last_overlay_modified
12313 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12315 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12319 b
->clip_changed
= 0;
12320 b
->prevent_redisplay_optimizations_p
= 0;
12322 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12323 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12324 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12325 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12327 w
->current_matrix
->buffer
= b
;
12328 w
->current_matrix
->begv
= BUF_BEGV (b
);
12329 w
->current_matrix
->zv
= BUF_ZV (b
);
12331 w
->last_cursor
= w
->cursor
;
12332 w
->last_cursor_off_p
= w
->cursor_off_p
;
12334 if (w
== XWINDOW (selected_window
))
12335 w
->last_point
= make_number (BUF_PT (b
));
12337 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12343 w
->window_end_valid
= w
->buffer
;
12344 w
->update_mode_line
= Qnil
;
12349 /* Mark the display of windows in the window tree rooted at WINDOW as
12350 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12351 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12352 be redisplayed the next time redisplay_internal is called. */
12355 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12359 for (; !NILP (window
); window
= w
->next
)
12361 w
= XWINDOW (window
);
12362 mark_window_display_accurate_1 (w
, accurate_p
);
12364 if (!NILP (w
->vchild
))
12365 mark_window_display_accurate (w
->vchild
, accurate_p
);
12366 if (!NILP (w
->hchild
))
12367 mark_window_display_accurate (w
->hchild
, accurate_p
);
12372 update_overlay_arrows (1);
12376 /* Force a thorough redisplay the next time by setting
12377 last_arrow_position and last_arrow_string to t, which is
12378 unequal to any useful value of Voverlay_arrow_... */
12379 update_overlay_arrows (-1);
12384 /* Return value in display table DP (Lisp_Char_Table *) for character
12385 C. Since a display table doesn't have any parent, we don't have to
12386 follow parent. Do not call this function directly but use the
12387 macro DISP_CHAR_VECTOR. */
12390 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12394 if (ASCII_CHAR_P (c
))
12397 if (SUB_CHAR_TABLE_P (val
))
12398 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12404 XSETCHAR_TABLE (table
, dp
);
12405 val
= char_table_ref (table
, c
);
12414 /***********************************************************************
12416 ***********************************************************************/
12418 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12421 redisplay_windows (Lisp_Object window
)
12423 while (!NILP (window
))
12425 struct window
*w
= XWINDOW (window
);
12427 if (!NILP (w
->hchild
))
12428 redisplay_windows (w
->hchild
);
12429 else if (!NILP (w
->vchild
))
12430 redisplay_windows (w
->vchild
);
12431 else if (!NILP (w
->buffer
))
12433 displayed_buffer
= XBUFFER (w
->buffer
);
12434 /* Use list_of_error, not Qerror, so that
12435 we catch only errors and don't run the debugger. */
12436 internal_condition_case_1 (redisplay_window_0
, window
,
12438 redisplay_window_error
);
12446 redisplay_window_error (Lisp_Object ignore
)
12448 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12453 redisplay_window_0 (Lisp_Object window
)
12455 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12456 redisplay_window (window
, 0);
12461 redisplay_window_1 (Lisp_Object window
)
12463 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12464 redisplay_window (window
, 1);
12469 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12470 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12471 which positions recorded in ROW differ from current buffer
12474 Return 0 if cursor is not on this row, 1 otherwise. */
12477 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12478 struct glyph_matrix
*matrix
,
12479 EMACS_INT delta
, EMACS_INT delta_bytes
,
12482 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12483 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12484 struct glyph
*cursor
= NULL
;
12485 /* The last known character position in row. */
12486 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12488 EMACS_INT pt_old
= PT
- delta
;
12489 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12490 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12491 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12492 /* A glyph beyond the edge of TEXT_AREA which we should never
12494 struct glyph
*glyphs_end
= end
;
12495 /* Non-zero means we've found a match for cursor position, but that
12496 glyph has the avoid_cursor_p flag set. */
12497 int match_with_avoid_cursor
= 0;
12498 /* Non-zero means we've seen at least one glyph that came from a
12500 int string_seen
= 0;
12501 /* Largest and smalles buffer positions seen so far during scan of
12503 EMACS_INT bpos_max
= pos_before
;
12504 EMACS_INT bpos_min
= pos_after
;
12505 /* Last buffer position covered by an overlay string with an integer
12506 `cursor' property. */
12507 EMACS_INT bpos_covered
= 0;
12509 /* Skip over glyphs not having an object at the start and the end of
12510 the row. These are special glyphs like truncation marks on
12511 terminal frames. */
12512 if (row
->displays_text_p
)
12514 if (!row
->reversed_p
)
12517 && INTEGERP (glyph
->object
)
12518 && glyph
->charpos
< 0)
12520 x
+= glyph
->pixel_width
;
12524 && INTEGERP ((end
- 1)->object
)
12525 /* CHARPOS is zero for blanks and stretch glyphs
12526 inserted by extend_face_to_end_of_line. */
12527 && (end
- 1)->charpos
<= 0)
12529 glyph_before
= glyph
- 1;
12536 /* If the glyph row is reversed, we need to process it from back
12537 to front, so swap the edge pointers. */
12538 glyphs_end
= end
= glyph
- 1;
12539 glyph
+= row
->used
[TEXT_AREA
] - 1;
12541 while (glyph
> end
+ 1
12542 && INTEGERP (glyph
->object
)
12543 && glyph
->charpos
< 0)
12546 x
-= glyph
->pixel_width
;
12548 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12550 /* By default, in reversed rows we put the cursor on the
12551 rightmost (first in the reading order) glyph. */
12552 for (g
= end
+ 1; g
< glyph
; g
++)
12553 x
+= g
->pixel_width
;
12555 && INTEGERP ((end
+ 1)->object
)
12556 && (end
+ 1)->charpos
<= 0)
12558 glyph_before
= glyph
+ 1;
12562 else if (row
->reversed_p
)
12564 /* In R2L rows that don't display text, put the cursor on the
12565 rightmost glyph. Case in point: an empty last line that is
12566 part of an R2L paragraph. */
12568 /* Avoid placing the cursor on the last glyph of the row, where
12569 on terminal frames we hold the vertical border between
12570 adjacent windows. */
12571 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12572 && !WINDOW_RIGHTMOST_P (w
)
12573 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12575 x
= -1; /* will be computed below, at label compute_x */
12578 /* Step 1: Try to find the glyph whose character position
12579 corresponds to point. If that's not possible, find 2 glyphs
12580 whose character positions are the closest to point, one before
12581 point, the other after it. */
12582 if (!row
->reversed_p
)
12583 while (/* not marched to end of glyph row */
12585 /* glyph was not inserted by redisplay for internal purposes */
12586 && !INTEGERP (glyph
->object
))
12588 if (BUFFERP (glyph
->object
))
12590 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12592 if (glyph
->charpos
> bpos_max
)
12593 bpos_max
= glyph
->charpos
;
12594 if (glyph
->charpos
< bpos_min
)
12595 bpos_min
= glyph
->charpos
;
12596 if (!glyph
->avoid_cursor_p
)
12598 /* If we hit point, we've found the glyph on which to
12599 display the cursor. */
12602 match_with_avoid_cursor
= 0;
12605 /* See if we've found a better approximation to
12606 POS_BEFORE or to POS_AFTER. Note that we want the
12607 first (leftmost) glyph of all those that are the
12608 closest from below, and the last (rightmost) of all
12609 those from above. */
12610 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12612 pos_before
= glyph
->charpos
;
12613 glyph_before
= glyph
;
12615 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12617 pos_after
= glyph
->charpos
;
12618 glyph_after
= glyph
;
12621 else if (dpos
== 0)
12622 match_with_avoid_cursor
= 1;
12624 else if (STRINGP (glyph
->object
))
12626 Lisp_Object chprop
;
12627 EMACS_INT glyph_pos
= glyph
->charpos
;
12629 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12631 if (INTEGERP (chprop
))
12633 bpos_covered
= bpos_max
+ XINT (chprop
);
12634 /* If the `cursor' property covers buffer positions up
12635 to and including point, we should display cursor on
12636 this glyph. Note that overlays and text properties
12637 with string values stop bidi reordering, so every
12638 buffer position to the left of the string is always
12639 smaller than any position to the right of the
12640 string. Therefore, if a `cursor' property on one
12641 of the string's characters has an integer value, we
12642 will break out of the loop below _before_ we get to
12643 the position match above. IOW, integer values of
12644 the `cursor' property override the "exact match for
12645 point" strategy of positioning the cursor. */
12646 /* Implementation note: bpos_max == pt_old when, e.g.,
12647 we are in an empty line, where bpos_max is set to
12648 MATRIX_ROW_START_CHARPOS, see above. */
12649 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12658 x
+= glyph
->pixel_width
;
12661 else if (glyph
> end
) /* row is reversed */
12662 while (!INTEGERP (glyph
->object
))
12664 if (BUFFERP (glyph
->object
))
12666 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12668 if (glyph
->charpos
> bpos_max
)
12669 bpos_max
= glyph
->charpos
;
12670 if (glyph
->charpos
< bpos_min
)
12671 bpos_min
= glyph
->charpos
;
12672 if (!glyph
->avoid_cursor_p
)
12676 match_with_avoid_cursor
= 0;
12679 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12681 pos_before
= glyph
->charpos
;
12682 glyph_before
= glyph
;
12684 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12686 pos_after
= glyph
->charpos
;
12687 glyph_after
= glyph
;
12690 else if (dpos
== 0)
12691 match_with_avoid_cursor
= 1;
12693 else if (STRINGP (glyph
->object
))
12695 Lisp_Object chprop
;
12696 EMACS_INT glyph_pos
= glyph
->charpos
;
12698 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12700 if (INTEGERP (chprop
))
12702 bpos_covered
= bpos_max
+ XINT (chprop
);
12703 /* If the `cursor' property covers buffer positions up
12704 to and including point, we should display cursor on
12706 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12715 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12717 x
--; /* can't use any pixel_width */
12720 x
-= glyph
->pixel_width
;
12723 /* Step 2: If we didn't find an exact match for point, we need to
12724 look for a proper place to put the cursor among glyphs between
12725 GLYPH_BEFORE and GLYPH_AFTER. */
12726 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12727 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12728 && bpos_covered
< pt_old
)
12730 /* An empty line has a single glyph whose OBJECT is zero and
12731 whose CHARPOS is the position of a newline on that line.
12732 Note that on a TTY, there are more glyphs after that, which
12733 were produced by extend_face_to_end_of_line, but their
12734 CHARPOS is zero or negative. */
12736 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12737 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12739 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12741 EMACS_INT ellipsis_pos
;
12743 /* Scan back over the ellipsis glyphs. */
12744 if (!row
->reversed_p
)
12746 ellipsis_pos
= (glyph
- 1)->charpos
;
12747 while (glyph
> row
->glyphs
[TEXT_AREA
]
12748 && (glyph
- 1)->charpos
== ellipsis_pos
)
12749 glyph
--, x
-= glyph
->pixel_width
;
12750 /* That loop always goes one position too far, including
12751 the glyph before the ellipsis. So scan forward over
12753 x
+= glyph
->pixel_width
;
12756 else /* row is reversed */
12758 ellipsis_pos
= (glyph
+ 1)->charpos
;
12759 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12760 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12761 glyph
++, x
+= glyph
->pixel_width
;
12762 x
-= glyph
->pixel_width
;
12766 else if (match_with_avoid_cursor
12767 /* A truncated row may not include PT among its
12768 character positions. Setting the cursor inside the
12769 scroll margin will trigger recalculation of hscroll
12770 in hscroll_window_tree. */
12771 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12772 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12773 /* Zero-width characters produce no glyphs. */
12776 && (row
->reversed_p
12777 ? glyph_after
> glyphs_end
12778 : glyph_after
< glyphs_end
)))
12780 cursor
= glyph_after
;
12783 else if (string_seen
)
12785 int incr
= row
->reversed_p
? -1 : +1;
12787 /* Need to find the glyph that came out of a string which is
12788 present at point. That glyph is somewhere between
12789 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12790 positioned between POS_BEFORE and POS_AFTER in the
12792 struct glyph
*start
, *stop
;
12793 EMACS_INT pos
= pos_before
;
12797 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
12798 correspond to POS_BEFORE and POS_AFTER, respectively. We
12799 need START and STOP in the order that corresponds to the
12800 row's direction as given by its reversed_p flag. If the
12801 directionality of characters between POS_BEFORE and
12802 POS_AFTER is the opposite of the row's base direction,
12803 these characters will have been reordered for display,
12804 and we need to reverse START and STOP. */
12805 if (!row
->reversed_p
)
12807 start
= min (glyph_before
, glyph_after
);
12808 stop
= max (glyph_before
, glyph_after
);
12812 start
= max (glyph_before
, glyph_after
);
12813 stop
= min (glyph_before
, glyph_after
);
12815 for (glyph
= start
+ incr
;
12816 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12819 /* Any glyphs that come from the buffer are here because
12820 of bidi reordering. Skip them, and only pay
12821 attention to glyphs that came from some string. */
12822 if (STRINGP (glyph
->object
))
12827 str
= glyph
->object
;
12828 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12829 if (tem
== 0 /* from overlay */
12832 /* If the string from which this glyph came is
12833 found in the buffer at point, then we've
12834 found the glyph we've been looking for. If
12835 it comes from an overlay (tem == 0), and it
12836 has the `cursor' property on one of its
12837 glyphs, record that glyph as a candidate for
12838 displaying the cursor. (As in the
12839 unidirectional version, we will display the
12840 cursor on the last candidate we find.) */
12841 if (tem
== 0 || tem
== pt_old
)
12843 /* The glyphs from this string could have
12844 been reordered. Find the one with the
12845 smallest string position. Or there could
12846 be a character in the string with the
12847 `cursor' property, which means display
12848 cursor on that character's glyph. */
12849 EMACS_INT strpos
= glyph
->charpos
;
12854 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12855 && EQ (glyph
->object
, str
);
12859 EMACS_INT gpos
= glyph
->charpos
;
12861 cprop
= Fget_char_property (make_number (gpos
),
12869 if (tem
&& glyph
->charpos
< strpos
)
12871 strpos
= glyph
->charpos
;
12880 pos
= tem
+ 1; /* don't find previous instances */
12882 /* This string is not what we want; skip all of the
12883 glyphs that came from it. */
12884 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12885 && EQ (glyph
->object
, str
))
12892 /* If we reached the end of the line, and END was from a string,
12893 the cursor is not on this line. */
12895 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12896 && STRINGP (end
->object
)
12897 && row
->continued_p
)
12903 if (cursor
!= NULL
)
12909 /* Need to compute x that corresponds to GLYPH. */
12910 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12912 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12914 x
+= g
->pixel_width
;
12918 /* ROW could be part of a continued line, which, under bidi
12919 reordering, might have other rows whose start and end charpos
12920 occlude point. Only set w->cursor if we found a better
12921 approximation to the cursor position than we have from previously
12922 examined candidate rows belonging to the same continued line. */
12923 if (/* we already have a candidate row */
12924 w
->cursor
.vpos
>= 0
12925 /* that candidate is not the row we are processing */
12926 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12927 /* the row we are processing is part of a continued line */
12928 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12929 /* Make sure cursor.vpos specifies a row whose start and end
12930 charpos occlude point. This is because some callers of this
12931 function leave cursor.vpos at the row where the cursor was
12932 displayed during the last redisplay cycle. */
12933 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12934 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12937 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12939 /* Don't consider glyphs that are outside TEXT_AREA. */
12940 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12942 /* Keep the candidate whose buffer position is the closest to
12944 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12945 w
->cursor
.hpos
>= 0
12946 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12947 && BUFFERP (g1
->object
)
12948 && (g1
->charpos
== pt_old
/* an exact match always wins */
12949 || (BUFFERP (glyph
->object
)
12950 && eabs (g1
->charpos
- pt_old
)
12951 < eabs (glyph
->charpos
- pt_old
))))
12953 /* If this candidate gives an exact match, use that. */
12954 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12955 /* Otherwise, keep the candidate that comes from a row
12956 spanning less buffer positions. This may win when one or
12957 both candidate positions are on glyphs that came from
12958 display strings, for which we cannot compare buffer
12960 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12961 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12962 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12965 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12967 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12968 w
->cursor
.y
= row
->y
+ dy
;
12970 if (w
== XWINDOW (selected_window
))
12972 if (!row
->continued_p
12973 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12976 this_line_buffer
= XBUFFER (w
->buffer
);
12978 CHARPOS (this_line_start_pos
)
12979 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12980 BYTEPOS (this_line_start_pos
)
12981 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12983 CHARPOS (this_line_end_pos
)
12984 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12985 BYTEPOS (this_line_end_pos
)
12986 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12988 this_line_y
= w
->cursor
.y
;
12989 this_line_pixel_height
= row
->height
;
12990 this_line_vpos
= w
->cursor
.vpos
;
12991 this_line_start_x
= row
->x
;
12994 CHARPOS (this_line_start_pos
) = 0;
13001 /* Run window scroll functions, if any, for WINDOW with new window
13002 start STARTP. Sets the window start of WINDOW to that position.
13004 We assume that the window's buffer is really current. */
13006 static inline struct text_pos
13007 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13009 struct window
*w
= XWINDOW (window
);
13010 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13012 if (current_buffer
!= XBUFFER (w
->buffer
))
13015 if (!NILP (Vwindow_scroll_functions
))
13017 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13018 make_number (CHARPOS (startp
)));
13019 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13020 /* In case the hook functions switch buffers. */
13021 if (current_buffer
!= XBUFFER (w
->buffer
))
13022 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13029 /* Make sure the line containing the cursor is fully visible.
13030 A value of 1 means there is nothing to be done.
13031 (Either the line is fully visible, or it cannot be made so,
13032 or we cannot tell.)
13034 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13035 is higher than window.
13037 A value of 0 means the caller should do scrolling
13038 as if point had gone off the screen. */
13041 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13043 struct glyph_matrix
*matrix
;
13044 struct glyph_row
*row
;
13047 if (!make_cursor_line_fully_visible_p
)
13050 /* It's not always possible to find the cursor, e.g, when a window
13051 is full of overlay strings. Don't do anything in that case. */
13052 if (w
->cursor
.vpos
< 0)
13055 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13056 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13058 /* If the cursor row is not partially visible, there's nothing to do. */
13059 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13062 /* If the row the cursor is in is taller than the window's height,
13063 it's not clear what to do, so do nothing. */
13064 window_height
= window_box_height (w
);
13065 if (row
->height
>= window_height
)
13067 if (!force_p
|| MINI_WINDOW_P (w
)
13068 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13075 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13076 non-zero means only WINDOW is redisplayed in redisplay_internal.
13077 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13078 in redisplay_window to bring a partially visible line into view in
13079 the case that only the cursor has moved.
13081 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13082 last screen line's vertical height extends past the end of the screen.
13086 1 if scrolling succeeded
13088 0 if scrolling didn't find point.
13090 -1 if new fonts have been loaded so that we must interrupt
13091 redisplay, adjust glyph matrices, and try again. */
13097 SCROLLING_NEED_LARGER_MATRICES
13100 /* If scroll-conservatively is more than this, never recenter.
13102 If you change this, don't forget to update the doc string of
13103 `scroll-conservatively' and the Emacs manual. */
13104 #define SCROLL_LIMIT 100
13107 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13108 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13109 int temp_scroll_step
, int last_line_misfit
)
13111 struct window
*w
= XWINDOW (window
);
13112 struct frame
*f
= XFRAME (w
->frame
);
13113 struct text_pos pos
, startp
;
13115 int this_scroll_margin
, scroll_max
, rc
, height
;
13116 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13117 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13118 Lisp_Object aggressive
;
13119 /* We will never try scrolling more than this number of lines. */
13120 int scroll_limit
= SCROLL_LIMIT
;
13123 debug_method_add (w
, "try_scrolling");
13126 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13128 /* Compute scroll margin height in pixels. We scroll when point is
13129 within this distance from the top or bottom of the window. */
13130 if (scroll_margin
> 0)
13131 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13132 * FRAME_LINE_HEIGHT (f
);
13134 this_scroll_margin
= 0;
13136 /* Force arg_scroll_conservatively to have a reasonable value, to
13137 avoid scrolling too far away with slow move_it_* functions. Note
13138 that the user can supply scroll-conservatively equal to
13139 `most-positive-fixnum', which can be larger than INT_MAX. */
13140 if (arg_scroll_conservatively
> scroll_limit
)
13142 arg_scroll_conservatively
= scroll_limit
+ 1;
13143 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13145 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13146 /* Compute how much we should try to scroll maximally to bring
13147 point into view. */
13148 scroll_max
= (max (scroll_step
,
13149 max (arg_scroll_conservatively
, temp_scroll_step
))
13150 * FRAME_LINE_HEIGHT (f
));
13151 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13152 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13153 /* We're trying to scroll because of aggressive scrolling but no
13154 scroll_step is set. Choose an arbitrary one. */
13155 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13161 /* Decide whether to scroll down. */
13162 if (PT
> CHARPOS (startp
))
13164 int scroll_margin_y
;
13166 /* Compute the pixel ypos of the scroll margin, then move it to
13167 either that ypos or PT, whichever comes first. */
13168 start_display (&it
, w
, startp
);
13169 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13170 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13171 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13172 (MOVE_TO_POS
| MOVE_TO_Y
));
13174 if (PT
> CHARPOS (it
.current
.pos
))
13176 int y0
= line_bottom_y (&it
);
13177 /* Compute how many pixels below window bottom to stop searching
13178 for PT. This avoids costly search for PT that is far away if
13179 the user limited scrolling by a small number of lines, but
13180 always finds PT if scroll_conservatively is set to a large
13181 number, such as most-positive-fixnum. */
13182 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13183 int y_to_move
= it
.last_visible_y
+ slack
;
13185 /* Compute the distance from the scroll margin to PT or to
13186 the scroll limit, whichever comes first. This should
13187 include the height of the cursor line, to make that line
13189 move_it_to (&it
, PT
, -1, y_to_move
,
13190 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13191 dy
= line_bottom_y (&it
) - y0
;
13193 if (dy
> scroll_max
)
13194 return SCROLLING_FAILED
;
13202 /* Point is in or below the bottom scroll margin, so move the
13203 window start down. If scrolling conservatively, move it just
13204 enough down to make point visible. If scroll_step is set,
13205 move it down by scroll_step. */
13206 if (arg_scroll_conservatively
)
13208 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13209 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13210 else if (scroll_step
|| temp_scroll_step
)
13211 amount_to_scroll
= scroll_max
;
13214 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13215 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13216 if (NUMBERP (aggressive
))
13218 double float_amount
= XFLOATINT (aggressive
) * height
;
13219 amount_to_scroll
= float_amount
;
13220 if (amount_to_scroll
== 0 && float_amount
> 0)
13221 amount_to_scroll
= 1;
13222 /* Don't let point enter the scroll margin near top of
13224 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13225 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13229 if (amount_to_scroll
<= 0)
13230 return SCROLLING_FAILED
;
13232 start_display (&it
, w
, startp
);
13233 if (arg_scroll_conservatively
<= scroll_limit
)
13234 move_it_vertically (&it
, amount_to_scroll
);
13237 /* Extra precision for users who set scroll-conservatively
13238 to a large number: make sure the amount we scroll
13239 the window start is never less than amount_to_scroll,
13240 which was computed as distance from window bottom to
13241 point. This matters when lines at window top and lines
13242 below window bottom have different height. */
13243 struct it it1
= it
;
13244 /* We use a temporary it1 because line_bottom_y can modify
13245 its argument, if it moves one line down; see there. */
13246 int start_y
= line_bottom_y (&it1
);
13249 move_it_by_lines (&it
, 1);
13251 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13254 /* If STARTP is unchanged, move it down another screen line. */
13255 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13256 move_it_by_lines (&it
, 1);
13257 startp
= it
.current
.pos
;
13261 struct text_pos scroll_margin_pos
= startp
;
13263 /* See if point is inside the scroll margin at the top of the
13265 if (this_scroll_margin
)
13267 start_display (&it
, w
, startp
);
13268 move_it_vertically (&it
, this_scroll_margin
);
13269 scroll_margin_pos
= it
.current
.pos
;
13272 if (PT
< CHARPOS (scroll_margin_pos
))
13274 /* Point is in the scroll margin at the top of the window or
13275 above what is displayed in the window. */
13278 /* Compute the vertical distance from PT to the scroll
13279 margin position. Move as far as scroll_max allows, or
13280 one screenful, or 10 screen lines, whichever is largest.
13281 Give up if distance is greater than scroll_max. */
13282 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13283 start_display (&it
, w
, pos
);
13285 y_to_move
= max (it
.last_visible_y
,
13286 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13287 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13289 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13290 dy
= it
.current_y
- y0
;
13291 if (dy
> scroll_max
)
13292 return SCROLLING_FAILED
;
13294 /* Compute new window start. */
13295 start_display (&it
, w
, startp
);
13297 if (arg_scroll_conservatively
)
13298 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13299 max (scroll_step
, temp_scroll_step
));
13300 else if (scroll_step
|| temp_scroll_step
)
13301 amount_to_scroll
= scroll_max
;
13304 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13305 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13306 if (NUMBERP (aggressive
))
13308 double float_amount
= XFLOATINT (aggressive
) * height
;
13309 amount_to_scroll
= float_amount
;
13310 if (amount_to_scroll
== 0 && float_amount
> 0)
13311 amount_to_scroll
= 1;
13312 amount_to_scroll
-=
13313 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13314 /* Don't let point enter the scroll margin near
13315 bottom of the window. */
13316 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13317 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13321 if (amount_to_scroll
<= 0)
13322 return SCROLLING_FAILED
;
13324 move_it_vertically_backward (&it
, amount_to_scroll
);
13325 startp
= it
.current
.pos
;
13329 /* Run window scroll functions. */
13330 startp
= run_window_scroll_functions (window
, startp
);
13332 /* Display the window. Give up if new fonts are loaded, or if point
13334 if (!try_window (window
, startp
, 0))
13335 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13336 else if (w
->cursor
.vpos
< 0)
13338 clear_glyph_matrix (w
->desired_matrix
);
13339 rc
= SCROLLING_FAILED
;
13343 /* Maybe forget recorded base line for line number display. */
13344 if (!just_this_one_p
13345 || current_buffer
->clip_changed
13346 || BEG_UNCHANGED
< CHARPOS (startp
))
13347 w
->base_line_number
= Qnil
;
13349 /* If cursor ends up on a partially visible line,
13350 treat that as being off the bottom of the screen. */
13351 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13352 /* It's possible that the cursor is on the first line of the
13353 buffer, which is partially obscured due to a vscroll
13354 (Bug#7537). In that case, avoid looping forever . */
13355 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13357 clear_glyph_matrix (w
->desired_matrix
);
13358 ++extra_scroll_margin_lines
;
13361 rc
= SCROLLING_SUCCESS
;
13368 /* Compute a suitable window start for window W if display of W starts
13369 on a continuation line. Value is non-zero if a new window start
13372 The new window start will be computed, based on W's width, starting
13373 from the start of the continued line. It is the start of the
13374 screen line with the minimum distance from the old start W->start. */
13377 compute_window_start_on_continuation_line (struct window
*w
)
13379 struct text_pos pos
, start_pos
;
13380 int window_start_changed_p
= 0;
13382 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13384 /* If window start is on a continuation line... Window start may be
13385 < BEGV in case there's invisible text at the start of the
13386 buffer (M-x rmail, for example). */
13387 if (CHARPOS (start_pos
) > BEGV
13388 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13391 struct glyph_row
*row
;
13393 /* Handle the case that the window start is out of range. */
13394 if (CHARPOS (start_pos
) < BEGV
)
13395 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13396 else if (CHARPOS (start_pos
) > ZV
)
13397 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13399 /* Find the start of the continued line. This should be fast
13400 because scan_buffer is fast (newline cache). */
13401 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13402 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13403 row
, DEFAULT_FACE_ID
);
13404 reseat_at_previous_visible_line_start (&it
);
13406 /* If the line start is "too far" away from the window start,
13407 say it takes too much time to compute a new window start. */
13408 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13409 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13411 int min_distance
, distance
;
13413 /* Move forward by display lines to find the new window
13414 start. If window width was enlarged, the new start can
13415 be expected to be > the old start. If window width was
13416 decreased, the new window start will be < the old start.
13417 So, we're looking for the display line start with the
13418 minimum distance from the old window start. */
13419 pos
= it
.current
.pos
;
13420 min_distance
= INFINITY
;
13421 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13422 distance
< min_distance
)
13424 min_distance
= distance
;
13425 pos
= it
.current
.pos
;
13426 move_it_by_lines (&it
, 1);
13429 /* Set the window start there. */
13430 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13431 window_start_changed_p
= 1;
13435 return window_start_changed_p
;
13439 /* Try cursor movement in case text has not changed in window WINDOW,
13440 with window start STARTP. Value is
13442 CURSOR_MOVEMENT_SUCCESS if successful
13444 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13446 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13447 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13448 we want to scroll as if scroll-step were set to 1. See the code.
13450 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13451 which case we have to abort this redisplay, and adjust matrices
13456 CURSOR_MOVEMENT_SUCCESS
,
13457 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13458 CURSOR_MOVEMENT_MUST_SCROLL
,
13459 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13463 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13465 struct window
*w
= XWINDOW (window
);
13466 struct frame
*f
= XFRAME (w
->frame
);
13467 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13470 if (inhibit_try_cursor_movement
)
13474 /* Handle case where text has not changed, only point, and it has
13475 not moved off the frame. */
13476 if (/* Point may be in this window. */
13477 PT
>= CHARPOS (startp
)
13478 /* Selective display hasn't changed. */
13479 && !current_buffer
->clip_changed
13480 /* Function force-mode-line-update is used to force a thorough
13481 redisplay. It sets either windows_or_buffers_changed or
13482 update_mode_lines. So don't take a shortcut here for these
13484 && !update_mode_lines
13485 && !windows_or_buffers_changed
13486 && !cursor_type_changed
13487 /* Can't use this case if highlighting a region. When a
13488 region exists, cursor movement has to do more than just
13490 && !(!NILP (Vtransient_mark_mode
)
13491 && !NILP (BVAR (current_buffer
, mark_active
)))
13492 && NILP (w
->region_showing
)
13493 && NILP (Vshow_trailing_whitespace
)
13494 /* Right after splitting windows, last_point may be nil. */
13495 && INTEGERP (w
->last_point
)
13496 /* This code is not used for mini-buffer for the sake of the case
13497 of redisplaying to replace an echo area message; since in
13498 that case the mini-buffer contents per se are usually
13499 unchanged. This code is of no real use in the mini-buffer
13500 since the handling of this_line_start_pos, etc., in redisplay
13501 handles the same cases. */
13502 && !EQ (window
, minibuf_window
)
13503 /* When splitting windows or for new windows, it happens that
13504 redisplay is called with a nil window_end_vpos or one being
13505 larger than the window. This should really be fixed in
13506 window.c. I don't have this on my list, now, so we do
13507 approximately the same as the old redisplay code. --gerd. */
13508 && INTEGERP (w
->window_end_vpos
)
13509 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13510 && (FRAME_WINDOW_P (f
)
13511 || !overlay_arrow_in_current_buffer_p ()))
13513 int this_scroll_margin
, top_scroll_margin
;
13514 struct glyph_row
*row
= NULL
;
13517 debug_method_add (w
, "cursor movement");
13520 /* Scroll if point within this distance from the top or bottom
13521 of the window. This is a pixel value. */
13522 if (scroll_margin
> 0)
13524 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13525 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13528 this_scroll_margin
= 0;
13530 top_scroll_margin
= this_scroll_margin
;
13531 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13532 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13534 /* Start with the row the cursor was displayed during the last
13535 not paused redisplay. Give up if that row is not valid. */
13536 if (w
->last_cursor
.vpos
< 0
13537 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13538 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13541 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13542 if (row
->mode_line_p
)
13544 if (!row
->enabled_p
)
13545 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13548 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13550 int scroll_p
= 0, must_scroll
= 0;
13551 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13553 if (PT
> XFASTINT (w
->last_point
))
13555 /* Point has moved forward. */
13556 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13557 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13559 xassert (row
->enabled_p
);
13563 /* If the end position of a row equals the start
13564 position of the next row, and PT is at that position,
13565 we would rather display cursor in the next line. */
13566 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13567 && MATRIX_ROW_END_CHARPOS (row
) == PT
13568 && row
< w
->current_matrix
->rows
13569 + w
->current_matrix
->nrows
- 1
13570 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13571 && !cursor_row_p (row
))
13574 /* If within the scroll margin, scroll. Note that
13575 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13576 the next line would be drawn, and that
13577 this_scroll_margin can be zero. */
13578 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13579 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13580 /* Line is completely visible last line in window
13581 and PT is to be set in the next line. */
13582 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13583 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13584 && !row
->ends_at_zv_p
13585 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13588 else if (PT
< XFASTINT (w
->last_point
))
13590 /* Cursor has to be moved backward. Note that PT >=
13591 CHARPOS (startp) because of the outer if-statement. */
13592 while (!row
->mode_line_p
13593 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13594 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13595 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13596 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13597 row
> w
->current_matrix
->rows
13598 && (row
-1)->ends_in_newline_from_string_p
))))
13599 && (row
->y
> top_scroll_margin
13600 || CHARPOS (startp
) == BEGV
))
13602 xassert (row
->enabled_p
);
13606 /* Consider the following case: Window starts at BEGV,
13607 there is invisible, intangible text at BEGV, so that
13608 display starts at some point START > BEGV. It can
13609 happen that we are called with PT somewhere between
13610 BEGV and START. Try to handle that case. */
13611 if (row
< w
->current_matrix
->rows
13612 || row
->mode_line_p
)
13614 row
= w
->current_matrix
->rows
;
13615 if (row
->mode_line_p
)
13619 /* Due to newlines in overlay strings, we may have to
13620 skip forward over overlay strings. */
13621 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13622 && MATRIX_ROW_END_CHARPOS (row
) == PT
13623 && !cursor_row_p (row
))
13626 /* If within the scroll margin, scroll. */
13627 if (row
->y
< top_scroll_margin
13628 && CHARPOS (startp
) != BEGV
)
13633 /* Cursor did not move. So don't scroll even if cursor line
13634 is partially visible, as it was so before. */
13635 rc
= CURSOR_MOVEMENT_SUCCESS
;
13638 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13639 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13641 /* if PT is not in the glyph row, give up. */
13642 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13645 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13646 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13648 /* If rows are bidi-reordered and point moved, back up
13649 until we find a row that does not belong to a
13650 continuation line. This is because we must consider
13651 all rows of a continued line as candidates for the
13652 new cursor positioning, since row start and end
13653 positions change non-linearly with vertical position
13655 /* FIXME: Revisit this when glyph ``spilling'' in
13656 continuation lines' rows is implemented for
13657 bidi-reordered rows. */
13658 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13660 xassert (row
->enabled_p
);
13662 /* If we hit the beginning of the displayed portion
13663 without finding the first row of a continued
13665 if (row
<= w
->current_matrix
->rows
)
13667 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13675 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13676 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13677 && make_cursor_line_fully_visible_p
)
13679 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13680 && !row
->ends_at_zv_p
13681 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13682 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13683 else if (row
->height
> window_box_height (w
))
13685 /* If we end up in a partially visible line, let's
13686 make it fully visible, except when it's taller
13687 than the window, in which case we can't do much
13690 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13694 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13695 if (!cursor_row_fully_visible_p (w
, 0, 1))
13696 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13698 rc
= CURSOR_MOVEMENT_SUCCESS
;
13702 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13703 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13704 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13706 /* With bidi-reordered rows, there could be more than
13707 one candidate row whose start and end positions
13708 occlude point. We need to let set_cursor_from_row
13709 find the best candidate. */
13710 /* FIXME: Revisit this when glyph ``spilling'' in
13711 continuation lines' rows is implemented for
13712 bidi-reordered rows. */
13717 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13718 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13719 && cursor_row_p (row
))
13720 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13722 /* As soon as we've found the first suitable row
13723 whose ends_at_zv_p flag is set, we are done. */
13725 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13727 rc
= CURSOR_MOVEMENT_SUCCESS
;
13732 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13733 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13734 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13735 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13736 /* If we didn't find any candidate rows, or exited the
13737 loop before all the candidates were examined, signal
13738 to the caller that this method failed. */
13739 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13740 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13741 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13743 rc
= CURSOR_MOVEMENT_SUCCESS
;
13749 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13751 rc
= CURSOR_MOVEMENT_SUCCESS
;
13756 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13757 && MATRIX_ROW_START_CHARPOS (row
) == PT
13758 && cursor_row_p (row
));
13766 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
13770 set_vertical_scroll_bar (struct window
*w
)
13772 EMACS_INT start
, end
, whole
;
13774 /* Calculate the start and end positions for the current window.
13775 At some point, it would be nice to choose between scrollbars
13776 which reflect the whole buffer size, with special markers
13777 indicating narrowing, and scrollbars which reflect only the
13780 Note that mini-buffers sometimes aren't displaying any text. */
13781 if (!MINI_WINDOW_P (w
)
13782 || (w
== XWINDOW (minibuf_window
)
13783 && NILP (echo_area_buffer
[0])))
13785 struct buffer
*buf
= XBUFFER (w
->buffer
);
13786 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13787 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13788 /* I don't think this is guaranteed to be right. For the
13789 moment, we'll pretend it is. */
13790 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13794 if (whole
< (end
- start
))
13795 whole
= end
- start
;
13798 start
= end
= whole
= 0;
13800 /* Indicate what this scroll bar ought to be displaying now. */
13801 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13802 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13803 (w
, end
- start
, whole
, start
);
13807 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13808 selected_window is redisplayed.
13810 We can return without actually redisplaying the window if
13811 fonts_changed_p is nonzero. In that case, redisplay_internal will
13815 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13817 struct window
*w
= XWINDOW (window
);
13818 struct frame
*f
= XFRAME (w
->frame
);
13819 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13820 struct buffer
*old
= current_buffer
;
13821 struct text_pos lpoint
, opoint
, startp
;
13822 int update_mode_line
;
13825 /* Record it now because it's overwritten. */
13826 int current_matrix_up_to_date_p
= 0;
13827 int used_current_matrix_p
= 0;
13828 /* This is less strict than current_matrix_up_to_date_p.
13829 It indictes that the buffer contents and narrowing are unchanged. */
13830 int buffer_unchanged_p
= 0;
13831 int temp_scroll_step
= 0;
13832 int count
= SPECPDL_INDEX ();
13834 int centering_position
= -1;
13835 int last_line_misfit
= 0;
13836 EMACS_INT beg_unchanged
, end_unchanged
;
13838 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13841 /* W must be a leaf window here. */
13842 xassert (!NILP (w
->buffer
));
13844 *w
->desired_matrix
->method
= 0;
13848 reconsider_clip_changes (w
, buffer
);
13850 /* Has the mode line to be updated? */
13851 update_mode_line
= (!NILP (w
->update_mode_line
)
13852 || update_mode_lines
13853 || buffer
->clip_changed
13854 || buffer
->prevent_redisplay_optimizations_p
);
13856 if (MINI_WINDOW_P (w
))
13858 if (w
== XWINDOW (echo_area_window
)
13859 && !NILP (echo_area_buffer
[0]))
13861 if (update_mode_line
)
13862 /* We may have to update a tty frame's menu bar or a
13863 tool-bar. Example `M-x C-h C-h C-g'. */
13864 goto finish_menu_bars
;
13866 /* We've already displayed the echo area glyphs in this window. */
13867 goto finish_scroll_bars
;
13869 else if ((w
!= XWINDOW (minibuf_window
)
13870 || minibuf_level
== 0)
13871 /* When buffer is nonempty, redisplay window normally. */
13872 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13873 /* Quail displays non-mini buffers in minibuffer window.
13874 In that case, redisplay the window normally. */
13875 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13877 /* W is a mini-buffer window, but it's not active, so clear
13879 int yb
= window_text_bottom_y (w
);
13880 struct glyph_row
*row
;
13883 for (y
= 0, row
= w
->desired_matrix
->rows
;
13885 y
+= row
->height
, ++row
)
13886 blank_row (w
, row
, y
);
13887 goto finish_scroll_bars
;
13890 clear_glyph_matrix (w
->desired_matrix
);
13893 /* Otherwise set up data on this window; select its buffer and point
13895 /* Really select the buffer, for the sake of buffer-local
13897 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13899 current_matrix_up_to_date_p
13900 = (!NILP (w
->window_end_valid
)
13901 && !current_buffer
->clip_changed
13902 && !current_buffer
->prevent_redisplay_optimizations_p
13903 && XFASTINT (w
->last_modified
) >= MODIFF
13904 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13906 /* Run the window-bottom-change-functions
13907 if it is possible that the text on the screen has changed
13908 (either due to modification of the text, or any other reason). */
13909 if (!current_matrix_up_to_date_p
13910 && !NILP (Vwindow_text_change_functions
))
13912 safe_run_hooks (Qwindow_text_change_functions
);
13916 beg_unchanged
= BEG_UNCHANGED
;
13917 end_unchanged
= END_UNCHANGED
;
13919 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13921 specbind (Qinhibit_point_motion_hooks
, Qt
);
13924 = (!NILP (w
->window_end_valid
)
13925 && !current_buffer
->clip_changed
13926 && XFASTINT (w
->last_modified
) >= MODIFF
13927 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13929 /* When windows_or_buffers_changed is non-zero, we can't rely on
13930 the window end being valid, so set it to nil there. */
13931 if (windows_or_buffers_changed
)
13933 /* If window starts on a continuation line, maybe adjust the
13934 window start in case the window's width changed. */
13935 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13936 compute_window_start_on_continuation_line (w
);
13938 w
->window_end_valid
= Qnil
;
13941 /* Some sanity checks. */
13942 CHECK_WINDOW_END (w
);
13943 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13945 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13948 /* If %c is in mode line, update it if needed. */
13949 if (!NILP (w
->column_number_displayed
)
13950 /* This alternative quickly identifies a common case
13951 where no change is needed. */
13952 && !(PT
== XFASTINT (w
->last_point
)
13953 && XFASTINT (w
->last_modified
) >= MODIFF
13954 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13955 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13956 update_mode_line
= 1;
13958 /* Count number of windows showing the selected buffer. An indirect
13959 buffer counts as its base buffer. */
13960 if (!just_this_one_p
)
13962 struct buffer
*current_base
, *window_base
;
13963 current_base
= current_buffer
;
13964 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13965 if (current_base
->base_buffer
)
13966 current_base
= current_base
->base_buffer
;
13967 if (window_base
->base_buffer
)
13968 window_base
= window_base
->base_buffer
;
13969 if (current_base
== window_base
)
13973 /* Point refers normally to the selected window. For any other
13974 window, set up appropriate value. */
13975 if (!EQ (window
, selected_window
))
13977 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13978 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13982 new_pt_byte
= BEGV_BYTE
;
13983 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13985 else if (new_pt
> (ZV
- 1))
13988 new_pt_byte
= ZV_BYTE
;
13989 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13992 /* We don't use SET_PT so that the point-motion hooks don't run. */
13993 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13996 /* If any of the character widths specified in the display table
13997 have changed, invalidate the width run cache. It's true that
13998 this may be a bit late to catch such changes, but the rest of
13999 redisplay goes (non-fatally) haywire when the display table is
14000 changed, so why should we worry about doing any better? */
14001 if (current_buffer
->width_run_cache
)
14003 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14005 if (! disptab_matches_widthtab (disptab
,
14006 XVECTOR (BVAR (current_buffer
, width_table
))))
14008 invalidate_region_cache (current_buffer
,
14009 current_buffer
->width_run_cache
,
14011 recompute_width_table (current_buffer
, disptab
);
14015 /* If window-start is screwed up, choose a new one. */
14016 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14019 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14021 /* If someone specified a new starting point but did not insist,
14022 check whether it can be used. */
14023 if (!NILP (w
->optional_new_start
)
14024 && CHARPOS (startp
) >= BEGV
14025 && CHARPOS (startp
) <= ZV
)
14027 w
->optional_new_start
= Qnil
;
14028 start_display (&it
, w
, startp
);
14029 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14030 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14031 if (IT_CHARPOS (it
) == PT
)
14032 w
->force_start
= Qt
;
14033 /* IT may overshoot PT if text at PT is invisible. */
14034 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14035 w
->force_start
= Qt
;
14040 /* Handle case where place to start displaying has been specified,
14041 unless the specified location is outside the accessible range. */
14042 if (!NILP (w
->force_start
)
14043 || w
->frozen_window_start_p
)
14045 /* We set this later on if we have to adjust point. */
14048 w
->force_start
= Qnil
;
14050 w
->window_end_valid
= Qnil
;
14052 /* Forget any recorded base line for line number display. */
14053 if (!buffer_unchanged_p
)
14054 w
->base_line_number
= Qnil
;
14056 /* Redisplay the mode line. Select the buffer properly for that.
14057 Also, run the hook window-scroll-functions
14058 because we have scrolled. */
14059 /* Note, we do this after clearing force_start because
14060 if there's an error, it is better to forget about force_start
14061 than to get into an infinite loop calling the hook functions
14062 and having them get more errors. */
14063 if (!update_mode_line
14064 || ! NILP (Vwindow_scroll_functions
))
14066 update_mode_line
= 1;
14067 w
->update_mode_line
= Qt
;
14068 startp
= run_window_scroll_functions (window
, startp
);
14071 w
->last_modified
= make_number (0);
14072 w
->last_overlay_modified
= make_number (0);
14073 if (CHARPOS (startp
) < BEGV
)
14074 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14075 else if (CHARPOS (startp
) > ZV
)
14076 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14078 /* Redisplay, then check if cursor has been set during the
14079 redisplay. Give up if new fonts were loaded. */
14080 /* We used to issue a CHECK_MARGINS argument to try_window here,
14081 but this causes scrolling to fail when point begins inside
14082 the scroll margin (bug#148) -- cyd */
14083 if (!try_window (window
, startp
, 0))
14085 w
->force_start
= Qt
;
14086 clear_glyph_matrix (w
->desired_matrix
);
14087 goto need_larger_matrices
;
14090 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14092 /* If point does not appear, try to move point so it does
14093 appear. The desired matrix has been built above, so we
14094 can use it here. */
14095 new_vpos
= window_box_height (w
) / 2;
14098 if (!cursor_row_fully_visible_p (w
, 0, 0))
14100 /* Point does appear, but on a line partly visible at end of window.
14101 Move it back to a fully-visible line. */
14102 new_vpos
= window_box_height (w
);
14105 /* If we need to move point for either of the above reasons,
14106 now actually do it. */
14109 struct glyph_row
*row
;
14111 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14112 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14115 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14116 MATRIX_ROW_START_BYTEPOS (row
));
14118 if (w
!= XWINDOW (selected_window
))
14119 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14120 else if (current_buffer
== old
)
14121 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14123 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14125 /* If we are highlighting the region, then we just changed
14126 the region, so redisplay to show it. */
14127 if (!NILP (Vtransient_mark_mode
)
14128 && !NILP (BVAR (current_buffer
, mark_active
)))
14130 clear_glyph_matrix (w
->desired_matrix
);
14131 if (!try_window (window
, startp
, 0))
14132 goto need_larger_matrices
;
14137 debug_method_add (w
, "forced window start");
14142 /* Handle case where text has not changed, only point, and it has
14143 not moved off the frame, and we are not retrying after hscroll.
14144 (current_matrix_up_to_date_p is nonzero when retrying.) */
14145 if (current_matrix_up_to_date_p
14146 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14147 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14151 case CURSOR_MOVEMENT_SUCCESS
:
14152 used_current_matrix_p
= 1;
14155 case CURSOR_MOVEMENT_MUST_SCROLL
:
14156 goto try_to_scroll
;
14162 /* If current starting point was originally the beginning of a line
14163 but no longer is, find a new starting point. */
14164 else if (!NILP (w
->start_at_line_beg
)
14165 && !(CHARPOS (startp
) <= BEGV
14166 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14169 debug_method_add (w
, "recenter 1");
14174 /* Try scrolling with try_window_id. Value is > 0 if update has
14175 been done, it is -1 if we know that the same window start will
14176 not work. It is 0 if unsuccessful for some other reason. */
14177 else if ((tem
= try_window_id (w
)) != 0)
14180 debug_method_add (w
, "try_window_id %d", tem
);
14183 if (fonts_changed_p
)
14184 goto need_larger_matrices
;
14188 /* Otherwise try_window_id has returned -1 which means that we
14189 don't want the alternative below this comment to execute. */
14191 else if (CHARPOS (startp
) >= BEGV
14192 && CHARPOS (startp
) <= ZV
14193 && PT
>= CHARPOS (startp
)
14194 && (CHARPOS (startp
) < ZV
14195 /* Avoid starting at end of buffer. */
14196 || CHARPOS (startp
) == BEGV
14197 || (XFASTINT (w
->last_modified
) >= MODIFF
14198 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14201 /* If first window line is a continuation line, and window start
14202 is inside the modified region, but the first change is before
14203 current window start, we must select a new window start.
14205 However, if this is the result of a down-mouse event (e.g. by
14206 extending the mouse-drag-overlay), we don't want to select a
14207 new window start, since that would change the position under
14208 the mouse, resulting in an unwanted mouse-movement rather
14209 than a simple mouse-click. */
14210 if (NILP (w
->start_at_line_beg
)
14211 && NILP (do_mouse_tracking
)
14212 && CHARPOS (startp
) > BEGV
14213 && CHARPOS (startp
) > BEG
+ beg_unchanged
14214 && CHARPOS (startp
) <= Z
- end_unchanged
14215 /* Even if w->start_at_line_beg is nil, a new window may
14216 start at a line_beg, since that's how set_buffer_window
14217 sets it. So, we need to check the return value of
14218 compute_window_start_on_continuation_line. (See also
14220 && XMARKER (w
->start
)->buffer
== current_buffer
14221 && compute_window_start_on_continuation_line (w
))
14223 w
->force_start
= Qt
;
14224 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14229 debug_method_add (w
, "same window start");
14232 /* Try to redisplay starting at same place as before.
14233 If point has not moved off frame, accept the results. */
14234 if (!current_matrix_up_to_date_p
14235 /* Don't use try_window_reusing_current_matrix in this case
14236 because a window scroll function can have changed the
14238 || !NILP (Vwindow_scroll_functions
)
14239 || MINI_WINDOW_P (w
)
14240 || !(used_current_matrix_p
14241 = try_window_reusing_current_matrix (w
)))
14243 IF_DEBUG (debug_method_add (w
, "1"));
14244 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14245 /* -1 means we need to scroll.
14246 0 means we need new matrices, but fonts_changed_p
14247 is set in that case, so we will detect it below. */
14248 goto try_to_scroll
;
14251 if (fonts_changed_p
)
14252 goto need_larger_matrices
;
14254 if (w
->cursor
.vpos
>= 0)
14256 if (!just_this_one_p
14257 || current_buffer
->clip_changed
14258 || BEG_UNCHANGED
< CHARPOS (startp
))
14259 /* Forget any recorded base line for line number display. */
14260 w
->base_line_number
= Qnil
;
14262 if (!cursor_row_fully_visible_p (w
, 1, 0))
14264 clear_glyph_matrix (w
->desired_matrix
);
14265 last_line_misfit
= 1;
14267 /* Drop through and scroll. */
14272 clear_glyph_matrix (w
->desired_matrix
);
14277 w
->last_modified
= make_number (0);
14278 w
->last_overlay_modified
= make_number (0);
14280 /* Redisplay the mode line. Select the buffer properly for that. */
14281 if (!update_mode_line
)
14283 update_mode_line
= 1;
14284 w
->update_mode_line
= Qt
;
14287 /* Try to scroll by specified few lines. */
14288 if ((scroll_conservatively
14289 || emacs_scroll_step
14290 || temp_scroll_step
14291 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14292 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14293 && CHARPOS (startp
) >= BEGV
14294 && CHARPOS (startp
) <= ZV
)
14296 /* The function returns -1 if new fonts were loaded, 1 if
14297 successful, 0 if not successful. */
14298 int ss
= try_scrolling (window
, just_this_one_p
,
14299 scroll_conservatively
,
14301 temp_scroll_step
, last_line_misfit
);
14304 case SCROLLING_SUCCESS
:
14307 case SCROLLING_NEED_LARGER_MATRICES
:
14308 goto need_larger_matrices
;
14310 case SCROLLING_FAILED
:
14318 /* Finally, just choose a place to start which positions point
14319 according to user preferences. */
14324 debug_method_add (w
, "recenter");
14327 /* w->vscroll = 0; */
14329 /* Forget any previously recorded base line for line number display. */
14330 if (!buffer_unchanged_p
)
14331 w
->base_line_number
= Qnil
;
14333 /* Determine the window start relative to point. */
14334 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14335 it
.current_y
= it
.last_visible_y
;
14336 if (centering_position
< 0)
14340 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14342 EMACS_INT margin_pos
= CHARPOS (startp
);
14344 Lisp_Object aggressive
;
14346 /* If there is a scroll margin at the top of the window, find
14347 its character position. */
14349 /* Cannot call start_display if startp is not in the
14350 accessible region of the buffer. This can happen when we
14351 have just switched to a different buffer and/or changed
14352 its restriction. In that case, startp is initialized to
14353 the character position 1 (BEG) because we did not yet
14354 have chance to display the buffer even once. */
14355 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14359 start_display (&it1
, w
, startp
);
14360 move_it_vertically (&it1
, margin
);
14361 margin_pos
= IT_CHARPOS (it1
);
14363 scrolling_up
= PT
> margin_pos
;
14366 ? BVAR (current_buffer
, scroll_up_aggressively
)
14367 : BVAR (current_buffer
, scroll_down_aggressively
);
14369 if (!MINI_WINDOW_P (w
)
14370 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14374 /* Setting scroll-conservatively overrides
14375 scroll-*-aggressively. */
14376 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14378 double float_amount
= XFLOATINT (aggressive
);
14380 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14381 if (pt_offset
== 0 && float_amount
> 0)
14386 /* Compute how much to move the window start backward from
14387 point so that point will be displayed where the user
14391 centering_position
= it
.last_visible_y
;
14393 centering_position
-= pt_offset
;
14394 centering_position
-=
14395 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14396 /* Don't let point enter the scroll margin near top of
14398 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14399 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14402 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14405 /* Set the window start half the height of the window backward
14407 centering_position
= window_box_height (w
) / 2;
14409 move_it_vertically_backward (&it
, centering_position
);
14411 xassert (IT_CHARPOS (it
) >= BEGV
);
14413 /* The function move_it_vertically_backward may move over more
14414 than the specified y-distance. If it->w is small, e.g. a
14415 mini-buffer window, we may end up in front of the window's
14416 display area. Start displaying at the start of the line
14417 containing PT in this case. */
14418 if (it
.current_y
<= 0)
14420 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14421 move_it_vertically_backward (&it
, 0);
14425 it
.current_x
= it
.hpos
= 0;
14427 /* Set the window start position here explicitly, to avoid an
14428 infinite loop in case the functions in window-scroll-functions
14430 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14432 /* Run scroll hooks. */
14433 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14435 /* Redisplay the window. */
14436 if (!current_matrix_up_to_date_p
14437 || windows_or_buffers_changed
14438 || cursor_type_changed
14439 /* Don't use try_window_reusing_current_matrix in this case
14440 because it can have changed the buffer. */
14441 || !NILP (Vwindow_scroll_functions
)
14442 || !just_this_one_p
14443 || MINI_WINDOW_P (w
)
14444 || !(used_current_matrix_p
14445 = try_window_reusing_current_matrix (w
)))
14446 try_window (window
, startp
, 0);
14448 /* If new fonts have been loaded (due to fontsets), give up. We
14449 have to start a new redisplay since we need to re-adjust glyph
14451 if (fonts_changed_p
)
14452 goto need_larger_matrices
;
14454 /* If cursor did not appear assume that the middle of the window is
14455 in the first line of the window. Do it again with the next line.
14456 (Imagine a window of height 100, displaying two lines of height
14457 60. Moving back 50 from it->last_visible_y will end in the first
14459 if (w
->cursor
.vpos
< 0)
14461 if (!NILP (w
->window_end_valid
)
14462 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14464 clear_glyph_matrix (w
->desired_matrix
);
14465 move_it_by_lines (&it
, 1);
14466 try_window (window
, it
.current
.pos
, 0);
14468 else if (PT
< IT_CHARPOS (it
))
14470 clear_glyph_matrix (w
->desired_matrix
);
14471 move_it_by_lines (&it
, -1);
14472 try_window (window
, it
.current
.pos
, 0);
14476 /* Not much we can do about it. */
14480 /* Consider the following case: Window starts at BEGV, there is
14481 invisible, intangible text at BEGV, so that display starts at
14482 some point START > BEGV. It can happen that we are called with
14483 PT somewhere between BEGV and START. Try to handle that case. */
14484 if (w
->cursor
.vpos
< 0)
14486 struct glyph_row
*row
= w
->current_matrix
->rows
;
14487 if (row
->mode_line_p
)
14489 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14492 if (!cursor_row_fully_visible_p (w
, 0, 0))
14494 /* If vscroll is enabled, disable it and try again. */
14498 clear_glyph_matrix (w
->desired_matrix
);
14502 /* If centering point failed to make the whole line visible,
14503 put point at the top instead. That has to make the whole line
14504 visible, if it can be done. */
14505 if (centering_position
== 0)
14508 clear_glyph_matrix (w
->desired_matrix
);
14509 centering_position
= 0;
14515 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14516 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14517 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14520 /* Display the mode line, if we must. */
14521 if ((update_mode_line
14522 /* If window not full width, must redo its mode line
14523 if (a) the window to its side is being redone and
14524 (b) we do a frame-based redisplay. This is a consequence
14525 of how inverted lines are drawn in frame-based redisplay. */
14526 || (!just_this_one_p
14527 && !FRAME_WINDOW_P (f
)
14528 && !WINDOW_FULL_WIDTH_P (w
))
14529 /* Line number to display. */
14530 || INTEGERP (w
->base_line_pos
)
14531 /* Column number is displayed and different from the one displayed. */
14532 || (!NILP (w
->column_number_displayed
)
14533 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14534 /* This means that the window has a mode line. */
14535 && (WINDOW_WANTS_MODELINE_P (w
)
14536 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14538 display_mode_lines (w
);
14540 /* If mode line height has changed, arrange for a thorough
14541 immediate redisplay using the correct mode line height. */
14542 if (WINDOW_WANTS_MODELINE_P (w
)
14543 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14545 fonts_changed_p
= 1;
14546 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14547 = DESIRED_MODE_LINE_HEIGHT (w
);
14550 /* If header line height has changed, arrange for a thorough
14551 immediate redisplay using the correct header line height. */
14552 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14553 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14555 fonts_changed_p
= 1;
14556 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14557 = DESIRED_HEADER_LINE_HEIGHT (w
);
14560 if (fonts_changed_p
)
14561 goto need_larger_matrices
;
14564 if (!line_number_displayed
14565 && !BUFFERP (w
->base_line_pos
))
14567 w
->base_line_pos
= Qnil
;
14568 w
->base_line_number
= Qnil
;
14573 /* When we reach a frame's selected window, redo the frame's menu bar. */
14574 if (update_mode_line
14575 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14577 int redisplay_menu_p
= 0;
14579 if (FRAME_WINDOW_P (f
))
14581 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14582 || defined (HAVE_NS) || defined (USE_GTK)
14583 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14585 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14589 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14591 if (redisplay_menu_p
)
14592 display_menu_bar (w
);
14594 #ifdef HAVE_WINDOW_SYSTEM
14595 if (FRAME_WINDOW_P (f
))
14597 #if defined (USE_GTK) || defined (HAVE_NS)
14598 if (FRAME_EXTERNAL_TOOL_BAR (f
))
14599 redisplay_tool_bar (f
);
14601 if (WINDOWP (f
->tool_bar_window
)
14602 && (FRAME_TOOL_BAR_LINES (f
) > 0
14603 || !NILP (Vauto_resize_tool_bars
))
14604 && redisplay_tool_bar (f
))
14605 ignore_mouse_drag_p
= 1;
14611 #ifdef HAVE_WINDOW_SYSTEM
14612 if (FRAME_WINDOW_P (f
)
14613 && update_window_fringes (w
, (just_this_one_p
14614 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14615 || w
->pseudo_window_p
)))
14619 if (draw_window_fringes (w
, 1))
14620 x_draw_vertical_border (w
);
14624 #endif /* HAVE_WINDOW_SYSTEM */
14626 /* We go to this label, with fonts_changed_p nonzero,
14627 if it is necessary to try again using larger glyph matrices.
14628 We have to redeem the scroll bar even in this case,
14629 because the loop in redisplay_internal expects that. */
14630 need_larger_matrices
:
14632 finish_scroll_bars
:
14634 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14636 /* Set the thumb's position and size. */
14637 set_vertical_scroll_bar (w
);
14639 /* Note that we actually used the scroll bar attached to this
14640 window, so it shouldn't be deleted at the end of redisplay. */
14641 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14642 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14645 /* Restore current_buffer and value of point in it. The window
14646 update may have changed the buffer, so first make sure `opoint'
14647 is still valid (Bug#6177). */
14648 if (CHARPOS (opoint
) < BEGV
)
14649 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14650 else if (CHARPOS (opoint
) > ZV
)
14651 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14653 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14655 set_buffer_internal_1 (old
);
14656 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14657 shorter. This can be caused by log truncation in *Messages*. */
14658 if (CHARPOS (lpoint
) <= ZV
)
14659 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14661 unbind_to (count
, Qnil
);
14665 /* Build the complete desired matrix of WINDOW with a window start
14666 buffer position POS.
14668 Value is 1 if successful. It is zero if fonts were loaded during
14669 redisplay which makes re-adjusting glyph matrices necessary, and -1
14670 if point would appear in the scroll margins.
14671 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14672 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14676 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14678 struct window
*w
= XWINDOW (window
);
14680 struct glyph_row
*last_text_row
= NULL
;
14681 struct frame
*f
= XFRAME (w
->frame
);
14683 /* Make POS the new window start. */
14684 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14686 /* Mark cursor position as unknown. No overlay arrow seen. */
14687 w
->cursor
.vpos
= -1;
14688 overlay_arrow_seen
= 0;
14690 /* Initialize iterator and info to start at POS. */
14691 start_display (&it
, w
, pos
);
14693 /* Display all lines of W. */
14694 while (it
.current_y
< it
.last_visible_y
)
14696 if (display_line (&it
))
14697 last_text_row
= it
.glyph_row
- 1;
14698 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14702 /* Don't let the cursor end in the scroll margins. */
14703 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14704 && !MINI_WINDOW_P (w
))
14706 int this_scroll_margin
;
14708 if (scroll_margin
> 0)
14710 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14711 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14714 this_scroll_margin
= 0;
14716 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14717 && w
->cursor
.y
< this_scroll_margin
14718 && CHARPOS (pos
) > BEGV
14719 && IT_CHARPOS (it
) < ZV
)
14720 /* rms: considering make_cursor_line_fully_visible_p here
14721 seems to give wrong results. We don't want to recenter
14722 when the last line is partly visible, we want to allow
14723 that case to be handled in the usual way. */
14724 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14726 w
->cursor
.vpos
= -1;
14727 clear_glyph_matrix (w
->desired_matrix
);
14732 /* If bottom moved off end of frame, change mode line percentage. */
14733 if (XFASTINT (w
->window_end_pos
) <= 0
14734 && Z
!= IT_CHARPOS (it
))
14735 w
->update_mode_line
= Qt
;
14737 /* Set window_end_pos to the offset of the last character displayed
14738 on the window from the end of current_buffer. Set
14739 window_end_vpos to its row number. */
14742 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14743 w
->window_end_bytepos
14744 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14746 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14748 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14749 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14750 ->displays_text_p
);
14754 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14755 w
->window_end_pos
= make_number (Z
- ZV
);
14756 w
->window_end_vpos
= make_number (0);
14759 /* But that is not valid info until redisplay finishes. */
14760 w
->window_end_valid
= Qnil
;
14766 /************************************************************************
14767 Window redisplay reusing current matrix when buffer has not changed
14768 ************************************************************************/
14770 /* Try redisplay of window W showing an unchanged buffer with a
14771 different window start than the last time it was displayed by
14772 reusing its current matrix. Value is non-zero if successful.
14773 W->start is the new window start. */
14776 try_window_reusing_current_matrix (struct window
*w
)
14778 struct frame
*f
= XFRAME (w
->frame
);
14779 struct glyph_row
*bottom_row
;
14782 struct text_pos start
, new_start
;
14783 int nrows_scrolled
, i
;
14784 struct glyph_row
*last_text_row
;
14785 struct glyph_row
*last_reused_text_row
;
14786 struct glyph_row
*start_row
;
14787 int start_vpos
, min_y
, max_y
;
14790 if (inhibit_try_window_reusing
)
14794 if (/* This function doesn't handle terminal frames. */
14795 !FRAME_WINDOW_P (f
)
14796 /* Don't try to reuse the display if windows have been split
14798 || windows_or_buffers_changed
14799 || cursor_type_changed
)
14802 /* Can't do this if region may have changed. */
14803 if ((!NILP (Vtransient_mark_mode
)
14804 && !NILP (BVAR (current_buffer
, mark_active
)))
14805 || !NILP (w
->region_showing
)
14806 || !NILP (Vshow_trailing_whitespace
))
14809 /* If top-line visibility has changed, give up. */
14810 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14811 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14814 /* Give up if old or new display is scrolled vertically. We could
14815 make this function handle this, but right now it doesn't. */
14816 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14817 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14820 /* The variable new_start now holds the new window start. The old
14821 start `start' can be determined from the current matrix. */
14822 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14823 start
= start_row
->minpos
;
14824 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14826 /* Clear the desired matrix for the display below. */
14827 clear_glyph_matrix (w
->desired_matrix
);
14829 if (CHARPOS (new_start
) <= CHARPOS (start
))
14831 /* Don't use this method if the display starts with an ellipsis
14832 displayed for invisible text. It's not easy to handle that case
14833 below, and it's certainly not worth the effort since this is
14834 not a frequent case. */
14835 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14838 IF_DEBUG (debug_method_add (w
, "twu1"));
14840 /* Display up to a row that can be reused. The variable
14841 last_text_row is set to the last row displayed that displays
14842 text. Note that it.vpos == 0 if or if not there is a
14843 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14844 start_display (&it
, w
, new_start
);
14845 w
->cursor
.vpos
= -1;
14846 last_text_row
= last_reused_text_row
= NULL
;
14848 while (it
.current_y
< it
.last_visible_y
14849 && !fonts_changed_p
)
14851 /* If we have reached into the characters in the START row,
14852 that means the line boundaries have changed. So we
14853 can't start copying with the row START. Maybe it will
14854 work to start copying with the following row. */
14855 while (IT_CHARPOS (it
) > CHARPOS (start
))
14857 /* Advance to the next row as the "start". */
14859 start
= start_row
->minpos
;
14860 /* If there are no more rows to try, or just one, give up. */
14861 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14862 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14863 || CHARPOS (start
) == ZV
)
14865 clear_glyph_matrix (w
->desired_matrix
);
14869 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14871 /* If we have reached alignment,
14872 we can copy the rest of the rows. */
14873 if (IT_CHARPOS (it
) == CHARPOS (start
))
14876 if (display_line (&it
))
14877 last_text_row
= it
.glyph_row
- 1;
14880 /* A value of current_y < last_visible_y means that we stopped
14881 at the previous window start, which in turn means that we
14882 have at least one reusable row. */
14883 if (it
.current_y
< it
.last_visible_y
)
14885 struct glyph_row
*row
;
14887 /* IT.vpos always starts from 0; it counts text lines. */
14888 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14890 /* Find PT if not already found in the lines displayed. */
14891 if (w
->cursor
.vpos
< 0)
14893 int dy
= it
.current_y
- start_row
->y
;
14895 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14896 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14898 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14899 dy
, nrows_scrolled
);
14902 clear_glyph_matrix (w
->desired_matrix
);
14907 /* Scroll the display. Do it before the current matrix is
14908 changed. The problem here is that update has not yet
14909 run, i.e. part of the current matrix is not up to date.
14910 scroll_run_hook will clear the cursor, and use the
14911 current matrix to get the height of the row the cursor is
14913 run
.current_y
= start_row
->y
;
14914 run
.desired_y
= it
.current_y
;
14915 run
.height
= it
.last_visible_y
- it
.current_y
;
14917 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14920 FRAME_RIF (f
)->update_window_begin_hook (w
);
14921 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14922 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14923 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14927 /* Shift current matrix down by nrows_scrolled lines. */
14928 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14929 rotate_matrix (w
->current_matrix
,
14931 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14934 /* Disable lines that must be updated. */
14935 for (i
= 0; i
< nrows_scrolled
; ++i
)
14936 (start_row
+ i
)->enabled_p
= 0;
14938 /* Re-compute Y positions. */
14939 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14940 max_y
= it
.last_visible_y
;
14941 for (row
= start_row
+ nrows_scrolled
;
14945 row
->y
= it
.current_y
;
14946 row
->visible_height
= row
->height
;
14948 if (row
->y
< min_y
)
14949 row
->visible_height
-= min_y
- row
->y
;
14950 if (row
->y
+ row
->height
> max_y
)
14951 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14952 if (row
->fringe_bitmap_periodic_p
)
14953 row
->redraw_fringe_bitmaps_p
= 1;
14955 it
.current_y
+= row
->height
;
14957 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14958 last_reused_text_row
= row
;
14959 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14963 /* Disable lines in the current matrix which are now
14964 below the window. */
14965 for (++row
; row
< bottom_row
; ++row
)
14966 row
->enabled_p
= row
->mode_line_p
= 0;
14969 /* Update window_end_pos etc.; last_reused_text_row is the last
14970 reused row from the current matrix containing text, if any.
14971 The value of last_text_row is the last displayed line
14972 containing text. */
14973 if (last_reused_text_row
)
14975 w
->window_end_bytepos
14976 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14978 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14980 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14981 w
->current_matrix
));
14983 else if (last_text_row
)
14985 w
->window_end_bytepos
14986 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14988 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14990 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14994 /* This window must be completely empty. */
14995 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14996 w
->window_end_pos
= make_number (Z
- ZV
);
14997 w
->window_end_vpos
= make_number (0);
14999 w
->window_end_valid
= Qnil
;
15001 /* Update hint: don't try scrolling again in update_window. */
15002 w
->desired_matrix
->no_scrolling_p
= 1;
15005 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15009 else if (CHARPOS (new_start
) > CHARPOS (start
))
15011 struct glyph_row
*pt_row
, *row
;
15012 struct glyph_row
*first_reusable_row
;
15013 struct glyph_row
*first_row_to_display
;
15015 int yb
= window_text_bottom_y (w
);
15017 /* Find the row starting at new_start, if there is one. Don't
15018 reuse a partially visible line at the end. */
15019 first_reusable_row
= start_row
;
15020 while (first_reusable_row
->enabled_p
15021 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15022 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15023 < CHARPOS (new_start
)))
15024 ++first_reusable_row
;
15026 /* Give up if there is no row to reuse. */
15027 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15028 || !first_reusable_row
->enabled_p
15029 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15030 != CHARPOS (new_start
)))
15033 /* We can reuse fully visible rows beginning with
15034 first_reusable_row to the end of the window. Set
15035 first_row_to_display to the first row that cannot be reused.
15036 Set pt_row to the row containing point, if there is any. */
15038 for (first_row_to_display
= first_reusable_row
;
15039 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15040 ++first_row_to_display
)
15042 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15043 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15044 pt_row
= first_row_to_display
;
15047 /* Start displaying at the start of first_row_to_display. */
15048 xassert (first_row_to_display
->y
< yb
);
15049 init_to_row_start (&it
, w
, first_row_to_display
);
15051 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15053 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15055 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15056 + WINDOW_HEADER_LINE_HEIGHT (w
));
15058 /* Display lines beginning with first_row_to_display in the
15059 desired matrix. Set last_text_row to the last row displayed
15060 that displays text. */
15061 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15062 if (pt_row
== NULL
)
15063 w
->cursor
.vpos
= -1;
15064 last_text_row
= NULL
;
15065 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15066 if (display_line (&it
))
15067 last_text_row
= it
.glyph_row
- 1;
15069 /* If point is in a reused row, adjust y and vpos of the cursor
15073 w
->cursor
.vpos
-= nrows_scrolled
;
15074 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15077 /* Give up if point isn't in a row displayed or reused. (This
15078 also handles the case where w->cursor.vpos < nrows_scrolled
15079 after the calls to display_line, which can happen with scroll
15080 margins. See bug#1295.) */
15081 if (w
->cursor
.vpos
< 0)
15083 clear_glyph_matrix (w
->desired_matrix
);
15087 /* Scroll the display. */
15088 run
.current_y
= first_reusable_row
->y
;
15089 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15090 run
.height
= it
.last_visible_y
- run
.current_y
;
15091 dy
= run
.current_y
- run
.desired_y
;
15096 FRAME_RIF (f
)->update_window_begin_hook (w
);
15097 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15098 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15099 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15103 /* Adjust Y positions of reused rows. */
15104 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15105 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15106 max_y
= it
.last_visible_y
;
15107 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15110 row
->visible_height
= row
->height
;
15111 if (row
->y
< min_y
)
15112 row
->visible_height
-= min_y
- row
->y
;
15113 if (row
->y
+ row
->height
> max_y
)
15114 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15115 if (row
->fringe_bitmap_periodic_p
)
15116 row
->redraw_fringe_bitmaps_p
= 1;
15119 /* Scroll the current matrix. */
15120 xassert (nrows_scrolled
> 0);
15121 rotate_matrix (w
->current_matrix
,
15123 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15126 /* Disable rows not reused. */
15127 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15128 row
->enabled_p
= 0;
15130 /* Point may have moved to a different line, so we cannot assume that
15131 the previous cursor position is valid; locate the correct row. */
15134 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15135 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15139 w
->cursor
.y
= row
->y
;
15141 if (row
< bottom_row
)
15143 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15144 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15146 /* Can't use this optimization with bidi-reordered glyph
15147 rows, unless cursor is already at point. */
15148 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15150 if (!(w
->cursor
.hpos
>= 0
15151 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15152 && BUFFERP (glyph
->object
)
15153 && glyph
->charpos
== PT
))
15158 && (!BUFFERP (glyph
->object
)
15159 || glyph
->charpos
< PT
);
15163 w
->cursor
.x
+= glyph
->pixel_width
;
15168 /* Adjust window end. A null value of last_text_row means that
15169 the window end is in reused rows which in turn means that
15170 only its vpos can have changed. */
15173 w
->window_end_bytepos
15174 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15176 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15178 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15183 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15186 w
->window_end_valid
= Qnil
;
15187 w
->desired_matrix
->no_scrolling_p
= 1;
15190 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15200 /************************************************************************
15201 Window redisplay reusing current matrix when buffer has changed
15202 ************************************************************************/
15204 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15205 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15206 EMACS_INT
*, EMACS_INT
*);
15207 static struct glyph_row
*
15208 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15209 struct glyph_row
*);
15212 /* Return the last row in MATRIX displaying text. If row START is
15213 non-null, start searching with that row. IT gives the dimensions
15214 of the display. Value is null if matrix is empty; otherwise it is
15215 a pointer to the row found. */
15217 static struct glyph_row
*
15218 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15219 struct glyph_row
*start
)
15221 struct glyph_row
*row
, *row_found
;
15223 /* Set row_found to the last row in IT->w's current matrix
15224 displaying text. The loop looks funny but think of partially
15227 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15228 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15230 xassert (row
->enabled_p
);
15232 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15241 /* Return the last row in the current matrix of W that is not affected
15242 by changes at the start of current_buffer that occurred since W's
15243 current matrix was built. Value is null if no such row exists.
15245 BEG_UNCHANGED us the number of characters unchanged at the start of
15246 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15247 first changed character in current_buffer. Characters at positions <
15248 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15249 when the current matrix was built. */
15251 static struct glyph_row
*
15252 find_last_unchanged_at_beg_row (struct window
*w
)
15254 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15255 struct glyph_row
*row
;
15256 struct glyph_row
*row_found
= NULL
;
15257 int yb
= window_text_bottom_y (w
);
15259 /* Find the last row displaying unchanged text. */
15260 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15261 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15262 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15265 if (/* If row ends before first_changed_pos, it is unchanged,
15266 except in some case. */
15267 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15268 /* When row ends in ZV and we write at ZV it is not
15270 && !row
->ends_at_zv_p
15271 /* When first_changed_pos is the end of a continued line,
15272 row is not unchanged because it may be no longer
15274 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15275 && (row
->continued_p
15276 || row
->exact_window_width_line_p
)))
15279 /* Stop if last visible row. */
15280 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15288 /* Find the first glyph row in the current matrix of W that is not
15289 affected by changes at the end of current_buffer since the
15290 time W's current matrix was built.
15292 Return in *DELTA the number of chars by which buffer positions in
15293 unchanged text at the end of current_buffer must be adjusted.
15295 Return in *DELTA_BYTES the corresponding number of bytes.
15297 Value is null if no such row exists, i.e. all rows are affected by
15300 static struct glyph_row
*
15301 find_first_unchanged_at_end_row (struct window
*w
,
15302 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15304 struct glyph_row
*row
;
15305 struct glyph_row
*row_found
= NULL
;
15307 *delta
= *delta_bytes
= 0;
15309 /* Display must not have been paused, otherwise the current matrix
15310 is not up to date. */
15311 eassert (!NILP (w
->window_end_valid
));
15313 /* A value of window_end_pos >= END_UNCHANGED means that the window
15314 end is in the range of changed text. If so, there is no
15315 unchanged row at the end of W's current matrix. */
15316 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15319 /* Set row to the last row in W's current matrix displaying text. */
15320 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15322 /* If matrix is entirely empty, no unchanged row exists. */
15323 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15325 /* The value of row is the last glyph row in the matrix having a
15326 meaningful buffer position in it. The end position of row
15327 corresponds to window_end_pos. This allows us to translate
15328 buffer positions in the current matrix to current buffer
15329 positions for characters not in changed text. */
15331 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15332 EMACS_INT Z_BYTE_old
=
15333 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15334 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15335 struct glyph_row
*first_text_row
15336 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15338 *delta
= Z
- Z_old
;
15339 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15341 /* Set last_unchanged_pos to the buffer position of the last
15342 character in the buffer that has not been changed. Z is the
15343 index + 1 of the last character in current_buffer, i.e. by
15344 subtracting END_UNCHANGED we get the index of the last
15345 unchanged character, and we have to add BEG to get its buffer
15347 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15348 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15350 /* Search backward from ROW for a row displaying a line that
15351 starts at a minimum position >= last_unchanged_pos_old. */
15352 for (; row
> first_text_row
; --row
)
15354 /* This used to abort, but it can happen.
15355 It is ok to just stop the search instead here. KFS. */
15356 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15359 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15364 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15370 /* Make sure that glyph rows in the current matrix of window W
15371 reference the same glyph memory as corresponding rows in the
15372 frame's frame matrix. This function is called after scrolling W's
15373 current matrix on a terminal frame in try_window_id and
15374 try_window_reusing_current_matrix. */
15377 sync_frame_with_window_matrix_rows (struct window
*w
)
15379 struct frame
*f
= XFRAME (w
->frame
);
15380 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15382 /* Preconditions: W must be a leaf window and full-width. Its frame
15383 must have a frame matrix. */
15384 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15385 xassert (WINDOW_FULL_WIDTH_P (w
));
15386 xassert (!FRAME_WINDOW_P (f
));
15388 /* If W is a full-width window, glyph pointers in W's current matrix
15389 have, by definition, to be the same as glyph pointers in the
15390 corresponding frame matrix. Note that frame matrices have no
15391 marginal areas (see build_frame_matrix). */
15392 window_row
= w
->current_matrix
->rows
;
15393 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15394 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15395 while (window_row
< window_row_end
)
15397 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15398 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15400 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15401 frame_row
->glyphs
[TEXT_AREA
] = start
;
15402 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15403 frame_row
->glyphs
[LAST_AREA
] = end
;
15405 /* Disable frame rows whose corresponding window rows have
15406 been disabled in try_window_id. */
15407 if (!window_row
->enabled_p
)
15408 frame_row
->enabled_p
= 0;
15410 ++window_row
, ++frame_row
;
15415 /* Find the glyph row in window W containing CHARPOS. Consider all
15416 rows between START and END (not inclusive). END null means search
15417 all rows to the end of the display area of W. Value is the row
15418 containing CHARPOS or null. */
15421 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15422 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15424 struct glyph_row
*row
= start
;
15425 struct glyph_row
*best_row
= NULL
;
15426 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15429 /* If we happen to start on a header-line, skip that. */
15430 if (row
->mode_line_p
)
15433 if ((end
&& row
>= end
) || !row
->enabled_p
)
15436 last_y
= window_text_bottom_y (w
) - dy
;
15440 /* Give up if we have gone too far. */
15441 if (end
&& row
>= end
)
15443 /* This formerly returned if they were equal.
15444 I think that both quantities are of a "last plus one" type;
15445 if so, when they are equal, the row is within the screen. -- rms. */
15446 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15449 /* If it is in this row, return this row. */
15450 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15451 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15452 /* The end position of a row equals the start
15453 position of the next row. If CHARPOS is there, we
15454 would rather display it in the next line, except
15455 when this line ends in ZV. */
15456 && !row
->ends_at_zv_p
15457 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15458 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15462 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15463 || (!best_row
&& !row
->continued_p
))
15465 /* In bidi-reordered rows, there could be several rows
15466 occluding point, all of them belonging to the same
15467 continued line. We need to find the row which fits
15468 CHARPOS the best. */
15469 for (g
= row
->glyphs
[TEXT_AREA
];
15470 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15473 if (!STRINGP (g
->object
))
15475 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15477 mindif
= eabs (g
->charpos
- charpos
);
15479 /* Exact match always wins. */
15486 else if (best_row
&& !row
->continued_p
)
15493 /* Try to redisplay window W by reusing its existing display. W's
15494 current matrix must be up to date when this function is called,
15495 i.e. window_end_valid must not be nil.
15499 1 if display has been updated
15500 0 if otherwise unsuccessful
15501 -1 if redisplay with same window start is known not to succeed
15503 The following steps are performed:
15505 1. Find the last row in the current matrix of W that is not
15506 affected by changes at the start of current_buffer. If no such row
15509 2. Find the first row in W's current matrix that is not affected by
15510 changes at the end of current_buffer. Maybe there is no such row.
15512 3. Display lines beginning with the row + 1 found in step 1 to the
15513 row found in step 2 or, if step 2 didn't find a row, to the end of
15516 4. If cursor is not known to appear on the window, give up.
15518 5. If display stopped at the row found in step 2, scroll the
15519 display and current matrix as needed.
15521 6. Maybe display some lines at the end of W, if we must. This can
15522 happen under various circumstances, like a partially visible line
15523 becoming fully visible, or because newly displayed lines are displayed
15524 in smaller font sizes.
15526 7. Update W's window end information. */
15529 try_window_id (struct window
*w
)
15531 struct frame
*f
= XFRAME (w
->frame
);
15532 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15533 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15534 struct glyph_row
*last_unchanged_at_beg_row
;
15535 struct glyph_row
*first_unchanged_at_end_row
;
15536 struct glyph_row
*row
;
15537 struct glyph_row
*bottom_row
;
15540 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15542 struct text_pos start_pos
;
15544 int first_unchanged_at_end_vpos
= 0;
15545 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15546 struct text_pos start
;
15547 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15550 if (inhibit_try_window_id
)
15554 /* This is handy for debugging. */
15556 #define GIVE_UP(X) \
15558 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15562 #define GIVE_UP(X) return 0
15565 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15567 /* Don't use this for mini-windows because these can show
15568 messages and mini-buffers, and we don't handle that here. */
15569 if (MINI_WINDOW_P (w
))
15572 /* This flag is used to prevent redisplay optimizations. */
15573 if (windows_or_buffers_changed
|| cursor_type_changed
)
15576 /* Verify that narrowing has not changed.
15577 Also verify that we were not told to prevent redisplay optimizations.
15578 It would be nice to further
15579 reduce the number of cases where this prevents try_window_id. */
15580 if (current_buffer
->clip_changed
15581 || current_buffer
->prevent_redisplay_optimizations_p
)
15584 /* Window must either use window-based redisplay or be full width. */
15585 if (!FRAME_WINDOW_P (f
)
15586 && (!FRAME_LINE_INS_DEL_OK (f
)
15587 || !WINDOW_FULL_WIDTH_P (w
)))
15590 /* Give up if point is known NOT to appear in W. */
15591 if (PT
< CHARPOS (start
))
15594 /* Another way to prevent redisplay optimizations. */
15595 if (XFASTINT (w
->last_modified
) == 0)
15598 /* Verify that window is not hscrolled. */
15599 if (XFASTINT (w
->hscroll
) != 0)
15602 /* Verify that display wasn't paused. */
15603 if (NILP (w
->window_end_valid
))
15606 /* Can't use this if highlighting a region because a cursor movement
15607 will do more than just set the cursor. */
15608 if (!NILP (Vtransient_mark_mode
)
15609 && !NILP (BVAR (current_buffer
, mark_active
)))
15612 /* Likewise if highlighting trailing whitespace. */
15613 if (!NILP (Vshow_trailing_whitespace
))
15616 /* Likewise if showing a region. */
15617 if (!NILP (w
->region_showing
))
15620 /* Can't use this if overlay arrow position and/or string have
15622 if (overlay_arrows_changed_p ())
15625 /* When word-wrap is on, adding a space to the first word of a
15626 wrapped line can change the wrap position, altering the line
15627 above it. It might be worthwhile to handle this more
15628 intelligently, but for now just redisplay from scratch. */
15629 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15632 /* Under bidi reordering, adding or deleting a character in the
15633 beginning of a paragraph, before the first strong directional
15634 character, can change the base direction of the paragraph (unless
15635 the buffer specifies a fixed paragraph direction), which will
15636 require to redisplay the whole paragraph. It might be worthwhile
15637 to find the paragraph limits and widen the range of redisplayed
15638 lines to that, but for now just give up this optimization and
15639 redisplay from scratch. */
15640 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15641 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15644 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15645 only if buffer has really changed. The reason is that the gap is
15646 initially at Z for freshly visited files. The code below would
15647 set end_unchanged to 0 in that case. */
15648 if (MODIFF
> SAVE_MODIFF
15649 /* This seems to happen sometimes after saving a buffer. */
15650 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15652 if (GPT
- BEG
< BEG_UNCHANGED
)
15653 BEG_UNCHANGED
= GPT
- BEG
;
15654 if (Z
- GPT
< END_UNCHANGED
)
15655 END_UNCHANGED
= Z
- GPT
;
15658 /* The position of the first and last character that has been changed. */
15659 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15660 last_changed_charpos
= Z
- END_UNCHANGED
;
15662 /* If window starts after a line end, and the last change is in
15663 front of that newline, then changes don't affect the display.
15664 This case happens with stealth-fontification. Note that although
15665 the display is unchanged, glyph positions in the matrix have to
15666 be adjusted, of course. */
15667 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15668 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15669 && ((last_changed_charpos
< CHARPOS (start
)
15670 && CHARPOS (start
) == BEGV
)
15671 || (last_changed_charpos
< CHARPOS (start
) - 1
15672 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15674 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15675 struct glyph_row
*r0
;
15677 /* Compute how many chars/bytes have been added to or removed
15678 from the buffer. */
15679 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15680 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15681 Z_delta
= Z
- Z_old
;
15682 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15684 /* Give up if PT is not in the window. Note that it already has
15685 been checked at the start of try_window_id that PT is not in
15686 front of the window start. */
15687 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15690 /* If window start is unchanged, we can reuse the whole matrix
15691 as is, after adjusting glyph positions. No need to compute
15692 the window end again, since its offset from Z hasn't changed. */
15693 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15694 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15695 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15696 /* PT must not be in a partially visible line. */
15697 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15698 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15700 /* Adjust positions in the glyph matrix. */
15701 if (Z_delta
|| Z_delta_bytes
)
15703 struct glyph_row
*r1
15704 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15705 increment_matrix_positions (w
->current_matrix
,
15706 MATRIX_ROW_VPOS (r0
, current_matrix
),
15707 MATRIX_ROW_VPOS (r1
, current_matrix
),
15708 Z_delta
, Z_delta_bytes
);
15711 /* Set the cursor. */
15712 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15714 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15721 /* Handle the case that changes are all below what is displayed in
15722 the window, and that PT is in the window. This shortcut cannot
15723 be taken if ZV is visible in the window, and text has been added
15724 there that is visible in the window. */
15725 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15726 /* ZV is not visible in the window, or there are no
15727 changes at ZV, actually. */
15728 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15729 || first_changed_charpos
== last_changed_charpos
))
15731 struct glyph_row
*r0
;
15733 /* Give up if PT is not in the window. Note that it already has
15734 been checked at the start of try_window_id that PT is not in
15735 front of the window start. */
15736 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15739 /* If window start is unchanged, we can reuse the whole matrix
15740 as is, without changing glyph positions since no text has
15741 been added/removed in front of the window end. */
15742 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15743 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15744 /* PT must not be in a partially visible line. */
15745 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15746 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15748 /* We have to compute the window end anew since text
15749 could have been added/removed after it. */
15751 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15752 w
->window_end_bytepos
15753 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15755 /* Set the cursor. */
15756 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15758 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15765 /* Give up if window start is in the changed area.
15767 The condition used to read
15769 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15771 but why that was tested escapes me at the moment. */
15772 if (CHARPOS (start
) >= first_changed_charpos
15773 && CHARPOS (start
) <= last_changed_charpos
)
15776 /* Check that window start agrees with the start of the first glyph
15777 row in its current matrix. Check this after we know the window
15778 start is not in changed text, otherwise positions would not be
15780 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15781 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15784 /* Give up if the window ends in strings. Overlay strings
15785 at the end are difficult to handle, so don't try. */
15786 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15787 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15790 /* Compute the position at which we have to start displaying new
15791 lines. Some of the lines at the top of the window might be
15792 reusable because they are not displaying changed text. Find the
15793 last row in W's current matrix not affected by changes at the
15794 start of current_buffer. Value is null if changes start in the
15795 first line of window. */
15796 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15797 if (last_unchanged_at_beg_row
)
15799 /* Avoid starting to display in the moddle of a character, a TAB
15800 for instance. This is easier than to set up the iterator
15801 exactly, and it's not a frequent case, so the additional
15802 effort wouldn't really pay off. */
15803 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15804 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15805 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15806 --last_unchanged_at_beg_row
;
15808 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15811 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15813 start_pos
= it
.current
.pos
;
15815 /* Start displaying new lines in the desired matrix at the same
15816 vpos we would use in the current matrix, i.e. below
15817 last_unchanged_at_beg_row. */
15818 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15820 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15821 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15823 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15827 /* There are no reusable lines at the start of the window.
15828 Start displaying in the first text line. */
15829 start_display (&it
, w
, start
);
15830 it
.vpos
= it
.first_vpos
;
15831 start_pos
= it
.current
.pos
;
15834 /* Find the first row that is not affected by changes at the end of
15835 the buffer. Value will be null if there is no unchanged row, in
15836 which case we must redisplay to the end of the window. delta
15837 will be set to the value by which buffer positions beginning with
15838 first_unchanged_at_end_row have to be adjusted due to text
15840 first_unchanged_at_end_row
15841 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15842 IF_DEBUG (debug_delta
= delta
);
15843 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15845 /* Set stop_pos to the buffer position up to which we will have to
15846 display new lines. If first_unchanged_at_end_row != NULL, this
15847 is the buffer position of the start of the line displayed in that
15848 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15849 that we don't stop at a buffer position. */
15851 if (first_unchanged_at_end_row
)
15853 xassert (last_unchanged_at_beg_row
== NULL
15854 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15856 /* If this is a continuation line, move forward to the next one
15857 that isn't. Changes in lines above affect this line.
15858 Caution: this may move first_unchanged_at_end_row to a row
15859 not displaying text. */
15860 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15861 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15862 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15863 < it
.last_visible_y
))
15864 ++first_unchanged_at_end_row
;
15866 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15867 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15868 >= it
.last_visible_y
))
15869 first_unchanged_at_end_row
= NULL
;
15872 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15874 first_unchanged_at_end_vpos
15875 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15876 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15879 else if (last_unchanged_at_beg_row
== NULL
)
15885 /* Either there is no unchanged row at the end, or the one we have
15886 now displays text. This is a necessary condition for the window
15887 end pos calculation at the end of this function. */
15888 xassert (first_unchanged_at_end_row
== NULL
15889 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15891 debug_last_unchanged_at_beg_vpos
15892 = (last_unchanged_at_beg_row
15893 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15895 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15897 #endif /* GLYPH_DEBUG != 0 */
15900 /* Display new lines. Set last_text_row to the last new line
15901 displayed which has text on it, i.e. might end up as being the
15902 line where the window_end_vpos is. */
15903 w
->cursor
.vpos
= -1;
15904 last_text_row
= NULL
;
15905 overlay_arrow_seen
= 0;
15906 while (it
.current_y
< it
.last_visible_y
15907 && !fonts_changed_p
15908 && (first_unchanged_at_end_row
== NULL
15909 || IT_CHARPOS (it
) < stop_pos
))
15911 if (display_line (&it
))
15912 last_text_row
= it
.glyph_row
- 1;
15915 if (fonts_changed_p
)
15919 /* Compute differences in buffer positions, y-positions etc. for
15920 lines reused at the bottom of the window. Compute what we can
15922 if (first_unchanged_at_end_row
15923 /* No lines reused because we displayed everything up to the
15924 bottom of the window. */
15925 && it
.current_y
< it
.last_visible_y
)
15928 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15930 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15931 run
.current_y
= first_unchanged_at_end_row
->y
;
15932 run
.desired_y
= run
.current_y
+ dy
;
15933 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15937 delta
= delta_bytes
= dvpos
= dy
15938 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15939 first_unchanged_at_end_row
= NULL
;
15941 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15944 /* Find the cursor if not already found. We have to decide whether
15945 PT will appear on this window (it sometimes doesn't, but this is
15946 not a very frequent case.) This decision has to be made before
15947 the current matrix is altered. A value of cursor.vpos < 0 means
15948 that PT is either in one of the lines beginning at
15949 first_unchanged_at_end_row or below the window. Don't care for
15950 lines that might be displayed later at the window end; as
15951 mentioned, this is not a frequent case. */
15952 if (w
->cursor
.vpos
< 0)
15954 /* Cursor in unchanged rows at the top? */
15955 if (PT
< CHARPOS (start_pos
)
15956 && last_unchanged_at_beg_row
)
15958 row
= row_containing_pos (w
, PT
,
15959 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15960 last_unchanged_at_beg_row
+ 1, 0);
15962 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15965 /* Start from first_unchanged_at_end_row looking for PT. */
15966 else if (first_unchanged_at_end_row
)
15968 row
= row_containing_pos (w
, PT
- delta
,
15969 first_unchanged_at_end_row
, NULL
, 0);
15971 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15972 delta_bytes
, dy
, dvpos
);
15975 /* Give up if cursor was not found. */
15976 if (w
->cursor
.vpos
< 0)
15978 clear_glyph_matrix (w
->desired_matrix
);
15983 /* Don't let the cursor end in the scroll margins. */
15985 int this_scroll_margin
, cursor_height
;
15987 this_scroll_margin
= max (0, scroll_margin
);
15988 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15989 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15990 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15992 if ((w
->cursor
.y
< this_scroll_margin
15993 && CHARPOS (start
) > BEGV
)
15994 /* Old redisplay didn't take scroll margin into account at the bottom,
15995 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15996 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15997 ? cursor_height
+ this_scroll_margin
15998 : 1)) > it
.last_visible_y
)
16000 w
->cursor
.vpos
= -1;
16001 clear_glyph_matrix (w
->desired_matrix
);
16006 /* Scroll the display. Do it before changing the current matrix so
16007 that xterm.c doesn't get confused about where the cursor glyph is
16009 if (dy
&& run
.height
)
16013 if (FRAME_WINDOW_P (f
))
16015 FRAME_RIF (f
)->update_window_begin_hook (w
);
16016 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16017 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16018 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16022 /* Terminal frame. In this case, dvpos gives the number of
16023 lines to scroll by; dvpos < 0 means scroll up. */
16025 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16026 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16027 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16028 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16029 + window_internal_height (w
));
16031 #if defined (HAVE_GPM) || defined (MSDOS)
16032 x_clear_window_mouse_face (w
);
16034 /* Perform the operation on the screen. */
16037 /* Scroll last_unchanged_at_beg_row to the end of the
16038 window down dvpos lines. */
16039 set_terminal_window (f
, end
);
16041 /* On dumb terminals delete dvpos lines at the end
16042 before inserting dvpos empty lines. */
16043 if (!FRAME_SCROLL_REGION_OK (f
))
16044 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16046 /* Insert dvpos empty lines in front of
16047 last_unchanged_at_beg_row. */
16048 ins_del_lines (f
, from
, dvpos
);
16050 else if (dvpos
< 0)
16052 /* Scroll up last_unchanged_at_beg_vpos to the end of
16053 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16054 set_terminal_window (f
, end
);
16056 /* Delete dvpos lines in front of
16057 last_unchanged_at_beg_vpos. ins_del_lines will set
16058 the cursor to the given vpos and emit |dvpos| delete
16060 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16062 /* On a dumb terminal insert dvpos empty lines at the
16064 if (!FRAME_SCROLL_REGION_OK (f
))
16065 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16068 set_terminal_window (f
, 0);
16074 /* Shift reused rows of the current matrix to the right position.
16075 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16077 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16078 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16081 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16082 bottom_vpos
, dvpos
);
16083 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16086 else if (dvpos
> 0)
16088 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16089 bottom_vpos
, dvpos
);
16090 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16091 first_unchanged_at_end_vpos
+ dvpos
, 0);
16094 /* For frame-based redisplay, make sure that current frame and window
16095 matrix are in sync with respect to glyph memory. */
16096 if (!FRAME_WINDOW_P (f
))
16097 sync_frame_with_window_matrix_rows (w
);
16099 /* Adjust buffer positions in reused rows. */
16100 if (delta
|| delta_bytes
)
16101 increment_matrix_positions (current_matrix
,
16102 first_unchanged_at_end_vpos
+ dvpos
,
16103 bottom_vpos
, delta
, delta_bytes
);
16105 /* Adjust Y positions. */
16107 shift_glyph_matrix (w
, current_matrix
,
16108 first_unchanged_at_end_vpos
+ dvpos
,
16111 if (first_unchanged_at_end_row
)
16113 first_unchanged_at_end_row
+= dvpos
;
16114 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16115 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16116 first_unchanged_at_end_row
= NULL
;
16119 /* If scrolling up, there may be some lines to display at the end of
16121 last_text_row_at_end
= NULL
;
16124 /* Scrolling up can leave for example a partially visible line
16125 at the end of the window to be redisplayed. */
16126 /* Set last_row to the glyph row in the current matrix where the
16127 window end line is found. It has been moved up or down in
16128 the matrix by dvpos. */
16129 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16130 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16132 /* If last_row is the window end line, it should display text. */
16133 xassert (last_row
->displays_text_p
);
16135 /* If window end line was partially visible before, begin
16136 displaying at that line. Otherwise begin displaying with the
16137 line following it. */
16138 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16140 init_to_row_start (&it
, w
, last_row
);
16141 it
.vpos
= last_vpos
;
16142 it
.current_y
= last_row
->y
;
16146 init_to_row_end (&it
, w
, last_row
);
16147 it
.vpos
= 1 + last_vpos
;
16148 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16152 /* We may start in a continuation line. If so, we have to
16153 get the right continuation_lines_width and current_x. */
16154 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16155 it
.hpos
= it
.current_x
= 0;
16157 /* Display the rest of the lines at the window end. */
16158 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16159 while (it
.current_y
< it
.last_visible_y
16160 && !fonts_changed_p
)
16162 /* Is it always sure that the display agrees with lines in
16163 the current matrix? I don't think so, so we mark rows
16164 displayed invalid in the current matrix by setting their
16165 enabled_p flag to zero. */
16166 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16167 if (display_line (&it
))
16168 last_text_row_at_end
= it
.glyph_row
- 1;
16172 /* Update window_end_pos and window_end_vpos. */
16173 if (first_unchanged_at_end_row
16174 && !last_text_row_at_end
)
16176 /* Window end line if one of the preserved rows from the current
16177 matrix. Set row to the last row displaying text in current
16178 matrix starting at first_unchanged_at_end_row, after
16180 xassert (first_unchanged_at_end_row
->displays_text_p
);
16181 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16182 first_unchanged_at_end_row
);
16183 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16185 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16186 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16188 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16189 xassert (w
->window_end_bytepos
>= 0);
16190 IF_DEBUG (debug_method_add (w
, "A"));
16192 else if (last_text_row_at_end
)
16195 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16196 w
->window_end_bytepos
16197 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16199 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16200 xassert (w
->window_end_bytepos
>= 0);
16201 IF_DEBUG (debug_method_add (w
, "B"));
16203 else if (last_text_row
)
16205 /* We have displayed either to the end of the window or at the
16206 end of the window, i.e. the last row with text is to be found
16207 in the desired matrix. */
16209 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16210 w
->window_end_bytepos
16211 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16213 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16214 xassert (w
->window_end_bytepos
>= 0);
16216 else if (first_unchanged_at_end_row
== NULL
16217 && last_text_row
== NULL
16218 && last_text_row_at_end
== NULL
)
16220 /* Displayed to end of window, but no line containing text was
16221 displayed. Lines were deleted at the end of the window. */
16222 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16223 int vpos
= XFASTINT (w
->window_end_vpos
);
16224 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16225 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16228 row
== NULL
&& vpos
>= first_vpos
;
16229 --vpos
, --current_row
, --desired_row
)
16231 if (desired_row
->enabled_p
)
16233 if (desired_row
->displays_text_p
)
16236 else if (current_row
->displays_text_p
)
16240 xassert (row
!= NULL
);
16241 w
->window_end_vpos
= make_number (vpos
+ 1);
16242 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16243 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16244 xassert (w
->window_end_bytepos
>= 0);
16245 IF_DEBUG (debug_method_add (w
, "C"));
16250 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16251 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16253 /* Record that display has not been completed. */
16254 w
->window_end_valid
= Qnil
;
16255 w
->desired_matrix
->no_scrolling_p
= 1;
16263 /***********************************************************************
16264 More debugging support
16265 ***********************************************************************/
16269 void dump_glyph_row (struct glyph_row
*, int, int);
16270 void dump_glyph_matrix (struct glyph_matrix
*, int);
16271 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16274 /* Dump the contents of glyph matrix MATRIX on stderr.
16276 GLYPHS 0 means don't show glyph contents.
16277 GLYPHS 1 means show glyphs in short form
16278 GLYPHS > 1 means show glyphs in long form. */
16281 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
16284 for (i
= 0; i
< matrix
->nrows
; ++i
)
16285 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16289 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16290 the glyph row and area where the glyph comes from. */
16293 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
16295 if (glyph
->type
== CHAR_GLYPH
)
16298 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16299 glyph
- row
->glyphs
[TEXT_AREA
],
16302 (BUFFERP (glyph
->object
)
16304 : (STRINGP (glyph
->object
)
16307 glyph
->pixel_width
,
16309 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16313 glyph
->left_box_line_p
,
16314 glyph
->right_box_line_p
);
16316 else if (glyph
->type
== STRETCH_GLYPH
)
16319 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16320 glyph
- row
->glyphs
[TEXT_AREA
],
16323 (BUFFERP (glyph
->object
)
16325 : (STRINGP (glyph
->object
)
16328 glyph
->pixel_width
,
16332 glyph
->left_box_line_p
,
16333 glyph
->right_box_line_p
);
16335 else if (glyph
->type
== IMAGE_GLYPH
)
16338 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16339 glyph
- row
->glyphs
[TEXT_AREA
],
16342 (BUFFERP (glyph
->object
)
16344 : (STRINGP (glyph
->object
)
16347 glyph
->pixel_width
,
16351 glyph
->left_box_line_p
,
16352 glyph
->right_box_line_p
);
16354 else if (glyph
->type
== COMPOSITE_GLYPH
)
16357 " %5d %4c %6d %c %3d 0x%05x",
16358 glyph
- row
->glyphs
[TEXT_AREA
],
16361 (BUFFERP (glyph
->object
)
16363 : (STRINGP (glyph
->object
)
16366 glyph
->pixel_width
,
16368 if (glyph
->u
.cmp
.automatic
)
16371 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16372 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16374 glyph
->left_box_line_p
,
16375 glyph
->right_box_line_p
);
16380 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16381 GLYPHS 0 means don't show glyph contents.
16382 GLYPHS 1 means show glyphs in short form
16383 GLYPHS > 1 means show glyphs in long form. */
16386 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
16390 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16391 fprintf (stderr
, "======================================================================\n");
16393 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16394 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16396 MATRIX_ROW_START_CHARPOS (row
),
16397 MATRIX_ROW_END_CHARPOS (row
),
16398 row
->used
[TEXT_AREA
],
16399 row
->contains_overlapping_glyphs_p
,
16401 row
->truncated_on_left_p
,
16402 row
->truncated_on_right_p
,
16404 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16405 row
->displays_text_p
,
16408 row
->ends_in_middle_of_char_p
,
16409 row
->starts_in_middle_of_char_p
,
16415 row
->visible_height
,
16418 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16419 row
->end
.overlay_string_index
,
16420 row
->continuation_lines_width
);
16421 fprintf (stderr
, "%9d %5d\n",
16422 CHARPOS (row
->start
.string_pos
),
16423 CHARPOS (row
->end
.string_pos
));
16424 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16425 row
->end
.dpvec_index
);
16432 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16434 struct glyph
*glyph
= row
->glyphs
[area
];
16435 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16437 /* Glyph for a line end in text. */
16438 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16441 if (glyph
< glyph_end
)
16442 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16444 for (; glyph
< glyph_end
; ++glyph
)
16445 dump_glyph (row
, glyph
, area
);
16448 else if (glyphs
== 1)
16452 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16454 char *s
= (char *) alloca (row
->used
[area
] + 1);
16457 for (i
= 0; i
< row
->used
[area
]; ++i
)
16459 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16460 if (glyph
->type
== CHAR_GLYPH
16461 && glyph
->u
.ch
< 0x80
16462 && glyph
->u
.ch
>= ' ')
16463 s
[i
] = glyph
->u
.ch
;
16469 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16475 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16476 Sdump_glyph_matrix
, 0, 1, "p",
16477 doc
: /* Dump the current matrix of the selected window to stderr.
16478 Shows contents of glyph row structures. With non-nil
16479 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16480 glyphs in short form, otherwise show glyphs in long form. */)
16481 (Lisp_Object glyphs
)
16483 struct window
*w
= XWINDOW (selected_window
);
16484 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16486 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16487 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16488 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16489 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16490 fprintf (stderr
, "=============================================\n");
16491 dump_glyph_matrix (w
->current_matrix
,
16492 NILP (glyphs
) ? 0 : XINT (glyphs
));
16497 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16498 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16501 struct frame
*f
= XFRAME (selected_frame
);
16502 dump_glyph_matrix (f
->current_matrix
, 1);
16507 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16508 doc
: /* Dump glyph row ROW to stderr.
16509 GLYPH 0 means don't dump glyphs.
16510 GLYPH 1 means dump glyphs in short form.
16511 GLYPH > 1 or omitted means dump glyphs in long form. */)
16512 (Lisp_Object row
, Lisp_Object glyphs
)
16514 struct glyph_matrix
*matrix
;
16517 CHECK_NUMBER (row
);
16518 matrix
= XWINDOW (selected_window
)->current_matrix
;
16520 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16521 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16523 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16528 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16529 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16530 GLYPH 0 means don't dump glyphs.
16531 GLYPH 1 means dump glyphs in short form.
16532 GLYPH > 1 or omitted means dump glyphs in long form. */)
16533 (Lisp_Object row
, Lisp_Object glyphs
)
16535 struct frame
*sf
= SELECTED_FRAME ();
16536 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16539 CHECK_NUMBER (row
);
16541 if (vpos
>= 0 && vpos
< m
->nrows
)
16542 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16543 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16548 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16549 doc
: /* Toggle tracing of redisplay.
16550 With ARG, turn tracing on if and only if ARG is positive. */)
16554 trace_redisplay_p
= !trace_redisplay_p
;
16557 arg
= Fprefix_numeric_value (arg
);
16558 trace_redisplay_p
= XINT (arg
) > 0;
16565 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16566 doc
: /* Like `format', but print result to stderr.
16567 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16568 (ptrdiff_t nargs
, Lisp_Object
*args
)
16570 Lisp_Object s
= Fformat (nargs
, args
);
16571 fprintf (stderr
, "%s", SDATA (s
));
16575 #endif /* GLYPH_DEBUG */
16579 /***********************************************************************
16580 Building Desired Matrix Rows
16581 ***********************************************************************/
16583 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16584 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16586 static struct glyph_row
*
16587 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16589 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16590 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16591 struct buffer
*old
= current_buffer
;
16592 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16593 int arrow_len
= SCHARS (overlay_arrow_string
);
16594 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16595 const unsigned char *p
;
16598 int n_glyphs_before
;
16600 set_buffer_temp (buffer
);
16601 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16602 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16603 SET_TEXT_POS (it
.position
, 0, 0);
16605 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16607 while (p
< arrow_end
)
16609 Lisp_Object face
, ilisp
;
16611 /* Get the next character. */
16613 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16616 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16617 if (! ASCII_CHAR_P (it
.c
))
16618 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16622 /* Get its face. */
16623 ilisp
= make_number (p
- arrow_string
);
16624 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16625 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16627 /* Compute its width, get its glyphs. */
16628 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16629 SET_TEXT_POS (it
.position
, -1, -1);
16630 PRODUCE_GLYPHS (&it
);
16632 /* If this character doesn't fit any more in the line, we have
16633 to remove some glyphs. */
16634 if (it
.current_x
> it
.last_visible_x
)
16636 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16641 set_buffer_temp (old
);
16642 return it
.glyph_row
;
16646 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16647 glyphs are only inserted for terminal frames since we can't really
16648 win with truncation glyphs when partially visible glyphs are
16649 involved. Which glyphs to insert is determined by
16650 produce_special_glyphs. */
16653 insert_left_trunc_glyphs (struct it
*it
)
16655 struct it truncate_it
;
16656 struct glyph
*from
, *end
, *to
, *toend
;
16658 xassert (!FRAME_WINDOW_P (it
->f
));
16660 /* Get the truncation glyphs. */
16662 truncate_it
.current_x
= 0;
16663 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16664 truncate_it
.glyph_row
= &scratch_glyph_row
;
16665 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16666 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16667 truncate_it
.object
= make_number (0);
16668 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16670 /* Overwrite glyphs from IT with truncation glyphs. */
16671 if (!it
->glyph_row
->reversed_p
)
16673 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16674 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16675 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16676 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16681 /* There may be padding glyphs left over. Overwrite them too. */
16682 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16684 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16690 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16694 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16695 that back to front. */
16696 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16697 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16698 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16699 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16701 while (from
>= end
&& to
>= toend
)
16703 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16706 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16707 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16708 while (from
>= end
&& to
>= toend
)
16713 /* Need to free some room before prepending additional
16715 int move_by
= from
- end
+ 1;
16716 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16717 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16719 for ( ; g
>= g0
; g
--)
16721 while (from
>= end
)
16723 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16729 /* Compute the pixel height and width of IT->glyph_row.
16731 Most of the time, ascent and height of a display line will be equal
16732 to the max_ascent and max_height values of the display iterator
16733 structure. This is not the case if
16735 1. We hit ZV without displaying anything. In this case, max_ascent
16736 and max_height will be zero.
16738 2. We have some glyphs that don't contribute to the line height.
16739 (The glyph row flag contributes_to_line_height_p is for future
16740 pixmap extensions).
16742 The first case is easily covered by using default values because in
16743 these cases, the line height does not really matter, except that it
16744 must not be zero. */
16747 compute_line_metrics (struct it
*it
)
16749 struct glyph_row
*row
= it
->glyph_row
;
16751 if (FRAME_WINDOW_P (it
->f
))
16753 int i
, min_y
, max_y
;
16755 /* The line may consist of one space only, that was added to
16756 place the cursor on it. If so, the row's height hasn't been
16758 if (row
->height
== 0)
16760 if (it
->max_ascent
+ it
->max_descent
== 0)
16761 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16762 row
->ascent
= it
->max_ascent
;
16763 row
->height
= it
->max_ascent
+ it
->max_descent
;
16764 row
->phys_ascent
= it
->max_phys_ascent
;
16765 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16766 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16769 /* Compute the width of this line. */
16770 row
->pixel_width
= row
->x
;
16771 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16772 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16774 xassert (row
->pixel_width
>= 0);
16775 xassert (row
->ascent
>= 0 && row
->height
> 0);
16777 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16778 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16780 /* If first line's physical ascent is larger than its logical
16781 ascent, use the physical ascent, and make the row taller.
16782 This makes accented characters fully visible. */
16783 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16784 && row
->phys_ascent
> row
->ascent
)
16786 row
->height
+= row
->phys_ascent
- row
->ascent
;
16787 row
->ascent
= row
->phys_ascent
;
16790 /* Compute how much of the line is visible. */
16791 row
->visible_height
= row
->height
;
16793 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16794 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16796 if (row
->y
< min_y
)
16797 row
->visible_height
-= min_y
- row
->y
;
16798 if (row
->y
+ row
->height
> max_y
)
16799 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16803 row
->pixel_width
= row
->used
[TEXT_AREA
];
16804 if (row
->continued_p
)
16805 row
->pixel_width
-= it
->continuation_pixel_width
;
16806 else if (row
->truncated_on_right_p
)
16807 row
->pixel_width
-= it
->truncation_pixel_width
;
16808 row
->ascent
= row
->phys_ascent
= 0;
16809 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16810 row
->extra_line_spacing
= 0;
16813 /* Compute a hash code for this row. */
16817 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16818 for (i
= 0; i
< row
->used
[area
]; ++i
)
16819 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16820 + row
->glyphs
[area
][i
].u
.val
16821 + row
->glyphs
[area
][i
].face_id
16822 + row
->glyphs
[area
][i
].padding_p
16823 + (row
->glyphs
[area
][i
].type
<< 2));
16826 it
->max_ascent
= it
->max_descent
= 0;
16827 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16831 /* Append one space to the glyph row of iterator IT if doing a
16832 window-based redisplay. The space has the same face as
16833 IT->face_id. Value is non-zero if a space was added.
16835 This function is called to make sure that there is always one glyph
16836 at the end of a glyph row that the cursor can be set on under
16837 window-systems. (If there weren't such a glyph we would not know
16838 how wide and tall a box cursor should be displayed).
16840 At the same time this space let's a nicely handle clearing to the
16841 end of the line if the row ends in italic text. */
16844 append_space_for_newline (struct it
*it
, int default_face_p
)
16846 if (FRAME_WINDOW_P (it
->f
))
16848 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16850 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16851 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16853 /* Save some values that must not be changed.
16854 Must save IT->c and IT->len because otherwise
16855 ITERATOR_AT_END_P wouldn't work anymore after
16856 append_space_for_newline has been called. */
16857 enum display_element_type saved_what
= it
->what
;
16858 int saved_c
= it
->c
, saved_len
= it
->len
;
16859 int saved_char_to_display
= it
->char_to_display
;
16860 int saved_x
= it
->current_x
;
16861 int saved_face_id
= it
->face_id
;
16862 struct text_pos saved_pos
;
16863 Lisp_Object saved_object
;
16866 saved_object
= it
->object
;
16867 saved_pos
= it
->position
;
16869 it
->what
= IT_CHARACTER
;
16870 memset (&it
->position
, 0, sizeof it
->position
);
16871 it
->object
= make_number (0);
16872 it
->c
= it
->char_to_display
= ' ';
16875 if (default_face_p
)
16876 it
->face_id
= DEFAULT_FACE_ID
;
16877 else if (it
->face_before_selective_p
)
16878 it
->face_id
= it
->saved_face_id
;
16879 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16880 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16882 PRODUCE_GLYPHS (it
);
16884 it
->override_ascent
= -1;
16885 it
->constrain_row_ascent_descent_p
= 0;
16886 it
->current_x
= saved_x
;
16887 it
->object
= saved_object
;
16888 it
->position
= saved_pos
;
16889 it
->what
= saved_what
;
16890 it
->face_id
= saved_face_id
;
16891 it
->len
= saved_len
;
16893 it
->char_to_display
= saved_char_to_display
;
16902 /* Extend the face of the last glyph in the text area of IT->glyph_row
16903 to the end of the display line. Called from display_line. If the
16904 glyph row is empty, add a space glyph to it so that we know the
16905 face to draw. Set the glyph row flag fill_line_p. If the glyph
16906 row is R2L, prepend a stretch glyph to cover the empty space to the
16907 left of the leftmost glyph. */
16910 extend_face_to_end_of_line (struct it
*it
)
16913 struct frame
*f
= it
->f
;
16915 /* If line is already filled, do nothing. Non window-system frames
16916 get a grace of one more ``pixel'' because their characters are
16917 1-``pixel'' wide, so they hit the equality too early. This grace
16918 is needed only for R2L rows that are not continued, to produce
16919 one extra blank where we could display the cursor. */
16920 if (it
->current_x
>= it
->last_visible_x
16921 + (!FRAME_WINDOW_P (f
)
16922 && it
->glyph_row
->reversed_p
16923 && !it
->glyph_row
->continued_p
))
16926 /* Face extension extends the background and box of IT->face_id
16927 to the end of the line. If the background equals the background
16928 of the frame, we don't have to do anything. */
16929 if (it
->face_before_selective_p
)
16930 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16932 face
= FACE_FROM_ID (f
, it
->face_id
);
16934 if (FRAME_WINDOW_P (f
)
16935 && it
->glyph_row
->displays_text_p
16936 && face
->box
== FACE_NO_BOX
16937 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16939 && !it
->glyph_row
->reversed_p
)
16942 /* Set the glyph row flag indicating that the face of the last glyph
16943 in the text area has to be drawn to the end of the text area. */
16944 it
->glyph_row
->fill_line_p
= 1;
16946 /* If current character of IT is not ASCII, make sure we have the
16947 ASCII face. This will be automatically undone the next time
16948 get_next_display_element returns a multibyte character. Note
16949 that the character will always be single byte in unibyte
16951 if (!ASCII_CHAR_P (it
->c
))
16953 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16956 if (FRAME_WINDOW_P (f
))
16958 /* If the row is empty, add a space with the current face of IT,
16959 so that we know which face to draw. */
16960 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16962 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16963 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16964 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16966 #ifdef HAVE_WINDOW_SYSTEM
16967 if (it
->glyph_row
->reversed_p
)
16969 /* Prepend a stretch glyph to the row, such that the
16970 rightmost glyph will be drawn flushed all the way to the
16971 right margin of the window. The stretch glyph that will
16972 occupy the empty space, if any, to the left of the
16974 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16975 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16976 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16978 int row_width
, stretch_ascent
, stretch_width
;
16979 struct text_pos saved_pos
;
16980 int saved_face_id
, saved_avoid_cursor
;
16982 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16983 row_width
+= g
->pixel_width
;
16984 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16985 if (stretch_width
> 0)
16988 (((it
->ascent
+ it
->descent
)
16989 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16990 saved_pos
= it
->position
;
16991 memset (&it
->position
, 0, sizeof it
->position
);
16992 saved_avoid_cursor
= it
->avoid_cursor_p
;
16993 it
->avoid_cursor_p
= 1;
16994 saved_face_id
= it
->face_id
;
16995 /* The last row's stretch glyph should get the default
16996 face, to avoid painting the rest of the window with
16997 the region face, if the region ends at ZV. */
16998 if (it
->glyph_row
->ends_at_zv_p
)
16999 it
->face_id
= DEFAULT_FACE_ID
;
17001 it
->face_id
= face
->id
;
17002 append_stretch_glyph (it
, make_number (0), stretch_width
,
17003 it
->ascent
+ it
->descent
, stretch_ascent
);
17004 it
->position
= saved_pos
;
17005 it
->avoid_cursor_p
= saved_avoid_cursor
;
17006 it
->face_id
= saved_face_id
;
17009 #endif /* HAVE_WINDOW_SYSTEM */
17013 /* Save some values that must not be changed. */
17014 int saved_x
= it
->current_x
;
17015 struct text_pos saved_pos
;
17016 Lisp_Object saved_object
;
17017 enum display_element_type saved_what
= it
->what
;
17018 int saved_face_id
= it
->face_id
;
17020 saved_object
= it
->object
;
17021 saved_pos
= it
->position
;
17023 it
->what
= IT_CHARACTER
;
17024 memset (&it
->position
, 0, sizeof it
->position
);
17025 it
->object
= make_number (0);
17026 it
->c
= it
->char_to_display
= ' ';
17028 /* The last row's blank glyphs should get the default face, to
17029 avoid painting the rest of the window with the region face,
17030 if the region ends at ZV. */
17031 if (it
->glyph_row
->ends_at_zv_p
)
17032 it
->face_id
= DEFAULT_FACE_ID
;
17034 it
->face_id
= face
->id
;
17036 PRODUCE_GLYPHS (it
);
17038 while (it
->current_x
<= it
->last_visible_x
)
17039 PRODUCE_GLYPHS (it
);
17041 /* Don't count these blanks really. It would let us insert a left
17042 truncation glyph below and make us set the cursor on them, maybe. */
17043 it
->current_x
= saved_x
;
17044 it
->object
= saved_object
;
17045 it
->position
= saved_pos
;
17046 it
->what
= saved_what
;
17047 it
->face_id
= saved_face_id
;
17052 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17053 trailing whitespace. */
17056 trailing_whitespace_p (EMACS_INT charpos
)
17058 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17061 while (bytepos
< ZV_BYTE
17062 && (c
= FETCH_CHAR (bytepos
),
17063 c
== ' ' || c
== '\t'))
17066 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17068 if (bytepos
!= PT_BYTE
)
17075 /* Highlight trailing whitespace, if any, in ROW. */
17078 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17080 int used
= row
->used
[TEXT_AREA
];
17084 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17085 struct glyph
*glyph
= start
+ used
- 1;
17087 if (row
->reversed_p
)
17089 /* Right-to-left rows need to be processed in the opposite
17090 direction, so swap the edge pointers. */
17092 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17095 /* Skip over glyphs inserted to display the cursor at the
17096 end of a line, for extending the face of the last glyph
17097 to the end of the line on terminals, and for truncation
17098 and continuation glyphs. */
17099 if (!row
->reversed_p
)
17101 while (glyph
>= start
17102 && glyph
->type
== CHAR_GLYPH
17103 && INTEGERP (glyph
->object
))
17108 while (glyph
<= start
17109 && glyph
->type
== CHAR_GLYPH
17110 && INTEGERP (glyph
->object
))
17114 /* If last glyph is a space or stretch, and it's trailing
17115 whitespace, set the face of all trailing whitespace glyphs in
17116 IT->glyph_row to `trailing-whitespace'. */
17117 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17118 && BUFFERP (glyph
->object
)
17119 && (glyph
->type
== STRETCH_GLYPH
17120 || (glyph
->type
== CHAR_GLYPH
17121 && glyph
->u
.ch
== ' '))
17122 && trailing_whitespace_p (glyph
->charpos
))
17124 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17128 if (!row
->reversed_p
)
17130 while (glyph
>= start
17131 && BUFFERP (glyph
->object
)
17132 && (glyph
->type
== STRETCH_GLYPH
17133 || (glyph
->type
== CHAR_GLYPH
17134 && glyph
->u
.ch
== ' ')))
17135 (glyph
--)->face_id
= face_id
;
17139 while (glyph
<= start
17140 && BUFFERP (glyph
->object
)
17141 && (glyph
->type
== STRETCH_GLYPH
17142 || (glyph
->type
== CHAR_GLYPH
17143 && glyph
->u
.ch
== ' ')))
17144 (glyph
++)->face_id
= face_id
;
17151 /* Value is non-zero if glyph row ROW should be
17152 used to hold the cursor. */
17155 cursor_row_p (struct glyph_row
*row
)
17159 if (PT
== CHARPOS (row
->end
.pos
))
17161 /* Suppose the row ends on a string.
17162 Unless the row is continued, that means it ends on a newline
17163 in the string. If it's anything other than a display string
17164 (e.g. a before-string from an overlay), we don't want the
17165 cursor there. (This heuristic seems to give the optimal
17166 behavior for the various types of multi-line strings.) */
17167 if (CHARPOS (row
->end
.string_pos
) >= 0)
17169 if (row
->continued_p
)
17173 /* Check for `display' property. */
17174 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17175 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17176 struct glyph
*glyph
;
17179 for (glyph
= end
; glyph
>= beg
; --glyph
)
17180 if (STRINGP (glyph
->object
))
17183 = Fget_char_property (make_number (PT
),
17187 && display_prop_string_p (prop
, glyph
->object
));
17192 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17194 /* If the row ends in middle of a real character,
17195 and the line is continued, we want the cursor here.
17196 That's because CHARPOS (ROW->end.pos) would equal
17197 PT if PT is before the character. */
17198 if (!row
->ends_in_ellipsis_p
)
17199 result
= row
->continued_p
;
17201 /* If the row ends in an ellipsis, then
17202 CHARPOS (ROW->end.pos) will equal point after the
17203 invisible text. We want that position to be displayed
17204 after the ellipsis. */
17207 /* If the row ends at ZV, display the cursor at the end of that
17208 row instead of at the start of the row below. */
17209 else if (row
->ends_at_zv_p
)
17220 /* Push the display property PROP so that it will be rendered at the
17221 current position in IT. Return 1 if PROP was successfully pushed,
17225 push_display_prop (struct it
*it
, Lisp_Object prop
)
17227 push_it (it
, NULL
);
17229 if (STRINGP (prop
))
17231 if (SCHARS (prop
) == 0)
17238 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17239 it
->current
.overlay_string_index
= -1;
17240 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17241 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17242 it
->method
= GET_FROM_STRING
;
17243 it
->stop_charpos
= 0;
17245 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17247 it
->method
= GET_FROM_STRETCH
;
17250 #ifdef HAVE_WINDOW_SYSTEM
17251 else if (IMAGEP (prop
))
17253 it
->what
= IT_IMAGE
;
17254 it
->image_id
= lookup_image (it
->f
, prop
);
17255 it
->method
= GET_FROM_IMAGE
;
17257 #endif /* HAVE_WINDOW_SYSTEM */
17260 pop_it (it
); /* bogus display property, give up */
17267 /* Return the character-property PROP at the current position in IT. */
17270 get_it_property (struct it
*it
, Lisp_Object prop
)
17272 Lisp_Object position
;
17274 if (STRINGP (it
->object
))
17275 position
= make_number (IT_STRING_CHARPOS (*it
));
17276 else if (BUFFERP (it
->object
))
17277 position
= make_number (IT_CHARPOS (*it
));
17281 return Fget_char_property (position
, prop
, it
->object
);
17284 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17287 handle_line_prefix (struct it
*it
)
17289 Lisp_Object prefix
;
17290 if (it
->continuation_lines_width
> 0)
17292 prefix
= get_it_property (it
, Qwrap_prefix
);
17294 prefix
= Vwrap_prefix
;
17298 prefix
= get_it_property (it
, Qline_prefix
);
17300 prefix
= Vline_prefix
;
17302 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17304 /* If the prefix is wider than the window, and we try to wrap
17305 it, it would acquire its own wrap prefix, and so on till the
17306 iterator stack overflows. So, don't wrap the prefix. */
17307 it
->line_wrap
= TRUNCATE
;
17308 it
->avoid_cursor_p
= 1;
17314 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17315 only for R2L lines from display_line, when it decides that too many
17316 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17319 unproduce_glyphs (struct it
*it
, int n
)
17321 struct glyph
*glyph
, *end
;
17323 xassert (it
->glyph_row
);
17324 xassert (it
->glyph_row
->reversed_p
);
17325 xassert (it
->area
== TEXT_AREA
);
17326 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17328 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17329 n
= it
->glyph_row
->used
[TEXT_AREA
];
17330 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17331 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17332 for ( ; glyph
< end
; glyph
++)
17333 glyph
[-n
] = *glyph
;
17336 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17337 and ROW->maxpos. */
17339 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17340 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17341 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17343 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17344 lines' rows is implemented for bidi-reordered rows. */
17346 /* ROW->minpos is the value of min_pos, the minimal buffer position
17349 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17351 /* We didn't find _any_ valid buffer positions in any of the
17352 glyphs, so we must trust the iterator's computed positions. */
17353 row
->minpos
= row
->start
.pos
;
17356 max_pos
= CHARPOS (it
->current
.pos
);
17357 max_bpos
= BYTEPOS (it
->current
.pos
);
17360 /* Here are the various use-cases for ending the row, and the
17361 corresponding values for ROW->maxpos:
17363 Line ends in a newline from buffer eol_pos + 1
17364 Line is continued from buffer max_pos + 1
17365 Line is truncated on right it->current.pos
17366 Line ends in a newline from string max_pos
17367 Line is continued from string max_pos
17368 Line is continued from display vector max_pos
17369 Line is entirely from a string min_pos == max_pos
17370 Line is entirely from a display vector min_pos == max_pos
17371 Line that ends at ZV ZV
17373 If you discover other use-cases, please add them here as
17375 if (row
->ends_at_zv_p
)
17376 row
->maxpos
= it
->current
.pos
;
17377 else if (row
->used
[TEXT_AREA
])
17379 if (row
->ends_in_newline_from_string_p
)
17380 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17381 else if (CHARPOS (it
->eol_pos
) > 0)
17382 SET_TEXT_POS (row
->maxpos
,
17383 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17384 else if (row
->continued_p
)
17386 /* If max_pos is different from IT's current position, it
17387 means IT->method does not belong to the display element
17388 at max_pos. However, it also means that the display
17389 element at max_pos was displayed in its entirety on this
17390 line, which is equivalent to saying that the next line
17391 starts at the next buffer position. */
17392 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17393 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17396 INC_BOTH (max_pos
, max_bpos
);
17397 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17400 else if (row
->truncated_on_right_p
)
17401 /* display_line already called reseat_at_next_visible_line_start,
17402 which puts the iterator at the beginning of the next line, in
17403 the logical order. */
17404 row
->maxpos
= it
->current
.pos
;
17405 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17406 /* A line that is entirely from a string/image/stretch... */
17407 row
->maxpos
= row
->minpos
;
17412 row
->maxpos
= it
->current
.pos
;
17415 /* Construct the glyph row IT->glyph_row in the desired matrix of
17416 IT->w from text at the current position of IT. See dispextern.h
17417 for an overview of struct it. Value is non-zero if
17418 IT->glyph_row displays text, as opposed to a line displaying ZV
17422 display_line (struct it
*it
)
17424 struct glyph_row
*row
= it
->glyph_row
;
17425 Lisp_Object overlay_arrow_string
;
17427 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17428 int wrap_row_used
= -1;
17429 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17430 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17431 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17432 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17433 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17435 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17436 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17438 /* We always start displaying at hpos zero even if hscrolled. */
17439 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17441 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17442 >= it
->w
->desired_matrix
->nrows
)
17444 it
->w
->nrows_scale_factor
++;
17445 fonts_changed_p
= 1;
17449 /* Is IT->w showing the region? */
17450 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17452 /* Clear the result glyph row and enable it. */
17453 prepare_desired_row (row
);
17455 row
->y
= it
->current_y
;
17456 row
->start
= it
->start
;
17457 row
->continuation_lines_width
= it
->continuation_lines_width
;
17458 row
->displays_text_p
= 1;
17459 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17460 it
->starts_in_middle_of_char_p
= 0;
17462 /* Arrange the overlays nicely for our purposes. Usually, we call
17463 display_line on only one line at a time, in which case this
17464 can't really hurt too much, or we call it on lines which appear
17465 one after another in the buffer, in which case all calls to
17466 recenter_overlay_lists but the first will be pretty cheap. */
17467 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17469 /* Move over display elements that are not visible because we are
17470 hscrolled. This may stop at an x-position < IT->first_visible_x
17471 if the first glyph is partially visible or if we hit a line end. */
17472 if (it
->current_x
< it
->first_visible_x
)
17474 this_line_min_pos
= row
->start
.pos
;
17475 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17476 MOVE_TO_POS
| MOVE_TO_X
);
17477 /* Record the smallest positions seen while we moved over
17478 display elements that are not visible. This is needed by
17479 redisplay_internal for optimizing the case where the cursor
17480 stays inside the same line. The rest of this function only
17481 considers positions that are actually displayed, so
17482 RECORD_MAX_MIN_POS will not otherwise record positions that
17483 are hscrolled to the left of the left edge of the window. */
17484 min_pos
= CHARPOS (this_line_min_pos
);
17485 min_bpos
= BYTEPOS (this_line_min_pos
);
17489 /* We only do this when not calling `move_it_in_display_line_to'
17490 above, because move_it_in_display_line_to calls
17491 handle_line_prefix itself. */
17492 handle_line_prefix (it
);
17495 /* Get the initial row height. This is either the height of the
17496 text hscrolled, if there is any, or zero. */
17497 row
->ascent
= it
->max_ascent
;
17498 row
->height
= it
->max_ascent
+ it
->max_descent
;
17499 row
->phys_ascent
= it
->max_phys_ascent
;
17500 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17501 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17503 /* Utility macro to record max and min buffer positions seen until now. */
17504 #define RECORD_MAX_MIN_POS(IT) \
17507 if (IT_CHARPOS (*(IT)) < min_pos) \
17509 min_pos = IT_CHARPOS (*(IT)); \
17510 min_bpos = IT_BYTEPOS (*(IT)); \
17512 if (IT_CHARPOS (*(IT)) > max_pos) \
17514 max_pos = IT_CHARPOS (*(IT)); \
17515 max_bpos = IT_BYTEPOS (*(IT)); \
17520 /* Loop generating characters. The loop is left with IT on the next
17521 character to display. */
17524 int n_glyphs_before
, hpos_before
, x_before
;
17526 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17528 /* Retrieve the next thing to display. Value is zero if end of
17530 if (!get_next_display_element (it
))
17532 /* Maybe add a space at the end of this line that is used to
17533 display the cursor there under X. Set the charpos of the
17534 first glyph of blank lines not corresponding to any text
17536 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17537 row
->exact_window_width_line_p
= 1;
17538 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17539 || row
->used
[TEXT_AREA
] == 0)
17541 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17542 row
->displays_text_p
= 0;
17544 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17545 && (!MINI_WINDOW_P (it
->w
)
17546 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17547 row
->indicate_empty_line_p
= 1;
17550 it
->continuation_lines_width
= 0;
17551 row
->ends_at_zv_p
= 1;
17552 /* A row that displays right-to-left text must always have
17553 its last face extended all the way to the end of line,
17554 even if this row ends in ZV, because we still write to
17555 the screen left to right. */
17556 if (row
->reversed_p
)
17557 extend_face_to_end_of_line (it
);
17561 /* Now, get the metrics of what we want to display. This also
17562 generates glyphs in `row' (which is IT->glyph_row). */
17563 n_glyphs_before
= row
->used
[TEXT_AREA
];
17566 /* Remember the line height so far in case the next element doesn't
17567 fit on the line. */
17568 if (it
->line_wrap
!= TRUNCATE
)
17570 ascent
= it
->max_ascent
;
17571 descent
= it
->max_descent
;
17572 phys_ascent
= it
->max_phys_ascent
;
17573 phys_descent
= it
->max_phys_descent
;
17575 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17577 if (IT_DISPLAYING_WHITESPACE (it
))
17583 wrap_row_used
= row
->used
[TEXT_AREA
];
17584 wrap_row_ascent
= row
->ascent
;
17585 wrap_row_height
= row
->height
;
17586 wrap_row_phys_ascent
= row
->phys_ascent
;
17587 wrap_row_phys_height
= row
->phys_height
;
17588 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17589 wrap_row_min_pos
= min_pos
;
17590 wrap_row_min_bpos
= min_bpos
;
17591 wrap_row_max_pos
= max_pos
;
17592 wrap_row_max_bpos
= max_bpos
;
17598 PRODUCE_GLYPHS (it
);
17600 /* If this display element was in marginal areas, continue with
17602 if (it
->area
!= TEXT_AREA
)
17604 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17605 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17606 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17607 row
->phys_height
= max (row
->phys_height
,
17608 it
->max_phys_ascent
+ it
->max_phys_descent
);
17609 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17610 it
->max_extra_line_spacing
);
17611 set_iterator_to_next (it
, 1);
17615 /* Does the display element fit on the line? If we truncate
17616 lines, we should draw past the right edge of the window. If
17617 we don't truncate, we want to stop so that we can display the
17618 continuation glyph before the right margin. If lines are
17619 continued, there are two possible strategies for characters
17620 resulting in more than 1 glyph (e.g. tabs): Display as many
17621 glyphs as possible in this line and leave the rest for the
17622 continuation line, or display the whole element in the next
17623 line. Original redisplay did the former, so we do it also. */
17624 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17625 hpos_before
= it
->hpos
;
17628 if (/* Not a newline. */
17630 /* Glyphs produced fit entirely in the line. */
17631 && it
->current_x
< it
->last_visible_x
)
17633 it
->hpos
+= nglyphs
;
17634 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17635 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17636 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17637 row
->phys_height
= max (row
->phys_height
,
17638 it
->max_phys_ascent
+ it
->max_phys_descent
);
17639 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17640 it
->max_extra_line_spacing
);
17641 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17642 row
->x
= x
- it
->first_visible_x
;
17643 /* Record the maximum and minimum buffer positions seen so
17644 far in glyphs that will be displayed by this row. */
17646 RECORD_MAX_MIN_POS (it
);
17651 struct glyph
*glyph
;
17653 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17655 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17656 new_x
= x
+ glyph
->pixel_width
;
17658 if (/* Lines are continued. */
17659 it
->line_wrap
!= TRUNCATE
17660 && (/* Glyph doesn't fit on the line. */
17661 new_x
> it
->last_visible_x
17662 /* Or it fits exactly on a window system frame. */
17663 || (new_x
== it
->last_visible_x
17664 && FRAME_WINDOW_P (it
->f
))))
17666 /* End of a continued line. */
17669 || (new_x
== it
->last_visible_x
17670 && FRAME_WINDOW_P (it
->f
)))
17672 /* Current glyph is the only one on the line or
17673 fits exactly on the line. We must continue
17674 the line because we can't draw the cursor
17675 after the glyph. */
17676 row
->continued_p
= 1;
17677 it
->current_x
= new_x
;
17678 it
->continuation_lines_width
+= new_x
;
17680 /* Record the maximum and minimum buffer
17681 positions seen so far in glyphs that will be
17682 displayed by this row. */
17684 RECORD_MAX_MIN_POS (it
);
17685 if (i
== nglyphs
- 1)
17687 /* If line-wrap is on, check if a previous
17688 wrap point was found. */
17689 if (wrap_row_used
> 0
17690 /* Even if there is a previous wrap
17691 point, continue the line here as
17692 usual, if (i) the previous character
17693 was a space or tab AND (ii) the
17694 current character is not. */
17696 || IT_DISPLAYING_WHITESPACE (it
)))
17699 set_iterator_to_next (it
, 1);
17700 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17702 if (!get_next_display_element (it
))
17704 row
->exact_window_width_line_p
= 1;
17705 it
->continuation_lines_width
= 0;
17706 row
->continued_p
= 0;
17707 row
->ends_at_zv_p
= 1;
17709 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17711 row
->continued_p
= 0;
17712 row
->exact_window_width_line_p
= 1;
17717 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17718 && !FRAME_WINDOW_P (it
->f
))
17720 /* A padding glyph that doesn't fit on this line.
17721 This means the whole character doesn't fit
17723 if (row
->reversed_p
)
17724 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17725 - n_glyphs_before
);
17726 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17728 /* Fill the rest of the row with continuation
17729 glyphs like in 20.x. */
17730 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17731 < row
->glyphs
[1 + TEXT_AREA
])
17732 produce_special_glyphs (it
, IT_CONTINUATION
);
17734 row
->continued_p
= 1;
17735 it
->current_x
= x_before
;
17736 it
->continuation_lines_width
+= x_before
;
17738 /* Restore the height to what it was before the
17739 element not fitting on the line. */
17740 it
->max_ascent
= ascent
;
17741 it
->max_descent
= descent
;
17742 it
->max_phys_ascent
= phys_ascent
;
17743 it
->max_phys_descent
= phys_descent
;
17745 else if (wrap_row_used
> 0)
17748 if (row
->reversed_p
)
17749 unproduce_glyphs (it
,
17750 row
->used
[TEXT_AREA
] - wrap_row_used
);
17752 it
->continuation_lines_width
+= wrap_x
;
17753 row
->used
[TEXT_AREA
] = wrap_row_used
;
17754 row
->ascent
= wrap_row_ascent
;
17755 row
->height
= wrap_row_height
;
17756 row
->phys_ascent
= wrap_row_phys_ascent
;
17757 row
->phys_height
= wrap_row_phys_height
;
17758 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17759 min_pos
= wrap_row_min_pos
;
17760 min_bpos
= wrap_row_min_bpos
;
17761 max_pos
= wrap_row_max_pos
;
17762 max_bpos
= wrap_row_max_bpos
;
17763 row
->continued_p
= 1;
17764 row
->ends_at_zv_p
= 0;
17765 row
->exact_window_width_line_p
= 0;
17766 it
->continuation_lines_width
+= x
;
17768 /* Make sure that a non-default face is extended
17769 up to the right margin of the window. */
17770 extend_face_to_end_of_line (it
);
17772 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17774 /* A TAB that extends past the right edge of the
17775 window. This produces a single glyph on
17776 window system frames. We leave the glyph in
17777 this row and let it fill the row, but don't
17778 consume the TAB. */
17779 it
->continuation_lines_width
+= it
->last_visible_x
;
17780 row
->ends_in_middle_of_char_p
= 1;
17781 row
->continued_p
= 1;
17782 glyph
->pixel_width
= it
->last_visible_x
- x
;
17783 it
->starts_in_middle_of_char_p
= 1;
17787 /* Something other than a TAB that draws past
17788 the right edge of the window. Restore
17789 positions to values before the element. */
17790 if (row
->reversed_p
)
17791 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17792 - (n_glyphs_before
+ i
));
17793 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17795 /* Display continuation glyphs. */
17796 if (!FRAME_WINDOW_P (it
->f
))
17797 produce_special_glyphs (it
, IT_CONTINUATION
);
17798 row
->continued_p
= 1;
17800 it
->current_x
= x_before
;
17801 it
->continuation_lines_width
+= x
;
17802 extend_face_to_end_of_line (it
);
17804 if (nglyphs
> 1 && i
> 0)
17806 row
->ends_in_middle_of_char_p
= 1;
17807 it
->starts_in_middle_of_char_p
= 1;
17810 /* Restore the height to what it was before the
17811 element not fitting on the line. */
17812 it
->max_ascent
= ascent
;
17813 it
->max_descent
= descent
;
17814 it
->max_phys_ascent
= phys_ascent
;
17815 it
->max_phys_descent
= phys_descent
;
17820 else if (new_x
> it
->first_visible_x
)
17822 /* Increment number of glyphs actually displayed. */
17825 /* Record the maximum and minimum buffer positions
17826 seen so far in glyphs that will be displayed by
17829 RECORD_MAX_MIN_POS (it
);
17831 if (x
< it
->first_visible_x
)
17832 /* Glyph is partially visible, i.e. row starts at
17833 negative X position. */
17834 row
->x
= x
- it
->first_visible_x
;
17838 /* Glyph is completely off the left margin of the
17839 window. This should not happen because of the
17840 move_it_in_display_line at the start of this
17841 function, unless the text display area of the
17842 window is empty. */
17843 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17847 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17848 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17849 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17850 row
->phys_height
= max (row
->phys_height
,
17851 it
->max_phys_ascent
+ it
->max_phys_descent
);
17852 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17853 it
->max_extra_line_spacing
);
17855 /* End of this display line if row is continued. */
17856 if (row
->continued_p
|| row
->ends_at_zv_p
)
17861 /* Is this a line end? If yes, we're also done, after making
17862 sure that a non-default face is extended up to the right
17863 margin of the window. */
17864 if (ITERATOR_AT_END_OF_LINE_P (it
))
17866 int used_before
= row
->used
[TEXT_AREA
];
17868 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17870 /* Add a space at the end of the line that is used to
17871 display the cursor there. */
17872 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17873 append_space_for_newline (it
, 0);
17875 /* Extend the face to the end of the line. */
17876 extend_face_to_end_of_line (it
);
17878 /* Make sure we have the position. */
17879 if (used_before
== 0)
17880 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17882 /* Record the position of the newline, for use in
17884 it
->eol_pos
= it
->current
.pos
;
17886 /* Consume the line end. This skips over invisible lines. */
17887 set_iterator_to_next (it
, 1);
17888 it
->continuation_lines_width
= 0;
17892 /* Proceed with next display element. Note that this skips
17893 over lines invisible because of selective display. */
17894 set_iterator_to_next (it
, 1);
17896 /* If we truncate lines, we are done when the last displayed
17897 glyphs reach past the right margin of the window. */
17898 if (it
->line_wrap
== TRUNCATE
17899 && (FRAME_WINDOW_P (it
->f
)
17900 ? (it
->current_x
>= it
->last_visible_x
)
17901 : (it
->current_x
> it
->last_visible_x
)))
17903 /* Maybe add truncation glyphs. */
17904 if (!FRAME_WINDOW_P (it
->f
))
17908 if (!row
->reversed_p
)
17910 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17911 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17916 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17917 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17919 /* Remove any padding glyphs at the front of ROW, to
17920 make room for the truncation glyphs we will be
17921 adding below. The loop below always inserts at
17922 least one truncation glyph, so also remove the
17923 last glyph added to ROW. */
17924 unproduce_glyphs (it
, i
+ 1);
17925 /* Adjust i for the loop below. */
17926 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17929 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17931 row
->used
[TEXT_AREA
] = i
;
17932 produce_special_glyphs (it
, IT_TRUNCATION
);
17935 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17937 /* Don't truncate if we can overflow newline into fringe. */
17938 if (!get_next_display_element (it
))
17940 it
->continuation_lines_width
= 0;
17941 row
->ends_at_zv_p
= 1;
17942 row
->exact_window_width_line_p
= 1;
17945 if (ITERATOR_AT_END_OF_LINE_P (it
))
17947 row
->exact_window_width_line_p
= 1;
17948 goto at_end_of_line
;
17952 row
->truncated_on_right_p
= 1;
17953 it
->continuation_lines_width
= 0;
17954 reseat_at_next_visible_line_start (it
, 0);
17955 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17956 it
->hpos
= hpos_before
;
17957 it
->current_x
= x_before
;
17962 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17963 at the left window margin. */
17964 if (it
->first_visible_x
17965 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17967 if (!FRAME_WINDOW_P (it
->f
))
17968 insert_left_trunc_glyphs (it
);
17969 row
->truncated_on_left_p
= 1;
17972 /* Remember the position at which this line ends.
17974 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17975 cannot be before the call to find_row_edges below, since that is
17976 where these positions are determined. */
17977 row
->end
= it
->current
;
17980 row
->minpos
= row
->start
.pos
;
17981 row
->maxpos
= row
->end
.pos
;
17985 /* ROW->minpos and ROW->maxpos must be the smallest and
17986 `1 + the largest' buffer positions in ROW. But if ROW was
17987 bidi-reordered, these two positions can be anywhere in the
17988 row, so we must determine them now. */
17989 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17992 /* If the start of this line is the overlay arrow-position, then
17993 mark this glyph row as the one containing the overlay arrow.
17994 This is clearly a mess with variable size fonts. It would be
17995 better to let it be displayed like cursors under X. */
17996 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17997 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17998 !NILP (overlay_arrow_string
)))
18000 /* Overlay arrow in window redisplay is a fringe bitmap. */
18001 if (STRINGP (overlay_arrow_string
))
18003 struct glyph_row
*arrow_row
18004 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18005 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18006 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18007 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18008 struct glyph
*p2
, *end
;
18010 /* Copy the arrow glyphs. */
18011 while (glyph
< arrow_end
)
18014 /* Throw away padding glyphs. */
18016 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18017 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18023 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18028 xassert (INTEGERP (overlay_arrow_string
));
18029 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18031 overlay_arrow_seen
= 1;
18034 /* Compute pixel dimensions of this line. */
18035 compute_line_metrics (it
);
18037 /* Record whether this row ends inside an ellipsis. */
18038 row
->ends_in_ellipsis_p
18039 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18040 && it
->ellipsis_p
);
18042 /* Save fringe bitmaps in this row. */
18043 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18044 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18045 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18046 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18048 it
->left_user_fringe_bitmap
= 0;
18049 it
->left_user_fringe_face_id
= 0;
18050 it
->right_user_fringe_bitmap
= 0;
18051 it
->right_user_fringe_face_id
= 0;
18053 /* Maybe set the cursor. */
18054 cvpos
= it
->w
->cursor
.vpos
;
18056 /* In bidi-reordered rows, keep checking for proper cursor
18057 position even if one has been found already, because buffer
18058 positions in such rows change non-linearly with ROW->VPOS,
18059 when a line is continued. One exception: when we are at ZV,
18060 display cursor on the first suitable glyph row, since all
18061 the empty rows after that also have their position set to ZV. */
18062 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18063 lines' rows is implemented for bidi-reordered rows. */
18065 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18066 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18067 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18068 && cursor_row_p (row
))
18069 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18071 /* Highlight trailing whitespace. */
18072 if (!NILP (Vshow_trailing_whitespace
))
18073 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18075 /* Prepare for the next line. This line starts horizontally at (X
18076 HPOS) = (0 0). Vertical positions are incremented. As a
18077 convenience for the caller, IT->glyph_row is set to the next
18079 it
->current_x
= it
->hpos
= 0;
18080 it
->current_y
+= row
->height
;
18081 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18084 /* The next row should by default use the same value of the
18085 reversed_p flag as this one. set_iterator_to_next decides when
18086 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18087 the flag accordingly. */
18088 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18089 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18090 it
->start
= row
->end
;
18091 return row
->displays_text_p
;
18093 #undef RECORD_MAX_MIN_POS
18096 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18097 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18098 doc
: /* Return paragraph direction at point in BUFFER.
18099 Value is either `left-to-right' or `right-to-left'.
18100 If BUFFER is omitted or nil, it defaults to the current buffer.
18102 Paragraph direction determines how the text in the paragraph is displayed.
18103 In left-to-right paragraphs, text begins at the left margin of the window
18104 and the reading direction is generally left to right. In right-to-left
18105 paragraphs, text begins at the right margin and is read from right to left.
18107 See also `bidi-paragraph-direction'. */)
18108 (Lisp_Object buffer
)
18110 struct buffer
*buf
= current_buffer
;
18111 struct buffer
*old
= buf
;
18113 if (! NILP (buffer
))
18115 CHECK_BUFFER (buffer
);
18116 buf
= XBUFFER (buffer
);
18119 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18120 return Qleft_to_right
;
18121 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18122 return BVAR (buf
, bidi_paragraph_direction
);
18125 /* Determine the direction from buffer text. We could try to
18126 use current_matrix if it is up to date, but this seems fast
18127 enough as it is. */
18128 struct bidi_it itb
;
18129 EMACS_INT pos
= BUF_PT (buf
);
18130 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18133 set_buffer_temp (buf
);
18134 /* bidi_paragraph_init finds the base direction of the paragraph
18135 by searching forward from paragraph start. We need the base
18136 direction of the current or _previous_ paragraph, so we need
18137 to make sure we are within that paragraph. To that end, find
18138 the previous non-empty line. */
18139 if (pos
>= ZV
&& pos
> BEGV
)
18142 bytepos
= CHAR_TO_BYTE (pos
);
18144 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18145 || c
== ' ' || c
== '\t' || c
== '\f')
18147 if (bytepos
<= BEGV_BYTE
)
18152 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18155 itb
.bytepos
= bytepos
;
18157 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18159 itb
.separator_limit
= -1;
18160 itb
.paragraph_dir
= NEUTRAL_DIR
;
18162 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18163 set_buffer_temp (old
);
18164 switch (itb
.paragraph_dir
)
18167 return Qleft_to_right
;
18170 return Qright_to_left
;
18180 /***********************************************************************
18182 ***********************************************************************/
18184 /* Redisplay the menu bar in the frame for window W.
18186 The menu bar of X frames that don't have X toolkit support is
18187 displayed in a special window W->frame->menu_bar_window.
18189 The menu bar of terminal frames is treated specially as far as
18190 glyph matrices are concerned. Menu bar lines are not part of
18191 windows, so the update is done directly on the frame matrix rows
18192 for the menu bar. */
18195 display_menu_bar (struct window
*w
)
18197 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18202 /* Don't do all this for graphical frames. */
18204 if (FRAME_W32_P (f
))
18207 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18213 if (FRAME_NS_P (f
))
18215 #endif /* HAVE_NS */
18217 #ifdef USE_X_TOOLKIT
18218 xassert (!FRAME_WINDOW_P (f
));
18219 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18220 it
.first_visible_x
= 0;
18221 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18222 #else /* not USE_X_TOOLKIT */
18223 if (FRAME_WINDOW_P (f
))
18225 /* Menu bar lines are displayed in the desired matrix of the
18226 dummy window menu_bar_window. */
18227 struct window
*menu_w
;
18228 xassert (WINDOWP (f
->menu_bar_window
));
18229 menu_w
= XWINDOW (f
->menu_bar_window
);
18230 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18232 it
.first_visible_x
= 0;
18233 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18237 /* This is a TTY frame, i.e. character hpos/vpos are used as
18239 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18241 it
.first_visible_x
= 0;
18242 it
.last_visible_x
= FRAME_COLS (f
);
18244 #endif /* not USE_X_TOOLKIT */
18246 if (! mode_line_inverse_video
)
18247 /* Force the menu-bar to be displayed in the default face. */
18248 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18250 /* Clear all rows of the menu bar. */
18251 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18253 struct glyph_row
*row
= it
.glyph_row
+ i
;
18254 clear_glyph_row (row
);
18255 row
->enabled_p
= 1;
18256 row
->full_width_p
= 1;
18259 /* Display all items of the menu bar. */
18260 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18261 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18263 Lisp_Object string
;
18265 /* Stop at nil string. */
18266 string
= AREF (items
, i
+ 1);
18270 /* Remember where item was displayed. */
18271 ASET (items
, i
+ 3, make_number (it
.hpos
));
18273 /* Display the item, pad with one space. */
18274 if (it
.current_x
< it
.last_visible_x
)
18275 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18276 SCHARS (string
) + 1, 0, 0, -1);
18279 /* Fill out the line with spaces. */
18280 if (it
.current_x
< it
.last_visible_x
)
18281 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18283 /* Compute the total height of the lines. */
18284 compute_line_metrics (&it
);
18289 /***********************************************************************
18291 ***********************************************************************/
18293 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18294 FORCE is non-zero, redisplay mode lines unconditionally.
18295 Otherwise, redisplay only mode lines that are garbaged. Value is
18296 the number of windows whose mode lines were redisplayed. */
18299 redisplay_mode_lines (Lisp_Object window
, int force
)
18303 while (!NILP (window
))
18305 struct window
*w
= XWINDOW (window
);
18307 if (WINDOWP (w
->hchild
))
18308 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18309 else if (WINDOWP (w
->vchild
))
18310 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18312 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18313 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18315 struct text_pos lpoint
;
18316 struct buffer
*old
= current_buffer
;
18318 /* Set the window's buffer for the mode line display. */
18319 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18320 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18322 /* Point refers normally to the selected window. For any
18323 other window, set up appropriate value. */
18324 if (!EQ (window
, selected_window
))
18326 struct text_pos pt
;
18328 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18329 if (CHARPOS (pt
) < BEGV
)
18330 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18331 else if (CHARPOS (pt
) > (ZV
- 1))
18332 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18334 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18337 /* Display mode lines. */
18338 clear_glyph_matrix (w
->desired_matrix
);
18339 if (display_mode_lines (w
))
18342 w
->must_be_updated_p
= 1;
18345 /* Restore old settings. */
18346 set_buffer_internal_1 (old
);
18347 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18357 /* Display the mode and/or header line of window W. Value is the
18358 sum number of mode lines and header lines displayed. */
18361 display_mode_lines (struct window
*w
)
18363 Lisp_Object old_selected_window
, old_selected_frame
;
18366 old_selected_frame
= selected_frame
;
18367 selected_frame
= w
->frame
;
18368 old_selected_window
= selected_window
;
18369 XSETWINDOW (selected_window
, w
);
18371 /* These will be set while the mode line specs are processed. */
18372 line_number_displayed
= 0;
18373 w
->column_number_displayed
= Qnil
;
18375 if (WINDOW_WANTS_MODELINE_P (w
))
18377 struct window
*sel_w
= XWINDOW (old_selected_window
);
18379 /* Select mode line face based on the real selected window. */
18380 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18381 BVAR (current_buffer
, mode_line_format
));
18385 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18387 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18388 BVAR (current_buffer
, header_line_format
));
18392 selected_frame
= old_selected_frame
;
18393 selected_window
= old_selected_window
;
18398 /* Display mode or header line of window W. FACE_ID specifies which
18399 line to display; it is either MODE_LINE_FACE_ID or
18400 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18401 display. Value is the pixel height of the mode/header line
18405 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18409 int count
= SPECPDL_INDEX ();
18411 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18412 /* Don't extend on a previously drawn mode-line.
18413 This may happen if called from pos_visible_p. */
18414 it
.glyph_row
->enabled_p
= 0;
18415 prepare_desired_row (it
.glyph_row
);
18417 it
.glyph_row
->mode_line_p
= 1;
18419 if (! mode_line_inverse_video
)
18420 /* Force the mode-line to be displayed in the default face. */
18421 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18423 record_unwind_protect (unwind_format_mode_line
,
18424 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18426 mode_line_target
= MODE_LINE_DISPLAY
;
18428 /* Temporarily make frame's keyboard the current kboard so that
18429 kboard-local variables in the mode_line_format will get the right
18431 push_kboard (FRAME_KBOARD (it
.f
));
18432 record_unwind_save_match_data ();
18433 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18436 unbind_to (count
, Qnil
);
18438 /* Fill up with spaces. */
18439 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18441 compute_line_metrics (&it
);
18442 it
.glyph_row
->full_width_p
= 1;
18443 it
.glyph_row
->continued_p
= 0;
18444 it
.glyph_row
->truncated_on_left_p
= 0;
18445 it
.glyph_row
->truncated_on_right_p
= 0;
18447 /* Make a 3D mode-line have a shadow at its right end. */
18448 face
= FACE_FROM_ID (it
.f
, face_id
);
18449 extend_face_to_end_of_line (&it
);
18450 if (face
->box
!= FACE_NO_BOX
)
18452 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18453 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18454 last
->right_box_line_p
= 1;
18457 return it
.glyph_row
->height
;
18460 /* Move element ELT in LIST to the front of LIST.
18461 Return the updated list. */
18464 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18466 register Lisp_Object tail
, prev
;
18467 register Lisp_Object tem
;
18471 while (CONSP (tail
))
18477 /* Splice out the link TAIL. */
18479 list
= XCDR (tail
);
18481 Fsetcdr (prev
, XCDR (tail
));
18483 /* Now make it the first. */
18484 Fsetcdr (tail
, list
);
18489 tail
= XCDR (tail
);
18493 /* Not found--return unchanged LIST. */
18497 /* Contribute ELT to the mode line for window IT->w. How it
18498 translates into text depends on its data type.
18500 IT describes the display environment in which we display, as usual.
18502 DEPTH is the depth in recursion. It is used to prevent
18503 infinite recursion here.
18505 FIELD_WIDTH is the number of characters the display of ELT should
18506 occupy in the mode line, and PRECISION is the maximum number of
18507 characters to display from ELT's representation. See
18508 display_string for details.
18510 Returns the hpos of the end of the text generated by ELT.
18512 PROPS is a property list to add to any string we encounter.
18514 If RISKY is nonzero, remove (disregard) any properties in any string
18515 we encounter, and ignore :eval and :propertize.
18517 The global variable `mode_line_target' determines whether the
18518 output is passed to `store_mode_line_noprop',
18519 `store_mode_line_string', or `display_string'. */
18522 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18523 Lisp_Object elt
, Lisp_Object props
, int risky
)
18525 int n
= 0, field
, prec
;
18530 elt
= build_string ("*too-deep*");
18534 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18538 /* A string: output it and check for %-constructs within it. */
18540 EMACS_INT offset
= 0;
18542 if (SCHARS (elt
) > 0
18543 && (!NILP (props
) || risky
))
18545 Lisp_Object oprops
, aelt
;
18546 oprops
= Ftext_properties_at (make_number (0), elt
);
18548 /* If the starting string's properties are not what
18549 we want, translate the string. Also, if the string
18550 is risky, do that anyway. */
18552 if (NILP (Fequal (props
, oprops
)) || risky
)
18554 /* If the starting string has properties,
18555 merge the specified ones onto the existing ones. */
18556 if (! NILP (oprops
) && !risky
)
18560 oprops
= Fcopy_sequence (oprops
);
18562 while (CONSP (tem
))
18564 oprops
= Fplist_put (oprops
, XCAR (tem
),
18565 XCAR (XCDR (tem
)));
18566 tem
= XCDR (XCDR (tem
));
18571 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18572 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18574 /* AELT is what we want. Move it to the front
18575 without consing. */
18577 mode_line_proptrans_alist
18578 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18584 /* If AELT has the wrong props, it is useless.
18585 so get rid of it. */
18587 mode_line_proptrans_alist
18588 = Fdelq (aelt
, mode_line_proptrans_alist
);
18590 elt
= Fcopy_sequence (elt
);
18591 Fset_text_properties (make_number (0), Flength (elt
),
18593 /* Add this item to mode_line_proptrans_alist. */
18594 mode_line_proptrans_alist
18595 = Fcons (Fcons (elt
, props
),
18596 mode_line_proptrans_alist
);
18597 /* Truncate mode_line_proptrans_alist
18598 to at most 50 elements. */
18599 tem
= Fnthcdr (make_number (50),
18600 mode_line_proptrans_alist
);
18602 XSETCDR (tem
, Qnil
);
18611 prec
= precision
- n
;
18612 switch (mode_line_target
)
18614 case MODE_LINE_NOPROP
:
18615 case MODE_LINE_TITLE
:
18616 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18618 case MODE_LINE_STRING
:
18619 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18621 case MODE_LINE_DISPLAY
:
18622 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18623 0, prec
, 0, STRING_MULTIBYTE (elt
));
18630 /* Handle the non-literal case. */
18632 while ((precision
<= 0 || n
< precision
)
18633 && SREF (elt
, offset
) != 0
18634 && (mode_line_target
!= MODE_LINE_DISPLAY
18635 || it
->current_x
< it
->last_visible_x
))
18637 EMACS_INT last_offset
= offset
;
18639 /* Advance to end of string or next format specifier. */
18640 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18643 if (offset
- 1 != last_offset
)
18645 EMACS_INT nchars
, nbytes
;
18647 /* Output to end of string or up to '%'. Field width
18648 is length of string. Don't output more than
18649 PRECISION allows us. */
18652 prec
= c_string_width (SDATA (elt
) + last_offset
,
18653 offset
- last_offset
, precision
- n
,
18656 switch (mode_line_target
)
18658 case MODE_LINE_NOPROP
:
18659 case MODE_LINE_TITLE
:
18660 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18662 case MODE_LINE_STRING
:
18664 EMACS_INT bytepos
= last_offset
;
18665 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18666 EMACS_INT endpos
= (precision
<= 0
18667 ? string_byte_to_char (elt
, offset
)
18668 : charpos
+ nchars
);
18670 n
+= store_mode_line_string (NULL
,
18671 Fsubstring (elt
, make_number (charpos
),
18672 make_number (endpos
)),
18676 case MODE_LINE_DISPLAY
:
18678 EMACS_INT bytepos
= last_offset
;
18679 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18681 if (precision
<= 0)
18682 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18683 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18685 STRING_MULTIBYTE (elt
));
18690 else /* c == '%' */
18692 EMACS_INT percent_position
= offset
;
18694 /* Get the specified minimum width. Zero means
18697 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18698 field
= field
* 10 + c
- '0';
18700 /* Don't pad beyond the total padding allowed. */
18701 if (field_width
- n
> 0 && field
> field_width
- n
)
18702 field
= field_width
- n
;
18704 /* Note that either PRECISION <= 0 or N < PRECISION. */
18705 prec
= precision
- n
;
18708 n
+= display_mode_element (it
, depth
, field
, prec
,
18709 Vglobal_mode_string
, props
,
18714 EMACS_INT bytepos
, charpos
;
18716 Lisp_Object string
;
18718 bytepos
= percent_position
;
18719 charpos
= (STRING_MULTIBYTE (elt
)
18720 ? string_byte_to_char (elt
, bytepos
)
18722 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18723 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18725 switch (mode_line_target
)
18727 case MODE_LINE_NOPROP
:
18728 case MODE_LINE_TITLE
:
18729 n
+= store_mode_line_noprop (spec
, field
, prec
);
18731 case MODE_LINE_STRING
:
18733 int len
= strlen (spec
);
18734 Lisp_Object tem
= make_string (spec
, len
);
18735 props
= Ftext_properties_at (make_number (charpos
), elt
);
18736 /* Should only keep face property in props */
18737 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18740 case MODE_LINE_DISPLAY
:
18742 int nglyphs_before
, nwritten
;
18744 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18745 nwritten
= display_string (spec
, string
, elt
,
18750 /* Assign to the glyphs written above the
18751 string where the `%x' came from, position
18755 struct glyph
*glyph
18756 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18760 for (i
= 0; i
< nwritten
; ++i
)
18762 glyph
[i
].object
= elt
;
18763 glyph
[i
].charpos
= charpos
;
18780 /* A symbol: process the value of the symbol recursively
18781 as if it appeared here directly. Avoid error if symbol void.
18782 Special case: if value of symbol is a string, output the string
18785 register Lisp_Object tem
;
18787 /* If the variable is not marked as risky to set
18788 then its contents are risky to use. */
18789 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18792 tem
= Fboundp (elt
);
18795 tem
= Fsymbol_value (elt
);
18796 /* If value is a string, output that string literally:
18797 don't check for % within it. */
18801 if (!EQ (tem
, elt
))
18803 /* Give up right away for nil or t. */
18813 register Lisp_Object car
, tem
;
18815 /* A cons cell: five distinct cases.
18816 If first element is :eval or :propertize, do something special.
18817 If first element is a string or a cons, process all the elements
18818 and effectively concatenate them.
18819 If first element is a negative number, truncate displaying cdr to
18820 at most that many characters. If positive, pad (with spaces)
18821 to at least that many characters.
18822 If first element is a symbol, process the cadr or caddr recursively
18823 according to whether the symbol's value is non-nil or nil. */
18825 if (EQ (car
, QCeval
))
18827 /* An element of the form (:eval FORM) means evaluate FORM
18828 and use the result as mode line elements. */
18833 if (CONSP (XCDR (elt
)))
18836 spec
= safe_eval (XCAR (XCDR (elt
)));
18837 n
+= display_mode_element (it
, depth
, field_width
- n
,
18838 precision
- n
, spec
, props
,
18842 else if (EQ (car
, QCpropertize
))
18844 /* An element of the form (:propertize ELT PROPS...)
18845 means display ELT but applying properties PROPS. */
18850 if (CONSP (XCDR (elt
)))
18851 n
+= display_mode_element (it
, depth
, field_width
- n
,
18852 precision
- n
, XCAR (XCDR (elt
)),
18853 XCDR (XCDR (elt
)), risky
);
18855 else if (SYMBOLP (car
))
18857 tem
= Fboundp (car
);
18861 /* elt is now the cdr, and we know it is a cons cell.
18862 Use its car if CAR has a non-nil value. */
18865 tem
= Fsymbol_value (car
);
18872 /* Symbol's value is nil (or symbol is unbound)
18873 Get the cddr of the original list
18874 and if possible find the caddr and use that. */
18878 else if (!CONSP (elt
))
18883 else if (INTEGERP (car
))
18885 register int lim
= XINT (car
);
18889 /* Negative int means reduce maximum width. */
18890 if (precision
<= 0)
18893 precision
= min (precision
, -lim
);
18897 /* Padding specified. Don't let it be more than
18898 current maximum. */
18900 lim
= min (precision
, lim
);
18902 /* If that's more padding than already wanted, queue it.
18903 But don't reduce padding already specified even if
18904 that is beyond the current truncation point. */
18905 field_width
= max (lim
, field_width
);
18909 else if (STRINGP (car
) || CONSP (car
))
18911 Lisp_Object halftail
= elt
;
18915 && (precision
<= 0 || n
< precision
))
18917 n
+= display_mode_element (it
, depth
,
18918 /* Do padding only after the last
18919 element in the list. */
18920 (! CONSP (XCDR (elt
))
18923 precision
- n
, XCAR (elt
),
18927 if ((len
& 1) == 0)
18928 halftail
= XCDR (halftail
);
18929 /* Check for cycle. */
18930 if (EQ (halftail
, elt
))
18939 elt
= build_string ("*invalid*");
18943 /* Pad to FIELD_WIDTH. */
18944 if (field_width
> 0 && n
< field_width
)
18946 switch (mode_line_target
)
18948 case MODE_LINE_NOPROP
:
18949 case MODE_LINE_TITLE
:
18950 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18952 case MODE_LINE_STRING
:
18953 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18955 case MODE_LINE_DISPLAY
:
18956 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18965 /* Store a mode-line string element in mode_line_string_list.
18967 If STRING is non-null, display that C string. Otherwise, the Lisp
18968 string LISP_STRING is displayed.
18970 FIELD_WIDTH is the minimum number of output glyphs to produce.
18971 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18972 with spaces. FIELD_WIDTH <= 0 means don't pad.
18974 PRECISION is the maximum number of characters to output from
18975 STRING. PRECISION <= 0 means don't truncate the string.
18977 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18978 properties to the string.
18980 PROPS are the properties to add to the string.
18981 The mode_line_string_face face property is always added to the string.
18985 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18986 int field_width
, int precision
, Lisp_Object props
)
18991 if (string
!= NULL
)
18993 len
= strlen (string
);
18994 if (precision
> 0 && len
> precision
)
18996 lisp_string
= make_string (string
, len
);
18998 props
= mode_line_string_face_prop
;
18999 else if (!NILP (mode_line_string_face
))
19001 Lisp_Object face
= Fplist_get (props
, Qface
);
19002 props
= Fcopy_sequence (props
);
19004 face
= mode_line_string_face
;
19006 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19007 props
= Fplist_put (props
, Qface
, face
);
19009 Fadd_text_properties (make_number (0), make_number (len
),
19010 props
, lisp_string
);
19014 len
= XFASTINT (Flength (lisp_string
));
19015 if (precision
> 0 && len
> precision
)
19018 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19021 if (!NILP (mode_line_string_face
))
19025 props
= Ftext_properties_at (make_number (0), lisp_string
);
19026 face
= Fplist_get (props
, Qface
);
19028 face
= mode_line_string_face
;
19030 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19031 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19033 lisp_string
= Fcopy_sequence (lisp_string
);
19036 Fadd_text_properties (make_number (0), make_number (len
),
19037 props
, lisp_string
);
19042 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19046 if (field_width
> len
)
19048 field_width
-= len
;
19049 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19051 Fadd_text_properties (make_number (0), make_number (field_width
),
19052 props
, lisp_string
);
19053 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19061 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19063 doc
: /* Format a string out of a mode line format specification.
19064 First arg FORMAT specifies the mode line format (see `mode-line-format'
19065 for details) to use.
19067 By default, the format is evaluated for the currently selected window.
19069 Optional second arg FACE specifies the face property to put on all
19070 characters for which no face is specified. The value nil means the
19071 default face. The value t means whatever face the window's mode line
19072 currently uses (either `mode-line' or `mode-line-inactive',
19073 depending on whether the window is the selected window or not).
19074 An integer value means the value string has no text
19077 Optional third and fourth args WINDOW and BUFFER specify the window
19078 and buffer to use as the context for the formatting (defaults
19079 are the selected window and the WINDOW's buffer). */)
19080 (Lisp_Object format
, Lisp_Object face
,
19081 Lisp_Object window
, Lisp_Object buffer
)
19086 struct buffer
*old_buffer
= NULL
;
19088 int no_props
= INTEGERP (face
);
19089 int count
= SPECPDL_INDEX ();
19091 int string_start
= 0;
19094 window
= selected_window
;
19095 CHECK_WINDOW (window
);
19096 w
= XWINDOW (window
);
19099 buffer
= w
->buffer
;
19100 CHECK_BUFFER (buffer
);
19102 /* Make formatting the modeline a non-op when noninteractive, otherwise
19103 there will be problems later caused by a partially initialized frame. */
19104 if (NILP (format
) || noninteractive
)
19105 return empty_unibyte_string
;
19110 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19111 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19112 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19113 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19114 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19115 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19116 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19119 if (XBUFFER (buffer
) != current_buffer
)
19120 old_buffer
= current_buffer
;
19122 /* Save things including mode_line_proptrans_alist,
19123 and set that to nil so that we don't alter the outer value. */
19124 record_unwind_protect (unwind_format_mode_line
,
19125 format_mode_line_unwind_data
19126 (old_buffer
, selected_window
, 1));
19127 mode_line_proptrans_alist
= Qnil
;
19129 Fselect_window (window
, Qt
);
19131 set_buffer_internal_1 (XBUFFER (buffer
));
19133 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19137 mode_line_target
= MODE_LINE_NOPROP
;
19138 mode_line_string_face_prop
= Qnil
;
19139 mode_line_string_list
= Qnil
;
19140 string_start
= MODE_LINE_NOPROP_LEN (0);
19144 mode_line_target
= MODE_LINE_STRING
;
19145 mode_line_string_list
= Qnil
;
19146 mode_line_string_face
= face
;
19147 mode_line_string_face_prop
19148 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19151 push_kboard (FRAME_KBOARD (it
.f
));
19152 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19157 len
= MODE_LINE_NOPROP_LEN (string_start
);
19158 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19162 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19163 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19164 empty_unibyte_string
);
19167 unbind_to (count
, Qnil
);
19171 /* Write a null-terminated, right justified decimal representation of
19172 the positive integer D to BUF using a minimal field width WIDTH. */
19175 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19177 register char *p
= buf
;
19185 *p
++ = d
% 10 + '0';
19190 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19201 /* Write a null-terminated, right justified decimal and "human
19202 readable" representation of the nonnegative integer D to BUF using
19203 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19205 static const char power_letter
[] =
19219 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19221 /* We aim to represent the nonnegative integer D as
19222 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19223 EMACS_INT quotient
= d
;
19225 /* -1 means: do not use TENTHS. */
19229 /* Length of QUOTIENT.TENTHS as a string. */
19235 if (1000 <= quotient
)
19237 /* Scale to the appropriate EXPONENT. */
19240 remainder
= quotient
% 1000;
19244 while (1000 <= quotient
);
19246 /* Round to nearest and decide whether to use TENTHS or not. */
19249 tenths
= remainder
/ 100;
19250 if (50 <= remainder
% 100)
19257 if (quotient
== 10)
19265 if (500 <= remainder
)
19267 if (quotient
< 999)
19278 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19279 if (tenths
== -1 && quotient
<= 99)
19286 p
= psuffix
= buf
+ max (width
, length
);
19288 /* Print EXPONENT. */
19289 *psuffix
++ = power_letter
[exponent
];
19292 /* Print TENTHS. */
19295 *--p
= '0' + tenths
;
19299 /* Print QUOTIENT. */
19302 int digit
= quotient
% 10;
19303 *--p
= '0' + digit
;
19305 while ((quotient
/= 10) != 0);
19307 /* Print leading spaces. */
19312 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19313 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19314 type of CODING_SYSTEM. Return updated pointer into BUF. */
19316 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19319 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19322 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19323 const unsigned char *eol_str
;
19325 /* The EOL conversion we are using. */
19326 Lisp_Object eoltype
;
19328 val
= CODING_SYSTEM_SPEC (coding_system
);
19331 if (!VECTORP (val
)) /* Not yet decided. */
19336 eoltype
= eol_mnemonic_undecided
;
19337 /* Don't mention EOL conversion if it isn't decided. */
19342 Lisp_Object eolvalue
;
19344 attrs
= AREF (val
, 0);
19345 eolvalue
= AREF (val
, 2);
19348 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19352 /* The EOL conversion that is normal on this system. */
19354 if (NILP (eolvalue
)) /* Not yet decided. */
19355 eoltype
= eol_mnemonic_undecided
;
19356 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19357 eoltype
= eol_mnemonic_undecided
;
19358 else /* eolvalue is Qunix, Qdos, or Qmac. */
19359 eoltype
= (EQ (eolvalue
, Qunix
)
19360 ? eol_mnemonic_unix
19361 : (EQ (eolvalue
, Qdos
) == 1
19362 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19368 /* Mention the EOL conversion if it is not the usual one. */
19369 if (STRINGP (eoltype
))
19371 eol_str
= SDATA (eoltype
);
19372 eol_str_len
= SBYTES (eoltype
);
19374 else if (CHARACTERP (eoltype
))
19376 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19377 int c
= XFASTINT (eoltype
);
19378 eol_str_len
= CHAR_STRING (c
, tmp
);
19383 eol_str
= invalid_eol_type
;
19384 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19386 memcpy (buf
, eol_str
, eol_str_len
);
19387 buf
+= eol_str_len
;
19393 /* Return a string for the output of a mode line %-spec for window W,
19394 generated by character C. FIELD_WIDTH > 0 means pad the string
19395 returned with spaces to that value. Return a Lisp string in
19396 *STRING if the resulting string is taken from that Lisp string.
19398 Note we operate on the current buffer for most purposes,
19399 the exception being w->base_line_pos. */
19401 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19403 static const char *
19404 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19405 Lisp_Object
*string
)
19408 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19409 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19410 struct buffer
*b
= current_buffer
;
19418 if (!NILP (BVAR (b
, read_only
)))
19420 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19425 /* This differs from %* only for a modified read-only buffer. */
19426 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19428 if (!NILP (BVAR (b
, read_only
)))
19433 /* This differs from %* in ignoring read-only-ness. */
19434 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19446 if (command_loop_level
> 5)
19448 p
= decode_mode_spec_buf
;
19449 for (i
= 0; i
< command_loop_level
; i
++)
19452 return decode_mode_spec_buf
;
19460 if (command_loop_level
> 5)
19462 p
= decode_mode_spec_buf
;
19463 for (i
= 0; i
< command_loop_level
; i
++)
19466 return decode_mode_spec_buf
;
19473 /* Let lots_of_dashes be a string of infinite length. */
19474 if (mode_line_target
== MODE_LINE_NOPROP
||
19475 mode_line_target
== MODE_LINE_STRING
)
19477 if (field_width
<= 0
19478 || field_width
> sizeof (lots_of_dashes
))
19480 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19481 decode_mode_spec_buf
[i
] = '-';
19482 decode_mode_spec_buf
[i
] = '\0';
19483 return decode_mode_spec_buf
;
19486 return lots_of_dashes
;
19490 obj
= BVAR (b
, name
);
19494 /* %c and %l are ignored in `frame-title-format'.
19495 (In redisplay_internal, the frame title is drawn _before_ the
19496 windows are updated, so the stuff which depends on actual
19497 window contents (such as %l) may fail to render properly, or
19498 even crash emacs.) */
19499 if (mode_line_target
== MODE_LINE_TITLE
)
19503 EMACS_INT col
= current_column ();
19504 w
->column_number_displayed
= make_number (col
);
19505 pint2str (decode_mode_spec_buf
, field_width
, col
);
19506 return decode_mode_spec_buf
;
19510 #ifndef SYSTEM_MALLOC
19512 if (NILP (Vmemory_full
))
19515 return "!MEM FULL! ";
19522 /* %F displays the frame name. */
19523 if (!NILP (f
->title
))
19524 return SSDATA (f
->title
);
19525 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19526 return SSDATA (f
->name
);
19530 obj
= BVAR (b
, filename
);
19535 EMACS_INT size
= ZV
- BEGV
;
19536 pint2str (decode_mode_spec_buf
, field_width
, size
);
19537 return decode_mode_spec_buf
;
19542 EMACS_INT size
= ZV
- BEGV
;
19543 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19544 return decode_mode_spec_buf
;
19549 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19550 EMACS_INT topline
, nlines
, height
;
19553 /* %c and %l are ignored in `frame-title-format'. */
19554 if (mode_line_target
== MODE_LINE_TITLE
)
19557 startpos
= XMARKER (w
->start
)->charpos
;
19558 startpos_byte
= marker_byte_position (w
->start
);
19559 height
= WINDOW_TOTAL_LINES (w
);
19561 /* If we decided that this buffer isn't suitable for line numbers,
19562 don't forget that too fast. */
19563 if (EQ (w
->base_line_pos
, w
->buffer
))
19565 /* But do forget it, if the window shows a different buffer now. */
19566 else if (BUFFERP (w
->base_line_pos
))
19567 w
->base_line_pos
= Qnil
;
19569 /* If the buffer is very big, don't waste time. */
19570 if (INTEGERP (Vline_number_display_limit
)
19571 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19573 w
->base_line_pos
= Qnil
;
19574 w
->base_line_number
= Qnil
;
19578 if (INTEGERP (w
->base_line_number
)
19579 && INTEGERP (w
->base_line_pos
)
19580 && XFASTINT (w
->base_line_pos
) <= startpos
)
19582 line
= XFASTINT (w
->base_line_number
);
19583 linepos
= XFASTINT (w
->base_line_pos
);
19584 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19589 linepos
= BUF_BEGV (b
);
19590 linepos_byte
= BUF_BEGV_BYTE (b
);
19593 /* Count lines from base line to window start position. */
19594 nlines
= display_count_lines (linepos_byte
,
19598 topline
= nlines
+ line
;
19600 /* Determine a new base line, if the old one is too close
19601 or too far away, or if we did not have one.
19602 "Too close" means it's plausible a scroll-down would
19603 go back past it. */
19604 if (startpos
== BUF_BEGV (b
))
19606 w
->base_line_number
= make_number (topline
);
19607 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19609 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19610 || linepos
== BUF_BEGV (b
))
19612 EMACS_INT limit
= BUF_BEGV (b
);
19613 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19614 EMACS_INT position
;
19615 EMACS_INT distance
=
19616 (height
* 2 + 30) * line_number_display_limit_width
;
19618 if (startpos
- distance
> limit
)
19620 limit
= startpos
- distance
;
19621 limit_byte
= CHAR_TO_BYTE (limit
);
19624 nlines
= display_count_lines (startpos_byte
,
19626 - (height
* 2 + 30),
19628 /* If we couldn't find the lines we wanted within
19629 line_number_display_limit_width chars per line,
19630 give up on line numbers for this window. */
19631 if (position
== limit_byte
&& limit
== startpos
- distance
)
19633 w
->base_line_pos
= w
->buffer
;
19634 w
->base_line_number
= Qnil
;
19638 w
->base_line_number
= make_number (topline
- nlines
);
19639 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19642 /* Now count lines from the start pos to point. */
19643 nlines
= display_count_lines (startpos_byte
,
19644 PT_BYTE
, PT
, &junk
);
19646 /* Record that we did display the line number. */
19647 line_number_displayed
= 1;
19649 /* Make the string to show. */
19650 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19651 return decode_mode_spec_buf
;
19654 char* p
= decode_mode_spec_buf
;
19655 int pad
= field_width
- 2;
19661 return decode_mode_spec_buf
;
19667 obj
= BVAR (b
, mode_name
);
19671 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19677 EMACS_INT pos
= marker_position (w
->start
);
19678 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19680 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19682 if (pos
<= BUF_BEGV (b
))
19687 else if (pos
<= BUF_BEGV (b
))
19691 if (total
> 1000000)
19692 /* Do it differently for a large value, to avoid overflow. */
19693 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19695 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19696 /* We can't normally display a 3-digit number,
19697 so get us a 2-digit number that is close. */
19700 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19701 return decode_mode_spec_buf
;
19705 /* Display percentage of size above the bottom of the screen. */
19708 EMACS_INT toppos
= marker_position (w
->start
);
19709 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19710 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19712 if (botpos
>= BUF_ZV (b
))
19714 if (toppos
<= BUF_BEGV (b
))
19721 if (total
> 1000000)
19722 /* Do it differently for a large value, to avoid overflow. */
19723 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19725 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19726 /* We can't normally display a 3-digit number,
19727 so get us a 2-digit number that is close. */
19730 if (toppos
<= BUF_BEGV (b
))
19731 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
19733 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19734 return decode_mode_spec_buf
;
19739 /* status of process */
19740 obj
= Fget_buffer_process (Fcurrent_buffer ());
19742 return "no process";
19744 obj
= Fsymbol_name (Fprocess_status (obj
));
19750 int count
= inhibit_garbage_collection ();
19751 Lisp_Object val
= call1 (intern ("file-remote-p"),
19752 BVAR (current_buffer
, directory
));
19753 unbind_to (count
, Qnil
);
19761 case 't': /* indicate TEXT or BINARY */
19765 /* coding-system (not including end-of-line format) */
19767 /* coding-system (including end-of-line type) */
19769 int eol_flag
= (c
== 'Z');
19770 char *p
= decode_mode_spec_buf
;
19772 if (! FRAME_WINDOW_P (f
))
19774 /* No need to mention EOL here--the terminal never needs
19775 to do EOL conversion. */
19776 p
= decode_mode_spec_coding (CODING_ID_NAME
19777 (FRAME_KEYBOARD_CODING (f
)->id
),
19779 p
= decode_mode_spec_coding (CODING_ID_NAME
19780 (FRAME_TERMINAL_CODING (f
)->id
),
19783 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19786 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19787 #ifdef subprocesses
19788 obj
= Fget_buffer_process (Fcurrent_buffer ());
19789 if (PROCESSP (obj
))
19791 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19793 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19796 #endif /* subprocesses */
19799 return decode_mode_spec_buf
;
19806 return SSDATA (obj
);
19813 /* Count up to COUNT lines starting from START_BYTE.
19814 But don't go beyond LIMIT_BYTE.
19815 Return the number of lines thus found (always nonnegative).
19817 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19820 display_count_lines (EMACS_INT start_byte
,
19821 EMACS_INT limit_byte
, EMACS_INT count
,
19822 EMACS_INT
*byte_pos_ptr
)
19824 register unsigned char *cursor
;
19825 unsigned char *base
;
19827 register EMACS_INT ceiling
;
19828 register unsigned char *ceiling_addr
;
19829 EMACS_INT orig_count
= count
;
19831 /* If we are not in selective display mode,
19832 check only for newlines. */
19833 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19834 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19838 while (start_byte
< limit_byte
)
19840 ceiling
= BUFFER_CEILING_OF (start_byte
);
19841 ceiling
= min (limit_byte
- 1, ceiling
);
19842 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19843 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19846 if (selective_display
)
19847 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19850 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19853 if (cursor
!= ceiling_addr
)
19857 start_byte
+= cursor
- base
+ 1;
19858 *byte_pos_ptr
= start_byte
;
19862 if (++cursor
== ceiling_addr
)
19868 start_byte
+= cursor
- base
;
19873 while (start_byte
> limit_byte
)
19875 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19876 ceiling
= max (limit_byte
, ceiling
);
19877 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19878 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19881 if (selective_display
)
19882 while (--cursor
!= ceiling_addr
19883 && *cursor
!= '\n' && *cursor
!= 015)
19886 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19889 if (cursor
!= ceiling_addr
)
19893 start_byte
+= cursor
- base
+ 1;
19894 *byte_pos_ptr
= start_byte
;
19895 /* When scanning backwards, we should
19896 not count the newline posterior to which we stop. */
19897 return - orig_count
- 1;
19903 /* Here we add 1 to compensate for the last decrement
19904 of CURSOR, which took it past the valid range. */
19905 start_byte
+= cursor
- base
+ 1;
19909 *byte_pos_ptr
= limit_byte
;
19912 return - orig_count
+ count
;
19913 return orig_count
- count
;
19919 /***********************************************************************
19921 ***********************************************************************/
19923 /* Display a NUL-terminated string, starting with index START.
19925 If STRING is non-null, display that C string. Otherwise, the Lisp
19926 string LISP_STRING is displayed. There's a case that STRING is
19927 non-null and LISP_STRING is not nil. It means STRING is a string
19928 data of LISP_STRING. In that case, we display LISP_STRING while
19929 ignoring its text properties.
19931 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19932 FACE_STRING. Display STRING or LISP_STRING with the face at
19933 FACE_STRING_POS in FACE_STRING:
19935 Display the string in the environment given by IT, but use the
19936 standard display table, temporarily.
19938 FIELD_WIDTH is the minimum number of output glyphs to produce.
19939 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19940 with spaces. If STRING has more characters, more than FIELD_WIDTH
19941 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19943 PRECISION is the maximum number of characters to output from
19944 STRING. PRECISION < 0 means don't truncate the string.
19946 This is roughly equivalent to printf format specifiers:
19948 FIELD_WIDTH PRECISION PRINTF
19949 ----------------------------------------
19955 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19956 display them, and < 0 means obey the current buffer's value of
19957 enable_multibyte_characters.
19959 Value is the number of columns displayed. */
19962 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19963 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19964 int field_width
, int precision
, int max_x
, int multibyte
)
19966 int hpos_at_start
= it
->hpos
;
19967 int saved_face_id
= it
->face_id
;
19968 struct glyph_row
*row
= it
->glyph_row
;
19970 /* Initialize the iterator IT for iteration over STRING beginning
19971 with index START. */
19972 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19973 precision
, field_width
, multibyte
);
19974 if (string
&& STRINGP (lisp_string
))
19975 /* LISP_STRING is the one returned by decode_mode_spec. We should
19976 ignore its text properties. */
19977 it
->stop_charpos
= -1;
19979 /* If displaying STRING, set up the face of the iterator
19980 from LISP_STRING, if that's given. */
19981 if (STRINGP (face_string
))
19987 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19988 0, it
->region_beg_charpos
,
19989 it
->region_end_charpos
,
19990 &endptr
, it
->base_face_id
, 0);
19991 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19992 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19995 /* Set max_x to the maximum allowed X position. Don't let it go
19996 beyond the right edge of the window. */
19998 max_x
= it
->last_visible_x
;
20000 max_x
= min (max_x
, it
->last_visible_x
);
20002 /* Skip over display elements that are not visible. because IT->w is
20004 if (it
->current_x
< it
->first_visible_x
)
20005 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20006 MOVE_TO_POS
| MOVE_TO_X
);
20008 row
->ascent
= it
->max_ascent
;
20009 row
->height
= it
->max_ascent
+ it
->max_descent
;
20010 row
->phys_ascent
= it
->max_phys_ascent
;
20011 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20012 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20014 /* This condition is for the case that we are called with current_x
20015 past last_visible_x. */
20016 while (it
->current_x
< max_x
)
20018 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20020 /* Get the next display element. */
20021 if (!get_next_display_element (it
))
20024 /* Produce glyphs. */
20025 x_before
= it
->current_x
;
20026 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20027 PRODUCE_GLYPHS (it
);
20029 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
20032 while (i
< nglyphs
)
20034 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20036 if (it
->line_wrap
!= TRUNCATE
20037 && x
+ glyph
->pixel_width
> max_x
)
20039 /* End of continued line or max_x reached. */
20040 if (CHAR_GLYPH_PADDING_P (*glyph
))
20042 /* A wide character is unbreakable. */
20043 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
20044 it
->current_x
= x_before
;
20048 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20053 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20055 /* Glyph is at least partially visible. */
20057 if (x
< it
->first_visible_x
)
20058 it
->glyph_row
->x
= x
- it
->first_visible_x
;
20062 /* Glyph is off the left margin of the display area.
20063 Should not happen. */
20067 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20068 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20069 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20070 row
->phys_height
= max (row
->phys_height
,
20071 it
->max_phys_ascent
+ it
->max_phys_descent
);
20072 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20073 it
->max_extra_line_spacing
);
20074 x
+= glyph
->pixel_width
;
20078 /* Stop if max_x reached. */
20082 /* Stop at line ends. */
20083 if (ITERATOR_AT_END_OF_LINE_P (it
))
20085 it
->continuation_lines_width
= 0;
20089 set_iterator_to_next (it
, 1);
20091 /* Stop if truncating at the right edge. */
20092 if (it
->line_wrap
== TRUNCATE
20093 && it
->current_x
>= it
->last_visible_x
)
20095 /* Add truncation mark, but don't do it if the line is
20096 truncated at a padding space. */
20097 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20099 if (!FRAME_WINDOW_P (it
->f
))
20103 if (it
->current_x
> it
->last_visible_x
)
20105 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20106 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20108 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20110 row
->used
[TEXT_AREA
] = ii
;
20111 produce_special_glyphs (it
, IT_TRUNCATION
);
20114 produce_special_glyphs (it
, IT_TRUNCATION
);
20116 it
->glyph_row
->truncated_on_right_p
= 1;
20122 /* Maybe insert a truncation at the left. */
20123 if (it
->first_visible_x
20124 && IT_CHARPOS (*it
) > 0)
20126 if (!FRAME_WINDOW_P (it
->f
))
20127 insert_left_trunc_glyphs (it
);
20128 it
->glyph_row
->truncated_on_left_p
= 1;
20131 it
->face_id
= saved_face_id
;
20133 /* Value is number of columns displayed. */
20134 return it
->hpos
- hpos_at_start
;
20139 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20140 appears as an element of LIST or as the car of an element of LIST.
20141 If PROPVAL is a list, compare each element against LIST in that
20142 way, and return 1/2 if any element of PROPVAL is found in LIST.
20143 Otherwise return 0. This function cannot quit.
20144 The return value is 2 if the text is invisible but with an ellipsis
20145 and 1 if it's invisible and without an ellipsis. */
20148 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20150 register Lisp_Object tail
, proptail
;
20152 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20154 register Lisp_Object tem
;
20156 if (EQ (propval
, tem
))
20158 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20159 return NILP (XCDR (tem
)) ? 1 : 2;
20162 if (CONSP (propval
))
20164 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20166 Lisp_Object propelt
;
20167 propelt
= XCAR (proptail
);
20168 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20170 register Lisp_Object tem
;
20172 if (EQ (propelt
, tem
))
20174 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20175 return NILP (XCDR (tem
)) ? 1 : 2;
20183 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20184 doc
: /* Non-nil if the property makes the text invisible.
20185 POS-OR-PROP can be a marker or number, in which case it is taken to be
20186 a position in the current buffer and the value of the `invisible' property
20187 is checked; or it can be some other value, which is then presumed to be the
20188 value of the `invisible' property of the text of interest.
20189 The non-nil value returned can be t for truly invisible text or something
20190 else if the text is replaced by an ellipsis. */)
20191 (Lisp_Object pos_or_prop
)
20194 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20195 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20197 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20198 return (invis
== 0 ? Qnil
20200 : make_number (invis
));
20203 /* Calculate a width or height in pixels from a specification using
20204 the following elements:
20207 NUM - a (fractional) multiple of the default font width/height
20208 (NUM) - specifies exactly NUM pixels
20209 UNIT - a fixed number of pixels, see below.
20210 ELEMENT - size of a display element in pixels, see below.
20211 (NUM . SPEC) - equals NUM * SPEC
20212 (+ SPEC SPEC ...) - add pixel values
20213 (- SPEC SPEC ...) - subtract pixel values
20214 (- SPEC) - negate pixel value
20217 INT or FLOAT - a number constant
20218 SYMBOL - use symbol's (buffer local) variable binding.
20221 in - pixels per inch *)
20222 mm - pixels per 1/1000 meter *)
20223 cm - pixels per 1/100 meter *)
20224 width - width of current font in pixels.
20225 height - height of current font in pixels.
20227 *) using the ratio(s) defined in display-pixels-per-inch.
20231 left-fringe - left fringe width in pixels
20232 right-fringe - right fringe width in pixels
20234 left-margin - left margin width in pixels
20235 right-margin - right margin width in pixels
20237 scroll-bar - scroll-bar area width in pixels
20241 Pixels corresponding to 5 inches:
20244 Total width of non-text areas on left side of window (if scroll-bar is on left):
20245 '(space :width (+ left-fringe left-margin scroll-bar))
20247 Align to first text column (in header line):
20248 '(space :align-to 0)
20250 Align to middle of text area minus half the width of variable `my-image'
20251 containing a loaded image:
20252 '(space :align-to (0.5 . (- text my-image)))
20254 Width of left margin minus width of 1 character in the default font:
20255 '(space :width (- left-margin 1))
20257 Width of left margin minus width of 2 characters in the current font:
20258 '(space :width (- left-margin (2 . width)))
20260 Center 1 character over left-margin (in header line):
20261 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20263 Different ways to express width of left fringe plus left margin minus one pixel:
20264 '(space :width (- (+ left-fringe left-margin) (1)))
20265 '(space :width (+ left-fringe left-margin (- (1))))
20266 '(space :width (+ left-fringe left-margin (-1)))
20270 #define NUMVAL(X) \
20271 ((INTEGERP (X) || FLOATP (X)) \
20276 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20277 struct font
*font
, int width_p
, int *align_to
)
20281 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20282 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20285 return OK_PIXELS (0);
20287 xassert (FRAME_LIVE_P (it
->f
));
20289 if (SYMBOLP (prop
))
20291 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20293 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20295 if (unit
[0] == 'i' && unit
[1] == 'n')
20297 else if (unit
[0] == 'm' && unit
[1] == 'm')
20299 else if (unit
[0] == 'c' && unit
[1] == 'm')
20306 #ifdef HAVE_WINDOW_SYSTEM
20307 if (FRAME_WINDOW_P (it
->f
)
20309 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20310 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20312 return OK_PIXELS (ppi
/ pixels
);
20315 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20316 || (CONSP (Vdisplay_pixels_per_inch
)
20318 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20319 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20321 return OK_PIXELS (ppi
/ pixels
);
20327 #ifdef HAVE_WINDOW_SYSTEM
20328 if (EQ (prop
, Qheight
))
20329 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20330 if (EQ (prop
, Qwidth
))
20331 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20333 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20334 return OK_PIXELS (1);
20337 if (EQ (prop
, Qtext
))
20338 return OK_PIXELS (width_p
20339 ? window_box_width (it
->w
, TEXT_AREA
)
20340 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20342 if (align_to
&& *align_to
< 0)
20345 if (EQ (prop
, Qleft
))
20346 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20347 if (EQ (prop
, Qright
))
20348 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20349 if (EQ (prop
, Qcenter
))
20350 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20351 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20352 if (EQ (prop
, Qleft_fringe
))
20353 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20354 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20355 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20356 if (EQ (prop
, Qright_fringe
))
20357 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20358 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20359 : window_box_right_offset (it
->w
, TEXT_AREA
));
20360 if (EQ (prop
, Qleft_margin
))
20361 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20362 if (EQ (prop
, Qright_margin
))
20363 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20364 if (EQ (prop
, Qscroll_bar
))
20365 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20367 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20368 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20369 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20374 if (EQ (prop
, Qleft_fringe
))
20375 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20376 if (EQ (prop
, Qright_fringe
))
20377 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20378 if (EQ (prop
, Qleft_margin
))
20379 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20380 if (EQ (prop
, Qright_margin
))
20381 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20382 if (EQ (prop
, Qscroll_bar
))
20383 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20386 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20389 if (INTEGERP (prop
) || FLOATP (prop
))
20391 int base_unit
= (width_p
20392 ? FRAME_COLUMN_WIDTH (it
->f
)
20393 : FRAME_LINE_HEIGHT (it
->f
));
20394 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20399 Lisp_Object car
= XCAR (prop
);
20400 Lisp_Object cdr
= XCDR (prop
);
20404 #ifdef HAVE_WINDOW_SYSTEM
20405 if (FRAME_WINDOW_P (it
->f
)
20406 && valid_image_p (prop
))
20408 int id
= lookup_image (it
->f
, prop
);
20409 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20411 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20414 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20420 while (CONSP (cdr
))
20422 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20423 font
, width_p
, align_to
))
20426 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20431 if (EQ (car
, Qminus
))
20433 return OK_PIXELS (pixels
);
20436 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20439 if (INTEGERP (car
) || FLOATP (car
))
20442 pixels
= XFLOATINT (car
);
20444 return OK_PIXELS (pixels
);
20445 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20446 font
, width_p
, align_to
))
20447 return OK_PIXELS (pixels
* fact
);
20458 /***********************************************************************
20460 ***********************************************************************/
20462 #ifdef HAVE_WINDOW_SYSTEM
20467 dump_glyph_string (struct glyph_string
*s
)
20469 fprintf (stderr
, "glyph string\n");
20470 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20471 s
->x
, s
->y
, s
->width
, s
->height
);
20472 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20473 fprintf (stderr
, " hl = %d\n", s
->hl
);
20474 fprintf (stderr
, " left overhang = %d, right = %d\n",
20475 s
->left_overhang
, s
->right_overhang
);
20476 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20477 fprintf (stderr
, " extends to end of line = %d\n",
20478 s
->extends_to_end_of_line_p
);
20479 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20480 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20483 #endif /* GLYPH_DEBUG */
20485 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20486 of XChar2b structures for S; it can't be allocated in
20487 init_glyph_string because it must be allocated via `alloca'. W
20488 is the window on which S is drawn. ROW and AREA are the glyph row
20489 and area within the row from which S is constructed. START is the
20490 index of the first glyph structure covered by S. HL is a
20491 face-override for drawing S. */
20494 #define OPTIONAL_HDC(hdc) HDC hdc,
20495 #define DECLARE_HDC(hdc) HDC hdc;
20496 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20497 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20500 #ifndef OPTIONAL_HDC
20501 #define OPTIONAL_HDC(hdc)
20502 #define DECLARE_HDC(hdc)
20503 #define ALLOCATE_HDC(hdc, f)
20504 #define RELEASE_HDC(hdc, f)
20508 init_glyph_string (struct glyph_string
*s
,
20510 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20511 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20513 memset (s
, 0, sizeof *s
);
20515 s
->f
= XFRAME (w
->frame
);
20519 s
->display
= FRAME_X_DISPLAY (s
->f
);
20520 s
->window
= FRAME_X_WINDOW (s
->f
);
20521 s
->char2b
= char2b
;
20525 s
->first_glyph
= row
->glyphs
[area
] + start
;
20526 s
->height
= row
->height
;
20527 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20528 s
->ybase
= s
->y
+ row
->ascent
;
20532 /* Append the list of glyph strings with head H and tail T to the list
20533 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20536 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20537 struct glyph_string
*h
, struct glyph_string
*t
)
20551 /* Prepend the list of glyph strings with head H and tail T to the
20552 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20556 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20557 struct glyph_string
*h
, struct glyph_string
*t
)
20571 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20572 Set *HEAD and *TAIL to the resulting list. */
20575 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20576 struct glyph_string
*s
)
20578 s
->next
= s
->prev
= NULL
;
20579 append_glyph_string_lists (head
, tail
, s
, s
);
20583 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20584 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20585 make sure that X resources for the face returned are allocated.
20586 Value is a pointer to a realized face that is ready for display if
20587 DISPLAY_P is non-zero. */
20589 static inline struct face
*
20590 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20591 XChar2b
*char2b
, int display_p
)
20593 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20597 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20599 if (code
!= FONT_INVALID_CODE
)
20600 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20602 STORE_XCHAR2B (char2b
, 0, 0);
20605 /* Make sure X resources of the face are allocated. */
20606 #ifdef HAVE_X_WINDOWS
20610 xassert (face
!= NULL
);
20611 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20618 /* Get face and two-byte form of character glyph GLYPH on frame F.
20619 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20620 a pointer to a realized face that is ready for display. */
20622 static inline struct face
*
20623 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20624 XChar2b
*char2b
, int *two_byte_p
)
20628 xassert (glyph
->type
== CHAR_GLYPH
);
20629 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20638 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20639 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20641 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20643 if (code
!= FONT_INVALID_CODE
)
20644 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20646 STORE_XCHAR2B (char2b
, 0, 0);
20649 /* Make sure X resources of the face are allocated. */
20650 xassert (face
!= NULL
);
20651 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20656 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20657 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20660 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20664 if (CHAR_BYTE8_P (c
))
20665 code
= CHAR_TO_BYTE8 (c
);
20667 code
= font
->driver
->encode_char (font
, c
);
20669 if (code
== FONT_INVALID_CODE
)
20671 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20676 /* Fill glyph string S with composition components specified by S->cmp.
20678 BASE_FACE is the base face of the composition.
20679 S->cmp_from is the index of the first component for S.
20681 OVERLAPS non-zero means S should draw the foreground only, and use
20682 its physical height for clipping. See also draw_glyphs.
20684 Value is the index of a component not in S. */
20687 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20691 /* For all glyphs of this composition, starting at the offset
20692 S->cmp_from, until we reach the end of the definition or encounter a
20693 glyph that requires the different face, add it to S. */
20698 s
->for_overlaps
= overlaps
;
20701 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20703 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20707 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20710 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20717 s
->font
= s
->face
->font
;
20719 else if (s
->face
!= face
)
20727 /* All glyph strings for the same composition has the same width,
20728 i.e. the width set for the first component of the composition. */
20729 s
->width
= s
->first_glyph
->pixel_width
;
20731 /* If the specified font could not be loaded, use the frame's
20732 default font, but record the fact that we couldn't load it in
20733 the glyph string so that we can draw rectangles for the
20734 characters of the glyph string. */
20735 if (s
->font
== NULL
)
20737 s
->font_not_found_p
= 1;
20738 s
->font
= FRAME_FONT (s
->f
);
20741 /* Adjust base line for subscript/superscript text. */
20742 s
->ybase
+= s
->first_glyph
->voffset
;
20744 /* This glyph string must always be drawn with 16-bit functions. */
20751 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20752 int start
, int end
, int overlaps
)
20754 struct glyph
*glyph
, *last
;
20755 Lisp_Object lgstring
;
20758 s
->for_overlaps
= overlaps
;
20759 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20760 last
= s
->row
->glyphs
[s
->area
] + end
;
20761 s
->cmp_id
= glyph
->u
.cmp
.id
;
20762 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20763 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20764 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20765 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20766 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20768 while (glyph
< last
20769 && glyph
->u
.cmp
.automatic
20770 && glyph
->u
.cmp
.id
== s
->cmp_id
20771 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20772 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20774 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20776 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20777 unsigned code
= LGLYPH_CODE (lglyph
);
20779 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20781 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20782 return glyph
- s
->row
->glyphs
[s
->area
];
20786 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20787 See the comment of fill_glyph_string for arguments.
20788 Value is the index of the first glyph not in S. */
20792 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20793 int start
, int end
, int overlaps
)
20795 struct glyph
*glyph
, *last
;
20798 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20799 s
->for_overlaps
= overlaps
;
20800 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20801 last
= s
->row
->glyphs
[s
->area
] + end
;
20802 voffset
= glyph
->voffset
;
20803 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20804 s
->font
= s
->face
->font
;
20806 s
->width
= glyph
->pixel_width
;
20808 while (glyph
< last
20809 && glyph
->type
== GLYPHLESS_GLYPH
20810 && glyph
->voffset
== voffset
20811 && glyph
->face_id
== face_id
)
20814 s
->width
+= glyph
->pixel_width
;
20817 s
->ybase
+= voffset
;
20818 return glyph
- s
->row
->glyphs
[s
->area
];
20822 /* Fill glyph string S from a sequence of character glyphs.
20824 FACE_ID is the face id of the string. START is the index of the
20825 first glyph to consider, END is the index of the last + 1.
20826 OVERLAPS non-zero means S should draw the foreground only, and use
20827 its physical height for clipping. See also draw_glyphs.
20829 Value is the index of the first glyph not in S. */
20832 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20833 int start
, int end
, int overlaps
)
20835 struct glyph
*glyph
, *last
;
20837 int glyph_not_available_p
;
20839 xassert (s
->f
== XFRAME (s
->w
->frame
));
20840 xassert (s
->nchars
== 0);
20841 xassert (start
>= 0 && end
> start
);
20843 s
->for_overlaps
= overlaps
;
20844 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20845 last
= s
->row
->glyphs
[s
->area
] + end
;
20846 voffset
= glyph
->voffset
;
20847 s
->padding_p
= glyph
->padding_p
;
20848 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20850 while (glyph
< last
20851 && glyph
->type
== CHAR_GLYPH
20852 && glyph
->voffset
== voffset
20853 /* Same face id implies same font, nowadays. */
20854 && glyph
->face_id
== face_id
20855 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20859 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20860 s
->char2b
+ s
->nchars
,
20862 s
->two_byte_p
= two_byte_p
;
20864 xassert (s
->nchars
<= end
- start
);
20865 s
->width
+= glyph
->pixel_width
;
20866 if (glyph
++->padding_p
!= s
->padding_p
)
20870 s
->font
= s
->face
->font
;
20872 /* If the specified font could not be loaded, use the frame's font,
20873 but record the fact that we couldn't load it in
20874 S->font_not_found_p so that we can draw rectangles for the
20875 characters of the glyph string. */
20876 if (s
->font
== NULL
|| glyph_not_available_p
)
20878 s
->font_not_found_p
= 1;
20879 s
->font
= FRAME_FONT (s
->f
);
20882 /* Adjust base line for subscript/superscript text. */
20883 s
->ybase
+= voffset
;
20885 xassert (s
->face
&& s
->face
->gc
);
20886 return glyph
- s
->row
->glyphs
[s
->area
];
20890 /* Fill glyph string S from image glyph S->first_glyph. */
20893 fill_image_glyph_string (struct glyph_string
*s
)
20895 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20896 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20898 s
->slice
= s
->first_glyph
->slice
.img
;
20899 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20900 s
->font
= s
->face
->font
;
20901 s
->width
= s
->first_glyph
->pixel_width
;
20903 /* Adjust base line for subscript/superscript text. */
20904 s
->ybase
+= s
->first_glyph
->voffset
;
20908 /* Fill glyph string S from a sequence of stretch glyphs.
20910 START is the index of the first glyph to consider,
20911 END is the index of the last + 1.
20913 Value is the index of the first glyph not in S. */
20916 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20918 struct glyph
*glyph
, *last
;
20919 int voffset
, face_id
;
20921 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20923 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20924 last
= s
->row
->glyphs
[s
->area
] + end
;
20925 face_id
= glyph
->face_id
;
20926 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20927 s
->font
= s
->face
->font
;
20928 s
->width
= glyph
->pixel_width
;
20930 voffset
= glyph
->voffset
;
20934 && glyph
->type
== STRETCH_GLYPH
20935 && glyph
->voffset
== voffset
20936 && glyph
->face_id
== face_id
);
20938 s
->width
+= glyph
->pixel_width
;
20940 /* Adjust base line for subscript/superscript text. */
20941 s
->ybase
+= voffset
;
20943 /* The case that face->gc == 0 is handled when drawing the glyph
20944 string by calling PREPARE_FACE_FOR_DISPLAY. */
20946 return glyph
- s
->row
->glyphs
[s
->area
];
20949 static struct font_metrics
*
20950 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20952 static struct font_metrics metrics
;
20953 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20955 if (! font
|| code
== FONT_INVALID_CODE
)
20957 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20962 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20963 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20964 assumed to be zero. */
20967 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20969 *left
= *right
= 0;
20971 if (glyph
->type
== CHAR_GLYPH
)
20975 struct font_metrics
*pcm
;
20977 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20978 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20980 if (pcm
->rbearing
> pcm
->width
)
20981 *right
= pcm
->rbearing
- pcm
->width
;
20982 if (pcm
->lbearing
< 0)
20983 *left
= -pcm
->lbearing
;
20986 else if (glyph
->type
== COMPOSITE_GLYPH
)
20988 if (! glyph
->u
.cmp
.automatic
)
20990 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20992 if (cmp
->rbearing
> cmp
->pixel_width
)
20993 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20994 if (cmp
->lbearing
< 0)
20995 *left
= - cmp
->lbearing
;
20999 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21000 struct font_metrics metrics
;
21002 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21003 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21004 if (metrics
.rbearing
> metrics
.width
)
21005 *right
= metrics
.rbearing
- metrics
.width
;
21006 if (metrics
.lbearing
< 0)
21007 *left
= - metrics
.lbearing
;
21013 /* Return the index of the first glyph preceding glyph string S that
21014 is overwritten by S because of S's left overhang. Value is -1
21015 if no glyphs are overwritten. */
21018 left_overwritten (struct glyph_string
*s
)
21022 if (s
->left_overhang
)
21025 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21026 int first
= s
->first_glyph
- glyphs
;
21028 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21029 x
-= glyphs
[i
].pixel_width
;
21040 /* Return the index of the first glyph preceding glyph string S that
21041 is overwriting S because of its right overhang. Value is -1 if no
21042 glyph in front of S overwrites S. */
21045 left_overwriting (struct glyph_string
*s
)
21048 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21049 int first
= s
->first_glyph
- glyphs
;
21053 for (i
= first
- 1; i
>= 0; --i
)
21056 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21059 x
-= glyphs
[i
].pixel_width
;
21066 /* Return the index of the last glyph following glyph string S that is
21067 overwritten by S because of S's right overhang. Value is -1 if
21068 no such glyph is found. */
21071 right_overwritten (struct glyph_string
*s
)
21075 if (s
->right_overhang
)
21078 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21079 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21080 int end
= s
->row
->used
[s
->area
];
21082 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21083 x
+= glyphs
[i
].pixel_width
;
21092 /* Return the index of the last glyph following glyph string S that
21093 overwrites S because of its left overhang. Value is negative
21094 if no such glyph is found. */
21097 right_overwriting (struct glyph_string
*s
)
21100 int end
= s
->row
->used
[s
->area
];
21101 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21102 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21106 for (i
= first
; i
< end
; ++i
)
21109 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21112 x
+= glyphs
[i
].pixel_width
;
21119 /* Set background width of glyph string S. START is the index of the
21120 first glyph following S. LAST_X is the right-most x-position + 1
21121 in the drawing area. */
21124 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21126 /* If the face of this glyph string has to be drawn to the end of
21127 the drawing area, set S->extends_to_end_of_line_p. */
21129 if (start
== s
->row
->used
[s
->area
]
21130 && s
->area
== TEXT_AREA
21131 && ((s
->row
->fill_line_p
21132 && (s
->hl
== DRAW_NORMAL_TEXT
21133 || s
->hl
== DRAW_IMAGE_RAISED
21134 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21135 || s
->hl
== DRAW_MOUSE_FACE
))
21136 s
->extends_to_end_of_line_p
= 1;
21138 /* If S extends its face to the end of the line, set its
21139 background_width to the distance to the right edge of the drawing
21141 if (s
->extends_to_end_of_line_p
)
21142 s
->background_width
= last_x
- s
->x
+ 1;
21144 s
->background_width
= s
->width
;
21148 /* Compute overhangs and x-positions for glyph string S and its
21149 predecessors, or successors. X is the starting x-position for S.
21150 BACKWARD_P non-zero means process predecessors. */
21153 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21159 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21160 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21170 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21171 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21181 /* The following macros are only called from draw_glyphs below.
21182 They reference the following parameters of that function directly:
21183 `w', `row', `area', and `overlap_p'
21184 as well as the following local variables:
21185 `s', `f', and `hdc' (in W32) */
21188 /* On W32, silently add local `hdc' variable to argument list of
21189 init_glyph_string. */
21190 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21191 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21193 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21194 init_glyph_string (s, char2b, w, row, area, start, hl)
21197 /* Add a glyph string for a stretch glyph to the list of strings
21198 between HEAD and TAIL. START is the index of the stretch glyph in
21199 row area AREA of glyph row ROW. END is the index of the last glyph
21200 in that glyph row area. X is the current output position assigned
21201 to the new glyph string constructed. HL overrides that face of the
21202 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21203 is the right-most x-position of the drawing area. */
21205 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21206 and below -- keep them on one line. */
21207 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21210 s = (struct glyph_string *) alloca (sizeof *s); \
21211 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21212 START = fill_stretch_glyph_string (s, START, END); \
21213 append_glyph_string (&HEAD, &TAIL, s); \
21219 /* Add a glyph string for an image glyph to the list of strings
21220 between HEAD and TAIL. START is the index of the image glyph in
21221 row area AREA of glyph row ROW. END is the index of the last glyph
21222 in that glyph row area. X is the current output position assigned
21223 to the new glyph string constructed. HL overrides that face of the
21224 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21225 is the right-most x-position of the drawing area. */
21227 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21230 s = (struct glyph_string *) alloca (sizeof *s); \
21231 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21232 fill_image_glyph_string (s); \
21233 append_glyph_string (&HEAD, &TAIL, s); \
21240 /* Add a glyph string for a sequence of character glyphs to the list
21241 of strings between HEAD and TAIL. START is the index of the first
21242 glyph in row area AREA of glyph row ROW that is part of the new
21243 glyph string. END is the index of the last glyph in that glyph row
21244 area. X is the current output position assigned to the new glyph
21245 string constructed. HL overrides that face of the glyph; e.g. it
21246 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21247 right-most x-position of the drawing area. */
21249 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21255 face_id = (row)->glyphs[area][START].face_id; \
21257 s = (struct glyph_string *) alloca (sizeof *s); \
21258 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21259 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21260 append_glyph_string (&HEAD, &TAIL, s); \
21262 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21267 /* Add a glyph string for a composite sequence to the list of strings
21268 between HEAD and TAIL. START is the index of the first glyph in
21269 row area AREA of glyph row ROW that is part of the new glyph
21270 string. END is the index of the last glyph in that glyph row area.
21271 X is the current output position assigned to the new glyph string
21272 constructed. HL overrides that face of the glyph; e.g. it is
21273 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21274 x-position of the drawing area. */
21276 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21278 int face_id = (row)->glyphs[area][START].face_id; \
21279 struct face *base_face = FACE_FROM_ID (f, face_id); \
21280 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21281 struct composition *cmp = composition_table[cmp_id]; \
21283 struct glyph_string *first_s IF_LINT (= NULL); \
21286 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21288 /* Make glyph_strings for each glyph sequence that is drawable by \
21289 the same face, and append them to HEAD/TAIL. */ \
21290 for (n = 0; n < cmp->glyph_len;) \
21292 s = (struct glyph_string *) alloca (sizeof *s); \
21293 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21294 append_glyph_string (&(HEAD), &(TAIL), s); \
21300 n = fill_composite_glyph_string (s, base_face, overlaps); \
21308 /* Add a glyph string for a glyph-string sequence to the list of strings
21309 between HEAD and TAIL. */
21311 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21315 Lisp_Object gstring; \
21317 face_id = (row)->glyphs[area][START].face_id; \
21318 gstring = (composition_gstring_from_id \
21319 ((row)->glyphs[area][START].u.cmp.id)); \
21320 s = (struct glyph_string *) alloca (sizeof *s); \
21321 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21322 * LGSTRING_GLYPH_LEN (gstring)); \
21323 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21324 append_glyph_string (&(HEAD), &(TAIL), s); \
21326 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21330 /* Add a glyph string for a sequence of glyphless character's glyphs
21331 to the list of strings between HEAD and TAIL. The meanings of
21332 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21334 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21339 face_id = (row)->glyphs[area][START].face_id; \
21341 s = (struct glyph_string *) alloca (sizeof *s); \
21342 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21343 append_glyph_string (&HEAD, &TAIL, s); \
21345 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21351 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21352 of AREA of glyph row ROW on window W between indices START and END.
21353 HL overrides the face for drawing glyph strings, e.g. it is
21354 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21355 x-positions of the drawing area.
21357 This is an ugly monster macro construct because we must use alloca
21358 to allocate glyph strings (because draw_glyphs can be called
21359 asynchronously). */
21361 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21364 HEAD = TAIL = NULL; \
21365 while (START < END) \
21367 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21368 switch (first_glyph->type) \
21371 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21375 case COMPOSITE_GLYPH: \
21376 if (first_glyph->u.cmp.automatic) \
21377 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21380 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21384 case STRETCH_GLYPH: \
21385 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21389 case IMAGE_GLYPH: \
21390 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21394 case GLYPHLESS_GLYPH: \
21395 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21405 set_glyph_string_background_width (s, START, LAST_X); \
21412 /* Draw glyphs between START and END in AREA of ROW on window W,
21413 starting at x-position X. X is relative to AREA in W. HL is a
21414 face-override with the following meaning:
21416 DRAW_NORMAL_TEXT draw normally
21417 DRAW_CURSOR draw in cursor face
21418 DRAW_MOUSE_FACE draw in mouse face.
21419 DRAW_INVERSE_VIDEO draw in mode line face
21420 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21421 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21423 If OVERLAPS is non-zero, draw only the foreground of characters and
21424 clip to the physical height of ROW. Non-zero value also defines
21425 the overlapping part to be drawn:
21427 OVERLAPS_PRED overlap with preceding rows
21428 OVERLAPS_SUCC overlap with succeeding rows
21429 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21430 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21432 Value is the x-position reached, relative to AREA of W. */
21435 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21436 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21437 enum draw_glyphs_face hl
, int overlaps
)
21439 struct glyph_string
*head
, *tail
;
21440 struct glyph_string
*s
;
21441 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21442 int i
, j
, x_reached
, last_x
, area_left
= 0;
21443 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21446 ALLOCATE_HDC (hdc
, f
);
21448 /* Let's rather be paranoid than getting a SEGV. */
21449 end
= min (end
, row
->used
[area
]);
21450 start
= max (0, start
);
21451 start
= min (end
, start
);
21453 /* Translate X to frame coordinates. Set last_x to the right
21454 end of the drawing area. */
21455 if (row
->full_width_p
)
21457 /* X is relative to the left edge of W, without scroll bars
21459 area_left
= WINDOW_LEFT_EDGE_X (w
);
21460 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21464 area_left
= window_box_left (w
, area
);
21465 last_x
= area_left
+ window_box_width (w
, area
);
21469 /* Build a doubly-linked list of glyph_string structures between
21470 head and tail from what we have to draw. Note that the macro
21471 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21472 the reason we use a separate variable `i'. */
21474 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21476 x_reached
= tail
->x
+ tail
->background_width
;
21480 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21481 the row, redraw some glyphs in front or following the glyph
21482 strings built above. */
21483 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21485 struct glyph_string
*h
, *t
;
21486 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21487 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21488 int check_mouse_face
= 0;
21491 /* If mouse highlighting is on, we may need to draw adjacent
21492 glyphs using mouse-face highlighting. */
21493 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21495 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21497 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21498 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21500 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21502 check_mouse_face
= 1;
21503 mouse_beg_col
= (row
== mouse_beg_row
)
21504 ? hlinfo
->mouse_face_beg_col
: 0;
21505 mouse_end_col
= (row
== mouse_end_row
)
21506 ? hlinfo
->mouse_face_end_col
21507 : row
->used
[TEXT_AREA
];
21511 /* Compute overhangs for all glyph strings. */
21512 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21513 for (s
= head
; s
; s
= s
->next
)
21514 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21516 /* Prepend glyph strings for glyphs in front of the first glyph
21517 string that are overwritten because of the first glyph
21518 string's left overhang. The background of all strings
21519 prepended must be drawn because the first glyph string
21521 i
= left_overwritten (head
);
21524 enum draw_glyphs_face overlap_hl
;
21526 /* If this row contains mouse highlighting, attempt to draw
21527 the overlapped glyphs with the correct highlight. This
21528 code fails if the overlap encompasses more than one glyph
21529 and mouse-highlight spans only some of these glyphs.
21530 However, making it work perfectly involves a lot more
21531 code, and I don't know if the pathological case occurs in
21532 practice, so we'll stick to this for now. --- cyd */
21533 if (check_mouse_face
21534 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21535 overlap_hl
= DRAW_MOUSE_FACE
;
21537 overlap_hl
= DRAW_NORMAL_TEXT
;
21540 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21541 overlap_hl
, dummy_x
, last_x
);
21543 compute_overhangs_and_x (t
, head
->x
, 1);
21544 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21548 /* Prepend glyph strings for glyphs in front of the first glyph
21549 string that overwrite that glyph string because of their
21550 right overhang. For these strings, only the foreground must
21551 be drawn, because it draws over the glyph string at `head'.
21552 The background must not be drawn because this would overwrite
21553 right overhangs of preceding glyphs for which no glyph
21555 i
= left_overwriting (head
);
21558 enum draw_glyphs_face overlap_hl
;
21560 if (check_mouse_face
21561 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21562 overlap_hl
= DRAW_MOUSE_FACE
;
21564 overlap_hl
= DRAW_NORMAL_TEXT
;
21567 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21568 overlap_hl
, dummy_x
, last_x
);
21569 for (s
= h
; s
; s
= s
->next
)
21570 s
->background_filled_p
= 1;
21571 compute_overhangs_and_x (t
, head
->x
, 1);
21572 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21575 /* Append glyphs strings for glyphs following the last glyph
21576 string tail that are overwritten by tail. The background of
21577 these strings has to be drawn because tail's foreground draws
21579 i
= right_overwritten (tail
);
21582 enum draw_glyphs_face overlap_hl
;
21584 if (check_mouse_face
21585 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21586 overlap_hl
= DRAW_MOUSE_FACE
;
21588 overlap_hl
= DRAW_NORMAL_TEXT
;
21590 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21591 overlap_hl
, x
, last_x
);
21592 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21593 we don't have `end = i;' here. */
21594 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21595 append_glyph_string_lists (&head
, &tail
, h
, t
);
21599 /* Append glyph strings for glyphs following the last glyph
21600 string tail that overwrite tail. The foreground of such
21601 glyphs has to be drawn because it writes into the background
21602 of tail. The background must not be drawn because it could
21603 paint over the foreground of following glyphs. */
21604 i
= right_overwriting (tail
);
21607 enum draw_glyphs_face overlap_hl
;
21608 if (check_mouse_face
21609 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21610 overlap_hl
= DRAW_MOUSE_FACE
;
21612 overlap_hl
= DRAW_NORMAL_TEXT
;
21615 i
++; /* We must include the Ith glyph. */
21616 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21617 overlap_hl
, x
, last_x
);
21618 for (s
= h
; s
; s
= s
->next
)
21619 s
->background_filled_p
= 1;
21620 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21621 append_glyph_string_lists (&head
, &tail
, h
, t
);
21623 if (clip_head
|| clip_tail
)
21624 for (s
= head
; s
; s
= s
->next
)
21626 s
->clip_head
= clip_head
;
21627 s
->clip_tail
= clip_tail
;
21631 /* Draw all strings. */
21632 for (s
= head
; s
; s
= s
->next
)
21633 FRAME_RIF (f
)->draw_glyph_string (s
);
21636 /* When focus a sole frame and move horizontally, this sets on_p to 0
21637 causing a failure to erase prev cursor position. */
21638 if (area
== TEXT_AREA
21639 && !row
->full_width_p
21640 /* When drawing overlapping rows, only the glyph strings'
21641 foreground is drawn, which doesn't erase a cursor
21645 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21646 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21647 : (tail
? tail
->x
+ tail
->background_width
: x
));
21651 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21652 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21656 /* Value is the x-position up to which drawn, relative to AREA of W.
21657 This doesn't include parts drawn because of overhangs. */
21658 if (row
->full_width_p
)
21659 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21661 x_reached
-= area_left
;
21663 RELEASE_HDC (hdc
, f
);
21668 /* Expand row matrix if too narrow. Don't expand if area
21671 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21673 if (!fonts_changed_p \
21674 && (it->glyph_row->glyphs[area] \
21675 < it->glyph_row->glyphs[area + 1])) \
21677 it->w->ncols_scale_factor++; \
21678 fonts_changed_p = 1; \
21682 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21683 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21686 append_glyph (struct it
*it
)
21688 struct glyph
*glyph
;
21689 enum glyph_row_area area
= it
->area
;
21691 xassert (it
->glyph_row
);
21692 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21694 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21695 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21697 /* If the glyph row is reversed, we need to prepend the glyph
21698 rather than append it. */
21699 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21703 /* Make room for the additional glyph. */
21704 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21706 glyph
= it
->glyph_row
->glyphs
[area
];
21708 glyph
->charpos
= CHARPOS (it
->position
);
21709 glyph
->object
= it
->object
;
21710 if (it
->pixel_width
> 0)
21712 glyph
->pixel_width
= it
->pixel_width
;
21713 glyph
->padding_p
= 0;
21717 /* Assure at least 1-pixel width. Otherwise, cursor can't
21718 be displayed correctly. */
21719 glyph
->pixel_width
= 1;
21720 glyph
->padding_p
= 1;
21722 glyph
->ascent
= it
->ascent
;
21723 glyph
->descent
= it
->descent
;
21724 glyph
->voffset
= it
->voffset
;
21725 glyph
->type
= CHAR_GLYPH
;
21726 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21727 glyph
->multibyte_p
= it
->multibyte_p
;
21728 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21729 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21730 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21731 || it
->phys_descent
> it
->descent
);
21732 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21733 glyph
->face_id
= it
->face_id
;
21734 glyph
->u
.ch
= it
->char_to_display
;
21735 glyph
->slice
.img
= null_glyph_slice
;
21736 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21739 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21740 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21742 glyph
->bidi_type
= it
->bidi_it
.type
;
21746 glyph
->resolved_level
= 0;
21747 glyph
->bidi_type
= UNKNOWN_BT
;
21749 ++it
->glyph_row
->used
[area
];
21752 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21755 /* Store one glyph for the composition IT->cmp_it.id in
21756 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21760 append_composite_glyph (struct it
*it
)
21762 struct glyph
*glyph
;
21763 enum glyph_row_area area
= it
->area
;
21765 xassert (it
->glyph_row
);
21767 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21768 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21770 /* If the glyph row is reversed, we need to prepend the glyph
21771 rather than append it. */
21772 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21776 /* Make room for the new glyph. */
21777 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21779 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21781 glyph
->charpos
= it
->cmp_it
.charpos
;
21782 glyph
->object
= it
->object
;
21783 glyph
->pixel_width
= it
->pixel_width
;
21784 glyph
->ascent
= it
->ascent
;
21785 glyph
->descent
= it
->descent
;
21786 glyph
->voffset
= it
->voffset
;
21787 glyph
->type
= COMPOSITE_GLYPH
;
21788 if (it
->cmp_it
.ch
< 0)
21790 glyph
->u
.cmp
.automatic
= 0;
21791 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21792 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21796 glyph
->u
.cmp
.automatic
= 1;
21797 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21798 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21799 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21801 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21802 glyph
->multibyte_p
= it
->multibyte_p
;
21803 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21804 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21805 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21806 || it
->phys_descent
> it
->descent
);
21807 glyph
->padding_p
= 0;
21808 glyph
->glyph_not_available_p
= 0;
21809 glyph
->face_id
= it
->face_id
;
21810 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21813 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21814 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21816 glyph
->bidi_type
= it
->bidi_it
.type
;
21818 ++it
->glyph_row
->used
[area
];
21821 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21825 /* Change IT->ascent and IT->height according to the setting of
21829 take_vertical_position_into_account (struct it
*it
)
21833 if (it
->voffset
< 0)
21834 /* Increase the ascent so that we can display the text higher
21836 it
->ascent
-= it
->voffset
;
21838 /* Increase the descent so that we can display the text lower
21840 it
->descent
+= it
->voffset
;
21845 /* Produce glyphs/get display metrics for the image IT is loaded with.
21846 See the description of struct display_iterator in dispextern.h for
21847 an overview of struct display_iterator. */
21850 produce_image_glyph (struct it
*it
)
21854 int glyph_ascent
, crop
;
21855 struct glyph_slice slice
;
21857 xassert (it
->what
== IT_IMAGE
);
21859 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21861 /* Make sure X resources of the face is loaded. */
21862 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21864 if (it
->image_id
< 0)
21866 /* Fringe bitmap. */
21867 it
->ascent
= it
->phys_ascent
= 0;
21868 it
->descent
= it
->phys_descent
= 0;
21869 it
->pixel_width
= 0;
21874 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21876 /* Make sure X resources of the image is loaded. */
21877 prepare_image_for_display (it
->f
, img
);
21879 slice
.x
= slice
.y
= 0;
21880 slice
.width
= img
->width
;
21881 slice
.height
= img
->height
;
21883 if (INTEGERP (it
->slice
.x
))
21884 slice
.x
= XINT (it
->slice
.x
);
21885 else if (FLOATP (it
->slice
.x
))
21886 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21888 if (INTEGERP (it
->slice
.y
))
21889 slice
.y
= XINT (it
->slice
.y
);
21890 else if (FLOATP (it
->slice
.y
))
21891 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21893 if (INTEGERP (it
->slice
.width
))
21894 slice
.width
= XINT (it
->slice
.width
);
21895 else if (FLOATP (it
->slice
.width
))
21896 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21898 if (INTEGERP (it
->slice
.height
))
21899 slice
.height
= XINT (it
->slice
.height
);
21900 else if (FLOATP (it
->slice
.height
))
21901 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21903 if (slice
.x
>= img
->width
)
21904 slice
.x
= img
->width
;
21905 if (slice
.y
>= img
->height
)
21906 slice
.y
= img
->height
;
21907 if (slice
.x
+ slice
.width
>= img
->width
)
21908 slice
.width
= img
->width
- slice
.x
;
21909 if (slice
.y
+ slice
.height
> img
->height
)
21910 slice
.height
= img
->height
- slice
.y
;
21912 if (slice
.width
== 0 || slice
.height
== 0)
21915 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21917 it
->descent
= slice
.height
- glyph_ascent
;
21919 it
->descent
+= img
->vmargin
;
21920 if (slice
.y
+ slice
.height
== img
->height
)
21921 it
->descent
+= img
->vmargin
;
21922 it
->phys_descent
= it
->descent
;
21924 it
->pixel_width
= slice
.width
;
21926 it
->pixel_width
+= img
->hmargin
;
21927 if (slice
.x
+ slice
.width
== img
->width
)
21928 it
->pixel_width
+= img
->hmargin
;
21930 /* It's quite possible for images to have an ascent greater than
21931 their height, so don't get confused in that case. */
21932 if (it
->descent
< 0)
21937 if (face
->box
!= FACE_NO_BOX
)
21939 if (face
->box_line_width
> 0)
21942 it
->ascent
+= face
->box_line_width
;
21943 if (slice
.y
+ slice
.height
== img
->height
)
21944 it
->descent
+= face
->box_line_width
;
21947 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21948 it
->pixel_width
+= eabs (face
->box_line_width
);
21949 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21950 it
->pixel_width
+= eabs (face
->box_line_width
);
21953 take_vertical_position_into_account (it
);
21955 /* Automatically crop wide image glyphs at right edge so we can
21956 draw the cursor on same display row. */
21957 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21958 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21960 it
->pixel_width
-= crop
;
21961 slice
.width
-= crop
;
21966 struct glyph
*glyph
;
21967 enum glyph_row_area area
= it
->area
;
21969 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21970 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21972 glyph
->charpos
= CHARPOS (it
->position
);
21973 glyph
->object
= it
->object
;
21974 glyph
->pixel_width
= it
->pixel_width
;
21975 glyph
->ascent
= glyph_ascent
;
21976 glyph
->descent
= it
->descent
;
21977 glyph
->voffset
= it
->voffset
;
21978 glyph
->type
= IMAGE_GLYPH
;
21979 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21980 glyph
->multibyte_p
= it
->multibyte_p
;
21981 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21982 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21983 glyph
->overlaps_vertically_p
= 0;
21984 glyph
->padding_p
= 0;
21985 glyph
->glyph_not_available_p
= 0;
21986 glyph
->face_id
= it
->face_id
;
21987 glyph
->u
.img_id
= img
->id
;
21988 glyph
->slice
.img
= slice
;
21989 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21992 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21993 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21995 glyph
->bidi_type
= it
->bidi_it
.type
;
21997 ++it
->glyph_row
->used
[area
];
22000 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22005 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22006 of the glyph, WIDTH and HEIGHT are the width and height of the
22007 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22010 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22011 int width
, int height
, int ascent
)
22013 struct glyph
*glyph
;
22014 enum glyph_row_area area
= it
->area
;
22016 xassert (ascent
>= 0 && ascent
<= height
);
22018 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22019 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22021 /* If the glyph row is reversed, we need to prepend the glyph
22022 rather than append it. */
22023 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22027 /* Make room for the additional glyph. */
22028 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22030 glyph
= it
->glyph_row
->glyphs
[area
];
22032 glyph
->charpos
= CHARPOS (it
->position
);
22033 glyph
->object
= object
;
22034 glyph
->pixel_width
= width
;
22035 glyph
->ascent
= ascent
;
22036 glyph
->descent
= height
- ascent
;
22037 glyph
->voffset
= it
->voffset
;
22038 glyph
->type
= STRETCH_GLYPH
;
22039 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22040 glyph
->multibyte_p
= it
->multibyte_p
;
22041 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22042 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22043 glyph
->overlaps_vertically_p
= 0;
22044 glyph
->padding_p
= 0;
22045 glyph
->glyph_not_available_p
= 0;
22046 glyph
->face_id
= it
->face_id
;
22047 glyph
->u
.stretch
.ascent
= ascent
;
22048 glyph
->u
.stretch
.height
= height
;
22049 glyph
->slice
.img
= null_glyph_slice
;
22050 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22053 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22054 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22056 glyph
->bidi_type
= it
->bidi_it
.type
;
22060 glyph
->resolved_level
= 0;
22061 glyph
->bidi_type
= UNKNOWN_BT
;
22063 ++it
->glyph_row
->used
[area
];
22066 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22070 /* Produce a stretch glyph for iterator IT. IT->object is the value
22071 of the glyph property displayed. The value must be a list
22072 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22075 1. `:width WIDTH' specifies that the space should be WIDTH *
22076 canonical char width wide. WIDTH may be an integer or floating
22079 2. `:relative-width FACTOR' specifies that the width of the stretch
22080 should be computed from the width of the first character having the
22081 `glyph' property, and should be FACTOR times that width.
22083 3. `:align-to HPOS' specifies that the space should be wide enough
22084 to reach HPOS, a value in canonical character units.
22086 Exactly one of the above pairs must be present.
22088 4. `:height HEIGHT' specifies that the height of the stretch produced
22089 should be HEIGHT, measured in canonical character units.
22091 5. `:relative-height FACTOR' specifies that the height of the
22092 stretch should be FACTOR times the height of the characters having
22093 the glyph property.
22095 Either none or exactly one of 4 or 5 must be present.
22097 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22098 of the stretch should be used for the ascent of the stretch.
22099 ASCENT must be in the range 0 <= ASCENT <= 100. */
22102 produce_stretch_glyph (struct it
*it
)
22104 /* (space :width WIDTH :height HEIGHT ...) */
22105 Lisp_Object prop
, plist
;
22106 int width
= 0, height
= 0, align_to
= -1;
22107 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22110 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22111 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22113 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22115 /* List should start with `space'. */
22116 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22117 plist
= XCDR (it
->object
);
22119 /* Compute the width of the stretch. */
22120 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22121 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22123 /* Absolute width `:width WIDTH' specified and valid. */
22124 zero_width_ok_p
= 1;
22127 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22130 /* Relative width `:relative-width FACTOR' specified and valid.
22131 Compute the width of the characters having the `glyph'
22134 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22137 if (it
->multibyte_p
)
22138 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22141 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22142 if (! ASCII_CHAR_P (it2
.c
))
22143 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22146 it2
.glyph_row
= NULL
;
22147 it2
.what
= IT_CHARACTER
;
22148 x_produce_glyphs (&it2
);
22149 width
= NUMVAL (prop
) * it2
.pixel_width
;
22151 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22152 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22154 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22155 align_to
= (align_to
< 0
22157 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22158 else if (align_to
< 0)
22159 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22160 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22161 zero_width_ok_p
= 1;
22164 /* Nothing specified -> width defaults to canonical char width. */
22165 width
= FRAME_COLUMN_WIDTH (it
->f
);
22167 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22170 /* Compute height. */
22171 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22172 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22175 zero_height_ok_p
= 1;
22177 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22179 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22181 height
= FONT_HEIGHT (font
);
22183 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22186 /* Compute percentage of height used for ascent. If
22187 `:ascent ASCENT' is present and valid, use that. Otherwise,
22188 derive the ascent from the font in use. */
22189 if (prop
= Fplist_get (plist
, QCascent
),
22190 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22191 ascent
= height
* NUMVAL (prop
) / 100.0;
22192 else if (!NILP (prop
)
22193 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22194 ascent
= min (max (0, (int)tem
), height
);
22196 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22198 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22199 && it
->current_x
+ width
> it
->last_visible_x
)
22200 width
= it
->last_visible_x
- it
->current_x
- 1;
22202 if (width
> 0 && height
> 0 && it
->glyph_row
)
22204 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22205 if (!STRINGP (object
))
22206 object
= it
->w
->buffer
;
22207 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22210 it
->pixel_width
= width
;
22211 it
->ascent
= it
->phys_ascent
= ascent
;
22212 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22213 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22215 take_vertical_position_into_account (it
);
22218 /* Calculate line-height and line-spacing properties.
22219 An integer value specifies explicit pixel value.
22220 A float value specifies relative value to current face height.
22221 A cons (float . face-name) specifies relative value to
22222 height of specified face font.
22224 Returns height in pixels, or nil. */
22228 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22229 int boff
, int override
)
22231 Lisp_Object face_name
= Qnil
;
22232 int ascent
, descent
, height
;
22234 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22239 face_name
= XCAR (val
);
22241 if (!NUMBERP (val
))
22242 val
= make_number (1);
22243 if (NILP (face_name
))
22245 height
= it
->ascent
+ it
->descent
;
22250 if (NILP (face_name
))
22252 font
= FRAME_FONT (it
->f
);
22253 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22255 else if (EQ (face_name
, Qt
))
22264 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22266 return make_number (-1);
22268 face
= FACE_FROM_ID (it
->f
, face_id
);
22271 return make_number (-1);
22272 boff
= font
->baseline_offset
;
22273 if (font
->vertical_centering
)
22274 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22277 ascent
= FONT_BASE (font
) + boff
;
22278 descent
= FONT_DESCENT (font
) - boff
;
22282 it
->override_ascent
= ascent
;
22283 it
->override_descent
= descent
;
22284 it
->override_boff
= boff
;
22287 height
= ascent
+ descent
;
22291 height
= (int)(XFLOAT_DATA (val
) * height
);
22292 else if (INTEGERP (val
))
22293 height
*= XINT (val
);
22295 return make_number (height
);
22299 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22300 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22301 and only if this is for a character for which no font was found.
22303 If the display method (it->glyphless_method) is
22304 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22305 length of the acronym or the hexadecimal string, UPPER_XOFF and
22306 UPPER_YOFF are pixel offsets for the upper part of the string,
22307 LOWER_XOFF and LOWER_YOFF are for the lower part.
22309 For the other display methods, LEN through LOWER_YOFF are zero. */
22312 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22313 short upper_xoff
, short upper_yoff
,
22314 short lower_xoff
, short lower_yoff
)
22316 struct glyph
*glyph
;
22317 enum glyph_row_area area
= it
->area
;
22319 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22320 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22322 /* If the glyph row is reversed, we need to prepend the glyph
22323 rather than append it. */
22324 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22328 /* Make room for the additional glyph. */
22329 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22331 glyph
= it
->glyph_row
->glyphs
[area
];
22333 glyph
->charpos
= CHARPOS (it
->position
);
22334 glyph
->object
= it
->object
;
22335 glyph
->pixel_width
= it
->pixel_width
;
22336 glyph
->ascent
= it
->ascent
;
22337 glyph
->descent
= it
->descent
;
22338 glyph
->voffset
= it
->voffset
;
22339 glyph
->type
= GLYPHLESS_GLYPH
;
22340 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22341 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22342 glyph
->u
.glyphless
.len
= len
;
22343 glyph
->u
.glyphless
.ch
= it
->c
;
22344 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22345 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22346 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22347 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22348 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22349 glyph
->multibyte_p
= it
->multibyte_p
;
22350 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22351 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22352 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22353 || it
->phys_descent
> it
->descent
);
22354 glyph
->padding_p
= 0;
22355 glyph
->glyph_not_available_p
= 0;
22356 glyph
->face_id
= face_id
;
22357 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22360 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22361 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22363 glyph
->bidi_type
= it
->bidi_it
.type
;
22365 ++it
->glyph_row
->used
[area
];
22368 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22372 /* Produce a glyph for a glyphless character for iterator IT.
22373 IT->glyphless_method specifies which method to use for displaying
22374 the character. See the description of enum
22375 glyphless_display_method in dispextern.h for the detail.
22377 FOR_NO_FONT is nonzero if and only if this is for a character for
22378 which no font was found. ACRONYM, if non-nil, is an acronym string
22379 for the character. */
22382 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22387 int base_width
, base_height
, width
, height
;
22388 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22391 /* Get the metrics of the base font. We always refer to the current
22393 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22394 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22395 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22396 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22397 base_height
= it
->ascent
+ it
->descent
;
22398 base_width
= font
->average_width
;
22400 /* Get a face ID for the glyph by utilizing a cache (the same way as
22401 doen for `escape-glyph' in get_next_display_element). */
22402 if (it
->f
== last_glyphless_glyph_frame
22403 && it
->face_id
== last_glyphless_glyph_face_id
)
22405 face_id
= last_glyphless_glyph_merged_face_id
;
22409 /* Merge the `glyphless-char' face into the current face. */
22410 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22411 last_glyphless_glyph_frame
= it
->f
;
22412 last_glyphless_glyph_face_id
= it
->face_id
;
22413 last_glyphless_glyph_merged_face_id
= face_id
;
22416 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22418 it
->pixel_width
= THIN_SPACE_WIDTH
;
22420 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22422 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22424 width
= CHAR_WIDTH (it
->c
);
22427 else if (width
> 4)
22429 it
->pixel_width
= base_width
* width
;
22431 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22437 unsigned int code
[6];
22439 int ascent
, descent
;
22440 struct font_metrics metrics_upper
, metrics_lower
;
22442 face
= FACE_FROM_ID (it
->f
, face_id
);
22443 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22444 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22446 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22448 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22449 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22450 if (CONSP (acronym
))
22451 acronym
= XCAR (acronym
);
22452 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22456 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22457 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22460 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22461 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22462 upper_len
= (len
+ 1) / 2;
22463 font
->driver
->text_extents (font
, code
, upper_len
,
22465 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22470 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22471 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22472 upper_xoff
= upper_yoff
= 2; /* the typical case */
22473 if (base_width
>= width
)
22475 /* Align the upper to the left, the lower to the right. */
22476 it
->pixel_width
= base_width
;
22477 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22481 /* Center the shorter one. */
22482 it
->pixel_width
= width
;
22483 if (metrics_upper
.width
>= metrics_lower
.width
)
22484 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22487 /* FIXME: This code doesn't look right. It formerly was
22488 missing the "lower_xoff = 0;", which couldn't have
22489 been right since it left lower_xoff uninitialized. */
22491 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22495 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22496 top, bottom, and between upper and lower strings. */
22497 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22498 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22499 /* Center vertically.
22500 H:base_height, D:base_descent
22501 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22503 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22504 descent = D - H/2 + h/2;
22505 lower_yoff = descent - 2 - ld;
22506 upper_yoff = lower_yoff - la - 1 - ud; */
22507 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22508 descent
= it
->descent
- (base_height
- height
) / 2;
22509 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22510 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22511 - metrics_upper
.descent
);
22512 /* Don't make the height shorter than the base height. */
22513 if (height
> base_height
)
22515 it
->ascent
= ascent
;
22516 it
->descent
= descent
;
22520 it
->phys_ascent
= it
->ascent
;
22521 it
->phys_descent
= it
->descent
;
22523 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22524 upper_xoff
, upper_yoff
,
22525 lower_xoff
, lower_yoff
);
22527 take_vertical_position_into_account (it
);
22532 Produce glyphs/get display metrics for the display element IT is
22533 loaded with. See the description of struct it in dispextern.h
22534 for an overview of struct it. */
22537 x_produce_glyphs (struct it
*it
)
22539 int extra_line_spacing
= it
->extra_line_spacing
;
22541 it
->glyph_not_available_p
= 0;
22543 if (it
->what
== IT_CHARACTER
)
22546 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22547 struct font
*font
= face
->font
;
22548 struct font_metrics
*pcm
= NULL
;
22549 int boff
; /* baseline offset */
22553 /* When no suitable font is found, display this character by
22554 the method specified in the first extra slot of
22555 Vglyphless_char_display. */
22556 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22558 xassert (it
->what
== IT_GLYPHLESS
);
22559 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22563 boff
= font
->baseline_offset
;
22564 if (font
->vertical_centering
)
22565 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22567 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22573 if (it
->override_ascent
>= 0)
22575 it
->ascent
= it
->override_ascent
;
22576 it
->descent
= it
->override_descent
;
22577 boff
= it
->override_boff
;
22581 it
->ascent
= FONT_BASE (font
) + boff
;
22582 it
->descent
= FONT_DESCENT (font
) - boff
;
22585 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22587 pcm
= get_per_char_metric (font
, &char2b
);
22588 if (pcm
->width
== 0
22589 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22595 it
->phys_ascent
= pcm
->ascent
+ boff
;
22596 it
->phys_descent
= pcm
->descent
- boff
;
22597 it
->pixel_width
= pcm
->width
;
22601 it
->glyph_not_available_p
= 1;
22602 it
->phys_ascent
= it
->ascent
;
22603 it
->phys_descent
= it
->descent
;
22604 it
->pixel_width
= font
->space_width
;
22607 if (it
->constrain_row_ascent_descent_p
)
22609 if (it
->descent
> it
->max_descent
)
22611 it
->ascent
+= it
->descent
- it
->max_descent
;
22612 it
->descent
= it
->max_descent
;
22614 if (it
->ascent
> it
->max_ascent
)
22616 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22617 it
->ascent
= it
->max_ascent
;
22619 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22620 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22621 extra_line_spacing
= 0;
22624 /* If this is a space inside a region of text with
22625 `space-width' property, change its width. */
22626 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22628 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22630 /* If face has a box, add the box thickness to the character
22631 height. If character has a box line to the left and/or
22632 right, add the box line width to the character's width. */
22633 if (face
->box
!= FACE_NO_BOX
)
22635 int thick
= face
->box_line_width
;
22639 it
->ascent
+= thick
;
22640 it
->descent
+= thick
;
22645 if (it
->start_of_box_run_p
)
22646 it
->pixel_width
+= thick
;
22647 if (it
->end_of_box_run_p
)
22648 it
->pixel_width
+= thick
;
22651 /* If face has an overline, add the height of the overline
22652 (1 pixel) and a 1 pixel margin to the character height. */
22653 if (face
->overline_p
)
22654 it
->ascent
+= overline_margin
;
22656 if (it
->constrain_row_ascent_descent_p
)
22658 if (it
->ascent
> it
->max_ascent
)
22659 it
->ascent
= it
->max_ascent
;
22660 if (it
->descent
> it
->max_descent
)
22661 it
->descent
= it
->max_descent
;
22664 take_vertical_position_into_account (it
);
22666 /* If we have to actually produce glyphs, do it. */
22671 /* Translate a space with a `space-width' property
22672 into a stretch glyph. */
22673 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22674 / FONT_HEIGHT (font
));
22675 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22676 it
->ascent
+ it
->descent
, ascent
);
22681 /* If characters with lbearing or rbearing are displayed
22682 in this line, record that fact in a flag of the
22683 glyph row. This is used to optimize X output code. */
22684 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22685 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22687 if (! stretched_p
&& it
->pixel_width
== 0)
22688 /* We assure that all visible glyphs have at least 1-pixel
22690 it
->pixel_width
= 1;
22692 else if (it
->char_to_display
== '\n')
22694 /* A newline has no width, but we need the height of the
22695 line. But if previous part of the line sets a height,
22696 don't increase that height */
22698 Lisp_Object height
;
22699 Lisp_Object total_height
= Qnil
;
22701 it
->override_ascent
= -1;
22702 it
->pixel_width
= 0;
22705 height
= get_it_property (it
, Qline_height
);
22706 /* Split (line-height total-height) list */
22708 && CONSP (XCDR (height
))
22709 && NILP (XCDR (XCDR (height
))))
22711 total_height
= XCAR (XCDR (height
));
22712 height
= XCAR (height
);
22714 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22716 if (it
->override_ascent
>= 0)
22718 it
->ascent
= it
->override_ascent
;
22719 it
->descent
= it
->override_descent
;
22720 boff
= it
->override_boff
;
22724 it
->ascent
= FONT_BASE (font
) + boff
;
22725 it
->descent
= FONT_DESCENT (font
) - boff
;
22728 if (EQ (height
, Qt
))
22730 if (it
->descent
> it
->max_descent
)
22732 it
->ascent
+= it
->descent
- it
->max_descent
;
22733 it
->descent
= it
->max_descent
;
22735 if (it
->ascent
> it
->max_ascent
)
22737 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22738 it
->ascent
= it
->max_ascent
;
22740 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22741 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22742 it
->constrain_row_ascent_descent_p
= 1;
22743 extra_line_spacing
= 0;
22747 Lisp_Object spacing
;
22749 it
->phys_ascent
= it
->ascent
;
22750 it
->phys_descent
= it
->descent
;
22752 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22753 && face
->box
!= FACE_NO_BOX
22754 && face
->box_line_width
> 0)
22756 it
->ascent
+= face
->box_line_width
;
22757 it
->descent
+= face
->box_line_width
;
22760 && XINT (height
) > it
->ascent
+ it
->descent
)
22761 it
->ascent
= XINT (height
) - it
->descent
;
22763 if (!NILP (total_height
))
22764 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22767 spacing
= get_it_property (it
, Qline_spacing
);
22768 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22770 if (INTEGERP (spacing
))
22772 extra_line_spacing
= XINT (spacing
);
22773 if (!NILP (total_height
))
22774 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22778 else /* i.e. (it->char_to_display == '\t') */
22780 if (font
->space_width
> 0)
22782 int tab_width
= it
->tab_width
* font
->space_width
;
22783 int x
= it
->current_x
+ it
->continuation_lines_width
;
22784 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22786 /* If the distance from the current position to the next tab
22787 stop is less than a space character width, use the
22788 tab stop after that. */
22789 if (next_tab_x
- x
< font
->space_width
)
22790 next_tab_x
+= tab_width
;
22792 it
->pixel_width
= next_tab_x
- x
;
22794 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22795 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22799 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22800 it
->ascent
+ it
->descent
, it
->ascent
);
22805 it
->pixel_width
= 0;
22810 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22812 /* A static composition.
22814 Note: A composition is represented as one glyph in the
22815 glyph matrix. There are no padding glyphs.
22817 Important note: pixel_width, ascent, and descent are the
22818 values of what is drawn by draw_glyphs (i.e. the values of
22819 the overall glyphs composed). */
22820 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22821 int boff
; /* baseline offset */
22822 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22823 int glyph_len
= cmp
->glyph_len
;
22824 struct font
*font
= face
->font
;
22828 /* If we have not yet calculated pixel size data of glyphs of
22829 the composition for the current face font, calculate them
22830 now. Theoretically, we have to check all fonts for the
22831 glyphs, but that requires much time and memory space. So,
22832 here we check only the font of the first glyph. This may
22833 lead to incorrect display, but it's very rare, and C-l
22834 (recenter-top-bottom) can correct the display anyway. */
22835 if (! cmp
->font
|| cmp
->font
!= font
)
22837 /* Ascent and descent of the font of the first character
22838 of this composition (adjusted by baseline offset).
22839 Ascent and descent of overall glyphs should not be less
22840 than these, respectively. */
22841 int font_ascent
, font_descent
, font_height
;
22842 /* Bounding box of the overall glyphs. */
22843 int leftmost
, rightmost
, lowest
, highest
;
22844 int lbearing
, rbearing
;
22845 int i
, width
, ascent
, descent
;
22846 int left_padded
= 0, right_padded
= 0;
22847 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
22849 struct font_metrics
*pcm
;
22850 int font_not_found_p
;
22853 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22854 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22856 if (glyph_len
< cmp
->glyph_len
)
22858 for (i
= 0; i
< glyph_len
; i
++)
22860 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22862 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22867 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22868 : IT_CHARPOS (*it
));
22869 /* If no suitable font is found, use the default font. */
22870 font_not_found_p
= font
== NULL
;
22871 if (font_not_found_p
)
22873 face
= face
->ascii_face
;
22876 boff
= font
->baseline_offset
;
22877 if (font
->vertical_centering
)
22878 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22879 font_ascent
= FONT_BASE (font
) + boff
;
22880 font_descent
= FONT_DESCENT (font
) - boff
;
22881 font_height
= FONT_HEIGHT (font
);
22883 cmp
->font
= (void *) font
;
22886 if (! font_not_found_p
)
22888 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22890 pcm
= get_per_char_metric (font
, &char2b
);
22893 /* Initialize the bounding box. */
22896 width
= pcm
->width
;
22897 ascent
= pcm
->ascent
;
22898 descent
= pcm
->descent
;
22899 lbearing
= pcm
->lbearing
;
22900 rbearing
= pcm
->rbearing
;
22904 width
= font
->space_width
;
22905 ascent
= FONT_BASE (font
);
22906 descent
= FONT_DESCENT (font
);
22913 lowest
= - descent
+ boff
;
22914 highest
= ascent
+ boff
;
22916 if (! font_not_found_p
22917 && font
->default_ascent
22918 && CHAR_TABLE_P (Vuse_default_ascent
)
22919 && !NILP (Faref (Vuse_default_ascent
,
22920 make_number (it
->char_to_display
))))
22921 highest
= font
->default_ascent
+ boff
;
22923 /* Draw the first glyph at the normal position. It may be
22924 shifted to right later if some other glyphs are drawn
22926 cmp
->offsets
[i
* 2] = 0;
22927 cmp
->offsets
[i
* 2 + 1] = boff
;
22928 cmp
->lbearing
= lbearing
;
22929 cmp
->rbearing
= rbearing
;
22931 /* Set cmp->offsets for the remaining glyphs. */
22932 for (i
++; i
< glyph_len
; i
++)
22934 int left
, right
, btm
, top
;
22935 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22937 struct face
*this_face
;
22941 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22942 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22943 font
= this_face
->font
;
22949 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22951 pcm
= get_per_char_metric (font
, &char2b
);
22954 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22957 width
= pcm
->width
;
22958 ascent
= pcm
->ascent
;
22959 descent
= pcm
->descent
;
22960 lbearing
= pcm
->lbearing
;
22961 rbearing
= pcm
->rbearing
;
22962 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22964 /* Relative composition with or without
22965 alternate chars. */
22966 left
= (leftmost
+ rightmost
- width
) / 2;
22967 btm
= - descent
+ boff
;
22968 if (font
->relative_compose
22969 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22970 || NILP (Faref (Vignore_relative_composition
,
22971 make_number (ch
)))))
22974 if (- descent
>= font
->relative_compose
)
22975 /* One extra pixel between two glyphs. */
22977 else if (ascent
<= 0)
22978 /* One extra pixel between two glyphs. */
22979 btm
= lowest
- 1 - ascent
- descent
;
22984 /* A composition rule is specified by an integer
22985 value that encodes global and new reference
22986 points (GREF and NREF). GREF and NREF are
22987 specified by numbers as below:
22989 0---1---2 -- ascent
22993 9--10--11 -- center
22995 ---3---4---5--- baseline
22997 6---7---8 -- descent
22999 int rule
= COMPOSITION_RULE (cmp
, i
);
23000 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23002 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23003 grefx
= gref
% 3, nrefx
= nref
% 3;
23004 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23006 xoff
= font_height
* (xoff
- 128) / 256;
23008 yoff
= font_height
* (yoff
- 128) / 256;
23011 + grefx
* (rightmost
- leftmost
) / 2
23012 - nrefx
* width
/ 2
23015 btm
= ((grefy
== 0 ? highest
23017 : grefy
== 2 ? lowest
23018 : (highest
+ lowest
) / 2)
23019 - (nrefy
== 0 ? ascent
+ descent
23020 : nrefy
== 1 ? descent
- boff
23022 : (ascent
+ descent
) / 2)
23026 cmp
->offsets
[i
* 2] = left
;
23027 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23029 /* Update the bounding box of the overall glyphs. */
23032 right
= left
+ width
;
23033 if (left
< leftmost
)
23035 if (right
> rightmost
)
23038 top
= btm
+ descent
+ ascent
;
23044 if (cmp
->lbearing
> left
+ lbearing
)
23045 cmp
->lbearing
= left
+ lbearing
;
23046 if (cmp
->rbearing
< left
+ rbearing
)
23047 cmp
->rbearing
= left
+ rbearing
;
23051 /* If there are glyphs whose x-offsets are negative,
23052 shift all glyphs to the right and make all x-offsets
23056 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23057 cmp
->offsets
[i
* 2] -= leftmost
;
23058 rightmost
-= leftmost
;
23059 cmp
->lbearing
-= leftmost
;
23060 cmp
->rbearing
-= leftmost
;
23063 if (left_padded
&& cmp
->lbearing
< 0)
23065 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23066 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23067 rightmost
-= cmp
->lbearing
;
23068 cmp
->rbearing
-= cmp
->lbearing
;
23071 if (right_padded
&& rightmost
< cmp
->rbearing
)
23073 rightmost
= cmp
->rbearing
;
23076 cmp
->pixel_width
= rightmost
;
23077 cmp
->ascent
= highest
;
23078 cmp
->descent
= - lowest
;
23079 if (cmp
->ascent
< font_ascent
)
23080 cmp
->ascent
= font_ascent
;
23081 if (cmp
->descent
< font_descent
)
23082 cmp
->descent
= font_descent
;
23086 && (cmp
->lbearing
< 0
23087 || cmp
->rbearing
> cmp
->pixel_width
))
23088 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23090 it
->pixel_width
= cmp
->pixel_width
;
23091 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23092 it
->descent
= it
->phys_descent
= cmp
->descent
;
23093 if (face
->box
!= FACE_NO_BOX
)
23095 int thick
= face
->box_line_width
;
23099 it
->ascent
+= thick
;
23100 it
->descent
+= thick
;
23105 if (it
->start_of_box_run_p
)
23106 it
->pixel_width
+= thick
;
23107 if (it
->end_of_box_run_p
)
23108 it
->pixel_width
+= thick
;
23111 /* If face has an overline, add the height of the overline
23112 (1 pixel) and a 1 pixel margin to the character height. */
23113 if (face
->overline_p
)
23114 it
->ascent
+= overline_margin
;
23116 take_vertical_position_into_account (it
);
23117 if (it
->ascent
< 0)
23119 if (it
->descent
< 0)
23123 append_composite_glyph (it
);
23125 else if (it
->what
== IT_COMPOSITION
)
23127 /* A dynamic (automatic) composition. */
23128 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23129 Lisp_Object gstring
;
23130 struct font_metrics metrics
;
23132 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23134 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23137 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23138 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23139 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23140 it
->descent
= it
->phys_descent
= metrics
.descent
;
23141 if (face
->box
!= FACE_NO_BOX
)
23143 int thick
= face
->box_line_width
;
23147 it
->ascent
+= thick
;
23148 it
->descent
+= thick
;
23153 if (it
->start_of_box_run_p
)
23154 it
->pixel_width
+= thick
;
23155 if (it
->end_of_box_run_p
)
23156 it
->pixel_width
+= thick
;
23158 /* If face has an overline, add the height of the overline
23159 (1 pixel) and a 1 pixel margin to the character height. */
23160 if (face
->overline_p
)
23161 it
->ascent
+= overline_margin
;
23162 take_vertical_position_into_account (it
);
23163 if (it
->ascent
< 0)
23165 if (it
->descent
< 0)
23169 append_composite_glyph (it
);
23171 else if (it
->what
== IT_GLYPHLESS
)
23172 produce_glyphless_glyph (it
, 0, Qnil
);
23173 else if (it
->what
== IT_IMAGE
)
23174 produce_image_glyph (it
);
23175 else if (it
->what
== IT_STRETCH
)
23176 produce_stretch_glyph (it
);
23179 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23180 because this isn't true for images with `:ascent 100'. */
23181 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23182 if (it
->area
== TEXT_AREA
)
23183 it
->current_x
+= it
->pixel_width
;
23185 if (extra_line_spacing
> 0)
23187 it
->descent
+= extra_line_spacing
;
23188 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23189 it
->max_extra_line_spacing
= extra_line_spacing
;
23192 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23193 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23194 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23195 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23199 Output LEN glyphs starting at START at the nominal cursor position.
23200 Advance the nominal cursor over the text. The global variable
23201 updated_window contains the window being updated, updated_row is
23202 the glyph row being updated, and updated_area is the area of that
23203 row being updated. */
23206 x_write_glyphs (struct glyph
*start
, int len
)
23210 xassert (updated_window
&& updated_row
);
23213 /* Write glyphs. */
23215 hpos
= start
- updated_row
->glyphs
[updated_area
];
23216 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23217 updated_row
, updated_area
,
23219 DRAW_NORMAL_TEXT
, 0);
23221 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23222 if (updated_area
== TEXT_AREA
23223 && updated_window
->phys_cursor_on_p
23224 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23225 && updated_window
->phys_cursor
.hpos
>= hpos
23226 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23227 updated_window
->phys_cursor_on_p
= 0;
23231 /* Advance the output cursor. */
23232 output_cursor
.hpos
+= len
;
23233 output_cursor
.x
= x
;
23238 Insert LEN glyphs from START at the nominal cursor position. */
23241 x_insert_glyphs (struct glyph
*start
, int len
)
23245 int line_height
, shift_by_width
, shifted_region_width
;
23246 struct glyph_row
*row
;
23247 struct glyph
*glyph
;
23248 int frame_x
, frame_y
;
23251 xassert (updated_window
&& updated_row
);
23253 w
= updated_window
;
23254 f
= XFRAME (WINDOW_FRAME (w
));
23256 /* Get the height of the line we are in. */
23258 line_height
= row
->height
;
23260 /* Get the width of the glyphs to insert. */
23261 shift_by_width
= 0;
23262 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23263 shift_by_width
+= glyph
->pixel_width
;
23265 /* Get the width of the region to shift right. */
23266 shifted_region_width
= (window_box_width (w
, updated_area
)
23271 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23272 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23274 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23275 line_height
, shift_by_width
);
23277 /* Write the glyphs. */
23278 hpos
= start
- row
->glyphs
[updated_area
];
23279 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23281 DRAW_NORMAL_TEXT
, 0);
23283 /* Advance the output cursor. */
23284 output_cursor
.hpos
+= len
;
23285 output_cursor
.x
+= shift_by_width
;
23291 Erase the current text line from the nominal cursor position
23292 (inclusive) to pixel column TO_X (exclusive). The idea is that
23293 everything from TO_X onward is already erased.
23295 TO_X is a pixel position relative to updated_area of
23296 updated_window. TO_X == -1 means clear to the end of this area. */
23299 x_clear_end_of_line (int to_x
)
23302 struct window
*w
= updated_window
;
23303 int max_x
, min_y
, max_y
;
23304 int from_x
, from_y
, to_y
;
23306 xassert (updated_window
&& updated_row
);
23307 f
= XFRAME (w
->frame
);
23309 if (updated_row
->full_width_p
)
23310 max_x
= WINDOW_TOTAL_WIDTH (w
);
23312 max_x
= window_box_width (w
, updated_area
);
23313 max_y
= window_text_bottom_y (w
);
23315 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23316 of window. For TO_X > 0, truncate to end of drawing area. */
23322 to_x
= min (to_x
, max_x
);
23324 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23326 /* Notice if the cursor will be cleared by this operation. */
23327 if (!updated_row
->full_width_p
)
23328 notice_overwritten_cursor (w
, updated_area
,
23329 output_cursor
.x
, -1,
23331 MATRIX_ROW_BOTTOM_Y (updated_row
));
23333 from_x
= output_cursor
.x
;
23335 /* Translate to frame coordinates. */
23336 if (updated_row
->full_width_p
)
23338 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23339 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23343 int area_left
= window_box_left (w
, updated_area
);
23344 from_x
+= area_left
;
23348 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23349 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23350 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23352 /* Prevent inadvertently clearing to end of the X window. */
23353 if (to_x
> from_x
&& to_y
> from_y
)
23356 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23357 to_x
- from_x
, to_y
- from_y
);
23362 #endif /* HAVE_WINDOW_SYSTEM */
23366 /***********************************************************************
23368 ***********************************************************************/
23370 /* Value is the internal representation of the specified cursor type
23371 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23372 of the bar cursor. */
23374 static enum text_cursor_kinds
23375 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23377 enum text_cursor_kinds type
;
23382 if (EQ (arg
, Qbox
))
23383 return FILLED_BOX_CURSOR
;
23385 if (EQ (arg
, Qhollow
))
23386 return HOLLOW_BOX_CURSOR
;
23388 if (EQ (arg
, Qbar
))
23395 && EQ (XCAR (arg
), Qbar
)
23396 && INTEGERP (XCDR (arg
))
23397 && XINT (XCDR (arg
)) >= 0)
23399 *width
= XINT (XCDR (arg
));
23403 if (EQ (arg
, Qhbar
))
23406 return HBAR_CURSOR
;
23410 && EQ (XCAR (arg
), Qhbar
)
23411 && INTEGERP (XCDR (arg
))
23412 && XINT (XCDR (arg
)) >= 0)
23414 *width
= XINT (XCDR (arg
));
23415 return HBAR_CURSOR
;
23418 /* Treat anything unknown as "hollow box cursor".
23419 It was bad to signal an error; people have trouble fixing
23420 .Xdefaults with Emacs, when it has something bad in it. */
23421 type
= HOLLOW_BOX_CURSOR
;
23426 /* Set the default cursor types for specified frame. */
23428 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23433 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23434 FRAME_CURSOR_WIDTH (f
) = width
;
23436 /* By default, set up the blink-off state depending on the on-state. */
23438 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23441 FRAME_BLINK_OFF_CURSOR (f
)
23442 = get_specified_cursor_type (XCDR (tem
), &width
);
23443 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23446 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23450 #ifdef HAVE_WINDOW_SYSTEM
23452 /* Return the cursor we want to be displayed in window W. Return
23453 width of bar/hbar cursor through WIDTH arg. Return with
23454 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23455 (i.e. if the `system caret' should track this cursor).
23457 In a mini-buffer window, we want the cursor only to appear if we
23458 are reading input from this window. For the selected window, we
23459 want the cursor type given by the frame parameter or buffer local
23460 setting of cursor-type. If explicitly marked off, draw no cursor.
23461 In all other cases, we want a hollow box cursor. */
23463 static enum text_cursor_kinds
23464 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23465 int *active_cursor
)
23467 struct frame
*f
= XFRAME (w
->frame
);
23468 struct buffer
*b
= XBUFFER (w
->buffer
);
23469 int cursor_type
= DEFAULT_CURSOR
;
23470 Lisp_Object alt_cursor
;
23471 int non_selected
= 0;
23473 *active_cursor
= 1;
23476 if (cursor_in_echo_area
23477 && FRAME_HAS_MINIBUF_P (f
)
23478 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23480 if (w
== XWINDOW (echo_area_window
))
23482 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23484 *width
= FRAME_CURSOR_WIDTH (f
);
23485 return FRAME_DESIRED_CURSOR (f
);
23488 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23491 *active_cursor
= 0;
23495 /* Detect a nonselected window or nonselected frame. */
23496 else if (w
!= XWINDOW (f
->selected_window
)
23497 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23499 *active_cursor
= 0;
23501 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23507 /* Never display a cursor in a window in which cursor-type is nil. */
23508 if (NILP (BVAR (b
, cursor_type
)))
23511 /* Get the normal cursor type for this window. */
23512 if (EQ (BVAR (b
, cursor_type
), Qt
))
23514 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23515 *width
= FRAME_CURSOR_WIDTH (f
);
23518 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23520 /* Use cursor-in-non-selected-windows instead
23521 for non-selected window or frame. */
23524 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23525 if (!EQ (Qt
, alt_cursor
))
23526 return get_specified_cursor_type (alt_cursor
, width
);
23527 /* t means modify the normal cursor type. */
23528 if (cursor_type
== FILLED_BOX_CURSOR
)
23529 cursor_type
= HOLLOW_BOX_CURSOR
;
23530 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23532 return cursor_type
;
23535 /* Use normal cursor if not blinked off. */
23536 if (!w
->cursor_off_p
)
23538 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23540 if (cursor_type
== FILLED_BOX_CURSOR
)
23542 /* Using a block cursor on large images can be very annoying.
23543 So use a hollow cursor for "large" images.
23544 If image is not transparent (no mask), also use hollow cursor. */
23545 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23546 if (img
!= NULL
&& IMAGEP (img
->spec
))
23548 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23549 where N = size of default frame font size.
23550 This should cover most of the "tiny" icons people may use. */
23552 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23553 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23554 cursor_type
= HOLLOW_BOX_CURSOR
;
23557 else if (cursor_type
!= NO_CURSOR
)
23559 /* Display current only supports BOX and HOLLOW cursors for images.
23560 So for now, unconditionally use a HOLLOW cursor when cursor is
23561 not a solid box cursor. */
23562 cursor_type
= HOLLOW_BOX_CURSOR
;
23565 return cursor_type
;
23568 /* Cursor is blinked off, so determine how to "toggle" it. */
23570 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23571 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23572 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23574 /* Then see if frame has specified a specific blink off cursor type. */
23575 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23577 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23578 return FRAME_BLINK_OFF_CURSOR (f
);
23582 /* Some people liked having a permanently visible blinking cursor,
23583 while others had very strong opinions against it. So it was
23584 decided to remove it. KFS 2003-09-03 */
23586 /* Finally perform built-in cursor blinking:
23587 filled box <-> hollow box
23588 wide [h]bar <-> narrow [h]bar
23589 narrow [h]bar <-> no cursor
23590 other type <-> no cursor */
23592 if (cursor_type
== FILLED_BOX_CURSOR
)
23593 return HOLLOW_BOX_CURSOR
;
23595 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23598 return cursor_type
;
23606 /* Notice when the text cursor of window W has been completely
23607 overwritten by a drawing operation that outputs glyphs in AREA
23608 starting at X0 and ending at X1 in the line starting at Y0 and
23609 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23610 the rest of the line after X0 has been written. Y coordinates
23611 are window-relative. */
23614 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23615 int x0
, int x1
, int y0
, int y1
)
23617 int cx0
, cx1
, cy0
, cy1
;
23618 struct glyph_row
*row
;
23620 if (!w
->phys_cursor_on_p
)
23622 if (area
!= TEXT_AREA
)
23625 if (w
->phys_cursor
.vpos
< 0
23626 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23627 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23628 !(row
->enabled_p
&& row
->displays_text_p
)))
23631 if (row
->cursor_in_fringe_p
)
23633 row
->cursor_in_fringe_p
= 0;
23634 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23635 w
->phys_cursor_on_p
= 0;
23639 cx0
= w
->phys_cursor
.x
;
23640 cx1
= cx0
+ w
->phys_cursor_width
;
23641 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23644 /* The cursor image will be completely removed from the
23645 screen if the output area intersects the cursor area in
23646 y-direction. When we draw in [y0 y1[, and some part of
23647 the cursor is at y < y0, that part must have been drawn
23648 before. When scrolling, the cursor is erased before
23649 actually scrolling, so we don't come here. When not
23650 scrolling, the rows above the old cursor row must have
23651 changed, and in this case these rows must have written
23652 over the cursor image.
23654 Likewise if part of the cursor is below y1, with the
23655 exception of the cursor being in the first blank row at
23656 the buffer and window end because update_text_area
23657 doesn't draw that row. (Except when it does, but
23658 that's handled in update_text_area.) */
23660 cy0
= w
->phys_cursor
.y
;
23661 cy1
= cy0
+ w
->phys_cursor_height
;
23662 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23665 w
->phys_cursor_on_p
= 0;
23668 #endif /* HAVE_WINDOW_SYSTEM */
23671 /************************************************************************
23673 ************************************************************************/
23675 #ifdef HAVE_WINDOW_SYSTEM
23678 Fix the display of area AREA of overlapping row ROW in window W
23679 with respect to the overlapping part OVERLAPS. */
23682 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23683 enum glyph_row_area area
, int overlaps
)
23690 for (i
= 0; i
< row
->used
[area
];)
23692 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23694 int start
= i
, start_x
= x
;
23698 x
+= row
->glyphs
[area
][i
].pixel_width
;
23701 while (i
< row
->used
[area
]
23702 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23704 draw_glyphs (w
, start_x
, row
, area
,
23706 DRAW_NORMAL_TEXT
, overlaps
);
23710 x
+= row
->glyphs
[area
][i
].pixel_width
;
23720 Draw the cursor glyph of window W in glyph row ROW. See the
23721 comment of draw_glyphs for the meaning of HL. */
23724 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23725 enum draw_glyphs_face hl
)
23727 /* If cursor hpos is out of bounds, don't draw garbage. This can
23728 happen in mini-buffer windows when switching between echo area
23729 glyphs and mini-buffer. */
23730 if ((row
->reversed_p
23731 ? (w
->phys_cursor
.hpos
>= 0)
23732 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23734 int on_p
= w
->phys_cursor_on_p
;
23736 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23737 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23739 w
->phys_cursor_on_p
= on_p
;
23741 if (hl
== DRAW_CURSOR
)
23742 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23743 /* When we erase the cursor, and ROW is overlapped by other
23744 rows, make sure that these overlapping parts of other rows
23746 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23748 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23750 if (row
> w
->current_matrix
->rows
23751 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23752 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23753 OVERLAPS_ERASED_CURSOR
);
23755 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23756 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23757 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23758 OVERLAPS_ERASED_CURSOR
);
23765 Erase the image of a cursor of window W from the screen. */
23768 erase_phys_cursor (struct window
*w
)
23770 struct frame
*f
= XFRAME (w
->frame
);
23771 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23772 int hpos
= w
->phys_cursor
.hpos
;
23773 int vpos
= w
->phys_cursor
.vpos
;
23774 int mouse_face_here_p
= 0;
23775 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23776 struct glyph_row
*cursor_row
;
23777 struct glyph
*cursor_glyph
;
23778 enum draw_glyphs_face hl
;
23780 /* No cursor displayed or row invalidated => nothing to do on the
23782 if (w
->phys_cursor_type
== NO_CURSOR
)
23783 goto mark_cursor_off
;
23785 /* VPOS >= active_glyphs->nrows means that window has been resized.
23786 Don't bother to erase the cursor. */
23787 if (vpos
>= active_glyphs
->nrows
)
23788 goto mark_cursor_off
;
23790 /* If row containing cursor is marked invalid, there is nothing we
23792 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23793 if (!cursor_row
->enabled_p
)
23794 goto mark_cursor_off
;
23796 /* If line spacing is > 0, old cursor may only be partially visible in
23797 window after split-window. So adjust visible height. */
23798 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23799 window_text_bottom_y (w
) - cursor_row
->y
);
23801 /* If row is completely invisible, don't attempt to delete a cursor which
23802 isn't there. This can happen if cursor is at top of a window, and
23803 we switch to a buffer with a header line in that window. */
23804 if (cursor_row
->visible_height
<= 0)
23805 goto mark_cursor_off
;
23807 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23808 if (cursor_row
->cursor_in_fringe_p
)
23810 cursor_row
->cursor_in_fringe_p
= 0;
23811 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23812 goto mark_cursor_off
;
23815 /* This can happen when the new row is shorter than the old one.
23816 In this case, either draw_glyphs or clear_end_of_line
23817 should have cleared the cursor. Note that we wouldn't be
23818 able to erase the cursor in this case because we don't have a
23819 cursor glyph at hand. */
23820 if ((cursor_row
->reversed_p
23821 ? (w
->phys_cursor
.hpos
< 0)
23822 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23823 goto mark_cursor_off
;
23825 /* If the cursor is in the mouse face area, redisplay that when
23826 we clear the cursor. */
23827 if (! NILP (hlinfo
->mouse_face_window
)
23828 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23829 /* Don't redraw the cursor's spot in mouse face if it is at the
23830 end of a line (on a newline). The cursor appears there, but
23831 mouse highlighting does not. */
23832 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23833 mouse_face_here_p
= 1;
23835 /* Maybe clear the display under the cursor. */
23836 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23839 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23842 cursor_glyph
= get_phys_cursor_glyph (w
);
23843 if (cursor_glyph
== NULL
)
23844 goto mark_cursor_off
;
23846 width
= cursor_glyph
->pixel_width
;
23847 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23848 x
= w
->phys_cursor
.x
;
23850 width
-= left_x
- x
;
23851 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23852 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23853 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23856 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23859 /* Erase the cursor by redrawing the character underneath it. */
23860 if (mouse_face_here_p
)
23861 hl
= DRAW_MOUSE_FACE
;
23863 hl
= DRAW_NORMAL_TEXT
;
23864 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23867 w
->phys_cursor_on_p
= 0;
23868 w
->phys_cursor_type
= NO_CURSOR
;
23873 Display or clear cursor of window W. If ON is zero, clear the
23874 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23875 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23878 display_and_set_cursor (struct window
*w
, int on
,
23879 int hpos
, int vpos
, int x
, int y
)
23881 struct frame
*f
= XFRAME (w
->frame
);
23882 int new_cursor_type
;
23883 int new_cursor_width
;
23885 struct glyph_row
*glyph_row
;
23886 struct glyph
*glyph
;
23888 /* This is pointless on invisible frames, and dangerous on garbaged
23889 windows and frames; in the latter case, the frame or window may
23890 be in the midst of changing its size, and x and y may be off the
23892 if (! FRAME_VISIBLE_P (f
)
23893 || FRAME_GARBAGED_P (f
)
23894 || vpos
>= w
->current_matrix
->nrows
23895 || hpos
>= w
->current_matrix
->matrix_w
)
23898 /* If cursor is off and we want it off, return quickly. */
23899 if (!on
&& !w
->phys_cursor_on_p
)
23902 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23903 /* If cursor row is not enabled, we don't really know where to
23904 display the cursor. */
23905 if (!glyph_row
->enabled_p
)
23907 w
->phys_cursor_on_p
= 0;
23912 if (!glyph_row
->exact_window_width_line_p
23913 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23914 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23916 xassert (interrupt_input_blocked
);
23918 /* Set new_cursor_type to the cursor we want to be displayed. */
23919 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23920 &new_cursor_width
, &active_cursor
);
23922 /* If cursor is currently being shown and we don't want it to be or
23923 it is in the wrong place, or the cursor type is not what we want,
23925 if (w
->phys_cursor_on_p
23927 || w
->phys_cursor
.x
!= x
23928 || w
->phys_cursor
.y
!= y
23929 || new_cursor_type
!= w
->phys_cursor_type
23930 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23931 && new_cursor_width
!= w
->phys_cursor_width
)))
23932 erase_phys_cursor (w
);
23934 /* Don't check phys_cursor_on_p here because that flag is only set
23935 to zero in some cases where we know that the cursor has been
23936 completely erased, to avoid the extra work of erasing the cursor
23937 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23938 still not be visible, or it has only been partly erased. */
23941 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23942 w
->phys_cursor_height
= glyph_row
->height
;
23944 /* Set phys_cursor_.* before x_draw_.* is called because some
23945 of them may need the information. */
23946 w
->phys_cursor
.x
= x
;
23947 w
->phys_cursor
.y
= glyph_row
->y
;
23948 w
->phys_cursor
.hpos
= hpos
;
23949 w
->phys_cursor
.vpos
= vpos
;
23952 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23953 new_cursor_type
, new_cursor_width
,
23954 on
, active_cursor
);
23958 /* Switch the display of W's cursor on or off, according to the value
23962 update_window_cursor (struct window
*w
, int on
)
23964 /* Don't update cursor in windows whose frame is in the process
23965 of being deleted. */
23966 if (w
->current_matrix
)
23969 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23970 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23976 /* Call update_window_cursor with parameter ON_P on all leaf windows
23977 in the window tree rooted at W. */
23980 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23984 if (!NILP (w
->hchild
))
23985 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23986 else if (!NILP (w
->vchild
))
23987 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23989 update_window_cursor (w
, on_p
);
23991 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23997 Display the cursor on window W, or clear it, according to ON_P.
23998 Don't change the cursor's position. */
24001 x_update_cursor (struct frame
*f
, int on_p
)
24003 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24008 Clear the cursor of window W to background color, and mark the
24009 cursor as not shown. This is used when the text where the cursor
24010 is about to be rewritten. */
24013 x_clear_cursor (struct window
*w
)
24015 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24016 update_window_cursor (w
, 0);
24019 #endif /* HAVE_WINDOW_SYSTEM */
24021 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24024 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24025 int start_hpos
, int end_hpos
,
24026 enum draw_glyphs_face draw
)
24028 #ifdef HAVE_WINDOW_SYSTEM
24029 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24031 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24035 #if defined (HAVE_GPM) || defined (MSDOS)
24036 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24040 /* Display the active region described by mouse_face_* according to DRAW. */
24043 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24045 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24046 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24048 if (/* If window is in the process of being destroyed, don't bother
24050 w
->current_matrix
!= NULL
24051 /* Don't update mouse highlight if hidden */
24052 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24053 /* Recognize when we are called to operate on rows that don't exist
24054 anymore. This can happen when a window is split. */
24055 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24057 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24058 struct glyph_row
*row
, *first
, *last
;
24060 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24061 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24063 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24065 int start_hpos
, end_hpos
, start_x
;
24067 /* For all but the first row, the highlight starts at column 0. */
24070 /* R2L rows have BEG and END in reversed order, but the
24071 screen drawing geometry is always left to right. So
24072 we need to mirror the beginning and end of the
24073 highlighted area in R2L rows. */
24074 if (!row
->reversed_p
)
24076 start_hpos
= hlinfo
->mouse_face_beg_col
;
24077 start_x
= hlinfo
->mouse_face_beg_x
;
24079 else if (row
== last
)
24081 start_hpos
= hlinfo
->mouse_face_end_col
;
24082 start_x
= hlinfo
->mouse_face_end_x
;
24090 else if (row
->reversed_p
&& row
== last
)
24092 start_hpos
= hlinfo
->mouse_face_end_col
;
24093 start_x
= hlinfo
->mouse_face_end_x
;
24103 if (!row
->reversed_p
)
24104 end_hpos
= hlinfo
->mouse_face_end_col
;
24105 else if (row
== first
)
24106 end_hpos
= hlinfo
->mouse_face_beg_col
;
24109 end_hpos
= row
->used
[TEXT_AREA
];
24110 if (draw
== DRAW_NORMAL_TEXT
)
24111 row
->fill_line_p
= 1; /* Clear to end of line */
24114 else if (row
->reversed_p
&& row
== first
)
24115 end_hpos
= hlinfo
->mouse_face_beg_col
;
24118 end_hpos
= row
->used
[TEXT_AREA
];
24119 if (draw
== DRAW_NORMAL_TEXT
)
24120 row
->fill_line_p
= 1; /* Clear to end of line */
24123 if (end_hpos
> start_hpos
)
24125 draw_row_with_mouse_face (w
, start_x
, row
,
24126 start_hpos
, end_hpos
, draw
);
24129 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24133 #ifdef HAVE_WINDOW_SYSTEM
24134 /* When we've written over the cursor, arrange for it to
24135 be displayed again. */
24136 if (FRAME_WINDOW_P (f
)
24137 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24140 display_and_set_cursor (w
, 1,
24141 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24142 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24145 #endif /* HAVE_WINDOW_SYSTEM */
24148 #ifdef HAVE_WINDOW_SYSTEM
24149 /* Change the mouse cursor. */
24150 if (FRAME_WINDOW_P (f
))
24152 if (draw
== DRAW_NORMAL_TEXT
24153 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24154 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24155 else if (draw
== DRAW_MOUSE_FACE
)
24156 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24158 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24160 #endif /* HAVE_WINDOW_SYSTEM */
24164 Clear out the mouse-highlighted active region.
24165 Redraw it un-highlighted first. Value is non-zero if mouse
24166 face was actually drawn unhighlighted. */
24169 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24173 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24175 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24179 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24180 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24181 hlinfo
->mouse_face_window
= Qnil
;
24182 hlinfo
->mouse_face_overlay
= Qnil
;
24186 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24187 within the mouse face on that window. */
24189 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24191 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24193 /* Quickly resolve the easy cases. */
24194 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24195 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24197 if (vpos
< hlinfo
->mouse_face_beg_row
24198 || vpos
> hlinfo
->mouse_face_end_row
)
24200 if (vpos
> hlinfo
->mouse_face_beg_row
24201 && vpos
< hlinfo
->mouse_face_end_row
)
24204 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24206 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24208 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24211 else if ((vpos
== hlinfo
->mouse_face_beg_row
24212 && hpos
>= hlinfo
->mouse_face_beg_col
)
24213 || (vpos
== hlinfo
->mouse_face_end_row
24214 && hpos
< hlinfo
->mouse_face_end_col
))
24219 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24221 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24224 else if ((vpos
== hlinfo
->mouse_face_beg_row
24225 && hpos
<= hlinfo
->mouse_face_beg_col
)
24226 || (vpos
== hlinfo
->mouse_face_end_row
24227 && hpos
> hlinfo
->mouse_face_end_col
))
24235 Non-zero if physical cursor of window W is within mouse face. */
24238 cursor_in_mouse_face_p (struct window
*w
)
24240 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24245 /* Find the glyph rows START_ROW and END_ROW of window W that display
24246 characters between buffer positions START_CHARPOS and END_CHARPOS
24247 (excluding END_CHARPOS). This is similar to row_containing_pos,
24248 but is more accurate when bidi reordering makes buffer positions
24249 change non-linearly with glyph rows. */
24251 rows_from_pos_range (struct window
*w
,
24252 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24253 struct glyph_row
**start
, struct glyph_row
**end
)
24255 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24256 int last_y
= window_text_bottom_y (w
);
24257 struct glyph_row
*row
;
24262 while (!first
->enabled_p
24263 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24266 /* Find the START row. */
24268 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24271 /* A row can potentially be the START row if the range of the
24272 characters it displays intersects the range
24273 [START_CHARPOS..END_CHARPOS). */
24274 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24275 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24276 /* See the commentary in row_containing_pos, for the
24277 explanation of the complicated way to check whether
24278 some position is beyond the end of the characters
24279 displayed by a row. */
24280 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24281 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24282 && !row
->ends_at_zv_p
24283 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24284 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24285 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24286 && !row
->ends_at_zv_p
24287 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24289 /* Found a candidate row. Now make sure at least one of the
24290 glyphs it displays has a charpos from the range
24291 [START_CHARPOS..END_CHARPOS).
24293 This is not obvious because bidi reordering could make
24294 buffer positions of a row be 1,2,3,102,101,100, and if we
24295 want to highlight characters in [50..60), we don't want
24296 this row, even though [50..60) does intersect [1..103),
24297 the range of character positions given by the row's start
24298 and end positions. */
24299 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24300 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24304 if (BUFFERP (g
->object
)
24305 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24314 /* Find the END row. */
24316 /* If the last row is partially visible, start looking for END
24317 from that row, instead of starting from FIRST. */
24318 && !(row
->enabled_p
24319 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24321 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24323 struct glyph_row
*next
= row
+ 1;
24325 if (!next
->enabled_p
24326 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24327 /* The first row >= START whose range of displayed characters
24328 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24329 is the row END + 1. */
24330 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24331 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24332 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24333 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24334 && !next
->ends_at_zv_p
24335 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24336 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24337 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24338 && !next
->ends_at_zv_p
24339 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24346 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24347 but none of the characters it displays are in the range, it is
24349 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24350 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24354 if (BUFFERP (g
->object
)
24355 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24368 /* This function sets the mouse_face_* elements of HLINFO, assuming
24369 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24370 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24371 for the overlay or run of text properties specifying the mouse
24372 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24373 before-string and after-string that must also be highlighted.
24374 COVER_STRING, if non-nil, is a display string that may cover some
24375 or all of the highlighted text. */
24378 mouse_face_from_buffer_pos (Lisp_Object window
,
24379 Mouse_HLInfo
*hlinfo
,
24380 EMACS_INT mouse_charpos
,
24381 EMACS_INT start_charpos
,
24382 EMACS_INT end_charpos
,
24383 Lisp_Object before_string
,
24384 Lisp_Object after_string
,
24385 Lisp_Object cover_string
)
24387 struct window
*w
= XWINDOW (window
);
24388 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24389 struct glyph_row
*r1
, *r2
;
24390 struct glyph
*glyph
, *end
;
24391 EMACS_INT ignore
, pos
;
24394 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24395 xassert (NILP (before_string
) || STRINGP (before_string
));
24396 xassert (NILP (after_string
) || STRINGP (after_string
));
24398 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24399 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24401 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24402 /* If the before-string or display-string contains newlines,
24403 rows_from_pos_range skips to its last row. Move back. */
24404 if (!NILP (before_string
) || !NILP (cover_string
))
24406 struct glyph_row
*prev
;
24407 while ((prev
= r1
- 1, prev
>= first
)
24408 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24409 && prev
->used
[TEXT_AREA
] > 0)
24411 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24412 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24413 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24415 || !(EQ (glyph
->object
, before_string
)
24416 || EQ (glyph
->object
, cover_string
)))
24423 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24424 hlinfo
->mouse_face_past_end
= 1;
24426 else if (!NILP (after_string
))
24428 /* If the after-string has newlines, advance to its last row. */
24429 struct glyph_row
*next
;
24430 struct glyph_row
*last
24431 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24433 for (next
= r2
+ 1;
24435 && next
->used
[TEXT_AREA
] > 0
24436 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24440 /* The rest of the display engine assumes that mouse_face_beg_row is
24441 either above below mouse_face_end_row or identical to it. But
24442 with bidi-reordered continued lines, the row for START_CHARPOS
24443 could be below the row for END_CHARPOS. If so, swap the rows and
24444 store them in correct order. */
24447 struct glyph_row
*tem
= r2
;
24453 hlinfo
->mouse_face_beg_y
= r1
->y
;
24454 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24455 hlinfo
->mouse_face_end_y
= r2
->y
;
24456 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24458 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24459 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24460 could be anywhere in the row and in any order. The strategy
24461 below is to find the leftmost and the rightmost glyph that
24462 belongs to either of these 3 strings, or whose position is
24463 between START_CHARPOS and END_CHARPOS, and highlight all the
24464 glyphs between those two. This may cover more than just the text
24465 between START_CHARPOS and END_CHARPOS if the range of characters
24466 strides the bidi level boundary, e.g. if the beginning is in R2L
24467 text while the end is in L2R text or vice versa. */
24468 if (!r1
->reversed_p
)
24470 /* This row is in a left to right paragraph. Scan it left to
24472 glyph
= r1
->glyphs
[TEXT_AREA
];
24473 end
= glyph
+ r1
->used
[TEXT_AREA
];
24476 /* Skip truncation glyphs at the start of the glyph row. */
24477 if (r1
->displays_text_p
)
24479 && INTEGERP (glyph
->object
)
24480 && glyph
->charpos
< 0;
24482 x
+= glyph
->pixel_width
;
24484 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24485 or COVER_STRING, and the first glyph from buffer whose
24486 position is between START_CHARPOS and END_CHARPOS. */
24488 && !INTEGERP (glyph
->object
)
24489 && !EQ (glyph
->object
, cover_string
)
24490 && !(BUFFERP (glyph
->object
)
24491 && (glyph
->charpos
>= start_charpos
24492 && glyph
->charpos
< end_charpos
));
24495 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24496 are present at buffer positions between START_CHARPOS and
24497 END_CHARPOS, or if they come from an overlay. */
24498 if (EQ (glyph
->object
, before_string
))
24500 pos
= string_buffer_position (before_string
,
24502 /* If pos == 0, it means before_string came from an
24503 overlay, not from a buffer position. */
24504 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24507 else if (EQ (glyph
->object
, after_string
))
24509 pos
= string_buffer_position (after_string
, end_charpos
);
24510 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24513 x
+= glyph
->pixel_width
;
24515 hlinfo
->mouse_face_beg_x
= x
;
24516 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24520 /* This row is in a right to left paragraph. Scan it right to
24524 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24525 glyph
= end
+ r1
->used
[TEXT_AREA
];
24527 /* Skip truncation glyphs at the start of the glyph row. */
24528 if (r1
->displays_text_p
)
24530 && INTEGERP (glyph
->object
)
24531 && glyph
->charpos
< 0;
24535 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24536 or COVER_STRING, and the first glyph from buffer whose
24537 position is between START_CHARPOS and END_CHARPOS. */
24539 && !INTEGERP (glyph
->object
)
24540 && !EQ (glyph
->object
, cover_string
)
24541 && !(BUFFERP (glyph
->object
)
24542 && (glyph
->charpos
>= start_charpos
24543 && glyph
->charpos
< end_charpos
));
24546 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24547 are present at buffer positions between START_CHARPOS and
24548 END_CHARPOS, or if they come from an overlay. */
24549 if (EQ (glyph
->object
, before_string
))
24551 pos
= string_buffer_position (before_string
, start_charpos
);
24552 /* If pos == 0, it means before_string came from an
24553 overlay, not from a buffer position. */
24554 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24557 else if (EQ (glyph
->object
, after_string
))
24559 pos
= string_buffer_position (after_string
, end_charpos
);
24560 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24565 glyph
++; /* first glyph to the right of the highlighted area */
24566 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24567 x
+= g
->pixel_width
;
24568 hlinfo
->mouse_face_beg_x
= x
;
24569 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24572 /* If the highlight ends in a different row, compute GLYPH and END
24573 for the end row. Otherwise, reuse the values computed above for
24574 the row where the highlight begins. */
24577 if (!r2
->reversed_p
)
24579 glyph
= r2
->glyphs
[TEXT_AREA
];
24580 end
= glyph
+ r2
->used
[TEXT_AREA
];
24585 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24586 glyph
= end
+ r2
->used
[TEXT_AREA
];
24590 if (!r2
->reversed_p
)
24592 /* Skip truncation and continuation glyphs near the end of the
24593 row, and also blanks and stretch glyphs inserted by
24594 extend_face_to_end_of_line. */
24596 && INTEGERP ((end
- 1)->object
)
24597 && (end
- 1)->charpos
<= 0)
24599 /* Scan the rest of the glyph row from the end, looking for the
24600 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24601 COVER_STRING, or whose position is between START_CHARPOS
24605 && !INTEGERP (end
->object
)
24606 && !EQ (end
->object
, cover_string
)
24607 && !(BUFFERP (end
->object
)
24608 && (end
->charpos
>= start_charpos
24609 && end
->charpos
< end_charpos
));
24612 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24613 are present at buffer positions between START_CHARPOS and
24614 END_CHARPOS, or if they come from an overlay. */
24615 if (EQ (end
->object
, before_string
))
24617 pos
= string_buffer_position (before_string
, start_charpos
);
24618 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24621 else if (EQ (end
->object
, after_string
))
24623 pos
= string_buffer_position (after_string
, end_charpos
);
24624 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24628 /* Find the X coordinate of the last glyph to be highlighted. */
24629 for (; glyph
<= end
; ++glyph
)
24630 x
+= glyph
->pixel_width
;
24632 hlinfo
->mouse_face_end_x
= x
;
24633 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24637 /* Skip truncation and continuation glyphs near the end of the
24638 row, and also blanks and stretch glyphs inserted by
24639 extend_face_to_end_of_line. */
24643 && INTEGERP (end
->object
)
24644 && end
->charpos
<= 0)
24646 x
+= end
->pixel_width
;
24649 /* Scan the rest of the glyph row from the end, looking for the
24650 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24651 COVER_STRING, or whose position is between START_CHARPOS
24655 && !INTEGERP (end
->object
)
24656 && !EQ (end
->object
, cover_string
)
24657 && !(BUFFERP (end
->object
)
24658 && (end
->charpos
>= start_charpos
24659 && end
->charpos
< end_charpos
));
24662 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24663 are present at buffer positions between START_CHARPOS and
24664 END_CHARPOS, or if they come from an overlay. */
24665 if (EQ (end
->object
, before_string
))
24667 pos
= string_buffer_position (before_string
, start_charpos
);
24668 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24671 else if (EQ (end
->object
, after_string
))
24673 pos
= string_buffer_position (after_string
, end_charpos
);
24674 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24677 x
+= end
->pixel_width
;
24679 hlinfo
->mouse_face_end_x
= x
;
24680 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24683 hlinfo
->mouse_face_window
= window
;
24684 hlinfo
->mouse_face_face_id
24685 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24687 !hlinfo
->mouse_face_hidden
, -1);
24688 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24691 /* The following function is not used anymore (replaced with
24692 mouse_face_from_string_pos), but I leave it here for the time
24693 being, in case someone would. */
24695 #if 0 /* not used */
24697 /* Find the position of the glyph for position POS in OBJECT in
24698 window W's current matrix, and return in *X, *Y the pixel
24699 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24701 RIGHT_P non-zero means return the position of the right edge of the
24702 glyph, RIGHT_P zero means return the left edge position.
24704 If no glyph for POS exists in the matrix, return the position of
24705 the glyph with the next smaller position that is in the matrix, if
24706 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24707 exists in the matrix, return the position of the glyph with the
24708 next larger position in OBJECT.
24710 Value is non-zero if a glyph was found. */
24713 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24714 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24716 int yb
= window_text_bottom_y (w
);
24717 struct glyph_row
*r
;
24718 struct glyph
*best_glyph
= NULL
;
24719 struct glyph_row
*best_row
= NULL
;
24722 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24723 r
->enabled_p
&& r
->y
< yb
;
24726 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24727 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24730 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24731 if (EQ (g
->object
, object
))
24733 if (g
->charpos
== pos
)
24740 else if (best_glyph
== NULL
24741 || ((eabs (g
->charpos
- pos
)
24742 < eabs (best_glyph
->charpos
- pos
))
24745 : g
->charpos
> pos
)))
24759 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24763 *x
+= best_glyph
->pixel_width
;
24768 *vpos
= best_row
- w
->current_matrix
->rows
;
24771 return best_glyph
!= NULL
;
24773 #endif /* not used */
24775 /* Find the positions of the first and the last glyphs in window W's
24776 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24777 (assumed to be a string), and return in HLINFO's mouse_face_*
24778 members the pixel and column/row coordinates of those glyphs. */
24781 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24782 Lisp_Object object
,
24783 EMACS_INT startpos
, EMACS_INT endpos
)
24785 int yb
= window_text_bottom_y (w
);
24786 struct glyph_row
*r
;
24787 struct glyph
*g
, *e
;
24791 /* Find the glyph row with at least one position in the range
24792 [STARTPOS..ENDPOS], and the first glyph in that row whose
24793 position belongs to that range. */
24794 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24795 r
->enabled_p
&& r
->y
< yb
;
24798 if (!r
->reversed_p
)
24800 g
= r
->glyphs
[TEXT_AREA
];
24801 e
= g
+ r
->used
[TEXT_AREA
];
24802 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24803 if (EQ (g
->object
, object
)
24804 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24806 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24807 hlinfo
->mouse_face_beg_y
= r
->y
;
24808 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24809 hlinfo
->mouse_face_beg_x
= gx
;
24818 e
= r
->glyphs
[TEXT_AREA
];
24819 g
= e
+ r
->used
[TEXT_AREA
];
24820 for ( ; g
> e
; --g
)
24821 if (EQ ((g
-1)->object
, object
)
24822 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24824 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24825 hlinfo
->mouse_face_beg_y
= r
->y
;
24826 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24827 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24828 gx
+= g1
->pixel_width
;
24829 hlinfo
->mouse_face_beg_x
= gx
;
24841 /* Starting with the next row, look for the first row which does NOT
24842 include any glyphs whose positions are in the range. */
24843 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24845 g
= r
->glyphs
[TEXT_AREA
];
24846 e
= g
+ r
->used
[TEXT_AREA
];
24848 for ( ; g
< e
; ++g
)
24849 if (EQ (g
->object
, object
)
24850 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24859 /* The highlighted region ends on the previous row. */
24862 /* Set the end row and its vertical pixel coordinate. */
24863 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24864 hlinfo
->mouse_face_end_y
= r
->y
;
24866 /* Compute and set the end column and the end column's horizontal
24867 pixel coordinate. */
24868 if (!r
->reversed_p
)
24870 g
= r
->glyphs
[TEXT_AREA
];
24871 e
= g
+ r
->used
[TEXT_AREA
];
24872 for ( ; e
> g
; --e
)
24873 if (EQ ((e
-1)->object
, object
)
24874 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24876 hlinfo
->mouse_face_end_col
= e
- g
;
24878 for (gx
= r
->x
; g
< e
; ++g
)
24879 gx
+= g
->pixel_width
;
24880 hlinfo
->mouse_face_end_x
= gx
;
24884 e
= r
->glyphs
[TEXT_AREA
];
24885 g
= e
+ r
->used
[TEXT_AREA
];
24886 for (gx
= r
->x
; e
< g
; ++e
)
24888 if (EQ (e
->object
, object
)
24889 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24891 gx
+= e
->pixel_width
;
24893 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24894 hlinfo
->mouse_face_end_x
= gx
;
24898 #ifdef HAVE_WINDOW_SYSTEM
24900 /* See if position X, Y is within a hot-spot of an image. */
24903 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24905 if (!CONSP (hot_spot
))
24908 if (EQ (XCAR (hot_spot
), Qrect
))
24910 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24911 Lisp_Object rect
= XCDR (hot_spot
);
24915 if (!CONSP (XCAR (rect
)))
24917 if (!CONSP (XCDR (rect
)))
24919 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24921 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24923 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24925 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24929 else if (EQ (XCAR (hot_spot
), Qcircle
))
24931 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24932 Lisp_Object circ
= XCDR (hot_spot
);
24933 Lisp_Object lr
, lx0
, ly0
;
24935 && CONSP (XCAR (circ
))
24936 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24937 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24938 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24940 double r
= XFLOATINT (lr
);
24941 double dx
= XINT (lx0
) - x
;
24942 double dy
= XINT (ly0
) - y
;
24943 return (dx
* dx
+ dy
* dy
<= r
* r
);
24946 else if (EQ (XCAR (hot_spot
), Qpoly
))
24948 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24949 if (VECTORP (XCDR (hot_spot
)))
24951 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24952 Lisp_Object
*poly
= v
->contents
;
24953 int n
= v
->header
.size
;
24956 Lisp_Object lx
, ly
;
24959 /* Need an even number of coordinates, and at least 3 edges. */
24960 if (n
< 6 || n
& 1)
24963 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24964 If count is odd, we are inside polygon. Pixels on edges
24965 may or may not be included depending on actual geometry of the
24967 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24968 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24970 x0
= XINT (lx
), y0
= XINT (ly
);
24971 for (i
= 0; i
< n
; i
+= 2)
24973 int x1
= x0
, y1
= y0
;
24974 if ((lx
= poly
[i
], !INTEGERP (lx
))
24975 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24977 x0
= XINT (lx
), y0
= XINT (ly
);
24979 /* Does this segment cross the X line? */
24987 if (y
> y0
&& y
> y1
)
24989 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24999 find_hot_spot (Lisp_Object map
, int x
, int y
)
25001 while (CONSP (map
))
25003 if (CONSP (XCAR (map
))
25004 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25012 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25014 doc
: /* Lookup in image map MAP coordinates X and Y.
25015 An image map is an alist where each element has the format (AREA ID PLIST).
25016 An AREA is specified as either a rectangle, a circle, or a polygon:
25017 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25018 pixel coordinates of the upper left and bottom right corners.
25019 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25020 and the radius of the circle; r may be a float or integer.
25021 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25022 vector describes one corner in the polygon.
25023 Returns the alist element for the first matching AREA in MAP. */)
25024 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25032 return find_hot_spot (map
, XINT (x
), XINT (y
));
25036 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25038 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25040 /* Do not change cursor shape while dragging mouse. */
25041 if (!NILP (do_mouse_tracking
))
25044 if (!NILP (pointer
))
25046 if (EQ (pointer
, Qarrow
))
25047 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25048 else if (EQ (pointer
, Qhand
))
25049 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25050 else if (EQ (pointer
, Qtext
))
25051 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25052 else if (EQ (pointer
, intern ("hdrag")))
25053 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25054 #ifdef HAVE_X_WINDOWS
25055 else if (EQ (pointer
, intern ("vdrag")))
25056 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25058 else if (EQ (pointer
, intern ("hourglass")))
25059 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25060 else if (EQ (pointer
, Qmodeline
))
25061 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25063 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25066 if (cursor
!= No_Cursor
)
25067 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25070 #endif /* HAVE_WINDOW_SYSTEM */
25072 /* Take proper action when mouse has moved to the mode or header line
25073 or marginal area AREA of window W, x-position X and y-position Y.
25074 X is relative to the start of the text display area of W, so the
25075 width of bitmap areas and scroll bars must be subtracted to get a
25076 position relative to the start of the mode line. */
25079 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25080 enum window_part area
)
25082 struct window
*w
= XWINDOW (window
);
25083 struct frame
*f
= XFRAME (w
->frame
);
25084 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25085 #ifdef HAVE_WINDOW_SYSTEM
25086 Display_Info
*dpyinfo
;
25088 Cursor cursor
= No_Cursor
;
25089 Lisp_Object pointer
= Qnil
;
25090 int dx
, dy
, width
, height
;
25092 Lisp_Object string
, object
= Qnil
;
25093 Lisp_Object pos
, help
;
25095 Lisp_Object mouse_face
;
25096 int original_x_pixel
= x
;
25097 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25098 struct glyph_row
*row
;
25100 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25105 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25106 returns them in row/column units! */
25107 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25108 &object
, &dx
, &dy
, &width
, &height
);
25110 row
= (area
== ON_MODE_LINE
25111 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25112 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25114 /* Find the glyph under the mouse pointer. */
25115 if (row
->mode_line_p
&& row
->enabled_p
)
25117 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25118 end
= glyph
+ row
->used
[TEXT_AREA
];
25120 for (x0
= original_x_pixel
;
25121 glyph
< end
&& x0
>= glyph
->pixel_width
;
25123 x0
-= glyph
->pixel_width
;
25131 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25132 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25133 returns them in row/column units! */
25134 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25135 &object
, &dx
, &dy
, &width
, &height
);
25140 #ifdef HAVE_WINDOW_SYSTEM
25141 if (IMAGEP (object
))
25143 Lisp_Object image_map
, hotspot
;
25144 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25146 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25148 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25152 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25153 If so, we could look for mouse-enter, mouse-leave
25154 properties in PLIST (and do something...). */
25155 hotspot
= XCDR (hotspot
);
25156 if (CONSP (hotspot
)
25157 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25159 pointer
= Fplist_get (plist
, Qpointer
);
25160 if (NILP (pointer
))
25162 help
= Fplist_get (plist
, Qhelp_echo
);
25165 help_echo_string
= help
;
25166 /* Is this correct? ++kfs */
25167 XSETWINDOW (help_echo_window
, w
);
25168 help_echo_object
= w
->buffer
;
25169 help_echo_pos
= charpos
;
25173 if (NILP (pointer
))
25174 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25176 #endif /* HAVE_WINDOW_SYSTEM */
25178 if (STRINGP (string
))
25180 pos
= make_number (charpos
);
25181 /* If we're on a string with `help-echo' text property, arrange
25182 for the help to be displayed. This is done by setting the
25183 global variable help_echo_string to the help string. */
25186 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25189 help_echo_string
= help
;
25190 XSETWINDOW (help_echo_window
, w
);
25191 help_echo_object
= string
;
25192 help_echo_pos
= charpos
;
25196 #ifdef HAVE_WINDOW_SYSTEM
25197 if (FRAME_WINDOW_P (f
))
25199 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25200 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25201 if (NILP (pointer
))
25202 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25204 /* Change the mouse pointer according to what is under X/Y. */
25206 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25209 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25210 if (!KEYMAPP (map
))
25211 map
= Fget_text_property (pos
, Qkeymap
, string
);
25212 if (!KEYMAPP (map
))
25213 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25218 /* Change the mouse face according to what is under X/Y. */
25219 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25220 if (!NILP (mouse_face
)
25221 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25226 struct glyph
* tmp_glyph
;
25230 int total_pixel_width
;
25231 EMACS_INT begpos
, endpos
, ignore
;
25235 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25236 Qmouse_face
, string
, Qnil
);
25242 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25244 endpos
= SCHARS (string
);
25248 /* Calculate the glyph position GPOS of GLYPH in the
25249 displayed string, relative to the beginning of the
25250 highlighted part of the string.
25252 Note: GPOS is different from CHARPOS. CHARPOS is the
25253 position of GLYPH in the internal string object. A mode
25254 line string format has structures which are converted to
25255 a flattened string by the Emacs Lisp interpreter. The
25256 internal string is an element of those structures. The
25257 displayed string is the flattened string. */
25258 tmp_glyph
= row_start_glyph
;
25259 while (tmp_glyph
< glyph
25260 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25261 && begpos
<= tmp_glyph
->charpos
25262 && tmp_glyph
->charpos
< endpos
)))
25264 gpos
= glyph
- tmp_glyph
;
25266 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25267 the highlighted part of the displayed string to which
25268 GLYPH belongs. Note: GSEQ_LENGTH is different from
25269 SCHARS (STRING), because the latter returns the length of
25270 the internal string. */
25271 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25273 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25274 && begpos
<= tmp_glyph
->charpos
25275 && tmp_glyph
->charpos
< endpos
));
25278 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25280 /* Calculate the total pixel width of all the glyphs between
25281 the beginning of the highlighted area and GLYPH. */
25282 total_pixel_width
= 0;
25283 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25284 total_pixel_width
+= tmp_glyph
->pixel_width
;
25286 /* Pre calculation of re-rendering position. Note: X is in
25287 column units here, after the call to mode_line_string or
25288 marginal_area_string. */
25290 vpos
= (area
== ON_MODE_LINE
25291 ? (w
->current_matrix
)->nrows
- 1
25294 /* If GLYPH's position is included in the region that is
25295 already drawn in mouse face, we have nothing to do. */
25296 if ( EQ (window
, hlinfo
->mouse_face_window
)
25297 && (!row
->reversed_p
25298 ? (hlinfo
->mouse_face_beg_col
<= hpos
25299 && hpos
< hlinfo
->mouse_face_end_col
)
25300 /* In R2L rows we swap BEG and END, see below. */
25301 : (hlinfo
->mouse_face_end_col
<= hpos
25302 && hpos
< hlinfo
->mouse_face_beg_col
))
25303 && hlinfo
->mouse_face_beg_row
== vpos
)
25306 if (clear_mouse_face (hlinfo
))
25307 cursor
= No_Cursor
;
25309 if (!row
->reversed_p
)
25311 hlinfo
->mouse_face_beg_col
= hpos
;
25312 hlinfo
->mouse_face_beg_x
= original_x_pixel
25313 - (total_pixel_width
+ dx
);
25314 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25315 hlinfo
->mouse_face_end_x
= 0;
25319 /* In R2L rows, show_mouse_face expects BEG and END
25320 coordinates to be swapped. */
25321 hlinfo
->mouse_face_end_col
= hpos
;
25322 hlinfo
->mouse_face_end_x
= original_x_pixel
25323 - (total_pixel_width
+ dx
);
25324 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25325 hlinfo
->mouse_face_beg_x
= 0;
25328 hlinfo
->mouse_face_beg_row
= vpos
;
25329 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25330 hlinfo
->mouse_face_beg_y
= 0;
25331 hlinfo
->mouse_face_end_y
= 0;
25332 hlinfo
->mouse_face_past_end
= 0;
25333 hlinfo
->mouse_face_window
= window
;
25335 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25341 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25343 if (NILP (pointer
))
25346 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25347 clear_mouse_face (hlinfo
);
25349 #ifdef HAVE_WINDOW_SYSTEM
25350 if (FRAME_WINDOW_P (f
))
25351 define_frame_cursor1 (f
, cursor
, pointer
);
25357 Take proper action when the mouse has moved to position X, Y on
25358 frame F as regards highlighting characters that have mouse-face
25359 properties. Also de-highlighting chars where the mouse was before.
25360 X and Y can be negative or out of range. */
25363 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25365 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25366 enum window_part part
;
25367 Lisp_Object window
;
25369 Cursor cursor
= No_Cursor
;
25370 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25373 /* When a menu is active, don't highlight because this looks odd. */
25374 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25375 if (popup_activated ())
25379 if (NILP (Vmouse_highlight
)
25380 || !f
->glyphs_initialized_p
25381 || f
->pointer_invisible
)
25384 hlinfo
->mouse_face_mouse_x
= x
;
25385 hlinfo
->mouse_face_mouse_y
= y
;
25386 hlinfo
->mouse_face_mouse_frame
= f
;
25388 if (hlinfo
->mouse_face_defer
)
25391 if (gc_in_progress
)
25393 hlinfo
->mouse_face_deferred_gc
= 1;
25397 /* Which window is that in? */
25398 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25400 /* If we were displaying active text in another window, clear that.
25401 Also clear if we move out of text area in same window. */
25402 if (! EQ (window
, hlinfo
->mouse_face_window
)
25403 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25404 && !NILP (hlinfo
->mouse_face_window
)))
25405 clear_mouse_face (hlinfo
);
25407 /* Not on a window -> return. */
25408 if (!WINDOWP (window
))
25411 /* Reset help_echo_string. It will get recomputed below. */
25412 help_echo_string
= Qnil
;
25414 /* Convert to window-relative pixel coordinates. */
25415 w
= XWINDOW (window
);
25416 frame_to_window_pixel_xy (w
, &x
, &y
);
25418 #ifdef HAVE_WINDOW_SYSTEM
25419 /* Handle tool-bar window differently since it doesn't display a
25421 if (EQ (window
, f
->tool_bar_window
))
25423 note_tool_bar_highlight (f
, x
, y
);
25428 /* Mouse is on the mode, header line or margin? */
25429 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25430 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25432 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25436 #ifdef HAVE_WINDOW_SYSTEM
25437 if (part
== ON_VERTICAL_BORDER
)
25439 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25440 help_echo_string
= build_string ("drag-mouse-1: resize");
25442 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25443 || part
== ON_SCROLL_BAR
)
25444 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25446 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25449 /* Are we in a window whose display is up to date?
25450 And verify the buffer's text has not changed. */
25451 b
= XBUFFER (w
->buffer
);
25452 if (part
== ON_TEXT
25453 && EQ (w
->window_end_valid
, w
->buffer
)
25454 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25455 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25457 int hpos
, vpos
, i
, dx
, dy
, area
;
25459 struct glyph
*glyph
;
25460 Lisp_Object object
;
25461 Lisp_Object mouse_face
= Qnil
, position
;
25462 Lisp_Object
*overlay_vec
= NULL
;
25464 struct buffer
*obuf
;
25465 EMACS_INT obegv
, ozv
;
25468 /* Find the glyph under X/Y. */
25469 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25471 #ifdef HAVE_WINDOW_SYSTEM
25472 /* Look for :pointer property on image. */
25473 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25475 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25476 if (img
!= NULL
&& IMAGEP (img
->spec
))
25478 Lisp_Object image_map
, hotspot
;
25479 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25481 && (hotspot
= find_hot_spot (image_map
,
25482 glyph
->slice
.img
.x
+ dx
,
25483 glyph
->slice
.img
.y
+ dy
),
25485 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25489 /* Could check XCAR (hotspot) to see if we enter/leave
25491 If so, we could look for mouse-enter, mouse-leave
25492 properties in PLIST (and do something...). */
25493 hotspot
= XCDR (hotspot
);
25494 if (CONSP (hotspot
)
25495 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25497 pointer
= Fplist_get (plist
, Qpointer
);
25498 if (NILP (pointer
))
25500 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25501 if (!NILP (help_echo_string
))
25503 help_echo_window
= window
;
25504 help_echo_object
= glyph
->object
;
25505 help_echo_pos
= glyph
->charpos
;
25509 if (NILP (pointer
))
25510 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25513 #endif /* HAVE_WINDOW_SYSTEM */
25515 /* Clear mouse face if X/Y not over text. */
25517 || area
!= TEXT_AREA
25518 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25519 /* Glyph's OBJECT is an integer for glyphs inserted by the
25520 display engine for its internal purposes, like truncation
25521 and continuation glyphs and blanks beyond the end of
25522 line's text on text terminals. If we are over such a
25523 glyph, we are not over any text. */
25524 || INTEGERP (glyph
->object
)
25525 /* R2L rows have a stretch glyph at their front, which
25526 stands for no text, whereas L2R rows have no glyphs at
25527 all beyond the end of text. Treat such stretch glyphs
25528 like we do with NULL glyphs in L2R rows. */
25529 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25530 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25531 && glyph
->type
== STRETCH_GLYPH
25532 && glyph
->avoid_cursor_p
))
25534 if (clear_mouse_face (hlinfo
))
25535 cursor
= No_Cursor
;
25536 #ifdef HAVE_WINDOW_SYSTEM
25537 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25539 if (area
!= TEXT_AREA
)
25540 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25542 pointer
= Vvoid_text_area_pointer
;
25548 pos
= glyph
->charpos
;
25549 object
= glyph
->object
;
25550 if (!STRINGP (object
) && !BUFFERP (object
))
25553 /* If we get an out-of-range value, return now; avoid an error. */
25554 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25557 /* Make the window's buffer temporarily current for
25558 overlays_at and compute_char_face. */
25559 obuf
= current_buffer
;
25560 current_buffer
= b
;
25566 /* Is this char mouse-active or does it have help-echo? */
25567 position
= make_number (pos
);
25569 if (BUFFERP (object
))
25571 /* Put all the overlays we want in a vector in overlay_vec. */
25572 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25573 /* Sort overlays into increasing priority order. */
25574 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25579 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25582 cursor
= No_Cursor
;
25584 /* Check mouse-face highlighting. */
25586 /* If there exists an overlay with mouse-face overlapping
25587 the one we are currently highlighting, we have to
25588 check if we enter the overlapping overlay, and then
25589 highlight only that. */
25590 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25591 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25593 /* Find the highest priority overlay with a mouse-face. */
25594 Lisp_Object overlay
= Qnil
;
25595 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25597 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25598 if (!NILP (mouse_face
))
25599 overlay
= overlay_vec
[i
];
25602 /* If we're highlighting the same overlay as before, there's
25603 no need to do that again. */
25604 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25605 goto check_help_echo
;
25606 hlinfo
->mouse_face_overlay
= overlay
;
25608 /* Clear the display of the old active region, if any. */
25609 if (clear_mouse_face (hlinfo
))
25610 cursor
= No_Cursor
;
25612 /* If no overlay applies, get a text property. */
25613 if (NILP (overlay
))
25614 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25616 /* Next, compute the bounds of the mouse highlighting and
25618 if (!NILP (mouse_face
) && STRINGP (object
))
25620 /* The mouse-highlighting comes from a display string
25621 with a mouse-face. */
25625 s
= Fprevious_single_property_change
25626 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25627 e
= Fnext_single_property_change
25628 (position
, Qmouse_face
, object
, Qnil
);
25630 s
= make_number (0);
25632 e
= make_number (SCHARS (object
) - 1);
25633 mouse_face_from_string_pos (w
, hlinfo
, object
,
25634 XINT (s
), XINT (e
));
25635 hlinfo
->mouse_face_past_end
= 0;
25636 hlinfo
->mouse_face_window
= window
;
25637 hlinfo
->mouse_face_face_id
25638 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25639 glyph
->face_id
, 1);
25640 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25641 cursor
= No_Cursor
;
25645 /* The mouse-highlighting, if any, comes from an overlay
25646 or text property in the buffer. */
25647 Lisp_Object buffer
IF_LINT (= Qnil
);
25648 Lisp_Object cover_string
IF_LINT (= Qnil
);
25650 if (STRINGP (object
))
25652 /* If we are on a display string with no mouse-face,
25653 check if the text under it has one. */
25654 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25655 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25656 pos
= string_buffer_position (object
, start
);
25659 mouse_face
= get_char_property_and_overlay
25660 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25661 buffer
= w
->buffer
;
25662 cover_string
= object
;
25668 cover_string
= Qnil
;
25671 if (!NILP (mouse_face
))
25673 Lisp_Object before
, after
;
25674 Lisp_Object before_string
, after_string
;
25675 /* To correctly find the limits of mouse highlight
25676 in a bidi-reordered buffer, we must not use the
25677 optimization of limiting the search in
25678 previous-single-property-change and
25679 next-single-property-change, because
25680 rows_from_pos_range needs the real start and end
25681 positions to DTRT in this case. That's because
25682 the first row visible in a window does not
25683 necessarily display the character whose position
25684 is the smallest. */
25686 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25687 ? Fmarker_position (w
->start
)
25690 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25691 ? make_number (BUF_Z (XBUFFER (buffer
))
25692 - XFASTINT (w
->window_end_pos
))
25695 if (NILP (overlay
))
25697 /* Handle the text property case. */
25698 before
= Fprevious_single_property_change
25699 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25700 after
= Fnext_single_property_change
25701 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25702 before_string
= after_string
= Qnil
;
25706 /* Handle the overlay case. */
25707 before
= Foverlay_start (overlay
);
25708 after
= Foverlay_end (overlay
);
25709 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25710 after_string
= Foverlay_get (overlay
, Qafter_string
);
25712 if (!STRINGP (before_string
)) before_string
= Qnil
;
25713 if (!STRINGP (after_string
)) after_string
= Qnil
;
25716 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25719 before_string
, after_string
,
25721 cursor
= No_Cursor
;
25728 /* Look for a `help-echo' property. */
25729 if (NILP (help_echo_string
)) {
25730 Lisp_Object help
, overlay
;
25732 /* Check overlays first. */
25733 help
= overlay
= Qnil
;
25734 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25736 overlay
= overlay_vec
[i
];
25737 help
= Foverlay_get (overlay
, Qhelp_echo
);
25742 help_echo_string
= help
;
25743 help_echo_window
= window
;
25744 help_echo_object
= overlay
;
25745 help_echo_pos
= pos
;
25749 Lisp_Object obj
= glyph
->object
;
25750 EMACS_INT charpos
= glyph
->charpos
;
25752 /* Try text properties. */
25755 && charpos
< SCHARS (obj
))
25757 help
= Fget_text_property (make_number (charpos
),
25761 /* If the string itself doesn't specify a help-echo,
25762 see if the buffer text ``under'' it does. */
25763 struct glyph_row
*r
25764 = MATRIX_ROW (w
->current_matrix
, vpos
);
25765 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25766 EMACS_INT p
= string_buffer_position (obj
, start
);
25769 help
= Fget_char_property (make_number (p
),
25770 Qhelp_echo
, w
->buffer
);
25779 else if (BUFFERP (obj
)
25782 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25787 help_echo_string
= help
;
25788 help_echo_window
= window
;
25789 help_echo_object
= obj
;
25790 help_echo_pos
= charpos
;
25795 #ifdef HAVE_WINDOW_SYSTEM
25796 /* Look for a `pointer' property. */
25797 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25799 /* Check overlays first. */
25800 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25801 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25803 if (NILP (pointer
))
25805 Lisp_Object obj
= glyph
->object
;
25806 EMACS_INT charpos
= glyph
->charpos
;
25808 /* Try text properties. */
25811 && charpos
< SCHARS (obj
))
25813 pointer
= Fget_text_property (make_number (charpos
),
25815 if (NILP (pointer
))
25817 /* If the string itself doesn't specify a pointer,
25818 see if the buffer text ``under'' it does. */
25819 struct glyph_row
*r
25820 = MATRIX_ROW (w
->current_matrix
, vpos
);
25821 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25822 EMACS_INT p
= string_buffer_position (obj
, start
);
25824 pointer
= Fget_char_property (make_number (p
),
25825 Qpointer
, w
->buffer
);
25828 else if (BUFFERP (obj
)
25831 pointer
= Fget_text_property (make_number (charpos
),
25835 #endif /* HAVE_WINDOW_SYSTEM */
25839 current_buffer
= obuf
;
25844 #ifdef HAVE_WINDOW_SYSTEM
25845 if (FRAME_WINDOW_P (f
))
25846 define_frame_cursor1 (f
, cursor
, pointer
);
25848 /* This is here to prevent a compiler error, about "label at end of
25849 compound statement". */
25856 Clear any mouse-face on window W. This function is part of the
25857 redisplay interface, and is called from try_window_id and similar
25858 functions to ensure the mouse-highlight is off. */
25861 x_clear_window_mouse_face (struct window
*w
)
25863 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25864 Lisp_Object window
;
25867 XSETWINDOW (window
, w
);
25868 if (EQ (window
, hlinfo
->mouse_face_window
))
25869 clear_mouse_face (hlinfo
);
25875 Just discard the mouse face information for frame F, if any.
25876 This is used when the size of F is changed. */
25879 cancel_mouse_face (struct frame
*f
)
25881 Lisp_Object window
;
25882 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25884 window
= hlinfo
->mouse_face_window
;
25885 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25887 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25888 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25889 hlinfo
->mouse_face_window
= Qnil
;
25895 /***********************************************************************
25897 ***********************************************************************/
25899 #ifdef HAVE_WINDOW_SYSTEM
25901 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25902 which intersects rectangle R. R is in window-relative coordinates. */
25905 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25906 enum glyph_row_area area
)
25908 struct glyph
*first
= row
->glyphs
[area
];
25909 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25910 struct glyph
*last
;
25911 int first_x
, start_x
, x
;
25913 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25914 /* If row extends face to end of line write the whole line. */
25915 draw_glyphs (w
, 0, row
, area
,
25916 0, row
->used
[area
],
25917 DRAW_NORMAL_TEXT
, 0);
25920 /* Set START_X to the window-relative start position for drawing glyphs of
25921 AREA. The first glyph of the text area can be partially visible.
25922 The first glyphs of other areas cannot. */
25923 start_x
= window_box_left_offset (w
, area
);
25925 if (area
== TEXT_AREA
)
25928 /* Find the first glyph that must be redrawn. */
25930 && x
+ first
->pixel_width
< r
->x
)
25932 x
+= first
->pixel_width
;
25936 /* Find the last one. */
25940 && x
< r
->x
+ r
->width
)
25942 x
+= last
->pixel_width
;
25948 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25949 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25950 DRAW_NORMAL_TEXT
, 0);
25955 /* Redraw the parts of the glyph row ROW on window W intersecting
25956 rectangle R. R is in window-relative coordinates. Value is
25957 non-zero if mouse-face was overwritten. */
25960 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25962 xassert (row
->enabled_p
);
25964 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25965 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25966 0, row
->used
[TEXT_AREA
],
25967 DRAW_NORMAL_TEXT
, 0);
25970 if (row
->used
[LEFT_MARGIN_AREA
])
25971 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25972 if (row
->used
[TEXT_AREA
])
25973 expose_area (w
, row
, r
, TEXT_AREA
);
25974 if (row
->used
[RIGHT_MARGIN_AREA
])
25975 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25976 draw_row_fringe_bitmaps (w
, row
);
25979 return row
->mouse_face_p
;
25983 /* Redraw those parts of glyphs rows during expose event handling that
25984 overlap other rows. Redrawing of an exposed line writes over parts
25985 of lines overlapping that exposed line; this function fixes that.
25987 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25988 row in W's current matrix that is exposed and overlaps other rows.
25989 LAST_OVERLAPPING_ROW is the last such row. */
25992 expose_overlaps (struct window
*w
,
25993 struct glyph_row
*first_overlapping_row
,
25994 struct glyph_row
*last_overlapping_row
,
25997 struct glyph_row
*row
;
25999 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26000 if (row
->overlapping_p
)
26002 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26005 if (row
->used
[LEFT_MARGIN_AREA
])
26006 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26008 if (row
->used
[TEXT_AREA
])
26009 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26011 if (row
->used
[RIGHT_MARGIN_AREA
])
26012 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26018 /* Return non-zero if W's cursor intersects rectangle R. */
26021 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26023 XRectangle cr
, result
;
26024 struct glyph
*cursor_glyph
;
26025 struct glyph_row
*row
;
26027 if (w
->phys_cursor
.vpos
>= 0
26028 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26029 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26031 && row
->cursor_in_fringe_p
)
26033 /* Cursor is in the fringe. */
26034 cr
.x
= window_box_right_offset (w
,
26035 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26036 ? RIGHT_MARGIN_AREA
26039 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26040 cr
.height
= row
->height
;
26041 return x_intersect_rectangles (&cr
, r
, &result
);
26044 cursor_glyph
= get_phys_cursor_glyph (w
);
26047 /* r is relative to W's box, but w->phys_cursor.x is relative
26048 to left edge of W's TEXT area. Adjust it. */
26049 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26050 cr
.y
= w
->phys_cursor
.y
;
26051 cr
.width
= cursor_glyph
->pixel_width
;
26052 cr
.height
= w
->phys_cursor_height
;
26053 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26054 I assume the effect is the same -- and this is portable. */
26055 return x_intersect_rectangles (&cr
, r
, &result
);
26057 /* If we don't understand the format, pretend we're not in the hot-spot. */
26063 Draw a vertical window border to the right of window W if W doesn't
26064 have vertical scroll bars. */
26067 x_draw_vertical_border (struct window
*w
)
26069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26071 /* We could do better, if we knew what type of scroll-bar the adjacent
26072 windows (on either side) have... But we don't :-(
26073 However, I think this works ok. ++KFS 2003-04-25 */
26075 /* Redraw borders between horizontally adjacent windows. Don't
26076 do it for frames with vertical scroll bars because either the
26077 right scroll bar of a window, or the left scroll bar of its
26078 neighbor will suffice as a border. */
26079 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26082 if (!WINDOW_RIGHTMOST_P (w
)
26083 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26085 int x0
, x1
, y0
, y1
;
26087 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26090 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26093 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26095 else if (!WINDOW_LEFTMOST_P (w
)
26096 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26098 int x0
, x1
, y0
, y1
;
26100 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26103 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26106 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26111 /* Redraw the part of window W intersection rectangle FR. Pixel
26112 coordinates in FR are frame-relative. Call this function with
26113 input blocked. Value is non-zero if the exposure overwrites
26117 expose_window (struct window
*w
, XRectangle
*fr
)
26119 struct frame
*f
= XFRAME (w
->frame
);
26121 int mouse_face_overwritten_p
= 0;
26123 /* If window is not yet fully initialized, do nothing. This can
26124 happen when toolkit scroll bars are used and a window is split.
26125 Reconfiguring the scroll bar will generate an expose for a newly
26127 if (w
->current_matrix
== NULL
)
26130 /* When we're currently updating the window, display and current
26131 matrix usually don't agree. Arrange for a thorough display
26133 if (w
== updated_window
)
26135 SET_FRAME_GARBAGED (f
);
26139 /* Frame-relative pixel rectangle of W. */
26140 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26141 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26142 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26143 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26145 if (x_intersect_rectangles (fr
, &wr
, &r
))
26147 int yb
= window_text_bottom_y (w
);
26148 struct glyph_row
*row
;
26149 int cursor_cleared_p
;
26150 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26152 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26153 r
.x
, r
.y
, r
.width
, r
.height
));
26155 /* Convert to window coordinates. */
26156 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26157 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26159 /* Turn off the cursor. */
26160 if (!w
->pseudo_window_p
26161 && phys_cursor_in_rect_p (w
, &r
))
26163 x_clear_cursor (w
);
26164 cursor_cleared_p
= 1;
26167 cursor_cleared_p
= 0;
26169 /* Update lines intersecting rectangle R. */
26170 first_overlapping_row
= last_overlapping_row
= NULL
;
26171 for (row
= w
->current_matrix
->rows
;
26176 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26178 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26179 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26180 || (r
.y
>= y0
&& r
.y
< y1
)
26181 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26183 /* A header line may be overlapping, but there is no need
26184 to fix overlapping areas for them. KFS 2005-02-12 */
26185 if (row
->overlapping_p
&& !row
->mode_line_p
)
26187 if (first_overlapping_row
== NULL
)
26188 first_overlapping_row
= row
;
26189 last_overlapping_row
= row
;
26193 if (expose_line (w
, row
, &r
))
26194 mouse_face_overwritten_p
= 1;
26197 else if (row
->overlapping_p
)
26199 /* We must redraw a row overlapping the exposed area. */
26201 ? y0
+ row
->phys_height
> r
.y
26202 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26204 if (first_overlapping_row
== NULL
)
26205 first_overlapping_row
= row
;
26206 last_overlapping_row
= row
;
26214 /* Display the mode line if there is one. */
26215 if (WINDOW_WANTS_MODELINE_P (w
)
26216 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26218 && row
->y
< r
.y
+ r
.height
)
26220 if (expose_line (w
, row
, &r
))
26221 mouse_face_overwritten_p
= 1;
26224 if (!w
->pseudo_window_p
)
26226 /* Fix the display of overlapping rows. */
26227 if (first_overlapping_row
)
26228 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26231 /* Draw border between windows. */
26232 x_draw_vertical_border (w
);
26234 /* Turn the cursor on again. */
26235 if (cursor_cleared_p
)
26236 update_window_cursor (w
, 1);
26240 return mouse_face_overwritten_p
;
26245 /* Redraw (parts) of all windows in the window tree rooted at W that
26246 intersect R. R contains frame pixel coordinates. Value is
26247 non-zero if the exposure overwrites mouse-face. */
26250 expose_window_tree (struct window
*w
, XRectangle
*r
)
26252 struct frame
*f
= XFRAME (w
->frame
);
26253 int mouse_face_overwritten_p
= 0;
26255 while (w
&& !FRAME_GARBAGED_P (f
))
26257 if (!NILP (w
->hchild
))
26258 mouse_face_overwritten_p
26259 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26260 else if (!NILP (w
->vchild
))
26261 mouse_face_overwritten_p
26262 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26264 mouse_face_overwritten_p
|= expose_window (w
, r
);
26266 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26269 return mouse_face_overwritten_p
;
26274 Redisplay an exposed area of frame F. X and Y are the upper-left
26275 corner of the exposed rectangle. W and H are width and height of
26276 the exposed area. All are pixel values. W or H zero means redraw
26277 the entire frame. */
26280 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26283 int mouse_face_overwritten_p
= 0;
26285 TRACE ((stderr
, "expose_frame "));
26287 /* No need to redraw if frame will be redrawn soon. */
26288 if (FRAME_GARBAGED_P (f
))
26290 TRACE ((stderr
, " garbaged\n"));
26294 /* If basic faces haven't been realized yet, there is no point in
26295 trying to redraw anything. This can happen when we get an expose
26296 event while Emacs is starting, e.g. by moving another window. */
26297 if (FRAME_FACE_CACHE (f
) == NULL
26298 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26300 TRACE ((stderr
, " no faces\n"));
26304 if (w
== 0 || h
== 0)
26307 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26308 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26318 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26319 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26321 if (WINDOWP (f
->tool_bar_window
))
26322 mouse_face_overwritten_p
26323 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26325 #ifdef HAVE_X_WINDOWS
26327 #ifndef USE_X_TOOLKIT
26328 if (WINDOWP (f
->menu_bar_window
))
26329 mouse_face_overwritten_p
26330 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26331 #endif /* not USE_X_TOOLKIT */
26335 /* Some window managers support a focus-follows-mouse style with
26336 delayed raising of frames. Imagine a partially obscured frame,
26337 and moving the mouse into partially obscured mouse-face on that
26338 frame. The visible part of the mouse-face will be highlighted,
26339 then the WM raises the obscured frame. With at least one WM, KDE
26340 2.1, Emacs is not getting any event for the raising of the frame
26341 (even tried with SubstructureRedirectMask), only Expose events.
26342 These expose events will draw text normally, i.e. not
26343 highlighted. Which means we must redo the highlight here.
26344 Subsume it under ``we love X''. --gerd 2001-08-15 */
26345 /* Included in Windows version because Windows most likely does not
26346 do the right thing if any third party tool offers
26347 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26348 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26350 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26351 if (f
== hlinfo
->mouse_face_mouse_frame
)
26353 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26354 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26355 clear_mouse_face (hlinfo
);
26356 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26363 Determine the intersection of two rectangles R1 and R2. Return
26364 the intersection in *RESULT. Value is non-zero if RESULT is not
26368 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26370 XRectangle
*left
, *right
;
26371 XRectangle
*upper
, *lower
;
26372 int intersection_p
= 0;
26374 /* Rearrange so that R1 is the left-most rectangle. */
26376 left
= r1
, right
= r2
;
26378 left
= r2
, right
= r1
;
26380 /* X0 of the intersection is right.x0, if this is inside R1,
26381 otherwise there is no intersection. */
26382 if (right
->x
<= left
->x
+ left
->width
)
26384 result
->x
= right
->x
;
26386 /* The right end of the intersection is the minimum of
26387 the right ends of left and right. */
26388 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26391 /* Same game for Y. */
26393 upper
= r1
, lower
= r2
;
26395 upper
= r2
, lower
= r1
;
26397 /* The upper end of the intersection is lower.y0, if this is inside
26398 of upper. Otherwise, there is no intersection. */
26399 if (lower
->y
<= upper
->y
+ upper
->height
)
26401 result
->y
= lower
->y
;
26403 /* The lower end of the intersection is the minimum of the lower
26404 ends of upper and lower. */
26405 result
->height
= (min (lower
->y
+ lower
->height
,
26406 upper
->y
+ upper
->height
)
26408 intersection_p
= 1;
26412 return intersection_p
;
26415 #endif /* HAVE_WINDOW_SYSTEM */
26418 /***********************************************************************
26420 ***********************************************************************/
26423 syms_of_xdisp (void)
26425 Vwith_echo_area_save_vector
= Qnil
;
26426 staticpro (&Vwith_echo_area_save_vector
);
26428 Vmessage_stack
= Qnil
;
26429 staticpro (&Vmessage_stack
);
26431 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26432 staticpro (&Qinhibit_redisplay
);
26434 message_dolog_marker1
= Fmake_marker ();
26435 staticpro (&message_dolog_marker1
);
26436 message_dolog_marker2
= Fmake_marker ();
26437 staticpro (&message_dolog_marker2
);
26438 message_dolog_marker3
= Fmake_marker ();
26439 staticpro (&message_dolog_marker3
);
26442 defsubr (&Sdump_frame_glyph_matrix
);
26443 defsubr (&Sdump_glyph_matrix
);
26444 defsubr (&Sdump_glyph_row
);
26445 defsubr (&Sdump_tool_bar_row
);
26446 defsubr (&Strace_redisplay
);
26447 defsubr (&Strace_to_stderr
);
26449 #ifdef HAVE_WINDOW_SYSTEM
26450 defsubr (&Stool_bar_lines_needed
);
26451 defsubr (&Slookup_image_map
);
26453 defsubr (&Sformat_mode_line
);
26454 defsubr (&Sinvisible_p
);
26455 defsubr (&Scurrent_bidi_paragraph_direction
);
26457 staticpro (&Qmenu_bar_update_hook
);
26458 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26460 staticpro (&Qoverriding_terminal_local_map
);
26461 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26463 staticpro (&Qoverriding_local_map
);
26464 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26466 staticpro (&Qwindow_scroll_functions
);
26467 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26469 staticpro (&Qwindow_text_change_functions
);
26470 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26472 staticpro (&Qredisplay_end_trigger_functions
);
26473 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26475 staticpro (&Qinhibit_point_motion_hooks
);
26476 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26478 Qeval
= intern_c_string ("eval");
26479 staticpro (&Qeval
);
26481 QCdata
= intern_c_string (":data");
26482 staticpro (&QCdata
);
26483 Qdisplay
= intern_c_string ("display");
26484 staticpro (&Qdisplay
);
26485 Qspace_width
= intern_c_string ("space-width");
26486 staticpro (&Qspace_width
);
26487 Qraise
= intern_c_string ("raise");
26488 staticpro (&Qraise
);
26489 Qslice
= intern_c_string ("slice");
26490 staticpro (&Qslice
);
26491 Qspace
= intern_c_string ("space");
26492 staticpro (&Qspace
);
26493 Qmargin
= intern_c_string ("margin");
26494 staticpro (&Qmargin
);
26495 Qpointer
= intern_c_string ("pointer");
26496 staticpro (&Qpointer
);
26497 Qleft_margin
= intern_c_string ("left-margin");
26498 staticpro (&Qleft_margin
);
26499 Qright_margin
= intern_c_string ("right-margin");
26500 staticpro (&Qright_margin
);
26501 Qcenter
= intern_c_string ("center");
26502 staticpro (&Qcenter
);
26503 Qline_height
= intern_c_string ("line-height");
26504 staticpro (&Qline_height
);
26505 QCalign_to
= intern_c_string (":align-to");
26506 staticpro (&QCalign_to
);
26507 QCrelative_width
= intern_c_string (":relative-width");
26508 staticpro (&QCrelative_width
);
26509 QCrelative_height
= intern_c_string (":relative-height");
26510 staticpro (&QCrelative_height
);
26511 QCeval
= intern_c_string (":eval");
26512 staticpro (&QCeval
);
26513 QCpropertize
= intern_c_string (":propertize");
26514 staticpro (&QCpropertize
);
26515 QCfile
= intern_c_string (":file");
26516 staticpro (&QCfile
);
26517 Qfontified
= intern_c_string ("fontified");
26518 staticpro (&Qfontified
);
26519 Qfontification_functions
= intern_c_string ("fontification-functions");
26520 staticpro (&Qfontification_functions
);
26521 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26522 staticpro (&Qtrailing_whitespace
);
26523 Qescape_glyph
= intern_c_string ("escape-glyph");
26524 staticpro (&Qescape_glyph
);
26525 Qnobreak_space
= intern_c_string ("nobreak-space");
26526 staticpro (&Qnobreak_space
);
26527 Qimage
= intern_c_string ("image");
26528 staticpro (&Qimage
);
26529 Qtext
= intern_c_string ("text");
26530 staticpro (&Qtext
);
26531 Qboth
= intern_c_string ("both");
26532 staticpro (&Qboth
);
26533 Qboth_horiz
= intern_c_string ("both-horiz");
26534 staticpro (&Qboth_horiz
);
26535 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26536 staticpro (&Qtext_image_horiz
);
26537 QCmap
= intern_c_string (":map");
26538 staticpro (&QCmap
);
26539 QCpointer
= intern_c_string (":pointer");
26540 staticpro (&QCpointer
);
26541 Qrect
= intern_c_string ("rect");
26542 staticpro (&Qrect
);
26543 Qcircle
= intern_c_string ("circle");
26544 staticpro (&Qcircle
);
26545 Qpoly
= intern_c_string ("poly");
26546 staticpro (&Qpoly
);
26547 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26548 staticpro (&Qmessage_truncate_lines
);
26549 Qgrow_only
= intern_c_string ("grow-only");
26550 staticpro (&Qgrow_only
);
26551 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26552 staticpro (&Qinhibit_menubar_update
);
26553 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26554 staticpro (&Qinhibit_eval_during_redisplay
);
26555 Qposition
= intern_c_string ("position");
26556 staticpro (&Qposition
);
26557 Qbuffer_position
= intern_c_string ("buffer-position");
26558 staticpro (&Qbuffer_position
);
26559 Qobject
= intern_c_string ("object");
26560 staticpro (&Qobject
);
26561 Qbar
= intern_c_string ("bar");
26563 Qhbar
= intern_c_string ("hbar");
26564 staticpro (&Qhbar
);
26565 Qbox
= intern_c_string ("box");
26567 Qhollow
= intern_c_string ("hollow");
26568 staticpro (&Qhollow
);
26569 Qhand
= intern_c_string ("hand");
26570 staticpro (&Qhand
);
26571 Qarrow
= intern_c_string ("arrow");
26572 staticpro (&Qarrow
);
26573 Qtext
= intern_c_string ("text");
26574 staticpro (&Qtext
);
26575 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26576 staticpro (&Qinhibit_free_realized_faces
);
26578 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26579 Fcons (intern_c_string ("void-variable"), Qnil
)),
26581 staticpro (&list_of_error
);
26583 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26584 staticpro (&Qlast_arrow_position
);
26585 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26586 staticpro (&Qlast_arrow_string
);
26588 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26589 staticpro (&Qoverlay_arrow_string
);
26590 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26591 staticpro (&Qoverlay_arrow_bitmap
);
26593 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26594 staticpro (&echo_buffer
[0]);
26595 staticpro (&echo_buffer
[1]);
26597 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26598 staticpro (&echo_area_buffer
[0]);
26599 staticpro (&echo_area_buffer
[1]);
26601 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26602 staticpro (&Vmessages_buffer_name
);
26604 mode_line_proptrans_alist
= Qnil
;
26605 staticpro (&mode_line_proptrans_alist
);
26606 mode_line_string_list
= Qnil
;
26607 staticpro (&mode_line_string_list
);
26608 mode_line_string_face
= Qnil
;
26609 staticpro (&mode_line_string_face
);
26610 mode_line_string_face_prop
= Qnil
;
26611 staticpro (&mode_line_string_face_prop
);
26612 Vmode_line_unwind_vector
= Qnil
;
26613 staticpro (&Vmode_line_unwind_vector
);
26615 help_echo_string
= Qnil
;
26616 staticpro (&help_echo_string
);
26617 help_echo_object
= Qnil
;
26618 staticpro (&help_echo_object
);
26619 help_echo_window
= Qnil
;
26620 staticpro (&help_echo_window
);
26621 previous_help_echo_string
= Qnil
;
26622 staticpro (&previous_help_echo_string
);
26623 help_echo_pos
= -1;
26625 Qright_to_left
= intern_c_string ("right-to-left");
26626 staticpro (&Qright_to_left
);
26627 Qleft_to_right
= intern_c_string ("left-to-right");
26628 staticpro (&Qleft_to_right
);
26630 #ifdef HAVE_WINDOW_SYSTEM
26631 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26632 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26633 For example, if a block cursor is over a tab, it will be drawn as
26634 wide as that tab on the display. */);
26635 x_stretch_cursor_p
= 0;
26638 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26639 doc
: /* *Non-nil means highlight trailing whitespace.
26640 The face used for trailing whitespace is `trailing-whitespace'. */);
26641 Vshow_trailing_whitespace
= Qnil
;
26643 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26644 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26645 A value of t means highlight the character itself (for nobreak space,
26646 use face `nobreak-space').
26647 A value of nil means no highlighting.
26648 Other values mean display the escape glyph followed by an ordinary
26649 space or ordinary hyphen. */);
26650 Vnobreak_char_display
= Qt
;
26652 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26653 doc
: /* *The pointer shape to show in void text areas.
26654 A value of nil means to show the text pointer. Other options are `arrow',
26655 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26656 Vvoid_text_area_pointer
= Qarrow
;
26658 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26659 doc
: /* Non-nil means don't actually do any redisplay.
26660 This is used for internal purposes. */);
26661 Vinhibit_redisplay
= Qnil
;
26663 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26664 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26665 Vglobal_mode_string
= Qnil
;
26667 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26668 doc
: /* Marker for where to display an arrow on top of the buffer text.
26669 This must be the beginning of a line in order to work.
26670 See also `overlay-arrow-string'. */);
26671 Voverlay_arrow_position
= Qnil
;
26673 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26674 doc
: /* String to display as an arrow in non-window frames.
26675 See also `overlay-arrow-position'. */);
26676 Voverlay_arrow_string
= make_pure_c_string ("=>");
26678 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26679 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26680 The symbols on this list are examined during redisplay to determine
26681 where to display overlay arrows. */);
26682 Voverlay_arrow_variable_list
26683 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26685 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26686 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26687 If that fails to bring point back on frame, point is centered instead.
26688 If this is zero, point is always centered after it moves off frame.
26689 If you want scrolling to always be a line at a time, you should set
26690 `scroll-conservatively' to a large value rather than set this to 1. */);
26692 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26693 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26694 If point moves off-screen, redisplay will scroll by up to
26695 `scroll-conservatively' lines in order to bring point just barely
26696 onto the screen again. If that cannot be done, then redisplay
26697 recenters point as usual.
26699 If the value is greater than 100, redisplay will never recenter point,
26700 but will always scroll just enough text to bring point into view, even
26701 if you move far away.
26703 A value of zero means always recenter point if it moves off screen. */);
26704 scroll_conservatively
= 0;
26706 DEFVAR_INT ("scroll-margin", scroll_margin
,
26707 doc
: /* *Number of lines of margin at the top and bottom of a window.
26708 Recenter the window whenever point gets within this many lines
26709 of the top or bottom of the window. */);
26712 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26713 doc
: /* Pixels per inch value for non-window system displays.
26714 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26715 Vdisplay_pixels_per_inch
= make_float (72.0);
26718 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26721 DEFVAR_LISP ("truncate-partial-width-windows",
26722 Vtruncate_partial_width_windows
,
26723 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26724 For an integer value, truncate lines in each window narrower than the
26725 full frame width, provided the window width is less than that integer;
26726 otherwise, respect the value of `truncate-lines'.
26728 For any other non-nil value, truncate lines in all windows that do
26729 not span the full frame width.
26731 A value of nil means to respect the value of `truncate-lines'.
26733 If `word-wrap' is enabled, you might want to reduce this. */);
26734 Vtruncate_partial_width_windows
= make_number (50);
26736 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26737 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26738 Any other value means to use the appropriate face, `mode-line',
26739 `header-line', or `menu' respectively. */);
26740 mode_line_inverse_video
= 1;
26742 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26743 doc
: /* *Maximum buffer size for which line number should be displayed.
26744 If the buffer is bigger than this, the line number does not appear
26745 in the mode line. A value of nil means no limit. */);
26746 Vline_number_display_limit
= Qnil
;
26748 DEFVAR_INT ("line-number-display-limit-width",
26749 line_number_display_limit_width
,
26750 doc
: /* *Maximum line width (in characters) for line number display.
26751 If the average length of the lines near point is bigger than this, then the
26752 line number may be omitted from the mode line. */);
26753 line_number_display_limit_width
= 200;
26755 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26756 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26757 highlight_nonselected_windows
= 0;
26759 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26760 doc
: /* Non-nil if more than one frame is visible on this display.
26761 Minibuffer-only frames don't count, but iconified frames do.
26762 This variable is not guaranteed to be accurate except while processing
26763 `frame-title-format' and `icon-title-format'. */);
26765 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26766 doc
: /* Template for displaying the title bar of visible frames.
26767 \(Assuming the window manager supports this feature.)
26769 This variable has the same structure as `mode-line-format', except that
26770 the %c and %l constructs are ignored. It is used only on frames for
26771 which no explicit name has been set \(see `modify-frame-parameters'). */);
26773 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26774 doc
: /* Template for displaying the title bar of an iconified frame.
26775 \(Assuming the window manager supports this feature.)
26776 This variable has the same structure as `mode-line-format' (which see),
26777 and is used only on frames for which no explicit name has been set
26778 \(see `modify-frame-parameters'). */);
26780 = Vframe_title_format
26781 = pure_cons (intern_c_string ("multiple-frames"),
26782 pure_cons (make_pure_c_string ("%b"),
26783 pure_cons (pure_cons (empty_unibyte_string
,
26784 pure_cons (intern_c_string ("invocation-name"),
26785 pure_cons (make_pure_c_string ("@"),
26786 pure_cons (intern_c_string ("system-name"),
26790 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26791 doc
: /* Maximum number of lines to keep in the message log buffer.
26792 If nil, disable message logging. If t, log messages but don't truncate
26793 the buffer when it becomes large. */);
26794 Vmessage_log_max
= make_number (100);
26796 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26797 doc
: /* Functions called before redisplay, if window sizes have changed.
26798 The value should be a list of functions that take one argument.
26799 Just before redisplay, for each frame, if any of its windows have changed
26800 size since the last redisplay, or have been split or deleted,
26801 all the functions in the list are called, with the frame as argument. */);
26802 Vwindow_size_change_functions
= Qnil
;
26804 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26805 doc
: /* List of functions to call before redisplaying a window with scrolling.
26806 Each function is called with two arguments, the window and its new
26807 display-start position. Note that these functions are also called by
26808 `set-window-buffer'. Also note that the value of `window-end' is not
26809 valid when these functions are called. */);
26810 Vwindow_scroll_functions
= Qnil
;
26812 DEFVAR_LISP ("window-text-change-functions",
26813 Vwindow_text_change_functions
,
26814 doc
: /* Functions to call in redisplay when text in the window might change. */);
26815 Vwindow_text_change_functions
= Qnil
;
26817 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26818 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26819 Each function is called with two arguments, the window and the end trigger value.
26820 See `set-window-redisplay-end-trigger'. */);
26821 Vredisplay_end_trigger_functions
= Qnil
;
26823 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26824 doc
: /* *Non-nil means autoselect window with mouse pointer.
26825 If nil, do not autoselect windows.
26826 A positive number means delay autoselection by that many seconds: a
26827 window is autoselected only after the mouse has remained in that
26828 window for the duration of the delay.
26829 A negative number has a similar effect, but causes windows to be
26830 autoselected only after the mouse has stopped moving. \(Because of
26831 the way Emacs compares mouse events, you will occasionally wait twice
26832 that time before the window gets selected.\)
26833 Any other value means to autoselect window instantaneously when the
26834 mouse pointer enters it.
26836 Autoselection selects the minibuffer only if it is active, and never
26837 unselects the minibuffer if it is active.
26839 When customizing this variable make sure that the actual value of
26840 `focus-follows-mouse' matches the behavior of your window manager. */);
26841 Vmouse_autoselect_window
= Qnil
;
26843 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26844 doc
: /* *Non-nil means automatically resize tool-bars.
26845 This dynamically changes the tool-bar's height to the minimum height
26846 that is needed to make all tool-bar items visible.
26847 If value is `grow-only', the tool-bar's height is only increased
26848 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26849 Vauto_resize_tool_bars
= Qt
;
26851 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26852 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26853 auto_raise_tool_bar_buttons_p
= 1;
26855 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26856 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26857 make_cursor_line_fully_visible_p
= 1;
26859 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26860 doc
: /* *Border below tool-bar in pixels.
26861 If an integer, use it as the height of the border.
26862 If it is one of `internal-border-width' or `border-width', use the
26863 value of the corresponding frame parameter.
26864 Otherwise, no border is added below the tool-bar. */);
26865 Vtool_bar_border
= Qinternal_border_width
;
26867 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26868 doc
: /* *Margin around tool-bar buttons in pixels.
26869 If an integer, use that for both horizontal and vertical margins.
26870 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26871 HORZ specifying the horizontal margin, and VERT specifying the
26872 vertical margin. */);
26873 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26875 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26876 doc
: /* *Relief thickness of tool-bar buttons. */);
26877 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26879 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26880 doc
: /* Tool bar style to use.
26882 image - show images only
26883 text - show text only
26884 both - show both, text below image
26885 both-horiz - show text to the right of the image
26886 text-image-horiz - show text to the left of the image
26887 any other - use system default or image if no system default. */);
26888 Vtool_bar_style
= Qnil
;
26890 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26891 doc
: /* *Maximum number of characters a label can have to be shown.
26892 The tool bar style must also show labels for this to have any effect, see
26893 `tool-bar-style'. */);
26894 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26896 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26897 doc
: /* List of functions to call to fontify regions of text.
26898 Each function is called with one argument POS. Functions must
26899 fontify a region starting at POS in the current buffer, and give
26900 fontified regions the property `fontified'. */);
26901 Vfontification_functions
= Qnil
;
26902 Fmake_variable_buffer_local (Qfontification_functions
);
26904 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26905 unibyte_display_via_language_environment
,
26906 doc
: /* *Non-nil means display unibyte text according to language environment.
26907 Specifically, this means that raw bytes in the range 160-255 decimal
26908 are displayed by converting them to the equivalent multibyte characters
26909 according to the current language environment. As a result, they are
26910 displayed according to the current fontset.
26912 Note that this variable affects only how these bytes are displayed,
26913 but does not change the fact they are interpreted as raw bytes. */);
26914 unibyte_display_via_language_environment
= 0;
26916 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26917 doc
: /* *Maximum height for resizing mini-windows.
26918 If a float, it specifies a fraction of the mini-window frame's height.
26919 If an integer, it specifies a number of lines. */);
26920 Vmax_mini_window_height
= make_float (0.25);
26922 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26923 doc
: /* *How to resize mini-windows.
26924 A value of nil means don't automatically resize mini-windows.
26925 A value of t means resize them to fit the text displayed in them.
26926 A value of `grow-only', the default, means let mini-windows grow
26927 only, until their display becomes empty, at which point the windows
26928 go back to their normal size. */);
26929 Vresize_mini_windows
= Qgrow_only
;
26931 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26932 doc
: /* Alist specifying how to blink the cursor off.
26933 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26934 `cursor-type' frame-parameter or variable equals ON-STATE,
26935 comparing using `equal', Emacs uses OFF-STATE to specify
26936 how to blink it off. ON-STATE and OFF-STATE are values for
26937 the `cursor-type' frame parameter.
26939 If a frame's ON-STATE has no entry in this list,
26940 the frame's other specifications determine how to blink the cursor off. */);
26941 Vblink_cursor_alist
= Qnil
;
26943 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26944 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26945 If non-nil, windows are automatically scrolled horizontally to make
26946 point visible. */);
26947 automatic_hscrolling_p
= 1;
26948 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26949 staticpro (&Qauto_hscroll_mode
);
26951 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26952 doc
: /* *How many columns away from the window edge point is allowed to get
26953 before automatic hscrolling will horizontally scroll the window. */);
26954 hscroll_margin
= 5;
26956 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26957 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26958 When point is less than `hscroll-margin' columns from the window
26959 edge, automatic hscrolling will scroll the window by the amount of columns
26960 determined by this variable. If its value is a positive integer, scroll that
26961 many columns. If it's a positive floating-point number, it specifies the
26962 fraction of the window's width to scroll. If it's nil or zero, point will be
26963 centered horizontally after the scroll. Any other value, including negative
26964 numbers, are treated as if the value were zero.
26966 Automatic hscrolling always moves point outside the scroll margin, so if
26967 point was more than scroll step columns inside the margin, the window will
26968 scroll more than the value given by the scroll step.
26970 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26971 and `scroll-right' overrides this variable's effect. */);
26972 Vhscroll_step
= make_number (0);
26974 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26975 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26976 Bind this around calls to `message' to let it take effect. */);
26977 message_truncate_lines
= 0;
26979 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26980 doc
: /* Normal hook run to update the menu bar definitions.
26981 Redisplay runs this hook before it redisplays the menu bar.
26982 This is used to update submenus such as Buffers,
26983 whose contents depend on various data. */);
26984 Vmenu_bar_update_hook
= Qnil
;
26986 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26987 doc
: /* Frame for which we are updating a menu.
26988 The enable predicate for a menu binding should check this variable. */);
26989 Vmenu_updating_frame
= Qnil
;
26991 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26992 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26993 inhibit_menubar_update
= 0;
26995 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26996 doc
: /* Prefix prepended to all continuation lines at display time.
26997 The value may be a string, an image, or a stretch-glyph; it is
26998 interpreted in the same way as the value of a `display' text property.
27000 This variable is overridden by any `wrap-prefix' text or overlay
27003 To add a prefix to non-continuation lines, use `line-prefix'. */);
27004 Vwrap_prefix
= Qnil
;
27005 staticpro (&Qwrap_prefix
);
27006 Qwrap_prefix
= intern_c_string ("wrap-prefix");
27007 Fmake_variable_buffer_local (Qwrap_prefix
);
27009 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27010 doc
: /* Prefix prepended to all non-continuation lines at display time.
27011 The value may be a string, an image, or a stretch-glyph; it is
27012 interpreted in the same way as the value of a `display' text property.
27014 This variable is overridden by any `line-prefix' text or overlay
27017 To add a prefix to continuation lines, use `wrap-prefix'. */);
27018 Vline_prefix
= Qnil
;
27019 staticpro (&Qline_prefix
);
27020 Qline_prefix
= intern_c_string ("line-prefix");
27021 Fmake_variable_buffer_local (Qline_prefix
);
27023 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27024 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27025 inhibit_eval_during_redisplay
= 0;
27027 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27028 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27029 inhibit_free_realized_faces
= 0;
27032 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27033 doc
: /* Inhibit try_window_id display optimization. */);
27034 inhibit_try_window_id
= 0;
27036 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27037 doc
: /* Inhibit try_window_reusing display optimization. */);
27038 inhibit_try_window_reusing
= 0;
27040 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27041 doc
: /* Inhibit try_cursor_movement display optimization. */);
27042 inhibit_try_cursor_movement
= 0;
27043 #endif /* GLYPH_DEBUG */
27045 DEFVAR_INT ("overline-margin", overline_margin
,
27046 doc
: /* *Space between overline and text, in pixels.
27047 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27048 margin to the caracter height. */);
27049 overline_margin
= 2;
27051 DEFVAR_INT ("underline-minimum-offset",
27052 underline_minimum_offset
,
27053 doc
: /* Minimum distance between baseline and underline.
27054 This can improve legibility of underlined text at small font sizes,
27055 particularly when using variable `x-use-underline-position-properties'
27056 with fonts that specify an UNDERLINE_POSITION relatively close to the
27057 baseline. The default value is 1. */);
27058 underline_minimum_offset
= 1;
27060 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27061 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27062 This feature only works when on a window system that can change
27063 cursor shapes. */);
27064 display_hourglass_p
= 1;
27066 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27067 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27068 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27070 hourglass_atimer
= NULL
;
27071 hourglass_shown_p
= 0;
27073 DEFSYM (Qglyphless_char
, "glyphless-char");
27074 DEFSYM (Qhex_code
, "hex-code");
27075 DEFSYM (Qempty_box
, "empty-box");
27076 DEFSYM (Qthin_space
, "thin-space");
27077 DEFSYM (Qzero_width
, "zero-width");
27079 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27080 /* Intern this now in case it isn't already done.
27081 Setting this variable twice is harmless.
27082 But don't staticpro it here--that is done in alloc.c. */
27083 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27084 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27086 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27087 doc
: /* Char-table defining glyphless characters.
27088 Each element, if non-nil, should be one of the following:
27089 an ASCII acronym string: display this string in a box
27090 `hex-code': display the hexadecimal code of a character in a box
27091 `empty-box': display as an empty box
27092 `thin-space': display as 1-pixel width space
27093 `zero-width': don't display
27094 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27095 display method for graphical terminals and text terminals respectively.
27096 GRAPHICAL and TEXT should each have one of the values listed above.
27098 The char-table has one extra slot to control the display of a character for
27099 which no font is found. This slot only takes effect on graphical terminals.
27100 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27101 `thin-space'. The default is `empty-box'. */);
27102 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27103 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27108 /* Initialize this module when Emacs starts. */
27113 current_header_line_height
= current_mode_line_height
= -1;
27115 CHARPOS (this_line_start_pos
) = 0;
27117 if (!noninteractive
)
27119 struct window
*m
= XWINDOW (minibuf_window
);
27120 Lisp_Object frame
= m
->frame
;
27121 struct frame
*f
= XFRAME (frame
);
27122 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27123 struct window
*r
= XWINDOW (root
);
27126 echo_area_window
= minibuf_window
;
27128 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27129 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27130 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27131 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27132 XSETFASTINT (m
->total_lines
, 1);
27133 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27135 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27136 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27137 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27139 /* The default ellipsis glyphs `...'. */
27140 for (i
= 0; i
< 3; ++i
)
27141 default_invis_vector
[i
] = make_number ('.');
27145 /* Allocate the buffer for frame titles.
27146 Also used for `format-mode-line'. */
27148 mode_line_noprop_buf
= (char *) xmalloc (size
);
27149 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27150 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27151 mode_line_target
= MODE_LINE_DISPLAY
;
27154 help_echo_showing_p
= 0;
27157 /* Since w32 does not support atimers, it defines its own implementation of
27158 the following three functions in w32fns.c. */
27161 /* Platform-independent portion of hourglass implementation. */
27163 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27165 hourglass_started (void)
27167 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27170 /* Cancel a currently active hourglass timer, and start a new one. */
27172 start_hourglass (void)
27174 #if defined (HAVE_WINDOW_SYSTEM)
27176 int secs
, usecs
= 0;
27178 cancel_hourglass ();
27180 if (INTEGERP (Vhourglass_delay
)
27181 && XINT (Vhourglass_delay
) > 0)
27182 secs
= XFASTINT (Vhourglass_delay
);
27183 else if (FLOATP (Vhourglass_delay
)
27184 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27187 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27188 secs
= XFASTINT (tem
);
27189 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27192 secs
= DEFAULT_HOURGLASS_DELAY
;
27194 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27195 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27196 show_hourglass
, NULL
);
27201 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27204 cancel_hourglass (void)
27206 #if defined (HAVE_WINDOW_SYSTEM)
27207 if (hourglass_atimer
)
27209 cancel_atimer (hourglass_atimer
);
27210 hourglass_atimer
= NULL
;
27213 if (hourglass_shown_p
)
27217 #endif /* ! WINDOWSNT */