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 unsigned long int 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
;
8067 unsigned long int dups
;
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);
8093 /* If you change this format, don't forget to also
8094 change message_log_check_duplicate. */
8095 sprintf (dupstr
, " [%lu times]", dups
);
8096 duplen
= strlen (dupstr
);
8097 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8098 insert_1 (dupstr
, duplen
, 1, 0, 1);
8103 /* If we have more than the desired maximum number of lines
8104 in the *Messages* buffer now, delete the oldest ones.
8105 This is safe because we don't have undo in this buffer. */
8107 if (NATNUMP (Vmessage_log_max
))
8109 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8110 -XFASTINT (Vmessage_log_max
) - 1, 0);
8111 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8114 BEGV
= XMARKER (oldbegv
)->charpos
;
8115 BEGV_BYTE
= marker_byte_position (oldbegv
);
8124 ZV
= XMARKER (oldzv
)->charpos
;
8125 ZV_BYTE
= marker_byte_position (oldzv
);
8129 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8131 /* We can't do Fgoto_char (oldpoint) because it will run some
8133 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8134 XMARKER (oldpoint
)->bytepos
);
8137 unchain_marker (XMARKER (oldpoint
));
8138 unchain_marker (XMARKER (oldbegv
));
8139 unchain_marker (XMARKER (oldzv
));
8141 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8142 set_buffer_internal (oldbuf
);
8144 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8145 message_log_need_newline
= !nlflag
;
8146 Vdeactivate_mark
= old_deactivate_mark
;
8151 /* We are at the end of the buffer after just having inserted a newline.
8152 (Note: We depend on the fact we won't be crossing the gap.)
8153 Check to see if the most recent message looks a lot like the previous one.
8154 Return 0 if different, 1 if the new one should just replace it, or a
8155 value N > 1 if we should also append " [N times]". */
8157 static unsigned long int
8158 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8161 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8163 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8164 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8166 for (i
= 0; i
< len
; i
++)
8168 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8176 if (*p1
++ == ' ' && *p1
++ == '[')
8179 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8180 if (strncmp (pend
, " times]\n", 8) == 0)
8187 /* Display an echo area message M with a specified length of NBYTES
8188 bytes. The string may include null characters. If M is 0, clear
8189 out any existing message, and let the mini-buffer text show
8192 This may GC, so the buffer M must NOT point to a Lisp string. */
8195 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8197 /* First flush out any partial line written with print. */
8198 message_log_maybe_newline ();
8200 message_dolog (m
, nbytes
, 1, multibyte
);
8201 message2_nolog (m
, nbytes
, multibyte
);
8205 /* The non-logging counterpart of message2. */
8208 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8210 struct frame
*sf
= SELECTED_FRAME ();
8211 message_enable_multibyte
= multibyte
;
8213 if (FRAME_INITIAL_P (sf
))
8215 if (noninteractive_need_newline
)
8216 putc ('\n', stderr
);
8217 noninteractive_need_newline
= 0;
8219 fwrite (m
, nbytes
, 1, stderr
);
8220 if (cursor_in_echo_area
== 0)
8221 fprintf (stderr
, "\n");
8224 /* A null message buffer means that the frame hasn't really been
8225 initialized yet. Error messages get reported properly by
8226 cmd_error, so this must be just an informative message; toss it. */
8227 else if (INTERACTIVE
8228 && sf
->glyphs_initialized_p
8229 && FRAME_MESSAGE_BUF (sf
))
8231 Lisp_Object mini_window
;
8234 /* Get the frame containing the mini-buffer
8235 that the selected frame is using. */
8236 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8237 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8239 FRAME_SAMPLE_VISIBILITY (f
);
8240 if (FRAME_VISIBLE_P (sf
)
8241 && ! FRAME_VISIBLE_P (f
))
8242 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8246 set_message (m
, Qnil
, nbytes
, multibyte
);
8247 if (minibuffer_auto_raise
)
8248 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8251 clear_message (1, 1);
8253 do_pending_window_change (0);
8254 echo_area_display (1);
8255 do_pending_window_change (0);
8256 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8257 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8262 /* Display an echo area message M with a specified length of NBYTES
8263 bytes. The string may include null characters. If M is not a
8264 string, clear out any existing message, and let the mini-buffer
8267 This function cancels echoing. */
8270 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8272 struct gcpro gcpro1
;
8275 clear_message (1,1);
8278 /* First flush out any partial line written with print. */
8279 message_log_maybe_newline ();
8285 SAFE_ALLOCA (buffer
, char *, nbytes
);
8286 memcpy (buffer
, SDATA (m
), nbytes
);
8287 message_dolog (buffer
, nbytes
, 1, multibyte
);
8290 message3_nolog (m
, nbytes
, multibyte
);
8296 /* The non-logging version of message3.
8297 This does not cancel echoing, because it is used for echoing.
8298 Perhaps we need to make a separate function for echoing
8299 and make this cancel echoing. */
8302 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8304 struct frame
*sf
= SELECTED_FRAME ();
8305 message_enable_multibyte
= multibyte
;
8307 if (FRAME_INITIAL_P (sf
))
8309 if (noninteractive_need_newline
)
8310 putc ('\n', stderr
);
8311 noninteractive_need_newline
= 0;
8313 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8314 if (cursor_in_echo_area
== 0)
8315 fprintf (stderr
, "\n");
8318 /* A null message buffer means that the frame hasn't really been
8319 initialized yet. Error messages get reported properly by
8320 cmd_error, so this must be just an informative message; toss it. */
8321 else if (INTERACTIVE
8322 && sf
->glyphs_initialized_p
8323 && FRAME_MESSAGE_BUF (sf
))
8325 Lisp_Object mini_window
;
8329 /* Get the frame containing the mini-buffer
8330 that the selected frame is using. */
8331 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8332 frame
= XWINDOW (mini_window
)->frame
;
8335 FRAME_SAMPLE_VISIBILITY (f
);
8336 if (FRAME_VISIBLE_P (sf
)
8337 && !FRAME_VISIBLE_P (f
))
8338 Fmake_frame_visible (frame
);
8340 if (STRINGP (m
) && SCHARS (m
) > 0)
8342 set_message (NULL
, m
, nbytes
, multibyte
);
8343 if (minibuffer_auto_raise
)
8344 Fraise_frame (frame
);
8345 /* Assume we are not echoing.
8346 (If we are, echo_now will override this.) */
8347 echo_message_buffer
= Qnil
;
8350 clear_message (1, 1);
8352 do_pending_window_change (0);
8353 echo_area_display (1);
8354 do_pending_window_change (0);
8355 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8356 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8361 /* Display a null-terminated echo area message M. If M is 0, clear
8362 out any existing message, and let the mini-buffer text show through.
8364 The buffer M must continue to exist until after the echo area gets
8365 cleared or some other message gets displayed there. Do not pass
8366 text that is stored in a Lisp string. Do not pass text in a buffer
8367 that was alloca'd. */
8370 message1 (const char *m
)
8372 message2 (m
, (m
? strlen (m
) : 0), 0);
8376 /* The non-logging counterpart of message1. */
8379 message1_nolog (const char *m
)
8381 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8384 /* Display a message M which contains a single %s
8385 which gets replaced with STRING. */
8388 message_with_string (const char *m
, Lisp_Object string
, int log
)
8390 CHECK_STRING (string
);
8396 if (noninteractive_need_newline
)
8397 putc ('\n', stderr
);
8398 noninteractive_need_newline
= 0;
8399 fprintf (stderr
, m
, SDATA (string
));
8400 if (!cursor_in_echo_area
)
8401 fprintf (stderr
, "\n");
8405 else if (INTERACTIVE
)
8407 /* The frame whose minibuffer we're going to display the message on.
8408 It may be larger than the selected frame, so we need
8409 to use its buffer, not the selected frame's buffer. */
8410 Lisp_Object mini_window
;
8411 struct frame
*f
, *sf
= SELECTED_FRAME ();
8413 /* Get the frame containing the minibuffer
8414 that the selected frame is using. */
8415 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8416 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8418 /* A null message buffer means that the frame hasn't really been
8419 initialized yet. Error messages get reported properly by
8420 cmd_error, so this must be just an informative message; toss it. */
8421 if (FRAME_MESSAGE_BUF (f
))
8423 Lisp_Object args
[2], msg
;
8424 struct gcpro gcpro1
, gcpro2
;
8426 args
[0] = build_string (m
);
8427 args
[1] = msg
= string
;
8428 GCPRO2 (args
[0], msg
);
8431 msg
= Fformat (2, args
);
8434 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8436 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8440 /* Print should start at the beginning of the message
8441 buffer next time. */
8442 message_buf_print
= 0;
8448 /* Dump an informative message to the minibuf. If M is 0, clear out
8449 any existing message, and let the mini-buffer text show through. */
8452 vmessage (const char *m
, va_list ap
)
8458 if (noninteractive_need_newline
)
8459 putc ('\n', stderr
);
8460 noninteractive_need_newline
= 0;
8461 vfprintf (stderr
, m
, ap
);
8462 if (cursor_in_echo_area
== 0)
8463 fprintf (stderr
, "\n");
8467 else if (INTERACTIVE
)
8469 /* The frame whose mini-buffer we're going to display the message
8470 on. It may be larger than the selected frame, so we need to
8471 use its buffer, not the selected frame's buffer. */
8472 Lisp_Object mini_window
;
8473 struct frame
*f
, *sf
= SELECTED_FRAME ();
8475 /* Get the frame containing the mini-buffer
8476 that the selected frame is using. */
8477 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8478 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8480 /* A null message buffer means that the frame hasn't really been
8481 initialized yet. Error messages get reported properly by
8482 cmd_error, so this must be just an informative message; toss
8484 if (FRAME_MESSAGE_BUF (f
))
8490 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8491 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8493 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8498 /* Print should start at the beginning of the message
8499 buffer next time. */
8500 message_buf_print
= 0;
8506 message (const char *m
, ...)
8516 /* The non-logging version of message. */
8519 message_nolog (const char *m
, ...)
8521 Lisp_Object old_log_max
;
8524 old_log_max
= Vmessage_log_max
;
8525 Vmessage_log_max
= Qnil
;
8527 Vmessage_log_max
= old_log_max
;
8533 /* Display the current message in the current mini-buffer. This is
8534 only called from error handlers in process.c, and is not time
8538 update_echo_area (void)
8540 if (!NILP (echo_area_buffer
[0]))
8543 string
= Fcurrent_message ();
8544 message3 (string
, SBYTES (string
),
8545 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8550 /* Make sure echo area buffers in `echo_buffers' are live.
8551 If they aren't, make new ones. */
8554 ensure_echo_area_buffers (void)
8558 for (i
= 0; i
< 2; ++i
)
8559 if (!BUFFERP (echo_buffer
[i
])
8560 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8563 Lisp_Object old_buffer
;
8566 old_buffer
= echo_buffer
[i
];
8567 sprintf (name
, " *Echo Area %d*", i
);
8568 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8569 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8570 /* to force word wrap in echo area -
8571 it was decided to postpone this*/
8572 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8574 for (j
= 0; j
< 2; ++j
)
8575 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8576 echo_area_buffer
[j
] = echo_buffer
[i
];
8581 /* Call FN with args A1..A4 with either the current or last displayed
8582 echo_area_buffer as current buffer.
8584 WHICH zero means use the current message buffer
8585 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8586 from echo_buffer[] and clear it.
8588 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8589 suitable buffer from echo_buffer[] and clear it.
8591 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8592 that the current message becomes the last displayed one, make
8593 choose a suitable buffer for echo_area_buffer[0], and clear it.
8595 Value is what FN returns. */
8598 with_echo_area_buffer (struct window
*w
, int which
,
8599 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8600 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8603 int this_one
, the_other
, clear_buffer_p
, rc
;
8604 int count
= SPECPDL_INDEX ();
8606 /* If buffers aren't live, make new ones. */
8607 ensure_echo_area_buffers ();
8612 this_one
= 0, the_other
= 1;
8614 this_one
= 1, the_other
= 0;
8617 this_one
= 0, the_other
= 1;
8620 /* We need a fresh one in case the current echo buffer equals
8621 the one containing the last displayed echo area message. */
8622 if (!NILP (echo_area_buffer
[this_one
])
8623 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8624 echo_area_buffer
[this_one
] = Qnil
;
8627 /* Choose a suitable buffer from echo_buffer[] is we don't
8629 if (NILP (echo_area_buffer
[this_one
]))
8631 echo_area_buffer
[this_one
]
8632 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8633 ? echo_buffer
[the_other
]
8634 : echo_buffer
[this_one
]);
8638 buffer
= echo_area_buffer
[this_one
];
8640 /* Don't get confused by reusing the buffer used for echoing
8641 for a different purpose. */
8642 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8645 record_unwind_protect (unwind_with_echo_area_buffer
,
8646 with_echo_area_buffer_unwind_data (w
));
8648 /* Make the echo area buffer current. Note that for display
8649 purposes, it is not necessary that the displayed window's buffer
8650 == current_buffer, except for text property lookup. So, let's
8651 only set that buffer temporarily here without doing a full
8652 Fset_window_buffer. We must also change w->pointm, though,
8653 because otherwise an assertions in unshow_buffer fails, and Emacs
8655 set_buffer_internal_1 (XBUFFER (buffer
));
8659 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8662 BVAR (current_buffer
, undo_list
) = Qt
;
8663 BVAR (current_buffer
, read_only
) = Qnil
;
8664 specbind (Qinhibit_read_only
, Qt
);
8665 specbind (Qinhibit_modification_hooks
, Qt
);
8667 if (clear_buffer_p
&& Z
> BEG
)
8670 xassert (BEGV
>= BEG
);
8671 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8673 rc
= fn (a1
, a2
, a3
, a4
);
8675 xassert (BEGV
>= BEG
);
8676 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8678 unbind_to (count
, Qnil
);
8683 /* Save state that should be preserved around the call to the function
8684 FN called in with_echo_area_buffer. */
8687 with_echo_area_buffer_unwind_data (struct window
*w
)
8690 Lisp_Object vector
, tmp
;
8692 /* Reduce consing by keeping one vector in
8693 Vwith_echo_area_save_vector. */
8694 vector
= Vwith_echo_area_save_vector
;
8695 Vwith_echo_area_save_vector
= Qnil
;
8698 vector
= Fmake_vector (make_number (7), Qnil
);
8700 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8701 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8702 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8706 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8707 ASET (vector
, i
, w
->buffer
); ++i
;
8708 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8709 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8714 for (; i
< end
; ++i
)
8715 ASET (vector
, i
, Qnil
);
8718 xassert (i
== ASIZE (vector
));
8723 /* Restore global state from VECTOR which was created by
8724 with_echo_area_buffer_unwind_data. */
8727 unwind_with_echo_area_buffer (Lisp_Object vector
)
8729 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8730 Vdeactivate_mark
= AREF (vector
, 1);
8731 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8733 if (WINDOWP (AREF (vector
, 3)))
8736 Lisp_Object buffer
, charpos
, bytepos
;
8738 w
= XWINDOW (AREF (vector
, 3));
8739 buffer
= AREF (vector
, 4);
8740 charpos
= AREF (vector
, 5);
8741 bytepos
= AREF (vector
, 6);
8744 set_marker_both (w
->pointm
, buffer
,
8745 XFASTINT (charpos
), XFASTINT (bytepos
));
8748 Vwith_echo_area_save_vector
= vector
;
8753 /* Set up the echo area for use by print functions. MULTIBYTE_P
8754 non-zero means we will print multibyte. */
8757 setup_echo_area_for_printing (int multibyte_p
)
8759 /* If we can't find an echo area any more, exit. */
8760 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8763 ensure_echo_area_buffers ();
8765 if (!message_buf_print
)
8767 /* A message has been output since the last time we printed.
8768 Choose a fresh echo area buffer. */
8769 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8770 echo_area_buffer
[0] = echo_buffer
[1];
8772 echo_area_buffer
[0] = echo_buffer
[0];
8774 /* Switch to that buffer and clear it. */
8775 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8776 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8780 int count
= SPECPDL_INDEX ();
8781 specbind (Qinhibit_read_only
, Qt
);
8782 /* Note that undo recording is always disabled. */
8784 unbind_to (count
, Qnil
);
8786 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8788 /* Set up the buffer for the multibyteness we need. */
8790 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8791 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8793 /* Raise the frame containing the echo area. */
8794 if (minibuffer_auto_raise
)
8796 struct frame
*sf
= SELECTED_FRAME ();
8797 Lisp_Object mini_window
;
8798 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8799 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8802 message_log_maybe_newline ();
8803 message_buf_print
= 1;
8807 if (NILP (echo_area_buffer
[0]))
8809 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8810 echo_area_buffer
[0] = echo_buffer
[1];
8812 echo_area_buffer
[0] = echo_buffer
[0];
8815 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8817 /* Someone switched buffers between print requests. */
8818 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8819 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8825 /* Display an echo area message in window W. Value is non-zero if W's
8826 height is changed. If display_last_displayed_message_p is
8827 non-zero, display the message that was last displayed, otherwise
8828 display the current message. */
8831 display_echo_area (struct window
*w
)
8833 int i
, no_message_p
, window_height_changed_p
, count
;
8835 /* Temporarily disable garbage collections while displaying the echo
8836 area. This is done because a GC can print a message itself.
8837 That message would modify the echo area buffer's contents while a
8838 redisplay of the buffer is going on, and seriously confuse
8840 count
= inhibit_garbage_collection ();
8842 /* If there is no message, we must call display_echo_area_1
8843 nevertheless because it resizes the window. But we will have to
8844 reset the echo_area_buffer in question to nil at the end because
8845 with_echo_area_buffer will sets it to an empty buffer. */
8846 i
= display_last_displayed_message_p
? 1 : 0;
8847 no_message_p
= NILP (echo_area_buffer
[i
]);
8849 window_height_changed_p
8850 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8851 display_echo_area_1
,
8852 (intptr_t) w
, Qnil
, 0, 0);
8855 echo_area_buffer
[i
] = Qnil
;
8857 unbind_to (count
, Qnil
);
8858 return window_height_changed_p
;
8862 /* Helper for display_echo_area. Display the current buffer which
8863 contains the current echo area message in window W, a mini-window,
8864 a pointer to which is passed in A1. A2..A4 are currently not used.
8865 Change the height of W so that all of the message is displayed.
8866 Value is non-zero if height of W was changed. */
8869 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8872 struct window
*w
= (struct window
*) i1
;
8874 struct text_pos start
;
8875 int window_height_changed_p
= 0;
8877 /* Do this before displaying, so that we have a large enough glyph
8878 matrix for the display. If we can't get enough space for the
8879 whole text, display the last N lines. That works by setting w->start. */
8880 window_height_changed_p
= resize_mini_window (w
, 0);
8882 /* Use the starting position chosen by resize_mini_window. */
8883 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8886 clear_glyph_matrix (w
->desired_matrix
);
8887 XSETWINDOW (window
, w
);
8888 try_window (window
, start
, 0);
8890 return window_height_changed_p
;
8894 /* Resize the echo area window to exactly the size needed for the
8895 currently displayed message, if there is one. If a mini-buffer
8896 is active, don't shrink it. */
8899 resize_echo_area_exactly (void)
8901 if (BUFFERP (echo_area_buffer
[0])
8902 && WINDOWP (echo_area_window
))
8904 struct window
*w
= XWINDOW (echo_area_window
);
8906 Lisp_Object resize_exactly
;
8908 if (minibuf_level
== 0)
8909 resize_exactly
= Qt
;
8911 resize_exactly
= Qnil
;
8913 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8914 (intptr_t) w
, resize_exactly
,
8918 ++windows_or_buffers_changed
;
8919 ++update_mode_lines
;
8920 redisplay_internal ();
8926 /* Callback function for with_echo_area_buffer, when used from
8927 resize_echo_area_exactly. A1 contains a pointer to the window to
8928 resize, EXACTLY non-nil means resize the mini-window exactly to the
8929 size of the text displayed. A3 and A4 are not used. Value is what
8930 resize_mini_window returns. */
8933 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8936 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
8940 /* Resize mini-window W to fit the size of its contents. EXACT_P
8941 means size the window exactly to the size needed. Otherwise, it's
8942 only enlarged until W's buffer is empty.
8944 Set W->start to the right place to begin display. If the whole
8945 contents fit, start at the beginning. Otherwise, start so as
8946 to make the end of the contents appear. This is particularly
8947 important for y-or-n-p, but seems desirable generally.
8949 Value is non-zero if the window height has been changed. */
8952 resize_mini_window (struct window
*w
, int exact_p
)
8954 struct frame
*f
= XFRAME (w
->frame
);
8955 int window_height_changed_p
= 0;
8957 xassert (MINI_WINDOW_P (w
));
8959 /* By default, start display at the beginning. */
8960 set_marker_both (w
->start
, w
->buffer
,
8961 BUF_BEGV (XBUFFER (w
->buffer
)),
8962 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8964 /* Don't resize windows while redisplaying a window; it would
8965 confuse redisplay functions when the size of the window they are
8966 displaying changes from under them. Such a resizing can happen,
8967 for instance, when which-func prints a long message while
8968 we are running fontification-functions. We're running these
8969 functions with safe_call which binds inhibit-redisplay to t. */
8970 if (!NILP (Vinhibit_redisplay
))
8973 /* Nil means don't try to resize. */
8974 if (NILP (Vresize_mini_windows
)
8975 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8978 if (!FRAME_MINIBUF_ONLY_P (f
))
8981 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8982 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8983 int height
, max_height
;
8984 int unit
= FRAME_LINE_HEIGHT (f
);
8985 struct text_pos start
;
8986 struct buffer
*old_current_buffer
= NULL
;
8988 if (current_buffer
!= XBUFFER (w
->buffer
))
8990 old_current_buffer
= current_buffer
;
8991 set_buffer_internal (XBUFFER (w
->buffer
));
8994 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8996 /* Compute the max. number of lines specified by the user. */
8997 if (FLOATP (Vmax_mini_window_height
))
8998 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8999 else if (INTEGERP (Vmax_mini_window_height
))
9000 max_height
= XINT (Vmax_mini_window_height
);
9002 max_height
= total_height
/ 4;
9004 /* Correct that max. height if it's bogus. */
9005 max_height
= max (1, max_height
);
9006 max_height
= min (total_height
, max_height
);
9008 /* Find out the height of the text in the window. */
9009 if (it
.line_wrap
== TRUNCATE
)
9014 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9015 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9016 height
= it
.current_y
+ last_height
;
9018 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9019 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9020 height
= (height
+ unit
- 1) / unit
;
9023 /* Compute a suitable window start. */
9024 if (height
> max_height
)
9026 height
= max_height
;
9027 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9028 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9029 start
= it
.current
.pos
;
9032 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9033 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9035 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9037 /* Let it grow only, until we display an empty message, in which
9038 case the window shrinks again. */
9039 if (height
> WINDOW_TOTAL_LINES (w
))
9041 int old_height
= WINDOW_TOTAL_LINES (w
);
9042 freeze_window_starts (f
, 1);
9043 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9044 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9046 else if (height
< WINDOW_TOTAL_LINES (w
)
9047 && (exact_p
|| BEGV
== ZV
))
9049 int old_height
= WINDOW_TOTAL_LINES (w
);
9050 freeze_window_starts (f
, 0);
9051 shrink_mini_window (w
);
9052 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9057 /* Always resize to exact size needed. */
9058 if (height
> WINDOW_TOTAL_LINES (w
))
9060 int old_height
= WINDOW_TOTAL_LINES (w
);
9061 freeze_window_starts (f
, 1);
9062 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9063 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9065 else if (height
< WINDOW_TOTAL_LINES (w
))
9067 int old_height
= WINDOW_TOTAL_LINES (w
);
9068 freeze_window_starts (f
, 0);
9069 shrink_mini_window (w
);
9073 freeze_window_starts (f
, 1);
9074 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9077 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9081 if (old_current_buffer
)
9082 set_buffer_internal (old_current_buffer
);
9085 return window_height_changed_p
;
9089 /* Value is the current message, a string, or nil if there is no
9093 current_message (void)
9097 if (!BUFFERP (echo_area_buffer
[0]))
9101 with_echo_area_buffer (0, 0, current_message_1
,
9102 (intptr_t) &msg
, Qnil
, 0, 0);
9104 echo_area_buffer
[0] = Qnil
;
9112 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9115 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9118 *msg
= make_buffer_string (BEG
, Z
, 1);
9125 /* Push the current message on Vmessage_stack for later restauration
9126 by restore_message. Value is non-zero if the current message isn't
9127 empty. This is a relatively infrequent operation, so it's not
9128 worth optimizing. */
9134 msg
= current_message ();
9135 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9136 return STRINGP (msg
);
9140 /* Restore message display from the top of Vmessage_stack. */
9143 restore_message (void)
9147 xassert (CONSP (Vmessage_stack
));
9148 msg
= XCAR (Vmessage_stack
);
9150 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9152 message3_nolog (msg
, 0, 0);
9156 /* Handler for record_unwind_protect calling pop_message. */
9159 pop_message_unwind (Lisp_Object dummy
)
9165 /* Pop the top-most entry off Vmessage_stack. */
9170 xassert (CONSP (Vmessage_stack
));
9171 Vmessage_stack
= XCDR (Vmessage_stack
);
9175 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9176 exits. If the stack is not empty, we have a missing pop_message
9180 check_message_stack (void)
9182 if (!NILP (Vmessage_stack
))
9187 /* Truncate to NCHARS what will be displayed in the echo area the next
9188 time we display it---but don't redisplay it now. */
9191 truncate_echo_area (EMACS_INT nchars
)
9194 echo_area_buffer
[0] = Qnil
;
9195 /* A null message buffer means that the frame hasn't really been
9196 initialized yet. Error messages get reported properly by
9197 cmd_error, so this must be just an informative message; toss it. */
9198 else if (!noninteractive
9200 && !NILP (echo_area_buffer
[0]))
9202 struct frame
*sf
= SELECTED_FRAME ();
9203 if (FRAME_MESSAGE_BUF (sf
))
9204 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9209 /* Helper function for truncate_echo_area. Truncate the current
9210 message to at most NCHARS characters. */
9213 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9215 if (BEG
+ nchars
< Z
)
9216 del_range (BEG
+ nchars
, Z
);
9218 echo_area_buffer
[0] = Qnil
;
9223 /* Set the current message to a substring of S or STRING.
9225 If STRING is a Lisp string, set the message to the first NBYTES
9226 bytes from STRING. NBYTES zero means use the whole string. If
9227 STRING is multibyte, the message will be displayed multibyte.
9229 If S is not null, set the message to the first LEN bytes of S. LEN
9230 zero means use the whole string. MULTIBYTE_P non-zero means S is
9231 multibyte. Display the message multibyte in that case.
9233 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9234 to t before calling set_message_1 (which calls insert).
9238 set_message (const char *s
, Lisp_Object string
,
9239 EMACS_INT nbytes
, int multibyte_p
)
9241 message_enable_multibyte
9242 = ((s
&& multibyte_p
)
9243 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9245 with_echo_area_buffer (0, -1, set_message_1
,
9246 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9247 message_buf_print
= 0;
9248 help_echo_showing_p
= 0;
9252 /* Helper function for set_message. Arguments have the same meaning
9253 as there, with A1 corresponding to S and A2 corresponding to STRING
9254 This function is called with the echo area buffer being
9258 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9261 const char *s
= (const char *) i1
;
9262 const unsigned char *msg
= (const unsigned char *) s
;
9263 Lisp_Object string
= a2
;
9265 /* Change multibyteness of the echo buffer appropriately. */
9266 if (message_enable_multibyte
9267 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9268 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9270 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9271 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9272 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9274 /* Insert new message at BEG. */
9275 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9277 if (STRINGP (string
))
9282 nbytes
= SBYTES (string
);
9283 nchars
= string_byte_to_char (string
, nbytes
);
9285 /* This function takes care of single/multibyte conversion. We
9286 just have to ensure that the echo area buffer has the right
9287 setting of enable_multibyte_characters. */
9288 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9293 nbytes
= strlen (s
);
9295 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9297 /* Convert from multi-byte to single-byte. */
9302 /* Convert a multibyte string to single-byte. */
9303 for (i
= 0; i
< nbytes
; i
+= n
)
9305 c
= string_char_and_length (msg
+ i
, &n
);
9306 work
[0] = (ASCII_CHAR_P (c
)
9308 : multibyte_char_to_unibyte (c
));
9309 insert_1_both (work
, 1, 1, 1, 0, 0);
9312 else if (!multibyte_p
9313 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9315 /* Convert from single-byte to multi-byte. */
9318 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9320 /* Convert a single-byte string to multibyte. */
9321 for (i
= 0; i
< nbytes
; i
++)
9324 MAKE_CHAR_MULTIBYTE (c
);
9325 n
= CHAR_STRING (c
, str
);
9326 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9330 insert_1 (s
, nbytes
, 1, 0, 0);
9337 /* Clear messages. CURRENT_P non-zero means clear the current
9338 message. LAST_DISPLAYED_P non-zero means clear the message
9342 clear_message (int current_p
, int last_displayed_p
)
9346 echo_area_buffer
[0] = Qnil
;
9347 message_cleared_p
= 1;
9350 if (last_displayed_p
)
9351 echo_area_buffer
[1] = Qnil
;
9353 message_buf_print
= 0;
9356 /* Clear garbaged frames.
9358 This function is used where the old redisplay called
9359 redraw_garbaged_frames which in turn called redraw_frame which in
9360 turn called clear_frame. The call to clear_frame was a source of
9361 flickering. I believe a clear_frame is not necessary. It should
9362 suffice in the new redisplay to invalidate all current matrices,
9363 and ensure a complete redisplay of all windows. */
9366 clear_garbaged_frames (void)
9370 Lisp_Object tail
, frame
;
9371 int changed_count
= 0;
9373 FOR_EACH_FRAME (tail
, frame
)
9375 struct frame
*f
= XFRAME (frame
);
9377 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9381 Fredraw_frame (frame
);
9382 f
->force_flush_display_p
= 1;
9384 clear_current_matrices (f
);
9393 ++windows_or_buffers_changed
;
9398 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9399 is non-zero update selected_frame. Value is non-zero if the
9400 mini-windows height has been changed. */
9403 echo_area_display (int update_frame_p
)
9405 Lisp_Object mini_window
;
9408 int window_height_changed_p
= 0;
9409 struct frame
*sf
= SELECTED_FRAME ();
9411 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9412 w
= XWINDOW (mini_window
);
9413 f
= XFRAME (WINDOW_FRAME (w
));
9415 /* Don't display if frame is invisible or not yet initialized. */
9416 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9419 #ifdef HAVE_WINDOW_SYSTEM
9420 /* When Emacs starts, selected_frame may be the initial terminal
9421 frame. If we let this through, a message would be displayed on
9423 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9425 #endif /* HAVE_WINDOW_SYSTEM */
9427 /* Redraw garbaged frames. */
9429 clear_garbaged_frames ();
9431 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9433 echo_area_window
= mini_window
;
9434 window_height_changed_p
= display_echo_area (w
);
9435 w
->must_be_updated_p
= 1;
9437 /* Update the display, unless called from redisplay_internal.
9438 Also don't update the screen during redisplay itself. The
9439 update will happen at the end of redisplay, and an update
9440 here could cause confusion. */
9441 if (update_frame_p
&& !redisplaying_p
)
9445 /* If the display update has been interrupted by pending
9446 input, update mode lines in the frame. Due to the
9447 pending input, it might have been that redisplay hasn't
9448 been called, so that mode lines above the echo area are
9449 garbaged. This looks odd, so we prevent it here. */
9450 if (!display_completed
)
9451 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9453 if (window_height_changed_p
9454 /* Don't do this if Emacs is shutting down. Redisplay
9455 needs to run hooks. */
9456 && !NILP (Vrun_hooks
))
9458 /* Must update other windows. Likewise as in other
9459 cases, don't let this update be interrupted by
9461 int count
= SPECPDL_INDEX ();
9462 specbind (Qredisplay_dont_pause
, Qt
);
9463 windows_or_buffers_changed
= 1;
9464 redisplay_internal ();
9465 unbind_to (count
, Qnil
);
9467 else if (FRAME_WINDOW_P (f
) && n
== 0)
9469 /* Window configuration is the same as before.
9470 Can do with a display update of the echo area,
9471 unless we displayed some mode lines. */
9472 update_single_window (w
, 1);
9473 FRAME_RIF (f
)->flush_display (f
);
9476 update_frame (f
, 1, 1);
9478 /* If cursor is in the echo area, make sure that the next
9479 redisplay displays the minibuffer, so that the cursor will
9480 be replaced with what the minibuffer wants. */
9481 if (cursor_in_echo_area
)
9482 ++windows_or_buffers_changed
;
9485 else if (!EQ (mini_window
, selected_window
))
9486 windows_or_buffers_changed
++;
9488 /* Last displayed message is now the current message. */
9489 echo_area_buffer
[1] = echo_area_buffer
[0];
9490 /* Inform read_char that we're not echoing. */
9491 echo_message_buffer
= Qnil
;
9493 /* Prevent redisplay optimization in redisplay_internal by resetting
9494 this_line_start_pos. This is done because the mini-buffer now
9495 displays the message instead of its buffer text. */
9496 if (EQ (mini_window
, selected_window
))
9497 CHARPOS (this_line_start_pos
) = 0;
9499 return window_height_changed_p
;
9504 /***********************************************************************
9505 Mode Lines and Frame Titles
9506 ***********************************************************************/
9508 /* A buffer for constructing non-propertized mode-line strings and
9509 frame titles in it; allocated from the heap in init_xdisp and
9510 resized as needed in store_mode_line_noprop_char. */
9512 static char *mode_line_noprop_buf
;
9514 /* The buffer's end, and a current output position in it. */
9516 static char *mode_line_noprop_buf_end
;
9517 static char *mode_line_noprop_ptr
;
9519 #define MODE_LINE_NOPROP_LEN(start) \
9520 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9523 MODE_LINE_DISPLAY
= 0,
9529 /* Alist that caches the results of :propertize.
9530 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9531 static Lisp_Object mode_line_proptrans_alist
;
9533 /* List of strings making up the mode-line. */
9534 static Lisp_Object mode_line_string_list
;
9536 /* Base face property when building propertized mode line string. */
9537 static Lisp_Object mode_line_string_face
;
9538 static Lisp_Object mode_line_string_face_prop
;
9541 /* Unwind data for mode line strings */
9543 static Lisp_Object Vmode_line_unwind_vector
;
9546 format_mode_line_unwind_data (struct buffer
*obuf
,
9550 Lisp_Object vector
, tmp
;
9552 /* Reduce consing by keeping one vector in
9553 Vwith_echo_area_save_vector. */
9554 vector
= Vmode_line_unwind_vector
;
9555 Vmode_line_unwind_vector
= Qnil
;
9558 vector
= Fmake_vector (make_number (8), Qnil
);
9560 ASET (vector
, 0, make_number (mode_line_target
));
9561 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9562 ASET (vector
, 2, mode_line_string_list
);
9563 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9564 ASET (vector
, 4, mode_line_string_face
);
9565 ASET (vector
, 5, mode_line_string_face_prop
);
9568 XSETBUFFER (tmp
, obuf
);
9571 ASET (vector
, 6, tmp
);
9572 ASET (vector
, 7, owin
);
9578 unwind_format_mode_line (Lisp_Object vector
)
9580 mode_line_target
= XINT (AREF (vector
, 0));
9581 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9582 mode_line_string_list
= AREF (vector
, 2);
9583 if (! EQ (AREF (vector
, 3), Qt
))
9584 mode_line_proptrans_alist
= AREF (vector
, 3);
9585 mode_line_string_face
= AREF (vector
, 4);
9586 mode_line_string_face_prop
= AREF (vector
, 5);
9588 if (!NILP (AREF (vector
, 7)))
9589 /* Select window before buffer, since it may change the buffer. */
9590 Fselect_window (AREF (vector
, 7), Qt
);
9592 if (!NILP (AREF (vector
, 6)))
9594 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9595 ASET (vector
, 6, Qnil
);
9598 Vmode_line_unwind_vector
= vector
;
9603 /* Store a single character C for the frame title in mode_line_noprop_buf.
9604 Re-allocate mode_line_noprop_buf if necessary. */
9607 store_mode_line_noprop_char (char c
)
9609 /* If output position has reached the end of the allocated buffer,
9610 double the buffer's size. */
9611 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9613 int len
= MODE_LINE_NOPROP_LEN (0);
9614 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9615 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9616 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9617 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9620 *mode_line_noprop_ptr
++ = c
;
9624 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9625 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9626 characters that yield more columns than PRECISION; PRECISION <= 0
9627 means copy the whole string. Pad with spaces until FIELD_WIDTH
9628 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9629 pad. Called from display_mode_element when it is used to build a
9633 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9635 const unsigned char *str
= (const unsigned char *) string
;
9637 EMACS_INT dummy
, nbytes
;
9639 /* Copy at most PRECISION chars from STR. */
9640 nbytes
= strlen (string
);
9641 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9643 store_mode_line_noprop_char (*str
++);
9645 /* Fill up with spaces until FIELD_WIDTH reached. */
9646 while (field_width
> 0
9649 store_mode_line_noprop_char (' ');
9656 /***********************************************************************
9658 ***********************************************************************/
9660 #ifdef HAVE_WINDOW_SYSTEM
9662 /* Set the title of FRAME, if it has changed. The title format is
9663 Vicon_title_format if FRAME is iconified, otherwise it is
9664 frame_title_format. */
9667 x_consider_frame_title (Lisp_Object frame
)
9669 struct frame
*f
= XFRAME (frame
);
9671 if (FRAME_WINDOW_P (f
)
9672 || FRAME_MINIBUF_ONLY_P (f
)
9673 || f
->explicit_name
)
9675 /* Do we have more than one visible frame on this X display? */
9682 int count
= SPECPDL_INDEX ();
9684 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9686 Lisp_Object other_frame
= XCAR (tail
);
9687 struct frame
*tf
= XFRAME (other_frame
);
9690 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9691 && !FRAME_MINIBUF_ONLY_P (tf
)
9692 && !EQ (other_frame
, tip_frame
)
9693 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9697 /* Set global variable indicating that multiple frames exist. */
9698 multiple_frames
= CONSP (tail
);
9700 /* Switch to the buffer of selected window of the frame. Set up
9701 mode_line_target so that display_mode_element will output into
9702 mode_line_noprop_buf; then display the title. */
9703 record_unwind_protect (unwind_format_mode_line
,
9704 format_mode_line_unwind_data
9705 (current_buffer
, selected_window
, 0));
9707 Fselect_window (f
->selected_window
, Qt
);
9708 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9709 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9711 mode_line_target
= MODE_LINE_TITLE
;
9712 title_start
= MODE_LINE_NOPROP_LEN (0);
9713 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9714 NULL
, DEFAULT_FACE_ID
);
9715 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9716 len
= MODE_LINE_NOPROP_LEN (title_start
);
9717 title
= mode_line_noprop_buf
+ title_start
;
9718 unbind_to (count
, Qnil
);
9720 /* Set the title only if it's changed. This avoids consing in
9721 the common case where it hasn't. (If it turns out that we've
9722 already wasted too much time by walking through the list with
9723 display_mode_element, then we might need to optimize at a
9724 higher level than this.) */
9725 if (! STRINGP (f
->name
)
9726 || SBYTES (f
->name
) != len
9727 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9728 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9732 #endif /* not HAVE_WINDOW_SYSTEM */
9737 /***********************************************************************
9739 ***********************************************************************/
9742 /* Prepare for redisplay by updating menu-bar item lists when
9743 appropriate. This can call eval. */
9746 prepare_menu_bars (void)
9749 struct gcpro gcpro1
, gcpro2
;
9751 Lisp_Object tooltip_frame
;
9753 #ifdef HAVE_WINDOW_SYSTEM
9754 tooltip_frame
= tip_frame
;
9756 tooltip_frame
= Qnil
;
9759 /* Update all frame titles based on their buffer names, etc. We do
9760 this before the menu bars so that the buffer-menu will show the
9761 up-to-date frame titles. */
9762 #ifdef HAVE_WINDOW_SYSTEM
9763 if (windows_or_buffers_changed
|| update_mode_lines
)
9765 Lisp_Object tail
, frame
;
9767 FOR_EACH_FRAME (tail
, frame
)
9770 if (!EQ (frame
, tooltip_frame
)
9771 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9772 x_consider_frame_title (frame
);
9775 #endif /* HAVE_WINDOW_SYSTEM */
9777 /* Update the menu bar item lists, if appropriate. This has to be
9778 done before any actual redisplay or generation of display lines. */
9779 all_windows
= (update_mode_lines
9780 || buffer_shared
> 1
9781 || windows_or_buffers_changed
);
9784 Lisp_Object tail
, frame
;
9785 int count
= SPECPDL_INDEX ();
9786 /* 1 means that update_menu_bar has run its hooks
9787 so any further calls to update_menu_bar shouldn't do so again. */
9788 int menu_bar_hooks_run
= 0;
9790 record_unwind_save_match_data ();
9792 FOR_EACH_FRAME (tail
, frame
)
9796 /* Ignore tooltip frame. */
9797 if (EQ (frame
, tooltip_frame
))
9800 /* If a window on this frame changed size, report that to
9801 the user and clear the size-change flag. */
9802 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9804 Lisp_Object functions
;
9806 /* Clear flag first in case we get an error below. */
9807 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9808 functions
= Vwindow_size_change_functions
;
9809 GCPRO2 (tail
, functions
);
9811 while (CONSP (functions
))
9813 if (!EQ (XCAR (functions
), Qt
))
9814 call1 (XCAR (functions
), frame
);
9815 functions
= XCDR (functions
);
9821 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9822 #ifdef HAVE_WINDOW_SYSTEM
9823 update_tool_bar (f
, 0);
9826 if (windows_or_buffers_changed
9828 ns_set_doc_edited (f
, Fbuffer_modified_p
9829 (XWINDOW (f
->selected_window
)->buffer
));
9834 unbind_to (count
, Qnil
);
9838 struct frame
*sf
= SELECTED_FRAME ();
9839 update_menu_bar (sf
, 1, 0);
9840 #ifdef HAVE_WINDOW_SYSTEM
9841 update_tool_bar (sf
, 1);
9847 /* Update the menu bar item list for frame F. This has to be done
9848 before we start to fill in any display lines, because it can call
9851 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9853 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9854 already ran the menu bar hooks for this redisplay, so there
9855 is no need to run them again. The return value is the
9856 updated value of this flag, to pass to the next call. */
9859 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9862 register struct window
*w
;
9864 /* If called recursively during a menu update, do nothing. This can
9865 happen when, for instance, an activate-menubar-hook causes a
9867 if (inhibit_menubar_update
)
9870 window
= FRAME_SELECTED_WINDOW (f
);
9871 w
= XWINDOW (window
);
9873 if (FRAME_WINDOW_P (f
)
9875 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9876 || defined (HAVE_NS) || defined (USE_GTK)
9877 FRAME_EXTERNAL_MENU_BAR (f
)
9879 FRAME_MENU_BAR_LINES (f
) > 0
9881 : FRAME_MENU_BAR_LINES (f
) > 0)
9883 /* If the user has switched buffers or windows, we need to
9884 recompute to reflect the new bindings. But we'll
9885 recompute when update_mode_lines is set too; that means
9886 that people can use force-mode-line-update to request
9887 that the menu bar be recomputed. The adverse effect on
9888 the rest of the redisplay algorithm is about the same as
9889 windows_or_buffers_changed anyway. */
9890 if (windows_or_buffers_changed
9891 /* This used to test w->update_mode_line, but we believe
9892 there is no need to recompute the menu in that case. */
9893 || update_mode_lines
9894 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9895 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9896 != !NILP (w
->last_had_star
))
9897 || ((!NILP (Vtransient_mark_mode
)
9898 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9899 != !NILP (w
->region_showing
)))
9901 struct buffer
*prev
= current_buffer
;
9902 int count
= SPECPDL_INDEX ();
9904 specbind (Qinhibit_menubar_update
, Qt
);
9906 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9907 if (save_match_data
)
9908 record_unwind_save_match_data ();
9909 if (NILP (Voverriding_local_map_menu_flag
))
9911 specbind (Qoverriding_terminal_local_map
, Qnil
);
9912 specbind (Qoverriding_local_map
, Qnil
);
9917 /* Run the Lucid hook. */
9918 safe_run_hooks (Qactivate_menubar_hook
);
9920 /* If it has changed current-menubar from previous value,
9921 really recompute the menu-bar from the value. */
9922 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9923 call0 (Qrecompute_lucid_menubar
);
9925 safe_run_hooks (Qmenu_bar_update_hook
);
9930 XSETFRAME (Vmenu_updating_frame
, f
);
9931 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9933 /* Redisplay the menu bar in case we changed it. */
9934 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9935 || defined (HAVE_NS) || defined (USE_GTK)
9936 if (FRAME_WINDOW_P (f
))
9938 #if defined (HAVE_NS)
9939 /* All frames on Mac OS share the same menubar. So only
9940 the selected frame should be allowed to set it. */
9941 if (f
== SELECTED_FRAME ())
9943 set_frame_menubar (f
, 0, 0);
9946 /* On a terminal screen, the menu bar is an ordinary screen
9947 line, and this makes it get updated. */
9948 w
->update_mode_line
= Qt
;
9949 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9950 /* In the non-toolkit version, the menu bar is an ordinary screen
9951 line, and this makes it get updated. */
9952 w
->update_mode_line
= Qt
;
9953 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9955 unbind_to (count
, Qnil
);
9956 set_buffer_internal_1 (prev
);
9965 /***********************************************************************
9967 ***********************************************************************/
9969 #ifdef HAVE_WINDOW_SYSTEM
9972 Nominal cursor position -- where to draw output.
9973 HPOS and VPOS are window relative glyph matrix coordinates.
9974 X and Y are window relative pixel coordinates. */
9976 struct cursor_pos output_cursor
;
9980 Set the global variable output_cursor to CURSOR. All cursor
9981 positions are relative to updated_window. */
9984 set_output_cursor (struct cursor_pos
*cursor
)
9986 output_cursor
.hpos
= cursor
->hpos
;
9987 output_cursor
.vpos
= cursor
->vpos
;
9988 output_cursor
.x
= cursor
->x
;
9989 output_cursor
.y
= cursor
->y
;
9994 Set a nominal cursor position.
9996 HPOS and VPOS are column/row positions in a window glyph matrix. X
9997 and Y are window text area relative pixel positions.
9999 If this is done during an update, updated_window will contain the
10000 window that is being updated and the position is the future output
10001 cursor position for that window. If updated_window is null, use
10002 selected_window and display the cursor at the given position. */
10005 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10009 /* If updated_window is not set, work on selected_window. */
10010 if (updated_window
)
10011 w
= updated_window
;
10013 w
= XWINDOW (selected_window
);
10015 /* Set the output cursor. */
10016 output_cursor
.hpos
= hpos
;
10017 output_cursor
.vpos
= vpos
;
10018 output_cursor
.x
= x
;
10019 output_cursor
.y
= y
;
10021 /* If not called as part of an update, really display the cursor.
10022 This will also set the cursor position of W. */
10023 if (updated_window
== NULL
)
10026 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10027 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10028 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10033 #endif /* HAVE_WINDOW_SYSTEM */
10036 /***********************************************************************
10038 ***********************************************************************/
10040 #ifdef HAVE_WINDOW_SYSTEM
10042 /* Where the mouse was last time we reported a mouse event. */
10044 FRAME_PTR last_mouse_frame
;
10046 /* Tool-bar item index of the item on which a mouse button was pressed
10049 int last_tool_bar_item
;
10053 update_tool_bar_unwind (Lisp_Object frame
)
10055 selected_frame
= frame
;
10059 /* Update the tool-bar item list for frame F. This has to be done
10060 before we start to fill in any display lines. Called from
10061 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10062 and restore it here. */
10065 update_tool_bar (struct frame
*f
, int save_match_data
)
10067 #if defined (USE_GTK) || defined (HAVE_NS)
10068 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10070 int do_update
= WINDOWP (f
->tool_bar_window
)
10071 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10076 Lisp_Object window
;
10079 window
= FRAME_SELECTED_WINDOW (f
);
10080 w
= XWINDOW (window
);
10082 /* If the user has switched buffers or windows, we need to
10083 recompute to reflect the new bindings. But we'll
10084 recompute when update_mode_lines is set too; that means
10085 that people can use force-mode-line-update to request
10086 that the menu bar be recomputed. The adverse effect on
10087 the rest of the redisplay algorithm is about the same as
10088 windows_or_buffers_changed anyway. */
10089 if (windows_or_buffers_changed
10090 || !NILP (w
->update_mode_line
)
10091 || update_mode_lines
10092 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10093 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10094 != !NILP (w
->last_had_star
))
10095 || ((!NILP (Vtransient_mark_mode
)
10096 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10097 != !NILP (w
->region_showing
)))
10099 struct buffer
*prev
= current_buffer
;
10100 int count
= SPECPDL_INDEX ();
10101 Lisp_Object frame
, new_tool_bar
;
10102 int new_n_tool_bar
;
10103 struct gcpro gcpro1
;
10105 /* Set current_buffer to the buffer of the selected
10106 window of the frame, so that we get the right local
10108 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10110 /* Save match data, if we must. */
10111 if (save_match_data
)
10112 record_unwind_save_match_data ();
10114 /* Make sure that we don't accidentally use bogus keymaps. */
10115 if (NILP (Voverriding_local_map_menu_flag
))
10117 specbind (Qoverriding_terminal_local_map
, Qnil
);
10118 specbind (Qoverriding_local_map
, Qnil
);
10121 GCPRO1 (new_tool_bar
);
10123 /* We must temporarily set the selected frame to this frame
10124 before calling tool_bar_items, because the calculation of
10125 the tool-bar keymap uses the selected frame (see
10126 `tool-bar-make-keymap' in tool-bar.el). */
10127 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10128 XSETFRAME (frame
, f
);
10129 selected_frame
= frame
;
10131 /* Build desired tool-bar items from keymaps. */
10132 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10135 /* Redisplay the tool-bar if we changed it. */
10136 if (new_n_tool_bar
!= f
->n_tool_bar_items
10137 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10139 /* Redisplay that happens asynchronously due to an expose event
10140 may access f->tool_bar_items. Make sure we update both
10141 variables within BLOCK_INPUT so no such event interrupts. */
10143 f
->tool_bar_items
= new_tool_bar
;
10144 f
->n_tool_bar_items
= new_n_tool_bar
;
10145 w
->update_mode_line
= Qt
;
10151 unbind_to (count
, Qnil
);
10152 set_buffer_internal_1 (prev
);
10158 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10159 F's desired tool-bar contents. F->tool_bar_items must have
10160 been set up previously by calling prepare_menu_bars. */
10163 build_desired_tool_bar_string (struct frame
*f
)
10165 int i
, size
, size_needed
;
10166 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10167 Lisp_Object image
, plist
, props
;
10169 image
= plist
= props
= Qnil
;
10170 GCPRO3 (image
, plist
, props
);
10172 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10173 Otherwise, make a new string. */
10175 /* The size of the string we might be able to reuse. */
10176 size
= (STRINGP (f
->desired_tool_bar_string
)
10177 ? SCHARS (f
->desired_tool_bar_string
)
10180 /* We need one space in the string for each image. */
10181 size_needed
= f
->n_tool_bar_items
;
10183 /* Reuse f->desired_tool_bar_string, if possible. */
10184 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10185 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10186 make_number (' '));
10189 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10190 Fremove_text_properties (make_number (0), make_number (size
),
10191 props
, f
->desired_tool_bar_string
);
10194 /* Put a `display' property on the string for the images to display,
10195 put a `menu_item' property on tool-bar items with a value that
10196 is the index of the item in F's tool-bar item vector. */
10197 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10199 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10201 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10202 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10203 int hmargin
, vmargin
, relief
, idx
, end
;
10205 /* If image is a vector, choose the image according to the
10207 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10208 if (VECTORP (image
))
10212 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10213 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10216 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10217 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10219 xassert (ASIZE (image
) >= idx
);
10220 image
= AREF (image
, idx
);
10225 /* Ignore invalid image specifications. */
10226 if (!valid_image_p (image
))
10229 /* Display the tool-bar button pressed, or depressed. */
10230 plist
= Fcopy_sequence (XCDR (image
));
10232 /* Compute margin and relief to draw. */
10233 relief
= (tool_bar_button_relief
>= 0
10234 ? tool_bar_button_relief
10235 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10236 hmargin
= vmargin
= relief
;
10238 if (INTEGERP (Vtool_bar_button_margin
)
10239 && XINT (Vtool_bar_button_margin
) > 0)
10241 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10242 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10244 else if (CONSP (Vtool_bar_button_margin
))
10246 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10247 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10248 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10250 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10251 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10252 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10255 if (auto_raise_tool_bar_buttons_p
)
10257 /* Add a `:relief' property to the image spec if the item is
10261 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10268 /* If image is selected, display it pressed, i.e. with a
10269 negative relief. If it's not selected, display it with a
10271 plist
= Fplist_put (plist
, QCrelief
,
10273 ? make_number (-relief
)
10274 : make_number (relief
)));
10279 /* Put a margin around the image. */
10280 if (hmargin
|| vmargin
)
10282 if (hmargin
== vmargin
)
10283 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10285 plist
= Fplist_put (plist
, QCmargin
,
10286 Fcons (make_number (hmargin
),
10287 make_number (vmargin
)));
10290 /* If button is not enabled, and we don't have special images
10291 for the disabled state, make the image appear disabled by
10292 applying an appropriate algorithm to it. */
10293 if (!enabled_p
&& idx
< 0)
10294 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10296 /* Put a `display' text property on the string for the image to
10297 display. Put a `menu-item' property on the string that gives
10298 the start of this item's properties in the tool-bar items
10300 image
= Fcons (Qimage
, plist
);
10301 props
= list4 (Qdisplay
, image
,
10302 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10304 /* Let the last image hide all remaining spaces in the tool bar
10305 string. The string can be longer than needed when we reuse a
10306 previous string. */
10307 if (i
+ 1 == f
->n_tool_bar_items
)
10308 end
= SCHARS (f
->desired_tool_bar_string
);
10311 Fadd_text_properties (make_number (i
), make_number (end
),
10312 props
, f
->desired_tool_bar_string
);
10320 /* Display one line of the tool-bar of frame IT->f.
10322 HEIGHT specifies the desired height of the tool-bar line.
10323 If the actual height of the glyph row is less than HEIGHT, the
10324 row's height is increased to HEIGHT, and the icons are centered
10325 vertically in the new height.
10327 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10328 count a final empty row in case the tool-bar width exactly matches
10333 display_tool_bar_line (struct it
*it
, int height
)
10335 struct glyph_row
*row
= it
->glyph_row
;
10336 int max_x
= it
->last_visible_x
;
10337 struct glyph
*last
;
10339 prepare_desired_row (row
);
10340 row
->y
= it
->current_y
;
10342 /* Note that this isn't made use of if the face hasn't a box,
10343 so there's no need to check the face here. */
10344 it
->start_of_box_run_p
= 1;
10346 while (it
->current_x
< max_x
)
10348 int x
, n_glyphs_before
, i
, nglyphs
;
10349 struct it it_before
;
10351 /* Get the next display element. */
10352 if (!get_next_display_element (it
))
10354 /* Don't count empty row if we are counting needed tool-bar lines. */
10355 if (height
< 0 && !it
->hpos
)
10360 /* Produce glyphs. */
10361 n_glyphs_before
= row
->used
[TEXT_AREA
];
10364 PRODUCE_GLYPHS (it
);
10366 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10368 x
= it_before
.current_x
;
10369 while (i
< nglyphs
)
10371 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10373 if (x
+ glyph
->pixel_width
> max_x
)
10375 /* Glyph doesn't fit on line. Backtrack. */
10376 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10378 /* If this is the only glyph on this line, it will never fit on the
10379 tool-bar, so skip it. But ensure there is at least one glyph,
10380 so we don't accidentally disable the tool-bar. */
10381 if (n_glyphs_before
== 0
10382 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10388 x
+= glyph
->pixel_width
;
10392 /* Stop at line ends. */
10393 if (ITERATOR_AT_END_OF_LINE_P (it
))
10396 set_iterator_to_next (it
, 1);
10401 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10403 /* Use default face for the border below the tool bar.
10405 FIXME: When auto-resize-tool-bars is grow-only, there is
10406 no additional border below the possibly empty tool-bar lines.
10407 So to make the extra empty lines look "normal", we have to
10408 use the tool-bar face for the border too. */
10409 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10410 it
->face_id
= DEFAULT_FACE_ID
;
10412 extend_face_to_end_of_line (it
);
10413 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10414 last
->right_box_line_p
= 1;
10415 if (last
== row
->glyphs
[TEXT_AREA
])
10416 last
->left_box_line_p
= 1;
10418 /* Make line the desired height and center it vertically. */
10419 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10421 /* Don't add more than one line height. */
10422 height
%= FRAME_LINE_HEIGHT (it
->f
);
10423 it
->max_ascent
+= height
/ 2;
10424 it
->max_descent
+= (height
+ 1) / 2;
10427 compute_line_metrics (it
);
10429 /* If line is empty, make it occupy the rest of the tool-bar. */
10430 if (!row
->displays_text_p
)
10432 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10433 row
->visible_height
= row
->height
;
10434 row
->ascent
= row
->phys_ascent
= 0;
10435 row
->extra_line_spacing
= 0;
10438 row
->full_width_p
= 1;
10439 row
->continued_p
= 0;
10440 row
->truncated_on_left_p
= 0;
10441 row
->truncated_on_right_p
= 0;
10443 it
->current_x
= it
->hpos
= 0;
10444 it
->current_y
+= row
->height
;
10450 /* Max tool-bar height. */
10452 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10453 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10455 /* Value is the number of screen lines needed to make all tool-bar
10456 items of frame F visible. The number of actual rows needed is
10457 returned in *N_ROWS if non-NULL. */
10460 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10462 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10464 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10465 the desired matrix, so use (unused) mode-line row as temporary row to
10466 avoid destroying the first tool-bar row. */
10467 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10469 /* Initialize an iterator for iteration over
10470 F->desired_tool_bar_string in the tool-bar window of frame F. */
10471 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10472 it
.first_visible_x
= 0;
10473 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10474 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10476 while (!ITERATOR_AT_END_P (&it
))
10478 clear_glyph_row (temp_row
);
10479 it
.glyph_row
= temp_row
;
10480 display_tool_bar_line (&it
, -1);
10482 clear_glyph_row (temp_row
);
10484 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10486 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10488 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10492 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10494 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10495 (Lisp_Object frame
)
10502 frame
= selected_frame
;
10504 CHECK_FRAME (frame
);
10505 f
= XFRAME (frame
);
10507 if (WINDOWP (f
->tool_bar_window
)
10508 || (w
= XWINDOW (f
->tool_bar_window
),
10509 WINDOW_TOTAL_LINES (w
) > 0))
10511 update_tool_bar (f
, 1);
10512 if (f
->n_tool_bar_items
)
10514 build_desired_tool_bar_string (f
);
10515 nlines
= tool_bar_lines_needed (f
, NULL
);
10519 return make_number (nlines
);
10523 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10524 height should be changed. */
10527 redisplay_tool_bar (struct frame
*f
)
10531 struct glyph_row
*row
;
10533 #if defined (USE_GTK) || defined (HAVE_NS)
10534 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10535 update_frame_tool_bar (f
);
10539 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10540 do anything. This means you must start with tool-bar-lines
10541 non-zero to get the auto-sizing effect. Or in other words, you
10542 can turn off tool-bars by specifying tool-bar-lines zero. */
10543 if (!WINDOWP (f
->tool_bar_window
)
10544 || (w
= XWINDOW (f
->tool_bar_window
),
10545 WINDOW_TOTAL_LINES (w
) == 0))
10548 /* Set up an iterator for the tool-bar window. */
10549 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10550 it
.first_visible_x
= 0;
10551 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10552 row
= it
.glyph_row
;
10554 /* Build a string that represents the contents of the tool-bar. */
10555 build_desired_tool_bar_string (f
);
10556 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10558 if (f
->n_tool_bar_rows
== 0)
10562 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10563 nlines
!= WINDOW_TOTAL_LINES (w
)))
10566 int old_height
= WINDOW_TOTAL_LINES (w
);
10568 XSETFRAME (frame
, f
);
10569 Fmodify_frame_parameters (frame
,
10570 Fcons (Fcons (Qtool_bar_lines
,
10571 make_number (nlines
)),
10573 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10575 clear_glyph_matrix (w
->desired_matrix
);
10576 fonts_changed_p
= 1;
10582 /* Display as many lines as needed to display all tool-bar items. */
10584 if (f
->n_tool_bar_rows
> 0)
10586 int border
, rows
, height
, extra
;
10588 if (INTEGERP (Vtool_bar_border
))
10589 border
= XINT (Vtool_bar_border
);
10590 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10591 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10592 else if (EQ (Vtool_bar_border
, Qborder_width
))
10593 border
= f
->border_width
;
10599 rows
= f
->n_tool_bar_rows
;
10600 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10601 extra
= it
.last_visible_y
- border
- height
* rows
;
10603 while (it
.current_y
< it
.last_visible_y
)
10606 if (extra
> 0 && rows
-- > 0)
10608 h
= (extra
+ rows
- 1) / rows
;
10611 display_tool_bar_line (&it
, height
+ h
);
10616 while (it
.current_y
< it
.last_visible_y
)
10617 display_tool_bar_line (&it
, 0);
10620 /* It doesn't make much sense to try scrolling in the tool-bar
10621 window, so don't do it. */
10622 w
->desired_matrix
->no_scrolling_p
= 1;
10623 w
->must_be_updated_p
= 1;
10625 if (!NILP (Vauto_resize_tool_bars
))
10627 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10628 int change_height_p
= 0;
10630 /* If we couldn't display everything, change the tool-bar's
10631 height if there is room for more. */
10632 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10633 && it
.current_y
< max_tool_bar_height
)
10634 change_height_p
= 1;
10636 row
= it
.glyph_row
- 1;
10638 /* If there are blank lines at the end, except for a partially
10639 visible blank line at the end that is smaller than
10640 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10641 if (!row
->displays_text_p
10642 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10643 change_height_p
= 1;
10645 /* If row displays tool-bar items, but is partially visible,
10646 change the tool-bar's height. */
10647 if (row
->displays_text_p
10648 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10649 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10650 change_height_p
= 1;
10652 /* Resize windows as needed by changing the `tool-bar-lines'
10653 frame parameter. */
10654 if (change_height_p
)
10657 int old_height
= WINDOW_TOTAL_LINES (w
);
10659 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10661 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10662 && !f
->minimize_tool_bar_window_p
)
10663 ? (nlines
> old_height
)
10664 : (nlines
!= old_height
));
10665 f
->minimize_tool_bar_window_p
= 0;
10667 if (change_height_p
)
10669 XSETFRAME (frame
, f
);
10670 Fmodify_frame_parameters (frame
,
10671 Fcons (Fcons (Qtool_bar_lines
,
10672 make_number (nlines
)),
10674 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10676 clear_glyph_matrix (w
->desired_matrix
);
10677 f
->n_tool_bar_rows
= nrows
;
10678 fonts_changed_p
= 1;
10685 f
->minimize_tool_bar_window_p
= 0;
10690 /* Get information about the tool-bar item which is displayed in GLYPH
10691 on frame F. Return in *PROP_IDX the index where tool-bar item
10692 properties start in F->tool_bar_items. Value is zero if
10693 GLYPH doesn't display a tool-bar item. */
10696 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10702 /* This function can be called asynchronously, which means we must
10703 exclude any possibility that Fget_text_property signals an
10705 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10706 charpos
= max (0, charpos
);
10708 /* Get the text property `menu-item' at pos. The value of that
10709 property is the start index of this item's properties in
10710 F->tool_bar_items. */
10711 prop
= Fget_text_property (make_number (charpos
),
10712 Qmenu_item
, f
->current_tool_bar_string
);
10713 if (INTEGERP (prop
))
10715 *prop_idx
= XINT (prop
);
10725 /* Get information about the tool-bar item at position X/Y on frame F.
10726 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10727 the current matrix of the tool-bar window of F, or NULL if not
10728 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10729 item in F->tool_bar_items. Value is
10731 -1 if X/Y is not on a tool-bar item
10732 0 if X/Y is on the same item that was highlighted before.
10736 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10737 int *hpos
, int *vpos
, int *prop_idx
)
10739 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10740 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10743 /* Find the glyph under X/Y. */
10744 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10745 if (*glyph
== NULL
)
10748 /* Get the start of this tool-bar item's properties in
10749 f->tool_bar_items. */
10750 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10753 /* Is mouse on the highlighted item? */
10754 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10755 && *vpos
>= hlinfo
->mouse_face_beg_row
10756 && *vpos
<= hlinfo
->mouse_face_end_row
10757 && (*vpos
> hlinfo
->mouse_face_beg_row
10758 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10759 && (*vpos
< hlinfo
->mouse_face_end_row
10760 || *hpos
< hlinfo
->mouse_face_end_col
10761 || hlinfo
->mouse_face_past_end
))
10769 Handle mouse button event on the tool-bar of frame F, at
10770 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10771 0 for button release. MODIFIERS is event modifiers for button
10775 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10776 unsigned int modifiers
)
10778 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10779 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10780 int hpos
, vpos
, prop_idx
;
10781 struct glyph
*glyph
;
10782 Lisp_Object enabled_p
;
10784 /* If not on the highlighted tool-bar item, return. */
10785 frame_to_window_pixel_xy (w
, &x
, &y
);
10786 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10789 /* If item is disabled, do nothing. */
10790 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10791 if (NILP (enabled_p
))
10796 /* Show item in pressed state. */
10797 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10798 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10799 last_tool_bar_item
= prop_idx
;
10803 Lisp_Object key
, frame
;
10804 struct input_event event
;
10805 EVENT_INIT (event
);
10807 /* Show item in released state. */
10808 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10809 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10811 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10813 XSETFRAME (frame
, f
);
10814 event
.kind
= TOOL_BAR_EVENT
;
10815 event
.frame_or_window
= frame
;
10817 kbd_buffer_store_event (&event
);
10819 event
.kind
= TOOL_BAR_EVENT
;
10820 event
.frame_or_window
= frame
;
10822 event
.modifiers
= modifiers
;
10823 kbd_buffer_store_event (&event
);
10824 last_tool_bar_item
= -1;
10829 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10830 tool-bar window-relative coordinates X/Y. Called from
10831 note_mouse_highlight. */
10834 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10836 Lisp_Object window
= f
->tool_bar_window
;
10837 struct window
*w
= XWINDOW (window
);
10838 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10839 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10841 struct glyph
*glyph
;
10842 struct glyph_row
*row
;
10844 Lisp_Object enabled_p
;
10846 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10847 int mouse_down_p
, rc
;
10849 /* Function note_mouse_highlight is called with negative X/Y
10850 values when mouse moves outside of the frame. */
10851 if (x
<= 0 || y
<= 0)
10853 clear_mouse_face (hlinfo
);
10857 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10860 /* Not on tool-bar item. */
10861 clear_mouse_face (hlinfo
);
10865 /* On same tool-bar item as before. */
10866 goto set_help_echo
;
10868 clear_mouse_face (hlinfo
);
10870 /* Mouse is down, but on different tool-bar item? */
10871 mouse_down_p
= (dpyinfo
->grabbed
10872 && f
== last_mouse_frame
10873 && FRAME_LIVE_P (f
));
10875 && last_tool_bar_item
!= prop_idx
)
10878 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10879 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10881 /* If tool-bar item is not enabled, don't highlight it. */
10882 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10883 if (!NILP (enabled_p
))
10885 /* Compute the x-position of the glyph. In front and past the
10886 image is a space. We include this in the highlighted area. */
10887 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10888 for (i
= x
= 0; i
< hpos
; ++i
)
10889 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10891 /* Record this as the current active region. */
10892 hlinfo
->mouse_face_beg_col
= hpos
;
10893 hlinfo
->mouse_face_beg_row
= vpos
;
10894 hlinfo
->mouse_face_beg_x
= x
;
10895 hlinfo
->mouse_face_beg_y
= row
->y
;
10896 hlinfo
->mouse_face_past_end
= 0;
10898 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10899 hlinfo
->mouse_face_end_row
= vpos
;
10900 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10901 hlinfo
->mouse_face_end_y
= row
->y
;
10902 hlinfo
->mouse_face_window
= window
;
10903 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10905 /* Display it as active. */
10906 show_mouse_face (hlinfo
, draw
);
10907 hlinfo
->mouse_face_image_state
= draw
;
10912 /* Set help_echo_string to a help string to display for this tool-bar item.
10913 XTread_socket does the rest. */
10914 help_echo_object
= help_echo_window
= Qnil
;
10915 help_echo_pos
= -1;
10916 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10917 if (NILP (help_echo_string
))
10918 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10921 #endif /* HAVE_WINDOW_SYSTEM */
10925 /************************************************************************
10926 Horizontal scrolling
10927 ************************************************************************/
10929 static int hscroll_window_tree (Lisp_Object
);
10930 static int hscroll_windows (Lisp_Object
);
10932 /* For all leaf windows in the window tree rooted at WINDOW, set their
10933 hscroll value so that PT is (i) visible in the window, and (ii) so
10934 that it is not within a certain margin at the window's left and
10935 right border. Value is non-zero if any window's hscroll has been
10939 hscroll_window_tree (Lisp_Object window
)
10941 int hscrolled_p
= 0;
10942 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10943 int hscroll_step_abs
= 0;
10944 double hscroll_step_rel
= 0;
10946 if (hscroll_relative_p
)
10948 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10949 if (hscroll_step_rel
< 0)
10951 hscroll_relative_p
= 0;
10952 hscroll_step_abs
= 0;
10955 else if (INTEGERP (Vhscroll_step
))
10957 hscroll_step_abs
= XINT (Vhscroll_step
);
10958 if (hscroll_step_abs
< 0)
10959 hscroll_step_abs
= 0;
10962 hscroll_step_abs
= 0;
10964 while (WINDOWP (window
))
10966 struct window
*w
= XWINDOW (window
);
10968 if (WINDOWP (w
->hchild
))
10969 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10970 else if (WINDOWP (w
->vchild
))
10971 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10972 else if (w
->cursor
.vpos
>= 0)
10975 int text_area_width
;
10976 struct glyph_row
*current_cursor_row
10977 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10978 struct glyph_row
*desired_cursor_row
10979 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10980 struct glyph_row
*cursor_row
10981 = (desired_cursor_row
->enabled_p
10982 ? desired_cursor_row
10983 : current_cursor_row
);
10985 text_area_width
= window_box_width (w
, TEXT_AREA
);
10987 /* Scroll when cursor is inside this scroll margin. */
10988 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10990 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10991 && ((XFASTINT (w
->hscroll
)
10992 && w
->cursor
.x
<= h_margin
)
10993 || (cursor_row
->enabled_p
10994 && cursor_row
->truncated_on_right_p
10995 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10999 struct buffer
*saved_current_buffer
;
11003 /* Find point in a display of infinite width. */
11004 saved_current_buffer
= current_buffer
;
11005 current_buffer
= XBUFFER (w
->buffer
);
11007 if (w
== XWINDOW (selected_window
))
11011 pt
= marker_position (w
->pointm
);
11012 pt
= max (BEGV
, pt
);
11016 /* Move iterator to pt starting at cursor_row->start in
11017 a line with infinite width. */
11018 init_to_row_start (&it
, w
, cursor_row
);
11019 it
.last_visible_x
= INFINITY
;
11020 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11021 current_buffer
= saved_current_buffer
;
11023 /* Position cursor in window. */
11024 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11025 hscroll
= max (0, (it
.current_x
11026 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11027 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11028 : (text_area_width
/ 2))))
11029 / FRAME_COLUMN_WIDTH (it
.f
);
11030 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11032 if (hscroll_relative_p
)
11033 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11036 wanted_x
= text_area_width
11037 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11040 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11044 if (hscroll_relative_p
)
11045 wanted_x
= text_area_width
* hscroll_step_rel
11048 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11051 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11053 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11055 /* Don't call Fset_window_hscroll if value hasn't
11056 changed because it will prevent redisplay
11058 if (XFASTINT (w
->hscroll
) != hscroll
)
11060 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11061 w
->hscroll
= make_number (hscroll
);
11070 /* Value is non-zero if hscroll of any leaf window has been changed. */
11071 return hscrolled_p
;
11075 /* Set hscroll so that cursor is visible and not inside horizontal
11076 scroll margins for all windows in the tree rooted at WINDOW. See
11077 also hscroll_window_tree above. Value is non-zero if any window's
11078 hscroll has been changed. If it has, desired matrices on the frame
11079 of WINDOW are cleared. */
11082 hscroll_windows (Lisp_Object window
)
11084 int hscrolled_p
= hscroll_window_tree (window
);
11086 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11087 return hscrolled_p
;
11092 /************************************************************************
11094 ************************************************************************/
11096 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11097 to a non-zero value. This is sometimes handy to have in a debugger
11102 /* First and last unchanged row for try_window_id. */
11104 int debug_first_unchanged_at_end_vpos
;
11105 int debug_last_unchanged_at_beg_vpos
;
11107 /* Delta vpos and y. */
11109 int debug_dvpos
, debug_dy
;
11111 /* Delta in characters and bytes for try_window_id. */
11113 EMACS_INT debug_delta
, debug_delta_bytes
;
11115 /* Values of window_end_pos and window_end_vpos at the end of
11118 EMACS_INT debug_end_vpos
;
11120 /* Append a string to W->desired_matrix->method. FMT is a printf
11121 format string. A1...A9 are a supplement for a variable-length
11122 argument list. If trace_redisplay_p is non-zero also printf the
11123 resulting string to stderr. */
11126 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11129 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11132 char *method
= w
->desired_matrix
->method
;
11133 int len
= strlen (method
);
11134 int size
= sizeof w
->desired_matrix
->method
;
11135 int remaining
= size
- len
- 1;
11137 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11138 if (len
&& remaining
)
11141 --remaining
, ++len
;
11144 strncpy (method
+ len
, buffer
, remaining
);
11146 if (trace_redisplay_p
)
11147 fprintf (stderr
, "%p (%s): %s\n",
11149 ((BUFFERP (w
->buffer
)
11150 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11151 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11156 #endif /* GLYPH_DEBUG */
11159 /* Value is non-zero if all changes in window W, which displays
11160 current_buffer, are in the text between START and END. START is a
11161 buffer position, END is given as a distance from Z. Used in
11162 redisplay_internal for display optimization. */
11165 text_outside_line_unchanged_p (struct window
*w
,
11166 EMACS_INT start
, EMACS_INT end
)
11168 int unchanged_p
= 1;
11170 /* If text or overlays have changed, see where. */
11171 if (XFASTINT (w
->last_modified
) < MODIFF
11172 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11174 /* Gap in the line? */
11175 if (GPT
< start
|| Z
- GPT
< end
)
11178 /* Changes start in front of the line, or end after it? */
11180 && (BEG_UNCHANGED
< start
- 1
11181 || END_UNCHANGED
< end
))
11184 /* If selective display, can't optimize if changes start at the
11185 beginning of the line. */
11187 && INTEGERP (BVAR (current_buffer
, selective_display
))
11188 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11189 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11192 /* If there are overlays at the start or end of the line, these
11193 may have overlay strings with newlines in them. A change at
11194 START, for instance, may actually concern the display of such
11195 overlay strings as well, and they are displayed on different
11196 lines. So, quickly rule out this case. (For the future, it
11197 might be desirable to implement something more telling than
11198 just BEG/END_UNCHANGED.) */
11201 if (BEG
+ BEG_UNCHANGED
== start
11202 && overlay_touches_p (start
))
11204 if (END_UNCHANGED
== end
11205 && overlay_touches_p (Z
- end
))
11209 /* Under bidi reordering, adding or deleting a character in the
11210 beginning of a paragraph, before the first strong directional
11211 character, can change the base direction of the paragraph (unless
11212 the buffer specifies a fixed paragraph direction), which will
11213 require to redisplay the whole paragraph. It might be worthwhile
11214 to find the paragraph limits and widen the range of redisplayed
11215 lines to that, but for now just give up this optimization. */
11216 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11217 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11221 return unchanged_p
;
11225 /* Do a frame update, taking possible shortcuts into account. This is
11226 the main external entry point for redisplay.
11228 If the last redisplay displayed an echo area message and that message
11229 is no longer requested, we clear the echo area or bring back the
11230 mini-buffer if that is in use. */
11235 redisplay_internal ();
11240 overlay_arrow_string_or_property (Lisp_Object var
)
11244 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11247 return Voverlay_arrow_string
;
11250 /* Return 1 if there are any overlay-arrows in current_buffer. */
11252 overlay_arrow_in_current_buffer_p (void)
11256 for (vlist
= Voverlay_arrow_variable_list
;
11258 vlist
= XCDR (vlist
))
11260 Lisp_Object var
= XCAR (vlist
);
11263 if (!SYMBOLP (var
))
11265 val
= find_symbol_value (var
);
11267 && current_buffer
== XMARKER (val
)->buffer
)
11274 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11278 overlay_arrows_changed_p (void)
11282 for (vlist
= Voverlay_arrow_variable_list
;
11284 vlist
= XCDR (vlist
))
11286 Lisp_Object var
= XCAR (vlist
);
11287 Lisp_Object val
, pstr
;
11289 if (!SYMBOLP (var
))
11291 val
= find_symbol_value (var
);
11292 if (!MARKERP (val
))
11294 if (! EQ (COERCE_MARKER (val
),
11295 Fget (var
, Qlast_arrow_position
))
11296 || ! (pstr
= overlay_arrow_string_or_property (var
),
11297 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11303 /* Mark overlay arrows to be updated on next redisplay. */
11306 update_overlay_arrows (int up_to_date
)
11310 for (vlist
= Voverlay_arrow_variable_list
;
11312 vlist
= XCDR (vlist
))
11314 Lisp_Object var
= XCAR (vlist
);
11316 if (!SYMBOLP (var
))
11319 if (up_to_date
> 0)
11321 Lisp_Object val
= find_symbol_value (var
);
11322 Fput (var
, Qlast_arrow_position
,
11323 COERCE_MARKER (val
));
11324 Fput (var
, Qlast_arrow_string
,
11325 overlay_arrow_string_or_property (var
));
11327 else if (up_to_date
< 0
11328 || !NILP (Fget (var
, Qlast_arrow_position
)))
11330 Fput (var
, Qlast_arrow_position
, Qt
);
11331 Fput (var
, Qlast_arrow_string
, Qt
);
11337 /* Return overlay arrow string to display at row.
11338 Return integer (bitmap number) for arrow bitmap in left fringe.
11339 Return nil if no overlay arrow. */
11342 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11346 for (vlist
= Voverlay_arrow_variable_list
;
11348 vlist
= XCDR (vlist
))
11350 Lisp_Object var
= XCAR (vlist
);
11353 if (!SYMBOLP (var
))
11356 val
= find_symbol_value (var
);
11359 && current_buffer
== XMARKER (val
)->buffer
11360 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11362 if (FRAME_WINDOW_P (it
->f
)
11363 /* FIXME: if ROW->reversed_p is set, this should test
11364 the right fringe, not the left one. */
11365 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11367 #ifdef HAVE_WINDOW_SYSTEM
11368 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11371 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11372 return make_number (fringe_bitmap
);
11375 return make_number (-1); /* Use default arrow bitmap */
11377 return overlay_arrow_string_or_property (var
);
11384 /* Return 1 if point moved out of or into a composition. Otherwise
11385 return 0. PREV_BUF and PREV_PT are the last point buffer and
11386 position. BUF and PT are the current point buffer and position. */
11389 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11390 struct buffer
*buf
, EMACS_INT pt
)
11392 EMACS_INT start
, end
;
11394 Lisp_Object buffer
;
11396 XSETBUFFER (buffer
, buf
);
11397 /* Check a composition at the last point if point moved within the
11399 if (prev_buf
== buf
)
11402 /* Point didn't move. */
11405 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11406 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11407 && COMPOSITION_VALID_P (start
, end
, prop
)
11408 && start
< prev_pt
&& end
> prev_pt
)
11409 /* The last point was within the composition. Return 1 iff
11410 point moved out of the composition. */
11411 return (pt
<= start
|| pt
>= end
);
11414 /* Check a composition at the current point. */
11415 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11416 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11417 && COMPOSITION_VALID_P (start
, end
, prop
)
11418 && start
< pt
&& end
> pt
);
11422 /* Reconsider the setting of B->clip_changed which is displayed
11426 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11428 if (b
->clip_changed
11429 && !NILP (w
->window_end_valid
)
11430 && w
->current_matrix
->buffer
== b
11431 && w
->current_matrix
->zv
== BUF_ZV (b
)
11432 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11433 b
->clip_changed
= 0;
11435 /* If display wasn't paused, and W is not a tool bar window, see if
11436 point has been moved into or out of a composition. In that case,
11437 we set b->clip_changed to 1 to force updating the screen. If
11438 b->clip_changed has already been set to 1, we can skip this
11440 if (!b
->clip_changed
11441 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11445 if (w
== XWINDOW (selected_window
))
11448 pt
= marker_position (w
->pointm
);
11450 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11451 || pt
!= XINT (w
->last_point
))
11452 && check_point_in_composition (w
->current_matrix
->buffer
,
11453 XINT (w
->last_point
),
11454 XBUFFER (w
->buffer
), pt
))
11455 b
->clip_changed
= 1;
11460 /* Select FRAME to forward the values of frame-local variables into C
11461 variables so that the redisplay routines can access those values
11465 select_frame_for_redisplay (Lisp_Object frame
)
11467 Lisp_Object tail
, tem
;
11468 Lisp_Object old
= selected_frame
;
11469 struct Lisp_Symbol
*sym
;
11471 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11473 selected_frame
= frame
;
11476 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11477 if (CONSP (XCAR (tail
))
11478 && (tem
= XCAR (XCAR (tail
)),
11480 && (sym
= indirect_variable (XSYMBOL (tem
)),
11481 sym
->redirect
== SYMBOL_LOCALIZED
)
11482 && sym
->val
.blv
->frame_local
)
11483 /* Use find_symbol_value rather than Fsymbol_value
11484 to avoid an error if it is void. */
11485 find_symbol_value (tem
);
11486 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11490 #define STOP_POLLING \
11491 do { if (! polling_stopped_here) stop_polling (); \
11492 polling_stopped_here = 1; } while (0)
11494 #define RESUME_POLLING \
11495 do { if (polling_stopped_here) start_polling (); \
11496 polling_stopped_here = 0; } while (0)
11499 /* Perhaps in the future avoid recentering windows if it
11500 is not necessary; currently that causes some problems. */
11503 redisplay_internal (void)
11505 struct window
*w
= XWINDOW (selected_window
);
11509 int must_finish
= 0;
11510 struct text_pos tlbufpos
, tlendpos
;
11511 int number_of_visible_frames
;
11514 int polling_stopped_here
= 0;
11515 Lisp_Object old_frame
= selected_frame
;
11517 /* Non-zero means redisplay has to consider all windows on all
11518 frames. Zero means, only selected_window is considered. */
11519 int consider_all_windows_p
;
11521 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11523 /* No redisplay if running in batch mode or frame is not yet fully
11524 initialized, or redisplay is explicitly turned off by setting
11525 Vinhibit_redisplay. */
11526 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11527 || !NILP (Vinhibit_redisplay
))
11530 /* Don't examine these until after testing Vinhibit_redisplay.
11531 When Emacs is shutting down, perhaps because its connection to
11532 X has dropped, we should not look at them at all. */
11533 fr
= XFRAME (w
->frame
);
11534 sf
= SELECTED_FRAME ();
11536 if (!fr
->glyphs_initialized_p
)
11539 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11540 if (popup_activated ())
11544 /* I don't think this happens but let's be paranoid. */
11545 if (redisplaying_p
)
11548 /* Record a function that resets redisplaying_p to its old value
11549 when we leave this function. */
11550 count
= SPECPDL_INDEX ();
11551 record_unwind_protect (unwind_redisplay
,
11552 Fcons (make_number (redisplaying_p
), selected_frame
));
11554 specbind (Qinhibit_free_realized_faces
, Qnil
);
11557 Lisp_Object tail
, frame
;
11559 FOR_EACH_FRAME (tail
, frame
)
11561 struct frame
*f
= XFRAME (frame
);
11562 f
->already_hscrolled_p
= 0;
11567 /* Remember the currently selected window. */
11570 if (!EQ (old_frame
, selected_frame
)
11571 && FRAME_LIVE_P (XFRAME (old_frame
)))
11572 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11573 selected_frame and selected_window to be temporarily out-of-sync so
11574 when we come back here via `goto retry', we need to resync because we
11575 may need to run Elisp code (via prepare_menu_bars). */
11576 select_frame_for_redisplay (old_frame
);
11579 reconsider_clip_changes (w
, current_buffer
);
11580 last_escape_glyph_frame
= NULL
;
11581 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11582 last_glyphless_glyph_frame
= NULL
;
11583 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11585 /* If new fonts have been loaded that make a glyph matrix adjustment
11586 necessary, do it. */
11587 if (fonts_changed_p
)
11589 adjust_glyphs (NULL
);
11590 ++windows_or_buffers_changed
;
11591 fonts_changed_p
= 0;
11594 /* If face_change_count is non-zero, init_iterator will free all
11595 realized faces, which includes the faces referenced from current
11596 matrices. So, we can't reuse current matrices in this case. */
11597 if (face_change_count
)
11598 ++windows_or_buffers_changed
;
11600 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11601 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11603 /* Since frames on a single ASCII terminal share the same
11604 display area, displaying a different frame means redisplay
11605 the whole thing. */
11606 windows_or_buffers_changed
++;
11607 SET_FRAME_GARBAGED (sf
);
11609 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11611 FRAME_TTY (sf
)->previous_frame
= sf
;
11614 /* Set the visible flags for all frames. Do this before checking
11615 for resized or garbaged frames; they want to know if their frames
11616 are visible. See the comment in frame.h for
11617 FRAME_SAMPLE_VISIBILITY. */
11619 Lisp_Object tail
, frame
;
11621 number_of_visible_frames
= 0;
11623 FOR_EACH_FRAME (tail
, frame
)
11625 struct frame
*f
= XFRAME (frame
);
11627 FRAME_SAMPLE_VISIBILITY (f
);
11628 if (FRAME_VISIBLE_P (f
))
11629 ++number_of_visible_frames
;
11630 clear_desired_matrices (f
);
11634 /* Notice any pending interrupt request to change frame size. */
11635 do_pending_window_change (1);
11637 /* do_pending_window_change could change the selected_window due to
11638 frame resizing which makes the selected window too small. */
11639 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11642 reconsider_clip_changes (w
, current_buffer
);
11645 /* Clear frames marked as garbaged. */
11646 if (frame_garbaged
)
11647 clear_garbaged_frames ();
11649 /* Build menubar and tool-bar items. */
11650 if (NILP (Vmemory_full
))
11651 prepare_menu_bars ();
11653 if (windows_or_buffers_changed
)
11654 update_mode_lines
++;
11656 /* Detect case that we need to write or remove a star in the mode line. */
11657 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11659 w
->update_mode_line
= Qt
;
11660 if (buffer_shared
> 1)
11661 update_mode_lines
++;
11664 /* Avoid invocation of point motion hooks by `current_column' below. */
11665 count1
= SPECPDL_INDEX ();
11666 specbind (Qinhibit_point_motion_hooks
, Qt
);
11668 /* If %c is in the mode line, update it if needed. */
11669 if (!NILP (w
->column_number_displayed
)
11670 /* This alternative quickly identifies a common case
11671 where no change is needed. */
11672 && !(PT
== XFASTINT (w
->last_point
)
11673 && XFASTINT (w
->last_modified
) >= MODIFF
11674 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11675 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11676 w
->update_mode_line
= Qt
;
11678 unbind_to (count1
, Qnil
);
11680 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11682 /* The variable buffer_shared is set in redisplay_window and
11683 indicates that we redisplay a buffer in different windows. See
11685 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11686 || cursor_type_changed
);
11688 /* If specs for an arrow have changed, do thorough redisplay
11689 to ensure we remove any arrow that should no longer exist. */
11690 if (overlay_arrows_changed_p ())
11691 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11693 /* Normally the message* functions will have already displayed and
11694 updated the echo area, but the frame may have been trashed, or
11695 the update may have been preempted, so display the echo area
11696 again here. Checking message_cleared_p captures the case that
11697 the echo area should be cleared. */
11698 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11699 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11700 || (message_cleared_p
11701 && minibuf_level
== 0
11702 /* If the mini-window is currently selected, this means the
11703 echo-area doesn't show through. */
11704 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11706 int window_height_changed_p
= echo_area_display (0);
11709 /* If we don't display the current message, don't clear the
11710 message_cleared_p flag, because, if we did, we wouldn't clear
11711 the echo area in the next redisplay which doesn't preserve
11713 if (!display_last_displayed_message_p
)
11714 message_cleared_p
= 0;
11716 if (fonts_changed_p
)
11718 else if (window_height_changed_p
)
11720 consider_all_windows_p
= 1;
11721 ++update_mode_lines
;
11722 ++windows_or_buffers_changed
;
11724 /* If window configuration was changed, frames may have been
11725 marked garbaged. Clear them or we will experience
11726 surprises wrt scrolling. */
11727 if (frame_garbaged
)
11728 clear_garbaged_frames ();
11731 else if (EQ (selected_window
, minibuf_window
)
11732 && (current_buffer
->clip_changed
11733 || XFASTINT (w
->last_modified
) < MODIFF
11734 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11735 && resize_mini_window (w
, 0))
11737 /* Resized active mini-window to fit the size of what it is
11738 showing if its contents might have changed. */
11740 /* FIXME: this causes all frames to be updated, which seems unnecessary
11741 since only the current frame needs to be considered. This function needs
11742 to be rewritten with two variables, consider_all_windows and
11743 consider_all_frames. */
11744 consider_all_windows_p
= 1;
11745 ++windows_or_buffers_changed
;
11746 ++update_mode_lines
;
11748 /* If window configuration was changed, frames may have been
11749 marked garbaged. Clear them or we will experience
11750 surprises wrt scrolling. */
11751 if (frame_garbaged
)
11752 clear_garbaged_frames ();
11756 /* If showing the region, and mark has changed, we must redisplay
11757 the whole window. The assignment to this_line_start_pos prevents
11758 the optimization directly below this if-statement. */
11759 if (((!NILP (Vtransient_mark_mode
)
11760 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11761 != !NILP (w
->region_showing
))
11762 || (!NILP (w
->region_showing
)
11763 && !EQ (w
->region_showing
,
11764 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11765 CHARPOS (this_line_start_pos
) = 0;
11767 /* Optimize the case that only the line containing the cursor in the
11768 selected window has changed. Variables starting with this_ are
11769 set in display_line and record information about the line
11770 containing the cursor. */
11771 tlbufpos
= this_line_start_pos
;
11772 tlendpos
= this_line_end_pos
;
11773 if (!consider_all_windows_p
11774 && CHARPOS (tlbufpos
) > 0
11775 && NILP (w
->update_mode_line
)
11776 && !current_buffer
->clip_changed
11777 && !current_buffer
->prevent_redisplay_optimizations_p
11778 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11779 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11780 /* Make sure recorded data applies to current buffer, etc. */
11781 && this_line_buffer
== current_buffer
11782 && current_buffer
== XBUFFER (w
->buffer
)
11783 && NILP (w
->force_start
)
11784 && NILP (w
->optional_new_start
)
11785 /* Point must be on the line that we have info recorded about. */
11786 && PT
>= CHARPOS (tlbufpos
)
11787 && PT
<= Z
- CHARPOS (tlendpos
)
11788 /* All text outside that line, including its final newline,
11789 must be unchanged. */
11790 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11791 CHARPOS (tlendpos
)))
11793 if (CHARPOS (tlbufpos
) > BEGV
11794 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11795 && (CHARPOS (tlbufpos
) == ZV
11796 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11797 /* Former continuation line has disappeared by becoming empty. */
11799 else if (XFASTINT (w
->last_modified
) < MODIFF
11800 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11801 || MINI_WINDOW_P (w
))
11803 /* We have to handle the case of continuation around a
11804 wide-column character (see the comment in indent.c around
11807 For instance, in the following case:
11809 -------- Insert --------
11810 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11811 J_I_ ==> J_I_ `^^' are cursors.
11815 As we have to redraw the line above, we cannot use this
11819 int line_height_before
= this_line_pixel_height
;
11821 /* Note that start_display will handle the case that the
11822 line starting at tlbufpos is a continuation line. */
11823 start_display (&it
, w
, tlbufpos
);
11825 /* Implementation note: It this still necessary? */
11826 if (it
.current_x
!= this_line_start_x
)
11829 TRACE ((stderr
, "trying display optimization 1\n"));
11830 w
->cursor
.vpos
= -1;
11831 overlay_arrow_seen
= 0;
11832 it
.vpos
= this_line_vpos
;
11833 it
.current_y
= this_line_y
;
11834 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11835 display_line (&it
);
11837 /* If line contains point, is not continued,
11838 and ends at same distance from eob as before, we win. */
11839 if (w
->cursor
.vpos
>= 0
11840 /* Line is not continued, otherwise this_line_start_pos
11841 would have been set to 0 in display_line. */
11842 && CHARPOS (this_line_start_pos
)
11843 /* Line ends as before. */
11844 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11845 /* Line has same height as before. Otherwise other lines
11846 would have to be shifted up or down. */
11847 && this_line_pixel_height
== line_height_before
)
11849 /* If this is not the window's last line, we must adjust
11850 the charstarts of the lines below. */
11851 if (it
.current_y
< it
.last_visible_y
)
11853 struct glyph_row
*row
11854 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11855 EMACS_INT delta
, delta_bytes
;
11857 /* We used to distinguish between two cases here,
11858 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11859 when the line ends in a newline or the end of the
11860 buffer's accessible portion. But both cases did
11861 the same, so they were collapsed. */
11863 - CHARPOS (tlendpos
)
11864 - MATRIX_ROW_START_CHARPOS (row
));
11865 delta_bytes
= (Z_BYTE
11866 - BYTEPOS (tlendpos
)
11867 - MATRIX_ROW_START_BYTEPOS (row
));
11869 increment_matrix_positions (w
->current_matrix
,
11870 this_line_vpos
+ 1,
11871 w
->current_matrix
->nrows
,
11872 delta
, delta_bytes
);
11875 /* If this row displays text now but previously didn't,
11876 or vice versa, w->window_end_vpos may have to be
11878 if ((it
.glyph_row
- 1)->displays_text_p
)
11880 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11881 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11883 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11884 && this_line_vpos
> 0)
11885 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11886 w
->window_end_valid
= Qnil
;
11888 /* Update hint: No need to try to scroll in update_window. */
11889 w
->desired_matrix
->no_scrolling_p
= 1;
11892 *w
->desired_matrix
->method
= 0;
11893 debug_method_add (w
, "optimization 1");
11895 #ifdef HAVE_WINDOW_SYSTEM
11896 update_window_fringes (w
, 0);
11903 else if (/* Cursor position hasn't changed. */
11904 PT
== XFASTINT (w
->last_point
)
11905 /* Make sure the cursor was last displayed
11906 in this window. Otherwise we have to reposition it. */
11907 && 0 <= w
->cursor
.vpos
11908 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11912 do_pending_window_change (1);
11913 /* If selected_window changed, redisplay again. */
11914 if (WINDOWP (selected_window
)
11915 && (w
= XWINDOW (selected_window
)) != sw
)
11918 /* We used to always goto end_of_redisplay here, but this
11919 isn't enough if we have a blinking cursor. */
11920 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11921 goto end_of_redisplay
;
11925 /* If highlighting the region, or if the cursor is in the echo area,
11926 then we can't just move the cursor. */
11927 else if (! (!NILP (Vtransient_mark_mode
)
11928 && !NILP (BVAR (current_buffer
, mark_active
)))
11929 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11930 || highlight_nonselected_windows
)
11931 && NILP (w
->region_showing
)
11932 && NILP (Vshow_trailing_whitespace
)
11933 && !cursor_in_echo_area
)
11936 struct glyph_row
*row
;
11938 /* Skip from tlbufpos to PT and see where it is. Note that
11939 PT may be in invisible text. If so, we will end at the
11940 next visible position. */
11941 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11942 NULL
, DEFAULT_FACE_ID
);
11943 it
.current_x
= this_line_start_x
;
11944 it
.current_y
= this_line_y
;
11945 it
.vpos
= this_line_vpos
;
11947 /* The call to move_it_to stops in front of PT, but
11948 moves over before-strings. */
11949 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11951 if (it
.vpos
== this_line_vpos
11952 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11955 xassert (this_line_vpos
== it
.vpos
);
11956 xassert (this_line_y
== it
.current_y
);
11957 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11959 *w
->desired_matrix
->method
= 0;
11960 debug_method_add (w
, "optimization 3");
11969 /* Text changed drastically or point moved off of line. */
11970 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11973 CHARPOS (this_line_start_pos
) = 0;
11974 consider_all_windows_p
|= buffer_shared
> 1;
11975 ++clear_face_cache_count
;
11976 #ifdef HAVE_WINDOW_SYSTEM
11977 ++clear_image_cache_count
;
11980 /* Build desired matrices, and update the display. If
11981 consider_all_windows_p is non-zero, do it for all windows on all
11982 frames. Otherwise do it for selected_window, only. */
11984 if (consider_all_windows_p
)
11986 Lisp_Object tail
, frame
;
11988 FOR_EACH_FRAME (tail
, frame
)
11989 XFRAME (frame
)->updated_p
= 0;
11991 /* Recompute # windows showing selected buffer. This will be
11992 incremented each time such a window is displayed. */
11995 FOR_EACH_FRAME (tail
, frame
)
11997 struct frame
*f
= XFRAME (frame
);
11999 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12001 if (! EQ (frame
, selected_frame
))
12002 /* Select the frame, for the sake of frame-local
12004 select_frame_for_redisplay (frame
);
12006 /* Mark all the scroll bars to be removed; we'll redeem
12007 the ones we want when we redisplay their windows. */
12008 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12009 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12011 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12012 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12014 /* The X error handler may have deleted that frame. */
12015 if (!FRAME_LIVE_P (f
))
12018 /* Any scroll bars which redisplay_windows should have
12019 nuked should now go away. */
12020 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12021 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12023 /* If fonts changed, display again. */
12024 /* ??? rms: I suspect it is a mistake to jump all the way
12025 back to retry here. It should just retry this frame. */
12026 if (fonts_changed_p
)
12029 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12031 /* See if we have to hscroll. */
12032 if (!f
->already_hscrolled_p
)
12034 f
->already_hscrolled_p
= 1;
12035 if (hscroll_windows (f
->root_window
))
12039 /* Prevent various kinds of signals during display
12040 update. stdio is not robust about handling
12041 signals, which can cause an apparent I/O
12043 if (interrupt_input
)
12044 unrequest_sigio ();
12047 /* Update the display. */
12048 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12049 pending
|= update_frame (f
, 0, 0);
12055 if (!EQ (old_frame
, selected_frame
)
12056 && FRAME_LIVE_P (XFRAME (old_frame
)))
12057 /* We played a bit fast-and-loose above and allowed selected_frame
12058 and selected_window to be temporarily out-of-sync but let's make
12059 sure this stays contained. */
12060 select_frame_for_redisplay (old_frame
);
12061 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12065 /* Do the mark_window_display_accurate after all windows have
12066 been redisplayed because this call resets flags in buffers
12067 which are needed for proper redisplay. */
12068 FOR_EACH_FRAME (tail
, frame
)
12070 struct frame
*f
= XFRAME (frame
);
12073 mark_window_display_accurate (f
->root_window
, 1);
12074 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12075 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12080 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12082 Lisp_Object mini_window
;
12083 struct frame
*mini_frame
;
12085 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12086 /* Use list_of_error, not Qerror, so that
12087 we catch only errors and don't run the debugger. */
12088 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12090 redisplay_window_error
);
12092 /* Compare desired and current matrices, perform output. */
12095 /* If fonts changed, display again. */
12096 if (fonts_changed_p
)
12099 /* Prevent various kinds of signals during display update.
12100 stdio is not robust about handling signals,
12101 which can cause an apparent I/O error. */
12102 if (interrupt_input
)
12103 unrequest_sigio ();
12106 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12108 if (hscroll_windows (selected_window
))
12111 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12112 pending
= update_frame (sf
, 0, 0);
12115 /* We may have called echo_area_display at the top of this
12116 function. If the echo area is on another frame, that may
12117 have put text on a frame other than the selected one, so the
12118 above call to update_frame would not have caught it. Catch
12120 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12121 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12123 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12125 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12126 pending
|= update_frame (mini_frame
, 0, 0);
12127 if (!pending
&& hscroll_windows (mini_window
))
12132 /* If display was paused because of pending input, make sure we do a
12133 thorough update the next time. */
12136 /* Prevent the optimization at the beginning of
12137 redisplay_internal that tries a single-line update of the
12138 line containing the cursor in the selected window. */
12139 CHARPOS (this_line_start_pos
) = 0;
12141 /* Let the overlay arrow be updated the next time. */
12142 update_overlay_arrows (0);
12144 /* If we pause after scrolling, some rows in the current
12145 matrices of some windows are not valid. */
12146 if (!WINDOW_FULL_WIDTH_P (w
)
12147 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12148 update_mode_lines
= 1;
12152 if (!consider_all_windows_p
)
12154 /* This has already been done above if
12155 consider_all_windows_p is set. */
12156 mark_window_display_accurate_1 (w
, 1);
12158 /* Say overlay arrows are up to date. */
12159 update_overlay_arrows (1);
12161 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12162 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12165 update_mode_lines
= 0;
12166 windows_or_buffers_changed
= 0;
12167 cursor_type_changed
= 0;
12170 /* Start SIGIO interrupts coming again. Having them off during the
12171 code above makes it less likely one will discard output, but not
12172 impossible, since there might be stuff in the system buffer here.
12173 But it is much hairier to try to do anything about that. */
12174 if (interrupt_input
)
12178 /* If a frame has become visible which was not before, redisplay
12179 again, so that we display it. Expose events for such a frame
12180 (which it gets when becoming visible) don't call the parts of
12181 redisplay constructing glyphs, so simply exposing a frame won't
12182 display anything in this case. So, we have to display these
12183 frames here explicitly. */
12186 Lisp_Object tail
, frame
;
12189 FOR_EACH_FRAME (tail
, frame
)
12191 int this_is_visible
= 0;
12193 if (XFRAME (frame
)->visible
)
12194 this_is_visible
= 1;
12195 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12196 if (XFRAME (frame
)->visible
)
12197 this_is_visible
= 1;
12199 if (this_is_visible
)
12203 if (new_count
!= number_of_visible_frames
)
12204 windows_or_buffers_changed
++;
12207 /* Change frame size now if a change is pending. */
12208 do_pending_window_change (1);
12210 /* If we just did a pending size change, or have additional
12211 visible frames, or selected_window changed, redisplay again. */
12212 if ((windows_or_buffers_changed
&& !pending
)
12213 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12216 /* Clear the face and image caches.
12218 We used to do this only if consider_all_windows_p. But the cache
12219 needs to be cleared if a timer creates images in the current
12220 buffer (e.g. the test case in Bug#6230). */
12222 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12224 clear_face_cache (0);
12225 clear_face_cache_count
= 0;
12228 #ifdef HAVE_WINDOW_SYSTEM
12229 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12231 clear_image_caches (Qnil
);
12232 clear_image_cache_count
= 0;
12234 #endif /* HAVE_WINDOW_SYSTEM */
12237 unbind_to (count
, Qnil
);
12242 /* Redisplay, but leave alone any recent echo area message unless
12243 another message has been requested in its place.
12245 This is useful in situations where you need to redisplay but no
12246 user action has occurred, making it inappropriate for the message
12247 area to be cleared. See tracking_off and
12248 wait_reading_process_output for examples of these situations.
12250 FROM_WHERE is an integer saying from where this function was
12251 called. This is useful for debugging. */
12254 redisplay_preserve_echo_area (int from_where
)
12256 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12258 if (!NILP (echo_area_buffer
[1]))
12260 /* We have a previously displayed message, but no current
12261 message. Redisplay the previous message. */
12262 display_last_displayed_message_p
= 1;
12263 redisplay_internal ();
12264 display_last_displayed_message_p
= 0;
12267 redisplay_internal ();
12269 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12270 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12271 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12275 /* Function registered with record_unwind_protect in
12276 redisplay_internal. Reset redisplaying_p to the value it had
12277 before redisplay_internal was called, and clear
12278 prevent_freeing_realized_faces_p. It also selects the previously
12279 selected frame, unless it has been deleted (by an X connection
12280 failure during redisplay, for example). */
12283 unwind_redisplay (Lisp_Object val
)
12285 Lisp_Object old_redisplaying_p
, old_frame
;
12287 old_redisplaying_p
= XCAR (val
);
12288 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12289 old_frame
= XCDR (val
);
12290 if (! EQ (old_frame
, selected_frame
)
12291 && FRAME_LIVE_P (XFRAME (old_frame
)))
12292 select_frame_for_redisplay (old_frame
);
12297 /* Mark the display of window W as accurate or inaccurate. If
12298 ACCURATE_P is non-zero mark display of W as accurate. If
12299 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12300 redisplay_internal is called. */
12303 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12305 if (BUFFERP (w
->buffer
))
12307 struct buffer
*b
= XBUFFER (w
->buffer
);
12310 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12311 w
->last_overlay_modified
12312 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12314 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12318 b
->clip_changed
= 0;
12319 b
->prevent_redisplay_optimizations_p
= 0;
12321 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12322 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12323 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12324 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12326 w
->current_matrix
->buffer
= b
;
12327 w
->current_matrix
->begv
= BUF_BEGV (b
);
12328 w
->current_matrix
->zv
= BUF_ZV (b
);
12330 w
->last_cursor
= w
->cursor
;
12331 w
->last_cursor_off_p
= w
->cursor_off_p
;
12333 if (w
== XWINDOW (selected_window
))
12334 w
->last_point
= make_number (BUF_PT (b
));
12336 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12342 w
->window_end_valid
= w
->buffer
;
12343 w
->update_mode_line
= Qnil
;
12348 /* Mark the display of windows in the window tree rooted at WINDOW as
12349 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12350 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12351 be redisplayed the next time redisplay_internal is called. */
12354 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12358 for (; !NILP (window
); window
= w
->next
)
12360 w
= XWINDOW (window
);
12361 mark_window_display_accurate_1 (w
, accurate_p
);
12363 if (!NILP (w
->vchild
))
12364 mark_window_display_accurate (w
->vchild
, accurate_p
);
12365 if (!NILP (w
->hchild
))
12366 mark_window_display_accurate (w
->hchild
, accurate_p
);
12371 update_overlay_arrows (1);
12375 /* Force a thorough redisplay the next time by setting
12376 last_arrow_position and last_arrow_string to t, which is
12377 unequal to any useful value of Voverlay_arrow_... */
12378 update_overlay_arrows (-1);
12383 /* Return value in display table DP (Lisp_Char_Table *) for character
12384 C. Since a display table doesn't have any parent, we don't have to
12385 follow parent. Do not call this function directly but use the
12386 macro DISP_CHAR_VECTOR. */
12389 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12393 if (ASCII_CHAR_P (c
))
12396 if (SUB_CHAR_TABLE_P (val
))
12397 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12403 XSETCHAR_TABLE (table
, dp
);
12404 val
= char_table_ref (table
, c
);
12413 /***********************************************************************
12415 ***********************************************************************/
12417 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12420 redisplay_windows (Lisp_Object window
)
12422 while (!NILP (window
))
12424 struct window
*w
= XWINDOW (window
);
12426 if (!NILP (w
->hchild
))
12427 redisplay_windows (w
->hchild
);
12428 else if (!NILP (w
->vchild
))
12429 redisplay_windows (w
->vchild
);
12430 else if (!NILP (w
->buffer
))
12432 displayed_buffer
= XBUFFER (w
->buffer
);
12433 /* Use list_of_error, not Qerror, so that
12434 we catch only errors and don't run the debugger. */
12435 internal_condition_case_1 (redisplay_window_0
, window
,
12437 redisplay_window_error
);
12445 redisplay_window_error (Lisp_Object ignore
)
12447 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12452 redisplay_window_0 (Lisp_Object window
)
12454 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12455 redisplay_window (window
, 0);
12460 redisplay_window_1 (Lisp_Object window
)
12462 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12463 redisplay_window (window
, 1);
12468 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12469 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12470 which positions recorded in ROW differ from current buffer
12473 Return 0 if cursor is not on this row, 1 otherwise. */
12476 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12477 struct glyph_matrix
*matrix
,
12478 EMACS_INT delta
, EMACS_INT delta_bytes
,
12481 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12482 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12483 struct glyph
*cursor
= NULL
;
12484 /* The last known character position in row. */
12485 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12487 EMACS_INT pt_old
= PT
- delta
;
12488 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12489 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12490 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12491 /* A glyph beyond the edge of TEXT_AREA which we should never
12493 struct glyph
*glyphs_end
= end
;
12494 /* Non-zero means we've found a match for cursor position, but that
12495 glyph has the avoid_cursor_p flag set. */
12496 int match_with_avoid_cursor
= 0;
12497 /* Non-zero means we've seen at least one glyph that came from a
12499 int string_seen
= 0;
12500 /* Largest and smalles buffer positions seen so far during scan of
12502 EMACS_INT bpos_max
= pos_before
;
12503 EMACS_INT bpos_min
= pos_after
;
12504 /* Last buffer position covered by an overlay string with an integer
12505 `cursor' property. */
12506 EMACS_INT bpos_covered
= 0;
12508 /* Skip over glyphs not having an object at the start and the end of
12509 the row. These are special glyphs like truncation marks on
12510 terminal frames. */
12511 if (row
->displays_text_p
)
12513 if (!row
->reversed_p
)
12516 && INTEGERP (glyph
->object
)
12517 && glyph
->charpos
< 0)
12519 x
+= glyph
->pixel_width
;
12523 && INTEGERP ((end
- 1)->object
)
12524 /* CHARPOS is zero for blanks and stretch glyphs
12525 inserted by extend_face_to_end_of_line. */
12526 && (end
- 1)->charpos
<= 0)
12528 glyph_before
= glyph
- 1;
12535 /* If the glyph row is reversed, we need to process it from back
12536 to front, so swap the edge pointers. */
12537 glyphs_end
= end
= glyph
- 1;
12538 glyph
+= row
->used
[TEXT_AREA
] - 1;
12540 while (glyph
> end
+ 1
12541 && INTEGERP (glyph
->object
)
12542 && glyph
->charpos
< 0)
12545 x
-= glyph
->pixel_width
;
12547 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12549 /* By default, in reversed rows we put the cursor on the
12550 rightmost (first in the reading order) glyph. */
12551 for (g
= end
+ 1; g
< glyph
; g
++)
12552 x
+= g
->pixel_width
;
12554 && INTEGERP ((end
+ 1)->object
)
12555 && (end
+ 1)->charpos
<= 0)
12557 glyph_before
= glyph
+ 1;
12561 else if (row
->reversed_p
)
12563 /* In R2L rows that don't display text, put the cursor on the
12564 rightmost glyph. Case in point: an empty last line that is
12565 part of an R2L paragraph. */
12567 /* Avoid placing the cursor on the last glyph of the row, where
12568 on terminal frames we hold the vertical border between
12569 adjacent windows. */
12570 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12571 && !WINDOW_RIGHTMOST_P (w
)
12572 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12574 x
= -1; /* will be computed below, at label compute_x */
12577 /* Step 1: Try to find the glyph whose character position
12578 corresponds to point. If that's not possible, find 2 glyphs
12579 whose character positions are the closest to point, one before
12580 point, the other after it. */
12581 if (!row
->reversed_p
)
12582 while (/* not marched to end of glyph row */
12584 /* glyph was not inserted by redisplay for internal purposes */
12585 && !INTEGERP (glyph
->object
))
12587 if (BUFFERP (glyph
->object
))
12589 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12591 if (glyph
->charpos
> bpos_max
)
12592 bpos_max
= glyph
->charpos
;
12593 if (glyph
->charpos
< bpos_min
)
12594 bpos_min
= glyph
->charpos
;
12595 if (!glyph
->avoid_cursor_p
)
12597 /* If we hit point, we've found the glyph on which to
12598 display the cursor. */
12601 match_with_avoid_cursor
= 0;
12604 /* See if we've found a better approximation to
12605 POS_BEFORE or to POS_AFTER. Note that we want the
12606 first (leftmost) glyph of all those that are the
12607 closest from below, and the last (rightmost) of all
12608 those from above. */
12609 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12611 pos_before
= glyph
->charpos
;
12612 glyph_before
= glyph
;
12614 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12616 pos_after
= glyph
->charpos
;
12617 glyph_after
= glyph
;
12620 else if (dpos
== 0)
12621 match_with_avoid_cursor
= 1;
12623 else if (STRINGP (glyph
->object
))
12625 Lisp_Object chprop
;
12626 EMACS_INT glyph_pos
= glyph
->charpos
;
12628 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12630 if (INTEGERP (chprop
))
12632 bpos_covered
= bpos_max
+ XINT (chprop
);
12633 /* If the `cursor' property covers buffer positions up
12634 to and including point, we should display cursor on
12635 this glyph. Note that overlays and text properties
12636 with string values stop bidi reordering, so every
12637 buffer position to the left of the string is always
12638 smaller than any position to the right of the
12639 string. Therefore, if a `cursor' property on one
12640 of the string's characters has an integer value, we
12641 will break out of the loop below _before_ we get to
12642 the position match above. IOW, integer values of
12643 the `cursor' property override the "exact match for
12644 point" strategy of positioning the cursor. */
12645 /* Implementation note: bpos_max == pt_old when, e.g.,
12646 we are in an empty line, where bpos_max is set to
12647 MATRIX_ROW_START_CHARPOS, see above. */
12648 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12657 x
+= glyph
->pixel_width
;
12660 else if (glyph
> end
) /* row is reversed */
12661 while (!INTEGERP (glyph
->object
))
12663 if (BUFFERP (glyph
->object
))
12665 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12667 if (glyph
->charpos
> bpos_max
)
12668 bpos_max
= glyph
->charpos
;
12669 if (glyph
->charpos
< bpos_min
)
12670 bpos_min
= glyph
->charpos
;
12671 if (!glyph
->avoid_cursor_p
)
12675 match_with_avoid_cursor
= 0;
12678 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12680 pos_before
= glyph
->charpos
;
12681 glyph_before
= glyph
;
12683 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12685 pos_after
= glyph
->charpos
;
12686 glyph_after
= glyph
;
12689 else if (dpos
== 0)
12690 match_with_avoid_cursor
= 1;
12692 else if (STRINGP (glyph
->object
))
12694 Lisp_Object chprop
;
12695 EMACS_INT glyph_pos
= glyph
->charpos
;
12697 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12699 if (INTEGERP (chprop
))
12701 bpos_covered
= bpos_max
+ XINT (chprop
);
12702 /* If the `cursor' property covers buffer positions up
12703 to and including point, we should display cursor on
12705 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12714 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12716 x
--; /* can't use any pixel_width */
12719 x
-= glyph
->pixel_width
;
12722 /* Step 2: If we didn't find an exact match for point, we need to
12723 look for a proper place to put the cursor among glyphs between
12724 GLYPH_BEFORE and GLYPH_AFTER. */
12725 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12726 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12727 && bpos_covered
< pt_old
)
12729 /* An empty line has a single glyph whose OBJECT is zero and
12730 whose CHARPOS is the position of a newline on that line.
12731 Note that on a TTY, there are more glyphs after that, which
12732 were produced by extend_face_to_end_of_line, but their
12733 CHARPOS is zero or negative. */
12735 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12736 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12738 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12740 EMACS_INT ellipsis_pos
;
12742 /* Scan back over the ellipsis glyphs. */
12743 if (!row
->reversed_p
)
12745 ellipsis_pos
= (glyph
- 1)->charpos
;
12746 while (glyph
> row
->glyphs
[TEXT_AREA
]
12747 && (glyph
- 1)->charpos
== ellipsis_pos
)
12748 glyph
--, x
-= glyph
->pixel_width
;
12749 /* That loop always goes one position too far, including
12750 the glyph before the ellipsis. So scan forward over
12752 x
+= glyph
->pixel_width
;
12755 else /* row is reversed */
12757 ellipsis_pos
= (glyph
+ 1)->charpos
;
12758 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12759 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12760 glyph
++, x
+= glyph
->pixel_width
;
12761 x
-= glyph
->pixel_width
;
12765 else if (match_with_avoid_cursor
12766 /* A truncated row may not include PT among its
12767 character positions. Setting the cursor inside the
12768 scroll margin will trigger recalculation of hscroll
12769 in hscroll_window_tree. */
12770 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12771 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12772 /* Zero-width characters produce no glyphs. */
12775 && (row
->reversed_p
12776 ? glyph_after
> glyphs_end
12777 : glyph_after
< glyphs_end
)))
12779 cursor
= glyph_after
;
12782 else if (string_seen
)
12784 int incr
= row
->reversed_p
? -1 : +1;
12786 /* Need to find the glyph that came out of a string which is
12787 present at point. That glyph is somewhere between
12788 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12789 positioned between POS_BEFORE and POS_AFTER in the
12791 struct glyph
*start
, *stop
;
12792 EMACS_INT pos
= pos_before
;
12796 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
12797 correspond to POS_BEFORE and POS_AFTER, respectively. We
12798 need START and STOP in the order that corresponds to the
12799 row's direction as given by its reversed_p flag. If the
12800 directionality of characters between POS_BEFORE and
12801 POS_AFTER is the opposite of the row's base direction,
12802 these characters will have been reordered for display,
12803 and we need to reverse START and STOP. */
12804 if (!row
->reversed_p
)
12806 start
= min (glyph_before
, glyph_after
);
12807 stop
= max (glyph_before
, glyph_after
);
12811 start
= max (glyph_before
, glyph_after
);
12812 stop
= min (glyph_before
, glyph_after
);
12814 for (glyph
= start
+ incr
;
12815 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12818 /* Any glyphs that come from the buffer are here because
12819 of bidi reordering. Skip them, and only pay
12820 attention to glyphs that came from some string. */
12821 if (STRINGP (glyph
->object
))
12826 str
= glyph
->object
;
12827 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12828 if (tem
== 0 /* from overlay */
12831 /* If the string from which this glyph came is
12832 found in the buffer at point, then we've
12833 found the glyph we've been looking for. If
12834 it comes from an overlay (tem == 0), and it
12835 has the `cursor' property on one of its
12836 glyphs, record that glyph as a candidate for
12837 displaying the cursor. (As in the
12838 unidirectional version, we will display the
12839 cursor on the last candidate we find.) */
12840 if (tem
== 0 || tem
== pt_old
)
12842 /* The glyphs from this string could have
12843 been reordered. Find the one with the
12844 smallest string position. Or there could
12845 be a character in the string with the
12846 `cursor' property, which means display
12847 cursor on that character's glyph. */
12848 EMACS_INT strpos
= glyph
->charpos
;
12853 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12854 && EQ (glyph
->object
, str
);
12858 EMACS_INT gpos
= glyph
->charpos
;
12860 cprop
= Fget_char_property (make_number (gpos
),
12868 if (tem
&& glyph
->charpos
< strpos
)
12870 strpos
= glyph
->charpos
;
12879 pos
= tem
+ 1; /* don't find previous instances */
12881 /* This string is not what we want; skip all of the
12882 glyphs that came from it. */
12883 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12884 && EQ (glyph
->object
, str
))
12891 /* If we reached the end of the line, and END was from a string,
12892 the cursor is not on this line. */
12894 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12895 && STRINGP (end
->object
)
12896 && row
->continued_p
)
12902 if (cursor
!= NULL
)
12908 /* Need to compute x that corresponds to GLYPH. */
12909 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12911 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12913 x
+= g
->pixel_width
;
12917 /* ROW could be part of a continued line, which, under bidi
12918 reordering, might have other rows whose start and end charpos
12919 occlude point. Only set w->cursor if we found a better
12920 approximation to the cursor position than we have from previously
12921 examined candidate rows belonging to the same continued line. */
12922 if (/* we already have a candidate row */
12923 w
->cursor
.vpos
>= 0
12924 /* that candidate is not the row we are processing */
12925 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12926 /* the row we are processing is part of a continued line */
12927 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12928 /* Make sure cursor.vpos specifies a row whose start and end
12929 charpos occlude point. This is because some callers of this
12930 function leave cursor.vpos at the row where the cursor was
12931 displayed during the last redisplay cycle. */
12932 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12933 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12936 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12938 /* Don't consider glyphs that are outside TEXT_AREA. */
12939 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12941 /* Keep the candidate whose buffer position is the closest to
12943 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12944 w
->cursor
.hpos
>= 0
12945 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12946 && BUFFERP (g1
->object
)
12947 && (g1
->charpos
== pt_old
/* an exact match always wins */
12948 || (BUFFERP (glyph
->object
)
12949 && eabs (g1
->charpos
- pt_old
)
12950 < eabs (glyph
->charpos
- pt_old
))))
12952 /* If this candidate gives an exact match, use that. */
12953 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12954 /* Otherwise, keep the candidate that comes from a row
12955 spanning less buffer positions. This may win when one or
12956 both candidate positions are on glyphs that came from
12957 display strings, for which we cannot compare buffer
12959 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12960 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12961 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12964 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12966 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12967 w
->cursor
.y
= row
->y
+ dy
;
12969 if (w
== XWINDOW (selected_window
))
12971 if (!row
->continued_p
12972 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12975 this_line_buffer
= XBUFFER (w
->buffer
);
12977 CHARPOS (this_line_start_pos
)
12978 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12979 BYTEPOS (this_line_start_pos
)
12980 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12982 CHARPOS (this_line_end_pos
)
12983 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12984 BYTEPOS (this_line_end_pos
)
12985 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12987 this_line_y
= w
->cursor
.y
;
12988 this_line_pixel_height
= row
->height
;
12989 this_line_vpos
= w
->cursor
.vpos
;
12990 this_line_start_x
= row
->x
;
12993 CHARPOS (this_line_start_pos
) = 0;
13000 /* Run window scroll functions, if any, for WINDOW with new window
13001 start STARTP. Sets the window start of WINDOW to that position.
13003 We assume that the window's buffer is really current. */
13005 static inline struct text_pos
13006 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13008 struct window
*w
= XWINDOW (window
);
13009 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13011 if (current_buffer
!= XBUFFER (w
->buffer
))
13014 if (!NILP (Vwindow_scroll_functions
))
13016 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13017 make_number (CHARPOS (startp
)));
13018 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13019 /* In case the hook functions switch buffers. */
13020 if (current_buffer
!= XBUFFER (w
->buffer
))
13021 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13028 /* Make sure the line containing the cursor is fully visible.
13029 A value of 1 means there is nothing to be done.
13030 (Either the line is fully visible, or it cannot be made so,
13031 or we cannot tell.)
13033 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13034 is higher than window.
13036 A value of 0 means the caller should do scrolling
13037 as if point had gone off the screen. */
13040 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13042 struct glyph_matrix
*matrix
;
13043 struct glyph_row
*row
;
13046 if (!make_cursor_line_fully_visible_p
)
13049 /* It's not always possible to find the cursor, e.g, when a window
13050 is full of overlay strings. Don't do anything in that case. */
13051 if (w
->cursor
.vpos
< 0)
13054 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13055 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13057 /* If the cursor row is not partially visible, there's nothing to do. */
13058 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13061 /* If the row the cursor is in is taller than the window's height,
13062 it's not clear what to do, so do nothing. */
13063 window_height
= window_box_height (w
);
13064 if (row
->height
>= window_height
)
13066 if (!force_p
|| MINI_WINDOW_P (w
)
13067 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13074 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13075 non-zero means only WINDOW is redisplayed in redisplay_internal.
13076 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13077 in redisplay_window to bring a partially visible line into view in
13078 the case that only the cursor has moved.
13080 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13081 last screen line's vertical height extends past the end of the screen.
13085 1 if scrolling succeeded
13087 0 if scrolling didn't find point.
13089 -1 if new fonts have been loaded so that we must interrupt
13090 redisplay, adjust glyph matrices, and try again. */
13096 SCROLLING_NEED_LARGER_MATRICES
13099 /* If scroll-conservatively is more than this, never recenter.
13101 If you change this, don't forget to update the doc string of
13102 `scroll-conservatively' and the Emacs manual. */
13103 #define SCROLL_LIMIT 100
13106 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13107 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13108 int temp_scroll_step
, int last_line_misfit
)
13110 struct window
*w
= XWINDOW (window
);
13111 struct frame
*f
= XFRAME (w
->frame
);
13112 struct text_pos pos
, startp
;
13114 int this_scroll_margin
, scroll_max
, rc
, height
;
13115 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13116 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13117 Lisp_Object aggressive
;
13118 /* We will never try scrolling more than this number of lines. */
13119 int scroll_limit
= SCROLL_LIMIT
;
13122 debug_method_add (w
, "try_scrolling");
13125 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13127 /* Compute scroll margin height in pixels. We scroll when point is
13128 within this distance from the top or bottom of the window. */
13129 if (scroll_margin
> 0)
13130 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13131 * FRAME_LINE_HEIGHT (f
);
13133 this_scroll_margin
= 0;
13135 /* Force arg_scroll_conservatively to have a reasonable value, to
13136 avoid scrolling too far away with slow move_it_* functions. Note
13137 that the user can supply scroll-conservatively equal to
13138 `most-positive-fixnum', which can be larger than INT_MAX. */
13139 if (arg_scroll_conservatively
> scroll_limit
)
13141 arg_scroll_conservatively
= scroll_limit
+ 1;
13142 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13144 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13145 /* Compute how much we should try to scroll maximally to bring
13146 point into view. */
13147 scroll_max
= (max (scroll_step
,
13148 max (arg_scroll_conservatively
, temp_scroll_step
))
13149 * FRAME_LINE_HEIGHT (f
));
13150 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13151 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13152 /* We're trying to scroll because of aggressive scrolling but no
13153 scroll_step is set. Choose an arbitrary one. */
13154 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13160 /* Decide whether to scroll down. */
13161 if (PT
> CHARPOS (startp
))
13163 int scroll_margin_y
;
13165 /* Compute the pixel ypos of the scroll margin, then move it to
13166 either that ypos or PT, whichever comes first. */
13167 start_display (&it
, w
, startp
);
13168 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13169 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13170 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13171 (MOVE_TO_POS
| MOVE_TO_Y
));
13173 if (PT
> CHARPOS (it
.current
.pos
))
13175 int y0
= line_bottom_y (&it
);
13176 /* Compute how many pixels below window bottom to stop searching
13177 for PT. This avoids costly search for PT that is far away if
13178 the user limited scrolling by a small number of lines, but
13179 always finds PT if scroll_conservatively is set to a large
13180 number, such as most-positive-fixnum. */
13181 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13182 int y_to_move
= it
.last_visible_y
+ slack
;
13184 /* Compute the distance from the scroll margin to PT or to
13185 the scroll limit, whichever comes first. This should
13186 include the height of the cursor line, to make that line
13188 move_it_to (&it
, PT
, -1, y_to_move
,
13189 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13190 dy
= line_bottom_y (&it
) - y0
;
13192 if (dy
> scroll_max
)
13193 return SCROLLING_FAILED
;
13201 /* Point is in or below the bottom scroll margin, so move the
13202 window start down. If scrolling conservatively, move it just
13203 enough down to make point visible. If scroll_step is set,
13204 move it down by scroll_step. */
13205 if (arg_scroll_conservatively
)
13207 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13208 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13209 else if (scroll_step
|| temp_scroll_step
)
13210 amount_to_scroll
= scroll_max
;
13213 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13214 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13215 if (NUMBERP (aggressive
))
13217 double float_amount
= XFLOATINT (aggressive
) * height
;
13218 amount_to_scroll
= float_amount
;
13219 if (amount_to_scroll
== 0 && float_amount
> 0)
13220 amount_to_scroll
= 1;
13221 /* Don't let point enter the scroll margin near top of
13223 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13224 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13228 if (amount_to_scroll
<= 0)
13229 return SCROLLING_FAILED
;
13231 start_display (&it
, w
, startp
);
13232 if (arg_scroll_conservatively
<= scroll_limit
)
13233 move_it_vertically (&it
, amount_to_scroll
);
13236 /* Extra precision for users who set scroll-conservatively
13237 to a large number: make sure the amount we scroll
13238 the window start is never less than amount_to_scroll,
13239 which was computed as distance from window bottom to
13240 point. This matters when lines at window top and lines
13241 below window bottom have different height. */
13242 struct it it1
= it
;
13243 /* We use a temporary it1 because line_bottom_y can modify
13244 its argument, if it moves one line down; see there. */
13245 int start_y
= line_bottom_y (&it1
);
13248 move_it_by_lines (&it
, 1);
13250 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13253 /* If STARTP is unchanged, move it down another screen line. */
13254 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13255 move_it_by_lines (&it
, 1);
13256 startp
= it
.current
.pos
;
13260 struct text_pos scroll_margin_pos
= startp
;
13262 /* See if point is inside the scroll margin at the top of the
13264 if (this_scroll_margin
)
13266 start_display (&it
, w
, startp
);
13267 move_it_vertically (&it
, this_scroll_margin
);
13268 scroll_margin_pos
= it
.current
.pos
;
13271 if (PT
< CHARPOS (scroll_margin_pos
))
13273 /* Point is in the scroll margin at the top of the window or
13274 above what is displayed in the window. */
13277 /* Compute the vertical distance from PT to the scroll
13278 margin position. Move as far as scroll_max allows, or
13279 one screenful, or 10 screen lines, whichever is largest.
13280 Give up if distance is greater than scroll_max. */
13281 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13282 start_display (&it
, w
, pos
);
13284 y_to_move
= max (it
.last_visible_y
,
13285 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13286 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13288 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13289 dy
= it
.current_y
- y0
;
13290 if (dy
> scroll_max
)
13291 return SCROLLING_FAILED
;
13293 /* Compute new window start. */
13294 start_display (&it
, w
, startp
);
13296 if (arg_scroll_conservatively
)
13297 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13298 max (scroll_step
, temp_scroll_step
));
13299 else if (scroll_step
|| temp_scroll_step
)
13300 amount_to_scroll
= scroll_max
;
13303 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13304 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13305 if (NUMBERP (aggressive
))
13307 double float_amount
= XFLOATINT (aggressive
) * height
;
13308 amount_to_scroll
= float_amount
;
13309 if (amount_to_scroll
== 0 && float_amount
> 0)
13310 amount_to_scroll
= 1;
13311 amount_to_scroll
-=
13312 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13313 /* Don't let point enter the scroll margin near
13314 bottom of the window. */
13315 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13316 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13320 if (amount_to_scroll
<= 0)
13321 return SCROLLING_FAILED
;
13323 move_it_vertically_backward (&it
, amount_to_scroll
);
13324 startp
= it
.current
.pos
;
13328 /* Run window scroll functions. */
13329 startp
= run_window_scroll_functions (window
, startp
);
13331 /* Display the window. Give up if new fonts are loaded, or if point
13333 if (!try_window (window
, startp
, 0))
13334 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13335 else if (w
->cursor
.vpos
< 0)
13337 clear_glyph_matrix (w
->desired_matrix
);
13338 rc
= SCROLLING_FAILED
;
13342 /* Maybe forget recorded base line for line number display. */
13343 if (!just_this_one_p
13344 || current_buffer
->clip_changed
13345 || BEG_UNCHANGED
< CHARPOS (startp
))
13346 w
->base_line_number
= Qnil
;
13348 /* If cursor ends up on a partially visible line,
13349 treat that as being off the bottom of the screen. */
13350 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13351 /* It's possible that the cursor is on the first line of the
13352 buffer, which is partially obscured due to a vscroll
13353 (Bug#7537). In that case, avoid looping forever . */
13354 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13356 clear_glyph_matrix (w
->desired_matrix
);
13357 ++extra_scroll_margin_lines
;
13360 rc
= SCROLLING_SUCCESS
;
13367 /* Compute a suitable window start for window W if display of W starts
13368 on a continuation line. Value is non-zero if a new window start
13371 The new window start will be computed, based on W's width, starting
13372 from the start of the continued line. It is the start of the
13373 screen line with the minimum distance from the old start W->start. */
13376 compute_window_start_on_continuation_line (struct window
*w
)
13378 struct text_pos pos
, start_pos
;
13379 int window_start_changed_p
= 0;
13381 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13383 /* If window start is on a continuation line... Window start may be
13384 < BEGV in case there's invisible text at the start of the
13385 buffer (M-x rmail, for example). */
13386 if (CHARPOS (start_pos
) > BEGV
13387 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13390 struct glyph_row
*row
;
13392 /* Handle the case that the window start is out of range. */
13393 if (CHARPOS (start_pos
) < BEGV
)
13394 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13395 else if (CHARPOS (start_pos
) > ZV
)
13396 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13398 /* Find the start of the continued line. This should be fast
13399 because scan_buffer is fast (newline cache). */
13400 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13401 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13402 row
, DEFAULT_FACE_ID
);
13403 reseat_at_previous_visible_line_start (&it
);
13405 /* If the line start is "too far" away from the window start,
13406 say it takes too much time to compute a new window start. */
13407 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13408 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13410 int min_distance
, distance
;
13412 /* Move forward by display lines to find the new window
13413 start. If window width was enlarged, the new start can
13414 be expected to be > the old start. If window width was
13415 decreased, the new window start will be < the old start.
13416 So, we're looking for the display line start with the
13417 minimum distance from the old window start. */
13418 pos
= it
.current
.pos
;
13419 min_distance
= INFINITY
;
13420 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13421 distance
< min_distance
)
13423 min_distance
= distance
;
13424 pos
= it
.current
.pos
;
13425 move_it_by_lines (&it
, 1);
13428 /* Set the window start there. */
13429 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13430 window_start_changed_p
= 1;
13434 return window_start_changed_p
;
13438 /* Try cursor movement in case text has not changed in window WINDOW,
13439 with window start STARTP. Value is
13441 CURSOR_MOVEMENT_SUCCESS if successful
13443 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13445 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13446 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13447 we want to scroll as if scroll-step were set to 1. See the code.
13449 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13450 which case we have to abort this redisplay, and adjust matrices
13455 CURSOR_MOVEMENT_SUCCESS
,
13456 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13457 CURSOR_MOVEMENT_MUST_SCROLL
,
13458 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13462 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13464 struct window
*w
= XWINDOW (window
);
13465 struct frame
*f
= XFRAME (w
->frame
);
13466 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13469 if (inhibit_try_cursor_movement
)
13473 /* Handle case where text has not changed, only point, and it has
13474 not moved off the frame. */
13475 if (/* Point may be in this window. */
13476 PT
>= CHARPOS (startp
)
13477 /* Selective display hasn't changed. */
13478 && !current_buffer
->clip_changed
13479 /* Function force-mode-line-update is used to force a thorough
13480 redisplay. It sets either windows_or_buffers_changed or
13481 update_mode_lines. So don't take a shortcut here for these
13483 && !update_mode_lines
13484 && !windows_or_buffers_changed
13485 && !cursor_type_changed
13486 /* Can't use this case if highlighting a region. When a
13487 region exists, cursor movement has to do more than just
13489 && !(!NILP (Vtransient_mark_mode
)
13490 && !NILP (BVAR (current_buffer
, mark_active
)))
13491 && NILP (w
->region_showing
)
13492 && NILP (Vshow_trailing_whitespace
)
13493 /* Right after splitting windows, last_point may be nil. */
13494 && INTEGERP (w
->last_point
)
13495 /* This code is not used for mini-buffer for the sake of the case
13496 of redisplaying to replace an echo area message; since in
13497 that case the mini-buffer contents per se are usually
13498 unchanged. This code is of no real use in the mini-buffer
13499 since the handling of this_line_start_pos, etc., in redisplay
13500 handles the same cases. */
13501 && !EQ (window
, minibuf_window
)
13502 /* When splitting windows or for new windows, it happens that
13503 redisplay is called with a nil window_end_vpos or one being
13504 larger than the window. This should really be fixed in
13505 window.c. I don't have this on my list, now, so we do
13506 approximately the same as the old redisplay code. --gerd. */
13507 && INTEGERP (w
->window_end_vpos
)
13508 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13509 && (FRAME_WINDOW_P (f
)
13510 || !overlay_arrow_in_current_buffer_p ()))
13512 int this_scroll_margin
, top_scroll_margin
;
13513 struct glyph_row
*row
= NULL
;
13516 debug_method_add (w
, "cursor movement");
13519 /* Scroll if point within this distance from the top or bottom
13520 of the window. This is a pixel value. */
13521 if (scroll_margin
> 0)
13523 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13524 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13527 this_scroll_margin
= 0;
13529 top_scroll_margin
= this_scroll_margin
;
13530 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13531 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13533 /* Start with the row the cursor was displayed during the last
13534 not paused redisplay. Give up if that row is not valid. */
13535 if (w
->last_cursor
.vpos
< 0
13536 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13537 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13540 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13541 if (row
->mode_line_p
)
13543 if (!row
->enabled_p
)
13544 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13547 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13549 int scroll_p
= 0, must_scroll
= 0;
13550 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13552 if (PT
> XFASTINT (w
->last_point
))
13554 /* Point has moved forward. */
13555 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13556 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13558 xassert (row
->enabled_p
);
13562 /* If the end position of a row equals the start
13563 position of the next row, and PT is at that position,
13564 we would rather display cursor in the next line. */
13565 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13566 && MATRIX_ROW_END_CHARPOS (row
) == PT
13567 && row
< w
->current_matrix
->rows
13568 + w
->current_matrix
->nrows
- 1
13569 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13570 && !cursor_row_p (row
))
13573 /* If within the scroll margin, scroll. Note that
13574 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13575 the next line would be drawn, and that
13576 this_scroll_margin can be zero. */
13577 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13578 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13579 /* Line is completely visible last line in window
13580 and PT is to be set in the next line. */
13581 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13582 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13583 && !row
->ends_at_zv_p
13584 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13587 else if (PT
< XFASTINT (w
->last_point
))
13589 /* Cursor has to be moved backward. Note that PT >=
13590 CHARPOS (startp) because of the outer if-statement. */
13591 while (!row
->mode_line_p
13592 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13593 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13594 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13595 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13596 row
> w
->current_matrix
->rows
13597 && (row
-1)->ends_in_newline_from_string_p
))))
13598 && (row
->y
> top_scroll_margin
13599 || CHARPOS (startp
) == BEGV
))
13601 xassert (row
->enabled_p
);
13605 /* Consider the following case: Window starts at BEGV,
13606 there is invisible, intangible text at BEGV, so that
13607 display starts at some point START > BEGV. It can
13608 happen that we are called with PT somewhere between
13609 BEGV and START. Try to handle that case. */
13610 if (row
< w
->current_matrix
->rows
13611 || row
->mode_line_p
)
13613 row
= w
->current_matrix
->rows
;
13614 if (row
->mode_line_p
)
13618 /* Due to newlines in overlay strings, we may have to
13619 skip forward over overlay strings. */
13620 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13621 && MATRIX_ROW_END_CHARPOS (row
) == PT
13622 && !cursor_row_p (row
))
13625 /* If within the scroll margin, scroll. */
13626 if (row
->y
< top_scroll_margin
13627 && CHARPOS (startp
) != BEGV
)
13632 /* Cursor did not move. So don't scroll even if cursor line
13633 is partially visible, as it was so before. */
13634 rc
= CURSOR_MOVEMENT_SUCCESS
;
13637 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13638 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13640 /* if PT is not in the glyph row, give up. */
13641 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13644 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13645 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13647 /* If rows are bidi-reordered and point moved, back up
13648 until we find a row that does not belong to a
13649 continuation line. This is because we must consider
13650 all rows of a continued line as candidates for the
13651 new cursor positioning, since row start and end
13652 positions change non-linearly with vertical position
13654 /* FIXME: Revisit this when glyph ``spilling'' in
13655 continuation lines' rows is implemented for
13656 bidi-reordered rows. */
13657 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13659 xassert (row
->enabled_p
);
13661 /* If we hit the beginning of the displayed portion
13662 without finding the first row of a continued
13664 if (row
<= w
->current_matrix
->rows
)
13666 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13674 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13675 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13676 && make_cursor_line_fully_visible_p
)
13678 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13679 && !row
->ends_at_zv_p
13680 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13681 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13682 else if (row
->height
> window_box_height (w
))
13684 /* If we end up in a partially visible line, let's
13685 make it fully visible, except when it's taller
13686 than the window, in which case we can't do much
13689 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13693 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13694 if (!cursor_row_fully_visible_p (w
, 0, 1))
13695 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13697 rc
= CURSOR_MOVEMENT_SUCCESS
;
13701 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13702 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13703 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13705 /* With bidi-reordered rows, there could be more than
13706 one candidate row whose start and end positions
13707 occlude point. We need to let set_cursor_from_row
13708 find the best candidate. */
13709 /* FIXME: Revisit this when glyph ``spilling'' in
13710 continuation lines' rows is implemented for
13711 bidi-reordered rows. */
13716 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13717 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13718 && cursor_row_p (row
))
13719 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13721 /* As soon as we've found the first suitable row
13722 whose ends_at_zv_p flag is set, we are done. */
13724 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13726 rc
= CURSOR_MOVEMENT_SUCCESS
;
13731 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13732 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13733 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13734 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13735 /* If we didn't find any candidate rows, or exited the
13736 loop before all the candidates were examined, signal
13737 to the caller that this method failed. */
13738 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13739 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13740 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13742 rc
= CURSOR_MOVEMENT_SUCCESS
;
13748 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13750 rc
= CURSOR_MOVEMENT_SUCCESS
;
13755 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13756 && MATRIX_ROW_START_CHARPOS (row
) == PT
13757 && cursor_row_p (row
));
13765 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
13769 set_vertical_scroll_bar (struct window
*w
)
13771 EMACS_INT start
, end
, whole
;
13773 /* Calculate the start and end positions for the current window.
13774 At some point, it would be nice to choose between scrollbars
13775 which reflect the whole buffer size, with special markers
13776 indicating narrowing, and scrollbars which reflect only the
13779 Note that mini-buffers sometimes aren't displaying any text. */
13780 if (!MINI_WINDOW_P (w
)
13781 || (w
== XWINDOW (minibuf_window
)
13782 && NILP (echo_area_buffer
[0])))
13784 struct buffer
*buf
= XBUFFER (w
->buffer
);
13785 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13786 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13787 /* I don't think this is guaranteed to be right. For the
13788 moment, we'll pretend it is. */
13789 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13793 if (whole
< (end
- start
))
13794 whole
= end
- start
;
13797 start
= end
= whole
= 0;
13799 /* Indicate what this scroll bar ought to be displaying now. */
13800 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13801 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13802 (w
, end
- start
, whole
, start
);
13806 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13807 selected_window is redisplayed.
13809 We can return without actually redisplaying the window if
13810 fonts_changed_p is nonzero. In that case, redisplay_internal will
13814 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13816 struct window
*w
= XWINDOW (window
);
13817 struct frame
*f
= XFRAME (w
->frame
);
13818 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13819 struct buffer
*old
= current_buffer
;
13820 struct text_pos lpoint
, opoint
, startp
;
13821 int update_mode_line
;
13824 /* Record it now because it's overwritten. */
13825 int current_matrix_up_to_date_p
= 0;
13826 int used_current_matrix_p
= 0;
13827 /* This is less strict than current_matrix_up_to_date_p.
13828 It indictes that the buffer contents and narrowing are unchanged. */
13829 int buffer_unchanged_p
= 0;
13830 int temp_scroll_step
= 0;
13831 int count
= SPECPDL_INDEX ();
13833 int centering_position
= -1;
13834 int last_line_misfit
= 0;
13835 EMACS_INT beg_unchanged
, end_unchanged
;
13837 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13840 /* W must be a leaf window here. */
13841 xassert (!NILP (w
->buffer
));
13843 *w
->desired_matrix
->method
= 0;
13847 reconsider_clip_changes (w
, buffer
);
13849 /* Has the mode line to be updated? */
13850 update_mode_line
= (!NILP (w
->update_mode_line
)
13851 || update_mode_lines
13852 || buffer
->clip_changed
13853 || buffer
->prevent_redisplay_optimizations_p
);
13855 if (MINI_WINDOW_P (w
))
13857 if (w
== XWINDOW (echo_area_window
)
13858 && !NILP (echo_area_buffer
[0]))
13860 if (update_mode_line
)
13861 /* We may have to update a tty frame's menu bar or a
13862 tool-bar. Example `M-x C-h C-h C-g'. */
13863 goto finish_menu_bars
;
13865 /* We've already displayed the echo area glyphs in this window. */
13866 goto finish_scroll_bars
;
13868 else if ((w
!= XWINDOW (minibuf_window
)
13869 || minibuf_level
== 0)
13870 /* When buffer is nonempty, redisplay window normally. */
13871 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13872 /* Quail displays non-mini buffers in minibuffer window.
13873 In that case, redisplay the window normally. */
13874 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13876 /* W is a mini-buffer window, but it's not active, so clear
13878 int yb
= window_text_bottom_y (w
);
13879 struct glyph_row
*row
;
13882 for (y
= 0, row
= w
->desired_matrix
->rows
;
13884 y
+= row
->height
, ++row
)
13885 blank_row (w
, row
, y
);
13886 goto finish_scroll_bars
;
13889 clear_glyph_matrix (w
->desired_matrix
);
13892 /* Otherwise set up data on this window; select its buffer and point
13894 /* Really select the buffer, for the sake of buffer-local
13896 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13898 current_matrix_up_to_date_p
13899 = (!NILP (w
->window_end_valid
)
13900 && !current_buffer
->clip_changed
13901 && !current_buffer
->prevent_redisplay_optimizations_p
13902 && XFASTINT (w
->last_modified
) >= MODIFF
13903 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13905 /* Run the window-bottom-change-functions
13906 if it is possible that the text on the screen has changed
13907 (either due to modification of the text, or any other reason). */
13908 if (!current_matrix_up_to_date_p
13909 && !NILP (Vwindow_text_change_functions
))
13911 safe_run_hooks (Qwindow_text_change_functions
);
13915 beg_unchanged
= BEG_UNCHANGED
;
13916 end_unchanged
= END_UNCHANGED
;
13918 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13920 specbind (Qinhibit_point_motion_hooks
, Qt
);
13923 = (!NILP (w
->window_end_valid
)
13924 && !current_buffer
->clip_changed
13925 && XFASTINT (w
->last_modified
) >= MODIFF
13926 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13928 /* When windows_or_buffers_changed is non-zero, we can't rely on
13929 the window end being valid, so set it to nil there. */
13930 if (windows_or_buffers_changed
)
13932 /* If window starts on a continuation line, maybe adjust the
13933 window start in case the window's width changed. */
13934 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13935 compute_window_start_on_continuation_line (w
);
13937 w
->window_end_valid
= Qnil
;
13940 /* Some sanity checks. */
13941 CHECK_WINDOW_END (w
);
13942 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13944 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13947 /* If %c is in mode line, update it if needed. */
13948 if (!NILP (w
->column_number_displayed
)
13949 /* This alternative quickly identifies a common case
13950 where no change is needed. */
13951 && !(PT
== XFASTINT (w
->last_point
)
13952 && XFASTINT (w
->last_modified
) >= MODIFF
13953 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13954 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13955 update_mode_line
= 1;
13957 /* Count number of windows showing the selected buffer. An indirect
13958 buffer counts as its base buffer. */
13959 if (!just_this_one_p
)
13961 struct buffer
*current_base
, *window_base
;
13962 current_base
= current_buffer
;
13963 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13964 if (current_base
->base_buffer
)
13965 current_base
= current_base
->base_buffer
;
13966 if (window_base
->base_buffer
)
13967 window_base
= window_base
->base_buffer
;
13968 if (current_base
== window_base
)
13972 /* Point refers normally to the selected window. For any other
13973 window, set up appropriate value. */
13974 if (!EQ (window
, selected_window
))
13976 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13977 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13981 new_pt_byte
= BEGV_BYTE
;
13982 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13984 else if (new_pt
> (ZV
- 1))
13987 new_pt_byte
= ZV_BYTE
;
13988 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13991 /* We don't use SET_PT so that the point-motion hooks don't run. */
13992 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13995 /* If any of the character widths specified in the display table
13996 have changed, invalidate the width run cache. It's true that
13997 this may be a bit late to catch such changes, but the rest of
13998 redisplay goes (non-fatally) haywire when the display table is
13999 changed, so why should we worry about doing any better? */
14000 if (current_buffer
->width_run_cache
)
14002 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14004 if (! disptab_matches_widthtab (disptab
,
14005 XVECTOR (BVAR (current_buffer
, width_table
))))
14007 invalidate_region_cache (current_buffer
,
14008 current_buffer
->width_run_cache
,
14010 recompute_width_table (current_buffer
, disptab
);
14014 /* If window-start is screwed up, choose a new one. */
14015 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14018 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14020 /* If someone specified a new starting point but did not insist,
14021 check whether it can be used. */
14022 if (!NILP (w
->optional_new_start
)
14023 && CHARPOS (startp
) >= BEGV
14024 && CHARPOS (startp
) <= ZV
)
14026 w
->optional_new_start
= Qnil
;
14027 start_display (&it
, w
, startp
);
14028 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14029 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14030 if (IT_CHARPOS (it
) == PT
)
14031 w
->force_start
= Qt
;
14032 /* IT may overshoot PT if text at PT is invisible. */
14033 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14034 w
->force_start
= Qt
;
14039 /* Handle case where place to start displaying has been specified,
14040 unless the specified location is outside the accessible range. */
14041 if (!NILP (w
->force_start
)
14042 || w
->frozen_window_start_p
)
14044 /* We set this later on if we have to adjust point. */
14047 w
->force_start
= Qnil
;
14049 w
->window_end_valid
= Qnil
;
14051 /* Forget any recorded base line for line number display. */
14052 if (!buffer_unchanged_p
)
14053 w
->base_line_number
= Qnil
;
14055 /* Redisplay the mode line. Select the buffer properly for that.
14056 Also, run the hook window-scroll-functions
14057 because we have scrolled. */
14058 /* Note, we do this after clearing force_start because
14059 if there's an error, it is better to forget about force_start
14060 than to get into an infinite loop calling the hook functions
14061 and having them get more errors. */
14062 if (!update_mode_line
14063 || ! NILP (Vwindow_scroll_functions
))
14065 update_mode_line
= 1;
14066 w
->update_mode_line
= Qt
;
14067 startp
= run_window_scroll_functions (window
, startp
);
14070 w
->last_modified
= make_number (0);
14071 w
->last_overlay_modified
= make_number (0);
14072 if (CHARPOS (startp
) < BEGV
)
14073 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14074 else if (CHARPOS (startp
) > ZV
)
14075 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14077 /* Redisplay, then check if cursor has been set during the
14078 redisplay. Give up if new fonts were loaded. */
14079 /* We used to issue a CHECK_MARGINS argument to try_window here,
14080 but this causes scrolling to fail when point begins inside
14081 the scroll margin (bug#148) -- cyd */
14082 if (!try_window (window
, startp
, 0))
14084 w
->force_start
= Qt
;
14085 clear_glyph_matrix (w
->desired_matrix
);
14086 goto need_larger_matrices
;
14089 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14091 /* If point does not appear, try to move point so it does
14092 appear. The desired matrix has been built above, so we
14093 can use it here. */
14094 new_vpos
= window_box_height (w
) / 2;
14097 if (!cursor_row_fully_visible_p (w
, 0, 0))
14099 /* Point does appear, but on a line partly visible at end of window.
14100 Move it back to a fully-visible line. */
14101 new_vpos
= window_box_height (w
);
14104 /* If we need to move point for either of the above reasons,
14105 now actually do it. */
14108 struct glyph_row
*row
;
14110 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14111 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14114 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14115 MATRIX_ROW_START_BYTEPOS (row
));
14117 if (w
!= XWINDOW (selected_window
))
14118 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14119 else if (current_buffer
== old
)
14120 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14122 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14124 /* If we are highlighting the region, then we just changed
14125 the region, so redisplay to show it. */
14126 if (!NILP (Vtransient_mark_mode
)
14127 && !NILP (BVAR (current_buffer
, mark_active
)))
14129 clear_glyph_matrix (w
->desired_matrix
);
14130 if (!try_window (window
, startp
, 0))
14131 goto need_larger_matrices
;
14136 debug_method_add (w
, "forced window start");
14141 /* Handle case where text has not changed, only point, and it has
14142 not moved off the frame, and we are not retrying after hscroll.
14143 (current_matrix_up_to_date_p is nonzero when retrying.) */
14144 if (current_matrix_up_to_date_p
14145 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14146 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14150 case CURSOR_MOVEMENT_SUCCESS
:
14151 used_current_matrix_p
= 1;
14154 case CURSOR_MOVEMENT_MUST_SCROLL
:
14155 goto try_to_scroll
;
14161 /* If current starting point was originally the beginning of a line
14162 but no longer is, find a new starting point. */
14163 else if (!NILP (w
->start_at_line_beg
)
14164 && !(CHARPOS (startp
) <= BEGV
14165 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14168 debug_method_add (w
, "recenter 1");
14173 /* Try scrolling with try_window_id. Value is > 0 if update has
14174 been done, it is -1 if we know that the same window start will
14175 not work. It is 0 if unsuccessful for some other reason. */
14176 else if ((tem
= try_window_id (w
)) != 0)
14179 debug_method_add (w
, "try_window_id %d", tem
);
14182 if (fonts_changed_p
)
14183 goto need_larger_matrices
;
14187 /* Otherwise try_window_id has returned -1 which means that we
14188 don't want the alternative below this comment to execute. */
14190 else if (CHARPOS (startp
) >= BEGV
14191 && CHARPOS (startp
) <= ZV
14192 && PT
>= CHARPOS (startp
)
14193 && (CHARPOS (startp
) < ZV
14194 /* Avoid starting at end of buffer. */
14195 || CHARPOS (startp
) == BEGV
14196 || (XFASTINT (w
->last_modified
) >= MODIFF
14197 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14200 /* If first window line is a continuation line, and window start
14201 is inside the modified region, but the first change is before
14202 current window start, we must select a new window start.
14204 However, if this is the result of a down-mouse event (e.g. by
14205 extending the mouse-drag-overlay), we don't want to select a
14206 new window start, since that would change the position under
14207 the mouse, resulting in an unwanted mouse-movement rather
14208 than a simple mouse-click. */
14209 if (NILP (w
->start_at_line_beg
)
14210 && NILP (do_mouse_tracking
)
14211 && CHARPOS (startp
) > BEGV
14212 && CHARPOS (startp
) > BEG
+ beg_unchanged
14213 && CHARPOS (startp
) <= Z
- end_unchanged
14214 /* Even if w->start_at_line_beg is nil, a new window may
14215 start at a line_beg, since that's how set_buffer_window
14216 sets it. So, we need to check the return value of
14217 compute_window_start_on_continuation_line. (See also
14219 && XMARKER (w
->start
)->buffer
== current_buffer
14220 && compute_window_start_on_continuation_line (w
))
14222 w
->force_start
= Qt
;
14223 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14228 debug_method_add (w
, "same window start");
14231 /* Try to redisplay starting at same place as before.
14232 If point has not moved off frame, accept the results. */
14233 if (!current_matrix_up_to_date_p
14234 /* Don't use try_window_reusing_current_matrix in this case
14235 because a window scroll function can have changed the
14237 || !NILP (Vwindow_scroll_functions
)
14238 || MINI_WINDOW_P (w
)
14239 || !(used_current_matrix_p
14240 = try_window_reusing_current_matrix (w
)))
14242 IF_DEBUG (debug_method_add (w
, "1"));
14243 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14244 /* -1 means we need to scroll.
14245 0 means we need new matrices, but fonts_changed_p
14246 is set in that case, so we will detect it below. */
14247 goto try_to_scroll
;
14250 if (fonts_changed_p
)
14251 goto need_larger_matrices
;
14253 if (w
->cursor
.vpos
>= 0)
14255 if (!just_this_one_p
14256 || current_buffer
->clip_changed
14257 || BEG_UNCHANGED
< CHARPOS (startp
))
14258 /* Forget any recorded base line for line number display. */
14259 w
->base_line_number
= Qnil
;
14261 if (!cursor_row_fully_visible_p (w
, 1, 0))
14263 clear_glyph_matrix (w
->desired_matrix
);
14264 last_line_misfit
= 1;
14266 /* Drop through and scroll. */
14271 clear_glyph_matrix (w
->desired_matrix
);
14276 w
->last_modified
= make_number (0);
14277 w
->last_overlay_modified
= make_number (0);
14279 /* Redisplay the mode line. Select the buffer properly for that. */
14280 if (!update_mode_line
)
14282 update_mode_line
= 1;
14283 w
->update_mode_line
= Qt
;
14286 /* Try to scroll by specified few lines. */
14287 if ((scroll_conservatively
14288 || emacs_scroll_step
14289 || temp_scroll_step
14290 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14291 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14292 && CHARPOS (startp
) >= BEGV
14293 && CHARPOS (startp
) <= ZV
)
14295 /* The function returns -1 if new fonts were loaded, 1 if
14296 successful, 0 if not successful. */
14297 int ss
= try_scrolling (window
, just_this_one_p
,
14298 scroll_conservatively
,
14300 temp_scroll_step
, last_line_misfit
);
14303 case SCROLLING_SUCCESS
:
14306 case SCROLLING_NEED_LARGER_MATRICES
:
14307 goto need_larger_matrices
;
14309 case SCROLLING_FAILED
:
14317 /* Finally, just choose a place to start which positions point
14318 according to user preferences. */
14323 debug_method_add (w
, "recenter");
14326 /* w->vscroll = 0; */
14328 /* Forget any previously recorded base line for line number display. */
14329 if (!buffer_unchanged_p
)
14330 w
->base_line_number
= Qnil
;
14332 /* Determine the window start relative to point. */
14333 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14334 it
.current_y
= it
.last_visible_y
;
14335 if (centering_position
< 0)
14339 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14341 EMACS_INT margin_pos
= CHARPOS (startp
);
14343 Lisp_Object aggressive
;
14345 /* If there is a scroll margin at the top of the window, find
14346 its character position. */
14348 /* Cannot call start_display if startp is not in the
14349 accessible region of the buffer. This can happen when we
14350 have just switched to a different buffer and/or changed
14351 its restriction. In that case, startp is initialized to
14352 the character position 1 (BEG) because we did not yet
14353 have chance to display the buffer even once. */
14354 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14358 start_display (&it1
, w
, startp
);
14359 move_it_vertically (&it1
, margin
);
14360 margin_pos
= IT_CHARPOS (it1
);
14362 scrolling_up
= PT
> margin_pos
;
14365 ? BVAR (current_buffer
, scroll_up_aggressively
)
14366 : BVAR (current_buffer
, scroll_down_aggressively
);
14368 if (!MINI_WINDOW_P (w
)
14369 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14373 /* Setting scroll-conservatively overrides
14374 scroll-*-aggressively. */
14375 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14377 double float_amount
= XFLOATINT (aggressive
);
14379 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14380 if (pt_offset
== 0 && float_amount
> 0)
14385 /* Compute how much to move the window start backward from
14386 point so that point will be displayed where the user
14390 centering_position
= it
.last_visible_y
;
14392 centering_position
-= pt_offset
;
14393 centering_position
-=
14394 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14395 /* Don't let point enter the scroll margin near top of
14397 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14398 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14401 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14404 /* Set the window start half the height of the window backward
14406 centering_position
= window_box_height (w
) / 2;
14408 move_it_vertically_backward (&it
, centering_position
);
14410 xassert (IT_CHARPOS (it
) >= BEGV
);
14412 /* The function move_it_vertically_backward may move over more
14413 than the specified y-distance. If it->w is small, e.g. a
14414 mini-buffer window, we may end up in front of the window's
14415 display area. Start displaying at the start of the line
14416 containing PT in this case. */
14417 if (it
.current_y
<= 0)
14419 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14420 move_it_vertically_backward (&it
, 0);
14424 it
.current_x
= it
.hpos
= 0;
14426 /* Set the window start position here explicitly, to avoid an
14427 infinite loop in case the functions in window-scroll-functions
14429 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14431 /* Run scroll hooks. */
14432 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14434 /* Redisplay the window. */
14435 if (!current_matrix_up_to_date_p
14436 || windows_or_buffers_changed
14437 || cursor_type_changed
14438 /* Don't use try_window_reusing_current_matrix in this case
14439 because it can have changed the buffer. */
14440 || !NILP (Vwindow_scroll_functions
)
14441 || !just_this_one_p
14442 || MINI_WINDOW_P (w
)
14443 || !(used_current_matrix_p
14444 = try_window_reusing_current_matrix (w
)))
14445 try_window (window
, startp
, 0);
14447 /* If new fonts have been loaded (due to fontsets), give up. We
14448 have to start a new redisplay since we need to re-adjust glyph
14450 if (fonts_changed_p
)
14451 goto need_larger_matrices
;
14453 /* If cursor did not appear assume that the middle of the window is
14454 in the first line of the window. Do it again with the next line.
14455 (Imagine a window of height 100, displaying two lines of height
14456 60. Moving back 50 from it->last_visible_y will end in the first
14458 if (w
->cursor
.vpos
< 0)
14460 if (!NILP (w
->window_end_valid
)
14461 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14463 clear_glyph_matrix (w
->desired_matrix
);
14464 move_it_by_lines (&it
, 1);
14465 try_window (window
, it
.current
.pos
, 0);
14467 else if (PT
< IT_CHARPOS (it
))
14469 clear_glyph_matrix (w
->desired_matrix
);
14470 move_it_by_lines (&it
, -1);
14471 try_window (window
, it
.current
.pos
, 0);
14475 /* Not much we can do about it. */
14479 /* Consider the following case: Window starts at BEGV, there is
14480 invisible, intangible text at BEGV, so that display starts at
14481 some point START > BEGV. It can happen that we are called with
14482 PT somewhere between BEGV and START. Try to handle that case. */
14483 if (w
->cursor
.vpos
< 0)
14485 struct glyph_row
*row
= w
->current_matrix
->rows
;
14486 if (row
->mode_line_p
)
14488 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14491 if (!cursor_row_fully_visible_p (w
, 0, 0))
14493 /* If vscroll is enabled, disable it and try again. */
14497 clear_glyph_matrix (w
->desired_matrix
);
14501 /* If centering point failed to make the whole line visible,
14502 put point at the top instead. That has to make the whole line
14503 visible, if it can be done. */
14504 if (centering_position
== 0)
14507 clear_glyph_matrix (w
->desired_matrix
);
14508 centering_position
= 0;
14514 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14515 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14516 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14519 /* Display the mode line, if we must. */
14520 if ((update_mode_line
14521 /* If window not full width, must redo its mode line
14522 if (a) the window to its side is being redone and
14523 (b) we do a frame-based redisplay. This is a consequence
14524 of how inverted lines are drawn in frame-based redisplay. */
14525 || (!just_this_one_p
14526 && !FRAME_WINDOW_P (f
)
14527 && !WINDOW_FULL_WIDTH_P (w
))
14528 /* Line number to display. */
14529 || INTEGERP (w
->base_line_pos
)
14530 /* Column number is displayed and different from the one displayed. */
14531 || (!NILP (w
->column_number_displayed
)
14532 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14533 /* This means that the window has a mode line. */
14534 && (WINDOW_WANTS_MODELINE_P (w
)
14535 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14537 display_mode_lines (w
);
14539 /* If mode line height has changed, arrange for a thorough
14540 immediate redisplay using the correct mode line height. */
14541 if (WINDOW_WANTS_MODELINE_P (w
)
14542 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14544 fonts_changed_p
= 1;
14545 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14546 = DESIRED_MODE_LINE_HEIGHT (w
);
14549 /* If header line height has changed, arrange for a thorough
14550 immediate redisplay using the correct header line height. */
14551 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14552 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14554 fonts_changed_p
= 1;
14555 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14556 = DESIRED_HEADER_LINE_HEIGHT (w
);
14559 if (fonts_changed_p
)
14560 goto need_larger_matrices
;
14563 if (!line_number_displayed
14564 && !BUFFERP (w
->base_line_pos
))
14566 w
->base_line_pos
= Qnil
;
14567 w
->base_line_number
= Qnil
;
14572 /* When we reach a frame's selected window, redo the frame's menu bar. */
14573 if (update_mode_line
14574 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14576 int redisplay_menu_p
= 0;
14578 if (FRAME_WINDOW_P (f
))
14580 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14581 || defined (HAVE_NS) || defined (USE_GTK)
14582 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14584 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14588 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14590 if (redisplay_menu_p
)
14591 display_menu_bar (w
);
14593 #ifdef HAVE_WINDOW_SYSTEM
14594 if (FRAME_WINDOW_P (f
))
14596 #if defined (USE_GTK) || defined (HAVE_NS)
14597 if (FRAME_EXTERNAL_TOOL_BAR (f
))
14598 redisplay_tool_bar (f
);
14600 if (WINDOWP (f
->tool_bar_window
)
14601 && (FRAME_TOOL_BAR_LINES (f
) > 0
14602 || !NILP (Vauto_resize_tool_bars
))
14603 && redisplay_tool_bar (f
))
14604 ignore_mouse_drag_p
= 1;
14610 #ifdef HAVE_WINDOW_SYSTEM
14611 if (FRAME_WINDOW_P (f
)
14612 && update_window_fringes (w
, (just_this_one_p
14613 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14614 || w
->pseudo_window_p
)))
14618 if (draw_window_fringes (w
, 1))
14619 x_draw_vertical_border (w
);
14623 #endif /* HAVE_WINDOW_SYSTEM */
14625 /* We go to this label, with fonts_changed_p nonzero,
14626 if it is necessary to try again using larger glyph matrices.
14627 We have to redeem the scroll bar even in this case,
14628 because the loop in redisplay_internal expects that. */
14629 need_larger_matrices
:
14631 finish_scroll_bars
:
14633 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14635 /* Set the thumb's position and size. */
14636 set_vertical_scroll_bar (w
);
14638 /* Note that we actually used the scroll bar attached to this
14639 window, so it shouldn't be deleted at the end of redisplay. */
14640 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14641 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14644 /* Restore current_buffer and value of point in it. The window
14645 update may have changed the buffer, so first make sure `opoint'
14646 is still valid (Bug#6177). */
14647 if (CHARPOS (opoint
) < BEGV
)
14648 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14649 else if (CHARPOS (opoint
) > ZV
)
14650 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14652 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14654 set_buffer_internal_1 (old
);
14655 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14656 shorter. This can be caused by log truncation in *Messages*. */
14657 if (CHARPOS (lpoint
) <= ZV
)
14658 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14660 unbind_to (count
, Qnil
);
14664 /* Build the complete desired matrix of WINDOW with a window start
14665 buffer position POS.
14667 Value is 1 if successful. It is zero if fonts were loaded during
14668 redisplay which makes re-adjusting glyph matrices necessary, and -1
14669 if point would appear in the scroll margins.
14670 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14671 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14675 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14677 struct window
*w
= XWINDOW (window
);
14679 struct glyph_row
*last_text_row
= NULL
;
14680 struct frame
*f
= XFRAME (w
->frame
);
14682 /* Make POS the new window start. */
14683 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14685 /* Mark cursor position as unknown. No overlay arrow seen. */
14686 w
->cursor
.vpos
= -1;
14687 overlay_arrow_seen
= 0;
14689 /* Initialize iterator and info to start at POS. */
14690 start_display (&it
, w
, pos
);
14692 /* Display all lines of W. */
14693 while (it
.current_y
< it
.last_visible_y
)
14695 if (display_line (&it
))
14696 last_text_row
= it
.glyph_row
- 1;
14697 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14701 /* Don't let the cursor end in the scroll margins. */
14702 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14703 && !MINI_WINDOW_P (w
))
14705 int this_scroll_margin
;
14707 if (scroll_margin
> 0)
14709 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14710 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14713 this_scroll_margin
= 0;
14715 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14716 && w
->cursor
.y
< this_scroll_margin
14717 && CHARPOS (pos
) > BEGV
14718 && IT_CHARPOS (it
) < ZV
)
14719 /* rms: considering make_cursor_line_fully_visible_p here
14720 seems to give wrong results. We don't want to recenter
14721 when the last line is partly visible, we want to allow
14722 that case to be handled in the usual way. */
14723 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14725 w
->cursor
.vpos
= -1;
14726 clear_glyph_matrix (w
->desired_matrix
);
14731 /* If bottom moved off end of frame, change mode line percentage. */
14732 if (XFASTINT (w
->window_end_pos
) <= 0
14733 && Z
!= IT_CHARPOS (it
))
14734 w
->update_mode_line
= Qt
;
14736 /* Set window_end_pos to the offset of the last character displayed
14737 on the window from the end of current_buffer. Set
14738 window_end_vpos to its row number. */
14741 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14742 w
->window_end_bytepos
14743 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14745 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14747 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14748 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14749 ->displays_text_p
);
14753 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14754 w
->window_end_pos
= make_number (Z
- ZV
);
14755 w
->window_end_vpos
= make_number (0);
14758 /* But that is not valid info until redisplay finishes. */
14759 w
->window_end_valid
= Qnil
;
14765 /************************************************************************
14766 Window redisplay reusing current matrix when buffer has not changed
14767 ************************************************************************/
14769 /* Try redisplay of window W showing an unchanged buffer with a
14770 different window start than the last time it was displayed by
14771 reusing its current matrix. Value is non-zero if successful.
14772 W->start is the new window start. */
14775 try_window_reusing_current_matrix (struct window
*w
)
14777 struct frame
*f
= XFRAME (w
->frame
);
14778 struct glyph_row
*bottom_row
;
14781 struct text_pos start
, new_start
;
14782 int nrows_scrolled
, i
;
14783 struct glyph_row
*last_text_row
;
14784 struct glyph_row
*last_reused_text_row
;
14785 struct glyph_row
*start_row
;
14786 int start_vpos
, min_y
, max_y
;
14789 if (inhibit_try_window_reusing
)
14793 if (/* This function doesn't handle terminal frames. */
14794 !FRAME_WINDOW_P (f
)
14795 /* Don't try to reuse the display if windows have been split
14797 || windows_or_buffers_changed
14798 || cursor_type_changed
)
14801 /* Can't do this if region may have changed. */
14802 if ((!NILP (Vtransient_mark_mode
)
14803 && !NILP (BVAR (current_buffer
, mark_active
)))
14804 || !NILP (w
->region_showing
)
14805 || !NILP (Vshow_trailing_whitespace
))
14808 /* If top-line visibility has changed, give up. */
14809 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14810 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14813 /* Give up if old or new display is scrolled vertically. We could
14814 make this function handle this, but right now it doesn't. */
14815 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14816 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14819 /* The variable new_start now holds the new window start. The old
14820 start `start' can be determined from the current matrix. */
14821 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14822 start
= start_row
->minpos
;
14823 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14825 /* Clear the desired matrix for the display below. */
14826 clear_glyph_matrix (w
->desired_matrix
);
14828 if (CHARPOS (new_start
) <= CHARPOS (start
))
14830 /* Don't use this method if the display starts with an ellipsis
14831 displayed for invisible text. It's not easy to handle that case
14832 below, and it's certainly not worth the effort since this is
14833 not a frequent case. */
14834 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14837 IF_DEBUG (debug_method_add (w
, "twu1"));
14839 /* Display up to a row that can be reused. The variable
14840 last_text_row is set to the last row displayed that displays
14841 text. Note that it.vpos == 0 if or if not there is a
14842 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14843 start_display (&it
, w
, new_start
);
14844 w
->cursor
.vpos
= -1;
14845 last_text_row
= last_reused_text_row
= NULL
;
14847 while (it
.current_y
< it
.last_visible_y
14848 && !fonts_changed_p
)
14850 /* If we have reached into the characters in the START row,
14851 that means the line boundaries have changed. So we
14852 can't start copying with the row START. Maybe it will
14853 work to start copying with the following row. */
14854 while (IT_CHARPOS (it
) > CHARPOS (start
))
14856 /* Advance to the next row as the "start". */
14858 start
= start_row
->minpos
;
14859 /* If there are no more rows to try, or just one, give up. */
14860 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14861 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14862 || CHARPOS (start
) == ZV
)
14864 clear_glyph_matrix (w
->desired_matrix
);
14868 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14870 /* If we have reached alignment,
14871 we can copy the rest of the rows. */
14872 if (IT_CHARPOS (it
) == CHARPOS (start
))
14875 if (display_line (&it
))
14876 last_text_row
= it
.glyph_row
- 1;
14879 /* A value of current_y < last_visible_y means that we stopped
14880 at the previous window start, which in turn means that we
14881 have at least one reusable row. */
14882 if (it
.current_y
< it
.last_visible_y
)
14884 struct glyph_row
*row
;
14886 /* IT.vpos always starts from 0; it counts text lines. */
14887 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14889 /* Find PT if not already found in the lines displayed. */
14890 if (w
->cursor
.vpos
< 0)
14892 int dy
= it
.current_y
- start_row
->y
;
14894 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14895 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14897 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14898 dy
, nrows_scrolled
);
14901 clear_glyph_matrix (w
->desired_matrix
);
14906 /* Scroll the display. Do it before the current matrix is
14907 changed. The problem here is that update has not yet
14908 run, i.e. part of the current matrix is not up to date.
14909 scroll_run_hook will clear the cursor, and use the
14910 current matrix to get the height of the row the cursor is
14912 run
.current_y
= start_row
->y
;
14913 run
.desired_y
= it
.current_y
;
14914 run
.height
= it
.last_visible_y
- it
.current_y
;
14916 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14919 FRAME_RIF (f
)->update_window_begin_hook (w
);
14920 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14921 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14922 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14926 /* Shift current matrix down by nrows_scrolled lines. */
14927 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14928 rotate_matrix (w
->current_matrix
,
14930 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14933 /* Disable lines that must be updated. */
14934 for (i
= 0; i
< nrows_scrolled
; ++i
)
14935 (start_row
+ i
)->enabled_p
= 0;
14937 /* Re-compute Y positions. */
14938 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14939 max_y
= it
.last_visible_y
;
14940 for (row
= start_row
+ nrows_scrolled
;
14944 row
->y
= it
.current_y
;
14945 row
->visible_height
= row
->height
;
14947 if (row
->y
< min_y
)
14948 row
->visible_height
-= min_y
- row
->y
;
14949 if (row
->y
+ row
->height
> max_y
)
14950 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14951 if (row
->fringe_bitmap_periodic_p
)
14952 row
->redraw_fringe_bitmaps_p
= 1;
14954 it
.current_y
+= row
->height
;
14956 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14957 last_reused_text_row
= row
;
14958 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14962 /* Disable lines in the current matrix which are now
14963 below the window. */
14964 for (++row
; row
< bottom_row
; ++row
)
14965 row
->enabled_p
= row
->mode_line_p
= 0;
14968 /* Update window_end_pos etc.; last_reused_text_row is the last
14969 reused row from the current matrix containing text, if any.
14970 The value of last_text_row is the last displayed line
14971 containing text. */
14972 if (last_reused_text_row
)
14974 w
->window_end_bytepos
14975 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14977 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14979 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14980 w
->current_matrix
));
14982 else if (last_text_row
)
14984 w
->window_end_bytepos
14985 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14987 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14989 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14993 /* This window must be completely empty. */
14994 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14995 w
->window_end_pos
= make_number (Z
- ZV
);
14996 w
->window_end_vpos
= make_number (0);
14998 w
->window_end_valid
= Qnil
;
15000 /* Update hint: don't try scrolling again in update_window. */
15001 w
->desired_matrix
->no_scrolling_p
= 1;
15004 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15008 else if (CHARPOS (new_start
) > CHARPOS (start
))
15010 struct glyph_row
*pt_row
, *row
;
15011 struct glyph_row
*first_reusable_row
;
15012 struct glyph_row
*first_row_to_display
;
15014 int yb
= window_text_bottom_y (w
);
15016 /* Find the row starting at new_start, if there is one. Don't
15017 reuse a partially visible line at the end. */
15018 first_reusable_row
= start_row
;
15019 while (first_reusable_row
->enabled_p
15020 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15021 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15022 < CHARPOS (new_start
)))
15023 ++first_reusable_row
;
15025 /* Give up if there is no row to reuse. */
15026 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15027 || !first_reusable_row
->enabled_p
15028 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15029 != CHARPOS (new_start
)))
15032 /* We can reuse fully visible rows beginning with
15033 first_reusable_row to the end of the window. Set
15034 first_row_to_display to the first row that cannot be reused.
15035 Set pt_row to the row containing point, if there is any. */
15037 for (first_row_to_display
= first_reusable_row
;
15038 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15039 ++first_row_to_display
)
15041 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15042 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15043 pt_row
= first_row_to_display
;
15046 /* Start displaying at the start of first_row_to_display. */
15047 xassert (first_row_to_display
->y
< yb
);
15048 init_to_row_start (&it
, w
, first_row_to_display
);
15050 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15052 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15054 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15055 + WINDOW_HEADER_LINE_HEIGHT (w
));
15057 /* Display lines beginning with first_row_to_display in the
15058 desired matrix. Set last_text_row to the last row displayed
15059 that displays text. */
15060 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15061 if (pt_row
== NULL
)
15062 w
->cursor
.vpos
= -1;
15063 last_text_row
= NULL
;
15064 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15065 if (display_line (&it
))
15066 last_text_row
= it
.glyph_row
- 1;
15068 /* If point is in a reused row, adjust y and vpos of the cursor
15072 w
->cursor
.vpos
-= nrows_scrolled
;
15073 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15076 /* Give up if point isn't in a row displayed or reused. (This
15077 also handles the case where w->cursor.vpos < nrows_scrolled
15078 after the calls to display_line, which can happen with scroll
15079 margins. See bug#1295.) */
15080 if (w
->cursor
.vpos
< 0)
15082 clear_glyph_matrix (w
->desired_matrix
);
15086 /* Scroll the display. */
15087 run
.current_y
= first_reusable_row
->y
;
15088 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15089 run
.height
= it
.last_visible_y
- run
.current_y
;
15090 dy
= run
.current_y
- run
.desired_y
;
15095 FRAME_RIF (f
)->update_window_begin_hook (w
);
15096 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15097 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15098 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15102 /* Adjust Y positions of reused rows. */
15103 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15104 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15105 max_y
= it
.last_visible_y
;
15106 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15109 row
->visible_height
= row
->height
;
15110 if (row
->y
< min_y
)
15111 row
->visible_height
-= min_y
- row
->y
;
15112 if (row
->y
+ row
->height
> max_y
)
15113 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15114 if (row
->fringe_bitmap_periodic_p
)
15115 row
->redraw_fringe_bitmaps_p
= 1;
15118 /* Scroll the current matrix. */
15119 xassert (nrows_scrolled
> 0);
15120 rotate_matrix (w
->current_matrix
,
15122 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15125 /* Disable rows not reused. */
15126 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15127 row
->enabled_p
= 0;
15129 /* Point may have moved to a different line, so we cannot assume that
15130 the previous cursor position is valid; locate the correct row. */
15133 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15134 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15138 w
->cursor
.y
= row
->y
;
15140 if (row
< bottom_row
)
15142 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15143 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15145 /* Can't use this optimization with bidi-reordered glyph
15146 rows, unless cursor is already at point. */
15147 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15149 if (!(w
->cursor
.hpos
>= 0
15150 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15151 && BUFFERP (glyph
->object
)
15152 && glyph
->charpos
== PT
))
15157 && (!BUFFERP (glyph
->object
)
15158 || glyph
->charpos
< PT
);
15162 w
->cursor
.x
+= glyph
->pixel_width
;
15167 /* Adjust window end. A null value of last_text_row means that
15168 the window end is in reused rows which in turn means that
15169 only its vpos can have changed. */
15172 w
->window_end_bytepos
15173 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15175 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15177 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15182 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15185 w
->window_end_valid
= Qnil
;
15186 w
->desired_matrix
->no_scrolling_p
= 1;
15189 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15199 /************************************************************************
15200 Window redisplay reusing current matrix when buffer has changed
15201 ************************************************************************/
15203 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15204 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15205 EMACS_INT
*, EMACS_INT
*);
15206 static struct glyph_row
*
15207 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15208 struct glyph_row
*);
15211 /* Return the last row in MATRIX displaying text. If row START is
15212 non-null, start searching with that row. IT gives the dimensions
15213 of the display. Value is null if matrix is empty; otherwise it is
15214 a pointer to the row found. */
15216 static struct glyph_row
*
15217 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15218 struct glyph_row
*start
)
15220 struct glyph_row
*row
, *row_found
;
15222 /* Set row_found to the last row in IT->w's current matrix
15223 displaying text. The loop looks funny but think of partially
15226 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15227 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15229 xassert (row
->enabled_p
);
15231 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15240 /* Return the last row in the current matrix of W that is not affected
15241 by changes at the start of current_buffer that occurred since W's
15242 current matrix was built. Value is null if no such row exists.
15244 BEG_UNCHANGED us the number of characters unchanged at the start of
15245 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15246 first changed character in current_buffer. Characters at positions <
15247 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15248 when the current matrix was built. */
15250 static struct glyph_row
*
15251 find_last_unchanged_at_beg_row (struct window
*w
)
15253 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15254 struct glyph_row
*row
;
15255 struct glyph_row
*row_found
= NULL
;
15256 int yb
= window_text_bottom_y (w
);
15258 /* Find the last row displaying unchanged text. */
15259 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15260 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15261 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15264 if (/* If row ends before first_changed_pos, it is unchanged,
15265 except in some case. */
15266 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15267 /* When row ends in ZV and we write at ZV it is not
15269 && !row
->ends_at_zv_p
15270 /* When first_changed_pos is the end of a continued line,
15271 row is not unchanged because it may be no longer
15273 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15274 && (row
->continued_p
15275 || row
->exact_window_width_line_p
)))
15278 /* Stop if last visible row. */
15279 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15287 /* Find the first glyph row in the current matrix of W that is not
15288 affected by changes at the end of current_buffer since the
15289 time W's current matrix was built.
15291 Return in *DELTA the number of chars by which buffer positions in
15292 unchanged text at the end of current_buffer must be adjusted.
15294 Return in *DELTA_BYTES the corresponding number of bytes.
15296 Value is null if no such row exists, i.e. all rows are affected by
15299 static struct glyph_row
*
15300 find_first_unchanged_at_end_row (struct window
*w
,
15301 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15303 struct glyph_row
*row
;
15304 struct glyph_row
*row_found
= NULL
;
15306 *delta
= *delta_bytes
= 0;
15308 /* Display must not have been paused, otherwise the current matrix
15309 is not up to date. */
15310 eassert (!NILP (w
->window_end_valid
));
15312 /* A value of window_end_pos >= END_UNCHANGED means that the window
15313 end is in the range of changed text. If so, there is no
15314 unchanged row at the end of W's current matrix. */
15315 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15318 /* Set row to the last row in W's current matrix displaying text. */
15319 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15321 /* If matrix is entirely empty, no unchanged row exists. */
15322 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15324 /* The value of row is the last glyph row in the matrix having a
15325 meaningful buffer position in it. The end position of row
15326 corresponds to window_end_pos. This allows us to translate
15327 buffer positions in the current matrix to current buffer
15328 positions for characters not in changed text. */
15330 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15331 EMACS_INT Z_BYTE_old
=
15332 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15333 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15334 struct glyph_row
*first_text_row
15335 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15337 *delta
= Z
- Z_old
;
15338 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15340 /* Set last_unchanged_pos to the buffer position of the last
15341 character in the buffer that has not been changed. Z is the
15342 index + 1 of the last character in current_buffer, i.e. by
15343 subtracting END_UNCHANGED we get the index of the last
15344 unchanged character, and we have to add BEG to get its buffer
15346 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15347 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15349 /* Search backward from ROW for a row displaying a line that
15350 starts at a minimum position >= last_unchanged_pos_old. */
15351 for (; row
> first_text_row
; --row
)
15353 /* This used to abort, but it can happen.
15354 It is ok to just stop the search instead here. KFS. */
15355 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15358 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15363 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15369 /* Make sure that glyph rows in the current matrix of window W
15370 reference the same glyph memory as corresponding rows in the
15371 frame's frame matrix. This function is called after scrolling W's
15372 current matrix on a terminal frame in try_window_id and
15373 try_window_reusing_current_matrix. */
15376 sync_frame_with_window_matrix_rows (struct window
*w
)
15378 struct frame
*f
= XFRAME (w
->frame
);
15379 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15381 /* Preconditions: W must be a leaf window and full-width. Its frame
15382 must have a frame matrix. */
15383 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15384 xassert (WINDOW_FULL_WIDTH_P (w
));
15385 xassert (!FRAME_WINDOW_P (f
));
15387 /* If W is a full-width window, glyph pointers in W's current matrix
15388 have, by definition, to be the same as glyph pointers in the
15389 corresponding frame matrix. Note that frame matrices have no
15390 marginal areas (see build_frame_matrix). */
15391 window_row
= w
->current_matrix
->rows
;
15392 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15393 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15394 while (window_row
< window_row_end
)
15396 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15397 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15399 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15400 frame_row
->glyphs
[TEXT_AREA
] = start
;
15401 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15402 frame_row
->glyphs
[LAST_AREA
] = end
;
15404 /* Disable frame rows whose corresponding window rows have
15405 been disabled in try_window_id. */
15406 if (!window_row
->enabled_p
)
15407 frame_row
->enabled_p
= 0;
15409 ++window_row
, ++frame_row
;
15414 /* Find the glyph row in window W containing CHARPOS. Consider all
15415 rows between START and END (not inclusive). END null means search
15416 all rows to the end of the display area of W. Value is the row
15417 containing CHARPOS or null. */
15420 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15421 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15423 struct glyph_row
*row
= start
;
15424 struct glyph_row
*best_row
= NULL
;
15425 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15428 /* If we happen to start on a header-line, skip that. */
15429 if (row
->mode_line_p
)
15432 if ((end
&& row
>= end
) || !row
->enabled_p
)
15435 last_y
= window_text_bottom_y (w
) - dy
;
15439 /* Give up if we have gone too far. */
15440 if (end
&& row
>= end
)
15442 /* This formerly returned if they were equal.
15443 I think that both quantities are of a "last plus one" type;
15444 if so, when they are equal, the row is within the screen. -- rms. */
15445 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15448 /* If it is in this row, return this row. */
15449 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15450 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15451 /* The end position of a row equals the start
15452 position of the next row. If CHARPOS is there, we
15453 would rather display it in the next line, except
15454 when this line ends in ZV. */
15455 && !row
->ends_at_zv_p
15456 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15457 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15461 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15462 || (!best_row
&& !row
->continued_p
))
15464 /* In bidi-reordered rows, there could be several rows
15465 occluding point, all of them belonging to the same
15466 continued line. We need to find the row which fits
15467 CHARPOS the best. */
15468 for (g
= row
->glyphs
[TEXT_AREA
];
15469 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15472 if (!STRINGP (g
->object
))
15474 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15476 mindif
= eabs (g
->charpos
- charpos
);
15478 /* Exact match always wins. */
15485 else if (best_row
&& !row
->continued_p
)
15492 /* Try to redisplay window W by reusing its existing display. W's
15493 current matrix must be up to date when this function is called,
15494 i.e. window_end_valid must not be nil.
15498 1 if display has been updated
15499 0 if otherwise unsuccessful
15500 -1 if redisplay with same window start is known not to succeed
15502 The following steps are performed:
15504 1. Find the last row in the current matrix of W that is not
15505 affected by changes at the start of current_buffer. If no such row
15508 2. Find the first row in W's current matrix that is not affected by
15509 changes at the end of current_buffer. Maybe there is no such row.
15511 3. Display lines beginning with the row + 1 found in step 1 to the
15512 row found in step 2 or, if step 2 didn't find a row, to the end of
15515 4. If cursor is not known to appear on the window, give up.
15517 5. If display stopped at the row found in step 2, scroll the
15518 display and current matrix as needed.
15520 6. Maybe display some lines at the end of W, if we must. This can
15521 happen under various circumstances, like a partially visible line
15522 becoming fully visible, or because newly displayed lines are displayed
15523 in smaller font sizes.
15525 7. Update W's window end information. */
15528 try_window_id (struct window
*w
)
15530 struct frame
*f
= XFRAME (w
->frame
);
15531 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15532 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15533 struct glyph_row
*last_unchanged_at_beg_row
;
15534 struct glyph_row
*first_unchanged_at_end_row
;
15535 struct glyph_row
*row
;
15536 struct glyph_row
*bottom_row
;
15539 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15541 struct text_pos start_pos
;
15543 int first_unchanged_at_end_vpos
= 0;
15544 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15545 struct text_pos start
;
15546 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15549 if (inhibit_try_window_id
)
15553 /* This is handy for debugging. */
15555 #define GIVE_UP(X) \
15557 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15561 #define GIVE_UP(X) return 0
15564 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15566 /* Don't use this for mini-windows because these can show
15567 messages and mini-buffers, and we don't handle that here. */
15568 if (MINI_WINDOW_P (w
))
15571 /* This flag is used to prevent redisplay optimizations. */
15572 if (windows_or_buffers_changed
|| cursor_type_changed
)
15575 /* Verify that narrowing has not changed.
15576 Also verify that we were not told to prevent redisplay optimizations.
15577 It would be nice to further
15578 reduce the number of cases where this prevents try_window_id. */
15579 if (current_buffer
->clip_changed
15580 || current_buffer
->prevent_redisplay_optimizations_p
)
15583 /* Window must either use window-based redisplay or be full width. */
15584 if (!FRAME_WINDOW_P (f
)
15585 && (!FRAME_LINE_INS_DEL_OK (f
)
15586 || !WINDOW_FULL_WIDTH_P (w
)))
15589 /* Give up if point is known NOT to appear in W. */
15590 if (PT
< CHARPOS (start
))
15593 /* Another way to prevent redisplay optimizations. */
15594 if (XFASTINT (w
->last_modified
) == 0)
15597 /* Verify that window is not hscrolled. */
15598 if (XFASTINT (w
->hscroll
) != 0)
15601 /* Verify that display wasn't paused. */
15602 if (NILP (w
->window_end_valid
))
15605 /* Can't use this if highlighting a region because a cursor movement
15606 will do more than just set the cursor. */
15607 if (!NILP (Vtransient_mark_mode
)
15608 && !NILP (BVAR (current_buffer
, mark_active
)))
15611 /* Likewise if highlighting trailing whitespace. */
15612 if (!NILP (Vshow_trailing_whitespace
))
15615 /* Likewise if showing a region. */
15616 if (!NILP (w
->region_showing
))
15619 /* Can't use this if overlay arrow position and/or string have
15621 if (overlay_arrows_changed_p ())
15624 /* When word-wrap is on, adding a space to the first word of a
15625 wrapped line can change the wrap position, altering the line
15626 above it. It might be worthwhile to handle this more
15627 intelligently, but for now just redisplay from scratch. */
15628 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15631 /* Under bidi reordering, adding or deleting a character in the
15632 beginning of a paragraph, before the first strong directional
15633 character, can change the base direction of the paragraph (unless
15634 the buffer specifies a fixed paragraph direction), which will
15635 require to redisplay the whole paragraph. It might be worthwhile
15636 to find the paragraph limits and widen the range of redisplayed
15637 lines to that, but for now just give up this optimization and
15638 redisplay from scratch. */
15639 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15640 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15643 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15644 only if buffer has really changed. The reason is that the gap is
15645 initially at Z for freshly visited files. The code below would
15646 set end_unchanged to 0 in that case. */
15647 if (MODIFF
> SAVE_MODIFF
15648 /* This seems to happen sometimes after saving a buffer. */
15649 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15651 if (GPT
- BEG
< BEG_UNCHANGED
)
15652 BEG_UNCHANGED
= GPT
- BEG
;
15653 if (Z
- GPT
< END_UNCHANGED
)
15654 END_UNCHANGED
= Z
- GPT
;
15657 /* The position of the first and last character that has been changed. */
15658 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15659 last_changed_charpos
= Z
- END_UNCHANGED
;
15661 /* If window starts after a line end, and the last change is in
15662 front of that newline, then changes don't affect the display.
15663 This case happens with stealth-fontification. Note that although
15664 the display is unchanged, glyph positions in the matrix have to
15665 be adjusted, of course. */
15666 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15667 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15668 && ((last_changed_charpos
< CHARPOS (start
)
15669 && CHARPOS (start
) == BEGV
)
15670 || (last_changed_charpos
< CHARPOS (start
) - 1
15671 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15673 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15674 struct glyph_row
*r0
;
15676 /* Compute how many chars/bytes have been added to or removed
15677 from the buffer. */
15678 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15679 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15680 Z_delta
= Z
- Z_old
;
15681 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15683 /* Give up if PT is not in the window. Note that it already has
15684 been checked at the start of try_window_id that PT is not in
15685 front of the window start. */
15686 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15689 /* If window start is unchanged, we can reuse the whole matrix
15690 as is, after adjusting glyph positions. No need to compute
15691 the window end again, since its offset from Z hasn't changed. */
15692 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15693 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15694 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15695 /* PT must not be in a partially visible line. */
15696 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15697 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15699 /* Adjust positions in the glyph matrix. */
15700 if (Z_delta
|| Z_delta_bytes
)
15702 struct glyph_row
*r1
15703 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15704 increment_matrix_positions (w
->current_matrix
,
15705 MATRIX_ROW_VPOS (r0
, current_matrix
),
15706 MATRIX_ROW_VPOS (r1
, current_matrix
),
15707 Z_delta
, Z_delta_bytes
);
15710 /* Set the cursor. */
15711 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15713 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15720 /* Handle the case that changes are all below what is displayed in
15721 the window, and that PT is in the window. This shortcut cannot
15722 be taken if ZV is visible in the window, and text has been added
15723 there that is visible in the window. */
15724 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15725 /* ZV is not visible in the window, or there are no
15726 changes at ZV, actually. */
15727 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15728 || first_changed_charpos
== last_changed_charpos
))
15730 struct glyph_row
*r0
;
15732 /* Give up if PT is not in the window. Note that it already has
15733 been checked at the start of try_window_id that PT is not in
15734 front of the window start. */
15735 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15738 /* If window start is unchanged, we can reuse the whole matrix
15739 as is, without changing glyph positions since no text has
15740 been added/removed in front of the window end. */
15741 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15742 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15743 /* PT must not be in a partially visible line. */
15744 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15745 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15747 /* We have to compute the window end anew since text
15748 could have been added/removed after it. */
15750 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15751 w
->window_end_bytepos
15752 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15754 /* Set the cursor. */
15755 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15757 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15764 /* Give up if window start is in the changed area.
15766 The condition used to read
15768 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15770 but why that was tested escapes me at the moment. */
15771 if (CHARPOS (start
) >= first_changed_charpos
15772 && CHARPOS (start
) <= last_changed_charpos
)
15775 /* Check that window start agrees with the start of the first glyph
15776 row in its current matrix. Check this after we know the window
15777 start is not in changed text, otherwise positions would not be
15779 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15780 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15783 /* Give up if the window ends in strings. Overlay strings
15784 at the end are difficult to handle, so don't try. */
15785 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15786 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15789 /* Compute the position at which we have to start displaying new
15790 lines. Some of the lines at the top of the window might be
15791 reusable because they are not displaying changed text. Find the
15792 last row in W's current matrix not affected by changes at the
15793 start of current_buffer. Value is null if changes start in the
15794 first line of window. */
15795 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15796 if (last_unchanged_at_beg_row
)
15798 /* Avoid starting to display in the moddle of a character, a TAB
15799 for instance. This is easier than to set up the iterator
15800 exactly, and it's not a frequent case, so the additional
15801 effort wouldn't really pay off. */
15802 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15803 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15804 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15805 --last_unchanged_at_beg_row
;
15807 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15810 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15812 start_pos
= it
.current
.pos
;
15814 /* Start displaying new lines in the desired matrix at the same
15815 vpos we would use in the current matrix, i.e. below
15816 last_unchanged_at_beg_row. */
15817 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15819 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15820 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15822 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15826 /* There are no reusable lines at the start of the window.
15827 Start displaying in the first text line. */
15828 start_display (&it
, w
, start
);
15829 it
.vpos
= it
.first_vpos
;
15830 start_pos
= it
.current
.pos
;
15833 /* Find the first row that is not affected by changes at the end of
15834 the buffer. Value will be null if there is no unchanged row, in
15835 which case we must redisplay to the end of the window. delta
15836 will be set to the value by which buffer positions beginning with
15837 first_unchanged_at_end_row have to be adjusted due to text
15839 first_unchanged_at_end_row
15840 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15841 IF_DEBUG (debug_delta
= delta
);
15842 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15844 /* Set stop_pos to the buffer position up to which we will have to
15845 display new lines. If first_unchanged_at_end_row != NULL, this
15846 is the buffer position of the start of the line displayed in that
15847 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15848 that we don't stop at a buffer position. */
15850 if (first_unchanged_at_end_row
)
15852 xassert (last_unchanged_at_beg_row
== NULL
15853 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15855 /* If this is a continuation line, move forward to the next one
15856 that isn't. Changes in lines above affect this line.
15857 Caution: this may move first_unchanged_at_end_row to a row
15858 not displaying text. */
15859 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15860 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15861 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15862 < it
.last_visible_y
))
15863 ++first_unchanged_at_end_row
;
15865 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15866 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15867 >= it
.last_visible_y
))
15868 first_unchanged_at_end_row
= NULL
;
15871 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15873 first_unchanged_at_end_vpos
15874 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15875 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15878 else if (last_unchanged_at_beg_row
== NULL
)
15884 /* Either there is no unchanged row at the end, or the one we have
15885 now displays text. This is a necessary condition for the window
15886 end pos calculation at the end of this function. */
15887 xassert (first_unchanged_at_end_row
== NULL
15888 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15890 debug_last_unchanged_at_beg_vpos
15891 = (last_unchanged_at_beg_row
15892 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15894 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15896 #endif /* GLYPH_DEBUG != 0 */
15899 /* Display new lines. Set last_text_row to the last new line
15900 displayed which has text on it, i.e. might end up as being the
15901 line where the window_end_vpos is. */
15902 w
->cursor
.vpos
= -1;
15903 last_text_row
= NULL
;
15904 overlay_arrow_seen
= 0;
15905 while (it
.current_y
< it
.last_visible_y
15906 && !fonts_changed_p
15907 && (first_unchanged_at_end_row
== NULL
15908 || IT_CHARPOS (it
) < stop_pos
))
15910 if (display_line (&it
))
15911 last_text_row
= it
.glyph_row
- 1;
15914 if (fonts_changed_p
)
15918 /* Compute differences in buffer positions, y-positions etc. for
15919 lines reused at the bottom of the window. Compute what we can
15921 if (first_unchanged_at_end_row
15922 /* No lines reused because we displayed everything up to the
15923 bottom of the window. */
15924 && it
.current_y
< it
.last_visible_y
)
15927 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15929 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15930 run
.current_y
= first_unchanged_at_end_row
->y
;
15931 run
.desired_y
= run
.current_y
+ dy
;
15932 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15936 delta
= delta_bytes
= dvpos
= dy
15937 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15938 first_unchanged_at_end_row
= NULL
;
15940 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15943 /* Find the cursor if not already found. We have to decide whether
15944 PT will appear on this window (it sometimes doesn't, but this is
15945 not a very frequent case.) This decision has to be made before
15946 the current matrix is altered. A value of cursor.vpos < 0 means
15947 that PT is either in one of the lines beginning at
15948 first_unchanged_at_end_row or below the window. Don't care for
15949 lines that might be displayed later at the window end; as
15950 mentioned, this is not a frequent case. */
15951 if (w
->cursor
.vpos
< 0)
15953 /* Cursor in unchanged rows at the top? */
15954 if (PT
< CHARPOS (start_pos
)
15955 && last_unchanged_at_beg_row
)
15957 row
= row_containing_pos (w
, PT
,
15958 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15959 last_unchanged_at_beg_row
+ 1, 0);
15961 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15964 /* Start from first_unchanged_at_end_row looking for PT. */
15965 else if (first_unchanged_at_end_row
)
15967 row
= row_containing_pos (w
, PT
- delta
,
15968 first_unchanged_at_end_row
, NULL
, 0);
15970 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15971 delta_bytes
, dy
, dvpos
);
15974 /* Give up if cursor was not found. */
15975 if (w
->cursor
.vpos
< 0)
15977 clear_glyph_matrix (w
->desired_matrix
);
15982 /* Don't let the cursor end in the scroll margins. */
15984 int this_scroll_margin
, cursor_height
;
15986 this_scroll_margin
= max (0, scroll_margin
);
15987 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15988 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15989 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15991 if ((w
->cursor
.y
< this_scroll_margin
15992 && CHARPOS (start
) > BEGV
)
15993 /* Old redisplay didn't take scroll margin into account at the bottom,
15994 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15995 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15996 ? cursor_height
+ this_scroll_margin
15997 : 1)) > it
.last_visible_y
)
15999 w
->cursor
.vpos
= -1;
16000 clear_glyph_matrix (w
->desired_matrix
);
16005 /* Scroll the display. Do it before changing the current matrix so
16006 that xterm.c doesn't get confused about where the cursor glyph is
16008 if (dy
&& run
.height
)
16012 if (FRAME_WINDOW_P (f
))
16014 FRAME_RIF (f
)->update_window_begin_hook (w
);
16015 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16016 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16017 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16021 /* Terminal frame. In this case, dvpos gives the number of
16022 lines to scroll by; dvpos < 0 means scroll up. */
16024 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16025 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16026 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16027 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16028 + window_internal_height (w
));
16030 #if defined (HAVE_GPM) || defined (MSDOS)
16031 x_clear_window_mouse_face (w
);
16033 /* Perform the operation on the screen. */
16036 /* Scroll last_unchanged_at_beg_row to the end of the
16037 window down dvpos lines. */
16038 set_terminal_window (f
, end
);
16040 /* On dumb terminals delete dvpos lines at the end
16041 before inserting dvpos empty lines. */
16042 if (!FRAME_SCROLL_REGION_OK (f
))
16043 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16045 /* Insert dvpos empty lines in front of
16046 last_unchanged_at_beg_row. */
16047 ins_del_lines (f
, from
, dvpos
);
16049 else if (dvpos
< 0)
16051 /* Scroll up last_unchanged_at_beg_vpos to the end of
16052 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16053 set_terminal_window (f
, end
);
16055 /* Delete dvpos lines in front of
16056 last_unchanged_at_beg_vpos. ins_del_lines will set
16057 the cursor to the given vpos and emit |dvpos| delete
16059 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16061 /* On a dumb terminal insert dvpos empty lines at the
16063 if (!FRAME_SCROLL_REGION_OK (f
))
16064 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16067 set_terminal_window (f
, 0);
16073 /* Shift reused rows of the current matrix to the right position.
16074 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16076 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16077 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16080 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16081 bottom_vpos
, dvpos
);
16082 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16085 else if (dvpos
> 0)
16087 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16088 bottom_vpos
, dvpos
);
16089 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16090 first_unchanged_at_end_vpos
+ dvpos
, 0);
16093 /* For frame-based redisplay, make sure that current frame and window
16094 matrix are in sync with respect to glyph memory. */
16095 if (!FRAME_WINDOW_P (f
))
16096 sync_frame_with_window_matrix_rows (w
);
16098 /* Adjust buffer positions in reused rows. */
16099 if (delta
|| delta_bytes
)
16100 increment_matrix_positions (current_matrix
,
16101 first_unchanged_at_end_vpos
+ dvpos
,
16102 bottom_vpos
, delta
, delta_bytes
);
16104 /* Adjust Y positions. */
16106 shift_glyph_matrix (w
, current_matrix
,
16107 first_unchanged_at_end_vpos
+ dvpos
,
16110 if (first_unchanged_at_end_row
)
16112 first_unchanged_at_end_row
+= dvpos
;
16113 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16114 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16115 first_unchanged_at_end_row
= NULL
;
16118 /* If scrolling up, there may be some lines to display at the end of
16120 last_text_row_at_end
= NULL
;
16123 /* Scrolling up can leave for example a partially visible line
16124 at the end of the window to be redisplayed. */
16125 /* Set last_row to the glyph row in the current matrix where the
16126 window end line is found. It has been moved up or down in
16127 the matrix by dvpos. */
16128 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16129 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16131 /* If last_row is the window end line, it should display text. */
16132 xassert (last_row
->displays_text_p
);
16134 /* If window end line was partially visible before, begin
16135 displaying at that line. Otherwise begin displaying with the
16136 line following it. */
16137 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16139 init_to_row_start (&it
, w
, last_row
);
16140 it
.vpos
= last_vpos
;
16141 it
.current_y
= last_row
->y
;
16145 init_to_row_end (&it
, w
, last_row
);
16146 it
.vpos
= 1 + last_vpos
;
16147 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16151 /* We may start in a continuation line. If so, we have to
16152 get the right continuation_lines_width and current_x. */
16153 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16154 it
.hpos
= it
.current_x
= 0;
16156 /* Display the rest of the lines at the window end. */
16157 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16158 while (it
.current_y
< it
.last_visible_y
16159 && !fonts_changed_p
)
16161 /* Is it always sure that the display agrees with lines in
16162 the current matrix? I don't think so, so we mark rows
16163 displayed invalid in the current matrix by setting their
16164 enabled_p flag to zero. */
16165 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16166 if (display_line (&it
))
16167 last_text_row_at_end
= it
.glyph_row
- 1;
16171 /* Update window_end_pos and window_end_vpos. */
16172 if (first_unchanged_at_end_row
16173 && !last_text_row_at_end
)
16175 /* Window end line if one of the preserved rows from the current
16176 matrix. Set row to the last row displaying text in current
16177 matrix starting at first_unchanged_at_end_row, after
16179 xassert (first_unchanged_at_end_row
->displays_text_p
);
16180 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16181 first_unchanged_at_end_row
);
16182 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16184 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16185 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16187 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16188 xassert (w
->window_end_bytepos
>= 0);
16189 IF_DEBUG (debug_method_add (w
, "A"));
16191 else if (last_text_row_at_end
)
16194 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16195 w
->window_end_bytepos
16196 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16198 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16199 xassert (w
->window_end_bytepos
>= 0);
16200 IF_DEBUG (debug_method_add (w
, "B"));
16202 else if (last_text_row
)
16204 /* We have displayed either to the end of the window or at the
16205 end of the window, i.e. the last row with text is to be found
16206 in the desired matrix. */
16208 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16209 w
->window_end_bytepos
16210 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16212 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16213 xassert (w
->window_end_bytepos
>= 0);
16215 else if (first_unchanged_at_end_row
== NULL
16216 && last_text_row
== NULL
16217 && last_text_row_at_end
== NULL
)
16219 /* Displayed to end of window, but no line containing text was
16220 displayed. Lines were deleted at the end of the window. */
16221 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16222 int vpos
= XFASTINT (w
->window_end_vpos
);
16223 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16224 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16227 row
== NULL
&& vpos
>= first_vpos
;
16228 --vpos
, --current_row
, --desired_row
)
16230 if (desired_row
->enabled_p
)
16232 if (desired_row
->displays_text_p
)
16235 else if (current_row
->displays_text_p
)
16239 xassert (row
!= NULL
);
16240 w
->window_end_vpos
= make_number (vpos
+ 1);
16241 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16242 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16243 xassert (w
->window_end_bytepos
>= 0);
16244 IF_DEBUG (debug_method_add (w
, "C"));
16249 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16250 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16252 /* Record that display has not been completed. */
16253 w
->window_end_valid
= Qnil
;
16254 w
->desired_matrix
->no_scrolling_p
= 1;
16262 /***********************************************************************
16263 More debugging support
16264 ***********************************************************************/
16268 void dump_glyph_row (struct glyph_row
*, int, int);
16269 void dump_glyph_matrix (struct glyph_matrix
*, int);
16270 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16273 /* Dump the contents of glyph matrix MATRIX on stderr.
16275 GLYPHS 0 means don't show glyph contents.
16276 GLYPHS 1 means show glyphs in short form
16277 GLYPHS > 1 means show glyphs in long form. */
16280 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
16283 for (i
= 0; i
< matrix
->nrows
; ++i
)
16284 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16288 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16289 the glyph row and area where the glyph comes from. */
16292 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
16294 if (glyph
->type
== CHAR_GLYPH
)
16297 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16298 glyph
- row
->glyphs
[TEXT_AREA
],
16301 (BUFFERP (glyph
->object
)
16303 : (STRINGP (glyph
->object
)
16306 glyph
->pixel_width
,
16308 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16312 glyph
->left_box_line_p
,
16313 glyph
->right_box_line_p
);
16315 else if (glyph
->type
== STRETCH_GLYPH
)
16318 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16319 glyph
- row
->glyphs
[TEXT_AREA
],
16322 (BUFFERP (glyph
->object
)
16324 : (STRINGP (glyph
->object
)
16327 glyph
->pixel_width
,
16331 glyph
->left_box_line_p
,
16332 glyph
->right_box_line_p
);
16334 else if (glyph
->type
== IMAGE_GLYPH
)
16337 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16338 glyph
- row
->glyphs
[TEXT_AREA
],
16341 (BUFFERP (glyph
->object
)
16343 : (STRINGP (glyph
->object
)
16346 glyph
->pixel_width
,
16350 glyph
->left_box_line_p
,
16351 glyph
->right_box_line_p
);
16353 else if (glyph
->type
== COMPOSITE_GLYPH
)
16356 " %5d %4c %6d %c %3d 0x%05x",
16357 glyph
- row
->glyphs
[TEXT_AREA
],
16360 (BUFFERP (glyph
->object
)
16362 : (STRINGP (glyph
->object
)
16365 glyph
->pixel_width
,
16367 if (glyph
->u
.cmp
.automatic
)
16370 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16371 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16373 glyph
->left_box_line_p
,
16374 glyph
->right_box_line_p
);
16379 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16380 GLYPHS 0 means don't show glyph contents.
16381 GLYPHS 1 means show glyphs in short form
16382 GLYPHS > 1 means show glyphs in long form. */
16385 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
16389 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16390 fprintf (stderr
, "======================================================================\n");
16392 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16393 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16395 MATRIX_ROW_START_CHARPOS (row
),
16396 MATRIX_ROW_END_CHARPOS (row
),
16397 row
->used
[TEXT_AREA
],
16398 row
->contains_overlapping_glyphs_p
,
16400 row
->truncated_on_left_p
,
16401 row
->truncated_on_right_p
,
16403 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16404 row
->displays_text_p
,
16407 row
->ends_in_middle_of_char_p
,
16408 row
->starts_in_middle_of_char_p
,
16414 row
->visible_height
,
16417 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16418 row
->end
.overlay_string_index
,
16419 row
->continuation_lines_width
);
16420 fprintf (stderr
, "%9d %5d\n",
16421 CHARPOS (row
->start
.string_pos
),
16422 CHARPOS (row
->end
.string_pos
));
16423 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16424 row
->end
.dpvec_index
);
16431 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16433 struct glyph
*glyph
= row
->glyphs
[area
];
16434 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16436 /* Glyph for a line end in text. */
16437 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16440 if (glyph
< glyph_end
)
16441 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16443 for (; glyph
< glyph_end
; ++glyph
)
16444 dump_glyph (row
, glyph
, area
);
16447 else if (glyphs
== 1)
16451 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16453 char *s
= (char *) alloca (row
->used
[area
] + 1);
16456 for (i
= 0; i
< row
->used
[area
]; ++i
)
16458 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16459 if (glyph
->type
== CHAR_GLYPH
16460 && glyph
->u
.ch
< 0x80
16461 && glyph
->u
.ch
>= ' ')
16462 s
[i
] = glyph
->u
.ch
;
16468 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16474 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16475 Sdump_glyph_matrix
, 0, 1, "p",
16476 doc
: /* Dump the current matrix of the selected window to stderr.
16477 Shows contents of glyph row structures. With non-nil
16478 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16479 glyphs in short form, otherwise show glyphs in long form. */)
16480 (Lisp_Object glyphs
)
16482 struct window
*w
= XWINDOW (selected_window
);
16483 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16485 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16486 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16487 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16488 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16489 fprintf (stderr
, "=============================================\n");
16490 dump_glyph_matrix (w
->current_matrix
,
16491 NILP (glyphs
) ? 0 : XINT (glyphs
));
16496 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16497 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16500 struct frame
*f
= XFRAME (selected_frame
);
16501 dump_glyph_matrix (f
->current_matrix
, 1);
16506 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16507 doc
: /* Dump glyph row ROW to stderr.
16508 GLYPH 0 means don't dump glyphs.
16509 GLYPH 1 means dump glyphs in short form.
16510 GLYPH > 1 or omitted means dump glyphs in long form. */)
16511 (Lisp_Object row
, Lisp_Object glyphs
)
16513 struct glyph_matrix
*matrix
;
16516 CHECK_NUMBER (row
);
16517 matrix
= XWINDOW (selected_window
)->current_matrix
;
16519 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16520 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16522 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16527 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16528 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16529 GLYPH 0 means don't dump glyphs.
16530 GLYPH 1 means dump glyphs in short form.
16531 GLYPH > 1 or omitted means dump glyphs in long form. */)
16532 (Lisp_Object row
, Lisp_Object glyphs
)
16534 struct frame
*sf
= SELECTED_FRAME ();
16535 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16538 CHECK_NUMBER (row
);
16540 if (vpos
>= 0 && vpos
< m
->nrows
)
16541 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16542 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16547 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16548 doc
: /* Toggle tracing of redisplay.
16549 With ARG, turn tracing on if and only if ARG is positive. */)
16553 trace_redisplay_p
= !trace_redisplay_p
;
16556 arg
= Fprefix_numeric_value (arg
);
16557 trace_redisplay_p
= XINT (arg
) > 0;
16564 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16565 doc
: /* Like `format', but print result to stderr.
16566 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16567 (ptrdiff_t nargs
, Lisp_Object
*args
)
16569 Lisp_Object s
= Fformat (nargs
, args
);
16570 fprintf (stderr
, "%s", SDATA (s
));
16574 #endif /* GLYPH_DEBUG */
16578 /***********************************************************************
16579 Building Desired Matrix Rows
16580 ***********************************************************************/
16582 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16583 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16585 static struct glyph_row
*
16586 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16588 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16589 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16590 struct buffer
*old
= current_buffer
;
16591 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16592 int arrow_len
= SCHARS (overlay_arrow_string
);
16593 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16594 const unsigned char *p
;
16597 int n_glyphs_before
;
16599 set_buffer_temp (buffer
);
16600 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16601 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16602 SET_TEXT_POS (it
.position
, 0, 0);
16604 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16606 while (p
< arrow_end
)
16608 Lisp_Object face
, ilisp
;
16610 /* Get the next character. */
16612 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16615 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16616 if (! ASCII_CHAR_P (it
.c
))
16617 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16621 /* Get its face. */
16622 ilisp
= make_number (p
- arrow_string
);
16623 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16624 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16626 /* Compute its width, get its glyphs. */
16627 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16628 SET_TEXT_POS (it
.position
, -1, -1);
16629 PRODUCE_GLYPHS (&it
);
16631 /* If this character doesn't fit any more in the line, we have
16632 to remove some glyphs. */
16633 if (it
.current_x
> it
.last_visible_x
)
16635 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16640 set_buffer_temp (old
);
16641 return it
.glyph_row
;
16645 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16646 glyphs are only inserted for terminal frames since we can't really
16647 win with truncation glyphs when partially visible glyphs are
16648 involved. Which glyphs to insert is determined by
16649 produce_special_glyphs. */
16652 insert_left_trunc_glyphs (struct it
*it
)
16654 struct it truncate_it
;
16655 struct glyph
*from
, *end
, *to
, *toend
;
16657 xassert (!FRAME_WINDOW_P (it
->f
));
16659 /* Get the truncation glyphs. */
16661 truncate_it
.current_x
= 0;
16662 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16663 truncate_it
.glyph_row
= &scratch_glyph_row
;
16664 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16665 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16666 truncate_it
.object
= make_number (0);
16667 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16669 /* Overwrite glyphs from IT with truncation glyphs. */
16670 if (!it
->glyph_row
->reversed_p
)
16672 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16673 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16674 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16675 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16680 /* There may be padding glyphs left over. Overwrite them too. */
16681 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16683 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16689 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16693 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16694 that back to front. */
16695 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16696 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16697 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16698 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16700 while (from
>= end
&& to
>= toend
)
16702 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16705 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16706 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16707 while (from
>= end
&& to
>= toend
)
16712 /* Need to free some room before prepending additional
16714 int move_by
= from
- end
+ 1;
16715 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16716 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16718 for ( ; g
>= g0
; g
--)
16720 while (from
>= end
)
16722 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16728 /* Compute the pixel height and width of IT->glyph_row.
16730 Most of the time, ascent and height of a display line will be equal
16731 to the max_ascent and max_height values of the display iterator
16732 structure. This is not the case if
16734 1. We hit ZV without displaying anything. In this case, max_ascent
16735 and max_height will be zero.
16737 2. We have some glyphs that don't contribute to the line height.
16738 (The glyph row flag contributes_to_line_height_p is for future
16739 pixmap extensions).
16741 The first case is easily covered by using default values because in
16742 these cases, the line height does not really matter, except that it
16743 must not be zero. */
16746 compute_line_metrics (struct it
*it
)
16748 struct glyph_row
*row
= it
->glyph_row
;
16750 if (FRAME_WINDOW_P (it
->f
))
16752 int i
, min_y
, max_y
;
16754 /* The line may consist of one space only, that was added to
16755 place the cursor on it. If so, the row's height hasn't been
16757 if (row
->height
== 0)
16759 if (it
->max_ascent
+ it
->max_descent
== 0)
16760 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16761 row
->ascent
= it
->max_ascent
;
16762 row
->height
= it
->max_ascent
+ it
->max_descent
;
16763 row
->phys_ascent
= it
->max_phys_ascent
;
16764 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16765 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16768 /* Compute the width of this line. */
16769 row
->pixel_width
= row
->x
;
16770 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16771 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16773 xassert (row
->pixel_width
>= 0);
16774 xassert (row
->ascent
>= 0 && row
->height
> 0);
16776 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16777 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16779 /* If first line's physical ascent is larger than its logical
16780 ascent, use the physical ascent, and make the row taller.
16781 This makes accented characters fully visible. */
16782 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16783 && row
->phys_ascent
> row
->ascent
)
16785 row
->height
+= row
->phys_ascent
- row
->ascent
;
16786 row
->ascent
= row
->phys_ascent
;
16789 /* Compute how much of the line is visible. */
16790 row
->visible_height
= row
->height
;
16792 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16793 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16795 if (row
->y
< min_y
)
16796 row
->visible_height
-= min_y
- row
->y
;
16797 if (row
->y
+ row
->height
> max_y
)
16798 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16802 row
->pixel_width
= row
->used
[TEXT_AREA
];
16803 if (row
->continued_p
)
16804 row
->pixel_width
-= it
->continuation_pixel_width
;
16805 else if (row
->truncated_on_right_p
)
16806 row
->pixel_width
-= it
->truncation_pixel_width
;
16807 row
->ascent
= row
->phys_ascent
= 0;
16808 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16809 row
->extra_line_spacing
= 0;
16812 /* Compute a hash code for this row. */
16816 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16817 for (i
= 0; i
< row
->used
[area
]; ++i
)
16818 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16819 + row
->glyphs
[area
][i
].u
.val
16820 + row
->glyphs
[area
][i
].face_id
16821 + row
->glyphs
[area
][i
].padding_p
16822 + (row
->glyphs
[area
][i
].type
<< 2));
16825 it
->max_ascent
= it
->max_descent
= 0;
16826 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16830 /* Append one space to the glyph row of iterator IT if doing a
16831 window-based redisplay. The space has the same face as
16832 IT->face_id. Value is non-zero if a space was added.
16834 This function is called to make sure that there is always one glyph
16835 at the end of a glyph row that the cursor can be set on under
16836 window-systems. (If there weren't such a glyph we would not know
16837 how wide and tall a box cursor should be displayed).
16839 At the same time this space let's a nicely handle clearing to the
16840 end of the line if the row ends in italic text. */
16843 append_space_for_newline (struct it
*it
, int default_face_p
)
16845 if (FRAME_WINDOW_P (it
->f
))
16847 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16849 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16850 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16852 /* Save some values that must not be changed.
16853 Must save IT->c and IT->len because otherwise
16854 ITERATOR_AT_END_P wouldn't work anymore after
16855 append_space_for_newline has been called. */
16856 enum display_element_type saved_what
= it
->what
;
16857 int saved_c
= it
->c
, saved_len
= it
->len
;
16858 int saved_char_to_display
= it
->char_to_display
;
16859 int saved_x
= it
->current_x
;
16860 int saved_face_id
= it
->face_id
;
16861 struct text_pos saved_pos
;
16862 Lisp_Object saved_object
;
16865 saved_object
= it
->object
;
16866 saved_pos
= it
->position
;
16868 it
->what
= IT_CHARACTER
;
16869 memset (&it
->position
, 0, sizeof it
->position
);
16870 it
->object
= make_number (0);
16871 it
->c
= it
->char_to_display
= ' ';
16874 if (default_face_p
)
16875 it
->face_id
= DEFAULT_FACE_ID
;
16876 else if (it
->face_before_selective_p
)
16877 it
->face_id
= it
->saved_face_id
;
16878 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16879 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16881 PRODUCE_GLYPHS (it
);
16883 it
->override_ascent
= -1;
16884 it
->constrain_row_ascent_descent_p
= 0;
16885 it
->current_x
= saved_x
;
16886 it
->object
= saved_object
;
16887 it
->position
= saved_pos
;
16888 it
->what
= saved_what
;
16889 it
->face_id
= saved_face_id
;
16890 it
->len
= saved_len
;
16892 it
->char_to_display
= saved_char_to_display
;
16901 /* Extend the face of the last glyph in the text area of IT->glyph_row
16902 to the end of the display line. Called from display_line. If the
16903 glyph row is empty, add a space glyph to it so that we know the
16904 face to draw. Set the glyph row flag fill_line_p. If the glyph
16905 row is R2L, prepend a stretch glyph to cover the empty space to the
16906 left of the leftmost glyph. */
16909 extend_face_to_end_of_line (struct it
*it
)
16912 struct frame
*f
= it
->f
;
16914 /* If line is already filled, do nothing. Non window-system frames
16915 get a grace of one more ``pixel'' because their characters are
16916 1-``pixel'' wide, so they hit the equality too early. This grace
16917 is needed only for R2L rows that are not continued, to produce
16918 one extra blank where we could display the cursor. */
16919 if (it
->current_x
>= it
->last_visible_x
16920 + (!FRAME_WINDOW_P (f
)
16921 && it
->glyph_row
->reversed_p
16922 && !it
->glyph_row
->continued_p
))
16925 /* Face extension extends the background and box of IT->face_id
16926 to the end of the line. If the background equals the background
16927 of the frame, we don't have to do anything. */
16928 if (it
->face_before_selective_p
)
16929 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16931 face
= FACE_FROM_ID (f
, it
->face_id
);
16933 if (FRAME_WINDOW_P (f
)
16934 && it
->glyph_row
->displays_text_p
16935 && face
->box
== FACE_NO_BOX
16936 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16938 && !it
->glyph_row
->reversed_p
)
16941 /* Set the glyph row flag indicating that the face of the last glyph
16942 in the text area has to be drawn to the end of the text area. */
16943 it
->glyph_row
->fill_line_p
= 1;
16945 /* If current character of IT is not ASCII, make sure we have the
16946 ASCII face. This will be automatically undone the next time
16947 get_next_display_element returns a multibyte character. Note
16948 that the character will always be single byte in unibyte
16950 if (!ASCII_CHAR_P (it
->c
))
16952 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16955 if (FRAME_WINDOW_P (f
))
16957 /* If the row is empty, add a space with the current face of IT,
16958 so that we know which face to draw. */
16959 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16961 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16962 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16963 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16965 #ifdef HAVE_WINDOW_SYSTEM
16966 if (it
->glyph_row
->reversed_p
)
16968 /* Prepend a stretch glyph to the row, such that the
16969 rightmost glyph will be drawn flushed all the way to the
16970 right margin of the window. The stretch glyph that will
16971 occupy the empty space, if any, to the left of the
16973 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16974 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16975 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16977 int row_width
, stretch_ascent
, stretch_width
;
16978 struct text_pos saved_pos
;
16979 int saved_face_id
, saved_avoid_cursor
;
16981 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16982 row_width
+= g
->pixel_width
;
16983 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16984 if (stretch_width
> 0)
16987 (((it
->ascent
+ it
->descent
)
16988 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16989 saved_pos
= it
->position
;
16990 memset (&it
->position
, 0, sizeof it
->position
);
16991 saved_avoid_cursor
= it
->avoid_cursor_p
;
16992 it
->avoid_cursor_p
= 1;
16993 saved_face_id
= it
->face_id
;
16994 /* The last row's stretch glyph should get the default
16995 face, to avoid painting the rest of the window with
16996 the region face, if the region ends at ZV. */
16997 if (it
->glyph_row
->ends_at_zv_p
)
16998 it
->face_id
= DEFAULT_FACE_ID
;
17000 it
->face_id
= face
->id
;
17001 append_stretch_glyph (it
, make_number (0), stretch_width
,
17002 it
->ascent
+ it
->descent
, stretch_ascent
);
17003 it
->position
= saved_pos
;
17004 it
->avoid_cursor_p
= saved_avoid_cursor
;
17005 it
->face_id
= saved_face_id
;
17008 #endif /* HAVE_WINDOW_SYSTEM */
17012 /* Save some values that must not be changed. */
17013 int saved_x
= it
->current_x
;
17014 struct text_pos saved_pos
;
17015 Lisp_Object saved_object
;
17016 enum display_element_type saved_what
= it
->what
;
17017 int saved_face_id
= it
->face_id
;
17019 saved_object
= it
->object
;
17020 saved_pos
= it
->position
;
17022 it
->what
= IT_CHARACTER
;
17023 memset (&it
->position
, 0, sizeof it
->position
);
17024 it
->object
= make_number (0);
17025 it
->c
= it
->char_to_display
= ' ';
17027 /* The last row's blank glyphs should get the default face, to
17028 avoid painting the rest of the window with the region face,
17029 if the region ends at ZV. */
17030 if (it
->glyph_row
->ends_at_zv_p
)
17031 it
->face_id
= DEFAULT_FACE_ID
;
17033 it
->face_id
= face
->id
;
17035 PRODUCE_GLYPHS (it
);
17037 while (it
->current_x
<= it
->last_visible_x
)
17038 PRODUCE_GLYPHS (it
);
17040 /* Don't count these blanks really. It would let us insert a left
17041 truncation glyph below and make us set the cursor on them, maybe. */
17042 it
->current_x
= saved_x
;
17043 it
->object
= saved_object
;
17044 it
->position
= saved_pos
;
17045 it
->what
= saved_what
;
17046 it
->face_id
= saved_face_id
;
17051 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17052 trailing whitespace. */
17055 trailing_whitespace_p (EMACS_INT charpos
)
17057 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17060 while (bytepos
< ZV_BYTE
17061 && (c
= FETCH_CHAR (bytepos
),
17062 c
== ' ' || c
== '\t'))
17065 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17067 if (bytepos
!= PT_BYTE
)
17074 /* Highlight trailing whitespace, if any, in ROW. */
17077 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17079 int used
= row
->used
[TEXT_AREA
];
17083 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17084 struct glyph
*glyph
= start
+ used
- 1;
17086 if (row
->reversed_p
)
17088 /* Right-to-left rows need to be processed in the opposite
17089 direction, so swap the edge pointers. */
17091 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17094 /* Skip over glyphs inserted to display the cursor at the
17095 end of a line, for extending the face of the last glyph
17096 to the end of the line on terminals, and for truncation
17097 and continuation glyphs. */
17098 if (!row
->reversed_p
)
17100 while (glyph
>= start
17101 && glyph
->type
== CHAR_GLYPH
17102 && INTEGERP (glyph
->object
))
17107 while (glyph
<= start
17108 && glyph
->type
== CHAR_GLYPH
17109 && INTEGERP (glyph
->object
))
17113 /* If last glyph is a space or stretch, and it's trailing
17114 whitespace, set the face of all trailing whitespace glyphs in
17115 IT->glyph_row to `trailing-whitespace'. */
17116 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17117 && BUFFERP (glyph
->object
)
17118 && (glyph
->type
== STRETCH_GLYPH
17119 || (glyph
->type
== CHAR_GLYPH
17120 && glyph
->u
.ch
== ' '))
17121 && trailing_whitespace_p (glyph
->charpos
))
17123 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17127 if (!row
->reversed_p
)
17129 while (glyph
>= start
17130 && BUFFERP (glyph
->object
)
17131 && (glyph
->type
== STRETCH_GLYPH
17132 || (glyph
->type
== CHAR_GLYPH
17133 && glyph
->u
.ch
== ' ')))
17134 (glyph
--)->face_id
= face_id
;
17138 while (glyph
<= start
17139 && BUFFERP (glyph
->object
)
17140 && (glyph
->type
== STRETCH_GLYPH
17141 || (glyph
->type
== CHAR_GLYPH
17142 && glyph
->u
.ch
== ' ')))
17143 (glyph
++)->face_id
= face_id
;
17150 /* Value is non-zero if glyph row ROW should be
17151 used to hold the cursor. */
17154 cursor_row_p (struct glyph_row
*row
)
17158 if (PT
== CHARPOS (row
->end
.pos
))
17160 /* Suppose the row ends on a string.
17161 Unless the row is continued, that means it ends on a newline
17162 in the string. If it's anything other than a display string
17163 (e.g. a before-string from an overlay), we don't want the
17164 cursor there. (This heuristic seems to give the optimal
17165 behavior for the various types of multi-line strings.) */
17166 if (CHARPOS (row
->end
.string_pos
) >= 0)
17168 if (row
->continued_p
)
17172 /* Check for `display' property. */
17173 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17174 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17175 struct glyph
*glyph
;
17178 for (glyph
= end
; glyph
>= beg
; --glyph
)
17179 if (STRINGP (glyph
->object
))
17182 = Fget_char_property (make_number (PT
),
17186 && display_prop_string_p (prop
, glyph
->object
));
17191 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17193 /* If the row ends in middle of a real character,
17194 and the line is continued, we want the cursor here.
17195 That's because CHARPOS (ROW->end.pos) would equal
17196 PT if PT is before the character. */
17197 if (!row
->ends_in_ellipsis_p
)
17198 result
= row
->continued_p
;
17200 /* If the row ends in an ellipsis, then
17201 CHARPOS (ROW->end.pos) will equal point after the
17202 invisible text. We want that position to be displayed
17203 after the ellipsis. */
17206 /* If the row ends at ZV, display the cursor at the end of that
17207 row instead of at the start of the row below. */
17208 else if (row
->ends_at_zv_p
)
17219 /* Push the display property PROP so that it will be rendered at the
17220 current position in IT. Return 1 if PROP was successfully pushed,
17224 push_display_prop (struct it
*it
, Lisp_Object prop
)
17226 push_it (it
, NULL
);
17228 if (STRINGP (prop
))
17230 if (SCHARS (prop
) == 0)
17237 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17238 it
->current
.overlay_string_index
= -1;
17239 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17240 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17241 it
->method
= GET_FROM_STRING
;
17242 it
->stop_charpos
= 0;
17244 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17246 it
->method
= GET_FROM_STRETCH
;
17249 #ifdef HAVE_WINDOW_SYSTEM
17250 else if (IMAGEP (prop
))
17252 it
->what
= IT_IMAGE
;
17253 it
->image_id
= lookup_image (it
->f
, prop
);
17254 it
->method
= GET_FROM_IMAGE
;
17256 #endif /* HAVE_WINDOW_SYSTEM */
17259 pop_it (it
); /* bogus display property, give up */
17266 /* Return the character-property PROP at the current position in IT. */
17269 get_it_property (struct it
*it
, Lisp_Object prop
)
17271 Lisp_Object position
;
17273 if (STRINGP (it
->object
))
17274 position
= make_number (IT_STRING_CHARPOS (*it
));
17275 else if (BUFFERP (it
->object
))
17276 position
= make_number (IT_CHARPOS (*it
));
17280 return Fget_char_property (position
, prop
, it
->object
);
17283 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17286 handle_line_prefix (struct it
*it
)
17288 Lisp_Object prefix
;
17289 if (it
->continuation_lines_width
> 0)
17291 prefix
= get_it_property (it
, Qwrap_prefix
);
17293 prefix
= Vwrap_prefix
;
17297 prefix
= get_it_property (it
, Qline_prefix
);
17299 prefix
= Vline_prefix
;
17301 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17303 /* If the prefix is wider than the window, and we try to wrap
17304 it, it would acquire its own wrap prefix, and so on till the
17305 iterator stack overflows. So, don't wrap the prefix. */
17306 it
->line_wrap
= TRUNCATE
;
17307 it
->avoid_cursor_p
= 1;
17313 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17314 only for R2L lines from display_line, when it decides that too many
17315 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17318 unproduce_glyphs (struct it
*it
, int n
)
17320 struct glyph
*glyph
, *end
;
17322 xassert (it
->glyph_row
);
17323 xassert (it
->glyph_row
->reversed_p
);
17324 xassert (it
->area
== TEXT_AREA
);
17325 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17327 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17328 n
= it
->glyph_row
->used
[TEXT_AREA
];
17329 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17330 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17331 for ( ; glyph
< end
; glyph
++)
17332 glyph
[-n
] = *glyph
;
17335 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17336 and ROW->maxpos. */
17338 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17339 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17340 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17342 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17343 lines' rows is implemented for bidi-reordered rows. */
17345 /* ROW->minpos is the value of min_pos, the minimal buffer position
17348 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17350 /* We didn't find _any_ valid buffer positions in any of the
17351 glyphs, so we must trust the iterator's computed positions. */
17352 row
->minpos
= row
->start
.pos
;
17355 max_pos
= CHARPOS (it
->current
.pos
);
17356 max_bpos
= BYTEPOS (it
->current
.pos
);
17359 /* Here are the various use-cases for ending the row, and the
17360 corresponding values for ROW->maxpos:
17362 Line ends in a newline from buffer eol_pos + 1
17363 Line is continued from buffer max_pos + 1
17364 Line is truncated on right it->current.pos
17365 Line ends in a newline from string max_pos
17366 Line is continued from string max_pos
17367 Line is continued from display vector max_pos
17368 Line is entirely from a string min_pos == max_pos
17369 Line is entirely from a display vector min_pos == max_pos
17370 Line that ends at ZV ZV
17372 If you discover other use-cases, please add them here as
17374 if (row
->ends_at_zv_p
)
17375 row
->maxpos
= it
->current
.pos
;
17376 else if (row
->used
[TEXT_AREA
])
17378 if (row
->ends_in_newline_from_string_p
)
17379 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17380 else if (CHARPOS (it
->eol_pos
) > 0)
17381 SET_TEXT_POS (row
->maxpos
,
17382 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17383 else if (row
->continued_p
)
17385 /* If max_pos is different from IT's current position, it
17386 means IT->method does not belong to the display element
17387 at max_pos. However, it also means that the display
17388 element at max_pos was displayed in its entirety on this
17389 line, which is equivalent to saying that the next line
17390 starts at the next buffer position. */
17391 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17392 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17395 INC_BOTH (max_pos
, max_bpos
);
17396 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17399 else if (row
->truncated_on_right_p
)
17400 /* display_line already called reseat_at_next_visible_line_start,
17401 which puts the iterator at the beginning of the next line, in
17402 the logical order. */
17403 row
->maxpos
= it
->current
.pos
;
17404 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17405 /* A line that is entirely from a string/image/stretch... */
17406 row
->maxpos
= row
->minpos
;
17411 row
->maxpos
= it
->current
.pos
;
17414 /* Construct the glyph row IT->glyph_row in the desired matrix of
17415 IT->w from text at the current position of IT. See dispextern.h
17416 for an overview of struct it. Value is non-zero if
17417 IT->glyph_row displays text, as opposed to a line displaying ZV
17421 display_line (struct it
*it
)
17423 struct glyph_row
*row
= it
->glyph_row
;
17424 Lisp_Object overlay_arrow_string
;
17426 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17427 int wrap_row_used
= -1;
17428 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17429 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17430 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17431 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17432 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17434 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17435 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17437 /* We always start displaying at hpos zero even if hscrolled. */
17438 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17440 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17441 >= it
->w
->desired_matrix
->nrows
)
17443 it
->w
->nrows_scale_factor
++;
17444 fonts_changed_p
= 1;
17448 /* Is IT->w showing the region? */
17449 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17451 /* Clear the result glyph row and enable it. */
17452 prepare_desired_row (row
);
17454 row
->y
= it
->current_y
;
17455 row
->start
= it
->start
;
17456 row
->continuation_lines_width
= it
->continuation_lines_width
;
17457 row
->displays_text_p
= 1;
17458 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17459 it
->starts_in_middle_of_char_p
= 0;
17461 /* Arrange the overlays nicely for our purposes. Usually, we call
17462 display_line on only one line at a time, in which case this
17463 can't really hurt too much, or we call it on lines which appear
17464 one after another in the buffer, in which case all calls to
17465 recenter_overlay_lists but the first will be pretty cheap. */
17466 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17468 /* Move over display elements that are not visible because we are
17469 hscrolled. This may stop at an x-position < IT->first_visible_x
17470 if the first glyph is partially visible or if we hit a line end. */
17471 if (it
->current_x
< it
->first_visible_x
)
17473 this_line_min_pos
= row
->start
.pos
;
17474 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17475 MOVE_TO_POS
| MOVE_TO_X
);
17476 /* Record the smallest positions seen while we moved over
17477 display elements that are not visible. This is needed by
17478 redisplay_internal for optimizing the case where the cursor
17479 stays inside the same line. The rest of this function only
17480 considers positions that are actually displayed, so
17481 RECORD_MAX_MIN_POS will not otherwise record positions that
17482 are hscrolled to the left of the left edge of the window. */
17483 min_pos
= CHARPOS (this_line_min_pos
);
17484 min_bpos
= BYTEPOS (this_line_min_pos
);
17488 /* We only do this when not calling `move_it_in_display_line_to'
17489 above, because move_it_in_display_line_to calls
17490 handle_line_prefix itself. */
17491 handle_line_prefix (it
);
17494 /* Get the initial row height. This is either the height of the
17495 text hscrolled, if there is any, or zero. */
17496 row
->ascent
= it
->max_ascent
;
17497 row
->height
= it
->max_ascent
+ it
->max_descent
;
17498 row
->phys_ascent
= it
->max_phys_ascent
;
17499 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17500 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17502 /* Utility macro to record max and min buffer positions seen until now. */
17503 #define RECORD_MAX_MIN_POS(IT) \
17506 if (IT_CHARPOS (*(IT)) < min_pos) \
17508 min_pos = IT_CHARPOS (*(IT)); \
17509 min_bpos = IT_BYTEPOS (*(IT)); \
17511 if (IT_CHARPOS (*(IT)) > max_pos) \
17513 max_pos = IT_CHARPOS (*(IT)); \
17514 max_bpos = IT_BYTEPOS (*(IT)); \
17519 /* Loop generating characters. The loop is left with IT on the next
17520 character to display. */
17523 int n_glyphs_before
, hpos_before
, x_before
;
17525 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17527 /* Retrieve the next thing to display. Value is zero if end of
17529 if (!get_next_display_element (it
))
17531 /* Maybe add a space at the end of this line that is used to
17532 display the cursor there under X. Set the charpos of the
17533 first glyph of blank lines not corresponding to any text
17535 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17536 row
->exact_window_width_line_p
= 1;
17537 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17538 || row
->used
[TEXT_AREA
] == 0)
17540 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17541 row
->displays_text_p
= 0;
17543 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17544 && (!MINI_WINDOW_P (it
->w
)
17545 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17546 row
->indicate_empty_line_p
= 1;
17549 it
->continuation_lines_width
= 0;
17550 row
->ends_at_zv_p
= 1;
17551 /* A row that displays right-to-left text must always have
17552 its last face extended all the way to the end of line,
17553 even if this row ends in ZV, because we still write to
17554 the screen left to right. */
17555 if (row
->reversed_p
)
17556 extend_face_to_end_of_line (it
);
17560 /* Now, get the metrics of what we want to display. This also
17561 generates glyphs in `row' (which is IT->glyph_row). */
17562 n_glyphs_before
= row
->used
[TEXT_AREA
];
17565 /* Remember the line height so far in case the next element doesn't
17566 fit on the line. */
17567 if (it
->line_wrap
!= TRUNCATE
)
17569 ascent
= it
->max_ascent
;
17570 descent
= it
->max_descent
;
17571 phys_ascent
= it
->max_phys_ascent
;
17572 phys_descent
= it
->max_phys_descent
;
17574 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17576 if (IT_DISPLAYING_WHITESPACE (it
))
17582 wrap_row_used
= row
->used
[TEXT_AREA
];
17583 wrap_row_ascent
= row
->ascent
;
17584 wrap_row_height
= row
->height
;
17585 wrap_row_phys_ascent
= row
->phys_ascent
;
17586 wrap_row_phys_height
= row
->phys_height
;
17587 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17588 wrap_row_min_pos
= min_pos
;
17589 wrap_row_min_bpos
= min_bpos
;
17590 wrap_row_max_pos
= max_pos
;
17591 wrap_row_max_bpos
= max_bpos
;
17597 PRODUCE_GLYPHS (it
);
17599 /* If this display element was in marginal areas, continue with
17601 if (it
->area
!= TEXT_AREA
)
17603 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17604 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17605 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17606 row
->phys_height
= max (row
->phys_height
,
17607 it
->max_phys_ascent
+ it
->max_phys_descent
);
17608 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17609 it
->max_extra_line_spacing
);
17610 set_iterator_to_next (it
, 1);
17614 /* Does the display element fit on the line? If we truncate
17615 lines, we should draw past the right edge of the window. If
17616 we don't truncate, we want to stop so that we can display the
17617 continuation glyph before the right margin. If lines are
17618 continued, there are two possible strategies for characters
17619 resulting in more than 1 glyph (e.g. tabs): Display as many
17620 glyphs as possible in this line and leave the rest for the
17621 continuation line, or display the whole element in the next
17622 line. Original redisplay did the former, so we do it also. */
17623 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17624 hpos_before
= it
->hpos
;
17627 if (/* Not a newline. */
17629 /* Glyphs produced fit entirely in the line. */
17630 && it
->current_x
< it
->last_visible_x
)
17632 it
->hpos
+= nglyphs
;
17633 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17634 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17635 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17636 row
->phys_height
= max (row
->phys_height
,
17637 it
->max_phys_ascent
+ it
->max_phys_descent
);
17638 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17639 it
->max_extra_line_spacing
);
17640 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17641 row
->x
= x
- it
->first_visible_x
;
17642 /* Record the maximum and minimum buffer positions seen so
17643 far in glyphs that will be displayed by this row. */
17645 RECORD_MAX_MIN_POS (it
);
17650 struct glyph
*glyph
;
17652 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17654 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17655 new_x
= x
+ glyph
->pixel_width
;
17657 if (/* Lines are continued. */
17658 it
->line_wrap
!= TRUNCATE
17659 && (/* Glyph doesn't fit on the line. */
17660 new_x
> it
->last_visible_x
17661 /* Or it fits exactly on a window system frame. */
17662 || (new_x
== it
->last_visible_x
17663 && FRAME_WINDOW_P (it
->f
))))
17665 /* End of a continued line. */
17668 || (new_x
== it
->last_visible_x
17669 && FRAME_WINDOW_P (it
->f
)))
17671 /* Current glyph is the only one on the line or
17672 fits exactly on the line. We must continue
17673 the line because we can't draw the cursor
17674 after the glyph. */
17675 row
->continued_p
= 1;
17676 it
->current_x
= new_x
;
17677 it
->continuation_lines_width
+= new_x
;
17679 /* Record the maximum and minimum buffer
17680 positions seen so far in glyphs that will be
17681 displayed by this row. */
17683 RECORD_MAX_MIN_POS (it
);
17684 if (i
== nglyphs
- 1)
17686 /* If line-wrap is on, check if a previous
17687 wrap point was found. */
17688 if (wrap_row_used
> 0
17689 /* Even if there is a previous wrap
17690 point, continue the line here as
17691 usual, if (i) the previous character
17692 was a space or tab AND (ii) the
17693 current character is not. */
17695 || IT_DISPLAYING_WHITESPACE (it
)))
17698 set_iterator_to_next (it
, 1);
17699 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17701 if (!get_next_display_element (it
))
17703 row
->exact_window_width_line_p
= 1;
17704 it
->continuation_lines_width
= 0;
17705 row
->continued_p
= 0;
17706 row
->ends_at_zv_p
= 1;
17708 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17710 row
->continued_p
= 0;
17711 row
->exact_window_width_line_p
= 1;
17716 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17717 && !FRAME_WINDOW_P (it
->f
))
17719 /* A padding glyph that doesn't fit on this line.
17720 This means the whole character doesn't fit
17722 if (row
->reversed_p
)
17723 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17724 - n_glyphs_before
);
17725 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17727 /* Fill the rest of the row with continuation
17728 glyphs like in 20.x. */
17729 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17730 < row
->glyphs
[1 + TEXT_AREA
])
17731 produce_special_glyphs (it
, IT_CONTINUATION
);
17733 row
->continued_p
= 1;
17734 it
->current_x
= x_before
;
17735 it
->continuation_lines_width
+= x_before
;
17737 /* Restore the height to what it was before the
17738 element not fitting on the line. */
17739 it
->max_ascent
= ascent
;
17740 it
->max_descent
= descent
;
17741 it
->max_phys_ascent
= phys_ascent
;
17742 it
->max_phys_descent
= phys_descent
;
17744 else if (wrap_row_used
> 0)
17747 if (row
->reversed_p
)
17748 unproduce_glyphs (it
,
17749 row
->used
[TEXT_AREA
] - wrap_row_used
);
17751 it
->continuation_lines_width
+= wrap_x
;
17752 row
->used
[TEXT_AREA
] = wrap_row_used
;
17753 row
->ascent
= wrap_row_ascent
;
17754 row
->height
= wrap_row_height
;
17755 row
->phys_ascent
= wrap_row_phys_ascent
;
17756 row
->phys_height
= wrap_row_phys_height
;
17757 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17758 min_pos
= wrap_row_min_pos
;
17759 min_bpos
= wrap_row_min_bpos
;
17760 max_pos
= wrap_row_max_pos
;
17761 max_bpos
= wrap_row_max_bpos
;
17762 row
->continued_p
= 1;
17763 row
->ends_at_zv_p
= 0;
17764 row
->exact_window_width_line_p
= 0;
17765 it
->continuation_lines_width
+= x
;
17767 /* Make sure that a non-default face is extended
17768 up to the right margin of the window. */
17769 extend_face_to_end_of_line (it
);
17771 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17773 /* A TAB that extends past the right edge of the
17774 window. This produces a single glyph on
17775 window system frames. We leave the glyph in
17776 this row and let it fill the row, but don't
17777 consume the TAB. */
17778 it
->continuation_lines_width
+= it
->last_visible_x
;
17779 row
->ends_in_middle_of_char_p
= 1;
17780 row
->continued_p
= 1;
17781 glyph
->pixel_width
= it
->last_visible_x
- x
;
17782 it
->starts_in_middle_of_char_p
= 1;
17786 /* Something other than a TAB that draws past
17787 the right edge of the window. Restore
17788 positions to values before the element. */
17789 if (row
->reversed_p
)
17790 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17791 - (n_glyphs_before
+ i
));
17792 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17794 /* Display continuation glyphs. */
17795 if (!FRAME_WINDOW_P (it
->f
))
17796 produce_special_glyphs (it
, IT_CONTINUATION
);
17797 row
->continued_p
= 1;
17799 it
->current_x
= x_before
;
17800 it
->continuation_lines_width
+= x
;
17801 extend_face_to_end_of_line (it
);
17803 if (nglyphs
> 1 && i
> 0)
17805 row
->ends_in_middle_of_char_p
= 1;
17806 it
->starts_in_middle_of_char_p
= 1;
17809 /* Restore the height to what it was before the
17810 element not fitting on the line. */
17811 it
->max_ascent
= ascent
;
17812 it
->max_descent
= descent
;
17813 it
->max_phys_ascent
= phys_ascent
;
17814 it
->max_phys_descent
= phys_descent
;
17819 else if (new_x
> it
->first_visible_x
)
17821 /* Increment number of glyphs actually displayed. */
17824 /* Record the maximum and minimum buffer positions
17825 seen so far in glyphs that will be displayed by
17828 RECORD_MAX_MIN_POS (it
);
17830 if (x
< it
->first_visible_x
)
17831 /* Glyph is partially visible, i.e. row starts at
17832 negative X position. */
17833 row
->x
= x
- it
->first_visible_x
;
17837 /* Glyph is completely off the left margin of the
17838 window. This should not happen because of the
17839 move_it_in_display_line at the start of this
17840 function, unless the text display area of the
17841 window is empty. */
17842 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17846 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17847 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17848 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17849 row
->phys_height
= max (row
->phys_height
,
17850 it
->max_phys_ascent
+ it
->max_phys_descent
);
17851 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17852 it
->max_extra_line_spacing
);
17854 /* End of this display line if row is continued. */
17855 if (row
->continued_p
|| row
->ends_at_zv_p
)
17860 /* Is this a line end? If yes, we're also done, after making
17861 sure that a non-default face is extended up to the right
17862 margin of the window. */
17863 if (ITERATOR_AT_END_OF_LINE_P (it
))
17865 int used_before
= row
->used
[TEXT_AREA
];
17867 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17869 /* Add a space at the end of the line that is used to
17870 display the cursor there. */
17871 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17872 append_space_for_newline (it
, 0);
17874 /* Extend the face to the end of the line. */
17875 extend_face_to_end_of_line (it
);
17877 /* Make sure we have the position. */
17878 if (used_before
== 0)
17879 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17881 /* Record the position of the newline, for use in
17883 it
->eol_pos
= it
->current
.pos
;
17885 /* Consume the line end. This skips over invisible lines. */
17886 set_iterator_to_next (it
, 1);
17887 it
->continuation_lines_width
= 0;
17891 /* Proceed with next display element. Note that this skips
17892 over lines invisible because of selective display. */
17893 set_iterator_to_next (it
, 1);
17895 /* If we truncate lines, we are done when the last displayed
17896 glyphs reach past the right margin of the window. */
17897 if (it
->line_wrap
== TRUNCATE
17898 && (FRAME_WINDOW_P (it
->f
)
17899 ? (it
->current_x
>= it
->last_visible_x
)
17900 : (it
->current_x
> it
->last_visible_x
)))
17902 /* Maybe add truncation glyphs. */
17903 if (!FRAME_WINDOW_P (it
->f
))
17907 if (!row
->reversed_p
)
17909 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17910 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17915 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17916 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17918 /* Remove any padding glyphs at the front of ROW, to
17919 make room for the truncation glyphs we will be
17920 adding below. The loop below always inserts at
17921 least one truncation glyph, so also remove the
17922 last glyph added to ROW. */
17923 unproduce_glyphs (it
, i
+ 1);
17924 /* Adjust i for the loop below. */
17925 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17928 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17930 row
->used
[TEXT_AREA
] = i
;
17931 produce_special_glyphs (it
, IT_TRUNCATION
);
17934 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17936 /* Don't truncate if we can overflow newline into fringe. */
17937 if (!get_next_display_element (it
))
17939 it
->continuation_lines_width
= 0;
17940 row
->ends_at_zv_p
= 1;
17941 row
->exact_window_width_line_p
= 1;
17944 if (ITERATOR_AT_END_OF_LINE_P (it
))
17946 row
->exact_window_width_line_p
= 1;
17947 goto at_end_of_line
;
17951 row
->truncated_on_right_p
= 1;
17952 it
->continuation_lines_width
= 0;
17953 reseat_at_next_visible_line_start (it
, 0);
17954 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17955 it
->hpos
= hpos_before
;
17956 it
->current_x
= x_before
;
17961 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17962 at the left window margin. */
17963 if (it
->first_visible_x
17964 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17966 if (!FRAME_WINDOW_P (it
->f
))
17967 insert_left_trunc_glyphs (it
);
17968 row
->truncated_on_left_p
= 1;
17971 /* Remember the position at which this line ends.
17973 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17974 cannot be before the call to find_row_edges below, since that is
17975 where these positions are determined. */
17976 row
->end
= it
->current
;
17979 row
->minpos
= row
->start
.pos
;
17980 row
->maxpos
= row
->end
.pos
;
17984 /* ROW->minpos and ROW->maxpos must be the smallest and
17985 `1 + the largest' buffer positions in ROW. But if ROW was
17986 bidi-reordered, these two positions can be anywhere in the
17987 row, so we must determine them now. */
17988 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17991 /* If the start of this line is the overlay arrow-position, then
17992 mark this glyph row as the one containing the overlay arrow.
17993 This is clearly a mess with variable size fonts. It would be
17994 better to let it be displayed like cursors under X. */
17995 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17996 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17997 !NILP (overlay_arrow_string
)))
17999 /* Overlay arrow in window redisplay is a fringe bitmap. */
18000 if (STRINGP (overlay_arrow_string
))
18002 struct glyph_row
*arrow_row
18003 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18004 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18005 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18006 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18007 struct glyph
*p2
, *end
;
18009 /* Copy the arrow glyphs. */
18010 while (glyph
< arrow_end
)
18013 /* Throw away padding glyphs. */
18015 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18016 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18022 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18027 xassert (INTEGERP (overlay_arrow_string
));
18028 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18030 overlay_arrow_seen
= 1;
18033 /* Compute pixel dimensions of this line. */
18034 compute_line_metrics (it
);
18036 /* Record whether this row ends inside an ellipsis. */
18037 row
->ends_in_ellipsis_p
18038 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18039 && it
->ellipsis_p
);
18041 /* Save fringe bitmaps in this row. */
18042 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18043 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18044 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18045 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18047 it
->left_user_fringe_bitmap
= 0;
18048 it
->left_user_fringe_face_id
= 0;
18049 it
->right_user_fringe_bitmap
= 0;
18050 it
->right_user_fringe_face_id
= 0;
18052 /* Maybe set the cursor. */
18053 cvpos
= it
->w
->cursor
.vpos
;
18055 /* In bidi-reordered rows, keep checking for proper cursor
18056 position even if one has been found already, because buffer
18057 positions in such rows change non-linearly with ROW->VPOS,
18058 when a line is continued. One exception: when we are at ZV,
18059 display cursor on the first suitable glyph row, since all
18060 the empty rows after that also have their position set to ZV. */
18061 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18062 lines' rows is implemented for bidi-reordered rows. */
18064 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18065 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18066 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18067 && cursor_row_p (row
))
18068 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18070 /* Highlight trailing whitespace. */
18071 if (!NILP (Vshow_trailing_whitespace
))
18072 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18074 /* Prepare for the next line. This line starts horizontally at (X
18075 HPOS) = (0 0). Vertical positions are incremented. As a
18076 convenience for the caller, IT->glyph_row is set to the next
18078 it
->current_x
= it
->hpos
= 0;
18079 it
->current_y
+= row
->height
;
18080 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18083 /* The next row should by default use the same value of the
18084 reversed_p flag as this one. set_iterator_to_next decides when
18085 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18086 the flag accordingly. */
18087 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18088 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18089 it
->start
= row
->end
;
18090 return row
->displays_text_p
;
18092 #undef RECORD_MAX_MIN_POS
18095 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18096 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18097 doc
: /* Return paragraph direction at point in BUFFER.
18098 Value is either `left-to-right' or `right-to-left'.
18099 If BUFFER is omitted or nil, it defaults to the current buffer.
18101 Paragraph direction determines how the text in the paragraph is displayed.
18102 In left-to-right paragraphs, text begins at the left margin of the window
18103 and the reading direction is generally left to right. In right-to-left
18104 paragraphs, text begins at the right margin and is read from right to left.
18106 See also `bidi-paragraph-direction'. */)
18107 (Lisp_Object buffer
)
18109 struct buffer
*buf
= current_buffer
;
18110 struct buffer
*old
= buf
;
18112 if (! NILP (buffer
))
18114 CHECK_BUFFER (buffer
);
18115 buf
= XBUFFER (buffer
);
18118 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18119 return Qleft_to_right
;
18120 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18121 return BVAR (buf
, bidi_paragraph_direction
);
18124 /* Determine the direction from buffer text. We could try to
18125 use current_matrix if it is up to date, but this seems fast
18126 enough as it is. */
18127 struct bidi_it itb
;
18128 EMACS_INT pos
= BUF_PT (buf
);
18129 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18132 set_buffer_temp (buf
);
18133 /* bidi_paragraph_init finds the base direction of the paragraph
18134 by searching forward from paragraph start. We need the base
18135 direction of the current or _previous_ paragraph, so we need
18136 to make sure we are within that paragraph. To that end, find
18137 the previous non-empty line. */
18138 if (pos
>= ZV
&& pos
> BEGV
)
18141 bytepos
= CHAR_TO_BYTE (pos
);
18143 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18144 || c
== ' ' || c
== '\t' || c
== '\f')
18146 if (bytepos
<= BEGV_BYTE
)
18151 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18154 itb
.bytepos
= bytepos
;
18156 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18158 itb
.separator_limit
= -1;
18159 itb
.paragraph_dir
= NEUTRAL_DIR
;
18161 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18162 set_buffer_temp (old
);
18163 switch (itb
.paragraph_dir
)
18166 return Qleft_to_right
;
18169 return Qright_to_left
;
18179 /***********************************************************************
18181 ***********************************************************************/
18183 /* Redisplay the menu bar in the frame for window W.
18185 The menu bar of X frames that don't have X toolkit support is
18186 displayed in a special window W->frame->menu_bar_window.
18188 The menu bar of terminal frames is treated specially as far as
18189 glyph matrices are concerned. Menu bar lines are not part of
18190 windows, so the update is done directly on the frame matrix rows
18191 for the menu bar. */
18194 display_menu_bar (struct window
*w
)
18196 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18201 /* Don't do all this for graphical frames. */
18203 if (FRAME_W32_P (f
))
18206 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18212 if (FRAME_NS_P (f
))
18214 #endif /* HAVE_NS */
18216 #ifdef USE_X_TOOLKIT
18217 xassert (!FRAME_WINDOW_P (f
));
18218 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18219 it
.first_visible_x
= 0;
18220 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18221 #else /* not USE_X_TOOLKIT */
18222 if (FRAME_WINDOW_P (f
))
18224 /* Menu bar lines are displayed in the desired matrix of the
18225 dummy window menu_bar_window. */
18226 struct window
*menu_w
;
18227 xassert (WINDOWP (f
->menu_bar_window
));
18228 menu_w
= XWINDOW (f
->menu_bar_window
);
18229 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18231 it
.first_visible_x
= 0;
18232 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18236 /* This is a TTY frame, i.e. character hpos/vpos are used as
18238 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18240 it
.first_visible_x
= 0;
18241 it
.last_visible_x
= FRAME_COLS (f
);
18243 #endif /* not USE_X_TOOLKIT */
18245 if (! mode_line_inverse_video
)
18246 /* Force the menu-bar to be displayed in the default face. */
18247 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18249 /* Clear all rows of the menu bar. */
18250 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18252 struct glyph_row
*row
= it
.glyph_row
+ i
;
18253 clear_glyph_row (row
);
18254 row
->enabled_p
= 1;
18255 row
->full_width_p
= 1;
18258 /* Display all items of the menu bar. */
18259 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18260 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18262 Lisp_Object string
;
18264 /* Stop at nil string. */
18265 string
= AREF (items
, i
+ 1);
18269 /* Remember where item was displayed. */
18270 ASET (items
, i
+ 3, make_number (it
.hpos
));
18272 /* Display the item, pad with one space. */
18273 if (it
.current_x
< it
.last_visible_x
)
18274 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18275 SCHARS (string
) + 1, 0, 0, -1);
18278 /* Fill out the line with spaces. */
18279 if (it
.current_x
< it
.last_visible_x
)
18280 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18282 /* Compute the total height of the lines. */
18283 compute_line_metrics (&it
);
18288 /***********************************************************************
18290 ***********************************************************************/
18292 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18293 FORCE is non-zero, redisplay mode lines unconditionally.
18294 Otherwise, redisplay only mode lines that are garbaged. Value is
18295 the number of windows whose mode lines were redisplayed. */
18298 redisplay_mode_lines (Lisp_Object window
, int force
)
18302 while (!NILP (window
))
18304 struct window
*w
= XWINDOW (window
);
18306 if (WINDOWP (w
->hchild
))
18307 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18308 else if (WINDOWP (w
->vchild
))
18309 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18311 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18312 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18314 struct text_pos lpoint
;
18315 struct buffer
*old
= current_buffer
;
18317 /* Set the window's buffer for the mode line display. */
18318 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18319 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18321 /* Point refers normally to the selected window. For any
18322 other window, set up appropriate value. */
18323 if (!EQ (window
, selected_window
))
18325 struct text_pos pt
;
18327 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18328 if (CHARPOS (pt
) < BEGV
)
18329 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18330 else if (CHARPOS (pt
) > (ZV
- 1))
18331 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18333 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18336 /* Display mode lines. */
18337 clear_glyph_matrix (w
->desired_matrix
);
18338 if (display_mode_lines (w
))
18341 w
->must_be_updated_p
= 1;
18344 /* Restore old settings. */
18345 set_buffer_internal_1 (old
);
18346 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18356 /* Display the mode and/or header line of window W. Value is the
18357 sum number of mode lines and header lines displayed. */
18360 display_mode_lines (struct window
*w
)
18362 Lisp_Object old_selected_window
, old_selected_frame
;
18365 old_selected_frame
= selected_frame
;
18366 selected_frame
= w
->frame
;
18367 old_selected_window
= selected_window
;
18368 XSETWINDOW (selected_window
, w
);
18370 /* These will be set while the mode line specs are processed. */
18371 line_number_displayed
= 0;
18372 w
->column_number_displayed
= Qnil
;
18374 if (WINDOW_WANTS_MODELINE_P (w
))
18376 struct window
*sel_w
= XWINDOW (old_selected_window
);
18378 /* Select mode line face based on the real selected window. */
18379 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18380 BVAR (current_buffer
, mode_line_format
));
18384 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18386 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18387 BVAR (current_buffer
, header_line_format
));
18391 selected_frame
= old_selected_frame
;
18392 selected_window
= old_selected_window
;
18397 /* Display mode or header line of window W. FACE_ID specifies which
18398 line to display; it is either MODE_LINE_FACE_ID or
18399 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18400 display. Value is the pixel height of the mode/header line
18404 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18408 int count
= SPECPDL_INDEX ();
18410 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18411 /* Don't extend on a previously drawn mode-line.
18412 This may happen if called from pos_visible_p. */
18413 it
.glyph_row
->enabled_p
= 0;
18414 prepare_desired_row (it
.glyph_row
);
18416 it
.glyph_row
->mode_line_p
= 1;
18418 if (! mode_line_inverse_video
)
18419 /* Force the mode-line to be displayed in the default face. */
18420 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18422 record_unwind_protect (unwind_format_mode_line
,
18423 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18425 mode_line_target
= MODE_LINE_DISPLAY
;
18427 /* Temporarily make frame's keyboard the current kboard so that
18428 kboard-local variables in the mode_line_format will get the right
18430 push_kboard (FRAME_KBOARD (it
.f
));
18431 record_unwind_save_match_data ();
18432 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18435 unbind_to (count
, Qnil
);
18437 /* Fill up with spaces. */
18438 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18440 compute_line_metrics (&it
);
18441 it
.glyph_row
->full_width_p
= 1;
18442 it
.glyph_row
->continued_p
= 0;
18443 it
.glyph_row
->truncated_on_left_p
= 0;
18444 it
.glyph_row
->truncated_on_right_p
= 0;
18446 /* Make a 3D mode-line have a shadow at its right end. */
18447 face
= FACE_FROM_ID (it
.f
, face_id
);
18448 extend_face_to_end_of_line (&it
);
18449 if (face
->box
!= FACE_NO_BOX
)
18451 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18452 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18453 last
->right_box_line_p
= 1;
18456 return it
.glyph_row
->height
;
18459 /* Move element ELT in LIST to the front of LIST.
18460 Return the updated list. */
18463 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18465 register Lisp_Object tail
, prev
;
18466 register Lisp_Object tem
;
18470 while (CONSP (tail
))
18476 /* Splice out the link TAIL. */
18478 list
= XCDR (tail
);
18480 Fsetcdr (prev
, XCDR (tail
));
18482 /* Now make it the first. */
18483 Fsetcdr (tail
, list
);
18488 tail
= XCDR (tail
);
18492 /* Not found--return unchanged LIST. */
18496 /* Contribute ELT to the mode line for window IT->w. How it
18497 translates into text depends on its data type.
18499 IT describes the display environment in which we display, as usual.
18501 DEPTH is the depth in recursion. It is used to prevent
18502 infinite recursion here.
18504 FIELD_WIDTH is the number of characters the display of ELT should
18505 occupy in the mode line, and PRECISION is the maximum number of
18506 characters to display from ELT's representation. See
18507 display_string for details.
18509 Returns the hpos of the end of the text generated by ELT.
18511 PROPS is a property list to add to any string we encounter.
18513 If RISKY is nonzero, remove (disregard) any properties in any string
18514 we encounter, and ignore :eval and :propertize.
18516 The global variable `mode_line_target' determines whether the
18517 output is passed to `store_mode_line_noprop',
18518 `store_mode_line_string', or `display_string'. */
18521 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18522 Lisp_Object elt
, Lisp_Object props
, int risky
)
18524 int n
= 0, field
, prec
;
18529 elt
= build_string ("*too-deep*");
18533 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18537 /* A string: output it and check for %-constructs within it. */
18539 EMACS_INT offset
= 0;
18541 if (SCHARS (elt
) > 0
18542 && (!NILP (props
) || risky
))
18544 Lisp_Object oprops
, aelt
;
18545 oprops
= Ftext_properties_at (make_number (0), elt
);
18547 /* If the starting string's properties are not what
18548 we want, translate the string. Also, if the string
18549 is risky, do that anyway. */
18551 if (NILP (Fequal (props
, oprops
)) || risky
)
18553 /* If the starting string has properties,
18554 merge the specified ones onto the existing ones. */
18555 if (! NILP (oprops
) && !risky
)
18559 oprops
= Fcopy_sequence (oprops
);
18561 while (CONSP (tem
))
18563 oprops
= Fplist_put (oprops
, XCAR (tem
),
18564 XCAR (XCDR (tem
)));
18565 tem
= XCDR (XCDR (tem
));
18570 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18571 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18573 /* AELT is what we want. Move it to the front
18574 without consing. */
18576 mode_line_proptrans_alist
18577 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18583 /* If AELT has the wrong props, it is useless.
18584 so get rid of it. */
18586 mode_line_proptrans_alist
18587 = Fdelq (aelt
, mode_line_proptrans_alist
);
18589 elt
= Fcopy_sequence (elt
);
18590 Fset_text_properties (make_number (0), Flength (elt
),
18592 /* Add this item to mode_line_proptrans_alist. */
18593 mode_line_proptrans_alist
18594 = Fcons (Fcons (elt
, props
),
18595 mode_line_proptrans_alist
);
18596 /* Truncate mode_line_proptrans_alist
18597 to at most 50 elements. */
18598 tem
= Fnthcdr (make_number (50),
18599 mode_line_proptrans_alist
);
18601 XSETCDR (tem
, Qnil
);
18610 prec
= precision
- n
;
18611 switch (mode_line_target
)
18613 case MODE_LINE_NOPROP
:
18614 case MODE_LINE_TITLE
:
18615 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18617 case MODE_LINE_STRING
:
18618 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18620 case MODE_LINE_DISPLAY
:
18621 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18622 0, prec
, 0, STRING_MULTIBYTE (elt
));
18629 /* Handle the non-literal case. */
18631 while ((precision
<= 0 || n
< precision
)
18632 && SREF (elt
, offset
) != 0
18633 && (mode_line_target
!= MODE_LINE_DISPLAY
18634 || it
->current_x
< it
->last_visible_x
))
18636 EMACS_INT last_offset
= offset
;
18638 /* Advance to end of string or next format specifier. */
18639 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18642 if (offset
- 1 != last_offset
)
18644 EMACS_INT nchars
, nbytes
;
18646 /* Output to end of string or up to '%'. Field width
18647 is length of string. Don't output more than
18648 PRECISION allows us. */
18651 prec
= c_string_width (SDATA (elt
) + last_offset
,
18652 offset
- last_offset
, precision
- n
,
18655 switch (mode_line_target
)
18657 case MODE_LINE_NOPROP
:
18658 case MODE_LINE_TITLE
:
18659 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18661 case MODE_LINE_STRING
:
18663 EMACS_INT bytepos
= last_offset
;
18664 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18665 EMACS_INT endpos
= (precision
<= 0
18666 ? string_byte_to_char (elt
, offset
)
18667 : charpos
+ nchars
);
18669 n
+= store_mode_line_string (NULL
,
18670 Fsubstring (elt
, make_number (charpos
),
18671 make_number (endpos
)),
18675 case MODE_LINE_DISPLAY
:
18677 EMACS_INT bytepos
= last_offset
;
18678 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18680 if (precision
<= 0)
18681 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18682 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18684 STRING_MULTIBYTE (elt
));
18689 else /* c == '%' */
18691 EMACS_INT percent_position
= offset
;
18693 /* Get the specified minimum width. Zero means
18696 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18697 field
= field
* 10 + c
- '0';
18699 /* Don't pad beyond the total padding allowed. */
18700 if (field_width
- n
> 0 && field
> field_width
- n
)
18701 field
= field_width
- n
;
18703 /* Note that either PRECISION <= 0 or N < PRECISION. */
18704 prec
= precision
- n
;
18707 n
+= display_mode_element (it
, depth
, field
, prec
,
18708 Vglobal_mode_string
, props
,
18713 EMACS_INT bytepos
, charpos
;
18715 Lisp_Object string
;
18717 bytepos
= percent_position
;
18718 charpos
= (STRING_MULTIBYTE (elt
)
18719 ? string_byte_to_char (elt
, bytepos
)
18721 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18722 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18724 switch (mode_line_target
)
18726 case MODE_LINE_NOPROP
:
18727 case MODE_LINE_TITLE
:
18728 n
+= store_mode_line_noprop (spec
, field
, prec
);
18730 case MODE_LINE_STRING
:
18732 int len
= strlen (spec
);
18733 Lisp_Object tem
= make_string (spec
, len
);
18734 props
= Ftext_properties_at (make_number (charpos
), elt
);
18735 /* Should only keep face property in props */
18736 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18739 case MODE_LINE_DISPLAY
:
18741 int nglyphs_before
, nwritten
;
18743 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18744 nwritten
= display_string (spec
, string
, elt
,
18749 /* Assign to the glyphs written above the
18750 string where the `%x' came from, position
18754 struct glyph
*glyph
18755 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18759 for (i
= 0; i
< nwritten
; ++i
)
18761 glyph
[i
].object
= elt
;
18762 glyph
[i
].charpos
= charpos
;
18779 /* A symbol: process the value of the symbol recursively
18780 as if it appeared here directly. Avoid error if symbol void.
18781 Special case: if value of symbol is a string, output the string
18784 register Lisp_Object tem
;
18786 /* If the variable is not marked as risky to set
18787 then its contents are risky to use. */
18788 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18791 tem
= Fboundp (elt
);
18794 tem
= Fsymbol_value (elt
);
18795 /* If value is a string, output that string literally:
18796 don't check for % within it. */
18800 if (!EQ (tem
, elt
))
18802 /* Give up right away for nil or t. */
18812 register Lisp_Object car
, tem
;
18814 /* A cons cell: five distinct cases.
18815 If first element is :eval or :propertize, do something special.
18816 If first element is a string or a cons, process all the elements
18817 and effectively concatenate them.
18818 If first element is a negative number, truncate displaying cdr to
18819 at most that many characters. If positive, pad (with spaces)
18820 to at least that many characters.
18821 If first element is a symbol, process the cadr or caddr recursively
18822 according to whether the symbol's value is non-nil or nil. */
18824 if (EQ (car
, QCeval
))
18826 /* An element of the form (:eval FORM) means evaluate FORM
18827 and use the result as mode line elements. */
18832 if (CONSP (XCDR (elt
)))
18835 spec
= safe_eval (XCAR (XCDR (elt
)));
18836 n
+= display_mode_element (it
, depth
, field_width
- n
,
18837 precision
- n
, spec
, props
,
18841 else if (EQ (car
, QCpropertize
))
18843 /* An element of the form (:propertize ELT PROPS...)
18844 means display ELT but applying properties PROPS. */
18849 if (CONSP (XCDR (elt
)))
18850 n
+= display_mode_element (it
, depth
, field_width
- n
,
18851 precision
- n
, XCAR (XCDR (elt
)),
18852 XCDR (XCDR (elt
)), risky
);
18854 else if (SYMBOLP (car
))
18856 tem
= Fboundp (car
);
18860 /* elt is now the cdr, and we know it is a cons cell.
18861 Use its car if CAR has a non-nil value. */
18864 tem
= Fsymbol_value (car
);
18871 /* Symbol's value is nil (or symbol is unbound)
18872 Get the cddr of the original list
18873 and if possible find the caddr and use that. */
18877 else if (!CONSP (elt
))
18882 else if (INTEGERP (car
))
18884 register int lim
= XINT (car
);
18888 /* Negative int means reduce maximum width. */
18889 if (precision
<= 0)
18892 precision
= min (precision
, -lim
);
18896 /* Padding specified. Don't let it be more than
18897 current maximum. */
18899 lim
= min (precision
, lim
);
18901 /* If that's more padding than already wanted, queue it.
18902 But don't reduce padding already specified even if
18903 that is beyond the current truncation point. */
18904 field_width
= max (lim
, field_width
);
18908 else if (STRINGP (car
) || CONSP (car
))
18910 Lisp_Object halftail
= elt
;
18914 && (precision
<= 0 || n
< precision
))
18916 n
+= display_mode_element (it
, depth
,
18917 /* Do padding only after the last
18918 element in the list. */
18919 (! CONSP (XCDR (elt
))
18922 precision
- n
, XCAR (elt
),
18926 if ((len
& 1) == 0)
18927 halftail
= XCDR (halftail
);
18928 /* Check for cycle. */
18929 if (EQ (halftail
, elt
))
18938 elt
= build_string ("*invalid*");
18942 /* Pad to FIELD_WIDTH. */
18943 if (field_width
> 0 && n
< field_width
)
18945 switch (mode_line_target
)
18947 case MODE_LINE_NOPROP
:
18948 case MODE_LINE_TITLE
:
18949 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18951 case MODE_LINE_STRING
:
18952 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18954 case MODE_LINE_DISPLAY
:
18955 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18964 /* Store a mode-line string element in mode_line_string_list.
18966 If STRING is non-null, display that C string. Otherwise, the Lisp
18967 string LISP_STRING is displayed.
18969 FIELD_WIDTH is the minimum number of output glyphs to produce.
18970 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18971 with spaces. FIELD_WIDTH <= 0 means don't pad.
18973 PRECISION is the maximum number of characters to output from
18974 STRING. PRECISION <= 0 means don't truncate the string.
18976 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18977 properties to the string.
18979 PROPS are the properties to add to the string.
18980 The mode_line_string_face face property is always added to the string.
18984 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18985 int field_width
, int precision
, Lisp_Object props
)
18990 if (string
!= NULL
)
18992 len
= strlen (string
);
18993 if (precision
> 0 && len
> precision
)
18995 lisp_string
= make_string (string
, len
);
18997 props
= mode_line_string_face_prop
;
18998 else if (!NILP (mode_line_string_face
))
19000 Lisp_Object face
= Fplist_get (props
, Qface
);
19001 props
= Fcopy_sequence (props
);
19003 face
= mode_line_string_face
;
19005 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19006 props
= Fplist_put (props
, Qface
, face
);
19008 Fadd_text_properties (make_number (0), make_number (len
),
19009 props
, lisp_string
);
19013 len
= XFASTINT (Flength (lisp_string
));
19014 if (precision
> 0 && len
> precision
)
19017 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19020 if (!NILP (mode_line_string_face
))
19024 props
= Ftext_properties_at (make_number (0), lisp_string
);
19025 face
= Fplist_get (props
, Qface
);
19027 face
= mode_line_string_face
;
19029 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19030 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19032 lisp_string
= Fcopy_sequence (lisp_string
);
19035 Fadd_text_properties (make_number (0), make_number (len
),
19036 props
, lisp_string
);
19041 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19045 if (field_width
> len
)
19047 field_width
-= len
;
19048 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19050 Fadd_text_properties (make_number (0), make_number (field_width
),
19051 props
, lisp_string
);
19052 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19060 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19062 doc
: /* Format a string out of a mode line format specification.
19063 First arg FORMAT specifies the mode line format (see `mode-line-format'
19064 for details) to use.
19066 By default, the format is evaluated for the currently selected window.
19068 Optional second arg FACE specifies the face property to put on all
19069 characters for which no face is specified. The value nil means the
19070 default face. The value t means whatever face the window's mode line
19071 currently uses (either `mode-line' or `mode-line-inactive',
19072 depending on whether the window is the selected window or not).
19073 An integer value means the value string has no text
19076 Optional third and fourth args WINDOW and BUFFER specify the window
19077 and buffer to use as the context for the formatting (defaults
19078 are the selected window and the WINDOW's buffer). */)
19079 (Lisp_Object format
, Lisp_Object face
,
19080 Lisp_Object window
, Lisp_Object buffer
)
19085 struct buffer
*old_buffer
= NULL
;
19087 int no_props
= INTEGERP (face
);
19088 int count
= SPECPDL_INDEX ();
19090 int string_start
= 0;
19093 window
= selected_window
;
19094 CHECK_WINDOW (window
);
19095 w
= XWINDOW (window
);
19098 buffer
= w
->buffer
;
19099 CHECK_BUFFER (buffer
);
19101 /* Make formatting the modeline a non-op when noninteractive, otherwise
19102 there will be problems later caused by a partially initialized frame. */
19103 if (NILP (format
) || noninteractive
)
19104 return empty_unibyte_string
;
19109 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19110 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19111 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19112 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19113 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19114 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19115 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19118 if (XBUFFER (buffer
) != current_buffer
)
19119 old_buffer
= current_buffer
;
19121 /* Save things including mode_line_proptrans_alist,
19122 and set that to nil so that we don't alter the outer value. */
19123 record_unwind_protect (unwind_format_mode_line
,
19124 format_mode_line_unwind_data
19125 (old_buffer
, selected_window
, 1));
19126 mode_line_proptrans_alist
= Qnil
;
19128 Fselect_window (window
, Qt
);
19130 set_buffer_internal_1 (XBUFFER (buffer
));
19132 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19136 mode_line_target
= MODE_LINE_NOPROP
;
19137 mode_line_string_face_prop
= Qnil
;
19138 mode_line_string_list
= Qnil
;
19139 string_start
= MODE_LINE_NOPROP_LEN (0);
19143 mode_line_target
= MODE_LINE_STRING
;
19144 mode_line_string_list
= Qnil
;
19145 mode_line_string_face
= face
;
19146 mode_line_string_face_prop
19147 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19150 push_kboard (FRAME_KBOARD (it
.f
));
19151 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19156 len
= MODE_LINE_NOPROP_LEN (string_start
);
19157 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19161 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19162 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19163 empty_unibyte_string
);
19166 unbind_to (count
, Qnil
);
19170 /* Write a null-terminated, right justified decimal representation of
19171 the positive integer D to BUF using a minimal field width WIDTH. */
19174 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19176 register char *p
= buf
;
19184 *p
++ = d
% 10 + '0';
19189 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19200 /* Write a null-terminated, right justified decimal and "human
19201 readable" representation of the nonnegative integer D to BUF using
19202 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19204 static const char power_letter
[] =
19218 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19220 /* We aim to represent the nonnegative integer D as
19221 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19222 EMACS_INT quotient
= d
;
19224 /* -1 means: do not use TENTHS. */
19228 /* Length of QUOTIENT.TENTHS as a string. */
19234 if (1000 <= quotient
)
19236 /* Scale to the appropriate EXPONENT. */
19239 remainder
= quotient
% 1000;
19243 while (1000 <= quotient
);
19245 /* Round to nearest and decide whether to use TENTHS or not. */
19248 tenths
= remainder
/ 100;
19249 if (50 <= remainder
% 100)
19256 if (quotient
== 10)
19264 if (500 <= remainder
)
19266 if (quotient
< 999)
19277 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19278 if (tenths
== -1 && quotient
<= 99)
19285 p
= psuffix
= buf
+ max (width
, length
);
19287 /* Print EXPONENT. */
19288 *psuffix
++ = power_letter
[exponent
];
19291 /* Print TENTHS. */
19294 *--p
= '0' + tenths
;
19298 /* Print QUOTIENT. */
19301 int digit
= quotient
% 10;
19302 *--p
= '0' + digit
;
19304 while ((quotient
/= 10) != 0);
19306 /* Print leading spaces. */
19311 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19312 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19313 type of CODING_SYSTEM. Return updated pointer into BUF. */
19315 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19318 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19321 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19322 const unsigned char *eol_str
;
19324 /* The EOL conversion we are using. */
19325 Lisp_Object eoltype
;
19327 val
= CODING_SYSTEM_SPEC (coding_system
);
19330 if (!VECTORP (val
)) /* Not yet decided. */
19335 eoltype
= eol_mnemonic_undecided
;
19336 /* Don't mention EOL conversion if it isn't decided. */
19341 Lisp_Object eolvalue
;
19343 attrs
= AREF (val
, 0);
19344 eolvalue
= AREF (val
, 2);
19347 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19351 /* The EOL conversion that is normal on this system. */
19353 if (NILP (eolvalue
)) /* Not yet decided. */
19354 eoltype
= eol_mnemonic_undecided
;
19355 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19356 eoltype
= eol_mnemonic_undecided
;
19357 else /* eolvalue is Qunix, Qdos, or Qmac. */
19358 eoltype
= (EQ (eolvalue
, Qunix
)
19359 ? eol_mnemonic_unix
19360 : (EQ (eolvalue
, Qdos
) == 1
19361 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19367 /* Mention the EOL conversion if it is not the usual one. */
19368 if (STRINGP (eoltype
))
19370 eol_str
= SDATA (eoltype
);
19371 eol_str_len
= SBYTES (eoltype
);
19373 else if (CHARACTERP (eoltype
))
19375 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19376 int c
= XFASTINT (eoltype
);
19377 eol_str_len
= CHAR_STRING (c
, tmp
);
19382 eol_str
= invalid_eol_type
;
19383 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19385 memcpy (buf
, eol_str
, eol_str_len
);
19386 buf
+= eol_str_len
;
19392 /* Return a string for the output of a mode line %-spec for window W,
19393 generated by character C. FIELD_WIDTH > 0 means pad the string
19394 returned with spaces to that value. Return a Lisp string in
19395 *STRING if the resulting string is taken from that Lisp string.
19397 Note we operate on the current buffer for most purposes,
19398 the exception being w->base_line_pos. */
19400 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19402 static const char *
19403 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19404 Lisp_Object
*string
)
19407 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19408 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19409 struct buffer
*b
= current_buffer
;
19417 if (!NILP (BVAR (b
, read_only
)))
19419 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19424 /* This differs from %* only for a modified read-only buffer. */
19425 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19427 if (!NILP (BVAR (b
, read_only
)))
19432 /* This differs from %* in ignoring read-only-ness. */
19433 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19445 if (command_loop_level
> 5)
19447 p
= decode_mode_spec_buf
;
19448 for (i
= 0; i
< command_loop_level
; i
++)
19451 return decode_mode_spec_buf
;
19459 if (command_loop_level
> 5)
19461 p
= decode_mode_spec_buf
;
19462 for (i
= 0; i
< command_loop_level
; i
++)
19465 return decode_mode_spec_buf
;
19472 /* Let lots_of_dashes be a string of infinite length. */
19473 if (mode_line_target
== MODE_LINE_NOPROP
||
19474 mode_line_target
== MODE_LINE_STRING
)
19476 if (field_width
<= 0
19477 || field_width
> sizeof (lots_of_dashes
))
19479 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19480 decode_mode_spec_buf
[i
] = '-';
19481 decode_mode_spec_buf
[i
] = '\0';
19482 return decode_mode_spec_buf
;
19485 return lots_of_dashes
;
19489 obj
= BVAR (b
, name
);
19493 /* %c and %l are ignored in `frame-title-format'.
19494 (In redisplay_internal, the frame title is drawn _before_ the
19495 windows are updated, so the stuff which depends on actual
19496 window contents (such as %l) may fail to render properly, or
19497 even crash emacs.) */
19498 if (mode_line_target
== MODE_LINE_TITLE
)
19502 EMACS_INT col
= current_column ();
19503 w
->column_number_displayed
= make_number (col
);
19504 pint2str (decode_mode_spec_buf
, field_width
, col
);
19505 return decode_mode_spec_buf
;
19509 #ifndef SYSTEM_MALLOC
19511 if (NILP (Vmemory_full
))
19514 return "!MEM FULL! ";
19521 /* %F displays the frame name. */
19522 if (!NILP (f
->title
))
19523 return SSDATA (f
->title
);
19524 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19525 return SSDATA (f
->name
);
19529 obj
= BVAR (b
, filename
);
19534 EMACS_INT size
= ZV
- BEGV
;
19535 pint2str (decode_mode_spec_buf
, field_width
, size
);
19536 return decode_mode_spec_buf
;
19541 EMACS_INT size
= ZV
- BEGV
;
19542 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19543 return decode_mode_spec_buf
;
19548 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19549 EMACS_INT topline
, nlines
, height
;
19552 /* %c and %l are ignored in `frame-title-format'. */
19553 if (mode_line_target
== MODE_LINE_TITLE
)
19556 startpos
= XMARKER (w
->start
)->charpos
;
19557 startpos_byte
= marker_byte_position (w
->start
);
19558 height
= WINDOW_TOTAL_LINES (w
);
19560 /* If we decided that this buffer isn't suitable for line numbers,
19561 don't forget that too fast. */
19562 if (EQ (w
->base_line_pos
, w
->buffer
))
19564 /* But do forget it, if the window shows a different buffer now. */
19565 else if (BUFFERP (w
->base_line_pos
))
19566 w
->base_line_pos
= Qnil
;
19568 /* If the buffer is very big, don't waste time. */
19569 if (INTEGERP (Vline_number_display_limit
)
19570 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19572 w
->base_line_pos
= Qnil
;
19573 w
->base_line_number
= Qnil
;
19577 if (INTEGERP (w
->base_line_number
)
19578 && INTEGERP (w
->base_line_pos
)
19579 && XFASTINT (w
->base_line_pos
) <= startpos
)
19581 line
= XFASTINT (w
->base_line_number
);
19582 linepos
= XFASTINT (w
->base_line_pos
);
19583 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19588 linepos
= BUF_BEGV (b
);
19589 linepos_byte
= BUF_BEGV_BYTE (b
);
19592 /* Count lines from base line to window start position. */
19593 nlines
= display_count_lines (linepos_byte
,
19597 topline
= nlines
+ line
;
19599 /* Determine a new base line, if the old one is too close
19600 or too far away, or if we did not have one.
19601 "Too close" means it's plausible a scroll-down would
19602 go back past it. */
19603 if (startpos
== BUF_BEGV (b
))
19605 w
->base_line_number
= make_number (topline
);
19606 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19608 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19609 || linepos
== BUF_BEGV (b
))
19611 EMACS_INT limit
= BUF_BEGV (b
);
19612 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19613 EMACS_INT position
;
19614 EMACS_INT distance
=
19615 (height
* 2 + 30) * line_number_display_limit_width
;
19617 if (startpos
- distance
> limit
)
19619 limit
= startpos
- distance
;
19620 limit_byte
= CHAR_TO_BYTE (limit
);
19623 nlines
= display_count_lines (startpos_byte
,
19625 - (height
* 2 + 30),
19627 /* If we couldn't find the lines we wanted within
19628 line_number_display_limit_width chars per line,
19629 give up on line numbers for this window. */
19630 if (position
== limit_byte
&& limit
== startpos
- distance
)
19632 w
->base_line_pos
= w
->buffer
;
19633 w
->base_line_number
= Qnil
;
19637 w
->base_line_number
= make_number (topline
- nlines
);
19638 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19641 /* Now count lines from the start pos to point. */
19642 nlines
= display_count_lines (startpos_byte
,
19643 PT_BYTE
, PT
, &junk
);
19645 /* Record that we did display the line number. */
19646 line_number_displayed
= 1;
19648 /* Make the string to show. */
19649 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19650 return decode_mode_spec_buf
;
19653 char* p
= decode_mode_spec_buf
;
19654 int pad
= field_width
- 2;
19660 return decode_mode_spec_buf
;
19666 obj
= BVAR (b
, mode_name
);
19670 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19676 EMACS_INT pos
= marker_position (w
->start
);
19677 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19679 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19681 if (pos
<= BUF_BEGV (b
))
19686 else if (pos
<= BUF_BEGV (b
))
19690 if (total
> 1000000)
19691 /* Do it differently for a large value, to avoid overflow. */
19692 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19694 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19695 /* We can't normally display a 3-digit number,
19696 so get us a 2-digit number that is close. */
19699 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19700 return decode_mode_spec_buf
;
19704 /* Display percentage of size above the bottom of the screen. */
19707 EMACS_INT toppos
= marker_position (w
->start
);
19708 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19709 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19711 if (botpos
>= BUF_ZV (b
))
19713 if (toppos
<= BUF_BEGV (b
))
19720 if (total
> 1000000)
19721 /* Do it differently for a large value, to avoid overflow. */
19722 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19724 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19725 /* We can't normally display a 3-digit number,
19726 so get us a 2-digit number that is close. */
19729 if (toppos
<= BUF_BEGV (b
))
19730 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
19732 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19733 return decode_mode_spec_buf
;
19738 /* status of process */
19739 obj
= Fget_buffer_process (Fcurrent_buffer ());
19741 return "no process";
19743 obj
= Fsymbol_name (Fprocess_status (obj
));
19749 int count
= inhibit_garbage_collection ();
19750 Lisp_Object val
= call1 (intern ("file-remote-p"),
19751 BVAR (current_buffer
, directory
));
19752 unbind_to (count
, Qnil
);
19760 case 't': /* indicate TEXT or BINARY */
19764 /* coding-system (not including end-of-line format) */
19766 /* coding-system (including end-of-line type) */
19768 int eol_flag
= (c
== 'Z');
19769 char *p
= decode_mode_spec_buf
;
19771 if (! FRAME_WINDOW_P (f
))
19773 /* No need to mention EOL here--the terminal never needs
19774 to do EOL conversion. */
19775 p
= decode_mode_spec_coding (CODING_ID_NAME
19776 (FRAME_KEYBOARD_CODING (f
)->id
),
19778 p
= decode_mode_spec_coding (CODING_ID_NAME
19779 (FRAME_TERMINAL_CODING (f
)->id
),
19782 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19785 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19786 #ifdef subprocesses
19787 obj
= Fget_buffer_process (Fcurrent_buffer ());
19788 if (PROCESSP (obj
))
19790 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19792 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19795 #endif /* subprocesses */
19798 return decode_mode_spec_buf
;
19805 return SSDATA (obj
);
19812 /* Count up to COUNT lines starting from START_BYTE.
19813 But don't go beyond LIMIT_BYTE.
19814 Return the number of lines thus found (always nonnegative).
19816 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19819 display_count_lines (EMACS_INT start_byte
,
19820 EMACS_INT limit_byte
, EMACS_INT count
,
19821 EMACS_INT
*byte_pos_ptr
)
19823 register unsigned char *cursor
;
19824 unsigned char *base
;
19826 register EMACS_INT ceiling
;
19827 register unsigned char *ceiling_addr
;
19828 EMACS_INT orig_count
= count
;
19830 /* If we are not in selective display mode,
19831 check only for newlines. */
19832 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19833 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19837 while (start_byte
< limit_byte
)
19839 ceiling
= BUFFER_CEILING_OF (start_byte
);
19840 ceiling
= min (limit_byte
- 1, ceiling
);
19841 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19842 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19845 if (selective_display
)
19846 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19849 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19852 if (cursor
!= ceiling_addr
)
19856 start_byte
+= cursor
- base
+ 1;
19857 *byte_pos_ptr
= start_byte
;
19861 if (++cursor
== ceiling_addr
)
19867 start_byte
+= cursor
- base
;
19872 while (start_byte
> limit_byte
)
19874 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19875 ceiling
= max (limit_byte
, ceiling
);
19876 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19877 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19880 if (selective_display
)
19881 while (--cursor
!= ceiling_addr
19882 && *cursor
!= '\n' && *cursor
!= 015)
19885 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19888 if (cursor
!= ceiling_addr
)
19892 start_byte
+= cursor
- base
+ 1;
19893 *byte_pos_ptr
= start_byte
;
19894 /* When scanning backwards, we should
19895 not count the newline posterior to which we stop. */
19896 return - orig_count
- 1;
19902 /* Here we add 1 to compensate for the last decrement
19903 of CURSOR, which took it past the valid range. */
19904 start_byte
+= cursor
- base
+ 1;
19908 *byte_pos_ptr
= limit_byte
;
19911 return - orig_count
+ count
;
19912 return orig_count
- count
;
19918 /***********************************************************************
19920 ***********************************************************************/
19922 /* Display a NUL-terminated string, starting with index START.
19924 If STRING is non-null, display that C string. Otherwise, the Lisp
19925 string LISP_STRING is displayed. There's a case that STRING is
19926 non-null and LISP_STRING is not nil. It means STRING is a string
19927 data of LISP_STRING. In that case, we display LISP_STRING while
19928 ignoring its text properties.
19930 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19931 FACE_STRING. Display STRING or LISP_STRING with the face at
19932 FACE_STRING_POS in FACE_STRING:
19934 Display the string in the environment given by IT, but use the
19935 standard display table, temporarily.
19937 FIELD_WIDTH is the minimum number of output glyphs to produce.
19938 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19939 with spaces. If STRING has more characters, more than FIELD_WIDTH
19940 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19942 PRECISION is the maximum number of characters to output from
19943 STRING. PRECISION < 0 means don't truncate the string.
19945 This is roughly equivalent to printf format specifiers:
19947 FIELD_WIDTH PRECISION PRINTF
19948 ----------------------------------------
19954 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19955 display them, and < 0 means obey the current buffer's value of
19956 enable_multibyte_characters.
19958 Value is the number of columns displayed. */
19961 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19962 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19963 int field_width
, int precision
, int max_x
, int multibyte
)
19965 int hpos_at_start
= it
->hpos
;
19966 int saved_face_id
= it
->face_id
;
19967 struct glyph_row
*row
= it
->glyph_row
;
19969 /* Initialize the iterator IT for iteration over STRING beginning
19970 with index START. */
19971 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19972 precision
, field_width
, multibyte
);
19973 if (string
&& STRINGP (lisp_string
))
19974 /* LISP_STRING is the one returned by decode_mode_spec. We should
19975 ignore its text properties. */
19976 it
->stop_charpos
= -1;
19978 /* If displaying STRING, set up the face of the iterator
19979 from LISP_STRING, if that's given. */
19980 if (STRINGP (face_string
))
19986 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19987 0, it
->region_beg_charpos
,
19988 it
->region_end_charpos
,
19989 &endptr
, it
->base_face_id
, 0);
19990 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19991 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19994 /* Set max_x to the maximum allowed X position. Don't let it go
19995 beyond the right edge of the window. */
19997 max_x
= it
->last_visible_x
;
19999 max_x
= min (max_x
, it
->last_visible_x
);
20001 /* Skip over display elements that are not visible. because IT->w is
20003 if (it
->current_x
< it
->first_visible_x
)
20004 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20005 MOVE_TO_POS
| MOVE_TO_X
);
20007 row
->ascent
= it
->max_ascent
;
20008 row
->height
= it
->max_ascent
+ it
->max_descent
;
20009 row
->phys_ascent
= it
->max_phys_ascent
;
20010 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20011 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20013 /* This condition is for the case that we are called with current_x
20014 past last_visible_x. */
20015 while (it
->current_x
< max_x
)
20017 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20019 /* Get the next display element. */
20020 if (!get_next_display_element (it
))
20023 /* Produce glyphs. */
20024 x_before
= it
->current_x
;
20025 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20026 PRODUCE_GLYPHS (it
);
20028 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
20031 while (i
< nglyphs
)
20033 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20035 if (it
->line_wrap
!= TRUNCATE
20036 && x
+ glyph
->pixel_width
> max_x
)
20038 /* End of continued line or max_x reached. */
20039 if (CHAR_GLYPH_PADDING_P (*glyph
))
20041 /* A wide character is unbreakable. */
20042 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
20043 it
->current_x
= x_before
;
20047 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20052 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20054 /* Glyph is at least partially visible. */
20056 if (x
< it
->first_visible_x
)
20057 it
->glyph_row
->x
= x
- it
->first_visible_x
;
20061 /* Glyph is off the left margin of the display area.
20062 Should not happen. */
20066 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20067 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20068 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20069 row
->phys_height
= max (row
->phys_height
,
20070 it
->max_phys_ascent
+ it
->max_phys_descent
);
20071 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20072 it
->max_extra_line_spacing
);
20073 x
+= glyph
->pixel_width
;
20077 /* Stop if max_x reached. */
20081 /* Stop at line ends. */
20082 if (ITERATOR_AT_END_OF_LINE_P (it
))
20084 it
->continuation_lines_width
= 0;
20088 set_iterator_to_next (it
, 1);
20090 /* Stop if truncating at the right edge. */
20091 if (it
->line_wrap
== TRUNCATE
20092 && it
->current_x
>= it
->last_visible_x
)
20094 /* Add truncation mark, but don't do it if the line is
20095 truncated at a padding space. */
20096 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20098 if (!FRAME_WINDOW_P (it
->f
))
20102 if (it
->current_x
> it
->last_visible_x
)
20104 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20105 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20107 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20109 row
->used
[TEXT_AREA
] = ii
;
20110 produce_special_glyphs (it
, IT_TRUNCATION
);
20113 produce_special_glyphs (it
, IT_TRUNCATION
);
20115 it
->glyph_row
->truncated_on_right_p
= 1;
20121 /* Maybe insert a truncation at the left. */
20122 if (it
->first_visible_x
20123 && IT_CHARPOS (*it
) > 0)
20125 if (!FRAME_WINDOW_P (it
->f
))
20126 insert_left_trunc_glyphs (it
);
20127 it
->glyph_row
->truncated_on_left_p
= 1;
20130 it
->face_id
= saved_face_id
;
20132 /* Value is number of columns displayed. */
20133 return it
->hpos
- hpos_at_start
;
20138 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20139 appears as an element of LIST or as the car of an element of LIST.
20140 If PROPVAL is a list, compare each element against LIST in that
20141 way, and return 1/2 if any element of PROPVAL is found in LIST.
20142 Otherwise return 0. This function cannot quit.
20143 The return value is 2 if the text is invisible but with an ellipsis
20144 and 1 if it's invisible and without an ellipsis. */
20147 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20149 register Lisp_Object tail
, proptail
;
20151 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20153 register Lisp_Object tem
;
20155 if (EQ (propval
, tem
))
20157 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20158 return NILP (XCDR (tem
)) ? 1 : 2;
20161 if (CONSP (propval
))
20163 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20165 Lisp_Object propelt
;
20166 propelt
= XCAR (proptail
);
20167 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20169 register Lisp_Object tem
;
20171 if (EQ (propelt
, tem
))
20173 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20174 return NILP (XCDR (tem
)) ? 1 : 2;
20182 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20183 doc
: /* Non-nil if the property makes the text invisible.
20184 POS-OR-PROP can be a marker or number, in which case it is taken to be
20185 a position in the current buffer and the value of the `invisible' property
20186 is checked; or it can be some other value, which is then presumed to be the
20187 value of the `invisible' property of the text of interest.
20188 The non-nil value returned can be t for truly invisible text or something
20189 else if the text is replaced by an ellipsis. */)
20190 (Lisp_Object pos_or_prop
)
20193 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20194 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20196 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20197 return (invis
== 0 ? Qnil
20199 : make_number (invis
));
20202 /* Calculate a width or height in pixels from a specification using
20203 the following elements:
20206 NUM - a (fractional) multiple of the default font width/height
20207 (NUM) - specifies exactly NUM pixels
20208 UNIT - a fixed number of pixels, see below.
20209 ELEMENT - size of a display element in pixels, see below.
20210 (NUM . SPEC) - equals NUM * SPEC
20211 (+ SPEC SPEC ...) - add pixel values
20212 (- SPEC SPEC ...) - subtract pixel values
20213 (- SPEC) - negate pixel value
20216 INT or FLOAT - a number constant
20217 SYMBOL - use symbol's (buffer local) variable binding.
20220 in - pixels per inch *)
20221 mm - pixels per 1/1000 meter *)
20222 cm - pixels per 1/100 meter *)
20223 width - width of current font in pixels.
20224 height - height of current font in pixels.
20226 *) using the ratio(s) defined in display-pixels-per-inch.
20230 left-fringe - left fringe width in pixels
20231 right-fringe - right fringe width in pixels
20233 left-margin - left margin width in pixels
20234 right-margin - right margin width in pixels
20236 scroll-bar - scroll-bar area width in pixels
20240 Pixels corresponding to 5 inches:
20243 Total width of non-text areas on left side of window (if scroll-bar is on left):
20244 '(space :width (+ left-fringe left-margin scroll-bar))
20246 Align to first text column (in header line):
20247 '(space :align-to 0)
20249 Align to middle of text area minus half the width of variable `my-image'
20250 containing a loaded image:
20251 '(space :align-to (0.5 . (- text my-image)))
20253 Width of left margin minus width of 1 character in the default font:
20254 '(space :width (- left-margin 1))
20256 Width of left margin minus width of 2 characters in the current font:
20257 '(space :width (- left-margin (2 . width)))
20259 Center 1 character over left-margin (in header line):
20260 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20262 Different ways to express width of left fringe plus left margin minus one pixel:
20263 '(space :width (- (+ left-fringe left-margin) (1)))
20264 '(space :width (+ left-fringe left-margin (- (1))))
20265 '(space :width (+ left-fringe left-margin (-1)))
20269 #define NUMVAL(X) \
20270 ((INTEGERP (X) || FLOATP (X)) \
20275 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20276 struct font
*font
, int width_p
, int *align_to
)
20280 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20281 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20284 return OK_PIXELS (0);
20286 xassert (FRAME_LIVE_P (it
->f
));
20288 if (SYMBOLP (prop
))
20290 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20292 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20294 if (unit
[0] == 'i' && unit
[1] == 'n')
20296 else if (unit
[0] == 'm' && unit
[1] == 'm')
20298 else if (unit
[0] == 'c' && unit
[1] == 'm')
20305 #ifdef HAVE_WINDOW_SYSTEM
20306 if (FRAME_WINDOW_P (it
->f
)
20308 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20309 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20311 return OK_PIXELS (ppi
/ pixels
);
20314 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20315 || (CONSP (Vdisplay_pixels_per_inch
)
20317 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20318 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20320 return OK_PIXELS (ppi
/ pixels
);
20326 #ifdef HAVE_WINDOW_SYSTEM
20327 if (EQ (prop
, Qheight
))
20328 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20329 if (EQ (prop
, Qwidth
))
20330 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20332 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20333 return OK_PIXELS (1);
20336 if (EQ (prop
, Qtext
))
20337 return OK_PIXELS (width_p
20338 ? window_box_width (it
->w
, TEXT_AREA
)
20339 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20341 if (align_to
&& *align_to
< 0)
20344 if (EQ (prop
, Qleft
))
20345 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20346 if (EQ (prop
, Qright
))
20347 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20348 if (EQ (prop
, Qcenter
))
20349 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20350 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20351 if (EQ (prop
, Qleft_fringe
))
20352 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20353 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20354 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20355 if (EQ (prop
, Qright_fringe
))
20356 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20357 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20358 : window_box_right_offset (it
->w
, TEXT_AREA
));
20359 if (EQ (prop
, Qleft_margin
))
20360 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20361 if (EQ (prop
, Qright_margin
))
20362 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20363 if (EQ (prop
, Qscroll_bar
))
20364 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20366 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20367 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20368 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20373 if (EQ (prop
, Qleft_fringe
))
20374 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20375 if (EQ (prop
, Qright_fringe
))
20376 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20377 if (EQ (prop
, Qleft_margin
))
20378 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20379 if (EQ (prop
, Qright_margin
))
20380 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20381 if (EQ (prop
, Qscroll_bar
))
20382 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20385 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20388 if (INTEGERP (prop
) || FLOATP (prop
))
20390 int base_unit
= (width_p
20391 ? FRAME_COLUMN_WIDTH (it
->f
)
20392 : FRAME_LINE_HEIGHT (it
->f
));
20393 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20398 Lisp_Object car
= XCAR (prop
);
20399 Lisp_Object cdr
= XCDR (prop
);
20403 #ifdef HAVE_WINDOW_SYSTEM
20404 if (FRAME_WINDOW_P (it
->f
)
20405 && valid_image_p (prop
))
20407 int id
= lookup_image (it
->f
, prop
);
20408 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20410 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20413 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20419 while (CONSP (cdr
))
20421 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20422 font
, width_p
, align_to
))
20425 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20430 if (EQ (car
, Qminus
))
20432 return OK_PIXELS (pixels
);
20435 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20438 if (INTEGERP (car
) || FLOATP (car
))
20441 pixels
= XFLOATINT (car
);
20443 return OK_PIXELS (pixels
);
20444 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20445 font
, width_p
, align_to
))
20446 return OK_PIXELS (pixels
* fact
);
20457 /***********************************************************************
20459 ***********************************************************************/
20461 #ifdef HAVE_WINDOW_SYSTEM
20466 dump_glyph_string (struct glyph_string
*s
)
20468 fprintf (stderr
, "glyph string\n");
20469 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20470 s
->x
, s
->y
, s
->width
, s
->height
);
20471 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20472 fprintf (stderr
, " hl = %d\n", s
->hl
);
20473 fprintf (stderr
, " left overhang = %d, right = %d\n",
20474 s
->left_overhang
, s
->right_overhang
);
20475 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20476 fprintf (stderr
, " extends to end of line = %d\n",
20477 s
->extends_to_end_of_line_p
);
20478 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20479 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20482 #endif /* GLYPH_DEBUG */
20484 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20485 of XChar2b structures for S; it can't be allocated in
20486 init_glyph_string because it must be allocated via `alloca'. W
20487 is the window on which S is drawn. ROW and AREA are the glyph row
20488 and area within the row from which S is constructed. START is the
20489 index of the first glyph structure covered by S. HL is a
20490 face-override for drawing S. */
20493 #define OPTIONAL_HDC(hdc) HDC hdc,
20494 #define DECLARE_HDC(hdc) HDC hdc;
20495 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20496 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20499 #ifndef OPTIONAL_HDC
20500 #define OPTIONAL_HDC(hdc)
20501 #define DECLARE_HDC(hdc)
20502 #define ALLOCATE_HDC(hdc, f)
20503 #define RELEASE_HDC(hdc, f)
20507 init_glyph_string (struct glyph_string
*s
,
20509 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20510 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20512 memset (s
, 0, sizeof *s
);
20514 s
->f
= XFRAME (w
->frame
);
20518 s
->display
= FRAME_X_DISPLAY (s
->f
);
20519 s
->window
= FRAME_X_WINDOW (s
->f
);
20520 s
->char2b
= char2b
;
20524 s
->first_glyph
= row
->glyphs
[area
] + start
;
20525 s
->height
= row
->height
;
20526 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20527 s
->ybase
= s
->y
+ row
->ascent
;
20531 /* Append the list of glyph strings with head H and tail T to the list
20532 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20535 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20536 struct glyph_string
*h
, struct glyph_string
*t
)
20550 /* Prepend the list of glyph strings with head H and tail T to the
20551 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20555 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20556 struct glyph_string
*h
, struct glyph_string
*t
)
20570 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20571 Set *HEAD and *TAIL to the resulting list. */
20574 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20575 struct glyph_string
*s
)
20577 s
->next
= s
->prev
= NULL
;
20578 append_glyph_string_lists (head
, tail
, s
, s
);
20582 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20583 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20584 make sure that X resources for the face returned are allocated.
20585 Value is a pointer to a realized face that is ready for display if
20586 DISPLAY_P is non-zero. */
20588 static inline struct face
*
20589 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20590 XChar2b
*char2b
, int display_p
)
20592 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20596 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20598 if (code
!= FONT_INVALID_CODE
)
20599 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20601 STORE_XCHAR2B (char2b
, 0, 0);
20604 /* Make sure X resources of the face are allocated. */
20605 #ifdef HAVE_X_WINDOWS
20609 xassert (face
!= NULL
);
20610 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20617 /* Get face and two-byte form of character glyph GLYPH on frame F.
20618 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20619 a pointer to a realized face that is ready for display. */
20621 static inline struct face
*
20622 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20623 XChar2b
*char2b
, int *two_byte_p
)
20627 xassert (glyph
->type
== CHAR_GLYPH
);
20628 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20637 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20638 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20640 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20642 if (code
!= FONT_INVALID_CODE
)
20643 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20645 STORE_XCHAR2B (char2b
, 0, 0);
20648 /* Make sure X resources of the face are allocated. */
20649 xassert (face
!= NULL
);
20650 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20655 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20656 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20659 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20663 if (CHAR_BYTE8_P (c
))
20664 code
= CHAR_TO_BYTE8 (c
);
20666 code
= font
->driver
->encode_char (font
, c
);
20668 if (code
== FONT_INVALID_CODE
)
20670 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20675 /* Fill glyph string S with composition components specified by S->cmp.
20677 BASE_FACE is the base face of the composition.
20678 S->cmp_from is the index of the first component for S.
20680 OVERLAPS non-zero means S should draw the foreground only, and use
20681 its physical height for clipping. See also draw_glyphs.
20683 Value is the index of a component not in S. */
20686 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20690 /* For all glyphs of this composition, starting at the offset
20691 S->cmp_from, until we reach the end of the definition or encounter a
20692 glyph that requires the different face, add it to S. */
20697 s
->for_overlaps
= overlaps
;
20700 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20702 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20706 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20709 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20716 s
->font
= s
->face
->font
;
20718 else if (s
->face
!= face
)
20726 /* All glyph strings for the same composition has the same width,
20727 i.e. the width set for the first component of the composition. */
20728 s
->width
= s
->first_glyph
->pixel_width
;
20730 /* If the specified font could not be loaded, use the frame's
20731 default font, but record the fact that we couldn't load it in
20732 the glyph string so that we can draw rectangles for the
20733 characters of the glyph string. */
20734 if (s
->font
== NULL
)
20736 s
->font_not_found_p
= 1;
20737 s
->font
= FRAME_FONT (s
->f
);
20740 /* Adjust base line for subscript/superscript text. */
20741 s
->ybase
+= s
->first_glyph
->voffset
;
20743 /* This glyph string must always be drawn with 16-bit functions. */
20750 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20751 int start
, int end
, int overlaps
)
20753 struct glyph
*glyph
, *last
;
20754 Lisp_Object lgstring
;
20757 s
->for_overlaps
= overlaps
;
20758 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20759 last
= s
->row
->glyphs
[s
->area
] + end
;
20760 s
->cmp_id
= glyph
->u
.cmp
.id
;
20761 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20762 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20763 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20764 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20765 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20767 while (glyph
< last
20768 && glyph
->u
.cmp
.automatic
20769 && glyph
->u
.cmp
.id
== s
->cmp_id
20770 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20771 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20773 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20775 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20776 unsigned code
= LGLYPH_CODE (lglyph
);
20778 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20780 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20781 return glyph
- s
->row
->glyphs
[s
->area
];
20785 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20786 See the comment of fill_glyph_string for arguments.
20787 Value is the index of the first glyph not in S. */
20791 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20792 int start
, int end
, int overlaps
)
20794 struct glyph
*glyph
, *last
;
20797 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20798 s
->for_overlaps
= overlaps
;
20799 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20800 last
= s
->row
->glyphs
[s
->area
] + end
;
20801 voffset
= glyph
->voffset
;
20802 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20803 s
->font
= s
->face
->font
;
20805 s
->width
= glyph
->pixel_width
;
20807 while (glyph
< last
20808 && glyph
->type
== GLYPHLESS_GLYPH
20809 && glyph
->voffset
== voffset
20810 && glyph
->face_id
== face_id
)
20813 s
->width
+= glyph
->pixel_width
;
20816 s
->ybase
+= voffset
;
20817 return glyph
- s
->row
->glyphs
[s
->area
];
20821 /* Fill glyph string S from a sequence of character glyphs.
20823 FACE_ID is the face id of the string. START is the index of the
20824 first glyph to consider, END is the index of the last + 1.
20825 OVERLAPS non-zero means S should draw the foreground only, and use
20826 its physical height for clipping. See also draw_glyphs.
20828 Value is the index of the first glyph not in S. */
20831 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20832 int start
, int end
, int overlaps
)
20834 struct glyph
*glyph
, *last
;
20836 int glyph_not_available_p
;
20838 xassert (s
->f
== XFRAME (s
->w
->frame
));
20839 xassert (s
->nchars
== 0);
20840 xassert (start
>= 0 && end
> start
);
20842 s
->for_overlaps
= overlaps
;
20843 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20844 last
= s
->row
->glyphs
[s
->area
] + end
;
20845 voffset
= glyph
->voffset
;
20846 s
->padding_p
= glyph
->padding_p
;
20847 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20849 while (glyph
< last
20850 && glyph
->type
== CHAR_GLYPH
20851 && glyph
->voffset
== voffset
20852 /* Same face id implies same font, nowadays. */
20853 && glyph
->face_id
== face_id
20854 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20858 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20859 s
->char2b
+ s
->nchars
,
20861 s
->two_byte_p
= two_byte_p
;
20863 xassert (s
->nchars
<= end
- start
);
20864 s
->width
+= glyph
->pixel_width
;
20865 if (glyph
++->padding_p
!= s
->padding_p
)
20869 s
->font
= s
->face
->font
;
20871 /* If the specified font could not be loaded, use the frame's font,
20872 but record the fact that we couldn't load it in
20873 S->font_not_found_p so that we can draw rectangles for the
20874 characters of the glyph string. */
20875 if (s
->font
== NULL
|| glyph_not_available_p
)
20877 s
->font_not_found_p
= 1;
20878 s
->font
= FRAME_FONT (s
->f
);
20881 /* Adjust base line for subscript/superscript text. */
20882 s
->ybase
+= voffset
;
20884 xassert (s
->face
&& s
->face
->gc
);
20885 return glyph
- s
->row
->glyphs
[s
->area
];
20889 /* Fill glyph string S from image glyph S->first_glyph. */
20892 fill_image_glyph_string (struct glyph_string
*s
)
20894 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20895 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20897 s
->slice
= s
->first_glyph
->slice
.img
;
20898 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20899 s
->font
= s
->face
->font
;
20900 s
->width
= s
->first_glyph
->pixel_width
;
20902 /* Adjust base line for subscript/superscript text. */
20903 s
->ybase
+= s
->first_glyph
->voffset
;
20907 /* Fill glyph string S from a sequence of stretch glyphs.
20909 START is the index of the first glyph to consider,
20910 END is the index of the last + 1.
20912 Value is the index of the first glyph not in S. */
20915 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20917 struct glyph
*glyph
, *last
;
20918 int voffset
, face_id
;
20920 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20922 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20923 last
= s
->row
->glyphs
[s
->area
] + end
;
20924 face_id
= glyph
->face_id
;
20925 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20926 s
->font
= s
->face
->font
;
20927 s
->width
= glyph
->pixel_width
;
20929 voffset
= glyph
->voffset
;
20933 && glyph
->type
== STRETCH_GLYPH
20934 && glyph
->voffset
== voffset
20935 && glyph
->face_id
== face_id
);
20937 s
->width
+= glyph
->pixel_width
;
20939 /* Adjust base line for subscript/superscript text. */
20940 s
->ybase
+= voffset
;
20942 /* The case that face->gc == 0 is handled when drawing the glyph
20943 string by calling PREPARE_FACE_FOR_DISPLAY. */
20945 return glyph
- s
->row
->glyphs
[s
->area
];
20948 static struct font_metrics
*
20949 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
20951 static struct font_metrics metrics
;
20952 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20954 if (! font
|| code
== FONT_INVALID_CODE
)
20956 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20961 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20962 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20963 assumed to be zero. */
20966 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20968 *left
= *right
= 0;
20970 if (glyph
->type
== CHAR_GLYPH
)
20974 struct font_metrics
*pcm
;
20976 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20977 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
20979 if (pcm
->rbearing
> pcm
->width
)
20980 *right
= pcm
->rbearing
- pcm
->width
;
20981 if (pcm
->lbearing
< 0)
20982 *left
= -pcm
->lbearing
;
20985 else if (glyph
->type
== COMPOSITE_GLYPH
)
20987 if (! glyph
->u
.cmp
.automatic
)
20989 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20991 if (cmp
->rbearing
> cmp
->pixel_width
)
20992 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20993 if (cmp
->lbearing
< 0)
20994 *left
= - cmp
->lbearing
;
20998 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20999 struct font_metrics metrics
;
21001 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21002 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21003 if (metrics
.rbearing
> metrics
.width
)
21004 *right
= metrics
.rbearing
- metrics
.width
;
21005 if (metrics
.lbearing
< 0)
21006 *left
= - metrics
.lbearing
;
21012 /* Return the index of the first glyph preceding glyph string S that
21013 is overwritten by S because of S's left overhang. Value is -1
21014 if no glyphs are overwritten. */
21017 left_overwritten (struct glyph_string
*s
)
21021 if (s
->left_overhang
)
21024 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21025 int first
= s
->first_glyph
- glyphs
;
21027 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21028 x
-= glyphs
[i
].pixel_width
;
21039 /* Return the index of the first glyph preceding glyph string S that
21040 is overwriting S because of its right overhang. Value is -1 if no
21041 glyph in front of S overwrites S. */
21044 left_overwriting (struct glyph_string
*s
)
21047 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21048 int first
= s
->first_glyph
- glyphs
;
21052 for (i
= first
- 1; i
>= 0; --i
)
21055 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21058 x
-= glyphs
[i
].pixel_width
;
21065 /* Return the index of the last glyph following glyph string S that is
21066 overwritten by S because of S's right overhang. Value is -1 if
21067 no such glyph is found. */
21070 right_overwritten (struct glyph_string
*s
)
21074 if (s
->right_overhang
)
21077 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21078 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21079 int end
= s
->row
->used
[s
->area
];
21081 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21082 x
+= glyphs
[i
].pixel_width
;
21091 /* Return the index of the last glyph following glyph string S that
21092 overwrites S because of its left overhang. Value is negative
21093 if no such glyph is found. */
21096 right_overwriting (struct glyph_string
*s
)
21099 int end
= s
->row
->used
[s
->area
];
21100 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21101 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21105 for (i
= first
; i
< end
; ++i
)
21108 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21111 x
+= glyphs
[i
].pixel_width
;
21118 /* Set background width of glyph string S. START is the index of the
21119 first glyph following S. LAST_X is the right-most x-position + 1
21120 in the drawing area. */
21123 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21125 /* If the face of this glyph string has to be drawn to the end of
21126 the drawing area, set S->extends_to_end_of_line_p. */
21128 if (start
== s
->row
->used
[s
->area
]
21129 && s
->area
== TEXT_AREA
21130 && ((s
->row
->fill_line_p
21131 && (s
->hl
== DRAW_NORMAL_TEXT
21132 || s
->hl
== DRAW_IMAGE_RAISED
21133 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21134 || s
->hl
== DRAW_MOUSE_FACE
))
21135 s
->extends_to_end_of_line_p
= 1;
21137 /* If S extends its face to the end of the line, set its
21138 background_width to the distance to the right edge of the drawing
21140 if (s
->extends_to_end_of_line_p
)
21141 s
->background_width
= last_x
- s
->x
+ 1;
21143 s
->background_width
= s
->width
;
21147 /* Compute overhangs and x-positions for glyph string S and its
21148 predecessors, or successors. X is the starting x-position for S.
21149 BACKWARD_P non-zero means process predecessors. */
21152 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21158 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21159 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21169 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21170 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21180 /* The following macros are only called from draw_glyphs below.
21181 They reference the following parameters of that function directly:
21182 `w', `row', `area', and `overlap_p'
21183 as well as the following local variables:
21184 `s', `f', and `hdc' (in W32) */
21187 /* On W32, silently add local `hdc' variable to argument list of
21188 init_glyph_string. */
21189 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21190 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21192 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21193 init_glyph_string (s, char2b, w, row, area, start, hl)
21196 /* Add a glyph string for a stretch glyph to the list of strings
21197 between HEAD and TAIL. START is the index of the stretch glyph in
21198 row area AREA of glyph row ROW. END is the index of the last glyph
21199 in that glyph row area. X is the current output position assigned
21200 to the new glyph string constructed. HL overrides that face of the
21201 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21202 is the right-most x-position of the drawing area. */
21204 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21205 and below -- keep them on one line. */
21206 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21209 s = (struct glyph_string *) alloca (sizeof *s); \
21210 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21211 START = fill_stretch_glyph_string (s, START, END); \
21212 append_glyph_string (&HEAD, &TAIL, s); \
21218 /* Add a glyph string for an image glyph to the list of strings
21219 between HEAD and TAIL. START is the index of the image glyph in
21220 row area AREA of glyph row ROW. END is the index of the last glyph
21221 in that glyph row area. X is the current output position assigned
21222 to the new glyph string constructed. HL overrides that face of the
21223 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21224 is the right-most x-position of the drawing area. */
21226 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21229 s = (struct glyph_string *) alloca (sizeof *s); \
21230 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21231 fill_image_glyph_string (s); \
21232 append_glyph_string (&HEAD, &TAIL, s); \
21239 /* Add a glyph string for a sequence of character glyphs to the list
21240 of strings between HEAD and TAIL. START is the index of the first
21241 glyph in row area AREA of glyph row ROW that is part of the new
21242 glyph string. END is the index of the last glyph in that glyph row
21243 area. X is the current output position assigned to the new glyph
21244 string constructed. HL overrides that face of the glyph; e.g. it
21245 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21246 right-most x-position of the drawing area. */
21248 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21254 face_id = (row)->glyphs[area][START].face_id; \
21256 s = (struct glyph_string *) alloca (sizeof *s); \
21257 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21258 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21259 append_glyph_string (&HEAD, &TAIL, s); \
21261 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21266 /* Add a glyph string for a composite sequence to the list of strings
21267 between HEAD and TAIL. START is the index of the first glyph in
21268 row area AREA of glyph row ROW that is part of the new glyph
21269 string. END is the index of the last glyph in that glyph row area.
21270 X is the current output position assigned to the new glyph string
21271 constructed. HL overrides that face of the glyph; e.g. it is
21272 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21273 x-position of the drawing area. */
21275 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21277 int face_id = (row)->glyphs[area][START].face_id; \
21278 struct face *base_face = FACE_FROM_ID (f, face_id); \
21279 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21280 struct composition *cmp = composition_table[cmp_id]; \
21282 struct glyph_string *first_s IF_LINT (= NULL); \
21285 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21287 /* Make glyph_strings for each glyph sequence that is drawable by \
21288 the same face, and append them to HEAD/TAIL. */ \
21289 for (n = 0; n < cmp->glyph_len;) \
21291 s = (struct glyph_string *) alloca (sizeof *s); \
21292 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21293 append_glyph_string (&(HEAD), &(TAIL), s); \
21299 n = fill_composite_glyph_string (s, base_face, overlaps); \
21307 /* Add a glyph string for a glyph-string sequence to the list of strings
21308 between HEAD and TAIL. */
21310 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21314 Lisp_Object gstring; \
21316 face_id = (row)->glyphs[area][START].face_id; \
21317 gstring = (composition_gstring_from_id \
21318 ((row)->glyphs[area][START].u.cmp.id)); \
21319 s = (struct glyph_string *) alloca (sizeof *s); \
21320 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21321 * LGSTRING_GLYPH_LEN (gstring)); \
21322 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21323 append_glyph_string (&(HEAD), &(TAIL), s); \
21325 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21329 /* Add a glyph string for a sequence of glyphless character's glyphs
21330 to the list of strings between HEAD and TAIL. The meanings of
21331 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21333 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21338 face_id = (row)->glyphs[area][START].face_id; \
21340 s = (struct glyph_string *) alloca (sizeof *s); \
21341 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21342 append_glyph_string (&HEAD, &TAIL, s); \
21344 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21350 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21351 of AREA of glyph row ROW on window W between indices START and END.
21352 HL overrides the face for drawing glyph strings, e.g. it is
21353 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21354 x-positions of the drawing area.
21356 This is an ugly monster macro construct because we must use alloca
21357 to allocate glyph strings (because draw_glyphs can be called
21358 asynchronously). */
21360 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21363 HEAD = TAIL = NULL; \
21364 while (START < END) \
21366 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21367 switch (first_glyph->type) \
21370 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21374 case COMPOSITE_GLYPH: \
21375 if (first_glyph->u.cmp.automatic) \
21376 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21379 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21383 case STRETCH_GLYPH: \
21384 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21388 case IMAGE_GLYPH: \
21389 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21393 case GLYPHLESS_GLYPH: \
21394 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21404 set_glyph_string_background_width (s, START, LAST_X); \
21411 /* Draw glyphs between START and END in AREA of ROW on window W,
21412 starting at x-position X. X is relative to AREA in W. HL is a
21413 face-override with the following meaning:
21415 DRAW_NORMAL_TEXT draw normally
21416 DRAW_CURSOR draw in cursor face
21417 DRAW_MOUSE_FACE draw in mouse face.
21418 DRAW_INVERSE_VIDEO draw in mode line face
21419 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21420 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21422 If OVERLAPS is non-zero, draw only the foreground of characters and
21423 clip to the physical height of ROW. Non-zero value also defines
21424 the overlapping part to be drawn:
21426 OVERLAPS_PRED overlap with preceding rows
21427 OVERLAPS_SUCC overlap with succeeding rows
21428 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21429 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21431 Value is the x-position reached, relative to AREA of W. */
21434 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21435 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21436 enum draw_glyphs_face hl
, int overlaps
)
21438 struct glyph_string
*head
, *tail
;
21439 struct glyph_string
*s
;
21440 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21441 int i
, j
, x_reached
, last_x
, area_left
= 0;
21442 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21445 ALLOCATE_HDC (hdc
, f
);
21447 /* Let's rather be paranoid than getting a SEGV. */
21448 end
= min (end
, row
->used
[area
]);
21449 start
= max (0, start
);
21450 start
= min (end
, start
);
21452 /* Translate X to frame coordinates. Set last_x to the right
21453 end of the drawing area. */
21454 if (row
->full_width_p
)
21456 /* X is relative to the left edge of W, without scroll bars
21458 area_left
= WINDOW_LEFT_EDGE_X (w
);
21459 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21463 area_left
= window_box_left (w
, area
);
21464 last_x
= area_left
+ window_box_width (w
, area
);
21468 /* Build a doubly-linked list of glyph_string structures between
21469 head and tail from what we have to draw. Note that the macro
21470 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21471 the reason we use a separate variable `i'. */
21473 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21475 x_reached
= tail
->x
+ tail
->background_width
;
21479 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21480 the row, redraw some glyphs in front or following the glyph
21481 strings built above. */
21482 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21484 struct glyph_string
*h
, *t
;
21485 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21486 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21487 int check_mouse_face
= 0;
21490 /* If mouse highlighting is on, we may need to draw adjacent
21491 glyphs using mouse-face highlighting. */
21492 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21494 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21496 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21497 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21499 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21501 check_mouse_face
= 1;
21502 mouse_beg_col
= (row
== mouse_beg_row
)
21503 ? hlinfo
->mouse_face_beg_col
: 0;
21504 mouse_end_col
= (row
== mouse_end_row
)
21505 ? hlinfo
->mouse_face_end_col
21506 : row
->used
[TEXT_AREA
];
21510 /* Compute overhangs for all glyph strings. */
21511 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21512 for (s
= head
; s
; s
= s
->next
)
21513 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21515 /* Prepend glyph strings for glyphs in front of the first glyph
21516 string that are overwritten because of the first glyph
21517 string's left overhang. The background of all strings
21518 prepended must be drawn because the first glyph string
21520 i
= left_overwritten (head
);
21523 enum draw_glyphs_face overlap_hl
;
21525 /* If this row contains mouse highlighting, attempt to draw
21526 the overlapped glyphs with the correct highlight. This
21527 code fails if the overlap encompasses more than one glyph
21528 and mouse-highlight spans only some of these glyphs.
21529 However, making it work perfectly involves a lot more
21530 code, and I don't know if the pathological case occurs in
21531 practice, so we'll stick to this for now. --- cyd */
21532 if (check_mouse_face
21533 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21534 overlap_hl
= DRAW_MOUSE_FACE
;
21536 overlap_hl
= DRAW_NORMAL_TEXT
;
21539 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21540 overlap_hl
, dummy_x
, last_x
);
21542 compute_overhangs_and_x (t
, head
->x
, 1);
21543 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21547 /* Prepend glyph strings for glyphs in front of the first glyph
21548 string that overwrite that glyph string because of their
21549 right overhang. For these strings, only the foreground must
21550 be drawn, because it draws over the glyph string at `head'.
21551 The background must not be drawn because this would overwrite
21552 right overhangs of preceding glyphs for which no glyph
21554 i
= left_overwriting (head
);
21557 enum draw_glyphs_face overlap_hl
;
21559 if (check_mouse_face
21560 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21561 overlap_hl
= DRAW_MOUSE_FACE
;
21563 overlap_hl
= DRAW_NORMAL_TEXT
;
21566 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21567 overlap_hl
, dummy_x
, last_x
);
21568 for (s
= h
; s
; s
= s
->next
)
21569 s
->background_filled_p
= 1;
21570 compute_overhangs_and_x (t
, head
->x
, 1);
21571 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21574 /* Append glyphs strings for glyphs following the last glyph
21575 string tail that are overwritten by tail. The background of
21576 these strings has to be drawn because tail's foreground draws
21578 i
= right_overwritten (tail
);
21581 enum draw_glyphs_face overlap_hl
;
21583 if (check_mouse_face
21584 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21585 overlap_hl
= DRAW_MOUSE_FACE
;
21587 overlap_hl
= DRAW_NORMAL_TEXT
;
21589 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21590 overlap_hl
, x
, last_x
);
21591 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21592 we don't have `end = i;' here. */
21593 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21594 append_glyph_string_lists (&head
, &tail
, h
, t
);
21598 /* Append glyph strings for glyphs following the last glyph
21599 string tail that overwrite tail. The foreground of such
21600 glyphs has to be drawn because it writes into the background
21601 of tail. The background must not be drawn because it could
21602 paint over the foreground of following glyphs. */
21603 i
= right_overwriting (tail
);
21606 enum draw_glyphs_face overlap_hl
;
21607 if (check_mouse_face
21608 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21609 overlap_hl
= DRAW_MOUSE_FACE
;
21611 overlap_hl
= DRAW_NORMAL_TEXT
;
21614 i
++; /* We must include the Ith glyph. */
21615 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21616 overlap_hl
, x
, last_x
);
21617 for (s
= h
; s
; s
= s
->next
)
21618 s
->background_filled_p
= 1;
21619 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21620 append_glyph_string_lists (&head
, &tail
, h
, t
);
21622 if (clip_head
|| clip_tail
)
21623 for (s
= head
; s
; s
= s
->next
)
21625 s
->clip_head
= clip_head
;
21626 s
->clip_tail
= clip_tail
;
21630 /* Draw all strings. */
21631 for (s
= head
; s
; s
= s
->next
)
21632 FRAME_RIF (f
)->draw_glyph_string (s
);
21635 /* When focus a sole frame and move horizontally, this sets on_p to 0
21636 causing a failure to erase prev cursor position. */
21637 if (area
== TEXT_AREA
21638 && !row
->full_width_p
21639 /* When drawing overlapping rows, only the glyph strings'
21640 foreground is drawn, which doesn't erase a cursor
21644 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21645 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21646 : (tail
? tail
->x
+ tail
->background_width
: x
));
21650 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21651 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21655 /* Value is the x-position up to which drawn, relative to AREA of W.
21656 This doesn't include parts drawn because of overhangs. */
21657 if (row
->full_width_p
)
21658 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21660 x_reached
-= area_left
;
21662 RELEASE_HDC (hdc
, f
);
21667 /* Expand row matrix if too narrow. Don't expand if area
21670 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21672 if (!fonts_changed_p \
21673 && (it->glyph_row->glyphs[area] \
21674 < it->glyph_row->glyphs[area + 1])) \
21676 it->w->ncols_scale_factor++; \
21677 fonts_changed_p = 1; \
21681 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21682 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21685 append_glyph (struct it
*it
)
21687 struct glyph
*glyph
;
21688 enum glyph_row_area area
= it
->area
;
21690 xassert (it
->glyph_row
);
21691 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21693 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21694 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21696 /* If the glyph row is reversed, we need to prepend the glyph
21697 rather than append it. */
21698 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21702 /* Make room for the additional glyph. */
21703 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21705 glyph
= it
->glyph_row
->glyphs
[area
];
21707 glyph
->charpos
= CHARPOS (it
->position
);
21708 glyph
->object
= it
->object
;
21709 if (it
->pixel_width
> 0)
21711 glyph
->pixel_width
= it
->pixel_width
;
21712 glyph
->padding_p
= 0;
21716 /* Assure at least 1-pixel width. Otherwise, cursor can't
21717 be displayed correctly. */
21718 glyph
->pixel_width
= 1;
21719 glyph
->padding_p
= 1;
21721 glyph
->ascent
= it
->ascent
;
21722 glyph
->descent
= it
->descent
;
21723 glyph
->voffset
= it
->voffset
;
21724 glyph
->type
= CHAR_GLYPH
;
21725 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21726 glyph
->multibyte_p
= it
->multibyte_p
;
21727 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21728 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21729 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21730 || it
->phys_descent
> it
->descent
);
21731 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21732 glyph
->face_id
= it
->face_id
;
21733 glyph
->u
.ch
= it
->char_to_display
;
21734 glyph
->slice
.img
= null_glyph_slice
;
21735 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21738 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21739 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21741 glyph
->bidi_type
= it
->bidi_it
.type
;
21745 glyph
->resolved_level
= 0;
21746 glyph
->bidi_type
= UNKNOWN_BT
;
21748 ++it
->glyph_row
->used
[area
];
21751 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21754 /* Store one glyph for the composition IT->cmp_it.id in
21755 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21759 append_composite_glyph (struct it
*it
)
21761 struct glyph
*glyph
;
21762 enum glyph_row_area area
= it
->area
;
21764 xassert (it
->glyph_row
);
21766 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21767 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21769 /* If the glyph row is reversed, we need to prepend the glyph
21770 rather than append it. */
21771 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21775 /* Make room for the new glyph. */
21776 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21778 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21780 glyph
->charpos
= it
->cmp_it
.charpos
;
21781 glyph
->object
= it
->object
;
21782 glyph
->pixel_width
= it
->pixel_width
;
21783 glyph
->ascent
= it
->ascent
;
21784 glyph
->descent
= it
->descent
;
21785 glyph
->voffset
= it
->voffset
;
21786 glyph
->type
= COMPOSITE_GLYPH
;
21787 if (it
->cmp_it
.ch
< 0)
21789 glyph
->u
.cmp
.automatic
= 0;
21790 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21791 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21795 glyph
->u
.cmp
.automatic
= 1;
21796 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21797 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21798 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21800 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21801 glyph
->multibyte_p
= it
->multibyte_p
;
21802 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21803 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21804 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21805 || it
->phys_descent
> it
->descent
);
21806 glyph
->padding_p
= 0;
21807 glyph
->glyph_not_available_p
= 0;
21808 glyph
->face_id
= it
->face_id
;
21809 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21812 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21813 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21815 glyph
->bidi_type
= it
->bidi_it
.type
;
21817 ++it
->glyph_row
->used
[area
];
21820 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21824 /* Change IT->ascent and IT->height according to the setting of
21828 take_vertical_position_into_account (struct it
*it
)
21832 if (it
->voffset
< 0)
21833 /* Increase the ascent so that we can display the text higher
21835 it
->ascent
-= it
->voffset
;
21837 /* Increase the descent so that we can display the text lower
21839 it
->descent
+= it
->voffset
;
21844 /* Produce glyphs/get display metrics for the image IT is loaded with.
21845 See the description of struct display_iterator in dispextern.h for
21846 an overview of struct display_iterator. */
21849 produce_image_glyph (struct it
*it
)
21853 int glyph_ascent
, crop
;
21854 struct glyph_slice slice
;
21856 xassert (it
->what
== IT_IMAGE
);
21858 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21860 /* Make sure X resources of the face is loaded. */
21861 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21863 if (it
->image_id
< 0)
21865 /* Fringe bitmap. */
21866 it
->ascent
= it
->phys_ascent
= 0;
21867 it
->descent
= it
->phys_descent
= 0;
21868 it
->pixel_width
= 0;
21873 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21875 /* Make sure X resources of the image is loaded. */
21876 prepare_image_for_display (it
->f
, img
);
21878 slice
.x
= slice
.y
= 0;
21879 slice
.width
= img
->width
;
21880 slice
.height
= img
->height
;
21882 if (INTEGERP (it
->slice
.x
))
21883 slice
.x
= XINT (it
->slice
.x
);
21884 else if (FLOATP (it
->slice
.x
))
21885 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21887 if (INTEGERP (it
->slice
.y
))
21888 slice
.y
= XINT (it
->slice
.y
);
21889 else if (FLOATP (it
->slice
.y
))
21890 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21892 if (INTEGERP (it
->slice
.width
))
21893 slice
.width
= XINT (it
->slice
.width
);
21894 else if (FLOATP (it
->slice
.width
))
21895 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21897 if (INTEGERP (it
->slice
.height
))
21898 slice
.height
= XINT (it
->slice
.height
);
21899 else if (FLOATP (it
->slice
.height
))
21900 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21902 if (slice
.x
>= img
->width
)
21903 slice
.x
= img
->width
;
21904 if (slice
.y
>= img
->height
)
21905 slice
.y
= img
->height
;
21906 if (slice
.x
+ slice
.width
>= img
->width
)
21907 slice
.width
= img
->width
- slice
.x
;
21908 if (slice
.y
+ slice
.height
> img
->height
)
21909 slice
.height
= img
->height
- slice
.y
;
21911 if (slice
.width
== 0 || slice
.height
== 0)
21914 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21916 it
->descent
= slice
.height
- glyph_ascent
;
21918 it
->descent
+= img
->vmargin
;
21919 if (slice
.y
+ slice
.height
== img
->height
)
21920 it
->descent
+= img
->vmargin
;
21921 it
->phys_descent
= it
->descent
;
21923 it
->pixel_width
= slice
.width
;
21925 it
->pixel_width
+= img
->hmargin
;
21926 if (slice
.x
+ slice
.width
== img
->width
)
21927 it
->pixel_width
+= img
->hmargin
;
21929 /* It's quite possible for images to have an ascent greater than
21930 their height, so don't get confused in that case. */
21931 if (it
->descent
< 0)
21936 if (face
->box
!= FACE_NO_BOX
)
21938 if (face
->box_line_width
> 0)
21941 it
->ascent
+= face
->box_line_width
;
21942 if (slice
.y
+ slice
.height
== img
->height
)
21943 it
->descent
+= face
->box_line_width
;
21946 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21947 it
->pixel_width
+= eabs (face
->box_line_width
);
21948 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21949 it
->pixel_width
+= eabs (face
->box_line_width
);
21952 take_vertical_position_into_account (it
);
21954 /* Automatically crop wide image glyphs at right edge so we can
21955 draw the cursor on same display row. */
21956 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21957 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21959 it
->pixel_width
-= crop
;
21960 slice
.width
-= crop
;
21965 struct glyph
*glyph
;
21966 enum glyph_row_area area
= it
->area
;
21968 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21969 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21971 glyph
->charpos
= CHARPOS (it
->position
);
21972 glyph
->object
= it
->object
;
21973 glyph
->pixel_width
= it
->pixel_width
;
21974 glyph
->ascent
= glyph_ascent
;
21975 glyph
->descent
= it
->descent
;
21976 glyph
->voffset
= it
->voffset
;
21977 glyph
->type
= IMAGE_GLYPH
;
21978 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21979 glyph
->multibyte_p
= it
->multibyte_p
;
21980 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21981 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21982 glyph
->overlaps_vertically_p
= 0;
21983 glyph
->padding_p
= 0;
21984 glyph
->glyph_not_available_p
= 0;
21985 glyph
->face_id
= it
->face_id
;
21986 glyph
->u
.img_id
= img
->id
;
21987 glyph
->slice
.img
= slice
;
21988 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21991 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21992 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21994 glyph
->bidi_type
= it
->bidi_it
.type
;
21996 ++it
->glyph_row
->used
[area
];
21999 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22004 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22005 of the glyph, WIDTH and HEIGHT are the width and height of the
22006 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22009 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22010 int width
, int height
, int ascent
)
22012 struct glyph
*glyph
;
22013 enum glyph_row_area area
= it
->area
;
22015 xassert (ascent
>= 0 && ascent
<= height
);
22017 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22018 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22020 /* If the glyph row is reversed, we need to prepend the glyph
22021 rather than append it. */
22022 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22026 /* Make room for the additional glyph. */
22027 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22029 glyph
= it
->glyph_row
->glyphs
[area
];
22031 glyph
->charpos
= CHARPOS (it
->position
);
22032 glyph
->object
= object
;
22033 glyph
->pixel_width
= width
;
22034 glyph
->ascent
= ascent
;
22035 glyph
->descent
= height
- ascent
;
22036 glyph
->voffset
= it
->voffset
;
22037 glyph
->type
= STRETCH_GLYPH
;
22038 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22039 glyph
->multibyte_p
= it
->multibyte_p
;
22040 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22041 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22042 glyph
->overlaps_vertically_p
= 0;
22043 glyph
->padding_p
= 0;
22044 glyph
->glyph_not_available_p
= 0;
22045 glyph
->face_id
= it
->face_id
;
22046 glyph
->u
.stretch
.ascent
= ascent
;
22047 glyph
->u
.stretch
.height
= height
;
22048 glyph
->slice
.img
= null_glyph_slice
;
22049 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22052 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22053 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22055 glyph
->bidi_type
= it
->bidi_it
.type
;
22059 glyph
->resolved_level
= 0;
22060 glyph
->bidi_type
= UNKNOWN_BT
;
22062 ++it
->glyph_row
->used
[area
];
22065 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22069 /* Produce a stretch glyph for iterator IT. IT->object is the value
22070 of the glyph property displayed. The value must be a list
22071 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22074 1. `:width WIDTH' specifies that the space should be WIDTH *
22075 canonical char width wide. WIDTH may be an integer or floating
22078 2. `:relative-width FACTOR' specifies that the width of the stretch
22079 should be computed from the width of the first character having the
22080 `glyph' property, and should be FACTOR times that width.
22082 3. `:align-to HPOS' specifies that the space should be wide enough
22083 to reach HPOS, a value in canonical character units.
22085 Exactly one of the above pairs must be present.
22087 4. `:height HEIGHT' specifies that the height of the stretch produced
22088 should be HEIGHT, measured in canonical character units.
22090 5. `:relative-height FACTOR' specifies that the height of the
22091 stretch should be FACTOR times the height of the characters having
22092 the glyph property.
22094 Either none or exactly one of 4 or 5 must be present.
22096 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22097 of the stretch should be used for the ascent of the stretch.
22098 ASCENT must be in the range 0 <= ASCENT <= 100. */
22101 produce_stretch_glyph (struct it
*it
)
22103 /* (space :width WIDTH :height HEIGHT ...) */
22104 Lisp_Object prop
, plist
;
22105 int width
= 0, height
= 0, align_to
= -1;
22106 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22109 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22110 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22112 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22114 /* List should start with `space'. */
22115 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22116 plist
= XCDR (it
->object
);
22118 /* Compute the width of the stretch. */
22119 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22120 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22122 /* Absolute width `:width WIDTH' specified and valid. */
22123 zero_width_ok_p
= 1;
22126 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22129 /* Relative width `:relative-width FACTOR' specified and valid.
22130 Compute the width of the characters having the `glyph'
22133 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22136 if (it
->multibyte_p
)
22137 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22140 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22141 if (! ASCII_CHAR_P (it2
.c
))
22142 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22145 it2
.glyph_row
= NULL
;
22146 it2
.what
= IT_CHARACTER
;
22147 x_produce_glyphs (&it2
);
22148 width
= NUMVAL (prop
) * it2
.pixel_width
;
22150 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22151 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22153 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22154 align_to
= (align_to
< 0
22156 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22157 else if (align_to
< 0)
22158 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22159 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22160 zero_width_ok_p
= 1;
22163 /* Nothing specified -> width defaults to canonical char width. */
22164 width
= FRAME_COLUMN_WIDTH (it
->f
);
22166 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22169 /* Compute height. */
22170 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22171 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22174 zero_height_ok_p
= 1;
22176 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22178 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22180 height
= FONT_HEIGHT (font
);
22182 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22185 /* Compute percentage of height used for ascent. If
22186 `:ascent ASCENT' is present and valid, use that. Otherwise,
22187 derive the ascent from the font in use. */
22188 if (prop
= Fplist_get (plist
, QCascent
),
22189 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22190 ascent
= height
* NUMVAL (prop
) / 100.0;
22191 else if (!NILP (prop
)
22192 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22193 ascent
= min (max (0, (int)tem
), height
);
22195 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22197 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22198 && it
->current_x
+ width
> it
->last_visible_x
)
22199 width
= it
->last_visible_x
- it
->current_x
- 1;
22201 if (width
> 0 && height
> 0 && it
->glyph_row
)
22203 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22204 if (!STRINGP (object
))
22205 object
= it
->w
->buffer
;
22206 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22209 it
->pixel_width
= width
;
22210 it
->ascent
= it
->phys_ascent
= ascent
;
22211 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22212 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22214 take_vertical_position_into_account (it
);
22217 /* Calculate line-height and line-spacing properties.
22218 An integer value specifies explicit pixel value.
22219 A float value specifies relative value to current face height.
22220 A cons (float . face-name) specifies relative value to
22221 height of specified face font.
22223 Returns height in pixels, or nil. */
22227 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22228 int boff
, int override
)
22230 Lisp_Object face_name
= Qnil
;
22231 int ascent
, descent
, height
;
22233 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22238 face_name
= XCAR (val
);
22240 if (!NUMBERP (val
))
22241 val
= make_number (1);
22242 if (NILP (face_name
))
22244 height
= it
->ascent
+ it
->descent
;
22249 if (NILP (face_name
))
22251 font
= FRAME_FONT (it
->f
);
22252 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22254 else if (EQ (face_name
, Qt
))
22263 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22265 return make_number (-1);
22267 face
= FACE_FROM_ID (it
->f
, face_id
);
22270 return make_number (-1);
22271 boff
= font
->baseline_offset
;
22272 if (font
->vertical_centering
)
22273 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22276 ascent
= FONT_BASE (font
) + boff
;
22277 descent
= FONT_DESCENT (font
) - boff
;
22281 it
->override_ascent
= ascent
;
22282 it
->override_descent
= descent
;
22283 it
->override_boff
= boff
;
22286 height
= ascent
+ descent
;
22290 height
= (int)(XFLOAT_DATA (val
) * height
);
22291 else if (INTEGERP (val
))
22292 height
*= XINT (val
);
22294 return make_number (height
);
22298 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22299 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22300 and only if this is for a character for which no font was found.
22302 If the display method (it->glyphless_method) is
22303 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22304 length of the acronym or the hexadecimal string, UPPER_XOFF and
22305 UPPER_YOFF are pixel offsets for the upper part of the string,
22306 LOWER_XOFF and LOWER_YOFF are for the lower part.
22308 For the other display methods, LEN through LOWER_YOFF are zero. */
22311 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22312 short upper_xoff
, short upper_yoff
,
22313 short lower_xoff
, short lower_yoff
)
22315 struct glyph
*glyph
;
22316 enum glyph_row_area area
= it
->area
;
22318 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22319 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22321 /* If the glyph row is reversed, we need to prepend the glyph
22322 rather than append it. */
22323 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22327 /* Make room for the additional glyph. */
22328 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22330 glyph
= it
->glyph_row
->glyphs
[area
];
22332 glyph
->charpos
= CHARPOS (it
->position
);
22333 glyph
->object
= it
->object
;
22334 glyph
->pixel_width
= it
->pixel_width
;
22335 glyph
->ascent
= it
->ascent
;
22336 glyph
->descent
= it
->descent
;
22337 glyph
->voffset
= it
->voffset
;
22338 glyph
->type
= GLYPHLESS_GLYPH
;
22339 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22340 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22341 glyph
->u
.glyphless
.len
= len
;
22342 glyph
->u
.glyphless
.ch
= it
->c
;
22343 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22344 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22345 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22346 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22347 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22348 glyph
->multibyte_p
= it
->multibyte_p
;
22349 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22350 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22351 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22352 || it
->phys_descent
> it
->descent
);
22353 glyph
->padding_p
= 0;
22354 glyph
->glyph_not_available_p
= 0;
22355 glyph
->face_id
= face_id
;
22356 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22359 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22360 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22362 glyph
->bidi_type
= it
->bidi_it
.type
;
22364 ++it
->glyph_row
->used
[area
];
22367 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22371 /* Produce a glyph for a glyphless character for iterator IT.
22372 IT->glyphless_method specifies which method to use for displaying
22373 the character. See the description of enum
22374 glyphless_display_method in dispextern.h for the detail.
22376 FOR_NO_FONT is nonzero if and only if this is for a character for
22377 which no font was found. ACRONYM, if non-nil, is an acronym string
22378 for the character. */
22381 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22386 int base_width
, base_height
, width
, height
;
22387 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22390 /* Get the metrics of the base font. We always refer to the current
22392 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22393 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22394 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22395 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22396 base_height
= it
->ascent
+ it
->descent
;
22397 base_width
= font
->average_width
;
22399 /* Get a face ID for the glyph by utilizing a cache (the same way as
22400 doen for `escape-glyph' in get_next_display_element). */
22401 if (it
->f
== last_glyphless_glyph_frame
22402 && it
->face_id
== last_glyphless_glyph_face_id
)
22404 face_id
= last_glyphless_glyph_merged_face_id
;
22408 /* Merge the `glyphless-char' face into the current face. */
22409 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22410 last_glyphless_glyph_frame
= it
->f
;
22411 last_glyphless_glyph_face_id
= it
->face_id
;
22412 last_glyphless_glyph_merged_face_id
= face_id
;
22415 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22417 it
->pixel_width
= THIN_SPACE_WIDTH
;
22419 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22421 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22423 width
= CHAR_WIDTH (it
->c
);
22426 else if (width
> 4)
22428 it
->pixel_width
= base_width
* width
;
22430 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22436 unsigned int code
[6];
22438 int ascent
, descent
;
22439 struct font_metrics metrics_upper
, metrics_lower
;
22441 face
= FACE_FROM_ID (it
->f
, face_id
);
22442 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22443 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22445 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22447 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22448 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22449 if (CONSP (acronym
))
22450 acronym
= XCAR (acronym
);
22451 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22455 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22456 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22459 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22460 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22461 upper_len
= (len
+ 1) / 2;
22462 font
->driver
->text_extents (font
, code
, upper_len
,
22464 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22469 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22470 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22471 upper_xoff
= upper_yoff
= 2; /* the typical case */
22472 if (base_width
>= width
)
22474 /* Align the upper to the left, the lower to the right. */
22475 it
->pixel_width
= base_width
;
22476 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22480 /* Center the shorter one. */
22481 it
->pixel_width
= width
;
22482 if (metrics_upper
.width
>= metrics_lower
.width
)
22483 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22486 /* FIXME: This code doesn't look right. It formerly was
22487 missing the "lower_xoff = 0;", which couldn't have
22488 been right since it left lower_xoff uninitialized. */
22490 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22494 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22495 top, bottom, and between upper and lower strings. */
22496 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22497 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22498 /* Center vertically.
22499 H:base_height, D:base_descent
22500 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22502 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22503 descent = D - H/2 + h/2;
22504 lower_yoff = descent - 2 - ld;
22505 upper_yoff = lower_yoff - la - 1 - ud; */
22506 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22507 descent
= it
->descent
- (base_height
- height
) / 2;
22508 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22509 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22510 - metrics_upper
.descent
);
22511 /* Don't make the height shorter than the base height. */
22512 if (height
> base_height
)
22514 it
->ascent
= ascent
;
22515 it
->descent
= descent
;
22519 it
->phys_ascent
= it
->ascent
;
22520 it
->phys_descent
= it
->descent
;
22522 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22523 upper_xoff
, upper_yoff
,
22524 lower_xoff
, lower_yoff
);
22526 take_vertical_position_into_account (it
);
22531 Produce glyphs/get display metrics for the display element IT is
22532 loaded with. See the description of struct it in dispextern.h
22533 for an overview of struct it. */
22536 x_produce_glyphs (struct it
*it
)
22538 int extra_line_spacing
= it
->extra_line_spacing
;
22540 it
->glyph_not_available_p
= 0;
22542 if (it
->what
== IT_CHARACTER
)
22545 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22546 struct font
*font
= face
->font
;
22547 struct font_metrics
*pcm
= NULL
;
22548 int boff
; /* baseline offset */
22552 /* When no suitable font is found, display this character by
22553 the method specified in the first extra slot of
22554 Vglyphless_char_display. */
22555 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22557 xassert (it
->what
== IT_GLYPHLESS
);
22558 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22562 boff
= font
->baseline_offset
;
22563 if (font
->vertical_centering
)
22564 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22566 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22572 if (it
->override_ascent
>= 0)
22574 it
->ascent
= it
->override_ascent
;
22575 it
->descent
= it
->override_descent
;
22576 boff
= it
->override_boff
;
22580 it
->ascent
= FONT_BASE (font
) + boff
;
22581 it
->descent
= FONT_DESCENT (font
) - boff
;
22584 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22586 pcm
= get_per_char_metric (font
, &char2b
);
22587 if (pcm
->width
== 0
22588 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22594 it
->phys_ascent
= pcm
->ascent
+ boff
;
22595 it
->phys_descent
= pcm
->descent
- boff
;
22596 it
->pixel_width
= pcm
->width
;
22600 it
->glyph_not_available_p
= 1;
22601 it
->phys_ascent
= it
->ascent
;
22602 it
->phys_descent
= it
->descent
;
22603 it
->pixel_width
= font
->space_width
;
22606 if (it
->constrain_row_ascent_descent_p
)
22608 if (it
->descent
> it
->max_descent
)
22610 it
->ascent
+= it
->descent
- it
->max_descent
;
22611 it
->descent
= it
->max_descent
;
22613 if (it
->ascent
> it
->max_ascent
)
22615 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22616 it
->ascent
= it
->max_ascent
;
22618 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22619 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22620 extra_line_spacing
= 0;
22623 /* If this is a space inside a region of text with
22624 `space-width' property, change its width. */
22625 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22627 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22629 /* If face has a box, add the box thickness to the character
22630 height. If character has a box line to the left and/or
22631 right, add the box line width to the character's width. */
22632 if (face
->box
!= FACE_NO_BOX
)
22634 int thick
= face
->box_line_width
;
22638 it
->ascent
+= thick
;
22639 it
->descent
+= thick
;
22644 if (it
->start_of_box_run_p
)
22645 it
->pixel_width
+= thick
;
22646 if (it
->end_of_box_run_p
)
22647 it
->pixel_width
+= thick
;
22650 /* If face has an overline, add the height of the overline
22651 (1 pixel) and a 1 pixel margin to the character height. */
22652 if (face
->overline_p
)
22653 it
->ascent
+= overline_margin
;
22655 if (it
->constrain_row_ascent_descent_p
)
22657 if (it
->ascent
> it
->max_ascent
)
22658 it
->ascent
= it
->max_ascent
;
22659 if (it
->descent
> it
->max_descent
)
22660 it
->descent
= it
->max_descent
;
22663 take_vertical_position_into_account (it
);
22665 /* If we have to actually produce glyphs, do it. */
22670 /* Translate a space with a `space-width' property
22671 into a stretch glyph. */
22672 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22673 / FONT_HEIGHT (font
));
22674 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22675 it
->ascent
+ it
->descent
, ascent
);
22680 /* If characters with lbearing or rbearing are displayed
22681 in this line, record that fact in a flag of the
22682 glyph row. This is used to optimize X output code. */
22683 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22684 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22686 if (! stretched_p
&& it
->pixel_width
== 0)
22687 /* We assure that all visible glyphs have at least 1-pixel
22689 it
->pixel_width
= 1;
22691 else if (it
->char_to_display
== '\n')
22693 /* A newline has no width, but we need the height of the
22694 line. But if previous part of the line sets a height,
22695 don't increase that height */
22697 Lisp_Object height
;
22698 Lisp_Object total_height
= Qnil
;
22700 it
->override_ascent
= -1;
22701 it
->pixel_width
= 0;
22704 height
= get_it_property (it
, Qline_height
);
22705 /* Split (line-height total-height) list */
22707 && CONSP (XCDR (height
))
22708 && NILP (XCDR (XCDR (height
))))
22710 total_height
= XCAR (XCDR (height
));
22711 height
= XCAR (height
);
22713 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22715 if (it
->override_ascent
>= 0)
22717 it
->ascent
= it
->override_ascent
;
22718 it
->descent
= it
->override_descent
;
22719 boff
= it
->override_boff
;
22723 it
->ascent
= FONT_BASE (font
) + boff
;
22724 it
->descent
= FONT_DESCENT (font
) - boff
;
22727 if (EQ (height
, Qt
))
22729 if (it
->descent
> it
->max_descent
)
22731 it
->ascent
+= it
->descent
- it
->max_descent
;
22732 it
->descent
= it
->max_descent
;
22734 if (it
->ascent
> it
->max_ascent
)
22736 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22737 it
->ascent
= it
->max_ascent
;
22739 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22740 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22741 it
->constrain_row_ascent_descent_p
= 1;
22742 extra_line_spacing
= 0;
22746 Lisp_Object spacing
;
22748 it
->phys_ascent
= it
->ascent
;
22749 it
->phys_descent
= it
->descent
;
22751 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22752 && face
->box
!= FACE_NO_BOX
22753 && face
->box_line_width
> 0)
22755 it
->ascent
+= face
->box_line_width
;
22756 it
->descent
+= face
->box_line_width
;
22759 && XINT (height
) > it
->ascent
+ it
->descent
)
22760 it
->ascent
= XINT (height
) - it
->descent
;
22762 if (!NILP (total_height
))
22763 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22766 spacing
= get_it_property (it
, Qline_spacing
);
22767 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22769 if (INTEGERP (spacing
))
22771 extra_line_spacing
= XINT (spacing
);
22772 if (!NILP (total_height
))
22773 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22777 else /* i.e. (it->char_to_display == '\t') */
22779 if (font
->space_width
> 0)
22781 int tab_width
= it
->tab_width
* font
->space_width
;
22782 int x
= it
->current_x
+ it
->continuation_lines_width
;
22783 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22785 /* If the distance from the current position to the next tab
22786 stop is less than a space character width, use the
22787 tab stop after that. */
22788 if (next_tab_x
- x
< font
->space_width
)
22789 next_tab_x
+= tab_width
;
22791 it
->pixel_width
= next_tab_x
- x
;
22793 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22794 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22798 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22799 it
->ascent
+ it
->descent
, it
->ascent
);
22804 it
->pixel_width
= 0;
22809 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22811 /* A static composition.
22813 Note: A composition is represented as one glyph in the
22814 glyph matrix. There are no padding glyphs.
22816 Important note: pixel_width, ascent, and descent are the
22817 values of what is drawn by draw_glyphs (i.e. the values of
22818 the overall glyphs composed). */
22819 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22820 int boff
; /* baseline offset */
22821 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22822 int glyph_len
= cmp
->glyph_len
;
22823 struct font
*font
= face
->font
;
22827 /* If we have not yet calculated pixel size data of glyphs of
22828 the composition for the current face font, calculate them
22829 now. Theoretically, we have to check all fonts for the
22830 glyphs, but that requires much time and memory space. So,
22831 here we check only the font of the first glyph. This may
22832 lead to incorrect display, but it's very rare, and C-l
22833 (recenter-top-bottom) can correct the display anyway. */
22834 if (! cmp
->font
|| cmp
->font
!= font
)
22836 /* Ascent and descent of the font of the first character
22837 of this composition (adjusted by baseline offset).
22838 Ascent and descent of overall glyphs should not be less
22839 than these, respectively. */
22840 int font_ascent
, font_descent
, font_height
;
22841 /* Bounding box of the overall glyphs. */
22842 int leftmost
, rightmost
, lowest
, highest
;
22843 int lbearing
, rbearing
;
22844 int i
, width
, ascent
, descent
;
22845 int left_padded
= 0, right_padded
= 0;
22846 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
22848 struct font_metrics
*pcm
;
22849 int font_not_found_p
;
22852 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22853 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22855 if (glyph_len
< cmp
->glyph_len
)
22857 for (i
= 0; i
< glyph_len
; i
++)
22859 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22861 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22866 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22867 : IT_CHARPOS (*it
));
22868 /* If no suitable font is found, use the default font. */
22869 font_not_found_p
= font
== NULL
;
22870 if (font_not_found_p
)
22872 face
= face
->ascii_face
;
22875 boff
= font
->baseline_offset
;
22876 if (font
->vertical_centering
)
22877 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22878 font_ascent
= FONT_BASE (font
) + boff
;
22879 font_descent
= FONT_DESCENT (font
) - boff
;
22880 font_height
= FONT_HEIGHT (font
);
22882 cmp
->font
= (void *) font
;
22885 if (! font_not_found_p
)
22887 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22889 pcm
= get_per_char_metric (font
, &char2b
);
22892 /* Initialize the bounding box. */
22895 width
= pcm
->width
;
22896 ascent
= pcm
->ascent
;
22897 descent
= pcm
->descent
;
22898 lbearing
= pcm
->lbearing
;
22899 rbearing
= pcm
->rbearing
;
22903 width
= font
->space_width
;
22904 ascent
= FONT_BASE (font
);
22905 descent
= FONT_DESCENT (font
);
22912 lowest
= - descent
+ boff
;
22913 highest
= ascent
+ boff
;
22915 if (! font_not_found_p
22916 && font
->default_ascent
22917 && CHAR_TABLE_P (Vuse_default_ascent
)
22918 && !NILP (Faref (Vuse_default_ascent
,
22919 make_number (it
->char_to_display
))))
22920 highest
= font
->default_ascent
+ boff
;
22922 /* Draw the first glyph at the normal position. It may be
22923 shifted to right later if some other glyphs are drawn
22925 cmp
->offsets
[i
* 2] = 0;
22926 cmp
->offsets
[i
* 2 + 1] = boff
;
22927 cmp
->lbearing
= lbearing
;
22928 cmp
->rbearing
= rbearing
;
22930 /* Set cmp->offsets for the remaining glyphs. */
22931 for (i
++; i
< glyph_len
; i
++)
22933 int left
, right
, btm
, top
;
22934 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22936 struct face
*this_face
;
22940 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22941 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22942 font
= this_face
->font
;
22948 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22950 pcm
= get_per_char_metric (font
, &char2b
);
22953 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22956 width
= pcm
->width
;
22957 ascent
= pcm
->ascent
;
22958 descent
= pcm
->descent
;
22959 lbearing
= pcm
->lbearing
;
22960 rbearing
= pcm
->rbearing
;
22961 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22963 /* Relative composition with or without
22964 alternate chars. */
22965 left
= (leftmost
+ rightmost
- width
) / 2;
22966 btm
= - descent
+ boff
;
22967 if (font
->relative_compose
22968 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22969 || NILP (Faref (Vignore_relative_composition
,
22970 make_number (ch
)))))
22973 if (- descent
>= font
->relative_compose
)
22974 /* One extra pixel between two glyphs. */
22976 else if (ascent
<= 0)
22977 /* One extra pixel between two glyphs. */
22978 btm
= lowest
- 1 - ascent
- descent
;
22983 /* A composition rule is specified by an integer
22984 value that encodes global and new reference
22985 points (GREF and NREF). GREF and NREF are
22986 specified by numbers as below:
22988 0---1---2 -- ascent
22992 9--10--11 -- center
22994 ---3---4---5--- baseline
22996 6---7---8 -- descent
22998 int rule
= COMPOSITION_RULE (cmp
, i
);
22999 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23001 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23002 grefx
= gref
% 3, nrefx
= nref
% 3;
23003 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23005 xoff
= font_height
* (xoff
- 128) / 256;
23007 yoff
= font_height
* (yoff
- 128) / 256;
23010 + grefx
* (rightmost
- leftmost
) / 2
23011 - nrefx
* width
/ 2
23014 btm
= ((grefy
== 0 ? highest
23016 : grefy
== 2 ? lowest
23017 : (highest
+ lowest
) / 2)
23018 - (nrefy
== 0 ? ascent
+ descent
23019 : nrefy
== 1 ? descent
- boff
23021 : (ascent
+ descent
) / 2)
23025 cmp
->offsets
[i
* 2] = left
;
23026 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23028 /* Update the bounding box of the overall glyphs. */
23031 right
= left
+ width
;
23032 if (left
< leftmost
)
23034 if (right
> rightmost
)
23037 top
= btm
+ descent
+ ascent
;
23043 if (cmp
->lbearing
> left
+ lbearing
)
23044 cmp
->lbearing
= left
+ lbearing
;
23045 if (cmp
->rbearing
< left
+ rbearing
)
23046 cmp
->rbearing
= left
+ rbearing
;
23050 /* If there are glyphs whose x-offsets are negative,
23051 shift all glyphs to the right and make all x-offsets
23055 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23056 cmp
->offsets
[i
* 2] -= leftmost
;
23057 rightmost
-= leftmost
;
23058 cmp
->lbearing
-= leftmost
;
23059 cmp
->rbearing
-= leftmost
;
23062 if (left_padded
&& cmp
->lbearing
< 0)
23064 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23065 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23066 rightmost
-= cmp
->lbearing
;
23067 cmp
->rbearing
-= cmp
->lbearing
;
23070 if (right_padded
&& rightmost
< cmp
->rbearing
)
23072 rightmost
= cmp
->rbearing
;
23075 cmp
->pixel_width
= rightmost
;
23076 cmp
->ascent
= highest
;
23077 cmp
->descent
= - lowest
;
23078 if (cmp
->ascent
< font_ascent
)
23079 cmp
->ascent
= font_ascent
;
23080 if (cmp
->descent
< font_descent
)
23081 cmp
->descent
= font_descent
;
23085 && (cmp
->lbearing
< 0
23086 || cmp
->rbearing
> cmp
->pixel_width
))
23087 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23089 it
->pixel_width
= cmp
->pixel_width
;
23090 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23091 it
->descent
= it
->phys_descent
= cmp
->descent
;
23092 if (face
->box
!= FACE_NO_BOX
)
23094 int thick
= face
->box_line_width
;
23098 it
->ascent
+= thick
;
23099 it
->descent
+= thick
;
23104 if (it
->start_of_box_run_p
)
23105 it
->pixel_width
+= thick
;
23106 if (it
->end_of_box_run_p
)
23107 it
->pixel_width
+= thick
;
23110 /* If face has an overline, add the height of the overline
23111 (1 pixel) and a 1 pixel margin to the character height. */
23112 if (face
->overline_p
)
23113 it
->ascent
+= overline_margin
;
23115 take_vertical_position_into_account (it
);
23116 if (it
->ascent
< 0)
23118 if (it
->descent
< 0)
23122 append_composite_glyph (it
);
23124 else if (it
->what
== IT_COMPOSITION
)
23126 /* A dynamic (automatic) composition. */
23127 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23128 Lisp_Object gstring
;
23129 struct font_metrics metrics
;
23131 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23133 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23136 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23137 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23138 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23139 it
->descent
= it
->phys_descent
= metrics
.descent
;
23140 if (face
->box
!= FACE_NO_BOX
)
23142 int thick
= face
->box_line_width
;
23146 it
->ascent
+= thick
;
23147 it
->descent
+= thick
;
23152 if (it
->start_of_box_run_p
)
23153 it
->pixel_width
+= thick
;
23154 if (it
->end_of_box_run_p
)
23155 it
->pixel_width
+= thick
;
23157 /* If face has an overline, add the height of the overline
23158 (1 pixel) and a 1 pixel margin to the character height. */
23159 if (face
->overline_p
)
23160 it
->ascent
+= overline_margin
;
23161 take_vertical_position_into_account (it
);
23162 if (it
->ascent
< 0)
23164 if (it
->descent
< 0)
23168 append_composite_glyph (it
);
23170 else if (it
->what
== IT_GLYPHLESS
)
23171 produce_glyphless_glyph (it
, 0, Qnil
);
23172 else if (it
->what
== IT_IMAGE
)
23173 produce_image_glyph (it
);
23174 else if (it
->what
== IT_STRETCH
)
23175 produce_stretch_glyph (it
);
23178 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23179 because this isn't true for images with `:ascent 100'. */
23180 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23181 if (it
->area
== TEXT_AREA
)
23182 it
->current_x
+= it
->pixel_width
;
23184 if (extra_line_spacing
> 0)
23186 it
->descent
+= extra_line_spacing
;
23187 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23188 it
->max_extra_line_spacing
= extra_line_spacing
;
23191 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23192 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23193 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23194 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23198 Output LEN glyphs starting at START at the nominal cursor position.
23199 Advance the nominal cursor over the text. The global variable
23200 updated_window contains the window being updated, updated_row is
23201 the glyph row being updated, and updated_area is the area of that
23202 row being updated. */
23205 x_write_glyphs (struct glyph
*start
, int len
)
23209 xassert (updated_window
&& updated_row
);
23212 /* Write glyphs. */
23214 hpos
= start
- updated_row
->glyphs
[updated_area
];
23215 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23216 updated_row
, updated_area
,
23218 DRAW_NORMAL_TEXT
, 0);
23220 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23221 if (updated_area
== TEXT_AREA
23222 && updated_window
->phys_cursor_on_p
23223 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23224 && updated_window
->phys_cursor
.hpos
>= hpos
23225 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23226 updated_window
->phys_cursor_on_p
= 0;
23230 /* Advance the output cursor. */
23231 output_cursor
.hpos
+= len
;
23232 output_cursor
.x
= x
;
23237 Insert LEN glyphs from START at the nominal cursor position. */
23240 x_insert_glyphs (struct glyph
*start
, int len
)
23244 int line_height
, shift_by_width
, shifted_region_width
;
23245 struct glyph_row
*row
;
23246 struct glyph
*glyph
;
23247 int frame_x
, frame_y
;
23250 xassert (updated_window
&& updated_row
);
23252 w
= updated_window
;
23253 f
= XFRAME (WINDOW_FRAME (w
));
23255 /* Get the height of the line we are in. */
23257 line_height
= row
->height
;
23259 /* Get the width of the glyphs to insert. */
23260 shift_by_width
= 0;
23261 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23262 shift_by_width
+= glyph
->pixel_width
;
23264 /* Get the width of the region to shift right. */
23265 shifted_region_width
= (window_box_width (w
, updated_area
)
23270 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23271 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23273 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23274 line_height
, shift_by_width
);
23276 /* Write the glyphs. */
23277 hpos
= start
- row
->glyphs
[updated_area
];
23278 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23280 DRAW_NORMAL_TEXT
, 0);
23282 /* Advance the output cursor. */
23283 output_cursor
.hpos
+= len
;
23284 output_cursor
.x
+= shift_by_width
;
23290 Erase the current text line from the nominal cursor position
23291 (inclusive) to pixel column TO_X (exclusive). The idea is that
23292 everything from TO_X onward is already erased.
23294 TO_X is a pixel position relative to updated_area of
23295 updated_window. TO_X == -1 means clear to the end of this area. */
23298 x_clear_end_of_line (int to_x
)
23301 struct window
*w
= updated_window
;
23302 int max_x
, min_y
, max_y
;
23303 int from_x
, from_y
, to_y
;
23305 xassert (updated_window
&& updated_row
);
23306 f
= XFRAME (w
->frame
);
23308 if (updated_row
->full_width_p
)
23309 max_x
= WINDOW_TOTAL_WIDTH (w
);
23311 max_x
= window_box_width (w
, updated_area
);
23312 max_y
= window_text_bottom_y (w
);
23314 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23315 of window. For TO_X > 0, truncate to end of drawing area. */
23321 to_x
= min (to_x
, max_x
);
23323 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23325 /* Notice if the cursor will be cleared by this operation. */
23326 if (!updated_row
->full_width_p
)
23327 notice_overwritten_cursor (w
, updated_area
,
23328 output_cursor
.x
, -1,
23330 MATRIX_ROW_BOTTOM_Y (updated_row
));
23332 from_x
= output_cursor
.x
;
23334 /* Translate to frame coordinates. */
23335 if (updated_row
->full_width_p
)
23337 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23338 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23342 int area_left
= window_box_left (w
, updated_area
);
23343 from_x
+= area_left
;
23347 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23348 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23349 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23351 /* Prevent inadvertently clearing to end of the X window. */
23352 if (to_x
> from_x
&& to_y
> from_y
)
23355 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23356 to_x
- from_x
, to_y
- from_y
);
23361 #endif /* HAVE_WINDOW_SYSTEM */
23365 /***********************************************************************
23367 ***********************************************************************/
23369 /* Value is the internal representation of the specified cursor type
23370 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23371 of the bar cursor. */
23373 static enum text_cursor_kinds
23374 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23376 enum text_cursor_kinds type
;
23381 if (EQ (arg
, Qbox
))
23382 return FILLED_BOX_CURSOR
;
23384 if (EQ (arg
, Qhollow
))
23385 return HOLLOW_BOX_CURSOR
;
23387 if (EQ (arg
, Qbar
))
23394 && EQ (XCAR (arg
), Qbar
)
23395 && INTEGERP (XCDR (arg
))
23396 && XINT (XCDR (arg
)) >= 0)
23398 *width
= XINT (XCDR (arg
));
23402 if (EQ (arg
, Qhbar
))
23405 return HBAR_CURSOR
;
23409 && EQ (XCAR (arg
), Qhbar
)
23410 && INTEGERP (XCDR (arg
))
23411 && XINT (XCDR (arg
)) >= 0)
23413 *width
= XINT (XCDR (arg
));
23414 return HBAR_CURSOR
;
23417 /* Treat anything unknown as "hollow box cursor".
23418 It was bad to signal an error; people have trouble fixing
23419 .Xdefaults with Emacs, when it has something bad in it. */
23420 type
= HOLLOW_BOX_CURSOR
;
23425 /* Set the default cursor types for specified frame. */
23427 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23432 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23433 FRAME_CURSOR_WIDTH (f
) = width
;
23435 /* By default, set up the blink-off state depending on the on-state. */
23437 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23440 FRAME_BLINK_OFF_CURSOR (f
)
23441 = get_specified_cursor_type (XCDR (tem
), &width
);
23442 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23445 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23449 #ifdef HAVE_WINDOW_SYSTEM
23451 /* Return the cursor we want to be displayed in window W. Return
23452 width of bar/hbar cursor through WIDTH arg. Return with
23453 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23454 (i.e. if the `system caret' should track this cursor).
23456 In a mini-buffer window, we want the cursor only to appear if we
23457 are reading input from this window. For the selected window, we
23458 want the cursor type given by the frame parameter or buffer local
23459 setting of cursor-type. If explicitly marked off, draw no cursor.
23460 In all other cases, we want a hollow box cursor. */
23462 static enum text_cursor_kinds
23463 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23464 int *active_cursor
)
23466 struct frame
*f
= XFRAME (w
->frame
);
23467 struct buffer
*b
= XBUFFER (w
->buffer
);
23468 int cursor_type
= DEFAULT_CURSOR
;
23469 Lisp_Object alt_cursor
;
23470 int non_selected
= 0;
23472 *active_cursor
= 1;
23475 if (cursor_in_echo_area
23476 && FRAME_HAS_MINIBUF_P (f
)
23477 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23479 if (w
== XWINDOW (echo_area_window
))
23481 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23483 *width
= FRAME_CURSOR_WIDTH (f
);
23484 return FRAME_DESIRED_CURSOR (f
);
23487 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23490 *active_cursor
= 0;
23494 /* Detect a nonselected window or nonselected frame. */
23495 else if (w
!= XWINDOW (f
->selected_window
)
23496 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23498 *active_cursor
= 0;
23500 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23506 /* Never display a cursor in a window in which cursor-type is nil. */
23507 if (NILP (BVAR (b
, cursor_type
)))
23510 /* Get the normal cursor type for this window. */
23511 if (EQ (BVAR (b
, cursor_type
), Qt
))
23513 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23514 *width
= FRAME_CURSOR_WIDTH (f
);
23517 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23519 /* Use cursor-in-non-selected-windows instead
23520 for non-selected window or frame. */
23523 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23524 if (!EQ (Qt
, alt_cursor
))
23525 return get_specified_cursor_type (alt_cursor
, width
);
23526 /* t means modify the normal cursor type. */
23527 if (cursor_type
== FILLED_BOX_CURSOR
)
23528 cursor_type
= HOLLOW_BOX_CURSOR
;
23529 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23531 return cursor_type
;
23534 /* Use normal cursor if not blinked off. */
23535 if (!w
->cursor_off_p
)
23537 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23539 if (cursor_type
== FILLED_BOX_CURSOR
)
23541 /* Using a block cursor on large images can be very annoying.
23542 So use a hollow cursor for "large" images.
23543 If image is not transparent (no mask), also use hollow cursor. */
23544 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23545 if (img
!= NULL
&& IMAGEP (img
->spec
))
23547 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23548 where N = size of default frame font size.
23549 This should cover most of the "tiny" icons people may use. */
23551 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23552 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23553 cursor_type
= HOLLOW_BOX_CURSOR
;
23556 else if (cursor_type
!= NO_CURSOR
)
23558 /* Display current only supports BOX and HOLLOW cursors for images.
23559 So for now, unconditionally use a HOLLOW cursor when cursor is
23560 not a solid box cursor. */
23561 cursor_type
= HOLLOW_BOX_CURSOR
;
23564 return cursor_type
;
23567 /* Cursor is blinked off, so determine how to "toggle" it. */
23569 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23570 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23571 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23573 /* Then see if frame has specified a specific blink off cursor type. */
23574 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23576 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23577 return FRAME_BLINK_OFF_CURSOR (f
);
23581 /* Some people liked having a permanently visible blinking cursor,
23582 while others had very strong opinions against it. So it was
23583 decided to remove it. KFS 2003-09-03 */
23585 /* Finally perform built-in cursor blinking:
23586 filled box <-> hollow box
23587 wide [h]bar <-> narrow [h]bar
23588 narrow [h]bar <-> no cursor
23589 other type <-> no cursor */
23591 if (cursor_type
== FILLED_BOX_CURSOR
)
23592 return HOLLOW_BOX_CURSOR
;
23594 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23597 return cursor_type
;
23605 /* Notice when the text cursor of window W has been completely
23606 overwritten by a drawing operation that outputs glyphs in AREA
23607 starting at X0 and ending at X1 in the line starting at Y0 and
23608 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23609 the rest of the line after X0 has been written. Y coordinates
23610 are window-relative. */
23613 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23614 int x0
, int x1
, int y0
, int y1
)
23616 int cx0
, cx1
, cy0
, cy1
;
23617 struct glyph_row
*row
;
23619 if (!w
->phys_cursor_on_p
)
23621 if (area
!= TEXT_AREA
)
23624 if (w
->phys_cursor
.vpos
< 0
23625 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23626 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23627 !(row
->enabled_p
&& row
->displays_text_p
)))
23630 if (row
->cursor_in_fringe_p
)
23632 row
->cursor_in_fringe_p
= 0;
23633 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23634 w
->phys_cursor_on_p
= 0;
23638 cx0
= w
->phys_cursor
.x
;
23639 cx1
= cx0
+ w
->phys_cursor_width
;
23640 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23643 /* The cursor image will be completely removed from the
23644 screen if the output area intersects the cursor area in
23645 y-direction. When we draw in [y0 y1[, and some part of
23646 the cursor is at y < y0, that part must have been drawn
23647 before. When scrolling, the cursor is erased before
23648 actually scrolling, so we don't come here. When not
23649 scrolling, the rows above the old cursor row must have
23650 changed, and in this case these rows must have written
23651 over the cursor image.
23653 Likewise if part of the cursor is below y1, with the
23654 exception of the cursor being in the first blank row at
23655 the buffer and window end because update_text_area
23656 doesn't draw that row. (Except when it does, but
23657 that's handled in update_text_area.) */
23659 cy0
= w
->phys_cursor
.y
;
23660 cy1
= cy0
+ w
->phys_cursor_height
;
23661 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23664 w
->phys_cursor_on_p
= 0;
23667 #endif /* HAVE_WINDOW_SYSTEM */
23670 /************************************************************************
23672 ************************************************************************/
23674 #ifdef HAVE_WINDOW_SYSTEM
23677 Fix the display of area AREA of overlapping row ROW in window W
23678 with respect to the overlapping part OVERLAPS. */
23681 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23682 enum glyph_row_area area
, int overlaps
)
23689 for (i
= 0; i
< row
->used
[area
];)
23691 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23693 int start
= i
, start_x
= x
;
23697 x
+= row
->glyphs
[area
][i
].pixel_width
;
23700 while (i
< row
->used
[area
]
23701 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23703 draw_glyphs (w
, start_x
, row
, area
,
23705 DRAW_NORMAL_TEXT
, overlaps
);
23709 x
+= row
->glyphs
[area
][i
].pixel_width
;
23719 Draw the cursor glyph of window W in glyph row ROW. See the
23720 comment of draw_glyphs for the meaning of HL. */
23723 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23724 enum draw_glyphs_face hl
)
23726 /* If cursor hpos is out of bounds, don't draw garbage. This can
23727 happen in mini-buffer windows when switching between echo area
23728 glyphs and mini-buffer. */
23729 if ((row
->reversed_p
23730 ? (w
->phys_cursor
.hpos
>= 0)
23731 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23733 int on_p
= w
->phys_cursor_on_p
;
23735 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23736 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23738 w
->phys_cursor_on_p
= on_p
;
23740 if (hl
== DRAW_CURSOR
)
23741 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23742 /* When we erase the cursor, and ROW is overlapped by other
23743 rows, make sure that these overlapping parts of other rows
23745 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23747 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23749 if (row
> w
->current_matrix
->rows
23750 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23751 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23752 OVERLAPS_ERASED_CURSOR
);
23754 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23755 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23756 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23757 OVERLAPS_ERASED_CURSOR
);
23764 Erase the image of a cursor of window W from the screen. */
23767 erase_phys_cursor (struct window
*w
)
23769 struct frame
*f
= XFRAME (w
->frame
);
23770 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23771 int hpos
= w
->phys_cursor
.hpos
;
23772 int vpos
= w
->phys_cursor
.vpos
;
23773 int mouse_face_here_p
= 0;
23774 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23775 struct glyph_row
*cursor_row
;
23776 struct glyph
*cursor_glyph
;
23777 enum draw_glyphs_face hl
;
23779 /* No cursor displayed or row invalidated => nothing to do on the
23781 if (w
->phys_cursor_type
== NO_CURSOR
)
23782 goto mark_cursor_off
;
23784 /* VPOS >= active_glyphs->nrows means that window has been resized.
23785 Don't bother to erase the cursor. */
23786 if (vpos
>= active_glyphs
->nrows
)
23787 goto mark_cursor_off
;
23789 /* If row containing cursor is marked invalid, there is nothing we
23791 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23792 if (!cursor_row
->enabled_p
)
23793 goto mark_cursor_off
;
23795 /* If line spacing is > 0, old cursor may only be partially visible in
23796 window after split-window. So adjust visible height. */
23797 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23798 window_text_bottom_y (w
) - cursor_row
->y
);
23800 /* If row is completely invisible, don't attempt to delete a cursor which
23801 isn't there. This can happen if cursor is at top of a window, and
23802 we switch to a buffer with a header line in that window. */
23803 if (cursor_row
->visible_height
<= 0)
23804 goto mark_cursor_off
;
23806 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23807 if (cursor_row
->cursor_in_fringe_p
)
23809 cursor_row
->cursor_in_fringe_p
= 0;
23810 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23811 goto mark_cursor_off
;
23814 /* This can happen when the new row is shorter than the old one.
23815 In this case, either draw_glyphs or clear_end_of_line
23816 should have cleared the cursor. Note that we wouldn't be
23817 able to erase the cursor in this case because we don't have a
23818 cursor glyph at hand. */
23819 if ((cursor_row
->reversed_p
23820 ? (w
->phys_cursor
.hpos
< 0)
23821 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23822 goto mark_cursor_off
;
23824 /* If the cursor is in the mouse face area, redisplay that when
23825 we clear the cursor. */
23826 if (! NILP (hlinfo
->mouse_face_window
)
23827 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23828 /* Don't redraw the cursor's spot in mouse face if it is at the
23829 end of a line (on a newline). The cursor appears there, but
23830 mouse highlighting does not. */
23831 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23832 mouse_face_here_p
= 1;
23834 /* Maybe clear the display under the cursor. */
23835 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23838 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23841 cursor_glyph
= get_phys_cursor_glyph (w
);
23842 if (cursor_glyph
== NULL
)
23843 goto mark_cursor_off
;
23845 width
= cursor_glyph
->pixel_width
;
23846 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23847 x
= w
->phys_cursor
.x
;
23849 width
-= left_x
- x
;
23850 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23851 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23852 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23855 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23858 /* Erase the cursor by redrawing the character underneath it. */
23859 if (mouse_face_here_p
)
23860 hl
= DRAW_MOUSE_FACE
;
23862 hl
= DRAW_NORMAL_TEXT
;
23863 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23866 w
->phys_cursor_on_p
= 0;
23867 w
->phys_cursor_type
= NO_CURSOR
;
23872 Display or clear cursor of window W. If ON is zero, clear the
23873 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23874 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23877 display_and_set_cursor (struct window
*w
, int on
,
23878 int hpos
, int vpos
, int x
, int y
)
23880 struct frame
*f
= XFRAME (w
->frame
);
23881 int new_cursor_type
;
23882 int new_cursor_width
;
23884 struct glyph_row
*glyph_row
;
23885 struct glyph
*glyph
;
23887 /* This is pointless on invisible frames, and dangerous on garbaged
23888 windows and frames; in the latter case, the frame or window may
23889 be in the midst of changing its size, and x and y may be off the
23891 if (! FRAME_VISIBLE_P (f
)
23892 || FRAME_GARBAGED_P (f
)
23893 || vpos
>= w
->current_matrix
->nrows
23894 || hpos
>= w
->current_matrix
->matrix_w
)
23897 /* If cursor is off and we want it off, return quickly. */
23898 if (!on
&& !w
->phys_cursor_on_p
)
23901 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23902 /* If cursor row is not enabled, we don't really know where to
23903 display the cursor. */
23904 if (!glyph_row
->enabled_p
)
23906 w
->phys_cursor_on_p
= 0;
23911 if (!glyph_row
->exact_window_width_line_p
23912 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23913 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23915 xassert (interrupt_input_blocked
);
23917 /* Set new_cursor_type to the cursor we want to be displayed. */
23918 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23919 &new_cursor_width
, &active_cursor
);
23921 /* If cursor is currently being shown and we don't want it to be or
23922 it is in the wrong place, or the cursor type is not what we want,
23924 if (w
->phys_cursor_on_p
23926 || w
->phys_cursor
.x
!= x
23927 || w
->phys_cursor
.y
!= y
23928 || new_cursor_type
!= w
->phys_cursor_type
23929 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23930 && new_cursor_width
!= w
->phys_cursor_width
)))
23931 erase_phys_cursor (w
);
23933 /* Don't check phys_cursor_on_p here because that flag is only set
23934 to zero in some cases where we know that the cursor has been
23935 completely erased, to avoid the extra work of erasing the cursor
23936 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23937 still not be visible, or it has only been partly erased. */
23940 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23941 w
->phys_cursor_height
= glyph_row
->height
;
23943 /* Set phys_cursor_.* before x_draw_.* is called because some
23944 of them may need the information. */
23945 w
->phys_cursor
.x
= x
;
23946 w
->phys_cursor
.y
= glyph_row
->y
;
23947 w
->phys_cursor
.hpos
= hpos
;
23948 w
->phys_cursor
.vpos
= vpos
;
23951 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23952 new_cursor_type
, new_cursor_width
,
23953 on
, active_cursor
);
23957 /* Switch the display of W's cursor on or off, according to the value
23961 update_window_cursor (struct window
*w
, int on
)
23963 /* Don't update cursor in windows whose frame is in the process
23964 of being deleted. */
23965 if (w
->current_matrix
)
23968 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23969 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23975 /* Call update_window_cursor with parameter ON_P on all leaf windows
23976 in the window tree rooted at W. */
23979 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23983 if (!NILP (w
->hchild
))
23984 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23985 else if (!NILP (w
->vchild
))
23986 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23988 update_window_cursor (w
, on_p
);
23990 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23996 Display the cursor on window W, or clear it, according to ON_P.
23997 Don't change the cursor's position. */
24000 x_update_cursor (struct frame
*f
, int on_p
)
24002 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24007 Clear the cursor of window W to background color, and mark the
24008 cursor as not shown. This is used when the text where the cursor
24009 is about to be rewritten. */
24012 x_clear_cursor (struct window
*w
)
24014 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24015 update_window_cursor (w
, 0);
24018 #endif /* HAVE_WINDOW_SYSTEM */
24020 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24023 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24024 int start_hpos
, int end_hpos
,
24025 enum draw_glyphs_face draw
)
24027 #ifdef HAVE_WINDOW_SYSTEM
24028 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24030 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24034 #if defined (HAVE_GPM) || defined (MSDOS)
24035 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24039 /* Display the active region described by mouse_face_* according to DRAW. */
24042 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24044 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24045 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24047 if (/* If window is in the process of being destroyed, don't bother
24049 w
->current_matrix
!= NULL
24050 /* Don't update mouse highlight if hidden */
24051 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24052 /* Recognize when we are called to operate on rows that don't exist
24053 anymore. This can happen when a window is split. */
24054 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24056 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24057 struct glyph_row
*row
, *first
, *last
;
24059 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24060 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24062 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24064 int start_hpos
, end_hpos
, start_x
;
24066 /* For all but the first row, the highlight starts at column 0. */
24069 /* R2L rows have BEG and END in reversed order, but the
24070 screen drawing geometry is always left to right. So
24071 we need to mirror the beginning and end of the
24072 highlighted area in R2L rows. */
24073 if (!row
->reversed_p
)
24075 start_hpos
= hlinfo
->mouse_face_beg_col
;
24076 start_x
= hlinfo
->mouse_face_beg_x
;
24078 else if (row
== last
)
24080 start_hpos
= hlinfo
->mouse_face_end_col
;
24081 start_x
= hlinfo
->mouse_face_end_x
;
24089 else if (row
->reversed_p
&& row
== last
)
24091 start_hpos
= hlinfo
->mouse_face_end_col
;
24092 start_x
= hlinfo
->mouse_face_end_x
;
24102 if (!row
->reversed_p
)
24103 end_hpos
= hlinfo
->mouse_face_end_col
;
24104 else if (row
== first
)
24105 end_hpos
= hlinfo
->mouse_face_beg_col
;
24108 end_hpos
= row
->used
[TEXT_AREA
];
24109 if (draw
== DRAW_NORMAL_TEXT
)
24110 row
->fill_line_p
= 1; /* Clear to end of line */
24113 else if (row
->reversed_p
&& row
== first
)
24114 end_hpos
= hlinfo
->mouse_face_beg_col
;
24117 end_hpos
= row
->used
[TEXT_AREA
];
24118 if (draw
== DRAW_NORMAL_TEXT
)
24119 row
->fill_line_p
= 1; /* Clear to end of line */
24122 if (end_hpos
> start_hpos
)
24124 draw_row_with_mouse_face (w
, start_x
, row
,
24125 start_hpos
, end_hpos
, draw
);
24128 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24132 #ifdef HAVE_WINDOW_SYSTEM
24133 /* When we've written over the cursor, arrange for it to
24134 be displayed again. */
24135 if (FRAME_WINDOW_P (f
)
24136 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24139 display_and_set_cursor (w
, 1,
24140 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24141 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24144 #endif /* HAVE_WINDOW_SYSTEM */
24147 #ifdef HAVE_WINDOW_SYSTEM
24148 /* Change the mouse cursor. */
24149 if (FRAME_WINDOW_P (f
))
24151 if (draw
== DRAW_NORMAL_TEXT
24152 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24153 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24154 else if (draw
== DRAW_MOUSE_FACE
)
24155 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24157 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24159 #endif /* HAVE_WINDOW_SYSTEM */
24163 Clear out the mouse-highlighted active region.
24164 Redraw it un-highlighted first. Value is non-zero if mouse
24165 face was actually drawn unhighlighted. */
24168 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24172 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24174 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24178 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24179 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24180 hlinfo
->mouse_face_window
= Qnil
;
24181 hlinfo
->mouse_face_overlay
= Qnil
;
24185 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24186 within the mouse face on that window. */
24188 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24190 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24192 /* Quickly resolve the easy cases. */
24193 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24194 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24196 if (vpos
< hlinfo
->mouse_face_beg_row
24197 || vpos
> hlinfo
->mouse_face_end_row
)
24199 if (vpos
> hlinfo
->mouse_face_beg_row
24200 && vpos
< hlinfo
->mouse_face_end_row
)
24203 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24205 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24207 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24210 else if ((vpos
== hlinfo
->mouse_face_beg_row
24211 && hpos
>= hlinfo
->mouse_face_beg_col
)
24212 || (vpos
== hlinfo
->mouse_face_end_row
24213 && hpos
< hlinfo
->mouse_face_end_col
))
24218 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24220 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24223 else if ((vpos
== hlinfo
->mouse_face_beg_row
24224 && hpos
<= hlinfo
->mouse_face_beg_col
)
24225 || (vpos
== hlinfo
->mouse_face_end_row
24226 && hpos
> hlinfo
->mouse_face_end_col
))
24234 Non-zero if physical cursor of window W is within mouse face. */
24237 cursor_in_mouse_face_p (struct window
*w
)
24239 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24244 /* Find the glyph rows START_ROW and END_ROW of window W that display
24245 characters between buffer positions START_CHARPOS and END_CHARPOS
24246 (excluding END_CHARPOS). This is similar to row_containing_pos,
24247 but is more accurate when bidi reordering makes buffer positions
24248 change non-linearly with glyph rows. */
24250 rows_from_pos_range (struct window
*w
,
24251 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24252 struct glyph_row
**start
, struct glyph_row
**end
)
24254 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24255 int last_y
= window_text_bottom_y (w
);
24256 struct glyph_row
*row
;
24261 while (!first
->enabled_p
24262 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24265 /* Find the START row. */
24267 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24270 /* A row can potentially be the START row if the range of the
24271 characters it displays intersects the range
24272 [START_CHARPOS..END_CHARPOS). */
24273 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24274 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24275 /* See the commentary in row_containing_pos, for the
24276 explanation of the complicated way to check whether
24277 some position is beyond the end of the characters
24278 displayed by a row. */
24279 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24280 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24281 && !row
->ends_at_zv_p
24282 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24283 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24284 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24285 && !row
->ends_at_zv_p
24286 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24288 /* Found a candidate row. Now make sure at least one of the
24289 glyphs it displays has a charpos from the range
24290 [START_CHARPOS..END_CHARPOS).
24292 This is not obvious because bidi reordering could make
24293 buffer positions of a row be 1,2,3,102,101,100, and if we
24294 want to highlight characters in [50..60), we don't want
24295 this row, even though [50..60) does intersect [1..103),
24296 the range of character positions given by the row's start
24297 and end positions. */
24298 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24299 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24303 if (BUFFERP (g
->object
)
24304 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24313 /* Find the END row. */
24315 /* If the last row is partially visible, start looking for END
24316 from that row, instead of starting from FIRST. */
24317 && !(row
->enabled_p
24318 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24320 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24322 struct glyph_row
*next
= row
+ 1;
24324 if (!next
->enabled_p
24325 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24326 /* The first row >= START whose range of displayed characters
24327 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24328 is the row END + 1. */
24329 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24330 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24331 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24332 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24333 && !next
->ends_at_zv_p
24334 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24335 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24336 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24337 && !next
->ends_at_zv_p
24338 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24345 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24346 but none of the characters it displays are in the range, it is
24348 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24349 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24353 if (BUFFERP (g
->object
)
24354 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24367 /* This function sets the mouse_face_* elements of HLINFO, assuming
24368 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24369 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24370 for the overlay or run of text properties specifying the mouse
24371 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24372 before-string and after-string that must also be highlighted.
24373 COVER_STRING, if non-nil, is a display string that may cover some
24374 or all of the highlighted text. */
24377 mouse_face_from_buffer_pos (Lisp_Object window
,
24378 Mouse_HLInfo
*hlinfo
,
24379 EMACS_INT mouse_charpos
,
24380 EMACS_INT start_charpos
,
24381 EMACS_INT end_charpos
,
24382 Lisp_Object before_string
,
24383 Lisp_Object after_string
,
24384 Lisp_Object cover_string
)
24386 struct window
*w
= XWINDOW (window
);
24387 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24388 struct glyph_row
*r1
, *r2
;
24389 struct glyph
*glyph
, *end
;
24390 EMACS_INT ignore
, pos
;
24393 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24394 xassert (NILP (before_string
) || STRINGP (before_string
));
24395 xassert (NILP (after_string
) || STRINGP (after_string
));
24397 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24398 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24400 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24401 /* If the before-string or display-string contains newlines,
24402 rows_from_pos_range skips to its last row. Move back. */
24403 if (!NILP (before_string
) || !NILP (cover_string
))
24405 struct glyph_row
*prev
;
24406 while ((prev
= r1
- 1, prev
>= first
)
24407 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24408 && prev
->used
[TEXT_AREA
] > 0)
24410 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24411 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24412 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24414 || !(EQ (glyph
->object
, before_string
)
24415 || EQ (glyph
->object
, cover_string
)))
24422 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24423 hlinfo
->mouse_face_past_end
= 1;
24425 else if (!NILP (after_string
))
24427 /* If the after-string has newlines, advance to its last row. */
24428 struct glyph_row
*next
;
24429 struct glyph_row
*last
24430 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24432 for (next
= r2
+ 1;
24434 && next
->used
[TEXT_AREA
] > 0
24435 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24439 /* The rest of the display engine assumes that mouse_face_beg_row is
24440 either above below mouse_face_end_row or identical to it. But
24441 with bidi-reordered continued lines, the row for START_CHARPOS
24442 could be below the row for END_CHARPOS. If so, swap the rows and
24443 store them in correct order. */
24446 struct glyph_row
*tem
= r2
;
24452 hlinfo
->mouse_face_beg_y
= r1
->y
;
24453 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24454 hlinfo
->mouse_face_end_y
= r2
->y
;
24455 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24457 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24458 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24459 could be anywhere in the row and in any order. The strategy
24460 below is to find the leftmost and the rightmost glyph that
24461 belongs to either of these 3 strings, or whose position is
24462 between START_CHARPOS and END_CHARPOS, and highlight all the
24463 glyphs between those two. This may cover more than just the text
24464 between START_CHARPOS and END_CHARPOS if the range of characters
24465 strides the bidi level boundary, e.g. if the beginning is in R2L
24466 text while the end is in L2R text or vice versa. */
24467 if (!r1
->reversed_p
)
24469 /* This row is in a left to right paragraph. Scan it left to
24471 glyph
= r1
->glyphs
[TEXT_AREA
];
24472 end
= glyph
+ r1
->used
[TEXT_AREA
];
24475 /* Skip truncation glyphs at the start of the glyph row. */
24476 if (r1
->displays_text_p
)
24478 && INTEGERP (glyph
->object
)
24479 && glyph
->charpos
< 0;
24481 x
+= glyph
->pixel_width
;
24483 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24484 or COVER_STRING, and the first glyph from buffer whose
24485 position is between START_CHARPOS and END_CHARPOS. */
24487 && !INTEGERP (glyph
->object
)
24488 && !EQ (glyph
->object
, cover_string
)
24489 && !(BUFFERP (glyph
->object
)
24490 && (glyph
->charpos
>= start_charpos
24491 && glyph
->charpos
< end_charpos
));
24494 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24495 are present at buffer positions between START_CHARPOS and
24496 END_CHARPOS, or if they come from an overlay. */
24497 if (EQ (glyph
->object
, before_string
))
24499 pos
= string_buffer_position (before_string
,
24501 /* If pos == 0, it means before_string came from an
24502 overlay, not from a buffer position. */
24503 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24506 else if (EQ (glyph
->object
, after_string
))
24508 pos
= string_buffer_position (after_string
, end_charpos
);
24509 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24512 x
+= glyph
->pixel_width
;
24514 hlinfo
->mouse_face_beg_x
= x
;
24515 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24519 /* This row is in a right to left paragraph. Scan it right to
24523 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24524 glyph
= end
+ r1
->used
[TEXT_AREA
];
24526 /* Skip truncation glyphs at the start of the glyph row. */
24527 if (r1
->displays_text_p
)
24529 && INTEGERP (glyph
->object
)
24530 && glyph
->charpos
< 0;
24534 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24535 or COVER_STRING, and the first glyph from buffer whose
24536 position is between START_CHARPOS and END_CHARPOS. */
24538 && !INTEGERP (glyph
->object
)
24539 && !EQ (glyph
->object
, cover_string
)
24540 && !(BUFFERP (glyph
->object
)
24541 && (glyph
->charpos
>= start_charpos
24542 && glyph
->charpos
< end_charpos
));
24545 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24546 are present at buffer positions between START_CHARPOS and
24547 END_CHARPOS, or if they come from an overlay. */
24548 if (EQ (glyph
->object
, before_string
))
24550 pos
= string_buffer_position (before_string
, start_charpos
);
24551 /* If pos == 0, it means before_string came from an
24552 overlay, not from a buffer position. */
24553 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24556 else if (EQ (glyph
->object
, after_string
))
24558 pos
= string_buffer_position (after_string
, end_charpos
);
24559 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24564 glyph
++; /* first glyph to the right of the highlighted area */
24565 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24566 x
+= g
->pixel_width
;
24567 hlinfo
->mouse_face_beg_x
= x
;
24568 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24571 /* If the highlight ends in a different row, compute GLYPH and END
24572 for the end row. Otherwise, reuse the values computed above for
24573 the row where the highlight begins. */
24576 if (!r2
->reversed_p
)
24578 glyph
= r2
->glyphs
[TEXT_AREA
];
24579 end
= glyph
+ r2
->used
[TEXT_AREA
];
24584 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24585 glyph
= end
+ r2
->used
[TEXT_AREA
];
24589 if (!r2
->reversed_p
)
24591 /* Skip truncation and continuation glyphs near the end of the
24592 row, and also blanks and stretch glyphs inserted by
24593 extend_face_to_end_of_line. */
24595 && INTEGERP ((end
- 1)->object
)
24596 && (end
- 1)->charpos
<= 0)
24598 /* Scan the rest of the glyph row from the end, looking for the
24599 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24600 COVER_STRING, or whose position is between START_CHARPOS
24604 && !INTEGERP (end
->object
)
24605 && !EQ (end
->object
, cover_string
)
24606 && !(BUFFERP (end
->object
)
24607 && (end
->charpos
>= start_charpos
24608 && end
->charpos
< end_charpos
));
24611 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24612 are present at buffer positions between START_CHARPOS and
24613 END_CHARPOS, or if they come from an overlay. */
24614 if (EQ (end
->object
, before_string
))
24616 pos
= string_buffer_position (before_string
, start_charpos
);
24617 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24620 else if (EQ (end
->object
, after_string
))
24622 pos
= string_buffer_position (after_string
, end_charpos
);
24623 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24627 /* Find the X coordinate of the last glyph to be highlighted. */
24628 for (; glyph
<= end
; ++glyph
)
24629 x
+= glyph
->pixel_width
;
24631 hlinfo
->mouse_face_end_x
= x
;
24632 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24636 /* Skip truncation and continuation glyphs near the end of the
24637 row, and also blanks and stretch glyphs inserted by
24638 extend_face_to_end_of_line. */
24642 && INTEGERP (end
->object
)
24643 && end
->charpos
<= 0)
24645 x
+= end
->pixel_width
;
24648 /* Scan the rest of the glyph row from the end, looking for the
24649 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24650 COVER_STRING, or whose position is between START_CHARPOS
24654 && !INTEGERP (end
->object
)
24655 && !EQ (end
->object
, cover_string
)
24656 && !(BUFFERP (end
->object
)
24657 && (end
->charpos
>= start_charpos
24658 && end
->charpos
< end_charpos
));
24661 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24662 are present at buffer positions between START_CHARPOS and
24663 END_CHARPOS, or if they come from an overlay. */
24664 if (EQ (end
->object
, before_string
))
24666 pos
= string_buffer_position (before_string
, start_charpos
);
24667 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24670 else if (EQ (end
->object
, after_string
))
24672 pos
= string_buffer_position (after_string
, end_charpos
);
24673 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24676 x
+= end
->pixel_width
;
24678 hlinfo
->mouse_face_end_x
= x
;
24679 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24682 hlinfo
->mouse_face_window
= window
;
24683 hlinfo
->mouse_face_face_id
24684 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24686 !hlinfo
->mouse_face_hidden
, -1);
24687 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24690 /* The following function is not used anymore (replaced with
24691 mouse_face_from_string_pos), but I leave it here for the time
24692 being, in case someone would. */
24694 #if 0 /* not used */
24696 /* Find the position of the glyph for position POS in OBJECT in
24697 window W's current matrix, and return in *X, *Y the pixel
24698 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24700 RIGHT_P non-zero means return the position of the right edge of the
24701 glyph, RIGHT_P zero means return the left edge position.
24703 If no glyph for POS exists in the matrix, return the position of
24704 the glyph with the next smaller position that is in the matrix, if
24705 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24706 exists in the matrix, return the position of the glyph with the
24707 next larger position in OBJECT.
24709 Value is non-zero if a glyph was found. */
24712 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24713 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24715 int yb
= window_text_bottom_y (w
);
24716 struct glyph_row
*r
;
24717 struct glyph
*best_glyph
= NULL
;
24718 struct glyph_row
*best_row
= NULL
;
24721 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24722 r
->enabled_p
&& r
->y
< yb
;
24725 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24726 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24729 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24730 if (EQ (g
->object
, object
))
24732 if (g
->charpos
== pos
)
24739 else if (best_glyph
== NULL
24740 || ((eabs (g
->charpos
- pos
)
24741 < eabs (best_glyph
->charpos
- pos
))
24744 : g
->charpos
> pos
)))
24758 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24762 *x
+= best_glyph
->pixel_width
;
24767 *vpos
= best_row
- w
->current_matrix
->rows
;
24770 return best_glyph
!= NULL
;
24772 #endif /* not used */
24774 /* Find the positions of the first and the last glyphs in window W's
24775 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24776 (assumed to be a string), and return in HLINFO's mouse_face_*
24777 members the pixel and column/row coordinates of those glyphs. */
24780 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24781 Lisp_Object object
,
24782 EMACS_INT startpos
, EMACS_INT endpos
)
24784 int yb
= window_text_bottom_y (w
);
24785 struct glyph_row
*r
;
24786 struct glyph
*g
, *e
;
24790 /* Find the glyph row with at least one position in the range
24791 [STARTPOS..ENDPOS], and the first glyph in that row whose
24792 position belongs to that range. */
24793 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24794 r
->enabled_p
&& r
->y
< yb
;
24797 if (!r
->reversed_p
)
24799 g
= r
->glyphs
[TEXT_AREA
];
24800 e
= g
+ r
->used
[TEXT_AREA
];
24801 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24802 if (EQ (g
->object
, object
)
24803 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24805 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24806 hlinfo
->mouse_face_beg_y
= r
->y
;
24807 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24808 hlinfo
->mouse_face_beg_x
= gx
;
24817 e
= r
->glyphs
[TEXT_AREA
];
24818 g
= e
+ r
->used
[TEXT_AREA
];
24819 for ( ; g
> e
; --g
)
24820 if (EQ ((g
-1)->object
, object
)
24821 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24823 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24824 hlinfo
->mouse_face_beg_y
= r
->y
;
24825 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24826 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24827 gx
+= g1
->pixel_width
;
24828 hlinfo
->mouse_face_beg_x
= gx
;
24840 /* Starting with the next row, look for the first row which does NOT
24841 include any glyphs whose positions are in the range. */
24842 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24844 g
= r
->glyphs
[TEXT_AREA
];
24845 e
= g
+ r
->used
[TEXT_AREA
];
24847 for ( ; g
< e
; ++g
)
24848 if (EQ (g
->object
, object
)
24849 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24858 /* The highlighted region ends on the previous row. */
24861 /* Set the end row and its vertical pixel coordinate. */
24862 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24863 hlinfo
->mouse_face_end_y
= r
->y
;
24865 /* Compute and set the end column and the end column's horizontal
24866 pixel coordinate. */
24867 if (!r
->reversed_p
)
24869 g
= r
->glyphs
[TEXT_AREA
];
24870 e
= g
+ r
->used
[TEXT_AREA
];
24871 for ( ; e
> g
; --e
)
24872 if (EQ ((e
-1)->object
, object
)
24873 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24875 hlinfo
->mouse_face_end_col
= e
- g
;
24877 for (gx
= r
->x
; g
< e
; ++g
)
24878 gx
+= g
->pixel_width
;
24879 hlinfo
->mouse_face_end_x
= gx
;
24883 e
= r
->glyphs
[TEXT_AREA
];
24884 g
= e
+ r
->used
[TEXT_AREA
];
24885 for (gx
= r
->x
; e
< g
; ++e
)
24887 if (EQ (e
->object
, object
)
24888 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24890 gx
+= e
->pixel_width
;
24892 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24893 hlinfo
->mouse_face_end_x
= gx
;
24897 #ifdef HAVE_WINDOW_SYSTEM
24899 /* See if position X, Y is within a hot-spot of an image. */
24902 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24904 if (!CONSP (hot_spot
))
24907 if (EQ (XCAR (hot_spot
), Qrect
))
24909 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24910 Lisp_Object rect
= XCDR (hot_spot
);
24914 if (!CONSP (XCAR (rect
)))
24916 if (!CONSP (XCDR (rect
)))
24918 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24920 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24922 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24924 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24928 else if (EQ (XCAR (hot_spot
), Qcircle
))
24930 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24931 Lisp_Object circ
= XCDR (hot_spot
);
24932 Lisp_Object lr
, lx0
, ly0
;
24934 && CONSP (XCAR (circ
))
24935 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24936 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24937 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24939 double r
= XFLOATINT (lr
);
24940 double dx
= XINT (lx0
) - x
;
24941 double dy
= XINT (ly0
) - y
;
24942 return (dx
* dx
+ dy
* dy
<= r
* r
);
24945 else if (EQ (XCAR (hot_spot
), Qpoly
))
24947 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24948 if (VECTORP (XCDR (hot_spot
)))
24950 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24951 Lisp_Object
*poly
= v
->contents
;
24952 int n
= v
->header
.size
;
24955 Lisp_Object lx
, ly
;
24958 /* Need an even number of coordinates, and at least 3 edges. */
24959 if (n
< 6 || n
& 1)
24962 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24963 If count is odd, we are inside polygon. Pixels on edges
24964 may or may not be included depending on actual geometry of the
24966 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24967 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24969 x0
= XINT (lx
), y0
= XINT (ly
);
24970 for (i
= 0; i
< n
; i
+= 2)
24972 int x1
= x0
, y1
= y0
;
24973 if ((lx
= poly
[i
], !INTEGERP (lx
))
24974 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24976 x0
= XINT (lx
), y0
= XINT (ly
);
24978 /* Does this segment cross the X line? */
24986 if (y
> y0
&& y
> y1
)
24988 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24998 find_hot_spot (Lisp_Object map
, int x
, int y
)
25000 while (CONSP (map
))
25002 if (CONSP (XCAR (map
))
25003 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25011 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25013 doc
: /* Lookup in image map MAP coordinates X and Y.
25014 An image map is an alist where each element has the format (AREA ID PLIST).
25015 An AREA is specified as either a rectangle, a circle, or a polygon:
25016 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25017 pixel coordinates of the upper left and bottom right corners.
25018 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25019 and the radius of the circle; r may be a float or integer.
25020 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25021 vector describes one corner in the polygon.
25022 Returns the alist element for the first matching AREA in MAP. */)
25023 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25031 return find_hot_spot (map
, XINT (x
), XINT (y
));
25035 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25037 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25039 /* Do not change cursor shape while dragging mouse. */
25040 if (!NILP (do_mouse_tracking
))
25043 if (!NILP (pointer
))
25045 if (EQ (pointer
, Qarrow
))
25046 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25047 else if (EQ (pointer
, Qhand
))
25048 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25049 else if (EQ (pointer
, Qtext
))
25050 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25051 else if (EQ (pointer
, intern ("hdrag")))
25052 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25053 #ifdef HAVE_X_WINDOWS
25054 else if (EQ (pointer
, intern ("vdrag")))
25055 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25057 else if (EQ (pointer
, intern ("hourglass")))
25058 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25059 else if (EQ (pointer
, Qmodeline
))
25060 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25062 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25065 if (cursor
!= No_Cursor
)
25066 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25069 #endif /* HAVE_WINDOW_SYSTEM */
25071 /* Take proper action when mouse has moved to the mode or header line
25072 or marginal area AREA of window W, x-position X and y-position Y.
25073 X is relative to the start of the text display area of W, so the
25074 width of bitmap areas and scroll bars must be subtracted to get a
25075 position relative to the start of the mode line. */
25078 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25079 enum window_part area
)
25081 struct window
*w
= XWINDOW (window
);
25082 struct frame
*f
= XFRAME (w
->frame
);
25083 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25084 #ifdef HAVE_WINDOW_SYSTEM
25085 Display_Info
*dpyinfo
;
25087 Cursor cursor
= No_Cursor
;
25088 Lisp_Object pointer
= Qnil
;
25089 int dx
, dy
, width
, height
;
25091 Lisp_Object string
, object
= Qnil
;
25092 Lisp_Object pos
, help
;
25094 Lisp_Object mouse_face
;
25095 int original_x_pixel
= x
;
25096 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25097 struct glyph_row
*row
;
25099 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25104 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25105 returns them in row/column units! */
25106 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25107 &object
, &dx
, &dy
, &width
, &height
);
25109 row
= (area
== ON_MODE_LINE
25110 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25111 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25113 /* Find the glyph under the mouse pointer. */
25114 if (row
->mode_line_p
&& row
->enabled_p
)
25116 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25117 end
= glyph
+ row
->used
[TEXT_AREA
];
25119 for (x0
= original_x_pixel
;
25120 glyph
< end
&& x0
>= glyph
->pixel_width
;
25122 x0
-= glyph
->pixel_width
;
25130 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25131 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25132 returns them in row/column units! */
25133 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25134 &object
, &dx
, &dy
, &width
, &height
);
25139 #ifdef HAVE_WINDOW_SYSTEM
25140 if (IMAGEP (object
))
25142 Lisp_Object image_map
, hotspot
;
25143 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25145 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25147 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25151 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25152 If so, we could look for mouse-enter, mouse-leave
25153 properties in PLIST (and do something...). */
25154 hotspot
= XCDR (hotspot
);
25155 if (CONSP (hotspot
)
25156 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25158 pointer
= Fplist_get (plist
, Qpointer
);
25159 if (NILP (pointer
))
25161 help
= Fplist_get (plist
, Qhelp_echo
);
25164 help_echo_string
= help
;
25165 /* Is this correct? ++kfs */
25166 XSETWINDOW (help_echo_window
, w
);
25167 help_echo_object
= w
->buffer
;
25168 help_echo_pos
= charpos
;
25172 if (NILP (pointer
))
25173 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25175 #endif /* HAVE_WINDOW_SYSTEM */
25177 if (STRINGP (string
))
25179 pos
= make_number (charpos
);
25180 /* If we're on a string with `help-echo' text property, arrange
25181 for the help to be displayed. This is done by setting the
25182 global variable help_echo_string to the help string. */
25185 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25188 help_echo_string
= help
;
25189 XSETWINDOW (help_echo_window
, w
);
25190 help_echo_object
= string
;
25191 help_echo_pos
= charpos
;
25195 #ifdef HAVE_WINDOW_SYSTEM
25196 if (FRAME_WINDOW_P (f
))
25198 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25199 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25200 if (NILP (pointer
))
25201 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25203 /* Change the mouse pointer according to what is under X/Y. */
25205 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25208 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25209 if (!KEYMAPP (map
))
25210 map
= Fget_text_property (pos
, Qkeymap
, string
);
25211 if (!KEYMAPP (map
))
25212 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25217 /* Change the mouse face according to what is under X/Y. */
25218 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25219 if (!NILP (mouse_face
)
25220 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25225 struct glyph
* tmp_glyph
;
25229 int total_pixel_width
;
25230 EMACS_INT begpos
, endpos
, ignore
;
25234 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25235 Qmouse_face
, string
, Qnil
);
25241 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25243 endpos
= SCHARS (string
);
25247 /* Calculate the glyph position GPOS of GLYPH in the
25248 displayed string, relative to the beginning of the
25249 highlighted part of the string.
25251 Note: GPOS is different from CHARPOS. CHARPOS is the
25252 position of GLYPH in the internal string object. A mode
25253 line string format has structures which are converted to
25254 a flattened string by the Emacs Lisp interpreter. The
25255 internal string is an element of those structures. The
25256 displayed string is the flattened string. */
25257 tmp_glyph
= row_start_glyph
;
25258 while (tmp_glyph
< glyph
25259 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25260 && begpos
<= tmp_glyph
->charpos
25261 && tmp_glyph
->charpos
< endpos
)))
25263 gpos
= glyph
- tmp_glyph
;
25265 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25266 the highlighted part of the displayed string to which
25267 GLYPH belongs. Note: GSEQ_LENGTH is different from
25268 SCHARS (STRING), because the latter returns the length of
25269 the internal string. */
25270 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25272 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25273 && begpos
<= tmp_glyph
->charpos
25274 && tmp_glyph
->charpos
< endpos
));
25277 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25279 /* Calculate the total pixel width of all the glyphs between
25280 the beginning of the highlighted area and GLYPH. */
25281 total_pixel_width
= 0;
25282 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25283 total_pixel_width
+= tmp_glyph
->pixel_width
;
25285 /* Pre calculation of re-rendering position. Note: X is in
25286 column units here, after the call to mode_line_string or
25287 marginal_area_string. */
25289 vpos
= (area
== ON_MODE_LINE
25290 ? (w
->current_matrix
)->nrows
- 1
25293 /* If GLYPH's position is included in the region that is
25294 already drawn in mouse face, we have nothing to do. */
25295 if ( EQ (window
, hlinfo
->mouse_face_window
)
25296 && (!row
->reversed_p
25297 ? (hlinfo
->mouse_face_beg_col
<= hpos
25298 && hpos
< hlinfo
->mouse_face_end_col
)
25299 /* In R2L rows we swap BEG and END, see below. */
25300 : (hlinfo
->mouse_face_end_col
<= hpos
25301 && hpos
< hlinfo
->mouse_face_beg_col
))
25302 && hlinfo
->mouse_face_beg_row
== vpos
)
25305 if (clear_mouse_face (hlinfo
))
25306 cursor
= No_Cursor
;
25308 if (!row
->reversed_p
)
25310 hlinfo
->mouse_face_beg_col
= hpos
;
25311 hlinfo
->mouse_face_beg_x
= original_x_pixel
25312 - (total_pixel_width
+ dx
);
25313 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25314 hlinfo
->mouse_face_end_x
= 0;
25318 /* In R2L rows, show_mouse_face expects BEG and END
25319 coordinates to be swapped. */
25320 hlinfo
->mouse_face_end_col
= hpos
;
25321 hlinfo
->mouse_face_end_x
= original_x_pixel
25322 - (total_pixel_width
+ dx
);
25323 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25324 hlinfo
->mouse_face_beg_x
= 0;
25327 hlinfo
->mouse_face_beg_row
= vpos
;
25328 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25329 hlinfo
->mouse_face_beg_y
= 0;
25330 hlinfo
->mouse_face_end_y
= 0;
25331 hlinfo
->mouse_face_past_end
= 0;
25332 hlinfo
->mouse_face_window
= window
;
25334 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25340 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25342 if (NILP (pointer
))
25345 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25346 clear_mouse_face (hlinfo
);
25348 #ifdef HAVE_WINDOW_SYSTEM
25349 if (FRAME_WINDOW_P (f
))
25350 define_frame_cursor1 (f
, cursor
, pointer
);
25356 Take proper action when the mouse has moved to position X, Y on
25357 frame F as regards highlighting characters that have mouse-face
25358 properties. Also de-highlighting chars where the mouse was before.
25359 X and Y can be negative or out of range. */
25362 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25364 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25365 enum window_part part
;
25366 Lisp_Object window
;
25368 Cursor cursor
= No_Cursor
;
25369 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25372 /* When a menu is active, don't highlight because this looks odd. */
25373 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25374 if (popup_activated ())
25378 if (NILP (Vmouse_highlight
)
25379 || !f
->glyphs_initialized_p
25380 || f
->pointer_invisible
)
25383 hlinfo
->mouse_face_mouse_x
= x
;
25384 hlinfo
->mouse_face_mouse_y
= y
;
25385 hlinfo
->mouse_face_mouse_frame
= f
;
25387 if (hlinfo
->mouse_face_defer
)
25390 if (gc_in_progress
)
25392 hlinfo
->mouse_face_deferred_gc
= 1;
25396 /* Which window is that in? */
25397 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25399 /* If we were displaying active text in another window, clear that.
25400 Also clear if we move out of text area in same window. */
25401 if (! EQ (window
, hlinfo
->mouse_face_window
)
25402 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25403 && !NILP (hlinfo
->mouse_face_window
)))
25404 clear_mouse_face (hlinfo
);
25406 /* Not on a window -> return. */
25407 if (!WINDOWP (window
))
25410 /* Reset help_echo_string. It will get recomputed below. */
25411 help_echo_string
= Qnil
;
25413 /* Convert to window-relative pixel coordinates. */
25414 w
= XWINDOW (window
);
25415 frame_to_window_pixel_xy (w
, &x
, &y
);
25417 #ifdef HAVE_WINDOW_SYSTEM
25418 /* Handle tool-bar window differently since it doesn't display a
25420 if (EQ (window
, f
->tool_bar_window
))
25422 note_tool_bar_highlight (f
, x
, y
);
25427 /* Mouse is on the mode, header line or margin? */
25428 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25429 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25431 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25435 #ifdef HAVE_WINDOW_SYSTEM
25436 if (part
== ON_VERTICAL_BORDER
)
25438 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25439 help_echo_string
= build_string ("drag-mouse-1: resize");
25441 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25442 || part
== ON_SCROLL_BAR
)
25443 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25445 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25448 /* Are we in a window whose display is up to date?
25449 And verify the buffer's text has not changed. */
25450 b
= XBUFFER (w
->buffer
);
25451 if (part
== ON_TEXT
25452 && EQ (w
->window_end_valid
, w
->buffer
)
25453 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25454 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25456 int hpos
, vpos
, i
, dx
, dy
, area
;
25458 struct glyph
*glyph
;
25459 Lisp_Object object
;
25460 Lisp_Object mouse_face
= Qnil
, position
;
25461 Lisp_Object
*overlay_vec
= NULL
;
25463 struct buffer
*obuf
;
25464 EMACS_INT obegv
, ozv
;
25467 /* Find the glyph under X/Y. */
25468 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25470 #ifdef HAVE_WINDOW_SYSTEM
25471 /* Look for :pointer property on image. */
25472 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25474 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25475 if (img
!= NULL
&& IMAGEP (img
->spec
))
25477 Lisp_Object image_map
, hotspot
;
25478 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25480 && (hotspot
= find_hot_spot (image_map
,
25481 glyph
->slice
.img
.x
+ dx
,
25482 glyph
->slice
.img
.y
+ dy
),
25484 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25488 /* Could check XCAR (hotspot) to see if we enter/leave
25490 If so, we could look for mouse-enter, mouse-leave
25491 properties in PLIST (and do something...). */
25492 hotspot
= XCDR (hotspot
);
25493 if (CONSP (hotspot
)
25494 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25496 pointer
= Fplist_get (plist
, Qpointer
);
25497 if (NILP (pointer
))
25499 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25500 if (!NILP (help_echo_string
))
25502 help_echo_window
= window
;
25503 help_echo_object
= glyph
->object
;
25504 help_echo_pos
= glyph
->charpos
;
25508 if (NILP (pointer
))
25509 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25512 #endif /* HAVE_WINDOW_SYSTEM */
25514 /* Clear mouse face if X/Y not over text. */
25516 || area
!= TEXT_AREA
25517 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25518 /* Glyph's OBJECT is an integer for glyphs inserted by the
25519 display engine for its internal purposes, like truncation
25520 and continuation glyphs and blanks beyond the end of
25521 line's text on text terminals. If we are over such a
25522 glyph, we are not over any text. */
25523 || INTEGERP (glyph
->object
)
25524 /* R2L rows have a stretch glyph at their front, which
25525 stands for no text, whereas L2R rows have no glyphs at
25526 all beyond the end of text. Treat such stretch glyphs
25527 like we do with NULL glyphs in L2R rows. */
25528 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25529 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25530 && glyph
->type
== STRETCH_GLYPH
25531 && glyph
->avoid_cursor_p
))
25533 if (clear_mouse_face (hlinfo
))
25534 cursor
= No_Cursor
;
25535 #ifdef HAVE_WINDOW_SYSTEM
25536 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25538 if (area
!= TEXT_AREA
)
25539 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25541 pointer
= Vvoid_text_area_pointer
;
25547 pos
= glyph
->charpos
;
25548 object
= glyph
->object
;
25549 if (!STRINGP (object
) && !BUFFERP (object
))
25552 /* If we get an out-of-range value, return now; avoid an error. */
25553 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25556 /* Make the window's buffer temporarily current for
25557 overlays_at and compute_char_face. */
25558 obuf
= current_buffer
;
25559 current_buffer
= b
;
25565 /* Is this char mouse-active or does it have help-echo? */
25566 position
= make_number (pos
);
25568 if (BUFFERP (object
))
25570 /* Put all the overlays we want in a vector in overlay_vec. */
25571 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25572 /* Sort overlays into increasing priority order. */
25573 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25578 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25581 cursor
= No_Cursor
;
25583 /* Check mouse-face highlighting. */
25585 /* If there exists an overlay with mouse-face overlapping
25586 the one we are currently highlighting, we have to
25587 check if we enter the overlapping overlay, and then
25588 highlight only that. */
25589 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25590 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25592 /* Find the highest priority overlay with a mouse-face. */
25593 Lisp_Object overlay
= Qnil
;
25594 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25596 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25597 if (!NILP (mouse_face
))
25598 overlay
= overlay_vec
[i
];
25601 /* If we're highlighting the same overlay as before, there's
25602 no need to do that again. */
25603 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25604 goto check_help_echo
;
25605 hlinfo
->mouse_face_overlay
= overlay
;
25607 /* Clear the display of the old active region, if any. */
25608 if (clear_mouse_face (hlinfo
))
25609 cursor
= No_Cursor
;
25611 /* If no overlay applies, get a text property. */
25612 if (NILP (overlay
))
25613 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25615 /* Next, compute the bounds of the mouse highlighting and
25617 if (!NILP (mouse_face
) && STRINGP (object
))
25619 /* The mouse-highlighting comes from a display string
25620 with a mouse-face. */
25624 s
= Fprevious_single_property_change
25625 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25626 e
= Fnext_single_property_change
25627 (position
, Qmouse_face
, object
, Qnil
);
25629 s
= make_number (0);
25631 e
= make_number (SCHARS (object
) - 1);
25632 mouse_face_from_string_pos (w
, hlinfo
, object
,
25633 XINT (s
), XINT (e
));
25634 hlinfo
->mouse_face_past_end
= 0;
25635 hlinfo
->mouse_face_window
= window
;
25636 hlinfo
->mouse_face_face_id
25637 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25638 glyph
->face_id
, 1);
25639 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25640 cursor
= No_Cursor
;
25644 /* The mouse-highlighting, if any, comes from an overlay
25645 or text property in the buffer. */
25646 Lisp_Object buffer
IF_LINT (= Qnil
);
25647 Lisp_Object cover_string
IF_LINT (= Qnil
);
25649 if (STRINGP (object
))
25651 /* If we are on a display string with no mouse-face,
25652 check if the text under it has one. */
25653 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25654 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25655 pos
= string_buffer_position (object
, start
);
25658 mouse_face
= get_char_property_and_overlay
25659 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25660 buffer
= w
->buffer
;
25661 cover_string
= object
;
25667 cover_string
= Qnil
;
25670 if (!NILP (mouse_face
))
25672 Lisp_Object before
, after
;
25673 Lisp_Object before_string
, after_string
;
25674 /* To correctly find the limits of mouse highlight
25675 in a bidi-reordered buffer, we must not use the
25676 optimization of limiting the search in
25677 previous-single-property-change and
25678 next-single-property-change, because
25679 rows_from_pos_range needs the real start and end
25680 positions to DTRT in this case. That's because
25681 the first row visible in a window does not
25682 necessarily display the character whose position
25683 is the smallest. */
25685 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25686 ? Fmarker_position (w
->start
)
25689 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25690 ? make_number (BUF_Z (XBUFFER (buffer
))
25691 - XFASTINT (w
->window_end_pos
))
25694 if (NILP (overlay
))
25696 /* Handle the text property case. */
25697 before
= Fprevious_single_property_change
25698 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25699 after
= Fnext_single_property_change
25700 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25701 before_string
= after_string
= Qnil
;
25705 /* Handle the overlay case. */
25706 before
= Foverlay_start (overlay
);
25707 after
= Foverlay_end (overlay
);
25708 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25709 after_string
= Foverlay_get (overlay
, Qafter_string
);
25711 if (!STRINGP (before_string
)) before_string
= Qnil
;
25712 if (!STRINGP (after_string
)) after_string
= Qnil
;
25715 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25718 before_string
, after_string
,
25720 cursor
= No_Cursor
;
25727 /* Look for a `help-echo' property. */
25728 if (NILP (help_echo_string
)) {
25729 Lisp_Object help
, overlay
;
25731 /* Check overlays first. */
25732 help
= overlay
= Qnil
;
25733 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25735 overlay
= overlay_vec
[i
];
25736 help
= Foverlay_get (overlay
, Qhelp_echo
);
25741 help_echo_string
= help
;
25742 help_echo_window
= window
;
25743 help_echo_object
= overlay
;
25744 help_echo_pos
= pos
;
25748 Lisp_Object obj
= glyph
->object
;
25749 EMACS_INT charpos
= glyph
->charpos
;
25751 /* Try text properties. */
25754 && charpos
< SCHARS (obj
))
25756 help
= Fget_text_property (make_number (charpos
),
25760 /* If the string itself doesn't specify a help-echo,
25761 see if the buffer text ``under'' it does. */
25762 struct glyph_row
*r
25763 = MATRIX_ROW (w
->current_matrix
, vpos
);
25764 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25765 EMACS_INT p
= string_buffer_position (obj
, start
);
25768 help
= Fget_char_property (make_number (p
),
25769 Qhelp_echo
, w
->buffer
);
25778 else if (BUFFERP (obj
)
25781 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25786 help_echo_string
= help
;
25787 help_echo_window
= window
;
25788 help_echo_object
= obj
;
25789 help_echo_pos
= charpos
;
25794 #ifdef HAVE_WINDOW_SYSTEM
25795 /* Look for a `pointer' property. */
25796 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25798 /* Check overlays first. */
25799 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25800 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25802 if (NILP (pointer
))
25804 Lisp_Object obj
= glyph
->object
;
25805 EMACS_INT charpos
= glyph
->charpos
;
25807 /* Try text properties. */
25810 && charpos
< SCHARS (obj
))
25812 pointer
= Fget_text_property (make_number (charpos
),
25814 if (NILP (pointer
))
25816 /* If the string itself doesn't specify a pointer,
25817 see if the buffer text ``under'' it does. */
25818 struct glyph_row
*r
25819 = MATRIX_ROW (w
->current_matrix
, vpos
);
25820 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25821 EMACS_INT p
= string_buffer_position (obj
, start
);
25823 pointer
= Fget_char_property (make_number (p
),
25824 Qpointer
, w
->buffer
);
25827 else if (BUFFERP (obj
)
25830 pointer
= Fget_text_property (make_number (charpos
),
25834 #endif /* HAVE_WINDOW_SYSTEM */
25838 current_buffer
= obuf
;
25843 #ifdef HAVE_WINDOW_SYSTEM
25844 if (FRAME_WINDOW_P (f
))
25845 define_frame_cursor1 (f
, cursor
, pointer
);
25847 /* This is here to prevent a compiler error, about "label at end of
25848 compound statement". */
25855 Clear any mouse-face on window W. This function is part of the
25856 redisplay interface, and is called from try_window_id and similar
25857 functions to ensure the mouse-highlight is off. */
25860 x_clear_window_mouse_face (struct window
*w
)
25862 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25863 Lisp_Object window
;
25866 XSETWINDOW (window
, w
);
25867 if (EQ (window
, hlinfo
->mouse_face_window
))
25868 clear_mouse_face (hlinfo
);
25874 Just discard the mouse face information for frame F, if any.
25875 This is used when the size of F is changed. */
25878 cancel_mouse_face (struct frame
*f
)
25880 Lisp_Object window
;
25881 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25883 window
= hlinfo
->mouse_face_window
;
25884 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25886 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25887 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25888 hlinfo
->mouse_face_window
= Qnil
;
25894 /***********************************************************************
25896 ***********************************************************************/
25898 #ifdef HAVE_WINDOW_SYSTEM
25900 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25901 which intersects rectangle R. R is in window-relative coordinates. */
25904 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25905 enum glyph_row_area area
)
25907 struct glyph
*first
= row
->glyphs
[area
];
25908 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25909 struct glyph
*last
;
25910 int first_x
, start_x
, x
;
25912 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25913 /* If row extends face to end of line write the whole line. */
25914 draw_glyphs (w
, 0, row
, area
,
25915 0, row
->used
[area
],
25916 DRAW_NORMAL_TEXT
, 0);
25919 /* Set START_X to the window-relative start position for drawing glyphs of
25920 AREA. The first glyph of the text area can be partially visible.
25921 The first glyphs of other areas cannot. */
25922 start_x
= window_box_left_offset (w
, area
);
25924 if (area
== TEXT_AREA
)
25927 /* Find the first glyph that must be redrawn. */
25929 && x
+ first
->pixel_width
< r
->x
)
25931 x
+= first
->pixel_width
;
25935 /* Find the last one. */
25939 && x
< r
->x
+ r
->width
)
25941 x
+= last
->pixel_width
;
25947 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25948 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25949 DRAW_NORMAL_TEXT
, 0);
25954 /* Redraw the parts of the glyph row ROW on window W intersecting
25955 rectangle R. R is in window-relative coordinates. Value is
25956 non-zero if mouse-face was overwritten. */
25959 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25961 xassert (row
->enabled_p
);
25963 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25964 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25965 0, row
->used
[TEXT_AREA
],
25966 DRAW_NORMAL_TEXT
, 0);
25969 if (row
->used
[LEFT_MARGIN_AREA
])
25970 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25971 if (row
->used
[TEXT_AREA
])
25972 expose_area (w
, row
, r
, TEXT_AREA
);
25973 if (row
->used
[RIGHT_MARGIN_AREA
])
25974 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25975 draw_row_fringe_bitmaps (w
, row
);
25978 return row
->mouse_face_p
;
25982 /* Redraw those parts of glyphs rows during expose event handling that
25983 overlap other rows. Redrawing of an exposed line writes over parts
25984 of lines overlapping that exposed line; this function fixes that.
25986 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25987 row in W's current matrix that is exposed and overlaps other rows.
25988 LAST_OVERLAPPING_ROW is the last such row. */
25991 expose_overlaps (struct window
*w
,
25992 struct glyph_row
*first_overlapping_row
,
25993 struct glyph_row
*last_overlapping_row
,
25996 struct glyph_row
*row
;
25998 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25999 if (row
->overlapping_p
)
26001 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26004 if (row
->used
[LEFT_MARGIN_AREA
])
26005 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26007 if (row
->used
[TEXT_AREA
])
26008 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26010 if (row
->used
[RIGHT_MARGIN_AREA
])
26011 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26017 /* Return non-zero if W's cursor intersects rectangle R. */
26020 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26022 XRectangle cr
, result
;
26023 struct glyph
*cursor_glyph
;
26024 struct glyph_row
*row
;
26026 if (w
->phys_cursor
.vpos
>= 0
26027 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26028 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26030 && row
->cursor_in_fringe_p
)
26032 /* Cursor is in the fringe. */
26033 cr
.x
= window_box_right_offset (w
,
26034 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26035 ? RIGHT_MARGIN_AREA
26038 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26039 cr
.height
= row
->height
;
26040 return x_intersect_rectangles (&cr
, r
, &result
);
26043 cursor_glyph
= get_phys_cursor_glyph (w
);
26046 /* r is relative to W's box, but w->phys_cursor.x is relative
26047 to left edge of W's TEXT area. Adjust it. */
26048 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26049 cr
.y
= w
->phys_cursor
.y
;
26050 cr
.width
= cursor_glyph
->pixel_width
;
26051 cr
.height
= w
->phys_cursor_height
;
26052 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26053 I assume the effect is the same -- and this is portable. */
26054 return x_intersect_rectangles (&cr
, r
, &result
);
26056 /* If we don't understand the format, pretend we're not in the hot-spot. */
26062 Draw a vertical window border to the right of window W if W doesn't
26063 have vertical scroll bars. */
26066 x_draw_vertical_border (struct window
*w
)
26068 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26070 /* We could do better, if we knew what type of scroll-bar the adjacent
26071 windows (on either side) have... But we don't :-(
26072 However, I think this works ok. ++KFS 2003-04-25 */
26074 /* Redraw borders between horizontally adjacent windows. Don't
26075 do it for frames with vertical scroll bars because either the
26076 right scroll bar of a window, or the left scroll bar of its
26077 neighbor will suffice as a border. */
26078 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26081 if (!WINDOW_RIGHTMOST_P (w
)
26082 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26084 int x0
, x1
, y0
, y1
;
26086 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26089 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26092 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26094 else if (!WINDOW_LEFTMOST_P (w
)
26095 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26097 int x0
, x1
, y0
, y1
;
26099 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26102 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26105 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26110 /* Redraw the part of window W intersection rectangle FR. Pixel
26111 coordinates in FR are frame-relative. Call this function with
26112 input blocked. Value is non-zero if the exposure overwrites
26116 expose_window (struct window
*w
, XRectangle
*fr
)
26118 struct frame
*f
= XFRAME (w
->frame
);
26120 int mouse_face_overwritten_p
= 0;
26122 /* If window is not yet fully initialized, do nothing. This can
26123 happen when toolkit scroll bars are used and a window is split.
26124 Reconfiguring the scroll bar will generate an expose for a newly
26126 if (w
->current_matrix
== NULL
)
26129 /* When we're currently updating the window, display and current
26130 matrix usually don't agree. Arrange for a thorough display
26132 if (w
== updated_window
)
26134 SET_FRAME_GARBAGED (f
);
26138 /* Frame-relative pixel rectangle of W. */
26139 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26140 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26141 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26142 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26144 if (x_intersect_rectangles (fr
, &wr
, &r
))
26146 int yb
= window_text_bottom_y (w
);
26147 struct glyph_row
*row
;
26148 int cursor_cleared_p
;
26149 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26151 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26152 r
.x
, r
.y
, r
.width
, r
.height
));
26154 /* Convert to window coordinates. */
26155 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26156 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26158 /* Turn off the cursor. */
26159 if (!w
->pseudo_window_p
26160 && phys_cursor_in_rect_p (w
, &r
))
26162 x_clear_cursor (w
);
26163 cursor_cleared_p
= 1;
26166 cursor_cleared_p
= 0;
26168 /* Update lines intersecting rectangle R. */
26169 first_overlapping_row
= last_overlapping_row
= NULL
;
26170 for (row
= w
->current_matrix
->rows
;
26175 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26177 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26178 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26179 || (r
.y
>= y0
&& r
.y
< y1
)
26180 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26182 /* A header line may be overlapping, but there is no need
26183 to fix overlapping areas for them. KFS 2005-02-12 */
26184 if (row
->overlapping_p
&& !row
->mode_line_p
)
26186 if (first_overlapping_row
== NULL
)
26187 first_overlapping_row
= row
;
26188 last_overlapping_row
= row
;
26192 if (expose_line (w
, row
, &r
))
26193 mouse_face_overwritten_p
= 1;
26196 else if (row
->overlapping_p
)
26198 /* We must redraw a row overlapping the exposed area. */
26200 ? y0
+ row
->phys_height
> r
.y
26201 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26203 if (first_overlapping_row
== NULL
)
26204 first_overlapping_row
= row
;
26205 last_overlapping_row
= row
;
26213 /* Display the mode line if there is one. */
26214 if (WINDOW_WANTS_MODELINE_P (w
)
26215 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26217 && row
->y
< r
.y
+ r
.height
)
26219 if (expose_line (w
, row
, &r
))
26220 mouse_face_overwritten_p
= 1;
26223 if (!w
->pseudo_window_p
)
26225 /* Fix the display of overlapping rows. */
26226 if (first_overlapping_row
)
26227 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26230 /* Draw border between windows. */
26231 x_draw_vertical_border (w
);
26233 /* Turn the cursor on again. */
26234 if (cursor_cleared_p
)
26235 update_window_cursor (w
, 1);
26239 return mouse_face_overwritten_p
;
26244 /* Redraw (parts) of all windows in the window tree rooted at W that
26245 intersect R. R contains frame pixel coordinates. Value is
26246 non-zero if the exposure overwrites mouse-face. */
26249 expose_window_tree (struct window
*w
, XRectangle
*r
)
26251 struct frame
*f
= XFRAME (w
->frame
);
26252 int mouse_face_overwritten_p
= 0;
26254 while (w
&& !FRAME_GARBAGED_P (f
))
26256 if (!NILP (w
->hchild
))
26257 mouse_face_overwritten_p
26258 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26259 else if (!NILP (w
->vchild
))
26260 mouse_face_overwritten_p
26261 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26263 mouse_face_overwritten_p
|= expose_window (w
, r
);
26265 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26268 return mouse_face_overwritten_p
;
26273 Redisplay an exposed area of frame F. X and Y are the upper-left
26274 corner of the exposed rectangle. W and H are width and height of
26275 the exposed area. All are pixel values. W or H zero means redraw
26276 the entire frame. */
26279 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26282 int mouse_face_overwritten_p
= 0;
26284 TRACE ((stderr
, "expose_frame "));
26286 /* No need to redraw if frame will be redrawn soon. */
26287 if (FRAME_GARBAGED_P (f
))
26289 TRACE ((stderr
, " garbaged\n"));
26293 /* If basic faces haven't been realized yet, there is no point in
26294 trying to redraw anything. This can happen when we get an expose
26295 event while Emacs is starting, e.g. by moving another window. */
26296 if (FRAME_FACE_CACHE (f
) == NULL
26297 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26299 TRACE ((stderr
, " no faces\n"));
26303 if (w
== 0 || h
== 0)
26306 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26307 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26317 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26318 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26320 if (WINDOWP (f
->tool_bar_window
))
26321 mouse_face_overwritten_p
26322 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26324 #ifdef HAVE_X_WINDOWS
26326 #ifndef USE_X_TOOLKIT
26327 if (WINDOWP (f
->menu_bar_window
))
26328 mouse_face_overwritten_p
26329 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26330 #endif /* not USE_X_TOOLKIT */
26334 /* Some window managers support a focus-follows-mouse style with
26335 delayed raising of frames. Imagine a partially obscured frame,
26336 and moving the mouse into partially obscured mouse-face on that
26337 frame. The visible part of the mouse-face will be highlighted,
26338 then the WM raises the obscured frame. With at least one WM, KDE
26339 2.1, Emacs is not getting any event for the raising of the frame
26340 (even tried with SubstructureRedirectMask), only Expose events.
26341 These expose events will draw text normally, i.e. not
26342 highlighted. Which means we must redo the highlight here.
26343 Subsume it under ``we love X''. --gerd 2001-08-15 */
26344 /* Included in Windows version because Windows most likely does not
26345 do the right thing if any third party tool offers
26346 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26347 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26349 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26350 if (f
== hlinfo
->mouse_face_mouse_frame
)
26352 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26353 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26354 clear_mouse_face (hlinfo
);
26355 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26362 Determine the intersection of two rectangles R1 and R2. Return
26363 the intersection in *RESULT. Value is non-zero if RESULT is not
26367 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26369 XRectangle
*left
, *right
;
26370 XRectangle
*upper
, *lower
;
26371 int intersection_p
= 0;
26373 /* Rearrange so that R1 is the left-most rectangle. */
26375 left
= r1
, right
= r2
;
26377 left
= r2
, right
= r1
;
26379 /* X0 of the intersection is right.x0, if this is inside R1,
26380 otherwise there is no intersection. */
26381 if (right
->x
<= left
->x
+ left
->width
)
26383 result
->x
= right
->x
;
26385 /* The right end of the intersection is the minimum of
26386 the right ends of left and right. */
26387 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26390 /* Same game for Y. */
26392 upper
= r1
, lower
= r2
;
26394 upper
= r2
, lower
= r1
;
26396 /* The upper end of the intersection is lower.y0, if this is inside
26397 of upper. Otherwise, there is no intersection. */
26398 if (lower
->y
<= upper
->y
+ upper
->height
)
26400 result
->y
= lower
->y
;
26402 /* The lower end of the intersection is the minimum of the lower
26403 ends of upper and lower. */
26404 result
->height
= (min (lower
->y
+ lower
->height
,
26405 upper
->y
+ upper
->height
)
26407 intersection_p
= 1;
26411 return intersection_p
;
26414 #endif /* HAVE_WINDOW_SYSTEM */
26417 /***********************************************************************
26419 ***********************************************************************/
26422 syms_of_xdisp (void)
26424 Vwith_echo_area_save_vector
= Qnil
;
26425 staticpro (&Vwith_echo_area_save_vector
);
26427 Vmessage_stack
= Qnil
;
26428 staticpro (&Vmessage_stack
);
26430 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26431 staticpro (&Qinhibit_redisplay
);
26433 message_dolog_marker1
= Fmake_marker ();
26434 staticpro (&message_dolog_marker1
);
26435 message_dolog_marker2
= Fmake_marker ();
26436 staticpro (&message_dolog_marker2
);
26437 message_dolog_marker3
= Fmake_marker ();
26438 staticpro (&message_dolog_marker3
);
26441 defsubr (&Sdump_frame_glyph_matrix
);
26442 defsubr (&Sdump_glyph_matrix
);
26443 defsubr (&Sdump_glyph_row
);
26444 defsubr (&Sdump_tool_bar_row
);
26445 defsubr (&Strace_redisplay
);
26446 defsubr (&Strace_to_stderr
);
26448 #ifdef HAVE_WINDOW_SYSTEM
26449 defsubr (&Stool_bar_lines_needed
);
26450 defsubr (&Slookup_image_map
);
26452 defsubr (&Sformat_mode_line
);
26453 defsubr (&Sinvisible_p
);
26454 defsubr (&Scurrent_bidi_paragraph_direction
);
26456 staticpro (&Qmenu_bar_update_hook
);
26457 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26459 staticpro (&Qoverriding_terminal_local_map
);
26460 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26462 staticpro (&Qoverriding_local_map
);
26463 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26465 staticpro (&Qwindow_scroll_functions
);
26466 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26468 staticpro (&Qwindow_text_change_functions
);
26469 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26471 staticpro (&Qredisplay_end_trigger_functions
);
26472 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26474 staticpro (&Qinhibit_point_motion_hooks
);
26475 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26477 Qeval
= intern_c_string ("eval");
26478 staticpro (&Qeval
);
26480 QCdata
= intern_c_string (":data");
26481 staticpro (&QCdata
);
26482 Qdisplay
= intern_c_string ("display");
26483 staticpro (&Qdisplay
);
26484 Qspace_width
= intern_c_string ("space-width");
26485 staticpro (&Qspace_width
);
26486 Qraise
= intern_c_string ("raise");
26487 staticpro (&Qraise
);
26488 Qslice
= intern_c_string ("slice");
26489 staticpro (&Qslice
);
26490 Qspace
= intern_c_string ("space");
26491 staticpro (&Qspace
);
26492 Qmargin
= intern_c_string ("margin");
26493 staticpro (&Qmargin
);
26494 Qpointer
= intern_c_string ("pointer");
26495 staticpro (&Qpointer
);
26496 Qleft_margin
= intern_c_string ("left-margin");
26497 staticpro (&Qleft_margin
);
26498 Qright_margin
= intern_c_string ("right-margin");
26499 staticpro (&Qright_margin
);
26500 Qcenter
= intern_c_string ("center");
26501 staticpro (&Qcenter
);
26502 Qline_height
= intern_c_string ("line-height");
26503 staticpro (&Qline_height
);
26504 QCalign_to
= intern_c_string (":align-to");
26505 staticpro (&QCalign_to
);
26506 QCrelative_width
= intern_c_string (":relative-width");
26507 staticpro (&QCrelative_width
);
26508 QCrelative_height
= intern_c_string (":relative-height");
26509 staticpro (&QCrelative_height
);
26510 QCeval
= intern_c_string (":eval");
26511 staticpro (&QCeval
);
26512 QCpropertize
= intern_c_string (":propertize");
26513 staticpro (&QCpropertize
);
26514 QCfile
= intern_c_string (":file");
26515 staticpro (&QCfile
);
26516 Qfontified
= intern_c_string ("fontified");
26517 staticpro (&Qfontified
);
26518 Qfontification_functions
= intern_c_string ("fontification-functions");
26519 staticpro (&Qfontification_functions
);
26520 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26521 staticpro (&Qtrailing_whitespace
);
26522 Qescape_glyph
= intern_c_string ("escape-glyph");
26523 staticpro (&Qescape_glyph
);
26524 Qnobreak_space
= intern_c_string ("nobreak-space");
26525 staticpro (&Qnobreak_space
);
26526 Qimage
= intern_c_string ("image");
26527 staticpro (&Qimage
);
26528 Qtext
= intern_c_string ("text");
26529 staticpro (&Qtext
);
26530 Qboth
= intern_c_string ("both");
26531 staticpro (&Qboth
);
26532 Qboth_horiz
= intern_c_string ("both-horiz");
26533 staticpro (&Qboth_horiz
);
26534 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26535 staticpro (&Qtext_image_horiz
);
26536 QCmap
= intern_c_string (":map");
26537 staticpro (&QCmap
);
26538 QCpointer
= intern_c_string (":pointer");
26539 staticpro (&QCpointer
);
26540 Qrect
= intern_c_string ("rect");
26541 staticpro (&Qrect
);
26542 Qcircle
= intern_c_string ("circle");
26543 staticpro (&Qcircle
);
26544 Qpoly
= intern_c_string ("poly");
26545 staticpro (&Qpoly
);
26546 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26547 staticpro (&Qmessage_truncate_lines
);
26548 Qgrow_only
= intern_c_string ("grow-only");
26549 staticpro (&Qgrow_only
);
26550 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26551 staticpro (&Qinhibit_menubar_update
);
26552 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26553 staticpro (&Qinhibit_eval_during_redisplay
);
26554 Qposition
= intern_c_string ("position");
26555 staticpro (&Qposition
);
26556 Qbuffer_position
= intern_c_string ("buffer-position");
26557 staticpro (&Qbuffer_position
);
26558 Qobject
= intern_c_string ("object");
26559 staticpro (&Qobject
);
26560 Qbar
= intern_c_string ("bar");
26562 Qhbar
= intern_c_string ("hbar");
26563 staticpro (&Qhbar
);
26564 Qbox
= intern_c_string ("box");
26566 Qhollow
= intern_c_string ("hollow");
26567 staticpro (&Qhollow
);
26568 Qhand
= intern_c_string ("hand");
26569 staticpro (&Qhand
);
26570 Qarrow
= intern_c_string ("arrow");
26571 staticpro (&Qarrow
);
26572 Qtext
= intern_c_string ("text");
26573 staticpro (&Qtext
);
26574 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26575 staticpro (&Qinhibit_free_realized_faces
);
26577 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26578 Fcons (intern_c_string ("void-variable"), Qnil
)),
26580 staticpro (&list_of_error
);
26582 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26583 staticpro (&Qlast_arrow_position
);
26584 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26585 staticpro (&Qlast_arrow_string
);
26587 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26588 staticpro (&Qoverlay_arrow_string
);
26589 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26590 staticpro (&Qoverlay_arrow_bitmap
);
26592 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26593 staticpro (&echo_buffer
[0]);
26594 staticpro (&echo_buffer
[1]);
26596 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26597 staticpro (&echo_area_buffer
[0]);
26598 staticpro (&echo_area_buffer
[1]);
26600 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26601 staticpro (&Vmessages_buffer_name
);
26603 mode_line_proptrans_alist
= Qnil
;
26604 staticpro (&mode_line_proptrans_alist
);
26605 mode_line_string_list
= Qnil
;
26606 staticpro (&mode_line_string_list
);
26607 mode_line_string_face
= Qnil
;
26608 staticpro (&mode_line_string_face
);
26609 mode_line_string_face_prop
= Qnil
;
26610 staticpro (&mode_line_string_face_prop
);
26611 Vmode_line_unwind_vector
= Qnil
;
26612 staticpro (&Vmode_line_unwind_vector
);
26614 help_echo_string
= Qnil
;
26615 staticpro (&help_echo_string
);
26616 help_echo_object
= Qnil
;
26617 staticpro (&help_echo_object
);
26618 help_echo_window
= Qnil
;
26619 staticpro (&help_echo_window
);
26620 previous_help_echo_string
= Qnil
;
26621 staticpro (&previous_help_echo_string
);
26622 help_echo_pos
= -1;
26624 Qright_to_left
= intern_c_string ("right-to-left");
26625 staticpro (&Qright_to_left
);
26626 Qleft_to_right
= intern_c_string ("left-to-right");
26627 staticpro (&Qleft_to_right
);
26629 #ifdef HAVE_WINDOW_SYSTEM
26630 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26631 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26632 For example, if a block cursor is over a tab, it will be drawn as
26633 wide as that tab on the display. */);
26634 x_stretch_cursor_p
= 0;
26637 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26638 doc
: /* *Non-nil means highlight trailing whitespace.
26639 The face used for trailing whitespace is `trailing-whitespace'. */);
26640 Vshow_trailing_whitespace
= Qnil
;
26642 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26643 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26644 A value of t means highlight the character itself (for nobreak space,
26645 use face `nobreak-space').
26646 A value of nil means no highlighting.
26647 Other values mean display the escape glyph followed by an ordinary
26648 space or ordinary hyphen. */);
26649 Vnobreak_char_display
= Qt
;
26651 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26652 doc
: /* *The pointer shape to show in void text areas.
26653 A value of nil means to show the text pointer. Other options are `arrow',
26654 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26655 Vvoid_text_area_pointer
= Qarrow
;
26657 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26658 doc
: /* Non-nil means don't actually do any redisplay.
26659 This is used for internal purposes. */);
26660 Vinhibit_redisplay
= Qnil
;
26662 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26663 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26664 Vglobal_mode_string
= Qnil
;
26666 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26667 doc
: /* Marker for where to display an arrow on top of the buffer text.
26668 This must be the beginning of a line in order to work.
26669 See also `overlay-arrow-string'. */);
26670 Voverlay_arrow_position
= Qnil
;
26672 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26673 doc
: /* String to display as an arrow in non-window frames.
26674 See also `overlay-arrow-position'. */);
26675 Voverlay_arrow_string
= make_pure_c_string ("=>");
26677 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26678 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26679 The symbols on this list are examined during redisplay to determine
26680 where to display overlay arrows. */);
26681 Voverlay_arrow_variable_list
26682 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26684 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26685 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26686 If that fails to bring point back on frame, point is centered instead.
26687 If this is zero, point is always centered after it moves off frame.
26688 If you want scrolling to always be a line at a time, you should set
26689 `scroll-conservatively' to a large value rather than set this to 1. */);
26691 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26692 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26693 If point moves off-screen, redisplay will scroll by up to
26694 `scroll-conservatively' lines in order to bring point just barely
26695 onto the screen again. If that cannot be done, then redisplay
26696 recenters point as usual.
26698 If the value is greater than 100, redisplay will never recenter point,
26699 but will always scroll just enough text to bring point into view, even
26700 if you move far away.
26702 A value of zero means always recenter point if it moves off screen. */);
26703 scroll_conservatively
= 0;
26705 DEFVAR_INT ("scroll-margin", scroll_margin
,
26706 doc
: /* *Number of lines of margin at the top and bottom of a window.
26707 Recenter the window whenever point gets within this many lines
26708 of the top or bottom of the window. */);
26711 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26712 doc
: /* Pixels per inch value for non-window system displays.
26713 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26714 Vdisplay_pixels_per_inch
= make_float (72.0);
26717 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26720 DEFVAR_LISP ("truncate-partial-width-windows",
26721 Vtruncate_partial_width_windows
,
26722 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26723 For an integer value, truncate lines in each window narrower than the
26724 full frame width, provided the window width is less than that integer;
26725 otherwise, respect the value of `truncate-lines'.
26727 For any other non-nil value, truncate lines in all windows that do
26728 not span the full frame width.
26730 A value of nil means to respect the value of `truncate-lines'.
26732 If `word-wrap' is enabled, you might want to reduce this. */);
26733 Vtruncate_partial_width_windows
= make_number (50);
26735 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26736 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26737 Any other value means to use the appropriate face, `mode-line',
26738 `header-line', or `menu' respectively. */);
26739 mode_line_inverse_video
= 1;
26741 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26742 doc
: /* *Maximum buffer size for which line number should be displayed.
26743 If the buffer is bigger than this, the line number does not appear
26744 in the mode line. A value of nil means no limit. */);
26745 Vline_number_display_limit
= Qnil
;
26747 DEFVAR_INT ("line-number-display-limit-width",
26748 line_number_display_limit_width
,
26749 doc
: /* *Maximum line width (in characters) for line number display.
26750 If the average length of the lines near point is bigger than this, then the
26751 line number may be omitted from the mode line. */);
26752 line_number_display_limit_width
= 200;
26754 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26755 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26756 highlight_nonselected_windows
= 0;
26758 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26759 doc
: /* Non-nil if more than one frame is visible on this display.
26760 Minibuffer-only frames don't count, but iconified frames do.
26761 This variable is not guaranteed to be accurate except while processing
26762 `frame-title-format' and `icon-title-format'. */);
26764 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26765 doc
: /* Template for displaying the title bar of visible frames.
26766 \(Assuming the window manager supports this feature.)
26768 This variable has the same structure as `mode-line-format', except that
26769 the %c and %l constructs are ignored. It is used only on frames for
26770 which no explicit name has been set \(see `modify-frame-parameters'). */);
26772 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26773 doc
: /* Template for displaying the title bar of an iconified frame.
26774 \(Assuming the window manager supports this feature.)
26775 This variable has the same structure as `mode-line-format' (which see),
26776 and is used only on frames for which no explicit name has been set
26777 \(see `modify-frame-parameters'). */);
26779 = Vframe_title_format
26780 = pure_cons (intern_c_string ("multiple-frames"),
26781 pure_cons (make_pure_c_string ("%b"),
26782 pure_cons (pure_cons (empty_unibyte_string
,
26783 pure_cons (intern_c_string ("invocation-name"),
26784 pure_cons (make_pure_c_string ("@"),
26785 pure_cons (intern_c_string ("system-name"),
26789 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26790 doc
: /* Maximum number of lines to keep in the message log buffer.
26791 If nil, disable message logging. If t, log messages but don't truncate
26792 the buffer when it becomes large. */);
26793 Vmessage_log_max
= make_number (100);
26795 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26796 doc
: /* Functions called before redisplay, if window sizes have changed.
26797 The value should be a list of functions that take one argument.
26798 Just before redisplay, for each frame, if any of its windows have changed
26799 size since the last redisplay, or have been split or deleted,
26800 all the functions in the list are called, with the frame as argument. */);
26801 Vwindow_size_change_functions
= Qnil
;
26803 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26804 doc
: /* List of functions to call before redisplaying a window with scrolling.
26805 Each function is called with two arguments, the window and its new
26806 display-start position. Note that these functions are also called by
26807 `set-window-buffer'. Also note that the value of `window-end' is not
26808 valid when these functions are called. */);
26809 Vwindow_scroll_functions
= Qnil
;
26811 DEFVAR_LISP ("window-text-change-functions",
26812 Vwindow_text_change_functions
,
26813 doc
: /* Functions to call in redisplay when text in the window might change. */);
26814 Vwindow_text_change_functions
= Qnil
;
26816 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26817 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26818 Each function is called with two arguments, the window and the end trigger value.
26819 See `set-window-redisplay-end-trigger'. */);
26820 Vredisplay_end_trigger_functions
= Qnil
;
26822 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26823 doc
: /* *Non-nil means autoselect window with mouse pointer.
26824 If nil, do not autoselect windows.
26825 A positive number means delay autoselection by that many seconds: a
26826 window is autoselected only after the mouse has remained in that
26827 window for the duration of the delay.
26828 A negative number has a similar effect, but causes windows to be
26829 autoselected only after the mouse has stopped moving. \(Because of
26830 the way Emacs compares mouse events, you will occasionally wait twice
26831 that time before the window gets selected.\)
26832 Any other value means to autoselect window instantaneously when the
26833 mouse pointer enters it.
26835 Autoselection selects the minibuffer only if it is active, and never
26836 unselects the minibuffer if it is active.
26838 When customizing this variable make sure that the actual value of
26839 `focus-follows-mouse' matches the behavior of your window manager. */);
26840 Vmouse_autoselect_window
= Qnil
;
26842 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26843 doc
: /* *Non-nil means automatically resize tool-bars.
26844 This dynamically changes the tool-bar's height to the minimum height
26845 that is needed to make all tool-bar items visible.
26846 If value is `grow-only', the tool-bar's height is only increased
26847 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26848 Vauto_resize_tool_bars
= Qt
;
26850 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26851 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26852 auto_raise_tool_bar_buttons_p
= 1;
26854 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26855 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26856 make_cursor_line_fully_visible_p
= 1;
26858 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26859 doc
: /* *Border below tool-bar in pixels.
26860 If an integer, use it as the height of the border.
26861 If it is one of `internal-border-width' or `border-width', use the
26862 value of the corresponding frame parameter.
26863 Otherwise, no border is added below the tool-bar. */);
26864 Vtool_bar_border
= Qinternal_border_width
;
26866 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26867 doc
: /* *Margin around tool-bar buttons in pixels.
26868 If an integer, use that for both horizontal and vertical margins.
26869 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26870 HORZ specifying the horizontal margin, and VERT specifying the
26871 vertical margin. */);
26872 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26874 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26875 doc
: /* *Relief thickness of tool-bar buttons. */);
26876 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26878 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26879 doc
: /* Tool bar style to use.
26881 image - show images only
26882 text - show text only
26883 both - show both, text below image
26884 both-horiz - show text to the right of the image
26885 text-image-horiz - show text to the left of the image
26886 any other - use system default or image if no system default. */);
26887 Vtool_bar_style
= Qnil
;
26889 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26890 doc
: /* *Maximum number of characters a label can have to be shown.
26891 The tool bar style must also show labels for this to have any effect, see
26892 `tool-bar-style'. */);
26893 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26895 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26896 doc
: /* List of functions to call to fontify regions of text.
26897 Each function is called with one argument POS. Functions must
26898 fontify a region starting at POS in the current buffer, and give
26899 fontified regions the property `fontified'. */);
26900 Vfontification_functions
= Qnil
;
26901 Fmake_variable_buffer_local (Qfontification_functions
);
26903 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26904 unibyte_display_via_language_environment
,
26905 doc
: /* *Non-nil means display unibyte text according to language environment.
26906 Specifically, this means that raw bytes in the range 160-255 decimal
26907 are displayed by converting them to the equivalent multibyte characters
26908 according to the current language environment. As a result, they are
26909 displayed according to the current fontset.
26911 Note that this variable affects only how these bytes are displayed,
26912 but does not change the fact they are interpreted as raw bytes. */);
26913 unibyte_display_via_language_environment
= 0;
26915 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26916 doc
: /* *Maximum height for resizing mini-windows.
26917 If a float, it specifies a fraction of the mini-window frame's height.
26918 If an integer, it specifies a number of lines. */);
26919 Vmax_mini_window_height
= make_float (0.25);
26921 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26922 doc
: /* *How to resize mini-windows.
26923 A value of nil means don't automatically resize mini-windows.
26924 A value of t means resize them to fit the text displayed in them.
26925 A value of `grow-only', the default, means let mini-windows grow
26926 only, until their display becomes empty, at which point the windows
26927 go back to their normal size. */);
26928 Vresize_mini_windows
= Qgrow_only
;
26930 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26931 doc
: /* Alist specifying how to blink the cursor off.
26932 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26933 `cursor-type' frame-parameter or variable equals ON-STATE,
26934 comparing using `equal', Emacs uses OFF-STATE to specify
26935 how to blink it off. ON-STATE and OFF-STATE are values for
26936 the `cursor-type' frame parameter.
26938 If a frame's ON-STATE has no entry in this list,
26939 the frame's other specifications determine how to blink the cursor off. */);
26940 Vblink_cursor_alist
= Qnil
;
26942 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
26943 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
26944 If non-nil, windows are automatically scrolled horizontally to make
26945 point visible. */);
26946 automatic_hscrolling_p
= 1;
26947 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26948 staticpro (&Qauto_hscroll_mode
);
26950 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
26951 doc
: /* *How many columns away from the window edge point is allowed to get
26952 before automatic hscrolling will horizontally scroll the window. */);
26953 hscroll_margin
= 5;
26955 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
26956 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26957 When point is less than `hscroll-margin' columns from the window
26958 edge, automatic hscrolling will scroll the window by the amount of columns
26959 determined by this variable. If its value is a positive integer, scroll that
26960 many columns. If it's a positive floating-point number, it specifies the
26961 fraction of the window's width to scroll. If it's nil or zero, point will be
26962 centered horizontally after the scroll. Any other value, including negative
26963 numbers, are treated as if the value were zero.
26965 Automatic hscrolling always moves point outside the scroll margin, so if
26966 point was more than scroll step columns inside the margin, the window will
26967 scroll more than the value given by the scroll step.
26969 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26970 and `scroll-right' overrides this variable's effect. */);
26971 Vhscroll_step
= make_number (0);
26973 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
26974 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26975 Bind this around calls to `message' to let it take effect. */);
26976 message_truncate_lines
= 0;
26978 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
26979 doc
: /* Normal hook run to update the menu bar definitions.
26980 Redisplay runs this hook before it redisplays the menu bar.
26981 This is used to update submenus such as Buffers,
26982 whose contents depend on various data. */);
26983 Vmenu_bar_update_hook
= Qnil
;
26985 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
26986 doc
: /* Frame for which we are updating a menu.
26987 The enable predicate for a menu binding should check this variable. */);
26988 Vmenu_updating_frame
= Qnil
;
26990 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
26991 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26992 inhibit_menubar_update
= 0;
26994 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
26995 doc
: /* Prefix prepended to all continuation lines at display time.
26996 The value may be a string, an image, or a stretch-glyph; it is
26997 interpreted in the same way as the value of a `display' text property.
26999 This variable is overridden by any `wrap-prefix' text or overlay
27002 To add a prefix to non-continuation lines, use `line-prefix'. */);
27003 Vwrap_prefix
= Qnil
;
27004 staticpro (&Qwrap_prefix
);
27005 Qwrap_prefix
= intern_c_string ("wrap-prefix");
27006 Fmake_variable_buffer_local (Qwrap_prefix
);
27008 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27009 doc
: /* Prefix prepended to all non-continuation lines at display time.
27010 The value may be a string, an image, or a stretch-glyph; it is
27011 interpreted in the same way as the value of a `display' text property.
27013 This variable is overridden by any `line-prefix' text or overlay
27016 To add a prefix to continuation lines, use `wrap-prefix'. */);
27017 Vline_prefix
= Qnil
;
27018 staticpro (&Qline_prefix
);
27019 Qline_prefix
= intern_c_string ("line-prefix");
27020 Fmake_variable_buffer_local (Qline_prefix
);
27022 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27023 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27024 inhibit_eval_during_redisplay
= 0;
27026 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27027 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27028 inhibit_free_realized_faces
= 0;
27031 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27032 doc
: /* Inhibit try_window_id display optimization. */);
27033 inhibit_try_window_id
= 0;
27035 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27036 doc
: /* Inhibit try_window_reusing display optimization. */);
27037 inhibit_try_window_reusing
= 0;
27039 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27040 doc
: /* Inhibit try_cursor_movement display optimization. */);
27041 inhibit_try_cursor_movement
= 0;
27042 #endif /* GLYPH_DEBUG */
27044 DEFVAR_INT ("overline-margin", overline_margin
,
27045 doc
: /* *Space between overline and text, in pixels.
27046 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27047 margin to the caracter height. */);
27048 overline_margin
= 2;
27050 DEFVAR_INT ("underline-minimum-offset",
27051 underline_minimum_offset
,
27052 doc
: /* Minimum distance between baseline and underline.
27053 This can improve legibility of underlined text at small font sizes,
27054 particularly when using variable `x-use-underline-position-properties'
27055 with fonts that specify an UNDERLINE_POSITION relatively close to the
27056 baseline. The default value is 1. */);
27057 underline_minimum_offset
= 1;
27059 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27060 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27061 This feature only works when on a window system that can change
27062 cursor shapes. */);
27063 display_hourglass_p
= 1;
27065 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27066 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27067 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27069 hourglass_atimer
= NULL
;
27070 hourglass_shown_p
= 0;
27072 DEFSYM (Qglyphless_char
, "glyphless-char");
27073 DEFSYM (Qhex_code
, "hex-code");
27074 DEFSYM (Qempty_box
, "empty-box");
27075 DEFSYM (Qthin_space
, "thin-space");
27076 DEFSYM (Qzero_width
, "zero-width");
27078 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27079 /* Intern this now in case it isn't already done.
27080 Setting this variable twice is harmless.
27081 But don't staticpro it here--that is done in alloc.c. */
27082 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27083 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27085 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27086 doc
: /* Char-table defining glyphless characters.
27087 Each element, if non-nil, should be one of the following:
27088 an ASCII acronym string: display this string in a box
27089 `hex-code': display the hexadecimal code of a character in a box
27090 `empty-box': display as an empty box
27091 `thin-space': display as 1-pixel width space
27092 `zero-width': don't display
27093 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27094 display method for graphical terminals and text terminals respectively.
27095 GRAPHICAL and TEXT should each have one of the values listed above.
27097 The char-table has one extra slot to control the display of a character for
27098 which no font is found. This slot only takes effect on graphical terminals.
27099 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27100 `thin-space'. The default is `empty-box'. */);
27101 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27102 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27107 /* Initialize this module when Emacs starts. */
27112 current_header_line_height
= current_mode_line_height
= -1;
27114 CHARPOS (this_line_start_pos
) = 0;
27116 if (!noninteractive
)
27118 struct window
*m
= XWINDOW (minibuf_window
);
27119 Lisp_Object frame
= m
->frame
;
27120 struct frame
*f
= XFRAME (frame
);
27121 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27122 struct window
*r
= XWINDOW (root
);
27125 echo_area_window
= minibuf_window
;
27127 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27128 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27129 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27130 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27131 XSETFASTINT (m
->total_lines
, 1);
27132 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27134 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27135 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27136 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27138 /* The default ellipsis glyphs `...'. */
27139 for (i
= 0; i
< 3; ++i
)
27140 default_invis_vector
[i
] = make_number ('.');
27144 /* Allocate the buffer for frame titles.
27145 Also used for `format-mode-line'. */
27147 mode_line_noprop_buf
= (char *) xmalloc (size
);
27148 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27149 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27150 mode_line_target
= MODE_LINE_DISPLAY
;
27153 help_echo_showing_p
= 0;
27156 /* Since w32 does not support atimers, it defines its own implementation of
27157 the following three functions in w32fns.c. */
27160 /* Platform-independent portion of hourglass implementation. */
27162 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27164 hourglass_started (void)
27166 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27169 /* Cancel a currently active hourglass timer, and start a new one. */
27171 start_hourglass (void)
27173 #if defined (HAVE_WINDOW_SYSTEM)
27175 int secs
, usecs
= 0;
27177 cancel_hourglass ();
27179 if (INTEGERP (Vhourglass_delay
)
27180 && XINT (Vhourglass_delay
) > 0)
27181 secs
= XFASTINT (Vhourglass_delay
);
27182 else if (FLOATP (Vhourglass_delay
)
27183 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27186 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27187 secs
= XFASTINT (tem
);
27188 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27191 secs
= DEFAULT_HOURGLASS_DELAY
;
27193 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27194 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27195 show_hourglass
, NULL
);
27200 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27203 cancel_hourglass (void)
27205 #if defined (HAVE_WINDOW_SYSTEM)
27206 if (hourglass_atimer
)
27208 cancel_atimer (hourglass_atimer
);
27209 hourglass_atimer
= NULL
;
27212 if (hourglass_shown_p
)
27216 #endif /* ! WINDOWSNT */