1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
599 /* Non-zero means print traces of redisplay if compiled with
602 int trace_redisplay_p
;
604 #endif /* GLYPH_DEBUG */
606 #ifdef DEBUG_TRACE_MOVE
607 /* Non-zero means trace with TRACE_MOVE to stderr. */
610 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
612 #define TRACE_MOVE(x) (void) 0
615 static Lisp_Object Qauto_hscroll_mode
;
617 /* Buffer being redisplayed -- for redisplay_window_error. */
619 static struct buffer
*displayed_buffer
;
621 /* Value returned from text property handlers (see below). */
626 HANDLED_RECOMPUTE_PROPS
,
627 HANDLED_OVERLAY_STRING_CONSUMED
,
631 /* A description of text properties that redisplay is interested
636 /* The name of the property. */
639 /* A unique index for the property. */
642 /* A handler function called to set up iterator IT from the property
643 at IT's current position. Value is used to steer handle_stop. */
644 enum prop_handled (*handler
) (struct it
*it
);
647 static enum prop_handled
handle_face_prop (struct it
*);
648 static enum prop_handled
handle_invisible_prop (struct it
*);
649 static enum prop_handled
handle_display_prop (struct it
*);
650 static enum prop_handled
handle_composition_prop (struct it
*);
651 static enum prop_handled
handle_overlay_change (struct it
*);
652 static enum prop_handled
handle_fontified_prop (struct it
*);
654 /* Properties handled by iterators. */
656 static struct props it_props
[] =
658 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
659 /* Handle `face' before `display' because some sub-properties of
660 `display' need to know the face. */
661 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
662 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
663 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
664 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
668 /* Value is the position described by X. If X is a marker, value is
669 the marker_position of X. Otherwise, value is X. */
671 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
673 /* Enumeration returned by some move_it_.* functions internally. */
677 /* Not used. Undefined value. */
680 /* Move ended at the requested buffer position or ZV. */
681 MOVE_POS_MATCH_OR_ZV
,
683 /* Move ended at the requested X pixel position. */
686 /* Move within a line ended at the end of a line that must be
690 /* Move within a line ended at the end of a line that would
691 be displayed truncated. */
694 /* Move within a line ended at a line end. */
698 /* This counter is used to clear the face cache every once in a while
699 in redisplay_internal. It is incremented for each redisplay.
700 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
703 #define CLEAR_FACE_CACHE_COUNT 500
704 static int clear_face_cache_count
;
706 /* Similarly for the image cache. */
708 #ifdef HAVE_WINDOW_SYSTEM
709 #define CLEAR_IMAGE_CACHE_COUNT 101
710 static int clear_image_cache_count
;
712 /* Null glyph slice */
713 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
716 /* Non-zero while redisplay_internal is in progress. */
720 static Lisp_Object Qinhibit_free_realized_faces
;
722 /* If a string, XTread_socket generates an event to display that string.
723 (The display is done in read_char.) */
725 Lisp_Object help_echo_string
;
726 Lisp_Object help_echo_window
;
727 Lisp_Object help_echo_object
;
728 EMACS_INT help_echo_pos
;
730 /* Temporary variable for XTread_socket. */
732 Lisp_Object previous_help_echo_string
;
734 /* Platform-independent portion of hourglass implementation. */
736 /* Non-zero means an hourglass cursor is currently shown. */
737 int hourglass_shown_p
;
739 /* If non-null, an asynchronous timer that, when it expires, displays
740 an hourglass cursor on all frames. */
741 struct atimer
*hourglass_atimer
;
743 /* Name of the face used to display glyphless characters. */
744 Lisp_Object Qglyphless_char
;
746 /* Symbol for the purpose of Vglyphless_char_display. */
747 static Lisp_Object Qglyphless_char_display
;
749 /* Method symbols for Vglyphless_char_display. */
750 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
752 /* Default pixel width of `thin-space' display method. */
753 #define THIN_SPACE_WIDTH 1
755 /* Default number of seconds to wait before displaying an hourglass
757 #define DEFAULT_HOURGLASS_DELAY 1
760 /* Function prototypes. */
762 static void setup_for_ellipsis (struct it
*, int);
763 static void set_iterator_to_next (struct it
*, int);
764 static void mark_window_display_accurate_1 (struct window
*, int);
765 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
766 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
767 static int cursor_row_p (struct glyph_row
*);
768 static int redisplay_mode_lines (Lisp_Object
, int);
769 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
771 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
773 static void handle_line_prefix (struct it
*);
775 static void pint2str (char *, int, EMACS_INT
);
776 static void pint2hrstr (char *, int, EMACS_INT
);
777 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
779 static void reconsider_clip_changes (struct window
*, struct buffer
*);
780 static int text_outside_line_unchanged_p (struct window
*,
781 EMACS_INT
, EMACS_INT
);
782 static void store_mode_line_noprop_char (char);
783 static int store_mode_line_noprop (const char *, int, int);
784 static void handle_stop (struct it
*);
785 static void handle_stop_backwards (struct it
*, EMACS_INT
);
786 static int single_display_spec_intangible_p (Lisp_Object
);
787 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
788 static void ensure_echo_area_buffers (void);
789 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
790 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
791 static int with_echo_area_buffer (struct window
*, int,
792 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
793 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
794 static void clear_garbaged_frames (void);
795 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
796 static void pop_message (void);
797 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
798 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
799 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
800 static int display_echo_area (struct window
*);
801 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
802 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
803 static Lisp_Object
unwind_redisplay (Lisp_Object
);
804 static int string_char_and_length (const unsigned char *, int *);
805 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
807 static int compute_window_start_on_continuation_line (struct window
*);
808 static Lisp_Object
safe_eval_handler (Lisp_Object
);
809 static void insert_left_trunc_glyphs (struct it
*);
810 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
812 static void extend_face_to_end_of_line (struct it
*);
813 static int append_space_for_newline (struct it
*, int);
814 static int cursor_row_fully_visible_p (struct window
*, int, int);
815 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
816 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
817 static int trailing_whitespace_p (EMACS_INT
);
818 static unsigned long int message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
819 static void push_it (struct it
*, struct text_pos
*);
820 static void pop_it (struct it
*);
821 static void sync_frame_with_window_matrix_rows (struct window
*);
822 static void select_frame_for_redisplay (Lisp_Object
);
823 static void redisplay_internal (void);
824 static int echo_area_display (int);
825 static void redisplay_windows (Lisp_Object
);
826 static void redisplay_window (Lisp_Object
, int);
827 static Lisp_Object
redisplay_window_error (Lisp_Object
);
828 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
829 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
830 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
831 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
833 static int update_menu_bar (struct frame
*, int, int);
834 static int try_window_reusing_current_matrix (struct window
*);
835 static int try_window_id (struct window
*);
836 static int display_line (struct it
*);
837 static int display_mode_lines (struct window
*);
838 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
839 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
840 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
841 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
842 static void display_menu_bar (struct window
*);
843 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
845 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
846 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
847 static void compute_line_metrics (struct it
*);
848 static void run_redisplay_end_trigger_hook (struct it
*);
849 static int get_overlay_strings (struct it
*, EMACS_INT
);
850 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
851 static void next_overlay_string (struct it
*);
852 static void reseat (struct it
*, struct text_pos
, int);
853 static void reseat_1 (struct it
*, struct text_pos
, int);
854 static void back_to_previous_visible_line_start (struct it
*);
855 void reseat_at_previous_visible_line_start (struct it
*);
856 static void reseat_at_next_visible_line_start (struct it
*, int);
857 static int next_element_from_ellipsis (struct it
*);
858 static int next_element_from_display_vector (struct it
*);
859 static int next_element_from_string (struct it
*);
860 static int next_element_from_c_string (struct it
*);
861 static int next_element_from_buffer (struct it
*);
862 static int next_element_from_composition (struct it
*);
863 static int next_element_from_image (struct it
*);
864 static int next_element_from_stretch (struct it
*);
865 static void load_overlay_strings (struct it
*, EMACS_INT
);
866 static int init_from_display_pos (struct it
*, struct window
*,
867 struct display_pos
*);
868 static void reseat_to_string (struct it
*, const char *,
869 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
870 static int get_next_display_element (struct it
*);
871 static enum move_it_result
872 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
873 enum move_operation_enum
);
874 void move_it_vertically_backward (struct it
*, int);
875 static void init_to_row_start (struct it
*, struct window
*,
877 static int init_to_row_end (struct it
*, struct window
*,
879 static void back_to_previous_line_start (struct it
*);
880 static int forward_to_next_line_start (struct it
*, int *);
881 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
882 Lisp_Object
, EMACS_INT
);
883 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
884 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
885 static EMACS_INT
number_of_chars (const char *, int);
886 static void compute_stop_pos (struct it
*);
887 static void compute_string_pos (struct text_pos
*, struct text_pos
,
889 static int face_before_or_after_it_pos (struct it
*, int);
890 static EMACS_INT
next_overlay_change (EMACS_INT
);
891 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
892 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
893 static int handle_single_display_spec (struct it
*, Lisp_Object
,
894 Lisp_Object
, Lisp_Object
,
895 struct text_pos
*, EMACS_INT
, int, int);
896 static int underlying_face_id (struct it
*);
897 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
900 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
901 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
903 #ifdef HAVE_WINDOW_SYSTEM
905 static void x_consider_frame_title (Lisp_Object
);
906 static int tool_bar_lines_needed (struct frame
*, int *);
907 static void update_tool_bar (struct frame
*, int);
908 static void build_desired_tool_bar_string (struct frame
*f
);
909 static int redisplay_tool_bar (struct frame
*);
910 static void display_tool_bar_line (struct it
*, int);
911 static void notice_overwritten_cursor (struct window
*,
914 static void append_stretch_glyph (struct it
*, Lisp_Object
,
918 #endif /* HAVE_WINDOW_SYSTEM */
920 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
921 static int coords_in_mouse_face_p (struct window
*, int, int);
925 /***********************************************************************
926 Window display dimensions
927 ***********************************************************************/
929 /* Return the bottom boundary y-position for text lines in window W.
930 This is the first y position at which a line cannot start.
931 It is relative to the top of the window.
933 This is the height of W minus the height of a mode line, if any. */
936 window_text_bottom_y (struct window
*w
)
938 int height
= WINDOW_TOTAL_HEIGHT (w
);
940 if (WINDOW_WANTS_MODELINE_P (w
))
941 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
945 /* Return the pixel width of display area AREA of window W. AREA < 0
946 means return the total width of W, not including fringes to
947 the left and right of the window. */
950 window_box_width (struct window
*w
, int area
)
952 int cols
= XFASTINT (w
->total_cols
);
955 if (!w
->pseudo_window_p
)
957 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
959 if (area
== TEXT_AREA
)
961 if (INTEGERP (w
->left_margin_cols
))
962 cols
-= XFASTINT (w
->left_margin_cols
);
963 if (INTEGERP (w
->right_margin_cols
))
964 cols
-= XFASTINT (w
->right_margin_cols
);
965 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
967 else if (area
== LEFT_MARGIN_AREA
)
969 cols
= (INTEGERP (w
->left_margin_cols
)
970 ? XFASTINT (w
->left_margin_cols
) : 0);
973 else if (area
== RIGHT_MARGIN_AREA
)
975 cols
= (INTEGERP (w
->right_margin_cols
)
976 ? XFASTINT (w
->right_margin_cols
) : 0);
981 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
985 /* Return the pixel height of the display area of window W, not
986 including mode lines of W, if any. */
989 window_box_height (struct window
*w
)
991 struct frame
*f
= XFRAME (w
->frame
);
992 int height
= WINDOW_TOTAL_HEIGHT (w
);
994 xassert (height
>= 0);
996 /* Note: the code below that determines the mode-line/header-line
997 height is essentially the same as that contained in the macro
998 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
999 the appropriate glyph row has its `mode_line_p' flag set,
1000 and if it doesn't, uses estimate_mode_line_height instead. */
1002 if (WINDOW_WANTS_MODELINE_P (w
))
1004 struct glyph_row
*ml_row
1005 = (w
->current_matrix
&& w
->current_matrix
->rows
1006 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1008 if (ml_row
&& ml_row
->mode_line_p
)
1009 height
-= ml_row
->height
;
1011 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1014 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1016 struct glyph_row
*hl_row
1017 = (w
->current_matrix
&& w
->current_matrix
->rows
1018 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1020 if (hl_row
&& hl_row
->mode_line_p
)
1021 height
-= hl_row
->height
;
1023 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1026 /* With a very small font and a mode-line that's taller than
1027 default, we might end up with a negative height. */
1028 return max (0, height
);
1031 /* Return the window-relative coordinate of the left edge of display
1032 area AREA of window W. AREA < 0 means return the left edge of the
1033 whole window, to the right of the left fringe of W. */
1036 window_box_left_offset (struct window
*w
, int area
)
1040 if (w
->pseudo_window_p
)
1043 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1045 if (area
== TEXT_AREA
)
1046 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1047 + window_box_width (w
, LEFT_MARGIN_AREA
));
1048 else if (area
== RIGHT_MARGIN_AREA
)
1049 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1050 + window_box_width (w
, LEFT_MARGIN_AREA
)
1051 + window_box_width (w
, TEXT_AREA
)
1052 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1054 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1055 else if (area
== LEFT_MARGIN_AREA
1056 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1057 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1063 /* Return the window-relative coordinate of the right edge of display
1064 area AREA of window W. AREA < 0 means return the right edge of the
1065 whole window, to the left of the right fringe of W. */
1068 window_box_right_offset (struct window
*w
, int area
)
1070 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1073 /* Return the frame-relative coordinate of the left edge of display
1074 area AREA of window W. AREA < 0 means return the left edge of the
1075 whole window, to the right of the left fringe of W. */
1078 window_box_left (struct window
*w
, int area
)
1080 struct frame
*f
= XFRAME (w
->frame
);
1083 if (w
->pseudo_window_p
)
1084 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1086 x
= (WINDOW_LEFT_EDGE_X (w
)
1087 + window_box_left_offset (w
, area
));
1093 /* Return the frame-relative coordinate of the right edge of display
1094 area AREA of window W. AREA < 0 means return the right edge of the
1095 whole window, to the left of the right fringe of W. */
1098 window_box_right (struct window
*w
, int area
)
1100 return window_box_left (w
, area
) + window_box_width (w
, area
);
1103 /* Get the bounding box of the display area AREA of window W, without
1104 mode lines, in frame-relative coordinates. AREA < 0 means the
1105 whole window, not including the left and right fringes of
1106 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1107 coordinates of the upper-left corner of the box. Return in
1108 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1111 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1112 int *box_width
, int *box_height
)
1115 *box_width
= window_box_width (w
, area
);
1117 *box_height
= window_box_height (w
);
1119 *box_x
= window_box_left (w
, area
);
1122 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1123 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1124 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1129 /* Get the bounding box of the display area AREA of window W, without
1130 mode lines. AREA < 0 means the whole window, not including the
1131 left and right fringe of the window. Return in *TOP_LEFT_X
1132 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1133 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1134 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1138 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1139 int *bottom_right_x
, int *bottom_right_y
)
1141 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1143 *bottom_right_x
+= *top_left_x
;
1144 *bottom_right_y
+= *top_left_y
;
1149 /***********************************************************************
1151 ***********************************************************************/
1153 /* Return the bottom y-position of the line the iterator IT is in.
1154 This can modify IT's settings. */
1157 line_bottom_y (struct it
*it
)
1159 int line_height
= it
->max_ascent
+ it
->max_descent
;
1160 int line_top_y
= it
->current_y
;
1162 if (line_height
== 0)
1165 line_height
= last_height
;
1166 else if (IT_CHARPOS (*it
) < ZV
)
1168 move_it_by_lines (it
, 1);
1169 line_height
= (it
->max_ascent
|| it
->max_descent
1170 ? it
->max_ascent
+ it
->max_descent
1175 struct glyph_row
*row
= it
->glyph_row
;
1177 /* Use the default character height. */
1178 it
->glyph_row
= NULL
;
1179 it
->what
= IT_CHARACTER
;
1182 PRODUCE_GLYPHS (it
);
1183 line_height
= it
->ascent
+ it
->descent
;
1184 it
->glyph_row
= row
;
1188 return line_top_y
+ line_height
;
1192 /* Return 1 if position CHARPOS is visible in window W.
1193 CHARPOS < 0 means return info about WINDOW_END position.
1194 If visible, set *X and *Y to pixel coordinates of top left corner.
1195 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1196 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1199 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1200 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1203 struct text_pos top
;
1205 struct buffer
*old_buffer
= NULL
;
1207 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1210 if (XBUFFER (w
->buffer
) != current_buffer
)
1212 old_buffer
= current_buffer
;
1213 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1216 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1218 /* Compute exact mode line heights. */
1219 if (WINDOW_WANTS_MODELINE_P (w
))
1220 current_mode_line_height
1221 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1222 BVAR (current_buffer
, mode_line_format
));
1224 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1225 current_header_line_height
1226 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1227 BVAR (current_buffer
, header_line_format
));
1229 start_display (&it
, w
, top
);
1230 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1231 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1233 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1235 /* We have reached CHARPOS, or passed it. How the call to
1236 move_it_to can overshoot: (i) If CHARPOS is on invisible
1237 text, move_it_to stops at the end of the invisible text,
1238 after CHARPOS. (ii) If CHARPOS is in a display vector,
1239 move_it_to stops on its last glyph. */
1240 int top_x
= it
.current_x
;
1241 int top_y
= it
.current_y
;
1242 enum it_method it_method
= it
.method
;
1243 /* Calling line_bottom_y may change it.method, it.position, etc. */
1244 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1245 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1247 if (top_y
< window_top_y
)
1248 visible_p
= bottom_y
> window_top_y
;
1249 else if (top_y
< it
.last_visible_y
)
1253 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1255 /* We stopped on the last glyph of a display vector.
1256 Try and recompute. Hack alert! */
1257 if (charpos
< 2 || top
.charpos
>= charpos
)
1258 top_x
= it
.glyph_row
->x
;
1262 start_display (&it2
, w
, top
);
1263 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1264 get_next_display_element (&it2
);
1265 PRODUCE_GLYPHS (&it2
);
1266 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1267 || it2
.current_x
> it2
.last_visible_x
)
1268 top_x
= it
.glyph_row
->x
;
1271 top_x
= it2
.current_x
;
1272 top_y
= it2
.current_y
;
1278 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1279 *rtop
= max (0, window_top_y
- top_y
);
1280 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1281 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1282 - max (top_y
, window_top_y
)));
1291 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1292 move_it_by_lines (&it
, 1);
1293 if (charpos
< IT_CHARPOS (it
)
1294 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1297 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1299 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1300 *rtop
= max (0, -it2
.current_y
);
1301 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1302 - it
.last_visible_y
));
1303 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1305 - max (it2
.current_y
,
1306 WINDOW_HEADER_LINE_HEIGHT (w
))));
1312 set_buffer_internal_1 (old_buffer
);
1314 current_header_line_height
= current_mode_line_height
= -1;
1316 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1317 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1320 /* Debugging code. */
1322 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1323 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1325 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1332 /* Return the next character from STR. Return in *LEN the length of
1333 the character. This is like STRING_CHAR_AND_LENGTH but never
1334 returns an invalid character. If we find one, we return a `?', but
1335 with the length of the invalid character. */
1338 string_char_and_length (const unsigned char *str
, int *len
)
1342 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1343 if (!CHAR_VALID_P (c
, 1))
1344 /* We may not change the length here because other places in Emacs
1345 don't use this function, i.e. they silently accept invalid
1354 /* Given a position POS containing a valid character and byte position
1355 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1357 static struct text_pos
1358 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1360 xassert (STRINGP (string
) && nchars
>= 0);
1362 if (STRING_MULTIBYTE (string
))
1364 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1369 string_char_and_length (p
, &len
);
1372 BYTEPOS (pos
) += len
;
1376 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1382 /* Value is the text position, i.e. character and byte position,
1383 for character position CHARPOS in STRING. */
1385 static INLINE
struct text_pos
1386 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1388 struct text_pos pos
;
1389 xassert (STRINGP (string
));
1390 xassert (charpos
>= 0);
1391 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1396 /* Value is a text position, i.e. character and byte position, for
1397 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1398 means recognize multibyte characters. */
1400 static struct text_pos
1401 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1403 struct text_pos pos
;
1405 xassert (s
!= NULL
);
1406 xassert (charpos
>= 0);
1412 SET_TEXT_POS (pos
, 0, 0);
1415 string_char_and_length ((const unsigned char *) s
, &len
);
1418 BYTEPOS (pos
) += len
;
1422 SET_TEXT_POS (pos
, charpos
, charpos
);
1428 /* Value is the number of characters in C string S. MULTIBYTE_P
1429 non-zero means recognize multibyte characters. */
1432 number_of_chars (const char *s
, int multibyte_p
)
1438 EMACS_INT rest
= strlen (s
);
1440 const unsigned char *p
= (const unsigned char *) s
;
1442 for (nchars
= 0; rest
> 0; ++nchars
)
1444 string_char_and_length (p
, &len
);
1445 rest
-= len
, p
+= len
;
1449 nchars
= strlen (s
);
1455 /* Compute byte position NEWPOS->bytepos corresponding to
1456 NEWPOS->charpos. POS is a known position in string STRING.
1457 NEWPOS->charpos must be >= POS.charpos. */
1460 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1462 xassert (STRINGP (string
));
1463 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1465 if (STRING_MULTIBYTE (string
))
1466 *newpos
= string_pos_nchars_ahead (pos
, string
,
1467 CHARPOS (*newpos
) - CHARPOS (pos
));
1469 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1473 Return an estimation of the pixel height of mode or header lines on
1474 frame F. FACE_ID specifies what line's height to estimate. */
1477 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1479 #ifdef HAVE_WINDOW_SYSTEM
1480 if (FRAME_WINDOW_P (f
))
1482 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1484 /* This function is called so early when Emacs starts that the face
1485 cache and mode line face are not yet initialized. */
1486 if (FRAME_FACE_CACHE (f
))
1488 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1492 height
= FONT_HEIGHT (face
->font
);
1493 if (face
->box_line_width
> 0)
1494 height
+= 2 * face
->box_line_width
;
1505 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1506 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1507 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1508 not force the value into range. */
1511 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1512 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1515 #ifdef HAVE_WINDOW_SYSTEM
1516 if (FRAME_WINDOW_P (f
))
1518 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1519 even for negative values. */
1521 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1523 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1525 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1526 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1529 STORE_NATIVE_RECT (*bounds
,
1530 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1531 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1532 FRAME_COLUMN_WIDTH (f
) - 1,
1533 FRAME_LINE_HEIGHT (f
) - 1);
1539 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1540 pix_x
= FRAME_TOTAL_COLS (f
);
1544 else if (pix_y
> FRAME_LINES (f
))
1545 pix_y
= FRAME_LINES (f
);
1555 /* Find the glyph under window-relative coordinates X/Y in window W.
1556 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1557 strings. Return in *HPOS and *VPOS the row and column number of
1558 the glyph found. Return in *AREA the glyph area containing X.
1559 Value is a pointer to the glyph found or null if X/Y is not on
1560 text, or we can't tell because W's current matrix is not up to
1565 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1566 int *dx
, int *dy
, int *area
)
1568 struct glyph
*glyph
, *end
;
1569 struct glyph_row
*row
= NULL
;
1572 /* Find row containing Y. Give up if some row is not enabled. */
1573 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1575 row
= MATRIX_ROW (w
->current_matrix
, i
);
1576 if (!row
->enabled_p
)
1578 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1585 /* Give up if Y is not in the window. */
1586 if (i
== w
->current_matrix
->nrows
)
1589 /* Get the glyph area containing X. */
1590 if (w
->pseudo_window_p
)
1597 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1599 *area
= LEFT_MARGIN_AREA
;
1600 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1602 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1605 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1609 *area
= RIGHT_MARGIN_AREA
;
1610 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1614 /* Find glyph containing X. */
1615 glyph
= row
->glyphs
[*area
];
1616 end
= glyph
+ row
->used
[*area
];
1618 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1620 x
-= glyph
->pixel_width
;
1630 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1633 *hpos
= glyph
- row
->glyphs
[*area
];
1637 /* Convert frame-relative x/y to coordinates relative to window W.
1638 Takes pseudo-windows into account. */
1641 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1643 if (w
->pseudo_window_p
)
1645 /* A pseudo-window is always full-width, and starts at the
1646 left edge of the frame, plus a frame border. */
1647 struct frame
*f
= XFRAME (w
->frame
);
1648 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1649 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1653 *x
-= WINDOW_LEFT_EDGE_X (w
);
1654 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1658 #ifdef HAVE_WINDOW_SYSTEM
1661 Return in RECTS[] at most N clipping rectangles for glyph string S.
1662 Return the number of stored rectangles. */
1665 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1672 if (s
->row
->full_width_p
)
1674 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1675 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1676 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1678 /* Unless displaying a mode or menu bar line, which are always
1679 fully visible, clip to the visible part of the row. */
1680 if (s
->w
->pseudo_window_p
)
1681 r
.height
= s
->row
->visible_height
;
1683 r
.height
= s
->height
;
1687 /* This is a text line that may be partially visible. */
1688 r
.x
= window_box_left (s
->w
, s
->area
);
1689 r
.width
= window_box_width (s
->w
, s
->area
);
1690 r
.height
= s
->row
->visible_height
;
1694 if (r
.x
< s
->clip_head
->x
)
1696 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1697 r
.width
-= s
->clip_head
->x
- r
.x
;
1700 r
.x
= s
->clip_head
->x
;
1703 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1705 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1706 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1711 /* If S draws overlapping rows, it's sufficient to use the top and
1712 bottom of the window for clipping because this glyph string
1713 intentionally draws over other lines. */
1714 if (s
->for_overlaps
)
1716 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1717 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1719 /* Alas, the above simple strategy does not work for the
1720 environments with anti-aliased text: if the same text is
1721 drawn onto the same place multiple times, it gets thicker.
1722 If the overlap we are processing is for the erased cursor, we
1723 take the intersection with the rectagle of the cursor. */
1724 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1726 XRectangle rc
, r_save
= r
;
1728 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1729 rc
.y
= s
->w
->phys_cursor
.y
;
1730 rc
.width
= s
->w
->phys_cursor_width
;
1731 rc
.height
= s
->w
->phys_cursor_height
;
1733 x_intersect_rectangles (&r_save
, &rc
, &r
);
1738 /* Don't use S->y for clipping because it doesn't take partially
1739 visible lines into account. For example, it can be negative for
1740 partially visible lines at the top of a window. */
1741 if (!s
->row
->full_width_p
1742 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1743 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1745 r
.y
= max (0, s
->row
->y
);
1748 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1750 /* If drawing the cursor, don't let glyph draw outside its
1751 advertised boundaries. Cleartype does this under some circumstances. */
1752 if (s
->hl
== DRAW_CURSOR
)
1754 struct glyph
*glyph
= s
->first_glyph
;
1759 r
.width
-= s
->x
- r
.x
;
1762 r
.width
= min (r
.width
, glyph
->pixel_width
);
1764 /* If r.y is below window bottom, ensure that we still see a cursor. */
1765 height
= min (glyph
->ascent
+ glyph
->descent
,
1766 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1767 max_y
= window_text_bottom_y (s
->w
) - height
;
1768 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1769 if (s
->ybase
- glyph
->ascent
> max_y
)
1776 /* Don't draw cursor glyph taller than our actual glyph. */
1777 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1778 if (height
< r
.height
)
1780 max_y
= r
.y
+ r
.height
;
1781 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1782 r
.height
= min (max_y
- r
.y
, height
);
1789 XRectangle r_save
= r
;
1791 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1795 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1796 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1798 #ifdef CONVERT_FROM_XRECT
1799 CONVERT_FROM_XRECT (r
, *rects
);
1807 /* If we are processing overlapping and allowed to return
1808 multiple clipping rectangles, we exclude the row of the glyph
1809 string from the clipping rectangle. This is to avoid drawing
1810 the same text on the environment with anti-aliasing. */
1811 #ifdef CONVERT_FROM_XRECT
1814 XRectangle
*rs
= rects
;
1816 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1818 if (s
->for_overlaps
& OVERLAPS_PRED
)
1821 if (r
.y
+ r
.height
> row_y
)
1824 rs
[i
].height
= row_y
- r
.y
;
1830 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1833 if (r
.y
< row_y
+ s
->row
->visible_height
)
1835 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1837 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1838 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1847 #ifdef CONVERT_FROM_XRECT
1848 for (i
= 0; i
< n
; i
++)
1849 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1856 Return in *NR the clipping rectangle for glyph string S. */
1859 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1861 get_glyph_string_clip_rects (s
, nr
, 1);
1866 Return the position and height of the phys cursor in window W.
1867 Set w->phys_cursor_width to width of phys cursor.
1871 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1872 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1874 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1875 int x
, y
, wd
, h
, h0
, y0
;
1877 /* Compute the width of the rectangle to draw. If on a stretch
1878 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1879 rectangle as wide as the glyph, but use a canonical character
1881 wd
= glyph
->pixel_width
- 1;
1882 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1886 x
= w
->phys_cursor
.x
;
1893 if (glyph
->type
== STRETCH_GLYPH
1894 && !x_stretch_cursor_p
)
1895 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1896 w
->phys_cursor_width
= wd
;
1898 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1900 /* If y is below window bottom, ensure that we still see a cursor. */
1901 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1903 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1904 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1906 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1909 h
= max (h
- (y0
- y
) + 1, h0
);
1914 y0
= window_text_bottom_y (w
) - h0
;
1922 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1923 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1928 * Remember which glyph the mouse is over.
1932 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1936 struct glyph_row
*r
, *gr
, *end_row
;
1937 enum window_part part
;
1938 enum glyph_row_area area
;
1939 int x
, y
, width
, height
;
1941 /* Try to determine frame pixel position and size of the glyph under
1942 frame pixel coordinates X/Y on frame F. */
1944 if (!f
->glyphs_initialized_p
1945 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1948 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1949 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1953 w
= XWINDOW (window
);
1954 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1955 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1957 x
= window_relative_x_coord (w
, part
, gx
);
1958 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1960 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1961 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1963 if (w
->pseudo_window_p
)
1966 part
= ON_MODE_LINE
; /* Don't adjust margin. */
1972 case ON_LEFT_MARGIN
:
1973 area
= LEFT_MARGIN_AREA
;
1976 case ON_RIGHT_MARGIN
:
1977 area
= RIGHT_MARGIN_AREA
;
1980 case ON_HEADER_LINE
:
1982 gr
= (part
== ON_HEADER_LINE
1983 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1984 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
1987 goto text_glyph_row_found
;
1994 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
1995 if (r
->y
+ r
->height
> y
)
2001 text_glyph_row_found
:
2004 struct glyph
*g
= gr
->glyphs
[area
];
2005 struct glyph
*end
= g
+ gr
->used
[area
];
2007 height
= gr
->height
;
2008 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2009 if (gx
+ g
->pixel_width
> x
)
2014 if (g
->type
== IMAGE_GLYPH
)
2016 /* Don't remember when mouse is over image, as
2017 image may have hot-spots. */
2018 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2021 width
= g
->pixel_width
;
2025 /* Use nominal char spacing at end of line. */
2027 gx
+= (x
/ width
) * width
;
2030 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2031 gx
+= window_box_left_offset (w
, area
);
2035 /* Use nominal line height at end of window. */
2036 gx
= (x
/ width
) * width
;
2038 gy
+= (y
/ height
) * height
;
2042 case ON_LEFT_FRINGE
:
2043 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2044 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2045 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2046 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2049 case ON_RIGHT_FRINGE
:
2050 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2051 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2052 : window_box_right_offset (w
, TEXT_AREA
));
2053 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2057 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2059 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2060 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2061 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2063 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2067 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2068 if (r
->y
+ r
->height
> y
)
2075 height
= gr
->height
;
2078 /* Use nominal line height at end of window. */
2080 gy
+= (y
/ height
) * height
;
2087 /* If there is no glyph under the mouse, then we divide the screen
2088 into a grid of the smallest glyph in the frame, and use that
2091 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2092 round down even for negative values. */
2098 gx
= (gx
/ width
) * width
;
2099 gy
= (gy
/ height
) * height
;
2104 gx
+= WINDOW_LEFT_EDGE_X (w
);
2105 gy
+= WINDOW_TOP_EDGE_Y (w
);
2108 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2110 /* Visible feedback for debugging. */
2113 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2114 f
->output_data
.x
->normal_gc
,
2115 gx
, gy
, width
, height
);
2121 #endif /* HAVE_WINDOW_SYSTEM */
2124 /***********************************************************************
2125 Lisp form evaluation
2126 ***********************************************************************/
2128 /* Error handler for safe_eval and safe_call. */
2131 safe_eval_handler (Lisp_Object arg
)
2133 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2138 /* Evaluate SEXPR and return the result, or nil if something went
2139 wrong. Prevent redisplay during the evaluation. */
2141 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2142 Return the result, or nil if something went wrong. Prevent
2143 redisplay during the evaluation. */
2146 safe_call (size_t nargs
, Lisp_Object
*args
)
2150 if (inhibit_eval_during_redisplay
)
2154 int count
= SPECPDL_INDEX ();
2155 struct gcpro gcpro1
;
2158 gcpro1
.nvars
= nargs
;
2159 specbind (Qinhibit_redisplay
, Qt
);
2160 /* Use Qt to ensure debugger does not run,
2161 so there is no possibility of wanting to redisplay. */
2162 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2165 val
= unbind_to (count
, val
);
2172 /* Call function FN with one argument ARG.
2173 Return the result, or nil if something went wrong. */
2176 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2178 Lisp_Object args
[2];
2181 return safe_call (2, args
);
2184 static Lisp_Object Qeval
;
2187 safe_eval (Lisp_Object sexpr
)
2189 return safe_call1 (Qeval
, sexpr
);
2192 /* Call function FN with one argument ARG.
2193 Return the result, or nil if something went wrong. */
2196 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2198 Lisp_Object args
[3];
2202 return safe_call (3, args
);
2207 /***********************************************************************
2209 ***********************************************************************/
2213 /* Define CHECK_IT to perform sanity checks on iterators.
2214 This is for debugging. It is too slow to do unconditionally. */
2220 if (it
->method
== GET_FROM_STRING
)
2222 xassert (STRINGP (it
->string
));
2223 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2227 xassert (IT_STRING_CHARPOS (*it
) < 0);
2228 if (it
->method
== GET_FROM_BUFFER
)
2230 /* Check that character and byte positions agree. */
2231 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2236 xassert (it
->current
.dpvec_index
>= 0);
2238 xassert (it
->current
.dpvec_index
< 0);
2241 #define CHECK_IT(IT) check_it ((IT))
2245 #define CHECK_IT(IT) (void) 0
2252 /* Check that the window end of window W is what we expect it
2253 to be---the last row in the current matrix displaying text. */
2256 check_window_end (w
)
2259 if (!MINI_WINDOW_P (w
)
2260 && !NILP (w
->window_end_valid
))
2262 struct glyph_row
*row
;
2263 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2264 XFASTINT (w
->window_end_vpos
)),
2266 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2267 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2271 #define CHECK_WINDOW_END(W) check_window_end ((W))
2273 #else /* not GLYPH_DEBUG */
2275 #define CHECK_WINDOW_END(W) (void) 0
2277 #endif /* not GLYPH_DEBUG */
2281 /***********************************************************************
2282 Iterator initialization
2283 ***********************************************************************/
2285 /* Initialize IT for displaying current_buffer in window W, starting
2286 at character position CHARPOS. CHARPOS < 0 means that no buffer
2287 position is specified which is useful when the iterator is assigned
2288 a position later. BYTEPOS is the byte position corresponding to
2289 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2291 If ROW is not null, calls to produce_glyphs with IT as parameter
2292 will produce glyphs in that row.
2294 BASE_FACE_ID is the id of a base face to use. It must be one of
2295 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2296 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2297 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2299 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2300 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2301 will be initialized to use the corresponding mode line glyph row of
2302 the desired matrix of W. */
2305 init_iterator (struct it
*it
, struct window
*w
,
2306 EMACS_INT charpos
, EMACS_INT bytepos
,
2307 struct glyph_row
*row
, enum face_id base_face_id
)
2309 int highlight_region_p
;
2310 enum face_id remapped_base_face_id
= base_face_id
;
2312 /* Some precondition checks. */
2313 xassert (w
!= NULL
&& it
!= NULL
);
2314 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2317 /* If face attributes have been changed since the last redisplay,
2318 free realized faces now because they depend on face definitions
2319 that might have changed. Don't free faces while there might be
2320 desired matrices pending which reference these faces. */
2321 if (face_change_count
&& !inhibit_free_realized_faces
)
2323 face_change_count
= 0;
2324 free_all_realized_faces (Qnil
);
2327 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2328 if (! NILP (Vface_remapping_alist
))
2329 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2331 /* Use one of the mode line rows of W's desired matrix if
2335 if (base_face_id
== MODE_LINE_FACE_ID
2336 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2337 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2338 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2339 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2343 memset (it
, 0, sizeof *it
);
2344 it
->current
.overlay_string_index
= -1;
2345 it
->current
.dpvec_index
= -1;
2346 it
->base_face_id
= remapped_base_face_id
;
2348 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2349 it
->paragraph_embedding
= L2R
;
2350 it
->bidi_it
.string
.lstring
= Qnil
;
2351 it
->bidi_it
.string
.s
= NULL
;
2353 /* The window in which we iterate over current_buffer: */
2354 XSETWINDOW (it
->window
, w
);
2356 it
->f
= XFRAME (w
->frame
);
2360 /* Extra space between lines (on window systems only). */
2361 if (base_face_id
== DEFAULT_FACE_ID
2362 && FRAME_WINDOW_P (it
->f
))
2364 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2365 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2366 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2367 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2368 * FRAME_LINE_HEIGHT (it
->f
));
2369 else if (it
->f
->extra_line_spacing
> 0)
2370 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2371 it
->max_extra_line_spacing
= 0;
2374 /* If realized faces have been removed, e.g. because of face
2375 attribute changes of named faces, recompute them. When running
2376 in batch mode, the face cache of the initial frame is null. If
2377 we happen to get called, make a dummy face cache. */
2378 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2379 init_frame_faces (it
->f
);
2380 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2381 recompute_basic_faces (it
->f
);
2383 /* Current value of the `slice', `space-width', and 'height' properties. */
2384 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2385 it
->space_width
= Qnil
;
2386 it
->font_height
= Qnil
;
2387 it
->override_ascent
= -1;
2389 /* Are control characters displayed as `^C'? */
2390 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2392 /* -1 means everything between a CR and the following line end
2393 is invisible. >0 means lines indented more than this value are
2395 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2396 ? XFASTINT (BVAR (current_buffer
, selective_display
))
2397 : (!NILP (BVAR (current_buffer
, selective_display
))
2399 it
->selective_display_ellipsis_p
2400 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2402 /* Display table to use. */
2403 it
->dp
= window_display_table (w
);
2405 /* Are multibyte characters enabled in current_buffer? */
2406 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2408 /* Do we need to reorder bidirectional text? Not if this is a
2409 unibyte buffer: by definition, none of the single-byte characters
2410 are strong R2L, so no reordering is needed. And bidi.c doesn't
2411 support unibyte buffers anyway. */
2413 = !NILP (BVAR (current_buffer
, bidi_display_reordering
)) && it
->multibyte_p
;
2415 /* Non-zero if we should highlight the region. */
2417 = (!NILP (Vtransient_mark_mode
)
2418 && !NILP (BVAR (current_buffer
, mark_active
))
2419 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2421 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2422 start and end of a visible region in window IT->w. Set both to
2423 -1 to indicate no region. */
2424 if (highlight_region_p
2425 /* Maybe highlight only in selected window. */
2426 && (/* Either show region everywhere. */
2427 highlight_nonselected_windows
2428 /* Or show region in the selected window. */
2429 || w
== XWINDOW (selected_window
)
2430 /* Or show the region if we are in the mini-buffer and W is
2431 the window the mini-buffer refers to. */
2432 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2433 && WINDOWP (minibuf_selected_window
)
2434 && w
== XWINDOW (minibuf_selected_window
))))
2436 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2437 it
->region_beg_charpos
= min (PT
, markpos
);
2438 it
->region_end_charpos
= max (PT
, markpos
);
2441 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2443 /* Get the position at which the redisplay_end_trigger hook should
2444 be run, if it is to be run at all. */
2445 if (MARKERP (w
->redisplay_end_trigger
)
2446 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2447 it
->redisplay_end_trigger_charpos
2448 = marker_position (w
->redisplay_end_trigger
);
2449 else if (INTEGERP (w
->redisplay_end_trigger
))
2450 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2452 /* Correct bogus values of tab_width. */
2453 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2454 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2457 /* Are lines in the display truncated? */
2458 if (base_face_id
!= DEFAULT_FACE_ID
2459 || XINT (it
->w
->hscroll
)
2460 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2461 && ((!NILP (Vtruncate_partial_width_windows
)
2462 && !INTEGERP (Vtruncate_partial_width_windows
))
2463 || (INTEGERP (Vtruncate_partial_width_windows
)
2464 && (WINDOW_TOTAL_COLS (it
->w
)
2465 < XINT (Vtruncate_partial_width_windows
))))))
2466 it
->line_wrap
= TRUNCATE
;
2467 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2468 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2469 ? WINDOW_WRAP
: WORD_WRAP
;
2471 it
->line_wrap
= TRUNCATE
;
2473 /* Get dimensions of truncation and continuation glyphs. These are
2474 displayed as fringe bitmaps under X, so we don't need them for such
2476 if (!FRAME_WINDOW_P (it
->f
))
2478 if (it
->line_wrap
== TRUNCATE
)
2480 /* We will need the truncation glyph. */
2481 xassert (it
->glyph_row
== NULL
);
2482 produce_special_glyphs (it
, IT_TRUNCATION
);
2483 it
->truncation_pixel_width
= it
->pixel_width
;
2487 /* We will need the continuation glyph. */
2488 xassert (it
->glyph_row
== NULL
);
2489 produce_special_glyphs (it
, IT_CONTINUATION
);
2490 it
->continuation_pixel_width
= it
->pixel_width
;
2493 /* Reset these values to zero because the produce_special_glyphs
2494 above has changed them. */
2495 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2496 it
->phys_ascent
= it
->phys_descent
= 0;
2499 /* Set this after getting the dimensions of truncation and
2500 continuation glyphs, so that we don't produce glyphs when calling
2501 produce_special_glyphs, above. */
2502 it
->glyph_row
= row
;
2503 it
->area
= TEXT_AREA
;
2505 /* Forget any previous info about this row being reversed. */
2507 it
->glyph_row
->reversed_p
= 0;
2509 /* Get the dimensions of the display area. The display area
2510 consists of the visible window area plus a horizontally scrolled
2511 part to the left of the window. All x-values are relative to the
2512 start of this total display area. */
2513 if (base_face_id
!= DEFAULT_FACE_ID
)
2515 /* Mode lines, menu bar in terminal frames. */
2516 it
->first_visible_x
= 0;
2517 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2522 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2523 it
->last_visible_x
= (it
->first_visible_x
2524 + window_box_width (w
, TEXT_AREA
));
2526 /* If we truncate lines, leave room for the truncator glyph(s) at
2527 the right margin. Otherwise, leave room for the continuation
2528 glyph(s). Truncation and continuation glyphs are not inserted
2529 for window-based redisplay. */
2530 if (!FRAME_WINDOW_P (it
->f
))
2532 if (it
->line_wrap
== TRUNCATE
)
2533 it
->last_visible_x
-= it
->truncation_pixel_width
;
2535 it
->last_visible_x
-= it
->continuation_pixel_width
;
2538 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2539 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2542 /* Leave room for a border glyph. */
2543 if (!FRAME_WINDOW_P (it
->f
)
2544 && !WINDOW_RIGHTMOST_P (it
->w
))
2545 it
->last_visible_x
-= 1;
2547 it
->last_visible_y
= window_text_bottom_y (w
);
2549 /* For mode lines and alike, arrange for the first glyph having a
2550 left box line if the face specifies a box. */
2551 if (base_face_id
!= DEFAULT_FACE_ID
)
2555 it
->face_id
= remapped_base_face_id
;
2557 /* If we have a boxed mode line, make the first character appear
2558 with a left box line. */
2559 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2560 if (face
->box
!= FACE_NO_BOX
)
2561 it
->start_of_box_run_p
= 1;
2564 /* If a buffer position was specified, set the iterator there,
2565 getting overlays and face properties from that position. */
2566 if (charpos
>= BUF_BEG (current_buffer
))
2568 it
->end_charpos
= ZV
;
2570 IT_CHARPOS (*it
) = charpos
;
2572 /* Compute byte position if not specified. */
2573 if (bytepos
< charpos
)
2574 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2576 IT_BYTEPOS (*it
) = bytepos
;
2578 it
->start
= it
->current
;
2580 /* If we are to reorder bidirectional text, init the bidi
2584 /* Note the paragraph direction that this buffer wants to
2586 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2588 it
->paragraph_embedding
= L2R
;
2589 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2591 it
->paragraph_embedding
= R2L
;
2593 it
->paragraph_embedding
= NEUTRAL_DIR
;
2594 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2598 /* Compute faces etc. */
2599 reseat (it
, it
->current
.pos
, 1);
2606 /* Initialize IT for the display of window W with window start POS. */
2609 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2611 struct glyph_row
*row
;
2612 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2614 row
= w
->desired_matrix
->rows
+ first_vpos
;
2615 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2616 it
->first_vpos
= first_vpos
;
2618 /* Don't reseat to previous visible line start if current start
2619 position is in a string or image. */
2620 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2622 int start_at_line_beg_p
;
2623 int first_y
= it
->current_y
;
2625 /* If window start is not at a line start, skip forward to POS to
2626 get the correct continuation lines width. */
2627 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2628 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2629 if (!start_at_line_beg_p
)
2633 reseat_at_previous_visible_line_start (it
);
2634 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2636 new_x
= it
->current_x
+ it
->pixel_width
;
2638 /* If lines are continued, this line may end in the middle
2639 of a multi-glyph character (e.g. a control character
2640 displayed as \003, or in the middle of an overlay
2641 string). In this case move_it_to above will not have
2642 taken us to the start of the continuation line but to the
2643 end of the continued line. */
2644 if (it
->current_x
> 0
2645 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2646 && (/* And glyph doesn't fit on the line. */
2647 new_x
> it
->last_visible_x
2648 /* Or it fits exactly and we're on a window
2650 || (new_x
== it
->last_visible_x
2651 && FRAME_WINDOW_P (it
->f
))))
2653 if (it
->current
.dpvec_index
>= 0
2654 || it
->current
.overlay_string_index
>= 0)
2656 set_iterator_to_next (it
, 1);
2657 move_it_in_display_line_to (it
, -1, -1, 0);
2660 it
->continuation_lines_width
+= it
->current_x
;
2663 /* We're starting a new display line, not affected by the
2664 height of the continued line, so clear the appropriate
2665 fields in the iterator structure. */
2666 it
->max_ascent
= it
->max_descent
= 0;
2667 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2669 it
->current_y
= first_y
;
2671 it
->current_x
= it
->hpos
= 0;
2677 /* Return 1 if POS is a position in ellipses displayed for invisible
2678 text. W is the window we display, for text property lookup. */
2681 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2683 Lisp_Object prop
, window
;
2685 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2687 /* If POS specifies a position in a display vector, this might
2688 be for an ellipsis displayed for invisible text. We won't
2689 get the iterator set up for delivering that ellipsis unless
2690 we make sure that it gets aware of the invisible text. */
2691 if (pos
->dpvec_index
>= 0
2692 && pos
->overlay_string_index
< 0
2693 && CHARPOS (pos
->string_pos
) < 0
2695 && (XSETWINDOW (window
, w
),
2696 prop
= Fget_char_property (make_number (charpos
),
2697 Qinvisible
, window
),
2698 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2700 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2702 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2709 /* Initialize IT for stepping through current_buffer in window W,
2710 starting at position POS that includes overlay string and display
2711 vector/ control character translation position information. Value
2712 is zero if there are overlay strings with newlines at POS. */
2715 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2717 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2718 int i
, overlay_strings_with_newlines
= 0;
2720 /* If POS specifies a position in a display vector, this might
2721 be for an ellipsis displayed for invisible text. We won't
2722 get the iterator set up for delivering that ellipsis unless
2723 we make sure that it gets aware of the invisible text. */
2724 if (in_ellipses_for_invisible_text_p (pos
, w
))
2730 /* Keep in mind: the call to reseat in init_iterator skips invisible
2731 text, so we might end up at a position different from POS. This
2732 is only a problem when POS is a row start after a newline and an
2733 overlay starts there with an after-string, and the overlay has an
2734 invisible property. Since we don't skip invisible text in
2735 display_line and elsewhere immediately after consuming the
2736 newline before the row start, such a POS will not be in a string,
2737 but the call to init_iterator below will move us to the
2739 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2741 /* This only scans the current chunk -- it should scan all chunks.
2742 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2743 to 16 in 22.1 to make this a lesser problem. */
2744 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2746 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2747 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2749 while (s
< e
&& *s
!= '\n')
2754 overlay_strings_with_newlines
= 1;
2759 /* If position is within an overlay string, set up IT to the right
2761 if (pos
->overlay_string_index
>= 0)
2765 /* If the first overlay string happens to have a `display'
2766 property for an image, the iterator will be set up for that
2767 image, and we have to undo that setup first before we can
2768 correct the overlay string index. */
2769 if (it
->method
== GET_FROM_IMAGE
)
2772 /* We already have the first chunk of overlay strings in
2773 IT->overlay_strings. Load more until the one for
2774 pos->overlay_string_index is in IT->overlay_strings. */
2775 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2777 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2778 it
->current
.overlay_string_index
= 0;
2781 load_overlay_strings (it
, 0);
2782 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2786 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2787 relative_index
= (it
->current
.overlay_string_index
2788 % OVERLAY_STRING_CHUNK_SIZE
);
2789 it
->string
= it
->overlay_strings
[relative_index
];
2790 xassert (STRINGP (it
->string
));
2791 it
->current
.string_pos
= pos
->string_pos
;
2792 it
->method
= GET_FROM_STRING
;
2795 if (CHARPOS (pos
->string_pos
) >= 0)
2797 /* Recorded position is not in an overlay string, but in another
2798 string. This can only be a string from a `display' property.
2799 IT should already be filled with that string. */
2800 it
->current
.string_pos
= pos
->string_pos
;
2801 xassert (STRINGP (it
->string
));
2804 /* Restore position in display vector translations, control
2805 character translations or ellipses. */
2806 if (pos
->dpvec_index
>= 0)
2808 if (it
->dpvec
== NULL
)
2809 get_next_display_element (it
);
2810 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2811 it
->current
.dpvec_index
= pos
->dpvec_index
;
2815 return !overlay_strings_with_newlines
;
2819 /* Initialize IT for stepping through current_buffer in window W
2820 starting at ROW->start. */
2823 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2825 init_from_display_pos (it
, w
, &row
->start
);
2826 it
->start
= row
->start
;
2827 it
->continuation_lines_width
= row
->continuation_lines_width
;
2832 /* Initialize IT for stepping through current_buffer in window W
2833 starting in the line following ROW, i.e. starting at ROW->end.
2834 Value is zero if there are overlay strings with newlines at ROW's
2838 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2842 if (init_from_display_pos (it
, w
, &row
->end
))
2844 if (row
->continued_p
)
2845 it
->continuation_lines_width
2846 = row
->continuation_lines_width
+ row
->pixel_width
;
2857 /***********************************************************************
2859 ***********************************************************************/
2861 /* Called when IT reaches IT->stop_charpos. Handle text property and
2862 overlay changes. Set IT->stop_charpos to the next position where
2866 handle_stop (struct it
*it
)
2868 enum prop_handled handled
;
2869 int handle_overlay_change_p
;
2873 it
->current
.dpvec_index
= -1;
2874 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2875 it
->ignore_overlay_strings_at_pos_p
= 0;
2878 /* Use face of preceding text for ellipsis (if invisible) */
2879 if (it
->selective_display_ellipsis_p
)
2880 it
->saved_face_id
= it
->face_id
;
2884 handled
= HANDLED_NORMALLY
;
2886 /* Call text property handlers. */
2887 for (p
= it_props
; p
->handler
; ++p
)
2889 handled
= p
->handler (it
);
2891 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2893 else if (handled
== HANDLED_RETURN
)
2895 /* We still want to show before and after strings from
2896 overlays even if the actual buffer text is replaced. */
2897 if (!handle_overlay_change_p
2899 || !get_overlay_strings_1 (it
, 0, 0))
2902 setup_for_ellipsis (it
, 0);
2903 /* When handling a display spec, we might load an
2904 empty string. In that case, discard it here. We
2905 used to discard it in handle_single_display_spec,
2906 but that causes get_overlay_strings_1, above, to
2907 ignore overlay strings that we must check. */
2908 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2912 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2916 it
->ignore_overlay_strings_at_pos_p
= 1;
2917 it
->string_from_display_prop_p
= 0;
2918 handle_overlay_change_p
= 0;
2920 handled
= HANDLED_RECOMPUTE_PROPS
;
2923 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2924 handle_overlay_change_p
= 0;
2927 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2929 /* Don't check for overlay strings below when set to deliver
2930 characters from a display vector. */
2931 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2932 handle_overlay_change_p
= 0;
2934 /* Handle overlay changes.
2935 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2936 if it finds overlays. */
2937 if (handle_overlay_change_p
)
2938 handled
= handle_overlay_change (it
);
2943 setup_for_ellipsis (it
, 0);
2947 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2949 /* Determine where to stop next. */
2950 if (handled
== HANDLED_NORMALLY
)
2951 compute_stop_pos (it
);
2955 /* Compute IT->stop_charpos from text property and overlay change
2956 information for IT's current position. */
2959 compute_stop_pos (struct it
*it
)
2961 register INTERVAL iv
, next_iv
;
2962 Lisp_Object object
, limit
, position
;
2963 EMACS_INT charpos
, bytepos
;
2965 /* If nowhere else, stop at the end. */
2966 it
->stop_charpos
= it
->end_charpos
;
2968 if (STRINGP (it
->string
))
2970 /* Strings are usually short, so don't limit the search for
2972 object
= it
->string
;
2974 charpos
= IT_STRING_CHARPOS (*it
);
2975 bytepos
= IT_STRING_BYTEPOS (*it
);
2981 /* If next overlay change is in front of the current stop pos
2982 (which is IT->end_charpos), stop there. Note: value of
2983 next_overlay_change is point-max if no overlay change
2985 charpos
= IT_CHARPOS (*it
);
2986 bytepos
= IT_BYTEPOS (*it
);
2987 pos
= next_overlay_change (charpos
);
2988 if (pos
< it
->stop_charpos
)
2989 it
->stop_charpos
= pos
;
2991 /* If showing the region, we have to stop at the region
2992 start or end because the face might change there. */
2993 if (it
->region_beg_charpos
> 0)
2995 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2996 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2997 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2998 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3001 /* Set up variables for computing the stop position from text
3002 property changes. */
3003 XSETBUFFER (object
, current_buffer
);
3004 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3007 /* Get the interval containing IT's position. Value is a null
3008 interval if there isn't such an interval. */
3009 position
= make_number (charpos
);
3010 iv
= validate_interval_range (object
, &position
, &position
, 0);
3011 if (!NULL_INTERVAL_P (iv
))
3013 Lisp_Object values_here
[LAST_PROP_IDX
];
3016 /* Get properties here. */
3017 for (p
= it_props
; p
->handler
; ++p
)
3018 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3020 /* Look for an interval following iv that has different
3022 for (next_iv
= next_interval (iv
);
3023 (!NULL_INTERVAL_P (next_iv
)
3025 || XFASTINT (limit
) > next_iv
->position
));
3026 next_iv
= next_interval (next_iv
))
3028 for (p
= it_props
; p
->handler
; ++p
)
3030 Lisp_Object new_value
;
3032 new_value
= textget (next_iv
->plist
, *p
->name
);
3033 if (!EQ (values_here
[p
->idx
], new_value
))
3041 if (!NULL_INTERVAL_P (next_iv
))
3043 if (INTEGERP (limit
)
3044 && next_iv
->position
>= XFASTINT (limit
))
3045 /* No text property change up to limit. */
3046 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3048 /* Text properties change in next_iv. */
3049 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3053 if (it
->cmp_it
.id
< 0)
3055 EMACS_INT stoppos
= it
->end_charpos
;
3057 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3059 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3060 stoppos
, it
->string
);
3063 xassert (STRINGP (it
->string
)
3064 || (it
->stop_charpos
>= BEGV
3065 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3069 /* Return the position of the next overlay change after POS in
3070 current_buffer. Value is point-max if no overlay change
3071 follows. This is like `next-overlay-change' but doesn't use
3075 next_overlay_change (EMACS_INT pos
)
3079 Lisp_Object
*overlays
;
3082 /* Get all overlays at the given position. */
3083 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3085 /* If any of these overlays ends before endpos,
3086 use its ending point instead. */
3087 for (i
= 0; i
< noverlays
; ++i
)
3092 oend
= OVERLAY_END (overlays
[i
]);
3093 oendpos
= OVERLAY_POSITION (oend
);
3094 endpos
= min (endpos
, oendpos
);
3100 /* Return the character position of a display string at or after
3101 CHARPOS. If no display string exists at or after CHARPOS, return
3102 ZV. A display string is either an overlay with `display' property
3103 whose value is a string, or a `display' text property whose value
3104 is a string. STRING is the string to iterate; if STRING->s is
3105 NULL, we are iterating a buffer. FRAME_WINDOW_P is non-zero when
3106 we are displaying a window on a GUI frame. */
3108 compute_display_string_pos (EMACS_INT charpos
, struct bidi_string_data
*string
,
3111 /* FIXME: Support display properties on strings (object = Qnil means
3113 Lisp_Object object
= Qnil
;
3114 Lisp_Object pos
, spec
;
3115 struct text_pos position
;
3121 /* If the character at CHARPOS is where the display string begins,
3123 pos
= make_number (charpos
);
3124 CHARPOS (position
) = charpos
;
3125 BYTEPOS (position
) = CHAR_TO_BYTE (charpos
);
3126 bufpos
= charpos
; /* FIXME! support strings as well */
3127 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3129 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3132 && handle_display_spec (NULL
, spec
, object
, Qnil
, &position
, bufpos
,
3136 /* Look forward for the first character with a `display' property
3137 that will replace the underlying text when displayed. */
3139 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3140 CHARPOS (position
) = XFASTINT (pos
);
3141 BYTEPOS (position
) = CHAR_TO_BYTE (CHARPOS (position
));
3142 if (CHARPOS (position
) >= ZV
)
3144 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3145 bufpos
= CHARPOS (position
); /* FIXME! support strings as well */
3146 } while (NILP (spec
)
3147 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &position
, bufpos
,
3150 return CHARPOS (position
);
3153 /* Return the character position of the end of the display string that
3154 started at CHARPOS. A display string is either an overlay with
3155 `display' property whose value is a string or a `display' text
3156 property whose value is a string. */
3158 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3160 /* FIXME: Support display properties on strings (object = Qnil means
3162 Lisp_Object object
= Qnil
;
3163 Lisp_Object pos
= make_number (charpos
);
3168 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3171 /* Look forward for the first character where the `display' property
3173 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3175 return XFASTINT (pos
);
3180 /***********************************************************************
3182 ***********************************************************************/
3184 /* Handle changes in the `fontified' property of the current buffer by
3185 calling hook functions from Qfontification_functions to fontify
3188 static enum prop_handled
3189 handle_fontified_prop (struct it
*it
)
3191 Lisp_Object prop
, pos
;
3192 enum prop_handled handled
= HANDLED_NORMALLY
;
3194 if (!NILP (Vmemory_full
))
3197 /* Get the value of the `fontified' property at IT's current buffer
3198 position. (The `fontified' property doesn't have a special
3199 meaning in strings.) If the value is nil, call functions from
3200 Qfontification_functions. */
3201 if (!STRINGP (it
->string
)
3203 && !NILP (Vfontification_functions
)
3204 && !NILP (Vrun_hooks
)
3205 && (pos
= make_number (IT_CHARPOS (*it
)),
3206 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3207 /* Ignore the special cased nil value always present at EOB since
3208 no amount of fontifying will be able to change it. */
3209 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3211 int count
= SPECPDL_INDEX ();
3213 struct buffer
*obuf
= current_buffer
;
3214 int begv
= BEGV
, zv
= ZV
;
3215 int old_clip_changed
= current_buffer
->clip_changed
;
3217 val
= Vfontification_functions
;
3218 specbind (Qfontification_functions
, Qnil
);
3220 xassert (it
->end_charpos
== ZV
);
3222 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3223 safe_call1 (val
, pos
);
3226 Lisp_Object fns
, fn
;
3227 struct gcpro gcpro1
, gcpro2
;
3232 for (; CONSP (val
); val
= XCDR (val
))
3238 /* A value of t indicates this hook has a local
3239 binding; it means to run the global binding too.
3240 In a global value, t should not occur. If it
3241 does, we must ignore it to avoid an endless
3243 for (fns
= Fdefault_value (Qfontification_functions
);
3249 safe_call1 (fn
, pos
);
3253 safe_call1 (fn
, pos
);
3259 unbind_to (count
, Qnil
);
3261 /* Fontification functions routinely call `save-restriction'.
3262 Normally, this tags clip_changed, which can confuse redisplay
3263 (see discussion in Bug#6671). Since we don't perform any
3264 special handling of fontification changes in the case where
3265 `save-restriction' isn't called, there's no point doing so in
3266 this case either. So, if the buffer's restrictions are
3267 actually left unchanged, reset clip_changed. */
3268 if (obuf
== current_buffer
)
3270 if (begv
== BEGV
&& zv
== ZV
)
3271 current_buffer
->clip_changed
= old_clip_changed
;
3273 /* There isn't much we can reasonably do to protect against
3274 misbehaving fontification, but here's a fig leaf. */
3275 else if (!NILP (BVAR (obuf
, name
)))
3276 set_buffer_internal_1 (obuf
);
3278 /* The fontification code may have added/removed text.
3279 It could do even a lot worse, but let's at least protect against
3280 the most obvious case where only the text past `pos' gets changed',
3281 as is/was done in grep.el where some escapes sequences are turned
3282 into face properties (bug#7876). */
3283 it
->end_charpos
= ZV
;
3285 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3286 something. This avoids an endless loop if they failed to
3287 fontify the text for which reason ever. */
3288 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3289 handled
= HANDLED_RECOMPUTE_PROPS
;
3297 /***********************************************************************
3299 ***********************************************************************/
3301 /* Set up iterator IT from face properties at its current position.
3302 Called from handle_stop. */
3304 static enum prop_handled
3305 handle_face_prop (struct it
*it
)
3308 EMACS_INT next_stop
;
3310 if (!STRINGP (it
->string
))
3313 = face_at_buffer_position (it
->w
,
3315 it
->region_beg_charpos
,
3316 it
->region_end_charpos
,
3319 + TEXT_PROP_DISTANCE_LIMIT
),
3320 0, it
->base_face_id
);
3322 /* Is this a start of a run of characters with box face?
3323 Caveat: this can be called for a freshly initialized
3324 iterator; face_id is -1 in this case. We know that the new
3325 face will not change until limit, i.e. if the new face has a
3326 box, all characters up to limit will have one. But, as
3327 usual, we don't know whether limit is really the end. */
3328 if (new_face_id
!= it
->face_id
)
3330 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3332 /* If new face has a box but old face has not, this is
3333 the start of a run of characters with box, i.e. it has
3334 a shadow on the left side. The value of face_id of the
3335 iterator will be -1 if this is the initial call that gets
3336 the face. In this case, we have to look in front of IT's
3337 position and see whether there is a face != new_face_id. */
3338 it
->start_of_box_run_p
3339 = (new_face
->box
!= FACE_NO_BOX
3340 && (it
->face_id
>= 0
3341 || IT_CHARPOS (*it
) == BEG
3342 || new_face_id
!= face_before_it_pos (it
)));
3343 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3351 Lisp_Object from_overlay
3352 = (it
->current
.overlay_string_index
>= 0
3353 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3356 /* See if we got to this string directly or indirectly from
3357 an overlay property. That includes the before-string or
3358 after-string of an overlay, strings in display properties
3359 provided by an overlay, their text properties, etc.
3361 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3362 if (! NILP (from_overlay
))
3363 for (i
= it
->sp
- 1; i
>= 0; i
--)
3365 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3367 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3368 else if (! NILP (it
->stack
[i
].from_overlay
))
3369 from_overlay
= it
->stack
[i
].from_overlay
;
3371 if (!NILP (from_overlay
))
3375 if (! NILP (from_overlay
))
3377 bufpos
= IT_CHARPOS (*it
);
3378 /* For a string from an overlay, the base face depends
3379 only on text properties and ignores overlays. */
3381 = face_for_overlay_string (it
->w
,
3383 it
->region_beg_charpos
,
3384 it
->region_end_charpos
,
3387 + TEXT_PROP_DISTANCE_LIMIT
),
3395 /* For strings from a `display' property, use the face at
3396 IT's current buffer position as the base face to merge
3397 with, so that overlay strings appear in the same face as
3398 surrounding text, unless they specify their own
3400 base_face_id
= underlying_face_id (it
);
3403 new_face_id
= face_at_string_position (it
->w
,
3405 IT_STRING_CHARPOS (*it
),
3407 it
->region_beg_charpos
,
3408 it
->region_end_charpos
,
3412 /* Is this a start of a run of characters with box? Caveat:
3413 this can be called for a freshly allocated iterator; face_id
3414 is -1 is this case. We know that the new face will not
3415 change until the next check pos, i.e. if the new face has a
3416 box, all characters up to that position will have a
3417 box. But, as usual, we don't know whether that position
3418 is really the end. */
3419 if (new_face_id
!= it
->face_id
)
3421 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3422 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3424 /* If new face has a box but old face hasn't, this is the
3425 start of a run of characters with box, i.e. it has a
3426 shadow on the left side. */
3427 it
->start_of_box_run_p
3428 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3429 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3433 it
->face_id
= new_face_id
;
3434 return HANDLED_NORMALLY
;
3438 /* Return the ID of the face ``underlying'' IT's current position,
3439 which is in a string. If the iterator is associated with a
3440 buffer, return the face at IT's current buffer position.
3441 Otherwise, use the iterator's base_face_id. */
3444 underlying_face_id (struct it
*it
)
3446 int face_id
= it
->base_face_id
, i
;
3448 xassert (STRINGP (it
->string
));
3450 for (i
= it
->sp
- 1; i
>= 0; --i
)
3451 if (NILP (it
->stack
[i
].string
))
3452 face_id
= it
->stack
[i
].face_id
;
3458 /* Compute the face one character before or after the current position
3459 of IT. BEFORE_P non-zero means get the face in front of IT's
3460 position. Value is the id of the face. */
3463 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3466 EMACS_INT next_check_charpos
;
3467 struct text_pos pos
;
3469 xassert (it
->s
== NULL
);
3471 if (STRINGP (it
->string
))
3476 /* No face change past the end of the string (for the case
3477 we are padding with spaces). No face change before the
3479 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3480 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3483 /* Set pos to the position before or after IT's current position. */
3485 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3487 /* For composition, we must check the character after the
3489 pos
= (it
->what
== IT_COMPOSITION
3490 ? string_pos (IT_STRING_CHARPOS (*it
)
3491 + it
->cmp_it
.nchars
, it
->string
)
3492 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3494 if (it
->current
.overlay_string_index
>= 0)
3495 bufpos
= IT_CHARPOS (*it
);
3499 base_face_id
= underlying_face_id (it
);
3501 /* Get the face for ASCII, or unibyte. */
3502 face_id
= face_at_string_position (it
->w
,
3506 it
->region_beg_charpos
,
3507 it
->region_end_charpos
,
3508 &next_check_charpos
,
3511 /* Correct the face for charsets different from ASCII. Do it
3512 for the multibyte case only. The face returned above is
3513 suitable for unibyte text if IT->string is unibyte. */
3514 if (STRING_MULTIBYTE (it
->string
))
3516 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3518 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3520 c
= string_char_and_length (p
, &len
);
3521 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3526 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3527 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3530 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3531 pos
= it
->current
.pos
;
3534 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3537 if (it
->what
== IT_COMPOSITION
)
3538 /* For composition, we must check the position after the
3540 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3542 INC_TEXT_POS (pos
, it
->multibyte_p
);
3545 /* Determine face for CHARSET_ASCII, or unibyte. */
3546 face_id
= face_at_buffer_position (it
->w
,
3548 it
->region_beg_charpos
,
3549 it
->region_end_charpos
,
3550 &next_check_charpos
,
3553 /* Correct the face for charsets different from ASCII. Do it
3554 for the multibyte case only. The face returned above is
3555 suitable for unibyte text if current_buffer is unibyte. */
3556 if (it
->multibyte_p
)
3558 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3559 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3560 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3569 /***********************************************************************
3571 ***********************************************************************/
3573 /* Set up iterator IT from invisible properties at its current
3574 position. Called from handle_stop. */
3576 static enum prop_handled
3577 handle_invisible_prop (struct it
*it
)
3579 enum prop_handled handled
= HANDLED_NORMALLY
;
3581 if (STRINGP (it
->string
))
3583 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3585 /* Get the value of the invisible text property at the
3586 current position. Value will be nil if there is no such
3588 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3589 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3592 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3594 handled
= HANDLED_RECOMPUTE_PROPS
;
3596 /* Get the position at which the next change of the
3597 invisible text property can be found in IT->string.
3598 Value will be nil if the property value is the same for
3599 all the rest of IT->string. */
3600 XSETINT (limit
, SCHARS (it
->string
));
3601 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3604 /* Text at current position is invisible. The next
3605 change in the property is at position end_charpos.
3606 Move IT's current position to that position. */
3607 if (INTEGERP (end_charpos
)
3608 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3610 struct text_pos old
;
3611 old
= it
->current
.string_pos
;
3612 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3613 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3617 /* The rest of the string is invisible. If this is an
3618 overlay string, proceed with the next overlay string
3619 or whatever comes and return a character from there. */
3620 if (it
->current
.overlay_string_index
>= 0)
3622 next_overlay_string (it
);
3623 /* Don't check for overlay strings when we just
3624 finished processing them. */
3625 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3629 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3630 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3638 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3639 Lisp_Object pos
, prop
, overlay
;
3641 /* First of all, is there invisible text at this position? */
3642 tem
= start_charpos
= IT_CHARPOS (*it
);
3643 pos
= make_number (tem
);
3644 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3646 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3648 /* If we are on invisible text, skip over it. */
3649 if (invis_p
&& start_charpos
< it
->end_charpos
)
3651 /* Record whether we have to display an ellipsis for the
3653 int display_ellipsis_p
= invis_p
== 2;
3655 handled
= HANDLED_RECOMPUTE_PROPS
;
3657 /* Loop skipping over invisible text. The loop is left at
3658 ZV or with IT on the first char being visible again. */
3661 /* Try to skip some invisible text. Return value is the
3662 position reached which can be equal to where we start
3663 if there is nothing invisible there. This skips both
3664 over invisible text properties and overlays with
3665 invisible property. */
3666 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3668 /* If we skipped nothing at all we weren't at invisible
3669 text in the first place. If everything to the end of
3670 the buffer was skipped, end the loop. */
3671 if (newpos
== tem
|| newpos
>= ZV
)
3675 /* We skipped some characters but not necessarily
3676 all there are. Check if we ended up on visible
3677 text. Fget_char_property returns the property of
3678 the char before the given position, i.e. if we
3679 get invis_p = 0, this means that the char at
3680 newpos is visible. */
3681 pos
= make_number (newpos
);
3682 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3683 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3686 /* If we ended up on invisible text, proceed to
3687 skip starting with next_stop. */
3691 /* If there are adjacent invisible texts, don't lose the
3692 second one's ellipsis. */
3694 display_ellipsis_p
= 1;
3698 /* The position newpos is now either ZV or on visible text. */
3699 if (it
->bidi_p
&& newpos
< ZV
)
3701 /* With bidi iteration, the region of invisible text
3702 could start and/or end in the middle of a non-base
3703 embedding level. Therefore, we need to skip
3704 invisible text using the bidi iterator, starting at
3705 IT's current position, until we find ourselves
3706 outside the invisible text. Skipping invisible text
3707 _after_ bidi iteration avoids affecting the visual
3708 order of the displayed text when invisible properties
3709 are added or removed. */
3710 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3712 /* If we were `reseat'ed to a new paragraph,
3713 determine the paragraph base direction. We need
3714 to do it now because next_element_from_buffer may
3715 not have a chance to do it, if we are going to
3716 skip any text at the beginning, which resets the
3718 bidi_paragraph_init (it
->paragraph_embedding
,
3723 bidi_move_to_visually_next (&it
->bidi_it
);
3725 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3726 && it
->bidi_it
.charpos
< newpos
);
3727 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3728 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3729 /* If we overstepped NEWPOS, record its position in the
3730 iterator, so that we skip invisible text if later the
3731 bidi iteration lands us in the invisible region
3733 if (IT_CHARPOS (*it
) >= newpos
)
3734 it
->prev_stop
= newpos
;
3738 IT_CHARPOS (*it
) = newpos
;
3739 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3742 /* If there are before-strings at the start of invisible
3743 text, and the text is invisible because of a text
3744 property, arrange to show before-strings because 20.x did
3745 it that way. (If the text is invisible because of an
3746 overlay property instead of a text property, this is
3747 already handled in the overlay code.) */
3749 && get_overlay_strings (it
, it
->stop_charpos
))
3751 handled
= HANDLED_RECOMPUTE_PROPS
;
3752 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3754 else if (display_ellipsis_p
)
3756 /* Make sure that the glyphs of the ellipsis will get
3757 correct `charpos' values. If we would not update
3758 it->position here, the glyphs would belong to the
3759 last visible character _before_ the invisible
3760 text, which confuses `set_cursor_from_row'.
3762 We use the last invisible position instead of the
3763 first because this way the cursor is always drawn on
3764 the first "." of the ellipsis, whenever PT is inside
3765 the invisible text. Otherwise the cursor would be
3766 placed _after_ the ellipsis when the point is after the
3767 first invisible character. */
3768 if (!STRINGP (it
->object
))
3770 it
->position
.charpos
= newpos
- 1;
3771 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3774 /* Let the ellipsis display before
3775 considering any properties of the following char.
3776 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3777 handled
= HANDLED_RETURN
;
3786 /* Make iterator IT return `...' next.
3787 Replaces LEN characters from buffer. */
3790 setup_for_ellipsis (struct it
*it
, int len
)
3792 /* Use the display table definition for `...'. Invalid glyphs
3793 will be handled by the method returning elements from dpvec. */
3794 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3796 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3797 it
->dpvec
= v
->contents
;
3798 it
->dpend
= v
->contents
+ v
->header
.size
;
3802 /* Default `...'. */
3803 it
->dpvec
= default_invis_vector
;
3804 it
->dpend
= default_invis_vector
+ 3;
3807 it
->dpvec_char_len
= len
;
3808 it
->current
.dpvec_index
= 0;
3809 it
->dpvec_face_id
= -1;
3811 /* Remember the current face id in case glyphs specify faces.
3812 IT's face is restored in set_iterator_to_next.
3813 saved_face_id was set to preceding char's face in handle_stop. */
3814 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3815 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3817 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3823 /***********************************************************************
3825 ***********************************************************************/
3827 /* Set up iterator IT from `display' property at its current position.
3828 Called from handle_stop.
3829 We return HANDLED_RETURN if some part of the display property
3830 overrides the display of the buffer text itself.
3831 Otherwise we return HANDLED_NORMALLY. */
3833 static enum prop_handled
3834 handle_display_prop (struct it
*it
)
3836 Lisp_Object propval
, object
, overlay
;
3837 struct text_pos
*position
;
3839 /* Nonzero if some property replaces the display of the text itself. */
3840 int display_replaced_p
= 0;
3842 if (STRINGP (it
->string
))
3844 object
= it
->string
;
3845 position
= &it
->current
.string_pos
;
3846 bufpos
= CHARPOS (it
->current
.pos
);
3850 XSETWINDOW (object
, it
->w
);
3851 position
= &it
->current
.pos
;
3852 bufpos
= CHARPOS (*position
);
3855 /* Reset those iterator values set from display property values. */
3856 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3857 it
->space_width
= Qnil
;
3858 it
->font_height
= Qnil
;
3861 /* We don't support recursive `display' properties, i.e. string
3862 values that have a string `display' property, that have a string
3863 `display' property etc. */
3864 if (!it
->string_from_display_prop_p
)
3865 it
->area
= TEXT_AREA
;
3867 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
3868 Qdisplay
, object
, &overlay
);
3870 return HANDLED_NORMALLY
;
3871 /* Now OVERLAY is the overlay that gave us this property, or nil
3872 if it was a text property. */
3874 if (!STRINGP (it
->string
))
3875 object
= it
->w
->buffer
;
3877 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
3879 FRAME_WINDOW_P (it
->f
));
3881 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3884 /* Subroutine of handle_display_prop. Returns non-zero if the display
3885 specification in SPEC is a replacing specification, i.e. it would
3886 replace the text covered by `display' property with something else,
3887 such as an image or a display string.
3889 See handle_single_display_spec for documentation of arguments.
3890 frame_window_p is non-zero if the window being redisplayed is on a
3891 GUI frame; this argument is used only if IT is NULL, see below.
3893 IT can be NULL, if this is called by the bidi reordering code
3894 through compute_display_string_pos, which see. In that case, this
3895 function only examines SPEC, but does not otherwise "handle" it, in
3896 the sense that it doesn't set up members of IT from the display
3899 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
3900 Lisp_Object overlay
, struct text_pos
*position
,
3901 EMACS_INT bufpos
, int frame_window_p
)
3903 int replacing_p
= 0;
3906 /* Simple specerties. */
3907 && !EQ (XCAR (spec
), Qimage
)
3908 && !EQ (XCAR (spec
), Qspace
)
3909 && !EQ (XCAR (spec
), Qwhen
)
3910 && !EQ (XCAR (spec
), Qslice
)
3911 && !EQ (XCAR (spec
), Qspace_width
)
3912 && !EQ (XCAR (spec
), Qheight
)
3913 && !EQ (XCAR (spec
), Qraise
)
3914 /* Marginal area specifications. */
3915 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
3916 && !EQ (XCAR (spec
), Qleft_fringe
)
3917 && !EQ (XCAR (spec
), Qright_fringe
)
3918 && !NILP (XCAR (spec
)))
3920 for (; CONSP (spec
); spec
= XCDR (spec
))
3922 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
3923 position
, bufpos
, replacing_p
,
3927 /* If some text in a string is replaced, `position' no
3928 longer points to the position of `object'. */
3929 if (!it
|| STRINGP (object
))
3934 else if (VECTORP (spec
))
3937 for (i
= 0; i
< ASIZE (spec
); ++i
)
3938 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
3939 position
, bufpos
, replacing_p
,
3943 /* If some text in a string is replaced, `position' no
3944 longer points to the position of `object'. */
3945 if (!it
|| STRINGP (object
))
3951 if (handle_single_display_spec (it
, spec
, object
, overlay
,
3952 position
, bufpos
, 0, frame_window_p
))
3959 /* Value is the position of the end of the `display' property starting
3960 at START_POS in OBJECT. */
3962 static struct text_pos
3963 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
3966 struct text_pos end_pos
;
3968 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3969 Qdisplay
, object
, Qnil
);
3970 CHARPOS (end_pos
) = XFASTINT (end
);
3971 if (STRINGP (object
))
3972 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3974 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3980 /* Set up IT from a single `display' property specification SPEC. OBJECT
3981 is the object in which the `display' property was found. *POSITION
3982 is the position in OBJECT at which the `display' property was found.
3983 BUFPOS is the buffer position of OBJECT (different from POSITION if
3984 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
3985 previously saw a display specification which already replaced text
3986 display with something else, for example an image; we ignore such
3987 properties after the first one has been processed.
3989 OVERLAY is the overlay this `display' property came from,
3990 or nil if it was a text property.
3992 If SPEC is a `space' or `image' specification, and in some other
3993 cases too, set *POSITION to the position where the `display'
3996 If IT is NULL, only examine the property specification in SPEC, but
3997 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
3998 is intended to be displayed in a window on a GUI frame.
4000 Value is non-zero if something was found which replaces the display
4001 of buffer or string text. */
4004 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4005 Lisp_Object overlay
, struct text_pos
*position
,
4006 EMACS_INT bufpos
, int display_replaced_p
,
4010 Lisp_Object location
, value
;
4011 struct text_pos start_pos
= *position
;
4014 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4015 If the result is non-nil, use VALUE instead of SPEC. */
4017 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4026 if (!NILP (form
) && !EQ (form
, Qt
))
4028 int count
= SPECPDL_INDEX ();
4029 struct gcpro gcpro1
;
4031 /* Bind `object' to the object having the `display' property, a
4032 buffer or string. Bind `position' to the position in the
4033 object where the property was found, and `buffer-position'
4034 to the current position in the buffer. */
4037 XSETBUFFER (object
, current_buffer
);
4038 specbind (Qobject
, object
);
4039 specbind (Qposition
, make_number (CHARPOS (*position
)));
4040 specbind (Qbuffer_position
, make_number (bufpos
));
4042 form
= safe_eval (form
);
4044 unbind_to (count
, Qnil
);
4050 /* Handle `(height HEIGHT)' specifications. */
4052 && EQ (XCAR (spec
), Qheight
)
4053 && CONSP (XCDR (spec
)))
4057 if (!FRAME_WINDOW_P (it
->f
))
4060 it
->font_height
= XCAR (XCDR (spec
));
4061 if (!NILP (it
->font_height
))
4063 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4064 int new_height
= -1;
4066 if (CONSP (it
->font_height
)
4067 && (EQ (XCAR (it
->font_height
), Qplus
)
4068 || EQ (XCAR (it
->font_height
), Qminus
))
4069 && CONSP (XCDR (it
->font_height
))
4070 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4072 /* `(+ N)' or `(- N)' where N is an integer. */
4073 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4074 if (EQ (XCAR (it
->font_height
), Qplus
))
4076 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4078 else if (FUNCTIONP (it
->font_height
))
4080 /* Call function with current height as argument.
4081 Value is the new height. */
4083 height
= safe_call1 (it
->font_height
,
4084 face
->lface
[LFACE_HEIGHT_INDEX
]);
4085 if (NUMBERP (height
))
4086 new_height
= XFLOATINT (height
);
4088 else if (NUMBERP (it
->font_height
))
4090 /* Value is a multiple of the canonical char height. */
4093 f
= FACE_FROM_ID (it
->f
,
4094 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4095 new_height
= (XFLOATINT (it
->font_height
)
4096 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4100 /* Evaluate IT->font_height with `height' bound to the
4101 current specified height to get the new height. */
4102 int count
= SPECPDL_INDEX ();
4104 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4105 value
= safe_eval (it
->font_height
);
4106 unbind_to (count
, Qnil
);
4108 if (NUMBERP (value
))
4109 new_height
= XFLOATINT (value
);
4113 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4120 /* Handle `(space-width WIDTH)'. */
4122 && EQ (XCAR (spec
), Qspace_width
)
4123 && CONSP (XCDR (spec
)))
4127 if (!FRAME_WINDOW_P (it
->f
))
4130 value
= XCAR (XCDR (spec
));
4131 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4132 it
->space_width
= value
;
4138 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4140 && EQ (XCAR (spec
), Qslice
))
4146 if (!FRAME_WINDOW_P (it
->f
))
4149 if (tem
= XCDR (spec
), CONSP (tem
))
4151 it
->slice
.x
= XCAR (tem
);
4152 if (tem
= XCDR (tem
), CONSP (tem
))
4154 it
->slice
.y
= XCAR (tem
);
4155 if (tem
= XCDR (tem
), CONSP (tem
))
4157 it
->slice
.width
= XCAR (tem
);
4158 if (tem
= XCDR (tem
), CONSP (tem
))
4159 it
->slice
.height
= XCAR (tem
);
4168 /* Handle `(raise FACTOR)'. */
4170 && EQ (XCAR (spec
), Qraise
)
4171 && CONSP (XCDR (spec
)))
4175 if (!FRAME_WINDOW_P (it
->f
))
4178 #ifdef HAVE_WINDOW_SYSTEM
4179 value
= XCAR (XCDR (spec
));
4180 if (NUMBERP (value
))
4182 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4183 it
->voffset
= - (XFLOATINT (value
)
4184 * (FONT_HEIGHT (face
->font
)));
4186 #endif /* HAVE_WINDOW_SYSTEM */
4192 /* Don't handle the other kinds of display specifications
4193 inside a string that we got from a `display' property. */
4194 if (it
&& it
->string_from_display_prop_p
)
4197 /* Characters having this form of property are not displayed, so
4198 we have to find the end of the property. */
4201 start_pos
= *position
;
4202 *position
= display_prop_end (it
, object
, start_pos
);
4206 /* Stop the scan at that end position--we assume that all
4207 text properties change there. */
4209 it
->stop_charpos
= position
->charpos
;
4211 /* Handle `(left-fringe BITMAP [FACE])'
4212 and `(right-fringe BITMAP [FACE])'. */
4214 && (EQ (XCAR (spec
), Qleft_fringe
)
4215 || EQ (XCAR (spec
), Qright_fringe
))
4216 && CONSP (XCDR (spec
)))
4222 if (!FRAME_WINDOW_P (it
->f
))
4223 /* If we return here, POSITION has been advanced
4224 across the text with this property. */
4227 else if (!frame_window_p
)
4230 #ifdef HAVE_WINDOW_SYSTEM
4231 value
= XCAR (XCDR (spec
));
4232 if (!SYMBOLP (value
)
4233 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4234 /* If we return here, POSITION has been advanced
4235 across the text with this property. */
4240 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4242 if (CONSP (XCDR (XCDR (spec
))))
4244 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4245 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4251 /* Save current settings of IT so that we can restore them
4252 when we are finished with the glyph property value. */
4253 push_it (it
, position
);
4255 it
->area
= TEXT_AREA
;
4256 it
->what
= IT_IMAGE
;
4257 it
->image_id
= -1; /* no image */
4258 it
->position
= start_pos
;
4259 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4260 it
->method
= GET_FROM_IMAGE
;
4261 it
->from_overlay
= Qnil
;
4262 it
->face_id
= face_id
;
4264 /* Say that we haven't consumed the characters with
4265 `display' property yet. The call to pop_it in
4266 set_iterator_to_next will clean this up. */
4267 *position
= start_pos
;
4269 if (EQ (XCAR (spec
), Qleft_fringe
))
4271 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4272 it
->left_user_fringe_face_id
= face_id
;
4276 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4277 it
->right_user_fringe_face_id
= face_id
;
4280 #endif /* HAVE_WINDOW_SYSTEM */
4284 /* Prepare to handle `((margin left-margin) ...)',
4285 `((margin right-margin) ...)' and `((margin nil) ...)'
4286 prefixes for display specifications. */
4287 location
= Qunbound
;
4288 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4292 value
= XCDR (spec
);
4294 value
= XCAR (value
);
4297 if (EQ (XCAR (tem
), Qmargin
)
4298 && (tem
= XCDR (tem
),
4299 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4301 || EQ (tem
, Qleft_margin
)
4302 || EQ (tem
, Qright_margin
))))
4306 if (EQ (location
, Qunbound
))
4312 /* After this point, VALUE is the property after any
4313 margin prefix has been stripped. It must be a string,
4314 an image specification, or `(space ...)'.
4316 LOCATION specifies where to display: `left-margin',
4317 `right-margin' or nil. */
4319 valid_p
= (STRINGP (value
)
4320 #ifdef HAVE_WINDOW_SYSTEM
4321 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4322 && valid_image_p (value
))
4323 #endif /* not HAVE_WINDOW_SYSTEM */
4324 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4326 if (valid_p
&& !display_replaced_p
)
4331 /* Save current settings of IT so that we can restore them
4332 when we are finished with the glyph property value. */
4333 push_it (it
, position
);
4334 it
->from_overlay
= overlay
;
4336 if (NILP (location
))
4337 it
->area
= TEXT_AREA
;
4338 else if (EQ (location
, Qleft_margin
))
4339 it
->area
= LEFT_MARGIN_AREA
;
4341 it
->area
= RIGHT_MARGIN_AREA
;
4343 if (STRINGP (value
))
4346 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4347 it
->current
.overlay_string_index
= -1;
4348 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4349 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4350 it
->method
= GET_FROM_STRING
;
4351 it
->stop_charpos
= 0;
4352 it
->string_from_display_prop_p
= 1;
4353 /* Say that we haven't consumed the characters with
4354 `display' property yet. The call to pop_it in
4355 set_iterator_to_next will clean this up. */
4356 if (BUFFERP (object
))
4357 *position
= start_pos
;
4359 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4361 it
->method
= GET_FROM_STRETCH
;
4363 *position
= it
->position
= start_pos
;
4365 #ifdef HAVE_WINDOW_SYSTEM
4368 it
->what
= IT_IMAGE
;
4369 it
->image_id
= lookup_image (it
->f
, value
);
4370 it
->position
= start_pos
;
4371 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4372 it
->method
= GET_FROM_IMAGE
;
4374 /* Say that we haven't consumed the characters with
4375 `display' property yet. The call to pop_it in
4376 set_iterator_to_next will clean this up. */
4377 *position
= start_pos
;
4379 #endif /* HAVE_WINDOW_SYSTEM */
4384 /* Invalid property or property not supported. Restore
4385 POSITION to what it was before. */
4386 *position
= start_pos
;
4390 /* Check if PROP is a display property value whose text should be
4391 treated as intangible. OVERLAY is the overlay from which PROP
4392 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4393 specify the buffer position covered by PROP. */
4396 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4397 EMACS_INT charpos
, EMACS_INT bytepos
)
4399 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4400 struct text_pos position
;
4402 SET_TEXT_POS (position
, charpos
, bytepos
);
4403 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4404 &position
, charpos
, frame_window_p
);
4408 /* Return 1 if PROP is a display sub-property value containing STRING.
4410 Implementation note: this and the following function are really
4411 special cases of handle_display_spec and
4412 handle_single_display_spec, and should ideally use the same code.
4413 Until they do, these two pairs must be consistent and must be
4414 modified in sync. */
4417 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4419 if (EQ (string
, prop
))
4422 /* Skip over `when FORM'. */
4423 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4428 /* Actually, the condition following `when' should be eval'ed,
4429 like handle_single_display_spec does, and we should return
4430 zero if it evaluates to nil. However, this function is
4431 called only when the buffer was already displayed and some
4432 glyph in the glyph matrix was found to come from a display
4433 string. Therefore, the condition was already evaluated, and
4434 the result was non-nil, otherwise the display string wouldn't
4435 have been displayed and we would have never been called for
4436 this property. Thus, we can skip the evaluation and assume
4437 its result is non-nil. */
4442 /* Skip over `margin LOCATION'. */
4443 if (EQ (XCAR (prop
), Qmargin
))
4454 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4458 /* Return 1 if STRING appears in the `display' property PROP. */
4461 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4464 && !EQ (XCAR (prop
), Qwhen
)
4465 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4467 /* A list of sub-properties. */
4468 while (CONSP (prop
))
4470 if (single_display_spec_string_p (XCAR (prop
), string
))
4475 else if (VECTORP (prop
))
4477 /* A vector of sub-properties. */
4479 for (i
= 0; i
< ASIZE (prop
); ++i
)
4480 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4484 return single_display_spec_string_p (prop
, string
);
4489 /* Look for STRING in overlays and text properties in the current
4490 buffer, between character positions FROM and TO (excluding TO).
4491 BACK_P non-zero means look back (in this case, TO is supposed to be
4493 Value is the first character position where STRING was found, or
4494 zero if it wasn't found before hitting TO.
4496 This function may only use code that doesn't eval because it is
4497 called asynchronously from note_mouse_highlight. */
4500 string_buffer_position_lim (Lisp_Object string
,
4501 EMACS_INT from
, EMACS_INT to
, int back_p
)
4503 Lisp_Object limit
, prop
, pos
;
4506 pos
= make_number (from
);
4508 if (!back_p
) /* looking forward */
4510 limit
= make_number (min (to
, ZV
));
4511 while (!found
&& !EQ (pos
, limit
))
4513 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4514 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4517 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4521 else /* looking back */
4523 limit
= make_number (max (to
, BEGV
));
4524 while (!found
&& !EQ (pos
, limit
))
4526 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4527 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4530 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4535 return found
? XINT (pos
) : 0;
4538 /* Determine which buffer position in current buffer STRING comes from.
4539 AROUND_CHARPOS is an approximate position where it could come from.
4540 Value is the buffer position or 0 if it couldn't be determined.
4542 This function is necessary because we don't record buffer positions
4543 in glyphs generated from strings (to keep struct glyph small).
4544 This function may only use code that doesn't eval because it is
4545 called asynchronously from note_mouse_highlight. */
4548 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4550 const int MAX_DISTANCE
= 1000;
4551 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4552 around_charpos
+ MAX_DISTANCE
,
4556 found
= string_buffer_position_lim (string
, around_charpos
,
4557 around_charpos
- MAX_DISTANCE
, 1);
4563 /***********************************************************************
4564 `composition' property
4565 ***********************************************************************/
4567 /* Set up iterator IT from `composition' property at its current
4568 position. Called from handle_stop. */
4570 static enum prop_handled
4571 handle_composition_prop (struct it
*it
)
4573 Lisp_Object prop
, string
;
4574 EMACS_INT pos
, pos_byte
, start
, end
;
4576 if (STRINGP (it
->string
))
4580 pos
= IT_STRING_CHARPOS (*it
);
4581 pos_byte
= IT_STRING_BYTEPOS (*it
);
4582 string
= it
->string
;
4583 s
= SDATA (string
) + pos_byte
;
4584 it
->c
= STRING_CHAR (s
);
4588 pos
= IT_CHARPOS (*it
);
4589 pos_byte
= IT_BYTEPOS (*it
);
4591 it
->c
= FETCH_CHAR (pos_byte
);
4594 /* If there's a valid composition and point is not inside of the
4595 composition (in the case that the composition is from the current
4596 buffer), draw a glyph composed from the composition components. */
4597 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4598 && COMPOSITION_VALID_P (start
, end
, prop
)
4599 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4603 if (STRINGP (it
->string
))
4604 pos_byte
= string_char_to_byte (it
->string
, start
);
4606 pos_byte
= CHAR_TO_BYTE (start
);
4608 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4611 if (it
->cmp_it
.id
>= 0)
4614 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4615 it
->cmp_it
.nglyphs
= -1;
4619 return HANDLED_NORMALLY
;
4624 /***********************************************************************
4626 ***********************************************************************/
4628 /* The following structure is used to record overlay strings for
4629 later sorting in load_overlay_strings. */
4631 struct overlay_entry
4633 Lisp_Object overlay
;
4640 /* Set up iterator IT from overlay strings at its current position.
4641 Called from handle_stop. */
4643 static enum prop_handled
4644 handle_overlay_change (struct it
*it
)
4646 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4647 return HANDLED_RECOMPUTE_PROPS
;
4649 return HANDLED_NORMALLY
;
4653 /* Set up the next overlay string for delivery by IT, if there is an
4654 overlay string to deliver. Called by set_iterator_to_next when the
4655 end of the current overlay string is reached. If there are more
4656 overlay strings to display, IT->string and
4657 IT->current.overlay_string_index are set appropriately here.
4658 Otherwise IT->string is set to nil. */
4661 next_overlay_string (struct it
*it
)
4663 ++it
->current
.overlay_string_index
;
4664 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4666 /* No more overlay strings. Restore IT's settings to what
4667 they were before overlay strings were processed, and
4668 continue to deliver from current_buffer. */
4670 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4673 || (NILP (it
->string
)
4674 && it
->method
== GET_FROM_BUFFER
4675 && it
->stop_charpos
>= BEGV
4676 && it
->stop_charpos
<= it
->end_charpos
));
4677 it
->current
.overlay_string_index
= -1;
4678 it
->n_overlay_strings
= 0;
4679 it
->overlay_strings_charpos
= -1;
4681 /* If we're at the end of the buffer, record that we have
4682 processed the overlay strings there already, so that
4683 next_element_from_buffer doesn't try it again. */
4684 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4685 it
->overlay_strings_at_end_processed_p
= 1;
4689 /* There are more overlay strings to process. If
4690 IT->current.overlay_string_index has advanced to a position
4691 where we must load IT->overlay_strings with more strings, do
4692 it. We must load at the IT->overlay_strings_charpos where
4693 IT->n_overlay_strings was originally computed; when invisible
4694 text is present, this might not be IT_CHARPOS (Bug#7016). */
4695 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4697 if (it
->current
.overlay_string_index
&& i
== 0)
4698 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4700 /* Initialize IT to deliver display elements from the overlay
4702 it
->string
= it
->overlay_strings
[i
];
4703 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4704 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4705 it
->method
= GET_FROM_STRING
;
4706 it
->stop_charpos
= 0;
4707 if (it
->cmp_it
.stop_pos
>= 0)
4708 it
->cmp_it
.stop_pos
= 0;
4715 /* Compare two overlay_entry structures E1 and E2. Used as a
4716 comparison function for qsort in load_overlay_strings. Overlay
4717 strings for the same position are sorted so that
4719 1. All after-strings come in front of before-strings, except
4720 when they come from the same overlay.
4722 2. Within after-strings, strings are sorted so that overlay strings
4723 from overlays with higher priorities come first.
4725 2. Within before-strings, strings are sorted so that overlay
4726 strings from overlays with higher priorities come last.
4728 Value is analogous to strcmp. */
4732 compare_overlay_entries (const void *e1
, const void *e2
)
4734 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4735 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4738 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4740 /* Let after-strings appear in front of before-strings if
4741 they come from different overlays. */
4742 if (EQ (entry1
->overlay
, entry2
->overlay
))
4743 result
= entry1
->after_string_p
? 1 : -1;
4745 result
= entry1
->after_string_p
? -1 : 1;
4747 else if (entry1
->after_string_p
)
4748 /* After-strings sorted in order of decreasing priority. */
4749 result
= entry2
->priority
- entry1
->priority
;
4751 /* Before-strings sorted in order of increasing priority. */
4752 result
= entry1
->priority
- entry2
->priority
;
4758 /* Load the vector IT->overlay_strings with overlay strings from IT's
4759 current buffer position, or from CHARPOS if that is > 0. Set
4760 IT->n_overlays to the total number of overlay strings found.
4762 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4763 a time. On entry into load_overlay_strings,
4764 IT->current.overlay_string_index gives the number of overlay
4765 strings that have already been loaded by previous calls to this
4768 IT->add_overlay_start contains an additional overlay start
4769 position to consider for taking overlay strings from, if non-zero.
4770 This position comes into play when the overlay has an `invisible'
4771 property, and both before and after-strings. When we've skipped to
4772 the end of the overlay, because of its `invisible' property, we
4773 nevertheless want its before-string to appear.
4774 IT->add_overlay_start will contain the overlay start position
4777 Overlay strings are sorted so that after-string strings come in
4778 front of before-string strings. Within before and after-strings,
4779 strings are sorted by overlay priority. See also function
4780 compare_overlay_entries. */
4783 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4785 Lisp_Object overlay
, window
, str
, invisible
;
4786 struct Lisp_Overlay
*ov
;
4787 EMACS_INT start
, end
;
4789 int n
= 0, i
, j
, invis_p
;
4790 struct overlay_entry
*entries
4791 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4794 charpos
= IT_CHARPOS (*it
);
4796 /* Append the overlay string STRING of overlay OVERLAY to vector
4797 `entries' which has size `size' and currently contains `n'
4798 elements. AFTER_P non-zero means STRING is an after-string of
4800 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4803 Lisp_Object priority; \
4807 int new_size = 2 * size; \
4808 struct overlay_entry *old = entries; \
4810 (struct overlay_entry *) alloca (new_size \
4811 * sizeof *entries); \
4812 memcpy (entries, old, size * sizeof *entries); \
4816 entries[n].string = (STRING); \
4817 entries[n].overlay = (OVERLAY); \
4818 priority = Foverlay_get ((OVERLAY), Qpriority); \
4819 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4820 entries[n].after_string_p = (AFTER_P); \
4825 /* Process overlay before the overlay center. */
4826 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4828 XSETMISC (overlay
, ov
);
4829 xassert (OVERLAYP (overlay
));
4830 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4831 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4836 /* Skip this overlay if it doesn't start or end at IT's current
4838 if (end
!= charpos
&& start
!= charpos
)
4841 /* Skip this overlay if it doesn't apply to IT->w. */
4842 window
= Foverlay_get (overlay
, Qwindow
);
4843 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4846 /* If the text ``under'' the overlay is invisible, both before-
4847 and after-strings from this overlay are visible; start and
4848 end position are indistinguishable. */
4849 invisible
= Foverlay_get (overlay
, Qinvisible
);
4850 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4852 /* If overlay has a non-empty before-string, record it. */
4853 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4854 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4856 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4858 /* If overlay has a non-empty after-string, record it. */
4859 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4860 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4862 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4865 /* Process overlays after the overlay center. */
4866 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4868 XSETMISC (overlay
, ov
);
4869 xassert (OVERLAYP (overlay
));
4870 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4871 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4873 if (start
> charpos
)
4876 /* Skip this overlay if it doesn't start or end at IT's current
4878 if (end
!= charpos
&& start
!= charpos
)
4881 /* Skip this overlay if it doesn't apply to IT->w. */
4882 window
= Foverlay_get (overlay
, Qwindow
);
4883 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4886 /* If the text ``under'' the overlay is invisible, it has a zero
4887 dimension, and both before- and after-strings apply. */
4888 invisible
= Foverlay_get (overlay
, Qinvisible
);
4889 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4891 /* If overlay has a non-empty before-string, record it. */
4892 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4893 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4895 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4897 /* If overlay has a non-empty after-string, record it. */
4898 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4899 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4901 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4904 #undef RECORD_OVERLAY_STRING
4908 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4910 /* Record number of overlay strings, and where we computed it. */
4911 it
->n_overlay_strings
= n
;
4912 it
->overlay_strings_charpos
= charpos
;
4914 /* IT->current.overlay_string_index is the number of overlay strings
4915 that have already been consumed by IT. Copy some of the
4916 remaining overlay strings to IT->overlay_strings. */
4918 j
= it
->current
.overlay_string_index
;
4919 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4921 it
->overlay_strings
[i
] = entries
[j
].string
;
4922 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4929 /* Get the first chunk of overlay strings at IT's current buffer
4930 position, or at CHARPOS if that is > 0. Value is non-zero if at
4931 least one overlay string was found. */
4934 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
4936 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4937 process. This fills IT->overlay_strings with strings, and sets
4938 IT->n_overlay_strings to the total number of strings to process.
4939 IT->pos.overlay_string_index has to be set temporarily to zero
4940 because load_overlay_strings needs this; it must be set to -1
4941 when no overlay strings are found because a zero value would
4942 indicate a position in the first overlay string. */
4943 it
->current
.overlay_string_index
= 0;
4944 load_overlay_strings (it
, charpos
);
4946 /* If we found overlay strings, set up IT to deliver display
4947 elements from the first one. Otherwise set up IT to deliver
4948 from current_buffer. */
4949 if (it
->n_overlay_strings
)
4951 /* Make sure we know settings in current_buffer, so that we can
4952 restore meaningful values when we're done with the overlay
4955 compute_stop_pos (it
);
4956 xassert (it
->face_id
>= 0);
4958 /* Save IT's settings. They are restored after all overlay
4959 strings have been processed. */
4960 xassert (!compute_stop_p
|| it
->sp
== 0);
4962 /* When called from handle_stop, there might be an empty display
4963 string loaded. In that case, don't bother saving it. */
4964 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
4967 /* Set up IT to deliver display elements from the first overlay
4969 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4970 it
->string
= it
->overlay_strings
[0];
4971 it
->from_overlay
= Qnil
;
4972 it
->stop_charpos
= 0;
4973 xassert (STRINGP (it
->string
));
4974 it
->end_charpos
= SCHARS (it
->string
);
4975 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4976 it
->method
= GET_FROM_STRING
;
4980 it
->current
.overlay_string_index
= -1;
4985 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4988 it
->method
= GET_FROM_BUFFER
;
4990 (void) get_overlay_strings_1 (it
, charpos
, 1);
4994 /* Value is non-zero if we found at least one overlay string. */
4995 return STRINGP (it
->string
);
5000 /***********************************************************************
5001 Saving and restoring state
5002 ***********************************************************************/
5004 /* Save current settings of IT on IT->stack. Called, for example,
5005 before setting up IT for an overlay string, to be able to restore
5006 IT's settings to what they were after the overlay string has been
5007 processed. If POSITION is non-NULL, it is the position to save on
5008 the stack instead of IT->position. */
5011 push_it (struct it
*it
, struct text_pos
*position
)
5013 struct iterator_stack_entry
*p
;
5015 xassert (it
->sp
< IT_STACK_SIZE
);
5016 p
= it
->stack
+ it
->sp
;
5018 p
->stop_charpos
= it
->stop_charpos
;
5019 p
->prev_stop
= it
->prev_stop
;
5020 p
->base_level_stop
= it
->base_level_stop
;
5021 p
->cmp_it
= it
->cmp_it
;
5022 xassert (it
->face_id
>= 0);
5023 p
->face_id
= it
->face_id
;
5024 p
->string
= it
->string
;
5025 p
->method
= it
->method
;
5026 p
->from_overlay
= it
->from_overlay
;
5029 case GET_FROM_IMAGE
:
5030 p
->u
.image
.object
= it
->object
;
5031 p
->u
.image
.image_id
= it
->image_id
;
5032 p
->u
.image
.slice
= it
->slice
;
5034 case GET_FROM_STRETCH
:
5035 p
->u
.stretch
.object
= it
->object
;
5038 p
->position
= position
? *position
: it
->position
;
5039 p
->current
= it
->current
;
5040 p
->end_charpos
= it
->end_charpos
;
5041 p
->string_nchars
= it
->string_nchars
;
5043 p
->multibyte_p
= it
->multibyte_p
;
5044 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5045 p
->space_width
= it
->space_width
;
5046 p
->font_height
= it
->font_height
;
5047 p
->voffset
= it
->voffset
;
5048 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5049 p
->display_ellipsis_p
= 0;
5050 p
->line_wrap
= it
->line_wrap
;
5055 iterate_out_of_display_property (struct it
*it
)
5057 /* Maybe initialize paragraph direction. If we are at the beginning
5058 of a new paragraph, next_element_from_buffer may not have a
5059 chance to do that. */
5060 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5061 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5062 /* prev_stop can be zero, so check against BEGV as well. */
5063 while (it
->bidi_it
.charpos
>= BEGV
5064 && it
->prev_stop
<= it
->bidi_it
.charpos
5065 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5066 bidi_move_to_visually_next (&it
->bidi_it
);
5067 /* Record the stop_pos we just crossed, for when we cross it
5069 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5070 it
->prev_stop
= CHARPOS (it
->position
);
5071 /* If we ended up not where pop_it put us, resync IT's
5072 positional members with the bidi iterator. */
5073 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5075 SET_TEXT_POS (it
->position
,
5076 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5077 it
->current
.pos
= it
->position
;
5081 /* Restore IT's settings from IT->stack. Called, for example, when no
5082 more overlay strings must be processed, and we return to delivering
5083 display elements from a buffer, or when the end of a string from a
5084 `display' property is reached and we return to delivering display
5085 elements from an overlay string, or from a buffer. */
5088 pop_it (struct it
*it
)
5090 struct iterator_stack_entry
*p
;
5092 xassert (it
->sp
> 0);
5094 p
= it
->stack
+ it
->sp
;
5095 it
->stop_charpos
= p
->stop_charpos
;
5096 it
->prev_stop
= p
->prev_stop
;
5097 it
->base_level_stop
= p
->base_level_stop
;
5098 it
->cmp_it
= p
->cmp_it
;
5099 it
->face_id
= p
->face_id
;
5100 it
->current
= p
->current
;
5101 it
->position
= p
->position
;
5102 it
->string
= p
->string
;
5103 it
->from_overlay
= p
->from_overlay
;
5104 if (NILP (it
->string
))
5105 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5106 it
->method
= p
->method
;
5109 case GET_FROM_IMAGE
:
5110 it
->image_id
= p
->u
.image
.image_id
;
5111 it
->object
= p
->u
.image
.object
;
5112 it
->slice
= p
->u
.image
.slice
;
5114 case GET_FROM_STRETCH
:
5115 it
->object
= p
->u
.comp
.object
;
5117 case GET_FROM_BUFFER
:
5118 it
->object
= it
->w
->buffer
;
5121 /* Bidi-iterate until we get out of the portion of text, if
5122 any, covered by a `display' text property or an overlay
5123 with `display' property. (We cannot just jump there,
5124 because the internal coherency of the bidi iterator state
5125 can not be preserved across such jumps.) We also must
5126 determine the paragraph base direction if the overlay we
5127 just processed is at the beginning of a new
5129 iterate_out_of_display_property (it
);
5132 case GET_FROM_STRING
:
5133 it
->object
= it
->string
;
5135 case GET_FROM_DISPLAY_VECTOR
:
5137 it
->method
= GET_FROM_C_STRING
;
5138 else if (STRINGP (it
->string
))
5139 it
->method
= GET_FROM_STRING
;
5142 it
->method
= GET_FROM_BUFFER
;
5143 it
->object
= it
->w
->buffer
;
5146 it
->end_charpos
= p
->end_charpos
;
5147 it
->string_nchars
= p
->string_nchars
;
5149 it
->multibyte_p
= p
->multibyte_p
;
5150 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5151 it
->space_width
= p
->space_width
;
5152 it
->font_height
= p
->font_height
;
5153 it
->voffset
= p
->voffset
;
5154 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5155 it
->line_wrap
= p
->line_wrap
;
5160 /***********************************************************************
5162 ***********************************************************************/
5164 /* Set IT's current position to the previous line start. */
5167 back_to_previous_line_start (struct it
*it
)
5169 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5170 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5174 /* Move IT to the next line start.
5176 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5177 we skipped over part of the text (as opposed to moving the iterator
5178 continuously over the text). Otherwise, don't change the value
5181 Newlines may come from buffer text, overlay strings, or strings
5182 displayed via the `display' property. That's the reason we can't
5183 simply use find_next_newline_no_quit.
5185 Note that this function may not skip over invisible text that is so
5186 because of text properties and immediately follows a newline. If
5187 it would, function reseat_at_next_visible_line_start, when called
5188 from set_iterator_to_next, would effectively make invisible
5189 characters following a newline part of the wrong glyph row, which
5190 leads to wrong cursor motion. */
5193 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5195 int old_selective
, newline_found_p
, n
;
5196 const int MAX_NEWLINE_DISTANCE
= 500;
5198 /* If already on a newline, just consume it to avoid unintended
5199 skipping over invisible text below. */
5200 if (it
->what
== IT_CHARACTER
5202 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5204 set_iterator_to_next (it
, 0);
5209 /* Don't handle selective display in the following. It's (a)
5210 unnecessary because it's done by the caller, and (b) leads to an
5211 infinite recursion because next_element_from_ellipsis indirectly
5212 calls this function. */
5213 old_selective
= it
->selective
;
5216 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5217 from buffer text. */
5218 for (n
= newline_found_p
= 0;
5219 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5220 n
+= STRINGP (it
->string
) ? 0 : 1)
5222 if (!get_next_display_element (it
))
5224 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5225 set_iterator_to_next (it
, 0);
5228 /* If we didn't find a newline near enough, see if we can use a
5230 if (!newline_found_p
)
5232 EMACS_INT start
= IT_CHARPOS (*it
);
5233 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5236 xassert (!STRINGP (it
->string
));
5238 /* If there isn't any `display' property in sight, and no
5239 overlays, we can just use the position of the newline in
5241 if (it
->stop_charpos
>= limit
5242 || ((pos
= Fnext_single_property_change (make_number (start
),
5244 Qnil
, make_number (limit
)),
5246 && next_overlay_change (start
) == ZV
))
5248 IT_CHARPOS (*it
) = limit
;
5249 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5250 *skipped_p
= newline_found_p
= 1;
5254 while (get_next_display_element (it
)
5255 && !newline_found_p
)
5257 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5258 set_iterator_to_next (it
, 0);
5263 it
->selective
= old_selective
;
5264 return newline_found_p
;
5268 /* Set IT's current position to the previous visible line start. Skip
5269 invisible text that is so either due to text properties or due to
5270 selective display. Caution: this does not change IT->current_x and
5274 back_to_previous_visible_line_start (struct it
*it
)
5276 while (IT_CHARPOS (*it
) > BEGV
)
5278 back_to_previous_line_start (it
);
5280 if (IT_CHARPOS (*it
) <= BEGV
)
5283 /* If selective > 0, then lines indented more than its value are
5285 if (it
->selective
> 0
5286 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5287 (double) it
->selective
)) /* iftc */
5290 /* Check the newline before point for invisibility. */
5293 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5294 Qinvisible
, it
->window
);
5295 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5299 if (IT_CHARPOS (*it
) <= BEGV
)
5306 Lisp_Object val
, overlay
;
5308 /* If newline is part of a composition, continue from start of composition */
5309 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5310 && beg
< IT_CHARPOS (*it
))
5313 /* If newline is replaced by a display property, find start of overlay
5314 or interval and continue search from that point. */
5316 pos
= --IT_CHARPOS (it2
);
5319 it2
.string_from_display_prop_p
= 0;
5320 if (handle_display_prop (&it2
) == HANDLED_RETURN
5321 && !NILP (val
= get_char_property_and_overlay
5322 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5323 && (OVERLAYP (overlay
)
5324 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5325 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5328 /* Newline is not replaced by anything -- so we are done. */
5334 IT_CHARPOS (*it
) = beg
;
5335 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5339 it
->continuation_lines_width
= 0;
5341 xassert (IT_CHARPOS (*it
) >= BEGV
);
5342 xassert (IT_CHARPOS (*it
) == BEGV
5343 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5348 /* Reseat iterator IT at the previous visible line start. Skip
5349 invisible text that is so either due to text properties or due to
5350 selective display. At the end, update IT's overlay information,
5351 face information etc. */
5354 reseat_at_previous_visible_line_start (struct it
*it
)
5356 back_to_previous_visible_line_start (it
);
5357 reseat (it
, it
->current
.pos
, 1);
5362 /* Reseat iterator IT on the next visible line start in the current
5363 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5364 preceding the line start. Skip over invisible text that is so
5365 because of selective display. Compute faces, overlays etc at the
5366 new position. Note that this function does not skip over text that
5367 is invisible because of text properties. */
5370 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5372 int newline_found_p
, skipped_p
= 0;
5374 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5376 /* Skip over lines that are invisible because they are indented
5377 more than the value of IT->selective. */
5378 if (it
->selective
> 0)
5379 while (IT_CHARPOS (*it
) < ZV
5380 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5381 (double) it
->selective
)) /* iftc */
5383 xassert (IT_BYTEPOS (*it
) == BEGV
5384 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5385 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5388 /* Position on the newline if that's what's requested. */
5389 if (on_newline_p
&& newline_found_p
)
5391 if (STRINGP (it
->string
))
5393 if (IT_STRING_CHARPOS (*it
) > 0)
5395 --IT_STRING_CHARPOS (*it
);
5396 --IT_STRING_BYTEPOS (*it
);
5399 else if (IT_CHARPOS (*it
) > BEGV
)
5403 reseat (it
, it
->current
.pos
, 0);
5407 reseat (it
, it
->current
.pos
, 0);
5414 /***********************************************************************
5415 Changing an iterator's position
5416 ***********************************************************************/
5418 /* Change IT's current position to POS in current_buffer. If FORCE_P
5419 is non-zero, always check for text properties at the new position.
5420 Otherwise, text properties are only looked up if POS >=
5421 IT->check_charpos of a property. */
5424 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5426 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5428 reseat_1 (it
, pos
, 0);
5430 /* Determine where to check text properties. Avoid doing it
5431 where possible because text property lookup is very expensive. */
5433 || CHARPOS (pos
) > it
->stop_charpos
5434 || CHARPOS (pos
) < original_pos
)
5438 /* For bidi iteration, we need to prime prev_stop and
5439 base_level_stop with our best estimations. */
5440 if (CHARPOS (pos
) < it
->prev_stop
)
5442 handle_stop_backwards (it
, BEGV
);
5443 if (CHARPOS (pos
) < it
->base_level_stop
)
5444 it
->base_level_stop
= 0;
5446 else if (CHARPOS (pos
) > it
->stop_charpos
5447 && it
->stop_charpos
>= BEGV
)
5448 handle_stop_backwards (it
, it
->stop_charpos
);
5455 it
->prev_stop
= it
->base_level_stop
= 0;
5464 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5465 IT->stop_pos to POS, also. */
5468 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5470 /* Don't call this function when scanning a C string. */
5471 xassert (it
->s
== NULL
);
5473 /* POS must be a reasonable value. */
5474 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5476 it
->current
.pos
= it
->position
= pos
;
5477 it
->end_charpos
= ZV
;
5479 it
->current
.dpvec_index
= -1;
5480 it
->current
.overlay_string_index
= -1;
5481 IT_STRING_CHARPOS (*it
) = -1;
5482 IT_STRING_BYTEPOS (*it
) = -1;
5484 it
->string_from_display_prop_p
= 0;
5485 it
->method
= GET_FROM_BUFFER
;
5486 it
->object
= it
->w
->buffer
;
5487 it
->area
= TEXT_AREA
;
5488 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5490 it
->string_from_display_prop_p
= 0;
5491 it
->face_before_selective_p
= 0;
5494 it
->bidi_it
.first_elt
= 1;
5495 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5496 it
->bidi_it
.disp_pos
= -1;
5497 it
->bidi_it
.string
.s
= NULL
;
5498 it
->bidi_it
.string
.lstring
= Qnil
;
5503 it
->stop_charpos
= CHARPOS (pos
);
5504 it
->base_level_stop
= CHARPOS (pos
);
5509 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5510 If S is non-null, it is a C string to iterate over. Otherwise,
5511 STRING gives a Lisp string to iterate over.
5513 If PRECISION > 0, don't return more then PRECISION number of
5514 characters from the string.
5516 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5517 characters have been returned. FIELD_WIDTH < 0 means an infinite
5520 MULTIBYTE = 0 means disable processing of multibyte characters,
5521 MULTIBYTE > 0 means enable it,
5522 MULTIBYTE < 0 means use IT->multibyte_p.
5524 IT must be initialized via a prior call to init_iterator before
5525 calling this function. */
5528 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5529 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5532 /* No region in strings. */
5533 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5535 /* No text property checks performed by default, but see below. */
5536 it
->stop_charpos
= -1;
5538 /* Set iterator position and end position. */
5539 memset (&it
->current
, 0, sizeof it
->current
);
5540 it
->current
.overlay_string_index
= -1;
5541 it
->current
.dpvec_index
= -1;
5542 xassert (charpos
>= 0);
5544 /* If STRING is specified, use its multibyteness, otherwise use the
5545 setting of MULTIBYTE, if specified. */
5547 it
->multibyte_p
= multibyte
> 0;
5549 /* String reordering is controlled by the default value of
5550 bidi-display-reordering. */
5552 it
->multibyte_p
&& BVAR (&buffer_defaults
, bidi_display_reordering
);
5557 xassert (STRINGP (string
));
5558 it
->string
= string
;
5560 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5561 it
->method
= GET_FROM_STRING
;
5562 it
->current
.string_pos
= string_pos (charpos
, string
);
5566 it
->paragraph_embedding
= NEUTRAL_DIR
;
5567 it
->bidi_it
.string
.lstring
= string
;
5568 it
->bidi_it
.string
.s
= SDATA (string
);
5569 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5570 it
->bidi_it
.string
.from_disp_str
= 0;
5571 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5572 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5578 it
->s
= (const unsigned char *) s
;
5581 /* Note that we use IT->current.pos, not it->current.string_pos,
5582 for displaying C strings. */
5583 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5584 if (it
->multibyte_p
)
5586 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5587 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5591 it
->paragraph_embedding
= NEUTRAL_DIR
;
5592 it
->bidi_it
.string
.lstring
= Qnil
;
5593 it
->bidi_it
.string
.s
= s
;
5594 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5595 it
->bidi_it
.string
.from_disp_str
= 0;
5596 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5603 /* Unibyte (a.k.a. ASCII) C strings are never bidi-reordered. */
5604 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5605 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5608 it
->method
= GET_FROM_C_STRING
;
5611 /* PRECISION > 0 means don't return more than PRECISION characters
5613 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5615 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5618 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5622 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5623 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5624 FIELD_WIDTH < 0 means infinite field width. This is useful for
5625 padding with `-' at the end of a mode line. */
5626 if (field_width
< 0)
5627 field_width
= INFINITY
;
5628 /* Implementation note: We deliberately don't enlarge
5629 it->bidi_it.string.schars here to fit it->end_charpos, because
5630 the bidi iterator cannot produce characters out of thin air. */
5631 if (field_width
> it
->end_charpos
- charpos
)
5632 it
->end_charpos
= charpos
+ field_width
;
5634 /* Use the standard display table for displaying strings. */
5635 if (DISP_TABLE_P (Vstandard_display_table
))
5636 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5638 it
->stop_charpos
= charpos
;
5640 it
->prev_stop
= charpos
;
5641 it
->base_level_stop
= 0;
5644 it
->bidi_it
.first_elt
= 1;
5645 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5646 it
->bidi_it
.disp_pos
= -1;
5649 if (s
== NULL
&& it
->multibyte_p
)
5651 EMACS_INT endpos
= SCHARS (it
->string
);
5652 if (endpos
> it
->end_charpos
)
5653 endpos
= it
->end_charpos
;
5654 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5662 /***********************************************************************
5664 ***********************************************************************/
5666 /* Map enum it_method value to corresponding next_element_from_* function. */
5668 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5670 next_element_from_buffer
,
5671 next_element_from_display_vector
,
5672 next_element_from_string
,
5673 next_element_from_c_string
,
5674 next_element_from_image
,
5675 next_element_from_stretch
5678 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5681 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5682 (possibly with the following characters). */
5684 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5685 ((IT)->cmp_it.id >= 0 \
5686 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5687 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5688 END_CHARPOS, (IT)->w, \
5689 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5693 /* Lookup the char-table Vglyphless_char_display for character C (-1
5694 if we want information for no-font case), and return the display
5695 method symbol. By side-effect, update it->what and
5696 it->glyphless_method. This function is called from
5697 get_next_display_element for each character element, and from
5698 x_produce_glyphs when no suitable font was found. */
5701 lookup_glyphless_char_display (int c
, struct it
*it
)
5703 Lisp_Object glyphless_method
= Qnil
;
5705 if (CHAR_TABLE_P (Vglyphless_char_display
)
5706 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
5710 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
5711 if (CONSP (glyphless_method
))
5712 glyphless_method
= FRAME_WINDOW_P (it
->f
)
5713 ? XCAR (glyphless_method
)
5714 : XCDR (glyphless_method
);
5717 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
5721 if (NILP (glyphless_method
))
5724 /* The default is to display the character by a proper font. */
5726 /* The default for the no-font case is to display an empty box. */
5727 glyphless_method
= Qempty_box
;
5729 if (EQ (glyphless_method
, Qzero_width
))
5732 return glyphless_method
;
5733 /* This method can't be used for the no-font case. */
5734 glyphless_method
= Qempty_box
;
5736 if (EQ (glyphless_method
, Qthin_space
))
5737 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
5738 else if (EQ (glyphless_method
, Qempty_box
))
5739 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
5740 else if (EQ (glyphless_method
, Qhex_code
))
5741 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
5742 else if (STRINGP (glyphless_method
))
5743 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
5746 /* Invalid value. We use the default method. */
5747 glyphless_method
= Qnil
;
5750 it
->what
= IT_GLYPHLESS
;
5751 return glyphless_method
;
5754 /* Load IT's display element fields with information about the next
5755 display element from the current position of IT. Value is zero if
5756 end of buffer (or C string) is reached. */
5758 static struct frame
*last_escape_glyph_frame
= NULL
;
5759 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5760 static int last_escape_glyph_merged_face_id
= 0;
5762 struct frame
*last_glyphless_glyph_frame
= NULL
;
5763 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
5764 int last_glyphless_glyph_merged_face_id
= 0;
5767 get_next_display_element (struct it
*it
)
5769 /* Non-zero means that we found a display element. Zero means that
5770 we hit the end of what we iterate over. Performance note: the
5771 function pointer `method' used here turns out to be faster than
5772 using a sequence of if-statements. */
5776 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5778 if (it
->what
== IT_CHARACTER
)
5780 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5781 and only if (a) the resolved directionality of that character
5783 /* FIXME: Do we need an exception for characters from display
5785 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5786 it
->c
= bidi_mirror_char (it
->c
);
5787 /* Map via display table or translate control characters.
5788 IT->c, IT->len etc. have been set to the next character by
5789 the function call above. If we have a display table, and it
5790 contains an entry for IT->c, translate it. Don't do this if
5791 IT->c itself comes from a display table, otherwise we could
5792 end up in an infinite recursion. (An alternative could be to
5793 count the recursion depth of this function and signal an
5794 error when a certain maximum depth is reached.) Is it worth
5796 if (success_p
&& it
->dpvec
== NULL
)
5799 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5800 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5801 nbsp_or_shy
= char_is_other
;
5802 int c
= it
->c
; /* This is the character to display. */
5804 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5806 xassert (SINGLE_BYTE_CHAR_P (c
));
5807 if (unibyte_display_via_language_environment
)
5809 c
= DECODE_CHAR (unibyte
, c
);
5811 c
= BYTE8_TO_CHAR (it
->c
);
5814 c
= BYTE8_TO_CHAR (it
->c
);
5818 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5821 struct Lisp_Vector
*v
= XVECTOR (dv
);
5823 /* Return the first character from the display table
5824 entry, if not empty. If empty, don't display the
5825 current character. */
5828 it
->dpvec_char_len
= it
->len
;
5829 it
->dpvec
= v
->contents
;
5830 it
->dpend
= v
->contents
+ v
->header
.size
;
5831 it
->current
.dpvec_index
= 0;
5832 it
->dpvec_face_id
= -1;
5833 it
->saved_face_id
= it
->face_id
;
5834 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5839 set_iterator_to_next (it
, 0);
5844 if (! NILP (lookup_glyphless_char_display (c
, it
)))
5846 if (it
->what
== IT_GLYPHLESS
)
5848 /* Don't display this character. */
5849 set_iterator_to_next (it
, 0);
5853 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5854 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5855 : c
== 0xAD ? char_is_soft_hyphen
5858 /* Translate control characters into `\003' or `^C' form.
5859 Control characters coming from a display table entry are
5860 currently not translated because we use IT->dpvec to hold
5861 the translation. This could easily be changed but I
5862 don't believe that it is worth doing.
5864 NBSP and SOFT-HYPEN are property translated too.
5866 Non-printable characters and raw-byte characters are also
5867 translated to octal form. */
5868 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5869 ? (it
->area
!= TEXT_AREA
5870 /* In mode line, treat \n, \t like other crl chars. */
5873 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5874 || (c
!= '\n' && c
!= '\t'))
5877 || ! CHAR_PRINTABLE_P (c
))))
5879 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5880 or a non-printable character which must be displayed
5881 either as '\003' or as `^C' where the '\\' and '^'
5882 can be defined in the display table. Fill
5883 IT->ctl_chars with glyphs for what we have to
5884 display. Then, set IT->dpvec to these glyphs. */
5887 int face_id
, lface_id
= 0 ;
5890 /* Handle control characters with ^. */
5892 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5896 g
= '^'; /* default glyph for Control */
5897 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5899 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5900 && GLYPH_CODE_CHAR_VALID_P (gc
))
5902 g
= GLYPH_CODE_CHAR (gc
);
5903 lface_id
= GLYPH_CODE_FACE (gc
);
5907 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5909 else if (it
->f
== last_escape_glyph_frame
5910 && it
->face_id
== last_escape_glyph_face_id
)
5912 face_id
= last_escape_glyph_merged_face_id
;
5916 /* Merge the escape-glyph face into the current face. */
5917 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5919 last_escape_glyph_frame
= it
->f
;
5920 last_escape_glyph_face_id
= it
->face_id
;
5921 last_escape_glyph_merged_face_id
= face_id
;
5924 XSETINT (it
->ctl_chars
[0], g
);
5925 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5927 goto display_control
;
5930 /* Handle non-break space in the mode where it only gets
5933 if (EQ (Vnobreak_char_display
, Qt
)
5934 && nbsp_or_shy
== char_is_nbsp
)
5936 /* Merge the no-break-space face into the current face. */
5937 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5941 XSETINT (it
->ctl_chars
[0], ' ');
5943 goto display_control
;
5946 /* Handle sequences that start with the "escape glyph". */
5948 /* the default escape glyph is \. */
5949 escape_glyph
= '\\';
5952 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5953 && GLYPH_CODE_CHAR_VALID_P (gc
))
5955 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5956 lface_id
= GLYPH_CODE_FACE (gc
);
5960 /* The display table specified a face.
5961 Merge it into face_id and also into escape_glyph. */
5962 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5965 else if (it
->f
== last_escape_glyph_frame
5966 && it
->face_id
== last_escape_glyph_face_id
)
5968 face_id
= last_escape_glyph_merged_face_id
;
5972 /* Merge the escape-glyph face into the current face. */
5973 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5975 last_escape_glyph_frame
= it
->f
;
5976 last_escape_glyph_face_id
= it
->face_id
;
5977 last_escape_glyph_merged_face_id
= face_id
;
5980 /* Handle soft hyphens in the mode where they only get
5983 if (EQ (Vnobreak_char_display
, Qt
)
5984 && nbsp_or_shy
== char_is_soft_hyphen
)
5986 XSETINT (it
->ctl_chars
[0], '-');
5988 goto display_control
;
5991 /* Handle non-break space and soft hyphen
5992 with the escape glyph. */
5996 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5997 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5998 XSETINT (it
->ctl_chars
[1], c
);
6000 goto display_control
;
6007 if (CHAR_BYTE8_P (c
))
6008 /* Display \200 instead of \17777600. */
6009 c
= CHAR_TO_BYTE8 (c
);
6010 len
= sprintf (str
, "%03o", c
);
6012 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6013 for (i
= 0; i
< len
; i
++)
6014 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6019 /* Set up IT->dpvec and return first character from it. */
6020 it
->dpvec_char_len
= it
->len
;
6021 it
->dpvec
= it
->ctl_chars
;
6022 it
->dpend
= it
->dpvec
+ ctl_len
;
6023 it
->current
.dpvec_index
= 0;
6024 it
->dpvec_face_id
= face_id
;
6025 it
->saved_face_id
= it
->face_id
;
6026 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6030 it
->char_to_display
= c
;
6034 it
->char_to_display
= it
->c
;
6038 /* Adjust face id for a multibyte character. There are no multibyte
6039 character in unibyte text. */
6040 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6043 && FRAME_WINDOW_P (it
->f
))
6045 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6047 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6049 /* Automatic composition with glyph-string. */
6050 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6052 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6056 EMACS_INT pos
= (it
->s
? -1
6057 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6058 : IT_CHARPOS (*it
));
6060 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
6066 /* Is this character the last one of a run of characters with
6067 box? If yes, set IT->end_of_box_run_p to 1. */
6071 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6073 int face_id
= underlying_face_id (it
);
6074 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6078 if (face
->box
== FACE_NO_BOX
)
6080 /* If the box comes from face properties in a
6081 display string, check faces in that string. */
6082 int string_face_id
= face_after_it_pos (it
);
6083 it
->end_of_box_run_p
6084 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6087 /* Otherwise, the box comes from the underlying face.
6088 If this is the last string character displayed, check
6089 the next buffer location. */
6090 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6091 && (it
->current
.overlay_string_index
6092 == it
->n_overlay_strings
- 1))
6096 struct text_pos pos
= it
->current
.pos
;
6097 INC_TEXT_POS (pos
, it
->multibyte_p
);
6099 next_face_id
= face_at_buffer_position
6100 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6101 it
->region_end_charpos
, &ignore
,
6102 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6104 it
->end_of_box_run_p
6105 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6112 int face_id
= face_after_it_pos (it
);
6113 it
->end_of_box_run_p
6114 = (face_id
!= it
->face_id
6115 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6119 /* Value is 0 if end of buffer or string reached. */
6124 /* Move IT to the next display element.
6126 RESEAT_P non-zero means if called on a newline in buffer text,
6127 skip to the next visible line start.
6129 Functions get_next_display_element and set_iterator_to_next are
6130 separate because I find this arrangement easier to handle than a
6131 get_next_display_element function that also increments IT's
6132 position. The way it is we can first look at an iterator's current
6133 display element, decide whether it fits on a line, and if it does,
6134 increment the iterator position. The other way around we probably
6135 would either need a flag indicating whether the iterator has to be
6136 incremented the next time, or we would have to implement a
6137 decrement position function which would not be easy to write. */
6140 set_iterator_to_next (struct it
*it
, int reseat_p
)
6142 /* Reset flags indicating start and end of a sequence of characters
6143 with box. Reset them at the start of this function because
6144 moving the iterator to a new position might set them. */
6145 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6149 case GET_FROM_BUFFER
:
6150 /* The current display element of IT is a character from
6151 current_buffer. Advance in the buffer, and maybe skip over
6152 invisible lines that are so because of selective display. */
6153 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6154 reseat_at_next_visible_line_start (it
, 0);
6155 else if (it
->cmp_it
.id
>= 0)
6157 /* We are currently getting glyphs from a composition. */
6162 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6163 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6164 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6166 it
->cmp_it
.from
= it
->cmp_it
.to
;
6171 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6173 it
->end_charpos
, Qnil
);
6176 else if (! it
->cmp_it
.reversed_p
)
6178 /* Composition created while scanning forward. */
6179 /* Update IT's char/byte positions to point to the first
6180 character of the next grapheme cluster, or to the
6181 character visually after the current composition. */
6182 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6183 bidi_move_to_visually_next (&it
->bidi_it
);
6184 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6185 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6187 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6189 /* Proceed to the next grapheme cluster. */
6190 it
->cmp_it
.from
= it
->cmp_it
.to
;
6194 /* No more grapheme clusters in this composition.
6195 Find the next stop position. */
6196 EMACS_INT stop
= it
->end_charpos
;
6197 if (it
->bidi_it
.scan_dir
< 0)
6198 /* Now we are scanning backward and don't know
6201 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6202 IT_BYTEPOS (*it
), stop
, Qnil
);
6207 /* Composition created while scanning backward. */
6208 /* Update IT's char/byte positions to point to the last
6209 character of the previous grapheme cluster, or the
6210 character visually after the current composition. */
6211 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6212 bidi_move_to_visually_next (&it
->bidi_it
);
6213 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6214 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6215 if (it
->cmp_it
.from
> 0)
6217 /* Proceed to the previous grapheme cluster. */
6218 it
->cmp_it
.to
= it
->cmp_it
.from
;
6222 /* No more grapheme clusters in this composition.
6223 Find the next stop position. */
6224 EMACS_INT stop
= it
->end_charpos
;
6225 if (it
->bidi_it
.scan_dir
< 0)
6226 /* Now we are scanning backward and don't know
6229 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6230 IT_BYTEPOS (*it
), stop
, Qnil
);
6236 xassert (it
->len
!= 0);
6240 IT_BYTEPOS (*it
) += it
->len
;
6241 IT_CHARPOS (*it
) += 1;
6245 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6246 /* If this is a new paragraph, determine its base
6247 direction (a.k.a. its base embedding level). */
6248 if (it
->bidi_it
.new_paragraph
)
6249 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6250 bidi_move_to_visually_next (&it
->bidi_it
);
6251 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6252 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6253 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6255 /* As the scan direction was changed, we must
6256 re-compute the stop position for composition. */
6257 EMACS_INT stop
= it
->end_charpos
;
6258 if (it
->bidi_it
.scan_dir
< 0)
6260 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6261 IT_BYTEPOS (*it
), stop
, Qnil
);
6264 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6268 case GET_FROM_C_STRING
:
6269 /* Current display element of IT is from a C string. */
6270 IT_BYTEPOS (*it
) += it
->len
;
6271 IT_CHARPOS (*it
) += 1;
6274 case GET_FROM_DISPLAY_VECTOR
:
6275 /* Current display element of IT is from a display table entry.
6276 Advance in the display table definition. Reset it to null if
6277 end reached, and continue with characters from buffers/
6279 ++it
->current
.dpvec_index
;
6281 /* Restore face of the iterator to what they were before the
6282 display vector entry (these entries may contain faces). */
6283 it
->face_id
= it
->saved_face_id
;
6285 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6287 int recheck_faces
= it
->ellipsis_p
;
6290 it
->method
= GET_FROM_C_STRING
;
6291 else if (STRINGP (it
->string
))
6292 it
->method
= GET_FROM_STRING
;
6295 it
->method
= GET_FROM_BUFFER
;
6296 it
->object
= it
->w
->buffer
;
6300 it
->current
.dpvec_index
= -1;
6302 /* Skip over characters which were displayed via IT->dpvec. */
6303 if (it
->dpvec_char_len
< 0)
6304 reseat_at_next_visible_line_start (it
, 1);
6305 else if (it
->dpvec_char_len
> 0)
6307 if (it
->method
== GET_FROM_STRING
6308 && it
->n_overlay_strings
> 0)
6309 it
->ignore_overlay_strings_at_pos_p
= 1;
6310 it
->len
= it
->dpvec_char_len
;
6311 set_iterator_to_next (it
, reseat_p
);
6314 /* Maybe recheck faces after display vector */
6316 it
->stop_charpos
= IT_CHARPOS (*it
);
6320 case GET_FROM_STRING
:
6321 /* Current display element is a character from a Lisp string. */
6322 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6323 if (it
->cmp_it
.id
>= 0)
6325 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6326 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6327 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6328 it
->cmp_it
.from
= it
->cmp_it
.to
;
6332 composition_compute_stop_pos (&it
->cmp_it
,
6333 IT_STRING_CHARPOS (*it
),
6334 IT_STRING_BYTEPOS (*it
),
6335 it
->end_charpos
, it
->string
);
6340 IT_STRING_BYTEPOS (*it
) += it
->len
;
6341 IT_STRING_CHARPOS (*it
) += 1;
6344 consider_string_end
:
6346 if (it
->current
.overlay_string_index
>= 0)
6348 /* IT->string is an overlay string. Advance to the
6349 next, if there is one. */
6350 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6353 next_overlay_string (it
);
6355 setup_for_ellipsis (it
, 0);
6360 /* IT->string is not an overlay string. If we reached
6361 its end, and there is something on IT->stack, proceed
6362 with what is on the stack. This can be either another
6363 string, this time an overlay string, or a buffer. */
6364 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6368 if (it
->method
== GET_FROM_STRING
)
6369 goto consider_string_end
;
6374 case GET_FROM_IMAGE
:
6375 case GET_FROM_STRETCH
:
6376 /* The position etc with which we have to proceed are on
6377 the stack. The position may be at the end of a string,
6378 if the `display' property takes up the whole string. */
6379 xassert (it
->sp
> 0);
6381 if (it
->method
== GET_FROM_STRING
)
6382 goto consider_string_end
;
6386 /* There are no other methods defined, so this should be a bug. */
6390 xassert (it
->method
!= GET_FROM_STRING
6391 || (STRINGP (it
->string
)
6392 && IT_STRING_CHARPOS (*it
) >= 0));
6395 /* Load IT's display element fields with information about the next
6396 display element which comes from a display table entry or from the
6397 result of translating a control character to one of the forms `^C'
6400 IT->dpvec holds the glyphs to return as characters.
6401 IT->saved_face_id holds the face id before the display vector--it
6402 is restored into IT->face_id in set_iterator_to_next. */
6405 next_element_from_display_vector (struct it
*it
)
6410 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6412 it
->face_id
= it
->saved_face_id
;
6414 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6415 That seemed totally bogus - so I changed it... */
6416 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6418 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6420 it
->c
= GLYPH_CODE_CHAR (gc
);
6421 it
->len
= CHAR_BYTES (it
->c
);
6423 /* The entry may contain a face id to use. Such a face id is
6424 the id of a Lisp face, not a realized face. A face id of
6425 zero means no face is specified. */
6426 if (it
->dpvec_face_id
>= 0)
6427 it
->face_id
= it
->dpvec_face_id
;
6430 int lface_id
= GLYPH_CODE_FACE (gc
);
6432 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6437 /* Display table entry is invalid. Return a space. */
6438 it
->c
= ' ', it
->len
= 1;
6440 /* Don't change position and object of the iterator here. They are
6441 still the values of the character that had this display table
6442 entry or was translated, and that's what we want. */
6443 it
->what
= IT_CHARACTER
;
6448 /* Load IT with the next display element from Lisp string IT->string.
6449 IT->current.string_pos is the current position within the string.
6450 If IT->current.overlay_string_index >= 0, the Lisp string is an
6454 next_element_from_string (struct it
*it
)
6456 struct text_pos position
;
6458 xassert (STRINGP (it
->string
));
6459 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6460 position
= it
->current
.string_pos
;
6462 /* Time to check for invisible text? */
6463 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6464 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6468 /* Since a handler may have changed IT->method, we must
6470 return GET_NEXT_DISPLAY_ELEMENT (it
);
6473 if (it
->current
.overlay_string_index
>= 0)
6475 /* Get the next character from an overlay string. In overlay
6476 strings, There is no field width or padding with spaces to
6478 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6483 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6484 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6485 && next_element_from_composition (it
))
6489 else if (STRING_MULTIBYTE (it
->string
))
6491 const unsigned char *s
= (SDATA (it
->string
)
6492 + IT_STRING_BYTEPOS (*it
));
6493 it
->c
= string_char_and_length (s
, &it
->len
);
6497 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6503 /* Get the next character from a Lisp string that is not an
6504 overlay string. Such strings come from the mode line, for
6505 example. We may have to pad with spaces, or truncate the
6506 string. See also next_element_from_c_string. */
6507 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6512 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6514 /* Pad with spaces. */
6515 it
->c
= ' ', it
->len
= 1;
6516 CHARPOS (position
) = BYTEPOS (position
) = -1;
6518 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6519 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6520 && next_element_from_composition (it
))
6524 else if (STRING_MULTIBYTE (it
->string
))
6526 const unsigned char *s
= (SDATA (it
->string
)
6527 + IT_STRING_BYTEPOS (*it
));
6528 it
->c
= string_char_and_length (s
, &it
->len
);
6532 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6537 /* Record what we have and where it came from. */
6538 it
->what
= IT_CHARACTER
;
6539 it
->object
= it
->string
;
6540 it
->position
= position
;
6545 /* Load IT with next display element from C string IT->s.
6546 IT->string_nchars is the maximum number of characters to return
6547 from the string. IT->end_charpos may be greater than
6548 IT->string_nchars when this function is called, in which case we
6549 may have to return padding spaces. Value is zero if end of string
6550 reached, including padding spaces. */
6553 next_element_from_c_string (struct it
*it
)
6558 it
->what
= IT_CHARACTER
;
6559 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6562 /* IT's position can be greater IT->string_nchars in case a field
6563 width or precision has been specified when the iterator was
6565 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6567 /* End of the game. */
6571 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6573 /* Pad with spaces. */
6574 it
->c
= ' ', it
->len
= 1;
6575 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6577 else if (it
->multibyte_p
)
6578 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6580 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6586 /* Set up IT to return characters from an ellipsis, if appropriate.
6587 The definition of the ellipsis glyphs may come from a display table
6588 entry. This function fills IT with the first glyph from the
6589 ellipsis if an ellipsis is to be displayed. */
6592 next_element_from_ellipsis (struct it
*it
)
6594 if (it
->selective_display_ellipsis_p
)
6595 setup_for_ellipsis (it
, it
->len
);
6598 /* The face at the current position may be different from the
6599 face we find after the invisible text. Remember what it
6600 was in IT->saved_face_id, and signal that it's there by
6601 setting face_before_selective_p. */
6602 it
->saved_face_id
= it
->face_id
;
6603 it
->method
= GET_FROM_BUFFER
;
6604 it
->object
= it
->w
->buffer
;
6605 reseat_at_next_visible_line_start (it
, 1);
6606 it
->face_before_selective_p
= 1;
6609 return GET_NEXT_DISPLAY_ELEMENT (it
);
6613 /* Deliver an image display element. The iterator IT is already
6614 filled with image information (done in handle_display_prop). Value
6619 next_element_from_image (struct it
*it
)
6621 it
->what
= IT_IMAGE
;
6622 it
->ignore_overlay_strings_at_pos_p
= 0;
6627 /* Fill iterator IT with next display element from a stretch glyph
6628 property. IT->object is the value of the text property. Value is
6632 next_element_from_stretch (struct it
*it
)
6634 it
->what
= IT_STRETCH
;
6638 /* Scan forward from CHARPOS in the current buffer, until we find a
6639 stop position > current IT's position. Then handle the stop
6640 position before that. This is called when we bump into a stop
6641 position while reordering bidirectional text. CHARPOS should be
6642 the last previously processed stop_pos (or BEGV, if none were
6643 processed yet) whose position is less that IT's current
6647 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6649 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6650 struct display_pos save_current
= it
->current
;
6651 struct text_pos save_position
= it
->position
;
6652 struct text_pos pos1
;
6653 EMACS_INT next_stop
;
6655 /* Scan in strict logical order. */
6659 it
->prev_stop
= charpos
;
6660 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6661 reseat_1 (it
, pos1
, 0);
6662 compute_stop_pos (it
);
6663 /* We must advance forward, right? */
6664 if (it
->stop_charpos
<= it
->prev_stop
)
6666 charpos
= it
->stop_charpos
;
6668 while (charpos
<= where_we_are
);
6670 next_stop
= it
->stop_charpos
;
6671 it
->stop_charpos
= it
->prev_stop
;
6673 it
->current
= save_current
;
6674 it
->position
= save_position
;
6676 it
->stop_charpos
= next_stop
;
6679 /* Load IT with the next display element from current_buffer. Value
6680 is zero if end of buffer reached. IT->stop_charpos is the next
6681 position at which to stop and check for text properties or buffer
6685 next_element_from_buffer (struct it
*it
)
6689 xassert (IT_CHARPOS (*it
) >= BEGV
);
6691 /* With bidi reordering, the character to display might not be the
6692 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6693 we were reseat()ed to a new buffer position, which is potentially
6694 a different paragraph. */
6695 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6697 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6698 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6699 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6701 /* Nothing to do, but reset the FIRST_ELT flag, like
6702 bidi_paragraph_init does, because we are not going to
6704 it
->bidi_it
.first_elt
= 0;
6706 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6707 /* FIXME: Should support all Unicode line separators. */
6708 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6709 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6711 /* If we are at the beginning of a line, we can produce the
6712 next element right away. */
6713 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6714 bidi_move_to_visually_next (&it
->bidi_it
);
6718 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6720 /* We need to prime the bidi iterator starting at the line's
6721 beginning, before we will be able to produce the next
6723 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6724 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6725 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6726 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6727 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6730 /* Now return to buffer position where we were asked to
6731 get the next display element, and produce that. */
6732 bidi_move_to_visually_next (&it
->bidi_it
);
6734 while (it
->bidi_it
.bytepos
!= orig_bytepos
6735 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6738 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6739 /* Adjust IT's position information to where we ended up. */
6740 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6741 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6742 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6744 EMACS_INT stop
= it
->end_charpos
;
6745 if (it
->bidi_it
.scan_dir
< 0)
6747 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6748 IT_BYTEPOS (*it
), stop
, Qnil
);
6752 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6754 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6756 int overlay_strings_follow_p
;
6758 /* End of the game, except when overlay strings follow that
6759 haven't been returned yet. */
6760 if (it
->overlay_strings_at_end_processed_p
)
6761 overlay_strings_follow_p
= 0;
6764 it
->overlay_strings_at_end_processed_p
= 1;
6765 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6768 if (overlay_strings_follow_p
)
6769 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6773 it
->position
= it
->current
.pos
;
6777 else if (!(!it
->bidi_p
6778 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6779 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6781 /* With bidi non-linear iteration, we could find ourselves
6782 far beyond the last computed stop_charpos, with several
6783 other stop positions in between that we missed. Scan
6784 them all now, in buffer's logical order, until we find
6785 and handle the last stop_charpos that precedes our
6786 current position. */
6787 handle_stop_backwards (it
, it
->stop_charpos
);
6788 return GET_NEXT_DISPLAY_ELEMENT (it
);
6794 /* Take note of the stop position we just moved across,
6795 for when we will move back across it. */
6796 it
->prev_stop
= it
->stop_charpos
;
6797 /* If we are at base paragraph embedding level, take
6798 note of the last stop position seen at this
6800 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6801 it
->base_level_stop
= it
->stop_charpos
;
6804 return GET_NEXT_DISPLAY_ELEMENT (it
);
6808 /* We can sometimes back up for reasons that have nothing
6809 to do with bidi reordering. E.g., compositions. The
6810 code below is only needed when we are above the base
6811 embedding level, so test for that explicitly. */
6812 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6813 && IT_CHARPOS (*it
) < it
->prev_stop
)
6815 if (it
->base_level_stop
<= 0)
6816 it
->base_level_stop
= BEGV
;
6817 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6819 handle_stop_backwards (it
, it
->base_level_stop
);
6820 return GET_NEXT_DISPLAY_ELEMENT (it
);
6824 /* No face changes, overlays etc. in sight, so just return a
6825 character from current_buffer. */
6829 /* Maybe run the redisplay end trigger hook. Performance note:
6830 This doesn't seem to cost measurable time. */
6831 if (it
->redisplay_end_trigger_charpos
6833 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6834 run_redisplay_end_trigger_hook (it
);
6836 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6837 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6839 && next_element_from_composition (it
))
6844 /* Get the next character, maybe multibyte. */
6845 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6846 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6847 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6849 it
->c
= *p
, it
->len
= 1;
6851 /* Record what we have and where it came from. */
6852 it
->what
= IT_CHARACTER
;
6853 it
->object
= it
->w
->buffer
;
6854 it
->position
= it
->current
.pos
;
6856 /* Normally we return the character found above, except when we
6857 really want to return an ellipsis for selective display. */
6862 /* A value of selective > 0 means hide lines indented more
6863 than that number of columns. */
6864 if (it
->selective
> 0
6865 && IT_CHARPOS (*it
) + 1 < ZV
6866 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6867 IT_BYTEPOS (*it
) + 1,
6868 (double) it
->selective
)) /* iftc */
6870 success_p
= next_element_from_ellipsis (it
);
6871 it
->dpvec_char_len
= -1;
6874 else if (it
->c
== '\r' && it
->selective
== -1)
6876 /* A value of selective == -1 means that everything from the
6877 CR to the end of the line is invisible, with maybe an
6878 ellipsis displayed for it. */
6879 success_p
= next_element_from_ellipsis (it
);
6880 it
->dpvec_char_len
= -1;
6885 /* Value is zero if end of buffer reached. */
6886 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6891 /* Run the redisplay end trigger hook for IT. */
6894 run_redisplay_end_trigger_hook (struct it
*it
)
6896 Lisp_Object args
[3];
6898 /* IT->glyph_row should be non-null, i.e. we should be actually
6899 displaying something, or otherwise we should not run the hook. */
6900 xassert (it
->glyph_row
);
6902 /* Set up hook arguments. */
6903 args
[0] = Qredisplay_end_trigger_functions
;
6904 args
[1] = it
->window
;
6905 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6906 it
->redisplay_end_trigger_charpos
= 0;
6908 /* Since we are *trying* to run these functions, don't try to run
6909 them again, even if they get an error. */
6910 it
->w
->redisplay_end_trigger
= Qnil
;
6911 Frun_hook_with_args (3, args
);
6913 /* Notice if it changed the face of the character we are on. */
6914 handle_face_prop (it
);
6918 /* Deliver a composition display element. Unlike the other
6919 next_element_from_XXX, this function is not registered in the array
6920 get_next_element[]. It is called from next_element_from_buffer and
6921 next_element_from_string when necessary. */
6924 next_element_from_composition (struct it
*it
)
6926 it
->what
= IT_COMPOSITION
;
6927 it
->len
= it
->cmp_it
.nbytes
;
6928 if (STRINGP (it
->string
))
6932 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6933 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6936 it
->position
= it
->current
.string_pos
;
6937 it
->object
= it
->string
;
6938 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6939 IT_STRING_BYTEPOS (*it
), it
->string
);
6945 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6946 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6949 if (it
->bidi_it
.new_paragraph
)
6950 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6951 /* Resync the bidi iterator with IT's new position.
6952 FIXME: this doesn't support bidirectional text. */
6953 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6954 bidi_move_to_visually_next (&it
->bidi_it
);
6958 it
->position
= it
->current
.pos
;
6959 it
->object
= it
->w
->buffer
;
6960 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6961 IT_BYTEPOS (*it
), Qnil
);
6968 /***********************************************************************
6969 Moving an iterator without producing glyphs
6970 ***********************************************************************/
6972 /* Check if iterator is at a position corresponding to a valid buffer
6973 position after some move_it_ call. */
6975 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6976 ((it)->method == GET_FROM_STRING \
6977 ? IT_STRING_CHARPOS (*it) == 0 \
6981 /* Move iterator IT to a specified buffer or X position within one
6982 line on the display without producing glyphs.
6984 OP should be a bit mask including some or all of these bits:
6985 MOVE_TO_X: Stop upon reaching x-position TO_X.
6986 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6987 Regardless of OP's value, stop upon reaching the end of the display line.
6989 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6990 This means, in particular, that TO_X includes window's horizontal
6993 The return value has several possible values that
6994 say what condition caused the scan to stop:
6996 MOVE_POS_MATCH_OR_ZV
6997 - when TO_POS or ZV was reached.
7000 -when TO_X was reached before TO_POS or ZV were reached.
7003 - when we reached the end of the display area and the line must
7007 - when we reached the end of the display area and the line is
7011 - when we stopped at a line end, i.e. a newline or a CR and selective
7014 static enum move_it_result
7015 move_it_in_display_line_to (struct it
*it
,
7016 EMACS_INT to_charpos
, int to_x
,
7017 enum move_operation_enum op
)
7019 enum move_it_result result
= MOVE_UNDEFINED
;
7020 struct glyph_row
*saved_glyph_row
;
7021 struct it wrap_it
, atpos_it
, atx_it
;
7023 enum it_method prev_method
= it
->method
;
7024 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7026 /* Don't produce glyphs in produce_glyphs. */
7027 saved_glyph_row
= it
->glyph_row
;
7028 it
->glyph_row
= NULL
;
7030 /* Use wrap_it to save a copy of IT wherever a word wrap could
7031 occur. Use atpos_it to save a copy of IT at the desired buffer
7032 position, if found, so that we can scan ahead and check if the
7033 word later overshoots the window edge. Use atx_it similarly, for
7039 #define BUFFER_POS_REACHED_P() \
7040 ((op & MOVE_TO_POS) != 0 \
7041 && BUFFERP (it->object) \
7042 && (IT_CHARPOS (*it) == to_charpos \
7043 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7044 && (it->method == GET_FROM_BUFFER \
7045 || (it->method == GET_FROM_DISPLAY_VECTOR \
7046 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7048 /* If there's a line-/wrap-prefix, handle it. */
7049 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7050 && it
->current_y
< it
->last_visible_y
)
7051 handle_line_prefix (it
);
7053 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7054 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7058 int x
, i
, ascent
= 0, descent
= 0;
7060 /* Utility macro to reset an iterator with x, ascent, and descent. */
7061 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7062 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7063 (IT)->max_descent = descent)
7065 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7067 if ((op
& MOVE_TO_POS
) != 0
7068 && BUFFERP (it
->object
)
7069 && it
->method
== GET_FROM_BUFFER
7070 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7072 && (prev_method
== GET_FROM_IMAGE
7073 || prev_method
== GET_FROM_STRETCH
)
7074 /* Passed TO_CHARPOS from left to right. */
7075 && ((prev_pos
< to_charpos
7076 && IT_CHARPOS (*it
) > to_charpos
)
7077 /* Passed TO_CHARPOS from right to left. */
7078 || (prev_pos
> to_charpos
7079 && IT_CHARPOS (*it
) < to_charpos
)))))
7081 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7083 result
= MOVE_POS_MATCH_OR_ZV
;
7086 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7087 /* If wrap_it is valid, the current position might be in a
7088 word that is wrapped. So, save the iterator in
7089 atpos_it and continue to see if wrapping happens. */
7093 prev_method
= it
->method
;
7094 if (it
->method
== GET_FROM_BUFFER
)
7095 prev_pos
= IT_CHARPOS (*it
);
7096 /* Stop when ZV reached.
7097 We used to stop here when TO_CHARPOS reached as well, but that is
7098 too soon if this glyph does not fit on this line. So we handle it
7099 explicitly below. */
7100 if (!get_next_display_element (it
))
7102 result
= MOVE_POS_MATCH_OR_ZV
;
7106 if (it
->line_wrap
== TRUNCATE
)
7108 if (BUFFER_POS_REACHED_P ())
7110 result
= MOVE_POS_MATCH_OR_ZV
;
7116 if (it
->line_wrap
== WORD_WRAP
)
7118 if (IT_DISPLAYING_WHITESPACE (it
))
7122 /* We have reached a glyph that follows one or more
7123 whitespace characters. If the position is
7124 already found, we are done. */
7125 if (atpos_it
.sp
>= 0)
7128 result
= MOVE_POS_MATCH_OR_ZV
;
7134 result
= MOVE_X_REACHED
;
7137 /* Otherwise, we can wrap here. */
7144 /* Remember the line height for the current line, in case
7145 the next element doesn't fit on the line. */
7146 ascent
= it
->max_ascent
;
7147 descent
= it
->max_descent
;
7149 /* The call to produce_glyphs will get the metrics of the
7150 display element IT is loaded with. Record the x-position
7151 before this display element, in case it doesn't fit on the
7155 PRODUCE_GLYPHS (it
);
7157 if (it
->area
!= TEXT_AREA
)
7159 set_iterator_to_next (it
, 1);
7160 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7161 SET_TEXT_POS (this_line_min_pos
,
7162 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7166 /* The number of glyphs we get back in IT->nglyphs will normally
7167 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7168 character on a terminal frame, or (iii) a line end. For the
7169 second case, IT->nglyphs - 1 padding glyphs will be present.
7170 (On X frames, there is only one glyph produced for a
7171 composite character.)
7173 The behavior implemented below means, for continuation lines,
7174 that as many spaces of a TAB as fit on the current line are
7175 displayed there. For terminal frames, as many glyphs of a
7176 multi-glyph character are displayed in the current line, too.
7177 This is what the old redisplay code did, and we keep it that
7178 way. Under X, the whole shape of a complex character must
7179 fit on the line or it will be completely displayed in the
7182 Note that both for tabs and padding glyphs, all glyphs have
7186 /* More than one glyph or glyph doesn't fit on line. All
7187 glyphs have the same width. */
7188 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7190 int x_before_this_char
= x
;
7191 int hpos_before_this_char
= it
->hpos
;
7193 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7195 new_x
= x
+ single_glyph_width
;
7197 /* We want to leave anything reaching TO_X to the caller. */
7198 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7200 if (BUFFER_POS_REACHED_P ())
7202 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7203 goto buffer_pos_reached
;
7204 if (atpos_it
.sp
< 0)
7207 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7212 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7215 result
= MOVE_X_REACHED
;
7221 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7226 if (/* Lines are continued. */
7227 it
->line_wrap
!= TRUNCATE
7228 && (/* And glyph doesn't fit on the line. */
7229 new_x
> it
->last_visible_x
7230 /* Or it fits exactly and we're on a window
7232 || (new_x
== it
->last_visible_x
7233 && FRAME_WINDOW_P (it
->f
))))
7235 if (/* IT->hpos == 0 means the very first glyph
7236 doesn't fit on the line, e.g. a wide image. */
7238 || (new_x
== it
->last_visible_x
7239 && FRAME_WINDOW_P (it
->f
)))
7242 it
->current_x
= new_x
;
7244 /* The character's last glyph just barely fits
7246 if (i
== it
->nglyphs
- 1)
7248 /* If this is the destination position,
7249 return a position *before* it in this row,
7250 now that we know it fits in this row. */
7251 if (BUFFER_POS_REACHED_P ())
7253 if (it
->line_wrap
!= WORD_WRAP
7256 it
->hpos
= hpos_before_this_char
;
7257 it
->current_x
= x_before_this_char
;
7258 result
= MOVE_POS_MATCH_OR_ZV
;
7261 if (it
->line_wrap
== WORD_WRAP
7265 atpos_it
.current_x
= x_before_this_char
;
7266 atpos_it
.hpos
= hpos_before_this_char
;
7270 set_iterator_to_next (it
, 1);
7271 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7272 SET_TEXT_POS (this_line_min_pos
,
7273 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7274 /* On graphical terminals, newlines may
7275 "overflow" into the fringe if
7276 overflow-newline-into-fringe is non-nil.
7277 On text-only terminals, newlines may
7278 overflow into the last glyph on the
7280 if (!FRAME_WINDOW_P (it
->f
)
7281 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7283 if (!get_next_display_element (it
))
7285 result
= MOVE_POS_MATCH_OR_ZV
;
7288 if (BUFFER_POS_REACHED_P ())
7290 if (ITERATOR_AT_END_OF_LINE_P (it
))
7291 result
= MOVE_POS_MATCH_OR_ZV
;
7293 result
= MOVE_LINE_CONTINUED
;
7296 if (ITERATOR_AT_END_OF_LINE_P (it
))
7298 result
= MOVE_NEWLINE_OR_CR
;
7305 IT_RESET_X_ASCENT_DESCENT (it
);
7307 if (wrap_it
.sp
>= 0)
7314 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7316 result
= MOVE_LINE_CONTINUED
;
7320 if (BUFFER_POS_REACHED_P ())
7322 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7323 goto buffer_pos_reached
;
7324 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7327 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7331 if (new_x
> it
->first_visible_x
)
7333 /* Glyph is visible. Increment number of glyphs that
7334 would be displayed. */
7339 if (result
!= MOVE_UNDEFINED
)
7342 else if (BUFFER_POS_REACHED_P ())
7345 IT_RESET_X_ASCENT_DESCENT (it
);
7346 result
= MOVE_POS_MATCH_OR_ZV
;
7349 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7351 /* Stop when TO_X specified and reached. This check is
7352 necessary here because of lines consisting of a line end,
7353 only. The line end will not produce any glyphs and we
7354 would never get MOVE_X_REACHED. */
7355 xassert (it
->nglyphs
== 0);
7356 result
= MOVE_X_REACHED
;
7360 /* Is this a line end? If yes, we're done. */
7361 if (ITERATOR_AT_END_OF_LINE_P (it
))
7363 result
= MOVE_NEWLINE_OR_CR
;
7367 if (it
->method
== GET_FROM_BUFFER
)
7368 prev_pos
= IT_CHARPOS (*it
);
7369 /* The current display element has been consumed. Advance
7371 set_iterator_to_next (it
, 1);
7372 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7373 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7375 /* Stop if lines are truncated and IT's current x-position is
7376 past the right edge of the window now. */
7377 if (it
->line_wrap
== TRUNCATE
7378 && it
->current_x
>= it
->last_visible_x
)
7380 if (!FRAME_WINDOW_P (it
->f
)
7381 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7383 if (!get_next_display_element (it
)
7384 || BUFFER_POS_REACHED_P ())
7386 result
= MOVE_POS_MATCH_OR_ZV
;
7389 if (ITERATOR_AT_END_OF_LINE_P (it
))
7391 result
= MOVE_NEWLINE_OR_CR
;
7395 result
= MOVE_LINE_TRUNCATED
;
7398 #undef IT_RESET_X_ASCENT_DESCENT
7401 #undef BUFFER_POS_REACHED_P
7403 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7404 restore the saved iterator. */
7405 if (atpos_it
.sp
>= 0)
7407 else if (atx_it
.sp
>= 0)
7412 /* Restore the iterator settings altered at the beginning of this
7414 it
->glyph_row
= saved_glyph_row
;
7418 /* For external use. */
7420 move_it_in_display_line (struct it
*it
,
7421 EMACS_INT to_charpos
, int to_x
,
7422 enum move_operation_enum op
)
7424 if (it
->line_wrap
== WORD_WRAP
7425 && (op
& MOVE_TO_X
))
7427 struct it save_it
= *it
;
7428 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7429 /* When word-wrap is on, TO_X may lie past the end
7430 of a wrapped line. Then it->current is the
7431 character on the next line, so backtrack to the
7432 space before the wrap point. */
7433 if (skip
== MOVE_LINE_CONTINUED
)
7435 int prev_x
= max (it
->current_x
- 1, 0);
7437 move_it_in_display_line_to
7438 (it
, -1, prev_x
, MOVE_TO_X
);
7442 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7446 /* Move IT forward until it satisfies one or more of the criteria in
7447 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7449 OP is a bit-mask that specifies where to stop, and in particular,
7450 which of those four position arguments makes a difference. See the
7451 description of enum move_operation_enum.
7453 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7454 screen line, this function will set IT to the next position >
7458 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7460 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7461 int line_height
, line_start_x
= 0, reached
= 0;
7465 if (op
& MOVE_TO_VPOS
)
7467 /* If no TO_CHARPOS and no TO_X specified, stop at the
7468 start of the line TO_VPOS. */
7469 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7471 if (it
->vpos
== to_vpos
)
7477 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7481 /* TO_VPOS >= 0 means stop at TO_X in the line at
7482 TO_VPOS, or at TO_POS, whichever comes first. */
7483 if (it
->vpos
== to_vpos
)
7489 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7491 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7496 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7498 /* We have reached TO_X but not in the line we want. */
7499 skip
= move_it_in_display_line_to (it
, to_charpos
,
7501 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7509 else if (op
& MOVE_TO_Y
)
7511 struct it it_backup
;
7513 if (it
->line_wrap
== WORD_WRAP
)
7516 /* TO_Y specified means stop at TO_X in the line containing
7517 TO_Y---or at TO_CHARPOS if this is reached first. The
7518 problem is that we can't really tell whether the line
7519 contains TO_Y before we have completely scanned it, and
7520 this may skip past TO_X. What we do is to first scan to
7523 If TO_X is not specified, use a TO_X of zero. The reason
7524 is to make the outcome of this function more predictable.
7525 If we didn't use TO_X == 0, we would stop at the end of
7526 the line which is probably not what a caller would expect
7528 skip
= move_it_in_display_line_to
7529 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7530 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7532 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7533 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7535 else if (skip
== MOVE_X_REACHED
)
7537 /* If TO_X was reached, we want to know whether TO_Y is
7538 in the line. We know this is the case if the already
7539 scanned glyphs make the line tall enough. Otherwise,
7540 we must check by scanning the rest of the line. */
7541 line_height
= it
->max_ascent
+ it
->max_descent
;
7542 if (to_y
>= it
->current_y
7543 && to_y
< it
->current_y
+ line_height
)
7549 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7550 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7552 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7553 line_height
= it
->max_ascent
+ it
->max_descent
;
7554 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7556 if (to_y
>= it
->current_y
7557 && to_y
< it
->current_y
+ line_height
)
7559 /* If TO_Y is in this line and TO_X was reached
7560 above, we scanned too far. We have to restore
7561 IT's settings to the ones before skipping. */
7568 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7574 /* Check whether TO_Y is in this line. */
7575 line_height
= it
->max_ascent
+ it
->max_descent
;
7576 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7578 if (to_y
>= it
->current_y
7579 && to_y
< it
->current_y
+ line_height
)
7581 /* When word-wrap is on, TO_X may lie past the end
7582 of a wrapped line. Then it->current is the
7583 character on the next line, so backtrack to the
7584 space before the wrap point. */
7585 if (skip
== MOVE_LINE_CONTINUED
7586 && it
->line_wrap
== WORD_WRAP
)
7588 int prev_x
= max (it
->current_x
- 1, 0);
7590 skip
= move_it_in_display_line_to
7591 (it
, -1, prev_x
, MOVE_TO_X
);
7600 else if (BUFFERP (it
->object
)
7601 && (it
->method
== GET_FROM_BUFFER
7602 || it
->method
== GET_FROM_STRETCH
)
7603 && IT_CHARPOS (*it
) >= to_charpos
)
7604 skip
= MOVE_POS_MATCH_OR_ZV
;
7606 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7610 case MOVE_POS_MATCH_OR_ZV
:
7614 case MOVE_NEWLINE_OR_CR
:
7615 set_iterator_to_next (it
, 1);
7616 it
->continuation_lines_width
= 0;
7619 case MOVE_LINE_TRUNCATED
:
7620 it
->continuation_lines_width
= 0;
7621 reseat_at_next_visible_line_start (it
, 0);
7622 if ((op
& MOVE_TO_POS
) != 0
7623 && IT_CHARPOS (*it
) > to_charpos
)
7630 case MOVE_LINE_CONTINUED
:
7631 /* For continued lines ending in a tab, some of the glyphs
7632 associated with the tab are displayed on the current
7633 line. Since it->current_x does not include these glyphs,
7634 we use it->last_visible_x instead. */
7637 it
->continuation_lines_width
+= it
->last_visible_x
;
7638 /* When moving by vpos, ensure that the iterator really
7639 advances to the next line (bug#847, bug#969). Fixme:
7640 do we need to do this in other circumstances? */
7641 if (it
->current_x
!= it
->last_visible_x
7642 && (op
& MOVE_TO_VPOS
)
7643 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7645 line_start_x
= it
->current_x
+ it
->pixel_width
7646 - it
->last_visible_x
;
7647 set_iterator_to_next (it
, 0);
7651 it
->continuation_lines_width
+= it
->current_x
;
7658 /* Reset/increment for the next run. */
7659 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7660 it
->current_x
= line_start_x
;
7663 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7665 last_height
= it
->max_ascent
+ it
->max_descent
;
7666 last_max_ascent
= it
->max_ascent
;
7667 it
->max_ascent
= it
->max_descent
= 0;
7672 /* On text terminals, we may stop at the end of a line in the middle
7673 of a multi-character glyph. If the glyph itself is continued,
7674 i.e. it is actually displayed on the next line, don't treat this
7675 stopping point as valid; move to the next line instead (unless
7676 that brings us offscreen). */
7677 if (!FRAME_WINDOW_P (it
->f
)
7679 && IT_CHARPOS (*it
) == to_charpos
7680 && it
->what
== IT_CHARACTER
7682 && it
->line_wrap
== WINDOW_WRAP
7683 && it
->current_x
== it
->last_visible_x
- 1
7686 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7688 it
->continuation_lines_width
+= it
->current_x
;
7689 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7690 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7692 last_height
= it
->max_ascent
+ it
->max_descent
;
7693 last_max_ascent
= it
->max_ascent
;
7696 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7700 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7702 If DY > 0, move IT backward at least that many pixels. DY = 0
7703 means move IT backward to the preceding line start or BEGV. This
7704 function may move over more than DY pixels if IT->current_y - DY
7705 ends up in the middle of a line; in this case IT->current_y will be
7706 set to the top of the line moved to. */
7709 move_it_vertically_backward (struct it
*it
, int dy
)
7713 EMACS_INT start_pos
;
7718 start_pos
= IT_CHARPOS (*it
);
7720 /* Estimate how many newlines we must move back. */
7721 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7723 /* Set the iterator's position that many lines back. */
7724 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7725 back_to_previous_visible_line_start (it
);
7727 /* Reseat the iterator here. When moving backward, we don't want
7728 reseat to skip forward over invisible text, set up the iterator
7729 to deliver from overlay strings at the new position etc. So,
7730 use reseat_1 here. */
7731 reseat_1 (it
, it
->current
.pos
, 1);
7733 /* We are now surely at a line start. */
7734 it
->current_x
= it
->hpos
= 0;
7735 it
->continuation_lines_width
= 0;
7737 /* Move forward and see what y-distance we moved. First move to the
7738 start of the next line so that we get its height. We need this
7739 height to be able to tell whether we reached the specified
7742 it2
.max_ascent
= it2
.max_descent
= 0;
7745 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7746 MOVE_TO_POS
| MOVE_TO_VPOS
);
7748 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7749 xassert (IT_CHARPOS (*it
) >= BEGV
);
7752 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7753 xassert (IT_CHARPOS (*it
) >= BEGV
);
7754 /* H is the actual vertical distance from the position in *IT
7755 and the starting position. */
7756 h
= it2
.current_y
- it
->current_y
;
7757 /* NLINES is the distance in number of lines. */
7758 nlines
= it2
.vpos
- it
->vpos
;
7760 /* Correct IT's y and vpos position
7761 so that they are relative to the starting point. */
7767 /* DY == 0 means move to the start of the screen line. The
7768 value of nlines is > 0 if continuation lines were involved. */
7770 move_it_by_lines (it
, nlines
);
7774 /* The y-position we try to reach, relative to *IT.
7775 Note that H has been subtracted in front of the if-statement. */
7776 int target_y
= it
->current_y
+ h
- dy
;
7777 int y0
= it3
.current_y
;
7778 int y1
= line_bottom_y (&it3
);
7779 int line_height
= y1
- y0
;
7781 /* If we did not reach target_y, try to move further backward if
7782 we can. If we moved too far backward, try to move forward. */
7783 if (target_y
< it
->current_y
7784 /* This is heuristic. In a window that's 3 lines high, with
7785 a line height of 13 pixels each, recentering with point
7786 on the bottom line will try to move -39/2 = 19 pixels
7787 backward. Try to avoid moving into the first line. */
7788 && (it
->current_y
- target_y
7789 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7790 && IT_CHARPOS (*it
) > BEGV
)
7792 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7793 target_y
- it
->current_y
));
7794 dy
= it
->current_y
- target_y
;
7795 goto move_further_back
;
7797 else if (target_y
>= it
->current_y
+ line_height
7798 && IT_CHARPOS (*it
) < ZV
)
7800 /* Should move forward by at least one line, maybe more.
7802 Note: Calling move_it_by_lines can be expensive on
7803 terminal frames, where compute_motion is used (via
7804 vmotion) to do the job, when there are very long lines
7805 and truncate-lines is nil. That's the reason for
7806 treating terminal frames specially here. */
7808 if (!FRAME_WINDOW_P (it
->f
))
7809 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7814 move_it_by_lines (it
, 1);
7816 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7823 /* Move IT by a specified amount of pixel lines DY. DY negative means
7824 move backwards. DY = 0 means move to start of screen line. At the
7825 end, IT will be on the start of a screen line. */
7828 move_it_vertically (struct it
*it
, int dy
)
7831 move_it_vertically_backward (it
, -dy
);
7834 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7835 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7836 MOVE_TO_POS
| MOVE_TO_Y
);
7837 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7839 /* If buffer ends in ZV without a newline, move to the start of
7840 the line to satisfy the post-condition. */
7841 if (IT_CHARPOS (*it
) == ZV
7843 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7844 move_it_by_lines (it
, 0);
7849 /* Move iterator IT past the end of the text line it is in. */
7852 move_it_past_eol (struct it
*it
)
7854 enum move_it_result rc
;
7856 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7857 if (rc
== MOVE_NEWLINE_OR_CR
)
7858 set_iterator_to_next (it
, 0);
7862 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7863 negative means move up. DVPOS == 0 means move to the start of the
7866 Optimization idea: If we would know that IT->f doesn't use
7867 a face with proportional font, we could be faster for
7868 truncate-lines nil. */
7871 move_it_by_lines (struct it
*it
, int dvpos
)
7874 /* The commented-out optimization uses vmotion on terminals. This
7875 gives bad results, because elements like it->what, on which
7876 callers such as pos_visible_p rely, aren't updated. */
7877 /* struct position pos;
7878 if (!FRAME_WINDOW_P (it->f))
7880 struct text_pos textpos;
7882 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7883 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7884 reseat (it, textpos, 1);
7885 it->vpos += pos.vpos;
7886 it->current_y += pos.vpos;
7892 /* DVPOS == 0 means move to the start of the screen line. */
7893 move_it_vertically_backward (it
, 0);
7894 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7895 /* Let next call to line_bottom_y calculate real line height */
7900 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7901 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7902 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7907 EMACS_INT start_charpos
, i
;
7909 /* Start at the beginning of the screen line containing IT's
7910 position. This may actually move vertically backwards,
7911 in case of overlays, so adjust dvpos accordingly. */
7913 move_it_vertically_backward (it
, 0);
7916 /* Go back -DVPOS visible lines and reseat the iterator there. */
7917 start_charpos
= IT_CHARPOS (*it
);
7918 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7919 back_to_previous_visible_line_start (it
);
7920 reseat (it
, it
->current
.pos
, 1);
7922 /* Move further back if we end up in a string or an image. */
7923 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7925 /* First try to move to start of display line. */
7927 move_it_vertically_backward (it
, 0);
7929 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7931 /* If start of line is still in string or image,
7932 move further back. */
7933 back_to_previous_visible_line_start (it
);
7934 reseat (it
, it
->current
.pos
, 1);
7938 it
->current_x
= it
->hpos
= 0;
7940 /* Above call may have moved too far if continuation lines
7941 are involved. Scan forward and see if it did. */
7943 it2
.vpos
= it2
.current_y
= 0;
7944 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7945 it
->vpos
-= it2
.vpos
;
7946 it
->current_y
-= it2
.current_y
;
7947 it
->current_x
= it
->hpos
= 0;
7949 /* If we moved too far back, move IT some lines forward. */
7950 if (it2
.vpos
> -dvpos
)
7952 int delta
= it2
.vpos
+ dvpos
;
7954 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7955 /* Move back again if we got too far ahead. */
7956 if (IT_CHARPOS (*it
) >= start_charpos
)
7962 /* Return 1 if IT points into the middle of a display vector. */
7965 in_display_vector_p (struct it
*it
)
7967 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7968 && it
->current
.dpvec_index
> 0
7969 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7973 /***********************************************************************
7975 ***********************************************************************/
7978 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7982 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7984 Lisp_Object args
[3];
7985 Lisp_Object msg
, fmt
;
7988 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7991 /* Do nothing if called asynchronously. Inserting text into
7992 a buffer may call after-change-functions and alike and
7993 that would means running Lisp asynchronously. */
7994 if (handling_signal
)
7998 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8000 args
[0] = fmt
= build_string (format
);
8003 msg
= Fformat (3, args
);
8005 len
= SBYTES (msg
) + 1;
8006 SAFE_ALLOCA (buffer
, char *, len
);
8007 memcpy (buffer
, SDATA (msg
), len
);
8009 message_dolog (buffer
, len
- 1, 1, 0);
8016 /* Output a newline in the *Messages* buffer if "needs" one. */
8019 message_log_maybe_newline (void)
8021 if (message_log_need_newline
)
8022 message_dolog ("", 0, 1, 0);
8026 /* Add a string M of length NBYTES to the message log, optionally
8027 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8028 nonzero, means interpret the contents of M as multibyte. This
8029 function calls low-level routines in order to bypass text property
8030 hooks, etc. which might not be safe to run.
8032 This may GC (insert may run before/after change hooks),
8033 so the buffer M must NOT point to a Lisp string. */
8036 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8038 const unsigned char *msg
= (const unsigned char *) m
;
8040 if (!NILP (Vmemory_full
))
8043 if (!NILP (Vmessage_log_max
))
8045 struct buffer
*oldbuf
;
8046 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8047 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8048 EMACS_INT point_at_end
= 0;
8049 EMACS_INT zv_at_end
= 0;
8050 Lisp_Object old_deactivate_mark
, tem
;
8051 struct gcpro gcpro1
;
8053 old_deactivate_mark
= Vdeactivate_mark
;
8054 oldbuf
= current_buffer
;
8055 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8056 BVAR (current_buffer
, undo_list
) = Qt
;
8058 oldpoint
= message_dolog_marker1
;
8059 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8060 oldbegv
= message_dolog_marker2
;
8061 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8062 oldzv
= message_dolog_marker3
;
8063 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8064 GCPRO1 (old_deactivate_mark
);
8072 BEGV_BYTE
= BEG_BYTE
;
8075 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8077 /* Insert the string--maybe converting multibyte to single byte
8078 or vice versa, so that all the text fits the buffer. */
8080 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8086 /* Convert a multibyte string to single-byte
8087 for the *Message* buffer. */
8088 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8090 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8091 work
[0] = (ASCII_CHAR_P (c
)
8093 : multibyte_char_to_unibyte (c
));
8094 insert_1_both (work
, 1, 1, 1, 0, 0);
8097 else if (! multibyte
8098 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8102 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8103 /* Convert a single-byte string to multibyte
8104 for the *Message* buffer. */
8105 for (i
= 0; i
< nbytes
; i
++)
8108 MAKE_CHAR_MULTIBYTE (c
);
8109 char_bytes
= CHAR_STRING (c
, str
);
8110 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8114 insert_1 (m
, nbytes
, 1, 0, 0);
8118 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8119 unsigned long int dups
;
8120 insert_1 ("\n", 1, 1, 0, 0);
8122 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8124 this_bol_byte
= PT_BYTE
;
8126 /* See if this line duplicates the previous one.
8127 If so, combine duplicates. */
8130 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8132 prev_bol_byte
= PT_BYTE
;
8134 dups
= message_log_check_duplicate (prev_bol_byte
,
8138 del_range_both (prev_bol
, prev_bol_byte
,
8139 this_bol
, this_bol_byte
, 0);
8145 /* If you change this format, don't forget to also
8146 change message_log_check_duplicate. */
8147 sprintf (dupstr
, " [%lu times]", dups
);
8148 duplen
= strlen (dupstr
);
8149 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8150 insert_1 (dupstr
, duplen
, 1, 0, 1);
8155 /* If we have more than the desired maximum number of lines
8156 in the *Messages* buffer now, delete the oldest ones.
8157 This is safe because we don't have undo in this buffer. */
8159 if (NATNUMP (Vmessage_log_max
))
8161 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8162 -XFASTINT (Vmessage_log_max
) - 1, 0);
8163 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8166 BEGV
= XMARKER (oldbegv
)->charpos
;
8167 BEGV_BYTE
= marker_byte_position (oldbegv
);
8176 ZV
= XMARKER (oldzv
)->charpos
;
8177 ZV_BYTE
= marker_byte_position (oldzv
);
8181 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8183 /* We can't do Fgoto_char (oldpoint) because it will run some
8185 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8186 XMARKER (oldpoint
)->bytepos
);
8189 unchain_marker (XMARKER (oldpoint
));
8190 unchain_marker (XMARKER (oldbegv
));
8191 unchain_marker (XMARKER (oldzv
));
8193 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8194 set_buffer_internal (oldbuf
);
8196 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8197 message_log_need_newline
= !nlflag
;
8198 Vdeactivate_mark
= old_deactivate_mark
;
8203 /* We are at the end of the buffer after just having inserted a newline.
8204 (Note: We depend on the fact we won't be crossing the gap.)
8205 Check to see if the most recent message looks a lot like the previous one.
8206 Return 0 if different, 1 if the new one should just replace it, or a
8207 value N > 1 if we should also append " [N times]". */
8209 static unsigned long int
8210 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8213 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8215 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8216 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8218 for (i
= 0; i
< len
; i
++)
8220 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8228 if (*p1
++ == ' ' && *p1
++ == '[')
8231 unsigned long int n
= strtoul ((char *) p1
, &pend
, 10);
8232 if (strncmp (pend
, " times]\n", 8) == 0)
8239 /* Display an echo area message M with a specified length of NBYTES
8240 bytes. The string may include null characters. If M is 0, clear
8241 out any existing message, and let the mini-buffer text show
8244 This may GC, so the buffer M must NOT point to a Lisp string. */
8247 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8249 /* First flush out any partial line written with print. */
8250 message_log_maybe_newline ();
8252 message_dolog (m
, nbytes
, 1, multibyte
);
8253 message2_nolog (m
, nbytes
, multibyte
);
8257 /* The non-logging counterpart of message2. */
8260 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8262 struct frame
*sf
= SELECTED_FRAME ();
8263 message_enable_multibyte
= multibyte
;
8265 if (FRAME_INITIAL_P (sf
))
8267 if (noninteractive_need_newline
)
8268 putc ('\n', stderr
);
8269 noninteractive_need_newline
= 0;
8271 fwrite (m
, nbytes
, 1, stderr
);
8272 if (cursor_in_echo_area
== 0)
8273 fprintf (stderr
, "\n");
8276 /* A null message buffer means that the frame hasn't really been
8277 initialized yet. Error messages get reported properly by
8278 cmd_error, so this must be just an informative message; toss it. */
8279 else if (INTERACTIVE
8280 && sf
->glyphs_initialized_p
8281 && FRAME_MESSAGE_BUF (sf
))
8283 Lisp_Object mini_window
;
8286 /* Get the frame containing the mini-buffer
8287 that the selected frame is using. */
8288 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8289 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8291 FRAME_SAMPLE_VISIBILITY (f
);
8292 if (FRAME_VISIBLE_P (sf
)
8293 && ! FRAME_VISIBLE_P (f
))
8294 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8298 set_message (m
, Qnil
, nbytes
, multibyte
);
8299 if (minibuffer_auto_raise
)
8300 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8303 clear_message (1, 1);
8305 do_pending_window_change (0);
8306 echo_area_display (1);
8307 do_pending_window_change (0);
8308 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8309 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8314 /* Display an echo area message M with a specified length of NBYTES
8315 bytes. The string may include null characters. If M is not a
8316 string, clear out any existing message, and let the mini-buffer
8319 This function cancels echoing. */
8322 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8324 struct gcpro gcpro1
;
8327 clear_message (1,1);
8330 /* First flush out any partial line written with print. */
8331 message_log_maybe_newline ();
8337 SAFE_ALLOCA (buffer
, char *, nbytes
);
8338 memcpy (buffer
, SDATA (m
), nbytes
);
8339 message_dolog (buffer
, nbytes
, 1, multibyte
);
8342 message3_nolog (m
, nbytes
, multibyte
);
8348 /* The non-logging version of message3.
8349 This does not cancel echoing, because it is used for echoing.
8350 Perhaps we need to make a separate function for echoing
8351 and make this cancel echoing. */
8354 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8356 struct frame
*sf
= SELECTED_FRAME ();
8357 message_enable_multibyte
= multibyte
;
8359 if (FRAME_INITIAL_P (sf
))
8361 if (noninteractive_need_newline
)
8362 putc ('\n', stderr
);
8363 noninteractive_need_newline
= 0;
8365 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8366 if (cursor_in_echo_area
== 0)
8367 fprintf (stderr
, "\n");
8370 /* A null message buffer means that the frame hasn't really been
8371 initialized yet. Error messages get reported properly by
8372 cmd_error, so this must be just an informative message; toss it. */
8373 else if (INTERACTIVE
8374 && sf
->glyphs_initialized_p
8375 && FRAME_MESSAGE_BUF (sf
))
8377 Lisp_Object mini_window
;
8381 /* Get the frame containing the mini-buffer
8382 that the selected frame is using. */
8383 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8384 frame
= XWINDOW (mini_window
)->frame
;
8387 FRAME_SAMPLE_VISIBILITY (f
);
8388 if (FRAME_VISIBLE_P (sf
)
8389 && !FRAME_VISIBLE_P (f
))
8390 Fmake_frame_visible (frame
);
8392 if (STRINGP (m
) && SCHARS (m
) > 0)
8394 set_message (NULL
, m
, nbytes
, multibyte
);
8395 if (minibuffer_auto_raise
)
8396 Fraise_frame (frame
);
8397 /* Assume we are not echoing.
8398 (If we are, echo_now will override this.) */
8399 echo_message_buffer
= Qnil
;
8402 clear_message (1, 1);
8404 do_pending_window_change (0);
8405 echo_area_display (1);
8406 do_pending_window_change (0);
8407 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8408 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8413 /* Display a null-terminated echo area message M. If M is 0, clear
8414 out any existing message, and let the mini-buffer text show through.
8416 The buffer M must continue to exist until after the echo area gets
8417 cleared or some other message gets displayed there. Do not pass
8418 text that is stored in a Lisp string. Do not pass text in a buffer
8419 that was alloca'd. */
8422 message1 (const char *m
)
8424 message2 (m
, (m
? strlen (m
) : 0), 0);
8428 /* The non-logging counterpart of message1. */
8431 message1_nolog (const char *m
)
8433 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8436 /* Display a message M which contains a single %s
8437 which gets replaced with STRING. */
8440 message_with_string (const char *m
, Lisp_Object string
, int log
)
8442 CHECK_STRING (string
);
8448 if (noninteractive_need_newline
)
8449 putc ('\n', stderr
);
8450 noninteractive_need_newline
= 0;
8451 fprintf (stderr
, m
, SDATA (string
));
8452 if (!cursor_in_echo_area
)
8453 fprintf (stderr
, "\n");
8457 else if (INTERACTIVE
)
8459 /* The frame whose minibuffer we're going to display the message on.
8460 It may be larger than the selected frame, so we need
8461 to use its buffer, not the selected frame's buffer. */
8462 Lisp_Object mini_window
;
8463 struct frame
*f
, *sf
= SELECTED_FRAME ();
8465 /* Get the frame containing the minibuffer
8466 that the selected frame is using. */
8467 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8468 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8470 /* A null message buffer means that the frame hasn't really been
8471 initialized yet. Error messages get reported properly by
8472 cmd_error, so this must be just an informative message; toss it. */
8473 if (FRAME_MESSAGE_BUF (f
))
8475 Lisp_Object args
[2], msg
;
8476 struct gcpro gcpro1
, gcpro2
;
8478 args
[0] = build_string (m
);
8479 args
[1] = msg
= string
;
8480 GCPRO2 (args
[0], msg
);
8483 msg
= Fformat (2, args
);
8486 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8488 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8492 /* Print should start at the beginning of the message
8493 buffer next time. */
8494 message_buf_print
= 0;
8500 /* Dump an informative message to the minibuf. If M is 0, clear out
8501 any existing message, and let the mini-buffer text show through. */
8504 vmessage (const char *m
, va_list ap
)
8510 if (noninteractive_need_newline
)
8511 putc ('\n', stderr
);
8512 noninteractive_need_newline
= 0;
8513 vfprintf (stderr
, m
, ap
);
8514 if (cursor_in_echo_area
== 0)
8515 fprintf (stderr
, "\n");
8519 else if (INTERACTIVE
)
8521 /* The frame whose mini-buffer we're going to display the message
8522 on. It may be larger than the selected frame, so we need to
8523 use its buffer, not the selected frame's buffer. */
8524 Lisp_Object mini_window
;
8525 struct frame
*f
, *sf
= SELECTED_FRAME ();
8527 /* Get the frame containing the mini-buffer
8528 that the selected frame is using. */
8529 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8530 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8532 /* A null message buffer means that the frame hasn't really been
8533 initialized yet. Error messages get reported properly by
8534 cmd_error, so this must be just an informative message; toss
8536 if (FRAME_MESSAGE_BUF (f
))
8542 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8543 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8545 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8550 /* Print should start at the beginning of the message
8551 buffer next time. */
8552 message_buf_print
= 0;
8558 message (const char *m
, ...)
8568 /* The non-logging version of message. */
8571 message_nolog (const char *m
, ...)
8573 Lisp_Object old_log_max
;
8576 old_log_max
= Vmessage_log_max
;
8577 Vmessage_log_max
= Qnil
;
8579 Vmessage_log_max
= old_log_max
;
8585 /* Display the current message in the current mini-buffer. This is
8586 only called from error handlers in process.c, and is not time
8590 update_echo_area (void)
8592 if (!NILP (echo_area_buffer
[0]))
8595 string
= Fcurrent_message ();
8596 message3 (string
, SBYTES (string
),
8597 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8602 /* Make sure echo area buffers in `echo_buffers' are live.
8603 If they aren't, make new ones. */
8606 ensure_echo_area_buffers (void)
8610 for (i
= 0; i
< 2; ++i
)
8611 if (!BUFFERP (echo_buffer
[i
])
8612 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
8615 Lisp_Object old_buffer
;
8618 old_buffer
= echo_buffer
[i
];
8619 sprintf (name
, " *Echo Area %d*", i
);
8620 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8621 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
8622 /* to force word wrap in echo area -
8623 it was decided to postpone this*/
8624 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8626 for (j
= 0; j
< 2; ++j
)
8627 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8628 echo_area_buffer
[j
] = echo_buffer
[i
];
8633 /* Call FN with args A1..A4 with either the current or last displayed
8634 echo_area_buffer as current buffer.
8636 WHICH zero means use the current message buffer
8637 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8638 from echo_buffer[] and clear it.
8640 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8641 suitable buffer from echo_buffer[] and clear it.
8643 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8644 that the current message becomes the last displayed one, make
8645 choose a suitable buffer for echo_area_buffer[0], and clear it.
8647 Value is what FN returns. */
8650 with_echo_area_buffer (struct window
*w
, int which
,
8651 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8652 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8655 int this_one
, the_other
, clear_buffer_p
, rc
;
8656 int count
= SPECPDL_INDEX ();
8658 /* If buffers aren't live, make new ones. */
8659 ensure_echo_area_buffers ();
8664 this_one
= 0, the_other
= 1;
8666 this_one
= 1, the_other
= 0;
8669 this_one
= 0, the_other
= 1;
8672 /* We need a fresh one in case the current echo buffer equals
8673 the one containing the last displayed echo area message. */
8674 if (!NILP (echo_area_buffer
[this_one
])
8675 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8676 echo_area_buffer
[this_one
] = Qnil
;
8679 /* Choose a suitable buffer from echo_buffer[] is we don't
8681 if (NILP (echo_area_buffer
[this_one
]))
8683 echo_area_buffer
[this_one
]
8684 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8685 ? echo_buffer
[the_other
]
8686 : echo_buffer
[this_one
]);
8690 buffer
= echo_area_buffer
[this_one
];
8692 /* Don't get confused by reusing the buffer used for echoing
8693 for a different purpose. */
8694 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8697 record_unwind_protect (unwind_with_echo_area_buffer
,
8698 with_echo_area_buffer_unwind_data (w
));
8700 /* Make the echo area buffer current. Note that for display
8701 purposes, it is not necessary that the displayed window's buffer
8702 == current_buffer, except for text property lookup. So, let's
8703 only set that buffer temporarily here without doing a full
8704 Fset_window_buffer. We must also change w->pointm, though,
8705 because otherwise an assertions in unshow_buffer fails, and Emacs
8707 set_buffer_internal_1 (XBUFFER (buffer
));
8711 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8714 BVAR (current_buffer
, undo_list
) = Qt
;
8715 BVAR (current_buffer
, read_only
) = Qnil
;
8716 specbind (Qinhibit_read_only
, Qt
);
8717 specbind (Qinhibit_modification_hooks
, Qt
);
8719 if (clear_buffer_p
&& Z
> BEG
)
8722 xassert (BEGV
>= BEG
);
8723 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8725 rc
= fn (a1
, a2
, a3
, a4
);
8727 xassert (BEGV
>= BEG
);
8728 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8730 unbind_to (count
, Qnil
);
8735 /* Save state that should be preserved around the call to the function
8736 FN called in with_echo_area_buffer. */
8739 with_echo_area_buffer_unwind_data (struct window
*w
)
8742 Lisp_Object vector
, tmp
;
8744 /* Reduce consing by keeping one vector in
8745 Vwith_echo_area_save_vector. */
8746 vector
= Vwith_echo_area_save_vector
;
8747 Vwith_echo_area_save_vector
= Qnil
;
8750 vector
= Fmake_vector (make_number (7), Qnil
);
8752 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8753 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8754 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8758 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8759 ASET (vector
, i
, w
->buffer
); ++i
;
8760 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8761 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8766 for (; i
< end
; ++i
)
8767 ASET (vector
, i
, Qnil
);
8770 xassert (i
== ASIZE (vector
));
8775 /* Restore global state from VECTOR which was created by
8776 with_echo_area_buffer_unwind_data. */
8779 unwind_with_echo_area_buffer (Lisp_Object vector
)
8781 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8782 Vdeactivate_mark
= AREF (vector
, 1);
8783 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8785 if (WINDOWP (AREF (vector
, 3)))
8788 Lisp_Object buffer
, charpos
, bytepos
;
8790 w
= XWINDOW (AREF (vector
, 3));
8791 buffer
= AREF (vector
, 4);
8792 charpos
= AREF (vector
, 5);
8793 bytepos
= AREF (vector
, 6);
8796 set_marker_both (w
->pointm
, buffer
,
8797 XFASTINT (charpos
), XFASTINT (bytepos
));
8800 Vwith_echo_area_save_vector
= vector
;
8805 /* Set up the echo area for use by print functions. MULTIBYTE_P
8806 non-zero means we will print multibyte. */
8809 setup_echo_area_for_printing (int multibyte_p
)
8811 /* If we can't find an echo area any more, exit. */
8812 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8815 ensure_echo_area_buffers ();
8817 if (!message_buf_print
)
8819 /* A message has been output since the last time we printed.
8820 Choose a fresh echo area buffer. */
8821 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8822 echo_area_buffer
[0] = echo_buffer
[1];
8824 echo_area_buffer
[0] = echo_buffer
[0];
8826 /* Switch to that buffer and clear it. */
8827 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8828 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8832 int count
= SPECPDL_INDEX ();
8833 specbind (Qinhibit_read_only
, Qt
);
8834 /* Note that undo recording is always disabled. */
8836 unbind_to (count
, Qnil
);
8838 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8840 /* Set up the buffer for the multibyteness we need. */
8842 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8843 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8845 /* Raise the frame containing the echo area. */
8846 if (minibuffer_auto_raise
)
8848 struct frame
*sf
= SELECTED_FRAME ();
8849 Lisp_Object mini_window
;
8850 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8851 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8854 message_log_maybe_newline ();
8855 message_buf_print
= 1;
8859 if (NILP (echo_area_buffer
[0]))
8861 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8862 echo_area_buffer
[0] = echo_buffer
[1];
8864 echo_area_buffer
[0] = echo_buffer
[0];
8867 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8869 /* Someone switched buffers between print requests. */
8870 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8871 BVAR (current_buffer
, truncate_lines
) = Qnil
;
8877 /* Display an echo area message in window W. Value is non-zero if W's
8878 height is changed. If display_last_displayed_message_p is
8879 non-zero, display the message that was last displayed, otherwise
8880 display the current message. */
8883 display_echo_area (struct window
*w
)
8885 int i
, no_message_p
, window_height_changed_p
, count
;
8887 /* Temporarily disable garbage collections while displaying the echo
8888 area. This is done because a GC can print a message itself.
8889 That message would modify the echo area buffer's contents while a
8890 redisplay of the buffer is going on, and seriously confuse
8892 count
= inhibit_garbage_collection ();
8894 /* If there is no message, we must call display_echo_area_1
8895 nevertheless because it resizes the window. But we will have to
8896 reset the echo_area_buffer in question to nil at the end because
8897 with_echo_area_buffer will sets it to an empty buffer. */
8898 i
= display_last_displayed_message_p
? 1 : 0;
8899 no_message_p
= NILP (echo_area_buffer
[i
]);
8901 window_height_changed_p
8902 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8903 display_echo_area_1
,
8904 (intptr_t) w
, Qnil
, 0, 0);
8907 echo_area_buffer
[i
] = Qnil
;
8909 unbind_to (count
, Qnil
);
8910 return window_height_changed_p
;
8914 /* Helper for display_echo_area. Display the current buffer which
8915 contains the current echo area message in window W, a mini-window,
8916 a pointer to which is passed in A1. A2..A4 are currently not used.
8917 Change the height of W so that all of the message is displayed.
8918 Value is non-zero if height of W was changed. */
8921 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8924 struct window
*w
= (struct window
*) i1
;
8926 struct text_pos start
;
8927 int window_height_changed_p
= 0;
8929 /* Do this before displaying, so that we have a large enough glyph
8930 matrix for the display. If we can't get enough space for the
8931 whole text, display the last N lines. That works by setting w->start. */
8932 window_height_changed_p
= resize_mini_window (w
, 0);
8934 /* Use the starting position chosen by resize_mini_window. */
8935 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8938 clear_glyph_matrix (w
->desired_matrix
);
8939 XSETWINDOW (window
, w
);
8940 try_window (window
, start
, 0);
8942 return window_height_changed_p
;
8946 /* Resize the echo area window to exactly the size needed for the
8947 currently displayed message, if there is one. If a mini-buffer
8948 is active, don't shrink it. */
8951 resize_echo_area_exactly (void)
8953 if (BUFFERP (echo_area_buffer
[0])
8954 && WINDOWP (echo_area_window
))
8956 struct window
*w
= XWINDOW (echo_area_window
);
8958 Lisp_Object resize_exactly
;
8960 if (minibuf_level
== 0)
8961 resize_exactly
= Qt
;
8963 resize_exactly
= Qnil
;
8965 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8966 (intptr_t) w
, resize_exactly
,
8970 ++windows_or_buffers_changed
;
8971 ++update_mode_lines
;
8972 redisplay_internal ();
8978 /* Callback function for with_echo_area_buffer, when used from
8979 resize_echo_area_exactly. A1 contains a pointer to the window to
8980 resize, EXACTLY non-nil means resize the mini-window exactly to the
8981 size of the text displayed. A3 and A4 are not used. Value is what
8982 resize_mini_window returns. */
8985 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8988 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
8992 /* Resize mini-window W to fit the size of its contents. EXACT_P
8993 means size the window exactly to the size needed. Otherwise, it's
8994 only enlarged until W's buffer is empty.
8996 Set W->start to the right place to begin display. If the whole
8997 contents fit, start at the beginning. Otherwise, start so as
8998 to make the end of the contents appear. This is particularly
8999 important for y-or-n-p, but seems desirable generally.
9001 Value is non-zero if the window height has been changed. */
9004 resize_mini_window (struct window
*w
, int exact_p
)
9006 struct frame
*f
= XFRAME (w
->frame
);
9007 int window_height_changed_p
= 0;
9009 xassert (MINI_WINDOW_P (w
));
9011 /* By default, start display at the beginning. */
9012 set_marker_both (w
->start
, w
->buffer
,
9013 BUF_BEGV (XBUFFER (w
->buffer
)),
9014 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9016 /* Don't resize windows while redisplaying a window; it would
9017 confuse redisplay functions when the size of the window they are
9018 displaying changes from under them. Such a resizing can happen,
9019 for instance, when which-func prints a long message while
9020 we are running fontification-functions. We're running these
9021 functions with safe_call which binds inhibit-redisplay to t. */
9022 if (!NILP (Vinhibit_redisplay
))
9025 /* Nil means don't try to resize. */
9026 if (NILP (Vresize_mini_windows
)
9027 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9030 if (!FRAME_MINIBUF_ONLY_P (f
))
9033 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9034 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9035 int height
, max_height
;
9036 int unit
= FRAME_LINE_HEIGHT (f
);
9037 struct text_pos start
;
9038 struct buffer
*old_current_buffer
= NULL
;
9040 if (current_buffer
!= XBUFFER (w
->buffer
))
9042 old_current_buffer
= current_buffer
;
9043 set_buffer_internal (XBUFFER (w
->buffer
));
9046 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9048 /* Compute the max. number of lines specified by the user. */
9049 if (FLOATP (Vmax_mini_window_height
))
9050 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9051 else if (INTEGERP (Vmax_mini_window_height
))
9052 max_height
= XINT (Vmax_mini_window_height
);
9054 max_height
= total_height
/ 4;
9056 /* Correct that max. height if it's bogus. */
9057 max_height
= max (1, max_height
);
9058 max_height
= min (total_height
, max_height
);
9060 /* Find out the height of the text in the window. */
9061 if (it
.line_wrap
== TRUNCATE
)
9066 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9067 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9068 height
= it
.current_y
+ last_height
;
9070 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9071 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9072 height
= (height
+ unit
- 1) / unit
;
9075 /* Compute a suitable window start. */
9076 if (height
> max_height
)
9078 height
= max_height
;
9079 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9080 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9081 start
= it
.current
.pos
;
9084 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9085 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9087 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9089 /* Let it grow only, until we display an empty message, in which
9090 case the window shrinks again. */
9091 if (height
> WINDOW_TOTAL_LINES (w
))
9093 int old_height
= WINDOW_TOTAL_LINES (w
);
9094 freeze_window_starts (f
, 1);
9095 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9096 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9098 else if (height
< WINDOW_TOTAL_LINES (w
)
9099 && (exact_p
|| BEGV
== ZV
))
9101 int old_height
= WINDOW_TOTAL_LINES (w
);
9102 freeze_window_starts (f
, 0);
9103 shrink_mini_window (w
);
9104 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9109 /* Always resize to exact size needed. */
9110 if (height
> WINDOW_TOTAL_LINES (w
))
9112 int old_height
= WINDOW_TOTAL_LINES (w
);
9113 freeze_window_starts (f
, 1);
9114 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9115 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9117 else if (height
< WINDOW_TOTAL_LINES (w
))
9119 int old_height
= WINDOW_TOTAL_LINES (w
);
9120 freeze_window_starts (f
, 0);
9121 shrink_mini_window (w
);
9125 freeze_window_starts (f
, 1);
9126 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9129 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9133 if (old_current_buffer
)
9134 set_buffer_internal (old_current_buffer
);
9137 return window_height_changed_p
;
9141 /* Value is the current message, a string, or nil if there is no
9145 current_message (void)
9149 if (!BUFFERP (echo_area_buffer
[0]))
9153 with_echo_area_buffer (0, 0, current_message_1
,
9154 (intptr_t) &msg
, Qnil
, 0, 0);
9156 echo_area_buffer
[0] = Qnil
;
9164 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9167 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9170 *msg
= make_buffer_string (BEG
, Z
, 1);
9177 /* Push the current message on Vmessage_stack for later restauration
9178 by restore_message. Value is non-zero if the current message isn't
9179 empty. This is a relatively infrequent operation, so it's not
9180 worth optimizing. */
9186 msg
= current_message ();
9187 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9188 return STRINGP (msg
);
9192 /* Restore message display from the top of Vmessage_stack. */
9195 restore_message (void)
9199 xassert (CONSP (Vmessage_stack
));
9200 msg
= XCAR (Vmessage_stack
);
9202 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9204 message3_nolog (msg
, 0, 0);
9208 /* Handler for record_unwind_protect calling pop_message. */
9211 pop_message_unwind (Lisp_Object dummy
)
9217 /* Pop the top-most entry off Vmessage_stack. */
9222 xassert (CONSP (Vmessage_stack
));
9223 Vmessage_stack
= XCDR (Vmessage_stack
);
9227 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9228 exits. If the stack is not empty, we have a missing pop_message
9232 check_message_stack (void)
9234 if (!NILP (Vmessage_stack
))
9239 /* Truncate to NCHARS what will be displayed in the echo area the next
9240 time we display it---but don't redisplay it now. */
9243 truncate_echo_area (EMACS_INT nchars
)
9246 echo_area_buffer
[0] = Qnil
;
9247 /* A null message buffer means that the frame hasn't really been
9248 initialized yet. Error messages get reported properly by
9249 cmd_error, so this must be just an informative message; toss it. */
9250 else if (!noninteractive
9252 && !NILP (echo_area_buffer
[0]))
9254 struct frame
*sf
= SELECTED_FRAME ();
9255 if (FRAME_MESSAGE_BUF (sf
))
9256 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9261 /* Helper function for truncate_echo_area. Truncate the current
9262 message to at most NCHARS characters. */
9265 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9267 if (BEG
+ nchars
< Z
)
9268 del_range (BEG
+ nchars
, Z
);
9270 echo_area_buffer
[0] = Qnil
;
9275 /* Set the current message to a substring of S or STRING.
9277 If STRING is a Lisp string, set the message to the first NBYTES
9278 bytes from STRING. NBYTES zero means use the whole string. If
9279 STRING is multibyte, the message will be displayed multibyte.
9281 If S is not null, set the message to the first LEN bytes of S. LEN
9282 zero means use the whole string. MULTIBYTE_P non-zero means S is
9283 multibyte. Display the message multibyte in that case.
9285 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9286 to t before calling set_message_1 (which calls insert).
9290 set_message (const char *s
, Lisp_Object string
,
9291 EMACS_INT nbytes
, int multibyte_p
)
9293 message_enable_multibyte
9294 = ((s
&& multibyte_p
)
9295 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9297 with_echo_area_buffer (0, -1, set_message_1
,
9298 (intptr_t) s
, string
, nbytes
, multibyte_p
);
9299 message_buf_print
= 0;
9300 help_echo_showing_p
= 0;
9304 /* Helper function for set_message. Arguments have the same meaning
9305 as there, with A1 corresponding to S and A2 corresponding to STRING
9306 This function is called with the echo area buffer being
9310 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9313 const char *s
= (const char *) i1
;
9314 const unsigned char *msg
= (const unsigned char *) s
;
9315 Lisp_Object string
= a2
;
9317 /* Change multibyteness of the echo buffer appropriately. */
9318 if (message_enable_multibyte
9319 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9320 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9322 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
9323 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
9324 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
9326 /* Insert new message at BEG. */
9327 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9329 if (STRINGP (string
))
9334 nbytes
= SBYTES (string
);
9335 nchars
= string_byte_to_char (string
, nbytes
);
9337 /* This function takes care of single/multibyte conversion. We
9338 just have to ensure that the echo area buffer has the right
9339 setting of enable_multibyte_characters. */
9340 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9345 nbytes
= strlen (s
);
9347 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9349 /* Convert from multi-byte to single-byte. */
9354 /* Convert a multibyte string to single-byte. */
9355 for (i
= 0; i
< nbytes
; i
+= n
)
9357 c
= string_char_and_length (msg
+ i
, &n
);
9358 work
[0] = (ASCII_CHAR_P (c
)
9360 : multibyte_char_to_unibyte (c
));
9361 insert_1_both (work
, 1, 1, 1, 0, 0);
9364 else if (!multibyte_p
9365 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9367 /* Convert from single-byte to multi-byte. */
9370 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9372 /* Convert a single-byte string to multibyte. */
9373 for (i
= 0; i
< nbytes
; i
++)
9376 MAKE_CHAR_MULTIBYTE (c
);
9377 n
= CHAR_STRING (c
, str
);
9378 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
9382 insert_1 (s
, nbytes
, 1, 0, 0);
9389 /* Clear messages. CURRENT_P non-zero means clear the current
9390 message. LAST_DISPLAYED_P non-zero means clear the message
9394 clear_message (int current_p
, int last_displayed_p
)
9398 echo_area_buffer
[0] = Qnil
;
9399 message_cleared_p
= 1;
9402 if (last_displayed_p
)
9403 echo_area_buffer
[1] = Qnil
;
9405 message_buf_print
= 0;
9408 /* Clear garbaged frames.
9410 This function is used where the old redisplay called
9411 redraw_garbaged_frames which in turn called redraw_frame which in
9412 turn called clear_frame. The call to clear_frame was a source of
9413 flickering. I believe a clear_frame is not necessary. It should
9414 suffice in the new redisplay to invalidate all current matrices,
9415 and ensure a complete redisplay of all windows. */
9418 clear_garbaged_frames (void)
9422 Lisp_Object tail
, frame
;
9423 int changed_count
= 0;
9425 FOR_EACH_FRAME (tail
, frame
)
9427 struct frame
*f
= XFRAME (frame
);
9429 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9433 Fredraw_frame (frame
);
9434 f
->force_flush_display_p
= 1;
9436 clear_current_matrices (f
);
9445 ++windows_or_buffers_changed
;
9450 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9451 is non-zero update selected_frame. Value is non-zero if the
9452 mini-windows height has been changed. */
9455 echo_area_display (int update_frame_p
)
9457 Lisp_Object mini_window
;
9460 int window_height_changed_p
= 0;
9461 struct frame
*sf
= SELECTED_FRAME ();
9463 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9464 w
= XWINDOW (mini_window
);
9465 f
= XFRAME (WINDOW_FRAME (w
));
9467 /* Don't display if frame is invisible or not yet initialized. */
9468 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9471 #ifdef HAVE_WINDOW_SYSTEM
9472 /* When Emacs starts, selected_frame may be the initial terminal
9473 frame. If we let this through, a message would be displayed on
9475 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9477 #endif /* HAVE_WINDOW_SYSTEM */
9479 /* Redraw garbaged frames. */
9481 clear_garbaged_frames ();
9483 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9485 echo_area_window
= mini_window
;
9486 window_height_changed_p
= display_echo_area (w
);
9487 w
->must_be_updated_p
= 1;
9489 /* Update the display, unless called from redisplay_internal.
9490 Also don't update the screen during redisplay itself. The
9491 update will happen at the end of redisplay, and an update
9492 here could cause confusion. */
9493 if (update_frame_p
&& !redisplaying_p
)
9497 /* If the display update has been interrupted by pending
9498 input, update mode lines in the frame. Due to the
9499 pending input, it might have been that redisplay hasn't
9500 been called, so that mode lines above the echo area are
9501 garbaged. This looks odd, so we prevent it here. */
9502 if (!display_completed
)
9503 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9505 if (window_height_changed_p
9506 /* Don't do this if Emacs is shutting down. Redisplay
9507 needs to run hooks. */
9508 && !NILP (Vrun_hooks
))
9510 /* Must update other windows. Likewise as in other
9511 cases, don't let this update be interrupted by
9513 int count
= SPECPDL_INDEX ();
9514 specbind (Qredisplay_dont_pause
, Qt
);
9515 windows_or_buffers_changed
= 1;
9516 redisplay_internal ();
9517 unbind_to (count
, Qnil
);
9519 else if (FRAME_WINDOW_P (f
) && n
== 0)
9521 /* Window configuration is the same as before.
9522 Can do with a display update of the echo area,
9523 unless we displayed some mode lines. */
9524 update_single_window (w
, 1);
9525 FRAME_RIF (f
)->flush_display (f
);
9528 update_frame (f
, 1, 1);
9530 /* If cursor is in the echo area, make sure that the next
9531 redisplay displays the minibuffer, so that the cursor will
9532 be replaced with what the minibuffer wants. */
9533 if (cursor_in_echo_area
)
9534 ++windows_or_buffers_changed
;
9537 else if (!EQ (mini_window
, selected_window
))
9538 windows_or_buffers_changed
++;
9540 /* Last displayed message is now the current message. */
9541 echo_area_buffer
[1] = echo_area_buffer
[0];
9542 /* Inform read_char that we're not echoing. */
9543 echo_message_buffer
= Qnil
;
9545 /* Prevent redisplay optimization in redisplay_internal by resetting
9546 this_line_start_pos. This is done because the mini-buffer now
9547 displays the message instead of its buffer text. */
9548 if (EQ (mini_window
, selected_window
))
9549 CHARPOS (this_line_start_pos
) = 0;
9551 return window_height_changed_p
;
9556 /***********************************************************************
9557 Mode Lines and Frame Titles
9558 ***********************************************************************/
9560 /* A buffer for constructing non-propertized mode-line strings and
9561 frame titles in it; allocated from the heap in init_xdisp and
9562 resized as needed in store_mode_line_noprop_char. */
9564 static char *mode_line_noprop_buf
;
9566 /* The buffer's end, and a current output position in it. */
9568 static char *mode_line_noprop_buf_end
;
9569 static char *mode_line_noprop_ptr
;
9571 #define MODE_LINE_NOPROP_LEN(start) \
9572 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9575 MODE_LINE_DISPLAY
= 0,
9581 /* Alist that caches the results of :propertize.
9582 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9583 static Lisp_Object mode_line_proptrans_alist
;
9585 /* List of strings making up the mode-line. */
9586 static Lisp_Object mode_line_string_list
;
9588 /* Base face property when building propertized mode line string. */
9589 static Lisp_Object mode_line_string_face
;
9590 static Lisp_Object mode_line_string_face_prop
;
9593 /* Unwind data for mode line strings */
9595 static Lisp_Object Vmode_line_unwind_vector
;
9598 format_mode_line_unwind_data (struct buffer
*obuf
,
9602 Lisp_Object vector
, tmp
;
9604 /* Reduce consing by keeping one vector in
9605 Vwith_echo_area_save_vector. */
9606 vector
= Vmode_line_unwind_vector
;
9607 Vmode_line_unwind_vector
= Qnil
;
9610 vector
= Fmake_vector (make_number (8), Qnil
);
9612 ASET (vector
, 0, make_number (mode_line_target
));
9613 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9614 ASET (vector
, 2, mode_line_string_list
);
9615 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9616 ASET (vector
, 4, mode_line_string_face
);
9617 ASET (vector
, 5, mode_line_string_face_prop
);
9620 XSETBUFFER (tmp
, obuf
);
9623 ASET (vector
, 6, tmp
);
9624 ASET (vector
, 7, owin
);
9630 unwind_format_mode_line (Lisp_Object vector
)
9632 mode_line_target
= XINT (AREF (vector
, 0));
9633 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9634 mode_line_string_list
= AREF (vector
, 2);
9635 if (! EQ (AREF (vector
, 3), Qt
))
9636 mode_line_proptrans_alist
= AREF (vector
, 3);
9637 mode_line_string_face
= AREF (vector
, 4);
9638 mode_line_string_face_prop
= AREF (vector
, 5);
9640 if (!NILP (AREF (vector
, 7)))
9641 /* Select window before buffer, since it may change the buffer. */
9642 Fselect_window (AREF (vector
, 7), Qt
);
9644 if (!NILP (AREF (vector
, 6)))
9646 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9647 ASET (vector
, 6, Qnil
);
9650 Vmode_line_unwind_vector
= vector
;
9655 /* Store a single character C for the frame title in mode_line_noprop_buf.
9656 Re-allocate mode_line_noprop_buf if necessary. */
9659 store_mode_line_noprop_char (char c
)
9661 /* If output position has reached the end of the allocated buffer,
9662 double the buffer's size. */
9663 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9665 int len
= MODE_LINE_NOPROP_LEN (0);
9666 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9667 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9668 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9669 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9672 *mode_line_noprop_ptr
++ = c
;
9676 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9677 mode_line_noprop_ptr. STRING is the string to store. Do not copy
9678 characters that yield more columns than PRECISION; PRECISION <= 0
9679 means copy the whole string. Pad with spaces until FIELD_WIDTH
9680 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9681 pad. Called from display_mode_element when it is used to build a
9685 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
9687 const unsigned char *str
= (const unsigned char *) string
;
9689 EMACS_INT dummy
, nbytes
;
9691 /* Copy at most PRECISION chars from STR. */
9692 nbytes
= strlen (string
);
9693 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9695 store_mode_line_noprop_char (*str
++);
9697 /* Fill up with spaces until FIELD_WIDTH reached. */
9698 while (field_width
> 0
9701 store_mode_line_noprop_char (' ');
9708 /***********************************************************************
9710 ***********************************************************************/
9712 #ifdef HAVE_WINDOW_SYSTEM
9714 /* Set the title of FRAME, if it has changed. The title format is
9715 Vicon_title_format if FRAME is iconified, otherwise it is
9716 frame_title_format. */
9719 x_consider_frame_title (Lisp_Object frame
)
9721 struct frame
*f
= XFRAME (frame
);
9723 if (FRAME_WINDOW_P (f
)
9724 || FRAME_MINIBUF_ONLY_P (f
)
9725 || f
->explicit_name
)
9727 /* Do we have more than one visible frame on this X display? */
9734 int count
= SPECPDL_INDEX ();
9736 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9738 Lisp_Object other_frame
= XCAR (tail
);
9739 struct frame
*tf
= XFRAME (other_frame
);
9742 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9743 && !FRAME_MINIBUF_ONLY_P (tf
)
9744 && !EQ (other_frame
, tip_frame
)
9745 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9749 /* Set global variable indicating that multiple frames exist. */
9750 multiple_frames
= CONSP (tail
);
9752 /* Switch to the buffer of selected window of the frame. Set up
9753 mode_line_target so that display_mode_element will output into
9754 mode_line_noprop_buf; then display the title. */
9755 record_unwind_protect (unwind_format_mode_line
,
9756 format_mode_line_unwind_data
9757 (current_buffer
, selected_window
, 0));
9759 Fselect_window (f
->selected_window
, Qt
);
9760 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9761 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9763 mode_line_target
= MODE_LINE_TITLE
;
9764 title_start
= MODE_LINE_NOPROP_LEN (0);
9765 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9766 NULL
, DEFAULT_FACE_ID
);
9767 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9768 len
= MODE_LINE_NOPROP_LEN (title_start
);
9769 title
= mode_line_noprop_buf
+ title_start
;
9770 unbind_to (count
, Qnil
);
9772 /* Set the title only if it's changed. This avoids consing in
9773 the common case where it hasn't. (If it turns out that we've
9774 already wasted too much time by walking through the list with
9775 display_mode_element, then we might need to optimize at a
9776 higher level than this.) */
9777 if (! STRINGP (f
->name
)
9778 || SBYTES (f
->name
) != len
9779 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9780 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9784 #endif /* not HAVE_WINDOW_SYSTEM */
9789 /***********************************************************************
9791 ***********************************************************************/
9794 /* Prepare for redisplay by updating menu-bar item lists when
9795 appropriate. This can call eval. */
9798 prepare_menu_bars (void)
9801 struct gcpro gcpro1
, gcpro2
;
9803 Lisp_Object tooltip_frame
;
9805 #ifdef HAVE_WINDOW_SYSTEM
9806 tooltip_frame
= tip_frame
;
9808 tooltip_frame
= Qnil
;
9811 /* Update all frame titles based on their buffer names, etc. We do
9812 this before the menu bars so that the buffer-menu will show the
9813 up-to-date frame titles. */
9814 #ifdef HAVE_WINDOW_SYSTEM
9815 if (windows_or_buffers_changed
|| update_mode_lines
)
9817 Lisp_Object tail
, frame
;
9819 FOR_EACH_FRAME (tail
, frame
)
9822 if (!EQ (frame
, tooltip_frame
)
9823 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9824 x_consider_frame_title (frame
);
9827 #endif /* HAVE_WINDOW_SYSTEM */
9829 /* Update the menu bar item lists, if appropriate. This has to be
9830 done before any actual redisplay or generation of display lines. */
9831 all_windows
= (update_mode_lines
9832 || buffer_shared
> 1
9833 || windows_or_buffers_changed
);
9836 Lisp_Object tail
, frame
;
9837 int count
= SPECPDL_INDEX ();
9838 /* 1 means that update_menu_bar has run its hooks
9839 so any further calls to update_menu_bar shouldn't do so again. */
9840 int menu_bar_hooks_run
= 0;
9842 record_unwind_save_match_data ();
9844 FOR_EACH_FRAME (tail
, frame
)
9848 /* Ignore tooltip frame. */
9849 if (EQ (frame
, tooltip_frame
))
9852 /* If a window on this frame changed size, report that to
9853 the user and clear the size-change flag. */
9854 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9856 Lisp_Object functions
;
9858 /* Clear flag first in case we get an error below. */
9859 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9860 functions
= Vwindow_size_change_functions
;
9861 GCPRO2 (tail
, functions
);
9863 while (CONSP (functions
))
9865 if (!EQ (XCAR (functions
), Qt
))
9866 call1 (XCAR (functions
), frame
);
9867 functions
= XCDR (functions
);
9873 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9874 #ifdef HAVE_WINDOW_SYSTEM
9875 update_tool_bar (f
, 0);
9878 if (windows_or_buffers_changed
9880 ns_set_doc_edited (f
, Fbuffer_modified_p
9881 (XWINDOW (f
->selected_window
)->buffer
));
9886 unbind_to (count
, Qnil
);
9890 struct frame
*sf
= SELECTED_FRAME ();
9891 update_menu_bar (sf
, 1, 0);
9892 #ifdef HAVE_WINDOW_SYSTEM
9893 update_tool_bar (sf
, 1);
9899 /* Update the menu bar item list for frame F. This has to be done
9900 before we start to fill in any display lines, because it can call
9903 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9905 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9906 already ran the menu bar hooks for this redisplay, so there
9907 is no need to run them again. The return value is the
9908 updated value of this flag, to pass to the next call. */
9911 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9914 register struct window
*w
;
9916 /* If called recursively during a menu update, do nothing. This can
9917 happen when, for instance, an activate-menubar-hook causes a
9919 if (inhibit_menubar_update
)
9922 window
= FRAME_SELECTED_WINDOW (f
);
9923 w
= XWINDOW (window
);
9925 if (FRAME_WINDOW_P (f
)
9927 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9928 || defined (HAVE_NS) || defined (USE_GTK)
9929 FRAME_EXTERNAL_MENU_BAR (f
)
9931 FRAME_MENU_BAR_LINES (f
) > 0
9933 : FRAME_MENU_BAR_LINES (f
) > 0)
9935 /* If the user has switched buffers or windows, we need to
9936 recompute to reflect the new bindings. But we'll
9937 recompute when update_mode_lines is set too; that means
9938 that people can use force-mode-line-update to request
9939 that the menu bar be recomputed. The adverse effect on
9940 the rest of the redisplay algorithm is about the same as
9941 windows_or_buffers_changed anyway. */
9942 if (windows_or_buffers_changed
9943 /* This used to test w->update_mode_line, but we believe
9944 there is no need to recompute the menu in that case. */
9945 || update_mode_lines
9946 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9947 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9948 != !NILP (w
->last_had_star
))
9949 || ((!NILP (Vtransient_mark_mode
)
9950 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
9951 != !NILP (w
->region_showing
)))
9953 struct buffer
*prev
= current_buffer
;
9954 int count
= SPECPDL_INDEX ();
9956 specbind (Qinhibit_menubar_update
, Qt
);
9958 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9959 if (save_match_data
)
9960 record_unwind_save_match_data ();
9961 if (NILP (Voverriding_local_map_menu_flag
))
9963 specbind (Qoverriding_terminal_local_map
, Qnil
);
9964 specbind (Qoverriding_local_map
, Qnil
);
9969 /* Run the Lucid hook. */
9970 safe_run_hooks (Qactivate_menubar_hook
);
9972 /* If it has changed current-menubar from previous value,
9973 really recompute the menu-bar from the value. */
9974 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9975 call0 (Qrecompute_lucid_menubar
);
9977 safe_run_hooks (Qmenu_bar_update_hook
);
9982 XSETFRAME (Vmenu_updating_frame
, f
);
9983 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9985 /* Redisplay the menu bar in case we changed it. */
9986 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9987 || defined (HAVE_NS) || defined (USE_GTK)
9988 if (FRAME_WINDOW_P (f
))
9990 #if defined (HAVE_NS)
9991 /* All frames on Mac OS share the same menubar. So only
9992 the selected frame should be allowed to set it. */
9993 if (f
== SELECTED_FRAME ())
9995 set_frame_menubar (f
, 0, 0);
9998 /* On a terminal screen, the menu bar is an ordinary screen
9999 line, and this makes it get updated. */
10000 w
->update_mode_line
= Qt
;
10001 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10002 /* In the non-toolkit version, the menu bar is an ordinary screen
10003 line, and this makes it get updated. */
10004 w
->update_mode_line
= Qt
;
10005 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10007 unbind_to (count
, Qnil
);
10008 set_buffer_internal_1 (prev
);
10017 /***********************************************************************
10019 ***********************************************************************/
10021 #ifdef HAVE_WINDOW_SYSTEM
10024 Nominal cursor position -- where to draw output.
10025 HPOS and VPOS are window relative glyph matrix coordinates.
10026 X and Y are window relative pixel coordinates. */
10028 struct cursor_pos output_cursor
;
10032 Set the global variable output_cursor to CURSOR. All cursor
10033 positions are relative to updated_window. */
10036 set_output_cursor (struct cursor_pos
*cursor
)
10038 output_cursor
.hpos
= cursor
->hpos
;
10039 output_cursor
.vpos
= cursor
->vpos
;
10040 output_cursor
.x
= cursor
->x
;
10041 output_cursor
.y
= cursor
->y
;
10046 Set a nominal cursor position.
10048 HPOS and VPOS are column/row positions in a window glyph matrix. X
10049 and Y are window text area relative pixel positions.
10051 If this is done during an update, updated_window will contain the
10052 window that is being updated and the position is the future output
10053 cursor position for that window. If updated_window is null, use
10054 selected_window and display the cursor at the given position. */
10057 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10061 /* If updated_window is not set, work on selected_window. */
10062 if (updated_window
)
10063 w
= updated_window
;
10065 w
= XWINDOW (selected_window
);
10067 /* Set the output cursor. */
10068 output_cursor
.hpos
= hpos
;
10069 output_cursor
.vpos
= vpos
;
10070 output_cursor
.x
= x
;
10071 output_cursor
.y
= y
;
10073 /* If not called as part of an update, really display the cursor.
10074 This will also set the cursor position of W. */
10075 if (updated_window
== NULL
)
10078 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10079 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10080 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10085 #endif /* HAVE_WINDOW_SYSTEM */
10088 /***********************************************************************
10090 ***********************************************************************/
10092 #ifdef HAVE_WINDOW_SYSTEM
10094 /* Where the mouse was last time we reported a mouse event. */
10096 FRAME_PTR last_mouse_frame
;
10098 /* Tool-bar item index of the item on which a mouse button was pressed
10101 int last_tool_bar_item
;
10105 update_tool_bar_unwind (Lisp_Object frame
)
10107 selected_frame
= frame
;
10111 /* Update the tool-bar item list for frame F. This has to be done
10112 before we start to fill in any display lines. Called from
10113 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10114 and restore it here. */
10117 update_tool_bar (struct frame
*f
, int save_match_data
)
10119 #if defined (USE_GTK) || defined (HAVE_NS)
10120 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10122 int do_update
= WINDOWP (f
->tool_bar_window
)
10123 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10128 Lisp_Object window
;
10131 window
= FRAME_SELECTED_WINDOW (f
);
10132 w
= XWINDOW (window
);
10134 /* If the user has switched buffers or windows, we need to
10135 recompute to reflect the new bindings. But we'll
10136 recompute when update_mode_lines is set too; that means
10137 that people can use force-mode-line-update to request
10138 that the menu bar be recomputed. The adverse effect on
10139 the rest of the redisplay algorithm is about the same as
10140 windows_or_buffers_changed anyway. */
10141 if (windows_or_buffers_changed
10142 || !NILP (w
->update_mode_line
)
10143 || update_mode_lines
10144 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10145 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10146 != !NILP (w
->last_had_star
))
10147 || ((!NILP (Vtransient_mark_mode
)
10148 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10149 != !NILP (w
->region_showing
)))
10151 struct buffer
*prev
= current_buffer
;
10152 int count
= SPECPDL_INDEX ();
10153 Lisp_Object frame
, new_tool_bar
;
10154 int new_n_tool_bar
;
10155 struct gcpro gcpro1
;
10157 /* Set current_buffer to the buffer of the selected
10158 window of the frame, so that we get the right local
10160 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10162 /* Save match data, if we must. */
10163 if (save_match_data
)
10164 record_unwind_save_match_data ();
10166 /* Make sure that we don't accidentally use bogus keymaps. */
10167 if (NILP (Voverriding_local_map_menu_flag
))
10169 specbind (Qoverriding_terminal_local_map
, Qnil
);
10170 specbind (Qoverriding_local_map
, Qnil
);
10173 GCPRO1 (new_tool_bar
);
10175 /* We must temporarily set the selected frame to this frame
10176 before calling tool_bar_items, because the calculation of
10177 the tool-bar keymap uses the selected frame (see
10178 `tool-bar-make-keymap' in tool-bar.el). */
10179 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10180 XSETFRAME (frame
, f
);
10181 selected_frame
= frame
;
10183 /* Build desired tool-bar items from keymaps. */
10184 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10187 /* Redisplay the tool-bar if we changed it. */
10188 if (new_n_tool_bar
!= f
->n_tool_bar_items
10189 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10191 /* Redisplay that happens asynchronously due to an expose event
10192 may access f->tool_bar_items. Make sure we update both
10193 variables within BLOCK_INPUT so no such event interrupts. */
10195 f
->tool_bar_items
= new_tool_bar
;
10196 f
->n_tool_bar_items
= new_n_tool_bar
;
10197 w
->update_mode_line
= Qt
;
10203 unbind_to (count
, Qnil
);
10204 set_buffer_internal_1 (prev
);
10210 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10211 F's desired tool-bar contents. F->tool_bar_items must have
10212 been set up previously by calling prepare_menu_bars. */
10215 build_desired_tool_bar_string (struct frame
*f
)
10217 int i
, size
, size_needed
;
10218 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10219 Lisp_Object image
, plist
, props
;
10221 image
= plist
= props
= Qnil
;
10222 GCPRO3 (image
, plist
, props
);
10224 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10225 Otherwise, make a new string. */
10227 /* The size of the string we might be able to reuse. */
10228 size
= (STRINGP (f
->desired_tool_bar_string
)
10229 ? SCHARS (f
->desired_tool_bar_string
)
10232 /* We need one space in the string for each image. */
10233 size_needed
= f
->n_tool_bar_items
;
10235 /* Reuse f->desired_tool_bar_string, if possible. */
10236 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10237 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10238 make_number (' '));
10241 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10242 Fremove_text_properties (make_number (0), make_number (size
),
10243 props
, f
->desired_tool_bar_string
);
10246 /* Put a `display' property on the string for the images to display,
10247 put a `menu_item' property on tool-bar items with a value that
10248 is the index of the item in F's tool-bar item vector. */
10249 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10251 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10253 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10254 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10255 int hmargin
, vmargin
, relief
, idx
, end
;
10257 /* If image is a vector, choose the image according to the
10259 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10260 if (VECTORP (image
))
10264 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10265 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10268 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10269 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10271 xassert (ASIZE (image
) >= idx
);
10272 image
= AREF (image
, idx
);
10277 /* Ignore invalid image specifications. */
10278 if (!valid_image_p (image
))
10281 /* Display the tool-bar button pressed, or depressed. */
10282 plist
= Fcopy_sequence (XCDR (image
));
10284 /* Compute margin and relief to draw. */
10285 relief
= (tool_bar_button_relief
>= 0
10286 ? tool_bar_button_relief
10287 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10288 hmargin
= vmargin
= relief
;
10290 if (INTEGERP (Vtool_bar_button_margin
)
10291 && XINT (Vtool_bar_button_margin
) > 0)
10293 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10294 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10296 else if (CONSP (Vtool_bar_button_margin
))
10298 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10299 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10300 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10302 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10303 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10304 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10307 if (auto_raise_tool_bar_buttons_p
)
10309 /* Add a `:relief' property to the image spec if the item is
10313 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10320 /* If image is selected, display it pressed, i.e. with a
10321 negative relief. If it's not selected, display it with a
10323 plist
= Fplist_put (plist
, QCrelief
,
10325 ? make_number (-relief
)
10326 : make_number (relief
)));
10331 /* Put a margin around the image. */
10332 if (hmargin
|| vmargin
)
10334 if (hmargin
== vmargin
)
10335 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10337 plist
= Fplist_put (plist
, QCmargin
,
10338 Fcons (make_number (hmargin
),
10339 make_number (vmargin
)));
10342 /* If button is not enabled, and we don't have special images
10343 for the disabled state, make the image appear disabled by
10344 applying an appropriate algorithm to it. */
10345 if (!enabled_p
&& idx
< 0)
10346 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10348 /* Put a `display' text property on the string for the image to
10349 display. Put a `menu-item' property on the string that gives
10350 the start of this item's properties in the tool-bar items
10352 image
= Fcons (Qimage
, plist
);
10353 props
= list4 (Qdisplay
, image
,
10354 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10356 /* Let the last image hide all remaining spaces in the tool bar
10357 string. The string can be longer than needed when we reuse a
10358 previous string. */
10359 if (i
+ 1 == f
->n_tool_bar_items
)
10360 end
= SCHARS (f
->desired_tool_bar_string
);
10363 Fadd_text_properties (make_number (i
), make_number (end
),
10364 props
, f
->desired_tool_bar_string
);
10372 /* Display one line of the tool-bar of frame IT->f.
10374 HEIGHT specifies the desired height of the tool-bar line.
10375 If the actual height of the glyph row is less than HEIGHT, the
10376 row's height is increased to HEIGHT, and the icons are centered
10377 vertically in the new height.
10379 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10380 count a final empty row in case the tool-bar width exactly matches
10385 display_tool_bar_line (struct it
*it
, int height
)
10387 struct glyph_row
*row
= it
->glyph_row
;
10388 int max_x
= it
->last_visible_x
;
10389 struct glyph
*last
;
10391 prepare_desired_row (row
);
10392 row
->y
= it
->current_y
;
10394 /* Note that this isn't made use of if the face hasn't a box,
10395 so there's no need to check the face here. */
10396 it
->start_of_box_run_p
= 1;
10398 while (it
->current_x
< max_x
)
10400 int x
, n_glyphs_before
, i
, nglyphs
;
10401 struct it it_before
;
10403 /* Get the next display element. */
10404 if (!get_next_display_element (it
))
10406 /* Don't count empty row if we are counting needed tool-bar lines. */
10407 if (height
< 0 && !it
->hpos
)
10412 /* Produce glyphs. */
10413 n_glyphs_before
= row
->used
[TEXT_AREA
];
10416 PRODUCE_GLYPHS (it
);
10418 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10420 x
= it_before
.current_x
;
10421 while (i
< nglyphs
)
10423 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10425 if (x
+ glyph
->pixel_width
> max_x
)
10427 /* Glyph doesn't fit on line. Backtrack. */
10428 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10430 /* If this is the only glyph on this line, it will never fit on the
10431 tool-bar, so skip it. But ensure there is at least one glyph,
10432 so we don't accidentally disable the tool-bar. */
10433 if (n_glyphs_before
== 0
10434 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10440 x
+= glyph
->pixel_width
;
10444 /* Stop at line ends. */
10445 if (ITERATOR_AT_END_OF_LINE_P (it
))
10448 set_iterator_to_next (it
, 1);
10453 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10455 /* Use default face for the border below the tool bar.
10457 FIXME: When auto-resize-tool-bars is grow-only, there is
10458 no additional border below the possibly empty tool-bar lines.
10459 So to make the extra empty lines look "normal", we have to
10460 use the tool-bar face for the border too. */
10461 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10462 it
->face_id
= DEFAULT_FACE_ID
;
10464 extend_face_to_end_of_line (it
);
10465 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10466 last
->right_box_line_p
= 1;
10467 if (last
== row
->glyphs
[TEXT_AREA
])
10468 last
->left_box_line_p
= 1;
10470 /* Make line the desired height and center it vertically. */
10471 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10473 /* Don't add more than one line height. */
10474 height
%= FRAME_LINE_HEIGHT (it
->f
);
10475 it
->max_ascent
+= height
/ 2;
10476 it
->max_descent
+= (height
+ 1) / 2;
10479 compute_line_metrics (it
);
10481 /* If line is empty, make it occupy the rest of the tool-bar. */
10482 if (!row
->displays_text_p
)
10484 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10485 row
->visible_height
= row
->height
;
10486 row
->ascent
= row
->phys_ascent
= 0;
10487 row
->extra_line_spacing
= 0;
10490 row
->full_width_p
= 1;
10491 row
->continued_p
= 0;
10492 row
->truncated_on_left_p
= 0;
10493 row
->truncated_on_right_p
= 0;
10495 it
->current_x
= it
->hpos
= 0;
10496 it
->current_y
+= row
->height
;
10502 /* Max tool-bar height. */
10504 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10505 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10507 /* Value is the number of screen lines needed to make all tool-bar
10508 items of frame F visible. The number of actual rows needed is
10509 returned in *N_ROWS if non-NULL. */
10512 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10514 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10516 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10517 the desired matrix, so use (unused) mode-line row as temporary row to
10518 avoid destroying the first tool-bar row. */
10519 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10521 /* Initialize an iterator for iteration over
10522 F->desired_tool_bar_string in the tool-bar window of frame F. */
10523 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10524 it
.first_visible_x
= 0;
10525 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10526 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10528 while (!ITERATOR_AT_END_P (&it
))
10530 clear_glyph_row (temp_row
);
10531 it
.glyph_row
= temp_row
;
10532 display_tool_bar_line (&it
, -1);
10534 clear_glyph_row (temp_row
);
10536 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10538 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10540 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10544 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10546 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10547 (Lisp_Object frame
)
10554 frame
= selected_frame
;
10556 CHECK_FRAME (frame
);
10557 f
= XFRAME (frame
);
10559 if (WINDOWP (f
->tool_bar_window
)
10560 || (w
= XWINDOW (f
->tool_bar_window
),
10561 WINDOW_TOTAL_LINES (w
) > 0))
10563 update_tool_bar (f
, 1);
10564 if (f
->n_tool_bar_items
)
10566 build_desired_tool_bar_string (f
);
10567 nlines
= tool_bar_lines_needed (f
, NULL
);
10571 return make_number (nlines
);
10575 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10576 height should be changed. */
10579 redisplay_tool_bar (struct frame
*f
)
10583 struct glyph_row
*row
;
10585 #if defined (USE_GTK) || defined (HAVE_NS)
10586 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10587 update_frame_tool_bar (f
);
10591 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10592 do anything. This means you must start with tool-bar-lines
10593 non-zero to get the auto-sizing effect. Or in other words, you
10594 can turn off tool-bars by specifying tool-bar-lines zero. */
10595 if (!WINDOWP (f
->tool_bar_window
)
10596 || (w
= XWINDOW (f
->tool_bar_window
),
10597 WINDOW_TOTAL_LINES (w
) == 0))
10600 /* Set up an iterator for the tool-bar window. */
10601 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10602 it
.first_visible_x
= 0;
10603 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10604 row
= it
.glyph_row
;
10606 /* Build a string that represents the contents of the tool-bar. */
10607 build_desired_tool_bar_string (f
);
10608 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10610 if (f
->n_tool_bar_rows
== 0)
10614 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10615 nlines
!= WINDOW_TOTAL_LINES (w
)))
10618 int old_height
= WINDOW_TOTAL_LINES (w
);
10620 XSETFRAME (frame
, f
);
10621 Fmodify_frame_parameters (frame
,
10622 Fcons (Fcons (Qtool_bar_lines
,
10623 make_number (nlines
)),
10625 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10627 clear_glyph_matrix (w
->desired_matrix
);
10628 fonts_changed_p
= 1;
10634 /* Display as many lines as needed to display all tool-bar items. */
10636 if (f
->n_tool_bar_rows
> 0)
10638 int border
, rows
, height
, extra
;
10640 if (INTEGERP (Vtool_bar_border
))
10641 border
= XINT (Vtool_bar_border
);
10642 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10643 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10644 else if (EQ (Vtool_bar_border
, Qborder_width
))
10645 border
= f
->border_width
;
10651 rows
= f
->n_tool_bar_rows
;
10652 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10653 extra
= it
.last_visible_y
- border
- height
* rows
;
10655 while (it
.current_y
< it
.last_visible_y
)
10658 if (extra
> 0 && rows
-- > 0)
10660 h
= (extra
+ rows
- 1) / rows
;
10663 display_tool_bar_line (&it
, height
+ h
);
10668 while (it
.current_y
< it
.last_visible_y
)
10669 display_tool_bar_line (&it
, 0);
10672 /* It doesn't make much sense to try scrolling in the tool-bar
10673 window, so don't do it. */
10674 w
->desired_matrix
->no_scrolling_p
= 1;
10675 w
->must_be_updated_p
= 1;
10677 if (!NILP (Vauto_resize_tool_bars
))
10679 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10680 int change_height_p
= 0;
10682 /* If we couldn't display everything, change the tool-bar's
10683 height if there is room for more. */
10684 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10685 && it
.current_y
< max_tool_bar_height
)
10686 change_height_p
= 1;
10688 row
= it
.glyph_row
- 1;
10690 /* If there are blank lines at the end, except for a partially
10691 visible blank line at the end that is smaller than
10692 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10693 if (!row
->displays_text_p
10694 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10695 change_height_p
= 1;
10697 /* If row displays tool-bar items, but is partially visible,
10698 change the tool-bar's height. */
10699 if (row
->displays_text_p
10700 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10701 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10702 change_height_p
= 1;
10704 /* Resize windows as needed by changing the `tool-bar-lines'
10705 frame parameter. */
10706 if (change_height_p
)
10709 int old_height
= WINDOW_TOTAL_LINES (w
);
10711 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10713 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10714 && !f
->minimize_tool_bar_window_p
)
10715 ? (nlines
> old_height
)
10716 : (nlines
!= old_height
));
10717 f
->minimize_tool_bar_window_p
= 0;
10719 if (change_height_p
)
10721 XSETFRAME (frame
, f
);
10722 Fmodify_frame_parameters (frame
,
10723 Fcons (Fcons (Qtool_bar_lines
,
10724 make_number (nlines
)),
10726 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10728 clear_glyph_matrix (w
->desired_matrix
);
10729 f
->n_tool_bar_rows
= nrows
;
10730 fonts_changed_p
= 1;
10737 f
->minimize_tool_bar_window_p
= 0;
10742 /* Get information about the tool-bar item which is displayed in GLYPH
10743 on frame F. Return in *PROP_IDX the index where tool-bar item
10744 properties start in F->tool_bar_items. Value is zero if
10745 GLYPH doesn't display a tool-bar item. */
10748 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10754 /* This function can be called asynchronously, which means we must
10755 exclude any possibility that Fget_text_property signals an
10757 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10758 charpos
= max (0, charpos
);
10760 /* Get the text property `menu-item' at pos. The value of that
10761 property is the start index of this item's properties in
10762 F->tool_bar_items. */
10763 prop
= Fget_text_property (make_number (charpos
),
10764 Qmenu_item
, f
->current_tool_bar_string
);
10765 if (INTEGERP (prop
))
10767 *prop_idx
= XINT (prop
);
10777 /* Get information about the tool-bar item at position X/Y on frame F.
10778 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10779 the current matrix of the tool-bar window of F, or NULL if not
10780 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10781 item in F->tool_bar_items. Value is
10783 -1 if X/Y is not on a tool-bar item
10784 0 if X/Y is on the same item that was highlighted before.
10788 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10789 int *hpos
, int *vpos
, int *prop_idx
)
10791 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10792 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10795 /* Find the glyph under X/Y. */
10796 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10797 if (*glyph
== NULL
)
10800 /* Get the start of this tool-bar item's properties in
10801 f->tool_bar_items. */
10802 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10805 /* Is mouse on the highlighted item? */
10806 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
10807 && *vpos
>= hlinfo
->mouse_face_beg_row
10808 && *vpos
<= hlinfo
->mouse_face_end_row
10809 && (*vpos
> hlinfo
->mouse_face_beg_row
10810 || *hpos
>= hlinfo
->mouse_face_beg_col
)
10811 && (*vpos
< hlinfo
->mouse_face_end_row
10812 || *hpos
< hlinfo
->mouse_face_end_col
10813 || hlinfo
->mouse_face_past_end
))
10821 Handle mouse button event on the tool-bar of frame F, at
10822 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10823 0 for button release. MODIFIERS is event modifiers for button
10827 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10828 unsigned int modifiers
)
10830 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10831 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10832 int hpos
, vpos
, prop_idx
;
10833 struct glyph
*glyph
;
10834 Lisp_Object enabled_p
;
10836 /* If not on the highlighted tool-bar item, return. */
10837 frame_to_window_pixel_xy (w
, &x
, &y
);
10838 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10841 /* If item is disabled, do nothing. */
10842 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10843 if (NILP (enabled_p
))
10848 /* Show item in pressed state. */
10849 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
10850 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10851 last_tool_bar_item
= prop_idx
;
10855 Lisp_Object key
, frame
;
10856 struct input_event event
;
10857 EVENT_INIT (event
);
10859 /* Show item in released state. */
10860 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
10861 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10863 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10865 XSETFRAME (frame
, f
);
10866 event
.kind
= TOOL_BAR_EVENT
;
10867 event
.frame_or_window
= frame
;
10869 kbd_buffer_store_event (&event
);
10871 event
.kind
= TOOL_BAR_EVENT
;
10872 event
.frame_or_window
= frame
;
10874 event
.modifiers
= modifiers
;
10875 kbd_buffer_store_event (&event
);
10876 last_tool_bar_item
= -1;
10881 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10882 tool-bar window-relative coordinates X/Y. Called from
10883 note_mouse_highlight. */
10886 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10888 Lisp_Object window
= f
->tool_bar_window
;
10889 struct window
*w
= XWINDOW (window
);
10890 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10891 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
10893 struct glyph
*glyph
;
10894 struct glyph_row
*row
;
10896 Lisp_Object enabled_p
;
10898 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10899 int mouse_down_p
, rc
;
10901 /* Function note_mouse_highlight is called with negative X/Y
10902 values when mouse moves outside of the frame. */
10903 if (x
<= 0 || y
<= 0)
10905 clear_mouse_face (hlinfo
);
10909 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10912 /* Not on tool-bar item. */
10913 clear_mouse_face (hlinfo
);
10917 /* On same tool-bar item as before. */
10918 goto set_help_echo
;
10920 clear_mouse_face (hlinfo
);
10922 /* Mouse is down, but on different tool-bar item? */
10923 mouse_down_p
= (dpyinfo
->grabbed
10924 && f
== last_mouse_frame
10925 && FRAME_LIVE_P (f
));
10927 && last_tool_bar_item
!= prop_idx
)
10930 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10931 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10933 /* If tool-bar item is not enabled, don't highlight it. */
10934 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10935 if (!NILP (enabled_p
))
10937 /* Compute the x-position of the glyph. In front and past the
10938 image is a space. We include this in the highlighted area. */
10939 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10940 for (i
= x
= 0; i
< hpos
; ++i
)
10941 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10943 /* Record this as the current active region. */
10944 hlinfo
->mouse_face_beg_col
= hpos
;
10945 hlinfo
->mouse_face_beg_row
= vpos
;
10946 hlinfo
->mouse_face_beg_x
= x
;
10947 hlinfo
->mouse_face_beg_y
= row
->y
;
10948 hlinfo
->mouse_face_past_end
= 0;
10950 hlinfo
->mouse_face_end_col
= hpos
+ 1;
10951 hlinfo
->mouse_face_end_row
= vpos
;
10952 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10953 hlinfo
->mouse_face_end_y
= row
->y
;
10954 hlinfo
->mouse_face_window
= window
;
10955 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10957 /* Display it as active. */
10958 show_mouse_face (hlinfo
, draw
);
10959 hlinfo
->mouse_face_image_state
= draw
;
10964 /* Set help_echo_string to a help string to display for this tool-bar item.
10965 XTread_socket does the rest. */
10966 help_echo_object
= help_echo_window
= Qnil
;
10967 help_echo_pos
= -1;
10968 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10969 if (NILP (help_echo_string
))
10970 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10973 #endif /* HAVE_WINDOW_SYSTEM */
10977 /************************************************************************
10978 Horizontal scrolling
10979 ************************************************************************/
10981 static int hscroll_window_tree (Lisp_Object
);
10982 static int hscroll_windows (Lisp_Object
);
10984 /* For all leaf windows in the window tree rooted at WINDOW, set their
10985 hscroll value so that PT is (i) visible in the window, and (ii) so
10986 that it is not within a certain margin at the window's left and
10987 right border. Value is non-zero if any window's hscroll has been
10991 hscroll_window_tree (Lisp_Object window
)
10993 int hscrolled_p
= 0;
10994 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10995 int hscroll_step_abs
= 0;
10996 double hscroll_step_rel
= 0;
10998 if (hscroll_relative_p
)
11000 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11001 if (hscroll_step_rel
< 0)
11003 hscroll_relative_p
= 0;
11004 hscroll_step_abs
= 0;
11007 else if (INTEGERP (Vhscroll_step
))
11009 hscroll_step_abs
= XINT (Vhscroll_step
);
11010 if (hscroll_step_abs
< 0)
11011 hscroll_step_abs
= 0;
11014 hscroll_step_abs
= 0;
11016 while (WINDOWP (window
))
11018 struct window
*w
= XWINDOW (window
);
11020 if (WINDOWP (w
->hchild
))
11021 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11022 else if (WINDOWP (w
->vchild
))
11023 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11024 else if (w
->cursor
.vpos
>= 0)
11027 int text_area_width
;
11028 struct glyph_row
*current_cursor_row
11029 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11030 struct glyph_row
*desired_cursor_row
11031 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11032 struct glyph_row
*cursor_row
11033 = (desired_cursor_row
->enabled_p
11034 ? desired_cursor_row
11035 : current_cursor_row
);
11037 text_area_width
= window_box_width (w
, TEXT_AREA
);
11039 /* Scroll when cursor is inside this scroll margin. */
11040 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11042 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11043 && ((XFASTINT (w
->hscroll
)
11044 && w
->cursor
.x
<= h_margin
)
11045 || (cursor_row
->enabled_p
11046 && cursor_row
->truncated_on_right_p
11047 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11051 struct buffer
*saved_current_buffer
;
11055 /* Find point in a display of infinite width. */
11056 saved_current_buffer
= current_buffer
;
11057 current_buffer
= XBUFFER (w
->buffer
);
11059 if (w
== XWINDOW (selected_window
))
11063 pt
= marker_position (w
->pointm
);
11064 pt
= max (BEGV
, pt
);
11068 /* Move iterator to pt starting at cursor_row->start in
11069 a line with infinite width. */
11070 init_to_row_start (&it
, w
, cursor_row
);
11071 it
.last_visible_x
= INFINITY
;
11072 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11073 current_buffer
= saved_current_buffer
;
11075 /* Position cursor in window. */
11076 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11077 hscroll
= max (0, (it
.current_x
11078 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11079 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11080 : (text_area_width
/ 2))))
11081 / FRAME_COLUMN_WIDTH (it
.f
);
11082 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11084 if (hscroll_relative_p
)
11085 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11088 wanted_x
= text_area_width
11089 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11092 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11096 if (hscroll_relative_p
)
11097 wanted_x
= text_area_width
* hscroll_step_rel
11100 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11103 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11105 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11107 /* Don't call Fset_window_hscroll if value hasn't
11108 changed because it will prevent redisplay
11110 if (XFASTINT (w
->hscroll
) != hscroll
)
11112 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11113 w
->hscroll
= make_number (hscroll
);
11122 /* Value is non-zero if hscroll of any leaf window has been changed. */
11123 return hscrolled_p
;
11127 /* Set hscroll so that cursor is visible and not inside horizontal
11128 scroll margins for all windows in the tree rooted at WINDOW. See
11129 also hscroll_window_tree above. Value is non-zero if any window's
11130 hscroll has been changed. If it has, desired matrices on the frame
11131 of WINDOW are cleared. */
11134 hscroll_windows (Lisp_Object window
)
11136 int hscrolled_p
= hscroll_window_tree (window
);
11138 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11139 return hscrolled_p
;
11144 /************************************************************************
11146 ************************************************************************/
11148 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11149 to a non-zero value. This is sometimes handy to have in a debugger
11154 /* First and last unchanged row for try_window_id. */
11156 int debug_first_unchanged_at_end_vpos
;
11157 int debug_last_unchanged_at_beg_vpos
;
11159 /* Delta vpos and y. */
11161 int debug_dvpos
, debug_dy
;
11163 /* Delta in characters and bytes for try_window_id. */
11165 EMACS_INT debug_delta
, debug_delta_bytes
;
11167 /* Values of window_end_pos and window_end_vpos at the end of
11170 EMACS_INT debug_end_vpos
;
11172 /* Append a string to W->desired_matrix->method. FMT is a printf
11173 format string. A1...A9 are a supplement for a variable-length
11174 argument list. If trace_redisplay_p is non-zero also printf the
11175 resulting string to stderr. */
11178 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11181 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11184 char *method
= w
->desired_matrix
->method
;
11185 int len
= strlen (method
);
11186 int size
= sizeof w
->desired_matrix
->method
;
11187 int remaining
= size
- len
- 1;
11189 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11190 if (len
&& remaining
)
11193 --remaining
, ++len
;
11196 strncpy (method
+ len
, buffer
, remaining
);
11198 if (trace_redisplay_p
)
11199 fprintf (stderr
, "%p (%s): %s\n",
11201 ((BUFFERP (w
->buffer
)
11202 && STRINGP (XBUFFER (w
->buffer
)->name
))
11203 ? SSDATA (XBUFFER (w
->buffer
)->name
)
11208 #endif /* GLYPH_DEBUG */
11211 /* Value is non-zero if all changes in window W, which displays
11212 current_buffer, are in the text between START and END. START is a
11213 buffer position, END is given as a distance from Z. Used in
11214 redisplay_internal for display optimization. */
11217 text_outside_line_unchanged_p (struct window
*w
,
11218 EMACS_INT start
, EMACS_INT end
)
11220 int unchanged_p
= 1;
11222 /* If text or overlays have changed, see where. */
11223 if (XFASTINT (w
->last_modified
) < MODIFF
11224 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11226 /* Gap in the line? */
11227 if (GPT
< start
|| Z
- GPT
< end
)
11230 /* Changes start in front of the line, or end after it? */
11232 && (BEG_UNCHANGED
< start
- 1
11233 || END_UNCHANGED
< end
))
11236 /* If selective display, can't optimize if changes start at the
11237 beginning of the line. */
11239 && INTEGERP (BVAR (current_buffer
, selective_display
))
11240 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11241 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11244 /* If there are overlays at the start or end of the line, these
11245 may have overlay strings with newlines in them. A change at
11246 START, for instance, may actually concern the display of such
11247 overlay strings as well, and they are displayed on different
11248 lines. So, quickly rule out this case. (For the future, it
11249 might be desirable to implement something more telling than
11250 just BEG/END_UNCHANGED.) */
11253 if (BEG
+ BEG_UNCHANGED
== start
11254 && overlay_touches_p (start
))
11256 if (END_UNCHANGED
== end
11257 && overlay_touches_p (Z
- end
))
11261 /* Under bidi reordering, adding or deleting a character in the
11262 beginning of a paragraph, before the first strong directional
11263 character, can change the base direction of the paragraph (unless
11264 the buffer specifies a fixed paragraph direction), which will
11265 require to redisplay the whole paragraph. It might be worthwhile
11266 to find the paragraph limits and widen the range of redisplayed
11267 lines to that, but for now just give up this optimization. */
11268 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11269 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
11273 return unchanged_p
;
11277 /* Do a frame update, taking possible shortcuts into account. This is
11278 the main external entry point for redisplay.
11280 If the last redisplay displayed an echo area message and that message
11281 is no longer requested, we clear the echo area or bring back the
11282 mini-buffer if that is in use. */
11287 redisplay_internal ();
11292 overlay_arrow_string_or_property (Lisp_Object var
)
11296 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11299 return Voverlay_arrow_string
;
11302 /* Return 1 if there are any overlay-arrows in current_buffer. */
11304 overlay_arrow_in_current_buffer_p (void)
11308 for (vlist
= Voverlay_arrow_variable_list
;
11310 vlist
= XCDR (vlist
))
11312 Lisp_Object var
= XCAR (vlist
);
11315 if (!SYMBOLP (var
))
11317 val
= find_symbol_value (var
);
11319 && current_buffer
== XMARKER (val
)->buffer
)
11326 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11330 overlay_arrows_changed_p (void)
11334 for (vlist
= Voverlay_arrow_variable_list
;
11336 vlist
= XCDR (vlist
))
11338 Lisp_Object var
= XCAR (vlist
);
11339 Lisp_Object val
, pstr
;
11341 if (!SYMBOLP (var
))
11343 val
= find_symbol_value (var
);
11344 if (!MARKERP (val
))
11346 if (! EQ (COERCE_MARKER (val
),
11347 Fget (var
, Qlast_arrow_position
))
11348 || ! (pstr
= overlay_arrow_string_or_property (var
),
11349 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11355 /* Mark overlay arrows to be updated on next redisplay. */
11358 update_overlay_arrows (int up_to_date
)
11362 for (vlist
= Voverlay_arrow_variable_list
;
11364 vlist
= XCDR (vlist
))
11366 Lisp_Object var
= XCAR (vlist
);
11368 if (!SYMBOLP (var
))
11371 if (up_to_date
> 0)
11373 Lisp_Object val
= find_symbol_value (var
);
11374 Fput (var
, Qlast_arrow_position
,
11375 COERCE_MARKER (val
));
11376 Fput (var
, Qlast_arrow_string
,
11377 overlay_arrow_string_or_property (var
));
11379 else if (up_to_date
< 0
11380 || !NILP (Fget (var
, Qlast_arrow_position
)))
11382 Fput (var
, Qlast_arrow_position
, Qt
);
11383 Fput (var
, Qlast_arrow_string
, Qt
);
11389 /* Return overlay arrow string to display at row.
11390 Return integer (bitmap number) for arrow bitmap in left fringe.
11391 Return nil if no overlay arrow. */
11394 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11398 for (vlist
= Voverlay_arrow_variable_list
;
11400 vlist
= XCDR (vlist
))
11402 Lisp_Object var
= XCAR (vlist
);
11405 if (!SYMBOLP (var
))
11408 val
= find_symbol_value (var
);
11411 && current_buffer
== XMARKER (val
)->buffer
11412 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11414 if (FRAME_WINDOW_P (it
->f
)
11415 /* FIXME: if ROW->reversed_p is set, this should test
11416 the right fringe, not the left one. */
11417 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11419 #ifdef HAVE_WINDOW_SYSTEM
11420 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11423 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11424 return make_number (fringe_bitmap
);
11427 return make_number (-1); /* Use default arrow bitmap */
11429 return overlay_arrow_string_or_property (var
);
11436 /* Return 1 if point moved out of or into a composition. Otherwise
11437 return 0. PREV_BUF and PREV_PT are the last point buffer and
11438 position. BUF and PT are the current point buffer and position. */
11441 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11442 struct buffer
*buf
, EMACS_INT pt
)
11444 EMACS_INT start
, end
;
11446 Lisp_Object buffer
;
11448 XSETBUFFER (buffer
, buf
);
11449 /* Check a composition at the last point if point moved within the
11451 if (prev_buf
== buf
)
11454 /* Point didn't move. */
11457 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11458 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11459 && COMPOSITION_VALID_P (start
, end
, prop
)
11460 && start
< prev_pt
&& end
> prev_pt
)
11461 /* The last point was within the composition. Return 1 iff
11462 point moved out of the composition. */
11463 return (pt
<= start
|| pt
>= end
);
11466 /* Check a composition at the current point. */
11467 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11468 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11469 && COMPOSITION_VALID_P (start
, end
, prop
)
11470 && start
< pt
&& end
> pt
);
11474 /* Reconsider the setting of B->clip_changed which is displayed
11478 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11480 if (b
->clip_changed
11481 && !NILP (w
->window_end_valid
)
11482 && w
->current_matrix
->buffer
== b
11483 && w
->current_matrix
->zv
== BUF_ZV (b
)
11484 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11485 b
->clip_changed
= 0;
11487 /* If display wasn't paused, and W is not a tool bar window, see if
11488 point has been moved into or out of a composition. In that case,
11489 we set b->clip_changed to 1 to force updating the screen. If
11490 b->clip_changed has already been set to 1, we can skip this
11492 if (!b
->clip_changed
11493 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11497 if (w
== XWINDOW (selected_window
))
11500 pt
= marker_position (w
->pointm
);
11502 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11503 || pt
!= XINT (w
->last_point
))
11504 && check_point_in_composition (w
->current_matrix
->buffer
,
11505 XINT (w
->last_point
),
11506 XBUFFER (w
->buffer
), pt
))
11507 b
->clip_changed
= 1;
11512 /* Select FRAME to forward the values of frame-local variables into C
11513 variables so that the redisplay routines can access those values
11517 select_frame_for_redisplay (Lisp_Object frame
)
11519 Lisp_Object tail
, tem
;
11520 Lisp_Object old
= selected_frame
;
11521 struct Lisp_Symbol
*sym
;
11523 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11525 selected_frame
= frame
;
11528 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11529 if (CONSP (XCAR (tail
))
11530 && (tem
= XCAR (XCAR (tail
)),
11532 && (sym
= indirect_variable (XSYMBOL (tem
)),
11533 sym
->redirect
== SYMBOL_LOCALIZED
)
11534 && sym
->val
.blv
->frame_local
)
11535 /* Use find_symbol_value rather than Fsymbol_value
11536 to avoid an error if it is void. */
11537 find_symbol_value (tem
);
11538 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11542 #define STOP_POLLING \
11543 do { if (! polling_stopped_here) stop_polling (); \
11544 polling_stopped_here = 1; } while (0)
11546 #define RESUME_POLLING \
11547 do { if (polling_stopped_here) start_polling (); \
11548 polling_stopped_here = 0; } while (0)
11551 /* Perhaps in the future avoid recentering windows if it
11552 is not necessary; currently that causes some problems. */
11555 redisplay_internal (void)
11557 struct window
*w
= XWINDOW (selected_window
);
11561 int must_finish
= 0;
11562 struct text_pos tlbufpos
, tlendpos
;
11563 int number_of_visible_frames
;
11566 int polling_stopped_here
= 0;
11567 Lisp_Object old_frame
= selected_frame
;
11569 /* Non-zero means redisplay has to consider all windows on all
11570 frames. Zero means, only selected_window is considered. */
11571 int consider_all_windows_p
;
11573 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11575 /* No redisplay if running in batch mode or frame is not yet fully
11576 initialized, or redisplay is explicitly turned off by setting
11577 Vinhibit_redisplay. */
11578 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11579 || !NILP (Vinhibit_redisplay
))
11582 /* Don't examine these until after testing Vinhibit_redisplay.
11583 When Emacs is shutting down, perhaps because its connection to
11584 X has dropped, we should not look at them at all. */
11585 fr
= XFRAME (w
->frame
);
11586 sf
= SELECTED_FRAME ();
11588 if (!fr
->glyphs_initialized_p
)
11591 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11592 if (popup_activated ())
11596 /* I don't think this happens but let's be paranoid. */
11597 if (redisplaying_p
)
11600 /* Record a function that resets redisplaying_p to its old value
11601 when we leave this function. */
11602 count
= SPECPDL_INDEX ();
11603 record_unwind_protect (unwind_redisplay
,
11604 Fcons (make_number (redisplaying_p
), selected_frame
));
11606 specbind (Qinhibit_free_realized_faces
, Qnil
);
11609 Lisp_Object tail
, frame
;
11611 FOR_EACH_FRAME (tail
, frame
)
11613 struct frame
*f
= XFRAME (frame
);
11614 f
->already_hscrolled_p
= 0;
11619 /* Remember the currently selected window. */
11622 if (!EQ (old_frame
, selected_frame
)
11623 && FRAME_LIVE_P (XFRAME (old_frame
)))
11624 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11625 selected_frame and selected_window to be temporarily out-of-sync so
11626 when we come back here via `goto retry', we need to resync because we
11627 may need to run Elisp code (via prepare_menu_bars). */
11628 select_frame_for_redisplay (old_frame
);
11631 reconsider_clip_changes (w
, current_buffer
);
11632 last_escape_glyph_frame
= NULL
;
11633 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11634 last_glyphless_glyph_frame
= NULL
;
11635 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
11637 /* If new fonts have been loaded that make a glyph matrix adjustment
11638 necessary, do it. */
11639 if (fonts_changed_p
)
11641 adjust_glyphs (NULL
);
11642 ++windows_or_buffers_changed
;
11643 fonts_changed_p
= 0;
11646 /* If face_change_count is non-zero, init_iterator will free all
11647 realized faces, which includes the faces referenced from current
11648 matrices. So, we can't reuse current matrices in this case. */
11649 if (face_change_count
)
11650 ++windows_or_buffers_changed
;
11652 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11653 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11655 /* Since frames on a single ASCII terminal share the same
11656 display area, displaying a different frame means redisplay
11657 the whole thing. */
11658 windows_or_buffers_changed
++;
11659 SET_FRAME_GARBAGED (sf
);
11661 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11663 FRAME_TTY (sf
)->previous_frame
= sf
;
11666 /* Set the visible flags for all frames. Do this before checking
11667 for resized or garbaged frames; they want to know if their frames
11668 are visible. See the comment in frame.h for
11669 FRAME_SAMPLE_VISIBILITY. */
11671 Lisp_Object tail
, frame
;
11673 number_of_visible_frames
= 0;
11675 FOR_EACH_FRAME (tail
, frame
)
11677 struct frame
*f
= XFRAME (frame
);
11679 FRAME_SAMPLE_VISIBILITY (f
);
11680 if (FRAME_VISIBLE_P (f
))
11681 ++number_of_visible_frames
;
11682 clear_desired_matrices (f
);
11686 /* Notice any pending interrupt request to change frame size. */
11687 do_pending_window_change (1);
11689 /* do_pending_window_change could change the selected_window due to
11690 frame resizing which makes the selected window too small. */
11691 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
11694 reconsider_clip_changes (w
, current_buffer
);
11697 /* Clear frames marked as garbaged. */
11698 if (frame_garbaged
)
11699 clear_garbaged_frames ();
11701 /* Build menubar and tool-bar items. */
11702 if (NILP (Vmemory_full
))
11703 prepare_menu_bars ();
11705 if (windows_or_buffers_changed
)
11706 update_mode_lines
++;
11708 /* Detect case that we need to write or remove a star in the mode line. */
11709 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11711 w
->update_mode_line
= Qt
;
11712 if (buffer_shared
> 1)
11713 update_mode_lines
++;
11716 /* Avoid invocation of point motion hooks by `current_column' below. */
11717 count1
= SPECPDL_INDEX ();
11718 specbind (Qinhibit_point_motion_hooks
, Qt
);
11720 /* If %c is in the mode line, update it if needed. */
11721 if (!NILP (w
->column_number_displayed
)
11722 /* This alternative quickly identifies a common case
11723 where no change is needed. */
11724 && !(PT
== XFASTINT (w
->last_point
)
11725 && XFASTINT (w
->last_modified
) >= MODIFF
11726 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11727 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
11728 w
->update_mode_line
= Qt
;
11730 unbind_to (count1
, Qnil
);
11732 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11734 /* The variable buffer_shared is set in redisplay_window and
11735 indicates that we redisplay a buffer in different windows. See
11737 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11738 || cursor_type_changed
);
11740 /* If specs for an arrow have changed, do thorough redisplay
11741 to ensure we remove any arrow that should no longer exist. */
11742 if (overlay_arrows_changed_p ())
11743 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11745 /* Normally the message* functions will have already displayed and
11746 updated the echo area, but the frame may have been trashed, or
11747 the update may have been preempted, so display the echo area
11748 again here. Checking message_cleared_p captures the case that
11749 the echo area should be cleared. */
11750 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11751 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11752 || (message_cleared_p
11753 && minibuf_level
== 0
11754 /* If the mini-window is currently selected, this means the
11755 echo-area doesn't show through. */
11756 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11758 int window_height_changed_p
= echo_area_display (0);
11761 /* If we don't display the current message, don't clear the
11762 message_cleared_p flag, because, if we did, we wouldn't clear
11763 the echo area in the next redisplay which doesn't preserve
11765 if (!display_last_displayed_message_p
)
11766 message_cleared_p
= 0;
11768 if (fonts_changed_p
)
11770 else if (window_height_changed_p
)
11772 consider_all_windows_p
= 1;
11773 ++update_mode_lines
;
11774 ++windows_or_buffers_changed
;
11776 /* If window configuration was changed, frames may have been
11777 marked garbaged. Clear them or we will experience
11778 surprises wrt scrolling. */
11779 if (frame_garbaged
)
11780 clear_garbaged_frames ();
11783 else if (EQ (selected_window
, minibuf_window
)
11784 && (current_buffer
->clip_changed
11785 || XFASTINT (w
->last_modified
) < MODIFF
11786 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11787 && resize_mini_window (w
, 0))
11789 /* Resized active mini-window to fit the size of what it is
11790 showing if its contents might have changed. */
11792 /* FIXME: this causes all frames to be updated, which seems unnecessary
11793 since only the current frame needs to be considered. This function needs
11794 to be rewritten with two variables, consider_all_windows and
11795 consider_all_frames. */
11796 consider_all_windows_p
= 1;
11797 ++windows_or_buffers_changed
;
11798 ++update_mode_lines
;
11800 /* If window configuration was changed, frames may have been
11801 marked garbaged. Clear them or we will experience
11802 surprises wrt scrolling. */
11803 if (frame_garbaged
)
11804 clear_garbaged_frames ();
11808 /* If showing the region, and mark has changed, we must redisplay
11809 the whole window. The assignment to this_line_start_pos prevents
11810 the optimization directly below this if-statement. */
11811 if (((!NILP (Vtransient_mark_mode
)
11812 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11813 != !NILP (w
->region_showing
))
11814 || (!NILP (w
->region_showing
)
11815 && !EQ (w
->region_showing
,
11816 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
11817 CHARPOS (this_line_start_pos
) = 0;
11819 /* Optimize the case that only the line containing the cursor in the
11820 selected window has changed. Variables starting with this_ are
11821 set in display_line and record information about the line
11822 containing the cursor. */
11823 tlbufpos
= this_line_start_pos
;
11824 tlendpos
= this_line_end_pos
;
11825 if (!consider_all_windows_p
11826 && CHARPOS (tlbufpos
) > 0
11827 && NILP (w
->update_mode_line
)
11828 && !current_buffer
->clip_changed
11829 && !current_buffer
->prevent_redisplay_optimizations_p
11830 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11831 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11832 /* Make sure recorded data applies to current buffer, etc. */
11833 && this_line_buffer
== current_buffer
11834 && current_buffer
== XBUFFER (w
->buffer
)
11835 && NILP (w
->force_start
)
11836 && NILP (w
->optional_new_start
)
11837 /* Point must be on the line that we have info recorded about. */
11838 && PT
>= CHARPOS (tlbufpos
)
11839 && PT
<= Z
- CHARPOS (tlendpos
)
11840 /* All text outside that line, including its final newline,
11841 must be unchanged. */
11842 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11843 CHARPOS (tlendpos
)))
11845 if (CHARPOS (tlbufpos
) > BEGV
11846 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11847 && (CHARPOS (tlbufpos
) == ZV
11848 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11849 /* Former continuation line has disappeared by becoming empty. */
11851 else if (XFASTINT (w
->last_modified
) < MODIFF
11852 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11853 || MINI_WINDOW_P (w
))
11855 /* We have to handle the case of continuation around a
11856 wide-column character (see the comment in indent.c around
11859 For instance, in the following case:
11861 -------- Insert --------
11862 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11863 J_I_ ==> J_I_ `^^' are cursors.
11867 As we have to redraw the line above, we cannot use this
11871 int line_height_before
= this_line_pixel_height
;
11873 /* Note that start_display will handle the case that the
11874 line starting at tlbufpos is a continuation line. */
11875 start_display (&it
, w
, tlbufpos
);
11877 /* Implementation note: It this still necessary? */
11878 if (it
.current_x
!= this_line_start_x
)
11881 TRACE ((stderr
, "trying display optimization 1\n"));
11882 w
->cursor
.vpos
= -1;
11883 overlay_arrow_seen
= 0;
11884 it
.vpos
= this_line_vpos
;
11885 it
.current_y
= this_line_y
;
11886 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11887 display_line (&it
);
11889 /* If line contains point, is not continued,
11890 and ends at same distance from eob as before, we win. */
11891 if (w
->cursor
.vpos
>= 0
11892 /* Line is not continued, otherwise this_line_start_pos
11893 would have been set to 0 in display_line. */
11894 && CHARPOS (this_line_start_pos
)
11895 /* Line ends as before. */
11896 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11897 /* Line has same height as before. Otherwise other lines
11898 would have to be shifted up or down. */
11899 && this_line_pixel_height
== line_height_before
)
11901 /* If this is not the window's last line, we must adjust
11902 the charstarts of the lines below. */
11903 if (it
.current_y
< it
.last_visible_y
)
11905 struct glyph_row
*row
11906 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11907 EMACS_INT delta
, delta_bytes
;
11909 /* We used to distinguish between two cases here,
11910 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11911 when the line ends in a newline or the end of the
11912 buffer's accessible portion. But both cases did
11913 the same, so they were collapsed. */
11915 - CHARPOS (tlendpos
)
11916 - MATRIX_ROW_START_CHARPOS (row
));
11917 delta_bytes
= (Z_BYTE
11918 - BYTEPOS (tlendpos
)
11919 - MATRIX_ROW_START_BYTEPOS (row
));
11921 increment_matrix_positions (w
->current_matrix
,
11922 this_line_vpos
+ 1,
11923 w
->current_matrix
->nrows
,
11924 delta
, delta_bytes
);
11927 /* If this row displays text now but previously didn't,
11928 or vice versa, w->window_end_vpos may have to be
11930 if ((it
.glyph_row
- 1)->displays_text_p
)
11932 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11933 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11935 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11936 && this_line_vpos
> 0)
11937 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11938 w
->window_end_valid
= Qnil
;
11940 /* Update hint: No need to try to scroll in update_window. */
11941 w
->desired_matrix
->no_scrolling_p
= 1;
11944 *w
->desired_matrix
->method
= 0;
11945 debug_method_add (w
, "optimization 1");
11947 #ifdef HAVE_WINDOW_SYSTEM
11948 update_window_fringes (w
, 0);
11955 else if (/* Cursor position hasn't changed. */
11956 PT
== XFASTINT (w
->last_point
)
11957 /* Make sure the cursor was last displayed
11958 in this window. Otherwise we have to reposition it. */
11959 && 0 <= w
->cursor
.vpos
11960 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11964 do_pending_window_change (1);
11965 /* If selected_window changed, redisplay again. */
11966 if (WINDOWP (selected_window
)
11967 && (w
= XWINDOW (selected_window
)) != sw
)
11970 /* We used to always goto end_of_redisplay here, but this
11971 isn't enough if we have a blinking cursor. */
11972 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11973 goto end_of_redisplay
;
11977 /* If highlighting the region, or if the cursor is in the echo area,
11978 then we can't just move the cursor. */
11979 else if (! (!NILP (Vtransient_mark_mode
)
11980 && !NILP (BVAR (current_buffer
, mark_active
)))
11981 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
11982 || highlight_nonselected_windows
)
11983 && NILP (w
->region_showing
)
11984 && NILP (Vshow_trailing_whitespace
)
11985 && !cursor_in_echo_area
)
11988 struct glyph_row
*row
;
11990 /* Skip from tlbufpos to PT and see where it is. Note that
11991 PT may be in invisible text. If so, we will end at the
11992 next visible position. */
11993 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11994 NULL
, DEFAULT_FACE_ID
);
11995 it
.current_x
= this_line_start_x
;
11996 it
.current_y
= this_line_y
;
11997 it
.vpos
= this_line_vpos
;
11999 /* The call to move_it_to stops in front of PT, but
12000 moves over before-strings. */
12001 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12003 if (it
.vpos
== this_line_vpos
12004 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12007 xassert (this_line_vpos
== it
.vpos
);
12008 xassert (this_line_y
== it
.current_y
);
12009 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12011 *w
->desired_matrix
->method
= 0;
12012 debug_method_add (w
, "optimization 3");
12021 /* Text changed drastically or point moved off of line. */
12022 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12025 CHARPOS (this_line_start_pos
) = 0;
12026 consider_all_windows_p
|= buffer_shared
> 1;
12027 ++clear_face_cache_count
;
12028 #ifdef HAVE_WINDOW_SYSTEM
12029 ++clear_image_cache_count
;
12032 /* Build desired matrices, and update the display. If
12033 consider_all_windows_p is non-zero, do it for all windows on all
12034 frames. Otherwise do it for selected_window, only. */
12036 if (consider_all_windows_p
)
12038 Lisp_Object tail
, frame
;
12040 FOR_EACH_FRAME (tail
, frame
)
12041 XFRAME (frame
)->updated_p
= 0;
12043 /* Recompute # windows showing selected buffer. This will be
12044 incremented each time such a window is displayed. */
12047 FOR_EACH_FRAME (tail
, frame
)
12049 struct frame
*f
= XFRAME (frame
);
12051 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12053 if (! EQ (frame
, selected_frame
))
12054 /* Select the frame, for the sake of frame-local
12056 select_frame_for_redisplay (frame
);
12058 /* Mark all the scroll bars to be removed; we'll redeem
12059 the ones we want when we redisplay their windows. */
12060 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12061 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12063 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12064 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12066 /* The X error handler may have deleted that frame. */
12067 if (!FRAME_LIVE_P (f
))
12070 /* Any scroll bars which redisplay_windows should have
12071 nuked should now go away. */
12072 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12073 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12075 /* If fonts changed, display again. */
12076 /* ??? rms: I suspect it is a mistake to jump all the way
12077 back to retry here. It should just retry this frame. */
12078 if (fonts_changed_p
)
12081 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12083 /* See if we have to hscroll. */
12084 if (!f
->already_hscrolled_p
)
12086 f
->already_hscrolled_p
= 1;
12087 if (hscroll_windows (f
->root_window
))
12091 /* Prevent various kinds of signals during display
12092 update. stdio is not robust about handling
12093 signals, which can cause an apparent I/O
12095 if (interrupt_input
)
12096 unrequest_sigio ();
12099 /* Update the display. */
12100 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12101 pending
|= update_frame (f
, 0, 0);
12107 if (!EQ (old_frame
, selected_frame
)
12108 && FRAME_LIVE_P (XFRAME (old_frame
)))
12109 /* We played a bit fast-and-loose above and allowed selected_frame
12110 and selected_window to be temporarily out-of-sync but let's make
12111 sure this stays contained. */
12112 select_frame_for_redisplay (old_frame
);
12113 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12117 /* Do the mark_window_display_accurate after all windows have
12118 been redisplayed because this call resets flags in buffers
12119 which are needed for proper redisplay. */
12120 FOR_EACH_FRAME (tail
, frame
)
12122 struct frame
*f
= XFRAME (frame
);
12125 mark_window_display_accurate (f
->root_window
, 1);
12126 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12127 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12132 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12134 Lisp_Object mini_window
;
12135 struct frame
*mini_frame
;
12137 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12138 /* Use list_of_error, not Qerror, so that
12139 we catch only errors and don't run the debugger. */
12140 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12142 redisplay_window_error
);
12144 /* Compare desired and current matrices, perform output. */
12147 /* If fonts changed, display again. */
12148 if (fonts_changed_p
)
12151 /* Prevent various kinds of signals during display update.
12152 stdio is not robust about handling signals,
12153 which can cause an apparent I/O error. */
12154 if (interrupt_input
)
12155 unrequest_sigio ();
12158 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12160 if (hscroll_windows (selected_window
))
12163 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12164 pending
= update_frame (sf
, 0, 0);
12167 /* We may have called echo_area_display at the top of this
12168 function. If the echo area is on another frame, that may
12169 have put text on a frame other than the selected one, so the
12170 above call to update_frame would not have caught it. Catch
12172 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12173 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12175 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12177 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12178 pending
|= update_frame (mini_frame
, 0, 0);
12179 if (!pending
&& hscroll_windows (mini_window
))
12184 /* If display was paused because of pending input, make sure we do a
12185 thorough update the next time. */
12188 /* Prevent the optimization at the beginning of
12189 redisplay_internal that tries a single-line update of the
12190 line containing the cursor in the selected window. */
12191 CHARPOS (this_line_start_pos
) = 0;
12193 /* Let the overlay arrow be updated the next time. */
12194 update_overlay_arrows (0);
12196 /* If we pause after scrolling, some rows in the current
12197 matrices of some windows are not valid. */
12198 if (!WINDOW_FULL_WIDTH_P (w
)
12199 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12200 update_mode_lines
= 1;
12204 if (!consider_all_windows_p
)
12206 /* This has already been done above if
12207 consider_all_windows_p is set. */
12208 mark_window_display_accurate_1 (w
, 1);
12210 /* Say overlay arrows are up to date. */
12211 update_overlay_arrows (1);
12213 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12214 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12217 update_mode_lines
= 0;
12218 windows_or_buffers_changed
= 0;
12219 cursor_type_changed
= 0;
12222 /* Start SIGIO interrupts coming again. Having them off during the
12223 code above makes it less likely one will discard output, but not
12224 impossible, since there might be stuff in the system buffer here.
12225 But it is much hairier to try to do anything about that. */
12226 if (interrupt_input
)
12230 /* If a frame has become visible which was not before, redisplay
12231 again, so that we display it. Expose events for such a frame
12232 (which it gets when becoming visible) don't call the parts of
12233 redisplay constructing glyphs, so simply exposing a frame won't
12234 display anything in this case. So, we have to display these
12235 frames here explicitly. */
12238 Lisp_Object tail
, frame
;
12241 FOR_EACH_FRAME (tail
, frame
)
12243 int this_is_visible
= 0;
12245 if (XFRAME (frame
)->visible
)
12246 this_is_visible
= 1;
12247 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12248 if (XFRAME (frame
)->visible
)
12249 this_is_visible
= 1;
12251 if (this_is_visible
)
12255 if (new_count
!= number_of_visible_frames
)
12256 windows_or_buffers_changed
++;
12259 /* Change frame size now if a change is pending. */
12260 do_pending_window_change (1);
12262 /* If we just did a pending size change, or have additional
12263 visible frames, or selected_window changed, redisplay again. */
12264 if ((windows_or_buffers_changed
&& !pending
)
12265 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12268 /* Clear the face and image caches.
12270 We used to do this only if consider_all_windows_p. But the cache
12271 needs to be cleared if a timer creates images in the current
12272 buffer (e.g. the test case in Bug#6230). */
12274 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12276 clear_face_cache (0);
12277 clear_face_cache_count
= 0;
12280 #ifdef HAVE_WINDOW_SYSTEM
12281 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12283 clear_image_caches (Qnil
);
12284 clear_image_cache_count
= 0;
12286 #endif /* HAVE_WINDOW_SYSTEM */
12289 unbind_to (count
, Qnil
);
12294 /* Redisplay, but leave alone any recent echo area message unless
12295 another message has been requested in its place.
12297 This is useful in situations where you need to redisplay but no
12298 user action has occurred, making it inappropriate for the message
12299 area to be cleared. See tracking_off and
12300 wait_reading_process_output for examples of these situations.
12302 FROM_WHERE is an integer saying from where this function was
12303 called. This is useful for debugging. */
12306 redisplay_preserve_echo_area (int from_where
)
12308 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12310 if (!NILP (echo_area_buffer
[1]))
12312 /* We have a previously displayed message, but no current
12313 message. Redisplay the previous message. */
12314 display_last_displayed_message_p
= 1;
12315 redisplay_internal ();
12316 display_last_displayed_message_p
= 0;
12319 redisplay_internal ();
12321 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12322 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12323 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12327 /* Function registered with record_unwind_protect in
12328 redisplay_internal. Reset redisplaying_p to the value it had
12329 before redisplay_internal was called, and clear
12330 prevent_freeing_realized_faces_p. It also selects the previously
12331 selected frame, unless it has been deleted (by an X connection
12332 failure during redisplay, for example). */
12335 unwind_redisplay (Lisp_Object val
)
12337 Lisp_Object old_redisplaying_p
, old_frame
;
12339 old_redisplaying_p
= XCAR (val
);
12340 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12341 old_frame
= XCDR (val
);
12342 if (! EQ (old_frame
, selected_frame
)
12343 && FRAME_LIVE_P (XFRAME (old_frame
)))
12344 select_frame_for_redisplay (old_frame
);
12349 /* Mark the display of window W as accurate or inaccurate. If
12350 ACCURATE_P is non-zero mark display of W as accurate. If
12351 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12352 redisplay_internal is called. */
12355 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12357 if (BUFFERP (w
->buffer
))
12359 struct buffer
*b
= XBUFFER (w
->buffer
);
12362 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12363 w
->last_overlay_modified
12364 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12366 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12370 b
->clip_changed
= 0;
12371 b
->prevent_redisplay_optimizations_p
= 0;
12373 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12374 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12375 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12376 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12378 w
->current_matrix
->buffer
= b
;
12379 w
->current_matrix
->begv
= BUF_BEGV (b
);
12380 w
->current_matrix
->zv
= BUF_ZV (b
);
12382 w
->last_cursor
= w
->cursor
;
12383 w
->last_cursor_off_p
= w
->cursor_off_p
;
12385 if (w
== XWINDOW (selected_window
))
12386 w
->last_point
= make_number (BUF_PT (b
));
12388 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12394 w
->window_end_valid
= w
->buffer
;
12395 w
->update_mode_line
= Qnil
;
12400 /* Mark the display of windows in the window tree rooted at WINDOW as
12401 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12402 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12403 be redisplayed the next time redisplay_internal is called. */
12406 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12410 for (; !NILP (window
); window
= w
->next
)
12412 w
= XWINDOW (window
);
12413 mark_window_display_accurate_1 (w
, accurate_p
);
12415 if (!NILP (w
->vchild
))
12416 mark_window_display_accurate (w
->vchild
, accurate_p
);
12417 if (!NILP (w
->hchild
))
12418 mark_window_display_accurate (w
->hchild
, accurate_p
);
12423 update_overlay_arrows (1);
12427 /* Force a thorough redisplay the next time by setting
12428 last_arrow_position and last_arrow_string to t, which is
12429 unequal to any useful value of Voverlay_arrow_... */
12430 update_overlay_arrows (-1);
12435 /* Return value in display table DP (Lisp_Char_Table *) for character
12436 C. Since a display table doesn't have any parent, we don't have to
12437 follow parent. Do not call this function directly but use the
12438 macro DISP_CHAR_VECTOR. */
12441 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12445 if (ASCII_CHAR_P (c
))
12448 if (SUB_CHAR_TABLE_P (val
))
12449 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12455 XSETCHAR_TABLE (table
, dp
);
12456 val
= char_table_ref (table
, c
);
12465 /***********************************************************************
12467 ***********************************************************************/
12469 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12472 redisplay_windows (Lisp_Object window
)
12474 while (!NILP (window
))
12476 struct window
*w
= XWINDOW (window
);
12478 if (!NILP (w
->hchild
))
12479 redisplay_windows (w
->hchild
);
12480 else if (!NILP (w
->vchild
))
12481 redisplay_windows (w
->vchild
);
12482 else if (!NILP (w
->buffer
))
12484 displayed_buffer
= XBUFFER (w
->buffer
);
12485 /* Use list_of_error, not Qerror, so that
12486 we catch only errors and don't run the debugger. */
12487 internal_condition_case_1 (redisplay_window_0
, window
,
12489 redisplay_window_error
);
12497 redisplay_window_error (Lisp_Object ignore
)
12499 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12504 redisplay_window_0 (Lisp_Object window
)
12506 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12507 redisplay_window (window
, 0);
12512 redisplay_window_1 (Lisp_Object window
)
12514 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12515 redisplay_window (window
, 1);
12520 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12521 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12522 which positions recorded in ROW differ from current buffer
12525 Return 0 if cursor is not on this row, 1 otherwise. */
12528 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12529 struct glyph_matrix
*matrix
,
12530 EMACS_INT delta
, EMACS_INT delta_bytes
,
12533 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12534 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12535 struct glyph
*cursor
= NULL
;
12536 /* The last known character position in row. */
12537 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12539 EMACS_INT pt_old
= PT
- delta
;
12540 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12541 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12542 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12543 /* A glyph beyond the edge of TEXT_AREA which we should never
12545 struct glyph
*glyphs_end
= end
;
12546 /* Non-zero means we've found a match for cursor position, but that
12547 glyph has the avoid_cursor_p flag set. */
12548 int match_with_avoid_cursor
= 0;
12549 /* Non-zero means we've seen at least one glyph that came from a
12551 int string_seen
= 0;
12552 /* Largest and smalles buffer positions seen so far during scan of
12554 EMACS_INT bpos_max
= pos_before
;
12555 EMACS_INT bpos_min
= pos_after
;
12556 /* Last buffer position covered by an overlay string with an integer
12557 `cursor' property. */
12558 EMACS_INT bpos_covered
= 0;
12560 /* Skip over glyphs not having an object at the start and the end of
12561 the row. These are special glyphs like truncation marks on
12562 terminal frames. */
12563 if (row
->displays_text_p
)
12565 if (!row
->reversed_p
)
12568 && INTEGERP (glyph
->object
)
12569 && glyph
->charpos
< 0)
12571 x
+= glyph
->pixel_width
;
12575 && INTEGERP ((end
- 1)->object
)
12576 /* CHARPOS is zero for blanks and stretch glyphs
12577 inserted by extend_face_to_end_of_line. */
12578 && (end
- 1)->charpos
<= 0)
12580 glyph_before
= glyph
- 1;
12587 /* If the glyph row is reversed, we need to process it from back
12588 to front, so swap the edge pointers. */
12589 glyphs_end
= end
= glyph
- 1;
12590 glyph
+= row
->used
[TEXT_AREA
] - 1;
12592 while (glyph
> end
+ 1
12593 && INTEGERP (glyph
->object
)
12594 && glyph
->charpos
< 0)
12597 x
-= glyph
->pixel_width
;
12599 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12601 /* By default, in reversed rows we put the cursor on the
12602 rightmost (first in the reading order) glyph. */
12603 for (g
= end
+ 1; g
< glyph
; g
++)
12604 x
+= g
->pixel_width
;
12606 && INTEGERP ((end
+ 1)->object
)
12607 && (end
+ 1)->charpos
<= 0)
12609 glyph_before
= glyph
+ 1;
12613 else if (row
->reversed_p
)
12615 /* In R2L rows that don't display text, put the cursor on the
12616 rightmost glyph. Case in point: an empty last line that is
12617 part of an R2L paragraph. */
12619 /* Avoid placing the cursor on the last glyph of the row, where
12620 on terminal frames we hold the vertical border between
12621 adjacent windows. */
12622 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12623 && !WINDOW_RIGHTMOST_P (w
)
12624 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12626 x
= -1; /* will be computed below, at label compute_x */
12629 /* Step 1: Try to find the glyph whose character position
12630 corresponds to point. If that's not possible, find 2 glyphs
12631 whose character positions are the closest to point, one before
12632 point, the other after it. */
12633 if (!row
->reversed_p
)
12634 while (/* not marched to end of glyph row */
12636 /* glyph was not inserted by redisplay for internal purposes */
12637 && !INTEGERP (glyph
->object
))
12639 if (BUFFERP (glyph
->object
))
12641 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12643 if (glyph
->charpos
> bpos_max
)
12644 bpos_max
= glyph
->charpos
;
12645 if (glyph
->charpos
< bpos_min
)
12646 bpos_min
= glyph
->charpos
;
12647 if (!glyph
->avoid_cursor_p
)
12649 /* If we hit point, we've found the glyph on which to
12650 display the cursor. */
12653 match_with_avoid_cursor
= 0;
12656 /* See if we've found a better approximation to
12657 POS_BEFORE or to POS_AFTER. Note that we want the
12658 first (leftmost) glyph of all those that are the
12659 closest from below, and the last (rightmost) of all
12660 those from above. */
12661 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12663 pos_before
= glyph
->charpos
;
12664 glyph_before
= glyph
;
12666 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12668 pos_after
= glyph
->charpos
;
12669 glyph_after
= glyph
;
12672 else if (dpos
== 0)
12673 match_with_avoid_cursor
= 1;
12675 else if (STRINGP (glyph
->object
))
12677 Lisp_Object chprop
;
12678 EMACS_INT glyph_pos
= glyph
->charpos
;
12680 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12682 if (INTEGERP (chprop
))
12684 bpos_covered
= bpos_max
+ XINT (chprop
);
12685 /* If the `cursor' property covers buffer positions up
12686 to and including point, we should display cursor on
12687 this glyph. Note that overlays and text properties
12688 with string values stop bidi reordering, so every
12689 buffer position to the left of the string is always
12690 smaller than any position to the right of the
12691 string. Therefore, if a `cursor' property on one
12692 of the string's characters has an integer value, we
12693 will break out of the loop below _before_ we get to
12694 the position match above. IOW, integer values of
12695 the `cursor' property override the "exact match for
12696 point" strategy of positioning the cursor. */
12697 /* Implementation note: bpos_max == pt_old when, e.g.,
12698 we are in an empty line, where bpos_max is set to
12699 MATRIX_ROW_START_CHARPOS, see above. */
12700 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12709 x
+= glyph
->pixel_width
;
12712 else if (glyph
> end
) /* row is reversed */
12713 while (!INTEGERP (glyph
->object
))
12715 if (BUFFERP (glyph
->object
))
12717 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12719 if (glyph
->charpos
> bpos_max
)
12720 bpos_max
= glyph
->charpos
;
12721 if (glyph
->charpos
< bpos_min
)
12722 bpos_min
= glyph
->charpos
;
12723 if (!glyph
->avoid_cursor_p
)
12727 match_with_avoid_cursor
= 0;
12730 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12732 pos_before
= glyph
->charpos
;
12733 glyph_before
= glyph
;
12735 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12737 pos_after
= glyph
->charpos
;
12738 glyph_after
= glyph
;
12741 else if (dpos
== 0)
12742 match_with_avoid_cursor
= 1;
12744 else if (STRINGP (glyph
->object
))
12746 Lisp_Object chprop
;
12747 EMACS_INT glyph_pos
= glyph
->charpos
;
12749 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12751 if (INTEGERP (chprop
))
12753 bpos_covered
= bpos_max
+ XINT (chprop
);
12754 /* If the `cursor' property covers buffer positions up
12755 to and including point, we should display cursor on
12757 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12766 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12768 x
--; /* can't use any pixel_width */
12771 x
-= glyph
->pixel_width
;
12774 /* Step 2: If we didn't find an exact match for point, we need to
12775 look for a proper place to put the cursor among glyphs between
12776 GLYPH_BEFORE and GLYPH_AFTER. */
12777 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12778 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12779 && bpos_covered
< pt_old
)
12781 /* An empty line has a single glyph whose OBJECT is zero and
12782 whose CHARPOS is the position of a newline on that line.
12783 Note that on a TTY, there are more glyphs after that, which
12784 were produced by extend_face_to_end_of_line, but their
12785 CHARPOS is zero or negative. */
12787 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12788 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
12790 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12792 EMACS_INT ellipsis_pos
;
12794 /* Scan back over the ellipsis glyphs. */
12795 if (!row
->reversed_p
)
12797 ellipsis_pos
= (glyph
- 1)->charpos
;
12798 while (glyph
> row
->glyphs
[TEXT_AREA
]
12799 && (glyph
- 1)->charpos
== ellipsis_pos
)
12800 glyph
--, x
-= glyph
->pixel_width
;
12801 /* That loop always goes one position too far, including
12802 the glyph before the ellipsis. So scan forward over
12804 x
+= glyph
->pixel_width
;
12807 else /* row is reversed */
12809 ellipsis_pos
= (glyph
+ 1)->charpos
;
12810 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12811 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12812 glyph
++, x
+= glyph
->pixel_width
;
12813 x
-= glyph
->pixel_width
;
12817 else if (match_with_avoid_cursor
12818 /* A truncated row may not include PT among its
12819 character positions. Setting the cursor inside the
12820 scroll margin will trigger recalculation of hscroll
12821 in hscroll_window_tree. */
12822 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
12823 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
12824 /* Zero-width characters produce no glyphs. */
12827 && (row
->reversed_p
12828 ? glyph_after
> glyphs_end
12829 : glyph_after
< glyphs_end
)))
12831 cursor
= glyph_after
;
12834 else if (string_seen
)
12836 int incr
= row
->reversed_p
? -1 : +1;
12838 /* Need to find the glyph that came out of a string which is
12839 present at point. That glyph is somewhere between
12840 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12841 positioned between POS_BEFORE and POS_AFTER in the
12843 struct glyph
*start
, *stop
;
12844 EMACS_INT pos
= pos_before
;
12848 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
12849 correspond to POS_BEFORE and POS_AFTER, respectively. We
12850 need START and STOP in the order that corresponds to the
12851 row's direction as given by its reversed_p flag. If the
12852 directionality of characters between POS_BEFORE and
12853 POS_AFTER is the opposite of the row's base direction,
12854 these characters will have been reordered for display,
12855 and we need to reverse START and STOP. */
12856 if (!row
->reversed_p
)
12858 start
= min (glyph_before
, glyph_after
);
12859 stop
= max (glyph_before
, glyph_after
);
12863 start
= max (glyph_before
, glyph_after
);
12864 stop
= min (glyph_before
, glyph_after
);
12866 for (glyph
= start
+ incr
;
12867 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12870 /* Any glyphs that come from the buffer are here because
12871 of bidi reordering. Skip them, and only pay
12872 attention to glyphs that came from some string. */
12873 if (STRINGP (glyph
->object
))
12878 str
= glyph
->object
;
12879 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
12880 if (tem
== 0 /* from overlay */
12883 /* If the string from which this glyph came is
12884 found in the buffer at point, then we've
12885 found the glyph we've been looking for. If
12886 it comes from an overlay (tem == 0), and it
12887 has the `cursor' property on one of its
12888 glyphs, record that glyph as a candidate for
12889 displaying the cursor. (As in the
12890 unidirectional version, we will display the
12891 cursor on the last candidate we find.) */
12892 if (tem
== 0 || tem
== pt_old
)
12894 /* The glyphs from this string could have
12895 been reordered. Find the one with the
12896 smallest string position. Or there could
12897 be a character in the string with the
12898 `cursor' property, which means display
12899 cursor on that character's glyph. */
12900 EMACS_INT strpos
= glyph
->charpos
;
12905 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12906 && EQ (glyph
->object
, str
);
12910 EMACS_INT gpos
= glyph
->charpos
;
12912 cprop
= Fget_char_property (make_number (gpos
),
12920 if (tem
&& glyph
->charpos
< strpos
)
12922 strpos
= glyph
->charpos
;
12931 pos
= tem
+ 1; /* don't find previous instances */
12933 /* This string is not what we want; skip all of the
12934 glyphs that came from it. */
12935 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12936 && EQ (glyph
->object
, str
))
12943 /* If we reached the end of the line, and END was from a string,
12944 the cursor is not on this line. */
12946 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12947 && STRINGP (end
->object
)
12948 && row
->continued_p
)
12954 if (cursor
!= NULL
)
12960 /* Need to compute x that corresponds to GLYPH. */
12961 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12963 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12965 x
+= g
->pixel_width
;
12969 /* ROW could be part of a continued line, which, under bidi
12970 reordering, might have other rows whose start and end charpos
12971 occlude point. Only set w->cursor if we found a better
12972 approximation to the cursor position than we have from previously
12973 examined candidate rows belonging to the same continued line. */
12974 if (/* we already have a candidate row */
12975 w
->cursor
.vpos
>= 0
12976 /* that candidate is not the row we are processing */
12977 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12978 /* the row we are processing is part of a continued line */
12979 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12980 /* Make sure cursor.vpos specifies a row whose start and end
12981 charpos occlude point. This is because some callers of this
12982 function leave cursor.vpos at the row where the cursor was
12983 displayed during the last redisplay cycle. */
12984 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12985 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12988 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12990 /* Don't consider glyphs that are outside TEXT_AREA. */
12991 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12993 /* Keep the candidate whose buffer position is the closest to
12995 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12996 w
->cursor
.hpos
>= 0
12997 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12998 && BUFFERP (g1
->object
)
12999 && (g1
->charpos
== pt_old
/* an exact match always wins */
13000 || (BUFFERP (glyph
->object
)
13001 && eabs (g1
->charpos
- pt_old
)
13002 < eabs (glyph
->charpos
- pt_old
))))
13004 /* If this candidate gives an exact match, use that. */
13005 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13006 /* Otherwise, keep the candidate that comes from a row
13007 spanning less buffer positions. This may win when one or
13008 both candidate positions are on glyphs that came from
13009 display strings, for which we cannot compare buffer
13011 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13012 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13013 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13016 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13018 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13019 w
->cursor
.y
= row
->y
+ dy
;
13021 if (w
== XWINDOW (selected_window
))
13023 if (!row
->continued_p
13024 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13027 this_line_buffer
= XBUFFER (w
->buffer
);
13029 CHARPOS (this_line_start_pos
)
13030 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13031 BYTEPOS (this_line_start_pos
)
13032 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13034 CHARPOS (this_line_end_pos
)
13035 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13036 BYTEPOS (this_line_end_pos
)
13037 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13039 this_line_y
= w
->cursor
.y
;
13040 this_line_pixel_height
= row
->height
;
13041 this_line_vpos
= w
->cursor
.vpos
;
13042 this_line_start_x
= row
->x
;
13045 CHARPOS (this_line_start_pos
) = 0;
13052 /* Run window scroll functions, if any, for WINDOW with new window
13053 start STARTP. Sets the window start of WINDOW to that position.
13055 We assume that the window's buffer is really current. */
13057 static INLINE
struct text_pos
13058 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13060 struct window
*w
= XWINDOW (window
);
13061 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13063 if (current_buffer
!= XBUFFER (w
->buffer
))
13066 if (!NILP (Vwindow_scroll_functions
))
13068 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13069 make_number (CHARPOS (startp
)));
13070 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13071 /* In case the hook functions switch buffers. */
13072 if (current_buffer
!= XBUFFER (w
->buffer
))
13073 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13080 /* Make sure the line containing the cursor is fully visible.
13081 A value of 1 means there is nothing to be done.
13082 (Either the line is fully visible, or it cannot be made so,
13083 or we cannot tell.)
13085 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13086 is higher than window.
13088 A value of 0 means the caller should do scrolling
13089 as if point had gone off the screen. */
13092 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13094 struct glyph_matrix
*matrix
;
13095 struct glyph_row
*row
;
13098 if (!make_cursor_line_fully_visible_p
)
13101 /* It's not always possible to find the cursor, e.g, when a window
13102 is full of overlay strings. Don't do anything in that case. */
13103 if (w
->cursor
.vpos
< 0)
13106 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13107 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13109 /* If the cursor row is not partially visible, there's nothing to do. */
13110 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13113 /* If the row the cursor is in is taller than the window's height,
13114 it's not clear what to do, so do nothing. */
13115 window_height
= window_box_height (w
);
13116 if (row
->height
>= window_height
)
13118 if (!force_p
|| MINI_WINDOW_P (w
)
13119 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13126 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13127 non-zero means only WINDOW is redisplayed in redisplay_internal.
13128 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13129 in redisplay_window to bring a partially visible line into view in
13130 the case that only the cursor has moved.
13132 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13133 last screen line's vertical height extends past the end of the screen.
13137 1 if scrolling succeeded
13139 0 if scrolling didn't find point.
13141 -1 if new fonts have been loaded so that we must interrupt
13142 redisplay, adjust glyph matrices, and try again. */
13148 SCROLLING_NEED_LARGER_MATRICES
13151 /* If scroll-conservatively is more than this, never recenter.
13153 If you change this, don't forget to update the doc string of
13154 `scroll-conservatively' and the Emacs manual. */
13155 #define SCROLL_LIMIT 100
13158 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13159 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13160 int temp_scroll_step
, int last_line_misfit
)
13162 struct window
*w
= XWINDOW (window
);
13163 struct frame
*f
= XFRAME (w
->frame
);
13164 struct text_pos pos
, startp
;
13166 int this_scroll_margin
, scroll_max
, rc
, height
;
13167 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13168 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13169 Lisp_Object aggressive
;
13170 /* We will never try scrolling more than this number of lines. */
13171 int scroll_limit
= SCROLL_LIMIT
;
13174 debug_method_add (w
, "try_scrolling");
13177 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13179 /* Compute scroll margin height in pixels. We scroll when point is
13180 within this distance from the top or bottom of the window. */
13181 if (scroll_margin
> 0)
13182 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13183 * FRAME_LINE_HEIGHT (f
);
13185 this_scroll_margin
= 0;
13187 /* Force arg_scroll_conservatively to have a reasonable value, to
13188 avoid scrolling too far away with slow move_it_* functions. Note
13189 that the user can supply scroll-conservatively equal to
13190 `most-positive-fixnum', which can be larger than INT_MAX. */
13191 if (arg_scroll_conservatively
> scroll_limit
)
13193 arg_scroll_conservatively
= scroll_limit
+ 1;
13194 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13196 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13197 /* Compute how much we should try to scroll maximally to bring
13198 point into view. */
13199 scroll_max
= (max (scroll_step
,
13200 max (arg_scroll_conservatively
, temp_scroll_step
))
13201 * FRAME_LINE_HEIGHT (f
));
13202 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13203 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13204 /* We're trying to scroll because of aggressive scrolling but no
13205 scroll_step is set. Choose an arbitrary one. */
13206 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13212 /* Decide whether to scroll down. */
13213 if (PT
> CHARPOS (startp
))
13215 int scroll_margin_y
;
13217 /* Compute the pixel ypos of the scroll margin, then move it to
13218 either that ypos or PT, whichever comes first. */
13219 start_display (&it
, w
, startp
);
13220 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13221 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13222 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13223 (MOVE_TO_POS
| MOVE_TO_Y
));
13225 if (PT
> CHARPOS (it
.current
.pos
))
13227 int y0
= line_bottom_y (&it
);
13228 /* Compute how many pixels below window bottom to stop searching
13229 for PT. This avoids costly search for PT that is far away if
13230 the user limited scrolling by a small number of lines, but
13231 always finds PT if scroll_conservatively is set to a large
13232 number, such as most-positive-fixnum. */
13233 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13234 int y_to_move
= it
.last_visible_y
+ slack
;
13236 /* Compute the distance from the scroll margin to PT or to
13237 the scroll limit, whichever comes first. This should
13238 include the height of the cursor line, to make that line
13240 move_it_to (&it
, PT
, -1, y_to_move
,
13241 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13242 dy
= line_bottom_y (&it
) - y0
;
13244 if (dy
> scroll_max
)
13245 return SCROLLING_FAILED
;
13253 /* Point is in or below the bottom scroll margin, so move the
13254 window start down. If scrolling conservatively, move it just
13255 enough down to make point visible. If scroll_step is set,
13256 move it down by scroll_step. */
13257 if (arg_scroll_conservatively
)
13259 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13260 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13261 else if (scroll_step
|| temp_scroll_step
)
13262 amount_to_scroll
= scroll_max
;
13265 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13266 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13267 if (NUMBERP (aggressive
))
13269 double float_amount
= XFLOATINT (aggressive
) * height
;
13270 amount_to_scroll
= float_amount
;
13271 if (amount_to_scroll
== 0 && float_amount
> 0)
13272 amount_to_scroll
= 1;
13273 /* Don't let point enter the scroll margin near top of
13275 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13276 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13280 if (amount_to_scroll
<= 0)
13281 return SCROLLING_FAILED
;
13283 start_display (&it
, w
, startp
);
13284 if (arg_scroll_conservatively
<= scroll_limit
)
13285 move_it_vertically (&it
, amount_to_scroll
);
13288 /* Extra precision for users who set scroll-conservatively
13289 to a large number: make sure the amount we scroll
13290 the window start is never less than amount_to_scroll,
13291 which was computed as distance from window bottom to
13292 point. This matters when lines at window top and lines
13293 below window bottom have different height. */
13294 struct it it1
= it
;
13295 /* We use a temporary it1 because line_bottom_y can modify
13296 its argument, if it moves one line down; see there. */
13297 int start_y
= line_bottom_y (&it1
);
13300 move_it_by_lines (&it
, 1);
13302 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13305 /* If STARTP is unchanged, move it down another screen line. */
13306 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13307 move_it_by_lines (&it
, 1);
13308 startp
= it
.current
.pos
;
13312 struct text_pos scroll_margin_pos
= startp
;
13314 /* See if point is inside the scroll margin at the top of the
13316 if (this_scroll_margin
)
13318 start_display (&it
, w
, startp
);
13319 move_it_vertically (&it
, this_scroll_margin
);
13320 scroll_margin_pos
= it
.current
.pos
;
13323 if (PT
< CHARPOS (scroll_margin_pos
))
13325 /* Point is in the scroll margin at the top of the window or
13326 above what is displayed in the window. */
13329 /* Compute the vertical distance from PT to the scroll
13330 margin position. Move as far as scroll_max allows, or
13331 one screenful, or 10 screen lines, whichever is largest.
13332 Give up if distance is greater than scroll_max. */
13333 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13334 start_display (&it
, w
, pos
);
13336 y_to_move
= max (it
.last_visible_y
,
13337 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
13338 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13340 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13341 dy
= it
.current_y
- y0
;
13342 if (dy
> scroll_max
)
13343 return SCROLLING_FAILED
;
13345 /* Compute new window start. */
13346 start_display (&it
, w
, startp
);
13348 if (arg_scroll_conservatively
)
13349 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
13350 max (scroll_step
, temp_scroll_step
));
13351 else if (scroll_step
|| temp_scroll_step
)
13352 amount_to_scroll
= scroll_max
;
13355 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
13356 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13357 if (NUMBERP (aggressive
))
13359 double float_amount
= XFLOATINT (aggressive
) * height
;
13360 amount_to_scroll
= float_amount
;
13361 if (amount_to_scroll
== 0 && float_amount
> 0)
13362 amount_to_scroll
= 1;
13363 amount_to_scroll
-=
13364 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
13365 /* Don't let point enter the scroll margin near
13366 bottom of the window. */
13367 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
13368 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
13372 if (amount_to_scroll
<= 0)
13373 return SCROLLING_FAILED
;
13375 move_it_vertically_backward (&it
, amount_to_scroll
);
13376 startp
= it
.current
.pos
;
13380 /* Run window scroll functions. */
13381 startp
= run_window_scroll_functions (window
, startp
);
13383 /* Display the window. Give up if new fonts are loaded, or if point
13385 if (!try_window (window
, startp
, 0))
13386 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13387 else if (w
->cursor
.vpos
< 0)
13389 clear_glyph_matrix (w
->desired_matrix
);
13390 rc
= SCROLLING_FAILED
;
13394 /* Maybe forget recorded base line for line number display. */
13395 if (!just_this_one_p
13396 || current_buffer
->clip_changed
13397 || BEG_UNCHANGED
< CHARPOS (startp
))
13398 w
->base_line_number
= Qnil
;
13400 /* If cursor ends up on a partially visible line,
13401 treat that as being off the bottom of the screen. */
13402 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
13403 /* It's possible that the cursor is on the first line of the
13404 buffer, which is partially obscured due to a vscroll
13405 (Bug#7537). In that case, avoid looping forever . */
13406 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
13408 clear_glyph_matrix (w
->desired_matrix
);
13409 ++extra_scroll_margin_lines
;
13412 rc
= SCROLLING_SUCCESS
;
13419 /* Compute a suitable window start for window W if display of W starts
13420 on a continuation line. Value is non-zero if a new window start
13423 The new window start will be computed, based on W's width, starting
13424 from the start of the continued line. It is the start of the
13425 screen line with the minimum distance from the old start W->start. */
13428 compute_window_start_on_continuation_line (struct window
*w
)
13430 struct text_pos pos
, start_pos
;
13431 int window_start_changed_p
= 0;
13433 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13435 /* If window start is on a continuation line... Window start may be
13436 < BEGV in case there's invisible text at the start of the
13437 buffer (M-x rmail, for example). */
13438 if (CHARPOS (start_pos
) > BEGV
13439 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13442 struct glyph_row
*row
;
13444 /* Handle the case that the window start is out of range. */
13445 if (CHARPOS (start_pos
) < BEGV
)
13446 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13447 else if (CHARPOS (start_pos
) > ZV
)
13448 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13450 /* Find the start of the continued line. This should be fast
13451 because scan_buffer is fast (newline cache). */
13452 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13453 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13454 row
, DEFAULT_FACE_ID
);
13455 reseat_at_previous_visible_line_start (&it
);
13457 /* If the line start is "too far" away from the window start,
13458 say it takes too much time to compute a new window start. */
13459 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13460 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13462 int min_distance
, distance
;
13464 /* Move forward by display lines to find the new window
13465 start. If window width was enlarged, the new start can
13466 be expected to be > the old start. If window width was
13467 decreased, the new window start will be < the old start.
13468 So, we're looking for the display line start with the
13469 minimum distance from the old window start. */
13470 pos
= it
.current
.pos
;
13471 min_distance
= INFINITY
;
13472 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13473 distance
< min_distance
)
13475 min_distance
= distance
;
13476 pos
= it
.current
.pos
;
13477 move_it_by_lines (&it
, 1);
13480 /* Set the window start there. */
13481 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13482 window_start_changed_p
= 1;
13486 return window_start_changed_p
;
13490 /* Try cursor movement in case text has not changed in window WINDOW,
13491 with window start STARTP. Value is
13493 CURSOR_MOVEMENT_SUCCESS if successful
13495 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13497 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13498 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13499 we want to scroll as if scroll-step were set to 1. See the code.
13501 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13502 which case we have to abort this redisplay, and adjust matrices
13507 CURSOR_MOVEMENT_SUCCESS
,
13508 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13509 CURSOR_MOVEMENT_MUST_SCROLL
,
13510 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13514 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13516 struct window
*w
= XWINDOW (window
);
13517 struct frame
*f
= XFRAME (w
->frame
);
13518 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13521 if (inhibit_try_cursor_movement
)
13525 /* Handle case where text has not changed, only point, and it has
13526 not moved off the frame. */
13527 if (/* Point may be in this window. */
13528 PT
>= CHARPOS (startp
)
13529 /* Selective display hasn't changed. */
13530 && !current_buffer
->clip_changed
13531 /* Function force-mode-line-update is used to force a thorough
13532 redisplay. It sets either windows_or_buffers_changed or
13533 update_mode_lines. So don't take a shortcut here for these
13535 && !update_mode_lines
13536 && !windows_or_buffers_changed
13537 && !cursor_type_changed
13538 /* Can't use this case if highlighting a region. When a
13539 region exists, cursor movement has to do more than just
13541 && !(!NILP (Vtransient_mark_mode
)
13542 && !NILP (BVAR (current_buffer
, mark_active
)))
13543 && NILP (w
->region_showing
)
13544 && NILP (Vshow_trailing_whitespace
)
13545 /* Right after splitting windows, last_point may be nil. */
13546 && INTEGERP (w
->last_point
)
13547 /* This code is not used for mini-buffer for the sake of the case
13548 of redisplaying to replace an echo area message; since in
13549 that case the mini-buffer contents per se are usually
13550 unchanged. This code is of no real use in the mini-buffer
13551 since the handling of this_line_start_pos, etc., in redisplay
13552 handles the same cases. */
13553 && !EQ (window
, minibuf_window
)
13554 /* When splitting windows or for new windows, it happens that
13555 redisplay is called with a nil window_end_vpos or one being
13556 larger than the window. This should really be fixed in
13557 window.c. I don't have this on my list, now, so we do
13558 approximately the same as the old redisplay code. --gerd. */
13559 && INTEGERP (w
->window_end_vpos
)
13560 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13561 && (FRAME_WINDOW_P (f
)
13562 || !overlay_arrow_in_current_buffer_p ()))
13564 int this_scroll_margin
, top_scroll_margin
;
13565 struct glyph_row
*row
= NULL
;
13568 debug_method_add (w
, "cursor movement");
13571 /* Scroll if point within this distance from the top or bottom
13572 of the window. This is a pixel value. */
13573 if (scroll_margin
> 0)
13575 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13576 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13579 this_scroll_margin
= 0;
13581 top_scroll_margin
= this_scroll_margin
;
13582 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13583 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13585 /* Start with the row the cursor was displayed during the last
13586 not paused redisplay. Give up if that row is not valid. */
13587 if (w
->last_cursor
.vpos
< 0
13588 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13589 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13592 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13593 if (row
->mode_line_p
)
13595 if (!row
->enabled_p
)
13596 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13599 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13601 int scroll_p
= 0, must_scroll
= 0;
13602 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13604 if (PT
> XFASTINT (w
->last_point
))
13606 /* Point has moved forward. */
13607 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13608 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13610 xassert (row
->enabled_p
);
13614 /* If the end position of a row equals the start
13615 position of the next row, and PT is at that position,
13616 we would rather display cursor in the next line. */
13617 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13618 && MATRIX_ROW_END_CHARPOS (row
) == PT
13619 && row
< w
->current_matrix
->rows
13620 + w
->current_matrix
->nrows
- 1
13621 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13622 && !cursor_row_p (row
))
13625 /* If within the scroll margin, scroll. Note that
13626 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13627 the next line would be drawn, and that
13628 this_scroll_margin can be zero. */
13629 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13630 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13631 /* Line is completely visible last line in window
13632 and PT is to be set in the next line. */
13633 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13634 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13635 && !row
->ends_at_zv_p
13636 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13639 else if (PT
< XFASTINT (w
->last_point
))
13641 /* Cursor has to be moved backward. Note that PT >=
13642 CHARPOS (startp) because of the outer if-statement. */
13643 while (!row
->mode_line_p
13644 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13645 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13646 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13647 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13648 row
> w
->current_matrix
->rows
13649 && (row
-1)->ends_in_newline_from_string_p
))))
13650 && (row
->y
> top_scroll_margin
13651 || CHARPOS (startp
) == BEGV
))
13653 xassert (row
->enabled_p
);
13657 /* Consider the following case: Window starts at BEGV,
13658 there is invisible, intangible text at BEGV, so that
13659 display starts at some point START > BEGV. It can
13660 happen that we are called with PT somewhere between
13661 BEGV and START. Try to handle that case. */
13662 if (row
< w
->current_matrix
->rows
13663 || row
->mode_line_p
)
13665 row
= w
->current_matrix
->rows
;
13666 if (row
->mode_line_p
)
13670 /* Due to newlines in overlay strings, we may have to
13671 skip forward over overlay strings. */
13672 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13673 && MATRIX_ROW_END_CHARPOS (row
) == PT
13674 && !cursor_row_p (row
))
13677 /* If within the scroll margin, scroll. */
13678 if (row
->y
< top_scroll_margin
13679 && CHARPOS (startp
) != BEGV
)
13684 /* Cursor did not move. So don't scroll even if cursor line
13685 is partially visible, as it was so before. */
13686 rc
= CURSOR_MOVEMENT_SUCCESS
;
13689 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13690 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13692 /* if PT is not in the glyph row, give up. */
13693 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13696 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13697 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13699 /* If rows are bidi-reordered and point moved, back up
13700 until we find a row that does not belong to a
13701 continuation line. This is because we must consider
13702 all rows of a continued line as candidates for the
13703 new cursor positioning, since row start and end
13704 positions change non-linearly with vertical position
13706 /* FIXME: Revisit this when glyph ``spilling'' in
13707 continuation lines' rows is implemented for
13708 bidi-reordered rows. */
13709 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13711 xassert (row
->enabled_p
);
13713 /* If we hit the beginning of the displayed portion
13714 without finding the first row of a continued
13716 if (row
<= w
->current_matrix
->rows
)
13718 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13726 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13727 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13728 && make_cursor_line_fully_visible_p
)
13730 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13731 && !row
->ends_at_zv_p
13732 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13733 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13734 else if (row
->height
> window_box_height (w
))
13736 /* If we end up in a partially visible line, let's
13737 make it fully visible, except when it's taller
13738 than the window, in which case we can't do much
13741 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13745 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13746 if (!cursor_row_fully_visible_p (w
, 0, 1))
13747 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13749 rc
= CURSOR_MOVEMENT_SUCCESS
;
13753 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13754 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13755 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
13757 /* With bidi-reordered rows, there could be more than
13758 one candidate row whose start and end positions
13759 occlude point. We need to let set_cursor_from_row
13760 find the best candidate. */
13761 /* FIXME: Revisit this when glyph ``spilling'' in
13762 continuation lines' rows is implemented for
13763 bidi-reordered rows. */
13768 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13769 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13770 && cursor_row_p (row
))
13771 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13773 /* As soon as we've found the first suitable row
13774 whose ends_at_zv_p flag is set, we are done. */
13776 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13778 rc
= CURSOR_MOVEMENT_SUCCESS
;
13783 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13784 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13785 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13786 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13787 /* If we didn't find any candidate rows, or exited the
13788 loop before all the candidates were examined, signal
13789 to the caller that this method failed. */
13790 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13791 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13792 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13794 rc
= CURSOR_MOVEMENT_SUCCESS
;
13800 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13802 rc
= CURSOR_MOVEMENT_SUCCESS
;
13807 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13808 && MATRIX_ROW_START_CHARPOS (row
) == PT
13809 && cursor_row_p (row
));
13817 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
13821 set_vertical_scroll_bar (struct window
*w
)
13823 EMACS_INT start
, end
, whole
;
13825 /* Calculate the start and end positions for the current window.
13826 At some point, it would be nice to choose between scrollbars
13827 which reflect the whole buffer size, with special markers
13828 indicating narrowing, and scrollbars which reflect only the
13831 Note that mini-buffers sometimes aren't displaying any text. */
13832 if (!MINI_WINDOW_P (w
)
13833 || (w
== XWINDOW (minibuf_window
)
13834 && NILP (echo_area_buffer
[0])))
13836 struct buffer
*buf
= XBUFFER (w
->buffer
);
13837 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13838 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13839 /* I don't think this is guaranteed to be right. For the
13840 moment, we'll pretend it is. */
13841 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13845 if (whole
< (end
- start
))
13846 whole
= end
- start
;
13849 start
= end
= whole
= 0;
13851 /* Indicate what this scroll bar ought to be displaying now. */
13852 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13853 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13854 (w
, end
- start
, whole
, start
);
13858 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13859 selected_window is redisplayed.
13861 We can return without actually redisplaying the window if
13862 fonts_changed_p is nonzero. In that case, redisplay_internal will
13866 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13868 struct window
*w
= XWINDOW (window
);
13869 struct frame
*f
= XFRAME (w
->frame
);
13870 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13871 struct buffer
*old
= current_buffer
;
13872 struct text_pos lpoint
, opoint
, startp
;
13873 int update_mode_line
;
13876 /* Record it now because it's overwritten. */
13877 int current_matrix_up_to_date_p
= 0;
13878 int used_current_matrix_p
= 0;
13879 /* This is less strict than current_matrix_up_to_date_p.
13880 It indictes that the buffer contents and narrowing are unchanged. */
13881 int buffer_unchanged_p
= 0;
13882 int temp_scroll_step
= 0;
13883 int count
= SPECPDL_INDEX ();
13885 int centering_position
= -1;
13886 int last_line_misfit
= 0;
13887 EMACS_INT beg_unchanged
, end_unchanged
;
13889 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13892 /* W must be a leaf window here. */
13893 xassert (!NILP (w
->buffer
));
13895 *w
->desired_matrix
->method
= 0;
13899 reconsider_clip_changes (w
, buffer
);
13901 /* Has the mode line to be updated? */
13902 update_mode_line
= (!NILP (w
->update_mode_line
)
13903 || update_mode_lines
13904 || buffer
->clip_changed
13905 || buffer
->prevent_redisplay_optimizations_p
);
13907 if (MINI_WINDOW_P (w
))
13909 if (w
== XWINDOW (echo_area_window
)
13910 && !NILP (echo_area_buffer
[0]))
13912 if (update_mode_line
)
13913 /* We may have to update a tty frame's menu bar or a
13914 tool-bar. Example `M-x C-h C-h C-g'. */
13915 goto finish_menu_bars
;
13917 /* We've already displayed the echo area glyphs in this window. */
13918 goto finish_scroll_bars
;
13920 else if ((w
!= XWINDOW (minibuf_window
)
13921 || minibuf_level
== 0)
13922 /* When buffer is nonempty, redisplay window normally. */
13923 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13924 /* Quail displays non-mini buffers in minibuffer window.
13925 In that case, redisplay the window normally. */
13926 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13928 /* W is a mini-buffer window, but it's not active, so clear
13930 int yb
= window_text_bottom_y (w
);
13931 struct glyph_row
*row
;
13934 for (y
= 0, row
= w
->desired_matrix
->rows
;
13936 y
+= row
->height
, ++row
)
13937 blank_row (w
, row
, y
);
13938 goto finish_scroll_bars
;
13941 clear_glyph_matrix (w
->desired_matrix
);
13944 /* Otherwise set up data on this window; select its buffer and point
13946 /* Really select the buffer, for the sake of buffer-local
13948 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13950 current_matrix_up_to_date_p
13951 = (!NILP (w
->window_end_valid
)
13952 && !current_buffer
->clip_changed
13953 && !current_buffer
->prevent_redisplay_optimizations_p
13954 && XFASTINT (w
->last_modified
) >= MODIFF
13955 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13957 /* Run the window-bottom-change-functions
13958 if it is possible that the text on the screen has changed
13959 (either due to modification of the text, or any other reason). */
13960 if (!current_matrix_up_to_date_p
13961 && !NILP (Vwindow_text_change_functions
))
13963 safe_run_hooks (Qwindow_text_change_functions
);
13967 beg_unchanged
= BEG_UNCHANGED
;
13968 end_unchanged
= END_UNCHANGED
;
13970 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13972 specbind (Qinhibit_point_motion_hooks
, Qt
);
13975 = (!NILP (w
->window_end_valid
)
13976 && !current_buffer
->clip_changed
13977 && XFASTINT (w
->last_modified
) >= MODIFF
13978 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13980 /* When windows_or_buffers_changed is non-zero, we can't rely on
13981 the window end being valid, so set it to nil there. */
13982 if (windows_or_buffers_changed
)
13984 /* If window starts on a continuation line, maybe adjust the
13985 window start in case the window's width changed. */
13986 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13987 compute_window_start_on_continuation_line (w
);
13989 w
->window_end_valid
= Qnil
;
13992 /* Some sanity checks. */
13993 CHECK_WINDOW_END (w
);
13994 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13996 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13999 /* If %c is in mode line, update it if needed. */
14000 if (!NILP (w
->column_number_displayed
)
14001 /* This alternative quickly identifies a common case
14002 where no change is needed. */
14003 && !(PT
== XFASTINT (w
->last_point
)
14004 && XFASTINT (w
->last_modified
) >= MODIFF
14005 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14006 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14007 update_mode_line
= 1;
14009 /* Count number of windows showing the selected buffer. An indirect
14010 buffer counts as its base buffer. */
14011 if (!just_this_one_p
)
14013 struct buffer
*current_base
, *window_base
;
14014 current_base
= current_buffer
;
14015 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14016 if (current_base
->base_buffer
)
14017 current_base
= current_base
->base_buffer
;
14018 if (window_base
->base_buffer
)
14019 window_base
= window_base
->base_buffer
;
14020 if (current_base
== window_base
)
14024 /* Point refers normally to the selected window. For any other
14025 window, set up appropriate value. */
14026 if (!EQ (window
, selected_window
))
14028 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14029 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14033 new_pt_byte
= BEGV_BYTE
;
14034 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14036 else if (new_pt
> (ZV
- 1))
14039 new_pt_byte
= ZV_BYTE
;
14040 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14043 /* We don't use SET_PT so that the point-motion hooks don't run. */
14044 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14047 /* If any of the character widths specified in the display table
14048 have changed, invalidate the width run cache. It's true that
14049 this may be a bit late to catch such changes, but the rest of
14050 redisplay goes (non-fatally) haywire when the display table is
14051 changed, so why should we worry about doing any better? */
14052 if (current_buffer
->width_run_cache
)
14054 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14056 if (! disptab_matches_widthtab (disptab
,
14057 XVECTOR (BVAR (current_buffer
, width_table
))))
14059 invalidate_region_cache (current_buffer
,
14060 current_buffer
->width_run_cache
,
14062 recompute_width_table (current_buffer
, disptab
);
14066 /* If window-start is screwed up, choose a new one. */
14067 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14070 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14072 /* If someone specified a new starting point but did not insist,
14073 check whether it can be used. */
14074 if (!NILP (w
->optional_new_start
)
14075 && CHARPOS (startp
) >= BEGV
14076 && CHARPOS (startp
) <= ZV
)
14078 w
->optional_new_start
= Qnil
;
14079 start_display (&it
, w
, startp
);
14080 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14081 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14082 if (IT_CHARPOS (it
) == PT
)
14083 w
->force_start
= Qt
;
14084 /* IT may overshoot PT if text at PT is invisible. */
14085 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14086 w
->force_start
= Qt
;
14091 /* Handle case where place to start displaying has been specified,
14092 unless the specified location is outside the accessible range. */
14093 if (!NILP (w
->force_start
)
14094 || w
->frozen_window_start_p
)
14096 /* We set this later on if we have to adjust point. */
14099 w
->force_start
= Qnil
;
14101 w
->window_end_valid
= Qnil
;
14103 /* Forget any recorded base line for line number display. */
14104 if (!buffer_unchanged_p
)
14105 w
->base_line_number
= Qnil
;
14107 /* Redisplay the mode line. Select the buffer properly for that.
14108 Also, run the hook window-scroll-functions
14109 because we have scrolled. */
14110 /* Note, we do this after clearing force_start because
14111 if there's an error, it is better to forget about force_start
14112 than to get into an infinite loop calling the hook functions
14113 and having them get more errors. */
14114 if (!update_mode_line
14115 || ! NILP (Vwindow_scroll_functions
))
14117 update_mode_line
= 1;
14118 w
->update_mode_line
= Qt
;
14119 startp
= run_window_scroll_functions (window
, startp
);
14122 w
->last_modified
= make_number (0);
14123 w
->last_overlay_modified
= make_number (0);
14124 if (CHARPOS (startp
) < BEGV
)
14125 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14126 else if (CHARPOS (startp
) > ZV
)
14127 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14129 /* Redisplay, then check if cursor has been set during the
14130 redisplay. Give up if new fonts were loaded. */
14131 /* We used to issue a CHECK_MARGINS argument to try_window here,
14132 but this causes scrolling to fail when point begins inside
14133 the scroll margin (bug#148) -- cyd */
14134 if (!try_window (window
, startp
, 0))
14136 w
->force_start
= Qt
;
14137 clear_glyph_matrix (w
->desired_matrix
);
14138 goto need_larger_matrices
;
14141 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14143 /* If point does not appear, try to move point so it does
14144 appear. The desired matrix has been built above, so we
14145 can use it here. */
14146 new_vpos
= window_box_height (w
) / 2;
14149 if (!cursor_row_fully_visible_p (w
, 0, 0))
14151 /* Point does appear, but on a line partly visible at end of window.
14152 Move it back to a fully-visible line. */
14153 new_vpos
= window_box_height (w
);
14156 /* If we need to move point for either of the above reasons,
14157 now actually do it. */
14160 struct glyph_row
*row
;
14162 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14163 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14166 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14167 MATRIX_ROW_START_BYTEPOS (row
));
14169 if (w
!= XWINDOW (selected_window
))
14170 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14171 else if (current_buffer
== old
)
14172 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14174 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14176 /* If we are highlighting the region, then we just changed
14177 the region, so redisplay to show it. */
14178 if (!NILP (Vtransient_mark_mode
)
14179 && !NILP (BVAR (current_buffer
, mark_active
)))
14181 clear_glyph_matrix (w
->desired_matrix
);
14182 if (!try_window (window
, startp
, 0))
14183 goto need_larger_matrices
;
14188 debug_method_add (w
, "forced window start");
14193 /* Handle case where text has not changed, only point, and it has
14194 not moved off the frame, and we are not retrying after hscroll.
14195 (current_matrix_up_to_date_p is nonzero when retrying.) */
14196 if (current_matrix_up_to_date_p
14197 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14198 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14202 case CURSOR_MOVEMENT_SUCCESS
:
14203 used_current_matrix_p
= 1;
14206 case CURSOR_MOVEMENT_MUST_SCROLL
:
14207 goto try_to_scroll
;
14213 /* If current starting point was originally the beginning of a line
14214 but no longer is, find a new starting point. */
14215 else if (!NILP (w
->start_at_line_beg
)
14216 && !(CHARPOS (startp
) <= BEGV
14217 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14220 debug_method_add (w
, "recenter 1");
14225 /* Try scrolling with try_window_id. Value is > 0 if update has
14226 been done, it is -1 if we know that the same window start will
14227 not work. It is 0 if unsuccessful for some other reason. */
14228 else if ((tem
= try_window_id (w
)) != 0)
14231 debug_method_add (w
, "try_window_id %d", tem
);
14234 if (fonts_changed_p
)
14235 goto need_larger_matrices
;
14239 /* Otherwise try_window_id has returned -1 which means that we
14240 don't want the alternative below this comment to execute. */
14242 else if (CHARPOS (startp
) >= BEGV
14243 && CHARPOS (startp
) <= ZV
14244 && PT
>= CHARPOS (startp
)
14245 && (CHARPOS (startp
) < ZV
14246 /* Avoid starting at end of buffer. */
14247 || CHARPOS (startp
) == BEGV
14248 || (XFASTINT (w
->last_modified
) >= MODIFF
14249 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14252 /* If first window line is a continuation line, and window start
14253 is inside the modified region, but the first change is before
14254 current window start, we must select a new window start.
14256 However, if this is the result of a down-mouse event (e.g. by
14257 extending the mouse-drag-overlay), we don't want to select a
14258 new window start, since that would change the position under
14259 the mouse, resulting in an unwanted mouse-movement rather
14260 than a simple mouse-click. */
14261 if (NILP (w
->start_at_line_beg
)
14262 && NILP (do_mouse_tracking
)
14263 && CHARPOS (startp
) > BEGV
14264 && CHARPOS (startp
) > BEG
+ beg_unchanged
14265 && CHARPOS (startp
) <= Z
- end_unchanged
14266 /* Even if w->start_at_line_beg is nil, a new window may
14267 start at a line_beg, since that's how set_buffer_window
14268 sets it. So, we need to check the return value of
14269 compute_window_start_on_continuation_line. (See also
14271 && XMARKER (w
->start
)->buffer
== current_buffer
14272 && compute_window_start_on_continuation_line (w
))
14274 w
->force_start
= Qt
;
14275 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14280 debug_method_add (w
, "same window start");
14283 /* Try to redisplay starting at same place as before.
14284 If point has not moved off frame, accept the results. */
14285 if (!current_matrix_up_to_date_p
14286 /* Don't use try_window_reusing_current_matrix in this case
14287 because a window scroll function can have changed the
14289 || !NILP (Vwindow_scroll_functions
)
14290 || MINI_WINDOW_P (w
)
14291 || !(used_current_matrix_p
14292 = try_window_reusing_current_matrix (w
)))
14294 IF_DEBUG (debug_method_add (w
, "1"));
14295 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14296 /* -1 means we need to scroll.
14297 0 means we need new matrices, but fonts_changed_p
14298 is set in that case, so we will detect it below. */
14299 goto try_to_scroll
;
14302 if (fonts_changed_p
)
14303 goto need_larger_matrices
;
14305 if (w
->cursor
.vpos
>= 0)
14307 if (!just_this_one_p
14308 || current_buffer
->clip_changed
14309 || BEG_UNCHANGED
< CHARPOS (startp
))
14310 /* Forget any recorded base line for line number display. */
14311 w
->base_line_number
= Qnil
;
14313 if (!cursor_row_fully_visible_p (w
, 1, 0))
14315 clear_glyph_matrix (w
->desired_matrix
);
14316 last_line_misfit
= 1;
14318 /* Drop through and scroll. */
14323 clear_glyph_matrix (w
->desired_matrix
);
14328 w
->last_modified
= make_number (0);
14329 w
->last_overlay_modified
= make_number (0);
14331 /* Redisplay the mode line. Select the buffer properly for that. */
14332 if (!update_mode_line
)
14334 update_mode_line
= 1;
14335 w
->update_mode_line
= Qt
;
14338 /* Try to scroll by specified few lines. */
14339 if ((scroll_conservatively
14340 || emacs_scroll_step
14341 || temp_scroll_step
14342 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
14343 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
14344 && CHARPOS (startp
) >= BEGV
14345 && CHARPOS (startp
) <= ZV
)
14347 /* The function returns -1 if new fonts were loaded, 1 if
14348 successful, 0 if not successful. */
14349 int ss
= try_scrolling (window
, just_this_one_p
,
14350 scroll_conservatively
,
14352 temp_scroll_step
, last_line_misfit
);
14355 case SCROLLING_SUCCESS
:
14358 case SCROLLING_NEED_LARGER_MATRICES
:
14359 goto need_larger_matrices
;
14361 case SCROLLING_FAILED
:
14369 /* Finally, just choose a place to start which positions point
14370 according to user preferences. */
14375 debug_method_add (w
, "recenter");
14378 /* w->vscroll = 0; */
14380 /* Forget any previously recorded base line for line number display. */
14381 if (!buffer_unchanged_p
)
14382 w
->base_line_number
= Qnil
;
14384 /* Determine the window start relative to point. */
14385 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14386 it
.current_y
= it
.last_visible_y
;
14387 if (centering_position
< 0)
14391 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14393 EMACS_INT margin_pos
= CHARPOS (startp
);
14395 Lisp_Object aggressive
;
14397 /* If there is a scroll margin at the top of the window, find
14398 its character position. */
14400 /* Cannot call start_display if startp is not in the
14401 accessible region of the buffer. This can happen when we
14402 have just switched to a different buffer and/or changed
14403 its restriction. In that case, startp is initialized to
14404 the character position 1 (BEG) because we did not yet
14405 have chance to display the buffer even once. */
14406 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
14410 start_display (&it1
, w
, startp
);
14411 move_it_vertically (&it1
, margin
);
14412 margin_pos
= IT_CHARPOS (it1
);
14414 scrolling_up
= PT
> margin_pos
;
14417 ? BVAR (current_buffer
, scroll_up_aggressively
)
14418 : BVAR (current_buffer
, scroll_down_aggressively
);
14420 if (!MINI_WINDOW_P (w
)
14421 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
14425 /* Setting scroll-conservatively overrides
14426 scroll-*-aggressively. */
14427 if (!scroll_conservatively
&& NUMBERP (aggressive
))
14429 double float_amount
= XFLOATINT (aggressive
);
14431 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
14432 if (pt_offset
== 0 && float_amount
> 0)
14437 /* Compute how much to move the window start backward from
14438 point so that point will be displayed where the user
14442 centering_position
= it
.last_visible_y
;
14444 centering_position
-= pt_offset
;
14445 centering_position
-=
14446 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
14447 /* Don't let point enter the scroll margin near top of
14449 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
14450 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
14453 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
14456 /* Set the window start half the height of the window backward
14458 centering_position
= window_box_height (w
) / 2;
14460 move_it_vertically_backward (&it
, centering_position
);
14462 xassert (IT_CHARPOS (it
) >= BEGV
);
14464 /* The function move_it_vertically_backward may move over more
14465 than the specified y-distance. If it->w is small, e.g. a
14466 mini-buffer window, we may end up in front of the window's
14467 display area. Start displaying at the start of the line
14468 containing PT in this case. */
14469 if (it
.current_y
<= 0)
14471 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14472 move_it_vertically_backward (&it
, 0);
14476 it
.current_x
= it
.hpos
= 0;
14478 /* Set the window start position here explicitly, to avoid an
14479 infinite loop in case the functions in window-scroll-functions
14481 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14483 /* Run scroll hooks. */
14484 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14486 /* Redisplay the window. */
14487 if (!current_matrix_up_to_date_p
14488 || windows_or_buffers_changed
14489 || cursor_type_changed
14490 /* Don't use try_window_reusing_current_matrix in this case
14491 because it can have changed the buffer. */
14492 || !NILP (Vwindow_scroll_functions
)
14493 || !just_this_one_p
14494 || MINI_WINDOW_P (w
)
14495 || !(used_current_matrix_p
14496 = try_window_reusing_current_matrix (w
)))
14497 try_window (window
, startp
, 0);
14499 /* If new fonts have been loaded (due to fontsets), give up. We
14500 have to start a new redisplay since we need to re-adjust glyph
14502 if (fonts_changed_p
)
14503 goto need_larger_matrices
;
14505 /* If cursor did not appear assume that the middle of the window is
14506 in the first line of the window. Do it again with the next line.
14507 (Imagine a window of height 100, displaying two lines of height
14508 60. Moving back 50 from it->last_visible_y will end in the first
14510 if (w
->cursor
.vpos
< 0)
14512 if (!NILP (w
->window_end_valid
)
14513 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14515 clear_glyph_matrix (w
->desired_matrix
);
14516 move_it_by_lines (&it
, 1);
14517 try_window (window
, it
.current
.pos
, 0);
14519 else if (PT
< IT_CHARPOS (it
))
14521 clear_glyph_matrix (w
->desired_matrix
);
14522 move_it_by_lines (&it
, -1);
14523 try_window (window
, it
.current
.pos
, 0);
14527 /* Not much we can do about it. */
14531 /* Consider the following case: Window starts at BEGV, there is
14532 invisible, intangible text at BEGV, so that display starts at
14533 some point START > BEGV. It can happen that we are called with
14534 PT somewhere between BEGV and START. Try to handle that case. */
14535 if (w
->cursor
.vpos
< 0)
14537 struct glyph_row
*row
= w
->current_matrix
->rows
;
14538 if (row
->mode_line_p
)
14540 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14543 if (!cursor_row_fully_visible_p (w
, 0, 0))
14545 /* If vscroll is enabled, disable it and try again. */
14549 clear_glyph_matrix (w
->desired_matrix
);
14553 /* If centering point failed to make the whole line visible,
14554 put point at the top instead. That has to make the whole line
14555 visible, if it can be done. */
14556 if (centering_position
== 0)
14559 clear_glyph_matrix (w
->desired_matrix
);
14560 centering_position
= 0;
14566 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14567 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14568 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14571 /* Display the mode line, if we must. */
14572 if ((update_mode_line
14573 /* If window not full width, must redo its mode line
14574 if (a) the window to its side is being redone and
14575 (b) we do a frame-based redisplay. This is a consequence
14576 of how inverted lines are drawn in frame-based redisplay. */
14577 || (!just_this_one_p
14578 && !FRAME_WINDOW_P (f
)
14579 && !WINDOW_FULL_WIDTH_P (w
))
14580 /* Line number to display. */
14581 || INTEGERP (w
->base_line_pos
)
14582 /* Column number is displayed and different from the one displayed. */
14583 || (!NILP (w
->column_number_displayed
)
14584 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
14585 /* This means that the window has a mode line. */
14586 && (WINDOW_WANTS_MODELINE_P (w
)
14587 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14589 display_mode_lines (w
);
14591 /* If mode line height has changed, arrange for a thorough
14592 immediate redisplay using the correct mode line height. */
14593 if (WINDOW_WANTS_MODELINE_P (w
)
14594 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14596 fonts_changed_p
= 1;
14597 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14598 = DESIRED_MODE_LINE_HEIGHT (w
);
14601 /* If header line height has changed, arrange for a thorough
14602 immediate redisplay using the correct header line height. */
14603 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14604 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14606 fonts_changed_p
= 1;
14607 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14608 = DESIRED_HEADER_LINE_HEIGHT (w
);
14611 if (fonts_changed_p
)
14612 goto need_larger_matrices
;
14615 if (!line_number_displayed
14616 && !BUFFERP (w
->base_line_pos
))
14618 w
->base_line_pos
= Qnil
;
14619 w
->base_line_number
= Qnil
;
14624 /* When we reach a frame's selected window, redo the frame's menu bar. */
14625 if (update_mode_line
14626 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14628 int redisplay_menu_p
= 0;
14630 if (FRAME_WINDOW_P (f
))
14632 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14633 || defined (HAVE_NS) || defined (USE_GTK)
14634 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14636 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14640 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14642 if (redisplay_menu_p
)
14643 display_menu_bar (w
);
14645 #ifdef HAVE_WINDOW_SYSTEM
14646 if (FRAME_WINDOW_P (f
))
14648 #if defined (USE_GTK) || defined (HAVE_NS)
14649 if (FRAME_EXTERNAL_TOOL_BAR (f
))
14650 redisplay_tool_bar (f
);
14652 if (WINDOWP (f
->tool_bar_window
)
14653 && (FRAME_TOOL_BAR_LINES (f
) > 0
14654 || !NILP (Vauto_resize_tool_bars
))
14655 && redisplay_tool_bar (f
))
14656 ignore_mouse_drag_p
= 1;
14662 #ifdef HAVE_WINDOW_SYSTEM
14663 if (FRAME_WINDOW_P (f
)
14664 && update_window_fringes (w
, (just_this_one_p
14665 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14666 || w
->pseudo_window_p
)))
14670 if (draw_window_fringes (w
, 1))
14671 x_draw_vertical_border (w
);
14675 #endif /* HAVE_WINDOW_SYSTEM */
14677 /* We go to this label, with fonts_changed_p nonzero,
14678 if it is necessary to try again using larger glyph matrices.
14679 We have to redeem the scroll bar even in this case,
14680 because the loop in redisplay_internal expects that. */
14681 need_larger_matrices
:
14683 finish_scroll_bars
:
14685 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14687 /* Set the thumb's position and size. */
14688 set_vertical_scroll_bar (w
);
14690 /* Note that we actually used the scroll bar attached to this
14691 window, so it shouldn't be deleted at the end of redisplay. */
14692 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14693 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14696 /* Restore current_buffer and value of point in it. The window
14697 update may have changed the buffer, so first make sure `opoint'
14698 is still valid (Bug#6177). */
14699 if (CHARPOS (opoint
) < BEGV
)
14700 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14701 else if (CHARPOS (opoint
) > ZV
)
14702 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14704 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14706 set_buffer_internal_1 (old
);
14707 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14708 shorter. This can be caused by log truncation in *Messages*. */
14709 if (CHARPOS (lpoint
) <= ZV
)
14710 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14712 unbind_to (count
, Qnil
);
14716 /* Build the complete desired matrix of WINDOW with a window start
14717 buffer position POS.
14719 Value is 1 if successful. It is zero if fonts were loaded during
14720 redisplay which makes re-adjusting glyph matrices necessary, and -1
14721 if point would appear in the scroll margins.
14722 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14723 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14727 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14729 struct window
*w
= XWINDOW (window
);
14731 struct glyph_row
*last_text_row
= NULL
;
14732 struct frame
*f
= XFRAME (w
->frame
);
14734 /* Make POS the new window start. */
14735 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14737 /* Mark cursor position as unknown. No overlay arrow seen. */
14738 w
->cursor
.vpos
= -1;
14739 overlay_arrow_seen
= 0;
14741 /* Initialize iterator and info to start at POS. */
14742 start_display (&it
, w
, pos
);
14744 /* Display all lines of W. */
14745 while (it
.current_y
< it
.last_visible_y
)
14747 if (display_line (&it
))
14748 last_text_row
= it
.glyph_row
- 1;
14749 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14753 /* Don't let the cursor end in the scroll margins. */
14754 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14755 && !MINI_WINDOW_P (w
))
14757 int this_scroll_margin
;
14759 if (scroll_margin
> 0)
14761 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14762 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14765 this_scroll_margin
= 0;
14767 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14768 && w
->cursor
.y
< this_scroll_margin
14769 && CHARPOS (pos
) > BEGV
14770 && IT_CHARPOS (it
) < ZV
)
14771 /* rms: considering make_cursor_line_fully_visible_p here
14772 seems to give wrong results. We don't want to recenter
14773 when the last line is partly visible, we want to allow
14774 that case to be handled in the usual way. */
14775 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14777 w
->cursor
.vpos
= -1;
14778 clear_glyph_matrix (w
->desired_matrix
);
14783 /* If bottom moved off end of frame, change mode line percentage. */
14784 if (XFASTINT (w
->window_end_pos
) <= 0
14785 && Z
!= IT_CHARPOS (it
))
14786 w
->update_mode_line
= Qt
;
14788 /* Set window_end_pos to the offset of the last character displayed
14789 on the window from the end of current_buffer. Set
14790 window_end_vpos to its row number. */
14793 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14794 w
->window_end_bytepos
14795 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14797 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14799 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14800 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14801 ->displays_text_p
);
14805 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14806 w
->window_end_pos
= make_number (Z
- ZV
);
14807 w
->window_end_vpos
= make_number (0);
14810 /* But that is not valid info until redisplay finishes. */
14811 w
->window_end_valid
= Qnil
;
14817 /************************************************************************
14818 Window redisplay reusing current matrix when buffer has not changed
14819 ************************************************************************/
14821 /* Try redisplay of window W showing an unchanged buffer with a
14822 different window start than the last time it was displayed by
14823 reusing its current matrix. Value is non-zero if successful.
14824 W->start is the new window start. */
14827 try_window_reusing_current_matrix (struct window
*w
)
14829 struct frame
*f
= XFRAME (w
->frame
);
14830 struct glyph_row
*bottom_row
;
14833 struct text_pos start
, new_start
;
14834 int nrows_scrolled
, i
;
14835 struct glyph_row
*last_text_row
;
14836 struct glyph_row
*last_reused_text_row
;
14837 struct glyph_row
*start_row
;
14838 int start_vpos
, min_y
, max_y
;
14841 if (inhibit_try_window_reusing
)
14845 if (/* This function doesn't handle terminal frames. */
14846 !FRAME_WINDOW_P (f
)
14847 /* Don't try to reuse the display if windows have been split
14849 || windows_or_buffers_changed
14850 || cursor_type_changed
)
14853 /* Can't do this if region may have changed. */
14854 if ((!NILP (Vtransient_mark_mode
)
14855 && !NILP (BVAR (current_buffer
, mark_active
)))
14856 || !NILP (w
->region_showing
)
14857 || !NILP (Vshow_trailing_whitespace
))
14860 /* If top-line visibility has changed, give up. */
14861 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14862 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14865 /* Give up if old or new display is scrolled vertically. We could
14866 make this function handle this, but right now it doesn't. */
14867 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14868 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14871 /* The variable new_start now holds the new window start. The old
14872 start `start' can be determined from the current matrix. */
14873 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14874 start
= start_row
->minpos
;
14875 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14877 /* Clear the desired matrix for the display below. */
14878 clear_glyph_matrix (w
->desired_matrix
);
14880 if (CHARPOS (new_start
) <= CHARPOS (start
))
14882 /* Don't use this method if the display starts with an ellipsis
14883 displayed for invisible text. It's not easy to handle that case
14884 below, and it's certainly not worth the effort since this is
14885 not a frequent case. */
14886 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14889 IF_DEBUG (debug_method_add (w
, "twu1"));
14891 /* Display up to a row that can be reused. The variable
14892 last_text_row is set to the last row displayed that displays
14893 text. Note that it.vpos == 0 if or if not there is a
14894 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14895 start_display (&it
, w
, new_start
);
14896 w
->cursor
.vpos
= -1;
14897 last_text_row
= last_reused_text_row
= NULL
;
14899 while (it
.current_y
< it
.last_visible_y
14900 && !fonts_changed_p
)
14902 /* If we have reached into the characters in the START row,
14903 that means the line boundaries have changed. So we
14904 can't start copying with the row START. Maybe it will
14905 work to start copying with the following row. */
14906 while (IT_CHARPOS (it
) > CHARPOS (start
))
14908 /* Advance to the next row as the "start". */
14910 start
= start_row
->minpos
;
14911 /* If there are no more rows to try, or just one, give up. */
14912 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14913 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14914 || CHARPOS (start
) == ZV
)
14916 clear_glyph_matrix (w
->desired_matrix
);
14920 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14922 /* If we have reached alignment,
14923 we can copy the rest of the rows. */
14924 if (IT_CHARPOS (it
) == CHARPOS (start
))
14927 if (display_line (&it
))
14928 last_text_row
= it
.glyph_row
- 1;
14931 /* A value of current_y < last_visible_y means that we stopped
14932 at the previous window start, which in turn means that we
14933 have at least one reusable row. */
14934 if (it
.current_y
< it
.last_visible_y
)
14936 struct glyph_row
*row
;
14938 /* IT.vpos always starts from 0; it counts text lines. */
14939 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14941 /* Find PT if not already found in the lines displayed. */
14942 if (w
->cursor
.vpos
< 0)
14944 int dy
= it
.current_y
- start_row
->y
;
14946 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14947 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14949 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14950 dy
, nrows_scrolled
);
14953 clear_glyph_matrix (w
->desired_matrix
);
14958 /* Scroll the display. Do it before the current matrix is
14959 changed. The problem here is that update has not yet
14960 run, i.e. part of the current matrix is not up to date.
14961 scroll_run_hook will clear the cursor, and use the
14962 current matrix to get the height of the row the cursor is
14964 run
.current_y
= start_row
->y
;
14965 run
.desired_y
= it
.current_y
;
14966 run
.height
= it
.last_visible_y
- it
.current_y
;
14968 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14971 FRAME_RIF (f
)->update_window_begin_hook (w
);
14972 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14973 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14974 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14978 /* Shift current matrix down by nrows_scrolled lines. */
14979 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14980 rotate_matrix (w
->current_matrix
,
14982 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14985 /* Disable lines that must be updated. */
14986 for (i
= 0; i
< nrows_scrolled
; ++i
)
14987 (start_row
+ i
)->enabled_p
= 0;
14989 /* Re-compute Y positions. */
14990 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14991 max_y
= it
.last_visible_y
;
14992 for (row
= start_row
+ nrows_scrolled
;
14996 row
->y
= it
.current_y
;
14997 row
->visible_height
= row
->height
;
14999 if (row
->y
< min_y
)
15000 row
->visible_height
-= min_y
- row
->y
;
15001 if (row
->y
+ row
->height
> max_y
)
15002 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15003 row
->redraw_fringe_bitmaps_p
= 1;
15005 it
.current_y
+= row
->height
;
15007 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15008 last_reused_text_row
= row
;
15009 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15013 /* Disable lines in the current matrix which are now
15014 below the window. */
15015 for (++row
; row
< bottom_row
; ++row
)
15016 row
->enabled_p
= row
->mode_line_p
= 0;
15019 /* Update window_end_pos etc.; last_reused_text_row is the last
15020 reused row from the current matrix containing text, if any.
15021 The value of last_text_row is the last displayed line
15022 containing text. */
15023 if (last_reused_text_row
)
15025 w
->window_end_bytepos
15026 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15028 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15030 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15031 w
->current_matrix
));
15033 else if (last_text_row
)
15035 w
->window_end_bytepos
15036 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15038 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15040 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15044 /* This window must be completely empty. */
15045 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15046 w
->window_end_pos
= make_number (Z
- ZV
);
15047 w
->window_end_vpos
= make_number (0);
15049 w
->window_end_valid
= Qnil
;
15051 /* Update hint: don't try scrolling again in update_window. */
15052 w
->desired_matrix
->no_scrolling_p
= 1;
15055 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15059 else if (CHARPOS (new_start
) > CHARPOS (start
))
15061 struct glyph_row
*pt_row
, *row
;
15062 struct glyph_row
*first_reusable_row
;
15063 struct glyph_row
*first_row_to_display
;
15065 int yb
= window_text_bottom_y (w
);
15067 /* Find the row starting at new_start, if there is one. Don't
15068 reuse a partially visible line at the end. */
15069 first_reusable_row
= start_row
;
15070 while (first_reusable_row
->enabled_p
15071 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15072 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15073 < CHARPOS (new_start
)))
15074 ++first_reusable_row
;
15076 /* Give up if there is no row to reuse. */
15077 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15078 || !first_reusable_row
->enabled_p
15079 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15080 != CHARPOS (new_start
)))
15083 /* We can reuse fully visible rows beginning with
15084 first_reusable_row to the end of the window. Set
15085 first_row_to_display to the first row that cannot be reused.
15086 Set pt_row to the row containing point, if there is any. */
15088 for (first_row_to_display
= first_reusable_row
;
15089 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15090 ++first_row_to_display
)
15092 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15093 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15094 pt_row
= first_row_to_display
;
15097 /* Start displaying at the start of first_row_to_display. */
15098 xassert (first_row_to_display
->y
< yb
);
15099 init_to_row_start (&it
, w
, first_row_to_display
);
15101 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15103 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15105 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15106 + WINDOW_HEADER_LINE_HEIGHT (w
));
15108 /* Display lines beginning with first_row_to_display in the
15109 desired matrix. Set last_text_row to the last row displayed
15110 that displays text. */
15111 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15112 if (pt_row
== NULL
)
15113 w
->cursor
.vpos
= -1;
15114 last_text_row
= NULL
;
15115 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15116 if (display_line (&it
))
15117 last_text_row
= it
.glyph_row
- 1;
15119 /* If point is in a reused row, adjust y and vpos of the cursor
15123 w
->cursor
.vpos
-= nrows_scrolled
;
15124 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15127 /* Give up if point isn't in a row displayed or reused. (This
15128 also handles the case where w->cursor.vpos < nrows_scrolled
15129 after the calls to display_line, which can happen with scroll
15130 margins. See bug#1295.) */
15131 if (w
->cursor
.vpos
< 0)
15133 clear_glyph_matrix (w
->desired_matrix
);
15137 /* Scroll the display. */
15138 run
.current_y
= first_reusable_row
->y
;
15139 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15140 run
.height
= it
.last_visible_y
- run
.current_y
;
15141 dy
= run
.current_y
- run
.desired_y
;
15146 FRAME_RIF (f
)->update_window_begin_hook (w
);
15147 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15148 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15149 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15153 /* Adjust Y positions of reused rows. */
15154 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15155 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15156 max_y
= it
.last_visible_y
;
15157 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15160 row
->visible_height
= row
->height
;
15161 if (row
->y
< min_y
)
15162 row
->visible_height
-= min_y
- row
->y
;
15163 if (row
->y
+ row
->height
> max_y
)
15164 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15165 row
->redraw_fringe_bitmaps_p
= 1;
15168 /* Scroll the current matrix. */
15169 xassert (nrows_scrolled
> 0);
15170 rotate_matrix (w
->current_matrix
,
15172 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15175 /* Disable rows not reused. */
15176 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15177 row
->enabled_p
= 0;
15179 /* Point may have moved to a different line, so we cannot assume that
15180 the previous cursor position is valid; locate the correct row. */
15183 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15184 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15188 w
->cursor
.y
= row
->y
;
15190 if (row
< bottom_row
)
15192 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15193 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15195 /* Can't use this optimization with bidi-reordered glyph
15196 rows, unless cursor is already at point. */
15197 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15199 if (!(w
->cursor
.hpos
>= 0
15200 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15201 && BUFFERP (glyph
->object
)
15202 && glyph
->charpos
== PT
))
15207 && (!BUFFERP (glyph
->object
)
15208 || glyph
->charpos
< PT
);
15212 w
->cursor
.x
+= glyph
->pixel_width
;
15217 /* Adjust window end. A null value of last_text_row means that
15218 the window end is in reused rows which in turn means that
15219 only its vpos can have changed. */
15222 w
->window_end_bytepos
15223 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15225 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15227 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15232 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15235 w
->window_end_valid
= Qnil
;
15236 w
->desired_matrix
->no_scrolling_p
= 1;
15239 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15249 /************************************************************************
15250 Window redisplay reusing current matrix when buffer has changed
15251 ************************************************************************/
15253 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15254 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15255 EMACS_INT
*, EMACS_INT
*);
15256 static struct glyph_row
*
15257 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15258 struct glyph_row
*);
15261 /* Return the last row in MATRIX displaying text. If row START is
15262 non-null, start searching with that row. IT gives the dimensions
15263 of the display. Value is null if matrix is empty; otherwise it is
15264 a pointer to the row found. */
15266 static struct glyph_row
*
15267 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15268 struct glyph_row
*start
)
15270 struct glyph_row
*row
, *row_found
;
15272 /* Set row_found to the last row in IT->w's current matrix
15273 displaying text. The loop looks funny but think of partially
15276 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15277 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15279 xassert (row
->enabled_p
);
15281 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15290 /* Return the last row in the current matrix of W that is not affected
15291 by changes at the start of current_buffer that occurred since W's
15292 current matrix was built. Value is null if no such row exists.
15294 BEG_UNCHANGED us the number of characters unchanged at the start of
15295 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15296 first changed character in current_buffer. Characters at positions <
15297 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15298 when the current matrix was built. */
15300 static struct glyph_row
*
15301 find_last_unchanged_at_beg_row (struct window
*w
)
15303 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15304 struct glyph_row
*row
;
15305 struct glyph_row
*row_found
= NULL
;
15306 int yb
= window_text_bottom_y (w
);
15308 /* Find the last row displaying unchanged text. */
15309 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15310 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15311 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15314 if (/* If row ends before first_changed_pos, it is unchanged,
15315 except in some case. */
15316 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15317 /* When row ends in ZV and we write at ZV it is not
15319 && !row
->ends_at_zv_p
15320 /* When first_changed_pos is the end of a continued line,
15321 row is not unchanged because it may be no longer
15323 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15324 && (row
->continued_p
15325 || row
->exact_window_width_line_p
)))
15328 /* Stop if last visible row. */
15329 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15337 /* Find the first glyph row in the current matrix of W that is not
15338 affected by changes at the end of current_buffer since the
15339 time W's current matrix was built.
15341 Return in *DELTA the number of chars by which buffer positions in
15342 unchanged text at the end of current_buffer must be adjusted.
15344 Return in *DELTA_BYTES the corresponding number of bytes.
15346 Value is null if no such row exists, i.e. all rows are affected by
15349 static struct glyph_row
*
15350 find_first_unchanged_at_end_row (struct window
*w
,
15351 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15353 struct glyph_row
*row
;
15354 struct glyph_row
*row_found
= NULL
;
15356 *delta
= *delta_bytes
= 0;
15358 /* Display must not have been paused, otherwise the current matrix
15359 is not up to date. */
15360 eassert (!NILP (w
->window_end_valid
));
15362 /* A value of window_end_pos >= END_UNCHANGED means that the window
15363 end is in the range of changed text. If so, there is no
15364 unchanged row at the end of W's current matrix. */
15365 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15368 /* Set row to the last row in W's current matrix displaying text. */
15369 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15371 /* If matrix is entirely empty, no unchanged row exists. */
15372 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15374 /* The value of row is the last glyph row in the matrix having a
15375 meaningful buffer position in it. The end position of row
15376 corresponds to window_end_pos. This allows us to translate
15377 buffer positions in the current matrix to current buffer
15378 positions for characters not in changed text. */
15380 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15381 EMACS_INT Z_BYTE_old
=
15382 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15383 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15384 struct glyph_row
*first_text_row
15385 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15387 *delta
= Z
- Z_old
;
15388 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15390 /* Set last_unchanged_pos to the buffer position of the last
15391 character in the buffer that has not been changed. Z is the
15392 index + 1 of the last character in current_buffer, i.e. by
15393 subtracting END_UNCHANGED we get the index of the last
15394 unchanged character, and we have to add BEG to get its buffer
15396 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15397 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15399 /* Search backward from ROW for a row displaying a line that
15400 starts at a minimum position >= last_unchanged_pos_old. */
15401 for (; row
> first_text_row
; --row
)
15403 /* This used to abort, but it can happen.
15404 It is ok to just stop the search instead here. KFS. */
15405 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15408 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15413 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15419 /* Make sure that glyph rows in the current matrix of window W
15420 reference the same glyph memory as corresponding rows in the
15421 frame's frame matrix. This function is called after scrolling W's
15422 current matrix on a terminal frame in try_window_id and
15423 try_window_reusing_current_matrix. */
15426 sync_frame_with_window_matrix_rows (struct window
*w
)
15428 struct frame
*f
= XFRAME (w
->frame
);
15429 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15431 /* Preconditions: W must be a leaf window and full-width. Its frame
15432 must have a frame matrix. */
15433 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15434 xassert (WINDOW_FULL_WIDTH_P (w
));
15435 xassert (!FRAME_WINDOW_P (f
));
15437 /* If W is a full-width window, glyph pointers in W's current matrix
15438 have, by definition, to be the same as glyph pointers in the
15439 corresponding frame matrix. Note that frame matrices have no
15440 marginal areas (see build_frame_matrix). */
15441 window_row
= w
->current_matrix
->rows
;
15442 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15443 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15444 while (window_row
< window_row_end
)
15446 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15447 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15449 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15450 frame_row
->glyphs
[TEXT_AREA
] = start
;
15451 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15452 frame_row
->glyphs
[LAST_AREA
] = end
;
15454 /* Disable frame rows whose corresponding window rows have
15455 been disabled in try_window_id. */
15456 if (!window_row
->enabled_p
)
15457 frame_row
->enabled_p
= 0;
15459 ++window_row
, ++frame_row
;
15464 /* Find the glyph row in window W containing CHARPOS. Consider all
15465 rows between START and END (not inclusive). END null means search
15466 all rows to the end of the display area of W. Value is the row
15467 containing CHARPOS or null. */
15470 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15471 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15473 struct glyph_row
*row
= start
;
15474 struct glyph_row
*best_row
= NULL
;
15475 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15478 /* If we happen to start on a header-line, skip that. */
15479 if (row
->mode_line_p
)
15482 if ((end
&& row
>= end
) || !row
->enabled_p
)
15485 last_y
= window_text_bottom_y (w
) - dy
;
15489 /* Give up if we have gone too far. */
15490 if (end
&& row
>= end
)
15492 /* This formerly returned if they were equal.
15493 I think that both quantities are of a "last plus one" type;
15494 if so, when they are equal, the row is within the screen. -- rms. */
15495 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15498 /* If it is in this row, return this row. */
15499 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15500 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15501 /* The end position of a row equals the start
15502 position of the next row. If CHARPOS is there, we
15503 would rather display it in the next line, except
15504 when this line ends in ZV. */
15505 && !row
->ends_at_zv_p
15506 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15507 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15511 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15512 || (!best_row
&& !row
->continued_p
))
15514 /* In bidi-reordered rows, there could be several rows
15515 occluding point, all of them belonging to the same
15516 continued line. We need to find the row which fits
15517 CHARPOS the best. */
15518 for (g
= row
->glyphs
[TEXT_AREA
];
15519 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15522 if (!STRINGP (g
->object
))
15524 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15526 mindif
= eabs (g
->charpos
- charpos
);
15528 /* Exact match always wins. */
15535 else if (best_row
&& !row
->continued_p
)
15542 /* Try to redisplay window W by reusing its existing display. W's
15543 current matrix must be up to date when this function is called,
15544 i.e. window_end_valid must not be nil.
15548 1 if display has been updated
15549 0 if otherwise unsuccessful
15550 -1 if redisplay with same window start is known not to succeed
15552 The following steps are performed:
15554 1. Find the last row in the current matrix of W that is not
15555 affected by changes at the start of current_buffer. If no such row
15558 2. Find the first row in W's current matrix that is not affected by
15559 changes at the end of current_buffer. Maybe there is no such row.
15561 3. Display lines beginning with the row + 1 found in step 1 to the
15562 row found in step 2 or, if step 2 didn't find a row, to the end of
15565 4. If cursor is not known to appear on the window, give up.
15567 5. If display stopped at the row found in step 2, scroll the
15568 display and current matrix as needed.
15570 6. Maybe display some lines at the end of W, if we must. This can
15571 happen under various circumstances, like a partially visible line
15572 becoming fully visible, or because newly displayed lines are displayed
15573 in smaller font sizes.
15575 7. Update W's window end information. */
15578 try_window_id (struct window
*w
)
15580 struct frame
*f
= XFRAME (w
->frame
);
15581 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15582 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15583 struct glyph_row
*last_unchanged_at_beg_row
;
15584 struct glyph_row
*first_unchanged_at_end_row
;
15585 struct glyph_row
*row
;
15586 struct glyph_row
*bottom_row
;
15589 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15591 struct text_pos start_pos
;
15593 int first_unchanged_at_end_vpos
= 0;
15594 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15595 struct text_pos start
;
15596 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15599 if (inhibit_try_window_id
)
15603 /* This is handy for debugging. */
15605 #define GIVE_UP(X) \
15607 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15611 #define GIVE_UP(X) return 0
15614 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15616 /* Don't use this for mini-windows because these can show
15617 messages and mini-buffers, and we don't handle that here. */
15618 if (MINI_WINDOW_P (w
))
15621 /* This flag is used to prevent redisplay optimizations. */
15622 if (windows_or_buffers_changed
|| cursor_type_changed
)
15625 /* Verify that narrowing has not changed.
15626 Also verify that we were not told to prevent redisplay optimizations.
15627 It would be nice to further
15628 reduce the number of cases where this prevents try_window_id. */
15629 if (current_buffer
->clip_changed
15630 || current_buffer
->prevent_redisplay_optimizations_p
)
15633 /* Window must either use window-based redisplay or be full width. */
15634 if (!FRAME_WINDOW_P (f
)
15635 && (!FRAME_LINE_INS_DEL_OK (f
)
15636 || !WINDOW_FULL_WIDTH_P (w
)))
15639 /* Give up if point is known NOT to appear in W. */
15640 if (PT
< CHARPOS (start
))
15643 /* Another way to prevent redisplay optimizations. */
15644 if (XFASTINT (w
->last_modified
) == 0)
15647 /* Verify that window is not hscrolled. */
15648 if (XFASTINT (w
->hscroll
) != 0)
15651 /* Verify that display wasn't paused. */
15652 if (NILP (w
->window_end_valid
))
15655 /* Can't use this if highlighting a region because a cursor movement
15656 will do more than just set the cursor. */
15657 if (!NILP (Vtransient_mark_mode
)
15658 && !NILP (BVAR (current_buffer
, mark_active
)))
15661 /* Likewise if highlighting trailing whitespace. */
15662 if (!NILP (Vshow_trailing_whitespace
))
15665 /* Likewise if showing a region. */
15666 if (!NILP (w
->region_showing
))
15669 /* Can't use this if overlay arrow position and/or string have
15671 if (overlay_arrows_changed_p ())
15674 /* When word-wrap is on, adding a space to the first word of a
15675 wrapped line can change the wrap position, altering the line
15676 above it. It might be worthwhile to handle this more
15677 intelligently, but for now just redisplay from scratch. */
15678 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
15681 /* Under bidi reordering, adding or deleting a character in the
15682 beginning of a paragraph, before the first strong directional
15683 character, can change the base direction of the paragraph (unless
15684 the buffer specifies a fixed paragraph direction), which will
15685 require to redisplay the whole paragraph. It might be worthwhile
15686 to find the paragraph limits and widen the range of redisplayed
15687 lines to that, but for now just give up this optimization and
15688 redisplay from scratch. */
15689 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
15690 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
15693 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15694 only if buffer has really changed. The reason is that the gap is
15695 initially at Z for freshly visited files. The code below would
15696 set end_unchanged to 0 in that case. */
15697 if (MODIFF
> SAVE_MODIFF
15698 /* This seems to happen sometimes after saving a buffer. */
15699 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15701 if (GPT
- BEG
< BEG_UNCHANGED
)
15702 BEG_UNCHANGED
= GPT
- BEG
;
15703 if (Z
- GPT
< END_UNCHANGED
)
15704 END_UNCHANGED
= Z
- GPT
;
15707 /* The position of the first and last character that has been changed. */
15708 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15709 last_changed_charpos
= Z
- END_UNCHANGED
;
15711 /* If window starts after a line end, and the last change is in
15712 front of that newline, then changes don't affect the display.
15713 This case happens with stealth-fontification. Note that although
15714 the display is unchanged, glyph positions in the matrix have to
15715 be adjusted, of course. */
15716 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15717 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15718 && ((last_changed_charpos
< CHARPOS (start
)
15719 && CHARPOS (start
) == BEGV
)
15720 || (last_changed_charpos
< CHARPOS (start
) - 1
15721 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15723 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
15724 struct glyph_row
*r0
;
15726 /* Compute how many chars/bytes have been added to or removed
15727 from the buffer. */
15728 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15729 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15730 Z_delta
= Z
- Z_old
;
15731 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15733 /* Give up if PT is not in the window. Note that it already has
15734 been checked at the start of try_window_id that PT is not in
15735 front of the window start. */
15736 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
15739 /* If window start is unchanged, we can reuse the whole matrix
15740 as is, after adjusting glyph positions. No need to compute
15741 the window end again, since its offset from Z hasn't changed. */
15742 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15743 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
15744 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
15745 /* PT must not be in a partially visible line. */
15746 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
15747 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15749 /* Adjust positions in the glyph matrix. */
15750 if (Z_delta
|| Z_delta_bytes
)
15752 struct glyph_row
*r1
15753 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15754 increment_matrix_positions (w
->current_matrix
,
15755 MATRIX_ROW_VPOS (r0
, current_matrix
),
15756 MATRIX_ROW_VPOS (r1
, current_matrix
),
15757 Z_delta
, Z_delta_bytes
);
15760 /* Set the cursor. */
15761 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15763 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15770 /* Handle the case that changes are all below what is displayed in
15771 the window, and that PT is in the window. This shortcut cannot
15772 be taken if ZV is visible in the window, and text has been added
15773 there that is visible in the window. */
15774 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15775 /* ZV is not visible in the window, or there are no
15776 changes at ZV, actually. */
15777 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15778 || first_changed_charpos
== last_changed_charpos
))
15780 struct glyph_row
*r0
;
15782 /* Give up if PT is not in the window. Note that it already has
15783 been checked at the start of try_window_id that PT is not in
15784 front of the window start. */
15785 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15788 /* If window start is unchanged, we can reuse the whole matrix
15789 as is, without changing glyph positions since no text has
15790 been added/removed in front of the window end. */
15791 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15792 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15793 /* PT must not be in a partially visible line. */
15794 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15795 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15797 /* We have to compute the window end anew since text
15798 could have been added/removed after it. */
15800 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15801 w
->window_end_bytepos
15802 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15804 /* Set the cursor. */
15805 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15807 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15814 /* Give up if window start is in the changed area.
15816 The condition used to read
15818 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15820 but why that was tested escapes me at the moment. */
15821 if (CHARPOS (start
) >= first_changed_charpos
15822 && CHARPOS (start
) <= last_changed_charpos
)
15825 /* Check that window start agrees with the start of the first glyph
15826 row in its current matrix. Check this after we know the window
15827 start is not in changed text, otherwise positions would not be
15829 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15830 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15833 /* Give up if the window ends in strings. Overlay strings
15834 at the end are difficult to handle, so don't try. */
15835 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15836 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15839 /* Compute the position at which we have to start displaying new
15840 lines. Some of the lines at the top of the window might be
15841 reusable because they are not displaying changed text. Find the
15842 last row in W's current matrix not affected by changes at the
15843 start of current_buffer. Value is null if changes start in the
15844 first line of window. */
15845 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15846 if (last_unchanged_at_beg_row
)
15848 /* Avoid starting to display in the moddle of a character, a TAB
15849 for instance. This is easier than to set up the iterator
15850 exactly, and it's not a frequent case, so the additional
15851 effort wouldn't really pay off. */
15852 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15853 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15854 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15855 --last_unchanged_at_beg_row
;
15857 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15860 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15862 start_pos
= it
.current
.pos
;
15864 /* Start displaying new lines in the desired matrix at the same
15865 vpos we would use in the current matrix, i.e. below
15866 last_unchanged_at_beg_row. */
15867 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15869 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15870 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15872 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15876 /* There are no reusable lines at the start of the window.
15877 Start displaying in the first text line. */
15878 start_display (&it
, w
, start
);
15879 it
.vpos
= it
.first_vpos
;
15880 start_pos
= it
.current
.pos
;
15883 /* Find the first row that is not affected by changes at the end of
15884 the buffer. Value will be null if there is no unchanged row, in
15885 which case we must redisplay to the end of the window. delta
15886 will be set to the value by which buffer positions beginning with
15887 first_unchanged_at_end_row have to be adjusted due to text
15889 first_unchanged_at_end_row
15890 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15891 IF_DEBUG (debug_delta
= delta
);
15892 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15894 /* Set stop_pos to the buffer position up to which we will have to
15895 display new lines. If first_unchanged_at_end_row != NULL, this
15896 is the buffer position of the start of the line displayed in that
15897 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15898 that we don't stop at a buffer position. */
15900 if (first_unchanged_at_end_row
)
15902 xassert (last_unchanged_at_beg_row
== NULL
15903 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15905 /* If this is a continuation line, move forward to the next one
15906 that isn't. Changes in lines above affect this line.
15907 Caution: this may move first_unchanged_at_end_row to a row
15908 not displaying text. */
15909 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15910 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15911 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15912 < it
.last_visible_y
))
15913 ++first_unchanged_at_end_row
;
15915 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15916 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15917 >= it
.last_visible_y
))
15918 first_unchanged_at_end_row
= NULL
;
15921 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15923 first_unchanged_at_end_vpos
15924 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15925 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15928 else if (last_unchanged_at_beg_row
== NULL
)
15934 /* Either there is no unchanged row at the end, or the one we have
15935 now displays text. This is a necessary condition for the window
15936 end pos calculation at the end of this function. */
15937 xassert (first_unchanged_at_end_row
== NULL
15938 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15940 debug_last_unchanged_at_beg_vpos
15941 = (last_unchanged_at_beg_row
15942 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15944 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15946 #endif /* GLYPH_DEBUG != 0 */
15949 /* Display new lines. Set last_text_row to the last new line
15950 displayed which has text on it, i.e. might end up as being the
15951 line where the window_end_vpos is. */
15952 w
->cursor
.vpos
= -1;
15953 last_text_row
= NULL
;
15954 overlay_arrow_seen
= 0;
15955 while (it
.current_y
< it
.last_visible_y
15956 && !fonts_changed_p
15957 && (first_unchanged_at_end_row
== NULL
15958 || IT_CHARPOS (it
) < stop_pos
))
15960 if (display_line (&it
))
15961 last_text_row
= it
.glyph_row
- 1;
15964 if (fonts_changed_p
)
15968 /* Compute differences in buffer positions, y-positions etc. for
15969 lines reused at the bottom of the window. Compute what we can
15971 if (first_unchanged_at_end_row
15972 /* No lines reused because we displayed everything up to the
15973 bottom of the window. */
15974 && it
.current_y
< it
.last_visible_y
)
15977 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15979 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15980 run
.current_y
= first_unchanged_at_end_row
->y
;
15981 run
.desired_y
= run
.current_y
+ dy
;
15982 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15986 delta
= delta_bytes
= dvpos
= dy
15987 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15988 first_unchanged_at_end_row
= NULL
;
15990 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15993 /* Find the cursor if not already found. We have to decide whether
15994 PT will appear on this window (it sometimes doesn't, but this is
15995 not a very frequent case.) This decision has to be made before
15996 the current matrix is altered. A value of cursor.vpos < 0 means
15997 that PT is either in one of the lines beginning at
15998 first_unchanged_at_end_row or below the window. Don't care for
15999 lines that might be displayed later at the window end; as
16000 mentioned, this is not a frequent case. */
16001 if (w
->cursor
.vpos
< 0)
16003 /* Cursor in unchanged rows at the top? */
16004 if (PT
< CHARPOS (start_pos
)
16005 && last_unchanged_at_beg_row
)
16007 row
= row_containing_pos (w
, PT
,
16008 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16009 last_unchanged_at_beg_row
+ 1, 0);
16011 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16014 /* Start from first_unchanged_at_end_row looking for PT. */
16015 else if (first_unchanged_at_end_row
)
16017 row
= row_containing_pos (w
, PT
- delta
,
16018 first_unchanged_at_end_row
, NULL
, 0);
16020 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16021 delta_bytes
, dy
, dvpos
);
16024 /* Give up if cursor was not found. */
16025 if (w
->cursor
.vpos
< 0)
16027 clear_glyph_matrix (w
->desired_matrix
);
16032 /* Don't let the cursor end in the scroll margins. */
16034 int this_scroll_margin
, cursor_height
;
16036 this_scroll_margin
= max (0, scroll_margin
);
16037 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16038 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16039 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16041 if ((w
->cursor
.y
< this_scroll_margin
16042 && CHARPOS (start
) > BEGV
)
16043 /* Old redisplay didn't take scroll margin into account at the bottom,
16044 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16045 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16046 ? cursor_height
+ this_scroll_margin
16047 : 1)) > it
.last_visible_y
)
16049 w
->cursor
.vpos
= -1;
16050 clear_glyph_matrix (w
->desired_matrix
);
16055 /* Scroll the display. Do it before changing the current matrix so
16056 that xterm.c doesn't get confused about where the cursor glyph is
16058 if (dy
&& run
.height
)
16062 if (FRAME_WINDOW_P (f
))
16064 FRAME_RIF (f
)->update_window_begin_hook (w
);
16065 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16066 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16067 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16071 /* Terminal frame. In this case, dvpos gives the number of
16072 lines to scroll by; dvpos < 0 means scroll up. */
16074 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16075 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16076 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16077 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16078 + window_internal_height (w
));
16080 #if defined (HAVE_GPM) || defined (MSDOS)
16081 x_clear_window_mouse_face (w
);
16083 /* Perform the operation on the screen. */
16086 /* Scroll last_unchanged_at_beg_row to the end of the
16087 window down dvpos lines. */
16088 set_terminal_window (f
, end
);
16090 /* On dumb terminals delete dvpos lines at the end
16091 before inserting dvpos empty lines. */
16092 if (!FRAME_SCROLL_REGION_OK (f
))
16093 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16095 /* Insert dvpos empty lines in front of
16096 last_unchanged_at_beg_row. */
16097 ins_del_lines (f
, from
, dvpos
);
16099 else if (dvpos
< 0)
16101 /* Scroll up last_unchanged_at_beg_vpos to the end of
16102 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16103 set_terminal_window (f
, end
);
16105 /* Delete dvpos lines in front of
16106 last_unchanged_at_beg_vpos. ins_del_lines will set
16107 the cursor to the given vpos and emit |dvpos| delete
16109 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16111 /* On a dumb terminal insert dvpos empty lines at the
16113 if (!FRAME_SCROLL_REGION_OK (f
))
16114 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16117 set_terminal_window (f
, 0);
16123 /* Shift reused rows of the current matrix to the right position.
16124 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16126 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16127 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16130 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16131 bottom_vpos
, dvpos
);
16132 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16135 else if (dvpos
> 0)
16137 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16138 bottom_vpos
, dvpos
);
16139 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16140 first_unchanged_at_end_vpos
+ dvpos
, 0);
16143 /* For frame-based redisplay, make sure that current frame and window
16144 matrix are in sync with respect to glyph memory. */
16145 if (!FRAME_WINDOW_P (f
))
16146 sync_frame_with_window_matrix_rows (w
);
16148 /* Adjust buffer positions in reused rows. */
16149 if (delta
|| delta_bytes
)
16150 increment_matrix_positions (current_matrix
,
16151 first_unchanged_at_end_vpos
+ dvpos
,
16152 bottom_vpos
, delta
, delta_bytes
);
16154 /* Adjust Y positions. */
16156 shift_glyph_matrix (w
, current_matrix
,
16157 first_unchanged_at_end_vpos
+ dvpos
,
16160 if (first_unchanged_at_end_row
)
16162 first_unchanged_at_end_row
+= dvpos
;
16163 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16164 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16165 first_unchanged_at_end_row
= NULL
;
16168 /* If scrolling up, there may be some lines to display at the end of
16170 last_text_row_at_end
= NULL
;
16173 /* Scrolling up can leave for example a partially visible line
16174 at the end of the window to be redisplayed. */
16175 /* Set last_row to the glyph row in the current matrix where the
16176 window end line is found. It has been moved up or down in
16177 the matrix by dvpos. */
16178 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16179 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16181 /* If last_row is the window end line, it should display text. */
16182 xassert (last_row
->displays_text_p
);
16184 /* If window end line was partially visible before, begin
16185 displaying at that line. Otherwise begin displaying with the
16186 line following it. */
16187 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16189 init_to_row_start (&it
, w
, last_row
);
16190 it
.vpos
= last_vpos
;
16191 it
.current_y
= last_row
->y
;
16195 init_to_row_end (&it
, w
, last_row
);
16196 it
.vpos
= 1 + last_vpos
;
16197 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16201 /* We may start in a continuation line. If so, we have to
16202 get the right continuation_lines_width and current_x. */
16203 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16204 it
.hpos
= it
.current_x
= 0;
16206 /* Display the rest of the lines at the window end. */
16207 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16208 while (it
.current_y
< it
.last_visible_y
16209 && !fonts_changed_p
)
16211 /* Is it always sure that the display agrees with lines in
16212 the current matrix? I don't think so, so we mark rows
16213 displayed invalid in the current matrix by setting their
16214 enabled_p flag to zero. */
16215 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16216 if (display_line (&it
))
16217 last_text_row_at_end
= it
.glyph_row
- 1;
16221 /* Update window_end_pos and window_end_vpos. */
16222 if (first_unchanged_at_end_row
16223 && !last_text_row_at_end
)
16225 /* Window end line if one of the preserved rows from the current
16226 matrix. Set row to the last row displaying text in current
16227 matrix starting at first_unchanged_at_end_row, after
16229 xassert (first_unchanged_at_end_row
->displays_text_p
);
16230 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16231 first_unchanged_at_end_row
);
16232 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16234 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16235 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16237 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16238 xassert (w
->window_end_bytepos
>= 0);
16239 IF_DEBUG (debug_method_add (w
, "A"));
16241 else if (last_text_row_at_end
)
16244 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16245 w
->window_end_bytepos
16246 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16248 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16249 xassert (w
->window_end_bytepos
>= 0);
16250 IF_DEBUG (debug_method_add (w
, "B"));
16252 else if (last_text_row
)
16254 /* We have displayed either to the end of the window or at the
16255 end of the window, i.e. the last row with text is to be found
16256 in the desired matrix. */
16258 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16259 w
->window_end_bytepos
16260 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16262 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16263 xassert (w
->window_end_bytepos
>= 0);
16265 else if (first_unchanged_at_end_row
== NULL
16266 && last_text_row
== NULL
16267 && last_text_row_at_end
== NULL
)
16269 /* Displayed to end of window, but no line containing text was
16270 displayed. Lines were deleted at the end of the window. */
16271 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16272 int vpos
= XFASTINT (w
->window_end_vpos
);
16273 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16274 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16277 row
== NULL
&& vpos
>= first_vpos
;
16278 --vpos
, --current_row
, --desired_row
)
16280 if (desired_row
->enabled_p
)
16282 if (desired_row
->displays_text_p
)
16285 else if (current_row
->displays_text_p
)
16289 xassert (row
!= NULL
);
16290 w
->window_end_vpos
= make_number (vpos
+ 1);
16291 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16292 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16293 xassert (w
->window_end_bytepos
>= 0);
16294 IF_DEBUG (debug_method_add (w
, "C"));
16299 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16300 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16302 /* Record that display has not been completed. */
16303 w
->window_end_valid
= Qnil
;
16304 w
->desired_matrix
->no_scrolling_p
= 1;
16312 /***********************************************************************
16313 More debugging support
16314 ***********************************************************************/
16318 void dump_glyph_row (struct glyph_row
*, int, int);
16319 void dump_glyph_matrix (struct glyph_matrix
*, int);
16320 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16323 /* Dump the contents of glyph matrix MATRIX on stderr.
16325 GLYPHS 0 means don't show glyph contents.
16326 GLYPHS 1 means show glyphs in short form
16327 GLYPHS > 1 means show glyphs in long form. */
16330 dump_glyph_matrix (matrix
, glyphs
)
16331 struct glyph_matrix
*matrix
;
16335 for (i
= 0; i
< matrix
->nrows
; ++i
)
16336 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16340 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16341 the glyph row and area where the glyph comes from. */
16344 dump_glyph (row
, glyph
, area
)
16345 struct glyph_row
*row
;
16346 struct glyph
*glyph
;
16349 if (glyph
->type
== CHAR_GLYPH
)
16352 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16353 glyph
- row
->glyphs
[TEXT_AREA
],
16356 (BUFFERP (glyph
->object
)
16358 : (STRINGP (glyph
->object
)
16361 glyph
->pixel_width
,
16363 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16367 glyph
->left_box_line_p
,
16368 glyph
->right_box_line_p
);
16370 else if (glyph
->type
== STRETCH_GLYPH
)
16373 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16374 glyph
- row
->glyphs
[TEXT_AREA
],
16377 (BUFFERP (glyph
->object
)
16379 : (STRINGP (glyph
->object
)
16382 glyph
->pixel_width
,
16386 glyph
->left_box_line_p
,
16387 glyph
->right_box_line_p
);
16389 else if (glyph
->type
== IMAGE_GLYPH
)
16392 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16393 glyph
- row
->glyphs
[TEXT_AREA
],
16396 (BUFFERP (glyph
->object
)
16398 : (STRINGP (glyph
->object
)
16401 glyph
->pixel_width
,
16405 glyph
->left_box_line_p
,
16406 glyph
->right_box_line_p
);
16408 else if (glyph
->type
== COMPOSITE_GLYPH
)
16411 " %5d %4c %6d %c %3d 0x%05x",
16412 glyph
- row
->glyphs
[TEXT_AREA
],
16415 (BUFFERP (glyph
->object
)
16417 : (STRINGP (glyph
->object
)
16420 glyph
->pixel_width
,
16422 if (glyph
->u
.cmp
.automatic
)
16425 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16426 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16428 glyph
->left_box_line_p
,
16429 glyph
->right_box_line_p
);
16434 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16435 GLYPHS 0 means don't show glyph contents.
16436 GLYPHS 1 means show glyphs in short form
16437 GLYPHS > 1 means show glyphs in long form. */
16440 dump_glyph_row (row
, vpos
, glyphs
)
16441 struct glyph_row
*row
;
16446 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16447 fprintf (stderr
, "======================================================================\n");
16449 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16450 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16452 MATRIX_ROW_START_CHARPOS (row
),
16453 MATRIX_ROW_END_CHARPOS (row
),
16454 row
->used
[TEXT_AREA
],
16455 row
->contains_overlapping_glyphs_p
,
16457 row
->truncated_on_left_p
,
16458 row
->truncated_on_right_p
,
16460 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16461 row
->displays_text_p
,
16464 row
->ends_in_middle_of_char_p
,
16465 row
->starts_in_middle_of_char_p
,
16471 row
->visible_height
,
16474 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16475 row
->end
.overlay_string_index
,
16476 row
->continuation_lines_width
);
16477 fprintf (stderr
, "%9d %5d\n",
16478 CHARPOS (row
->start
.string_pos
),
16479 CHARPOS (row
->end
.string_pos
));
16480 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16481 row
->end
.dpvec_index
);
16488 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16490 struct glyph
*glyph
= row
->glyphs
[area
];
16491 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16493 /* Glyph for a line end in text. */
16494 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16497 if (glyph
< glyph_end
)
16498 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16500 for (; glyph
< glyph_end
; ++glyph
)
16501 dump_glyph (row
, glyph
, area
);
16504 else if (glyphs
== 1)
16508 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16510 char *s
= (char *) alloca (row
->used
[area
] + 1);
16513 for (i
= 0; i
< row
->used
[area
]; ++i
)
16515 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16516 if (glyph
->type
== CHAR_GLYPH
16517 && glyph
->u
.ch
< 0x80
16518 && glyph
->u
.ch
>= ' ')
16519 s
[i
] = glyph
->u
.ch
;
16525 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16531 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16532 Sdump_glyph_matrix
, 0, 1, "p",
16533 doc
: /* Dump the current matrix of the selected window to stderr.
16534 Shows contents of glyph row structures. With non-nil
16535 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16536 glyphs in short form, otherwise show glyphs in long form. */)
16537 (Lisp_Object glyphs
)
16539 struct window
*w
= XWINDOW (selected_window
);
16540 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16542 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16543 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16544 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16545 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16546 fprintf (stderr
, "=============================================\n");
16547 dump_glyph_matrix (w
->current_matrix
,
16548 NILP (glyphs
) ? 0 : XINT (glyphs
));
16553 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16554 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16557 struct frame
*f
= XFRAME (selected_frame
);
16558 dump_glyph_matrix (f
->current_matrix
, 1);
16563 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16564 doc
: /* Dump glyph row ROW to stderr.
16565 GLYPH 0 means don't dump glyphs.
16566 GLYPH 1 means dump glyphs in short form.
16567 GLYPH > 1 or omitted means dump glyphs in long form. */)
16568 (Lisp_Object row
, Lisp_Object glyphs
)
16570 struct glyph_matrix
*matrix
;
16573 CHECK_NUMBER (row
);
16574 matrix
= XWINDOW (selected_window
)->current_matrix
;
16576 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16577 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16579 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16584 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16585 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16586 GLYPH 0 means don't dump glyphs.
16587 GLYPH 1 means dump glyphs in short form.
16588 GLYPH > 1 or omitted means dump glyphs in long form. */)
16589 (Lisp_Object row
, Lisp_Object glyphs
)
16591 struct frame
*sf
= SELECTED_FRAME ();
16592 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16595 CHECK_NUMBER (row
);
16597 if (vpos
>= 0 && vpos
< m
->nrows
)
16598 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16599 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16604 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16605 doc
: /* Toggle tracing of redisplay.
16606 With ARG, turn tracing on if and only if ARG is positive. */)
16610 trace_redisplay_p
= !trace_redisplay_p
;
16613 arg
= Fprefix_numeric_value (arg
);
16614 trace_redisplay_p
= XINT (arg
) > 0;
16621 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16622 doc
: /* Like `format', but print result to stderr.
16623 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16624 (size_t nargs
, Lisp_Object
*args
)
16626 Lisp_Object s
= Fformat (nargs
, args
);
16627 fprintf (stderr
, "%s", SDATA (s
));
16631 #endif /* GLYPH_DEBUG */
16635 /***********************************************************************
16636 Building Desired Matrix Rows
16637 ***********************************************************************/
16639 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16640 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16642 static struct glyph_row
*
16643 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16645 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16646 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16647 struct buffer
*old
= current_buffer
;
16648 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16649 int arrow_len
= SCHARS (overlay_arrow_string
);
16650 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16651 const unsigned char *p
;
16654 int n_glyphs_before
;
16656 set_buffer_temp (buffer
);
16657 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16658 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16659 SET_TEXT_POS (it
.position
, 0, 0);
16661 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
16663 while (p
< arrow_end
)
16665 Lisp_Object face
, ilisp
;
16667 /* Get the next character. */
16669 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16672 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16673 if (! ASCII_CHAR_P (it
.c
))
16674 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16678 /* Get its face. */
16679 ilisp
= make_number (p
- arrow_string
);
16680 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16681 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16683 /* Compute its width, get its glyphs. */
16684 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16685 SET_TEXT_POS (it
.position
, -1, -1);
16686 PRODUCE_GLYPHS (&it
);
16688 /* If this character doesn't fit any more in the line, we have
16689 to remove some glyphs. */
16690 if (it
.current_x
> it
.last_visible_x
)
16692 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16697 set_buffer_temp (old
);
16698 return it
.glyph_row
;
16702 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16703 glyphs are only inserted for terminal frames since we can't really
16704 win with truncation glyphs when partially visible glyphs are
16705 involved. Which glyphs to insert is determined by
16706 produce_special_glyphs. */
16709 insert_left_trunc_glyphs (struct it
*it
)
16711 struct it truncate_it
;
16712 struct glyph
*from
, *end
, *to
, *toend
;
16714 xassert (!FRAME_WINDOW_P (it
->f
));
16716 /* Get the truncation glyphs. */
16718 truncate_it
.current_x
= 0;
16719 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16720 truncate_it
.glyph_row
= &scratch_glyph_row
;
16721 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16722 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16723 truncate_it
.object
= make_number (0);
16724 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16726 /* Overwrite glyphs from IT with truncation glyphs. */
16727 if (!it
->glyph_row
->reversed_p
)
16729 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16730 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16731 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16732 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16737 /* There may be padding glyphs left over. Overwrite them too. */
16738 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16740 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16746 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16750 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16751 that back to front. */
16752 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16753 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16754 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16755 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16757 while (from
>= end
&& to
>= toend
)
16759 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16762 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16763 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16764 while (from
>= end
&& to
>= toend
)
16769 /* Need to free some room before prepending additional
16771 int move_by
= from
- end
+ 1;
16772 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16773 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16775 for ( ; g
>= g0
; g
--)
16777 while (from
>= end
)
16779 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16785 /* Compute the pixel height and width of IT->glyph_row.
16787 Most of the time, ascent and height of a display line will be equal
16788 to the max_ascent and max_height values of the display iterator
16789 structure. This is not the case if
16791 1. We hit ZV without displaying anything. In this case, max_ascent
16792 and max_height will be zero.
16794 2. We have some glyphs that don't contribute to the line height.
16795 (The glyph row flag contributes_to_line_height_p is for future
16796 pixmap extensions).
16798 The first case is easily covered by using default values because in
16799 these cases, the line height does not really matter, except that it
16800 must not be zero. */
16803 compute_line_metrics (struct it
*it
)
16805 struct glyph_row
*row
= it
->glyph_row
;
16807 if (FRAME_WINDOW_P (it
->f
))
16809 int i
, min_y
, max_y
;
16811 /* The line may consist of one space only, that was added to
16812 place the cursor on it. If so, the row's height hasn't been
16814 if (row
->height
== 0)
16816 if (it
->max_ascent
+ it
->max_descent
== 0)
16817 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16818 row
->ascent
= it
->max_ascent
;
16819 row
->height
= it
->max_ascent
+ it
->max_descent
;
16820 row
->phys_ascent
= it
->max_phys_ascent
;
16821 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16822 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16825 /* Compute the width of this line. */
16826 row
->pixel_width
= row
->x
;
16827 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16828 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16830 xassert (row
->pixel_width
>= 0);
16831 xassert (row
->ascent
>= 0 && row
->height
> 0);
16833 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16834 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16836 /* If first line's physical ascent is larger than its logical
16837 ascent, use the physical ascent, and make the row taller.
16838 This makes accented characters fully visible. */
16839 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16840 && row
->phys_ascent
> row
->ascent
)
16842 row
->height
+= row
->phys_ascent
- row
->ascent
;
16843 row
->ascent
= row
->phys_ascent
;
16846 /* Compute how much of the line is visible. */
16847 row
->visible_height
= row
->height
;
16849 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16850 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16852 if (row
->y
< min_y
)
16853 row
->visible_height
-= min_y
- row
->y
;
16854 if (row
->y
+ row
->height
> max_y
)
16855 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16859 row
->pixel_width
= row
->used
[TEXT_AREA
];
16860 if (row
->continued_p
)
16861 row
->pixel_width
-= it
->continuation_pixel_width
;
16862 else if (row
->truncated_on_right_p
)
16863 row
->pixel_width
-= it
->truncation_pixel_width
;
16864 row
->ascent
= row
->phys_ascent
= 0;
16865 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16866 row
->extra_line_spacing
= 0;
16869 /* Compute a hash code for this row. */
16873 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16874 for (i
= 0; i
< row
->used
[area
]; ++i
)
16875 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16876 + row
->glyphs
[area
][i
].u
.val
16877 + row
->glyphs
[area
][i
].face_id
16878 + row
->glyphs
[area
][i
].padding_p
16879 + (row
->glyphs
[area
][i
].type
<< 2));
16882 it
->max_ascent
= it
->max_descent
= 0;
16883 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16887 /* Append one space to the glyph row of iterator IT if doing a
16888 window-based redisplay. The space has the same face as
16889 IT->face_id. Value is non-zero if a space was added.
16891 This function is called to make sure that there is always one glyph
16892 at the end of a glyph row that the cursor can be set on under
16893 window-systems. (If there weren't such a glyph we would not know
16894 how wide and tall a box cursor should be displayed).
16896 At the same time this space let's a nicely handle clearing to the
16897 end of the line if the row ends in italic text. */
16900 append_space_for_newline (struct it
*it
, int default_face_p
)
16902 if (FRAME_WINDOW_P (it
->f
))
16904 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16906 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16907 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16909 /* Save some values that must not be changed.
16910 Must save IT->c and IT->len because otherwise
16911 ITERATOR_AT_END_P wouldn't work anymore after
16912 append_space_for_newline has been called. */
16913 enum display_element_type saved_what
= it
->what
;
16914 int saved_c
= it
->c
, saved_len
= it
->len
;
16915 int saved_char_to_display
= it
->char_to_display
;
16916 int saved_x
= it
->current_x
;
16917 int saved_face_id
= it
->face_id
;
16918 struct text_pos saved_pos
;
16919 Lisp_Object saved_object
;
16922 saved_object
= it
->object
;
16923 saved_pos
= it
->position
;
16925 it
->what
= IT_CHARACTER
;
16926 memset (&it
->position
, 0, sizeof it
->position
);
16927 it
->object
= make_number (0);
16928 it
->c
= it
->char_to_display
= ' ';
16931 if (default_face_p
)
16932 it
->face_id
= DEFAULT_FACE_ID
;
16933 else if (it
->face_before_selective_p
)
16934 it
->face_id
= it
->saved_face_id
;
16935 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16936 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16938 PRODUCE_GLYPHS (it
);
16940 it
->override_ascent
= -1;
16941 it
->constrain_row_ascent_descent_p
= 0;
16942 it
->current_x
= saved_x
;
16943 it
->object
= saved_object
;
16944 it
->position
= saved_pos
;
16945 it
->what
= saved_what
;
16946 it
->face_id
= saved_face_id
;
16947 it
->len
= saved_len
;
16949 it
->char_to_display
= saved_char_to_display
;
16958 /* Extend the face of the last glyph in the text area of IT->glyph_row
16959 to the end of the display line. Called from display_line. If the
16960 glyph row is empty, add a space glyph to it so that we know the
16961 face to draw. Set the glyph row flag fill_line_p. If the glyph
16962 row is R2L, prepend a stretch glyph to cover the empty space to the
16963 left of the leftmost glyph. */
16966 extend_face_to_end_of_line (struct it
*it
)
16969 struct frame
*f
= it
->f
;
16971 /* If line is already filled, do nothing. Non window-system frames
16972 get a grace of one more ``pixel'' because their characters are
16973 1-``pixel'' wide, so they hit the equality too early. This grace
16974 is needed only for R2L rows that are not continued, to produce
16975 one extra blank where we could display the cursor. */
16976 if (it
->current_x
>= it
->last_visible_x
16977 + (!FRAME_WINDOW_P (f
)
16978 && it
->glyph_row
->reversed_p
16979 && !it
->glyph_row
->continued_p
))
16982 /* Face extension extends the background and box of IT->face_id
16983 to the end of the line. If the background equals the background
16984 of the frame, we don't have to do anything. */
16985 if (it
->face_before_selective_p
)
16986 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16988 face
= FACE_FROM_ID (f
, it
->face_id
);
16990 if (FRAME_WINDOW_P (f
)
16991 && it
->glyph_row
->displays_text_p
16992 && face
->box
== FACE_NO_BOX
16993 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16995 && !it
->glyph_row
->reversed_p
)
16998 /* Set the glyph row flag indicating that the face of the last glyph
16999 in the text area has to be drawn to the end of the text area. */
17000 it
->glyph_row
->fill_line_p
= 1;
17002 /* If current character of IT is not ASCII, make sure we have the
17003 ASCII face. This will be automatically undone the next time
17004 get_next_display_element returns a multibyte character. Note
17005 that the character will always be single byte in unibyte
17007 if (!ASCII_CHAR_P (it
->c
))
17009 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17012 if (FRAME_WINDOW_P (f
))
17014 /* If the row is empty, add a space with the current face of IT,
17015 so that we know which face to draw. */
17016 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17018 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17019 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17020 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17022 #ifdef HAVE_WINDOW_SYSTEM
17023 if (it
->glyph_row
->reversed_p
)
17025 /* Prepend a stretch glyph to the row, such that the
17026 rightmost glyph will be drawn flushed all the way to the
17027 right margin of the window. The stretch glyph that will
17028 occupy the empty space, if any, to the left of the
17030 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17031 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17032 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17034 int row_width
, stretch_ascent
, stretch_width
;
17035 struct text_pos saved_pos
;
17036 int saved_face_id
, saved_avoid_cursor
;
17038 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17039 row_width
+= g
->pixel_width
;
17040 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17041 if (stretch_width
> 0)
17044 (((it
->ascent
+ it
->descent
)
17045 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17046 saved_pos
= it
->position
;
17047 memset (&it
->position
, 0, sizeof it
->position
);
17048 saved_avoid_cursor
= it
->avoid_cursor_p
;
17049 it
->avoid_cursor_p
= 1;
17050 saved_face_id
= it
->face_id
;
17051 /* The last row's stretch glyph should get the default
17052 face, to avoid painting the rest of the window with
17053 the region face, if the region ends at ZV. */
17054 if (it
->glyph_row
->ends_at_zv_p
)
17055 it
->face_id
= DEFAULT_FACE_ID
;
17057 it
->face_id
= face
->id
;
17058 append_stretch_glyph (it
, make_number (0), stretch_width
,
17059 it
->ascent
+ it
->descent
, stretch_ascent
);
17060 it
->position
= saved_pos
;
17061 it
->avoid_cursor_p
= saved_avoid_cursor
;
17062 it
->face_id
= saved_face_id
;
17065 #endif /* HAVE_WINDOW_SYSTEM */
17069 /* Save some values that must not be changed. */
17070 int saved_x
= it
->current_x
;
17071 struct text_pos saved_pos
;
17072 Lisp_Object saved_object
;
17073 enum display_element_type saved_what
= it
->what
;
17074 int saved_face_id
= it
->face_id
;
17076 saved_object
= it
->object
;
17077 saved_pos
= it
->position
;
17079 it
->what
= IT_CHARACTER
;
17080 memset (&it
->position
, 0, sizeof it
->position
);
17081 it
->object
= make_number (0);
17082 it
->c
= it
->char_to_display
= ' ';
17084 /* The last row's blank glyphs should get the default face, to
17085 avoid painting the rest of the window with the region face,
17086 if the region ends at ZV. */
17087 if (it
->glyph_row
->ends_at_zv_p
)
17088 it
->face_id
= DEFAULT_FACE_ID
;
17090 it
->face_id
= face
->id
;
17092 PRODUCE_GLYPHS (it
);
17094 while (it
->current_x
<= it
->last_visible_x
)
17095 PRODUCE_GLYPHS (it
);
17097 /* Don't count these blanks really. It would let us insert a left
17098 truncation glyph below and make us set the cursor on them, maybe. */
17099 it
->current_x
= saved_x
;
17100 it
->object
= saved_object
;
17101 it
->position
= saved_pos
;
17102 it
->what
= saved_what
;
17103 it
->face_id
= saved_face_id
;
17108 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17109 trailing whitespace. */
17112 trailing_whitespace_p (EMACS_INT charpos
)
17114 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17117 while (bytepos
< ZV_BYTE
17118 && (c
= FETCH_CHAR (bytepos
),
17119 c
== ' ' || c
== '\t'))
17122 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17124 if (bytepos
!= PT_BYTE
)
17131 /* Highlight trailing whitespace, if any, in ROW. */
17134 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17136 int used
= row
->used
[TEXT_AREA
];
17140 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17141 struct glyph
*glyph
= start
+ used
- 1;
17143 if (row
->reversed_p
)
17145 /* Right-to-left rows need to be processed in the opposite
17146 direction, so swap the edge pointers. */
17148 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17151 /* Skip over glyphs inserted to display the cursor at the
17152 end of a line, for extending the face of the last glyph
17153 to the end of the line on terminals, and for truncation
17154 and continuation glyphs. */
17155 if (!row
->reversed_p
)
17157 while (glyph
>= start
17158 && glyph
->type
== CHAR_GLYPH
17159 && INTEGERP (glyph
->object
))
17164 while (glyph
<= start
17165 && glyph
->type
== CHAR_GLYPH
17166 && INTEGERP (glyph
->object
))
17170 /* If last glyph is a space or stretch, and it's trailing
17171 whitespace, set the face of all trailing whitespace glyphs in
17172 IT->glyph_row to `trailing-whitespace'. */
17173 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17174 && BUFFERP (glyph
->object
)
17175 && (glyph
->type
== STRETCH_GLYPH
17176 || (glyph
->type
== CHAR_GLYPH
17177 && glyph
->u
.ch
== ' '))
17178 && trailing_whitespace_p (glyph
->charpos
))
17180 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17184 if (!row
->reversed_p
)
17186 while (glyph
>= start
17187 && BUFFERP (glyph
->object
)
17188 && (glyph
->type
== STRETCH_GLYPH
17189 || (glyph
->type
== CHAR_GLYPH
17190 && glyph
->u
.ch
== ' ')))
17191 (glyph
--)->face_id
= face_id
;
17195 while (glyph
<= start
17196 && BUFFERP (glyph
->object
)
17197 && (glyph
->type
== STRETCH_GLYPH
17198 || (glyph
->type
== CHAR_GLYPH
17199 && glyph
->u
.ch
== ' ')))
17200 (glyph
++)->face_id
= face_id
;
17207 /* Value is non-zero if glyph row ROW should be
17208 used to hold the cursor. */
17211 cursor_row_p (struct glyph_row
*row
)
17215 if (PT
== CHARPOS (row
->end
.pos
))
17217 /* Suppose the row ends on a string.
17218 Unless the row is continued, that means it ends on a newline
17219 in the string. If it's anything other than a display string
17220 (e.g. a before-string from an overlay), we don't want the
17221 cursor there. (This heuristic seems to give the optimal
17222 behavior for the various types of multi-line strings.) */
17223 if (CHARPOS (row
->end
.string_pos
) >= 0)
17225 if (row
->continued_p
)
17229 /* Check for `display' property. */
17230 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17231 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17232 struct glyph
*glyph
;
17235 for (glyph
= end
; glyph
>= beg
; --glyph
)
17236 if (STRINGP (glyph
->object
))
17239 = Fget_char_property (make_number (PT
),
17243 && display_prop_string_p (prop
, glyph
->object
));
17248 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17250 /* If the row ends in middle of a real character,
17251 and the line is continued, we want the cursor here.
17252 That's because CHARPOS (ROW->end.pos) would equal
17253 PT if PT is before the character. */
17254 if (!row
->ends_in_ellipsis_p
)
17255 result
= row
->continued_p
;
17257 /* If the row ends in an ellipsis, then
17258 CHARPOS (ROW->end.pos) will equal point after the
17259 invisible text. We want that position to be displayed
17260 after the ellipsis. */
17263 /* If the row ends at ZV, display the cursor at the end of that
17264 row instead of at the start of the row below. */
17265 else if (row
->ends_at_zv_p
)
17276 /* Push the display property PROP so that it will be rendered at the
17277 current position in IT. Return 1 if PROP was successfully pushed,
17281 push_display_prop (struct it
*it
, Lisp_Object prop
)
17283 push_it (it
, NULL
);
17285 if (STRINGP (prop
))
17287 if (SCHARS (prop
) == 0)
17294 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17295 it
->current
.overlay_string_index
= -1;
17296 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17297 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17298 it
->method
= GET_FROM_STRING
;
17299 it
->stop_charpos
= 0;
17301 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17303 it
->method
= GET_FROM_STRETCH
;
17306 #ifdef HAVE_WINDOW_SYSTEM
17307 else if (IMAGEP (prop
))
17309 it
->what
= IT_IMAGE
;
17310 it
->image_id
= lookup_image (it
->f
, prop
);
17311 it
->method
= GET_FROM_IMAGE
;
17313 #endif /* HAVE_WINDOW_SYSTEM */
17316 pop_it (it
); /* bogus display property, give up */
17323 /* Return the character-property PROP at the current position in IT. */
17326 get_it_property (struct it
*it
, Lisp_Object prop
)
17328 Lisp_Object position
;
17330 if (STRINGP (it
->object
))
17331 position
= make_number (IT_STRING_CHARPOS (*it
));
17332 else if (BUFFERP (it
->object
))
17333 position
= make_number (IT_CHARPOS (*it
));
17337 return Fget_char_property (position
, prop
, it
->object
);
17340 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17343 handle_line_prefix (struct it
*it
)
17345 Lisp_Object prefix
;
17346 if (it
->continuation_lines_width
> 0)
17348 prefix
= get_it_property (it
, Qwrap_prefix
);
17350 prefix
= Vwrap_prefix
;
17354 prefix
= get_it_property (it
, Qline_prefix
);
17356 prefix
= Vline_prefix
;
17358 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17360 /* If the prefix is wider than the window, and we try to wrap
17361 it, it would acquire its own wrap prefix, and so on till the
17362 iterator stack overflows. So, don't wrap the prefix. */
17363 it
->line_wrap
= TRUNCATE
;
17364 it
->avoid_cursor_p
= 1;
17370 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17371 only for R2L lines from display_line, when it decides that too many
17372 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17375 unproduce_glyphs (struct it
*it
, int n
)
17377 struct glyph
*glyph
, *end
;
17379 xassert (it
->glyph_row
);
17380 xassert (it
->glyph_row
->reversed_p
);
17381 xassert (it
->area
== TEXT_AREA
);
17382 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17384 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17385 n
= it
->glyph_row
->used
[TEXT_AREA
];
17386 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17387 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17388 for ( ; glyph
< end
; glyph
++)
17389 glyph
[-n
] = *glyph
;
17392 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17393 and ROW->maxpos. */
17395 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17396 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17397 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17399 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17400 lines' rows is implemented for bidi-reordered rows. */
17402 /* ROW->minpos is the value of min_pos, the minimal buffer position
17405 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17407 /* We didn't find _any_ valid buffer positions in any of the
17408 glyphs, so we must trust the iterator's computed positions. */
17409 row
->minpos
= row
->start
.pos
;
17412 max_pos
= CHARPOS (it
->current
.pos
);
17413 max_bpos
= BYTEPOS (it
->current
.pos
);
17416 /* Here are the various use-cases for ending the row, and the
17417 corresponding values for ROW->maxpos:
17419 Line ends in a newline from buffer eol_pos + 1
17420 Line is continued from buffer max_pos + 1
17421 Line is truncated on right it->current.pos
17422 Line ends in a newline from string max_pos
17423 Line is continued from string max_pos
17424 Line is continued from display vector max_pos
17425 Line is entirely from a string min_pos == max_pos
17426 Line is entirely from a display vector min_pos == max_pos
17427 Line that ends at ZV ZV
17429 If you discover other use-cases, please add them here as
17431 if (row
->ends_at_zv_p
)
17432 row
->maxpos
= it
->current
.pos
;
17433 else if (row
->used
[TEXT_AREA
])
17435 if (row
->ends_in_newline_from_string_p
)
17436 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17437 else if (CHARPOS (it
->eol_pos
) > 0)
17438 SET_TEXT_POS (row
->maxpos
,
17439 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17440 else if (row
->continued_p
)
17442 /* If max_pos is different from IT's current position, it
17443 means IT->method does not belong to the display element
17444 at max_pos. However, it also means that the display
17445 element at max_pos was displayed in its entirety on this
17446 line, which is equivalent to saying that the next line
17447 starts at the next buffer position. */
17448 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17449 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17452 INC_BOTH (max_pos
, max_bpos
);
17453 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17456 else if (row
->truncated_on_right_p
)
17457 /* display_line already called reseat_at_next_visible_line_start,
17458 which puts the iterator at the beginning of the next line, in
17459 the logical order. */
17460 row
->maxpos
= it
->current
.pos
;
17461 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17462 /* A line that is entirely from a string/image/stretch... */
17463 row
->maxpos
= row
->minpos
;
17468 row
->maxpos
= it
->current
.pos
;
17471 /* Construct the glyph row IT->glyph_row in the desired matrix of
17472 IT->w from text at the current position of IT. See dispextern.h
17473 for an overview of struct it. Value is non-zero if
17474 IT->glyph_row displays text, as opposed to a line displaying ZV
17478 display_line (struct it
*it
)
17480 struct glyph_row
*row
= it
->glyph_row
;
17481 Lisp_Object overlay_arrow_string
;
17483 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
17484 int wrap_row_used
= -1;
17485 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
17486 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
17487 int wrap_row_extra_line_spacing
IF_LINT (= 0);
17488 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
17489 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
17491 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17492 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
17494 /* We always start displaying at hpos zero even if hscrolled. */
17495 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17497 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17498 >= it
->w
->desired_matrix
->nrows
)
17500 it
->w
->nrows_scale_factor
++;
17501 fonts_changed_p
= 1;
17505 /* Is IT->w showing the region? */
17506 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17508 /* Clear the result glyph row and enable it. */
17509 prepare_desired_row (row
);
17511 row
->y
= it
->current_y
;
17512 row
->start
= it
->start
;
17513 row
->continuation_lines_width
= it
->continuation_lines_width
;
17514 row
->displays_text_p
= 1;
17515 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17516 it
->starts_in_middle_of_char_p
= 0;
17518 /* Arrange the overlays nicely for our purposes. Usually, we call
17519 display_line on only one line at a time, in which case this
17520 can't really hurt too much, or we call it on lines which appear
17521 one after another in the buffer, in which case all calls to
17522 recenter_overlay_lists but the first will be pretty cheap. */
17523 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17525 /* Move over display elements that are not visible because we are
17526 hscrolled. This may stop at an x-position < IT->first_visible_x
17527 if the first glyph is partially visible or if we hit a line end. */
17528 if (it
->current_x
< it
->first_visible_x
)
17530 this_line_min_pos
= row
->start
.pos
;
17531 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17532 MOVE_TO_POS
| MOVE_TO_X
);
17533 /* Record the smallest positions seen while we moved over
17534 display elements that are not visible. This is needed by
17535 redisplay_internal for optimizing the case where the cursor
17536 stays inside the same line. The rest of this function only
17537 considers positions that are actually displayed, so
17538 RECORD_MAX_MIN_POS will not otherwise record positions that
17539 are hscrolled to the left of the left edge of the window. */
17540 min_pos
= CHARPOS (this_line_min_pos
);
17541 min_bpos
= BYTEPOS (this_line_min_pos
);
17545 /* We only do this when not calling `move_it_in_display_line_to'
17546 above, because move_it_in_display_line_to calls
17547 handle_line_prefix itself. */
17548 handle_line_prefix (it
);
17551 /* Get the initial row height. This is either the height of the
17552 text hscrolled, if there is any, or zero. */
17553 row
->ascent
= it
->max_ascent
;
17554 row
->height
= it
->max_ascent
+ it
->max_descent
;
17555 row
->phys_ascent
= it
->max_phys_ascent
;
17556 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17557 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17559 /* Utility macro to record max and min buffer positions seen until now. */
17560 #define RECORD_MAX_MIN_POS(IT) \
17563 if (IT_CHARPOS (*(IT)) < min_pos) \
17565 min_pos = IT_CHARPOS (*(IT)); \
17566 min_bpos = IT_BYTEPOS (*(IT)); \
17568 if (IT_CHARPOS (*(IT)) > max_pos) \
17570 max_pos = IT_CHARPOS (*(IT)); \
17571 max_bpos = IT_BYTEPOS (*(IT)); \
17576 /* Loop generating characters. The loop is left with IT on the next
17577 character to display. */
17580 int n_glyphs_before
, hpos_before
, x_before
;
17582 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17584 /* Retrieve the next thing to display. Value is zero if end of
17586 if (!get_next_display_element (it
))
17588 /* Maybe add a space at the end of this line that is used to
17589 display the cursor there under X. Set the charpos of the
17590 first glyph of blank lines not corresponding to any text
17592 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17593 row
->exact_window_width_line_p
= 1;
17594 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17595 || row
->used
[TEXT_AREA
] == 0)
17597 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17598 row
->displays_text_p
= 0;
17600 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
17601 && (!MINI_WINDOW_P (it
->w
)
17602 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17603 row
->indicate_empty_line_p
= 1;
17606 it
->continuation_lines_width
= 0;
17607 row
->ends_at_zv_p
= 1;
17608 /* A row that displays right-to-left text must always have
17609 its last face extended all the way to the end of line,
17610 even if this row ends in ZV, because we still write to
17611 the screen left to right. */
17612 if (row
->reversed_p
)
17613 extend_face_to_end_of_line (it
);
17617 /* Now, get the metrics of what we want to display. This also
17618 generates glyphs in `row' (which is IT->glyph_row). */
17619 n_glyphs_before
= row
->used
[TEXT_AREA
];
17622 /* Remember the line height so far in case the next element doesn't
17623 fit on the line. */
17624 if (it
->line_wrap
!= TRUNCATE
)
17626 ascent
= it
->max_ascent
;
17627 descent
= it
->max_descent
;
17628 phys_ascent
= it
->max_phys_ascent
;
17629 phys_descent
= it
->max_phys_descent
;
17631 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17633 if (IT_DISPLAYING_WHITESPACE (it
))
17639 wrap_row_used
= row
->used
[TEXT_AREA
];
17640 wrap_row_ascent
= row
->ascent
;
17641 wrap_row_height
= row
->height
;
17642 wrap_row_phys_ascent
= row
->phys_ascent
;
17643 wrap_row_phys_height
= row
->phys_height
;
17644 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17645 wrap_row_min_pos
= min_pos
;
17646 wrap_row_min_bpos
= min_bpos
;
17647 wrap_row_max_pos
= max_pos
;
17648 wrap_row_max_bpos
= max_bpos
;
17654 PRODUCE_GLYPHS (it
);
17656 /* If this display element was in marginal areas, continue with
17658 if (it
->area
!= TEXT_AREA
)
17660 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17661 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17662 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17663 row
->phys_height
= max (row
->phys_height
,
17664 it
->max_phys_ascent
+ it
->max_phys_descent
);
17665 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17666 it
->max_extra_line_spacing
);
17667 set_iterator_to_next (it
, 1);
17671 /* Does the display element fit on the line? If we truncate
17672 lines, we should draw past the right edge of the window. If
17673 we don't truncate, we want to stop so that we can display the
17674 continuation glyph before the right margin. If lines are
17675 continued, there are two possible strategies for characters
17676 resulting in more than 1 glyph (e.g. tabs): Display as many
17677 glyphs as possible in this line and leave the rest for the
17678 continuation line, or display the whole element in the next
17679 line. Original redisplay did the former, so we do it also. */
17680 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17681 hpos_before
= it
->hpos
;
17684 if (/* Not a newline. */
17686 /* Glyphs produced fit entirely in the line. */
17687 && it
->current_x
< it
->last_visible_x
)
17689 it
->hpos
+= nglyphs
;
17690 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17691 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17692 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17693 row
->phys_height
= max (row
->phys_height
,
17694 it
->max_phys_ascent
+ it
->max_phys_descent
);
17695 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17696 it
->max_extra_line_spacing
);
17697 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17698 row
->x
= x
- it
->first_visible_x
;
17699 /* Record the maximum and minimum buffer positions seen so
17700 far in glyphs that will be displayed by this row. */
17702 RECORD_MAX_MIN_POS (it
);
17707 struct glyph
*glyph
;
17709 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17711 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17712 new_x
= x
+ glyph
->pixel_width
;
17714 if (/* Lines are continued. */
17715 it
->line_wrap
!= TRUNCATE
17716 && (/* Glyph doesn't fit on the line. */
17717 new_x
> it
->last_visible_x
17718 /* Or it fits exactly on a window system frame. */
17719 || (new_x
== it
->last_visible_x
17720 && FRAME_WINDOW_P (it
->f
))))
17722 /* End of a continued line. */
17725 || (new_x
== it
->last_visible_x
17726 && FRAME_WINDOW_P (it
->f
)))
17728 /* Current glyph is the only one on the line or
17729 fits exactly on the line. We must continue
17730 the line because we can't draw the cursor
17731 after the glyph. */
17732 row
->continued_p
= 1;
17733 it
->current_x
= new_x
;
17734 it
->continuation_lines_width
+= new_x
;
17736 /* Record the maximum and minimum buffer
17737 positions seen so far in glyphs that will be
17738 displayed by this row. */
17740 RECORD_MAX_MIN_POS (it
);
17741 if (i
== nglyphs
- 1)
17743 /* If line-wrap is on, check if a previous
17744 wrap point was found. */
17745 if (wrap_row_used
> 0
17746 /* Even if there is a previous wrap
17747 point, continue the line here as
17748 usual, if (i) the previous character
17749 was a space or tab AND (ii) the
17750 current character is not. */
17752 || IT_DISPLAYING_WHITESPACE (it
)))
17755 set_iterator_to_next (it
, 1);
17756 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17758 if (!get_next_display_element (it
))
17760 row
->exact_window_width_line_p
= 1;
17761 it
->continuation_lines_width
= 0;
17762 row
->continued_p
= 0;
17763 row
->ends_at_zv_p
= 1;
17765 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17767 row
->continued_p
= 0;
17768 row
->exact_window_width_line_p
= 1;
17773 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17774 && !FRAME_WINDOW_P (it
->f
))
17776 /* A padding glyph that doesn't fit on this line.
17777 This means the whole character doesn't fit
17779 if (row
->reversed_p
)
17780 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17781 - n_glyphs_before
);
17782 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17784 /* Fill the rest of the row with continuation
17785 glyphs like in 20.x. */
17786 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17787 < row
->glyphs
[1 + TEXT_AREA
])
17788 produce_special_glyphs (it
, IT_CONTINUATION
);
17790 row
->continued_p
= 1;
17791 it
->current_x
= x_before
;
17792 it
->continuation_lines_width
+= x_before
;
17794 /* Restore the height to what it was before the
17795 element not fitting on the line. */
17796 it
->max_ascent
= ascent
;
17797 it
->max_descent
= descent
;
17798 it
->max_phys_ascent
= phys_ascent
;
17799 it
->max_phys_descent
= phys_descent
;
17801 else if (wrap_row_used
> 0)
17804 if (row
->reversed_p
)
17805 unproduce_glyphs (it
,
17806 row
->used
[TEXT_AREA
] - wrap_row_used
);
17808 it
->continuation_lines_width
+= wrap_x
;
17809 row
->used
[TEXT_AREA
] = wrap_row_used
;
17810 row
->ascent
= wrap_row_ascent
;
17811 row
->height
= wrap_row_height
;
17812 row
->phys_ascent
= wrap_row_phys_ascent
;
17813 row
->phys_height
= wrap_row_phys_height
;
17814 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17815 min_pos
= wrap_row_min_pos
;
17816 min_bpos
= wrap_row_min_bpos
;
17817 max_pos
= wrap_row_max_pos
;
17818 max_bpos
= wrap_row_max_bpos
;
17819 row
->continued_p
= 1;
17820 row
->ends_at_zv_p
= 0;
17821 row
->exact_window_width_line_p
= 0;
17822 it
->continuation_lines_width
+= x
;
17824 /* Make sure that a non-default face is extended
17825 up to the right margin of the window. */
17826 extend_face_to_end_of_line (it
);
17828 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17830 /* A TAB that extends past the right edge of the
17831 window. This produces a single glyph on
17832 window system frames. We leave the glyph in
17833 this row and let it fill the row, but don't
17834 consume the TAB. */
17835 it
->continuation_lines_width
+= it
->last_visible_x
;
17836 row
->ends_in_middle_of_char_p
= 1;
17837 row
->continued_p
= 1;
17838 glyph
->pixel_width
= it
->last_visible_x
- x
;
17839 it
->starts_in_middle_of_char_p
= 1;
17843 /* Something other than a TAB that draws past
17844 the right edge of the window. Restore
17845 positions to values before the element. */
17846 if (row
->reversed_p
)
17847 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17848 - (n_glyphs_before
+ i
));
17849 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17851 /* Display continuation glyphs. */
17852 if (!FRAME_WINDOW_P (it
->f
))
17853 produce_special_glyphs (it
, IT_CONTINUATION
);
17854 row
->continued_p
= 1;
17856 it
->current_x
= x_before
;
17857 it
->continuation_lines_width
+= x
;
17858 extend_face_to_end_of_line (it
);
17860 if (nglyphs
> 1 && i
> 0)
17862 row
->ends_in_middle_of_char_p
= 1;
17863 it
->starts_in_middle_of_char_p
= 1;
17866 /* Restore the height to what it was before the
17867 element not fitting on the line. */
17868 it
->max_ascent
= ascent
;
17869 it
->max_descent
= descent
;
17870 it
->max_phys_ascent
= phys_ascent
;
17871 it
->max_phys_descent
= phys_descent
;
17876 else if (new_x
> it
->first_visible_x
)
17878 /* Increment number of glyphs actually displayed. */
17881 /* Record the maximum and minimum buffer positions
17882 seen so far in glyphs that will be displayed by
17885 RECORD_MAX_MIN_POS (it
);
17887 if (x
< it
->first_visible_x
)
17888 /* Glyph is partially visible, i.e. row starts at
17889 negative X position. */
17890 row
->x
= x
- it
->first_visible_x
;
17894 /* Glyph is completely off the left margin of the
17895 window. This should not happen because of the
17896 move_it_in_display_line at the start of this
17897 function, unless the text display area of the
17898 window is empty. */
17899 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17903 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17904 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17905 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17906 row
->phys_height
= max (row
->phys_height
,
17907 it
->max_phys_ascent
+ it
->max_phys_descent
);
17908 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17909 it
->max_extra_line_spacing
);
17911 /* End of this display line if row is continued. */
17912 if (row
->continued_p
|| row
->ends_at_zv_p
)
17917 /* Is this a line end? If yes, we're also done, after making
17918 sure that a non-default face is extended up to the right
17919 margin of the window. */
17920 if (ITERATOR_AT_END_OF_LINE_P (it
))
17922 int used_before
= row
->used
[TEXT_AREA
];
17924 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17926 /* Add a space at the end of the line that is used to
17927 display the cursor there. */
17928 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17929 append_space_for_newline (it
, 0);
17931 /* Extend the face to the end of the line. */
17932 extend_face_to_end_of_line (it
);
17934 /* Make sure we have the position. */
17935 if (used_before
== 0)
17936 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17938 /* Record the position of the newline, for use in
17940 it
->eol_pos
= it
->current
.pos
;
17942 /* Consume the line end. This skips over invisible lines. */
17943 set_iterator_to_next (it
, 1);
17944 it
->continuation_lines_width
= 0;
17948 /* Proceed with next display element. Note that this skips
17949 over lines invisible because of selective display. */
17950 set_iterator_to_next (it
, 1);
17952 /* If we truncate lines, we are done when the last displayed
17953 glyphs reach past the right margin of the window. */
17954 if (it
->line_wrap
== TRUNCATE
17955 && (FRAME_WINDOW_P (it
->f
)
17956 ? (it
->current_x
>= it
->last_visible_x
)
17957 : (it
->current_x
> it
->last_visible_x
)))
17959 /* Maybe add truncation glyphs. */
17960 if (!FRAME_WINDOW_P (it
->f
))
17964 if (!row
->reversed_p
)
17966 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17967 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17972 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17973 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17975 /* Remove any padding glyphs at the front of ROW, to
17976 make room for the truncation glyphs we will be
17977 adding below. The loop below always inserts at
17978 least one truncation glyph, so also remove the
17979 last glyph added to ROW. */
17980 unproduce_glyphs (it
, i
+ 1);
17981 /* Adjust i for the loop below. */
17982 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17985 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17987 row
->used
[TEXT_AREA
] = i
;
17988 produce_special_glyphs (it
, IT_TRUNCATION
);
17991 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17993 /* Don't truncate if we can overflow newline into fringe. */
17994 if (!get_next_display_element (it
))
17996 it
->continuation_lines_width
= 0;
17997 row
->ends_at_zv_p
= 1;
17998 row
->exact_window_width_line_p
= 1;
18001 if (ITERATOR_AT_END_OF_LINE_P (it
))
18003 row
->exact_window_width_line_p
= 1;
18004 goto at_end_of_line
;
18008 row
->truncated_on_right_p
= 1;
18009 it
->continuation_lines_width
= 0;
18010 reseat_at_next_visible_line_start (it
, 0);
18011 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18012 it
->hpos
= hpos_before
;
18013 it
->current_x
= x_before
;
18018 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18019 at the left window margin. */
18020 if (it
->first_visible_x
18021 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18023 if (!FRAME_WINDOW_P (it
->f
))
18024 insert_left_trunc_glyphs (it
);
18025 row
->truncated_on_left_p
= 1;
18028 /* Remember the position at which this line ends.
18030 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18031 cannot be before the call to find_row_edges below, since that is
18032 where these positions are determined. */
18033 row
->end
= it
->current
;
18036 row
->minpos
= row
->start
.pos
;
18037 row
->maxpos
= row
->end
.pos
;
18041 /* ROW->minpos and ROW->maxpos must be the smallest and
18042 `1 + the largest' buffer positions in ROW. But if ROW was
18043 bidi-reordered, these two positions can be anywhere in the
18044 row, so we must determine them now. */
18045 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18048 /* If the start of this line is the overlay arrow-position, then
18049 mark this glyph row as the one containing the overlay arrow.
18050 This is clearly a mess with variable size fonts. It would be
18051 better to let it be displayed like cursors under X. */
18052 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18053 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18054 !NILP (overlay_arrow_string
)))
18056 /* Overlay arrow in window redisplay is a fringe bitmap. */
18057 if (STRINGP (overlay_arrow_string
))
18059 struct glyph_row
*arrow_row
18060 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18061 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18062 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18063 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18064 struct glyph
*p2
, *end
;
18066 /* Copy the arrow glyphs. */
18067 while (glyph
< arrow_end
)
18070 /* Throw away padding glyphs. */
18072 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18073 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18079 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18084 xassert (INTEGERP (overlay_arrow_string
));
18085 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18087 overlay_arrow_seen
= 1;
18090 /* Compute pixel dimensions of this line. */
18091 compute_line_metrics (it
);
18093 /* Record whether this row ends inside an ellipsis. */
18094 row
->ends_in_ellipsis_p
18095 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18096 && it
->ellipsis_p
);
18098 /* Save fringe bitmaps in this row. */
18099 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18100 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18101 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18102 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18104 it
->left_user_fringe_bitmap
= 0;
18105 it
->left_user_fringe_face_id
= 0;
18106 it
->right_user_fringe_bitmap
= 0;
18107 it
->right_user_fringe_face_id
= 0;
18109 /* Maybe set the cursor. */
18110 cvpos
= it
->w
->cursor
.vpos
;
18112 /* In bidi-reordered rows, keep checking for proper cursor
18113 position even if one has been found already, because buffer
18114 positions in such rows change non-linearly with ROW->VPOS,
18115 when a line is continued. One exception: when we are at ZV,
18116 display cursor on the first suitable glyph row, since all
18117 the empty rows after that also have their position set to ZV. */
18118 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18119 lines' rows is implemented for bidi-reordered rows. */
18121 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18122 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18123 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18124 && cursor_row_p (row
))
18125 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18127 /* Highlight trailing whitespace. */
18128 if (!NILP (Vshow_trailing_whitespace
))
18129 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18131 /* Prepare for the next line. This line starts horizontally at (X
18132 HPOS) = (0 0). Vertical positions are incremented. As a
18133 convenience for the caller, IT->glyph_row is set to the next
18135 it
->current_x
= it
->hpos
= 0;
18136 it
->current_y
+= row
->height
;
18137 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18140 /* The next row should by default use the same value of the
18141 reversed_p flag as this one. set_iterator_to_next decides when
18142 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18143 the flag accordingly. */
18144 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18145 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18146 it
->start
= row
->end
;
18147 return row
->displays_text_p
;
18149 #undef RECORD_MAX_MIN_POS
18152 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18153 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18154 doc
: /* Return paragraph direction at point in BUFFER.
18155 Value is either `left-to-right' or `right-to-left'.
18156 If BUFFER is omitted or nil, it defaults to the current buffer.
18158 Paragraph direction determines how the text in the paragraph is displayed.
18159 In left-to-right paragraphs, text begins at the left margin of the window
18160 and the reading direction is generally left to right. In right-to-left
18161 paragraphs, text begins at the right margin and is read from right to left.
18163 See also `bidi-paragraph-direction'. */)
18164 (Lisp_Object buffer
)
18166 struct buffer
*buf
= current_buffer
;
18167 struct buffer
*old
= buf
;
18169 if (! NILP (buffer
))
18171 CHECK_BUFFER (buffer
);
18172 buf
= XBUFFER (buffer
);
18175 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18176 return Qleft_to_right
;
18177 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18178 return BVAR (buf
, bidi_paragraph_direction
);
18181 /* Determine the direction from buffer text. We could try to
18182 use current_matrix if it is up to date, but this seems fast
18183 enough as it is. */
18184 struct bidi_it itb
;
18185 EMACS_INT pos
= BUF_PT (buf
);
18186 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18189 set_buffer_temp (buf
);
18190 /* bidi_paragraph_init finds the base direction of the paragraph
18191 by searching forward from paragraph start. We need the base
18192 direction of the current or _previous_ paragraph, so we need
18193 to make sure we are within that paragraph. To that end, find
18194 the previous non-empty line. */
18195 if (pos
>= ZV
&& pos
> BEGV
)
18198 bytepos
= CHAR_TO_BYTE (pos
);
18200 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18201 || c
== ' ' || c
== '\t' || c
== '\f')
18203 if (bytepos
<= BEGV_BYTE
)
18208 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18211 itb
.bytepos
= bytepos
;
18213 itb
.string
.s
= NULL
;
18214 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18216 itb
.separator_limit
= -1;
18217 itb
.paragraph_dir
= NEUTRAL_DIR
;
18219 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18220 set_buffer_temp (old
);
18221 switch (itb
.paragraph_dir
)
18224 return Qleft_to_right
;
18227 return Qright_to_left
;
18237 /***********************************************************************
18239 ***********************************************************************/
18241 /* Redisplay the menu bar in the frame for window W.
18243 The menu bar of X frames that don't have X toolkit support is
18244 displayed in a special window W->frame->menu_bar_window.
18246 The menu bar of terminal frames is treated specially as far as
18247 glyph matrices are concerned. Menu bar lines are not part of
18248 windows, so the update is done directly on the frame matrix rows
18249 for the menu bar. */
18252 display_menu_bar (struct window
*w
)
18254 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18259 /* Don't do all this for graphical frames. */
18261 if (FRAME_W32_P (f
))
18264 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18270 if (FRAME_NS_P (f
))
18272 #endif /* HAVE_NS */
18274 #ifdef USE_X_TOOLKIT
18275 xassert (!FRAME_WINDOW_P (f
));
18276 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18277 it
.first_visible_x
= 0;
18278 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18279 #else /* not USE_X_TOOLKIT */
18280 if (FRAME_WINDOW_P (f
))
18282 /* Menu bar lines are displayed in the desired matrix of the
18283 dummy window menu_bar_window. */
18284 struct window
*menu_w
;
18285 xassert (WINDOWP (f
->menu_bar_window
));
18286 menu_w
= XWINDOW (f
->menu_bar_window
);
18287 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18289 it
.first_visible_x
= 0;
18290 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18294 /* This is a TTY frame, i.e. character hpos/vpos are used as
18296 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18298 it
.first_visible_x
= 0;
18299 it
.last_visible_x
= FRAME_COLS (f
);
18301 #endif /* not USE_X_TOOLKIT */
18303 if (! mode_line_inverse_video
)
18304 /* Force the menu-bar to be displayed in the default face. */
18305 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18307 /* Clear all rows of the menu bar. */
18308 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18310 struct glyph_row
*row
= it
.glyph_row
+ i
;
18311 clear_glyph_row (row
);
18312 row
->enabled_p
= 1;
18313 row
->full_width_p
= 1;
18316 /* Display all items of the menu bar. */
18317 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18318 for (i
= 0; i
< ASIZE (items
); i
+= 4)
18320 Lisp_Object string
;
18322 /* Stop at nil string. */
18323 string
= AREF (items
, i
+ 1);
18327 /* Remember where item was displayed. */
18328 ASET (items
, i
+ 3, make_number (it
.hpos
));
18330 /* Display the item, pad with one space. */
18331 if (it
.current_x
< it
.last_visible_x
)
18332 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18333 SCHARS (string
) + 1, 0, 0, -1);
18336 /* Fill out the line with spaces. */
18337 if (it
.current_x
< it
.last_visible_x
)
18338 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18340 /* Compute the total height of the lines. */
18341 compute_line_metrics (&it
);
18346 /***********************************************************************
18348 ***********************************************************************/
18350 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18351 FORCE is non-zero, redisplay mode lines unconditionally.
18352 Otherwise, redisplay only mode lines that are garbaged. Value is
18353 the number of windows whose mode lines were redisplayed. */
18356 redisplay_mode_lines (Lisp_Object window
, int force
)
18360 while (!NILP (window
))
18362 struct window
*w
= XWINDOW (window
);
18364 if (WINDOWP (w
->hchild
))
18365 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18366 else if (WINDOWP (w
->vchild
))
18367 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18369 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18370 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18372 struct text_pos lpoint
;
18373 struct buffer
*old
= current_buffer
;
18375 /* Set the window's buffer for the mode line display. */
18376 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18377 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18379 /* Point refers normally to the selected window. For any
18380 other window, set up appropriate value. */
18381 if (!EQ (window
, selected_window
))
18383 struct text_pos pt
;
18385 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18386 if (CHARPOS (pt
) < BEGV
)
18387 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18388 else if (CHARPOS (pt
) > (ZV
- 1))
18389 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18391 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18394 /* Display mode lines. */
18395 clear_glyph_matrix (w
->desired_matrix
);
18396 if (display_mode_lines (w
))
18399 w
->must_be_updated_p
= 1;
18402 /* Restore old settings. */
18403 set_buffer_internal_1 (old
);
18404 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18414 /* Display the mode and/or header line of window W. Value is the
18415 sum number of mode lines and header lines displayed. */
18418 display_mode_lines (struct window
*w
)
18420 Lisp_Object old_selected_window
, old_selected_frame
;
18423 old_selected_frame
= selected_frame
;
18424 selected_frame
= w
->frame
;
18425 old_selected_window
= selected_window
;
18426 XSETWINDOW (selected_window
, w
);
18428 /* These will be set while the mode line specs are processed. */
18429 line_number_displayed
= 0;
18430 w
->column_number_displayed
= Qnil
;
18432 if (WINDOW_WANTS_MODELINE_P (w
))
18434 struct window
*sel_w
= XWINDOW (old_selected_window
);
18436 /* Select mode line face based on the real selected window. */
18437 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18438 BVAR (current_buffer
, mode_line_format
));
18442 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18444 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18445 BVAR (current_buffer
, header_line_format
));
18449 selected_frame
= old_selected_frame
;
18450 selected_window
= old_selected_window
;
18455 /* Display mode or header line of window W. FACE_ID specifies which
18456 line to display; it is either MODE_LINE_FACE_ID or
18457 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18458 display. Value is the pixel height of the mode/header line
18462 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18466 int count
= SPECPDL_INDEX ();
18468 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18469 /* Don't extend on a previously drawn mode-line.
18470 This may happen if called from pos_visible_p. */
18471 it
.glyph_row
->enabled_p
= 0;
18472 prepare_desired_row (it
.glyph_row
);
18474 it
.glyph_row
->mode_line_p
= 1;
18476 if (! mode_line_inverse_video
)
18477 /* Force the mode-line to be displayed in the default face. */
18478 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18480 record_unwind_protect (unwind_format_mode_line
,
18481 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18483 mode_line_target
= MODE_LINE_DISPLAY
;
18485 /* Temporarily make frame's keyboard the current kboard so that
18486 kboard-local variables in the mode_line_format will get the right
18488 push_kboard (FRAME_KBOARD (it
.f
));
18489 record_unwind_save_match_data ();
18490 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18493 unbind_to (count
, Qnil
);
18495 /* Fill up with spaces. */
18496 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18498 compute_line_metrics (&it
);
18499 it
.glyph_row
->full_width_p
= 1;
18500 it
.glyph_row
->continued_p
= 0;
18501 it
.glyph_row
->truncated_on_left_p
= 0;
18502 it
.glyph_row
->truncated_on_right_p
= 0;
18504 /* Make a 3D mode-line have a shadow at its right end. */
18505 face
= FACE_FROM_ID (it
.f
, face_id
);
18506 extend_face_to_end_of_line (&it
);
18507 if (face
->box
!= FACE_NO_BOX
)
18509 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18510 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18511 last
->right_box_line_p
= 1;
18514 return it
.glyph_row
->height
;
18517 /* Move element ELT in LIST to the front of LIST.
18518 Return the updated list. */
18521 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18523 register Lisp_Object tail
, prev
;
18524 register Lisp_Object tem
;
18528 while (CONSP (tail
))
18534 /* Splice out the link TAIL. */
18536 list
= XCDR (tail
);
18538 Fsetcdr (prev
, XCDR (tail
));
18540 /* Now make it the first. */
18541 Fsetcdr (tail
, list
);
18546 tail
= XCDR (tail
);
18550 /* Not found--return unchanged LIST. */
18554 /* Contribute ELT to the mode line for window IT->w. How it
18555 translates into text depends on its data type.
18557 IT describes the display environment in which we display, as usual.
18559 DEPTH is the depth in recursion. It is used to prevent
18560 infinite recursion here.
18562 FIELD_WIDTH is the number of characters the display of ELT should
18563 occupy in the mode line, and PRECISION is the maximum number of
18564 characters to display from ELT's representation. See
18565 display_string for details.
18567 Returns the hpos of the end of the text generated by ELT.
18569 PROPS is a property list to add to any string we encounter.
18571 If RISKY is nonzero, remove (disregard) any properties in any string
18572 we encounter, and ignore :eval and :propertize.
18574 The global variable `mode_line_target' determines whether the
18575 output is passed to `store_mode_line_noprop',
18576 `store_mode_line_string', or `display_string'. */
18579 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18580 Lisp_Object elt
, Lisp_Object props
, int risky
)
18582 int n
= 0, field
, prec
;
18587 elt
= build_string ("*too-deep*");
18591 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18595 /* A string: output it and check for %-constructs within it. */
18597 EMACS_INT offset
= 0;
18599 if (SCHARS (elt
) > 0
18600 && (!NILP (props
) || risky
))
18602 Lisp_Object oprops
, aelt
;
18603 oprops
= Ftext_properties_at (make_number (0), elt
);
18605 /* If the starting string's properties are not what
18606 we want, translate the string. Also, if the string
18607 is risky, do that anyway. */
18609 if (NILP (Fequal (props
, oprops
)) || risky
)
18611 /* If the starting string has properties,
18612 merge the specified ones onto the existing ones. */
18613 if (! NILP (oprops
) && !risky
)
18617 oprops
= Fcopy_sequence (oprops
);
18619 while (CONSP (tem
))
18621 oprops
= Fplist_put (oprops
, XCAR (tem
),
18622 XCAR (XCDR (tem
)));
18623 tem
= XCDR (XCDR (tem
));
18628 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18629 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18631 /* AELT is what we want. Move it to the front
18632 without consing. */
18634 mode_line_proptrans_alist
18635 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18641 /* If AELT has the wrong props, it is useless.
18642 so get rid of it. */
18644 mode_line_proptrans_alist
18645 = Fdelq (aelt
, mode_line_proptrans_alist
);
18647 elt
= Fcopy_sequence (elt
);
18648 Fset_text_properties (make_number (0), Flength (elt
),
18650 /* Add this item to mode_line_proptrans_alist. */
18651 mode_line_proptrans_alist
18652 = Fcons (Fcons (elt
, props
),
18653 mode_line_proptrans_alist
);
18654 /* Truncate mode_line_proptrans_alist
18655 to at most 50 elements. */
18656 tem
= Fnthcdr (make_number (50),
18657 mode_line_proptrans_alist
);
18659 XSETCDR (tem
, Qnil
);
18668 prec
= precision
- n
;
18669 switch (mode_line_target
)
18671 case MODE_LINE_NOPROP
:
18672 case MODE_LINE_TITLE
:
18673 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
18675 case MODE_LINE_STRING
:
18676 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18678 case MODE_LINE_DISPLAY
:
18679 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18680 0, prec
, 0, STRING_MULTIBYTE (elt
));
18687 /* Handle the non-literal case. */
18689 while ((precision
<= 0 || n
< precision
)
18690 && SREF (elt
, offset
) != 0
18691 && (mode_line_target
!= MODE_LINE_DISPLAY
18692 || it
->current_x
< it
->last_visible_x
))
18694 EMACS_INT last_offset
= offset
;
18696 /* Advance to end of string or next format specifier. */
18697 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18700 if (offset
- 1 != last_offset
)
18702 EMACS_INT nchars
, nbytes
;
18704 /* Output to end of string or up to '%'. Field width
18705 is length of string. Don't output more than
18706 PRECISION allows us. */
18709 prec
= c_string_width (SDATA (elt
) + last_offset
,
18710 offset
- last_offset
, precision
- n
,
18713 switch (mode_line_target
)
18715 case MODE_LINE_NOPROP
:
18716 case MODE_LINE_TITLE
:
18717 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
18719 case MODE_LINE_STRING
:
18721 EMACS_INT bytepos
= last_offset
;
18722 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18723 EMACS_INT endpos
= (precision
<= 0
18724 ? string_byte_to_char (elt
, offset
)
18725 : charpos
+ nchars
);
18727 n
+= store_mode_line_string (NULL
,
18728 Fsubstring (elt
, make_number (charpos
),
18729 make_number (endpos
)),
18733 case MODE_LINE_DISPLAY
:
18735 EMACS_INT bytepos
= last_offset
;
18736 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18738 if (precision
<= 0)
18739 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18740 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18742 STRING_MULTIBYTE (elt
));
18747 else /* c == '%' */
18749 EMACS_INT percent_position
= offset
;
18751 /* Get the specified minimum width. Zero means
18754 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18755 field
= field
* 10 + c
- '0';
18757 /* Don't pad beyond the total padding allowed. */
18758 if (field_width
- n
> 0 && field
> field_width
- n
)
18759 field
= field_width
- n
;
18761 /* Note that either PRECISION <= 0 or N < PRECISION. */
18762 prec
= precision
- n
;
18765 n
+= display_mode_element (it
, depth
, field
, prec
,
18766 Vglobal_mode_string
, props
,
18771 EMACS_INT bytepos
, charpos
;
18773 Lisp_Object string
;
18775 bytepos
= percent_position
;
18776 charpos
= (STRING_MULTIBYTE (elt
)
18777 ? string_byte_to_char (elt
, bytepos
)
18779 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
18780 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18782 switch (mode_line_target
)
18784 case MODE_LINE_NOPROP
:
18785 case MODE_LINE_TITLE
:
18786 n
+= store_mode_line_noprop (spec
, field
, prec
);
18788 case MODE_LINE_STRING
:
18790 int len
= strlen (spec
);
18791 Lisp_Object tem
= make_string (spec
, len
);
18792 props
= Ftext_properties_at (make_number (charpos
), elt
);
18793 /* Should only keep face property in props */
18794 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18797 case MODE_LINE_DISPLAY
:
18799 int nglyphs_before
, nwritten
;
18801 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18802 nwritten
= display_string (spec
, string
, elt
,
18807 /* Assign to the glyphs written above the
18808 string where the `%x' came from, position
18812 struct glyph
*glyph
18813 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18817 for (i
= 0; i
< nwritten
; ++i
)
18819 glyph
[i
].object
= elt
;
18820 glyph
[i
].charpos
= charpos
;
18837 /* A symbol: process the value of the symbol recursively
18838 as if it appeared here directly. Avoid error if symbol void.
18839 Special case: if value of symbol is a string, output the string
18842 register Lisp_Object tem
;
18844 /* If the variable is not marked as risky to set
18845 then its contents are risky to use. */
18846 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18849 tem
= Fboundp (elt
);
18852 tem
= Fsymbol_value (elt
);
18853 /* If value is a string, output that string literally:
18854 don't check for % within it. */
18858 if (!EQ (tem
, elt
))
18860 /* Give up right away for nil or t. */
18870 register Lisp_Object car
, tem
;
18872 /* A cons cell: five distinct cases.
18873 If first element is :eval or :propertize, do something special.
18874 If first element is a string or a cons, process all the elements
18875 and effectively concatenate them.
18876 If first element is a negative number, truncate displaying cdr to
18877 at most that many characters. If positive, pad (with spaces)
18878 to at least that many characters.
18879 If first element is a symbol, process the cadr or caddr recursively
18880 according to whether the symbol's value is non-nil or nil. */
18882 if (EQ (car
, QCeval
))
18884 /* An element of the form (:eval FORM) means evaluate FORM
18885 and use the result as mode line elements. */
18890 if (CONSP (XCDR (elt
)))
18893 spec
= safe_eval (XCAR (XCDR (elt
)));
18894 n
+= display_mode_element (it
, depth
, field_width
- n
,
18895 precision
- n
, spec
, props
,
18899 else if (EQ (car
, QCpropertize
))
18901 /* An element of the form (:propertize ELT PROPS...)
18902 means display ELT but applying properties PROPS. */
18907 if (CONSP (XCDR (elt
)))
18908 n
+= display_mode_element (it
, depth
, field_width
- n
,
18909 precision
- n
, XCAR (XCDR (elt
)),
18910 XCDR (XCDR (elt
)), risky
);
18912 else if (SYMBOLP (car
))
18914 tem
= Fboundp (car
);
18918 /* elt is now the cdr, and we know it is a cons cell.
18919 Use its car if CAR has a non-nil value. */
18922 tem
= Fsymbol_value (car
);
18929 /* Symbol's value is nil (or symbol is unbound)
18930 Get the cddr of the original list
18931 and if possible find the caddr and use that. */
18935 else if (!CONSP (elt
))
18940 else if (INTEGERP (car
))
18942 register int lim
= XINT (car
);
18946 /* Negative int means reduce maximum width. */
18947 if (precision
<= 0)
18950 precision
= min (precision
, -lim
);
18954 /* Padding specified. Don't let it be more than
18955 current maximum. */
18957 lim
= min (precision
, lim
);
18959 /* If that's more padding than already wanted, queue it.
18960 But don't reduce padding already specified even if
18961 that is beyond the current truncation point. */
18962 field_width
= max (lim
, field_width
);
18966 else if (STRINGP (car
) || CONSP (car
))
18968 Lisp_Object halftail
= elt
;
18972 && (precision
<= 0 || n
< precision
))
18974 n
+= display_mode_element (it
, depth
,
18975 /* Do padding only after the last
18976 element in the list. */
18977 (! CONSP (XCDR (elt
))
18980 precision
- n
, XCAR (elt
),
18984 if ((len
& 1) == 0)
18985 halftail
= XCDR (halftail
);
18986 /* Check for cycle. */
18987 if (EQ (halftail
, elt
))
18996 elt
= build_string ("*invalid*");
19000 /* Pad to FIELD_WIDTH. */
19001 if (field_width
> 0 && n
< field_width
)
19003 switch (mode_line_target
)
19005 case MODE_LINE_NOPROP
:
19006 case MODE_LINE_TITLE
:
19007 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19009 case MODE_LINE_STRING
:
19010 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19012 case MODE_LINE_DISPLAY
:
19013 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19022 /* Store a mode-line string element in mode_line_string_list.
19024 If STRING is non-null, display that C string. Otherwise, the Lisp
19025 string LISP_STRING is displayed.
19027 FIELD_WIDTH is the minimum number of output glyphs to produce.
19028 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19029 with spaces. FIELD_WIDTH <= 0 means don't pad.
19031 PRECISION is the maximum number of characters to output from
19032 STRING. PRECISION <= 0 means don't truncate the string.
19034 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19035 properties to the string.
19037 PROPS are the properties to add to the string.
19038 The mode_line_string_face face property is always added to the string.
19042 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19043 int field_width
, int precision
, Lisp_Object props
)
19048 if (string
!= NULL
)
19050 len
= strlen (string
);
19051 if (precision
> 0 && len
> precision
)
19053 lisp_string
= make_string (string
, len
);
19055 props
= mode_line_string_face_prop
;
19056 else if (!NILP (mode_line_string_face
))
19058 Lisp_Object face
= Fplist_get (props
, Qface
);
19059 props
= Fcopy_sequence (props
);
19061 face
= mode_line_string_face
;
19063 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19064 props
= Fplist_put (props
, Qface
, face
);
19066 Fadd_text_properties (make_number (0), make_number (len
),
19067 props
, lisp_string
);
19071 len
= XFASTINT (Flength (lisp_string
));
19072 if (precision
> 0 && len
> precision
)
19075 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19078 if (!NILP (mode_line_string_face
))
19082 props
= Ftext_properties_at (make_number (0), lisp_string
);
19083 face
= Fplist_get (props
, Qface
);
19085 face
= mode_line_string_face
;
19087 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19088 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19090 lisp_string
= Fcopy_sequence (lisp_string
);
19093 Fadd_text_properties (make_number (0), make_number (len
),
19094 props
, lisp_string
);
19099 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19103 if (field_width
> len
)
19105 field_width
-= len
;
19106 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19108 Fadd_text_properties (make_number (0), make_number (field_width
),
19109 props
, lisp_string
);
19110 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19118 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19120 doc
: /* Format a string out of a mode line format specification.
19121 First arg FORMAT specifies the mode line format (see `mode-line-format'
19122 for details) to use.
19124 By default, the format is evaluated for the currently selected window.
19126 Optional second arg FACE specifies the face property to put on all
19127 characters for which no face is specified. The value nil means the
19128 default face. The value t means whatever face the window's mode line
19129 currently uses (either `mode-line' or `mode-line-inactive',
19130 depending on whether the window is the selected window or not).
19131 An integer value means the value string has no text
19134 Optional third and fourth args WINDOW and BUFFER specify the window
19135 and buffer to use as the context for the formatting (defaults
19136 are the selected window and the WINDOW's buffer). */)
19137 (Lisp_Object format
, Lisp_Object face
,
19138 Lisp_Object window
, Lisp_Object buffer
)
19143 struct buffer
*old_buffer
= NULL
;
19145 int no_props
= INTEGERP (face
);
19146 int count
= SPECPDL_INDEX ();
19148 int string_start
= 0;
19151 window
= selected_window
;
19152 CHECK_WINDOW (window
);
19153 w
= XWINDOW (window
);
19156 buffer
= w
->buffer
;
19157 CHECK_BUFFER (buffer
);
19159 /* Make formatting the modeline a non-op when noninteractive, otherwise
19160 there will be problems later caused by a partially initialized frame. */
19161 if (NILP (format
) || noninteractive
)
19162 return empty_unibyte_string
;
19167 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19168 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19169 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19170 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19171 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19172 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19173 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19176 if (XBUFFER (buffer
) != current_buffer
)
19177 old_buffer
= current_buffer
;
19179 /* Save things including mode_line_proptrans_alist,
19180 and set that to nil so that we don't alter the outer value. */
19181 record_unwind_protect (unwind_format_mode_line
,
19182 format_mode_line_unwind_data
19183 (old_buffer
, selected_window
, 1));
19184 mode_line_proptrans_alist
= Qnil
;
19186 Fselect_window (window
, Qt
);
19188 set_buffer_internal_1 (XBUFFER (buffer
));
19190 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19194 mode_line_target
= MODE_LINE_NOPROP
;
19195 mode_line_string_face_prop
= Qnil
;
19196 mode_line_string_list
= Qnil
;
19197 string_start
= MODE_LINE_NOPROP_LEN (0);
19201 mode_line_target
= MODE_LINE_STRING
;
19202 mode_line_string_list
= Qnil
;
19203 mode_line_string_face
= face
;
19204 mode_line_string_face_prop
19205 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19208 push_kboard (FRAME_KBOARD (it
.f
));
19209 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19214 len
= MODE_LINE_NOPROP_LEN (string_start
);
19215 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19219 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19220 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19221 empty_unibyte_string
);
19224 unbind_to (count
, Qnil
);
19228 /* Write a null-terminated, right justified decimal representation of
19229 the positive integer D to BUF using a minimal field width WIDTH. */
19232 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
19234 register char *p
= buf
;
19242 *p
++ = d
% 10 + '0';
19247 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19258 /* Write a null-terminated, right justified decimal and "human
19259 readable" representation of the nonnegative integer D to BUF using
19260 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19262 static const char power_letter
[] =
19276 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
19278 /* We aim to represent the nonnegative integer D as
19279 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19280 EMACS_INT quotient
= d
;
19282 /* -1 means: do not use TENTHS. */
19286 /* Length of QUOTIENT.TENTHS as a string. */
19292 if (1000 <= quotient
)
19294 /* Scale to the appropriate EXPONENT. */
19297 remainder
= quotient
% 1000;
19301 while (1000 <= quotient
);
19303 /* Round to nearest and decide whether to use TENTHS or not. */
19306 tenths
= remainder
/ 100;
19307 if (50 <= remainder
% 100)
19314 if (quotient
== 10)
19322 if (500 <= remainder
)
19324 if (quotient
< 999)
19335 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19336 if (tenths
== -1 && quotient
<= 99)
19343 p
= psuffix
= buf
+ max (width
, length
);
19345 /* Print EXPONENT. */
19346 *psuffix
++ = power_letter
[exponent
];
19349 /* Print TENTHS. */
19352 *--p
= '0' + tenths
;
19356 /* Print QUOTIENT. */
19359 int digit
= quotient
% 10;
19360 *--p
= '0' + digit
;
19362 while ((quotient
/= 10) != 0);
19364 /* Print leading spaces. */
19369 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19370 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19371 type of CODING_SYSTEM. Return updated pointer into BUF. */
19373 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19376 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19379 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
19380 const unsigned char *eol_str
;
19382 /* The EOL conversion we are using. */
19383 Lisp_Object eoltype
;
19385 val
= CODING_SYSTEM_SPEC (coding_system
);
19388 if (!VECTORP (val
)) /* Not yet decided. */
19393 eoltype
= eol_mnemonic_undecided
;
19394 /* Don't mention EOL conversion if it isn't decided. */
19399 Lisp_Object eolvalue
;
19401 attrs
= AREF (val
, 0);
19402 eolvalue
= AREF (val
, 2);
19405 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19409 /* The EOL conversion that is normal on this system. */
19411 if (NILP (eolvalue
)) /* Not yet decided. */
19412 eoltype
= eol_mnemonic_undecided
;
19413 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19414 eoltype
= eol_mnemonic_undecided
;
19415 else /* eolvalue is Qunix, Qdos, or Qmac. */
19416 eoltype
= (EQ (eolvalue
, Qunix
)
19417 ? eol_mnemonic_unix
19418 : (EQ (eolvalue
, Qdos
) == 1
19419 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19425 /* Mention the EOL conversion if it is not the usual one. */
19426 if (STRINGP (eoltype
))
19428 eol_str
= SDATA (eoltype
);
19429 eol_str_len
= SBYTES (eoltype
);
19431 else if (CHARACTERP (eoltype
))
19433 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19434 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19439 eol_str
= invalid_eol_type
;
19440 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19442 memcpy (buf
, eol_str
, eol_str_len
);
19443 buf
+= eol_str_len
;
19449 /* Return a string for the output of a mode line %-spec for window W,
19450 generated by character C. FIELD_WIDTH > 0 means pad the string
19451 returned with spaces to that value. Return a Lisp string in
19452 *STRING if the resulting string is taken from that Lisp string.
19454 Note we operate on the current buffer for most purposes,
19455 the exception being w->base_line_pos. */
19457 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19459 static const char *
19460 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19461 Lisp_Object
*string
)
19464 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19465 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19466 struct buffer
*b
= current_buffer
;
19474 if (!NILP (BVAR (b
, read_only
)))
19476 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19481 /* This differs from %* only for a modified read-only buffer. */
19482 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19484 if (!NILP (BVAR (b
, read_only
)))
19489 /* This differs from %* in ignoring read-only-ness. */
19490 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19502 if (command_loop_level
> 5)
19504 p
= decode_mode_spec_buf
;
19505 for (i
= 0; i
< command_loop_level
; i
++)
19508 return decode_mode_spec_buf
;
19516 if (command_loop_level
> 5)
19518 p
= decode_mode_spec_buf
;
19519 for (i
= 0; i
< command_loop_level
; i
++)
19522 return decode_mode_spec_buf
;
19529 /* Let lots_of_dashes be a string of infinite length. */
19530 if (mode_line_target
== MODE_LINE_NOPROP
||
19531 mode_line_target
== MODE_LINE_STRING
)
19533 if (field_width
<= 0
19534 || field_width
> sizeof (lots_of_dashes
))
19536 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19537 decode_mode_spec_buf
[i
] = '-';
19538 decode_mode_spec_buf
[i
] = '\0';
19539 return decode_mode_spec_buf
;
19542 return lots_of_dashes
;
19546 obj
= BVAR (b
, name
);
19550 /* %c and %l are ignored in `frame-title-format'.
19551 (In redisplay_internal, the frame title is drawn _before_ the
19552 windows are updated, so the stuff which depends on actual
19553 window contents (such as %l) may fail to render properly, or
19554 even crash emacs.) */
19555 if (mode_line_target
== MODE_LINE_TITLE
)
19559 EMACS_INT col
= current_column ();
19560 w
->column_number_displayed
= make_number (col
);
19561 pint2str (decode_mode_spec_buf
, field_width
, col
);
19562 return decode_mode_spec_buf
;
19566 #ifndef SYSTEM_MALLOC
19568 if (NILP (Vmemory_full
))
19571 return "!MEM FULL! ";
19578 /* %F displays the frame name. */
19579 if (!NILP (f
->title
))
19580 return SSDATA (f
->title
);
19581 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19582 return SSDATA (f
->name
);
19586 obj
= BVAR (b
, filename
);
19591 EMACS_INT size
= ZV
- BEGV
;
19592 pint2str (decode_mode_spec_buf
, field_width
, size
);
19593 return decode_mode_spec_buf
;
19598 EMACS_INT size
= ZV
- BEGV
;
19599 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19600 return decode_mode_spec_buf
;
19605 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19606 EMACS_INT topline
, nlines
, height
;
19609 /* %c and %l are ignored in `frame-title-format'. */
19610 if (mode_line_target
== MODE_LINE_TITLE
)
19613 startpos
= XMARKER (w
->start
)->charpos
;
19614 startpos_byte
= marker_byte_position (w
->start
);
19615 height
= WINDOW_TOTAL_LINES (w
);
19617 /* If we decided that this buffer isn't suitable for line numbers,
19618 don't forget that too fast. */
19619 if (EQ (w
->base_line_pos
, w
->buffer
))
19621 /* But do forget it, if the window shows a different buffer now. */
19622 else if (BUFFERP (w
->base_line_pos
))
19623 w
->base_line_pos
= Qnil
;
19625 /* If the buffer is very big, don't waste time. */
19626 if (INTEGERP (Vline_number_display_limit
)
19627 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19629 w
->base_line_pos
= Qnil
;
19630 w
->base_line_number
= Qnil
;
19634 if (INTEGERP (w
->base_line_number
)
19635 && INTEGERP (w
->base_line_pos
)
19636 && XFASTINT (w
->base_line_pos
) <= startpos
)
19638 line
= XFASTINT (w
->base_line_number
);
19639 linepos
= XFASTINT (w
->base_line_pos
);
19640 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19645 linepos
= BUF_BEGV (b
);
19646 linepos_byte
= BUF_BEGV_BYTE (b
);
19649 /* Count lines from base line to window start position. */
19650 nlines
= display_count_lines (linepos_byte
,
19654 topline
= nlines
+ line
;
19656 /* Determine a new base line, if the old one is too close
19657 or too far away, or if we did not have one.
19658 "Too close" means it's plausible a scroll-down would
19659 go back past it. */
19660 if (startpos
== BUF_BEGV (b
))
19662 w
->base_line_number
= make_number (topline
);
19663 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19665 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19666 || linepos
== BUF_BEGV (b
))
19668 EMACS_INT limit
= BUF_BEGV (b
);
19669 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19670 EMACS_INT position
;
19671 EMACS_INT distance
=
19672 (height
* 2 + 30) * line_number_display_limit_width
;
19674 if (startpos
- distance
> limit
)
19676 limit
= startpos
- distance
;
19677 limit_byte
= CHAR_TO_BYTE (limit
);
19680 nlines
= display_count_lines (startpos_byte
,
19682 - (height
* 2 + 30),
19684 /* If we couldn't find the lines we wanted within
19685 line_number_display_limit_width chars per line,
19686 give up on line numbers for this window. */
19687 if (position
== limit_byte
&& limit
== startpos
- distance
)
19689 w
->base_line_pos
= w
->buffer
;
19690 w
->base_line_number
= Qnil
;
19694 w
->base_line_number
= make_number (topline
- nlines
);
19695 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19698 /* Now count lines from the start pos to point. */
19699 nlines
= display_count_lines (startpos_byte
,
19700 PT_BYTE
, PT
, &junk
);
19702 /* Record that we did display the line number. */
19703 line_number_displayed
= 1;
19705 /* Make the string to show. */
19706 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19707 return decode_mode_spec_buf
;
19710 char* p
= decode_mode_spec_buf
;
19711 int pad
= field_width
- 2;
19717 return decode_mode_spec_buf
;
19723 obj
= BVAR (b
, mode_name
);
19727 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19733 EMACS_INT pos
= marker_position (w
->start
);
19734 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19736 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19738 if (pos
<= BUF_BEGV (b
))
19743 else if (pos
<= BUF_BEGV (b
))
19747 if (total
> 1000000)
19748 /* Do it differently for a large value, to avoid overflow. */
19749 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19751 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19752 /* We can't normally display a 3-digit number,
19753 so get us a 2-digit number that is close. */
19756 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19757 return decode_mode_spec_buf
;
19761 /* Display percentage of size above the bottom of the screen. */
19764 EMACS_INT toppos
= marker_position (w
->start
);
19765 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19766 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19768 if (botpos
>= BUF_ZV (b
))
19770 if (toppos
<= BUF_BEGV (b
))
19777 if (total
> 1000000)
19778 /* Do it differently for a large value, to avoid overflow. */
19779 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19781 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19782 /* We can't normally display a 3-digit number,
19783 so get us a 2-digit number that is close. */
19786 if (toppos
<= BUF_BEGV (b
))
19787 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
19789 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
19790 return decode_mode_spec_buf
;
19795 /* status of process */
19796 obj
= Fget_buffer_process (Fcurrent_buffer ());
19798 return "no process";
19800 obj
= Fsymbol_name (Fprocess_status (obj
));
19806 int count
= inhibit_garbage_collection ();
19807 Lisp_Object val
= call1 (intern ("file-remote-p"),
19808 BVAR (current_buffer
, directory
));
19809 unbind_to (count
, Qnil
);
19817 case 't': /* indicate TEXT or BINARY */
19821 /* coding-system (not including end-of-line format) */
19823 /* coding-system (including end-of-line type) */
19825 int eol_flag
= (c
== 'Z');
19826 char *p
= decode_mode_spec_buf
;
19828 if (! FRAME_WINDOW_P (f
))
19830 /* No need to mention EOL here--the terminal never needs
19831 to do EOL conversion. */
19832 p
= decode_mode_spec_coding (CODING_ID_NAME
19833 (FRAME_KEYBOARD_CODING (f
)->id
),
19835 p
= decode_mode_spec_coding (CODING_ID_NAME
19836 (FRAME_TERMINAL_CODING (f
)->id
),
19839 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
19842 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19843 #ifdef subprocesses
19844 obj
= Fget_buffer_process (Fcurrent_buffer ());
19845 if (PROCESSP (obj
))
19847 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19849 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19852 #endif /* subprocesses */
19855 return decode_mode_spec_buf
;
19862 return SSDATA (obj
);
19869 /* Count up to COUNT lines starting from START_BYTE.
19870 But don't go beyond LIMIT_BYTE.
19871 Return the number of lines thus found (always nonnegative).
19873 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19876 display_count_lines (EMACS_INT start_byte
,
19877 EMACS_INT limit_byte
, EMACS_INT count
,
19878 EMACS_INT
*byte_pos_ptr
)
19880 register unsigned char *cursor
;
19881 unsigned char *base
;
19883 register EMACS_INT ceiling
;
19884 register unsigned char *ceiling_addr
;
19885 EMACS_INT orig_count
= count
;
19887 /* If we are not in selective display mode,
19888 check only for newlines. */
19889 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
19890 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
19894 while (start_byte
< limit_byte
)
19896 ceiling
= BUFFER_CEILING_OF (start_byte
);
19897 ceiling
= min (limit_byte
- 1, ceiling
);
19898 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19899 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19902 if (selective_display
)
19903 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19906 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19909 if (cursor
!= ceiling_addr
)
19913 start_byte
+= cursor
- base
+ 1;
19914 *byte_pos_ptr
= start_byte
;
19918 if (++cursor
== ceiling_addr
)
19924 start_byte
+= cursor
- base
;
19929 while (start_byte
> limit_byte
)
19931 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19932 ceiling
= max (limit_byte
, ceiling
);
19933 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19934 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19937 if (selective_display
)
19938 while (--cursor
!= ceiling_addr
19939 && *cursor
!= '\n' && *cursor
!= 015)
19942 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19945 if (cursor
!= ceiling_addr
)
19949 start_byte
+= cursor
- base
+ 1;
19950 *byte_pos_ptr
= start_byte
;
19951 /* When scanning backwards, we should
19952 not count the newline posterior to which we stop. */
19953 return - orig_count
- 1;
19959 /* Here we add 1 to compensate for the last decrement
19960 of CURSOR, which took it past the valid range. */
19961 start_byte
+= cursor
- base
+ 1;
19965 *byte_pos_ptr
= limit_byte
;
19968 return - orig_count
+ count
;
19969 return orig_count
- count
;
19975 /***********************************************************************
19977 ***********************************************************************/
19979 /* Display a NUL-terminated string, starting with index START.
19981 If STRING is non-null, display that C string. Otherwise, the Lisp
19982 string LISP_STRING is displayed. There's a case that STRING is
19983 non-null and LISP_STRING is not nil. It means STRING is a string
19984 data of LISP_STRING. In that case, we display LISP_STRING while
19985 ignoring its text properties.
19987 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19988 FACE_STRING. Display STRING or LISP_STRING with the face at
19989 FACE_STRING_POS in FACE_STRING:
19991 Display the string in the environment given by IT, but use the
19992 standard display table, temporarily.
19994 FIELD_WIDTH is the minimum number of output glyphs to produce.
19995 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19996 with spaces. If STRING has more characters, more than FIELD_WIDTH
19997 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19999 PRECISION is the maximum number of characters to output from
20000 STRING. PRECISION < 0 means don't truncate the string.
20002 This is roughly equivalent to printf format specifiers:
20004 FIELD_WIDTH PRECISION PRINTF
20005 ----------------------------------------
20011 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20012 display them, and < 0 means obey the current buffer's value of
20013 enable_multibyte_characters.
20015 Value is the number of columns displayed. */
20018 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20019 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20020 int field_width
, int precision
, int max_x
, int multibyte
)
20022 int hpos_at_start
= it
->hpos
;
20023 int saved_face_id
= it
->face_id
;
20024 struct glyph_row
*row
= it
->glyph_row
;
20026 /* Initialize the iterator IT for iteration over STRING beginning
20027 with index START. */
20028 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20029 precision
, field_width
, multibyte
);
20030 if (string
&& STRINGP (lisp_string
))
20031 /* LISP_STRING is the one returned by decode_mode_spec. We should
20032 ignore its text properties. */
20033 it
->stop_charpos
= it
->end_charpos
;
20035 /* If displaying STRING, set up the face of the iterator from
20036 FACE_STRING, if that's given. */
20037 if (STRINGP (face_string
))
20043 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20044 0, it
->region_beg_charpos
,
20045 it
->region_end_charpos
,
20046 &endptr
, it
->base_face_id
, 0);
20047 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20048 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20051 /* Set max_x to the maximum allowed X position. Don't let it go
20052 beyond the right edge of the window. */
20054 max_x
= it
->last_visible_x
;
20056 max_x
= min (max_x
, it
->last_visible_x
);
20058 /* Skip over display elements that are not visible. because IT->w is
20060 if (it
->current_x
< it
->first_visible_x
)
20061 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20062 MOVE_TO_POS
| MOVE_TO_X
);
20064 row
->ascent
= it
->max_ascent
;
20065 row
->height
= it
->max_ascent
+ it
->max_descent
;
20066 row
->phys_ascent
= it
->max_phys_ascent
;
20067 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20068 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20070 /* This condition is for the case that we are called with current_x
20071 past last_visible_x. */
20072 while (it
->current_x
< max_x
)
20074 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20076 /* Get the next display element. */
20077 if (!get_next_display_element (it
))
20080 /* Produce glyphs. */
20081 x_before
= it
->current_x
;
20082 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20083 PRODUCE_GLYPHS (it
);
20085 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
20088 while (i
< nglyphs
)
20090 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20092 if (it
->line_wrap
!= TRUNCATE
20093 && x
+ glyph
->pixel_width
> max_x
)
20095 /* End of continued line or max_x reached. */
20096 if (CHAR_GLYPH_PADDING_P (*glyph
))
20098 /* A wide character is unbreakable. */
20099 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
20100 it
->current_x
= x_before
;
20104 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20109 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20111 /* Glyph is at least partially visible. */
20113 if (x
< it
->first_visible_x
)
20114 it
->glyph_row
->x
= x
- it
->first_visible_x
;
20118 /* Glyph is off the left margin of the display area.
20119 Should not happen. */
20123 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20124 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20125 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20126 row
->phys_height
= max (row
->phys_height
,
20127 it
->max_phys_ascent
+ it
->max_phys_descent
);
20128 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20129 it
->max_extra_line_spacing
);
20130 x
+= glyph
->pixel_width
;
20134 /* Stop if max_x reached. */
20138 /* Stop at line ends. */
20139 if (ITERATOR_AT_END_OF_LINE_P (it
))
20141 it
->continuation_lines_width
= 0;
20145 set_iterator_to_next (it
, 1);
20147 /* Stop if truncating at the right edge. */
20148 if (it
->line_wrap
== TRUNCATE
20149 && it
->current_x
>= it
->last_visible_x
)
20151 /* Add truncation mark, but don't do it if the line is
20152 truncated at a padding space. */
20153 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20155 if (!FRAME_WINDOW_P (it
->f
))
20159 if (it
->current_x
> it
->last_visible_x
)
20161 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20162 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20164 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20166 row
->used
[TEXT_AREA
] = ii
;
20167 produce_special_glyphs (it
, IT_TRUNCATION
);
20170 produce_special_glyphs (it
, IT_TRUNCATION
);
20172 it
->glyph_row
->truncated_on_right_p
= 1;
20178 /* Maybe insert a truncation at the left. */
20179 if (it
->first_visible_x
20180 && IT_CHARPOS (*it
) > 0)
20182 if (!FRAME_WINDOW_P (it
->f
))
20183 insert_left_trunc_glyphs (it
);
20184 it
->glyph_row
->truncated_on_left_p
= 1;
20187 it
->face_id
= saved_face_id
;
20189 /* Value is number of columns displayed. */
20190 return it
->hpos
- hpos_at_start
;
20195 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20196 appears as an element of LIST or as the car of an element of LIST.
20197 If PROPVAL is a list, compare each element against LIST in that
20198 way, and return 1/2 if any element of PROPVAL is found in LIST.
20199 Otherwise return 0. This function cannot quit.
20200 The return value is 2 if the text is invisible but with an ellipsis
20201 and 1 if it's invisible and without an ellipsis. */
20204 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20206 register Lisp_Object tail
, proptail
;
20208 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20210 register Lisp_Object tem
;
20212 if (EQ (propval
, tem
))
20214 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20215 return NILP (XCDR (tem
)) ? 1 : 2;
20218 if (CONSP (propval
))
20220 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20222 Lisp_Object propelt
;
20223 propelt
= XCAR (proptail
);
20224 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20226 register Lisp_Object tem
;
20228 if (EQ (propelt
, tem
))
20230 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20231 return NILP (XCDR (tem
)) ? 1 : 2;
20239 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20240 doc
: /* Non-nil if the property makes the text invisible.
20241 POS-OR-PROP can be a marker or number, in which case it is taken to be
20242 a position in the current buffer and the value of the `invisible' property
20243 is checked; or it can be some other value, which is then presumed to be the
20244 value of the `invisible' property of the text of interest.
20245 The non-nil value returned can be t for truly invisible text or something
20246 else if the text is replaced by an ellipsis. */)
20247 (Lisp_Object pos_or_prop
)
20250 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20251 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20253 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20254 return (invis
== 0 ? Qnil
20256 : make_number (invis
));
20259 /* Calculate a width or height in pixels from a specification using
20260 the following elements:
20263 NUM - a (fractional) multiple of the default font width/height
20264 (NUM) - specifies exactly NUM pixels
20265 UNIT - a fixed number of pixels, see below.
20266 ELEMENT - size of a display element in pixels, see below.
20267 (NUM . SPEC) - equals NUM * SPEC
20268 (+ SPEC SPEC ...) - add pixel values
20269 (- SPEC SPEC ...) - subtract pixel values
20270 (- SPEC) - negate pixel value
20273 INT or FLOAT - a number constant
20274 SYMBOL - use symbol's (buffer local) variable binding.
20277 in - pixels per inch *)
20278 mm - pixels per 1/1000 meter *)
20279 cm - pixels per 1/100 meter *)
20280 width - width of current font in pixels.
20281 height - height of current font in pixels.
20283 *) using the ratio(s) defined in display-pixels-per-inch.
20287 left-fringe - left fringe width in pixels
20288 right-fringe - right fringe width in pixels
20290 left-margin - left margin width in pixels
20291 right-margin - right margin width in pixels
20293 scroll-bar - scroll-bar area width in pixels
20297 Pixels corresponding to 5 inches:
20300 Total width of non-text areas on left side of window (if scroll-bar is on left):
20301 '(space :width (+ left-fringe left-margin scroll-bar))
20303 Align to first text column (in header line):
20304 '(space :align-to 0)
20306 Align to middle of text area minus half the width of variable `my-image'
20307 containing a loaded image:
20308 '(space :align-to (0.5 . (- text my-image)))
20310 Width of left margin minus width of 1 character in the default font:
20311 '(space :width (- left-margin 1))
20313 Width of left margin minus width of 2 characters in the current font:
20314 '(space :width (- left-margin (2 . width)))
20316 Center 1 character over left-margin (in header line):
20317 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20319 Different ways to express width of left fringe plus left margin minus one pixel:
20320 '(space :width (- (+ left-fringe left-margin) (1)))
20321 '(space :width (+ left-fringe left-margin (- (1))))
20322 '(space :width (+ left-fringe left-margin (-1)))
20326 #define NUMVAL(X) \
20327 ((INTEGERP (X) || FLOATP (X)) \
20332 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20333 struct font
*font
, int width_p
, int *align_to
)
20337 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20338 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20341 return OK_PIXELS (0);
20343 xassert (FRAME_LIVE_P (it
->f
));
20345 if (SYMBOLP (prop
))
20347 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20349 char *unit
= SSDATA (SYMBOL_NAME (prop
));
20351 if (unit
[0] == 'i' && unit
[1] == 'n')
20353 else if (unit
[0] == 'm' && unit
[1] == 'm')
20355 else if (unit
[0] == 'c' && unit
[1] == 'm')
20362 #ifdef HAVE_WINDOW_SYSTEM
20363 if (FRAME_WINDOW_P (it
->f
)
20365 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20366 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20368 return OK_PIXELS (ppi
/ pixels
);
20371 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20372 || (CONSP (Vdisplay_pixels_per_inch
)
20374 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20375 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20377 return OK_PIXELS (ppi
/ pixels
);
20383 #ifdef HAVE_WINDOW_SYSTEM
20384 if (EQ (prop
, Qheight
))
20385 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20386 if (EQ (prop
, Qwidth
))
20387 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20389 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20390 return OK_PIXELS (1);
20393 if (EQ (prop
, Qtext
))
20394 return OK_PIXELS (width_p
20395 ? window_box_width (it
->w
, TEXT_AREA
)
20396 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20398 if (align_to
&& *align_to
< 0)
20401 if (EQ (prop
, Qleft
))
20402 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20403 if (EQ (prop
, Qright
))
20404 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20405 if (EQ (prop
, Qcenter
))
20406 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20407 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20408 if (EQ (prop
, Qleft_fringe
))
20409 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20410 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20411 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20412 if (EQ (prop
, Qright_fringe
))
20413 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20414 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20415 : window_box_right_offset (it
->w
, TEXT_AREA
));
20416 if (EQ (prop
, Qleft_margin
))
20417 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20418 if (EQ (prop
, Qright_margin
))
20419 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20420 if (EQ (prop
, Qscroll_bar
))
20421 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20423 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20424 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20425 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20430 if (EQ (prop
, Qleft_fringe
))
20431 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20432 if (EQ (prop
, Qright_fringe
))
20433 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20434 if (EQ (prop
, Qleft_margin
))
20435 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20436 if (EQ (prop
, Qright_margin
))
20437 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20438 if (EQ (prop
, Qscroll_bar
))
20439 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20442 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20445 if (INTEGERP (prop
) || FLOATP (prop
))
20447 int base_unit
= (width_p
20448 ? FRAME_COLUMN_WIDTH (it
->f
)
20449 : FRAME_LINE_HEIGHT (it
->f
));
20450 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20455 Lisp_Object car
= XCAR (prop
);
20456 Lisp_Object cdr
= XCDR (prop
);
20460 #ifdef HAVE_WINDOW_SYSTEM
20461 if (FRAME_WINDOW_P (it
->f
)
20462 && valid_image_p (prop
))
20464 int id
= lookup_image (it
->f
, prop
);
20465 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20467 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20470 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20476 while (CONSP (cdr
))
20478 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20479 font
, width_p
, align_to
))
20482 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20487 if (EQ (car
, Qminus
))
20489 return OK_PIXELS (pixels
);
20492 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20495 if (INTEGERP (car
) || FLOATP (car
))
20498 pixels
= XFLOATINT (car
);
20500 return OK_PIXELS (pixels
);
20501 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20502 font
, width_p
, align_to
))
20503 return OK_PIXELS (pixels
* fact
);
20514 /***********************************************************************
20516 ***********************************************************************/
20518 #ifdef HAVE_WINDOW_SYSTEM
20523 dump_glyph_string (s
)
20524 struct glyph_string
*s
;
20526 fprintf (stderr
, "glyph string\n");
20527 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20528 s
->x
, s
->y
, s
->width
, s
->height
);
20529 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20530 fprintf (stderr
, " hl = %d\n", s
->hl
);
20531 fprintf (stderr
, " left overhang = %d, right = %d\n",
20532 s
->left_overhang
, s
->right_overhang
);
20533 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20534 fprintf (stderr
, " extends to end of line = %d\n",
20535 s
->extends_to_end_of_line_p
);
20536 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20537 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20540 #endif /* GLYPH_DEBUG */
20542 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20543 of XChar2b structures for S; it can't be allocated in
20544 init_glyph_string because it must be allocated via `alloca'. W
20545 is the window on which S is drawn. ROW and AREA are the glyph row
20546 and area within the row from which S is constructed. START is the
20547 index of the first glyph structure covered by S. HL is a
20548 face-override for drawing S. */
20551 #define OPTIONAL_HDC(hdc) HDC hdc,
20552 #define DECLARE_HDC(hdc) HDC hdc;
20553 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20554 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20557 #ifndef OPTIONAL_HDC
20558 #define OPTIONAL_HDC(hdc)
20559 #define DECLARE_HDC(hdc)
20560 #define ALLOCATE_HDC(hdc, f)
20561 #define RELEASE_HDC(hdc, f)
20565 init_glyph_string (struct glyph_string
*s
,
20567 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20568 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20570 memset (s
, 0, sizeof *s
);
20572 s
->f
= XFRAME (w
->frame
);
20576 s
->display
= FRAME_X_DISPLAY (s
->f
);
20577 s
->window
= FRAME_X_WINDOW (s
->f
);
20578 s
->char2b
= char2b
;
20582 s
->first_glyph
= row
->glyphs
[area
] + start
;
20583 s
->height
= row
->height
;
20584 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20585 s
->ybase
= s
->y
+ row
->ascent
;
20589 /* Append the list of glyph strings with head H and tail T to the list
20590 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20593 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20594 struct glyph_string
*h
, struct glyph_string
*t
)
20608 /* Prepend the list of glyph strings with head H and tail T to the
20609 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20613 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20614 struct glyph_string
*h
, struct glyph_string
*t
)
20628 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20629 Set *HEAD and *TAIL to the resulting list. */
20632 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20633 struct glyph_string
*s
)
20635 s
->next
= s
->prev
= NULL
;
20636 append_glyph_string_lists (head
, tail
, s
, s
);
20640 /* Get face and two-byte form of character C in face FACE_ID on frame F.
20641 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
20642 make sure that X resources for the face returned are allocated.
20643 Value is a pointer to a realized face that is ready for display if
20644 DISPLAY_P is non-zero. */
20646 static INLINE
struct face
*
20647 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20648 XChar2b
*char2b
, int display_p
)
20650 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20654 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20656 if (code
!= FONT_INVALID_CODE
)
20657 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20659 STORE_XCHAR2B (char2b
, 0, 0);
20662 /* Make sure X resources of the face are allocated. */
20663 #ifdef HAVE_X_WINDOWS
20667 xassert (face
!= NULL
);
20668 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20675 /* Get face and two-byte form of character glyph GLYPH on frame F.
20676 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20677 a pointer to a realized face that is ready for display. */
20679 static INLINE
struct face
*
20680 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20681 XChar2b
*char2b
, int *two_byte_p
)
20685 xassert (glyph
->type
== CHAR_GLYPH
);
20686 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20695 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20696 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20698 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20700 if (code
!= FONT_INVALID_CODE
)
20701 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20703 STORE_XCHAR2B (char2b
, 0, 0);
20706 /* Make sure X resources of the face are allocated. */
20707 xassert (face
!= NULL
);
20708 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20713 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20714 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20717 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20721 if (CHAR_BYTE8_P (c
))
20722 code
= CHAR_TO_BYTE8 (c
);
20724 code
= font
->driver
->encode_char (font
, c
);
20726 if (code
== FONT_INVALID_CODE
)
20728 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20733 /* Fill glyph string S with composition components specified by S->cmp.
20735 BASE_FACE is the base face of the composition.
20736 S->cmp_from is the index of the first component for S.
20738 OVERLAPS non-zero means S should draw the foreground only, and use
20739 its physical height for clipping. See also draw_glyphs.
20741 Value is the index of a component not in S. */
20744 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20748 /* For all glyphs of this composition, starting at the offset
20749 S->cmp_from, until we reach the end of the definition or encounter a
20750 glyph that requires the different face, add it to S. */
20755 s
->for_overlaps
= overlaps
;
20758 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20760 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20764 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20767 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20774 s
->font
= s
->face
->font
;
20776 else if (s
->face
!= face
)
20784 /* All glyph strings for the same composition has the same width,
20785 i.e. the width set for the first component of the composition. */
20786 s
->width
= s
->first_glyph
->pixel_width
;
20788 /* If the specified font could not be loaded, use the frame's
20789 default font, but record the fact that we couldn't load it in
20790 the glyph string so that we can draw rectangles for the
20791 characters of the glyph string. */
20792 if (s
->font
== NULL
)
20794 s
->font_not_found_p
= 1;
20795 s
->font
= FRAME_FONT (s
->f
);
20798 /* Adjust base line for subscript/superscript text. */
20799 s
->ybase
+= s
->first_glyph
->voffset
;
20801 /* This glyph string must always be drawn with 16-bit functions. */
20808 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20809 int start
, int end
, int overlaps
)
20811 struct glyph
*glyph
, *last
;
20812 Lisp_Object lgstring
;
20815 s
->for_overlaps
= overlaps
;
20816 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20817 last
= s
->row
->glyphs
[s
->area
] + end
;
20818 s
->cmp_id
= glyph
->u
.cmp
.id
;
20819 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20820 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20821 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20822 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20823 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20825 while (glyph
< last
20826 && glyph
->u
.cmp
.automatic
20827 && glyph
->u
.cmp
.id
== s
->cmp_id
20828 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20829 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20831 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20833 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20834 unsigned code
= LGLYPH_CODE (lglyph
);
20836 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20838 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20839 return glyph
- s
->row
->glyphs
[s
->area
];
20843 /* Fill glyph string S from a sequence glyphs for glyphless characters.
20844 See the comment of fill_glyph_string for arguments.
20845 Value is the index of the first glyph not in S. */
20849 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
20850 int start
, int end
, int overlaps
)
20852 struct glyph
*glyph
, *last
;
20855 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
20856 s
->for_overlaps
= overlaps
;
20857 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20858 last
= s
->row
->glyphs
[s
->area
] + end
;
20859 voffset
= glyph
->voffset
;
20860 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20861 s
->font
= s
->face
->font
;
20863 s
->width
= glyph
->pixel_width
;
20865 while (glyph
< last
20866 && glyph
->type
== GLYPHLESS_GLYPH
20867 && glyph
->voffset
== voffset
20868 && glyph
->face_id
== face_id
)
20871 s
->width
+= glyph
->pixel_width
;
20874 s
->ybase
+= voffset
;
20875 return glyph
- s
->row
->glyphs
[s
->area
];
20879 /* Fill glyph string S from a sequence of character glyphs.
20881 FACE_ID is the face id of the string. START is the index of the
20882 first glyph to consider, END is the index of the last + 1.
20883 OVERLAPS non-zero means S should draw the foreground only, and use
20884 its physical height for clipping. See also draw_glyphs.
20886 Value is the index of the first glyph not in S. */
20889 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20890 int start
, int end
, int overlaps
)
20892 struct glyph
*glyph
, *last
;
20894 int glyph_not_available_p
;
20896 xassert (s
->f
== XFRAME (s
->w
->frame
));
20897 xassert (s
->nchars
== 0);
20898 xassert (start
>= 0 && end
> start
);
20900 s
->for_overlaps
= overlaps
;
20901 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20902 last
= s
->row
->glyphs
[s
->area
] + end
;
20903 voffset
= glyph
->voffset
;
20904 s
->padding_p
= glyph
->padding_p
;
20905 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20907 while (glyph
< last
20908 && glyph
->type
== CHAR_GLYPH
20909 && glyph
->voffset
== voffset
20910 /* Same face id implies same font, nowadays. */
20911 && glyph
->face_id
== face_id
20912 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20916 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20917 s
->char2b
+ s
->nchars
,
20919 s
->two_byte_p
= two_byte_p
;
20921 xassert (s
->nchars
<= end
- start
);
20922 s
->width
+= glyph
->pixel_width
;
20923 if (glyph
++->padding_p
!= s
->padding_p
)
20927 s
->font
= s
->face
->font
;
20929 /* If the specified font could not be loaded, use the frame's font,
20930 but record the fact that we couldn't load it in
20931 S->font_not_found_p so that we can draw rectangles for the
20932 characters of the glyph string. */
20933 if (s
->font
== NULL
|| glyph_not_available_p
)
20935 s
->font_not_found_p
= 1;
20936 s
->font
= FRAME_FONT (s
->f
);
20939 /* Adjust base line for subscript/superscript text. */
20940 s
->ybase
+= voffset
;
20942 xassert (s
->face
&& s
->face
->gc
);
20943 return glyph
- s
->row
->glyphs
[s
->area
];
20947 /* Fill glyph string S from image glyph S->first_glyph. */
20950 fill_image_glyph_string (struct glyph_string
*s
)
20952 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20953 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20955 s
->slice
= s
->first_glyph
->slice
.img
;
20956 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20957 s
->font
= s
->face
->font
;
20958 s
->width
= s
->first_glyph
->pixel_width
;
20960 /* Adjust base line for subscript/superscript text. */
20961 s
->ybase
+= s
->first_glyph
->voffset
;
20965 /* Fill glyph string S from a sequence of stretch glyphs.
20967 START is the index of the first glyph to consider,
20968 END is the index of the last + 1.
20970 Value is the index of the first glyph not in S. */
20973 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
20975 struct glyph
*glyph
, *last
;
20976 int voffset
, face_id
;
20978 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20980 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20981 last
= s
->row
->glyphs
[s
->area
] + end
;
20982 face_id
= glyph
->face_id
;
20983 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20984 s
->font
= s
->face
->font
;
20985 s
->width
= glyph
->pixel_width
;
20987 voffset
= glyph
->voffset
;
20991 && glyph
->type
== STRETCH_GLYPH
20992 && glyph
->voffset
== voffset
20993 && glyph
->face_id
== face_id
);
20995 s
->width
+= glyph
->pixel_width
;
20997 /* Adjust base line for subscript/superscript text. */
20998 s
->ybase
+= voffset
;
21000 /* The case that face->gc == 0 is handled when drawing the glyph
21001 string by calling PREPARE_FACE_FOR_DISPLAY. */
21003 return glyph
- s
->row
->glyphs
[s
->area
];
21006 static struct font_metrics
*
21007 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21009 static struct font_metrics metrics
;
21010 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21012 if (! font
|| code
== FONT_INVALID_CODE
)
21014 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21019 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21020 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21021 assumed to be zero. */
21024 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21026 *left
= *right
= 0;
21028 if (glyph
->type
== CHAR_GLYPH
)
21032 struct font_metrics
*pcm
;
21034 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21035 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21037 if (pcm
->rbearing
> pcm
->width
)
21038 *right
= pcm
->rbearing
- pcm
->width
;
21039 if (pcm
->lbearing
< 0)
21040 *left
= -pcm
->lbearing
;
21043 else if (glyph
->type
== COMPOSITE_GLYPH
)
21045 if (! glyph
->u
.cmp
.automatic
)
21047 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21049 if (cmp
->rbearing
> cmp
->pixel_width
)
21050 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21051 if (cmp
->lbearing
< 0)
21052 *left
= - cmp
->lbearing
;
21056 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21057 struct font_metrics metrics
;
21059 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21060 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21061 if (metrics
.rbearing
> metrics
.width
)
21062 *right
= metrics
.rbearing
- metrics
.width
;
21063 if (metrics
.lbearing
< 0)
21064 *left
= - metrics
.lbearing
;
21070 /* Return the index of the first glyph preceding glyph string S that
21071 is overwritten by S because of S's left overhang. Value is -1
21072 if no glyphs are overwritten. */
21075 left_overwritten (struct glyph_string
*s
)
21079 if (s
->left_overhang
)
21082 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21083 int first
= s
->first_glyph
- glyphs
;
21085 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21086 x
-= glyphs
[i
].pixel_width
;
21097 /* Return the index of the first glyph preceding glyph string S that
21098 is overwriting S because of its right overhang. Value is -1 if no
21099 glyph in front of S overwrites S. */
21102 left_overwriting (struct glyph_string
*s
)
21105 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21106 int first
= s
->first_glyph
- glyphs
;
21110 for (i
= first
- 1; i
>= 0; --i
)
21113 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21116 x
-= glyphs
[i
].pixel_width
;
21123 /* Return the index of the last glyph following glyph string S that is
21124 overwritten by S because of S's right overhang. Value is -1 if
21125 no such glyph is found. */
21128 right_overwritten (struct glyph_string
*s
)
21132 if (s
->right_overhang
)
21135 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21136 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21137 int end
= s
->row
->used
[s
->area
];
21139 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21140 x
+= glyphs
[i
].pixel_width
;
21149 /* Return the index of the last glyph following glyph string S that
21150 overwrites S because of its left overhang. Value is negative
21151 if no such glyph is found. */
21154 right_overwriting (struct glyph_string
*s
)
21157 int end
= s
->row
->used
[s
->area
];
21158 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21159 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21163 for (i
= first
; i
< end
; ++i
)
21166 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21169 x
+= glyphs
[i
].pixel_width
;
21176 /* Set background width of glyph string S. START is the index of the
21177 first glyph following S. LAST_X is the right-most x-position + 1
21178 in the drawing area. */
21181 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21183 /* If the face of this glyph string has to be drawn to the end of
21184 the drawing area, set S->extends_to_end_of_line_p. */
21186 if (start
== s
->row
->used
[s
->area
]
21187 && s
->area
== TEXT_AREA
21188 && ((s
->row
->fill_line_p
21189 && (s
->hl
== DRAW_NORMAL_TEXT
21190 || s
->hl
== DRAW_IMAGE_RAISED
21191 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21192 || s
->hl
== DRAW_MOUSE_FACE
))
21193 s
->extends_to_end_of_line_p
= 1;
21195 /* If S extends its face to the end of the line, set its
21196 background_width to the distance to the right edge of the drawing
21198 if (s
->extends_to_end_of_line_p
)
21199 s
->background_width
= last_x
- s
->x
+ 1;
21201 s
->background_width
= s
->width
;
21205 /* Compute overhangs and x-positions for glyph string S and its
21206 predecessors, or successors. X is the starting x-position for S.
21207 BACKWARD_P non-zero means process predecessors. */
21210 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
21216 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21217 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21227 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21228 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21238 /* The following macros are only called from draw_glyphs below.
21239 They reference the following parameters of that function directly:
21240 `w', `row', `area', and `overlap_p'
21241 as well as the following local variables:
21242 `s', `f', and `hdc' (in W32) */
21245 /* On W32, silently add local `hdc' variable to argument list of
21246 init_glyph_string. */
21247 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21248 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21250 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21251 init_glyph_string (s, char2b, w, row, area, start, hl)
21254 /* Add a glyph string for a stretch glyph to the list of strings
21255 between HEAD and TAIL. START is the index of the stretch glyph in
21256 row area AREA of glyph row ROW. END is the index of the last glyph
21257 in that glyph row area. X is the current output position assigned
21258 to the new glyph string constructed. HL overrides that face of the
21259 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21260 is the right-most x-position of the drawing area. */
21262 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21263 and below -- keep them on one line. */
21264 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21267 s = (struct glyph_string *) alloca (sizeof *s); \
21268 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21269 START = fill_stretch_glyph_string (s, START, END); \
21270 append_glyph_string (&HEAD, &TAIL, s); \
21276 /* Add a glyph string for an image glyph to the list of strings
21277 between HEAD and TAIL. START is the index of the image glyph in
21278 row area AREA of glyph row ROW. END is the index of the last glyph
21279 in that glyph row area. X is the current output position assigned
21280 to the new glyph string constructed. HL overrides that face of the
21281 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21282 is the right-most x-position of the drawing area. */
21284 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21287 s = (struct glyph_string *) alloca (sizeof *s); \
21288 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21289 fill_image_glyph_string (s); \
21290 append_glyph_string (&HEAD, &TAIL, s); \
21297 /* Add a glyph string for a sequence of character glyphs to the list
21298 of strings between HEAD and TAIL. START is the index of the first
21299 glyph in row area AREA of glyph row ROW that is part of the new
21300 glyph string. END is the index of the last glyph in that glyph row
21301 area. X is the current output position assigned to the new glyph
21302 string constructed. HL overrides that face of the glyph; e.g. it
21303 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21304 right-most x-position of the drawing area. */
21306 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21312 face_id = (row)->glyphs[area][START].face_id; \
21314 s = (struct glyph_string *) alloca (sizeof *s); \
21315 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21316 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21317 append_glyph_string (&HEAD, &TAIL, s); \
21319 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21324 /* Add a glyph string for a composite sequence to the list of strings
21325 between HEAD and TAIL. START is the index of the first glyph in
21326 row area AREA of glyph row ROW that is part of the new glyph
21327 string. END is the index of the last glyph in that glyph row area.
21328 X is the current output position assigned to the new glyph string
21329 constructed. HL overrides that face of the glyph; e.g. it is
21330 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21331 x-position of the drawing area. */
21333 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21335 int face_id = (row)->glyphs[area][START].face_id; \
21336 struct face *base_face = FACE_FROM_ID (f, face_id); \
21337 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21338 struct composition *cmp = composition_table[cmp_id]; \
21340 struct glyph_string *first_s IF_LINT (= NULL); \
21343 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21345 /* Make glyph_strings for each glyph sequence that is drawable by \
21346 the same face, and append them to HEAD/TAIL. */ \
21347 for (n = 0; n < cmp->glyph_len;) \
21349 s = (struct glyph_string *) alloca (sizeof *s); \
21350 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21351 append_glyph_string (&(HEAD), &(TAIL), s); \
21357 n = fill_composite_glyph_string (s, base_face, overlaps); \
21365 /* Add a glyph string for a glyph-string sequence to the list of strings
21366 between HEAD and TAIL. */
21368 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21372 Lisp_Object gstring; \
21374 face_id = (row)->glyphs[area][START].face_id; \
21375 gstring = (composition_gstring_from_id \
21376 ((row)->glyphs[area][START].u.cmp.id)); \
21377 s = (struct glyph_string *) alloca (sizeof *s); \
21378 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21379 * LGSTRING_GLYPH_LEN (gstring)); \
21380 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21381 append_glyph_string (&(HEAD), &(TAIL), s); \
21383 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21387 /* Add a glyph string for a sequence of glyphless character's glyphs
21388 to the list of strings between HEAD and TAIL. The meanings of
21389 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
21391 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21396 face_id = (row)->glyphs[area][START].face_id; \
21398 s = (struct glyph_string *) alloca (sizeof *s); \
21399 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21400 append_glyph_string (&HEAD, &TAIL, s); \
21402 START = fill_glyphless_glyph_string (s, face_id, START, END, \
21408 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21409 of AREA of glyph row ROW on window W between indices START and END.
21410 HL overrides the face for drawing glyph strings, e.g. it is
21411 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21412 x-positions of the drawing area.
21414 This is an ugly monster macro construct because we must use alloca
21415 to allocate glyph strings (because draw_glyphs can be called
21416 asynchronously). */
21418 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21421 HEAD = TAIL = NULL; \
21422 while (START < END) \
21424 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21425 switch (first_glyph->type) \
21428 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21432 case COMPOSITE_GLYPH: \
21433 if (first_glyph->u.cmp.automatic) \
21434 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21437 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21441 case STRETCH_GLYPH: \
21442 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21446 case IMAGE_GLYPH: \
21447 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21451 case GLYPHLESS_GLYPH: \
21452 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
21462 set_glyph_string_background_width (s, START, LAST_X); \
21469 /* Draw glyphs between START and END in AREA of ROW on window W,
21470 starting at x-position X. X is relative to AREA in W. HL is a
21471 face-override with the following meaning:
21473 DRAW_NORMAL_TEXT draw normally
21474 DRAW_CURSOR draw in cursor face
21475 DRAW_MOUSE_FACE draw in mouse face.
21476 DRAW_INVERSE_VIDEO draw in mode line face
21477 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21478 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21480 If OVERLAPS is non-zero, draw only the foreground of characters and
21481 clip to the physical height of ROW. Non-zero value also defines
21482 the overlapping part to be drawn:
21484 OVERLAPS_PRED overlap with preceding rows
21485 OVERLAPS_SUCC overlap with succeeding rows
21486 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21487 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21489 Value is the x-position reached, relative to AREA of W. */
21492 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21493 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21494 enum draw_glyphs_face hl
, int overlaps
)
21496 struct glyph_string
*head
, *tail
;
21497 struct glyph_string
*s
;
21498 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21499 int i
, j
, x_reached
, last_x
, area_left
= 0;
21500 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21503 ALLOCATE_HDC (hdc
, f
);
21505 /* Let's rather be paranoid than getting a SEGV. */
21506 end
= min (end
, row
->used
[area
]);
21507 start
= max (0, start
);
21508 start
= min (end
, start
);
21510 /* Translate X to frame coordinates. Set last_x to the right
21511 end of the drawing area. */
21512 if (row
->full_width_p
)
21514 /* X is relative to the left edge of W, without scroll bars
21516 area_left
= WINDOW_LEFT_EDGE_X (w
);
21517 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21521 area_left
= window_box_left (w
, area
);
21522 last_x
= area_left
+ window_box_width (w
, area
);
21526 /* Build a doubly-linked list of glyph_string structures between
21527 head and tail from what we have to draw. Note that the macro
21528 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21529 the reason we use a separate variable `i'. */
21531 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21533 x_reached
= tail
->x
+ tail
->background_width
;
21537 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21538 the row, redraw some glyphs in front or following the glyph
21539 strings built above. */
21540 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21542 struct glyph_string
*h
, *t
;
21543 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
21544 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
21545 int check_mouse_face
= 0;
21548 /* If mouse highlighting is on, we may need to draw adjacent
21549 glyphs using mouse-face highlighting. */
21550 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21552 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21554 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
21555 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
21557 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21559 check_mouse_face
= 1;
21560 mouse_beg_col
= (row
== mouse_beg_row
)
21561 ? hlinfo
->mouse_face_beg_col
: 0;
21562 mouse_end_col
= (row
== mouse_end_row
)
21563 ? hlinfo
->mouse_face_end_col
21564 : row
->used
[TEXT_AREA
];
21568 /* Compute overhangs for all glyph strings. */
21569 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21570 for (s
= head
; s
; s
= s
->next
)
21571 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21573 /* Prepend glyph strings for glyphs in front of the first glyph
21574 string that are overwritten because of the first glyph
21575 string's left overhang. The background of all strings
21576 prepended must be drawn because the first glyph string
21578 i
= left_overwritten (head
);
21581 enum draw_glyphs_face overlap_hl
;
21583 /* If this row contains mouse highlighting, attempt to draw
21584 the overlapped glyphs with the correct highlight. This
21585 code fails if the overlap encompasses more than one glyph
21586 and mouse-highlight spans only some of these glyphs.
21587 However, making it work perfectly involves a lot more
21588 code, and I don't know if the pathological case occurs in
21589 practice, so we'll stick to this for now. --- cyd */
21590 if (check_mouse_face
21591 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21592 overlap_hl
= DRAW_MOUSE_FACE
;
21594 overlap_hl
= DRAW_NORMAL_TEXT
;
21597 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21598 overlap_hl
, dummy_x
, last_x
);
21600 compute_overhangs_and_x (t
, head
->x
, 1);
21601 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21605 /* Prepend glyph strings for glyphs in front of the first glyph
21606 string that overwrite that glyph string because of their
21607 right overhang. For these strings, only the foreground must
21608 be drawn, because it draws over the glyph string at `head'.
21609 The background must not be drawn because this would overwrite
21610 right overhangs of preceding glyphs for which no glyph
21612 i
= left_overwriting (head
);
21615 enum draw_glyphs_face overlap_hl
;
21617 if (check_mouse_face
21618 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21619 overlap_hl
= DRAW_MOUSE_FACE
;
21621 overlap_hl
= DRAW_NORMAL_TEXT
;
21624 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21625 overlap_hl
, dummy_x
, last_x
);
21626 for (s
= h
; s
; s
= s
->next
)
21627 s
->background_filled_p
= 1;
21628 compute_overhangs_and_x (t
, head
->x
, 1);
21629 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21632 /* Append glyphs strings for glyphs following the last glyph
21633 string tail that are overwritten by tail. The background of
21634 these strings has to be drawn because tail's foreground draws
21636 i
= right_overwritten (tail
);
21639 enum draw_glyphs_face overlap_hl
;
21641 if (check_mouse_face
21642 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21643 overlap_hl
= DRAW_MOUSE_FACE
;
21645 overlap_hl
= DRAW_NORMAL_TEXT
;
21647 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21648 overlap_hl
, x
, last_x
);
21649 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21650 we don't have `end = i;' here. */
21651 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21652 append_glyph_string_lists (&head
, &tail
, h
, t
);
21656 /* Append glyph strings for glyphs following the last glyph
21657 string tail that overwrite tail. The foreground of such
21658 glyphs has to be drawn because it writes into the background
21659 of tail. The background must not be drawn because it could
21660 paint over the foreground of following glyphs. */
21661 i
= right_overwriting (tail
);
21664 enum draw_glyphs_face overlap_hl
;
21665 if (check_mouse_face
21666 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21667 overlap_hl
= DRAW_MOUSE_FACE
;
21669 overlap_hl
= DRAW_NORMAL_TEXT
;
21672 i
++; /* We must include the Ith glyph. */
21673 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21674 overlap_hl
, x
, last_x
);
21675 for (s
= h
; s
; s
= s
->next
)
21676 s
->background_filled_p
= 1;
21677 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21678 append_glyph_string_lists (&head
, &tail
, h
, t
);
21680 if (clip_head
|| clip_tail
)
21681 for (s
= head
; s
; s
= s
->next
)
21683 s
->clip_head
= clip_head
;
21684 s
->clip_tail
= clip_tail
;
21688 /* Draw all strings. */
21689 for (s
= head
; s
; s
= s
->next
)
21690 FRAME_RIF (f
)->draw_glyph_string (s
);
21693 /* When focus a sole frame and move horizontally, this sets on_p to 0
21694 causing a failure to erase prev cursor position. */
21695 if (area
== TEXT_AREA
21696 && !row
->full_width_p
21697 /* When drawing overlapping rows, only the glyph strings'
21698 foreground is drawn, which doesn't erase a cursor
21702 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21703 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21704 : (tail
? tail
->x
+ tail
->background_width
: x
));
21708 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21709 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21713 /* Value is the x-position up to which drawn, relative to AREA of W.
21714 This doesn't include parts drawn because of overhangs. */
21715 if (row
->full_width_p
)
21716 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21718 x_reached
-= area_left
;
21720 RELEASE_HDC (hdc
, f
);
21725 /* Expand row matrix if too narrow. Don't expand if area
21728 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21730 if (!fonts_changed_p \
21731 && (it->glyph_row->glyphs[area] \
21732 < it->glyph_row->glyphs[area + 1])) \
21734 it->w->ncols_scale_factor++; \
21735 fonts_changed_p = 1; \
21739 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21740 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21743 append_glyph (struct it
*it
)
21745 struct glyph
*glyph
;
21746 enum glyph_row_area area
= it
->area
;
21748 xassert (it
->glyph_row
);
21749 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21751 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21752 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21754 /* If the glyph row is reversed, we need to prepend the glyph
21755 rather than append it. */
21756 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21760 /* Make room for the additional glyph. */
21761 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21763 glyph
= it
->glyph_row
->glyphs
[area
];
21765 glyph
->charpos
= CHARPOS (it
->position
);
21766 glyph
->object
= it
->object
;
21767 if (it
->pixel_width
> 0)
21769 glyph
->pixel_width
= it
->pixel_width
;
21770 glyph
->padding_p
= 0;
21774 /* Assure at least 1-pixel width. Otherwise, cursor can't
21775 be displayed correctly. */
21776 glyph
->pixel_width
= 1;
21777 glyph
->padding_p
= 1;
21779 glyph
->ascent
= it
->ascent
;
21780 glyph
->descent
= it
->descent
;
21781 glyph
->voffset
= it
->voffset
;
21782 glyph
->type
= CHAR_GLYPH
;
21783 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21784 glyph
->multibyte_p
= it
->multibyte_p
;
21785 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21786 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21787 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21788 || it
->phys_descent
> it
->descent
);
21789 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21790 glyph
->face_id
= it
->face_id
;
21791 glyph
->u
.ch
= it
->char_to_display
;
21792 glyph
->slice
.img
= null_glyph_slice
;
21793 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21796 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21797 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21799 glyph
->bidi_type
= it
->bidi_it
.type
;
21803 glyph
->resolved_level
= 0;
21804 glyph
->bidi_type
= UNKNOWN_BT
;
21806 ++it
->glyph_row
->used
[area
];
21809 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21812 /* Store one glyph for the composition IT->cmp_it.id in
21813 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21817 append_composite_glyph (struct it
*it
)
21819 struct glyph
*glyph
;
21820 enum glyph_row_area area
= it
->area
;
21822 xassert (it
->glyph_row
);
21824 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21825 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21827 /* If the glyph row is reversed, we need to prepend the glyph
21828 rather than append it. */
21829 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21833 /* Make room for the new glyph. */
21834 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21836 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21838 glyph
->charpos
= it
->cmp_it
.charpos
;
21839 glyph
->object
= it
->object
;
21840 glyph
->pixel_width
= it
->pixel_width
;
21841 glyph
->ascent
= it
->ascent
;
21842 glyph
->descent
= it
->descent
;
21843 glyph
->voffset
= it
->voffset
;
21844 glyph
->type
= COMPOSITE_GLYPH
;
21845 if (it
->cmp_it
.ch
< 0)
21847 glyph
->u
.cmp
.automatic
= 0;
21848 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21849 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21853 glyph
->u
.cmp
.automatic
= 1;
21854 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21855 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21856 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21858 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21859 glyph
->multibyte_p
= it
->multibyte_p
;
21860 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21861 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21862 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21863 || it
->phys_descent
> it
->descent
);
21864 glyph
->padding_p
= 0;
21865 glyph
->glyph_not_available_p
= 0;
21866 glyph
->face_id
= it
->face_id
;
21867 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21870 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21871 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21873 glyph
->bidi_type
= it
->bidi_it
.type
;
21875 ++it
->glyph_row
->used
[area
];
21878 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21882 /* Change IT->ascent and IT->height according to the setting of
21886 take_vertical_position_into_account (struct it
*it
)
21890 if (it
->voffset
< 0)
21891 /* Increase the ascent so that we can display the text higher
21893 it
->ascent
-= it
->voffset
;
21895 /* Increase the descent so that we can display the text lower
21897 it
->descent
+= it
->voffset
;
21902 /* Produce glyphs/get display metrics for the image IT is loaded with.
21903 See the description of struct display_iterator in dispextern.h for
21904 an overview of struct display_iterator. */
21907 produce_image_glyph (struct it
*it
)
21911 int glyph_ascent
, crop
;
21912 struct glyph_slice slice
;
21914 xassert (it
->what
== IT_IMAGE
);
21916 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21918 /* Make sure X resources of the face is loaded. */
21919 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21921 if (it
->image_id
< 0)
21923 /* Fringe bitmap. */
21924 it
->ascent
= it
->phys_ascent
= 0;
21925 it
->descent
= it
->phys_descent
= 0;
21926 it
->pixel_width
= 0;
21931 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21933 /* Make sure X resources of the image is loaded. */
21934 prepare_image_for_display (it
->f
, img
);
21936 slice
.x
= slice
.y
= 0;
21937 slice
.width
= img
->width
;
21938 slice
.height
= img
->height
;
21940 if (INTEGERP (it
->slice
.x
))
21941 slice
.x
= XINT (it
->slice
.x
);
21942 else if (FLOATP (it
->slice
.x
))
21943 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21945 if (INTEGERP (it
->slice
.y
))
21946 slice
.y
= XINT (it
->slice
.y
);
21947 else if (FLOATP (it
->slice
.y
))
21948 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21950 if (INTEGERP (it
->slice
.width
))
21951 slice
.width
= XINT (it
->slice
.width
);
21952 else if (FLOATP (it
->slice
.width
))
21953 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21955 if (INTEGERP (it
->slice
.height
))
21956 slice
.height
= XINT (it
->slice
.height
);
21957 else if (FLOATP (it
->slice
.height
))
21958 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21960 if (slice
.x
>= img
->width
)
21961 slice
.x
= img
->width
;
21962 if (slice
.y
>= img
->height
)
21963 slice
.y
= img
->height
;
21964 if (slice
.x
+ slice
.width
>= img
->width
)
21965 slice
.width
= img
->width
- slice
.x
;
21966 if (slice
.y
+ slice
.height
> img
->height
)
21967 slice
.height
= img
->height
- slice
.y
;
21969 if (slice
.width
== 0 || slice
.height
== 0)
21972 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21974 it
->descent
= slice
.height
- glyph_ascent
;
21976 it
->descent
+= img
->vmargin
;
21977 if (slice
.y
+ slice
.height
== img
->height
)
21978 it
->descent
+= img
->vmargin
;
21979 it
->phys_descent
= it
->descent
;
21981 it
->pixel_width
= slice
.width
;
21983 it
->pixel_width
+= img
->hmargin
;
21984 if (slice
.x
+ slice
.width
== img
->width
)
21985 it
->pixel_width
+= img
->hmargin
;
21987 /* It's quite possible for images to have an ascent greater than
21988 their height, so don't get confused in that case. */
21989 if (it
->descent
< 0)
21994 if (face
->box
!= FACE_NO_BOX
)
21996 if (face
->box_line_width
> 0)
21999 it
->ascent
+= face
->box_line_width
;
22000 if (slice
.y
+ slice
.height
== img
->height
)
22001 it
->descent
+= face
->box_line_width
;
22004 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22005 it
->pixel_width
+= eabs (face
->box_line_width
);
22006 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22007 it
->pixel_width
+= eabs (face
->box_line_width
);
22010 take_vertical_position_into_account (it
);
22012 /* Automatically crop wide image glyphs at right edge so we can
22013 draw the cursor on same display row. */
22014 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22015 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22017 it
->pixel_width
-= crop
;
22018 slice
.width
-= crop
;
22023 struct glyph
*glyph
;
22024 enum glyph_row_area area
= it
->area
;
22026 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22027 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22029 glyph
->charpos
= CHARPOS (it
->position
);
22030 glyph
->object
= it
->object
;
22031 glyph
->pixel_width
= it
->pixel_width
;
22032 glyph
->ascent
= glyph_ascent
;
22033 glyph
->descent
= it
->descent
;
22034 glyph
->voffset
= it
->voffset
;
22035 glyph
->type
= IMAGE_GLYPH
;
22036 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22037 glyph
->multibyte_p
= it
->multibyte_p
;
22038 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22039 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22040 glyph
->overlaps_vertically_p
= 0;
22041 glyph
->padding_p
= 0;
22042 glyph
->glyph_not_available_p
= 0;
22043 glyph
->face_id
= it
->face_id
;
22044 glyph
->u
.img_id
= img
->id
;
22045 glyph
->slice
.img
= slice
;
22046 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22049 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22050 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22052 glyph
->bidi_type
= it
->bidi_it
.type
;
22054 ++it
->glyph_row
->used
[area
];
22057 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22062 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22063 of the glyph, WIDTH and HEIGHT are the width and height of the
22064 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22067 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22068 int width
, int height
, int ascent
)
22070 struct glyph
*glyph
;
22071 enum glyph_row_area area
= it
->area
;
22073 xassert (ascent
>= 0 && ascent
<= height
);
22075 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22076 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22078 /* If the glyph row is reversed, we need to prepend the glyph
22079 rather than append it. */
22080 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22084 /* Make room for the additional glyph. */
22085 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22087 glyph
= it
->glyph_row
->glyphs
[area
];
22089 glyph
->charpos
= CHARPOS (it
->position
);
22090 glyph
->object
= object
;
22091 glyph
->pixel_width
= width
;
22092 glyph
->ascent
= ascent
;
22093 glyph
->descent
= height
- ascent
;
22094 glyph
->voffset
= it
->voffset
;
22095 glyph
->type
= STRETCH_GLYPH
;
22096 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22097 glyph
->multibyte_p
= it
->multibyte_p
;
22098 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22099 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22100 glyph
->overlaps_vertically_p
= 0;
22101 glyph
->padding_p
= 0;
22102 glyph
->glyph_not_available_p
= 0;
22103 glyph
->face_id
= it
->face_id
;
22104 glyph
->u
.stretch
.ascent
= ascent
;
22105 glyph
->u
.stretch
.height
= height
;
22106 glyph
->slice
.img
= null_glyph_slice
;
22107 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22110 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22111 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22113 glyph
->bidi_type
= it
->bidi_it
.type
;
22117 glyph
->resolved_level
= 0;
22118 glyph
->bidi_type
= UNKNOWN_BT
;
22120 ++it
->glyph_row
->used
[area
];
22123 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22127 /* Produce a stretch glyph for iterator IT. IT->object is the value
22128 of the glyph property displayed. The value must be a list
22129 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22132 1. `:width WIDTH' specifies that the space should be WIDTH *
22133 canonical char width wide. WIDTH may be an integer or floating
22136 2. `:relative-width FACTOR' specifies that the width of the stretch
22137 should be computed from the width of the first character having the
22138 `glyph' property, and should be FACTOR times that width.
22140 3. `:align-to HPOS' specifies that the space should be wide enough
22141 to reach HPOS, a value in canonical character units.
22143 Exactly one of the above pairs must be present.
22145 4. `:height HEIGHT' specifies that the height of the stretch produced
22146 should be HEIGHT, measured in canonical character units.
22148 5. `:relative-height FACTOR' specifies that the height of the
22149 stretch should be FACTOR times the height of the characters having
22150 the glyph property.
22152 Either none or exactly one of 4 or 5 must be present.
22154 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22155 of the stretch should be used for the ascent of the stretch.
22156 ASCENT must be in the range 0 <= ASCENT <= 100. */
22159 produce_stretch_glyph (struct it
*it
)
22161 /* (space :width WIDTH :height HEIGHT ...) */
22162 Lisp_Object prop
, plist
;
22163 int width
= 0, height
= 0, align_to
= -1;
22164 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22167 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22168 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22170 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22172 /* List should start with `space'. */
22173 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22174 plist
= XCDR (it
->object
);
22176 /* Compute the width of the stretch. */
22177 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22178 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22180 /* Absolute width `:width WIDTH' specified and valid. */
22181 zero_width_ok_p
= 1;
22184 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22187 /* Relative width `:relative-width FACTOR' specified and valid.
22188 Compute the width of the characters having the `glyph'
22191 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22194 if (it
->multibyte_p
)
22195 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22198 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
22199 if (! ASCII_CHAR_P (it2
.c
))
22200 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
22203 it2
.glyph_row
= NULL
;
22204 it2
.what
= IT_CHARACTER
;
22205 x_produce_glyphs (&it2
);
22206 width
= NUMVAL (prop
) * it2
.pixel_width
;
22208 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22209 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22211 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22212 align_to
= (align_to
< 0
22214 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22215 else if (align_to
< 0)
22216 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22217 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22218 zero_width_ok_p
= 1;
22221 /* Nothing specified -> width defaults to canonical char width. */
22222 width
= FRAME_COLUMN_WIDTH (it
->f
);
22224 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22227 /* Compute height. */
22228 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22229 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22232 zero_height_ok_p
= 1;
22234 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22236 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22238 height
= FONT_HEIGHT (font
);
22240 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22243 /* Compute percentage of height used for ascent. If
22244 `:ascent ASCENT' is present and valid, use that. Otherwise,
22245 derive the ascent from the font in use. */
22246 if (prop
= Fplist_get (plist
, QCascent
),
22247 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22248 ascent
= height
* NUMVAL (prop
) / 100.0;
22249 else if (!NILP (prop
)
22250 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22251 ascent
= min (max (0, (int)tem
), height
);
22253 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22255 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22256 && it
->current_x
+ width
> it
->last_visible_x
)
22257 width
= it
->last_visible_x
- it
->current_x
- 1;
22259 if (width
> 0 && height
> 0 && it
->glyph_row
)
22261 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22262 if (!STRINGP (object
))
22263 object
= it
->w
->buffer
;
22264 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22267 it
->pixel_width
= width
;
22268 it
->ascent
= it
->phys_ascent
= ascent
;
22269 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22270 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22272 take_vertical_position_into_account (it
);
22275 /* Calculate line-height and line-spacing properties.
22276 An integer value specifies explicit pixel value.
22277 A float value specifies relative value to current face height.
22278 A cons (float . face-name) specifies relative value to
22279 height of specified face font.
22281 Returns height in pixels, or nil. */
22285 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22286 int boff
, int override
)
22288 Lisp_Object face_name
= Qnil
;
22289 int ascent
, descent
, height
;
22291 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22296 face_name
= XCAR (val
);
22298 if (!NUMBERP (val
))
22299 val
= make_number (1);
22300 if (NILP (face_name
))
22302 height
= it
->ascent
+ it
->descent
;
22307 if (NILP (face_name
))
22309 font
= FRAME_FONT (it
->f
);
22310 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22312 else if (EQ (face_name
, Qt
))
22321 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22323 return make_number (-1);
22325 face
= FACE_FROM_ID (it
->f
, face_id
);
22328 return make_number (-1);
22329 boff
= font
->baseline_offset
;
22330 if (font
->vertical_centering
)
22331 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22334 ascent
= FONT_BASE (font
) + boff
;
22335 descent
= FONT_DESCENT (font
) - boff
;
22339 it
->override_ascent
= ascent
;
22340 it
->override_descent
= descent
;
22341 it
->override_boff
= boff
;
22344 height
= ascent
+ descent
;
22348 height
= (int)(XFLOAT_DATA (val
) * height
);
22349 else if (INTEGERP (val
))
22350 height
*= XINT (val
);
22352 return make_number (height
);
22356 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
22357 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
22358 and only if this is for a character for which no font was found.
22360 If the display method (it->glyphless_method) is
22361 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
22362 length of the acronym or the hexadecimal string, UPPER_XOFF and
22363 UPPER_YOFF are pixel offsets for the upper part of the string,
22364 LOWER_XOFF and LOWER_YOFF are for the lower part.
22366 For the other display methods, LEN through LOWER_YOFF are zero. */
22369 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
22370 short upper_xoff
, short upper_yoff
,
22371 short lower_xoff
, short lower_yoff
)
22373 struct glyph
*glyph
;
22374 enum glyph_row_area area
= it
->area
;
22376 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22377 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22379 /* If the glyph row is reversed, we need to prepend the glyph
22380 rather than append it. */
22381 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22385 /* Make room for the additional glyph. */
22386 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22388 glyph
= it
->glyph_row
->glyphs
[area
];
22390 glyph
->charpos
= CHARPOS (it
->position
);
22391 glyph
->object
= it
->object
;
22392 glyph
->pixel_width
= it
->pixel_width
;
22393 glyph
->ascent
= it
->ascent
;
22394 glyph
->descent
= it
->descent
;
22395 glyph
->voffset
= it
->voffset
;
22396 glyph
->type
= GLYPHLESS_GLYPH
;
22397 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
22398 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
22399 glyph
->u
.glyphless
.len
= len
;
22400 glyph
->u
.glyphless
.ch
= it
->c
;
22401 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
22402 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
22403 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
22404 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
22405 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22406 glyph
->multibyte_p
= it
->multibyte_p
;
22407 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22408 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22409 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22410 || it
->phys_descent
> it
->descent
);
22411 glyph
->padding_p
= 0;
22412 glyph
->glyph_not_available_p
= 0;
22413 glyph
->face_id
= face_id
;
22414 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22417 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22418 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22420 glyph
->bidi_type
= it
->bidi_it
.type
;
22422 ++it
->glyph_row
->used
[area
];
22425 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22429 /* Produce a glyph for a glyphless character for iterator IT.
22430 IT->glyphless_method specifies which method to use for displaying
22431 the character. See the description of enum
22432 glyphless_display_method in dispextern.h for the detail.
22434 FOR_NO_FONT is nonzero if and only if this is for a character for
22435 which no font was found. ACRONYM, if non-nil, is an acronym string
22436 for the character. */
22439 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
22444 int base_width
, base_height
, width
, height
;
22445 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
22448 /* Get the metrics of the base font. We always refer to the current
22450 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
22451 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22452 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
22453 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
22454 base_height
= it
->ascent
+ it
->descent
;
22455 base_width
= font
->average_width
;
22457 /* Get a face ID for the glyph by utilizing a cache (the same way as
22458 doen for `escape-glyph' in get_next_display_element). */
22459 if (it
->f
== last_glyphless_glyph_frame
22460 && it
->face_id
== last_glyphless_glyph_face_id
)
22462 face_id
= last_glyphless_glyph_merged_face_id
;
22466 /* Merge the `glyphless-char' face into the current face. */
22467 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
22468 last_glyphless_glyph_frame
= it
->f
;
22469 last_glyphless_glyph_face_id
= it
->face_id
;
22470 last_glyphless_glyph_merged_face_id
= face_id
;
22473 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
22475 it
->pixel_width
= THIN_SPACE_WIDTH
;
22477 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22479 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
22481 width
= CHAR_WIDTH (it
->c
);
22484 else if (width
> 4)
22486 it
->pixel_width
= base_width
* width
;
22488 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
22494 unsigned int code
[6];
22496 int ascent
, descent
;
22497 struct font_metrics metrics_upper
, metrics_lower
;
22499 face
= FACE_FROM_ID (it
->f
, face_id
);
22500 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22501 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22503 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
22505 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
22506 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
22507 if (CONSP (acronym
))
22508 acronym
= XCAR (acronym
);
22509 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
22513 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
22514 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
22517 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
22518 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
22519 upper_len
= (len
+ 1) / 2;
22520 font
->driver
->text_extents (font
, code
, upper_len
,
22522 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
22527 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
22528 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
22529 upper_xoff
= upper_yoff
= 2; /* the typical case */
22530 if (base_width
>= width
)
22532 /* Align the upper to the left, the lower to the right. */
22533 it
->pixel_width
= base_width
;
22534 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
22538 /* Center the shorter one. */
22539 it
->pixel_width
= width
;
22540 if (metrics_upper
.width
>= metrics_lower
.width
)
22541 lower_xoff
= (width
- metrics_lower
.width
) / 2;
22544 /* FIXME: This code doesn't look right. It formerly was
22545 missing the "lower_xoff = 0;", which couldn't have
22546 been right since it left lower_xoff uninitialized. */
22548 upper_xoff
= (width
- metrics_upper
.width
) / 2;
22552 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
22553 top, bottom, and between upper and lower strings. */
22554 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
22555 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
22556 /* Center vertically.
22557 H:base_height, D:base_descent
22558 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
22560 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
22561 descent = D - H/2 + h/2;
22562 lower_yoff = descent - 2 - ld;
22563 upper_yoff = lower_yoff - la - 1 - ud; */
22564 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
22565 descent
= it
->descent
- (base_height
- height
) / 2;
22566 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
22567 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
22568 - metrics_upper
.descent
);
22569 /* Don't make the height shorter than the base height. */
22570 if (height
> base_height
)
22572 it
->ascent
= ascent
;
22573 it
->descent
= descent
;
22577 it
->phys_ascent
= it
->ascent
;
22578 it
->phys_descent
= it
->descent
;
22580 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
22581 upper_xoff
, upper_yoff
,
22582 lower_xoff
, lower_yoff
);
22584 take_vertical_position_into_account (it
);
22589 Produce glyphs/get display metrics for the display element IT is
22590 loaded with. See the description of struct it in dispextern.h
22591 for an overview of struct it. */
22594 x_produce_glyphs (struct it
*it
)
22596 int extra_line_spacing
= it
->extra_line_spacing
;
22598 it
->glyph_not_available_p
= 0;
22600 if (it
->what
== IT_CHARACTER
)
22603 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22604 struct font
*font
= face
->font
;
22605 struct font_metrics
*pcm
= NULL
;
22606 int boff
; /* baseline offset */
22610 /* When no suitable font is found, display this character by
22611 the method specified in the first extra slot of
22612 Vglyphless_char_display. */
22613 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
22615 xassert (it
->what
== IT_GLYPHLESS
);
22616 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
22620 boff
= font
->baseline_offset
;
22621 if (font
->vertical_centering
)
22622 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22624 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22630 if (it
->override_ascent
>= 0)
22632 it
->ascent
= it
->override_ascent
;
22633 it
->descent
= it
->override_descent
;
22634 boff
= it
->override_boff
;
22638 it
->ascent
= FONT_BASE (font
) + boff
;
22639 it
->descent
= FONT_DESCENT (font
) - boff
;
22642 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22644 pcm
= get_per_char_metric (font
, &char2b
);
22645 if (pcm
->width
== 0
22646 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22652 it
->phys_ascent
= pcm
->ascent
+ boff
;
22653 it
->phys_descent
= pcm
->descent
- boff
;
22654 it
->pixel_width
= pcm
->width
;
22658 it
->glyph_not_available_p
= 1;
22659 it
->phys_ascent
= it
->ascent
;
22660 it
->phys_descent
= it
->descent
;
22661 it
->pixel_width
= font
->space_width
;
22664 if (it
->constrain_row_ascent_descent_p
)
22666 if (it
->descent
> it
->max_descent
)
22668 it
->ascent
+= it
->descent
- it
->max_descent
;
22669 it
->descent
= it
->max_descent
;
22671 if (it
->ascent
> it
->max_ascent
)
22673 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22674 it
->ascent
= it
->max_ascent
;
22676 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22677 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22678 extra_line_spacing
= 0;
22681 /* If this is a space inside a region of text with
22682 `space-width' property, change its width. */
22683 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22685 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22687 /* If face has a box, add the box thickness to the character
22688 height. If character has a box line to the left and/or
22689 right, add the box line width to the character's width. */
22690 if (face
->box
!= FACE_NO_BOX
)
22692 int thick
= face
->box_line_width
;
22696 it
->ascent
+= thick
;
22697 it
->descent
+= thick
;
22702 if (it
->start_of_box_run_p
)
22703 it
->pixel_width
+= thick
;
22704 if (it
->end_of_box_run_p
)
22705 it
->pixel_width
+= thick
;
22708 /* If face has an overline, add the height of the overline
22709 (1 pixel) and a 1 pixel margin to the character height. */
22710 if (face
->overline_p
)
22711 it
->ascent
+= overline_margin
;
22713 if (it
->constrain_row_ascent_descent_p
)
22715 if (it
->ascent
> it
->max_ascent
)
22716 it
->ascent
= it
->max_ascent
;
22717 if (it
->descent
> it
->max_descent
)
22718 it
->descent
= it
->max_descent
;
22721 take_vertical_position_into_account (it
);
22723 /* If we have to actually produce glyphs, do it. */
22728 /* Translate a space with a `space-width' property
22729 into a stretch glyph. */
22730 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22731 / FONT_HEIGHT (font
));
22732 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22733 it
->ascent
+ it
->descent
, ascent
);
22738 /* If characters with lbearing or rbearing are displayed
22739 in this line, record that fact in a flag of the
22740 glyph row. This is used to optimize X output code. */
22741 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22742 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22744 if (! stretched_p
&& it
->pixel_width
== 0)
22745 /* We assure that all visible glyphs have at least 1-pixel
22747 it
->pixel_width
= 1;
22749 else if (it
->char_to_display
== '\n')
22751 /* A newline has no width, but we need the height of the
22752 line. But if previous part of the line sets a height,
22753 don't increase that height */
22755 Lisp_Object height
;
22756 Lisp_Object total_height
= Qnil
;
22758 it
->override_ascent
= -1;
22759 it
->pixel_width
= 0;
22762 height
= get_it_property (it
, Qline_height
);
22763 /* Split (line-height total-height) list */
22765 && CONSP (XCDR (height
))
22766 && NILP (XCDR (XCDR (height
))))
22768 total_height
= XCAR (XCDR (height
));
22769 height
= XCAR (height
);
22771 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22773 if (it
->override_ascent
>= 0)
22775 it
->ascent
= it
->override_ascent
;
22776 it
->descent
= it
->override_descent
;
22777 boff
= it
->override_boff
;
22781 it
->ascent
= FONT_BASE (font
) + boff
;
22782 it
->descent
= FONT_DESCENT (font
) - boff
;
22785 if (EQ (height
, Qt
))
22787 if (it
->descent
> it
->max_descent
)
22789 it
->ascent
+= it
->descent
- it
->max_descent
;
22790 it
->descent
= it
->max_descent
;
22792 if (it
->ascent
> it
->max_ascent
)
22794 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22795 it
->ascent
= it
->max_ascent
;
22797 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22798 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22799 it
->constrain_row_ascent_descent_p
= 1;
22800 extra_line_spacing
= 0;
22804 Lisp_Object spacing
;
22806 it
->phys_ascent
= it
->ascent
;
22807 it
->phys_descent
= it
->descent
;
22809 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22810 && face
->box
!= FACE_NO_BOX
22811 && face
->box_line_width
> 0)
22813 it
->ascent
+= face
->box_line_width
;
22814 it
->descent
+= face
->box_line_width
;
22817 && XINT (height
) > it
->ascent
+ it
->descent
)
22818 it
->ascent
= XINT (height
) - it
->descent
;
22820 if (!NILP (total_height
))
22821 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22824 spacing
= get_it_property (it
, Qline_spacing
);
22825 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22827 if (INTEGERP (spacing
))
22829 extra_line_spacing
= XINT (spacing
);
22830 if (!NILP (total_height
))
22831 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22835 else /* i.e. (it->char_to_display == '\t') */
22837 if (font
->space_width
> 0)
22839 int tab_width
= it
->tab_width
* font
->space_width
;
22840 int x
= it
->current_x
+ it
->continuation_lines_width
;
22841 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22843 /* If the distance from the current position to the next tab
22844 stop is less than a space character width, use the
22845 tab stop after that. */
22846 if (next_tab_x
- x
< font
->space_width
)
22847 next_tab_x
+= tab_width
;
22849 it
->pixel_width
= next_tab_x
- x
;
22851 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22852 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22856 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22857 it
->ascent
+ it
->descent
, it
->ascent
);
22862 it
->pixel_width
= 0;
22867 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22869 /* A static composition.
22871 Note: A composition is represented as one glyph in the
22872 glyph matrix. There are no padding glyphs.
22874 Important note: pixel_width, ascent, and descent are the
22875 values of what is drawn by draw_glyphs (i.e. the values of
22876 the overall glyphs composed). */
22877 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22878 int boff
; /* baseline offset */
22879 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22880 int glyph_len
= cmp
->glyph_len
;
22881 struct font
*font
= face
->font
;
22885 /* If we have not yet calculated pixel size data of glyphs of
22886 the composition for the current face font, calculate them
22887 now. Theoretically, we have to check all fonts for the
22888 glyphs, but that requires much time and memory space. So,
22889 here we check only the font of the first glyph. This may
22890 lead to incorrect display, but it's very rare, and C-l
22891 (recenter-top-bottom) can correct the display anyway. */
22892 if (! cmp
->font
|| cmp
->font
!= font
)
22894 /* Ascent and descent of the font of the first character
22895 of this composition (adjusted by baseline offset).
22896 Ascent and descent of overall glyphs should not be less
22897 than these, respectively. */
22898 int font_ascent
, font_descent
, font_height
;
22899 /* Bounding box of the overall glyphs. */
22900 int leftmost
, rightmost
, lowest
, highest
;
22901 int lbearing
, rbearing
;
22902 int i
, width
, ascent
, descent
;
22903 int left_padded
= 0, right_padded
= 0;
22904 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
22906 struct font_metrics
*pcm
;
22907 int font_not_found_p
;
22910 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22911 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22913 if (glyph_len
< cmp
->glyph_len
)
22915 for (i
= 0; i
< glyph_len
; i
++)
22917 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22919 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22924 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22925 : IT_CHARPOS (*it
));
22926 /* If no suitable font is found, use the default font. */
22927 font_not_found_p
= font
== NULL
;
22928 if (font_not_found_p
)
22930 face
= face
->ascii_face
;
22933 boff
= font
->baseline_offset
;
22934 if (font
->vertical_centering
)
22935 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22936 font_ascent
= FONT_BASE (font
) + boff
;
22937 font_descent
= FONT_DESCENT (font
) - boff
;
22938 font_height
= FONT_HEIGHT (font
);
22940 cmp
->font
= (void *) font
;
22943 if (! font_not_found_p
)
22945 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22947 pcm
= get_per_char_metric (font
, &char2b
);
22950 /* Initialize the bounding box. */
22953 width
= pcm
->width
;
22954 ascent
= pcm
->ascent
;
22955 descent
= pcm
->descent
;
22956 lbearing
= pcm
->lbearing
;
22957 rbearing
= pcm
->rbearing
;
22961 width
= font
->space_width
;
22962 ascent
= FONT_BASE (font
);
22963 descent
= FONT_DESCENT (font
);
22970 lowest
= - descent
+ boff
;
22971 highest
= ascent
+ boff
;
22973 if (! font_not_found_p
22974 && font
->default_ascent
22975 && CHAR_TABLE_P (Vuse_default_ascent
)
22976 && !NILP (Faref (Vuse_default_ascent
,
22977 make_number (it
->char_to_display
))))
22978 highest
= font
->default_ascent
+ boff
;
22980 /* Draw the first glyph at the normal position. It may be
22981 shifted to right later if some other glyphs are drawn
22983 cmp
->offsets
[i
* 2] = 0;
22984 cmp
->offsets
[i
* 2 + 1] = boff
;
22985 cmp
->lbearing
= lbearing
;
22986 cmp
->rbearing
= rbearing
;
22988 /* Set cmp->offsets for the remaining glyphs. */
22989 for (i
++; i
< glyph_len
; i
++)
22991 int left
, right
, btm
, top
;
22992 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22994 struct face
*this_face
;
22998 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22999 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23000 font
= this_face
->font
;
23006 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23008 pcm
= get_per_char_metric (font
, &char2b
);
23011 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23014 width
= pcm
->width
;
23015 ascent
= pcm
->ascent
;
23016 descent
= pcm
->descent
;
23017 lbearing
= pcm
->lbearing
;
23018 rbearing
= pcm
->rbearing
;
23019 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23021 /* Relative composition with or without
23022 alternate chars. */
23023 left
= (leftmost
+ rightmost
- width
) / 2;
23024 btm
= - descent
+ boff
;
23025 if (font
->relative_compose
23026 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23027 || NILP (Faref (Vignore_relative_composition
,
23028 make_number (ch
)))))
23031 if (- descent
>= font
->relative_compose
)
23032 /* One extra pixel between two glyphs. */
23034 else if (ascent
<= 0)
23035 /* One extra pixel between two glyphs. */
23036 btm
= lowest
- 1 - ascent
- descent
;
23041 /* A composition rule is specified by an integer
23042 value that encodes global and new reference
23043 points (GREF and NREF). GREF and NREF are
23044 specified by numbers as below:
23046 0---1---2 -- ascent
23050 9--10--11 -- center
23052 ---3---4---5--- baseline
23054 6---7---8 -- descent
23056 int rule
= COMPOSITION_RULE (cmp
, i
);
23057 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23059 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23060 grefx
= gref
% 3, nrefx
= nref
% 3;
23061 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23063 xoff
= font_height
* (xoff
- 128) / 256;
23065 yoff
= font_height
* (yoff
- 128) / 256;
23068 + grefx
* (rightmost
- leftmost
) / 2
23069 - nrefx
* width
/ 2
23072 btm
= ((grefy
== 0 ? highest
23074 : grefy
== 2 ? lowest
23075 : (highest
+ lowest
) / 2)
23076 - (nrefy
== 0 ? ascent
+ descent
23077 : nrefy
== 1 ? descent
- boff
23079 : (ascent
+ descent
) / 2)
23083 cmp
->offsets
[i
* 2] = left
;
23084 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23086 /* Update the bounding box of the overall glyphs. */
23089 right
= left
+ width
;
23090 if (left
< leftmost
)
23092 if (right
> rightmost
)
23095 top
= btm
+ descent
+ ascent
;
23101 if (cmp
->lbearing
> left
+ lbearing
)
23102 cmp
->lbearing
= left
+ lbearing
;
23103 if (cmp
->rbearing
< left
+ rbearing
)
23104 cmp
->rbearing
= left
+ rbearing
;
23108 /* If there are glyphs whose x-offsets are negative,
23109 shift all glyphs to the right and make all x-offsets
23113 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23114 cmp
->offsets
[i
* 2] -= leftmost
;
23115 rightmost
-= leftmost
;
23116 cmp
->lbearing
-= leftmost
;
23117 cmp
->rbearing
-= leftmost
;
23120 if (left_padded
&& cmp
->lbearing
< 0)
23122 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23123 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23124 rightmost
-= cmp
->lbearing
;
23125 cmp
->rbearing
-= cmp
->lbearing
;
23128 if (right_padded
&& rightmost
< cmp
->rbearing
)
23130 rightmost
= cmp
->rbearing
;
23133 cmp
->pixel_width
= rightmost
;
23134 cmp
->ascent
= highest
;
23135 cmp
->descent
= - lowest
;
23136 if (cmp
->ascent
< font_ascent
)
23137 cmp
->ascent
= font_ascent
;
23138 if (cmp
->descent
< font_descent
)
23139 cmp
->descent
= font_descent
;
23143 && (cmp
->lbearing
< 0
23144 || cmp
->rbearing
> cmp
->pixel_width
))
23145 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23147 it
->pixel_width
= cmp
->pixel_width
;
23148 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23149 it
->descent
= it
->phys_descent
= cmp
->descent
;
23150 if (face
->box
!= FACE_NO_BOX
)
23152 int thick
= face
->box_line_width
;
23156 it
->ascent
+= thick
;
23157 it
->descent
+= thick
;
23162 if (it
->start_of_box_run_p
)
23163 it
->pixel_width
+= thick
;
23164 if (it
->end_of_box_run_p
)
23165 it
->pixel_width
+= thick
;
23168 /* If face has an overline, add the height of the overline
23169 (1 pixel) and a 1 pixel margin to the character height. */
23170 if (face
->overline_p
)
23171 it
->ascent
+= overline_margin
;
23173 take_vertical_position_into_account (it
);
23174 if (it
->ascent
< 0)
23176 if (it
->descent
< 0)
23180 append_composite_glyph (it
);
23182 else if (it
->what
== IT_COMPOSITION
)
23184 /* A dynamic (automatic) composition. */
23185 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23186 Lisp_Object gstring
;
23187 struct font_metrics metrics
;
23189 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23191 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23194 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23195 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23196 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23197 it
->descent
= it
->phys_descent
= metrics
.descent
;
23198 if (face
->box
!= FACE_NO_BOX
)
23200 int thick
= face
->box_line_width
;
23204 it
->ascent
+= thick
;
23205 it
->descent
+= thick
;
23210 if (it
->start_of_box_run_p
)
23211 it
->pixel_width
+= thick
;
23212 if (it
->end_of_box_run_p
)
23213 it
->pixel_width
+= thick
;
23215 /* If face has an overline, add the height of the overline
23216 (1 pixel) and a 1 pixel margin to the character height. */
23217 if (face
->overline_p
)
23218 it
->ascent
+= overline_margin
;
23219 take_vertical_position_into_account (it
);
23220 if (it
->ascent
< 0)
23222 if (it
->descent
< 0)
23226 append_composite_glyph (it
);
23228 else if (it
->what
== IT_GLYPHLESS
)
23229 produce_glyphless_glyph (it
, 0, Qnil
);
23230 else if (it
->what
== IT_IMAGE
)
23231 produce_image_glyph (it
);
23232 else if (it
->what
== IT_STRETCH
)
23233 produce_stretch_glyph (it
);
23236 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23237 because this isn't true for images with `:ascent 100'. */
23238 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23239 if (it
->area
== TEXT_AREA
)
23240 it
->current_x
+= it
->pixel_width
;
23242 if (extra_line_spacing
> 0)
23244 it
->descent
+= extra_line_spacing
;
23245 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23246 it
->max_extra_line_spacing
= extra_line_spacing
;
23249 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23250 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23251 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23252 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23256 Output LEN glyphs starting at START at the nominal cursor position.
23257 Advance the nominal cursor over the text. The global variable
23258 updated_window contains the window being updated, updated_row is
23259 the glyph row being updated, and updated_area is the area of that
23260 row being updated. */
23263 x_write_glyphs (struct glyph
*start
, int len
)
23267 xassert (updated_window
&& updated_row
);
23270 /* Write glyphs. */
23272 hpos
= start
- updated_row
->glyphs
[updated_area
];
23273 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23274 updated_row
, updated_area
,
23276 DRAW_NORMAL_TEXT
, 0);
23278 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23279 if (updated_area
== TEXT_AREA
23280 && updated_window
->phys_cursor_on_p
23281 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23282 && updated_window
->phys_cursor
.hpos
>= hpos
23283 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23284 updated_window
->phys_cursor_on_p
= 0;
23288 /* Advance the output cursor. */
23289 output_cursor
.hpos
+= len
;
23290 output_cursor
.x
= x
;
23295 Insert LEN glyphs from START at the nominal cursor position. */
23298 x_insert_glyphs (struct glyph
*start
, int len
)
23302 int line_height
, shift_by_width
, shifted_region_width
;
23303 struct glyph_row
*row
;
23304 struct glyph
*glyph
;
23305 int frame_x
, frame_y
;
23308 xassert (updated_window
&& updated_row
);
23310 w
= updated_window
;
23311 f
= XFRAME (WINDOW_FRAME (w
));
23313 /* Get the height of the line we are in. */
23315 line_height
= row
->height
;
23317 /* Get the width of the glyphs to insert. */
23318 shift_by_width
= 0;
23319 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23320 shift_by_width
+= glyph
->pixel_width
;
23322 /* Get the width of the region to shift right. */
23323 shifted_region_width
= (window_box_width (w
, updated_area
)
23328 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23329 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23331 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23332 line_height
, shift_by_width
);
23334 /* Write the glyphs. */
23335 hpos
= start
- row
->glyphs
[updated_area
];
23336 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23338 DRAW_NORMAL_TEXT
, 0);
23340 /* Advance the output cursor. */
23341 output_cursor
.hpos
+= len
;
23342 output_cursor
.x
+= shift_by_width
;
23348 Erase the current text line from the nominal cursor position
23349 (inclusive) to pixel column TO_X (exclusive). The idea is that
23350 everything from TO_X onward is already erased.
23352 TO_X is a pixel position relative to updated_area of
23353 updated_window. TO_X == -1 means clear to the end of this area. */
23356 x_clear_end_of_line (int to_x
)
23359 struct window
*w
= updated_window
;
23360 int max_x
, min_y
, max_y
;
23361 int from_x
, from_y
, to_y
;
23363 xassert (updated_window
&& updated_row
);
23364 f
= XFRAME (w
->frame
);
23366 if (updated_row
->full_width_p
)
23367 max_x
= WINDOW_TOTAL_WIDTH (w
);
23369 max_x
= window_box_width (w
, updated_area
);
23370 max_y
= window_text_bottom_y (w
);
23372 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23373 of window. For TO_X > 0, truncate to end of drawing area. */
23379 to_x
= min (to_x
, max_x
);
23381 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23383 /* Notice if the cursor will be cleared by this operation. */
23384 if (!updated_row
->full_width_p
)
23385 notice_overwritten_cursor (w
, updated_area
,
23386 output_cursor
.x
, -1,
23388 MATRIX_ROW_BOTTOM_Y (updated_row
));
23390 from_x
= output_cursor
.x
;
23392 /* Translate to frame coordinates. */
23393 if (updated_row
->full_width_p
)
23395 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23396 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23400 int area_left
= window_box_left (w
, updated_area
);
23401 from_x
+= area_left
;
23405 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23406 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23407 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23409 /* Prevent inadvertently clearing to end of the X window. */
23410 if (to_x
> from_x
&& to_y
> from_y
)
23413 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23414 to_x
- from_x
, to_y
- from_y
);
23419 #endif /* HAVE_WINDOW_SYSTEM */
23423 /***********************************************************************
23425 ***********************************************************************/
23427 /* Value is the internal representation of the specified cursor type
23428 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23429 of the bar cursor. */
23431 static enum text_cursor_kinds
23432 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23434 enum text_cursor_kinds type
;
23439 if (EQ (arg
, Qbox
))
23440 return FILLED_BOX_CURSOR
;
23442 if (EQ (arg
, Qhollow
))
23443 return HOLLOW_BOX_CURSOR
;
23445 if (EQ (arg
, Qbar
))
23452 && EQ (XCAR (arg
), Qbar
)
23453 && INTEGERP (XCDR (arg
))
23454 && XINT (XCDR (arg
)) >= 0)
23456 *width
= XINT (XCDR (arg
));
23460 if (EQ (arg
, Qhbar
))
23463 return HBAR_CURSOR
;
23467 && EQ (XCAR (arg
), Qhbar
)
23468 && INTEGERP (XCDR (arg
))
23469 && XINT (XCDR (arg
)) >= 0)
23471 *width
= XINT (XCDR (arg
));
23472 return HBAR_CURSOR
;
23475 /* Treat anything unknown as "hollow box cursor".
23476 It was bad to signal an error; people have trouble fixing
23477 .Xdefaults with Emacs, when it has something bad in it. */
23478 type
= HOLLOW_BOX_CURSOR
;
23483 /* Set the default cursor types for specified frame. */
23485 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23490 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23491 FRAME_CURSOR_WIDTH (f
) = width
;
23493 /* By default, set up the blink-off state depending on the on-state. */
23495 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23498 FRAME_BLINK_OFF_CURSOR (f
)
23499 = get_specified_cursor_type (XCDR (tem
), &width
);
23500 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23503 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23507 #ifdef HAVE_WINDOW_SYSTEM
23509 /* Return the cursor we want to be displayed in window W. Return
23510 width of bar/hbar cursor through WIDTH arg. Return with
23511 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23512 (i.e. if the `system caret' should track this cursor).
23514 In a mini-buffer window, we want the cursor only to appear if we
23515 are reading input from this window. For the selected window, we
23516 want the cursor type given by the frame parameter or buffer local
23517 setting of cursor-type. If explicitly marked off, draw no cursor.
23518 In all other cases, we want a hollow box cursor. */
23520 static enum text_cursor_kinds
23521 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23522 int *active_cursor
)
23524 struct frame
*f
= XFRAME (w
->frame
);
23525 struct buffer
*b
= XBUFFER (w
->buffer
);
23526 int cursor_type
= DEFAULT_CURSOR
;
23527 Lisp_Object alt_cursor
;
23528 int non_selected
= 0;
23530 *active_cursor
= 1;
23533 if (cursor_in_echo_area
23534 && FRAME_HAS_MINIBUF_P (f
)
23535 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23537 if (w
== XWINDOW (echo_area_window
))
23539 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
23541 *width
= FRAME_CURSOR_WIDTH (f
);
23542 return FRAME_DESIRED_CURSOR (f
);
23545 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23548 *active_cursor
= 0;
23552 /* Detect a nonselected window or nonselected frame. */
23553 else if (w
!= XWINDOW (f
->selected_window
)
23554 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
23556 *active_cursor
= 0;
23558 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23564 /* Never display a cursor in a window in which cursor-type is nil. */
23565 if (NILP (BVAR (b
, cursor_type
)))
23568 /* Get the normal cursor type for this window. */
23569 if (EQ (BVAR (b
, cursor_type
), Qt
))
23571 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23572 *width
= FRAME_CURSOR_WIDTH (f
);
23575 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
23577 /* Use cursor-in-non-selected-windows instead
23578 for non-selected window or frame. */
23581 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
23582 if (!EQ (Qt
, alt_cursor
))
23583 return get_specified_cursor_type (alt_cursor
, width
);
23584 /* t means modify the normal cursor type. */
23585 if (cursor_type
== FILLED_BOX_CURSOR
)
23586 cursor_type
= HOLLOW_BOX_CURSOR
;
23587 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23589 return cursor_type
;
23592 /* Use normal cursor if not blinked off. */
23593 if (!w
->cursor_off_p
)
23595 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23597 if (cursor_type
== FILLED_BOX_CURSOR
)
23599 /* Using a block cursor on large images can be very annoying.
23600 So use a hollow cursor for "large" images.
23601 If image is not transparent (no mask), also use hollow cursor. */
23602 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23603 if (img
!= NULL
&& IMAGEP (img
->spec
))
23605 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23606 where N = size of default frame font size.
23607 This should cover most of the "tiny" icons people may use. */
23609 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23610 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23611 cursor_type
= HOLLOW_BOX_CURSOR
;
23614 else if (cursor_type
!= NO_CURSOR
)
23616 /* Display current only supports BOX and HOLLOW cursors for images.
23617 So for now, unconditionally use a HOLLOW cursor when cursor is
23618 not a solid box cursor. */
23619 cursor_type
= HOLLOW_BOX_CURSOR
;
23622 return cursor_type
;
23625 /* Cursor is blinked off, so determine how to "toggle" it. */
23627 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23628 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
23629 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23631 /* Then see if frame has specified a specific blink off cursor type. */
23632 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23634 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23635 return FRAME_BLINK_OFF_CURSOR (f
);
23639 /* Some people liked having a permanently visible blinking cursor,
23640 while others had very strong opinions against it. So it was
23641 decided to remove it. KFS 2003-09-03 */
23643 /* Finally perform built-in cursor blinking:
23644 filled box <-> hollow box
23645 wide [h]bar <-> narrow [h]bar
23646 narrow [h]bar <-> no cursor
23647 other type <-> no cursor */
23649 if (cursor_type
== FILLED_BOX_CURSOR
)
23650 return HOLLOW_BOX_CURSOR
;
23652 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23655 return cursor_type
;
23663 /* Notice when the text cursor of window W has been completely
23664 overwritten by a drawing operation that outputs glyphs in AREA
23665 starting at X0 and ending at X1 in the line starting at Y0 and
23666 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23667 the rest of the line after X0 has been written. Y coordinates
23668 are window-relative. */
23671 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23672 int x0
, int x1
, int y0
, int y1
)
23674 int cx0
, cx1
, cy0
, cy1
;
23675 struct glyph_row
*row
;
23677 if (!w
->phys_cursor_on_p
)
23679 if (area
!= TEXT_AREA
)
23682 if (w
->phys_cursor
.vpos
< 0
23683 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23684 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23685 !(row
->enabled_p
&& row
->displays_text_p
)))
23688 if (row
->cursor_in_fringe_p
)
23690 row
->cursor_in_fringe_p
= 0;
23691 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23692 w
->phys_cursor_on_p
= 0;
23696 cx0
= w
->phys_cursor
.x
;
23697 cx1
= cx0
+ w
->phys_cursor_width
;
23698 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23701 /* The cursor image will be completely removed from the
23702 screen if the output area intersects the cursor area in
23703 y-direction. When we draw in [y0 y1[, and some part of
23704 the cursor is at y < y0, that part must have been drawn
23705 before. When scrolling, the cursor is erased before
23706 actually scrolling, so we don't come here. When not
23707 scrolling, the rows above the old cursor row must have
23708 changed, and in this case these rows must have written
23709 over the cursor image.
23711 Likewise if part of the cursor is below y1, with the
23712 exception of the cursor being in the first blank row at
23713 the buffer and window end because update_text_area
23714 doesn't draw that row. (Except when it does, but
23715 that's handled in update_text_area.) */
23717 cy0
= w
->phys_cursor
.y
;
23718 cy1
= cy0
+ w
->phys_cursor_height
;
23719 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23722 w
->phys_cursor_on_p
= 0;
23725 #endif /* HAVE_WINDOW_SYSTEM */
23728 /************************************************************************
23730 ************************************************************************/
23732 #ifdef HAVE_WINDOW_SYSTEM
23735 Fix the display of area AREA of overlapping row ROW in window W
23736 with respect to the overlapping part OVERLAPS. */
23739 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23740 enum glyph_row_area area
, int overlaps
)
23747 for (i
= 0; i
< row
->used
[area
];)
23749 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23751 int start
= i
, start_x
= x
;
23755 x
+= row
->glyphs
[area
][i
].pixel_width
;
23758 while (i
< row
->used
[area
]
23759 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23761 draw_glyphs (w
, start_x
, row
, area
,
23763 DRAW_NORMAL_TEXT
, overlaps
);
23767 x
+= row
->glyphs
[area
][i
].pixel_width
;
23777 Draw the cursor glyph of window W in glyph row ROW. See the
23778 comment of draw_glyphs for the meaning of HL. */
23781 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23782 enum draw_glyphs_face hl
)
23784 /* If cursor hpos is out of bounds, don't draw garbage. This can
23785 happen in mini-buffer windows when switching between echo area
23786 glyphs and mini-buffer. */
23787 if ((row
->reversed_p
23788 ? (w
->phys_cursor
.hpos
>= 0)
23789 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23791 int on_p
= w
->phys_cursor_on_p
;
23793 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23794 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23796 w
->phys_cursor_on_p
= on_p
;
23798 if (hl
== DRAW_CURSOR
)
23799 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23800 /* When we erase the cursor, and ROW is overlapped by other
23801 rows, make sure that these overlapping parts of other rows
23803 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23805 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23807 if (row
> w
->current_matrix
->rows
23808 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23809 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23810 OVERLAPS_ERASED_CURSOR
);
23812 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23813 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23814 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23815 OVERLAPS_ERASED_CURSOR
);
23822 Erase the image of a cursor of window W from the screen. */
23825 erase_phys_cursor (struct window
*w
)
23827 struct frame
*f
= XFRAME (w
->frame
);
23828 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23829 int hpos
= w
->phys_cursor
.hpos
;
23830 int vpos
= w
->phys_cursor
.vpos
;
23831 int mouse_face_here_p
= 0;
23832 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23833 struct glyph_row
*cursor_row
;
23834 struct glyph
*cursor_glyph
;
23835 enum draw_glyphs_face hl
;
23837 /* No cursor displayed or row invalidated => nothing to do on the
23839 if (w
->phys_cursor_type
== NO_CURSOR
)
23840 goto mark_cursor_off
;
23842 /* VPOS >= active_glyphs->nrows means that window has been resized.
23843 Don't bother to erase the cursor. */
23844 if (vpos
>= active_glyphs
->nrows
)
23845 goto mark_cursor_off
;
23847 /* If row containing cursor is marked invalid, there is nothing we
23849 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23850 if (!cursor_row
->enabled_p
)
23851 goto mark_cursor_off
;
23853 /* If line spacing is > 0, old cursor may only be partially visible in
23854 window after split-window. So adjust visible height. */
23855 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23856 window_text_bottom_y (w
) - cursor_row
->y
);
23858 /* If row is completely invisible, don't attempt to delete a cursor which
23859 isn't there. This can happen if cursor is at top of a window, and
23860 we switch to a buffer with a header line in that window. */
23861 if (cursor_row
->visible_height
<= 0)
23862 goto mark_cursor_off
;
23864 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23865 if (cursor_row
->cursor_in_fringe_p
)
23867 cursor_row
->cursor_in_fringe_p
= 0;
23868 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23869 goto mark_cursor_off
;
23872 /* This can happen when the new row is shorter than the old one.
23873 In this case, either draw_glyphs or clear_end_of_line
23874 should have cleared the cursor. Note that we wouldn't be
23875 able to erase the cursor in this case because we don't have a
23876 cursor glyph at hand. */
23877 if ((cursor_row
->reversed_p
23878 ? (w
->phys_cursor
.hpos
< 0)
23879 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23880 goto mark_cursor_off
;
23882 /* If the cursor is in the mouse face area, redisplay that when
23883 we clear the cursor. */
23884 if (! NILP (hlinfo
->mouse_face_window
)
23885 && coords_in_mouse_face_p (w
, hpos
, vpos
)
23886 /* Don't redraw the cursor's spot in mouse face if it is at the
23887 end of a line (on a newline). The cursor appears there, but
23888 mouse highlighting does not. */
23889 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23890 mouse_face_here_p
= 1;
23892 /* Maybe clear the display under the cursor. */
23893 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23896 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23899 cursor_glyph
= get_phys_cursor_glyph (w
);
23900 if (cursor_glyph
== NULL
)
23901 goto mark_cursor_off
;
23903 width
= cursor_glyph
->pixel_width
;
23904 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23905 x
= w
->phys_cursor
.x
;
23907 width
-= left_x
- x
;
23908 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23909 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23910 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23913 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23916 /* Erase the cursor by redrawing the character underneath it. */
23917 if (mouse_face_here_p
)
23918 hl
= DRAW_MOUSE_FACE
;
23920 hl
= DRAW_NORMAL_TEXT
;
23921 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23924 w
->phys_cursor_on_p
= 0;
23925 w
->phys_cursor_type
= NO_CURSOR
;
23930 Display or clear cursor of window W. If ON is zero, clear the
23931 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23932 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23935 display_and_set_cursor (struct window
*w
, int on
,
23936 int hpos
, int vpos
, int x
, int y
)
23938 struct frame
*f
= XFRAME (w
->frame
);
23939 int new_cursor_type
;
23940 int new_cursor_width
;
23942 struct glyph_row
*glyph_row
;
23943 struct glyph
*glyph
;
23945 /* This is pointless on invisible frames, and dangerous on garbaged
23946 windows and frames; in the latter case, the frame or window may
23947 be in the midst of changing its size, and x and y may be off the
23949 if (! FRAME_VISIBLE_P (f
)
23950 || FRAME_GARBAGED_P (f
)
23951 || vpos
>= w
->current_matrix
->nrows
23952 || hpos
>= w
->current_matrix
->matrix_w
)
23955 /* If cursor is off and we want it off, return quickly. */
23956 if (!on
&& !w
->phys_cursor_on_p
)
23959 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23960 /* If cursor row is not enabled, we don't really know where to
23961 display the cursor. */
23962 if (!glyph_row
->enabled_p
)
23964 w
->phys_cursor_on_p
= 0;
23969 if (!glyph_row
->exact_window_width_line_p
23970 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23971 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23973 xassert (interrupt_input_blocked
);
23975 /* Set new_cursor_type to the cursor we want to be displayed. */
23976 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23977 &new_cursor_width
, &active_cursor
);
23979 /* If cursor is currently being shown and we don't want it to be or
23980 it is in the wrong place, or the cursor type is not what we want,
23982 if (w
->phys_cursor_on_p
23984 || w
->phys_cursor
.x
!= x
23985 || w
->phys_cursor
.y
!= y
23986 || new_cursor_type
!= w
->phys_cursor_type
23987 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23988 && new_cursor_width
!= w
->phys_cursor_width
)))
23989 erase_phys_cursor (w
);
23991 /* Don't check phys_cursor_on_p here because that flag is only set
23992 to zero in some cases where we know that the cursor has been
23993 completely erased, to avoid the extra work of erasing the cursor
23994 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23995 still not be visible, or it has only been partly erased. */
23998 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23999 w
->phys_cursor_height
= glyph_row
->height
;
24001 /* Set phys_cursor_.* before x_draw_.* is called because some
24002 of them may need the information. */
24003 w
->phys_cursor
.x
= x
;
24004 w
->phys_cursor
.y
= glyph_row
->y
;
24005 w
->phys_cursor
.hpos
= hpos
;
24006 w
->phys_cursor
.vpos
= vpos
;
24009 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24010 new_cursor_type
, new_cursor_width
,
24011 on
, active_cursor
);
24015 /* Switch the display of W's cursor on or off, according to the value
24019 update_window_cursor (struct window
*w
, int on
)
24021 /* Don't update cursor in windows whose frame is in the process
24022 of being deleted. */
24023 if (w
->current_matrix
)
24026 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24027 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24033 /* Call update_window_cursor with parameter ON_P on all leaf windows
24034 in the window tree rooted at W. */
24037 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24041 if (!NILP (w
->hchild
))
24042 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24043 else if (!NILP (w
->vchild
))
24044 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24046 update_window_cursor (w
, on_p
);
24048 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24054 Display the cursor on window W, or clear it, according to ON_P.
24055 Don't change the cursor's position. */
24058 x_update_cursor (struct frame
*f
, int on_p
)
24060 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24065 Clear the cursor of window W to background color, and mark the
24066 cursor as not shown. This is used when the text where the cursor
24067 is about to be rewritten. */
24070 x_clear_cursor (struct window
*w
)
24072 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24073 update_window_cursor (w
, 0);
24076 #endif /* HAVE_WINDOW_SYSTEM */
24078 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24081 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24082 int start_hpos
, int end_hpos
,
24083 enum draw_glyphs_face draw
)
24085 #ifdef HAVE_WINDOW_SYSTEM
24086 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24088 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24092 #if defined (HAVE_GPM) || defined (MSDOS)
24093 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24097 /* Display the active region described by mouse_face_* according to DRAW. */
24100 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24102 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24103 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24105 if (/* If window is in the process of being destroyed, don't bother
24107 w
->current_matrix
!= NULL
24108 /* Don't update mouse highlight if hidden */
24109 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24110 /* Recognize when we are called to operate on rows that don't exist
24111 anymore. This can happen when a window is split. */
24112 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24114 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24115 struct glyph_row
*row
, *first
, *last
;
24117 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24118 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24120 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24122 int start_hpos
, end_hpos
, start_x
;
24124 /* For all but the first row, the highlight starts at column 0. */
24127 /* R2L rows have BEG and END in reversed order, but the
24128 screen drawing geometry is always left to right. So
24129 we need to mirror the beginning and end of the
24130 highlighted area in R2L rows. */
24131 if (!row
->reversed_p
)
24133 start_hpos
= hlinfo
->mouse_face_beg_col
;
24134 start_x
= hlinfo
->mouse_face_beg_x
;
24136 else if (row
== last
)
24138 start_hpos
= hlinfo
->mouse_face_end_col
;
24139 start_x
= hlinfo
->mouse_face_end_x
;
24147 else if (row
->reversed_p
&& row
== last
)
24149 start_hpos
= hlinfo
->mouse_face_end_col
;
24150 start_x
= hlinfo
->mouse_face_end_x
;
24160 if (!row
->reversed_p
)
24161 end_hpos
= hlinfo
->mouse_face_end_col
;
24162 else if (row
== first
)
24163 end_hpos
= hlinfo
->mouse_face_beg_col
;
24166 end_hpos
= row
->used
[TEXT_AREA
];
24167 if (draw
== DRAW_NORMAL_TEXT
)
24168 row
->fill_line_p
= 1; /* Clear to end of line */
24171 else if (row
->reversed_p
&& row
== first
)
24172 end_hpos
= hlinfo
->mouse_face_beg_col
;
24175 end_hpos
= row
->used
[TEXT_AREA
];
24176 if (draw
== DRAW_NORMAL_TEXT
)
24177 row
->fill_line_p
= 1; /* Clear to end of line */
24180 if (end_hpos
> start_hpos
)
24182 draw_row_with_mouse_face (w
, start_x
, row
,
24183 start_hpos
, end_hpos
, draw
);
24186 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24190 #ifdef HAVE_WINDOW_SYSTEM
24191 /* When we've written over the cursor, arrange for it to
24192 be displayed again. */
24193 if (FRAME_WINDOW_P (f
)
24194 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24197 display_and_set_cursor (w
, 1,
24198 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24199 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24202 #endif /* HAVE_WINDOW_SYSTEM */
24205 #ifdef HAVE_WINDOW_SYSTEM
24206 /* Change the mouse cursor. */
24207 if (FRAME_WINDOW_P (f
))
24209 if (draw
== DRAW_NORMAL_TEXT
24210 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
24211 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24212 else if (draw
== DRAW_MOUSE_FACE
)
24213 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24215 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24217 #endif /* HAVE_WINDOW_SYSTEM */
24221 Clear out the mouse-highlighted active region.
24222 Redraw it un-highlighted first. Value is non-zero if mouse
24223 face was actually drawn unhighlighted. */
24226 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
24230 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
24232 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
24236 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
24237 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
24238 hlinfo
->mouse_face_window
= Qnil
;
24239 hlinfo
->mouse_face_overlay
= Qnil
;
24243 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
24244 within the mouse face on that window. */
24246 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
24248 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
24250 /* Quickly resolve the easy cases. */
24251 if (!(WINDOWP (hlinfo
->mouse_face_window
)
24252 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
24254 if (vpos
< hlinfo
->mouse_face_beg_row
24255 || vpos
> hlinfo
->mouse_face_end_row
)
24257 if (vpos
> hlinfo
->mouse_face_beg_row
24258 && vpos
< hlinfo
->mouse_face_end_row
)
24261 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
24263 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24265 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
24268 else if ((vpos
== hlinfo
->mouse_face_beg_row
24269 && hpos
>= hlinfo
->mouse_face_beg_col
)
24270 || (vpos
== hlinfo
->mouse_face_end_row
24271 && hpos
< hlinfo
->mouse_face_end_col
))
24276 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
24278 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
24281 else if ((vpos
== hlinfo
->mouse_face_beg_row
24282 && hpos
<= hlinfo
->mouse_face_beg_col
)
24283 || (vpos
== hlinfo
->mouse_face_end_row
24284 && hpos
> hlinfo
->mouse_face_end_col
))
24292 Non-zero if physical cursor of window W is within mouse face. */
24295 cursor_in_mouse_face_p (struct window
*w
)
24297 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
24302 /* Find the glyph rows START_ROW and END_ROW of window W that display
24303 characters between buffer positions START_CHARPOS and END_CHARPOS
24304 (excluding END_CHARPOS). This is similar to row_containing_pos,
24305 but is more accurate when bidi reordering makes buffer positions
24306 change non-linearly with glyph rows. */
24308 rows_from_pos_range (struct window
*w
,
24309 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
24310 struct glyph_row
**start
, struct glyph_row
**end
)
24312 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24313 int last_y
= window_text_bottom_y (w
);
24314 struct glyph_row
*row
;
24319 while (!first
->enabled_p
24320 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
24323 /* Find the START row. */
24325 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
24328 /* A row can potentially be the START row if the range of the
24329 characters it displays intersects the range
24330 [START_CHARPOS..END_CHARPOS). */
24331 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
24332 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
24333 /* See the commentary in row_containing_pos, for the
24334 explanation of the complicated way to check whether
24335 some position is beyond the end of the characters
24336 displayed by a row. */
24337 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24338 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24339 && !row
->ends_at_zv_p
24340 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
24341 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
24342 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
24343 && !row
->ends_at_zv_p
24344 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
24346 /* Found a candidate row. Now make sure at least one of the
24347 glyphs it displays has a charpos from the range
24348 [START_CHARPOS..END_CHARPOS).
24350 This is not obvious because bidi reordering could make
24351 buffer positions of a row be 1,2,3,102,101,100, and if we
24352 want to highlight characters in [50..60), we don't want
24353 this row, even though [50..60) does intersect [1..103),
24354 the range of character positions given by the row's start
24355 and end positions. */
24356 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
24357 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
24361 if (BUFFERP (g
->object
)
24362 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24371 /* Find the END row. */
24373 /* If the last row is partially visible, start looking for END
24374 from that row, instead of starting from FIRST. */
24375 && !(row
->enabled_p
24376 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
24378 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
24380 struct glyph_row
*next
= row
+ 1;
24382 if (!next
->enabled_p
24383 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
24384 /* The first row >= START whose range of displayed characters
24385 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
24386 is the row END + 1. */
24387 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
24388 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
24389 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24390 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24391 && !next
->ends_at_zv_p
24392 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
24393 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
24394 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
24395 && !next
->ends_at_zv_p
24396 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
24403 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
24404 but none of the characters it displays are in the range, it is
24406 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
24407 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
24411 if (BUFFERP (g
->object
)
24412 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
24425 /* This function sets the mouse_face_* elements of HLINFO, assuming
24426 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24427 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24428 for the overlay or run of text properties specifying the mouse
24429 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24430 before-string and after-string that must also be highlighted.
24431 COVER_STRING, if non-nil, is a display string that may cover some
24432 or all of the highlighted text. */
24435 mouse_face_from_buffer_pos (Lisp_Object window
,
24436 Mouse_HLInfo
*hlinfo
,
24437 EMACS_INT mouse_charpos
,
24438 EMACS_INT start_charpos
,
24439 EMACS_INT end_charpos
,
24440 Lisp_Object before_string
,
24441 Lisp_Object after_string
,
24442 Lisp_Object cover_string
)
24444 struct window
*w
= XWINDOW (window
);
24445 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24446 struct glyph_row
*r1
, *r2
;
24447 struct glyph
*glyph
, *end
;
24448 EMACS_INT ignore
, pos
;
24451 xassert (NILP (cover_string
) || STRINGP (cover_string
));
24452 xassert (NILP (before_string
) || STRINGP (before_string
));
24453 xassert (NILP (after_string
) || STRINGP (after_string
));
24455 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
24456 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
24458 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24459 /* If the before-string or display-string contains newlines,
24460 rows_from_pos_range skips to its last row. Move back. */
24461 if (!NILP (before_string
) || !NILP (cover_string
))
24463 struct glyph_row
*prev
;
24464 while ((prev
= r1
- 1, prev
>= first
)
24465 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24466 && prev
->used
[TEXT_AREA
] > 0)
24468 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24469 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24470 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24472 || !(EQ (glyph
->object
, before_string
)
24473 || EQ (glyph
->object
, cover_string
)))
24480 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24481 hlinfo
->mouse_face_past_end
= 1;
24483 else if (!NILP (after_string
))
24485 /* If the after-string has newlines, advance to its last row. */
24486 struct glyph_row
*next
;
24487 struct glyph_row
*last
24488 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24490 for (next
= r2
+ 1;
24492 && next
->used
[TEXT_AREA
] > 0
24493 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24497 /* The rest of the display engine assumes that mouse_face_beg_row is
24498 either above below mouse_face_end_row or identical to it. But
24499 with bidi-reordered continued lines, the row for START_CHARPOS
24500 could be below the row for END_CHARPOS. If so, swap the rows and
24501 store them in correct order. */
24504 struct glyph_row
*tem
= r2
;
24510 hlinfo
->mouse_face_beg_y
= r1
->y
;
24511 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
24512 hlinfo
->mouse_face_end_y
= r2
->y
;
24513 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
24515 /* For a bidi-reordered row, the positions of BEFORE_STRING,
24516 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
24517 could be anywhere in the row and in any order. The strategy
24518 below is to find the leftmost and the rightmost glyph that
24519 belongs to either of these 3 strings, or whose position is
24520 between START_CHARPOS and END_CHARPOS, and highlight all the
24521 glyphs between those two. This may cover more than just the text
24522 between START_CHARPOS and END_CHARPOS if the range of characters
24523 strides the bidi level boundary, e.g. if the beginning is in R2L
24524 text while the end is in L2R text or vice versa. */
24525 if (!r1
->reversed_p
)
24527 /* This row is in a left to right paragraph. Scan it left to
24529 glyph
= r1
->glyphs
[TEXT_AREA
];
24530 end
= glyph
+ r1
->used
[TEXT_AREA
];
24533 /* Skip truncation glyphs at the start of the glyph row. */
24534 if (r1
->displays_text_p
)
24536 && INTEGERP (glyph
->object
)
24537 && glyph
->charpos
< 0;
24539 x
+= glyph
->pixel_width
;
24541 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24542 or COVER_STRING, and the first glyph from buffer whose
24543 position is between START_CHARPOS and END_CHARPOS. */
24545 && !INTEGERP (glyph
->object
)
24546 && !EQ (glyph
->object
, cover_string
)
24547 && !(BUFFERP (glyph
->object
)
24548 && (glyph
->charpos
>= start_charpos
24549 && glyph
->charpos
< end_charpos
));
24552 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24553 are present at buffer positions between START_CHARPOS and
24554 END_CHARPOS, or if they come from an overlay. */
24555 if (EQ (glyph
->object
, before_string
))
24557 pos
= string_buffer_position (before_string
,
24559 /* If pos == 0, it means before_string came from an
24560 overlay, not from a buffer position. */
24561 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24564 else if (EQ (glyph
->object
, after_string
))
24566 pos
= string_buffer_position (after_string
, end_charpos
);
24567 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24570 x
+= glyph
->pixel_width
;
24572 hlinfo
->mouse_face_beg_x
= x
;
24573 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24577 /* This row is in a right to left paragraph. Scan it right to
24581 end
= r1
->glyphs
[TEXT_AREA
] - 1;
24582 glyph
= end
+ r1
->used
[TEXT_AREA
];
24584 /* Skip truncation glyphs at the start of the glyph row. */
24585 if (r1
->displays_text_p
)
24587 && INTEGERP (glyph
->object
)
24588 && glyph
->charpos
< 0;
24592 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
24593 or COVER_STRING, and the first glyph from buffer whose
24594 position is between START_CHARPOS and END_CHARPOS. */
24596 && !INTEGERP (glyph
->object
)
24597 && !EQ (glyph
->object
, cover_string
)
24598 && !(BUFFERP (glyph
->object
)
24599 && (glyph
->charpos
>= start_charpos
24600 && glyph
->charpos
< end_charpos
));
24603 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24604 are present at buffer positions between START_CHARPOS and
24605 END_CHARPOS, or if they come from an overlay. */
24606 if (EQ (glyph
->object
, before_string
))
24608 pos
= string_buffer_position (before_string
, start_charpos
);
24609 /* If pos == 0, it means before_string came from an
24610 overlay, not from a buffer position. */
24611 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24614 else if (EQ (glyph
->object
, after_string
))
24616 pos
= string_buffer_position (after_string
, end_charpos
);
24617 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24622 glyph
++; /* first glyph to the right of the highlighted area */
24623 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
24624 x
+= g
->pixel_width
;
24625 hlinfo
->mouse_face_beg_x
= x
;
24626 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
24629 /* If the highlight ends in a different row, compute GLYPH and END
24630 for the end row. Otherwise, reuse the values computed above for
24631 the row where the highlight begins. */
24634 if (!r2
->reversed_p
)
24636 glyph
= r2
->glyphs
[TEXT_AREA
];
24637 end
= glyph
+ r2
->used
[TEXT_AREA
];
24642 end
= r2
->glyphs
[TEXT_AREA
] - 1;
24643 glyph
= end
+ r2
->used
[TEXT_AREA
];
24647 if (!r2
->reversed_p
)
24649 /* Skip truncation and continuation glyphs near the end of the
24650 row, and also blanks and stretch glyphs inserted by
24651 extend_face_to_end_of_line. */
24653 && INTEGERP ((end
- 1)->object
)
24654 && (end
- 1)->charpos
<= 0)
24656 /* Scan the rest of the glyph row from the end, looking for the
24657 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24658 COVER_STRING, or whose position is between START_CHARPOS
24662 && !INTEGERP (end
->object
)
24663 && !EQ (end
->object
, cover_string
)
24664 && !(BUFFERP (end
->object
)
24665 && (end
->charpos
>= start_charpos
24666 && end
->charpos
< end_charpos
));
24669 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24670 are present at buffer positions between START_CHARPOS and
24671 END_CHARPOS, or if they come from an overlay. */
24672 if (EQ (end
->object
, before_string
))
24674 pos
= string_buffer_position (before_string
, start_charpos
);
24675 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24678 else if (EQ (end
->object
, after_string
))
24680 pos
= string_buffer_position (after_string
, end_charpos
);
24681 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24685 /* Find the X coordinate of the last glyph to be highlighted. */
24686 for (; glyph
<= end
; ++glyph
)
24687 x
+= glyph
->pixel_width
;
24689 hlinfo
->mouse_face_end_x
= x
;
24690 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
24694 /* Skip truncation and continuation glyphs near the end of the
24695 row, and also blanks and stretch glyphs inserted by
24696 extend_face_to_end_of_line. */
24700 && INTEGERP (end
->object
)
24701 && end
->charpos
<= 0)
24703 x
+= end
->pixel_width
;
24706 /* Scan the rest of the glyph row from the end, looking for the
24707 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
24708 COVER_STRING, or whose position is between START_CHARPOS
24712 && !INTEGERP (end
->object
)
24713 && !EQ (end
->object
, cover_string
)
24714 && !(BUFFERP (end
->object
)
24715 && (end
->charpos
>= start_charpos
24716 && end
->charpos
< end_charpos
));
24719 /* BEFORE_STRING or AFTER_STRING are only relevant if they
24720 are present at buffer positions between START_CHARPOS and
24721 END_CHARPOS, or if they come from an overlay. */
24722 if (EQ (end
->object
, before_string
))
24724 pos
= string_buffer_position (before_string
, start_charpos
);
24725 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24728 else if (EQ (end
->object
, after_string
))
24730 pos
= string_buffer_position (after_string
, end_charpos
);
24731 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
24734 x
+= end
->pixel_width
;
24736 hlinfo
->mouse_face_end_x
= x
;
24737 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
24740 hlinfo
->mouse_face_window
= window
;
24741 hlinfo
->mouse_face_face_id
24742 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24744 !hlinfo
->mouse_face_hidden
, -1);
24745 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
24748 /* The following function is not used anymore (replaced with
24749 mouse_face_from_string_pos), but I leave it here for the time
24750 being, in case someone would. */
24752 #if 0 /* not used */
24754 /* Find the position of the glyph for position POS in OBJECT in
24755 window W's current matrix, and return in *X, *Y the pixel
24756 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24758 RIGHT_P non-zero means return the position of the right edge of the
24759 glyph, RIGHT_P zero means return the left edge position.
24761 If no glyph for POS exists in the matrix, return the position of
24762 the glyph with the next smaller position that is in the matrix, if
24763 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24764 exists in the matrix, return the position of the glyph with the
24765 next larger position in OBJECT.
24767 Value is non-zero if a glyph was found. */
24770 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24771 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24773 int yb
= window_text_bottom_y (w
);
24774 struct glyph_row
*r
;
24775 struct glyph
*best_glyph
= NULL
;
24776 struct glyph_row
*best_row
= NULL
;
24779 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24780 r
->enabled_p
&& r
->y
< yb
;
24783 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24784 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24787 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24788 if (EQ (g
->object
, object
))
24790 if (g
->charpos
== pos
)
24797 else if (best_glyph
== NULL
24798 || ((eabs (g
->charpos
- pos
)
24799 < eabs (best_glyph
->charpos
- pos
))
24802 : g
->charpos
> pos
)))
24816 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24820 *x
+= best_glyph
->pixel_width
;
24825 *vpos
= best_row
- w
->current_matrix
->rows
;
24828 return best_glyph
!= NULL
;
24830 #endif /* not used */
24832 /* Find the positions of the first and the last glyphs in window W's
24833 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
24834 (assumed to be a string), and return in HLINFO's mouse_face_*
24835 members the pixel and column/row coordinates of those glyphs. */
24838 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
24839 Lisp_Object object
,
24840 EMACS_INT startpos
, EMACS_INT endpos
)
24842 int yb
= window_text_bottom_y (w
);
24843 struct glyph_row
*r
;
24844 struct glyph
*g
, *e
;
24848 /* Find the glyph row with at least one position in the range
24849 [STARTPOS..ENDPOS], and the first glyph in that row whose
24850 position belongs to that range. */
24851 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24852 r
->enabled_p
&& r
->y
< yb
;
24855 if (!r
->reversed_p
)
24857 g
= r
->glyphs
[TEXT_AREA
];
24858 e
= g
+ r
->used
[TEXT_AREA
];
24859 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24860 if (EQ (g
->object
, object
)
24861 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24863 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24864 hlinfo
->mouse_face_beg_y
= r
->y
;
24865 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24866 hlinfo
->mouse_face_beg_x
= gx
;
24875 e
= r
->glyphs
[TEXT_AREA
];
24876 g
= e
+ r
->used
[TEXT_AREA
];
24877 for ( ; g
> e
; --g
)
24878 if (EQ ((g
-1)->object
, object
)
24879 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
24881 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
24882 hlinfo
->mouse_face_beg_y
= r
->y
;
24883 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
24884 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
24885 gx
+= g1
->pixel_width
;
24886 hlinfo
->mouse_face_beg_x
= gx
;
24898 /* Starting with the next row, look for the first row which does NOT
24899 include any glyphs whose positions are in the range. */
24900 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
24902 g
= r
->glyphs
[TEXT_AREA
];
24903 e
= g
+ r
->used
[TEXT_AREA
];
24905 for ( ; g
< e
; ++g
)
24906 if (EQ (g
->object
, object
)
24907 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
24916 /* The highlighted region ends on the previous row. */
24919 /* Set the end row and its vertical pixel coordinate. */
24920 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
24921 hlinfo
->mouse_face_end_y
= r
->y
;
24923 /* Compute and set the end column and the end column's horizontal
24924 pixel coordinate. */
24925 if (!r
->reversed_p
)
24927 g
= r
->glyphs
[TEXT_AREA
];
24928 e
= g
+ r
->used
[TEXT_AREA
];
24929 for ( ; e
> g
; --e
)
24930 if (EQ ((e
-1)->object
, object
)
24931 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
24933 hlinfo
->mouse_face_end_col
= e
- g
;
24935 for (gx
= r
->x
; g
< e
; ++g
)
24936 gx
+= g
->pixel_width
;
24937 hlinfo
->mouse_face_end_x
= gx
;
24941 e
= r
->glyphs
[TEXT_AREA
];
24942 g
= e
+ r
->used
[TEXT_AREA
];
24943 for (gx
= r
->x
; e
< g
; ++e
)
24945 if (EQ (e
->object
, object
)
24946 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
24948 gx
+= e
->pixel_width
;
24950 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
24951 hlinfo
->mouse_face_end_x
= gx
;
24955 #ifdef HAVE_WINDOW_SYSTEM
24957 /* See if position X, Y is within a hot-spot of an image. */
24960 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24962 if (!CONSP (hot_spot
))
24965 if (EQ (XCAR (hot_spot
), Qrect
))
24967 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24968 Lisp_Object rect
= XCDR (hot_spot
);
24972 if (!CONSP (XCAR (rect
)))
24974 if (!CONSP (XCDR (rect
)))
24976 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24978 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24980 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24982 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24986 else if (EQ (XCAR (hot_spot
), Qcircle
))
24988 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24989 Lisp_Object circ
= XCDR (hot_spot
);
24990 Lisp_Object lr
, lx0
, ly0
;
24992 && CONSP (XCAR (circ
))
24993 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24994 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24995 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24997 double r
= XFLOATINT (lr
);
24998 double dx
= XINT (lx0
) - x
;
24999 double dy
= XINT (ly0
) - y
;
25000 return (dx
* dx
+ dy
* dy
<= r
* r
);
25003 else if (EQ (XCAR (hot_spot
), Qpoly
))
25005 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25006 if (VECTORP (XCDR (hot_spot
)))
25008 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25009 Lisp_Object
*poly
= v
->contents
;
25010 int n
= v
->header
.size
;
25013 Lisp_Object lx
, ly
;
25016 /* Need an even number of coordinates, and at least 3 edges. */
25017 if (n
< 6 || n
& 1)
25020 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25021 If count is odd, we are inside polygon. Pixels on edges
25022 may or may not be included depending on actual geometry of the
25024 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25025 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25027 x0
= XINT (lx
), y0
= XINT (ly
);
25028 for (i
= 0; i
< n
; i
+= 2)
25030 int x1
= x0
, y1
= y0
;
25031 if ((lx
= poly
[i
], !INTEGERP (lx
))
25032 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25034 x0
= XINT (lx
), y0
= XINT (ly
);
25036 /* Does this segment cross the X line? */
25044 if (y
> y0
&& y
> y1
)
25046 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25056 find_hot_spot (Lisp_Object map
, int x
, int y
)
25058 while (CONSP (map
))
25060 if (CONSP (XCAR (map
))
25061 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25069 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25071 doc
: /* Lookup in image map MAP coordinates X and Y.
25072 An image map is an alist where each element has the format (AREA ID PLIST).
25073 An AREA is specified as either a rectangle, a circle, or a polygon:
25074 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25075 pixel coordinates of the upper left and bottom right corners.
25076 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25077 and the radius of the circle; r may be a float or integer.
25078 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25079 vector describes one corner in the polygon.
25080 Returns the alist element for the first matching AREA in MAP. */)
25081 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25089 return find_hot_spot (map
, XINT (x
), XINT (y
));
25093 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25095 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25097 /* Do not change cursor shape while dragging mouse. */
25098 if (!NILP (do_mouse_tracking
))
25101 if (!NILP (pointer
))
25103 if (EQ (pointer
, Qarrow
))
25104 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25105 else if (EQ (pointer
, Qhand
))
25106 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25107 else if (EQ (pointer
, Qtext
))
25108 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25109 else if (EQ (pointer
, intern ("hdrag")))
25110 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25111 #ifdef HAVE_X_WINDOWS
25112 else if (EQ (pointer
, intern ("vdrag")))
25113 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25115 else if (EQ (pointer
, intern ("hourglass")))
25116 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25117 else if (EQ (pointer
, Qmodeline
))
25118 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25120 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25123 if (cursor
!= No_Cursor
)
25124 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25127 #endif /* HAVE_WINDOW_SYSTEM */
25129 /* Take proper action when mouse has moved to the mode or header line
25130 or marginal area AREA of window W, x-position X and y-position Y.
25131 X is relative to the start of the text display area of W, so the
25132 width of bitmap areas and scroll bars must be subtracted to get a
25133 position relative to the start of the mode line. */
25136 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25137 enum window_part area
)
25139 struct window
*w
= XWINDOW (window
);
25140 struct frame
*f
= XFRAME (w
->frame
);
25141 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25142 #ifdef HAVE_WINDOW_SYSTEM
25143 Display_Info
*dpyinfo
;
25145 Cursor cursor
= No_Cursor
;
25146 Lisp_Object pointer
= Qnil
;
25147 int dx
, dy
, width
, height
;
25149 Lisp_Object string
, object
= Qnil
;
25150 Lisp_Object pos
, help
;
25152 Lisp_Object mouse_face
;
25153 int original_x_pixel
= x
;
25154 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25155 struct glyph_row
*row
;
25157 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25162 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25163 returns them in row/column units! */
25164 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25165 &object
, &dx
, &dy
, &width
, &height
);
25167 row
= (area
== ON_MODE_LINE
25168 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25169 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25171 /* Find the glyph under the mouse pointer. */
25172 if (row
->mode_line_p
&& row
->enabled_p
)
25174 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25175 end
= glyph
+ row
->used
[TEXT_AREA
];
25177 for (x0
= original_x_pixel
;
25178 glyph
< end
&& x0
>= glyph
->pixel_width
;
25180 x0
-= glyph
->pixel_width
;
25188 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25189 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25190 returns them in row/column units! */
25191 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25192 &object
, &dx
, &dy
, &width
, &height
);
25197 #ifdef HAVE_WINDOW_SYSTEM
25198 if (IMAGEP (object
))
25200 Lisp_Object image_map
, hotspot
;
25201 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
25203 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
25205 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25209 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
25210 If so, we could look for mouse-enter, mouse-leave
25211 properties in PLIST (and do something...). */
25212 hotspot
= XCDR (hotspot
);
25213 if (CONSP (hotspot
)
25214 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25216 pointer
= Fplist_get (plist
, Qpointer
);
25217 if (NILP (pointer
))
25219 help
= Fplist_get (plist
, Qhelp_echo
);
25222 help_echo_string
= help
;
25223 /* Is this correct? ++kfs */
25224 XSETWINDOW (help_echo_window
, w
);
25225 help_echo_object
= w
->buffer
;
25226 help_echo_pos
= charpos
;
25230 if (NILP (pointer
))
25231 pointer
= Fplist_get (XCDR (object
), QCpointer
);
25233 #endif /* HAVE_WINDOW_SYSTEM */
25235 if (STRINGP (string
))
25237 pos
= make_number (charpos
);
25238 /* If we're on a string with `help-echo' text property, arrange
25239 for the help to be displayed. This is done by setting the
25240 global variable help_echo_string to the help string. */
25243 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
25246 help_echo_string
= help
;
25247 XSETWINDOW (help_echo_window
, w
);
25248 help_echo_object
= string
;
25249 help_echo_pos
= charpos
;
25253 #ifdef HAVE_WINDOW_SYSTEM
25254 if (FRAME_WINDOW_P (f
))
25256 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25257 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25258 if (NILP (pointer
))
25259 pointer
= Fget_text_property (pos
, Qpointer
, string
);
25261 /* Change the mouse pointer according to what is under X/Y. */
25263 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
25266 map
= Fget_text_property (pos
, Qlocal_map
, string
);
25267 if (!KEYMAPP (map
))
25268 map
= Fget_text_property (pos
, Qkeymap
, string
);
25269 if (!KEYMAPP (map
))
25270 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
25275 /* Change the mouse face according to what is under X/Y. */
25276 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
25277 if (!NILP (mouse_face
)
25278 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25283 struct glyph
* tmp_glyph
;
25287 int total_pixel_width
;
25288 EMACS_INT begpos
, endpos
, ignore
;
25292 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
25293 Qmouse_face
, string
, Qnil
);
25299 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
25301 endpos
= SCHARS (string
);
25305 /* Calculate the glyph position GPOS of GLYPH in the
25306 displayed string, relative to the beginning of the
25307 highlighted part of the string.
25309 Note: GPOS is different from CHARPOS. CHARPOS is the
25310 position of GLYPH in the internal string object. A mode
25311 line string format has structures which are converted to
25312 a flattened string by the Emacs Lisp interpreter. The
25313 internal string is an element of those structures. The
25314 displayed string is the flattened string. */
25315 tmp_glyph
= row_start_glyph
;
25316 while (tmp_glyph
< glyph
25317 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25318 && begpos
<= tmp_glyph
->charpos
25319 && tmp_glyph
->charpos
< endpos
)))
25321 gpos
= glyph
- tmp_glyph
;
25323 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
25324 the highlighted part of the displayed string to which
25325 GLYPH belongs. Note: GSEQ_LENGTH is different from
25326 SCHARS (STRING), because the latter returns the length of
25327 the internal string. */
25328 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
25330 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
25331 && begpos
<= tmp_glyph
->charpos
25332 && tmp_glyph
->charpos
< endpos
));
25335 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
25337 /* Calculate the total pixel width of all the glyphs between
25338 the beginning of the highlighted area and GLYPH. */
25339 total_pixel_width
= 0;
25340 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
25341 total_pixel_width
+= tmp_glyph
->pixel_width
;
25343 /* Pre calculation of re-rendering position. Note: X is in
25344 column units here, after the call to mode_line_string or
25345 marginal_area_string. */
25347 vpos
= (area
== ON_MODE_LINE
25348 ? (w
->current_matrix
)->nrows
- 1
25351 /* If GLYPH's position is included in the region that is
25352 already drawn in mouse face, we have nothing to do. */
25353 if ( EQ (window
, hlinfo
->mouse_face_window
)
25354 && (!row
->reversed_p
25355 ? (hlinfo
->mouse_face_beg_col
<= hpos
25356 && hpos
< hlinfo
->mouse_face_end_col
)
25357 /* In R2L rows we swap BEG and END, see below. */
25358 : (hlinfo
->mouse_face_end_col
<= hpos
25359 && hpos
< hlinfo
->mouse_face_beg_col
))
25360 && hlinfo
->mouse_face_beg_row
== vpos
)
25363 if (clear_mouse_face (hlinfo
))
25364 cursor
= No_Cursor
;
25366 if (!row
->reversed_p
)
25368 hlinfo
->mouse_face_beg_col
= hpos
;
25369 hlinfo
->mouse_face_beg_x
= original_x_pixel
25370 - (total_pixel_width
+ dx
);
25371 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
25372 hlinfo
->mouse_face_end_x
= 0;
25376 /* In R2L rows, show_mouse_face expects BEG and END
25377 coordinates to be swapped. */
25378 hlinfo
->mouse_face_end_col
= hpos
;
25379 hlinfo
->mouse_face_end_x
= original_x_pixel
25380 - (total_pixel_width
+ dx
);
25381 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
25382 hlinfo
->mouse_face_beg_x
= 0;
25385 hlinfo
->mouse_face_beg_row
= vpos
;
25386 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
25387 hlinfo
->mouse_face_beg_y
= 0;
25388 hlinfo
->mouse_face_end_y
= 0;
25389 hlinfo
->mouse_face_past_end
= 0;
25390 hlinfo
->mouse_face_window
= window
;
25392 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
25398 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25400 if (NILP (pointer
))
25403 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
25404 clear_mouse_face (hlinfo
);
25406 #ifdef HAVE_WINDOW_SYSTEM
25407 if (FRAME_WINDOW_P (f
))
25408 define_frame_cursor1 (f
, cursor
, pointer
);
25414 Take proper action when the mouse has moved to position X, Y on
25415 frame F as regards highlighting characters that have mouse-face
25416 properties. Also de-highlighting chars where the mouse was before.
25417 X and Y can be negative or out of range. */
25420 note_mouse_highlight (struct frame
*f
, int x
, int y
)
25422 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25423 enum window_part part
;
25424 Lisp_Object window
;
25426 Cursor cursor
= No_Cursor
;
25427 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
25430 /* When a menu is active, don't highlight because this looks odd. */
25431 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
25432 if (popup_activated ())
25436 if (NILP (Vmouse_highlight
)
25437 || !f
->glyphs_initialized_p
25438 || f
->pointer_invisible
)
25441 hlinfo
->mouse_face_mouse_x
= x
;
25442 hlinfo
->mouse_face_mouse_y
= y
;
25443 hlinfo
->mouse_face_mouse_frame
= f
;
25445 if (hlinfo
->mouse_face_defer
)
25448 if (gc_in_progress
)
25450 hlinfo
->mouse_face_deferred_gc
= 1;
25454 /* Which window is that in? */
25455 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
25457 /* If we were displaying active text in another window, clear that.
25458 Also clear if we move out of text area in same window. */
25459 if (! EQ (window
, hlinfo
->mouse_face_window
)
25460 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
25461 && !NILP (hlinfo
->mouse_face_window
)))
25462 clear_mouse_face (hlinfo
);
25464 /* Not on a window -> return. */
25465 if (!WINDOWP (window
))
25468 /* Reset help_echo_string. It will get recomputed below. */
25469 help_echo_string
= Qnil
;
25471 /* Convert to window-relative pixel coordinates. */
25472 w
= XWINDOW (window
);
25473 frame_to_window_pixel_xy (w
, &x
, &y
);
25475 #ifdef HAVE_WINDOW_SYSTEM
25476 /* Handle tool-bar window differently since it doesn't display a
25478 if (EQ (window
, f
->tool_bar_window
))
25480 note_tool_bar_highlight (f
, x
, y
);
25485 /* Mouse is on the mode, header line or margin? */
25486 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
25487 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
25489 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
25493 #ifdef HAVE_WINDOW_SYSTEM
25494 if (part
== ON_VERTICAL_BORDER
)
25496 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25497 help_echo_string
= build_string ("drag-mouse-1: resize");
25499 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
25500 || part
== ON_SCROLL_BAR
)
25501 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25503 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25506 /* Are we in a window whose display is up to date?
25507 And verify the buffer's text has not changed. */
25508 b
= XBUFFER (w
->buffer
);
25509 if (part
== ON_TEXT
25510 && EQ (w
->window_end_valid
, w
->buffer
)
25511 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
25512 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
25514 int hpos
, vpos
, i
, dx
, dy
, area
;
25516 struct glyph
*glyph
;
25517 Lisp_Object object
;
25518 Lisp_Object mouse_face
= Qnil
, position
;
25519 Lisp_Object
*overlay_vec
= NULL
;
25521 struct buffer
*obuf
;
25522 EMACS_INT obegv
, ozv
;
25525 /* Find the glyph under X/Y. */
25526 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
25528 #ifdef HAVE_WINDOW_SYSTEM
25529 /* Look for :pointer property on image. */
25530 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25532 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25533 if (img
!= NULL
&& IMAGEP (img
->spec
))
25535 Lisp_Object image_map
, hotspot
;
25536 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
25538 && (hotspot
= find_hot_spot (image_map
,
25539 glyph
->slice
.img
.x
+ dx
,
25540 glyph
->slice
.img
.y
+ dy
),
25542 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
25546 /* Could check XCAR (hotspot) to see if we enter/leave
25548 If so, we could look for mouse-enter, mouse-leave
25549 properties in PLIST (and do something...). */
25550 hotspot
= XCDR (hotspot
);
25551 if (CONSP (hotspot
)
25552 && (plist
= XCAR (hotspot
), CONSP (plist
)))
25554 pointer
= Fplist_get (plist
, Qpointer
);
25555 if (NILP (pointer
))
25557 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
25558 if (!NILP (help_echo_string
))
25560 help_echo_window
= window
;
25561 help_echo_object
= glyph
->object
;
25562 help_echo_pos
= glyph
->charpos
;
25566 if (NILP (pointer
))
25567 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
25570 #endif /* HAVE_WINDOW_SYSTEM */
25572 /* Clear mouse face if X/Y not over text. */
25574 || area
!= TEXT_AREA
25575 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
25576 /* Glyph's OBJECT is an integer for glyphs inserted by the
25577 display engine for its internal purposes, like truncation
25578 and continuation glyphs and blanks beyond the end of
25579 line's text on text terminals. If we are over such a
25580 glyph, we are not over any text. */
25581 || INTEGERP (glyph
->object
)
25582 /* R2L rows have a stretch glyph at their front, which
25583 stands for no text, whereas L2R rows have no glyphs at
25584 all beyond the end of text. Treat such stretch glyphs
25585 like we do with NULL glyphs in L2R rows. */
25586 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
25587 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
25588 && glyph
->type
== STRETCH_GLYPH
25589 && glyph
->avoid_cursor_p
))
25591 if (clear_mouse_face (hlinfo
))
25592 cursor
= No_Cursor
;
25593 #ifdef HAVE_WINDOW_SYSTEM
25594 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25596 if (area
!= TEXT_AREA
)
25597 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25599 pointer
= Vvoid_text_area_pointer
;
25605 pos
= glyph
->charpos
;
25606 object
= glyph
->object
;
25607 if (!STRINGP (object
) && !BUFFERP (object
))
25610 /* If we get an out-of-range value, return now; avoid an error. */
25611 if (BUFFERP (object
) && pos
> BUF_Z (b
))
25614 /* Make the window's buffer temporarily current for
25615 overlays_at and compute_char_face. */
25616 obuf
= current_buffer
;
25617 current_buffer
= b
;
25623 /* Is this char mouse-active or does it have help-echo? */
25624 position
= make_number (pos
);
25626 if (BUFFERP (object
))
25628 /* Put all the overlays we want in a vector in overlay_vec. */
25629 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
25630 /* Sort overlays into increasing priority order. */
25631 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
25636 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
25639 cursor
= No_Cursor
;
25641 /* Check mouse-face highlighting. */
25643 /* If there exists an overlay with mouse-face overlapping
25644 the one we are currently highlighting, we have to
25645 check if we enter the overlapping overlay, and then
25646 highlight only that. */
25647 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
25648 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
25650 /* Find the highest priority overlay with a mouse-face. */
25651 Lisp_Object overlay
= Qnil
;
25652 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
25654 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
25655 if (!NILP (mouse_face
))
25656 overlay
= overlay_vec
[i
];
25659 /* If we're highlighting the same overlay as before, there's
25660 no need to do that again. */
25661 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
25662 goto check_help_echo
;
25663 hlinfo
->mouse_face_overlay
= overlay
;
25665 /* Clear the display of the old active region, if any. */
25666 if (clear_mouse_face (hlinfo
))
25667 cursor
= No_Cursor
;
25669 /* If no overlay applies, get a text property. */
25670 if (NILP (overlay
))
25671 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25673 /* Next, compute the bounds of the mouse highlighting and
25675 if (!NILP (mouse_face
) && STRINGP (object
))
25677 /* The mouse-highlighting comes from a display string
25678 with a mouse-face. */
25682 s
= Fprevious_single_property_change
25683 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25684 e
= Fnext_single_property_change
25685 (position
, Qmouse_face
, object
, Qnil
);
25687 s
= make_number (0);
25689 e
= make_number (SCHARS (object
) - 1);
25690 mouse_face_from_string_pos (w
, hlinfo
, object
,
25691 XINT (s
), XINT (e
));
25692 hlinfo
->mouse_face_past_end
= 0;
25693 hlinfo
->mouse_face_window
= window
;
25694 hlinfo
->mouse_face_face_id
25695 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25696 glyph
->face_id
, 1);
25697 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25698 cursor
= No_Cursor
;
25702 /* The mouse-highlighting, if any, comes from an overlay
25703 or text property in the buffer. */
25704 Lisp_Object buffer
IF_LINT (= Qnil
);
25705 Lisp_Object cover_string
IF_LINT (= Qnil
);
25707 if (STRINGP (object
))
25709 /* If we are on a display string with no mouse-face,
25710 check if the text under it has one. */
25711 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25712 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25713 pos
= string_buffer_position (object
, start
);
25716 mouse_face
= get_char_property_and_overlay
25717 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25718 buffer
= w
->buffer
;
25719 cover_string
= object
;
25725 cover_string
= Qnil
;
25728 if (!NILP (mouse_face
))
25730 Lisp_Object before
, after
;
25731 Lisp_Object before_string
, after_string
;
25732 /* To correctly find the limits of mouse highlight
25733 in a bidi-reordered buffer, we must not use the
25734 optimization of limiting the search in
25735 previous-single-property-change and
25736 next-single-property-change, because
25737 rows_from_pos_range needs the real start and end
25738 positions to DTRT in this case. That's because
25739 the first row visible in a window does not
25740 necessarily display the character whose position
25741 is the smallest. */
25743 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25744 ? Fmarker_position (w
->start
)
25747 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
25748 ? make_number (BUF_Z (XBUFFER (buffer
))
25749 - XFASTINT (w
->window_end_pos
))
25752 if (NILP (overlay
))
25754 /* Handle the text property case. */
25755 before
= Fprevious_single_property_change
25756 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
25757 after
= Fnext_single_property_change
25758 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
25759 before_string
= after_string
= Qnil
;
25763 /* Handle the overlay case. */
25764 before
= Foverlay_start (overlay
);
25765 after
= Foverlay_end (overlay
);
25766 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25767 after_string
= Foverlay_get (overlay
, Qafter_string
);
25769 if (!STRINGP (before_string
)) before_string
= Qnil
;
25770 if (!STRINGP (after_string
)) after_string
= Qnil
;
25773 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
25776 before_string
, after_string
,
25778 cursor
= No_Cursor
;
25785 /* Look for a `help-echo' property. */
25786 if (NILP (help_echo_string
)) {
25787 Lisp_Object help
, overlay
;
25789 /* Check overlays first. */
25790 help
= overlay
= Qnil
;
25791 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25793 overlay
= overlay_vec
[i
];
25794 help
= Foverlay_get (overlay
, Qhelp_echo
);
25799 help_echo_string
= help
;
25800 help_echo_window
= window
;
25801 help_echo_object
= overlay
;
25802 help_echo_pos
= pos
;
25806 Lisp_Object obj
= glyph
->object
;
25807 EMACS_INT charpos
= glyph
->charpos
;
25809 /* Try text properties. */
25812 && charpos
< SCHARS (obj
))
25814 help
= Fget_text_property (make_number (charpos
),
25818 /* If the string itself doesn't specify a help-echo,
25819 see if the buffer text ``under'' it does. */
25820 struct glyph_row
*r
25821 = MATRIX_ROW (w
->current_matrix
, vpos
);
25822 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25823 EMACS_INT p
= string_buffer_position (obj
, start
);
25826 help
= Fget_char_property (make_number (p
),
25827 Qhelp_echo
, w
->buffer
);
25836 else if (BUFFERP (obj
)
25839 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25844 help_echo_string
= help
;
25845 help_echo_window
= window
;
25846 help_echo_object
= obj
;
25847 help_echo_pos
= charpos
;
25852 #ifdef HAVE_WINDOW_SYSTEM
25853 /* Look for a `pointer' property. */
25854 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
25856 /* Check overlays first. */
25857 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25858 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25860 if (NILP (pointer
))
25862 Lisp_Object obj
= glyph
->object
;
25863 EMACS_INT charpos
= glyph
->charpos
;
25865 /* Try text properties. */
25868 && charpos
< SCHARS (obj
))
25870 pointer
= Fget_text_property (make_number (charpos
),
25872 if (NILP (pointer
))
25874 /* If the string itself doesn't specify a pointer,
25875 see if the buffer text ``under'' it does. */
25876 struct glyph_row
*r
25877 = MATRIX_ROW (w
->current_matrix
, vpos
);
25878 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
25879 EMACS_INT p
= string_buffer_position (obj
, start
);
25881 pointer
= Fget_char_property (make_number (p
),
25882 Qpointer
, w
->buffer
);
25885 else if (BUFFERP (obj
)
25888 pointer
= Fget_text_property (make_number (charpos
),
25892 #endif /* HAVE_WINDOW_SYSTEM */
25896 current_buffer
= obuf
;
25901 #ifdef HAVE_WINDOW_SYSTEM
25902 if (FRAME_WINDOW_P (f
))
25903 define_frame_cursor1 (f
, cursor
, pointer
);
25905 /* This is here to prevent a compiler error, about "label at end of
25906 compound statement". */
25913 Clear any mouse-face on window W. This function is part of the
25914 redisplay interface, and is called from try_window_id and similar
25915 functions to ensure the mouse-highlight is off. */
25918 x_clear_window_mouse_face (struct window
*w
)
25920 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25921 Lisp_Object window
;
25924 XSETWINDOW (window
, w
);
25925 if (EQ (window
, hlinfo
->mouse_face_window
))
25926 clear_mouse_face (hlinfo
);
25932 Just discard the mouse face information for frame F, if any.
25933 This is used when the size of F is changed. */
25936 cancel_mouse_face (struct frame
*f
)
25938 Lisp_Object window
;
25939 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25941 window
= hlinfo
->mouse_face_window
;
25942 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25944 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25945 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25946 hlinfo
->mouse_face_window
= Qnil
;
25952 /***********************************************************************
25954 ***********************************************************************/
25956 #ifdef HAVE_WINDOW_SYSTEM
25958 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25959 which intersects rectangle R. R is in window-relative coordinates. */
25962 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25963 enum glyph_row_area area
)
25965 struct glyph
*first
= row
->glyphs
[area
];
25966 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25967 struct glyph
*last
;
25968 int first_x
, start_x
, x
;
25970 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25971 /* If row extends face to end of line write the whole line. */
25972 draw_glyphs (w
, 0, row
, area
,
25973 0, row
->used
[area
],
25974 DRAW_NORMAL_TEXT
, 0);
25977 /* Set START_X to the window-relative start position for drawing glyphs of
25978 AREA. The first glyph of the text area can be partially visible.
25979 The first glyphs of other areas cannot. */
25980 start_x
= window_box_left_offset (w
, area
);
25982 if (area
== TEXT_AREA
)
25985 /* Find the first glyph that must be redrawn. */
25987 && x
+ first
->pixel_width
< r
->x
)
25989 x
+= first
->pixel_width
;
25993 /* Find the last one. */
25997 && x
< r
->x
+ r
->width
)
25999 x
+= last
->pixel_width
;
26005 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26006 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26007 DRAW_NORMAL_TEXT
, 0);
26012 /* Redraw the parts of the glyph row ROW on window W intersecting
26013 rectangle R. R is in window-relative coordinates. Value is
26014 non-zero if mouse-face was overwritten. */
26017 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26019 xassert (row
->enabled_p
);
26021 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26022 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26023 0, row
->used
[TEXT_AREA
],
26024 DRAW_NORMAL_TEXT
, 0);
26027 if (row
->used
[LEFT_MARGIN_AREA
])
26028 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26029 if (row
->used
[TEXT_AREA
])
26030 expose_area (w
, row
, r
, TEXT_AREA
);
26031 if (row
->used
[RIGHT_MARGIN_AREA
])
26032 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26033 draw_row_fringe_bitmaps (w
, row
);
26036 return row
->mouse_face_p
;
26040 /* Redraw those parts of glyphs rows during expose event handling that
26041 overlap other rows. Redrawing of an exposed line writes over parts
26042 of lines overlapping that exposed line; this function fixes that.
26044 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26045 row in W's current matrix that is exposed and overlaps other rows.
26046 LAST_OVERLAPPING_ROW is the last such row. */
26049 expose_overlaps (struct window
*w
,
26050 struct glyph_row
*first_overlapping_row
,
26051 struct glyph_row
*last_overlapping_row
,
26054 struct glyph_row
*row
;
26056 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26057 if (row
->overlapping_p
)
26059 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26062 if (row
->used
[LEFT_MARGIN_AREA
])
26063 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26065 if (row
->used
[TEXT_AREA
])
26066 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26068 if (row
->used
[RIGHT_MARGIN_AREA
])
26069 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26075 /* Return non-zero if W's cursor intersects rectangle R. */
26078 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26080 XRectangle cr
, result
;
26081 struct glyph
*cursor_glyph
;
26082 struct glyph_row
*row
;
26084 if (w
->phys_cursor
.vpos
>= 0
26085 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26086 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26088 && row
->cursor_in_fringe_p
)
26090 /* Cursor is in the fringe. */
26091 cr
.x
= window_box_right_offset (w
,
26092 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26093 ? RIGHT_MARGIN_AREA
26096 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26097 cr
.height
= row
->height
;
26098 return x_intersect_rectangles (&cr
, r
, &result
);
26101 cursor_glyph
= get_phys_cursor_glyph (w
);
26104 /* r is relative to W's box, but w->phys_cursor.x is relative
26105 to left edge of W's TEXT area. Adjust it. */
26106 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26107 cr
.y
= w
->phys_cursor
.y
;
26108 cr
.width
= cursor_glyph
->pixel_width
;
26109 cr
.height
= w
->phys_cursor_height
;
26110 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26111 I assume the effect is the same -- and this is portable. */
26112 return x_intersect_rectangles (&cr
, r
, &result
);
26114 /* If we don't understand the format, pretend we're not in the hot-spot. */
26120 Draw a vertical window border to the right of window W if W doesn't
26121 have vertical scroll bars. */
26124 x_draw_vertical_border (struct window
*w
)
26126 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26128 /* We could do better, if we knew what type of scroll-bar the adjacent
26129 windows (on either side) have... But we don't :-(
26130 However, I think this works ok. ++KFS 2003-04-25 */
26132 /* Redraw borders between horizontally adjacent windows. Don't
26133 do it for frames with vertical scroll bars because either the
26134 right scroll bar of a window, or the left scroll bar of its
26135 neighbor will suffice as a border. */
26136 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26139 if (!WINDOW_RIGHTMOST_P (w
)
26140 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26142 int x0
, x1
, y0
, y1
;
26144 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26147 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26150 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26152 else if (!WINDOW_LEFTMOST_P (w
)
26153 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26155 int x0
, x1
, y0
, y1
;
26157 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26160 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26163 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26168 /* Redraw the part of window W intersection rectangle FR. Pixel
26169 coordinates in FR are frame-relative. Call this function with
26170 input blocked. Value is non-zero if the exposure overwrites
26174 expose_window (struct window
*w
, XRectangle
*fr
)
26176 struct frame
*f
= XFRAME (w
->frame
);
26178 int mouse_face_overwritten_p
= 0;
26180 /* If window is not yet fully initialized, do nothing. This can
26181 happen when toolkit scroll bars are used and a window is split.
26182 Reconfiguring the scroll bar will generate an expose for a newly
26184 if (w
->current_matrix
== NULL
)
26187 /* When we're currently updating the window, display and current
26188 matrix usually don't agree. Arrange for a thorough display
26190 if (w
== updated_window
)
26192 SET_FRAME_GARBAGED (f
);
26196 /* Frame-relative pixel rectangle of W. */
26197 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26198 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
26199 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
26200 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
26202 if (x_intersect_rectangles (fr
, &wr
, &r
))
26204 int yb
= window_text_bottom_y (w
);
26205 struct glyph_row
*row
;
26206 int cursor_cleared_p
;
26207 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
26209 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
26210 r
.x
, r
.y
, r
.width
, r
.height
));
26212 /* Convert to window coordinates. */
26213 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
26214 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
26216 /* Turn off the cursor. */
26217 if (!w
->pseudo_window_p
26218 && phys_cursor_in_rect_p (w
, &r
))
26220 x_clear_cursor (w
);
26221 cursor_cleared_p
= 1;
26224 cursor_cleared_p
= 0;
26226 /* Update lines intersecting rectangle R. */
26227 first_overlapping_row
= last_overlapping_row
= NULL
;
26228 for (row
= w
->current_matrix
->rows
;
26233 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
26235 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
26236 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
26237 || (r
.y
>= y0
&& r
.y
< y1
)
26238 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
26240 /* A header line may be overlapping, but there is no need
26241 to fix overlapping areas for them. KFS 2005-02-12 */
26242 if (row
->overlapping_p
&& !row
->mode_line_p
)
26244 if (first_overlapping_row
== NULL
)
26245 first_overlapping_row
= row
;
26246 last_overlapping_row
= row
;
26250 if (expose_line (w
, row
, &r
))
26251 mouse_face_overwritten_p
= 1;
26254 else if (row
->overlapping_p
)
26256 /* We must redraw a row overlapping the exposed area. */
26258 ? y0
+ row
->phys_height
> r
.y
26259 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
26261 if (first_overlapping_row
== NULL
)
26262 first_overlapping_row
= row
;
26263 last_overlapping_row
= row
;
26271 /* Display the mode line if there is one. */
26272 if (WINDOW_WANTS_MODELINE_P (w
)
26273 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
26275 && row
->y
< r
.y
+ r
.height
)
26277 if (expose_line (w
, row
, &r
))
26278 mouse_face_overwritten_p
= 1;
26281 if (!w
->pseudo_window_p
)
26283 /* Fix the display of overlapping rows. */
26284 if (first_overlapping_row
)
26285 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
26288 /* Draw border between windows. */
26289 x_draw_vertical_border (w
);
26291 /* Turn the cursor on again. */
26292 if (cursor_cleared_p
)
26293 update_window_cursor (w
, 1);
26297 return mouse_face_overwritten_p
;
26302 /* Redraw (parts) of all windows in the window tree rooted at W that
26303 intersect R. R contains frame pixel coordinates. Value is
26304 non-zero if the exposure overwrites mouse-face. */
26307 expose_window_tree (struct window
*w
, XRectangle
*r
)
26309 struct frame
*f
= XFRAME (w
->frame
);
26310 int mouse_face_overwritten_p
= 0;
26312 while (w
&& !FRAME_GARBAGED_P (f
))
26314 if (!NILP (w
->hchild
))
26315 mouse_face_overwritten_p
26316 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
26317 else if (!NILP (w
->vchild
))
26318 mouse_face_overwritten_p
26319 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
26321 mouse_face_overwritten_p
|= expose_window (w
, r
);
26323 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
26326 return mouse_face_overwritten_p
;
26331 Redisplay an exposed area of frame F. X and Y are the upper-left
26332 corner of the exposed rectangle. W and H are width and height of
26333 the exposed area. All are pixel values. W or H zero means redraw
26334 the entire frame. */
26337 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
26340 int mouse_face_overwritten_p
= 0;
26342 TRACE ((stderr
, "expose_frame "));
26344 /* No need to redraw if frame will be redrawn soon. */
26345 if (FRAME_GARBAGED_P (f
))
26347 TRACE ((stderr
, " garbaged\n"));
26351 /* If basic faces haven't been realized yet, there is no point in
26352 trying to redraw anything. This can happen when we get an expose
26353 event while Emacs is starting, e.g. by moving another window. */
26354 if (FRAME_FACE_CACHE (f
) == NULL
26355 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
26357 TRACE ((stderr
, " no faces\n"));
26361 if (w
== 0 || h
== 0)
26364 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
26365 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
26375 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
26376 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
26378 if (WINDOWP (f
->tool_bar_window
))
26379 mouse_face_overwritten_p
26380 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
26382 #ifdef HAVE_X_WINDOWS
26384 #ifndef USE_X_TOOLKIT
26385 if (WINDOWP (f
->menu_bar_window
))
26386 mouse_face_overwritten_p
26387 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
26388 #endif /* not USE_X_TOOLKIT */
26392 /* Some window managers support a focus-follows-mouse style with
26393 delayed raising of frames. Imagine a partially obscured frame,
26394 and moving the mouse into partially obscured mouse-face on that
26395 frame. The visible part of the mouse-face will be highlighted,
26396 then the WM raises the obscured frame. With at least one WM, KDE
26397 2.1, Emacs is not getting any event for the raising of the frame
26398 (even tried with SubstructureRedirectMask), only Expose events.
26399 These expose events will draw text normally, i.e. not
26400 highlighted. Which means we must redo the highlight here.
26401 Subsume it under ``we love X''. --gerd 2001-08-15 */
26402 /* Included in Windows version because Windows most likely does not
26403 do the right thing if any third party tool offers
26404 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
26405 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
26407 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26408 if (f
== hlinfo
->mouse_face_mouse_frame
)
26410 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
26411 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
26412 clear_mouse_face (hlinfo
);
26413 note_mouse_highlight (f
, mouse_x
, mouse_y
);
26420 Determine the intersection of two rectangles R1 and R2. Return
26421 the intersection in *RESULT. Value is non-zero if RESULT is not
26425 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
26427 XRectangle
*left
, *right
;
26428 XRectangle
*upper
, *lower
;
26429 int intersection_p
= 0;
26431 /* Rearrange so that R1 is the left-most rectangle. */
26433 left
= r1
, right
= r2
;
26435 left
= r2
, right
= r1
;
26437 /* X0 of the intersection is right.x0, if this is inside R1,
26438 otherwise there is no intersection. */
26439 if (right
->x
<= left
->x
+ left
->width
)
26441 result
->x
= right
->x
;
26443 /* The right end of the intersection is the minimum of the
26444 the right ends of left and right. */
26445 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
26448 /* Same game for Y. */
26450 upper
= r1
, lower
= r2
;
26452 upper
= r2
, lower
= r1
;
26454 /* The upper end of the intersection is lower.y0, if this is inside
26455 of upper. Otherwise, there is no intersection. */
26456 if (lower
->y
<= upper
->y
+ upper
->height
)
26458 result
->y
= lower
->y
;
26460 /* The lower end of the intersection is the minimum of the lower
26461 ends of upper and lower. */
26462 result
->height
= (min (lower
->y
+ lower
->height
,
26463 upper
->y
+ upper
->height
)
26465 intersection_p
= 1;
26469 return intersection_p
;
26472 #endif /* HAVE_WINDOW_SYSTEM */
26475 /***********************************************************************
26477 ***********************************************************************/
26480 syms_of_xdisp (void)
26482 Vwith_echo_area_save_vector
= Qnil
;
26483 staticpro (&Vwith_echo_area_save_vector
);
26485 Vmessage_stack
= Qnil
;
26486 staticpro (&Vmessage_stack
);
26488 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
26489 staticpro (&Qinhibit_redisplay
);
26491 message_dolog_marker1
= Fmake_marker ();
26492 staticpro (&message_dolog_marker1
);
26493 message_dolog_marker2
= Fmake_marker ();
26494 staticpro (&message_dolog_marker2
);
26495 message_dolog_marker3
= Fmake_marker ();
26496 staticpro (&message_dolog_marker3
);
26499 defsubr (&Sdump_frame_glyph_matrix
);
26500 defsubr (&Sdump_glyph_matrix
);
26501 defsubr (&Sdump_glyph_row
);
26502 defsubr (&Sdump_tool_bar_row
);
26503 defsubr (&Strace_redisplay
);
26504 defsubr (&Strace_to_stderr
);
26506 #ifdef HAVE_WINDOW_SYSTEM
26507 defsubr (&Stool_bar_lines_needed
);
26508 defsubr (&Slookup_image_map
);
26510 defsubr (&Sformat_mode_line
);
26511 defsubr (&Sinvisible_p
);
26512 defsubr (&Scurrent_bidi_paragraph_direction
);
26514 staticpro (&Qmenu_bar_update_hook
);
26515 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
26517 staticpro (&Qoverriding_terminal_local_map
);
26518 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
26520 staticpro (&Qoverriding_local_map
);
26521 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
26523 staticpro (&Qwindow_scroll_functions
);
26524 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
26526 staticpro (&Qwindow_text_change_functions
);
26527 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
26529 staticpro (&Qredisplay_end_trigger_functions
);
26530 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
26532 staticpro (&Qinhibit_point_motion_hooks
);
26533 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
26535 Qeval
= intern_c_string ("eval");
26536 staticpro (&Qeval
);
26538 QCdata
= intern_c_string (":data");
26539 staticpro (&QCdata
);
26540 Qdisplay
= intern_c_string ("display");
26541 staticpro (&Qdisplay
);
26542 Qspace_width
= intern_c_string ("space-width");
26543 staticpro (&Qspace_width
);
26544 Qraise
= intern_c_string ("raise");
26545 staticpro (&Qraise
);
26546 Qslice
= intern_c_string ("slice");
26547 staticpro (&Qslice
);
26548 Qspace
= intern_c_string ("space");
26549 staticpro (&Qspace
);
26550 Qmargin
= intern_c_string ("margin");
26551 staticpro (&Qmargin
);
26552 Qpointer
= intern_c_string ("pointer");
26553 staticpro (&Qpointer
);
26554 Qleft_margin
= intern_c_string ("left-margin");
26555 staticpro (&Qleft_margin
);
26556 Qright_margin
= intern_c_string ("right-margin");
26557 staticpro (&Qright_margin
);
26558 Qcenter
= intern_c_string ("center");
26559 staticpro (&Qcenter
);
26560 Qline_height
= intern_c_string ("line-height");
26561 staticpro (&Qline_height
);
26562 QCalign_to
= intern_c_string (":align-to");
26563 staticpro (&QCalign_to
);
26564 QCrelative_width
= intern_c_string (":relative-width");
26565 staticpro (&QCrelative_width
);
26566 QCrelative_height
= intern_c_string (":relative-height");
26567 staticpro (&QCrelative_height
);
26568 QCeval
= intern_c_string (":eval");
26569 staticpro (&QCeval
);
26570 QCpropertize
= intern_c_string (":propertize");
26571 staticpro (&QCpropertize
);
26572 QCfile
= intern_c_string (":file");
26573 staticpro (&QCfile
);
26574 Qfontified
= intern_c_string ("fontified");
26575 staticpro (&Qfontified
);
26576 Qfontification_functions
= intern_c_string ("fontification-functions");
26577 staticpro (&Qfontification_functions
);
26578 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
26579 staticpro (&Qtrailing_whitespace
);
26580 Qescape_glyph
= intern_c_string ("escape-glyph");
26581 staticpro (&Qescape_glyph
);
26582 Qnobreak_space
= intern_c_string ("nobreak-space");
26583 staticpro (&Qnobreak_space
);
26584 Qimage
= intern_c_string ("image");
26585 staticpro (&Qimage
);
26586 Qtext
= intern_c_string ("text");
26587 staticpro (&Qtext
);
26588 Qboth
= intern_c_string ("both");
26589 staticpro (&Qboth
);
26590 Qboth_horiz
= intern_c_string ("both-horiz");
26591 staticpro (&Qboth_horiz
);
26592 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
26593 staticpro (&Qtext_image_horiz
);
26594 QCmap
= intern_c_string (":map");
26595 staticpro (&QCmap
);
26596 QCpointer
= intern_c_string (":pointer");
26597 staticpro (&QCpointer
);
26598 Qrect
= intern_c_string ("rect");
26599 staticpro (&Qrect
);
26600 Qcircle
= intern_c_string ("circle");
26601 staticpro (&Qcircle
);
26602 Qpoly
= intern_c_string ("poly");
26603 staticpro (&Qpoly
);
26604 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
26605 staticpro (&Qmessage_truncate_lines
);
26606 Qgrow_only
= intern_c_string ("grow-only");
26607 staticpro (&Qgrow_only
);
26608 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
26609 staticpro (&Qinhibit_menubar_update
);
26610 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
26611 staticpro (&Qinhibit_eval_during_redisplay
);
26612 Qposition
= intern_c_string ("position");
26613 staticpro (&Qposition
);
26614 Qbuffer_position
= intern_c_string ("buffer-position");
26615 staticpro (&Qbuffer_position
);
26616 Qobject
= intern_c_string ("object");
26617 staticpro (&Qobject
);
26618 Qbar
= intern_c_string ("bar");
26620 Qhbar
= intern_c_string ("hbar");
26621 staticpro (&Qhbar
);
26622 Qbox
= intern_c_string ("box");
26624 Qhollow
= intern_c_string ("hollow");
26625 staticpro (&Qhollow
);
26626 Qhand
= intern_c_string ("hand");
26627 staticpro (&Qhand
);
26628 Qarrow
= intern_c_string ("arrow");
26629 staticpro (&Qarrow
);
26630 Qtext
= intern_c_string ("text");
26631 staticpro (&Qtext
);
26632 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
26633 staticpro (&Qinhibit_free_realized_faces
);
26635 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
26636 Fcons (intern_c_string ("void-variable"), Qnil
)),
26638 staticpro (&list_of_error
);
26640 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
26641 staticpro (&Qlast_arrow_position
);
26642 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
26643 staticpro (&Qlast_arrow_string
);
26645 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
26646 staticpro (&Qoverlay_arrow_string
);
26647 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
26648 staticpro (&Qoverlay_arrow_bitmap
);
26650 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
26651 staticpro (&echo_buffer
[0]);
26652 staticpro (&echo_buffer
[1]);
26654 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
26655 staticpro (&echo_area_buffer
[0]);
26656 staticpro (&echo_area_buffer
[1]);
26658 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
26659 staticpro (&Vmessages_buffer_name
);
26661 mode_line_proptrans_alist
= Qnil
;
26662 staticpro (&mode_line_proptrans_alist
);
26663 mode_line_string_list
= Qnil
;
26664 staticpro (&mode_line_string_list
);
26665 mode_line_string_face
= Qnil
;
26666 staticpro (&mode_line_string_face
);
26667 mode_line_string_face_prop
= Qnil
;
26668 staticpro (&mode_line_string_face_prop
);
26669 Vmode_line_unwind_vector
= Qnil
;
26670 staticpro (&Vmode_line_unwind_vector
);
26672 help_echo_string
= Qnil
;
26673 staticpro (&help_echo_string
);
26674 help_echo_object
= Qnil
;
26675 staticpro (&help_echo_object
);
26676 help_echo_window
= Qnil
;
26677 staticpro (&help_echo_window
);
26678 previous_help_echo_string
= Qnil
;
26679 staticpro (&previous_help_echo_string
);
26680 help_echo_pos
= -1;
26682 Qright_to_left
= intern_c_string ("right-to-left");
26683 staticpro (&Qright_to_left
);
26684 Qleft_to_right
= intern_c_string ("left-to-right");
26685 staticpro (&Qleft_to_right
);
26687 #ifdef HAVE_WINDOW_SYSTEM
26688 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
26689 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26690 For example, if a block cursor is over a tab, it will be drawn as
26691 wide as that tab on the display. */);
26692 x_stretch_cursor_p
= 0;
26695 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
26696 doc
: /* *Non-nil means highlight trailing whitespace.
26697 The face used for trailing whitespace is `trailing-whitespace'. */);
26698 Vshow_trailing_whitespace
= Qnil
;
26700 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
26701 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26702 A value of t means highlight the character itself (for nobreak space,
26703 use face `nobreak-space').
26704 A value of nil means no highlighting.
26705 Other values mean display the escape glyph followed by an ordinary
26706 space or ordinary hyphen. */);
26707 Vnobreak_char_display
= Qt
;
26709 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
26710 doc
: /* *The pointer shape to show in void text areas.
26711 A value of nil means to show the text pointer. Other options are `arrow',
26712 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26713 Vvoid_text_area_pointer
= Qarrow
;
26715 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
26716 doc
: /* Non-nil means don't actually do any redisplay.
26717 This is used for internal purposes. */);
26718 Vinhibit_redisplay
= Qnil
;
26720 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
26721 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26722 Vglobal_mode_string
= Qnil
;
26724 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
26725 doc
: /* Marker for where to display an arrow on top of the buffer text.
26726 This must be the beginning of a line in order to work.
26727 See also `overlay-arrow-string'. */);
26728 Voverlay_arrow_position
= Qnil
;
26730 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
26731 doc
: /* String to display as an arrow in non-window frames.
26732 See also `overlay-arrow-position'. */);
26733 Voverlay_arrow_string
= make_pure_c_string ("=>");
26735 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
26736 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26737 The symbols on this list are examined during redisplay to determine
26738 where to display overlay arrows. */);
26739 Voverlay_arrow_variable_list
26740 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26742 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
26743 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26744 If that fails to bring point back on frame, point is centered instead.
26745 If this is zero, point is always centered after it moves off frame.
26746 If you want scrolling to always be a line at a time, you should set
26747 `scroll-conservatively' to a large value rather than set this to 1. */);
26749 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
26750 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26751 If point moves off-screen, redisplay will scroll by up to
26752 `scroll-conservatively' lines in order to bring point just barely
26753 onto the screen again. If that cannot be done, then redisplay
26754 recenters point as usual.
26756 If the value is greater than 100, redisplay will never recenter point,
26757 but will always scroll just enough text to bring point into view, even
26758 if you move far away.
26760 A value of zero means always recenter point if it moves off screen. */);
26761 scroll_conservatively
= 0;
26763 DEFVAR_INT ("scroll-margin", scroll_margin
,
26764 doc
: /* *Number of lines of margin at the top and bottom of a window.
26765 Recenter the window whenever point gets within this many lines
26766 of the top or bottom of the window. */);
26769 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
26770 doc
: /* Pixels per inch value for non-window system displays.
26771 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26772 Vdisplay_pixels_per_inch
= make_float (72.0);
26775 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
26778 DEFVAR_LISP ("truncate-partial-width-windows",
26779 Vtruncate_partial_width_windows
,
26780 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26781 For an integer value, truncate lines in each window narrower than the
26782 full frame width, provided the window width is less than that integer;
26783 otherwise, respect the value of `truncate-lines'.
26785 For any other non-nil value, truncate lines in all windows that do
26786 not span the full frame width.
26788 A value of nil means to respect the value of `truncate-lines'.
26790 If `word-wrap' is enabled, you might want to reduce this. */);
26791 Vtruncate_partial_width_windows
= make_number (50);
26793 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
26794 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26795 Any other value means to use the appropriate face, `mode-line',
26796 `header-line', or `menu' respectively. */);
26797 mode_line_inverse_video
= 1;
26799 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
26800 doc
: /* *Maximum buffer size for which line number should be displayed.
26801 If the buffer is bigger than this, the line number does not appear
26802 in the mode line. A value of nil means no limit. */);
26803 Vline_number_display_limit
= Qnil
;
26805 DEFVAR_INT ("line-number-display-limit-width",
26806 line_number_display_limit_width
,
26807 doc
: /* *Maximum line width (in characters) for line number display.
26808 If the average length of the lines near point is bigger than this, then the
26809 line number may be omitted from the mode line. */);
26810 line_number_display_limit_width
= 200;
26812 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
26813 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26814 highlight_nonselected_windows
= 0;
26816 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
26817 doc
: /* Non-nil if more than one frame is visible on this display.
26818 Minibuffer-only frames don't count, but iconified frames do.
26819 This variable is not guaranteed to be accurate except while processing
26820 `frame-title-format' and `icon-title-format'. */);
26822 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
26823 doc
: /* Template for displaying the title bar of visible frames.
26824 \(Assuming the window manager supports this feature.)
26826 This variable has the same structure as `mode-line-format', except that
26827 the %c and %l constructs are ignored. It is used only on frames for
26828 which no explicit name has been set \(see `modify-frame-parameters'). */);
26830 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
26831 doc
: /* Template for displaying the title bar of an iconified frame.
26832 \(Assuming the window manager supports this feature.)
26833 This variable has the same structure as `mode-line-format' (which see),
26834 and is used only on frames for which no explicit name has been set
26835 \(see `modify-frame-parameters'). */);
26837 = Vframe_title_format
26838 = pure_cons (intern_c_string ("multiple-frames"),
26839 pure_cons (make_pure_c_string ("%b"),
26840 pure_cons (pure_cons (empty_unibyte_string
,
26841 pure_cons (intern_c_string ("invocation-name"),
26842 pure_cons (make_pure_c_string ("@"),
26843 pure_cons (intern_c_string ("system-name"),
26847 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
26848 doc
: /* Maximum number of lines to keep in the message log buffer.
26849 If nil, disable message logging. If t, log messages but don't truncate
26850 the buffer when it becomes large. */);
26851 Vmessage_log_max
= make_number (100);
26853 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
26854 doc
: /* Functions called before redisplay, if window sizes have changed.
26855 The value should be a list of functions that take one argument.
26856 Just before redisplay, for each frame, if any of its windows have changed
26857 size since the last redisplay, or have been split or deleted,
26858 all the functions in the list are called, with the frame as argument. */);
26859 Vwindow_size_change_functions
= Qnil
;
26861 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
26862 doc
: /* List of functions to call before redisplaying a window with scrolling.
26863 Each function is called with two arguments, the window and its new
26864 display-start position. Note that these functions are also called by
26865 `set-window-buffer'. Also note that the value of `window-end' is not
26866 valid when these functions are called. */);
26867 Vwindow_scroll_functions
= Qnil
;
26869 DEFVAR_LISP ("window-text-change-functions",
26870 Vwindow_text_change_functions
,
26871 doc
: /* Functions to call in redisplay when text in the window might change. */);
26872 Vwindow_text_change_functions
= Qnil
;
26874 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
26875 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26876 Each function is called with two arguments, the window and the end trigger value.
26877 See `set-window-redisplay-end-trigger'. */);
26878 Vredisplay_end_trigger_functions
= Qnil
;
26880 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
26881 doc
: /* *Non-nil means autoselect window with mouse pointer.
26882 If nil, do not autoselect windows.
26883 A positive number means delay autoselection by that many seconds: a
26884 window is autoselected only after the mouse has remained in that
26885 window for the duration of the delay.
26886 A negative number has a similar effect, but causes windows to be
26887 autoselected only after the mouse has stopped moving. \(Because of
26888 the way Emacs compares mouse events, you will occasionally wait twice
26889 that time before the window gets selected.\)
26890 Any other value means to autoselect window instantaneously when the
26891 mouse pointer enters it.
26893 Autoselection selects the minibuffer only if it is active, and never
26894 unselects the minibuffer if it is active.
26896 When customizing this variable make sure that the actual value of
26897 `focus-follows-mouse' matches the behavior of your window manager. */);
26898 Vmouse_autoselect_window
= Qnil
;
26900 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
26901 doc
: /* *Non-nil means automatically resize tool-bars.
26902 This dynamically changes the tool-bar's height to the minimum height
26903 that is needed to make all tool-bar items visible.
26904 If value is `grow-only', the tool-bar's height is only increased
26905 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26906 Vauto_resize_tool_bars
= Qt
;
26908 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
26909 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26910 auto_raise_tool_bar_buttons_p
= 1;
26912 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
26913 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26914 make_cursor_line_fully_visible_p
= 1;
26916 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
26917 doc
: /* *Border below tool-bar in pixels.
26918 If an integer, use it as the height of the border.
26919 If it is one of `internal-border-width' or `border-width', use the
26920 value of the corresponding frame parameter.
26921 Otherwise, no border is added below the tool-bar. */);
26922 Vtool_bar_border
= Qinternal_border_width
;
26924 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
26925 doc
: /* *Margin around tool-bar buttons in pixels.
26926 If an integer, use that for both horizontal and vertical margins.
26927 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26928 HORZ specifying the horizontal margin, and VERT specifying the
26929 vertical margin. */);
26930 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26932 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
26933 doc
: /* *Relief thickness of tool-bar buttons. */);
26934 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26936 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
26937 doc
: /* Tool bar style to use.
26939 image - show images only
26940 text - show text only
26941 both - show both, text below image
26942 both-horiz - show text to the right of the image
26943 text-image-horiz - show text to the left of the image
26944 any other - use system default or image if no system default. */);
26945 Vtool_bar_style
= Qnil
;
26947 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
26948 doc
: /* *Maximum number of characters a label can have to be shown.
26949 The tool bar style must also show labels for this to have any effect, see
26950 `tool-bar-style'. */);
26951 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26953 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
26954 doc
: /* List of functions to call to fontify regions of text.
26955 Each function is called with one argument POS. Functions must
26956 fontify a region starting at POS in the current buffer, and give
26957 fontified regions the property `fontified'. */);
26958 Vfontification_functions
= Qnil
;
26959 Fmake_variable_buffer_local (Qfontification_functions
);
26961 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26962 unibyte_display_via_language_environment
,
26963 doc
: /* *Non-nil means display unibyte text according to language environment.
26964 Specifically, this means that raw bytes in the range 160-255 decimal
26965 are displayed by converting them to the equivalent multibyte characters
26966 according to the current language environment. As a result, they are
26967 displayed according to the current fontset.
26969 Note that this variable affects only how these bytes are displayed,
26970 but does not change the fact they are interpreted as raw bytes. */);
26971 unibyte_display_via_language_environment
= 0;
26973 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
26974 doc
: /* *Maximum height for resizing mini-windows.
26975 If a float, it specifies a fraction of the mini-window frame's height.
26976 If an integer, it specifies a number of lines. */);
26977 Vmax_mini_window_height
= make_float (0.25);
26979 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
26980 doc
: /* *How to resize mini-windows.
26981 A value of nil means don't automatically resize mini-windows.
26982 A value of t means resize them to fit the text displayed in them.
26983 A value of `grow-only', the default, means let mini-windows grow
26984 only, until their display becomes empty, at which point the windows
26985 go back to their normal size. */);
26986 Vresize_mini_windows
= Qgrow_only
;
26988 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
26989 doc
: /* Alist specifying how to blink the cursor off.
26990 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26991 `cursor-type' frame-parameter or variable equals ON-STATE,
26992 comparing using `equal', Emacs uses OFF-STATE to specify
26993 how to blink it off. ON-STATE and OFF-STATE are values for
26994 the `cursor-type' frame parameter.
26996 If a frame's ON-STATE has no entry in this list,
26997 the frame's other specifications determine how to blink the cursor off. */);
26998 Vblink_cursor_alist
= Qnil
;
27000 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27001 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27002 If non-nil, windows are automatically scrolled horizontally to make
27003 point visible. */);
27004 automatic_hscrolling_p
= 1;
27005 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
27006 staticpro (&Qauto_hscroll_mode
);
27008 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27009 doc
: /* *How many columns away from the window edge point is allowed to get
27010 before automatic hscrolling will horizontally scroll the window. */);
27011 hscroll_margin
= 5;
27013 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27014 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27015 When point is less than `hscroll-margin' columns from the window
27016 edge, automatic hscrolling will scroll the window by the amount of columns
27017 determined by this variable. If its value is a positive integer, scroll that
27018 many columns. If it's a positive floating-point number, it specifies the
27019 fraction of the window's width to scroll. If it's nil or zero, point will be
27020 centered horizontally after the scroll. Any other value, including negative
27021 numbers, are treated as if the value were zero.
27023 Automatic hscrolling always moves point outside the scroll margin, so if
27024 point was more than scroll step columns inside the margin, the window will
27025 scroll more than the value given by the scroll step.
27027 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27028 and `scroll-right' overrides this variable's effect. */);
27029 Vhscroll_step
= make_number (0);
27031 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27032 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27033 Bind this around calls to `message' to let it take effect. */);
27034 message_truncate_lines
= 0;
27036 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27037 doc
: /* Normal hook run to update the menu bar definitions.
27038 Redisplay runs this hook before it redisplays the menu bar.
27039 This is used to update submenus such as Buffers,
27040 whose contents depend on various data. */);
27041 Vmenu_bar_update_hook
= Qnil
;
27043 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27044 doc
: /* Frame for which we are updating a menu.
27045 The enable predicate for a menu binding should check this variable. */);
27046 Vmenu_updating_frame
= Qnil
;
27048 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27049 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27050 inhibit_menubar_update
= 0;
27052 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27053 doc
: /* Prefix prepended to all continuation lines at display time.
27054 The value may be a string, an image, or a stretch-glyph; it is
27055 interpreted in the same way as the value of a `display' text property.
27057 This variable is overridden by any `wrap-prefix' text or overlay
27060 To add a prefix to non-continuation lines, use `line-prefix'. */);
27061 Vwrap_prefix
= Qnil
;
27062 staticpro (&Qwrap_prefix
);
27063 Qwrap_prefix
= intern_c_string ("wrap-prefix");
27064 Fmake_variable_buffer_local (Qwrap_prefix
);
27066 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27067 doc
: /* Prefix prepended to all non-continuation lines at display time.
27068 The value may be a string, an image, or a stretch-glyph; it is
27069 interpreted in the same way as the value of a `display' text property.
27071 This variable is overridden by any `line-prefix' text or overlay
27074 To add a prefix to continuation lines, use `wrap-prefix'. */);
27075 Vline_prefix
= Qnil
;
27076 staticpro (&Qline_prefix
);
27077 Qline_prefix
= intern_c_string ("line-prefix");
27078 Fmake_variable_buffer_local (Qline_prefix
);
27080 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27081 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27082 inhibit_eval_during_redisplay
= 0;
27084 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27085 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27086 inhibit_free_realized_faces
= 0;
27089 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27090 doc
: /* Inhibit try_window_id display optimization. */);
27091 inhibit_try_window_id
= 0;
27093 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27094 doc
: /* Inhibit try_window_reusing display optimization. */);
27095 inhibit_try_window_reusing
= 0;
27097 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27098 doc
: /* Inhibit try_cursor_movement display optimization. */);
27099 inhibit_try_cursor_movement
= 0;
27100 #endif /* GLYPH_DEBUG */
27102 DEFVAR_INT ("overline-margin", overline_margin
,
27103 doc
: /* *Space between overline and text, in pixels.
27104 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27105 margin to the caracter height. */);
27106 overline_margin
= 2;
27108 DEFVAR_INT ("underline-minimum-offset",
27109 underline_minimum_offset
,
27110 doc
: /* Minimum distance between baseline and underline.
27111 This can improve legibility of underlined text at small font sizes,
27112 particularly when using variable `x-use-underline-position-properties'
27113 with fonts that specify an UNDERLINE_POSITION relatively close to the
27114 baseline. The default value is 1. */);
27115 underline_minimum_offset
= 1;
27117 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27118 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27119 This feature only works when on a window system that can change
27120 cursor shapes. */);
27121 display_hourglass_p
= 1;
27123 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27124 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27125 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27127 hourglass_atimer
= NULL
;
27128 hourglass_shown_p
= 0;
27130 DEFSYM (Qglyphless_char
, "glyphless-char");
27131 DEFSYM (Qhex_code
, "hex-code");
27132 DEFSYM (Qempty_box
, "empty-box");
27133 DEFSYM (Qthin_space
, "thin-space");
27134 DEFSYM (Qzero_width
, "zero-width");
27136 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27137 /* Intern this now in case it isn't already done.
27138 Setting this variable twice is harmless.
27139 But don't staticpro it here--that is done in alloc.c. */
27140 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27141 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27143 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27144 doc
: /* Char-table defining glyphless characters.
27145 Each element, if non-nil, should be one of the following:
27146 an ASCII acronym string: display this string in a box
27147 `hex-code': display the hexadecimal code of a character in a box
27148 `empty-box': display as an empty box
27149 `thin-space': display as 1-pixel width space
27150 `zero-width': don't display
27151 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27152 display method for graphical terminals and text terminals respectively.
27153 GRAPHICAL and TEXT should each have one of the values listed above.
27155 The char-table has one extra slot to control the display of a character for
27156 which no font is found. This slot only takes effect on graphical terminals.
27157 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27158 `thin-space'. The default is `empty-box'. */);
27159 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27160 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27165 /* Initialize this module when Emacs starts. */
27170 Lisp_Object root_window
;
27171 struct window
*mini_w
;
27173 current_header_line_height
= current_mode_line_height
= -1;
27175 CHARPOS (this_line_start_pos
) = 0;
27177 mini_w
= XWINDOW (minibuf_window
);
27178 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
27179 echo_area_window
= minibuf_window
;
27181 if (!noninteractive
)
27183 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
27186 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
27187 set_window_height (root_window
,
27188 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
27190 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
27191 set_window_height (minibuf_window
, 1, 0);
27193 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
27194 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
27196 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27197 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27198 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27200 /* The default ellipsis glyphs `...'. */
27201 for (i
= 0; i
< 3; ++i
)
27202 default_invis_vector
[i
] = make_number ('.');
27206 /* Allocate the buffer for frame titles.
27207 Also used for `format-mode-line'. */
27209 mode_line_noprop_buf
= (char *) xmalloc (size
);
27210 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27211 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27212 mode_line_target
= MODE_LINE_DISPLAY
;
27215 help_echo_showing_p
= 0;
27218 /* Since w32 does not support atimers, it defines its own implementation of
27219 the following three functions in w32fns.c. */
27222 /* Platform-independent portion of hourglass implementation. */
27224 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27226 hourglass_started (void)
27228 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27231 /* Cancel a currently active hourglass timer, and start a new one. */
27233 start_hourglass (void)
27235 #if defined (HAVE_WINDOW_SYSTEM)
27237 int secs
, usecs
= 0;
27239 cancel_hourglass ();
27241 if (INTEGERP (Vhourglass_delay
)
27242 && XINT (Vhourglass_delay
) > 0)
27243 secs
= XFASTINT (Vhourglass_delay
);
27244 else if (FLOATP (Vhourglass_delay
)
27245 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27248 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27249 secs
= XFASTINT (tem
);
27250 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27253 secs
= DEFAULT_HOURGLASS_DELAY
;
27255 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27256 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27257 show_hourglass
, NULL
);
27262 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27265 cancel_hourglass (void)
27267 #if defined (HAVE_WINDOW_SYSTEM)
27268 if (hourglass_atimer
)
27270 cancel_atimer (hourglass_atimer
);
27271 hourglass_atimer
= NULL
;
27274 if (hourglass_shown_p
)
27278 #endif /* ! WINDOWSNT */