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 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
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
609 CACHE = bidi_shelve_cache(); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1346 bidi_unshelve_cache (itdata
);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 EMACS_INT rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 EMACS_INT charpos
, EMACS_INT bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? XINT (BVAR (current_buffer
, selective_display
))
2433 : (!NILP (BVAR (current_buffer
, selective_display
))
2435 it
->selective_display_ellipsis_p
2436 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2438 /* Display table to use. */
2439 it
->dp
= window_display_table (w
);
2441 /* Are multibyte characters enabled in current_buffer? */
2442 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2444 /* Non-zero if we should highlight the region. */
2446 = (!NILP (Vtransient_mark_mode
)
2447 && !NILP (BVAR (current_buffer
, mark_active
))
2448 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2450 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2451 start and end of a visible region in window IT->w. Set both to
2452 -1 to indicate no region. */
2453 if (highlight_region_p
2454 /* Maybe highlight only in selected window. */
2455 && (/* Either show region everywhere. */
2456 highlight_nonselected_windows
2457 /* Or show region in the selected window. */
2458 || w
== XWINDOW (selected_window
)
2459 /* Or show the region if we are in the mini-buffer and W is
2460 the window the mini-buffer refers to. */
2461 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2462 && WINDOWP (minibuf_selected_window
)
2463 && w
== XWINDOW (minibuf_selected_window
))))
2465 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2466 it
->region_beg_charpos
= min (PT
, markpos
);
2467 it
->region_end_charpos
= max (PT
, markpos
);
2470 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2472 /* Get the position at which the redisplay_end_trigger hook should
2473 be run, if it is to be run at all. */
2474 if (MARKERP (w
->redisplay_end_trigger
)
2475 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2476 it
->redisplay_end_trigger_charpos
2477 = marker_position (w
->redisplay_end_trigger
);
2478 else if (INTEGERP (w
->redisplay_end_trigger
))
2479 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2481 /* Correct bogus values of tab_width. */
2482 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2483 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2486 /* Are lines in the display truncated? */
2487 if (base_face_id
!= DEFAULT_FACE_ID
2488 || XINT (it
->w
->hscroll
)
2489 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2490 && ((!NILP (Vtruncate_partial_width_windows
)
2491 && !INTEGERP (Vtruncate_partial_width_windows
))
2492 || (INTEGERP (Vtruncate_partial_width_windows
)
2493 && (WINDOW_TOTAL_COLS (it
->w
)
2494 < XINT (Vtruncate_partial_width_windows
))))))
2495 it
->line_wrap
= TRUNCATE
;
2496 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2497 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2498 ? WINDOW_WRAP
: WORD_WRAP
;
2500 it
->line_wrap
= TRUNCATE
;
2502 /* Get dimensions of truncation and continuation glyphs. These are
2503 displayed as fringe bitmaps under X, so we don't need them for such
2505 if (!FRAME_WINDOW_P (it
->f
))
2507 if (it
->line_wrap
== TRUNCATE
)
2509 /* We will need the truncation glyph. */
2510 xassert (it
->glyph_row
== NULL
);
2511 produce_special_glyphs (it
, IT_TRUNCATION
);
2512 it
->truncation_pixel_width
= it
->pixel_width
;
2516 /* We will need the continuation glyph. */
2517 xassert (it
->glyph_row
== NULL
);
2518 produce_special_glyphs (it
, IT_CONTINUATION
);
2519 it
->continuation_pixel_width
= it
->pixel_width
;
2522 /* Reset these values to zero because the produce_special_glyphs
2523 above has changed them. */
2524 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2525 it
->phys_ascent
= it
->phys_descent
= 0;
2528 /* Set this after getting the dimensions of truncation and
2529 continuation glyphs, so that we don't produce glyphs when calling
2530 produce_special_glyphs, above. */
2531 it
->glyph_row
= row
;
2532 it
->area
= TEXT_AREA
;
2534 /* Forget any previous info about this row being reversed. */
2536 it
->glyph_row
->reversed_p
= 0;
2538 /* Get the dimensions of the display area. The display area
2539 consists of the visible window area plus a horizontally scrolled
2540 part to the left of the window. All x-values are relative to the
2541 start of this total display area. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2544 /* Mode lines, menu bar in terminal frames. */
2545 it
->first_visible_x
= 0;
2546 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2551 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2552 it
->last_visible_x
= (it
->first_visible_x
2553 + window_box_width (w
, TEXT_AREA
));
2555 /* If we truncate lines, leave room for the truncator glyph(s) at
2556 the right margin. Otherwise, leave room for the continuation
2557 glyph(s). Truncation and continuation glyphs are not inserted
2558 for window-based redisplay. */
2559 if (!FRAME_WINDOW_P (it
->f
))
2561 if (it
->line_wrap
== TRUNCATE
)
2562 it
->last_visible_x
-= it
->truncation_pixel_width
;
2564 it
->last_visible_x
-= it
->continuation_pixel_width
;
2567 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2568 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2571 /* Leave room for a border glyph. */
2572 if (!FRAME_WINDOW_P (it
->f
)
2573 && !WINDOW_RIGHTMOST_P (it
->w
))
2574 it
->last_visible_x
-= 1;
2576 it
->last_visible_y
= window_text_bottom_y (w
);
2578 /* For mode lines and alike, arrange for the first glyph having a
2579 left box line if the face specifies a box. */
2580 if (base_face_id
!= DEFAULT_FACE_ID
)
2584 it
->face_id
= remapped_base_face_id
;
2586 /* If we have a boxed mode line, make the first character appear
2587 with a left box line. */
2588 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2589 if (face
->box
!= FACE_NO_BOX
)
2590 it
->start_of_box_run_p
= 1;
2593 /* If a buffer position was specified, set the iterator there,
2594 getting overlays and face properties from that position. */
2595 if (charpos
>= BUF_BEG (current_buffer
))
2597 it
->end_charpos
= ZV
;
2599 IT_CHARPOS (*it
) = charpos
;
2601 /* Compute byte position if not specified. */
2602 if (bytepos
< charpos
)
2603 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2605 IT_BYTEPOS (*it
) = bytepos
;
2607 it
->start
= it
->current
;
2608 /* Do we need to reorder bidirectional text? Not if this is a
2609 unibyte buffer: by definition, none of the single-byte
2610 characters are strong R2L, so no reordering is needed. And
2611 bidi.c doesn't support unibyte buffers anyway. */
2613 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2616 /* If we are to reorder bidirectional text, init the bidi
2620 /* Note the paragraph direction that this buffer wants to
2622 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= L2R
;
2625 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2627 it
->paragraph_embedding
= R2L
;
2629 it
->paragraph_embedding
= NEUTRAL_DIR
;
2630 bidi_unshelve_cache (NULL
);
2631 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2635 /* Compute faces etc. */
2636 reseat (it
, it
->current
.pos
, 1);
2643 /* Initialize IT for the display of window W with window start POS. */
2646 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2648 struct glyph_row
*row
;
2649 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2651 row
= w
->desired_matrix
->rows
+ first_vpos
;
2652 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2653 it
->first_vpos
= first_vpos
;
2655 /* Don't reseat to previous visible line start if current start
2656 position is in a string or image. */
2657 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2659 int start_at_line_beg_p
;
2660 int first_y
= it
->current_y
;
2662 /* If window start is not at a line start, skip forward to POS to
2663 get the correct continuation lines width. */
2664 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2665 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2666 if (!start_at_line_beg_p
)
2670 reseat_at_previous_visible_line_start (it
);
2671 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2673 new_x
= it
->current_x
+ it
->pixel_width
;
2675 /* If lines are continued, this line may end in the middle
2676 of a multi-glyph character (e.g. a control character
2677 displayed as \003, or in the middle of an overlay
2678 string). In this case move_it_to above will not have
2679 taken us to the start of the continuation line but to the
2680 end of the continued line. */
2681 if (it
->current_x
> 0
2682 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2683 && (/* And glyph doesn't fit on the line. */
2684 new_x
> it
->last_visible_x
2685 /* Or it fits exactly and we're on a window
2687 || (new_x
== it
->last_visible_x
2688 && FRAME_WINDOW_P (it
->f
))))
2690 if (it
->current
.dpvec_index
>= 0
2691 || it
->current
.overlay_string_index
>= 0)
2693 set_iterator_to_next (it
, 1);
2694 move_it_in_display_line_to (it
, -1, -1, 0);
2697 it
->continuation_lines_width
+= it
->current_x
;
2700 /* We're starting a new display line, not affected by the
2701 height of the continued line, so clear the appropriate
2702 fields in the iterator structure. */
2703 it
->max_ascent
= it
->max_descent
= 0;
2704 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2706 it
->current_y
= first_y
;
2708 it
->current_x
= it
->hpos
= 0;
2714 /* Return 1 if POS is a position in ellipses displayed for invisible
2715 text. W is the window we display, for text property lookup. */
2718 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2720 Lisp_Object prop
, window
;
2722 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2724 /* If POS specifies a position in a display vector, this might
2725 be for an ellipsis displayed for invisible text. We won't
2726 get the iterator set up for delivering that ellipsis unless
2727 we make sure that it gets aware of the invisible text. */
2728 if (pos
->dpvec_index
>= 0
2729 && pos
->overlay_string_index
< 0
2730 && CHARPOS (pos
->string_pos
) < 0
2732 && (XSETWINDOW (window
, w
),
2733 prop
= Fget_char_property (make_number (charpos
),
2734 Qinvisible
, window
),
2735 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2737 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2739 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2746 /* Initialize IT for stepping through current_buffer in window W,
2747 starting at position POS that includes overlay string and display
2748 vector/ control character translation position information. Value
2749 is zero if there are overlay strings with newlines at POS. */
2752 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2754 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2755 int i
, overlay_strings_with_newlines
= 0;
2757 /* If POS specifies a position in a display vector, this might
2758 be for an ellipsis displayed for invisible text. We won't
2759 get the iterator set up for delivering that ellipsis unless
2760 we make sure that it gets aware of the invisible text. */
2761 if (in_ellipses_for_invisible_text_p (pos
, w
))
2767 /* Keep in mind: the call to reseat in init_iterator skips invisible
2768 text, so we might end up at a position different from POS. This
2769 is only a problem when POS is a row start after a newline and an
2770 overlay starts there with an after-string, and the overlay has an
2771 invisible property. Since we don't skip invisible text in
2772 display_line and elsewhere immediately after consuming the
2773 newline before the row start, such a POS will not be in a string,
2774 but the call to init_iterator below will move us to the
2776 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2778 /* This only scans the current chunk -- it should scan all chunks.
2779 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2780 to 16 in 22.1 to make this a lesser problem. */
2781 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2783 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2784 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2786 while (s
< e
&& *s
!= '\n')
2791 overlay_strings_with_newlines
= 1;
2796 /* If position is within an overlay string, set up IT to the right
2798 if (pos
->overlay_string_index
>= 0)
2802 /* If the first overlay string happens to have a `display'
2803 property for an image, the iterator will be set up for that
2804 image, and we have to undo that setup first before we can
2805 correct the overlay string index. */
2806 if (it
->method
== GET_FROM_IMAGE
)
2809 /* We already have the first chunk of overlay strings in
2810 IT->overlay_strings. Load more until the one for
2811 pos->overlay_string_index is in IT->overlay_strings. */
2812 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2814 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2815 it
->current
.overlay_string_index
= 0;
2818 load_overlay_strings (it
, 0);
2819 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2823 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2824 relative_index
= (it
->current
.overlay_string_index
2825 % OVERLAY_STRING_CHUNK_SIZE
);
2826 it
->string
= it
->overlay_strings
[relative_index
];
2827 xassert (STRINGP (it
->string
));
2828 it
->current
.string_pos
= pos
->string_pos
;
2829 it
->method
= GET_FROM_STRING
;
2832 if (CHARPOS (pos
->string_pos
) >= 0)
2834 /* Recorded position is not in an overlay string, but in another
2835 string. This can only be a string from a `display' property.
2836 IT should already be filled with that string. */
2837 it
->current
.string_pos
= pos
->string_pos
;
2838 xassert (STRINGP (it
->string
));
2841 /* Restore position in display vector translations, control
2842 character translations or ellipses. */
2843 if (pos
->dpvec_index
>= 0)
2845 if (it
->dpvec
== NULL
)
2846 get_next_display_element (it
);
2847 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2848 it
->current
.dpvec_index
= pos
->dpvec_index
;
2852 return !overlay_strings_with_newlines
;
2856 /* Initialize IT for stepping through current_buffer in window W
2857 starting at ROW->start. */
2860 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2862 init_from_display_pos (it
, w
, &row
->start
);
2863 it
->start
= row
->start
;
2864 it
->continuation_lines_width
= row
->continuation_lines_width
;
2869 /* Initialize IT for stepping through current_buffer in window W
2870 starting in the line following ROW, i.e. starting at ROW->end.
2871 Value is zero if there are overlay strings with newlines at ROW's
2875 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2879 if (init_from_display_pos (it
, w
, &row
->end
))
2881 if (row
->continued_p
)
2882 it
->continuation_lines_width
2883 = row
->continuation_lines_width
+ row
->pixel_width
;
2894 /***********************************************************************
2896 ***********************************************************************/
2898 /* Called when IT reaches IT->stop_charpos. Handle text property and
2899 overlay changes. Set IT->stop_charpos to the next position where
2903 handle_stop (struct it
*it
)
2905 enum prop_handled handled
;
2906 int handle_overlay_change_p
;
2910 it
->current
.dpvec_index
= -1;
2911 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2912 it
->ignore_overlay_strings_at_pos_p
= 0;
2915 /* Use face of preceding text for ellipsis (if invisible) */
2916 if (it
->selective_display_ellipsis_p
)
2917 it
->saved_face_id
= it
->face_id
;
2921 handled
= HANDLED_NORMALLY
;
2923 /* Call text property handlers. */
2924 for (p
= it_props
; p
->handler
; ++p
)
2926 handled
= p
->handler (it
);
2928 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2930 else if (handled
== HANDLED_RETURN
)
2932 /* We still want to show before and after strings from
2933 overlays even if the actual buffer text is replaced. */
2934 if (!handle_overlay_change_p
2936 || !get_overlay_strings_1 (it
, 0, 0))
2939 setup_for_ellipsis (it
, 0);
2940 /* When handling a display spec, we might load an
2941 empty string. In that case, discard it here. We
2942 used to discard it in handle_single_display_spec,
2943 but that causes get_overlay_strings_1, above, to
2944 ignore overlay strings that we must check. */
2945 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2949 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2953 it
->ignore_overlay_strings_at_pos_p
= 1;
2954 it
->string_from_display_prop_p
= 0;
2955 it
->from_disp_prop_p
= 0;
2956 handle_overlay_change_p
= 0;
2958 handled
= HANDLED_RECOMPUTE_PROPS
;
2961 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2962 handle_overlay_change_p
= 0;
2965 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2967 /* Don't check for overlay strings below when set to deliver
2968 characters from a display vector. */
2969 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2970 handle_overlay_change_p
= 0;
2972 /* Handle overlay changes.
2973 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2974 if it finds overlays. */
2975 if (handle_overlay_change_p
)
2976 handled
= handle_overlay_change (it
);
2981 setup_for_ellipsis (it
, 0);
2985 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2987 /* Determine where to stop next. */
2988 if (handled
== HANDLED_NORMALLY
)
2989 compute_stop_pos (it
);
2993 /* Compute IT->stop_charpos from text property and overlay change
2994 information for IT's current position. */
2997 compute_stop_pos (struct it
*it
)
2999 register INTERVAL iv
, next_iv
;
3000 Lisp_Object object
, limit
, position
;
3001 EMACS_INT charpos
, bytepos
;
3003 /* If nowhere else, stop at the end. */
3004 it
->stop_charpos
= it
->end_charpos
;
3006 if (STRINGP (it
->string
))
3008 /* Strings are usually short, so don't limit the search for
3010 object
= it
->string
;
3012 charpos
= IT_STRING_CHARPOS (*it
);
3013 bytepos
= IT_STRING_BYTEPOS (*it
);
3019 /* If next overlay change is in front of the current stop pos
3020 (which is IT->end_charpos), stop there. Note: value of
3021 next_overlay_change is point-max if no overlay change
3023 charpos
= IT_CHARPOS (*it
);
3024 bytepos
= IT_BYTEPOS (*it
);
3025 pos
= next_overlay_change (charpos
);
3026 if (pos
< it
->stop_charpos
)
3027 it
->stop_charpos
= pos
;
3029 /* If showing the region, we have to stop at the region
3030 start or end because the face might change there. */
3031 if (it
->region_beg_charpos
> 0)
3033 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3034 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3035 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3036 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3039 /* Set up variables for computing the stop position from text
3040 property changes. */
3041 XSETBUFFER (object
, current_buffer
);
3042 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3045 /* Get the interval containing IT's position. Value is a null
3046 interval if there isn't such an interval. */
3047 position
= make_number (charpos
);
3048 iv
= validate_interval_range (object
, &position
, &position
, 0);
3049 if (!NULL_INTERVAL_P (iv
))
3051 Lisp_Object values_here
[LAST_PROP_IDX
];
3054 /* Get properties here. */
3055 for (p
= it_props
; p
->handler
; ++p
)
3056 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3058 /* Look for an interval following iv that has different
3060 for (next_iv
= next_interval (iv
);
3061 (!NULL_INTERVAL_P (next_iv
)
3063 || XFASTINT (limit
) > next_iv
->position
));
3064 next_iv
= next_interval (next_iv
))
3066 for (p
= it_props
; p
->handler
; ++p
)
3068 Lisp_Object new_value
;
3070 new_value
= textget (next_iv
->plist
, *p
->name
);
3071 if (!EQ (values_here
[p
->idx
], new_value
))
3079 if (!NULL_INTERVAL_P (next_iv
))
3081 if (INTEGERP (limit
)
3082 && next_iv
->position
>= XFASTINT (limit
))
3083 /* No text property change up to limit. */
3084 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3086 /* Text properties change in next_iv. */
3087 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3091 if (it
->cmp_it
.id
< 0)
3093 EMACS_INT stoppos
= it
->end_charpos
;
3095 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3097 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3098 stoppos
, it
->string
);
3101 xassert (STRINGP (it
->string
)
3102 || (it
->stop_charpos
>= BEGV
3103 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3107 /* Return the position of the next overlay change after POS in
3108 current_buffer. Value is point-max if no overlay change
3109 follows. This is like `next-overlay-change' but doesn't use
3113 next_overlay_change (EMACS_INT pos
)
3115 ptrdiff_t i
, noverlays
;
3117 Lisp_Object
*overlays
;
3119 /* Get all overlays at the given position. */
3120 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3122 /* If any of these overlays ends before endpos,
3123 use its ending point instead. */
3124 for (i
= 0; i
< noverlays
; ++i
)
3129 oend
= OVERLAY_END (overlays
[i
]);
3130 oendpos
= OVERLAY_POSITION (oend
);
3131 endpos
= min (endpos
, oendpos
);
3137 /* How many characters forward to search for a display property or
3138 display string. Enough for a screenful of 100 lines x 50
3139 characters in a line. */
3140 #define MAX_DISP_SCAN 5000
3142 /* Return the character position of a display string at or after
3143 position specified by POSITION. If no display string exists at or
3144 after POSITION, return ZV. A display string is either an overlay
3145 with `display' property whose value is a string, or a `display'
3146 text property whose value is a string. STRING is data about the
3147 string to iterate; if STRING->lstring is nil, we are iterating a
3148 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3151 compute_display_string_pos (struct text_pos
*position
,
3152 struct bidi_string_data
*string
,
3153 int frame_window_p
, int *disp_prop_p
)
3155 /* OBJECT = nil means current buffer. */
3156 Lisp_Object object
=
3157 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3158 Lisp_Object pos
, spec
, limpos
;
3159 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3160 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3161 EMACS_INT begb
= string_p
? 0 : BEGV
;
3162 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3164 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3165 struct text_pos tpos
;
3170 /* We don't support display properties whose values are strings
3171 that have display string properties. */
3172 || string
->from_disp_str
3173 /* C strings cannot have display properties. */
3174 || (string
->s
&& !STRINGP (object
)))
3180 /* If the character at CHARPOS is where the display string begins,
3182 pos
= make_number (charpos
);
3183 if (STRINGP (object
))
3184 bufpos
= string
->bufpos
;
3188 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3190 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3193 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3199 /* Look forward for the first character with a `display' property
3200 that will replace the underlying text when displayed. */
3201 limpos
= make_number (lim
);
3203 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3204 CHARPOS (tpos
) = XFASTINT (pos
);
3205 if (CHARPOS (tpos
) >= lim
)
3210 if (STRINGP (object
))
3211 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3213 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3214 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3215 if (!STRINGP (object
))
3216 bufpos
= CHARPOS (tpos
);
3217 } while (NILP (spec
)
3218 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3221 return CHARPOS (tpos
);
3224 /* Return the character position of the end of the display string that
3225 started at CHARPOS. A display string is either an overlay with
3226 `display' property whose value is a string or a `display' text
3227 property whose value is a string. */
3229 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3231 /* OBJECT = nil means current buffer. */
3232 Lisp_Object object
=
3233 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3234 Lisp_Object pos
= make_number (charpos
);
3236 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3238 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3241 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3244 /* Look forward for the first character where the `display' property
3246 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3248 return XFASTINT (pos
);
3253 /***********************************************************************
3255 ***********************************************************************/
3257 /* Handle changes in the `fontified' property of the current buffer by
3258 calling hook functions from Qfontification_functions to fontify
3261 static enum prop_handled
3262 handle_fontified_prop (struct it
*it
)
3264 Lisp_Object prop
, pos
;
3265 enum prop_handled handled
= HANDLED_NORMALLY
;
3267 if (!NILP (Vmemory_full
))
3270 /* Get the value of the `fontified' property at IT's current buffer
3271 position. (The `fontified' property doesn't have a special
3272 meaning in strings.) If the value is nil, call functions from
3273 Qfontification_functions. */
3274 if (!STRINGP (it
->string
)
3276 && !NILP (Vfontification_functions
)
3277 && !NILP (Vrun_hooks
)
3278 && (pos
= make_number (IT_CHARPOS (*it
)),
3279 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3280 /* Ignore the special cased nil value always present at EOB since
3281 no amount of fontifying will be able to change it. */
3282 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3284 int count
= SPECPDL_INDEX ();
3286 struct buffer
*obuf
= current_buffer
;
3287 int begv
= BEGV
, zv
= ZV
;
3288 int old_clip_changed
= current_buffer
->clip_changed
;
3290 val
= Vfontification_functions
;
3291 specbind (Qfontification_functions
, Qnil
);
3293 xassert (it
->end_charpos
== ZV
);
3295 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3296 safe_call1 (val
, pos
);
3299 Lisp_Object fns
, fn
;
3300 struct gcpro gcpro1
, gcpro2
;
3305 for (; CONSP (val
); val
= XCDR (val
))
3311 /* A value of t indicates this hook has a local
3312 binding; it means to run the global binding too.
3313 In a global value, t should not occur. If it
3314 does, we must ignore it to avoid an endless
3316 for (fns
= Fdefault_value (Qfontification_functions
);
3322 safe_call1 (fn
, pos
);
3326 safe_call1 (fn
, pos
);
3332 unbind_to (count
, Qnil
);
3334 /* Fontification functions routinely call `save-restriction'.
3335 Normally, this tags clip_changed, which can confuse redisplay
3336 (see discussion in Bug#6671). Since we don't perform any
3337 special handling of fontification changes in the case where
3338 `save-restriction' isn't called, there's no point doing so in
3339 this case either. So, if the buffer's restrictions are
3340 actually left unchanged, reset clip_changed. */
3341 if (obuf
== current_buffer
)
3343 if (begv
== BEGV
&& zv
== ZV
)
3344 current_buffer
->clip_changed
= old_clip_changed
;
3346 /* There isn't much we can reasonably do to protect against
3347 misbehaving fontification, but here's a fig leaf. */
3348 else if (!NILP (BVAR (obuf
, name
)))
3349 set_buffer_internal_1 (obuf
);
3351 /* The fontification code may have added/removed text.
3352 It could do even a lot worse, but let's at least protect against
3353 the most obvious case where only the text past `pos' gets changed',
3354 as is/was done in grep.el where some escapes sequences are turned
3355 into face properties (bug#7876). */
3356 it
->end_charpos
= ZV
;
3358 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3359 something. This avoids an endless loop if they failed to
3360 fontify the text for which reason ever. */
3361 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3362 handled
= HANDLED_RECOMPUTE_PROPS
;
3370 /***********************************************************************
3372 ***********************************************************************/
3374 /* Set up iterator IT from face properties at its current position.
3375 Called from handle_stop. */
3377 static enum prop_handled
3378 handle_face_prop (struct it
*it
)
3381 EMACS_INT next_stop
;
3383 if (!STRINGP (it
->string
))
3386 = face_at_buffer_position (it
->w
,
3388 it
->region_beg_charpos
,
3389 it
->region_end_charpos
,
3392 + TEXT_PROP_DISTANCE_LIMIT
),
3393 0, it
->base_face_id
);
3395 /* Is this a start of a run of characters with box face?
3396 Caveat: this can be called for a freshly initialized
3397 iterator; face_id is -1 in this case. We know that the new
3398 face will not change until limit, i.e. if the new face has a
3399 box, all characters up to limit will have one. But, as
3400 usual, we don't know whether limit is really the end. */
3401 if (new_face_id
!= it
->face_id
)
3403 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3405 /* If new face has a box but old face has not, this is
3406 the start of a run of characters with box, i.e. it has
3407 a shadow on the left side. The value of face_id of the
3408 iterator will be -1 if this is the initial call that gets
3409 the face. In this case, we have to look in front of IT's
3410 position and see whether there is a face != new_face_id. */
3411 it
->start_of_box_run_p
3412 = (new_face
->box
!= FACE_NO_BOX
3413 && (it
->face_id
>= 0
3414 || IT_CHARPOS (*it
) == BEG
3415 || new_face_id
!= face_before_it_pos (it
)));
3416 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3424 Lisp_Object from_overlay
3425 = (it
->current
.overlay_string_index
>= 0
3426 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3429 /* See if we got to this string directly or indirectly from
3430 an overlay property. That includes the before-string or
3431 after-string of an overlay, strings in display properties
3432 provided by an overlay, their text properties, etc.
3434 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3435 if (! NILP (from_overlay
))
3436 for (i
= it
->sp
- 1; i
>= 0; i
--)
3438 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3440 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3441 else if (! NILP (it
->stack
[i
].from_overlay
))
3442 from_overlay
= it
->stack
[i
].from_overlay
;
3444 if (!NILP (from_overlay
))
3448 if (! NILP (from_overlay
))
3450 bufpos
= IT_CHARPOS (*it
);
3451 /* For a string from an overlay, the base face depends
3452 only on text properties and ignores overlays. */
3454 = face_for_overlay_string (it
->w
,
3456 it
->region_beg_charpos
,
3457 it
->region_end_charpos
,
3460 + TEXT_PROP_DISTANCE_LIMIT
),
3468 /* For strings from a `display' property, use the face at
3469 IT's current buffer position as the base face to merge
3470 with, so that overlay strings appear in the same face as
3471 surrounding text, unless they specify their own
3473 base_face_id
= underlying_face_id (it
);
3476 new_face_id
= face_at_string_position (it
->w
,
3478 IT_STRING_CHARPOS (*it
),
3480 it
->region_beg_charpos
,
3481 it
->region_end_charpos
,
3485 /* Is this a start of a run of characters with box? Caveat:
3486 this can be called for a freshly allocated iterator; face_id
3487 is -1 is this case. We know that the new face will not
3488 change until the next check pos, i.e. if the new face has a
3489 box, all characters up to that position will have a
3490 box. But, as usual, we don't know whether that position
3491 is really the end. */
3492 if (new_face_id
!= it
->face_id
)
3494 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3495 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3497 /* If new face has a box but old face hasn't, this is the
3498 start of a run of characters with box, i.e. it has a
3499 shadow on the left side. */
3500 it
->start_of_box_run_p
3501 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3502 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3506 it
->face_id
= new_face_id
;
3507 return HANDLED_NORMALLY
;
3511 /* Return the ID of the face ``underlying'' IT's current position,
3512 which is in a string. If the iterator is associated with a
3513 buffer, return the face at IT's current buffer position.
3514 Otherwise, use the iterator's base_face_id. */
3517 underlying_face_id (struct it
*it
)
3519 int face_id
= it
->base_face_id
, i
;
3521 xassert (STRINGP (it
->string
));
3523 for (i
= it
->sp
- 1; i
>= 0; --i
)
3524 if (NILP (it
->stack
[i
].string
))
3525 face_id
= it
->stack
[i
].face_id
;
3531 /* Compute the face one character before or after the current position
3532 of IT, in the visual order. BEFORE_P non-zero means get the face
3533 in front (to the left in L2R paragraphs, to the right in R2L
3534 paragraphs) of IT's screen position. Value is the ID of the face. */
3537 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3540 EMACS_INT next_check_charpos
;
3542 void *it_copy_data
= NULL
;
3544 xassert (it
->s
== NULL
);
3546 if (STRINGP (it
->string
))
3548 EMACS_INT bufpos
, charpos
;
3551 /* No face change past the end of the string (for the case
3552 we are padding with spaces). No face change before the
3554 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3555 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3560 /* Set charpos to the position before or after IT's current
3561 position, in the logical order, which in the non-bidi
3562 case is the same as the visual order. */
3564 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3565 else if (it
->what
== IT_COMPOSITION
)
3566 /* For composition, we must check the character after the
3568 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3570 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3576 /* With bidi iteration, the character before the current
3577 in the visual order cannot be found by simple
3578 iteration, because "reverse" reordering is not
3579 supported. Instead, we need to use the move_it_*
3580 family of functions. */
3581 /* Ignore face changes before the first visible
3582 character on this display line. */
3583 if (it
->current_x
<= it
->first_visible_x
)
3585 SAVE_IT (it_copy
, *it
, it_copy_data
);
3586 /* Implementation note: Since move_it_in_display_line
3587 works in the iterator geometry, and thinks the first
3588 character is always the leftmost, even in R2L lines,
3589 we don't need to distinguish between the R2L and L2R
3591 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3592 it_copy
.current_x
- 1, MOVE_TO_X
);
3593 charpos
= IT_STRING_CHARPOS (it_copy
);
3594 RESTORE_IT (it
, it
, it_copy_data
);
3598 /* Set charpos to the string position of the character
3599 that comes after IT's current position in the visual
3601 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3605 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3607 charpos
= it_copy
.bidi_it
.charpos
;
3610 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3612 if (it
->current
.overlay_string_index
>= 0)
3613 bufpos
= IT_CHARPOS (*it
);
3617 base_face_id
= underlying_face_id (it
);
3619 /* Get the face for ASCII, or unibyte. */
3620 face_id
= face_at_string_position (it
->w
,
3624 it
->region_beg_charpos
,
3625 it
->region_end_charpos
,
3626 &next_check_charpos
,
3629 /* Correct the face for charsets different from ASCII. Do it
3630 for the multibyte case only. The face returned above is
3631 suitable for unibyte text if IT->string is unibyte. */
3632 if (STRING_MULTIBYTE (it
->string
))
3634 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3635 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3637 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3639 c
= string_char_and_length (p
, &len
);
3640 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3645 struct text_pos pos
;
3647 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3648 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3651 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3652 pos
= it
->current
.pos
;
3657 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3660 if (it
->what
== IT_COMPOSITION
)
3662 /* For composition, we must check the position after
3664 pos
.charpos
+= it
->cmp_it
.nchars
;
3665 pos
.bytepos
+= it
->len
;
3668 INC_TEXT_POS (pos
, it
->multibyte_p
);
3675 /* With bidi iteration, the character before the current
3676 in the visual order cannot be found by simple
3677 iteration, because "reverse" reordering is not
3678 supported. Instead, we need to use the move_it_*
3679 family of functions. */
3680 /* Ignore face changes before the first visible
3681 character on this display line. */
3682 if (it
->current_x
<= it
->first_visible_x
)
3684 SAVE_IT (it_copy
, *it
, it_copy_data
);
3685 /* Implementation note: Since move_it_in_display_line
3686 works in the iterator geometry, and thinks the first
3687 character is always the leftmost, even in R2L lines,
3688 we don't need to distinguish between the R2L and L2R
3690 move_it_in_display_line (&it_copy
, ZV
,
3691 it_copy
.current_x
- 1, MOVE_TO_X
);
3692 pos
= it_copy
.current
.pos
;
3693 RESTORE_IT (it
, it
, it_copy_data
);
3697 /* Set charpos to the buffer position of the character
3698 that comes after IT's current position in the visual
3700 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3704 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3707 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3710 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3712 /* Determine face for CHARSET_ASCII, or unibyte. */
3713 face_id
= face_at_buffer_position (it
->w
,
3715 it
->region_beg_charpos
,
3716 it
->region_end_charpos
,
3717 &next_check_charpos
,
3720 /* Correct the face for charsets different from ASCII. Do it
3721 for the multibyte case only. The face returned above is
3722 suitable for unibyte text if current_buffer is unibyte. */
3723 if (it
->multibyte_p
)
3725 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3726 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3727 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3736 /***********************************************************************
3738 ***********************************************************************/
3740 /* Set up iterator IT from invisible properties at its current
3741 position. Called from handle_stop. */
3743 static enum prop_handled
3744 handle_invisible_prop (struct it
*it
)
3746 enum prop_handled handled
= HANDLED_NORMALLY
;
3748 if (STRINGP (it
->string
))
3750 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3752 /* Get the value of the invisible text property at the
3753 current position. Value will be nil if there is no such
3755 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3756 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3759 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3763 handled
= HANDLED_RECOMPUTE_PROPS
;
3765 /* Get the position at which the next change of the
3766 invisible text property can be found in IT->string.
3767 Value will be nil if the property value is the same for
3768 all the rest of IT->string. */
3769 XSETINT (limit
, SCHARS (it
->string
));
3770 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3773 /* Text at current position is invisible. The next
3774 change in the property is at position end_charpos.
3775 Move IT's current position to that position. */
3776 if (INTEGERP (end_charpos
)
3777 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3779 struct text_pos old
;
3782 old
= it
->current
.string_pos
;
3783 oldpos
= CHARPOS (old
);
3786 if (it
->bidi_it
.first_elt
3787 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3788 bidi_paragraph_init (it
->paragraph_embedding
,
3790 /* Bidi-iterate out of the invisible text. */
3793 bidi_move_to_visually_next (&it
->bidi_it
);
3795 while (oldpos
<= it
->bidi_it
.charpos
3796 && it
->bidi_it
.charpos
< endpos
);
3798 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3799 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3800 if (IT_CHARPOS (*it
) >= endpos
)
3801 it
->prev_stop
= endpos
;
3805 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3806 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3811 /* The rest of the string is invisible. If this is an
3812 overlay string, proceed with the next overlay string
3813 or whatever comes and return a character from there. */
3814 if (it
->current
.overlay_string_index
>= 0)
3816 next_overlay_string (it
);
3817 /* Don't check for overlay strings when we just
3818 finished processing them. */
3819 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3823 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3824 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3832 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3833 Lisp_Object pos
, prop
, overlay
;
3835 /* First of all, is there invisible text at this position? */
3836 tem
= start_charpos
= IT_CHARPOS (*it
);
3837 pos
= make_number (tem
);
3838 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3840 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3842 /* If we are on invisible text, skip over it. */
3843 if (invis_p
&& start_charpos
< it
->end_charpos
)
3845 /* Record whether we have to display an ellipsis for the
3847 int display_ellipsis_p
= invis_p
== 2;
3849 handled
= HANDLED_RECOMPUTE_PROPS
;
3851 /* Loop skipping over invisible text. The loop is left at
3852 ZV or with IT on the first char being visible again. */
3855 /* Try to skip some invisible text. Return value is the
3856 position reached which can be equal to where we start
3857 if there is nothing invisible there. This skips both
3858 over invisible text properties and overlays with
3859 invisible property. */
3860 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3862 /* If we skipped nothing at all we weren't at invisible
3863 text in the first place. If everything to the end of
3864 the buffer was skipped, end the loop. */
3865 if (newpos
== tem
|| newpos
>= ZV
)
3869 /* We skipped some characters but not necessarily
3870 all there are. Check if we ended up on visible
3871 text. Fget_char_property returns the property of
3872 the char before the given position, i.e. if we
3873 get invis_p = 0, this means that the char at
3874 newpos is visible. */
3875 pos
= make_number (newpos
);
3876 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3877 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3880 /* If we ended up on invisible text, proceed to
3881 skip starting with next_stop. */
3885 /* If there are adjacent invisible texts, don't lose the
3886 second one's ellipsis. */
3888 display_ellipsis_p
= 1;
3892 /* The position newpos is now either ZV or on visible text. */
3893 if (it
->bidi_p
&& newpos
< ZV
)
3895 /* With bidi iteration, the region of invisible text
3896 could start and/or end in the middle of a non-base
3897 embedding level. Therefore, we need to skip
3898 invisible text using the bidi iterator, starting at
3899 IT's current position, until we find ourselves
3900 outside the invisible text. Skipping invisible text
3901 _after_ bidi iteration avoids affecting the visual
3902 order of the displayed text when invisible properties
3903 are added or removed. */
3904 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3906 /* If we were `reseat'ed to a new paragraph,
3907 determine the paragraph base direction. We need
3908 to do it now because next_element_from_buffer may
3909 not have a chance to do it, if we are going to
3910 skip any text at the beginning, which resets the
3912 bidi_paragraph_init (it
->paragraph_embedding
,
3917 bidi_move_to_visually_next (&it
->bidi_it
);
3919 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3920 && it
->bidi_it
.charpos
< newpos
);
3921 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3922 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3923 /* If we overstepped NEWPOS, record its position in the
3924 iterator, so that we skip invisible text if later the
3925 bidi iteration lands us in the invisible region
3927 if (IT_CHARPOS (*it
) >= newpos
)
3928 it
->prev_stop
= newpos
;
3932 IT_CHARPOS (*it
) = newpos
;
3933 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3936 /* If there are before-strings at the start of invisible
3937 text, and the text is invisible because of a text
3938 property, arrange to show before-strings because 20.x did
3939 it that way. (If the text is invisible because of an
3940 overlay property instead of a text property, this is
3941 already handled in the overlay code.) */
3943 && get_overlay_strings (it
, it
->stop_charpos
))
3945 handled
= HANDLED_RECOMPUTE_PROPS
;
3946 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3948 else if (display_ellipsis_p
)
3950 /* Make sure that the glyphs of the ellipsis will get
3951 correct `charpos' values. If we would not update
3952 it->position here, the glyphs would belong to the
3953 last visible character _before_ the invisible
3954 text, which confuses `set_cursor_from_row'.
3956 We use the last invisible position instead of the
3957 first because this way the cursor is always drawn on
3958 the first "." of the ellipsis, whenever PT is inside
3959 the invisible text. Otherwise the cursor would be
3960 placed _after_ the ellipsis when the point is after the
3961 first invisible character. */
3962 if (!STRINGP (it
->object
))
3964 it
->position
.charpos
= newpos
- 1;
3965 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3968 /* Let the ellipsis display before
3969 considering any properties of the following char.
3970 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3971 handled
= HANDLED_RETURN
;
3980 /* Make iterator IT return `...' next.
3981 Replaces LEN characters from buffer. */
3984 setup_for_ellipsis (struct it
*it
, int len
)
3986 /* Use the display table definition for `...'. Invalid glyphs
3987 will be handled by the method returning elements from dpvec. */
3988 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3990 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3991 it
->dpvec
= v
->contents
;
3992 it
->dpend
= v
->contents
+ v
->header
.size
;
3996 /* Default `...'. */
3997 it
->dpvec
= default_invis_vector
;
3998 it
->dpend
= default_invis_vector
+ 3;
4001 it
->dpvec_char_len
= len
;
4002 it
->current
.dpvec_index
= 0;
4003 it
->dpvec_face_id
= -1;
4005 /* Remember the current face id in case glyphs specify faces.
4006 IT's face is restored in set_iterator_to_next.
4007 saved_face_id was set to preceding char's face in handle_stop. */
4008 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4009 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4011 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4017 /***********************************************************************
4019 ***********************************************************************/
4021 /* Set up iterator IT from `display' property at its current position.
4022 Called from handle_stop.
4023 We return HANDLED_RETURN if some part of the display property
4024 overrides the display of the buffer text itself.
4025 Otherwise we return HANDLED_NORMALLY. */
4027 static enum prop_handled
4028 handle_display_prop (struct it
*it
)
4030 Lisp_Object propval
, object
, overlay
;
4031 struct text_pos
*position
;
4033 /* Nonzero if some property replaces the display of the text itself. */
4034 int display_replaced_p
= 0;
4036 if (STRINGP (it
->string
))
4038 object
= it
->string
;
4039 position
= &it
->current
.string_pos
;
4040 bufpos
= CHARPOS (it
->current
.pos
);
4044 XSETWINDOW (object
, it
->w
);
4045 position
= &it
->current
.pos
;
4046 bufpos
= CHARPOS (*position
);
4049 /* Reset those iterator values set from display property values. */
4050 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4051 it
->space_width
= Qnil
;
4052 it
->font_height
= Qnil
;
4055 /* We don't support recursive `display' properties, i.e. string
4056 values that have a string `display' property, that have a string
4057 `display' property etc. */
4058 if (!it
->string_from_display_prop_p
)
4059 it
->area
= TEXT_AREA
;
4061 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4062 Qdisplay
, object
, &overlay
);
4064 return HANDLED_NORMALLY
;
4065 /* Now OVERLAY is the overlay that gave us this property, or nil
4066 if it was a text property. */
4068 if (!STRINGP (it
->string
))
4069 object
= it
->w
->buffer
;
4071 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4073 FRAME_WINDOW_P (it
->f
));
4075 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4078 /* Subroutine of handle_display_prop. Returns non-zero if the display
4079 specification in SPEC is a replacing specification, i.e. it would
4080 replace the text covered by `display' property with something else,
4081 such as an image or a display string.
4083 See handle_single_display_spec for documentation of arguments.
4084 frame_window_p is non-zero if the window being redisplayed is on a
4085 GUI frame; this argument is used only if IT is NULL, see below.
4087 IT can be NULL, if this is called by the bidi reordering code
4088 through compute_display_string_pos, which see. In that case, this
4089 function only examines SPEC, but does not otherwise "handle" it, in
4090 the sense that it doesn't set up members of IT from the display
4093 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4094 Lisp_Object overlay
, struct text_pos
*position
,
4095 EMACS_INT bufpos
, int frame_window_p
)
4097 int replacing_p
= 0;
4100 /* Simple specerties. */
4101 && !EQ (XCAR (spec
), Qimage
)
4102 && !EQ (XCAR (spec
), Qspace
)
4103 && !EQ (XCAR (spec
), Qwhen
)
4104 && !EQ (XCAR (spec
), Qslice
)
4105 && !EQ (XCAR (spec
), Qspace_width
)
4106 && !EQ (XCAR (spec
), Qheight
)
4107 && !EQ (XCAR (spec
), Qraise
)
4108 /* Marginal area specifications. */
4109 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4110 && !EQ (XCAR (spec
), Qleft_fringe
)
4111 && !EQ (XCAR (spec
), Qright_fringe
)
4112 && !NILP (XCAR (spec
)))
4114 for (; CONSP (spec
); spec
= XCDR (spec
))
4116 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4117 position
, bufpos
, replacing_p
,
4121 /* If some text in a string is replaced, `position' no
4122 longer points to the position of `object'. */
4123 if (!it
|| STRINGP (object
))
4128 else if (VECTORP (spec
))
4131 for (i
= 0; i
< ASIZE (spec
); ++i
)
4132 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4133 position
, bufpos
, replacing_p
,
4137 /* If some text in a string is replaced, `position' no
4138 longer points to the position of `object'. */
4139 if (!it
|| STRINGP (object
))
4145 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4146 position
, bufpos
, 0, frame_window_p
))
4153 /* Value is the position of the end of the `display' property starting
4154 at START_POS in OBJECT. */
4156 static struct text_pos
4157 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4160 struct text_pos end_pos
;
4162 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4163 Qdisplay
, object
, Qnil
);
4164 CHARPOS (end_pos
) = XFASTINT (end
);
4165 if (STRINGP (object
))
4166 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4168 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4174 /* Set up IT from a single `display' property specification SPEC. OBJECT
4175 is the object in which the `display' property was found. *POSITION
4176 is the position in OBJECT at which the `display' property was found.
4177 BUFPOS is the buffer position of OBJECT (different from POSITION if
4178 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4179 previously saw a display specification which already replaced text
4180 display with something else, for example an image; we ignore such
4181 properties after the first one has been processed.
4183 OVERLAY is the overlay this `display' property came from,
4184 or nil if it was a text property.
4186 If SPEC is a `space' or `image' specification, and in some other
4187 cases too, set *POSITION to the position where the `display'
4190 If IT is NULL, only examine the property specification in SPEC, but
4191 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4192 is intended to be displayed in a window on a GUI frame.
4194 Value is non-zero if something was found which replaces the display
4195 of buffer or string text. */
4198 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4199 Lisp_Object overlay
, struct text_pos
*position
,
4200 EMACS_INT bufpos
, int display_replaced_p
,
4204 Lisp_Object location
, value
;
4205 struct text_pos start_pos
= *position
;
4208 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4209 If the result is non-nil, use VALUE instead of SPEC. */
4211 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4220 if (!NILP (form
) && !EQ (form
, Qt
))
4222 int count
= SPECPDL_INDEX ();
4223 struct gcpro gcpro1
;
4225 /* Bind `object' to the object having the `display' property, a
4226 buffer or string. Bind `position' to the position in the
4227 object where the property was found, and `buffer-position'
4228 to the current position in the buffer. */
4231 XSETBUFFER (object
, current_buffer
);
4232 specbind (Qobject
, object
);
4233 specbind (Qposition
, make_number (CHARPOS (*position
)));
4234 specbind (Qbuffer_position
, make_number (bufpos
));
4236 form
= safe_eval (form
);
4238 unbind_to (count
, Qnil
);
4244 /* Handle `(height HEIGHT)' specifications. */
4246 && EQ (XCAR (spec
), Qheight
)
4247 && CONSP (XCDR (spec
)))
4251 if (!FRAME_WINDOW_P (it
->f
))
4254 it
->font_height
= XCAR (XCDR (spec
));
4255 if (!NILP (it
->font_height
))
4257 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4258 int new_height
= -1;
4260 if (CONSP (it
->font_height
)
4261 && (EQ (XCAR (it
->font_height
), Qplus
)
4262 || EQ (XCAR (it
->font_height
), Qminus
))
4263 && CONSP (XCDR (it
->font_height
))
4264 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4266 /* `(+ N)' or `(- N)' where N is an integer. */
4267 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4268 if (EQ (XCAR (it
->font_height
), Qplus
))
4270 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4272 else if (FUNCTIONP (it
->font_height
))
4274 /* Call function with current height as argument.
4275 Value is the new height. */
4277 height
= safe_call1 (it
->font_height
,
4278 face
->lface
[LFACE_HEIGHT_INDEX
]);
4279 if (NUMBERP (height
))
4280 new_height
= XFLOATINT (height
);
4282 else if (NUMBERP (it
->font_height
))
4284 /* Value is a multiple of the canonical char height. */
4287 f
= FACE_FROM_ID (it
->f
,
4288 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4289 new_height
= (XFLOATINT (it
->font_height
)
4290 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4294 /* Evaluate IT->font_height with `height' bound to the
4295 current specified height to get the new height. */
4296 int count
= SPECPDL_INDEX ();
4298 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4299 value
= safe_eval (it
->font_height
);
4300 unbind_to (count
, Qnil
);
4302 if (NUMBERP (value
))
4303 new_height
= XFLOATINT (value
);
4307 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4314 /* Handle `(space-width WIDTH)'. */
4316 && EQ (XCAR (spec
), Qspace_width
)
4317 && CONSP (XCDR (spec
)))
4321 if (!FRAME_WINDOW_P (it
->f
))
4324 value
= XCAR (XCDR (spec
));
4325 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4326 it
->space_width
= value
;
4332 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4334 && EQ (XCAR (spec
), Qslice
))
4340 if (!FRAME_WINDOW_P (it
->f
))
4343 if (tem
= XCDR (spec
), CONSP (tem
))
4345 it
->slice
.x
= XCAR (tem
);
4346 if (tem
= XCDR (tem
), CONSP (tem
))
4348 it
->slice
.y
= XCAR (tem
);
4349 if (tem
= XCDR (tem
), CONSP (tem
))
4351 it
->slice
.width
= XCAR (tem
);
4352 if (tem
= XCDR (tem
), CONSP (tem
))
4353 it
->slice
.height
= XCAR (tem
);
4362 /* Handle `(raise FACTOR)'. */
4364 && EQ (XCAR (spec
), Qraise
)
4365 && CONSP (XCDR (spec
)))
4369 if (!FRAME_WINDOW_P (it
->f
))
4372 #ifdef HAVE_WINDOW_SYSTEM
4373 value
= XCAR (XCDR (spec
));
4374 if (NUMBERP (value
))
4376 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4377 it
->voffset
= - (XFLOATINT (value
)
4378 * (FONT_HEIGHT (face
->font
)));
4380 #endif /* HAVE_WINDOW_SYSTEM */
4386 /* Don't handle the other kinds of display specifications
4387 inside a string that we got from a `display' property. */
4388 if (it
&& it
->string_from_display_prop_p
)
4391 /* Characters having this form of property are not displayed, so
4392 we have to find the end of the property. */
4395 start_pos
= *position
;
4396 *position
= display_prop_end (it
, object
, start_pos
);
4400 /* Stop the scan at that end position--we assume that all
4401 text properties change there. */
4403 it
->stop_charpos
= position
->charpos
;
4405 /* Handle `(left-fringe BITMAP [FACE])'
4406 and `(right-fringe BITMAP [FACE])'. */
4408 && (EQ (XCAR (spec
), Qleft_fringe
)
4409 || EQ (XCAR (spec
), Qright_fringe
))
4410 && CONSP (XCDR (spec
)))
4416 if (!FRAME_WINDOW_P (it
->f
))
4417 /* If we return here, POSITION has been advanced
4418 across the text with this property. */
4421 else if (!frame_window_p
)
4424 #ifdef HAVE_WINDOW_SYSTEM
4425 value
= XCAR (XCDR (spec
));
4426 if (!SYMBOLP (value
)
4427 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4428 /* If we return here, POSITION has been advanced
4429 across the text with this property. */
4434 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4436 if (CONSP (XCDR (XCDR (spec
))))
4438 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4439 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4445 /* Save current settings of IT so that we can restore them
4446 when we are finished with the glyph property value. */
4447 push_it (it
, position
);
4449 it
->area
= TEXT_AREA
;
4450 it
->what
= IT_IMAGE
;
4451 it
->image_id
= -1; /* no image */
4452 it
->position
= start_pos
;
4453 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4454 it
->method
= GET_FROM_IMAGE
;
4455 it
->from_overlay
= Qnil
;
4456 it
->face_id
= face_id
;
4457 it
->from_disp_prop_p
= 1;
4459 /* Say that we haven't consumed the characters with
4460 `display' property yet. The call to pop_it in
4461 set_iterator_to_next will clean this up. */
4462 *position
= start_pos
;
4464 if (EQ (XCAR (spec
), Qleft_fringe
))
4466 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4467 it
->left_user_fringe_face_id
= face_id
;
4471 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4472 it
->right_user_fringe_face_id
= face_id
;
4475 #endif /* HAVE_WINDOW_SYSTEM */
4479 /* Prepare to handle `((margin left-margin) ...)',
4480 `((margin right-margin) ...)' and `((margin nil) ...)'
4481 prefixes for display specifications. */
4482 location
= Qunbound
;
4483 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4487 value
= XCDR (spec
);
4489 value
= XCAR (value
);
4492 if (EQ (XCAR (tem
), Qmargin
)
4493 && (tem
= XCDR (tem
),
4494 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4496 || EQ (tem
, Qleft_margin
)
4497 || EQ (tem
, Qright_margin
))))
4501 if (EQ (location
, Qunbound
))
4507 /* After this point, VALUE is the property after any
4508 margin prefix has been stripped. It must be a string,
4509 an image specification, or `(space ...)'.
4511 LOCATION specifies where to display: `left-margin',
4512 `right-margin' or nil. */
4514 valid_p
= (STRINGP (value
)
4515 #ifdef HAVE_WINDOW_SYSTEM
4516 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4517 && valid_image_p (value
))
4518 #endif /* not HAVE_WINDOW_SYSTEM */
4519 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4521 if (valid_p
&& !display_replaced_p
)
4526 /* Save current settings of IT so that we can restore them
4527 when we are finished with the glyph property value. */
4528 push_it (it
, position
);
4529 it
->from_overlay
= overlay
;
4530 it
->from_disp_prop_p
= 1;
4532 if (NILP (location
))
4533 it
->area
= TEXT_AREA
;
4534 else if (EQ (location
, Qleft_margin
))
4535 it
->area
= LEFT_MARGIN_AREA
;
4537 it
->area
= RIGHT_MARGIN_AREA
;
4539 if (STRINGP (value
))
4542 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4543 it
->current
.overlay_string_index
= -1;
4544 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4545 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4546 it
->method
= GET_FROM_STRING
;
4547 it
->stop_charpos
= 0;
4549 it
->base_level_stop
= 0;
4550 it
->string_from_display_prop_p
= 1;
4551 /* Say that we haven't consumed the characters with
4552 `display' property yet. The call to pop_it in
4553 set_iterator_to_next will clean this up. */
4554 if (BUFFERP (object
))
4555 *position
= start_pos
;
4557 /* Force paragraph direction to be that of the parent
4558 object. If the parent object's paragraph direction is
4559 not yet determined, default to L2R. */
4560 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4561 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4563 it
->paragraph_embedding
= L2R
;
4565 /* Set up the bidi iterator for this display string. */
4568 it
->bidi_it
.string
.lstring
= it
->string
;
4569 it
->bidi_it
.string
.s
= NULL
;
4570 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4571 it
->bidi_it
.string
.bufpos
= bufpos
;
4572 it
->bidi_it
.string
.from_disp_str
= 1;
4573 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4574 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4577 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4579 it
->method
= GET_FROM_STRETCH
;
4581 *position
= it
->position
= start_pos
;
4583 #ifdef HAVE_WINDOW_SYSTEM
4586 it
->what
= IT_IMAGE
;
4587 it
->image_id
= lookup_image (it
->f
, value
);
4588 it
->position
= start_pos
;
4589 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4590 it
->method
= GET_FROM_IMAGE
;
4592 /* Say that we haven't consumed the characters with
4593 `display' property yet. The call to pop_it in
4594 set_iterator_to_next will clean this up. */
4595 *position
= start_pos
;
4597 #endif /* HAVE_WINDOW_SYSTEM */
4602 /* Invalid property or property not supported. Restore
4603 POSITION to what it was before. */
4604 *position
= start_pos
;
4608 /* Check if PROP is a display property value whose text should be
4609 treated as intangible. OVERLAY is the overlay from which PROP
4610 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4611 specify the buffer position covered by PROP. */
4614 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4615 EMACS_INT charpos
, EMACS_INT bytepos
)
4617 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4618 struct text_pos position
;
4620 SET_TEXT_POS (position
, charpos
, bytepos
);
4621 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4622 &position
, charpos
, frame_window_p
);
4626 /* Return 1 if PROP is a display sub-property value containing STRING.
4628 Implementation note: this and the following function are really
4629 special cases of handle_display_spec and
4630 handle_single_display_spec, and should ideally use the same code.
4631 Until they do, these two pairs must be consistent and must be
4632 modified in sync. */
4635 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4637 if (EQ (string
, prop
))
4640 /* Skip over `when FORM'. */
4641 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4646 /* Actually, the condition following `when' should be eval'ed,
4647 like handle_single_display_spec does, and we should return
4648 zero if it evaluates to nil. However, this function is
4649 called only when the buffer was already displayed and some
4650 glyph in the glyph matrix was found to come from a display
4651 string. Therefore, the condition was already evaluated, and
4652 the result was non-nil, otherwise the display string wouldn't
4653 have been displayed and we would have never been called for
4654 this property. Thus, we can skip the evaluation and assume
4655 its result is non-nil. */
4660 /* Skip over `margin LOCATION'. */
4661 if (EQ (XCAR (prop
), Qmargin
))
4672 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4676 /* Return 1 if STRING appears in the `display' property PROP. */
4679 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4682 && !EQ (XCAR (prop
), Qwhen
)
4683 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4685 /* A list of sub-properties. */
4686 while (CONSP (prop
))
4688 if (single_display_spec_string_p (XCAR (prop
), string
))
4693 else if (VECTORP (prop
))
4695 /* A vector of sub-properties. */
4697 for (i
= 0; i
< ASIZE (prop
); ++i
)
4698 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4702 return single_display_spec_string_p (prop
, string
);
4707 /* Look for STRING in overlays and text properties in the current
4708 buffer, between character positions FROM and TO (excluding TO).
4709 BACK_P non-zero means look back (in this case, TO is supposed to be
4711 Value is the first character position where STRING was found, or
4712 zero if it wasn't found before hitting TO.
4714 This function may only use code that doesn't eval because it is
4715 called asynchronously from note_mouse_highlight. */
4718 string_buffer_position_lim (Lisp_Object string
,
4719 EMACS_INT from
, EMACS_INT to
, int back_p
)
4721 Lisp_Object limit
, prop
, pos
;
4724 pos
= make_number (from
);
4726 if (!back_p
) /* looking forward */
4728 limit
= make_number (min (to
, ZV
));
4729 while (!found
&& !EQ (pos
, limit
))
4731 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4732 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4735 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4739 else /* looking back */
4741 limit
= make_number (max (to
, BEGV
));
4742 while (!found
&& !EQ (pos
, limit
))
4744 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4745 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4748 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4753 return found
? XINT (pos
) : 0;
4756 /* Determine which buffer position in current buffer STRING comes from.
4757 AROUND_CHARPOS is an approximate position where it could come from.
4758 Value is the buffer position or 0 if it couldn't be determined.
4760 This function is necessary because we don't record buffer positions
4761 in glyphs generated from strings (to keep struct glyph small).
4762 This function may only use code that doesn't eval because it is
4763 called asynchronously from note_mouse_highlight. */
4766 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4768 const int MAX_DISTANCE
= 1000;
4769 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4770 around_charpos
+ MAX_DISTANCE
,
4774 found
= string_buffer_position_lim (string
, around_charpos
,
4775 around_charpos
- MAX_DISTANCE
, 1);
4781 /***********************************************************************
4782 `composition' property
4783 ***********************************************************************/
4785 /* Set up iterator IT from `composition' property at its current
4786 position. Called from handle_stop. */
4788 static enum prop_handled
4789 handle_composition_prop (struct it
*it
)
4791 Lisp_Object prop
, string
;
4792 EMACS_INT pos
, pos_byte
, start
, end
;
4794 if (STRINGP (it
->string
))
4798 pos
= IT_STRING_CHARPOS (*it
);
4799 pos_byte
= IT_STRING_BYTEPOS (*it
);
4800 string
= it
->string
;
4801 s
= SDATA (string
) + pos_byte
;
4802 it
->c
= STRING_CHAR (s
);
4806 pos
= IT_CHARPOS (*it
);
4807 pos_byte
= IT_BYTEPOS (*it
);
4809 it
->c
= FETCH_CHAR (pos_byte
);
4812 /* If there's a valid composition and point is not inside of the
4813 composition (in the case that the composition is from the current
4814 buffer), draw a glyph composed from the composition components. */
4815 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4816 && COMPOSITION_VALID_P (start
, end
, prop
)
4817 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4820 /* As we can't handle this situation (perhaps font-lock added
4821 a new composition), we just return here hoping that next
4822 redisplay will detect this composition much earlier. */
4823 return HANDLED_NORMALLY
;
4826 if (STRINGP (it
->string
))
4827 pos_byte
= string_char_to_byte (it
->string
, start
);
4829 pos_byte
= CHAR_TO_BYTE (start
);
4831 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4834 if (it
->cmp_it
.id
>= 0)
4837 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4838 it
->cmp_it
.nglyphs
= -1;
4842 return HANDLED_NORMALLY
;
4847 /***********************************************************************
4849 ***********************************************************************/
4851 /* The following structure is used to record overlay strings for
4852 later sorting in load_overlay_strings. */
4854 struct overlay_entry
4856 Lisp_Object overlay
;
4863 /* Set up iterator IT from overlay strings at its current position.
4864 Called from handle_stop. */
4866 static enum prop_handled
4867 handle_overlay_change (struct it
*it
)
4869 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4870 return HANDLED_RECOMPUTE_PROPS
;
4872 return HANDLED_NORMALLY
;
4876 /* Set up the next overlay string for delivery by IT, if there is an
4877 overlay string to deliver. Called by set_iterator_to_next when the
4878 end of the current overlay string is reached. If there are more
4879 overlay strings to display, IT->string and
4880 IT->current.overlay_string_index are set appropriately here.
4881 Otherwise IT->string is set to nil. */
4884 next_overlay_string (struct it
*it
)
4886 ++it
->current
.overlay_string_index
;
4887 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4889 /* No more overlay strings. Restore IT's settings to what
4890 they were before overlay strings were processed, and
4891 continue to deliver from current_buffer. */
4893 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4896 || (NILP (it
->string
)
4897 && it
->method
== GET_FROM_BUFFER
4898 && it
->stop_charpos
>= BEGV
4899 && it
->stop_charpos
<= it
->end_charpos
));
4900 it
->current
.overlay_string_index
= -1;
4901 it
->n_overlay_strings
= 0;
4902 it
->overlay_strings_charpos
= -1;
4904 /* If we're at the end of the buffer, record that we have
4905 processed the overlay strings there already, so that
4906 next_element_from_buffer doesn't try it again. */
4907 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4908 it
->overlay_strings_at_end_processed_p
= 1;
4912 /* There are more overlay strings to process. If
4913 IT->current.overlay_string_index has advanced to a position
4914 where we must load IT->overlay_strings with more strings, do
4915 it. We must load at the IT->overlay_strings_charpos where
4916 IT->n_overlay_strings was originally computed; when invisible
4917 text is present, this might not be IT_CHARPOS (Bug#7016). */
4918 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4920 if (it
->current
.overlay_string_index
&& i
== 0)
4921 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4923 /* Initialize IT to deliver display elements from the overlay
4925 it
->string
= it
->overlay_strings
[i
];
4926 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4927 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4928 it
->method
= GET_FROM_STRING
;
4929 it
->stop_charpos
= 0;
4930 if (it
->cmp_it
.stop_pos
>= 0)
4931 it
->cmp_it
.stop_pos
= 0;
4933 it
->base_level_stop
= 0;
4935 /* Set up the bidi iterator for this overlay string. */
4938 it
->bidi_it
.string
.lstring
= it
->string
;
4939 it
->bidi_it
.string
.s
= NULL
;
4940 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4941 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4942 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4943 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4944 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4952 /* Compare two overlay_entry structures E1 and E2. Used as a
4953 comparison function for qsort in load_overlay_strings. Overlay
4954 strings for the same position are sorted so that
4956 1. All after-strings come in front of before-strings, except
4957 when they come from the same overlay.
4959 2. Within after-strings, strings are sorted so that overlay strings
4960 from overlays with higher priorities come first.
4962 2. Within before-strings, strings are sorted so that overlay
4963 strings from overlays with higher priorities come last.
4965 Value is analogous to strcmp. */
4969 compare_overlay_entries (const void *e1
, const void *e2
)
4971 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4972 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4975 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4977 /* Let after-strings appear in front of before-strings if
4978 they come from different overlays. */
4979 if (EQ (entry1
->overlay
, entry2
->overlay
))
4980 result
= entry1
->after_string_p
? 1 : -1;
4982 result
= entry1
->after_string_p
? -1 : 1;
4984 else if (entry1
->after_string_p
)
4985 /* After-strings sorted in order of decreasing priority. */
4986 result
= entry2
->priority
- entry1
->priority
;
4988 /* Before-strings sorted in order of increasing priority. */
4989 result
= entry1
->priority
- entry2
->priority
;
4995 /* Load the vector IT->overlay_strings with overlay strings from IT's
4996 current buffer position, or from CHARPOS if that is > 0. Set
4997 IT->n_overlays to the total number of overlay strings found.
4999 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5000 a time. On entry into load_overlay_strings,
5001 IT->current.overlay_string_index gives the number of overlay
5002 strings that have already been loaded by previous calls to this
5005 IT->add_overlay_start contains an additional overlay start
5006 position to consider for taking overlay strings from, if non-zero.
5007 This position comes into play when the overlay has an `invisible'
5008 property, and both before and after-strings. When we've skipped to
5009 the end of the overlay, because of its `invisible' property, we
5010 nevertheless want its before-string to appear.
5011 IT->add_overlay_start will contain the overlay start position
5014 Overlay strings are sorted so that after-string strings come in
5015 front of before-string strings. Within before and after-strings,
5016 strings are sorted by overlay priority. See also function
5017 compare_overlay_entries. */
5020 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5022 Lisp_Object overlay
, window
, str
, invisible
;
5023 struct Lisp_Overlay
*ov
;
5024 EMACS_INT start
, end
;
5026 int n
= 0, i
, j
, invis_p
;
5027 struct overlay_entry
*entries
5028 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5031 charpos
= IT_CHARPOS (*it
);
5033 /* Append the overlay string STRING of overlay OVERLAY to vector
5034 `entries' which has size `size' and currently contains `n'
5035 elements. AFTER_P non-zero means STRING is an after-string of
5037 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5040 Lisp_Object priority; \
5044 int new_size = 2 * size; \
5045 struct overlay_entry *old = entries; \
5047 (struct overlay_entry *) alloca (new_size \
5048 * sizeof *entries); \
5049 memcpy (entries, old, size * sizeof *entries); \
5053 entries[n].string = (STRING); \
5054 entries[n].overlay = (OVERLAY); \
5055 priority = Foverlay_get ((OVERLAY), Qpriority); \
5056 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5057 entries[n].after_string_p = (AFTER_P); \
5062 /* Process overlay before the overlay center. */
5063 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5065 XSETMISC (overlay
, ov
);
5066 xassert (OVERLAYP (overlay
));
5067 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5068 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5073 /* Skip this overlay if it doesn't start or end at IT's current
5075 if (end
!= charpos
&& start
!= charpos
)
5078 /* Skip this overlay if it doesn't apply to IT->w. */
5079 window
= Foverlay_get (overlay
, Qwindow
);
5080 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5083 /* If the text ``under'' the overlay is invisible, both before-
5084 and after-strings from this overlay are visible; start and
5085 end position are indistinguishable. */
5086 invisible
= Foverlay_get (overlay
, Qinvisible
);
5087 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5089 /* If overlay has a non-empty before-string, record it. */
5090 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5091 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5093 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5095 /* If overlay has a non-empty after-string, record it. */
5096 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5097 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5099 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5102 /* Process overlays after the overlay center. */
5103 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5105 XSETMISC (overlay
, ov
);
5106 xassert (OVERLAYP (overlay
));
5107 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5108 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5110 if (start
> charpos
)
5113 /* Skip this overlay if it doesn't start or end at IT's current
5115 if (end
!= charpos
&& start
!= charpos
)
5118 /* Skip this overlay if it doesn't apply to IT->w. */
5119 window
= Foverlay_get (overlay
, Qwindow
);
5120 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5123 /* If the text ``under'' the overlay is invisible, it has a zero
5124 dimension, and both before- and after-strings apply. */
5125 invisible
= Foverlay_get (overlay
, Qinvisible
);
5126 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5128 /* If overlay has a non-empty before-string, record it. */
5129 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5130 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5132 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5134 /* If overlay has a non-empty after-string, record it. */
5135 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5136 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5138 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5141 #undef RECORD_OVERLAY_STRING
5145 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5147 /* Record number of overlay strings, and where we computed it. */
5148 it
->n_overlay_strings
= n
;
5149 it
->overlay_strings_charpos
= charpos
;
5151 /* IT->current.overlay_string_index is the number of overlay strings
5152 that have already been consumed by IT. Copy some of the
5153 remaining overlay strings to IT->overlay_strings. */
5155 j
= it
->current
.overlay_string_index
;
5156 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5158 it
->overlay_strings
[i
] = entries
[j
].string
;
5159 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5166 /* Get the first chunk of overlay strings at IT's current buffer
5167 position, or at CHARPOS if that is > 0. Value is non-zero if at
5168 least one overlay string was found. */
5171 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5173 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5174 process. This fills IT->overlay_strings with strings, and sets
5175 IT->n_overlay_strings to the total number of strings to process.
5176 IT->pos.overlay_string_index has to be set temporarily to zero
5177 because load_overlay_strings needs this; it must be set to -1
5178 when no overlay strings are found because a zero value would
5179 indicate a position in the first overlay string. */
5180 it
->current
.overlay_string_index
= 0;
5181 load_overlay_strings (it
, charpos
);
5183 /* If we found overlay strings, set up IT to deliver display
5184 elements from the first one. Otherwise set up IT to deliver
5185 from current_buffer. */
5186 if (it
->n_overlay_strings
)
5188 /* Make sure we know settings in current_buffer, so that we can
5189 restore meaningful values when we're done with the overlay
5192 compute_stop_pos (it
);
5193 xassert (it
->face_id
>= 0);
5195 /* Save IT's settings. They are restored after all overlay
5196 strings have been processed. */
5197 xassert (!compute_stop_p
|| it
->sp
== 0);
5199 /* When called from handle_stop, there might be an empty display
5200 string loaded. In that case, don't bother saving it. */
5201 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5204 /* Set up IT to deliver display elements from the first overlay
5206 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5207 it
->string
= it
->overlay_strings
[0];
5208 it
->from_overlay
= Qnil
;
5209 it
->stop_charpos
= 0;
5210 xassert (STRINGP (it
->string
));
5211 it
->end_charpos
= SCHARS (it
->string
);
5213 it
->base_level_stop
= 0;
5214 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5215 it
->method
= GET_FROM_STRING
;
5216 it
->from_disp_prop_p
= 0;
5218 /* Force paragraph direction to be that of the parent
5220 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5221 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5223 it
->paragraph_embedding
= L2R
;
5225 /* Set up the bidi iterator for this overlay string. */
5228 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5230 it
->bidi_it
.string
.lstring
= it
->string
;
5231 it
->bidi_it
.string
.s
= NULL
;
5232 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5233 it
->bidi_it
.string
.bufpos
= pos
;
5234 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5235 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5236 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5241 it
->current
.overlay_string_index
= -1;
5246 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5249 it
->method
= GET_FROM_BUFFER
;
5251 (void) get_overlay_strings_1 (it
, charpos
, 1);
5255 /* Value is non-zero if we found at least one overlay string. */
5256 return STRINGP (it
->string
);
5261 /***********************************************************************
5262 Saving and restoring state
5263 ***********************************************************************/
5265 /* Save current settings of IT on IT->stack. Called, for example,
5266 before setting up IT for an overlay string, to be able to restore
5267 IT's settings to what they were after the overlay string has been
5268 processed. If POSITION is non-NULL, it is the position to save on
5269 the stack instead of IT->position. */
5272 push_it (struct it
*it
, struct text_pos
*position
)
5274 struct iterator_stack_entry
*p
;
5276 xassert (it
->sp
< IT_STACK_SIZE
);
5277 p
= it
->stack
+ it
->sp
;
5279 p
->stop_charpos
= it
->stop_charpos
;
5280 p
->prev_stop
= it
->prev_stop
;
5281 p
->base_level_stop
= it
->base_level_stop
;
5282 p
->cmp_it
= it
->cmp_it
;
5283 xassert (it
->face_id
>= 0);
5284 p
->face_id
= it
->face_id
;
5285 p
->string
= it
->string
;
5286 p
->method
= it
->method
;
5287 p
->from_overlay
= it
->from_overlay
;
5290 case GET_FROM_IMAGE
:
5291 p
->u
.image
.object
= it
->object
;
5292 p
->u
.image
.image_id
= it
->image_id
;
5293 p
->u
.image
.slice
= it
->slice
;
5295 case GET_FROM_STRETCH
:
5296 p
->u
.stretch
.object
= it
->object
;
5299 p
->position
= position
? *position
: it
->position
;
5300 p
->current
= it
->current
;
5301 p
->end_charpos
= it
->end_charpos
;
5302 p
->string_nchars
= it
->string_nchars
;
5304 p
->multibyte_p
= it
->multibyte_p
;
5305 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5306 p
->space_width
= it
->space_width
;
5307 p
->font_height
= it
->font_height
;
5308 p
->voffset
= it
->voffset
;
5309 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5310 p
->display_ellipsis_p
= 0;
5311 p
->line_wrap
= it
->line_wrap
;
5312 p
->bidi_p
= it
->bidi_p
;
5313 p
->paragraph_embedding
= it
->paragraph_embedding
;
5314 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5317 /* Save the state of the bidi iterator as well. */
5319 bidi_push_it (&it
->bidi_it
);
5323 iterate_out_of_display_property (struct it
*it
)
5325 int buffer_p
= BUFFERP (it
->object
);
5326 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5327 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5329 /* Maybe initialize paragraph direction. If we are at the beginning
5330 of a new paragraph, next_element_from_buffer may not have a
5331 chance to do that. */
5332 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5333 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5334 /* prev_stop can be zero, so check against BEGV as well. */
5335 while (it
->bidi_it
.charpos
>= bob
5336 && it
->prev_stop
<= it
->bidi_it
.charpos
5337 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5338 bidi_move_to_visually_next (&it
->bidi_it
);
5339 /* Record the stop_pos we just crossed, for when we cross it
5341 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5342 it
->prev_stop
= CHARPOS (it
->position
);
5343 /* If we ended up not where pop_it put us, resync IT's
5344 positional members with the bidi iterator. */
5345 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5347 SET_TEXT_POS (it
->position
,
5348 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5350 it
->current
.pos
= it
->position
;
5352 it
->current
.string_pos
= it
->position
;
5356 /* Restore IT's settings from IT->stack. Called, for example, when no
5357 more overlay strings must be processed, and we return to delivering
5358 display elements from a buffer, or when the end of a string from a
5359 `display' property is reached and we return to delivering display
5360 elements from an overlay string, or from a buffer. */
5363 pop_it (struct it
*it
)
5365 struct iterator_stack_entry
*p
;
5366 int from_display_prop
= it
->from_disp_prop_p
;
5368 xassert (it
->sp
> 0);
5370 p
= it
->stack
+ it
->sp
;
5371 it
->stop_charpos
= p
->stop_charpos
;
5372 it
->prev_stop
= p
->prev_stop
;
5373 it
->base_level_stop
= p
->base_level_stop
;
5374 it
->cmp_it
= p
->cmp_it
;
5375 it
->face_id
= p
->face_id
;
5376 it
->current
= p
->current
;
5377 it
->position
= p
->position
;
5378 it
->string
= p
->string
;
5379 it
->from_overlay
= p
->from_overlay
;
5380 if (NILP (it
->string
))
5381 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5382 it
->method
= p
->method
;
5385 case GET_FROM_IMAGE
:
5386 it
->image_id
= p
->u
.image
.image_id
;
5387 it
->object
= p
->u
.image
.object
;
5388 it
->slice
= p
->u
.image
.slice
;
5390 case GET_FROM_STRETCH
:
5391 it
->object
= p
->u
.stretch
.object
;
5393 case GET_FROM_BUFFER
:
5394 it
->object
= it
->w
->buffer
;
5396 case GET_FROM_STRING
:
5397 it
->object
= it
->string
;
5399 case GET_FROM_DISPLAY_VECTOR
:
5401 it
->method
= GET_FROM_C_STRING
;
5402 else if (STRINGP (it
->string
))
5403 it
->method
= GET_FROM_STRING
;
5406 it
->method
= GET_FROM_BUFFER
;
5407 it
->object
= it
->w
->buffer
;
5410 it
->end_charpos
= p
->end_charpos
;
5411 it
->string_nchars
= p
->string_nchars
;
5413 it
->multibyte_p
= p
->multibyte_p
;
5414 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5415 it
->space_width
= p
->space_width
;
5416 it
->font_height
= p
->font_height
;
5417 it
->voffset
= p
->voffset
;
5418 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5419 it
->line_wrap
= p
->line_wrap
;
5420 it
->bidi_p
= p
->bidi_p
;
5421 it
->paragraph_embedding
= p
->paragraph_embedding
;
5422 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5425 bidi_pop_it (&it
->bidi_it
);
5426 /* Bidi-iterate until we get out of the portion of text, if any,
5427 covered by a `display' text property or by an overlay with
5428 `display' property. (We cannot just jump there, because the
5429 internal coherency of the bidi iterator state can not be
5430 preserved across such jumps.) We also must determine the
5431 paragraph base direction if the overlay we just processed is
5432 at the beginning of a new paragraph. */
5433 if (from_display_prop
5434 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5435 iterate_out_of_display_property (it
);
5437 xassert ((BUFFERP (it
->object
)
5438 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5439 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5440 || (STRINGP (it
->object
)
5441 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5442 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5448 /***********************************************************************
5450 ***********************************************************************/
5452 /* Set IT's current position to the previous line start. */
5455 back_to_previous_line_start (struct it
*it
)
5457 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5458 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5462 /* Move IT to the next line start.
5464 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5465 we skipped over part of the text (as opposed to moving the iterator
5466 continuously over the text). Otherwise, don't change the value
5469 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5470 iterator on the newline, if it was found.
5472 Newlines may come from buffer text, overlay strings, or strings
5473 displayed via the `display' property. That's the reason we can't
5474 simply use find_next_newline_no_quit.
5476 Note that this function may not skip over invisible text that is so
5477 because of text properties and immediately follows a newline. If
5478 it would, function reseat_at_next_visible_line_start, when called
5479 from set_iterator_to_next, would effectively make invisible
5480 characters following a newline part of the wrong glyph row, which
5481 leads to wrong cursor motion. */
5484 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5485 struct bidi_it
*bidi_it_prev
)
5487 EMACS_INT old_selective
;
5488 int newline_found_p
, n
;
5489 const int MAX_NEWLINE_DISTANCE
= 500;
5491 /* If already on a newline, just consume it to avoid unintended
5492 skipping over invisible text below. */
5493 if (it
->what
== IT_CHARACTER
5495 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5497 if (it
->bidi_p
&& bidi_it_prev
)
5498 *bidi_it_prev
= it
->bidi_it
;
5499 set_iterator_to_next (it
, 0);
5504 /* Don't handle selective display in the following. It's (a)
5505 unnecessary because it's done by the caller, and (b) leads to an
5506 infinite recursion because next_element_from_ellipsis indirectly
5507 calls this function. */
5508 old_selective
= it
->selective
;
5511 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5512 from buffer text. */
5513 for (n
= newline_found_p
= 0;
5514 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5515 n
+= STRINGP (it
->string
) ? 0 : 1)
5517 if (!get_next_display_element (it
))
5519 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5520 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5521 *bidi_it_prev
= it
->bidi_it
;
5522 set_iterator_to_next (it
, 0);
5525 /* If we didn't find a newline near enough, see if we can use a
5527 if (!newline_found_p
)
5529 EMACS_INT start
= IT_CHARPOS (*it
);
5530 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5533 xassert (!STRINGP (it
->string
));
5535 /* If we are not bidi-reordering, and there isn't any `display'
5536 property in sight, and no overlays, we can just use the
5537 position of the newline in buffer text. */
5539 && (it
->stop_charpos
>= limit
5540 || ((pos
= Fnext_single_property_change (make_number (start
),
5542 make_number (limit
)),
5544 && next_overlay_change (start
) == ZV
)))
5546 IT_CHARPOS (*it
) = limit
;
5547 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5548 *skipped_p
= newline_found_p
= 1;
5552 while (get_next_display_element (it
)
5553 && !newline_found_p
)
5555 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5556 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5557 *bidi_it_prev
= it
->bidi_it
;
5558 set_iterator_to_next (it
, 0);
5563 it
->selective
= old_selective
;
5564 return newline_found_p
;
5568 /* Set IT's current position to the previous visible line start. Skip
5569 invisible text that is so either due to text properties or due to
5570 selective display. Caution: this does not change IT->current_x and
5574 back_to_previous_visible_line_start (struct it
*it
)
5576 while (IT_CHARPOS (*it
) > BEGV
)
5578 back_to_previous_line_start (it
);
5580 if (IT_CHARPOS (*it
) <= BEGV
)
5583 /* If selective > 0, then lines indented more than its value are
5585 if (it
->selective
> 0
5586 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5590 /* Check the newline before point for invisibility. */
5593 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5594 Qinvisible
, it
->window
);
5595 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5599 if (IT_CHARPOS (*it
) <= BEGV
)
5604 void *it2data
= NULL
;
5607 Lisp_Object val
, overlay
;
5609 SAVE_IT (it2
, *it
, it2data
);
5611 /* If newline is part of a composition, continue from start of composition */
5612 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5613 && beg
< IT_CHARPOS (*it
))
5616 /* If newline is replaced by a display property, find start of overlay
5617 or interval and continue search from that point. */
5618 pos
= --IT_CHARPOS (it2
);
5621 bidi_unshelve_cache (NULL
);
5622 it2
.string_from_display_prop_p
= 0;
5623 it2
.from_disp_prop_p
= 0;
5624 if (handle_display_prop (&it2
) == HANDLED_RETURN
5625 && !NILP (val
= get_char_property_and_overlay
5626 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5627 && (OVERLAYP (overlay
)
5628 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5629 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5631 RESTORE_IT (it
, it
, it2data
);
5635 /* Newline is not replaced by anything -- so we are done. */
5636 RESTORE_IT (it
, it
, it2data
);
5642 IT_CHARPOS (*it
) = beg
;
5643 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5647 it
->continuation_lines_width
= 0;
5649 xassert (IT_CHARPOS (*it
) >= BEGV
);
5650 xassert (IT_CHARPOS (*it
) == BEGV
5651 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5656 /* Reseat iterator IT at the previous visible line start. Skip
5657 invisible text that is so either due to text properties or due to
5658 selective display. At the end, update IT's overlay information,
5659 face information etc. */
5662 reseat_at_previous_visible_line_start (struct it
*it
)
5664 back_to_previous_visible_line_start (it
);
5665 reseat (it
, it
->current
.pos
, 1);
5670 /* Reseat iterator IT on the next visible line start in the current
5671 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5672 preceding the line start. Skip over invisible text that is so
5673 because of selective display. Compute faces, overlays etc at the
5674 new position. Note that this function does not skip over text that
5675 is invisible because of text properties. */
5678 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5680 int newline_found_p
, skipped_p
= 0;
5681 struct bidi_it bidi_it_prev
;
5683 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5685 /* Skip over lines that are invisible because they are indented
5686 more than the value of IT->selective. */
5687 if (it
->selective
> 0)
5688 while (IT_CHARPOS (*it
) < ZV
5689 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5692 xassert (IT_BYTEPOS (*it
) == BEGV
5693 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5695 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5698 /* Position on the newline if that's what's requested. */
5699 if (on_newline_p
&& newline_found_p
)
5701 if (STRINGP (it
->string
))
5703 if (IT_STRING_CHARPOS (*it
) > 0)
5707 --IT_STRING_CHARPOS (*it
);
5708 --IT_STRING_BYTEPOS (*it
);
5712 /* We need to restore the bidi iterator to the state
5713 it had on the newline, and resync the IT's
5714 position with that. */
5715 it
->bidi_it
= bidi_it_prev
;
5716 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5717 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5721 else if (IT_CHARPOS (*it
) > BEGV
)
5730 /* We need to restore the bidi iterator to the state it
5731 had on the newline and resync IT with that. */
5732 it
->bidi_it
= bidi_it_prev
;
5733 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5734 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5736 reseat (it
, it
->current
.pos
, 0);
5740 reseat (it
, it
->current
.pos
, 0);
5747 /***********************************************************************
5748 Changing an iterator's position
5749 ***********************************************************************/
5751 /* Change IT's current position to POS in current_buffer. If FORCE_P
5752 is non-zero, always check for text properties at the new position.
5753 Otherwise, text properties are only looked up if POS >=
5754 IT->check_charpos of a property. */
5757 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5759 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5761 reseat_1 (it
, pos
, 0);
5763 /* Determine where to check text properties. Avoid doing it
5764 where possible because text property lookup is very expensive. */
5766 || CHARPOS (pos
) > it
->stop_charpos
5767 || CHARPOS (pos
) < original_pos
)
5771 /* For bidi iteration, we need to prime prev_stop and
5772 base_level_stop with our best estimations. */
5773 /* Implementation note: Of course, POS is not necessarily a
5774 stop position, so assigning prev_pos to it is a lie; we
5775 should have called compute_stop_backwards. However, if
5776 the current buffer does not include any R2L characters,
5777 that call would be a waste of cycles, because the
5778 iterator will never move back, and thus never cross this
5779 "fake" stop position. So we delay that backward search
5780 until the time we really need it, in next_element_from_buffer. */
5781 if (CHARPOS (pos
) != it
->prev_stop
)
5782 it
->prev_stop
= CHARPOS (pos
);
5783 if (CHARPOS (pos
) < it
->base_level_stop
)
5784 it
->base_level_stop
= 0; /* meaning it's unknown */
5790 it
->prev_stop
= it
->base_level_stop
= 0;
5799 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5800 IT->stop_pos to POS, also. */
5803 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5805 /* Don't call this function when scanning a C string. */
5806 xassert (it
->s
== NULL
);
5808 /* POS must be a reasonable value. */
5809 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5811 it
->current
.pos
= it
->position
= pos
;
5812 it
->end_charpos
= ZV
;
5814 it
->current
.dpvec_index
= -1;
5815 it
->current
.overlay_string_index
= -1;
5816 IT_STRING_CHARPOS (*it
) = -1;
5817 IT_STRING_BYTEPOS (*it
) = -1;
5819 it
->method
= GET_FROM_BUFFER
;
5820 it
->object
= it
->w
->buffer
;
5821 it
->area
= TEXT_AREA
;
5822 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5824 it
->string_from_display_prop_p
= 0;
5825 it
->from_disp_prop_p
= 0;
5826 it
->face_before_selective_p
= 0;
5829 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5831 bidi_unshelve_cache (NULL
);
5832 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5833 it
->bidi_it
.string
.s
= NULL
;
5834 it
->bidi_it
.string
.lstring
= Qnil
;
5835 it
->bidi_it
.string
.bufpos
= 0;
5836 it
->bidi_it
.string
.unibyte
= 0;
5841 it
->stop_charpos
= CHARPOS (pos
);
5842 it
->base_level_stop
= CHARPOS (pos
);
5847 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5848 If S is non-null, it is a C string to iterate over. Otherwise,
5849 STRING gives a Lisp string to iterate over.
5851 If PRECISION > 0, don't return more then PRECISION number of
5852 characters from the string.
5854 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5855 characters have been returned. FIELD_WIDTH < 0 means an infinite
5858 MULTIBYTE = 0 means disable processing of multibyte characters,
5859 MULTIBYTE > 0 means enable it,
5860 MULTIBYTE < 0 means use IT->multibyte_p.
5862 IT must be initialized via a prior call to init_iterator before
5863 calling this function. */
5866 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5867 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5870 /* No region in strings. */
5871 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5873 /* No text property checks performed by default, but see below. */
5874 it
->stop_charpos
= -1;
5876 /* Set iterator position and end position. */
5877 memset (&it
->current
, 0, sizeof it
->current
);
5878 it
->current
.overlay_string_index
= -1;
5879 it
->current
.dpvec_index
= -1;
5880 xassert (charpos
>= 0);
5882 /* If STRING is specified, use its multibyteness, otherwise use the
5883 setting of MULTIBYTE, if specified. */
5885 it
->multibyte_p
= multibyte
> 0;
5887 /* Bidirectional reordering of strings is controlled by the default
5888 value of bidi-display-reordering. */
5889 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5893 xassert (STRINGP (string
));
5894 it
->string
= string
;
5896 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5897 it
->method
= GET_FROM_STRING
;
5898 it
->current
.string_pos
= string_pos (charpos
, string
);
5902 it
->bidi_it
.string
.lstring
= string
;
5903 it
->bidi_it
.string
.s
= NULL
;
5904 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5905 it
->bidi_it
.string
.bufpos
= 0;
5906 it
->bidi_it
.string
.from_disp_str
= 0;
5907 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5908 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5909 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5914 it
->s
= (const unsigned char *) s
;
5917 /* Note that we use IT->current.pos, not it->current.string_pos,
5918 for displaying C strings. */
5919 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5920 if (it
->multibyte_p
)
5922 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5923 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5927 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5928 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5933 it
->bidi_it
.string
.lstring
= Qnil
;
5934 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5935 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5936 it
->bidi_it
.string
.bufpos
= 0;
5937 it
->bidi_it
.string
.from_disp_str
= 0;
5938 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5939 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5942 it
->method
= GET_FROM_C_STRING
;
5945 /* PRECISION > 0 means don't return more than PRECISION characters
5947 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5949 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5951 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5954 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5955 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5956 FIELD_WIDTH < 0 means infinite field width. This is useful for
5957 padding with `-' at the end of a mode line. */
5958 if (field_width
< 0)
5959 field_width
= INFINITY
;
5960 /* Implementation note: We deliberately don't enlarge
5961 it->bidi_it.string.schars here to fit it->end_charpos, because
5962 the bidi iterator cannot produce characters out of thin air. */
5963 if (field_width
> it
->end_charpos
- charpos
)
5964 it
->end_charpos
= charpos
+ field_width
;
5966 /* Use the standard display table for displaying strings. */
5967 if (DISP_TABLE_P (Vstandard_display_table
))
5968 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5970 it
->stop_charpos
= charpos
;
5971 it
->prev_stop
= charpos
;
5972 it
->base_level_stop
= 0;
5975 it
->bidi_it
.first_elt
= 1;
5976 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5977 it
->bidi_it
.disp_pos
= -1;
5979 if (s
== NULL
&& it
->multibyte_p
)
5981 EMACS_INT endpos
= SCHARS (it
->string
);
5982 if (endpos
> it
->end_charpos
)
5983 endpos
= it
->end_charpos
;
5984 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5992 /***********************************************************************
5994 ***********************************************************************/
5996 /* Map enum it_method value to corresponding next_element_from_* function. */
5998 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6000 next_element_from_buffer
,
6001 next_element_from_display_vector
,
6002 next_element_from_string
,
6003 next_element_from_c_string
,
6004 next_element_from_image
,
6005 next_element_from_stretch
6008 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6011 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6012 (possibly with the following characters). */
6014 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6015 ((IT)->cmp_it.id >= 0 \
6016 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6017 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6018 END_CHARPOS, (IT)->w, \
6019 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6023 /* Lookup the char-table Vglyphless_char_display for character C (-1
6024 if we want information for no-font case), and return the display
6025 method symbol. By side-effect, update it->what and
6026 it->glyphless_method. This function is called from
6027 get_next_display_element for each character element, and from
6028 x_produce_glyphs when no suitable font was found. */
6031 lookup_glyphless_char_display (int c
, struct it
*it
)
6033 Lisp_Object glyphless_method
= Qnil
;
6035 if (CHAR_TABLE_P (Vglyphless_char_display
)
6036 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6040 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6041 if (CONSP (glyphless_method
))
6042 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6043 ? XCAR (glyphless_method
)
6044 : XCDR (glyphless_method
);
6047 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6051 if (NILP (glyphless_method
))
6054 /* The default is to display the character by a proper font. */
6056 /* The default for the no-font case is to display an empty box. */
6057 glyphless_method
= Qempty_box
;
6059 if (EQ (glyphless_method
, Qzero_width
))
6062 return glyphless_method
;
6063 /* This method can't be used for the no-font case. */
6064 glyphless_method
= Qempty_box
;
6066 if (EQ (glyphless_method
, Qthin_space
))
6067 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6068 else if (EQ (glyphless_method
, Qempty_box
))
6069 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6070 else if (EQ (glyphless_method
, Qhex_code
))
6071 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6072 else if (STRINGP (glyphless_method
))
6073 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6076 /* Invalid value. We use the default method. */
6077 glyphless_method
= Qnil
;
6080 it
->what
= IT_GLYPHLESS
;
6081 return glyphless_method
;
6084 /* Load IT's display element fields with information about the next
6085 display element from the current position of IT. Value is zero if
6086 end of buffer (or C string) is reached. */
6088 static struct frame
*last_escape_glyph_frame
= NULL
;
6089 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6090 static int last_escape_glyph_merged_face_id
= 0;
6092 struct frame
*last_glyphless_glyph_frame
= NULL
;
6093 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6094 int last_glyphless_glyph_merged_face_id
= 0;
6097 get_next_display_element (struct it
*it
)
6099 /* Non-zero means that we found a display element. Zero means that
6100 we hit the end of what we iterate over. Performance note: the
6101 function pointer `method' used here turns out to be faster than
6102 using a sequence of if-statements. */
6106 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6108 if (it
->what
== IT_CHARACTER
)
6110 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6111 and only if (a) the resolved directionality of that character
6113 /* FIXME: Do we need an exception for characters from display
6115 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6116 it
->c
= bidi_mirror_char (it
->c
);
6117 /* Map via display table or translate control characters.
6118 IT->c, IT->len etc. have been set to the next character by
6119 the function call above. If we have a display table, and it
6120 contains an entry for IT->c, translate it. Don't do this if
6121 IT->c itself comes from a display table, otherwise we could
6122 end up in an infinite recursion. (An alternative could be to
6123 count the recursion depth of this function and signal an
6124 error when a certain maximum depth is reached.) Is it worth
6126 if (success_p
&& it
->dpvec
== NULL
)
6129 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6130 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6131 nbsp_or_shy
= char_is_other
;
6132 int c
= it
->c
; /* This is the character to display. */
6134 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6136 xassert (SINGLE_BYTE_CHAR_P (c
));
6137 if (unibyte_display_via_language_environment
)
6139 c
= DECODE_CHAR (unibyte
, c
);
6141 c
= BYTE8_TO_CHAR (it
->c
);
6144 c
= BYTE8_TO_CHAR (it
->c
);
6148 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6151 struct Lisp_Vector
*v
= XVECTOR (dv
);
6153 /* Return the first character from the display table
6154 entry, if not empty. If empty, don't display the
6155 current character. */
6158 it
->dpvec_char_len
= it
->len
;
6159 it
->dpvec
= v
->contents
;
6160 it
->dpend
= v
->contents
+ v
->header
.size
;
6161 it
->current
.dpvec_index
= 0;
6162 it
->dpvec_face_id
= -1;
6163 it
->saved_face_id
= it
->face_id
;
6164 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6169 set_iterator_to_next (it
, 0);
6174 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6176 if (it
->what
== IT_GLYPHLESS
)
6178 /* Don't display this character. */
6179 set_iterator_to_next (it
, 0);
6183 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6184 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6185 : c
== 0xAD ? char_is_soft_hyphen
6188 /* Translate control characters into `\003' or `^C' form.
6189 Control characters coming from a display table entry are
6190 currently not translated because we use IT->dpvec to hold
6191 the translation. This could easily be changed but I
6192 don't believe that it is worth doing.
6194 NBSP and SOFT-HYPEN are property translated too.
6196 Non-printable characters and raw-byte characters are also
6197 translated to octal form. */
6198 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6199 ? (it
->area
!= TEXT_AREA
6200 /* In mode line, treat \n, \t like other crl chars. */
6203 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6204 || (c
!= '\n' && c
!= '\t'))
6207 || ! CHAR_PRINTABLE_P (c
))))
6209 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6210 or a non-printable character which must be displayed
6211 either as '\003' or as `^C' where the '\\' and '^'
6212 can be defined in the display table. Fill
6213 IT->ctl_chars with glyphs for what we have to
6214 display. Then, set IT->dpvec to these glyphs. */
6218 EMACS_INT lface_id
= 0;
6221 /* Handle control characters with ^. */
6223 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6227 g
= '^'; /* default glyph for Control */
6228 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6230 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6231 && GLYPH_CODE_CHAR_VALID_P (gc
))
6233 g
= GLYPH_CODE_CHAR (gc
);
6234 lface_id
= GLYPH_CODE_FACE (gc
);
6238 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6240 else if (it
->f
== last_escape_glyph_frame
6241 && it
->face_id
== last_escape_glyph_face_id
)
6243 face_id
= last_escape_glyph_merged_face_id
;
6247 /* Merge the escape-glyph face into the current face. */
6248 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6250 last_escape_glyph_frame
= it
->f
;
6251 last_escape_glyph_face_id
= it
->face_id
;
6252 last_escape_glyph_merged_face_id
= face_id
;
6255 XSETINT (it
->ctl_chars
[0], g
);
6256 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6258 goto display_control
;
6261 /* Handle non-break space in the mode where it only gets
6264 if (EQ (Vnobreak_char_display
, Qt
)
6265 && nbsp_or_shy
== char_is_nbsp
)
6267 /* Merge the no-break-space face into the current face. */
6268 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6272 XSETINT (it
->ctl_chars
[0], ' ');
6274 goto display_control
;
6277 /* Handle sequences that start with the "escape glyph". */
6279 /* the default escape glyph is \. */
6280 escape_glyph
= '\\';
6283 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6284 && GLYPH_CODE_CHAR_VALID_P (gc
))
6286 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6287 lface_id
= GLYPH_CODE_FACE (gc
);
6291 /* The display table specified a face.
6292 Merge it into face_id and also into escape_glyph. */
6293 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6296 else if (it
->f
== last_escape_glyph_frame
6297 && it
->face_id
== last_escape_glyph_face_id
)
6299 face_id
= last_escape_glyph_merged_face_id
;
6303 /* Merge the escape-glyph face into the current face. */
6304 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6306 last_escape_glyph_frame
= it
->f
;
6307 last_escape_glyph_face_id
= it
->face_id
;
6308 last_escape_glyph_merged_face_id
= face_id
;
6311 /* Handle soft hyphens in the mode where they only get
6314 if (EQ (Vnobreak_char_display
, Qt
)
6315 && nbsp_or_shy
== char_is_soft_hyphen
)
6317 XSETINT (it
->ctl_chars
[0], '-');
6319 goto display_control
;
6322 /* Handle non-break space and soft hyphen
6323 with the escape glyph. */
6327 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6328 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6329 XSETINT (it
->ctl_chars
[1], c
);
6331 goto display_control
;
6338 if (CHAR_BYTE8_P (c
))
6339 /* Display \200 instead of \17777600. */
6340 c
= CHAR_TO_BYTE8 (c
);
6341 len
= sprintf (str
, "%03o", c
);
6343 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6344 for (i
= 0; i
< len
; i
++)
6345 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6350 /* Set up IT->dpvec and return first character from it. */
6351 it
->dpvec_char_len
= it
->len
;
6352 it
->dpvec
= it
->ctl_chars
;
6353 it
->dpend
= it
->dpvec
+ ctl_len
;
6354 it
->current
.dpvec_index
= 0;
6355 it
->dpvec_face_id
= face_id
;
6356 it
->saved_face_id
= it
->face_id
;
6357 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6361 it
->char_to_display
= c
;
6365 it
->char_to_display
= it
->c
;
6369 /* Adjust face id for a multibyte character. There are no multibyte
6370 character in unibyte text. */
6371 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6374 && FRAME_WINDOW_P (it
->f
))
6376 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6378 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6380 /* Automatic composition with glyph-string. */
6381 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6383 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6387 EMACS_INT pos
= (it
->s
? -1
6388 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6389 : IT_CHARPOS (*it
));
6392 if (it
->what
== IT_CHARACTER
)
6393 c
= it
->char_to_display
;
6396 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6400 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6401 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6404 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6409 /* Is this character the last one of a run of characters with
6410 box? If yes, set IT->end_of_box_run_p to 1. */
6414 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6416 int face_id
= underlying_face_id (it
);
6417 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6421 if (face
->box
== FACE_NO_BOX
)
6423 /* If the box comes from face properties in a
6424 display string, check faces in that string. */
6425 int string_face_id
= face_after_it_pos (it
);
6426 it
->end_of_box_run_p
6427 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6430 /* Otherwise, the box comes from the underlying face.
6431 If this is the last string character displayed, check
6432 the next buffer location. */
6433 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6434 && (it
->current
.overlay_string_index
6435 == it
->n_overlay_strings
- 1))
6439 struct text_pos pos
= it
->current
.pos
;
6440 INC_TEXT_POS (pos
, it
->multibyte_p
);
6442 next_face_id
= face_at_buffer_position
6443 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6444 it
->region_end_charpos
, &ignore
,
6445 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6447 it
->end_of_box_run_p
6448 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6455 int face_id
= face_after_it_pos (it
);
6456 it
->end_of_box_run_p
6457 = (face_id
!= it
->face_id
6458 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6462 /* Value is 0 if end of buffer or string reached. */
6467 /* Move IT to the next display element.
6469 RESEAT_P non-zero means if called on a newline in buffer text,
6470 skip to the next visible line start.
6472 Functions get_next_display_element and set_iterator_to_next are
6473 separate because I find this arrangement easier to handle than a
6474 get_next_display_element function that also increments IT's
6475 position. The way it is we can first look at an iterator's current
6476 display element, decide whether it fits on a line, and if it does,
6477 increment the iterator position. The other way around we probably
6478 would either need a flag indicating whether the iterator has to be
6479 incremented the next time, or we would have to implement a
6480 decrement position function which would not be easy to write. */
6483 set_iterator_to_next (struct it
*it
, int reseat_p
)
6485 /* Reset flags indicating start and end of a sequence of characters
6486 with box. Reset them at the start of this function because
6487 moving the iterator to a new position might set them. */
6488 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6492 case GET_FROM_BUFFER
:
6493 /* The current display element of IT is a character from
6494 current_buffer. Advance in the buffer, and maybe skip over
6495 invisible lines that are so because of selective display. */
6496 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6497 reseat_at_next_visible_line_start (it
, 0);
6498 else if (it
->cmp_it
.id
>= 0)
6500 /* We are currently getting glyphs from a composition. */
6505 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6506 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6507 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6509 it
->cmp_it
.from
= it
->cmp_it
.to
;
6514 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6516 it
->end_charpos
, Qnil
);
6519 else if (! it
->cmp_it
.reversed_p
)
6521 /* Composition created while scanning forward. */
6522 /* Update IT's char/byte positions to point to the first
6523 character of the next grapheme cluster, or to the
6524 character visually after the current composition. */
6525 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6526 bidi_move_to_visually_next (&it
->bidi_it
);
6527 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6528 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6530 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6532 /* Proceed to the next grapheme cluster. */
6533 it
->cmp_it
.from
= it
->cmp_it
.to
;
6537 /* No more grapheme clusters in this composition.
6538 Find the next stop position. */
6539 EMACS_INT stop
= it
->end_charpos
;
6540 if (it
->bidi_it
.scan_dir
< 0)
6541 /* Now we are scanning backward and don't know
6544 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6545 IT_BYTEPOS (*it
), stop
, Qnil
);
6550 /* Composition created while scanning backward. */
6551 /* Update IT's char/byte positions to point to the last
6552 character of the previous grapheme cluster, or the
6553 character visually after the current composition. */
6554 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6555 bidi_move_to_visually_next (&it
->bidi_it
);
6556 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6557 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6558 if (it
->cmp_it
.from
> 0)
6560 /* Proceed to the previous grapheme cluster. */
6561 it
->cmp_it
.to
= it
->cmp_it
.from
;
6565 /* No more grapheme clusters in this composition.
6566 Find the next stop position. */
6567 EMACS_INT stop
= it
->end_charpos
;
6568 if (it
->bidi_it
.scan_dir
< 0)
6569 /* Now we are scanning backward and don't know
6572 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6573 IT_BYTEPOS (*it
), stop
, Qnil
);
6579 xassert (it
->len
!= 0);
6583 IT_BYTEPOS (*it
) += it
->len
;
6584 IT_CHARPOS (*it
) += 1;
6588 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6589 /* If this is a new paragraph, determine its base
6590 direction (a.k.a. its base embedding level). */
6591 if (it
->bidi_it
.new_paragraph
)
6592 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6593 bidi_move_to_visually_next (&it
->bidi_it
);
6594 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6595 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6596 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6598 /* As the scan direction was changed, we must
6599 re-compute the stop position for composition. */
6600 EMACS_INT stop
= it
->end_charpos
;
6601 if (it
->bidi_it
.scan_dir
< 0)
6603 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6604 IT_BYTEPOS (*it
), stop
, Qnil
);
6607 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6611 case GET_FROM_C_STRING
:
6612 /* Current display element of IT is from a C string. */
6614 /* If the string position is beyond string's end, it means
6615 next_element_from_c_string is padding the string with
6616 blanks, in which case we bypass the bidi iterator,
6617 because it cannot deal with such virtual characters. */
6618 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6620 IT_BYTEPOS (*it
) += it
->len
;
6621 IT_CHARPOS (*it
) += 1;
6625 bidi_move_to_visually_next (&it
->bidi_it
);
6626 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6627 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6631 case GET_FROM_DISPLAY_VECTOR
:
6632 /* Current display element of IT is from a display table entry.
6633 Advance in the display table definition. Reset it to null if
6634 end reached, and continue with characters from buffers/
6636 ++it
->current
.dpvec_index
;
6638 /* Restore face of the iterator to what they were before the
6639 display vector entry (these entries may contain faces). */
6640 it
->face_id
= it
->saved_face_id
;
6642 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6644 int recheck_faces
= it
->ellipsis_p
;
6647 it
->method
= GET_FROM_C_STRING
;
6648 else if (STRINGP (it
->string
))
6649 it
->method
= GET_FROM_STRING
;
6652 it
->method
= GET_FROM_BUFFER
;
6653 it
->object
= it
->w
->buffer
;
6657 it
->current
.dpvec_index
= -1;
6659 /* Skip over characters which were displayed via IT->dpvec. */
6660 if (it
->dpvec_char_len
< 0)
6661 reseat_at_next_visible_line_start (it
, 1);
6662 else if (it
->dpvec_char_len
> 0)
6664 if (it
->method
== GET_FROM_STRING
6665 && it
->n_overlay_strings
> 0)
6666 it
->ignore_overlay_strings_at_pos_p
= 1;
6667 it
->len
= it
->dpvec_char_len
;
6668 set_iterator_to_next (it
, reseat_p
);
6671 /* Maybe recheck faces after display vector */
6673 it
->stop_charpos
= IT_CHARPOS (*it
);
6677 case GET_FROM_STRING
:
6678 /* Current display element is a character from a Lisp string. */
6679 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6680 if (it
->cmp_it
.id
>= 0)
6686 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6687 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6688 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6689 it
->cmp_it
.from
= it
->cmp_it
.to
;
6693 composition_compute_stop_pos (&it
->cmp_it
,
6694 IT_STRING_CHARPOS (*it
),
6695 IT_STRING_BYTEPOS (*it
),
6696 it
->end_charpos
, it
->string
);
6699 else if (! it
->cmp_it
.reversed_p
)
6701 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6702 bidi_move_to_visually_next (&it
->bidi_it
);
6703 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6704 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6706 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6707 it
->cmp_it
.from
= it
->cmp_it
.to
;
6710 EMACS_INT stop
= it
->end_charpos
;
6711 if (it
->bidi_it
.scan_dir
< 0)
6713 composition_compute_stop_pos (&it
->cmp_it
,
6714 IT_STRING_CHARPOS (*it
),
6715 IT_STRING_BYTEPOS (*it
), stop
,
6721 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6722 bidi_move_to_visually_next (&it
->bidi_it
);
6723 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6724 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6725 if (it
->cmp_it
.from
> 0)
6726 it
->cmp_it
.to
= it
->cmp_it
.from
;
6729 EMACS_INT stop
= it
->end_charpos
;
6730 if (it
->bidi_it
.scan_dir
< 0)
6732 composition_compute_stop_pos (&it
->cmp_it
,
6733 IT_STRING_CHARPOS (*it
),
6734 IT_STRING_BYTEPOS (*it
), stop
,
6742 /* If the string position is beyond string's end, it
6743 means next_element_from_string is padding the string
6744 with blanks, in which case we bypass the bidi
6745 iterator, because it cannot deal with such virtual
6747 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6749 IT_STRING_BYTEPOS (*it
) += it
->len
;
6750 IT_STRING_CHARPOS (*it
) += 1;
6754 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6756 bidi_move_to_visually_next (&it
->bidi_it
);
6757 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6758 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6759 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6761 EMACS_INT stop
= it
->end_charpos
;
6763 if (it
->bidi_it
.scan_dir
< 0)
6765 composition_compute_stop_pos (&it
->cmp_it
,
6766 IT_STRING_CHARPOS (*it
),
6767 IT_STRING_BYTEPOS (*it
), stop
,
6773 consider_string_end
:
6775 if (it
->current
.overlay_string_index
>= 0)
6777 /* IT->string is an overlay string. Advance to the
6778 next, if there is one. */
6779 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6782 next_overlay_string (it
);
6784 setup_for_ellipsis (it
, 0);
6789 /* IT->string is not an overlay string. If we reached
6790 its end, and there is something on IT->stack, proceed
6791 with what is on the stack. This can be either another
6792 string, this time an overlay string, or a buffer. */
6793 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6797 if (it
->method
== GET_FROM_STRING
)
6798 goto consider_string_end
;
6803 case GET_FROM_IMAGE
:
6804 case GET_FROM_STRETCH
:
6805 /* The position etc with which we have to proceed are on
6806 the stack. The position may be at the end of a string,
6807 if the `display' property takes up the whole string. */
6808 xassert (it
->sp
> 0);
6810 if (it
->method
== GET_FROM_STRING
)
6811 goto consider_string_end
;
6815 /* There are no other methods defined, so this should be a bug. */
6819 xassert (it
->method
!= GET_FROM_STRING
6820 || (STRINGP (it
->string
)
6821 && IT_STRING_CHARPOS (*it
) >= 0));
6824 /* Load IT's display element fields with information about the next
6825 display element which comes from a display table entry or from the
6826 result of translating a control character to one of the forms `^C'
6829 IT->dpvec holds the glyphs to return as characters.
6830 IT->saved_face_id holds the face id before the display vector--it
6831 is restored into IT->face_id in set_iterator_to_next. */
6834 next_element_from_display_vector (struct it
*it
)
6839 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6841 it
->face_id
= it
->saved_face_id
;
6843 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6844 That seemed totally bogus - so I changed it... */
6845 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6847 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6849 it
->c
= GLYPH_CODE_CHAR (gc
);
6850 it
->len
= CHAR_BYTES (it
->c
);
6852 /* The entry may contain a face id to use. Such a face id is
6853 the id of a Lisp face, not a realized face. A face id of
6854 zero means no face is specified. */
6855 if (it
->dpvec_face_id
>= 0)
6856 it
->face_id
= it
->dpvec_face_id
;
6859 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6861 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6866 /* Display table entry is invalid. Return a space. */
6867 it
->c
= ' ', it
->len
= 1;
6869 /* Don't change position and object of the iterator here. They are
6870 still the values of the character that had this display table
6871 entry or was translated, and that's what we want. */
6872 it
->what
= IT_CHARACTER
;
6876 /* Get the first element of string/buffer in the visual order, after
6877 being reseated to a new position in a string or a buffer. */
6879 get_visually_first_element (struct it
*it
)
6881 int string_p
= STRINGP (it
->string
) || it
->s
;
6882 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6883 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6885 if (STRINGP (it
->string
))
6887 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6888 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6892 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6893 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6896 if (it
->bidi_it
.charpos
== eob
)
6898 /* Nothing to do, but reset the FIRST_ELT flag, like
6899 bidi_paragraph_init does, because we are not going to
6901 it
->bidi_it
.first_elt
= 0;
6903 else if (it
->bidi_it
.charpos
== bob
6905 /* FIXME: Should support all Unicode line separators. */
6906 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6907 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6909 /* If we are at the beginning of a line/string, we can produce
6910 the next element right away. */
6911 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6912 bidi_move_to_visually_next (&it
->bidi_it
);
6916 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6918 /* We need to prime the bidi iterator starting at the line's or
6919 string's beginning, before we will be able to produce the
6922 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6925 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6927 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6929 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6932 /* Now return to buffer/string position where we were asked
6933 to get the next display element, and produce that. */
6934 bidi_move_to_visually_next (&it
->bidi_it
);
6936 while (it
->bidi_it
.bytepos
!= orig_bytepos
6937 && it
->bidi_it
.charpos
< eob
);
6940 /* Adjust IT's position information to where we ended up. */
6941 if (STRINGP (it
->string
))
6943 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6944 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6948 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6949 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6952 if (STRINGP (it
->string
) || !it
->s
)
6954 EMACS_INT stop
, charpos
, bytepos
;
6956 if (STRINGP (it
->string
))
6959 stop
= SCHARS (it
->string
);
6960 if (stop
> it
->end_charpos
)
6961 stop
= it
->end_charpos
;
6962 charpos
= IT_STRING_CHARPOS (*it
);
6963 bytepos
= IT_STRING_BYTEPOS (*it
);
6967 stop
= it
->end_charpos
;
6968 charpos
= IT_CHARPOS (*it
);
6969 bytepos
= IT_BYTEPOS (*it
);
6971 if (it
->bidi_it
.scan_dir
< 0)
6973 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6978 /* Load IT with the next display element from Lisp string IT->string.
6979 IT->current.string_pos is the current position within the string.
6980 If IT->current.overlay_string_index >= 0, the Lisp string is an
6984 next_element_from_string (struct it
*it
)
6986 struct text_pos position
;
6988 xassert (STRINGP (it
->string
));
6989 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
6990 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6991 position
= it
->current
.string_pos
;
6993 /* With bidi reordering, the character to display might not be the
6994 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
6995 that we were reseat()ed to a new string, whose paragraph
6996 direction is not known. */
6997 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6999 get_visually_first_element (it
);
7000 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7003 /* Time to check for invisible text? */
7004 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7006 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7009 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7010 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7012 /* With bidi non-linear iteration, we could find
7013 ourselves far beyond the last computed stop_charpos,
7014 with several other stop positions in between that we
7015 missed. Scan them all now, in buffer's logical
7016 order, until we find and handle the last stop_charpos
7017 that precedes our current position. */
7018 handle_stop_backwards (it
, it
->stop_charpos
);
7019 return GET_NEXT_DISPLAY_ELEMENT (it
);
7025 /* Take note of the stop position we just moved
7026 across, for when we will move back across it. */
7027 it
->prev_stop
= it
->stop_charpos
;
7028 /* If we are at base paragraph embedding level, take
7029 note of the last stop position seen at this
7031 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7032 it
->base_level_stop
= it
->stop_charpos
;
7036 /* Since a handler may have changed IT->method, we must
7038 return GET_NEXT_DISPLAY_ELEMENT (it
);
7042 /* If we are before prev_stop, we may have overstepped
7043 on our way backwards a stop_pos, and if so, we need
7044 to handle that stop_pos. */
7045 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7046 /* We can sometimes back up for reasons that have nothing
7047 to do with bidi reordering. E.g., compositions. The
7048 code below is only needed when we are above the base
7049 embedding level, so test for that explicitly. */
7050 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7052 /* If we lost track of base_level_stop, we have no better
7053 place for handle_stop_backwards to start from than string
7054 beginning. This happens, e.g., when we were reseated to
7055 the previous screenful of text by vertical-motion. */
7056 if (it
->base_level_stop
<= 0
7057 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7058 it
->base_level_stop
= 0;
7059 handle_stop_backwards (it
, it
->base_level_stop
);
7060 return GET_NEXT_DISPLAY_ELEMENT (it
);
7064 if (it
->current
.overlay_string_index
>= 0)
7066 /* Get the next character from an overlay string. In overlay
7067 strings, There is no field width or padding with spaces to
7069 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7074 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7075 IT_STRING_BYTEPOS (*it
),
7076 it
->bidi_it
.scan_dir
< 0
7078 : SCHARS (it
->string
))
7079 && next_element_from_composition (it
))
7083 else if (STRING_MULTIBYTE (it
->string
))
7085 const unsigned char *s
= (SDATA (it
->string
)
7086 + IT_STRING_BYTEPOS (*it
));
7087 it
->c
= string_char_and_length (s
, &it
->len
);
7091 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7097 /* Get the next character from a Lisp string that is not an
7098 overlay string. Such strings come from the mode line, for
7099 example. We may have to pad with spaces, or truncate the
7100 string. See also next_element_from_c_string. */
7101 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7106 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7108 /* Pad with spaces. */
7109 it
->c
= ' ', it
->len
= 1;
7110 CHARPOS (position
) = BYTEPOS (position
) = -1;
7112 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7113 IT_STRING_BYTEPOS (*it
),
7114 it
->bidi_it
.scan_dir
< 0
7116 : it
->string_nchars
)
7117 && next_element_from_composition (it
))
7121 else if (STRING_MULTIBYTE (it
->string
))
7123 const unsigned char *s
= (SDATA (it
->string
)
7124 + IT_STRING_BYTEPOS (*it
));
7125 it
->c
= string_char_and_length (s
, &it
->len
);
7129 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7134 /* Record what we have and where it came from. */
7135 it
->what
= IT_CHARACTER
;
7136 it
->object
= it
->string
;
7137 it
->position
= position
;
7142 /* Load IT with next display element from C string IT->s.
7143 IT->string_nchars is the maximum number of characters to return
7144 from the string. IT->end_charpos may be greater than
7145 IT->string_nchars when this function is called, in which case we
7146 may have to return padding spaces. Value is zero if end of string
7147 reached, including padding spaces. */
7150 next_element_from_c_string (struct it
*it
)
7155 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7156 it
->what
= IT_CHARACTER
;
7157 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7160 /* With bidi reordering, the character to display might not be the
7161 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7162 we were reseated to a new string, whose paragraph direction is
7164 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7165 get_visually_first_element (it
);
7167 /* IT's position can be greater than IT->string_nchars in case a
7168 field width or precision has been specified when the iterator was
7170 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7172 /* End of the game. */
7176 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7178 /* Pad with spaces. */
7179 it
->c
= ' ', it
->len
= 1;
7180 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7182 else if (it
->multibyte_p
)
7183 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7185 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7191 /* Set up IT to return characters from an ellipsis, if appropriate.
7192 The definition of the ellipsis glyphs may come from a display table
7193 entry. This function fills IT with the first glyph from the
7194 ellipsis if an ellipsis is to be displayed. */
7197 next_element_from_ellipsis (struct it
*it
)
7199 if (it
->selective_display_ellipsis_p
)
7200 setup_for_ellipsis (it
, it
->len
);
7203 /* The face at the current position may be different from the
7204 face we find after the invisible text. Remember what it
7205 was in IT->saved_face_id, and signal that it's there by
7206 setting face_before_selective_p. */
7207 it
->saved_face_id
= it
->face_id
;
7208 it
->method
= GET_FROM_BUFFER
;
7209 it
->object
= it
->w
->buffer
;
7210 reseat_at_next_visible_line_start (it
, 1);
7211 it
->face_before_selective_p
= 1;
7214 return GET_NEXT_DISPLAY_ELEMENT (it
);
7218 /* Deliver an image display element. The iterator IT is already
7219 filled with image information (done in handle_display_prop). Value
7224 next_element_from_image (struct it
*it
)
7226 it
->what
= IT_IMAGE
;
7227 it
->ignore_overlay_strings_at_pos_p
= 0;
7232 /* Fill iterator IT with next display element from a stretch glyph
7233 property. IT->object is the value of the text property. Value is
7237 next_element_from_stretch (struct it
*it
)
7239 it
->what
= IT_STRETCH
;
7243 /* Scan backwards from IT's current position until we find a stop
7244 position, or until BEGV. This is called when we find ourself
7245 before both the last known prev_stop and base_level_stop while
7246 reordering bidirectional text. */
7249 compute_stop_pos_backwards (struct it
*it
)
7251 const int SCAN_BACK_LIMIT
= 1000;
7252 struct text_pos pos
;
7253 struct display_pos save_current
= it
->current
;
7254 struct text_pos save_position
= it
->position
;
7255 EMACS_INT charpos
= IT_CHARPOS (*it
);
7256 EMACS_INT where_we_are
= charpos
;
7257 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7258 EMACS_INT save_end_pos
= it
->end_charpos
;
7260 xassert (NILP (it
->string
) && !it
->s
);
7261 xassert (it
->bidi_p
);
7265 it
->end_charpos
= min (charpos
+ 1, ZV
);
7266 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7267 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7268 reseat_1 (it
, pos
, 0);
7269 compute_stop_pos (it
);
7270 /* We must advance forward, right? */
7271 if (it
->stop_charpos
<= charpos
)
7274 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7276 if (it
->stop_charpos
<= where_we_are
)
7277 it
->prev_stop
= it
->stop_charpos
;
7279 it
->prev_stop
= BEGV
;
7281 it
->current
= save_current
;
7282 it
->position
= save_position
;
7283 it
->stop_charpos
= save_stop_pos
;
7284 it
->end_charpos
= save_end_pos
;
7287 /* Scan forward from CHARPOS in the current buffer/string, until we
7288 find a stop position > current IT's position. Then handle the stop
7289 position before that. This is called when we bump into a stop
7290 position while reordering bidirectional text. CHARPOS should be
7291 the last previously processed stop_pos (or BEGV/0, if none were
7292 processed yet) whose position is less that IT's current
7296 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7298 int bufp
= !STRINGP (it
->string
);
7299 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7300 struct display_pos save_current
= it
->current
;
7301 struct text_pos save_position
= it
->position
;
7302 struct text_pos pos1
;
7303 EMACS_INT next_stop
;
7305 /* Scan in strict logical order. */
7306 xassert (it
->bidi_p
);
7310 it
->prev_stop
= charpos
;
7313 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7314 reseat_1 (it
, pos1
, 0);
7317 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7318 compute_stop_pos (it
);
7319 /* We must advance forward, right? */
7320 if (it
->stop_charpos
<= it
->prev_stop
)
7322 charpos
= it
->stop_charpos
;
7324 while (charpos
<= where_we_are
);
7327 it
->current
= save_current
;
7328 it
->position
= save_position
;
7329 next_stop
= it
->stop_charpos
;
7330 it
->stop_charpos
= it
->prev_stop
;
7332 it
->stop_charpos
= next_stop
;
7335 /* Load IT with the next display element from current_buffer. Value
7336 is zero if end of buffer reached. IT->stop_charpos is the next
7337 position at which to stop and check for text properties or buffer
7341 next_element_from_buffer (struct it
*it
)
7345 xassert (IT_CHARPOS (*it
) >= BEGV
);
7346 xassert (NILP (it
->string
) && !it
->s
);
7347 xassert (!it
->bidi_p
7348 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7349 && it
->bidi_it
.string
.s
== NULL
));
7351 /* With bidi reordering, the character to display might not be the
7352 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7353 we were reseat()ed to a new buffer position, which is potentially
7354 a different paragraph. */
7355 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7357 get_visually_first_element (it
);
7358 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7361 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7363 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7365 int overlay_strings_follow_p
;
7367 /* End of the game, except when overlay strings follow that
7368 haven't been returned yet. */
7369 if (it
->overlay_strings_at_end_processed_p
)
7370 overlay_strings_follow_p
= 0;
7373 it
->overlay_strings_at_end_processed_p
= 1;
7374 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7377 if (overlay_strings_follow_p
)
7378 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7382 it
->position
= it
->current
.pos
;
7386 else if (!(!it
->bidi_p
7387 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7388 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7390 /* With bidi non-linear iteration, we could find ourselves
7391 far beyond the last computed stop_charpos, with several
7392 other stop positions in between that we missed. Scan
7393 them all now, in buffer's logical order, until we find
7394 and handle the last stop_charpos that precedes our
7395 current position. */
7396 handle_stop_backwards (it
, it
->stop_charpos
);
7397 return GET_NEXT_DISPLAY_ELEMENT (it
);
7403 /* Take note of the stop position we just moved across,
7404 for when we will move back across it. */
7405 it
->prev_stop
= it
->stop_charpos
;
7406 /* If we are at base paragraph embedding level, take
7407 note of the last stop position seen at this
7409 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7410 it
->base_level_stop
= it
->stop_charpos
;
7413 return GET_NEXT_DISPLAY_ELEMENT (it
);
7417 /* If we are before prev_stop, we may have overstepped on
7418 our way backwards a stop_pos, and if so, we need to
7419 handle that stop_pos. */
7420 && IT_CHARPOS (*it
) < it
->prev_stop
7421 /* We can sometimes back up for reasons that have nothing
7422 to do with bidi reordering. E.g., compositions. The
7423 code below is only needed when we are above the base
7424 embedding level, so test for that explicitly. */
7425 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7427 if (it
->base_level_stop
<= 0
7428 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7430 /* If we lost track of base_level_stop, we need to find
7431 prev_stop by looking backwards. This happens, e.g., when
7432 we were reseated to the previous screenful of text by
7434 it
->base_level_stop
= BEGV
;
7435 compute_stop_pos_backwards (it
);
7436 handle_stop_backwards (it
, it
->prev_stop
);
7439 handle_stop_backwards (it
, it
->base_level_stop
);
7440 return GET_NEXT_DISPLAY_ELEMENT (it
);
7444 /* No face changes, overlays etc. in sight, so just return a
7445 character from current_buffer. */
7449 /* Maybe run the redisplay end trigger hook. Performance note:
7450 This doesn't seem to cost measurable time. */
7451 if (it
->redisplay_end_trigger_charpos
7453 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7454 run_redisplay_end_trigger_hook (it
);
7456 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7457 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7459 && next_element_from_composition (it
))
7464 /* Get the next character, maybe multibyte. */
7465 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7466 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7467 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7469 it
->c
= *p
, it
->len
= 1;
7471 /* Record what we have and where it came from. */
7472 it
->what
= IT_CHARACTER
;
7473 it
->object
= it
->w
->buffer
;
7474 it
->position
= it
->current
.pos
;
7476 /* Normally we return the character found above, except when we
7477 really want to return an ellipsis for selective display. */
7482 /* A value of selective > 0 means hide lines indented more
7483 than that number of columns. */
7484 if (it
->selective
> 0
7485 && IT_CHARPOS (*it
) + 1 < ZV
7486 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7487 IT_BYTEPOS (*it
) + 1,
7490 success_p
= next_element_from_ellipsis (it
);
7491 it
->dpvec_char_len
= -1;
7494 else if (it
->c
== '\r' && it
->selective
== -1)
7496 /* A value of selective == -1 means that everything from the
7497 CR to the end of the line is invisible, with maybe an
7498 ellipsis displayed for it. */
7499 success_p
= next_element_from_ellipsis (it
);
7500 it
->dpvec_char_len
= -1;
7505 /* Value is zero if end of buffer reached. */
7506 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7511 /* Run the redisplay end trigger hook for IT. */
7514 run_redisplay_end_trigger_hook (struct it
*it
)
7516 Lisp_Object args
[3];
7518 /* IT->glyph_row should be non-null, i.e. we should be actually
7519 displaying something, or otherwise we should not run the hook. */
7520 xassert (it
->glyph_row
);
7522 /* Set up hook arguments. */
7523 args
[0] = Qredisplay_end_trigger_functions
;
7524 args
[1] = it
->window
;
7525 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7526 it
->redisplay_end_trigger_charpos
= 0;
7528 /* Since we are *trying* to run these functions, don't try to run
7529 them again, even if they get an error. */
7530 it
->w
->redisplay_end_trigger
= Qnil
;
7531 Frun_hook_with_args (3, args
);
7533 /* Notice if it changed the face of the character we are on. */
7534 handle_face_prop (it
);
7538 /* Deliver a composition display element. Unlike the other
7539 next_element_from_XXX, this function is not registered in the array
7540 get_next_element[]. It is called from next_element_from_buffer and
7541 next_element_from_string when necessary. */
7544 next_element_from_composition (struct it
*it
)
7546 it
->what
= IT_COMPOSITION
;
7547 it
->len
= it
->cmp_it
.nbytes
;
7548 if (STRINGP (it
->string
))
7552 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7553 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7556 it
->position
= it
->current
.string_pos
;
7557 it
->object
= it
->string
;
7558 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7559 IT_STRING_BYTEPOS (*it
), it
->string
);
7565 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7566 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7569 if (it
->bidi_it
.new_paragraph
)
7570 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7571 /* Resync the bidi iterator with IT's new position.
7572 FIXME: this doesn't support bidirectional text. */
7573 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7574 bidi_move_to_visually_next (&it
->bidi_it
);
7578 it
->position
= it
->current
.pos
;
7579 it
->object
= it
->w
->buffer
;
7580 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7581 IT_BYTEPOS (*it
), Qnil
);
7588 /***********************************************************************
7589 Moving an iterator without producing glyphs
7590 ***********************************************************************/
7592 /* Check if iterator is at a position corresponding to a valid buffer
7593 position after some move_it_ call. */
7595 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7596 ((it)->method == GET_FROM_STRING \
7597 ? IT_STRING_CHARPOS (*it) == 0 \
7601 /* Move iterator IT to a specified buffer or X position within one
7602 line on the display without producing glyphs.
7604 OP should be a bit mask including some or all of these bits:
7605 MOVE_TO_X: Stop upon reaching x-position TO_X.
7606 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7607 Regardless of OP's value, stop upon reaching the end of the display line.
7609 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7610 This means, in particular, that TO_X includes window's horizontal
7613 The return value has several possible values that
7614 say what condition caused the scan to stop:
7616 MOVE_POS_MATCH_OR_ZV
7617 - when TO_POS or ZV was reached.
7620 -when TO_X was reached before TO_POS or ZV were reached.
7623 - when we reached the end of the display area and the line must
7627 - when we reached the end of the display area and the line is
7631 - when we stopped at a line end, i.e. a newline or a CR and selective
7634 static enum move_it_result
7635 move_it_in_display_line_to (struct it
*it
,
7636 EMACS_INT to_charpos
, int to_x
,
7637 enum move_operation_enum op
)
7639 enum move_it_result result
= MOVE_UNDEFINED
;
7640 struct glyph_row
*saved_glyph_row
;
7641 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7642 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7643 void *ppos_data
= NULL
;
7645 enum it_method prev_method
= it
->method
;
7646 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7647 int saw_smaller_pos
= prev_pos
< to_charpos
;
7649 /* Don't produce glyphs in produce_glyphs. */
7650 saved_glyph_row
= it
->glyph_row
;
7651 it
->glyph_row
= NULL
;
7653 /* Use wrap_it to save a copy of IT wherever a word wrap could
7654 occur. Use atpos_it to save a copy of IT at the desired buffer
7655 position, if found, so that we can scan ahead and check if the
7656 word later overshoots the window edge. Use atx_it similarly, for
7662 /* Use ppos_it under bidi reordering to save a copy of IT for the
7663 position > CHARPOS that is the closest to CHARPOS. We restore
7664 that position in IT when we have scanned the entire display line
7665 without finding a match for CHARPOS and all the character
7666 positions are greater than CHARPOS. */
7669 SAVE_IT (ppos_it
, *it
, ppos_data
);
7670 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7671 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7672 SAVE_IT (ppos_it
, *it
, ppos_data
);
7675 #define BUFFER_POS_REACHED_P() \
7676 ((op & MOVE_TO_POS) != 0 \
7677 && BUFFERP (it->object) \
7678 && (IT_CHARPOS (*it) == to_charpos \
7679 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7680 && (it->method == GET_FROM_BUFFER \
7681 || (it->method == GET_FROM_DISPLAY_VECTOR \
7682 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7684 /* If there's a line-/wrap-prefix, handle it. */
7685 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7686 && it
->current_y
< it
->last_visible_y
)
7687 handle_line_prefix (it
);
7689 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7690 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7694 int x
, i
, ascent
= 0, descent
= 0;
7696 /* Utility macro to reset an iterator with x, ascent, and descent. */
7697 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7698 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7699 (IT)->max_descent = descent)
7701 /* Stop if we move beyond TO_CHARPOS (after an image or a
7702 display string or stretch glyph). */
7703 if ((op
& MOVE_TO_POS
) != 0
7704 && BUFFERP (it
->object
)
7705 && it
->method
== GET_FROM_BUFFER
7706 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7708 && (prev_method
== GET_FROM_IMAGE
7709 || prev_method
== GET_FROM_STRETCH
7710 || prev_method
== GET_FROM_STRING
)
7711 /* Passed TO_CHARPOS from left to right. */
7712 && ((prev_pos
< to_charpos
7713 && IT_CHARPOS (*it
) > to_charpos
)
7714 /* Passed TO_CHARPOS from right to left. */
7715 || (prev_pos
> to_charpos
7716 && IT_CHARPOS (*it
) < to_charpos
)))))
7718 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7720 result
= MOVE_POS_MATCH_OR_ZV
;
7723 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7724 /* If wrap_it is valid, the current position might be in a
7725 word that is wrapped. So, save the iterator in
7726 atpos_it and continue to see if wrapping happens. */
7727 SAVE_IT (atpos_it
, *it
, atpos_data
);
7730 /* Stop when ZV reached.
7731 We used to stop here when TO_CHARPOS reached as well, but that is
7732 too soon if this glyph does not fit on this line. So we handle it
7733 explicitly below. */
7734 if (!get_next_display_element (it
))
7736 result
= MOVE_POS_MATCH_OR_ZV
;
7740 if (it
->line_wrap
== TRUNCATE
)
7742 if (BUFFER_POS_REACHED_P ())
7744 result
= MOVE_POS_MATCH_OR_ZV
;
7750 if (it
->line_wrap
== WORD_WRAP
)
7752 if (IT_DISPLAYING_WHITESPACE (it
))
7756 /* We have reached a glyph that follows one or more
7757 whitespace characters. If the position is
7758 already found, we are done. */
7759 if (atpos_it
.sp
>= 0)
7761 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7762 result
= MOVE_POS_MATCH_OR_ZV
;
7767 RESTORE_IT (it
, &atx_it
, atx_data
);
7768 result
= MOVE_X_REACHED
;
7771 /* Otherwise, we can wrap here. */
7772 SAVE_IT (wrap_it
, *it
, wrap_data
);
7778 /* Remember the line height for the current line, in case
7779 the next element doesn't fit on the line. */
7780 ascent
= it
->max_ascent
;
7781 descent
= it
->max_descent
;
7783 /* The call to produce_glyphs will get the metrics of the
7784 display element IT is loaded with. Record the x-position
7785 before this display element, in case it doesn't fit on the
7789 PRODUCE_GLYPHS (it
);
7791 if (it
->area
!= TEXT_AREA
)
7793 prev_method
= it
->method
;
7794 if (it
->method
== GET_FROM_BUFFER
)
7795 prev_pos
= IT_CHARPOS (*it
);
7796 set_iterator_to_next (it
, 1);
7797 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7798 SET_TEXT_POS (this_line_min_pos
,
7799 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7801 && (op
& MOVE_TO_POS
)
7802 && IT_CHARPOS (*it
) > to_charpos
7803 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7804 SAVE_IT (ppos_it
, *it
, ppos_data
);
7808 /* The number of glyphs we get back in IT->nglyphs will normally
7809 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7810 character on a terminal frame, or (iii) a line end. For the
7811 second case, IT->nglyphs - 1 padding glyphs will be present.
7812 (On X frames, there is only one glyph produced for a
7813 composite character.)
7815 The behavior implemented below means, for continuation lines,
7816 that as many spaces of a TAB as fit on the current line are
7817 displayed there. For terminal frames, as many glyphs of a
7818 multi-glyph character are displayed in the current line, too.
7819 This is what the old redisplay code did, and we keep it that
7820 way. Under X, the whole shape of a complex character must
7821 fit on the line or it will be completely displayed in the
7824 Note that both for tabs and padding glyphs, all glyphs have
7828 /* More than one glyph or glyph doesn't fit on line. All
7829 glyphs have the same width. */
7830 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7832 int x_before_this_char
= x
;
7833 int hpos_before_this_char
= it
->hpos
;
7835 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7837 new_x
= x
+ single_glyph_width
;
7839 /* We want to leave anything reaching TO_X to the caller. */
7840 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7842 if (BUFFER_POS_REACHED_P ())
7844 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7845 goto buffer_pos_reached
;
7846 if (atpos_it
.sp
< 0)
7848 SAVE_IT (atpos_it
, *it
, atpos_data
);
7849 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7854 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7857 result
= MOVE_X_REACHED
;
7862 SAVE_IT (atx_it
, *it
, atx_data
);
7863 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7868 if (/* Lines are continued. */
7869 it
->line_wrap
!= TRUNCATE
7870 && (/* And glyph doesn't fit on the line. */
7871 new_x
> it
->last_visible_x
7872 /* Or it fits exactly and we're on a window
7874 || (new_x
== it
->last_visible_x
7875 && FRAME_WINDOW_P (it
->f
))))
7877 if (/* IT->hpos == 0 means the very first glyph
7878 doesn't fit on the line, e.g. a wide image. */
7880 || (new_x
== it
->last_visible_x
7881 && FRAME_WINDOW_P (it
->f
)))
7884 it
->current_x
= new_x
;
7886 /* The character's last glyph just barely fits
7888 if (i
== it
->nglyphs
- 1)
7890 /* If this is the destination position,
7891 return a position *before* it in this row,
7892 now that we know it fits in this row. */
7893 if (BUFFER_POS_REACHED_P ())
7895 if (it
->line_wrap
!= WORD_WRAP
7898 it
->hpos
= hpos_before_this_char
;
7899 it
->current_x
= x_before_this_char
;
7900 result
= MOVE_POS_MATCH_OR_ZV
;
7903 if (it
->line_wrap
== WORD_WRAP
7906 SAVE_IT (atpos_it
, *it
, atpos_data
);
7907 atpos_it
.current_x
= x_before_this_char
;
7908 atpos_it
.hpos
= hpos_before_this_char
;
7912 prev_method
= it
->method
;
7913 if (it
->method
== GET_FROM_BUFFER
)
7914 prev_pos
= IT_CHARPOS (*it
);
7915 set_iterator_to_next (it
, 1);
7916 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7917 SET_TEXT_POS (this_line_min_pos
,
7918 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7919 /* On graphical terminals, newlines may
7920 "overflow" into the fringe if
7921 overflow-newline-into-fringe is non-nil.
7922 On text-only terminals, newlines may
7923 overflow into the last glyph on the
7925 if (!FRAME_WINDOW_P (it
->f
)
7926 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7928 if (!get_next_display_element (it
))
7930 result
= MOVE_POS_MATCH_OR_ZV
;
7933 if (BUFFER_POS_REACHED_P ())
7935 if (ITERATOR_AT_END_OF_LINE_P (it
))
7936 result
= MOVE_POS_MATCH_OR_ZV
;
7938 result
= MOVE_LINE_CONTINUED
;
7941 if (ITERATOR_AT_END_OF_LINE_P (it
))
7943 result
= MOVE_NEWLINE_OR_CR
;
7950 IT_RESET_X_ASCENT_DESCENT (it
);
7952 if (wrap_it
.sp
>= 0)
7954 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7959 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7961 result
= MOVE_LINE_CONTINUED
;
7965 if (BUFFER_POS_REACHED_P ())
7967 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7968 goto buffer_pos_reached
;
7969 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7971 SAVE_IT (atpos_it
, *it
, atpos_data
);
7972 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7976 if (new_x
> it
->first_visible_x
)
7978 /* Glyph is visible. Increment number of glyphs that
7979 would be displayed. */
7984 if (result
!= MOVE_UNDEFINED
)
7987 else if (BUFFER_POS_REACHED_P ())
7990 IT_RESET_X_ASCENT_DESCENT (it
);
7991 result
= MOVE_POS_MATCH_OR_ZV
;
7994 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7996 /* Stop when TO_X specified and reached. This check is
7997 necessary here because of lines consisting of a line end,
7998 only. The line end will not produce any glyphs and we
7999 would never get MOVE_X_REACHED. */
8000 xassert (it
->nglyphs
== 0);
8001 result
= MOVE_X_REACHED
;
8005 /* Is this a line end? If yes, we're done. */
8006 if (ITERATOR_AT_END_OF_LINE_P (it
))
8008 /* If we are past TO_CHARPOS, but never saw any character
8009 positions smaller than TO_CHARPOS, return
8010 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8012 if ((op
& MOVE_TO_POS
) != 0
8014 && IT_CHARPOS (*it
) > to_charpos
)
8016 result
= MOVE_POS_MATCH_OR_ZV
;
8017 if (it
->bidi_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8018 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8021 result
= MOVE_NEWLINE_OR_CR
;
8025 prev_method
= it
->method
;
8026 if (it
->method
== GET_FROM_BUFFER
)
8027 prev_pos
= IT_CHARPOS (*it
);
8028 /* The current display element has been consumed. Advance
8030 set_iterator_to_next (it
, 1);
8031 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8032 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8033 if (IT_CHARPOS (*it
) < to_charpos
)
8034 saw_smaller_pos
= 1;
8036 && (op
& MOVE_TO_POS
)
8037 && IT_CHARPOS (*it
) >= to_charpos
8038 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8039 SAVE_IT (ppos_it
, *it
, ppos_data
);
8041 /* Stop if lines are truncated and IT's current x-position is
8042 past the right edge of the window now. */
8043 if (it
->line_wrap
== TRUNCATE
8044 && it
->current_x
>= it
->last_visible_x
)
8046 if (!FRAME_WINDOW_P (it
->f
)
8047 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8051 if ((at_eob_p
= !get_next_display_element (it
))
8052 || BUFFER_POS_REACHED_P ()
8053 /* If we are past TO_CHARPOS, but never saw any
8054 character positions smaller than TO_CHARPOS,
8055 return MOVE_POS_MATCH_OR_ZV, like the
8056 unidirectional display did. */
8057 || ((op
& MOVE_TO_POS
) != 0
8059 && IT_CHARPOS (*it
) > to_charpos
))
8061 result
= MOVE_POS_MATCH_OR_ZV
;
8062 if (it
->bidi_p
&& !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8063 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8066 if (ITERATOR_AT_END_OF_LINE_P (it
))
8068 result
= MOVE_NEWLINE_OR_CR
;
8072 else if ((op
& MOVE_TO_POS
) != 0
8074 && IT_CHARPOS (*it
) > to_charpos
)
8076 result
= MOVE_POS_MATCH_OR_ZV
;
8077 if (it
->bidi_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8078 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8081 result
= MOVE_LINE_TRUNCATED
;
8084 #undef IT_RESET_X_ASCENT_DESCENT
8087 #undef BUFFER_POS_REACHED_P
8089 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8090 restore the saved iterator. */
8091 if (atpos_it
.sp
>= 0)
8092 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8093 else if (atx_it
.sp
>= 0)
8094 RESTORE_IT (it
, &atx_it
, atx_data
);
8107 /* Restore the iterator settings altered at the beginning of this
8109 it
->glyph_row
= saved_glyph_row
;
8113 /* For external use. */
8115 move_it_in_display_line (struct it
*it
,
8116 EMACS_INT to_charpos
, int to_x
,
8117 enum move_operation_enum op
)
8119 if (it
->line_wrap
== WORD_WRAP
8120 && (op
& MOVE_TO_X
))
8123 void *save_data
= NULL
;
8126 SAVE_IT (save_it
, *it
, save_data
);
8127 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8128 /* When word-wrap is on, TO_X may lie past the end
8129 of a wrapped line. Then it->current is the
8130 character on the next line, so backtrack to the
8131 space before the wrap point. */
8132 if (skip
== MOVE_LINE_CONTINUED
)
8134 int prev_x
= max (it
->current_x
- 1, 0);
8135 RESTORE_IT (it
, &save_it
, save_data
);
8136 move_it_in_display_line_to
8137 (it
, -1, prev_x
, MOVE_TO_X
);
8143 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8147 /* Move IT forward until it satisfies one or more of the criteria in
8148 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8150 OP is a bit-mask that specifies where to stop, and in particular,
8151 which of those four position arguments makes a difference. See the
8152 description of enum move_operation_enum.
8154 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8155 screen line, this function will set IT to the next position that is
8156 displayed to the right of TO_CHARPOS on the screen. */
8159 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8161 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8162 int line_height
, line_start_x
= 0, reached
= 0;
8163 void *backup_data
= NULL
;
8167 if (op
& MOVE_TO_VPOS
)
8169 /* If no TO_CHARPOS and no TO_X specified, stop at the
8170 start of the line TO_VPOS. */
8171 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8173 if (it
->vpos
== to_vpos
)
8179 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8183 /* TO_VPOS >= 0 means stop at TO_X in the line at
8184 TO_VPOS, or at TO_POS, whichever comes first. */
8185 if (it
->vpos
== to_vpos
)
8191 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8193 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8198 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8200 /* We have reached TO_X but not in the line we want. */
8201 skip
= move_it_in_display_line_to (it
, to_charpos
,
8203 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8211 else if (op
& MOVE_TO_Y
)
8213 struct it it_backup
;
8215 if (it
->line_wrap
== WORD_WRAP
)
8216 SAVE_IT (it_backup
, *it
, backup_data
);
8218 /* TO_Y specified means stop at TO_X in the line containing
8219 TO_Y---or at TO_CHARPOS if this is reached first. The
8220 problem is that we can't really tell whether the line
8221 contains TO_Y before we have completely scanned it, and
8222 this may skip past TO_X. What we do is to first scan to
8225 If TO_X is not specified, use a TO_X of zero. The reason
8226 is to make the outcome of this function more predictable.
8227 If we didn't use TO_X == 0, we would stop at the end of
8228 the line which is probably not what a caller would expect
8230 skip
= move_it_in_display_line_to
8231 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8232 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8234 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8235 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8237 else if (skip
== MOVE_X_REACHED
)
8239 /* If TO_X was reached, we want to know whether TO_Y is
8240 in the line. We know this is the case if the already
8241 scanned glyphs make the line tall enough. Otherwise,
8242 we must check by scanning the rest of the line. */
8243 line_height
= it
->max_ascent
+ it
->max_descent
;
8244 if (to_y
>= it
->current_y
8245 && to_y
< it
->current_y
+ line_height
)
8250 SAVE_IT (it_backup
, *it
, backup_data
);
8251 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8252 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8254 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8255 line_height
= it
->max_ascent
+ it
->max_descent
;
8256 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8258 if (to_y
>= it
->current_y
8259 && to_y
< it
->current_y
+ line_height
)
8261 /* If TO_Y is in this line and TO_X was reached
8262 above, we scanned too far. We have to restore
8263 IT's settings to the ones before skipping. */
8264 RESTORE_IT (it
, &it_backup
, backup_data
);
8270 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8276 /* Check whether TO_Y is in this line. */
8277 line_height
= it
->max_ascent
+ it
->max_descent
;
8278 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8280 if (to_y
>= it
->current_y
8281 && to_y
< it
->current_y
+ line_height
)
8283 /* When word-wrap is on, TO_X may lie past the end
8284 of a wrapped line. Then it->current is the
8285 character on the next line, so backtrack to the
8286 space before the wrap point. */
8287 if (skip
== MOVE_LINE_CONTINUED
8288 && it
->line_wrap
== WORD_WRAP
)
8290 int prev_x
= max (it
->current_x
- 1, 0);
8291 RESTORE_IT (it
, &it_backup
, backup_data
);
8292 skip
= move_it_in_display_line_to
8293 (it
, -1, prev_x
, MOVE_TO_X
);
8302 else if (BUFFERP (it
->object
)
8303 && (it
->method
== GET_FROM_BUFFER
8304 || it
->method
== GET_FROM_STRETCH
)
8305 && IT_CHARPOS (*it
) >= to_charpos
)
8306 skip
= MOVE_POS_MATCH_OR_ZV
;
8308 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8312 case MOVE_POS_MATCH_OR_ZV
:
8316 case MOVE_NEWLINE_OR_CR
:
8317 set_iterator_to_next (it
, 1);
8318 it
->continuation_lines_width
= 0;
8321 case MOVE_LINE_TRUNCATED
:
8322 it
->continuation_lines_width
= 0;
8323 reseat_at_next_visible_line_start (it
, 0);
8324 if ((op
& MOVE_TO_POS
) != 0
8325 && IT_CHARPOS (*it
) > to_charpos
)
8332 case MOVE_LINE_CONTINUED
:
8333 /* For continued lines ending in a tab, some of the glyphs
8334 associated with the tab are displayed on the current
8335 line. Since it->current_x does not include these glyphs,
8336 we use it->last_visible_x instead. */
8339 it
->continuation_lines_width
+= it
->last_visible_x
;
8340 /* When moving by vpos, ensure that the iterator really
8341 advances to the next line (bug#847, bug#969). Fixme:
8342 do we need to do this in other circumstances? */
8343 if (it
->current_x
!= it
->last_visible_x
8344 && (op
& MOVE_TO_VPOS
)
8345 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8347 line_start_x
= it
->current_x
+ it
->pixel_width
8348 - it
->last_visible_x
;
8349 set_iterator_to_next (it
, 0);
8353 it
->continuation_lines_width
+= it
->current_x
;
8360 /* Reset/increment for the next run. */
8361 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8362 it
->current_x
= line_start_x
;
8365 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8367 last_height
= it
->max_ascent
+ it
->max_descent
;
8368 last_max_ascent
= it
->max_ascent
;
8369 it
->max_ascent
= it
->max_descent
= 0;
8374 /* On text terminals, we may stop at the end of a line in the middle
8375 of a multi-character glyph. If the glyph itself is continued,
8376 i.e. it is actually displayed on the next line, don't treat this
8377 stopping point as valid; move to the next line instead (unless
8378 that brings us offscreen). */
8379 if (!FRAME_WINDOW_P (it
->f
)
8381 && IT_CHARPOS (*it
) == to_charpos
8382 && it
->what
== IT_CHARACTER
8384 && it
->line_wrap
== WINDOW_WRAP
8385 && it
->current_x
== it
->last_visible_x
- 1
8388 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8390 it
->continuation_lines_width
+= it
->current_x
;
8391 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8392 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8394 last_height
= it
->max_ascent
+ it
->max_descent
;
8395 last_max_ascent
= it
->max_ascent
;
8399 xfree (backup_data
);
8401 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8405 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8407 If DY > 0, move IT backward at least that many pixels. DY = 0
8408 means move IT backward to the preceding line start or BEGV. This
8409 function may move over more than DY pixels if IT->current_y - DY
8410 ends up in the middle of a line; in this case IT->current_y will be
8411 set to the top of the line moved to. */
8414 move_it_vertically_backward (struct it
*it
, int dy
)
8418 void *it2data
= NULL
, *it3data
= NULL
;
8419 EMACS_INT start_pos
;
8424 start_pos
= IT_CHARPOS (*it
);
8426 /* Estimate how many newlines we must move back. */
8427 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8429 /* Set the iterator's position that many lines back. */
8430 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8431 back_to_previous_visible_line_start (it
);
8433 /* Reseat the iterator here. When moving backward, we don't want
8434 reseat to skip forward over invisible text, set up the iterator
8435 to deliver from overlay strings at the new position etc. So,
8436 use reseat_1 here. */
8437 reseat_1 (it
, it
->current
.pos
, 1);
8439 /* We are now surely at a line start. */
8440 it
->current_x
= it
->hpos
= 0;
8441 it
->continuation_lines_width
= 0;
8443 /* Move forward and see what y-distance we moved. First move to the
8444 start of the next line so that we get its height. We need this
8445 height to be able to tell whether we reached the specified
8447 SAVE_IT (it2
, *it
, it2data
);
8448 it2
.max_ascent
= it2
.max_descent
= 0;
8451 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8452 MOVE_TO_POS
| MOVE_TO_VPOS
);
8454 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8455 xassert (IT_CHARPOS (*it
) >= BEGV
);
8456 SAVE_IT (it3
, it2
, it3data
);
8458 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8459 xassert (IT_CHARPOS (*it
) >= BEGV
);
8460 /* H is the actual vertical distance from the position in *IT
8461 and the starting position. */
8462 h
= it2
.current_y
- it
->current_y
;
8463 /* NLINES is the distance in number of lines. */
8464 nlines
= it2
.vpos
- it
->vpos
;
8466 /* Correct IT's y and vpos position
8467 so that they are relative to the starting point. */
8473 /* DY == 0 means move to the start of the screen line. The
8474 value of nlines is > 0 if continuation lines were involved. */
8475 RESTORE_IT (it
, it
, it2data
);
8477 move_it_by_lines (it
, nlines
);
8482 /* The y-position we try to reach, relative to *IT.
8483 Note that H has been subtracted in front of the if-statement. */
8484 int target_y
= it
->current_y
+ h
- dy
;
8485 int y0
= it3
.current_y
;
8489 RESTORE_IT (&it3
, &it3
, it3data
);
8490 y1
= line_bottom_y (&it3
);
8491 line_height
= y1
- y0
;
8492 RESTORE_IT (it
, it
, it2data
);
8493 /* If we did not reach target_y, try to move further backward if
8494 we can. If we moved too far backward, try to move forward. */
8495 if (target_y
< it
->current_y
8496 /* This is heuristic. In a window that's 3 lines high, with
8497 a line height of 13 pixels each, recentering with point
8498 on the bottom line will try to move -39/2 = 19 pixels
8499 backward. Try to avoid moving into the first line. */
8500 && (it
->current_y
- target_y
8501 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8502 && IT_CHARPOS (*it
) > BEGV
)
8504 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8505 target_y
- it
->current_y
));
8506 dy
= it
->current_y
- target_y
;
8507 goto move_further_back
;
8509 else if (target_y
>= it
->current_y
+ line_height
8510 && IT_CHARPOS (*it
) < ZV
)
8512 /* Should move forward by at least one line, maybe more.
8514 Note: Calling move_it_by_lines can be expensive on
8515 terminal frames, where compute_motion is used (via
8516 vmotion) to do the job, when there are very long lines
8517 and truncate-lines is nil. That's the reason for
8518 treating terminal frames specially here. */
8520 if (!FRAME_WINDOW_P (it
->f
))
8521 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8526 move_it_by_lines (it
, 1);
8528 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8535 /* Move IT by a specified amount of pixel lines DY. DY negative means
8536 move backwards. DY = 0 means move to start of screen line. At the
8537 end, IT will be on the start of a screen line. */
8540 move_it_vertically (struct it
*it
, int dy
)
8543 move_it_vertically_backward (it
, -dy
);
8546 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8547 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8548 MOVE_TO_POS
| MOVE_TO_Y
);
8549 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8551 /* If buffer ends in ZV without a newline, move to the start of
8552 the line to satisfy the post-condition. */
8553 if (IT_CHARPOS (*it
) == ZV
8555 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8556 move_it_by_lines (it
, 0);
8561 /* Move iterator IT past the end of the text line it is in. */
8564 move_it_past_eol (struct it
*it
)
8566 enum move_it_result rc
;
8568 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8569 if (rc
== MOVE_NEWLINE_OR_CR
)
8570 set_iterator_to_next (it
, 0);
8574 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8575 negative means move up. DVPOS == 0 means move to the start of the
8578 Optimization idea: If we would know that IT->f doesn't use
8579 a face with proportional font, we could be faster for
8580 truncate-lines nil. */
8583 move_it_by_lines (struct it
*it
, int dvpos
)
8586 /* The commented-out optimization uses vmotion on terminals. This
8587 gives bad results, because elements like it->what, on which
8588 callers such as pos_visible_p rely, aren't updated. */
8589 /* struct position pos;
8590 if (!FRAME_WINDOW_P (it->f))
8592 struct text_pos textpos;
8594 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8595 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8596 reseat (it, textpos, 1);
8597 it->vpos += pos.vpos;
8598 it->current_y += pos.vpos;
8604 /* DVPOS == 0 means move to the start of the screen line. */
8605 move_it_vertically_backward (it
, 0);
8606 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8607 /* Let next call to line_bottom_y calculate real line height */
8612 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8613 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8614 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8619 void *it2data
= NULL
;
8620 EMACS_INT start_charpos
, i
;
8622 /* Start at the beginning of the screen line containing IT's
8623 position. This may actually move vertically backwards,
8624 in case of overlays, so adjust dvpos accordingly. */
8626 move_it_vertically_backward (it
, 0);
8629 /* Go back -DVPOS visible lines and reseat the iterator there. */
8630 start_charpos
= IT_CHARPOS (*it
);
8631 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8632 back_to_previous_visible_line_start (it
);
8633 reseat (it
, it
->current
.pos
, 1);
8635 /* Move further back if we end up in a string or an image. */
8636 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8638 /* First try to move to start of display line. */
8640 move_it_vertically_backward (it
, 0);
8642 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8644 /* If start of line is still in string or image,
8645 move further back. */
8646 back_to_previous_visible_line_start (it
);
8647 reseat (it
, it
->current
.pos
, 1);
8651 it
->current_x
= it
->hpos
= 0;
8653 /* Above call may have moved too far if continuation lines
8654 are involved. Scan forward and see if it did. */
8655 SAVE_IT (it2
, *it
, it2data
);
8656 it2
.vpos
= it2
.current_y
= 0;
8657 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8658 it
->vpos
-= it2
.vpos
;
8659 it
->current_y
-= it2
.current_y
;
8660 it
->current_x
= it
->hpos
= 0;
8662 /* If we moved too far back, move IT some lines forward. */
8663 if (it2
.vpos
> -dvpos
)
8665 int delta
= it2
.vpos
+ dvpos
;
8667 RESTORE_IT (&it2
, &it2
, it2data
);
8668 SAVE_IT (it2
, *it
, it2data
);
8669 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8670 /* Move back again if we got too far ahead. */
8671 if (IT_CHARPOS (*it
) >= start_charpos
)
8672 RESTORE_IT (it
, &it2
, it2data
);
8677 RESTORE_IT (it
, it
, it2data
);
8681 /* Return 1 if IT points into the middle of a display vector. */
8684 in_display_vector_p (struct it
*it
)
8686 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8687 && it
->current
.dpvec_index
> 0
8688 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8692 /***********************************************************************
8694 ***********************************************************************/
8697 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8701 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8703 Lisp_Object args
[3];
8704 Lisp_Object msg
, fmt
;
8707 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8710 /* Do nothing if called asynchronously. Inserting text into
8711 a buffer may call after-change-functions and alike and
8712 that would means running Lisp asynchronously. */
8713 if (handling_signal
)
8717 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8719 args
[0] = fmt
= build_string (format
);
8722 msg
= Fformat (3, args
);
8724 len
= SBYTES (msg
) + 1;
8725 SAFE_ALLOCA (buffer
, char *, len
);
8726 memcpy (buffer
, SDATA (msg
), len
);
8728 message_dolog (buffer
, len
- 1, 1, 0);
8735 /* Output a newline in the *Messages* buffer if "needs" one. */
8738 message_log_maybe_newline (void)
8740 if (message_log_need_newline
)
8741 message_dolog ("", 0, 1, 0);
8745 /* Add a string M of length NBYTES to the message log, optionally
8746 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8747 nonzero, means interpret the contents of M as multibyte. This
8748 function calls low-level routines in order to bypass text property
8749 hooks, etc. which might not be safe to run.
8751 This may GC (insert may run before/after change hooks),
8752 so the buffer M must NOT point to a Lisp string. */
8755 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8757 const unsigned char *msg
= (const unsigned char *) m
;
8759 if (!NILP (Vmemory_full
))
8762 if (!NILP (Vmessage_log_max
))
8764 struct buffer
*oldbuf
;
8765 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8766 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8767 EMACS_INT point_at_end
= 0;
8768 EMACS_INT zv_at_end
= 0;
8769 Lisp_Object old_deactivate_mark
, tem
;
8770 struct gcpro gcpro1
;
8772 old_deactivate_mark
= Vdeactivate_mark
;
8773 oldbuf
= current_buffer
;
8774 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8775 BVAR (current_buffer
, undo_list
) = Qt
;
8777 oldpoint
= message_dolog_marker1
;
8778 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8779 oldbegv
= message_dolog_marker2
;
8780 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8781 oldzv
= message_dolog_marker3
;
8782 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8783 GCPRO1 (old_deactivate_mark
);
8791 BEGV_BYTE
= BEG_BYTE
;
8794 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8796 /* Insert the string--maybe converting multibyte to single byte
8797 or vice versa, so that all the text fits the buffer. */
8799 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8805 /* Convert a multibyte string to single-byte
8806 for the *Message* buffer. */
8807 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8809 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8810 work
[0] = (ASCII_CHAR_P (c
)
8812 : multibyte_char_to_unibyte (c
));
8813 insert_1_both (work
, 1, 1, 1, 0, 0);
8816 else if (! multibyte
8817 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8821 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8822 /* Convert a single-byte string to multibyte
8823 for the *Message* buffer. */
8824 for (i
= 0; i
< nbytes
; i
++)
8827 MAKE_CHAR_MULTIBYTE (c
);
8828 char_bytes
= CHAR_STRING (c
, str
);
8829 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8833 insert_1 (m
, nbytes
, 1, 0, 0);
8837 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8839 insert_1 ("\n", 1, 1, 0, 0);
8841 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8843 this_bol_byte
= PT_BYTE
;
8845 /* See if this line duplicates the previous one.
8846 If so, combine duplicates. */
8849 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8851 prev_bol_byte
= PT_BYTE
;
8853 dups
= message_log_check_duplicate (prev_bol_byte
,
8857 del_range_both (prev_bol
, prev_bol_byte
,
8858 this_bol
, this_bol_byte
, 0);
8861 char dupstr
[sizeof " [ times]"
8862 + INT_STRLEN_BOUND (printmax_t
)];
8865 /* If you change this format, don't forget to also
8866 change message_log_check_duplicate. */
8867 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8868 duplen
= strlen (dupstr
);
8869 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8870 insert_1 (dupstr
, duplen
, 1, 0, 1);
8875 /* If we have more than the desired maximum number of lines
8876 in the *Messages* buffer now, delete the oldest ones.
8877 This is safe because we don't have undo in this buffer. */
8879 if (NATNUMP (Vmessage_log_max
))
8881 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8882 -XFASTINT (Vmessage_log_max
) - 1, 0);
8883 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8886 BEGV
= XMARKER (oldbegv
)->charpos
;
8887 BEGV_BYTE
= marker_byte_position (oldbegv
);
8896 ZV
= XMARKER (oldzv
)->charpos
;
8897 ZV_BYTE
= marker_byte_position (oldzv
);
8901 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8903 /* We can't do Fgoto_char (oldpoint) because it will run some
8905 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8906 XMARKER (oldpoint
)->bytepos
);
8909 unchain_marker (XMARKER (oldpoint
));
8910 unchain_marker (XMARKER (oldbegv
));
8911 unchain_marker (XMARKER (oldzv
));
8913 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8914 set_buffer_internal (oldbuf
);
8916 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8917 message_log_need_newline
= !nlflag
;
8918 Vdeactivate_mark
= old_deactivate_mark
;
8923 /* We are at the end of the buffer after just having inserted a newline.
8924 (Note: We depend on the fact we won't be crossing the gap.)
8925 Check to see if the most recent message looks a lot like the previous one.
8926 Return 0 if different, 1 if the new one should just replace it, or a
8927 value N > 1 if we should also append " [N times]". */
8930 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8933 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8935 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8936 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8938 for (i
= 0; i
< len
; i
++)
8940 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8948 if (*p1
++ == ' ' && *p1
++ == '[')
8951 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8952 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8959 /* Display an echo area message M with a specified length of NBYTES
8960 bytes. The string may include null characters. If M is 0, clear
8961 out any existing message, and let the mini-buffer text show
8964 This may GC, so the buffer M must NOT point to a Lisp string. */
8967 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8969 /* First flush out any partial line written with print. */
8970 message_log_maybe_newline ();
8972 message_dolog (m
, nbytes
, 1, multibyte
);
8973 message2_nolog (m
, nbytes
, multibyte
);
8977 /* The non-logging counterpart of message2. */
8980 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8982 struct frame
*sf
= SELECTED_FRAME ();
8983 message_enable_multibyte
= multibyte
;
8985 if (FRAME_INITIAL_P (sf
))
8987 if (noninteractive_need_newline
)
8988 putc ('\n', stderr
);
8989 noninteractive_need_newline
= 0;
8991 fwrite (m
, nbytes
, 1, stderr
);
8992 if (cursor_in_echo_area
== 0)
8993 fprintf (stderr
, "\n");
8996 /* A null message buffer means that the frame hasn't really been
8997 initialized yet. Error messages get reported properly by
8998 cmd_error, so this must be just an informative message; toss it. */
8999 else if (INTERACTIVE
9000 && sf
->glyphs_initialized_p
9001 && FRAME_MESSAGE_BUF (sf
))
9003 Lisp_Object mini_window
;
9006 /* Get the frame containing the mini-buffer
9007 that the selected frame is using. */
9008 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9009 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9011 FRAME_SAMPLE_VISIBILITY (f
);
9012 if (FRAME_VISIBLE_P (sf
)
9013 && ! FRAME_VISIBLE_P (f
))
9014 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9018 set_message (m
, Qnil
, nbytes
, multibyte
);
9019 if (minibuffer_auto_raise
)
9020 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9023 clear_message (1, 1);
9025 do_pending_window_change (0);
9026 echo_area_display (1);
9027 do_pending_window_change (0);
9028 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9029 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9034 /* Display an echo area message M with a specified length of NBYTES
9035 bytes. The string may include null characters. If M is not a
9036 string, clear out any existing message, and let the mini-buffer
9039 This function cancels echoing. */
9042 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9044 struct gcpro gcpro1
;
9047 clear_message (1,1);
9050 /* First flush out any partial line written with print. */
9051 message_log_maybe_newline ();
9057 SAFE_ALLOCA (buffer
, char *, nbytes
);
9058 memcpy (buffer
, SDATA (m
), nbytes
);
9059 message_dolog (buffer
, nbytes
, 1, multibyte
);
9062 message3_nolog (m
, nbytes
, multibyte
);
9068 /* The non-logging version of message3.
9069 This does not cancel echoing, because it is used for echoing.
9070 Perhaps we need to make a separate function for echoing
9071 and make this cancel echoing. */
9074 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9076 struct frame
*sf
= SELECTED_FRAME ();
9077 message_enable_multibyte
= multibyte
;
9079 if (FRAME_INITIAL_P (sf
))
9081 if (noninteractive_need_newline
)
9082 putc ('\n', stderr
);
9083 noninteractive_need_newline
= 0;
9085 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9086 if (cursor_in_echo_area
== 0)
9087 fprintf (stderr
, "\n");
9090 /* A null message buffer means that the frame hasn't really been
9091 initialized yet. Error messages get reported properly by
9092 cmd_error, so this must be just an informative message; toss it. */
9093 else if (INTERACTIVE
9094 && sf
->glyphs_initialized_p
9095 && FRAME_MESSAGE_BUF (sf
))
9097 Lisp_Object mini_window
;
9101 /* Get the frame containing the mini-buffer
9102 that the selected frame is using. */
9103 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9104 frame
= XWINDOW (mini_window
)->frame
;
9107 FRAME_SAMPLE_VISIBILITY (f
);
9108 if (FRAME_VISIBLE_P (sf
)
9109 && !FRAME_VISIBLE_P (f
))
9110 Fmake_frame_visible (frame
);
9112 if (STRINGP (m
) && SCHARS (m
) > 0)
9114 set_message (NULL
, m
, nbytes
, multibyte
);
9115 if (minibuffer_auto_raise
)
9116 Fraise_frame (frame
);
9117 /* Assume we are not echoing.
9118 (If we are, echo_now will override this.) */
9119 echo_message_buffer
= Qnil
;
9122 clear_message (1, 1);
9124 do_pending_window_change (0);
9125 echo_area_display (1);
9126 do_pending_window_change (0);
9127 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9128 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9133 /* Display a null-terminated echo area message M. If M is 0, clear
9134 out any existing message, and let the mini-buffer text show through.
9136 The buffer M must continue to exist until after the echo area gets
9137 cleared or some other message gets displayed there. Do not pass
9138 text that is stored in a Lisp string. Do not pass text in a buffer
9139 that was alloca'd. */
9142 message1 (const char *m
)
9144 message2 (m
, (m
? strlen (m
) : 0), 0);
9148 /* The non-logging counterpart of message1. */
9151 message1_nolog (const char *m
)
9153 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9156 /* Display a message M which contains a single %s
9157 which gets replaced with STRING. */
9160 message_with_string (const char *m
, Lisp_Object string
, int log
)
9162 CHECK_STRING (string
);
9168 if (noninteractive_need_newline
)
9169 putc ('\n', stderr
);
9170 noninteractive_need_newline
= 0;
9171 fprintf (stderr
, m
, SDATA (string
));
9172 if (!cursor_in_echo_area
)
9173 fprintf (stderr
, "\n");
9177 else if (INTERACTIVE
)
9179 /* The frame whose minibuffer we're going to display the message on.
9180 It may be larger than the selected frame, so we need
9181 to use its buffer, not the selected frame's buffer. */
9182 Lisp_Object mini_window
;
9183 struct frame
*f
, *sf
= SELECTED_FRAME ();
9185 /* Get the frame containing the minibuffer
9186 that the selected frame is using. */
9187 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9188 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9190 /* A null message buffer means that the frame hasn't really been
9191 initialized yet. Error messages get reported properly by
9192 cmd_error, so this must be just an informative message; toss it. */
9193 if (FRAME_MESSAGE_BUF (f
))
9195 Lisp_Object args
[2], msg
;
9196 struct gcpro gcpro1
, gcpro2
;
9198 args
[0] = build_string (m
);
9199 args
[1] = msg
= string
;
9200 GCPRO2 (args
[0], msg
);
9203 msg
= Fformat (2, args
);
9206 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9208 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9212 /* Print should start at the beginning of the message
9213 buffer next time. */
9214 message_buf_print
= 0;
9220 /* Dump an informative message to the minibuf. If M is 0, clear out
9221 any existing message, and let the mini-buffer text show through. */
9224 vmessage (const char *m
, va_list ap
)
9230 if (noninteractive_need_newline
)
9231 putc ('\n', stderr
);
9232 noninteractive_need_newline
= 0;
9233 vfprintf (stderr
, m
, ap
);
9234 if (cursor_in_echo_area
== 0)
9235 fprintf (stderr
, "\n");
9239 else if (INTERACTIVE
)
9241 /* The frame whose mini-buffer we're going to display the message
9242 on. It may be larger than the selected frame, so we need to
9243 use its buffer, not the selected frame's buffer. */
9244 Lisp_Object mini_window
;
9245 struct frame
*f
, *sf
= SELECTED_FRAME ();
9247 /* Get the frame containing the mini-buffer
9248 that the selected frame is using. */
9249 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9250 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9252 /* A null message buffer means that the frame hasn't really been
9253 initialized yet. Error messages get reported properly by
9254 cmd_error, so this must be just an informative message; toss
9256 if (FRAME_MESSAGE_BUF (f
))
9262 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9263 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9265 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9270 /* Print should start at the beginning of the message
9271 buffer next time. */
9272 message_buf_print
= 0;
9278 message (const char *m
, ...)
9288 /* The non-logging version of message. */
9291 message_nolog (const char *m
, ...)
9293 Lisp_Object old_log_max
;
9296 old_log_max
= Vmessage_log_max
;
9297 Vmessage_log_max
= Qnil
;
9299 Vmessage_log_max
= old_log_max
;
9305 /* Display the current message in the current mini-buffer. This is
9306 only called from error handlers in process.c, and is not time
9310 update_echo_area (void)
9312 if (!NILP (echo_area_buffer
[0]))
9315 string
= Fcurrent_message ();
9316 message3 (string
, SBYTES (string
),
9317 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9322 /* Make sure echo area buffers in `echo_buffers' are live.
9323 If they aren't, make new ones. */
9326 ensure_echo_area_buffers (void)
9330 for (i
= 0; i
< 2; ++i
)
9331 if (!BUFFERP (echo_buffer
[i
])
9332 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9335 Lisp_Object old_buffer
;
9338 old_buffer
= echo_buffer
[i
];
9339 sprintf (name
, " *Echo Area %d*", i
);
9340 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9341 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9342 /* to force word wrap in echo area -
9343 it was decided to postpone this*/
9344 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9346 for (j
= 0; j
< 2; ++j
)
9347 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9348 echo_area_buffer
[j
] = echo_buffer
[i
];
9353 /* Call FN with args A1..A4 with either the current or last displayed
9354 echo_area_buffer as current buffer.
9356 WHICH zero means use the current message buffer
9357 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9358 from echo_buffer[] and clear it.
9360 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9361 suitable buffer from echo_buffer[] and clear it.
9363 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9364 that the current message becomes the last displayed one, make
9365 choose a suitable buffer for echo_area_buffer[0], and clear it.
9367 Value is what FN returns. */
9370 with_echo_area_buffer (struct window
*w
, int which
,
9371 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9372 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9375 int this_one
, the_other
, clear_buffer_p
, rc
;
9376 int count
= SPECPDL_INDEX ();
9378 /* If buffers aren't live, make new ones. */
9379 ensure_echo_area_buffers ();
9384 this_one
= 0, the_other
= 1;
9386 this_one
= 1, the_other
= 0;
9389 this_one
= 0, the_other
= 1;
9392 /* We need a fresh one in case the current echo buffer equals
9393 the one containing the last displayed echo area message. */
9394 if (!NILP (echo_area_buffer
[this_one
])
9395 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9396 echo_area_buffer
[this_one
] = Qnil
;
9399 /* Choose a suitable buffer from echo_buffer[] is we don't
9401 if (NILP (echo_area_buffer
[this_one
]))
9403 echo_area_buffer
[this_one
]
9404 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9405 ? echo_buffer
[the_other
]
9406 : echo_buffer
[this_one
]);
9410 buffer
= echo_area_buffer
[this_one
];
9412 /* Don't get confused by reusing the buffer used for echoing
9413 for a different purpose. */
9414 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9417 record_unwind_protect (unwind_with_echo_area_buffer
,
9418 with_echo_area_buffer_unwind_data (w
));
9420 /* Make the echo area buffer current. Note that for display
9421 purposes, it is not necessary that the displayed window's buffer
9422 == current_buffer, except for text property lookup. So, let's
9423 only set that buffer temporarily here without doing a full
9424 Fset_window_buffer. We must also change w->pointm, though,
9425 because otherwise an assertions in unshow_buffer fails, and Emacs
9427 set_buffer_internal_1 (XBUFFER (buffer
));
9431 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9434 BVAR (current_buffer
, undo_list
) = Qt
;
9435 BVAR (current_buffer
, read_only
) = Qnil
;
9436 specbind (Qinhibit_read_only
, Qt
);
9437 specbind (Qinhibit_modification_hooks
, Qt
);
9439 if (clear_buffer_p
&& Z
> BEG
)
9442 xassert (BEGV
>= BEG
);
9443 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9445 rc
= fn (a1
, a2
, a3
, a4
);
9447 xassert (BEGV
>= BEG
);
9448 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9450 unbind_to (count
, Qnil
);
9455 /* Save state that should be preserved around the call to the function
9456 FN called in with_echo_area_buffer. */
9459 with_echo_area_buffer_unwind_data (struct window
*w
)
9462 Lisp_Object vector
, tmp
;
9464 /* Reduce consing by keeping one vector in
9465 Vwith_echo_area_save_vector. */
9466 vector
= Vwith_echo_area_save_vector
;
9467 Vwith_echo_area_save_vector
= Qnil
;
9470 vector
= Fmake_vector (make_number (7), Qnil
);
9472 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9473 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9474 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9478 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9479 ASET (vector
, i
, w
->buffer
); ++i
;
9480 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9481 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9486 for (; i
< end
; ++i
)
9487 ASET (vector
, i
, Qnil
);
9490 xassert (i
== ASIZE (vector
));
9495 /* Restore global state from VECTOR which was created by
9496 with_echo_area_buffer_unwind_data. */
9499 unwind_with_echo_area_buffer (Lisp_Object vector
)
9501 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9502 Vdeactivate_mark
= AREF (vector
, 1);
9503 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9505 if (WINDOWP (AREF (vector
, 3)))
9508 Lisp_Object buffer
, charpos
, bytepos
;
9510 w
= XWINDOW (AREF (vector
, 3));
9511 buffer
= AREF (vector
, 4);
9512 charpos
= AREF (vector
, 5);
9513 bytepos
= AREF (vector
, 6);
9516 set_marker_both (w
->pointm
, buffer
,
9517 XFASTINT (charpos
), XFASTINT (bytepos
));
9520 Vwith_echo_area_save_vector
= vector
;
9525 /* Set up the echo area for use by print functions. MULTIBYTE_P
9526 non-zero means we will print multibyte. */
9529 setup_echo_area_for_printing (int multibyte_p
)
9531 /* If we can't find an echo area any more, exit. */
9532 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9535 ensure_echo_area_buffers ();
9537 if (!message_buf_print
)
9539 /* A message has been output since the last time we printed.
9540 Choose a fresh echo area buffer. */
9541 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9542 echo_area_buffer
[0] = echo_buffer
[1];
9544 echo_area_buffer
[0] = echo_buffer
[0];
9546 /* Switch to that buffer and clear it. */
9547 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9548 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9552 int count
= SPECPDL_INDEX ();
9553 specbind (Qinhibit_read_only
, Qt
);
9554 /* Note that undo recording is always disabled. */
9556 unbind_to (count
, Qnil
);
9558 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9560 /* Set up the buffer for the multibyteness we need. */
9562 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9563 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9565 /* Raise the frame containing the echo area. */
9566 if (minibuffer_auto_raise
)
9568 struct frame
*sf
= SELECTED_FRAME ();
9569 Lisp_Object mini_window
;
9570 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9571 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9574 message_log_maybe_newline ();
9575 message_buf_print
= 1;
9579 if (NILP (echo_area_buffer
[0]))
9581 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9582 echo_area_buffer
[0] = echo_buffer
[1];
9584 echo_area_buffer
[0] = echo_buffer
[0];
9587 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9589 /* Someone switched buffers between print requests. */
9590 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9591 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9597 /* Display an echo area message in window W. Value is non-zero if W's
9598 height is changed. If display_last_displayed_message_p is
9599 non-zero, display the message that was last displayed, otherwise
9600 display the current message. */
9603 display_echo_area (struct window
*w
)
9605 int i
, no_message_p
, window_height_changed_p
, count
;
9607 /* Temporarily disable garbage collections while displaying the echo
9608 area. This is done because a GC can print a message itself.
9609 That message would modify the echo area buffer's contents while a
9610 redisplay of the buffer is going on, and seriously confuse
9612 count
= inhibit_garbage_collection ();
9614 /* If there is no message, we must call display_echo_area_1
9615 nevertheless because it resizes the window. But we will have to
9616 reset the echo_area_buffer in question to nil at the end because
9617 with_echo_area_buffer will sets it to an empty buffer. */
9618 i
= display_last_displayed_message_p
? 1 : 0;
9619 no_message_p
= NILP (echo_area_buffer
[i
]);
9621 window_height_changed_p
9622 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9623 display_echo_area_1
,
9624 (intptr_t) w
, Qnil
, 0, 0);
9627 echo_area_buffer
[i
] = Qnil
;
9629 unbind_to (count
, Qnil
);
9630 return window_height_changed_p
;
9634 /* Helper for display_echo_area. Display the current buffer which
9635 contains the current echo area message in window W, a mini-window,
9636 a pointer to which is passed in A1. A2..A4 are currently not used.
9637 Change the height of W so that all of the message is displayed.
9638 Value is non-zero if height of W was changed. */
9641 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9644 struct window
*w
= (struct window
*) i1
;
9646 struct text_pos start
;
9647 int window_height_changed_p
= 0;
9649 /* Do this before displaying, so that we have a large enough glyph
9650 matrix for the display. If we can't get enough space for the
9651 whole text, display the last N lines. That works by setting w->start. */
9652 window_height_changed_p
= resize_mini_window (w
, 0);
9654 /* Use the starting position chosen by resize_mini_window. */
9655 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9658 clear_glyph_matrix (w
->desired_matrix
);
9659 XSETWINDOW (window
, w
);
9660 try_window (window
, start
, 0);
9662 return window_height_changed_p
;
9666 /* Resize the echo area window to exactly the size needed for the
9667 currently displayed message, if there is one. If a mini-buffer
9668 is active, don't shrink it. */
9671 resize_echo_area_exactly (void)
9673 if (BUFFERP (echo_area_buffer
[0])
9674 && WINDOWP (echo_area_window
))
9676 struct window
*w
= XWINDOW (echo_area_window
);
9678 Lisp_Object resize_exactly
;
9680 if (minibuf_level
== 0)
9681 resize_exactly
= Qt
;
9683 resize_exactly
= Qnil
;
9685 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9686 (intptr_t) w
, resize_exactly
,
9690 ++windows_or_buffers_changed
;
9691 ++update_mode_lines
;
9692 redisplay_internal ();
9698 /* Callback function for with_echo_area_buffer, when used from
9699 resize_echo_area_exactly. A1 contains a pointer to the window to
9700 resize, EXACTLY non-nil means resize the mini-window exactly to the
9701 size of the text displayed. A3 and A4 are not used. Value is what
9702 resize_mini_window returns. */
9705 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9708 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9712 /* Resize mini-window W to fit the size of its contents. EXACT_P
9713 means size the window exactly to the size needed. Otherwise, it's
9714 only enlarged until W's buffer is empty.
9716 Set W->start to the right place to begin display. If the whole
9717 contents fit, start at the beginning. Otherwise, start so as
9718 to make the end of the contents appear. This is particularly
9719 important for y-or-n-p, but seems desirable generally.
9721 Value is non-zero if the window height has been changed. */
9724 resize_mini_window (struct window
*w
, int exact_p
)
9726 struct frame
*f
= XFRAME (w
->frame
);
9727 int window_height_changed_p
= 0;
9729 xassert (MINI_WINDOW_P (w
));
9731 /* By default, start display at the beginning. */
9732 set_marker_both (w
->start
, w
->buffer
,
9733 BUF_BEGV (XBUFFER (w
->buffer
)),
9734 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9736 /* Don't resize windows while redisplaying a window; it would
9737 confuse redisplay functions when the size of the window they are
9738 displaying changes from under them. Such a resizing can happen,
9739 for instance, when which-func prints a long message while
9740 we are running fontification-functions. We're running these
9741 functions with safe_call which binds inhibit-redisplay to t. */
9742 if (!NILP (Vinhibit_redisplay
))
9745 /* Nil means don't try to resize. */
9746 if (NILP (Vresize_mini_windows
)
9747 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9750 if (!FRAME_MINIBUF_ONLY_P (f
))
9753 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9754 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9755 int height
, max_height
;
9756 int unit
= FRAME_LINE_HEIGHT (f
);
9757 struct text_pos start
;
9758 struct buffer
*old_current_buffer
= NULL
;
9760 if (current_buffer
!= XBUFFER (w
->buffer
))
9762 old_current_buffer
= current_buffer
;
9763 set_buffer_internal (XBUFFER (w
->buffer
));
9766 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9768 /* Compute the max. number of lines specified by the user. */
9769 if (FLOATP (Vmax_mini_window_height
))
9770 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9771 else if (INTEGERP (Vmax_mini_window_height
))
9772 max_height
= XINT (Vmax_mini_window_height
);
9774 max_height
= total_height
/ 4;
9776 /* Correct that max. height if it's bogus. */
9777 max_height
= max (1, max_height
);
9778 max_height
= min (total_height
, max_height
);
9780 /* Find out the height of the text in the window. */
9781 if (it
.line_wrap
== TRUNCATE
)
9786 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9787 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9788 height
= it
.current_y
+ last_height
;
9790 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9791 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9792 height
= (height
+ unit
- 1) / unit
;
9795 /* Compute a suitable window start. */
9796 if (height
> max_height
)
9798 height
= max_height
;
9799 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9800 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9801 start
= it
.current
.pos
;
9804 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9805 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9807 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9809 /* Let it grow only, until we display an empty message, in which
9810 case the window shrinks again. */
9811 if (height
> WINDOW_TOTAL_LINES (w
))
9813 int old_height
= WINDOW_TOTAL_LINES (w
);
9814 freeze_window_starts (f
, 1);
9815 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9816 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9818 else if (height
< WINDOW_TOTAL_LINES (w
)
9819 && (exact_p
|| BEGV
== ZV
))
9821 int old_height
= WINDOW_TOTAL_LINES (w
);
9822 freeze_window_starts (f
, 0);
9823 shrink_mini_window (w
);
9824 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9829 /* Always resize to exact size needed. */
9830 if (height
> WINDOW_TOTAL_LINES (w
))
9832 int old_height
= WINDOW_TOTAL_LINES (w
);
9833 freeze_window_starts (f
, 1);
9834 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9835 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9837 else if (height
< WINDOW_TOTAL_LINES (w
))
9839 int old_height
= WINDOW_TOTAL_LINES (w
);
9840 freeze_window_starts (f
, 0);
9841 shrink_mini_window (w
);
9845 freeze_window_starts (f
, 1);
9846 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9849 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9853 if (old_current_buffer
)
9854 set_buffer_internal (old_current_buffer
);
9857 return window_height_changed_p
;
9861 /* Value is the current message, a string, or nil if there is no
9865 current_message (void)
9869 if (!BUFFERP (echo_area_buffer
[0]))
9873 with_echo_area_buffer (0, 0, current_message_1
,
9874 (intptr_t) &msg
, Qnil
, 0, 0);
9876 echo_area_buffer
[0] = Qnil
;
9884 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9887 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9890 *msg
= make_buffer_string (BEG
, Z
, 1);
9897 /* Push the current message on Vmessage_stack for later restauration
9898 by restore_message. Value is non-zero if the current message isn't
9899 empty. This is a relatively infrequent operation, so it's not
9900 worth optimizing. */
9906 msg
= current_message ();
9907 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9908 return STRINGP (msg
);
9912 /* Restore message display from the top of Vmessage_stack. */
9915 restore_message (void)
9919 xassert (CONSP (Vmessage_stack
));
9920 msg
= XCAR (Vmessage_stack
);
9922 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9924 message3_nolog (msg
, 0, 0);
9928 /* Handler for record_unwind_protect calling pop_message. */
9931 pop_message_unwind (Lisp_Object dummy
)
9937 /* Pop the top-most entry off Vmessage_stack. */
9942 xassert (CONSP (Vmessage_stack
));
9943 Vmessage_stack
= XCDR (Vmessage_stack
);
9947 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9948 exits. If the stack is not empty, we have a missing pop_message
9952 check_message_stack (void)
9954 if (!NILP (Vmessage_stack
))
9959 /* Truncate to NCHARS what will be displayed in the echo area the next
9960 time we display it---but don't redisplay it now. */
9963 truncate_echo_area (EMACS_INT nchars
)
9966 echo_area_buffer
[0] = Qnil
;
9967 /* A null message buffer means that the frame hasn't really been
9968 initialized yet. Error messages get reported properly by
9969 cmd_error, so this must be just an informative message; toss it. */
9970 else if (!noninteractive
9972 && !NILP (echo_area_buffer
[0]))
9974 struct frame
*sf
= SELECTED_FRAME ();
9975 if (FRAME_MESSAGE_BUF (sf
))
9976 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9981 /* Helper function for truncate_echo_area. Truncate the current
9982 message to at most NCHARS characters. */
9985 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9987 if (BEG
+ nchars
< Z
)
9988 del_range (BEG
+ nchars
, Z
);
9990 echo_area_buffer
[0] = Qnil
;
9995 /* Set the current message to a substring of S or STRING.
9997 If STRING is a Lisp string, set the message to the first NBYTES
9998 bytes from STRING. NBYTES zero means use the whole string. If
9999 STRING is multibyte, the message will be displayed multibyte.
10001 If S is not null, set the message to the first LEN bytes of S. LEN
10002 zero means use the whole string. MULTIBYTE_P non-zero means S is
10003 multibyte. Display the message multibyte in that case.
10005 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10006 to t before calling set_message_1 (which calls insert).
10010 set_message (const char *s
, Lisp_Object string
,
10011 EMACS_INT nbytes
, int multibyte_p
)
10013 message_enable_multibyte
10014 = ((s
&& multibyte_p
)
10015 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10017 with_echo_area_buffer (0, -1, set_message_1
,
10018 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10019 message_buf_print
= 0;
10020 help_echo_showing_p
= 0;
10024 /* Helper function for set_message. Arguments have the same meaning
10025 as there, with A1 corresponding to S and A2 corresponding to STRING
10026 This function is called with the echo area buffer being
10030 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10033 const char *s
= (const char *) i1
;
10034 const unsigned char *msg
= (const unsigned char *) s
;
10035 Lisp_Object string
= a2
;
10037 /* Change multibyteness of the echo buffer appropriately. */
10038 if (message_enable_multibyte
10039 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10040 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10042 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10043 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10044 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10046 /* Insert new message at BEG. */
10047 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10049 if (STRINGP (string
))
10054 nbytes
= SBYTES (string
);
10055 nchars
= string_byte_to_char (string
, nbytes
);
10057 /* This function takes care of single/multibyte conversion. We
10058 just have to ensure that the echo area buffer has the right
10059 setting of enable_multibyte_characters. */
10060 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10065 nbytes
= strlen (s
);
10067 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10069 /* Convert from multi-byte to single-byte. */
10074 /* Convert a multibyte string to single-byte. */
10075 for (i
= 0; i
< nbytes
; i
+= n
)
10077 c
= string_char_and_length (msg
+ i
, &n
);
10078 work
[0] = (ASCII_CHAR_P (c
)
10080 : multibyte_char_to_unibyte (c
));
10081 insert_1_both (work
, 1, 1, 1, 0, 0);
10084 else if (!multibyte_p
10085 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10087 /* Convert from single-byte to multi-byte. */
10090 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10092 /* Convert a single-byte string to multibyte. */
10093 for (i
= 0; i
< nbytes
; i
++)
10096 MAKE_CHAR_MULTIBYTE (c
);
10097 n
= CHAR_STRING (c
, str
);
10098 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10102 insert_1 (s
, nbytes
, 1, 0, 0);
10109 /* Clear messages. CURRENT_P non-zero means clear the current
10110 message. LAST_DISPLAYED_P non-zero means clear the message
10114 clear_message (int current_p
, int last_displayed_p
)
10118 echo_area_buffer
[0] = Qnil
;
10119 message_cleared_p
= 1;
10122 if (last_displayed_p
)
10123 echo_area_buffer
[1] = Qnil
;
10125 message_buf_print
= 0;
10128 /* Clear garbaged frames.
10130 This function is used where the old redisplay called
10131 redraw_garbaged_frames which in turn called redraw_frame which in
10132 turn called clear_frame. The call to clear_frame was a source of
10133 flickering. I believe a clear_frame is not necessary. It should
10134 suffice in the new redisplay to invalidate all current matrices,
10135 and ensure a complete redisplay of all windows. */
10138 clear_garbaged_frames (void)
10140 if (frame_garbaged
)
10142 Lisp_Object tail
, frame
;
10143 int changed_count
= 0;
10145 FOR_EACH_FRAME (tail
, frame
)
10147 struct frame
*f
= XFRAME (frame
);
10149 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10153 Fredraw_frame (frame
);
10154 f
->force_flush_display_p
= 1;
10156 clear_current_matrices (f
);
10163 frame_garbaged
= 0;
10165 ++windows_or_buffers_changed
;
10170 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10171 is non-zero update selected_frame. Value is non-zero if the
10172 mini-windows height has been changed. */
10175 echo_area_display (int update_frame_p
)
10177 Lisp_Object mini_window
;
10180 int window_height_changed_p
= 0;
10181 struct frame
*sf
= SELECTED_FRAME ();
10183 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10184 w
= XWINDOW (mini_window
);
10185 f
= XFRAME (WINDOW_FRAME (w
));
10187 /* Don't display if frame is invisible or not yet initialized. */
10188 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10191 #ifdef HAVE_WINDOW_SYSTEM
10192 /* When Emacs starts, selected_frame may be the initial terminal
10193 frame. If we let this through, a message would be displayed on
10195 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10197 #endif /* HAVE_WINDOW_SYSTEM */
10199 /* Redraw garbaged frames. */
10200 if (frame_garbaged
)
10201 clear_garbaged_frames ();
10203 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10205 echo_area_window
= mini_window
;
10206 window_height_changed_p
= display_echo_area (w
);
10207 w
->must_be_updated_p
= 1;
10209 /* Update the display, unless called from redisplay_internal.
10210 Also don't update the screen during redisplay itself. The
10211 update will happen at the end of redisplay, and an update
10212 here could cause confusion. */
10213 if (update_frame_p
&& !redisplaying_p
)
10217 /* If the display update has been interrupted by pending
10218 input, update mode lines in the frame. Due to the
10219 pending input, it might have been that redisplay hasn't
10220 been called, so that mode lines above the echo area are
10221 garbaged. This looks odd, so we prevent it here. */
10222 if (!display_completed
)
10223 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10225 if (window_height_changed_p
10226 /* Don't do this if Emacs is shutting down. Redisplay
10227 needs to run hooks. */
10228 && !NILP (Vrun_hooks
))
10230 /* Must update other windows. Likewise as in other
10231 cases, don't let this update be interrupted by
10233 int count
= SPECPDL_INDEX ();
10234 specbind (Qredisplay_dont_pause
, Qt
);
10235 windows_or_buffers_changed
= 1;
10236 redisplay_internal ();
10237 unbind_to (count
, Qnil
);
10239 else if (FRAME_WINDOW_P (f
) && n
== 0)
10241 /* Window configuration is the same as before.
10242 Can do with a display update of the echo area,
10243 unless we displayed some mode lines. */
10244 update_single_window (w
, 1);
10245 FRAME_RIF (f
)->flush_display (f
);
10248 update_frame (f
, 1, 1);
10250 /* If cursor is in the echo area, make sure that the next
10251 redisplay displays the minibuffer, so that the cursor will
10252 be replaced with what the minibuffer wants. */
10253 if (cursor_in_echo_area
)
10254 ++windows_or_buffers_changed
;
10257 else if (!EQ (mini_window
, selected_window
))
10258 windows_or_buffers_changed
++;
10260 /* Last displayed message is now the current message. */
10261 echo_area_buffer
[1] = echo_area_buffer
[0];
10262 /* Inform read_char that we're not echoing. */
10263 echo_message_buffer
= Qnil
;
10265 /* Prevent redisplay optimization in redisplay_internal by resetting
10266 this_line_start_pos. This is done because the mini-buffer now
10267 displays the message instead of its buffer text. */
10268 if (EQ (mini_window
, selected_window
))
10269 CHARPOS (this_line_start_pos
) = 0;
10271 return window_height_changed_p
;
10276 /***********************************************************************
10277 Mode Lines and Frame Titles
10278 ***********************************************************************/
10280 /* A buffer for constructing non-propertized mode-line strings and
10281 frame titles in it; allocated from the heap in init_xdisp and
10282 resized as needed in store_mode_line_noprop_char. */
10284 static char *mode_line_noprop_buf
;
10286 /* The buffer's end, and a current output position in it. */
10288 static char *mode_line_noprop_buf_end
;
10289 static char *mode_line_noprop_ptr
;
10291 #define MODE_LINE_NOPROP_LEN(start) \
10292 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10295 MODE_LINE_DISPLAY
= 0,
10299 } mode_line_target
;
10301 /* Alist that caches the results of :propertize.
10302 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10303 static Lisp_Object mode_line_proptrans_alist
;
10305 /* List of strings making up the mode-line. */
10306 static Lisp_Object mode_line_string_list
;
10308 /* Base face property when building propertized mode line string. */
10309 static Lisp_Object mode_line_string_face
;
10310 static Lisp_Object mode_line_string_face_prop
;
10313 /* Unwind data for mode line strings */
10315 static Lisp_Object Vmode_line_unwind_vector
;
10318 format_mode_line_unwind_data (struct buffer
*obuf
,
10320 int save_proptrans
)
10322 Lisp_Object vector
, tmp
;
10324 /* Reduce consing by keeping one vector in
10325 Vwith_echo_area_save_vector. */
10326 vector
= Vmode_line_unwind_vector
;
10327 Vmode_line_unwind_vector
= Qnil
;
10330 vector
= Fmake_vector (make_number (8), Qnil
);
10332 ASET (vector
, 0, make_number (mode_line_target
));
10333 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10334 ASET (vector
, 2, mode_line_string_list
);
10335 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10336 ASET (vector
, 4, mode_line_string_face
);
10337 ASET (vector
, 5, mode_line_string_face_prop
);
10340 XSETBUFFER (tmp
, obuf
);
10343 ASET (vector
, 6, tmp
);
10344 ASET (vector
, 7, owin
);
10350 unwind_format_mode_line (Lisp_Object vector
)
10352 mode_line_target
= XINT (AREF (vector
, 0));
10353 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10354 mode_line_string_list
= AREF (vector
, 2);
10355 if (! EQ (AREF (vector
, 3), Qt
))
10356 mode_line_proptrans_alist
= AREF (vector
, 3);
10357 mode_line_string_face
= AREF (vector
, 4);
10358 mode_line_string_face_prop
= AREF (vector
, 5);
10360 if (!NILP (AREF (vector
, 7)))
10361 /* Select window before buffer, since it may change the buffer. */
10362 Fselect_window (AREF (vector
, 7), Qt
);
10364 if (!NILP (AREF (vector
, 6)))
10366 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10367 ASET (vector
, 6, Qnil
);
10370 Vmode_line_unwind_vector
= vector
;
10375 /* Store a single character C for the frame title in mode_line_noprop_buf.
10376 Re-allocate mode_line_noprop_buf if necessary. */
10379 store_mode_line_noprop_char (char c
)
10381 /* If output position has reached the end of the allocated buffer,
10382 double the buffer's size. */
10383 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10385 int len
= MODE_LINE_NOPROP_LEN (0);
10386 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
10387 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10388 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10389 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10392 *mode_line_noprop_ptr
++ = c
;
10396 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10397 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10398 characters that yield more columns than PRECISION; PRECISION <= 0
10399 means copy the whole string. Pad with spaces until FIELD_WIDTH
10400 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10401 pad. Called from display_mode_element when it is used to build a
10405 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10407 const unsigned char *str
= (const unsigned char *) string
;
10409 EMACS_INT dummy
, nbytes
;
10411 /* Copy at most PRECISION chars from STR. */
10412 nbytes
= strlen (string
);
10413 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10415 store_mode_line_noprop_char (*str
++);
10417 /* Fill up with spaces until FIELD_WIDTH reached. */
10418 while (field_width
> 0
10419 && n
< field_width
)
10421 store_mode_line_noprop_char (' ');
10428 /***********************************************************************
10430 ***********************************************************************/
10432 #ifdef HAVE_WINDOW_SYSTEM
10434 /* Set the title of FRAME, if it has changed. The title format is
10435 Vicon_title_format if FRAME is iconified, otherwise it is
10436 frame_title_format. */
10439 x_consider_frame_title (Lisp_Object frame
)
10441 struct frame
*f
= XFRAME (frame
);
10443 if (FRAME_WINDOW_P (f
)
10444 || FRAME_MINIBUF_ONLY_P (f
)
10445 || f
->explicit_name
)
10447 /* Do we have more than one visible frame on this X display? */
10454 int count
= SPECPDL_INDEX ();
10456 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10458 Lisp_Object other_frame
= XCAR (tail
);
10459 struct frame
*tf
= XFRAME (other_frame
);
10462 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10463 && !FRAME_MINIBUF_ONLY_P (tf
)
10464 && !EQ (other_frame
, tip_frame
)
10465 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10469 /* Set global variable indicating that multiple frames exist. */
10470 multiple_frames
= CONSP (tail
);
10472 /* Switch to the buffer of selected window of the frame. Set up
10473 mode_line_target so that display_mode_element will output into
10474 mode_line_noprop_buf; then display the title. */
10475 record_unwind_protect (unwind_format_mode_line
,
10476 format_mode_line_unwind_data
10477 (current_buffer
, selected_window
, 0));
10479 Fselect_window (f
->selected_window
, Qt
);
10480 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10481 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10483 mode_line_target
= MODE_LINE_TITLE
;
10484 title_start
= MODE_LINE_NOPROP_LEN (0);
10485 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10486 NULL
, DEFAULT_FACE_ID
);
10487 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10488 len
= MODE_LINE_NOPROP_LEN (title_start
);
10489 title
= mode_line_noprop_buf
+ title_start
;
10490 unbind_to (count
, Qnil
);
10492 /* Set the title only if it's changed. This avoids consing in
10493 the common case where it hasn't. (If it turns out that we've
10494 already wasted too much time by walking through the list with
10495 display_mode_element, then we might need to optimize at a
10496 higher level than this.) */
10497 if (! STRINGP (f
->name
)
10498 || SBYTES (f
->name
) != len
10499 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10500 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10504 #endif /* not HAVE_WINDOW_SYSTEM */
10509 /***********************************************************************
10511 ***********************************************************************/
10514 /* Prepare for redisplay by updating menu-bar item lists when
10515 appropriate. This can call eval. */
10518 prepare_menu_bars (void)
10521 struct gcpro gcpro1
, gcpro2
;
10523 Lisp_Object tooltip_frame
;
10525 #ifdef HAVE_WINDOW_SYSTEM
10526 tooltip_frame
= tip_frame
;
10528 tooltip_frame
= Qnil
;
10531 /* Update all frame titles based on their buffer names, etc. We do
10532 this before the menu bars so that the buffer-menu will show the
10533 up-to-date frame titles. */
10534 #ifdef HAVE_WINDOW_SYSTEM
10535 if (windows_or_buffers_changed
|| update_mode_lines
)
10537 Lisp_Object tail
, frame
;
10539 FOR_EACH_FRAME (tail
, frame
)
10541 f
= XFRAME (frame
);
10542 if (!EQ (frame
, tooltip_frame
)
10543 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10544 x_consider_frame_title (frame
);
10547 #endif /* HAVE_WINDOW_SYSTEM */
10549 /* Update the menu bar item lists, if appropriate. This has to be
10550 done before any actual redisplay or generation of display lines. */
10551 all_windows
= (update_mode_lines
10552 || buffer_shared
> 1
10553 || windows_or_buffers_changed
);
10556 Lisp_Object tail
, frame
;
10557 int count
= SPECPDL_INDEX ();
10558 /* 1 means that update_menu_bar has run its hooks
10559 so any further calls to update_menu_bar shouldn't do so again. */
10560 int menu_bar_hooks_run
= 0;
10562 record_unwind_save_match_data ();
10564 FOR_EACH_FRAME (tail
, frame
)
10566 f
= XFRAME (frame
);
10568 /* Ignore tooltip frame. */
10569 if (EQ (frame
, tooltip_frame
))
10572 /* If a window on this frame changed size, report that to
10573 the user and clear the size-change flag. */
10574 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10576 Lisp_Object functions
;
10578 /* Clear flag first in case we get an error below. */
10579 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10580 functions
= Vwindow_size_change_functions
;
10581 GCPRO2 (tail
, functions
);
10583 while (CONSP (functions
))
10585 if (!EQ (XCAR (functions
), Qt
))
10586 call1 (XCAR (functions
), frame
);
10587 functions
= XCDR (functions
);
10593 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10594 #ifdef HAVE_WINDOW_SYSTEM
10595 update_tool_bar (f
, 0);
10598 if (windows_or_buffers_changed
10600 ns_set_doc_edited (f
, Fbuffer_modified_p
10601 (XWINDOW (f
->selected_window
)->buffer
));
10606 unbind_to (count
, Qnil
);
10610 struct frame
*sf
= SELECTED_FRAME ();
10611 update_menu_bar (sf
, 1, 0);
10612 #ifdef HAVE_WINDOW_SYSTEM
10613 update_tool_bar (sf
, 1);
10619 /* Update the menu bar item list for frame F. This has to be done
10620 before we start to fill in any display lines, because it can call
10623 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10625 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10626 already ran the menu bar hooks for this redisplay, so there
10627 is no need to run them again. The return value is the
10628 updated value of this flag, to pass to the next call. */
10631 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10633 Lisp_Object window
;
10634 register struct window
*w
;
10636 /* If called recursively during a menu update, do nothing. This can
10637 happen when, for instance, an activate-menubar-hook causes a
10639 if (inhibit_menubar_update
)
10642 window
= FRAME_SELECTED_WINDOW (f
);
10643 w
= XWINDOW (window
);
10645 if (FRAME_WINDOW_P (f
)
10647 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10648 || defined (HAVE_NS) || defined (USE_GTK)
10649 FRAME_EXTERNAL_MENU_BAR (f
)
10651 FRAME_MENU_BAR_LINES (f
) > 0
10653 : FRAME_MENU_BAR_LINES (f
) > 0)
10655 /* If the user has switched buffers or windows, we need to
10656 recompute to reflect the new bindings. But we'll
10657 recompute when update_mode_lines is set too; that means
10658 that people can use force-mode-line-update to request
10659 that the menu bar be recomputed. The adverse effect on
10660 the rest of the redisplay algorithm is about the same as
10661 windows_or_buffers_changed anyway. */
10662 if (windows_or_buffers_changed
10663 /* This used to test w->update_mode_line, but we believe
10664 there is no need to recompute the menu in that case. */
10665 || update_mode_lines
10666 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10667 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10668 != !NILP (w
->last_had_star
))
10669 || ((!NILP (Vtransient_mark_mode
)
10670 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10671 != !NILP (w
->region_showing
)))
10673 struct buffer
*prev
= current_buffer
;
10674 int count
= SPECPDL_INDEX ();
10676 specbind (Qinhibit_menubar_update
, Qt
);
10678 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10679 if (save_match_data
)
10680 record_unwind_save_match_data ();
10681 if (NILP (Voverriding_local_map_menu_flag
))
10683 specbind (Qoverriding_terminal_local_map
, Qnil
);
10684 specbind (Qoverriding_local_map
, Qnil
);
10689 /* Run the Lucid hook. */
10690 safe_run_hooks (Qactivate_menubar_hook
);
10692 /* If it has changed current-menubar from previous value,
10693 really recompute the menu-bar from the value. */
10694 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10695 call0 (Qrecompute_lucid_menubar
);
10697 safe_run_hooks (Qmenu_bar_update_hook
);
10702 XSETFRAME (Vmenu_updating_frame
, f
);
10703 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10705 /* Redisplay the menu bar in case we changed it. */
10706 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10707 || defined (HAVE_NS) || defined (USE_GTK)
10708 if (FRAME_WINDOW_P (f
))
10710 #if defined (HAVE_NS)
10711 /* All frames on Mac OS share the same menubar. So only
10712 the selected frame should be allowed to set it. */
10713 if (f
== SELECTED_FRAME ())
10715 set_frame_menubar (f
, 0, 0);
10718 /* On a terminal screen, the menu bar is an ordinary screen
10719 line, and this makes it get updated. */
10720 w
->update_mode_line
= Qt
;
10721 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10722 /* In the non-toolkit version, the menu bar is an ordinary screen
10723 line, and this makes it get updated. */
10724 w
->update_mode_line
= Qt
;
10725 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10727 unbind_to (count
, Qnil
);
10728 set_buffer_internal_1 (prev
);
10737 /***********************************************************************
10739 ***********************************************************************/
10741 #ifdef HAVE_WINDOW_SYSTEM
10744 Nominal cursor position -- where to draw output.
10745 HPOS and VPOS are window relative glyph matrix coordinates.
10746 X and Y are window relative pixel coordinates. */
10748 struct cursor_pos output_cursor
;
10752 Set the global variable output_cursor to CURSOR. All cursor
10753 positions are relative to updated_window. */
10756 set_output_cursor (struct cursor_pos
*cursor
)
10758 output_cursor
.hpos
= cursor
->hpos
;
10759 output_cursor
.vpos
= cursor
->vpos
;
10760 output_cursor
.x
= cursor
->x
;
10761 output_cursor
.y
= cursor
->y
;
10766 Set a nominal cursor position.
10768 HPOS and VPOS are column/row positions in a window glyph matrix. X
10769 and Y are window text area relative pixel positions.
10771 If this is done during an update, updated_window will contain the
10772 window that is being updated and the position is the future output
10773 cursor position for that window. If updated_window is null, use
10774 selected_window and display the cursor at the given position. */
10777 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10781 /* If updated_window is not set, work on selected_window. */
10782 if (updated_window
)
10783 w
= updated_window
;
10785 w
= XWINDOW (selected_window
);
10787 /* Set the output cursor. */
10788 output_cursor
.hpos
= hpos
;
10789 output_cursor
.vpos
= vpos
;
10790 output_cursor
.x
= x
;
10791 output_cursor
.y
= y
;
10793 /* If not called as part of an update, really display the cursor.
10794 This will also set the cursor position of W. */
10795 if (updated_window
== NULL
)
10798 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10799 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10800 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10805 #endif /* HAVE_WINDOW_SYSTEM */
10808 /***********************************************************************
10810 ***********************************************************************/
10812 #ifdef HAVE_WINDOW_SYSTEM
10814 /* Where the mouse was last time we reported a mouse event. */
10816 FRAME_PTR last_mouse_frame
;
10818 /* Tool-bar item index of the item on which a mouse button was pressed
10821 int last_tool_bar_item
;
10825 update_tool_bar_unwind (Lisp_Object frame
)
10827 selected_frame
= frame
;
10831 /* Update the tool-bar item list for frame F. This has to be done
10832 before we start to fill in any display lines. Called from
10833 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10834 and restore it here. */
10837 update_tool_bar (struct frame
*f
, int save_match_data
)
10839 #if defined (USE_GTK) || defined (HAVE_NS)
10840 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10842 int do_update
= WINDOWP (f
->tool_bar_window
)
10843 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10848 Lisp_Object window
;
10851 window
= FRAME_SELECTED_WINDOW (f
);
10852 w
= XWINDOW (window
);
10854 /* If the user has switched buffers or windows, we need to
10855 recompute to reflect the new bindings. But we'll
10856 recompute when update_mode_lines is set too; that means
10857 that people can use force-mode-line-update to request
10858 that the menu bar be recomputed. The adverse effect on
10859 the rest of the redisplay algorithm is about the same as
10860 windows_or_buffers_changed anyway. */
10861 if (windows_or_buffers_changed
10862 || !NILP (w
->update_mode_line
)
10863 || update_mode_lines
10864 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10865 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10866 != !NILP (w
->last_had_star
))
10867 || ((!NILP (Vtransient_mark_mode
)
10868 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10869 != !NILP (w
->region_showing
)))
10871 struct buffer
*prev
= current_buffer
;
10872 int count
= SPECPDL_INDEX ();
10873 Lisp_Object frame
, new_tool_bar
;
10874 int new_n_tool_bar
;
10875 struct gcpro gcpro1
;
10877 /* Set current_buffer to the buffer of the selected
10878 window of the frame, so that we get the right local
10880 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10882 /* Save match data, if we must. */
10883 if (save_match_data
)
10884 record_unwind_save_match_data ();
10886 /* Make sure that we don't accidentally use bogus keymaps. */
10887 if (NILP (Voverriding_local_map_menu_flag
))
10889 specbind (Qoverriding_terminal_local_map
, Qnil
);
10890 specbind (Qoverriding_local_map
, Qnil
);
10893 GCPRO1 (new_tool_bar
);
10895 /* We must temporarily set the selected frame to this frame
10896 before calling tool_bar_items, because the calculation of
10897 the tool-bar keymap uses the selected frame (see
10898 `tool-bar-make-keymap' in tool-bar.el). */
10899 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10900 XSETFRAME (frame
, f
);
10901 selected_frame
= frame
;
10903 /* Build desired tool-bar items from keymaps. */
10904 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10907 /* Redisplay the tool-bar if we changed it. */
10908 if (new_n_tool_bar
!= f
->n_tool_bar_items
10909 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10911 /* Redisplay that happens asynchronously due to an expose event
10912 may access f->tool_bar_items. Make sure we update both
10913 variables within BLOCK_INPUT so no such event interrupts. */
10915 f
->tool_bar_items
= new_tool_bar
;
10916 f
->n_tool_bar_items
= new_n_tool_bar
;
10917 w
->update_mode_line
= Qt
;
10923 unbind_to (count
, Qnil
);
10924 set_buffer_internal_1 (prev
);
10930 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10931 F's desired tool-bar contents. F->tool_bar_items must have
10932 been set up previously by calling prepare_menu_bars. */
10935 build_desired_tool_bar_string (struct frame
*f
)
10937 int i
, size
, size_needed
;
10938 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10939 Lisp_Object image
, plist
, props
;
10941 image
= plist
= props
= Qnil
;
10942 GCPRO3 (image
, plist
, props
);
10944 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10945 Otherwise, make a new string. */
10947 /* The size of the string we might be able to reuse. */
10948 size
= (STRINGP (f
->desired_tool_bar_string
)
10949 ? SCHARS (f
->desired_tool_bar_string
)
10952 /* We need one space in the string for each image. */
10953 size_needed
= f
->n_tool_bar_items
;
10955 /* Reuse f->desired_tool_bar_string, if possible. */
10956 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10957 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10958 make_number (' '));
10961 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10962 Fremove_text_properties (make_number (0), make_number (size
),
10963 props
, f
->desired_tool_bar_string
);
10966 /* Put a `display' property on the string for the images to display,
10967 put a `menu_item' property on tool-bar items with a value that
10968 is the index of the item in F's tool-bar item vector. */
10969 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10971 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10973 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10974 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10975 int hmargin
, vmargin
, relief
, idx
, end
;
10977 /* If image is a vector, choose the image according to the
10979 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10980 if (VECTORP (image
))
10984 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10985 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10988 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10989 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10991 xassert (ASIZE (image
) >= idx
);
10992 image
= AREF (image
, idx
);
10997 /* Ignore invalid image specifications. */
10998 if (!valid_image_p (image
))
11001 /* Display the tool-bar button pressed, or depressed. */
11002 plist
= Fcopy_sequence (XCDR (image
));
11004 /* Compute margin and relief to draw. */
11005 relief
= (tool_bar_button_relief
>= 0
11006 ? tool_bar_button_relief
11007 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11008 hmargin
= vmargin
= relief
;
11010 if (INTEGERP (Vtool_bar_button_margin
)
11011 && XINT (Vtool_bar_button_margin
) > 0)
11013 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11014 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11016 else if (CONSP (Vtool_bar_button_margin
))
11018 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11019 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11020 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11022 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11023 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11024 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11027 if (auto_raise_tool_bar_buttons_p
)
11029 /* Add a `:relief' property to the image spec if the item is
11033 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11040 /* If image is selected, display it pressed, i.e. with a
11041 negative relief. If it's not selected, display it with a
11043 plist
= Fplist_put (plist
, QCrelief
,
11045 ? make_number (-relief
)
11046 : make_number (relief
)));
11051 /* Put a margin around the image. */
11052 if (hmargin
|| vmargin
)
11054 if (hmargin
== vmargin
)
11055 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11057 plist
= Fplist_put (plist
, QCmargin
,
11058 Fcons (make_number (hmargin
),
11059 make_number (vmargin
)));
11062 /* If button is not enabled, and we don't have special images
11063 for the disabled state, make the image appear disabled by
11064 applying an appropriate algorithm to it. */
11065 if (!enabled_p
&& idx
< 0)
11066 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11068 /* Put a `display' text property on the string for the image to
11069 display. Put a `menu-item' property on the string that gives
11070 the start of this item's properties in the tool-bar items
11072 image
= Fcons (Qimage
, plist
);
11073 props
= list4 (Qdisplay
, image
,
11074 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11076 /* Let the last image hide all remaining spaces in the tool bar
11077 string. The string can be longer than needed when we reuse a
11078 previous string. */
11079 if (i
+ 1 == f
->n_tool_bar_items
)
11080 end
= SCHARS (f
->desired_tool_bar_string
);
11083 Fadd_text_properties (make_number (i
), make_number (end
),
11084 props
, f
->desired_tool_bar_string
);
11092 /* Display one line of the tool-bar of frame IT->f.
11094 HEIGHT specifies the desired height of the tool-bar line.
11095 If the actual height of the glyph row is less than HEIGHT, the
11096 row's height is increased to HEIGHT, and the icons are centered
11097 vertically in the new height.
11099 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11100 count a final empty row in case the tool-bar width exactly matches
11105 display_tool_bar_line (struct it
*it
, int height
)
11107 struct glyph_row
*row
= it
->glyph_row
;
11108 int max_x
= it
->last_visible_x
;
11109 struct glyph
*last
;
11111 prepare_desired_row (row
);
11112 row
->y
= it
->current_y
;
11114 /* Note that this isn't made use of if the face hasn't a box,
11115 so there's no need to check the face here. */
11116 it
->start_of_box_run_p
= 1;
11118 while (it
->current_x
< max_x
)
11120 int x
, n_glyphs_before
, i
, nglyphs
;
11121 struct it it_before
;
11123 /* Get the next display element. */
11124 if (!get_next_display_element (it
))
11126 /* Don't count empty row if we are counting needed tool-bar lines. */
11127 if (height
< 0 && !it
->hpos
)
11132 /* Produce glyphs. */
11133 n_glyphs_before
= row
->used
[TEXT_AREA
];
11136 PRODUCE_GLYPHS (it
);
11138 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11140 x
= it_before
.current_x
;
11141 while (i
< nglyphs
)
11143 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11145 if (x
+ glyph
->pixel_width
> max_x
)
11147 /* Glyph doesn't fit on line. Backtrack. */
11148 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11150 /* If this is the only glyph on this line, it will never fit on the
11151 tool-bar, so skip it. But ensure there is at least one glyph,
11152 so we don't accidentally disable the tool-bar. */
11153 if (n_glyphs_before
== 0
11154 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11160 x
+= glyph
->pixel_width
;
11164 /* Stop at line end. */
11165 if (ITERATOR_AT_END_OF_LINE_P (it
))
11168 set_iterator_to_next (it
, 1);
11173 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11175 /* Use default face for the border below the tool bar.
11177 FIXME: When auto-resize-tool-bars is grow-only, there is
11178 no additional border below the possibly empty tool-bar lines.
11179 So to make the extra empty lines look "normal", we have to
11180 use the tool-bar face for the border too. */
11181 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11182 it
->face_id
= DEFAULT_FACE_ID
;
11184 extend_face_to_end_of_line (it
);
11185 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11186 last
->right_box_line_p
= 1;
11187 if (last
== row
->glyphs
[TEXT_AREA
])
11188 last
->left_box_line_p
= 1;
11190 /* Make line the desired height and center it vertically. */
11191 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11193 /* Don't add more than one line height. */
11194 height
%= FRAME_LINE_HEIGHT (it
->f
);
11195 it
->max_ascent
+= height
/ 2;
11196 it
->max_descent
+= (height
+ 1) / 2;
11199 compute_line_metrics (it
);
11201 /* If line is empty, make it occupy the rest of the tool-bar. */
11202 if (!row
->displays_text_p
)
11204 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11205 row
->visible_height
= row
->height
;
11206 row
->ascent
= row
->phys_ascent
= 0;
11207 row
->extra_line_spacing
= 0;
11210 row
->full_width_p
= 1;
11211 row
->continued_p
= 0;
11212 row
->truncated_on_left_p
= 0;
11213 row
->truncated_on_right_p
= 0;
11215 it
->current_x
= it
->hpos
= 0;
11216 it
->current_y
+= row
->height
;
11222 /* Max tool-bar height. */
11224 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11225 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11227 /* Value is the number of screen lines needed to make all tool-bar
11228 items of frame F visible. The number of actual rows needed is
11229 returned in *N_ROWS if non-NULL. */
11232 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11234 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11236 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11237 the desired matrix, so use (unused) mode-line row as temporary row to
11238 avoid destroying the first tool-bar row. */
11239 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11241 /* Initialize an iterator for iteration over
11242 F->desired_tool_bar_string in the tool-bar window of frame F. */
11243 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11244 it
.first_visible_x
= 0;
11245 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11246 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11247 it
.paragraph_embedding
= L2R
;
11249 while (!ITERATOR_AT_END_P (&it
))
11251 clear_glyph_row (temp_row
);
11252 it
.glyph_row
= temp_row
;
11253 display_tool_bar_line (&it
, -1);
11255 clear_glyph_row (temp_row
);
11257 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11259 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11261 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11265 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11267 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11268 (Lisp_Object frame
)
11275 frame
= selected_frame
;
11277 CHECK_FRAME (frame
);
11278 f
= XFRAME (frame
);
11280 if (WINDOWP (f
->tool_bar_window
)
11281 && (w
= XWINDOW (f
->tool_bar_window
),
11282 WINDOW_TOTAL_LINES (w
) > 0))
11284 update_tool_bar (f
, 1);
11285 if (f
->n_tool_bar_items
)
11287 build_desired_tool_bar_string (f
);
11288 nlines
= tool_bar_lines_needed (f
, NULL
);
11292 return make_number (nlines
);
11296 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11297 height should be changed. */
11300 redisplay_tool_bar (struct frame
*f
)
11304 struct glyph_row
*row
;
11306 #if defined (USE_GTK) || defined (HAVE_NS)
11307 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11308 update_frame_tool_bar (f
);
11312 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11313 do anything. This means you must start with tool-bar-lines
11314 non-zero to get the auto-sizing effect. Or in other words, you
11315 can turn off tool-bars by specifying tool-bar-lines zero. */
11316 if (!WINDOWP (f
->tool_bar_window
)
11317 || (w
= XWINDOW (f
->tool_bar_window
),
11318 WINDOW_TOTAL_LINES (w
) == 0))
11321 /* Set up an iterator for the tool-bar window. */
11322 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11323 it
.first_visible_x
= 0;
11324 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11325 row
= it
.glyph_row
;
11327 /* Build a string that represents the contents of the tool-bar. */
11328 build_desired_tool_bar_string (f
);
11329 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11330 /* FIXME: This should be controlled by a user option. But it
11331 doesn't make sense to have an R2L tool bar if the menu bar cannot
11332 be drawn also R2L, and making the menu bar R2L is tricky due
11333 toolkit-specific code that implements it. If an R2L tool bar is
11334 ever supported, display_tool_bar_line should also be augmented to
11335 call unproduce_glyphs like display_line and display_string
11337 it
.paragraph_embedding
= L2R
;
11339 if (f
->n_tool_bar_rows
== 0)
11343 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11344 nlines
!= WINDOW_TOTAL_LINES (w
)))
11347 int old_height
= WINDOW_TOTAL_LINES (w
);
11349 XSETFRAME (frame
, f
);
11350 Fmodify_frame_parameters (frame
,
11351 Fcons (Fcons (Qtool_bar_lines
,
11352 make_number (nlines
)),
11354 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11356 clear_glyph_matrix (w
->desired_matrix
);
11357 fonts_changed_p
= 1;
11363 /* Display as many lines as needed to display all tool-bar items. */
11365 if (f
->n_tool_bar_rows
> 0)
11367 int border
, rows
, height
, extra
;
11369 if (INTEGERP (Vtool_bar_border
))
11370 border
= XINT (Vtool_bar_border
);
11371 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11372 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11373 else if (EQ (Vtool_bar_border
, Qborder_width
))
11374 border
= f
->border_width
;
11380 rows
= f
->n_tool_bar_rows
;
11381 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11382 extra
= it
.last_visible_y
- border
- height
* rows
;
11384 while (it
.current_y
< it
.last_visible_y
)
11387 if (extra
> 0 && rows
-- > 0)
11389 h
= (extra
+ rows
- 1) / rows
;
11392 display_tool_bar_line (&it
, height
+ h
);
11397 while (it
.current_y
< it
.last_visible_y
)
11398 display_tool_bar_line (&it
, 0);
11401 /* It doesn't make much sense to try scrolling in the tool-bar
11402 window, so don't do it. */
11403 w
->desired_matrix
->no_scrolling_p
= 1;
11404 w
->must_be_updated_p
= 1;
11406 if (!NILP (Vauto_resize_tool_bars
))
11408 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11409 int change_height_p
= 0;
11411 /* If we couldn't display everything, change the tool-bar's
11412 height if there is room for more. */
11413 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11414 && it
.current_y
< max_tool_bar_height
)
11415 change_height_p
= 1;
11417 row
= it
.glyph_row
- 1;
11419 /* If there are blank lines at the end, except for a partially
11420 visible blank line at the end that is smaller than
11421 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11422 if (!row
->displays_text_p
11423 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11424 change_height_p
= 1;
11426 /* If row displays tool-bar items, but is partially visible,
11427 change the tool-bar's height. */
11428 if (row
->displays_text_p
11429 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11430 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11431 change_height_p
= 1;
11433 /* Resize windows as needed by changing the `tool-bar-lines'
11434 frame parameter. */
11435 if (change_height_p
)
11438 int old_height
= WINDOW_TOTAL_LINES (w
);
11440 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11442 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11443 && !f
->minimize_tool_bar_window_p
)
11444 ? (nlines
> old_height
)
11445 : (nlines
!= old_height
));
11446 f
->minimize_tool_bar_window_p
= 0;
11448 if (change_height_p
)
11450 XSETFRAME (frame
, f
);
11451 Fmodify_frame_parameters (frame
,
11452 Fcons (Fcons (Qtool_bar_lines
,
11453 make_number (nlines
)),
11455 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11457 clear_glyph_matrix (w
->desired_matrix
);
11458 f
->n_tool_bar_rows
= nrows
;
11459 fonts_changed_p
= 1;
11466 f
->minimize_tool_bar_window_p
= 0;
11471 /* Get information about the tool-bar item which is displayed in GLYPH
11472 on frame F. Return in *PROP_IDX the index where tool-bar item
11473 properties start in F->tool_bar_items. Value is zero if
11474 GLYPH doesn't display a tool-bar item. */
11477 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11483 /* This function can be called asynchronously, which means we must
11484 exclude any possibility that Fget_text_property signals an
11486 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11487 charpos
= max (0, charpos
);
11489 /* Get the text property `menu-item' at pos. The value of that
11490 property is the start index of this item's properties in
11491 F->tool_bar_items. */
11492 prop
= Fget_text_property (make_number (charpos
),
11493 Qmenu_item
, f
->current_tool_bar_string
);
11494 if (INTEGERP (prop
))
11496 *prop_idx
= XINT (prop
);
11506 /* Get information about the tool-bar item at position X/Y on frame F.
11507 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11508 the current matrix of the tool-bar window of F, or NULL if not
11509 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11510 item in F->tool_bar_items. Value is
11512 -1 if X/Y is not on a tool-bar item
11513 0 if X/Y is on the same item that was highlighted before.
11517 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11518 int *hpos
, int *vpos
, int *prop_idx
)
11520 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11521 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11524 /* Find the glyph under X/Y. */
11525 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11526 if (*glyph
== NULL
)
11529 /* Get the start of this tool-bar item's properties in
11530 f->tool_bar_items. */
11531 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11534 /* Is mouse on the highlighted item? */
11535 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11536 && *vpos
>= hlinfo
->mouse_face_beg_row
11537 && *vpos
<= hlinfo
->mouse_face_end_row
11538 && (*vpos
> hlinfo
->mouse_face_beg_row
11539 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11540 && (*vpos
< hlinfo
->mouse_face_end_row
11541 || *hpos
< hlinfo
->mouse_face_end_col
11542 || hlinfo
->mouse_face_past_end
))
11550 Handle mouse button event on the tool-bar of frame F, at
11551 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11552 0 for button release. MODIFIERS is event modifiers for button
11556 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11557 unsigned int modifiers
)
11559 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11560 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11561 int hpos
, vpos
, prop_idx
;
11562 struct glyph
*glyph
;
11563 Lisp_Object enabled_p
;
11565 /* If not on the highlighted tool-bar item, return. */
11566 frame_to_window_pixel_xy (w
, &x
, &y
);
11567 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11570 /* If item is disabled, do nothing. */
11571 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11572 if (NILP (enabled_p
))
11577 /* Show item in pressed state. */
11578 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11579 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11580 last_tool_bar_item
= prop_idx
;
11584 Lisp_Object key
, frame
;
11585 struct input_event event
;
11586 EVENT_INIT (event
);
11588 /* Show item in released state. */
11589 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11590 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11592 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11594 XSETFRAME (frame
, f
);
11595 event
.kind
= TOOL_BAR_EVENT
;
11596 event
.frame_or_window
= frame
;
11598 kbd_buffer_store_event (&event
);
11600 event
.kind
= TOOL_BAR_EVENT
;
11601 event
.frame_or_window
= frame
;
11603 event
.modifiers
= modifiers
;
11604 kbd_buffer_store_event (&event
);
11605 last_tool_bar_item
= -1;
11610 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11611 tool-bar window-relative coordinates X/Y. Called from
11612 note_mouse_highlight. */
11615 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11617 Lisp_Object window
= f
->tool_bar_window
;
11618 struct window
*w
= XWINDOW (window
);
11619 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11620 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11622 struct glyph
*glyph
;
11623 struct glyph_row
*row
;
11625 Lisp_Object enabled_p
;
11627 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11628 int mouse_down_p
, rc
;
11630 /* Function note_mouse_highlight is called with negative X/Y
11631 values when mouse moves outside of the frame. */
11632 if (x
<= 0 || y
<= 0)
11634 clear_mouse_face (hlinfo
);
11638 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11641 /* Not on tool-bar item. */
11642 clear_mouse_face (hlinfo
);
11646 /* On same tool-bar item as before. */
11647 goto set_help_echo
;
11649 clear_mouse_face (hlinfo
);
11651 /* Mouse is down, but on different tool-bar item? */
11652 mouse_down_p
= (dpyinfo
->grabbed
11653 && f
== last_mouse_frame
11654 && FRAME_LIVE_P (f
));
11656 && last_tool_bar_item
!= prop_idx
)
11659 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11660 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11662 /* If tool-bar item is not enabled, don't highlight it. */
11663 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11664 if (!NILP (enabled_p
))
11666 /* Compute the x-position of the glyph. In front and past the
11667 image is a space. We include this in the highlighted area. */
11668 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11669 for (i
= x
= 0; i
< hpos
; ++i
)
11670 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11672 /* Record this as the current active region. */
11673 hlinfo
->mouse_face_beg_col
= hpos
;
11674 hlinfo
->mouse_face_beg_row
= vpos
;
11675 hlinfo
->mouse_face_beg_x
= x
;
11676 hlinfo
->mouse_face_beg_y
= row
->y
;
11677 hlinfo
->mouse_face_past_end
= 0;
11679 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11680 hlinfo
->mouse_face_end_row
= vpos
;
11681 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11682 hlinfo
->mouse_face_end_y
= row
->y
;
11683 hlinfo
->mouse_face_window
= window
;
11684 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11686 /* Display it as active. */
11687 show_mouse_face (hlinfo
, draw
);
11688 hlinfo
->mouse_face_image_state
= draw
;
11693 /* Set help_echo_string to a help string to display for this tool-bar item.
11694 XTread_socket does the rest. */
11695 help_echo_object
= help_echo_window
= Qnil
;
11696 help_echo_pos
= -1;
11697 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11698 if (NILP (help_echo_string
))
11699 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11702 #endif /* HAVE_WINDOW_SYSTEM */
11706 /************************************************************************
11707 Horizontal scrolling
11708 ************************************************************************/
11710 static int hscroll_window_tree (Lisp_Object
);
11711 static int hscroll_windows (Lisp_Object
);
11713 /* For all leaf windows in the window tree rooted at WINDOW, set their
11714 hscroll value so that PT is (i) visible in the window, and (ii) so
11715 that it is not within a certain margin at the window's left and
11716 right border. Value is non-zero if any window's hscroll has been
11720 hscroll_window_tree (Lisp_Object window
)
11722 int hscrolled_p
= 0;
11723 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11724 int hscroll_step_abs
= 0;
11725 double hscroll_step_rel
= 0;
11727 if (hscroll_relative_p
)
11729 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11730 if (hscroll_step_rel
< 0)
11732 hscroll_relative_p
= 0;
11733 hscroll_step_abs
= 0;
11736 else if (INTEGERP (Vhscroll_step
))
11738 hscroll_step_abs
= XINT (Vhscroll_step
);
11739 if (hscroll_step_abs
< 0)
11740 hscroll_step_abs
= 0;
11743 hscroll_step_abs
= 0;
11745 while (WINDOWP (window
))
11747 struct window
*w
= XWINDOW (window
);
11749 if (WINDOWP (w
->hchild
))
11750 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11751 else if (WINDOWP (w
->vchild
))
11752 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11753 else if (w
->cursor
.vpos
>= 0)
11756 int text_area_width
;
11757 struct glyph_row
*current_cursor_row
11758 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11759 struct glyph_row
*desired_cursor_row
11760 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11761 struct glyph_row
*cursor_row
11762 = (desired_cursor_row
->enabled_p
11763 ? desired_cursor_row
11764 : current_cursor_row
);
11766 text_area_width
= window_box_width (w
, TEXT_AREA
);
11768 /* Scroll when cursor is inside this scroll margin. */
11769 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11771 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11772 && ((XFASTINT (w
->hscroll
)
11773 && w
->cursor
.x
<= h_margin
)
11774 || (cursor_row
->enabled_p
11775 && cursor_row
->truncated_on_right_p
11776 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11780 struct buffer
*saved_current_buffer
;
11784 /* Find point in a display of infinite width. */
11785 saved_current_buffer
= current_buffer
;
11786 current_buffer
= XBUFFER (w
->buffer
);
11788 if (w
== XWINDOW (selected_window
))
11792 pt
= marker_position (w
->pointm
);
11793 pt
= max (BEGV
, pt
);
11797 /* Move iterator to pt starting at cursor_row->start in
11798 a line with infinite width. */
11799 init_to_row_start (&it
, w
, cursor_row
);
11800 it
.last_visible_x
= INFINITY
;
11801 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11802 current_buffer
= saved_current_buffer
;
11804 /* Position cursor in window. */
11805 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11806 hscroll
= max (0, (it
.current_x
11807 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11808 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11809 : (text_area_width
/ 2))))
11810 / FRAME_COLUMN_WIDTH (it
.f
);
11811 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11813 if (hscroll_relative_p
)
11814 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11817 wanted_x
= text_area_width
11818 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11821 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11825 if (hscroll_relative_p
)
11826 wanted_x
= text_area_width
* hscroll_step_rel
11829 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11832 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11834 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11836 /* Don't call Fset_window_hscroll if value hasn't
11837 changed because it will prevent redisplay
11839 if (XFASTINT (w
->hscroll
) != hscroll
)
11841 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11842 w
->hscroll
= make_number (hscroll
);
11851 /* Value is non-zero if hscroll of any leaf window has been changed. */
11852 return hscrolled_p
;
11856 /* Set hscroll so that cursor is visible and not inside horizontal
11857 scroll margins for all windows in the tree rooted at WINDOW. See
11858 also hscroll_window_tree above. Value is non-zero if any window's
11859 hscroll has been changed. If it has, desired matrices on the frame
11860 of WINDOW are cleared. */
11863 hscroll_windows (Lisp_Object window
)
11865 int hscrolled_p
= hscroll_window_tree (window
);
11867 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11868 return hscrolled_p
;
11873 /************************************************************************
11875 ************************************************************************/
11877 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11878 to a non-zero value. This is sometimes handy to have in a debugger
11883 /* First and last unchanged row for try_window_id. */
11885 static int debug_first_unchanged_at_end_vpos
;
11886 static int debug_last_unchanged_at_beg_vpos
;
11888 /* Delta vpos and y. */
11890 static int debug_dvpos
, debug_dy
;
11892 /* Delta in characters and bytes for try_window_id. */
11894 static EMACS_INT debug_delta
, debug_delta_bytes
;
11896 /* Values of window_end_pos and window_end_vpos at the end of
11899 static EMACS_INT debug_end_vpos
;
11901 /* Append a string to W->desired_matrix->method. FMT is a printf
11902 format string. If trace_redisplay_p is non-zero also printf the
11903 resulting string to stderr. */
11905 static void debug_method_add (struct window
*, char const *, ...)
11906 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11909 debug_method_add (struct window
*w
, char const *fmt
, ...)
11912 char *method
= w
->desired_matrix
->method
;
11913 int len
= strlen (method
);
11914 int size
= sizeof w
->desired_matrix
->method
;
11915 int remaining
= size
- len
- 1;
11918 va_start (ap
, fmt
);
11919 vsprintf (buffer
, fmt
, ap
);
11921 if (len
&& remaining
)
11924 --remaining
, ++len
;
11927 strncpy (method
+ len
, buffer
, remaining
);
11929 if (trace_redisplay_p
)
11930 fprintf (stderr
, "%p (%s): %s\n",
11932 ((BUFFERP (w
->buffer
)
11933 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11934 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11939 #endif /* GLYPH_DEBUG */
11942 /* Value is non-zero if all changes in window W, which displays
11943 current_buffer, are in the text between START and END. START is a
11944 buffer position, END is given as a distance from Z. Used in
11945 redisplay_internal for display optimization. */
11948 text_outside_line_unchanged_p (struct window
*w
,
11949 EMACS_INT start
, EMACS_INT end
)
11951 int unchanged_p
= 1;
11953 /* If text or overlays have changed, see where. */
11954 if (XFASTINT (w
->last_modified
) < MODIFF
11955 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11957 /* Gap in the line? */
11958 if (GPT
< start
|| Z
- GPT
< end
)
11961 /* Changes start in front of the line, or end after it? */
11963 && (BEG_UNCHANGED
< start
- 1
11964 || END_UNCHANGED
< end
))
11967 /* If selective display, can't optimize if changes start at the
11968 beginning of the line. */
11970 && INTEGERP (BVAR (current_buffer
, selective_display
))
11971 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11972 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11975 /* If there are overlays at the start or end of the line, these
11976 may have overlay strings with newlines in them. A change at
11977 START, for instance, may actually concern the display of such
11978 overlay strings as well, and they are displayed on different
11979 lines. So, quickly rule out this case. (For the future, it
11980 might be desirable to implement something more telling than
11981 just BEG/END_UNCHANGED.) */
11984 if (BEG
+ BEG_UNCHANGED
== start
11985 && overlay_touches_p (start
))
11987 if (END_UNCHANGED
== end
11988 && overlay_touches_p (Z
- end
))
11992 /* Under bidi reordering, adding or deleting a character in the
11993 beginning of a paragraph, before the first strong directional
11994 character, can change the base direction of the paragraph (unless
11995 the buffer specifies a fixed paragraph direction), which will
11996 require to redisplay the whole paragraph. It might be worthwhile
11997 to find the paragraph limits and widen the range of redisplayed
11998 lines to that, but for now just give up this optimization. */
11999 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12000 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12004 return unchanged_p
;
12008 /* Do a frame update, taking possible shortcuts into account. This is
12009 the main external entry point for redisplay.
12011 If the last redisplay displayed an echo area message and that message
12012 is no longer requested, we clear the echo area or bring back the
12013 mini-buffer if that is in use. */
12018 redisplay_internal ();
12023 overlay_arrow_string_or_property (Lisp_Object var
)
12027 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12030 return Voverlay_arrow_string
;
12033 /* Return 1 if there are any overlay-arrows in current_buffer. */
12035 overlay_arrow_in_current_buffer_p (void)
12039 for (vlist
= Voverlay_arrow_variable_list
;
12041 vlist
= XCDR (vlist
))
12043 Lisp_Object var
= XCAR (vlist
);
12046 if (!SYMBOLP (var
))
12048 val
= find_symbol_value (var
);
12050 && current_buffer
== XMARKER (val
)->buffer
)
12057 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12061 overlay_arrows_changed_p (void)
12065 for (vlist
= Voverlay_arrow_variable_list
;
12067 vlist
= XCDR (vlist
))
12069 Lisp_Object var
= XCAR (vlist
);
12070 Lisp_Object val
, pstr
;
12072 if (!SYMBOLP (var
))
12074 val
= find_symbol_value (var
);
12075 if (!MARKERP (val
))
12077 if (! EQ (COERCE_MARKER (val
),
12078 Fget (var
, Qlast_arrow_position
))
12079 || ! (pstr
= overlay_arrow_string_or_property (var
),
12080 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12086 /* Mark overlay arrows to be updated on next redisplay. */
12089 update_overlay_arrows (int up_to_date
)
12093 for (vlist
= Voverlay_arrow_variable_list
;
12095 vlist
= XCDR (vlist
))
12097 Lisp_Object var
= XCAR (vlist
);
12099 if (!SYMBOLP (var
))
12102 if (up_to_date
> 0)
12104 Lisp_Object val
= find_symbol_value (var
);
12105 Fput (var
, Qlast_arrow_position
,
12106 COERCE_MARKER (val
));
12107 Fput (var
, Qlast_arrow_string
,
12108 overlay_arrow_string_or_property (var
));
12110 else if (up_to_date
< 0
12111 || !NILP (Fget (var
, Qlast_arrow_position
)))
12113 Fput (var
, Qlast_arrow_position
, Qt
);
12114 Fput (var
, Qlast_arrow_string
, Qt
);
12120 /* Return overlay arrow string to display at row.
12121 Return integer (bitmap number) for arrow bitmap in left fringe.
12122 Return nil if no overlay arrow. */
12125 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12129 for (vlist
= Voverlay_arrow_variable_list
;
12131 vlist
= XCDR (vlist
))
12133 Lisp_Object var
= XCAR (vlist
);
12136 if (!SYMBOLP (var
))
12139 val
= find_symbol_value (var
);
12142 && current_buffer
== XMARKER (val
)->buffer
12143 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12145 if (FRAME_WINDOW_P (it
->f
)
12146 /* FIXME: if ROW->reversed_p is set, this should test
12147 the right fringe, not the left one. */
12148 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12150 #ifdef HAVE_WINDOW_SYSTEM
12151 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12154 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12155 return make_number (fringe_bitmap
);
12158 return make_number (-1); /* Use default arrow bitmap */
12160 return overlay_arrow_string_or_property (var
);
12167 /* Return 1 if point moved out of or into a composition. Otherwise
12168 return 0. PREV_BUF and PREV_PT are the last point buffer and
12169 position. BUF and PT are the current point buffer and position. */
12172 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12173 struct buffer
*buf
, EMACS_INT pt
)
12175 EMACS_INT start
, end
;
12177 Lisp_Object buffer
;
12179 XSETBUFFER (buffer
, buf
);
12180 /* Check a composition at the last point if point moved within the
12182 if (prev_buf
== buf
)
12185 /* Point didn't move. */
12188 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12189 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12190 && COMPOSITION_VALID_P (start
, end
, prop
)
12191 && start
< prev_pt
&& end
> prev_pt
)
12192 /* The last point was within the composition. Return 1 iff
12193 point moved out of the composition. */
12194 return (pt
<= start
|| pt
>= end
);
12197 /* Check a composition at the current point. */
12198 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12199 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12200 && COMPOSITION_VALID_P (start
, end
, prop
)
12201 && start
< pt
&& end
> pt
);
12205 /* Reconsider the setting of B->clip_changed which is displayed
12209 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12211 if (b
->clip_changed
12212 && !NILP (w
->window_end_valid
)
12213 && w
->current_matrix
->buffer
== b
12214 && w
->current_matrix
->zv
== BUF_ZV (b
)
12215 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12216 b
->clip_changed
= 0;
12218 /* If display wasn't paused, and W is not a tool bar window, see if
12219 point has been moved into or out of a composition. In that case,
12220 we set b->clip_changed to 1 to force updating the screen. If
12221 b->clip_changed has already been set to 1, we can skip this
12223 if (!b
->clip_changed
12224 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12228 if (w
== XWINDOW (selected_window
))
12231 pt
= marker_position (w
->pointm
);
12233 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12234 || pt
!= XINT (w
->last_point
))
12235 && check_point_in_composition (w
->current_matrix
->buffer
,
12236 XINT (w
->last_point
),
12237 XBUFFER (w
->buffer
), pt
))
12238 b
->clip_changed
= 1;
12243 /* Select FRAME to forward the values of frame-local variables into C
12244 variables so that the redisplay routines can access those values
12248 select_frame_for_redisplay (Lisp_Object frame
)
12250 Lisp_Object tail
, tem
;
12251 Lisp_Object old
= selected_frame
;
12252 struct Lisp_Symbol
*sym
;
12254 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12256 selected_frame
= frame
;
12259 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12260 if (CONSP (XCAR (tail
))
12261 && (tem
= XCAR (XCAR (tail
)),
12263 && (sym
= indirect_variable (XSYMBOL (tem
)),
12264 sym
->redirect
== SYMBOL_LOCALIZED
)
12265 && sym
->val
.blv
->frame_local
)
12266 /* Use find_symbol_value rather than Fsymbol_value
12267 to avoid an error if it is void. */
12268 find_symbol_value (tem
);
12269 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12273 #define STOP_POLLING \
12274 do { if (! polling_stopped_here) stop_polling (); \
12275 polling_stopped_here = 1; } while (0)
12277 #define RESUME_POLLING \
12278 do { if (polling_stopped_here) start_polling (); \
12279 polling_stopped_here = 0; } while (0)
12282 /* Perhaps in the future avoid recentering windows if it
12283 is not necessary; currently that causes some problems. */
12286 redisplay_internal (void)
12288 struct window
*w
= XWINDOW (selected_window
);
12292 int must_finish
= 0;
12293 struct text_pos tlbufpos
, tlendpos
;
12294 int number_of_visible_frames
;
12297 int polling_stopped_here
= 0;
12298 Lisp_Object old_frame
= selected_frame
;
12300 /* Non-zero means redisplay has to consider all windows on all
12301 frames. Zero means, only selected_window is considered. */
12302 int consider_all_windows_p
;
12304 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12306 /* No redisplay if running in batch mode or frame is not yet fully
12307 initialized, or redisplay is explicitly turned off by setting
12308 Vinhibit_redisplay. */
12309 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12310 || !NILP (Vinhibit_redisplay
))
12313 /* Don't examine these until after testing Vinhibit_redisplay.
12314 When Emacs is shutting down, perhaps because its connection to
12315 X has dropped, we should not look at them at all. */
12316 fr
= XFRAME (w
->frame
);
12317 sf
= SELECTED_FRAME ();
12319 if (!fr
->glyphs_initialized_p
)
12322 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12323 if (popup_activated ())
12327 /* I don't think this happens but let's be paranoid. */
12328 if (redisplaying_p
)
12331 /* Record a function that resets redisplaying_p to its old value
12332 when we leave this function. */
12333 count
= SPECPDL_INDEX ();
12334 record_unwind_protect (unwind_redisplay
,
12335 Fcons (make_number (redisplaying_p
), selected_frame
));
12337 specbind (Qinhibit_free_realized_faces
, Qnil
);
12340 Lisp_Object tail
, frame
;
12342 FOR_EACH_FRAME (tail
, frame
)
12344 struct frame
*f
= XFRAME (frame
);
12345 f
->already_hscrolled_p
= 0;
12350 /* Remember the currently selected window. */
12353 if (!EQ (old_frame
, selected_frame
)
12354 && FRAME_LIVE_P (XFRAME (old_frame
)))
12355 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12356 selected_frame and selected_window to be temporarily out-of-sync so
12357 when we come back here via `goto retry', we need to resync because we
12358 may need to run Elisp code (via prepare_menu_bars). */
12359 select_frame_for_redisplay (old_frame
);
12362 reconsider_clip_changes (w
, current_buffer
);
12363 last_escape_glyph_frame
= NULL
;
12364 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12365 last_glyphless_glyph_frame
= NULL
;
12366 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12368 /* If new fonts have been loaded that make a glyph matrix adjustment
12369 necessary, do it. */
12370 if (fonts_changed_p
)
12372 adjust_glyphs (NULL
);
12373 ++windows_or_buffers_changed
;
12374 fonts_changed_p
= 0;
12377 /* If face_change_count is non-zero, init_iterator will free all
12378 realized faces, which includes the faces referenced from current
12379 matrices. So, we can't reuse current matrices in this case. */
12380 if (face_change_count
)
12381 ++windows_or_buffers_changed
;
12383 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12384 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12386 /* Since frames on a single ASCII terminal share the same
12387 display area, displaying a different frame means redisplay
12388 the whole thing. */
12389 windows_or_buffers_changed
++;
12390 SET_FRAME_GARBAGED (sf
);
12392 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12394 FRAME_TTY (sf
)->previous_frame
= sf
;
12397 /* Set the visible flags for all frames. Do this before checking
12398 for resized or garbaged frames; they want to know if their frames
12399 are visible. See the comment in frame.h for
12400 FRAME_SAMPLE_VISIBILITY. */
12402 Lisp_Object tail
, frame
;
12404 number_of_visible_frames
= 0;
12406 FOR_EACH_FRAME (tail
, frame
)
12408 struct frame
*f
= XFRAME (frame
);
12410 FRAME_SAMPLE_VISIBILITY (f
);
12411 if (FRAME_VISIBLE_P (f
))
12412 ++number_of_visible_frames
;
12413 clear_desired_matrices (f
);
12417 /* Notice any pending interrupt request to change frame size. */
12418 do_pending_window_change (1);
12420 /* do_pending_window_change could change the selected_window due to
12421 frame resizing which makes the selected window too small. */
12422 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12425 reconsider_clip_changes (w
, current_buffer
);
12428 /* Clear frames marked as garbaged. */
12429 if (frame_garbaged
)
12430 clear_garbaged_frames ();
12432 /* Build menubar and tool-bar items. */
12433 if (NILP (Vmemory_full
))
12434 prepare_menu_bars ();
12436 if (windows_or_buffers_changed
)
12437 update_mode_lines
++;
12439 /* Detect case that we need to write or remove a star in the mode line. */
12440 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12442 w
->update_mode_line
= Qt
;
12443 if (buffer_shared
> 1)
12444 update_mode_lines
++;
12447 /* Avoid invocation of point motion hooks by `current_column' below. */
12448 count1
= SPECPDL_INDEX ();
12449 specbind (Qinhibit_point_motion_hooks
, Qt
);
12451 /* If %c is in the mode line, update it if needed. */
12452 if (!NILP (w
->column_number_displayed
)
12453 /* This alternative quickly identifies a common case
12454 where no change is needed. */
12455 && !(PT
== XFASTINT (w
->last_point
)
12456 && XFASTINT (w
->last_modified
) >= MODIFF
12457 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12458 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12459 w
->update_mode_line
= Qt
;
12461 unbind_to (count1
, Qnil
);
12463 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12465 /* The variable buffer_shared is set in redisplay_window and
12466 indicates that we redisplay a buffer in different windows. See
12468 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12469 || cursor_type_changed
);
12471 /* If specs for an arrow have changed, do thorough redisplay
12472 to ensure we remove any arrow that should no longer exist. */
12473 if (overlay_arrows_changed_p ())
12474 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12476 /* Normally the message* functions will have already displayed and
12477 updated the echo area, but the frame may have been trashed, or
12478 the update may have been preempted, so display the echo area
12479 again here. Checking message_cleared_p captures the case that
12480 the echo area should be cleared. */
12481 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12482 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12483 || (message_cleared_p
12484 && minibuf_level
== 0
12485 /* If the mini-window is currently selected, this means the
12486 echo-area doesn't show through. */
12487 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12489 int window_height_changed_p
= echo_area_display (0);
12492 /* If we don't display the current message, don't clear the
12493 message_cleared_p flag, because, if we did, we wouldn't clear
12494 the echo area in the next redisplay which doesn't preserve
12496 if (!display_last_displayed_message_p
)
12497 message_cleared_p
= 0;
12499 if (fonts_changed_p
)
12501 else if (window_height_changed_p
)
12503 consider_all_windows_p
= 1;
12504 ++update_mode_lines
;
12505 ++windows_or_buffers_changed
;
12507 /* If window configuration was changed, frames may have been
12508 marked garbaged. Clear them or we will experience
12509 surprises wrt scrolling. */
12510 if (frame_garbaged
)
12511 clear_garbaged_frames ();
12514 else if (EQ (selected_window
, minibuf_window
)
12515 && (current_buffer
->clip_changed
12516 || XFASTINT (w
->last_modified
) < MODIFF
12517 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12518 && resize_mini_window (w
, 0))
12520 /* Resized active mini-window to fit the size of what it is
12521 showing if its contents might have changed. */
12523 /* FIXME: this causes all frames to be updated, which seems unnecessary
12524 since only the current frame needs to be considered. This function needs
12525 to be rewritten with two variables, consider_all_windows and
12526 consider_all_frames. */
12527 consider_all_windows_p
= 1;
12528 ++windows_or_buffers_changed
;
12529 ++update_mode_lines
;
12531 /* If window configuration was changed, frames may have been
12532 marked garbaged. Clear them or we will experience
12533 surprises wrt scrolling. */
12534 if (frame_garbaged
)
12535 clear_garbaged_frames ();
12539 /* If showing the region, and mark has changed, we must redisplay
12540 the whole window. The assignment to this_line_start_pos prevents
12541 the optimization directly below this if-statement. */
12542 if (((!NILP (Vtransient_mark_mode
)
12543 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12544 != !NILP (w
->region_showing
))
12545 || (!NILP (w
->region_showing
)
12546 && !EQ (w
->region_showing
,
12547 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12548 CHARPOS (this_line_start_pos
) = 0;
12550 /* Optimize the case that only the line containing the cursor in the
12551 selected window has changed. Variables starting with this_ are
12552 set in display_line and record information about the line
12553 containing the cursor. */
12554 tlbufpos
= this_line_start_pos
;
12555 tlendpos
= this_line_end_pos
;
12556 if (!consider_all_windows_p
12557 && CHARPOS (tlbufpos
) > 0
12558 && NILP (w
->update_mode_line
)
12559 && !current_buffer
->clip_changed
12560 && !current_buffer
->prevent_redisplay_optimizations_p
12561 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12562 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12563 /* Make sure recorded data applies to current buffer, etc. */
12564 && this_line_buffer
== current_buffer
12565 && current_buffer
== XBUFFER (w
->buffer
)
12566 && NILP (w
->force_start
)
12567 && NILP (w
->optional_new_start
)
12568 /* Point must be on the line that we have info recorded about. */
12569 && PT
>= CHARPOS (tlbufpos
)
12570 && PT
<= Z
- CHARPOS (tlendpos
)
12571 /* All text outside that line, including its final newline,
12572 must be unchanged. */
12573 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12574 CHARPOS (tlendpos
)))
12576 if (CHARPOS (tlbufpos
) > BEGV
12577 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12578 && (CHARPOS (tlbufpos
) == ZV
12579 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12580 /* Former continuation line has disappeared by becoming empty. */
12582 else if (XFASTINT (w
->last_modified
) < MODIFF
12583 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12584 || MINI_WINDOW_P (w
))
12586 /* We have to handle the case of continuation around a
12587 wide-column character (see the comment in indent.c around
12590 For instance, in the following case:
12592 -------- Insert --------
12593 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12594 J_I_ ==> J_I_ `^^' are cursors.
12598 As we have to redraw the line above, we cannot use this
12602 int line_height_before
= this_line_pixel_height
;
12604 /* Note that start_display will handle the case that the
12605 line starting at tlbufpos is a continuation line. */
12606 start_display (&it
, w
, tlbufpos
);
12608 /* Implementation note: It this still necessary? */
12609 if (it
.current_x
!= this_line_start_x
)
12612 TRACE ((stderr
, "trying display optimization 1\n"));
12613 w
->cursor
.vpos
= -1;
12614 overlay_arrow_seen
= 0;
12615 it
.vpos
= this_line_vpos
;
12616 it
.current_y
= this_line_y
;
12617 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12618 display_line (&it
);
12620 /* If line contains point, is not continued,
12621 and ends at same distance from eob as before, we win. */
12622 if (w
->cursor
.vpos
>= 0
12623 /* Line is not continued, otherwise this_line_start_pos
12624 would have been set to 0 in display_line. */
12625 && CHARPOS (this_line_start_pos
)
12626 /* Line ends as before. */
12627 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12628 /* Line has same height as before. Otherwise other lines
12629 would have to be shifted up or down. */
12630 && this_line_pixel_height
== line_height_before
)
12632 /* If this is not the window's last line, we must adjust
12633 the charstarts of the lines below. */
12634 if (it
.current_y
< it
.last_visible_y
)
12636 struct glyph_row
*row
12637 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12638 EMACS_INT delta
, delta_bytes
;
12640 /* We used to distinguish between two cases here,
12641 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12642 when the line ends in a newline or the end of the
12643 buffer's accessible portion. But both cases did
12644 the same, so they were collapsed. */
12646 - CHARPOS (tlendpos
)
12647 - MATRIX_ROW_START_CHARPOS (row
));
12648 delta_bytes
= (Z_BYTE
12649 - BYTEPOS (tlendpos
)
12650 - MATRIX_ROW_START_BYTEPOS (row
));
12652 increment_matrix_positions (w
->current_matrix
,
12653 this_line_vpos
+ 1,
12654 w
->current_matrix
->nrows
,
12655 delta
, delta_bytes
);
12658 /* If this row displays text now but previously didn't,
12659 or vice versa, w->window_end_vpos may have to be
12661 if ((it
.glyph_row
- 1)->displays_text_p
)
12663 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12664 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12666 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12667 && this_line_vpos
> 0)
12668 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12669 w
->window_end_valid
= Qnil
;
12671 /* Update hint: No need to try to scroll in update_window. */
12672 w
->desired_matrix
->no_scrolling_p
= 1;
12675 *w
->desired_matrix
->method
= 0;
12676 debug_method_add (w
, "optimization 1");
12678 #ifdef HAVE_WINDOW_SYSTEM
12679 update_window_fringes (w
, 0);
12686 else if (/* Cursor position hasn't changed. */
12687 PT
== XFASTINT (w
->last_point
)
12688 /* Make sure the cursor was last displayed
12689 in this window. Otherwise we have to reposition it. */
12690 && 0 <= w
->cursor
.vpos
12691 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12695 do_pending_window_change (1);
12696 /* If selected_window changed, redisplay again. */
12697 if (WINDOWP (selected_window
)
12698 && (w
= XWINDOW (selected_window
)) != sw
)
12701 /* We used to always goto end_of_redisplay here, but this
12702 isn't enough if we have a blinking cursor. */
12703 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12704 goto end_of_redisplay
;
12708 /* If highlighting the region, or if the cursor is in the echo area,
12709 then we can't just move the cursor. */
12710 else if (! (!NILP (Vtransient_mark_mode
)
12711 && !NILP (BVAR (current_buffer
, mark_active
)))
12712 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12713 || highlight_nonselected_windows
)
12714 && NILP (w
->region_showing
)
12715 && NILP (Vshow_trailing_whitespace
)
12716 && !cursor_in_echo_area
)
12719 struct glyph_row
*row
;
12721 /* Skip from tlbufpos to PT and see where it is. Note that
12722 PT may be in invisible text. If so, we will end at the
12723 next visible position. */
12724 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12725 NULL
, DEFAULT_FACE_ID
);
12726 it
.current_x
= this_line_start_x
;
12727 it
.current_y
= this_line_y
;
12728 it
.vpos
= this_line_vpos
;
12730 /* The call to move_it_to stops in front of PT, but
12731 moves over before-strings. */
12732 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12734 if (it
.vpos
== this_line_vpos
12735 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12738 xassert (this_line_vpos
== it
.vpos
);
12739 xassert (this_line_y
== it
.current_y
);
12740 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12742 *w
->desired_matrix
->method
= 0;
12743 debug_method_add (w
, "optimization 3");
12752 /* Text changed drastically or point moved off of line. */
12753 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12756 CHARPOS (this_line_start_pos
) = 0;
12757 consider_all_windows_p
|= buffer_shared
> 1;
12758 ++clear_face_cache_count
;
12759 #ifdef HAVE_WINDOW_SYSTEM
12760 ++clear_image_cache_count
;
12763 /* Build desired matrices, and update the display. If
12764 consider_all_windows_p is non-zero, do it for all windows on all
12765 frames. Otherwise do it for selected_window, only. */
12767 if (consider_all_windows_p
)
12769 Lisp_Object tail
, frame
;
12771 FOR_EACH_FRAME (tail
, frame
)
12772 XFRAME (frame
)->updated_p
= 0;
12774 /* Recompute # windows showing selected buffer. This will be
12775 incremented each time such a window is displayed. */
12778 FOR_EACH_FRAME (tail
, frame
)
12780 struct frame
*f
= XFRAME (frame
);
12782 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12784 if (! EQ (frame
, selected_frame
))
12785 /* Select the frame, for the sake of frame-local
12787 select_frame_for_redisplay (frame
);
12789 /* Mark all the scroll bars to be removed; we'll redeem
12790 the ones we want when we redisplay their windows. */
12791 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12792 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12794 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12795 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12797 /* The X error handler may have deleted that frame. */
12798 if (!FRAME_LIVE_P (f
))
12801 /* Any scroll bars which redisplay_windows should have
12802 nuked should now go away. */
12803 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12804 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12806 /* If fonts changed, display again. */
12807 /* ??? rms: I suspect it is a mistake to jump all the way
12808 back to retry here. It should just retry this frame. */
12809 if (fonts_changed_p
)
12812 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12814 /* See if we have to hscroll. */
12815 if (!f
->already_hscrolled_p
)
12817 f
->already_hscrolled_p
= 1;
12818 if (hscroll_windows (f
->root_window
))
12822 /* Prevent various kinds of signals during display
12823 update. stdio is not robust about handling
12824 signals, which can cause an apparent I/O
12826 if (interrupt_input
)
12827 unrequest_sigio ();
12830 /* Update the display. */
12831 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12832 pending
|= update_frame (f
, 0, 0);
12838 if (!EQ (old_frame
, selected_frame
)
12839 && FRAME_LIVE_P (XFRAME (old_frame
)))
12840 /* We played a bit fast-and-loose above and allowed selected_frame
12841 and selected_window to be temporarily out-of-sync but let's make
12842 sure this stays contained. */
12843 select_frame_for_redisplay (old_frame
);
12844 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12848 /* Do the mark_window_display_accurate after all windows have
12849 been redisplayed because this call resets flags in buffers
12850 which are needed for proper redisplay. */
12851 FOR_EACH_FRAME (tail
, frame
)
12853 struct frame
*f
= XFRAME (frame
);
12856 mark_window_display_accurate (f
->root_window
, 1);
12857 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12858 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12863 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12865 Lisp_Object mini_window
;
12866 struct frame
*mini_frame
;
12868 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12869 /* Use list_of_error, not Qerror, so that
12870 we catch only errors and don't run the debugger. */
12871 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12873 redisplay_window_error
);
12875 /* Compare desired and current matrices, perform output. */
12878 /* If fonts changed, display again. */
12879 if (fonts_changed_p
)
12882 /* Prevent various kinds of signals during display update.
12883 stdio is not robust about handling signals,
12884 which can cause an apparent I/O error. */
12885 if (interrupt_input
)
12886 unrequest_sigio ();
12889 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12891 if (hscroll_windows (selected_window
))
12894 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12895 pending
= update_frame (sf
, 0, 0);
12898 /* We may have called echo_area_display at the top of this
12899 function. If the echo area is on another frame, that may
12900 have put text on a frame other than the selected one, so the
12901 above call to update_frame would not have caught it. Catch
12903 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12904 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12906 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12908 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12909 pending
|= update_frame (mini_frame
, 0, 0);
12910 if (!pending
&& hscroll_windows (mini_window
))
12915 /* If display was paused because of pending input, make sure we do a
12916 thorough update the next time. */
12919 /* Prevent the optimization at the beginning of
12920 redisplay_internal that tries a single-line update of the
12921 line containing the cursor in the selected window. */
12922 CHARPOS (this_line_start_pos
) = 0;
12924 /* Let the overlay arrow be updated the next time. */
12925 update_overlay_arrows (0);
12927 /* If we pause after scrolling, some rows in the current
12928 matrices of some windows are not valid. */
12929 if (!WINDOW_FULL_WIDTH_P (w
)
12930 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12931 update_mode_lines
= 1;
12935 if (!consider_all_windows_p
)
12937 /* This has already been done above if
12938 consider_all_windows_p is set. */
12939 mark_window_display_accurate_1 (w
, 1);
12941 /* Say overlay arrows are up to date. */
12942 update_overlay_arrows (1);
12944 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12945 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12948 update_mode_lines
= 0;
12949 windows_or_buffers_changed
= 0;
12950 cursor_type_changed
= 0;
12953 /* Start SIGIO interrupts coming again. Having them off during the
12954 code above makes it less likely one will discard output, but not
12955 impossible, since there might be stuff in the system buffer here.
12956 But it is much hairier to try to do anything about that. */
12957 if (interrupt_input
)
12961 /* If a frame has become visible which was not before, redisplay
12962 again, so that we display it. Expose events for such a frame
12963 (which it gets when becoming visible) don't call the parts of
12964 redisplay constructing glyphs, so simply exposing a frame won't
12965 display anything in this case. So, we have to display these
12966 frames here explicitly. */
12969 Lisp_Object tail
, frame
;
12972 FOR_EACH_FRAME (tail
, frame
)
12974 int this_is_visible
= 0;
12976 if (XFRAME (frame
)->visible
)
12977 this_is_visible
= 1;
12978 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12979 if (XFRAME (frame
)->visible
)
12980 this_is_visible
= 1;
12982 if (this_is_visible
)
12986 if (new_count
!= number_of_visible_frames
)
12987 windows_or_buffers_changed
++;
12990 /* Change frame size now if a change is pending. */
12991 do_pending_window_change (1);
12993 /* If we just did a pending size change, or have additional
12994 visible frames, or selected_window changed, redisplay again. */
12995 if ((windows_or_buffers_changed
&& !pending
)
12996 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12999 /* Clear the face and image caches.
13001 We used to do this only if consider_all_windows_p. But the cache
13002 needs to be cleared if a timer creates images in the current
13003 buffer (e.g. the test case in Bug#6230). */
13005 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13007 clear_face_cache (0);
13008 clear_face_cache_count
= 0;
13011 #ifdef HAVE_WINDOW_SYSTEM
13012 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13014 clear_image_caches (Qnil
);
13015 clear_image_cache_count
= 0;
13017 #endif /* HAVE_WINDOW_SYSTEM */
13020 unbind_to (count
, Qnil
);
13025 /* Redisplay, but leave alone any recent echo area message unless
13026 another message has been requested in its place.
13028 This is useful in situations where you need to redisplay but no
13029 user action has occurred, making it inappropriate for the message
13030 area to be cleared. See tracking_off and
13031 wait_reading_process_output for examples of these situations.
13033 FROM_WHERE is an integer saying from where this function was
13034 called. This is useful for debugging. */
13037 redisplay_preserve_echo_area (int from_where
)
13039 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13041 if (!NILP (echo_area_buffer
[1]))
13043 /* We have a previously displayed message, but no current
13044 message. Redisplay the previous message. */
13045 display_last_displayed_message_p
= 1;
13046 redisplay_internal ();
13047 display_last_displayed_message_p
= 0;
13050 redisplay_internal ();
13052 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13053 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13054 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13058 /* Function registered with record_unwind_protect in
13059 redisplay_internal. Reset redisplaying_p to the value it had
13060 before redisplay_internal was called, and clear
13061 prevent_freeing_realized_faces_p. It also selects the previously
13062 selected frame, unless it has been deleted (by an X connection
13063 failure during redisplay, for example). */
13066 unwind_redisplay (Lisp_Object val
)
13068 Lisp_Object old_redisplaying_p
, old_frame
;
13070 old_redisplaying_p
= XCAR (val
);
13071 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13072 old_frame
= XCDR (val
);
13073 if (! EQ (old_frame
, selected_frame
)
13074 && FRAME_LIVE_P (XFRAME (old_frame
)))
13075 select_frame_for_redisplay (old_frame
);
13080 /* Mark the display of window W as accurate or inaccurate. If
13081 ACCURATE_P is non-zero mark display of W as accurate. If
13082 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13083 redisplay_internal is called. */
13086 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13088 if (BUFFERP (w
->buffer
))
13090 struct buffer
*b
= XBUFFER (w
->buffer
);
13093 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13094 w
->last_overlay_modified
13095 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13097 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13101 b
->clip_changed
= 0;
13102 b
->prevent_redisplay_optimizations_p
= 0;
13104 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13105 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13106 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13107 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13109 w
->current_matrix
->buffer
= b
;
13110 w
->current_matrix
->begv
= BUF_BEGV (b
);
13111 w
->current_matrix
->zv
= BUF_ZV (b
);
13113 w
->last_cursor
= w
->cursor
;
13114 w
->last_cursor_off_p
= w
->cursor_off_p
;
13116 if (w
== XWINDOW (selected_window
))
13117 w
->last_point
= make_number (BUF_PT (b
));
13119 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13125 w
->window_end_valid
= w
->buffer
;
13126 w
->update_mode_line
= Qnil
;
13131 /* Mark the display of windows in the window tree rooted at WINDOW as
13132 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13133 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13134 be redisplayed the next time redisplay_internal is called. */
13137 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13141 for (; !NILP (window
); window
= w
->next
)
13143 w
= XWINDOW (window
);
13144 mark_window_display_accurate_1 (w
, accurate_p
);
13146 if (!NILP (w
->vchild
))
13147 mark_window_display_accurate (w
->vchild
, accurate_p
);
13148 if (!NILP (w
->hchild
))
13149 mark_window_display_accurate (w
->hchild
, accurate_p
);
13154 update_overlay_arrows (1);
13158 /* Force a thorough redisplay the next time by setting
13159 last_arrow_position and last_arrow_string to t, which is
13160 unequal to any useful value of Voverlay_arrow_... */
13161 update_overlay_arrows (-1);
13166 /* Return value in display table DP (Lisp_Char_Table *) for character
13167 C. Since a display table doesn't have any parent, we don't have to
13168 follow parent. Do not call this function directly but use the
13169 macro DISP_CHAR_VECTOR. */
13172 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13176 if (ASCII_CHAR_P (c
))
13179 if (SUB_CHAR_TABLE_P (val
))
13180 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13186 XSETCHAR_TABLE (table
, dp
);
13187 val
= char_table_ref (table
, c
);
13196 /***********************************************************************
13198 ***********************************************************************/
13200 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13203 redisplay_windows (Lisp_Object window
)
13205 while (!NILP (window
))
13207 struct window
*w
= XWINDOW (window
);
13209 if (!NILP (w
->hchild
))
13210 redisplay_windows (w
->hchild
);
13211 else if (!NILP (w
->vchild
))
13212 redisplay_windows (w
->vchild
);
13213 else if (!NILP (w
->buffer
))
13215 displayed_buffer
= XBUFFER (w
->buffer
);
13216 /* Use list_of_error, not Qerror, so that
13217 we catch only errors and don't run the debugger. */
13218 internal_condition_case_1 (redisplay_window_0
, window
,
13220 redisplay_window_error
);
13228 redisplay_window_error (Lisp_Object ignore
)
13230 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13235 redisplay_window_0 (Lisp_Object window
)
13237 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13238 redisplay_window (window
, 0);
13243 redisplay_window_1 (Lisp_Object window
)
13245 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13246 redisplay_window (window
, 1);
13251 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13252 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13253 which positions recorded in ROW differ from current buffer
13256 Return 0 if cursor is not on this row, 1 otherwise. */
13259 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13260 struct glyph_matrix
*matrix
,
13261 EMACS_INT delta
, EMACS_INT delta_bytes
,
13264 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13265 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13266 struct glyph
*cursor
= NULL
;
13267 /* The last known character position in row. */
13268 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13270 EMACS_INT pt_old
= PT
- delta
;
13271 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13272 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13273 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13274 /* A glyph beyond the edge of TEXT_AREA which we should never
13276 struct glyph
*glyphs_end
= end
;
13277 /* Non-zero means we've found a match for cursor position, but that
13278 glyph has the avoid_cursor_p flag set. */
13279 int match_with_avoid_cursor
= 0;
13280 /* Non-zero means we've seen at least one glyph that came from a
13282 int string_seen
= 0;
13283 /* Largest and smalles buffer positions seen so far during scan of
13285 EMACS_INT bpos_max
= pos_before
;
13286 EMACS_INT bpos_min
= pos_after
;
13287 /* Last buffer position covered by an overlay string with an integer
13288 `cursor' property. */
13289 EMACS_INT bpos_covered
= 0;
13291 /* Skip over glyphs not having an object at the start and the end of
13292 the row. These are special glyphs like truncation marks on
13293 terminal frames. */
13294 if (row
->displays_text_p
)
13296 if (!row
->reversed_p
)
13299 && INTEGERP (glyph
->object
)
13300 && glyph
->charpos
< 0)
13302 x
+= glyph
->pixel_width
;
13306 && INTEGERP ((end
- 1)->object
)
13307 /* CHARPOS is zero for blanks and stretch glyphs
13308 inserted by extend_face_to_end_of_line. */
13309 && (end
- 1)->charpos
<= 0)
13311 glyph_before
= glyph
- 1;
13318 /* If the glyph row is reversed, we need to process it from back
13319 to front, so swap the edge pointers. */
13320 glyphs_end
= end
= glyph
- 1;
13321 glyph
+= row
->used
[TEXT_AREA
] - 1;
13323 while (glyph
> end
+ 1
13324 && INTEGERP (glyph
->object
)
13325 && glyph
->charpos
< 0)
13328 x
-= glyph
->pixel_width
;
13330 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13332 /* By default, in reversed rows we put the cursor on the
13333 rightmost (first in the reading order) glyph. */
13334 for (g
= end
+ 1; g
< glyph
; g
++)
13335 x
+= g
->pixel_width
;
13337 && INTEGERP ((end
+ 1)->object
)
13338 && (end
+ 1)->charpos
<= 0)
13340 glyph_before
= glyph
+ 1;
13344 else if (row
->reversed_p
)
13346 /* In R2L rows that don't display text, put the cursor on the
13347 rightmost glyph. Case in point: an empty last line that is
13348 part of an R2L paragraph. */
13350 /* Avoid placing the cursor on the last glyph of the row, where
13351 on terminal frames we hold the vertical border between
13352 adjacent windows. */
13353 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13354 && !WINDOW_RIGHTMOST_P (w
)
13355 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13357 x
= -1; /* will be computed below, at label compute_x */
13360 /* Step 1: Try to find the glyph whose character position
13361 corresponds to point. If that's not possible, find 2 glyphs
13362 whose character positions are the closest to point, one before
13363 point, the other after it. */
13364 if (!row
->reversed_p
)
13365 while (/* not marched to end of glyph row */
13367 /* glyph was not inserted by redisplay for internal purposes */
13368 && !INTEGERP (glyph
->object
))
13370 if (BUFFERP (glyph
->object
))
13372 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13374 if (glyph
->charpos
> bpos_max
)
13375 bpos_max
= glyph
->charpos
;
13376 if (glyph
->charpos
< bpos_min
)
13377 bpos_min
= glyph
->charpos
;
13378 if (!glyph
->avoid_cursor_p
)
13380 /* If we hit point, we've found the glyph on which to
13381 display the cursor. */
13384 match_with_avoid_cursor
= 0;
13387 /* See if we've found a better approximation to
13388 POS_BEFORE or to POS_AFTER. Note that we want the
13389 first (leftmost) glyph of all those that are the
13390 closest from below, and the last (rightmost) of all
13391 those from above. */
13392 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13394 pos_before
= glyph
->charpos
;
13395 glyph_before
= glyph
;
13397 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13399 pos_after
= glyph
->charpos
;
13400 glyph_after
= glyph
;
13403 else if (dpos
== 0)
13404 match_with_avoid_cursor
= 1;
13406 else if (STRINGP (glyph
->object
))
13408 Lisp_Object chprop
;
13409 EMACS_INT glyph_pos
= glyph
->charpos
;
13411 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13413 if (INTEGERP (chprop
))
13415 bpos_covered
= bpos_max
+ XINT (chprop
);
13416 /* If the `cursor' property covers buffer positions up
13417 to and including point, we should display cursor on
13418 this glyph. Note that overlays and text properties
13419 with string values stop bidi reordering, so every
13420 buffer position to the left of the string is always
13421 smaller than any position to the right of the
13422 string. Therefore, if a `cursor' property on one
13423 of the string's characters has an integer value, we
13424 will break out of the loop below _before_ we get to
13425 the position match above. IOW, integer values of
13426 the `cursor' property override the "exact match for
13427 point" strategy of positioning the cursor. */
13428 /* Implementation note: bpos_max == pt_old when, e.g.,
13429 we are in an empty line, where bpos_max is set to
13430 MATRIX_ROW_START_CHARPOS, see above. */
13431 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13440 x
+= glyph
->pixel_width
;
13443 else if (glyph
> end
) /* row is reversed */
13444 while (!INTEGERP (glyph
->object
))
13446 if (BUFFERP (glyph
->object
))
13448 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13450 if (glyph
->charpos
> bpos_max
)
13451 bpos_max
= glyph
->charpos
;
13452 if (glyph
->charpos
< bpos_min
)
13453 bpos_min
= glyph
->charpos
;
13454 if (!glyph
->avoid_cursor_p
)
13458 match_with_avoid_cursor
= 0;
13461 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13463 pos_before
= glyph
->charpos
;
13464 glyph_before
= glyph
;
13466 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13468 pos_after
= glyph
->charpos
;
13469 glyph_after
= glyph
;
13472 else if (dpos
== 0)
13473 match_with_avoid_cursor
= 1;
13475 else if (STRINGP (glyph
->object
))
13477 Lisp_Object chprop
;
13478 EMACS_INT glyph_pos
= glyph
->charpos
;
13480 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13482 if (INTEGERP (chprop
))
13484 bpos_covered
= bpos_max
+ XINT (chprop
);
13485 /* If the `cursor' property covers buffer positions up
13486 to and including point, we should display cursor on
13488 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13497 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13499 x
--; /* can't use any pixel_width */
13502 x
-= glyph
->pixel_width
;
13505 /* Step 2: If we didn't find an exact match for point, we need to
13506 look for a proper place to put the cursor among glyphs between
13507 GLYPH_BEFORE and GLYPH_AFTER. */
13508 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13509 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13510 && bpos_covered
< pt_old
)
13512 /* An empty line has a single glyph whose OBJECT is zero and
13513 whose CHARPOS is the position of a newline on that line.
13514 Note that on a TTY, there are more glyphs after that, which
13515 were produced by extend_face_to_end_of_line, but their
13516 CHARPOS is zero or negative. */
13518 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13519 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13521 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13523 EMACS_INT ellipsis_pos
;
13525 /* Scan back over the ellipsis glyphs. */
13526 if (!row
->reversed_p
)
13528 ellipsis_pos
= (glyph
- 1)->charpos
;
13529 while (glyph
> row
->glyphs
[TEXT_AREA
]
13530 && (glyph
- 1)->charpos
== ellipsis_pos
)
13531 glyph
--, x
-= glyph
->pixel_width
;
13532 /* That loop always goes one position too far, including
13533 the glyph before the ellipsis. So scan forward over
13535 x
+= glyph
->pixel_width
;
13538 else /* row is reversed */
13540 ellipsis_pos
= (glyph
+ 1)->charpos
;
13541 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13542 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13543 glyph
++, x
+= glyph
->pixel_width
;
13544 x
-= glyph
->pixel_width
;
13548 else if (match_with_avoid_cursor
13549 /* A truncated row may not include PT among its
13550 character positions. Setting the cursor inside the
13551 scroll margin will trigger recalculation of hscroll
13552 in hscroll_window_tree. */
13553 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13554 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13555 /* Zero-width characters produce no glyphs. */
13558 && (row
->reversed_p
13559 ? glyph_after
> glyphs_end
13560 : glyph_after
< glyphs_end
)))
13562 cursor
= glyph_after
;
13565 else if (string_seen
)
13567 int incr
= row
->reversed_p
? -1 : +1;
13569 /* Need to find the glyph that came out of a string which is
13570 present at point. That glyph is somewhere between
13571 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13572 positioned between POS_BEFORE and POS_AFTER in the
13574 struct glyph
*start
, *stop
;
13575 EMACS_INT pos
= pos_before
;
13579 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13580 correspond to POS_BEFORE and POS_AFTER, respectively. We
13581 need START and STOP in the order that corresponds to the
13582 row's direction as given by its reversed_p flag. If the
13583 directionality of characters between POS_BEFORE and
13584 POS_AFTER is the opposite of the row's base direction,
13585 these characters will have been reordered for display,
13586 and we need to reverse START and STOP. */
13587 if (!row
->reversed_p
)
13589 start
= min (glyph_before
, glyph_after
);
13590 stop
= max (glyph_before
, glyph_after
);
13594 start
= max (glyph_before
, glyph_after
);
13595 stop
= min (glyph_before
, glyph_after
);
13597 for (glyph
= start
+ incr
;
13598 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13601 /* Any glyphs that come from the buffer are here because
13602 of bidi reordering. Skip them, and only pay
13603 attention to glyphs that came from some string. */
13604 if (STRINGP (glyph
->object
))
13609 str
= glyph
->object
;
13610 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
13611 if (tem
== 0 /* from overlay */
13614 /* If the string from which this glyph came is
13615 found in the buffer at point, then we've
13616 found the glyph we've been looking for. If
13617 it comes from an overlay (tem == 0), and it
13618 has the `cursor' property on one of its
13619 glyphs, record that glyph as a candidate for
13620 displaying the cursor. (As in the
13621 unidirectional version, we will display the
13622 cursor on the last candidate we find.) */
13623 if (tem
== 0 || tem
== pt_old
)
13625 /* The glyphs from this string could have
13626 been reordered. Find the one with the
13627 smallest string position. Or there could
13628 be a character in the string with the
13629 `cursor' property, which means display
13630 cursor on that character's glyph. */
13631 EMACS_INT strpos
= glyph
->charpos
;
13636 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13637 && EQ (glyph
->object
, str
);
13641 EMACS_INT gpos
= glyph
->charpos
;
13643 cprop
= Fget_char_property (make_number (gpos
),
13651 if (tem
&& glyph
->charpos
< strpos
)
13653 strpos
= glyph
->charpos
;
13662 pos
= tem
+ 1; /* don't find previous instances */
13664 /* This string is not what we want; skip all of the
13665 glyphs that came from it. */
13666 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13667 && EQ (glyph
->object
, str
))
13674 /* If we reached the end of the line, and END was from a string,
13675 the cursor is not on this line. */
13677 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13678 && STRINGP (end
->object
)
13679 && row
->continued_p
)
13685 if (cursor
!= NULL
)
13691 /* Need to compute x that corresponds to GLYPH. */
13692 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13694 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13696 x
+= g
->pixel_width
;
13700 /* ROW could be part of a continued line, which, under bidi
13701 reordering, might have other rows whose start and end charpos
13702 occlude point. Only set w->cursor if we found a better
13703 approximation to the cursor position than we have from previously
13704 examined candidate rows belonging to the same continued line. */
13705 if (/* we already have a candidate row */
13706 w
->cursor
.vpos
>= 0
13707 /* that candidate is not the row we are processing */
13708 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13709 /* Make sure cursor.vpos specifies a row whose start and end
13710 charpos occlude point. This is because some callers of this
13711 function leave cursor.vpos at the row where the cursor was
13712 displayed during the last redisplay cycle. */
13713 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13714 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13717 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13719 /* Don't consider glyphs that are outside TEXT_AREA. */
13720 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13722 /* Keep the candidate whose buffer position is the closest to
13723 point or has the `cursor' property. */
13724 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13725 w
->cursor
.hpos
>= 0
13726 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13727 && ((BUFFERP (g1
->object
)
13728 && (g1
->charpos
== pt_old
/* an exact match always wins */
13729 || (BUFFERP (glyph
->object
)
13730 && eabs (g1
->charpos
- pt_old
)
13731 < eabs (glyph
->charpos
- pt_old
))))
13732 /* previous candidate is a glyph from a string that has
13733 a non-nil `cursor' property */
13734 || (STRINGP (g1
->object
)
13735 && !NILP (Fget_char_property (make_number (g1
->charpos
),
13736 Qcursor
, g1
->object
)))))
13738 /* If this candidate gives an exact match, use that. */
13739 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13740 /* Otherwise, keep the candidate that comes from a row
13741 spanning less buffer positions. This may win when one or
13742 both candidate positions are on glyphs that came from
13743 display strings, for which we cannot compare buffer
13745 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13746 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13747 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13750 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13752 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13753 w
->cursor
.y
= row
->y
+ dy
;
13755 if (w
== XWINDOW (selected_window
))
13757 if (!row
->continued_p
13758 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13761 this_line_buffer
= XBUFFER (w
->buffer
);
13763 CHARPOS (this_line_start_pos
)
13764 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13765 BYTEPOS (this_line_start_pos
)
13766 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13768 CHARPOS (this_line_end_pos
)
13769 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13770 BYTEPOS (this_line_end_pos
)
13771 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13773 this_line_y
= w
->cursor
.y
;
13774 this_line_pixel_height
= row
->height
;
13775 this_line_vpos
= w
->cursor
.vpos
;
13776 this_line_start_x
= row
->x
;
13779 CHARPOS (this_line_start_pos
) = 0;
13786 /* Run window scroll functions, if any, for WINDOW with new window
13787 start STARTP. Sets the window start of WINDOW to that position.
13789 We assume that the window's buffer is really current. */
13791 static inline struct text_pos
13792 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13794 struct window
*w
= XWINDOW (window
);
13795 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13797 if (current_buffer
!= XBUFFER (w
->buffer
))
13800 if (!NILP (Vwindow_scroll_functions
))
13802 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13803 make_number (CHARPOS (startp
)));
13804 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13805 /* In case the hook functions switch buffers. */
13806 if (current_buffer
!= XBUFFER (w
->buffer
))
13807 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13814 /* Make sure the line containing the cursor is fully visible.
13815 A value of 1 means there is nothing to be done.
13816 (Either the line is fully visible, or it cannot be made so,
13817 or we cannot tell.)
13819 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13820 is higher than window.
13822 A value of 0 means the caller should do scrolling
13823 as if point had gone off the screen. */
13826 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13828 struct glyph_matrix
*matrix
;
13829 struct glyph_row
*row
;
13832 if (!make_cursor_line_fully_visible_p
)
13835 /* It's not always possible to find the cursor, e.g, when a window
13836 is full of overlay strings. Don't do anything in that case. */
13837 if (w
->cursor
.vpos
< 0)
13840 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13841 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13843 /* If the cursor row is not partially visible, there's nothing to do. */
13844 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13847 /* If the row the cursor is in is taller than the window's height,
13848 it's not clear what to do, so do nothing. */
13849 window_height
= window_box_height (w
);
13850 if (row
->height
>= window_height
)
13852 if (!force_p
|| MINI_WINDOW_P (w
)
13853 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13860 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13861 non-zero means only WINDOW is redisplayed in redisplay_internal.
13862 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13863 in redisplay_window to bring a partially visible line into view in
13864 the case that only the cursor has moved.
13866 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13867 last screen line's vertical height extends past the end of the screen.
13871 1 if scrolling succeeded
13873 0 if scrolling didn't find point.
13875 -1 if new fonts have been loaded so that we must interrupt
13876 redisplay, adjust glyph matrices, and try again. */
13882 SCROLLING_NEED_LARGER_MATRICES
13885 /* If scroll-conservatively is more than this, never recenter.
13887 If you change this, don't forget to update the doc string of
13888 `scroll-conservatively' and the Emacs manual. */
13889 #define SCROLL_LIMIT 100
13892 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13893 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13894 int temp_scroll_step
, int last_line_misfit
)
13896 struct window
*w
= XWINDOW (window
);
13897 struct frame
*f
= XFRAME (w
->frame
);
13898 struct text_pos pos
, startp
;
13900 int this_scroll_margin
, scroll_max
, rc
, height
;
13901 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13902 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13903 Lisp_Object aggressive
;
13904 /* We will never try scrolling more than this number of lines. */
13905 int scroll_limit
= SCROLL_LIMIT
;
13908 debug_method_add (w
, "try_scrolling");
13911 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13913 /* Compute scroll margin height in pixels. We scroll when point is
13914 within this distance from the top or bottom of the window. */
13915 if (scroll_margin
> 0)
13916 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13917 * FRAME_LINE_HEIGHT (f
);
13919 this_scroll_margin
= 0;
13921 /* Force arg_scroll_conservatively to have a reasonable value, to
13922 avoid scrolling too far away with slow move_it_* functions. Note
13923 that the user can supply scroll-conservatively equal to
13924 `most-positive-fixnum', which can be larger than INT_MAX. */
13925 if (arg_scroll_conservatively
> scroll_limit
)
13927 arg_scroll_conservatively
= scroll_limit
+ 1;
13928 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13930 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13931 /* Compute how much we should try to scroll maximally to bring
13932 point into view. */
13933 scroll_max
= (max (scroll_step
,
13934 max (arg_scroll_conservatively
, temp_scroll_step
))
13935 * FRAME_LINE_HEIGHT (f
));
13936 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13937 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13938 /* We're trying to scroll because of aggressive scrolling but no
13939 scroll_step is set. Choose an arbitrary one. */
13940 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13946 /* Decide whether to scroll down. */
13947 if (PT
> CHARPOS (startp
))
13949 int scroll_margin_y
;
13951 /* Compute the pixel ypos of the scroll margin, then move it to
13952 either that ypos or PT, whichever comes first. */
13953 start_display (&it
, w
, startp
);
13954 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13955 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13956 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13957 (MOVE_TO_POS
| MOVE_TO_Y
));
13959 if (PT
> CHARPOS (it
.current
.pos
))
13961 int y0
= line_bottom_y (&it
);
13962 /* Compute how many pixels below window bottom to stop searching
13963 for PT. This avoids costly search for PT that is far away if
13964 the user limited scrolling by a small number of lines, but
13965 always finds PT if scroll_conservatively is set to a large
13966 number, such as most-positive-fixnum. */
13967 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13968 int y_to_move
= it
.last_visible_y
+ slack
;
13970 /* Compute the distance from the scroll margin to PT or to
13971 the scroll limit, whichever comes first. This should
13972 include the height of the cursor line, to make that line
13974 move_it_to (&it
, PT
, -1, y_to_move
,
13975 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13976 dy
= line_bottom_y (&it
) - y0
;
13978 if (dy
> scroll_max
)
13979 return SCROLLING_FAILED
;
13987 /* Point is in or below the bottom scroll margin, so move the
13988 window start down. If scrolling conservatively, move it just
13989 enough down to make point visible. If scroll_step is set,
13990 move it down by scroll_step. */
13991 if (arg_scroll_conservatively
)
13993 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13994 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13995 else if (scroll_step
|| temp_scroll_step
)
13996 amount_to_scroll
= scroll_max
;
13999 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14000 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14001 if (NUMBERP (aggressive
))
14003 double float_amount
= XFLOATINT (aggressive
) * height
;
14004 amount_to_scroll
= float_amount
;
14005 if (amount_to_scroll
== 0 && float_amount
> 0)
14006 amount_to_scroll
= 1;
14007 /* Don't let point enter the scroll margin near top of
14009 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14010 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14014 if (amount_to_scroll
<= 0)
14015 return SCROLLING_FAILED
;
14017 start_display (&it
, w
, startp
);
14018 if (arg_scroll_conservatively
<= scroll_limit
)
14019 move_it_vertically (&it
, amount_to_scroll
);
14022 /* Extra precision for users who set scroll-conservatively
14023 to a large number: make sure the amount we scroll
14024 the window start is never less than amount_to_scroll,
14025 which was computed as distance from window bottom to
14026 point. This matters when lines at window top and lines
14027 below window bottom have different height. */
14029 void *it1data
= NULL
;
14030 /* We use a temporary it1 because line_bottom_y can modify
14031 its argument, if it moves one line down; see there. */
14034 SAVE_IT (it1
, it
, it1data
);
14035 start_y
= line_bottom_y (&it1
);
14037 RESTORE_IT (&it
, &it
, it1data
);
14038 move_it_by_lines (&it
, 1);
14039 SAVE_IT (it1
, it
, it1data
);
14040 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14043 /* If STARTP is unchanged, move it down another screen line. */
14044 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14045 move_it_by_lines (&it
, 1);
14046 startp
= it
.current
.pos
;
14050 struct text_pos scroll_margin_pos
= startp
;
14052 /* See if point is inside the scroll margin at the top of the
14054 if (this_scroll_margin
)
14056 start_display (&it
, w
, startp
);
14057 move_it_vertically (&it
, this_scroll_margin
);
14058 scroll_margin_pos
= it
.current
.pos
;
14061 if (PT
< CHARPOS (scroll_margin_pos
))
14063 /* Point is in the scroll margin at the top of the window or
14064 above what is displayed in the window. */
14067 /* Compute the vertical distance from PT to the scroll
14068 margin position. Move as far as scroll_max allows, or
14069 one screenful, or 10 screen lines, whichever is largest.
14070 Give up if distance is greater than scroll_max. */
14071 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14072 start_display (&it
, w
, pos
);
14074 y_to_move
= max (it
.last_visible_y
,
14075 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14076 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14078 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14079 dy
= it
.current_y
- y0
;
14080 if (dy
> scroll_max
)
14081 return SCROLLING_FAILED
;
14083 /* Compute new window start. */
14084 start_display (&it
, w
, startp
);
14086 if (arg_scroll_conservatively
)
14087 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14088 max (scroll_step
, temp_scroll_step
));
14089 else if (scroll_step
|| temp_scroll_step
)
14090 amount_to_scroll
= scroll_max
;
14093 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14094 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14095 if (NUMBERP (aggressive
))
14097 double float_amount
= XFLOATINT (aggressive
) * height
;
14098 amount_to_scroll
= float_amount
;
14099 if (amount_to_scroll
== 0 && float_amount
> 0)
14100 amount_to_scroll
= 1;
14101 amount_to_scroll
-=
14102 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14103 /* Don't let point enter the scroll margin near
14104 bottom of the window. */
14105 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14106 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14110 if (amount_to_scroll
<= 0)
14111 return SCROLLING_FAILED
;
14113 move_it_vertically_backward (&it
, amount_to_scroll
);
14114 startp
= it
.current
.pos
;
14118 /* Run window scroll functions. */
14119 startp
= run_window_scroll_functions (window
, startp
);
14121 /* Display the window. Give up if new fonts are loaded, or if point
14123 if (!try_window (window
, startp
, 0))
14124 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14125 else if (w
->cursor
.vpos
< 0)
14127 clear_glyph_matrix (w
->desired_matrix
);
14128 rc
= SCROLLING_FAILED
;
14132 /* Maybe forget recorded base line for line number display. */
14133 if (!just_this_one_p
14134 || current_buffer
->clip_changed
14135 || BEG_UNCHANGED
< CHARPOS (startp
))
14136 w
->base_line_number
= Qnil
;
14138 /* If cursor ends up on a partially visible line,
14139 treat that as being off the bottom of the screen. */
14140 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14141 /* It's possible that the cursor is on the first line of the
14142 buffer, which is partially obscured due to a vscroll
14143 (Bug#7537). In that case, avoid looping forever . */
14144 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14146 clear_glyph_matrix (w
->desired_matrix
);
14147 ++extra_scroll_margin_lines
;
14150 rc
= SCROLLING_SUCCESS
;
14157 /* Compute a suitable window start for window W if display of W starts
14158 on a continuation line. Value is non-zero if a new window start
14161 The new window start will be computed, based on W's width, starting
14162 from the start of the continued line. It is the start of the
14163 screen line with the minimum distance from the old start W->start. */
14166 compute_window_start_on_continuation_line (struct window
*w
)
14168 struct text_pos pos
, start_pos
;
14169 int window_start_changed_p
= 0;
14171 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14173 /* If window start is on a continuation line... Window start may be
14174 < BEGV in case there's invisible text at the start of the
14175 buffer (M-x rmail, for example). */
14176 if (CHARPOS (start_pos
) > BEGV
14177 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14180 struct glyph_row
*row
;
14182 /* Handle the case that the window start is out of range. */
14183 if (CHARPOS (start_pos
) < BEGV
)
14184 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14185 else if (CHARPOS (start_pos
) > ZV
)
14186 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14188 /* Find the start of the continued line. This should be fast
14189 because scan_buffer is fast (newline cache). */
14190 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14191 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14192 row
, DEFAULT_FACE_ID
);
14193 reseat_at_previous_visible_line_start (&it
);
14195 /* If the line start is "too far" away from the window start,
14196 say it takes too much time to compute a new window start. */
14197 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14198 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14200 int min_distance
, distance
;
14202 /* Move forward by display lines to find the new window
14203 start. If window width was enlarged, the new start can
14204 be expected to be > the old start. If window width was
14205 decreased, the new window start will be < the old start.
14206 So, we're looking for the display line start with the
14207 minimum distance from the old window start. */
14208 pos
= it
.current
.pos
;
14209 min_distance
= INFINITY
;
14210 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14211 distance
< min_distance
)
14213 min_distance
= distance
;
14214 pos
= it
.current
.pos
;
14215 move_it_by_lines (&it
, 1);
14218 /* Set the window start there. */
14219 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14220 window_start_changed_p
= 1;
14224 return window_start_changed_p
;
14228 /* Try cursor movement in case text has not changed in window WINDOW,
14229 with window start STARTP. Value is
14231 CURSOR_MOVEMENT_SUCCESS if successful
14233 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14235 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14236 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14237 we want to scroll as if scroll-step were set to 1. See the code.
14239 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14240 which case we have to abort this redisplay, and adjust matrices
14245 CURSOR_MOVEMENT_SUCCESS
,
14246 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14247 CURSOR_MOVEMENT_MUST_SCROLL
,
14248 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14252 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14254 struct window
*w
= XWINDOW (window
);
14255 struct frame
*f
= XFRAME (w
->frame
);
14256 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14259 if (inhibit_try_cursor_movement
)
14263 /* Handle case where text has not changed, only point, and it has
14264 not moved off the frame. */
14265 if (/* Point may be in this window. */
14266 PT
>= CHARPOS (startp
)
14267 /* Selective display hasn't changed. */
14268 && !current_buffer
->clip_changed
14269 /* Function force-mode-line-update is used to force a thorough
14270 redisplay. It sets either windows_or_buffers_changed or
14271 update_mode_lines. So don't take a shortcut here for these
14273 && !update_mode_lines
14274 && !windows_or_buffers_changed
14275 && !cursor_type_changed
14276 /* Can't use this case if highlighting a region. When a
14277 region exists, cursor movement has to do more than just
14279 && !(!NILP (Vtransient_mark_mode
)
14280 && !NILP (BVAR (current_buffer
, mark_active
)))
14281 && NILP (w
->region_showing
)
14282 && NILP (Vshow_trailing_whitespace
)
14283 /* Right after splitting windows, last_point may be nil. */
14284 && INTEGERP (w
->last_point
)
14285 /* This code is not used for mini-buffer for the sake of the case
14286 of redisplaying to replace an echo area message; since in
14287 that case the mini-buffer contents per se are usually
14288 unchanged. This code is of no real use in the mini-buffer
14289 since the handling of this_line_start_pos, etc., in redisplay
14290 handles the same cases. */
14291 && !EQ (window
, minibuf_window
)
14292 /* When splitting windows or for new windows, it happens that
14293 redisplay is called with a nil window_end_vpos or one being
14294 larger than the window. This should really be fixed in
14295 window.c. I don't have this on my list, now, so we do
14296 approximately the same as the old redisplay code. --gerd. */
14297 && INTEGERP (w
->window_end_vpos
)
14298 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14299 && (FRAME_WINDOW_P (f
)
14300 || !overlay_arrow_in_current_buffer_p ()))
14302 int this_scroll_margin
, top_scroll_margin
;
14303 struct glyph_row
*row
= NULL
;
14306 debug_method_add (w
, "cursor movement");
14309 /* Scroll if point within this distance from the top or bottom
14310 of the window. This is a pixel value. */
14311 if (scroll_margin
> 0)
14313 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14314 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14317 this_scroll_margin
= 0;
14319 top_scroll_margin
= this_scroll_margin
;
14320 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14321 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14323 /* Start with the row the cursor was displayed during the last
14324 not paused redisplay. Give up if that row is not valid. */
14325 if (w
->last_cursor
.vpos
< 0
14326 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14327 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14330 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14331 if (row
->mode_line_p
)
14333 if (!row
->enabled_p
)
14334 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14337 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14339 int scroll_p
= 0, must_scroll
= 0;
14340 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14342 if (PT
> XFASTINT (w
->last_point
))
14344 /* Point has moved forward. */
14345 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14346 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14348 xassert (row
->enabled_p
);
14352 /* If the end position of a row equals the start
14353 position of the next row, and PT is at that position,
14354 we would rather display cursor in the next line. */
14355 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14356 && MATRIX_ROW_END_CHARPOS (row
) == PT
14357 && row
< w
->current_matrix
->rows
14358 + w
->current_matrix
->nrows
- 1
14359 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14360 && !cursor_row_p (row
))
14363 /* If within the scroll margin, scroll. Note that
14364 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14365 the next line would be drawn, and that
14366 this_scroll_margin can be zero. */
14367 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14368 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14369 /* Line is completely visible last line in window
14370 and PT is to be set in the next line. */
14371 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14372 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14373 && !row
->ends_at_zv_p
14374 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14377 else if (PT
< XFASTINT (w
->last_point
))
14379 /* Cursor has to be moved backward. Note that PT >=
14380 CHARPOS (startp) because of the outer if-statement. */
14381 while (!row
->mode_line_p
14382 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14383 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14384 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14385 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14386 row
> w
->current_matrix
->rows
14387 && (row
-1)->ends_in_newline_from_string_p
))))
14388 && (row
->y
> top_scroll_margin
14389 || CHARPOS (startp
) == BEGV
))
14391 xassert (row
->enabled_p
);
14395 /* Consider the following case: Window starts at BEGV,
14396 there is invisible, intangible text at BEGV, so that
14397 display starts at some point START > BEGV. It can
14398 happen that we are called with PT somewhere between
14399 BEGV and START. Try to handle that case. */
14400 if (row
< w
->current_matrix
->rows
14401 || row
->mode_line_p
)
14403 row
= w
->current_matrix
->rows
;
14404 if (row
->mode_line_p
)
14408 /* Due to newlines in overlay strings, we may have to
14409 skip forward over overlay strings. */
14410 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14411 && MATRIX_ROW_END_CHARPOS (row
) == PT
14412 && !cursor_row_p (row
))
14415 /* If within the scroll margin, scroll. */
14416 if (row
->y
< top_scroll_margin
14417 && CHARPOS (startp
) != BEGV
)
14422 /* Cursor did not move. So don't scroll even if cursor line
14423 is partially visible, as it was so before. */
14424 rc
= CURSOR_MOVEMENT_SUCCESS
;
14427 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14428 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14430 /* if PT is not in the glyph row, give up. */
14431 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14434 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14435 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14437 /* If rows are bidi-reordered and point moved, back up
14438 until we find a row that does not belong to a
14439 continuation line. This is because we must consider
14440 all rows of a continued line as candidates for the
14441 new cursor positioning, since row start and end
14442 positions change non-linearly with vertical position
14444 /* FIXME: Revisit this when glyph ``spilling'' in
14445 continuation lines' rows is implemented for
14446 bidi-reordered rows. */
14447 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14449 xassert (row
->enabled_p
);
14451 /* If we hit the beginning of the displayed portion
14452 without finding the first row of a continued
14454 if (row
<= w
->current_matrix
->rows
)
14456 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14464 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14465 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14466 && make_cursor_line_fully_visible_p
)
14468 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14469 && !row
->ends_at_zv_p
14470 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14471 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14472 else if (row
->height
> window_box_height (w
))
14474 /* If we end up in a partially visible line, let's
14475 make it fully visible, except when it's taller
14476 than the window, in which case we can't do much
14479 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14483 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14484 if (!cursor_row_fully_visible_p (w
, 0, 1))
14485 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14487 rc
= CURSOR_MOVEMENT_SUCCESS
;
14491 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14492 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14493 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14495 /* With bidi-reordered rows, there could be more than
14496 one candidate row whose start and end positions
14497 occlude point. We need to let set_cursor_from_row
14498 find the best candidate. */
14499 /* FIXME: Revisit this when glyph ``spilling'' in
14500 continuation lines' rows is implemented for
14501 bidi-reordered rows. */
14506 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14507 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14508 && cursor_row_p (row
))
14509 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14511 /* As soon as we've found the first suitable row
14512 whose ends_at_zv_p flag is set, we are done. */
14514 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14516 rc
= CURSOR_MOVEMENT_SUCCESS
;
14521 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14522 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14523 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14524 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14525 /* If we didn't find any candidate rows, or exited the
14526 loop before all the candidates were examined, signal
14527 to the caller that this method failed. */
14528 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14529 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14530 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14532 rc
= CURSOR_MOVEMENT_SUCCESS
;
14538 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14540 rc
= CURSOR_MOVEMENT_SUCCESS
;
14545 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14546 && MATRIX_ROW_START_CHARPOS (row
) == PT
14547 && cursor_row_p (row
));
14555 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14559 set_vertical_scroll_bar (struct window
*w
)
14561 EMACS_INT start
, end
, whole
;
14563 /* Calculate the start and end positions for the current window.
14564 At some point, it would be nice to choose between scrollbars
14565 which reflect the whole buffer size, with special markers
14566 indicating narrowing, and scrollbars which reflect only the
14569 Note that mini-buffers sometimes aren't displaying any text. */
14570 if (!MINI_WINDOW_P (w
)
14571 || (w
== XWINDOW (minibuf_window
)
14572 && NILP (echo_area_buffer
[0])))
14574 struct buffer
*buf
= XBUFFER (w
->buffer
);
14575 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14576 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14577 /* I don't think this is guaranteed to be right. For the
14578 moment, we'll pretend it is. */
14579 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14583 if (whole
< (end
- start
))
14584 whole
= end
- start
;
14587 start
= end
= whole
= 0;
14589 /* Indicate what this scroll bar ought to be displaying now. */
14590 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14591 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14592 (w
, end
- start
, whole
, start
);
14596 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14597 selected_window is redisplayed.
14599 We can return without actually redisplaying the window if
14600 fonts_changed_p is nonzero. In that case, redisplay_internal will
14604 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14606 struct window
*w
= XWINDOW (window
);
14607 struct frame
*f
= XFRAME (w
->frame
);
14608 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14609 struct buffer
*old
= current_buffer
;
14610 struct text_pos lpoint
, opoint
, startp
;
14611 int update_mode_line
;
14614 /* Record it now because it's overwritten. */
14615 int current_matrix_up_to_date_p
= 0;
14616 int used_current_matrix_p
= 0;
14617 /* This is less strict than current_matrix_up_to_date_p.
14618 It indictes that the buffer contents and narrowing are unchanged. */
14619 int buffer_unchanged_p
= 0;
14620 int temp_scroll_step
= 0;
14621 int count
= SPECPDL_INDEX ();
14623 int centering_position
= -1;
14624 int last_line_misfit
= 0;
14625 EMACS_INT beg_unchanged
, end_unchanged
;
14627 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14630 /* W must be a leaf window here. */
14631 xassert (!NILP (w
->buffer
));
14633 *w
->desired_matrix
->method
= 0;
14637 reconsider_clip_changes (w
, buffer
);
14639 /* Has the mode line to be updated? */
14640 update_mode_line
= (!NILP (w
->update_mode_line
)
14641 || update_mode_lines
14642 || buffer
->clip_changed
14643 || buffer
->prevent_redisplay_optimizations_p
);
14645 if (MINI_WINDOW_P (w
))
14647 if (w
== XWINDOW (echo_area_window
)
14648 && !NILP (echo_area_buffer
[0]))
14650 if (update_mode_line
)
14651 /* We may have to update a tty frame's menu bar or a
14652 tool-bar. Example `M-x C-h C-h C-g'. */
14653 goto finish_menu_bars
;
14655 /* We've already displayed the echo area glyphs in this window. */
14656 goto finish_scroll_bars
;
14658 else if ((w
!= XWINDOW (minibuf_window
)
14659 || minibuf_level
== 0)
14660 /* When buffer is nonempty, redisplay window normally. */
14661 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14662 /* Quail displays non-mini buffers in minibuffer window.
14663 In that case, redisplay the window normally. */
14664 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14666 /* W is a mini-buffer window, but it's not active, so clear
14668 int yb
= window_text_bottom_y (w
);
14669 struct glyph_row
*row
;
14672 for (y
= 0, row
= w
->desired_matrix
->rows
;
14674 y
+= row
->height
, ++row
)
14675 blank_row (w
, row
, y
);
14676 goto finish_scroll_bars
;
14679 clear_glyph_matrix (w
->desired_matrix
);
14682 /* Otherwise set up data on this window; select its buffer and point
14684 /* Really select the buffer, for the sake of buffer-local
14686 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14688 current_matrix_up_to_date_p
14689 = (!NILP (w
->window_end_valid
)
14690 && !current_buffer
->clip_changed
14691 && !current_buffer
->prevent_redisplay_optimizations_p
14692 && XFASTINT (w
->last_modified
) >= MODIFF
14693 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14695 /* Run the window-bottom-change-functions
14696 if it is possible that the text on the screen has changed
14697 (either due to modification of the text, or any other reason). */
14698 if (!current_matrix_up_to_date_p
14699 && !NILP (Vwindow_text_change_functions
))
14701 safe_run_hooks (Qwindow_text_change_functions
);
14705 beg_unchanged
= BEG_UNCHANGED
;
14706 end_unchanged
= END_UNCHANGED
;
14708 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14710 specbind (Qinhibit_point_motion_hooks
, Qt
);
14713 = (!NILP (w
->window_end_valid
)
14714 && !current_buffer
->clip_changed
14715 && XFASTINT (w
->last_modified
) >= MODIFF
14716 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14718 /* When windows_or_buffers_changed is non-zero, we can't rely on
14719 the window end being valid, so set it to nil there. */
14720 if (windows_or_buffers_changed
)
14722 /* If window starts on a continuation line, maybe adjust the
14723 window start in case the window's width changed. */
14724 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14725 compute_window_start_on_continuation_line (w
);
14727 w
->window_end_valid
= Qnil
;
14730 /* Some sanity checks. */
14731 CHECK_WINDOW_END (w
);
14732 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14734 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14737 /* If %c is in mode line, update it if needed. */
14738 if (!NILP (w
->column_number_displayed
)
14739 /* This alternative quickly identifies a common case
14740 where no change is needed. */
14741 && !(PT
== XFASTINT (w
->last_point
)
14742 && XFASTINT (w
->last_modified
) >= MODIFF
14743 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14744 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14745 update_mode_line
= 1;
14747 /* Count number of windows showing the selected buffer. An indirect
14748 buffer counts as its base buffer. */
14749 if (!just_this_one_p
)
14751 struct buffer
*current_base
, *window_base
;
14752 current_base
= current_buffer
;
14753 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14754 if (current_base
->base_buffer
)
14755 current_base
= current_base
->base_buffer
;
14756 if (window_base
->base_buffer
)
14757 window_base
= window_base
->base_buffer
;
14758 if (current_base
== window_base
)
14762 /* Point refers normally to the selected window. For any other
14763 window, set up appropriate value. */
14764 if (!EQ (window
, selected_window
))
14766 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14767 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14771 new_pt_byte
= BEGV_BYTE
;
14772 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14774 else if (new_pt
> (ZV
- 1))
14777 new_pt_byte
= ZV_BYTE
;
14778 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14781 /* We don't use SET_PT so that the point-motion hooks don't run. */
14782 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14785 /* If any of the character widths specified in the display table
14786 have changed, invalidate the width run cache. It's true that
14787 this may be a bit late to catch such changes, but the rest of
14788 redisplay goes (non-fatally) haywire when the display table is
14789 changed, so why should we worry about doing any better? */
14790 if (current_buffer
->width_run_cache
)
14792 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14794 if (! disptab_matches_widthtab (disptab
,
14795 XVECTOR (BVAR (current_buffer
, width_table
))))
14797 invalidate_region_cache (current_buffer
,
14798 current_buffer
->width_run_cache
,
14800 recompute_width_table (current_buffer
, disptab
);
14804 /* If window-start is screwed up, choose a new one. */
14805 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14808 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14810 /* If someone specified a new starting point but did not insist,
14811 check whether it can be used. */
14812 if (!NILP (w
->optional_new_start
)
14813 && CHARPOS (startp
) >= BEGV
14814 && CHARPOS (startp
) <= ZV
)
14816 w
->optional_new_start
= Qnil
;
14817 start_display (&it
, w
, startp
);
14818 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14819 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14820 if (IT_CHARPOS (it
) == PT
)
14821 w
->force_start
= Qt
;
14822 /* IT may overshoot PT if text at PT is invisible. */
14823 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14824 w
->force_start
= Qt
;
14829 /* Handle case where place to start displaying has been specified,
14830 unless the specified location is outside the accessible range. */
14831 if (!NILP (w
->force_start
)
14832 || w
->frozen_window_start_p
)
14834 /* We set this later on if we have to adjust point. */
14837 w
->force_start
= Qnil
;
14839 w
->window_end_valid
= Qnil
;
14841 /* Forget any recorded base line for line number display. */
14842 if (!buffer_unchanged_p
)
14843 w
->base_line_number
= Qnil
;
14845 /* Redisplay the mode line. Select the buffer properly for that.
14846 Also, run the hook window-scroll-functions
14847 because we have scrolled. */
14848 /* Note, we do this after clearing force_start because
14849 if there's an error, it is better to forget about force_start
14850 than to get into an infinite loop calling the hook functions
14851 and having them get more errors. */
14852 if (!update_mode_line
14853 || ! NILP (Vwindow_scroll_functions
))
14855 update_mode_line
= 1;
14856 w
->update_mode_line
= Qt
;
14857 startp
= run_window_scroll_functions (window
, startp
);
14860 w
->last_modified
= make_number (0);
14861 w
->last_overlay_modified
= make_number (0);
14862 if (CHARPOS (startp
) < BEGV
)
14863 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14864 else if (CHARPOS (startp
) > ZV
)
14865 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14867 /* Redisplay, then check if cursor has been set during the
14868 redisplay. Give up if new fonts were loaded. */
14869 /* We used to issue a CHECK_MARGINS argument to try_window here,
14870 but this causes scrolling to fail when point begins inside
14871 the scroll margin (bug#148) -- cyd */
14872 if (!try_window (window
, startp
, 0))
14874 w
->force_start
= Qt
;
14875 clear_glyph_matrix (w
->desired_matrix
);
14876 goto need_larger_matrices
;
14879 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14881 /* If point does not appear, try to move point so it does
14882 appear. The desired matrix has been built above, so we
14883 can use it here. */
14884 new_vpos
= window_box_height (w
) / 2;
14887 if (!cursor_row_fully_visible_p (w
, 0, 0))
14889 /* Point does appear, but on a line partly visible at end of window.
14890 Move it back to a fully-visible line. */
14891 new_vpos
= window_box_height (w
);
14894 /* If we need to move point for either of the above reasons,
14895 now actually do it. */
14898 struct glyph_row
*row
;
14900 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14901 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14904 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14905 MATRIX_ROW_START_BYTEPOS (row
));
14907 if (w
!= XWINDOW (selected_window
))
14908 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14909 else if (current_buffer
== old
)
14910 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14912 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14914 /* If we are highlighting the region, then we just changed
14915 the region, so redisplay to show it. */
14916 if (!NILP (Vtransient_mark_mode
)
14917 && !NILP (BVAR (current_buffer
, mark_active
)))
14919 clear_glyph_matrix (w
->desired_matrix
);
14920 if (!try_window (window
, startp
, 0))
14921 goto need_larger_matrices
;
14926 debug_method_add (w
, "forced window start");
14931 /* Handle case where text has not changed, only point, and it has
14932 not moved off the frame, and we are not retrying after hscroll.
14933 (current_matrix_up_to_date_p is nonzero when retrying.) */
14934 if (current_matrix_up_to_date_p
14935 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14936 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14940 case CURSOR_MOVEMENT_SUCCESS
:
14941 used_current_matrix_p
= 1;
14944 case CURSOR_MOVEMENT_MUST_SCROLL
:
14945 goto try_to_scroll
;
14951 /* If current starting point was originally the beginning of a line
14952 but no longer is, find a new starting point. */
14953 else if (!NILP (w
->start_at_line_beg
)
14954 && !(CHARPOS (startp
) <= BEGV
14955 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14958 debug_method_add (w
, "recenter 1");
14963 /* Try scrolling with try_window_id. Value is > 0 if update has
14964 been done, it is -1 if we know that the same window start will
14965 not work. It is 0 if unsuccessful for some other reason. */
14966 else if ((tem
= try_window_id (w
)) != 0)
14969 debug_method_add (w
, "try_window_id %d", tem
);
14972 if (fonts_changed_p
)
14973 goto need_larger_matrices
;
14977 /* Otherwise try_window_id has returned -1 which means that we
14978 don't want the alternative below this comment to execute. */
14980 else if (CHARPOS (startp
) >= BEGV
14981 && CHARPOS (startp
) <= ZV
14982 && PT
>= CHARPOS (startp
)
14983 && (CHARPOS (startp
) < ZV
14984 /* Avoid starting at end of buffer. */
14985 || CHARPOS (startp
) == BEGV
14986 || (XFASTINT (w
->last_modified
) >= MODIFF
14987 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14990 /* If first window line is a continuation line, and window start
14991 is inside the modified region, but the first change is before
14992 current window start, we must select a new window start.
14994 However, if this is the result of a down-mouse event (e.g. by
14995 extending the mouse-drag-overlay), we don't want to select a
14996 new window start, since that would change the position under
14997 the mouse, resulting in an unwanted mouse-movement rather
14998 than a simple mouse-click. */
14999 if (NILP (w
->start_at_line_beg
)
15000 && NILP (do_mouse_tracking
)
15001 && CHARPOS (startp
) > BEGV
15002 && CHARPOS (startp
) > BEG
+ beg_unchanged
15003 && CHARPOS (startp
) <= Z
- end_unchanged
15004 /* Even if w->start_at_line_beg is nil, a new window may
15005 start at a line_beg, since that's how set_buffer_window
15006 sets it. So, we need to check the return value of
15007 compute_window_start_on_continuation_line. (See also
15009 && XMARKER (w
->start
)->buffer
== current_buffer
15010 && compute_window_start_on_continuation_line (w
))
15012 w
->force_start
= Qt
;
15013 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15018 debug_method_add (w
, "same window start");
15021 /* Try to redisplay starting at same place as before.
15022 If point has not moved off frame, accept the results. */
15023 if (!current_matrix_up_to_date_p
15024 /* Don't use try_window_reusing_current_matrix in this case
15025 because a window scroll function can have changed the
15027 || !NILP (Vwindow_scroll_functions
)
15028 || MINI_WINDOW_P (w
)
15029 || !(used_current_matrix_p
15030 = try_window_reusing_current_matrix (w
)))
15032 IF_DEBUG (debug_method_add (w
, "1"));
15033 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15034 /* -1 means we need to scroll.
15035 0 means we need new matrices, but fonts_changed_p
15036 is set in that case, so we will detect it below. */
15037 goto try_to_scroll
;
15040 if (fonts_changed_p
)
15041 goto need_larger_matrices
;
15043 if (w
->cursor
.vpos
>= 0)
15045 if (!just_this_one_p
15046 || current_buffer
->clip_changed
15047 || BEG_UNCHANGED
< CHARPOS (startp
))
15048 /* Forget any recorded base line for line number display. */
15049 w
->base_line_number
= Qnil
;
15051 if (!cursor_row_fully_visible_p (w
, 1, 0))
15053 clear_glyph_matrix (w
->desired_matrix
);
15054 last_line_misfit
= 1;
15056 /* Drop through and scroll. */
15061 clear_glyph_matrix (w
->desired_matrix
);
15066 w
->last_modified
= make_number (0);
15067 w
->last_overlay_modified
= make_number (0);
15069 /* Redisplay the mode line. Select the buffer properly for that. */
15070 if (!update_mode_line
)
15072 update_mode_line
= 1;
15073 w
->update_mode_line
= Qt
;
15076 /* Try to scroll by specified few lines. */
15077 if ((scroll_conservatively
15078 || emacs_scroll_step
15079 || temp_scroll_step
15080 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15081 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15082 && CHARPOS (startp
) >= BEGV
15083 && CHARPOS (startp
) <= ZV
)
15085 /* The function returns -1 if new fonts were loaded, 1 if
15086 successful, 0 if not successful. */
15087 int ss
= try_scrolling (window
, just_this_one_p
,
15088 scroll_conservatively
,
15090 temp_scroll_step
, last_line_misfit
);
15093 case SCROLLING_SUCCESS
:
15096 case SCROLLING_NEED_LARGER_MATRICES
:
15097 goto need_larger_matrices
;
15099 case SCROLLING_FAILED
:
15107 /* Finally, just choose a place to start which positions point
15108 according to user preferences. */
15113 debug_method_add (w
, "recenter");
15116 /* w->vscroll = 0; */
15118 /* Forget any previously recorded base line for line number display. */
15119 if (!buffer_unchanged_p
)
15120 w
->base_line_number
= Qnil
;
15122 /* Determine the window start relative to point. */
15123 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15124 it
.current_y
= it
.last_visible_y
;
15125 if (centering_position
< 0)
15129 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15131 EMACS_INT margin_pos
= CHARPOS (startp
);
15133 Lisp_Object aggressive
;
15135 /* If there is a scroll margin at the top of the window, find
15136 its character position. */
15138 /* Cannot call start_display if startp is not in the
15139 accessible region of the buffer. This can happen when we
15140 have just switched to a different buffer and/or changed
15141 its restriction. In that case, startp is initialized to
15142 the character position 1 (BEG) because we did not yet
15143 have chance to display the buffer even once. */
15144 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15147 void *it1data
= NULL
;
15149 SAVE_IT (it1
, it
, it1data
);
15150 start_display (&it1
, w
, startp
);
15151 move_it_vertically (&it1
, margin
);
15152 margin_pos
= IT_CHARPOS (it1
);
15153 RESTORE_IT (&it
, &it
, it1data
);
15155 scrolling_up
= PT
> margin_pos
;
15158 ? BVAR (current_buffer
, scroll_up_aggressively
)
15159 : BVAR (current_buffer
, scroll_down_aggressively
);
15161 if (!MINI_WINDOW_P (w
)
15162 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15166 /* Setting scroll-conservatively overrides
15167 scroll-*-aggressively. */
15168 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15170 double float_amount
= XFLOATINT (aggressive
);
15172 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15173 if (pt_offset
== 0 && float_amount
> 0)
15178 /* Compute how much to move the window start backward from
15179 point so that point will be displayed where the user
15183 centering_position
= it
.last_visible_y
;
15185 centering_position
-= pt_offset
;
15186 centering_position
-=
15187 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
15188 /* Don't let point enter the scroll margin near top of
15190 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15191 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15194 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15197 /* Set the window start half the height of the window backward
15199 centering_position
= window_box_height (w
) / 2;
15201 move_it_vertically_backward (&it
, centering_position
);
15203 xassert (IT_CHARPOS (it
) >= BEGV
);
15205 /* The function move_it_vertically_backward may move over more
15206 than the specified y-distance. If it->w is small, e.g. a
15207 mini-buffer window, we may end up in front of the window's
15208 display area. Start displaying at the start of the line
15209 containing PT in this case. */
15210 if (it
.current_y
<= 0)
15212 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15213 move_it_vertically_backward (&it
, 0);
15217 it
.current_x
= it
.hpos
= 0;
15219 /* Set the window start position here explicitly, to avoid an
15220 infinite loop in case the functions in window-scroll-functions
15222 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15224 /* Run scroll hooks. */
15225 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15227 /* Redisplay the window. */
15228 if (!current_matrix_up_to_date_p
15229 || windows_or_buffers_changed
15230 || cursor_type_changed
15231 /* Don't use try_window_reusing_current_matrix in this case
15232 because it can have changed the buffer. */
15233 || !NILP (Vwindow_scroll_functions
)
15234 || !just_this_one_p
15235 || MINI_WINDOW_P (w
)
15236 || !(used_current_matrix_p
15237 = try_window_reusing_current_matrix (w
)))
15238 try_window (window
, startp
, 0);
15240 /* If new fonts have been loaded (due to fontsets), give up. We
15241 have to start a new redisplay since we need to re-adjust glyph
15243 if (fonts_changed_p
)
15244 goto need_larger_matrices
;
15246 /* If cursor did not appear assume that the middle of the window is
15247 in the first line of the window. Do it again with the next line.
15248 (Imagine a window of height 100, displaying two lines of height
15249 60. Moving back 50 from it->last_visible_y will end in the first
15251 if (w
->cursor
.vpos
< 0)
15253 if (!NILP (w
->window_end_valid
)
15254 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15256 clear_glyph_matrix (w
->desired_matrix
);
15257 move_it_by_lines (&it
, 1);
15258 try_window (window
, it
.current
.pos
, 0);
15260 else if (PT
< IT_CHARPOS (it
))
15262 clear_glyph_matrix (w
->desired_matrix
);
15263 move_it_by_lines (&it
, -1);
15264 try_window (window
, it
.current
.pos
, 0);
15268 /* Not much we can do about it. */
15272 /* Consider the following case: Window starts at BEGV, there is
15273 invisible, intangible text at BEGV, so that display starts at
15274 some point START > BEGV. It can happen that we are called with
15275 PT somewhere between BEGV and START. Try to handle that case. */
15276 if (w
->cursor
.vpos
< 0)
15278 struct glyph_row
*row
= w
->current_matrix
->rows
;
15279 if (row
->mode_line_p
)
15281 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15284 if (!cursor_row_fully_visible_p (w
, 0, 0))
15286 /* If vscroll is enabled, disable it and try again. */
15290 clear_glyph_matrix (w
->desired_matrix
);
15294 /* If centering point failed to make the whole line visible,
15295 put point at the top instead. That has to make the whole line
15296 visible, if it can be done. */
15297 if (centering_position
== 0)
15300 clear_glyph_matrix (w
->desired_matrix
);
15301 centering_position
= 0;
15307 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15308 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15309 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15312 /* Display the mode line, if we must. */
15313 if ((update_mode_line
15314 /* If window not full width, must redo its mode line
15315 if (a) the window to its side is being redone and
15316 (b) we do a frame-based redisplay. This is a consequence
15317 of how inverted lines are drawn in frame-based redisplay. */
15318 || (!just_this_one_p
15319 && !FRAME_WINDOW_P (f
)
15320 && !WINDOW_FULL_WIDTH_P (w
))
15321 /* Line number to display. */
15322 || INTEGERP (w
->base_line_pos
)
15323 /* Column number is displayed and different from the one displayed. */
15324 || (!NILP (w
->column_number_displayed
)
15325 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15326 /* This means that the window has a mode line. */
15327 && (WINDOW_WANTS_MODELINE_P (w
)
15328 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15330 display_mode_lines (w
);
15332 /* If mode line height has changed, arrange for a thorough
15333 immediate redisplay using the correct mode line height. */
15334 if (WINDOW_WANTS_MODELINE_P (w
)
15335 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15337 fonts_changed_p
= 1;
15338 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15339 = DESIRED_MODE_LINE_HEIGHT (w
);
15342 /* If header line height has changed, arrange for a thorough
15343 immediate redisplay using the correct header line height. */
15344 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15345 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15347 fonts_changed_p
= 1;
15348 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15349 = DESIRED_HEADER_LINE_HEIGHT (w
);
15352 if (fonts_changed_p
)
15353 goto need_larger_matrices
;
15356 if (!line_number_displayed
15357 && !BUFFERP (w
->base_line_pos
))
15359 w
->base_line_pos
= Qnil
;
15360 w
->base_line_number
= Qnil
;
15365 /* When we reach a frame's selected window, redo the frame's menu bar. */
15366 if (update_mode_line
15367 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15369 int redisplay_menu_p
= 0;
15371 if (FRAME_WINDOW_P (f
))
15373 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15374 || defined (HAVE_NS) || defined (USE_GTK)
15375 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15377 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15381 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15383 if (redisplay_menu_p
)
15384 display_menu_bar (w
);
15386 #ifdef HAVE_WINDOW_SYSTEM
15387 if (FRAME_WINDOW_P (f
))
15389 #if defined (USE_GTK) || defined (HAVE_NS)
15390 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15391 redisplay_tool_bar (f
);
15393 if (WINDOWP (f
->tool_bar_window
)
15394 && (FRAME_TOOL_BAR_LINES (f
) > 0
15395 || !NILP (Vauto_resize_tool_bars
))
15396 && redisplay_tool_bar (f
))
15397 ignore_mouse_drag_p
= 1;
15403 #ifdef HAVE_WINDOW_SYSTEM
15404 if (FRAME_WINDOW_P (f
)
15405 && update_window_fringes (w
, (just_this_one_p
15406 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15407 || w
->pseudo_window_p
)))
15411 if (draw_window_fringes (w
, 1))
15412 x_draw_vertical_border (w
);
15416 #endif /* HAVE_WINDOW_SYSTEM */
15418 /* We go to this label, with fonts_changed_p nonzero,
15419 if it is necessary to try again using larger glyph matrices.
15420 We have to redeem the scroll bar even in this case,
15421 because the loop in redisplay_internal expects that. */
15422 need_larger_matrices
:
15424 finish_scroll_bars
:
15426 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15428 /* Set the thumb's position and size. */
15429 set_vertical_scroll_bar (w
);
15431 /* Note that we actually used the scroll bar attached to this
15432 window, so it shouldn't be deleted at the end of redisplay. */
15433 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15434 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15437 /* Restore current_buffer and value of point in it. The window
15438 update may have changed the buffer, so first make sure `opoint'
15439 is still valid (Bug#6177). */
15440 if (CHARPOS (opoint
) < BEGV
)
15441 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15442 else if (CHARPOS (opoint
) > ZV
)
15443 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15445 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15447 set_buffer_internal_1 (old
);
15448 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15449 shorter. This can be caused by log truncation in *Messages*. */
15450 if (CHARPOS (lpoint
) <= ZV
)
15451 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15453 unbind_to (count
, Qnil
);
15457 /* Build the complete desired matrix of WINDOW with a window start
15458 buffer position POS.
15460 Value is 1 if successful. It is zero if fonts were loaded during
15461 redisplay which makes re-adjusting glyph matrices necessary, and -1
15462 if point would appear in the scroll margins.
15463 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15464 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15468 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15470 struct window
*w
= XWINDOW (window
);
15472 struct glyph_row
*last_text_row
= NULL
;
15473 struct frame
*f
= XFRAME (w
->frame
);
15475 /* Make POS the new window start. */
15476 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15478 /* Mark cursor position as unknown. No overlay arrow seen. */
15479 w
->cursor
.vpos
= -1;
15480 overlay_arrow_seen
= 0;
15482 /* Initialize iterator and info to start at POS. */
15483 start_display (&it
, w
, pos
);
15485 /* Display all lines of W. */
15486 while (it
.current_y
< it
.last_visible_y
)
15488 if (display_line (&it
))
15489 last_text_row
= it
.glyph_row
- 1;
15490 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15494 /* Don't let the cursor end in the scroll margins. */
15495 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15496 && !MINI_WINDOW_P (w
))
15498 int this_scroll_margin
;
15500 if (scroll_margin
> 0)
15502 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15503 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15506 this_scroll_margin
= 0;
15508 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15509 && w
->cursor
.y
< this_scroll_margin
15510 && CHARPOS (pos
) > BEGV
15511 && IT_CHARPOS (it
) < ZV
)
15512 /* rms: considering make_cursor_line_fully_visible_p here
15513 seems to give wrong results. We don't want to recenter
15514 when the last line is partly visible, we want to allow
15515 that case to be handled in the usual way. */
15516 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15518 w
->cursor
.vpos
= -1;
15519 clear_glyph_matrix (w
->desired_matrix
);
15524 /* If bottom moved off end of frame, change mode line percentage. */
15525 if (XFASTINT (w
->window_end_pos
) <= 0
15526 && Z
!= IT_CHARPOS (it
))
15527 w
->update_mode_line
= Qt
;
15529 /* Set window_end_pos to the offset of the last character displayed
15530 on the window from the end of current_buffer. Set
15531 window_end_vpos to its row number. */
15534 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15535 w
->window_end_bytepos
15536 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15538 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15540 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15541 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15542 ->displays_text_p
);
15546 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15547 w
->window_end_pos
= make_number (Z
- ZV
);
15548 w
->window_end_vpos
= make_number (0);
15551 /* But that is not valid info until redisplay finishes. */
15552 w
->window_end_valid
= Qnil
;
15558 /************************************************************************
15559 Window redisplay reusing current matrix when buffer has not changed
15560 ************************************************************************/
15562 /* Try redisplay of window W showing an unchanged buffer with a
15563 different window start than the last time it was displayed by
15564 reusing its current matrix. Value is non-zero if successful.
15565 W->start is the new window start. */
15568 try_window_reusing_current_matrix (struct window
*w
)
15570 struct frame
*f
= XFRAME (w
->frame
);
15571 struct glyph_row
*bottom_row
;
15574 struct text_pos start
, new_start
;
15575 int nrows_scrolled
, i
;
15576 struct glyph_row
*last_text_row
;
15577 struct glyph_row
*last_reused_text_row
;
15578 struct glyph_row
*start_row
;
15579 int start_vpos
, min_y
, max_y
;
15582 if (inhibit_try_window_reusing
)
15586 if (/* This function doesn't handle terminal frames. */
15587 !FRAME_WINDOW_P (f
)
15588 /* Don't try to reuse the display if windows have been split
15590 || windows_or_buffers_changed
15591 || cursor_type_changed
)
15594 /* Can't do this if region may have changed. */
15595 if ((!NILP (Vtransient_mark_mode
)
15596 && !NILP (BVAR (current_buffer
, mark_active
)))
15597 || !NILP (w
->region_showing
)
15598 || !NILP (Vshow_trailing_whitespace
))
15601 /* If top-line visibility has changed, give up. */
15602 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15603 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15606 /* Give up if old or new display is scrolled vertically. We could
15607 make this function handle this, but right now it doesn't. */
15608 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15609 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15612 /* The variable new_start now holds the new window start. The old
15613 start `start' can be determined from the current matrix. */
15614 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15615 start
= start_row
->minpos
;
15616 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15618 /* Clear the desired matrix for the display below. */
15619 clear_glyph_matrix (w
->desired_matrix
);
15621 if (CHARPOS (new_start
) <= CHARPOS (start
))
15623 /* Don't use this method if the display starts with an ellipsis
15624 displayed for invisible text. It's not easy to handle that case
15625 below, and it's certainly not worth the effort since this is
15626 not a frequent case. */
15627 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15630 IF_DEBUG (debug_method_add (w
, "twu1"));
15632 /* Display up to a row that can be reused. The variable
15633 last_text_row is set to the last row displayed that displays
15634 text. Note that it.vpos == 0 if or if not there is a
15635 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15636 start_display (&it
, w
, new_start
);
15637 w
->cursor
.vpos
= -1;
15638 last_text_row
= last_reused_text_row
= NULL
;
15640 while (it
.current_y
< it
.last_visible_y
15641 && !fonts_changed_p
)
15643 /* If we have reached into the characters in the START row,
15644 that means the line boundaries have changed. So we
15645 can't start copying with the row START. Maybe it will
15646 work to start copying with the following row. */
15647 while (IT_CHARPOS (it
) > CHARPOS (start
))
15649 /* Advance to the next row as the "start". */
15651 start
= start_row
->minpos
;
15652 /* If there are no more rows to try, or just one, give up. */
15653 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15654 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15655 || CHARPOS (start
) == ZV
)
15657 clear_glyph_matrix (w
->desired_matrix
);
15661 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15663 /* If we have reached alignment,
15664 we can copy the rest of the rows. */
15665 if (IT_CHARPOS (it
) == CHARPOS (start
))
15668 if (display_line (&it
))
15669 last_text_row
= it
.glyph_row
- 1;
15672 /* A value of current_y < last_visible_y means that we stopped
15673 at the previous window start, which in turn means that we
15674 have at least one reusable row. */
15675 if (it
.current_y
< it
.last_visible_y
)
15677 struct glyph_row
*row
;
15679 /* IT.vpos always starts from 0; it counts text lines. */
15680 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15682 /* Find PT if not already found in the lines displayed. */
15683 if (w
->cursor
.vpos
< 0)
15685 int dy
= it
.current_y
- start_row
->y
;
15687 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15688 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15690 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15691 dy
, nrows_scrolled
);
15694 clear_glyph_matrix (w
->desired_matrix
);
15699 /* Scroll the display. Do it before the current matrix is
15700 changed. The problem here is that update has not yet
15701 run, i.e. part of the current matrix is not up to date.
15702 scroll_run_hook will clear the cursor, and use the
15703 current matrix to get the height of the row the cursor is
15705 run
.current_y
= start_row
->y
;
15706 run
.desired_y
= it
.current_y
;
15707 run
.height
= it
.last_visible_y
- it
.current_y
;
15709 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15712 FRAME_RIF (f
)->update_window_begin_hook (w
);
15713 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15714 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15715 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15719 /* Shift current matrix down by nrows_scrolled lines. */
15720 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15721 rotate_matrix (w
->current_matrix
,
15723 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15726 /* Disable lines that must be updated. */
15727 for (i
= 0; i
< nrows_scrolled
; ++i
)
15728 (start_row
+ i
)->enabled_p
= 0;
15730 /* Re-compute Y positions. */
15731 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15732 max_y
= it
.last_visible_y
;
15733 for (row
= start_row
+ nrows_scrolled
;
15737 row
->y
= it
.current_y
;
15738 row
->visible_height
= row
->height
;
15740 if (row
->y
< min_y
)
15741 row
->visible_height
-= min_y
- row
->y
;
15742 if (row
->y
+ row
->height
> max_y
)
15743 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15744 if (row
->fringe_bitmap_periodic_p
)
15745 row
->redraw_fringe_bitmaps_p
= 1;
15747 it
.current_y
+= row
->height
;
15749 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15750 last_reused_text_row
= row
;
15751 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15755 /* Disable lines in the current matrix which are now
15756 below the window. */
15757 for (++row
; row
< bottom_row
; ++row
)
15758 row
->enabled_p
= row
->mode_line_p
= 0;
15761 /* Update window_end_pos etc.; last_reused_text_row is the last
15762 reused row from the current matrix containing text, if any.
15763 The value of last_text_row is the last displayed line
15764 containing text. */
15765 if (last_reused_text_row
)
15767 w
->window_end_bytepos
15768 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15770 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15772 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15773 w
->current_matrix
));
15775 else if (last_text_row
)
15777 w
->window_end_bytepos
15778 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15780 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15782 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15786 /* This window must be completely empty. */
15787 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15788 w
->window_end_pos
= make_number (Z
- ZV
);
15789 w
->window_end_vpos
= make_number (0);
15791 w
->window_end_valid
= Qnil
;
15793 /* Update hint: don't try scrolling again in update_window. */
15794 w
->desired_matrix
->no_scrolling_p
= 1;
15797 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15801 else if (CHARPOS (new_start
) > CHARPOS (start
))
15803 struct glyph_row
*pt_row
, *row
;
15804 struct glyph_row
*first_reusable_row
;
15805 struct glyph_row
*first_row_to_display
;
15807 int yb
= window_text_bottom_y (w
);
15809 /* Find the row starting at new_start, if there is one. Don't
15810 reuse a partially visible line at the end. */
15811 first_reusable_row
= start_row
;
15812 while (first_reusable_row
->enabled_p
15813 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15814 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15815 < CHARPOS (new_start
)))
15816 ++first_reusable_row
;
15818 /* Give up if there is no row to reuse. */
15819 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15820 || !first_reusable_row
->enabled_p
15821 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15822 != CHARPOS (new_start
)))
15825 /* We can reuse fully visible rows beginning with
15826 first_reusable_row to the end of the window. Set
15827 first_row_to_display to the first row that cannot be reused.
15828 Set pt_row to the row containing point, if there is any. */
15830 for (first_row_to_display
= first_reusable_row
;
15831 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15832 ++first_row_to_display
)
15834 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15835 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15836 pt_row
= first_row_to_display
;
15839 /* Start displaying at the start of first_row_to_display. */
15840 xassert (first_row_to_display
->y
< yb
);
15841 init_to_row_start (&it
, w
, first_row_to_display
);
15843 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15845 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15847 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15848 + WINDOW_HEADER_LINE_HEIGHT (w
));
15850 /* Display lines beginning with first_row_to_display in the
15851 desired matrix. Set last_text_row to the last row displayed
15852 that displays text. */
15853 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15854 if (pt_row
== NULL
)
15855 w
->cursor
.vpos
= -1;
15856 last_text_row
= NULL
;
15857 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15858 if (display_line (&it
))
15859 last_text_row
= it
.glyph_row
- 1;
15861 /* If point is in a reused row, adjust y and vpos of the cursor
15865 w
->cursor
.vpos
-= nrows_scrolled
;
15866 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15869 /* Give up if point isn't in a row displayed or reused. (This
15870 also handles the case where w->cursor.vpos < nrows_scrolled
15871 after the calls to display_line, which can happen with scroll
15872 margins. See bug#1295.) */
15873 if (w
->cursor
.vpos
< 0)
15875 clear_glyph_matrix (w
->desired_matrix
);
15879 /* Scroll the display. */
15880 run
.current_y
= first_reusable_row
->y
;
15881 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15882 run
.height
= it
.last_visible_y
- run
.current_y
;
15883 dy
= run
.current_y
- run
.desired_y
;
15888 FRAME_RIF (f
)->update_window_begin_hook (w
);
15889 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15890 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15891 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15895 /* Adjust Y positions of reused rows. */
15896 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15897 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15898 max_y
= it
.last_visible_y
;
15899 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15902 row
->visible_height
= row
->height
;
15903 if (row
->y
< min_y
)
15904 row
->visible_height
-= min_y
- row
->y
;
15905 if (row
->y
+ row
->height
> max_y
)
15906 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15907 if (row
->fringe_bitmap_periodic_p
)
15908 row
->redraw_fringe_bitmaps_p
= 1;
15911 /* Scroll the current matrix. */
15912 xassert (nrows_scrolled
> 0);
15913 rotate_matrix (w
->current_matrix
,
15915 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15918 /* Disable rows not reused. */
15919 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15920 row
->enabled_p
= 0;
15922 /* Point may have moved to a different line, so we cannot assume that
15923 the previous cursor position is valid; locate the correct row. */
15926 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15927 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15931 w
->cursor
.y
= row
->y
;
15933 if (row
< bottom_row
)
15935 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15936 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15938 /* Can't use this optimization with bidi-reordered glyph
15939 rows, unless cursor is already at point. */
15940 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15942 if (!(w
->cursor
.hpos
>= 0
15943 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15944 && BUFFERP (glyph
->object
)
15945 && glyph
->charpos
== PT
))
15950 && (!BUFFERP (glyph
->object
)
15951 || glyph
->charpos
< PT
);
15955 w
->cursor
.x
+= glyph
->pixel_width
;
15960 /* Adjust window end. A null value of last_text_row means that
15961 the window end is in reused rows which in turn means that
15962 only its vpos can have changed. */
15965 w
->window_end_bytepos
15966 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15968 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15970 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15975 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15978 w
->window_end_valid
= Qnil
;
15979 w
->desired_matrix
->no_scrolling_p
= 1;
15982 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15992 /************************************************************************
15993 Window redisplay reusing current matrix when buffer has changed
15994 ************************************************************************/
15996 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15997 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15998 EMACS_INT
*, EMACS_INT
*);
15999 static struct glyph_row
*
16000 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16001 struct glyph_row
*);
16004 /* Return the last row in MATRIX displaying text. If row START is
16005 non-null, start searching with that row. IT gives the dimensions
16006 of the display. Value is null if matrix is empty; otherwise it is
16007 a pointer to the row found. */
16009 static struct glyph_row
*
16010 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16011 struct glyph_row
*start
)
16013 struct glyph_row
*row
, *row_found
;
16015 /* Set row_found to the last row in IT->w's current matrix
16016 displaying text. The loop looks funny but think of partially
16019 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16020 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16022 xassert (row
->enabled_p
);
16024 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16033 /* Return the last row in the current matrix of W that is not affected
16034 by changes at the start of current_buffer that occurred since W's
16035 current matrix was built. Value is null if no such row exists.
16037 BEG_UNCHANGED us the number of characters unchanged at the start of
16038 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16039 first changed character in current_buffer. Characters at positions <
16040 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16041 when the current matrix was built. */
16043 static struct glyph_row
*
16044 find_last_unchanged_at_beg_row (struct window
*w
)
16046 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16047 struct glyph_row
*row
;
16048 struct glyph_row
*row_found
= NULL
;
16049 int yb
= window_text_bottom_y (w
);
16051 /* Find the last row displaying unchanged text. */
16052 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16053 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16054 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16057 if (/* If row ends before first_changed_pos, it is unchanged,
16058 except in some case. */
16059 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16060 /* When row ends in ZV and we write at ZV it is not
16062 && !row
->ends_at_zv_p
16063 /* When first_changed_pos is the end of a continued line,
16064 row is not unchanged because it may be no longer
16066 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16067 && (row
->continued_p
16068 || row
->exact_window_width_line_p
)))
16071 /* Stop if last visible row. */
16072 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16080 /* Find the first glyph row in the current matrix of W that is not
16081 affected by changes at the end of current_buffer since the
16082 time W's current matrix was built.
16084 Return in *DELTA the number of chars by which buffer positions in
16085 unchanged text at the end of current_buffer must be adjusted.
16087 Return in *DELTA_BYTES the corresponding number of bytes.
16089 Value is null if no such row exists, i.e. all rows are affected by
16092 static struct glyph_row
*
16093 find_first_unchanged_at_end_row (struct window
*w
,
16094 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16096 struct glyph_row
*row
;
16097 struct glyph_row
*row_found
= NULL
;
16099 *delta
= *delta_bytes
= 0;
16101 /* Display must not have been paused, otherwise the current matrix
16102 is not up to date. */
16103 eassert (!NILP (w
->window_end_valid
));
16105 /* A value of window_end_pos >= END_UNCHANGED means that the window
16106 end is in the range of changed text. If so, there is no
16107 unchanged row at the end of W's current matrix. */
16108 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16111 /* Set row to the last row in W's current matrix displaying text. */
16112 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16114 /* If matrix is entirely empty, no unchanged row exists. */
16115 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16117 /* The value of row is the last glyph row in the matrix having a
16118 meaningful buffer position in it. The end position of row
16119 corresponds to window_end_pos. This allows us to translate
16120 buffer positions in the current matrix to current buffer
16121 positions for characters not in changed text. */
16123 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16124 EMACS_INT Z_BYTE_old
=
16125 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16126 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16127 struct glyph_row
*first_text_row
16128 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16130 *delta
= Z
- Z_old
;
16131 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16133 /* Set last_unchanged_pos to the buffer position of the last
16134 character in the buffer that has not been changed. Z is the
16135 index + 1 of the last character in current_buffer, i.e. by
16136 subtracting END_UNCHANGED we get the index of the last
16137 unchanged character, and we have to add BEG to get its buffer
16139 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16140 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16142 /* Search backward from ROW for a row displaying a line that
16143 starts at a minimum position >= last_unchanged_pos_old. */
16144 for (; row
> first_text_row
; --row
)
16146 /* This used to abort, but it can happen.
16147 It is ok to just stop the search instead here. KFS. */
16148 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16151 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16156 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16162 /* Make sure that glyph rows in the current matrix of window W
16163 reference the same glyph memory as corresponding rows in the
16164 frame's frame matrix. This function is called after scrolling W's
16165 current matrix on a terminal frame in try_window_id and
16166 try_window_reusing_current_matrix. */
16169 sync_frame_with_window_matrix_rows (struct window
*w
)
16171 struct frame
*f
= XFRAME (w
->frame
);
16172 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16174 /* Preconditions: W must be a leaf window and full-width. Its frame
16175 must have a frame matrix. */
16176 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16177 xassert (WINDOW_FULL_WIDTH_P (w
));
16178 xassert (!FRAME_WINDOW_P (f
));
16180 /* If W is a full-width window, glyph pointers in W's current matrix
16181 have, by definition, to be the same as glyph pointers in the
16182 corresponding frame matrix. Note that frame matrices have no
16183 marginal areas (see build_frame_matrix). */
16184 window_row
= w
->current_matrix
->rows
;
16185 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16186 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16187 while (window_row
< window_row_end
)
16189 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16190 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16192 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16193 frame_row
->glyphs
[TEXT_AREA
] = start
;
16194 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16195 frame_row
->glyphs
[LAST_AREA
] = end
;
16197 /* Disable frame rows whose corresponding window rows have
16198 been disabled in try_window_id. */
16199 if (!window_row
->enabled_p
)
16200 frame_row
->enabled_p
= 0;
16202 ++window_row
, ++frame_row
;
16207 /* Find the glyph row in window W containing CHARPOS. Consider all
16208 rows between START and END (not inclusive). END null means search
16209 all rows to the end of the display area of W. Value is the row
16210 containing CHARPOS or null. */
16213 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16214 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16216 struct glyph_row
*row
= start
;
16217 struct glyph_row
*best_row
= NULL
;
16218 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16221 /* If we happen to start on a header-line, skip that. */
16222 if (row
->mode_line_p
)
16225 if ((end
&& row
>= end
) || !row
->enabled_p
)
16228 last_y
= window_text_bottom_y (w
) - dy
;
16232 /* Give up if we have gone too far. */
16233 if (end
&& row
>= end
)
16235 /* This formerly returned if they were equal.
16236 I think that both quantities are of a "last plus one" type;
16237 if so, when they are equal, the row is within the screen. -- rms. */
16238 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16241 /* If it is in this row, return this row. */
16242 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16243 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16244 /* The end position of a row equals the start
16245 position of the next row. If CHARPOS is there, we
16246 would rather display it in the next line, except
16247 when this line ends in ZV. */
16248 && !row
->ends_at_zv_p
16249 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16250 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16254 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16255 || (!best_row
&& !row
->continued_p
))
16257 /* In bidi-reordered rows, there could be several rows
16258 occluding point, all of them belonging to the same
16259 continued line. We need to find the row which fits
16260 CHARPOS the best. */
16261 for (g
= row
->glyphs
[TEXT_AREA
];
16262 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16265 if (!STRINGP (g
->object
))
16267 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16269 mindif
= eabs (g
->charpos
- charpos
);
16271 /* Exact match always wins. */
16278 else if (best_row
&& !row
->continued_p
)
16285 /* Try to redisplay window W by reusing its existing display. W's
16286 current matrix must be up to date when this function is called,
16287 i.e. window_end_valid must not be nil.
16291 1 if display has been updated
16292 0 if otherwise unsuccessful
16293 -1 if redisplay with same window start is known not to succeed
16295 The following steps are performed:
16297 1. Find the last row in the current matrix of W that is not
16298 affected by changes at the start of current_buffer. If no such row
16301 2. Find the first row in W's current matrix that is not affected by
16302 changes at the end of current_buffer. Maybe there is no such row.
16304 3. Display lines beginning with the row + 1 found in step 1 to the
16305 row found in step 2 or, if step 2 didn't find a row, to the end of
16308 4. If cursor is not known to appear on the window, give up.
16310 5. If display stopped at the row found in step 2, scroll the
16311 display and current matrix as needed.
16313 6. Maybe display some lines at the end of W, if we must. This can
16314 happen under various circumstances, like a partially visible line
16315 becoming fully visible, or because newly displayed lines are displayed
16316 in smaller font sizes.
16318 7. Update W's window end information. */
16321 try_window_id (struct window
*w
)
16323 struct frame
*f
= XFRAME (w
->frame
);
16324 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16325 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16326 struct glyph_row
*last_unchanged_at_beg_row
;
16327 struct glyph_row
*first_unchanged_at_end_row
;
16328 struct glyph_row
*row
;
16329 struct glyph_row
*bottom_row
;
16332 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16334 struct text_pos start_pos
;
16336 int first_unchanged_at_end_vpos
= 0;
16337 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16338 struct text_pos start
;
16339 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16342 if (inhibit_try_window_id
)
16346 /* This is handy for debugging. */
16348 #define GIVE_UP(X) \
16350 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16354 #define GIVE_UP(X) return 0
16357 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16359 /* Don't use this for mini-windows because these can show
16360 messages and mini-buffers, and we don't handle that here. */
16361 if (MINI_WINDOW_P (w
))
16364 /* This flag is used to prevent redisplay optimizations. */
16365 if (windows_or_buffers_changed
|| cursor_type_changed
)
16368 /* Verify that narrowing has not changed.
16369 Also verify that we were not told to prevent redisplay optimizations.
16370 It would be nice to further
16371 reduce the number of cases where this prevents try_window_id. */
16372 if (current_buffer
->clip_changed
16373 || current_buffer
->prevent_redisplay_optimizations_p
)
16376 /* Window must either use window-based redisplay or be full width. */
16377 if (!FRAME_WINDOW_P (f
)
16378 && (!FRAME_LINE_INS_DEL_OK (f
)
16379 || !WINDOW_FULL_WIDTH_P (w
)))
16382 /* Give up if point is known NOT to appear in W. */
16383 if (PT
< CHARPOS (start
))
16386 /* Another way to prevent redisplay optimizations. */
16387 if (XFASTINT (w
->last_modified
) == 0)
16390 /* Verify that window is not hscrolled. */
16391 if (XFASTINT (w
->hscroll
) != 0)
16394 /* Verify that display wasn't paused. */
16395 if (NILP (w
->window_end_valid
))
16398 /* Can't use this if highlighting a region because a cursor movement
16399 will do more than just set the cursor. */
16400 if (!NILP (Vtransient_mark_mode
)
16401 && !NILP (BVAR (current_buffer
, mark_active
)))
16404 /* Likewise if highlighting trailing whitespace. */
16405 if (!NILP (Vshow_trailing_whitespace
))
16408 /* Likewise if showing a region. */
16409 if (!NILP (w
->region_showing
))
16412 /* Can't use this if overlay arrow position and/or string have
16414 if (overlay_arrows_changed_p ())
16417 /* When word-wrap is on, adding a space to the first word of a
16418 wrapped line can change the wrap position, altering the line
16419 above it. It might be worthwhile to handle this more
16420 intelligently, but for now just redisplay from scratch. */
16421 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16424 /* Under bidi reordering, adding or deleting a character in the
16425 beginning of a paragraph, before the first strong directional
16426 character, can change the base direction of the paragraph (unless
16427 the buffer specifies a fixed paragraph direction), which will
16428 require to redisplay the whole paragraph. It might be worthwhile
16429 to find the paragraph limits and widen the range of redisplayed
16430 lines to that, but for now just give up this optimization and
16431 redisplay from scratch. */
16432 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16433 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16436 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16437 only if buffer has really changed. The reason is that the gap is
16438 initially at Z for freshly visited files. The code below would
16439 set end_unchanged to 0 in that case. */
16440 if (MODIFF
> SAVE_MODIFF
16441 /* This seems to happen sometimes after saving a buffer. */
16442 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16444 if (GPT
- BEG
< BEG_UNCHANGED
)
16445 BEG_UNCHANGED
= GPT
- BEG
;
16446 if (Z
- GPT
< END_UNCHANGED
)
16447 END_UNCHANGED
= Z
- GPT
;
16450 /* The position of the first and last character that has been changed. */
16451 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16452 last_changed_charpos
= Z
- END_UNCHANGED
;
16454 /* If window starts after a line end, and the last change is in
16455 front of that newline, then changes don't affect the display.
16456 This case happens with stealth-fontification. Note that although
16457 the display is unchanged, glyph positions in the matrix have to
16458 be adjusted, of course. */
16459 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16460 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16461 && ((last_changed_charpos
< CHARPOS (start
)
16462 && CHARPOS (start
) == BEGV
)
16463 || (last_changed_charpos
< CHARPOS (start
) - 1
16464 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16466 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16467 struct glyph_row
*r0
;
16469 /* Compute how many chars/bytes have been added to or removed
16470 from the buffer. */
16471 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16472 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16473 Z_delta
= Z
- Z_old
;
16474 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16476 /* Give up if PT is not in the window. Note that it already has
16477 been checked at the start of try_window_id that PT is not in
16478 front of the window start. */
16479 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16482 /* If window start is unchanged, we can reuse the whole matrix
16483 as is, after adjusting glyph positions. No need to compute
16484 the window end again, since its offset from Z hasn't changed. */
16485 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16486 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16487 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16488 /* PT must not be in a partially visible line. */
16489 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16490 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16492 /* Adjust positions in the glyph matrix. */
16493 if (Z_delta
|| Z_delta_bytes
)
16495 struct glyph_row
*r1
16496 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16497 increment_matrix_positions (w
->current_matrix
,
16498 MATRIX_ROW_VPOS (r0
, current_matrix
),
16499 MATRIX_ROW_VPOS (r1
, current_matrix
),
16500 Z_delta
, Z_delta_bytes
);
16503 /* Set the cursor. */
16504 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16506 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16513 /* Handle the case that changes are all below what is displayed in
16514 the window, and that PT is in the window. This shortcut cannot
16515 be taken if ZV is visible in the window, and text has been added
16516 there that is visible in the window. */
16517 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16518 /* ZV is not visible in the window, or there are no
16519 changes at ZV, actually. */
16520 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16521 || first_changed_charpos
== last_changed_charpos
))
16523 struct glyph_row
*r0
;
16525 /* Give up if PT is not in the window. Note that it already has
16526 been checked at the start of try_window_id that PT is not in
16527 front of the window start. */
16528 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16531 /* If window start is unchanged, we can reuse the whole matrix
16532 as is, without changing glyph positions since no text has
16533 been added/removed in front of the window end. */
16534 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16535 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16536 /* PT must not be in a partially visible line. */
16537 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16538 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16540 /* We have to compute the window end anew since text
16541 could have been added/removed after it. */
16543 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16544 w
->window_end_bytepos
16545 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16547 /* Set the cursor. */
16548 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16550 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16557 /* Give up if window start is in the changed area.
16559 The condition used to read
16561 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16563 but why that was tested escapes me at the moment. */
16564 if (CHARPOS (start
) >= first_changed_charpos
16565 && CHARPOS (start
) <= last_changed_charpos
)
16568 /* Check that window start agrees with the start of the first glyph
16569 row in its current matrix. Check this after we know the window
16570 start is not in changed text, otherwise positions would not be
16572 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16573 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16576 /* Give up if the window ends in strings. Overlay strings
16577 at the end are difficult to handle, so don't try. */
16578 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16579 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16582 /* Compute the position at which we have to start displaying new
16583 lines. Some of the lines at the top of the window might be
16584 reusable because they are not displaying changed text. Find the
16585 last row in W's current matrix not affected by changes at the
16586 start of current_buffer. Value is null if changes start in the
16587 first line of window. */
16588 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16589 if (last_unchanged_at_beg_row
)
16591 /* Avoid starting to display in the moddle of a character, a TAB
16592 for instance. This is easier than to set up the iterator
16593 exactly, and it's not a frequent case, so the additional
16594 effort wouldn't really pay off. */
16595 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16596 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16597 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16598 --last_unchanged_at_beg_row
;
16600 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16603 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16605 start_pos
= it
.current
.pos
;
16607 /* Start displaying new lines in the desired matrix at the same
16608 vpos we would use in the current matrix, i.e. below
16609 last_unchanged_at_beg_row. */
16610 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16612 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16613 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16615 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16619 /* There are no reusable lines at the start of the window.
16620 Start displaying in the first text line. */
16621 start_display (&it
, w
, start
);
16622 it
.vpos
= it
.first_vpos
;
16623 start_pos
= it
.current
.pos
;
16626 /* Find the first row that is not affected by changes at the end of
16627 the buffer. Value will be null if there is no unchanged row, in
16628 which case we must redisplay to the end of the window. delta
16629 will be set to the value by which buffer positions beginning with
16630 first_unchanged_at_end_row have to be adjusted due to text
16632 first_unchanged_at_end_row
16633 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16634 IF_DEBUG (debug_delta
= delta
);
16635 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16637 /* Set stop_pos to the buffer position up to which we will have to
16638 display new lines. If first_unchanged_at_end_row != NULL, this
16639 is the buffer position of the start of the line displayed in that
16640 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16641 that we don't stop at a buffer position. */
16643 if (first_unchanged_at_end_row
)
16645 xassert (last_unchanged_at_beg_row
== NULL
16646 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16648 /* If this is a continuation line, move forward to the next one
16649 that isn't. Changes in lines above affect this line.
16650 Caution: this may move first_unchanged_at_end_row to a row
16651 not displaying text. */
16652 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16653 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16654 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16655 < it
.last_visible_y
))
16656 ++first_unchanged_at_end_row
;
16658 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16659 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16660 >= it
.last_visible_y
))
16661 first_unchanged_at_end_row
= NULL
;
16664 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16666 first_unchanged_at_end_vpos
16667 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16668 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16671 else if (last_unchanged_at_beg_row
== NULL
)
16677 /* Either there is no unchanged row at the end, or the one we have
16678 now displays text. This is a necessary condition for the window
16679 end pos calculation at the end of this function. */
16680 xassert (first_unchanged_at_end_row
== NULL
16681 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16683 debug_last_unchanged_at_beg_vpos
16684 = (last_unchanged_at_beg_row
16685 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16687 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16689 #endif /* GLYPH_DEBUG != 0 */
16692 /* Display new lines. Set last_text_row to the last new line
16693 displayed which has text on it, i.e. might end up as being the
16694 line where the window_end_vpos is. */
16695 w
->cursor
.vpos
= -1;
16696 last_text_row
= NULL
;
16697 overlay_arrow_seen
= 0;
16698 while (it
.current_y
< it
.last_visible_y
16699 && !fonts_changed_p
16700 && (first_unchanged_at_end_row
== NULL
16701 || IT_CHARPOS (it
) < stop_pos
))
16703 if (display_line (&it
))
16704 last_text_row
= it
.glyph_row
- 1;
16707 if (fonts_changed_p
)
16711 /* Compute differences in buffer positions, y-positions etc. for
16712 lines reused at the bottom of the window. Compute what we can
16714 if (first_unchanged_at_end_row
16715 /* No lines reused because we displayed everything up to the
16716 bottom of the window. */
16717 && it
.current_y
< it
.last_visible_y
)
16720 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16722 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16723 run
.current_y
= first_unchanged_at_end_row
->y
;
16724 run
.desired_y
= run
.current_y
+ dy
;
16725 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16729 delta
= delta_bytes
= dvpos
= dy
16730 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16731 first_unchanged_at_end_row
= NULL
;
16733 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16736 /* Find the cursor if not already found. We have to decide whether
16737 PT will appear on this window (it sometimes doesn't, but this is
16738 not a very frequent case.) This decision has to be made before
16739 the current matrix is altered. A value of cursor.vpos < 0 means
16740 that PT is either in one of the lines beginning at
16741 first_unchanged_at_end_row or below the window. Don't care for
16742 lines that might be displayed later at the window end; as
16743 mentioned, this is not a frequent case. */
16744 if (w
->cursor
.vpos
< 0)
16746 /* Cursor in unchanged rows at the top? */
16747 if (PT
< CHARPOS (start_pos
)
16748 && last_unchanged_at_beg_row
)
16750 row
= row_containing_pos (w
, PT
,
16751 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16752 last_unchanged_at_beg_row
+ 1, 0);
16754 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16757 /* Start from first_unchanged_at_end_row looking for PT. */
16758 else if (first_unchanged_at_end_row
)
16760 row
= row_containing_pos (w
, PT
- delta
,
16761 first_unchanged_at_end_row
, NULL
, 0);
16763 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16764 delta_bytes
, dy
, dvpos
);
16767 /* Give up if cursor was not found. */
16768 if (w
->cursor
.vpos
< 0)
16770 clear_glyph_matrix (w
->desired_matrix
);
16775 /* Don't let the cursor end in the scroll margins. */
16777 int this_scroll_margin
, cursor_height
;
16779 this_scroll_margin
= max (0, scroll_margin
);
16780 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16781 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16782 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16784 if ((w
->cursor
.y
< this_scroll_margin
16785 && CHARPOS (start
) > BEGV
)
16786 /* Old redisplay didn't take scroll margin into account at the bottom,
16787 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16788 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16789 ? cursor_height
+ this_scroll_margin
16790 : 1)) > it
.last_visible_y
)
16792 w
->cursor
.vpos
= -1;
16793 clear_glyph_matrix (w
->desired_matrix
);
16798 /* Scroll the display. Do it before changing the current matrix so
16799 that xterm.c doesn't get confused about where the cursor glyph is
16801 if (dy
&& run
.height
)
16805 if (FRAME_WINDOW_P (f
))
16807 FRAME_RIF (f
)->update_window_begin_hook (w
);
16808 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16809 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16810 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16814 /* Terminal frame. In this case, dvpos gives the number of
16815 lines to scroll by; dvpos < 0 means scroll up. */
16817 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16818 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16819 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16820 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16821 + window_internal_height (w
));
16823 #if defined (HAVE_GPM) || defined (MSDOS)
16824 x_clear_window_mouse_face (w
);
16826 /* Perform the operation on the screen. */
16829 /* Scroll last_unchanged_at_beg_row to the end of the
16830 window down dvpos lines. */
16831 set_terminal_window (f
, end
);
16833 /* On dumb terminals delete dvpos lines at the end
16834 before inserting dvpos empty lines. */
16835 if (!FRAME_SCROLL_REGION_OK (f
))
16836 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16838 /* Insert dvpos empty lines in front of
16839 last_unchanged_at_beg_row. */
16840 ins_del_lines (f
, from
, dvpos
);
16842 else if (dvpos
< 0)
16844 /* Scroll up last_unchanged_at_beg_vpos to the end of
16845 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16846 set_terminal_window (f
, end
);
16848 /* Delete dvpos lines in front of
16849 last_unchanged_at_beg_vpos. ins_del_lines will set
16850 the cursor to the given vpos and emit |dvpos| delete
16852 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16854 /* On a dumb terminal insert dvpos empty lines at the
16856 if (!FRAME_SCROLL_REGION_OK (f
))
16857 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16860 set_terminal_window (f
, 0);
16866 /* Shift reused rows of the current matrix to the right position.
16867 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16869 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16870 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16873 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16874 bottom_vpos
, dvpos
);
16875 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16878 else if (dvpos
> 0)
16880 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16881 bottom_vpos
, dvpos
);
16882 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16883 first_unchanged_at_end_vpos
+ dvpos
, 0);
16886 /* For frame-based redisplay, make sure that current frame and window
16887 matrix are in sync with respect to glyph memory. */
16888 if (!FRAME_WINDOW_P (f
))
16889 sync_frame_with_window_matrix_rows (w
);
16891 /* Adjust buffer positions in reused rows. */
16892 if (delta
|| delta_bytes
)
16893 increment_matrix_positions (current_matrix
,
16894 first_unchanged_at_end_vpos
+ dvpos
,
16895 bottom_vpos
, delta
, delta_bytes
);
16897 /* Adjust Y positions. */
16899 shift_glyph_matrix (w
, current_matrix
,
16900 first_unchanged_at_end_vpos
+ dvpos
,
16903 if (first_unchanged_at_end_row
)
16905 first_unchanged_at_end_row
+= dvpos
;
16906 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16907 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16908 first_unchanged_at_end_row
= NULL
;
16911 /* If scrolling up, there may be some lines to display at the end of
16913 last_text_row_at_end
= NULL
;
16916 /* Scrolling up can leave for example a partially visible line
16917 at the end of the window to be redisplayed. */
16918 /* Set last_row to the glyph row in the current matrix where the
16919 window end line is found. It has been moved up or down in
16920 the matrix by dvpos. */
16921 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16922 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16924 /* If last_row is the window end line, it should display text. */
16925 xassert (last_row
->displays_text_p
);
16927 /* If window end line was partially visible before, begin
16928 displaying at that line. Otherwise begin displaying with the
16929 line following it. */
16930 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16932 init_to_row_start (&it
, w
, last_row
);
16933 it
.vpos
= last_vpos
;
16934 it
.current_y
= last_row
->y
;
16938 init_to_row_end (&it
, w
, last_row
);
16939 it
.vpos
= 1 + last_vpos
;
16940 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16944 /* We may start in a continuation line. If so, we have to
16945 get the right continuation_lines_width and current_x. */
16946 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16947 it
.hpos
= it
.current_x
= 0;
16949 /* Display the rest of the lines at the window end. */
16950 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16951 while (it
.current_y
< it
.last_visible_y
16952 && !fonts_changed_p
)
16954 /* Is it always sure that the display agrees with lines in
16955 the current matrix? I don't think so, so we mark rows
16956 displayed invalid in the current matrix by setting their
16957 enabled_p flag to zero. */
16958 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16959 if (display_line (&it
))
16960 last_text_row_at_end
= it
.glyph_row
- 1;
16964 /* Update window_end_pos and window_end_vpos. */
16965 if (first_unchanged_at_end_row
16966 && !last_text_row_at_end
)
16968 /* Window end line if one of the preserved rows from the current
16969 matrix. Set row to the last row displaying text in current
16970 matrix starting at first_unchanged_at_end_row, after
16972 xassert (first_unchanged_at_end_row
->displays_text_p
);
16973 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16974 first_unchanged_at_end_row
);
16975 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16977 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16978 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16980 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16981 xassert (w
->window_end_bytepos
>= 0);
16982 IF_DEBUG (debug_method_add (w
, "A"));
16984 else if (last_text_row_at_end
)
16987 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16988 w
->window_end_bytepos
16989 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16991 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16992 xassert (w
->window_end_bytepos
>= 0);
16993 IF_DEBUG (debug_method_add (w
, "B"));
16995 else if (last_text_row
)
16997 /* We have displayed either to the end of the window or at the
16998 end of the window, i.e. the last row with text is to be found
16999 in the desired matrix. */
17001 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17002 w
->window_end_bytepos
17003 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17005 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17006 xassert (w
->window_end_bytepos
>= 0);
17008 else if (first_unchanged_at_end_row
== NULL
17009 && last_text_row
== NULL
17010 && last_text_row_at_end
== NULL
)
17012 /* Displayed to end of window, but no line containing text was
17013 displayed. Lines were deleted at the end of the window. */
17014 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17015 int vpos
= XFASTINT (w
->window_end_vpos
);
17016 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17017 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17020 row
== NULL
&& vpos
>= first_vpos
;
17021 --vpos
, --current_row
, --desired_row
)
17023 if (desired_row
->enabled_p
)
17025 if (desired_row
->displays_text_p
)
17028 else if (current_row
->displays_text_p
)
17032 xassert (row
!= NULL
);
17033 w
->window_end_vpos
= make_number (vpos
+ 1);
17034 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17035 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17036 xassert (w
->window_end_bytepos
>= 0);
17037 IF_DEBUG (debug_method_add (w
, "C"));
17042 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17043 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17045 /* Record that display has not been completed. */
17046 w
->window_end_valid
= Qnil
;
17047 w
->desired_matrix
->no_scrolling_p
= 1;
17055 /***********************************************************************
17056 More debugging support
17057 ***********************************************************************/
17061 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17062 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17063 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17066 /* Dump the contents of glyph matrix MATRIX on stderr.
17068 GLYPHS 0 means don't show glyph contents.
17069 GLYPHS 1 means show glyphs in short form
17070 GLYPHS > 1 means show glyphs in long form. */
17073 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17076 for (i
= 0; i
< matrix
->nrows
; ++i
)
17077 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17081 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17082 the glyph row and area where the glyph comes from. */
17085 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17087 if (glyph
->type
== CHAR_GLYPH
)
17090 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17091 glyph
- row
->glyphs
[TEXT_AREA
],
17094 (BUFFERP (glyph
->object
)
17096 : (STRINGP (glyph
->object
)
17099 glyph
->pixel_width
,
17101 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17105 glyph
->left_box_line_p
,
17106 glyph
->right_box_line_p
);
17108 else if (glyph
->type
== STRETCH_GLYPH
)
17111 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17112 glyph
- row
->glyphs
[TEXT_AREA
],
17115 (BUFFERP (glyph
->object
)
17117 : (STRINGP (glyph
->object
)
17120 glyph
->pixel_width
,
17124 glyph
->left_box_line_p
,
17125 glyph
->right_box_line_p
);
17127 else if (glyph
->type
== IMAGE_GLYPH
)
17130 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17131 glyph
- row
->glyphs
[TEXT_AREA
],
17134 (BUFFERP (glyph
->object
)
17136 : (STRINGP (glyph
->object
)
17139 glyph
->pixel_width
,
17143 glyph
->left_box_line_p
,
17144 glyph
->right_box_line_p
);
17146 else if (glyph
->type
== COMPOSITE_GLYPH
)
17149 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17150 glyph
- row
->glyphs
[TEXT_AREA
],
17153 (BUFFERP (glyph
->object
)
17155 : (STRINGP (glyph
->object
)
17158 glyph
->pixel_width
,
17160 if (glyph
->u
.cmp
.automatic
)
17163 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17164 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17166 glyph
->left_box_line_p
,
17167 glyph
->right_box_line_p
);
17172 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17173 GLYPHS 0 means don't show glyph contents.
17174 GLYPHS 1 means show glyphs in short form
17175 GLYPHS > 1 means show glyphs in long form. */
17178 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17182 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17183 fprintf (stderr
, "======================================================================\n");
17185 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17186 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17188 MATRIX_ROW_START_CHARPOS (row
),
17189 MATRIX_ROW_END_CHARPOS (row
),
17190 row
->used
[TEXT_AREA
],
17191 row
->contains_overlapping_glyphs_p
,
17193 row
->truncated_on_left_p
,
17194 row
->truncated_on_right_p
,
17196 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17197 row
->displays_text_p
,
17200 row
->ends_in_middle_of_char_p
,
17201 row
->starts_in_middle_of_char_p
,
17207 row
->visible_height
,
17210 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17211 row
->end
.overlay_string_index
,
17212 row
->continuation_lines_width
);
17213 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17214 CHARPOS (row
->start
.string_pos
),
17215 CHARPOS (row
->end
.string_pos
));
17216 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17217 row
->end
.dpvec_index
);
17224 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17226 struct glyph
*glyph
= row
->glyphs
[area
];
17227 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17229 /* Glyph for a line end in text. */
17230 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17233 if (glyph
< glyph_end
)
17234 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17236 for (; glyph
< glyph_end
; ++glyph
)
17237 dump_glyph (row
, glyph
, area
);
17240 else if (glyphs
== 1)
17244 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17246 char *s
= (char *) alloca (row
->used
[area
] + 1);
17249 for (i
= 0; i
< row
->used
[area
]; ++i
)
17251 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17252 if (glyph
->type
== CHAR_GLYPH
17253 && glyph
->u
.ch
< 0x80
17254 && glyph
->u
.ch
>= ' ')
17255 s
[i
] = glyph
->u
.ch
;
17261 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17267 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17268 Sdump_glyph_matrix
, 0, 1, "p",
17269 doc
: /* Dump the current matrix of the selected window to stderr.
17270 Shows contents of glyph row structures. With non-nil
17271 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17272 glyphs in short form, otherwise show glyphs in long form. */)
17273 (Lisp_Object glyphs
)
17275 struct window
*w
= XWINDOW (selected_window
);
17276 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17278 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17279 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17280 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17281 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17282 fprintf (stderr
, "=============================================\n");
17283 dump_glyph_matrix (w
->current_matrix
,
17284 NILP (glyphs
) ? 0 : XINT (glyphs
));
17289 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17290 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17293 struct frame
*f
= XFRAME (selected_frame
);
17294 dump_glyph_matrix (f
->current_matrix
, 1);
17299 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17300 doc
: /* Dump glyph row ROW to stderr.
17301 GLYPH 0 means don't dump glyphs.
17302 GLYPH 1 means dump glyphs in short form.
17303 GLYPH > 1 or omitted means dump glyphs in long form. */)
17304 (Lisp_Object row
, Lisp_Object glyphs
)
17306 struct glyph_matrix
*matrix
;
17309 CHECK_NUMBER (row
);
17310 matrix
= XWINDOW (selected_window
)->current_matrix
;
17312 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17313 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17315 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17320 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17321 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17322 GLYPH 0 means don't dump glyphs.
17323 GLYPH 1 means dump glyphs in short form.
17324 GLYPH > 1 or omitted means dump glyphs in long form. */)
17325 (Lisp_Object row
, Lisp_Object glyphs
)
17327 struct frame
*sf
= SELECTED_FRAME ();
17328 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17331 CHECK_NUMBER (row
);
17333 if (vpos
>= 0 && vpos
< m
->nrows
)
17334 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17335 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17340 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17341 doc
: /* Toggle tracing of redisplay.
17342 With ARG, turn tracing on if and only if ARG is positive. */)
17346 trace_redisplay_p
= !trace_redisplay_p
;
17349 arg
= Fprefix_numeric_value (arg
);
17350 trace_redisplay_p
= XINT (arg
) > 0;
17357 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17358 doc
: /* Like `format', but print result to stderr.
17359 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17360 (ptrdiff_t nargs
, Lisp_Object
*args
)
17362 Lisp_Object s
= Fformat (nargs
, args
);
17363 fprintf (stderr
, "%s", SDATA (s
));
17367 #endif /* GLYPH_DEBUG */
17371 /***********************************************************************
17372 Building Desired Matrix Rows
17373 ***********************************************************************/
17375 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17376 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17378 static struct glyph_row
*
17379 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17381 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17382 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17383 struct buffer
*old
= current_buffer
;
17384 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17385 int arrow_len
= SCHARS (overlay_arrow_string
);
17386 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17387 const unsigned char *p
;
17390 int n_glyphs_before
;
17392 set_buffer_temp (buffer
);
17393 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17394 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17395 SET_TEXT_POS (it
.position
, 0, 0);
17397 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17399 while (p
< arrow_end
)
17401 Lisp_Object face
, ilisp
;
17403 /* Get the next character. */
17405 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17408 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17409 if (! ASCII_CHAR_P (it
.c
))
17410 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17414 /* Get its face. */
17415 ilisp
= make_number (p
- arrow_string
);
17416 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17417 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17419 /* Compute its width, get its glyphs. */
17420 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17421 SET_TEXT_POS (it
.position
, -1, -1);
17422 PRODUCE_GLYPHS (&it
);
17424 /* If this character doesn't fit any more in the line, we have
17425 to remove some glyphs. */
17426 if (it
.current_x
> it
.last_visible_x
)
17428 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17433 set_buffer_temp (old
);
17434 return it
.glyph_row
;
17438 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17439 glyphs are only inserted for terminal frames since we can't really
17440 win with truncation glyphs when partially visible glyphs are
17441 involved. Which glyphs to insert is determined by
17442 produce_special_glyphs. */
17445 insert_left_trunc_glyphs (struct it
*it
)
17447 struct it truncate_it
;
17448 struct glyph
*from
, *end
, *to
, *toend
;
17450 xassert (!FRAME_WINDOW_P (it
->f
));
17452 /* Get the truncation glyphs. */
17454 truncate_it
.current_x
= 0;
17455 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17456 truncate_it
.glyph_row
= &scratch_glyph_row
;
17457 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17458 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17459 truncate_it
.object
= make_number (0);
17460 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17462 /* Overwrite glyphs from IT with truncation glyphs. */
17463 if (!it
->glyph_row
->reversed_p
)
17465 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17466 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17467 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17468 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17473 /* There may be padding glyphs left over. Overwrite them too. */
17474 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17476 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17482 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17486 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17487 that back to front. */
17488 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17489 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17490 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17491 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17493 while (from
>= end
&& to
>= toend
)
17495 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17498 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17499 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17500 while (from
>= end
&& to
>= toend
)
17505 /* Need to free some room before prepending additional
17507 int move_by
= from
- end
+ 1;
17508 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17509 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17511 for ( ; g
>= g0
; g
--)
17513 while (from
>= end
)
17515 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17521 /* Compute the pixel height and width of IT->glyph_row.
17523 Most of the time, ascent and height of a display line will be equal
17524 to the max_ascent and max_height values of the display iterator
17525 structure. This is not the case if
17527 1. We hit ZV without displaying anything. In this case, max_ascent
17528 and max_height will be zero.
17530 2. We have some glyphs that don't contribute to the line height.
17531 (The glyph row flag contributes_to_line_height_p is for future
17532 pixmap extensions).
17534 The first case is easily covered by using default values because in
17535 these cases, the line height does not really matter, except that it
17536 must not be zero. */
17539 compute_line_metrics (struct it
*it
)
17541 struct glyph_row
*row
= it
->glyph_row
;
17543 if (FRAME_WINDOW_P (it
->f
))
17545 int i
, min_y
, max_y
;
17547 /* The line may consist of one space only, that was added to
17548 place the cursor on it. If so, the row's height hasn't been
17550 if (row
->height
== 0)
17552 if (it
->max_ascent
+ it
->max_descent
== 0)
17553 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17554 row
->ascent
= it
->max_ascent
;
17555 row
->height
= it
->max_ascent
+ it
->max_descent
;
17556 row
->phys_ascent
= it
->max_phys_ascent
;
17557 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17558 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17561 /* Compute the width of this line. */
17562 row
->pixel_width
= row
->x
;
17563 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17564 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17566 xassert (row
->pixel_width
>= 0);
17567 xassert (row
->ascent
>= 0 && row
->height
> 0);
17569 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17570 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17572 /* If first line's physical ascent is larger than its logical
17573 ascent, use the physical ascent, and make the row taller.
17574 This makes accented characters fully visible. */
17575 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17576 && row
->phys_ascent
> row
->ascent
)
17578 row
->height
+= row
->phys_ascent
- row
->ascent
;
17579 row
->ascent
= row
->phys_ascent
;
17582 /* Compute how much of the line is visible. */
17583 row
->visible_height
= row
->height
;
17585 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17586 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17588 if (row
->y
< min_y
)
17589 row
->visible_height
-= min_y
- row
->y
;
17590 if (row
->y
+ row
->height
> max_y
)
17591 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17595 row
->pixel_width
= row
->used
[TEXT_AREA
];
17596 if (row
->continued_p
)
17597 row
->pixel_width
-= it
->continuation_pixel_width
;
17598 else if (row
->truncated_on_right_p
)
17599 row
->pixel_width
-= it
->truncation_pixel_width
;
17600 row
->ascent
= row
->phys_ascent
= 0;
17601 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17602 row
->extra_line_spacing
= 0;
17605 /* Compute a hash code for this row. */
17609 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17610 for (i
= 0; i
< row
->used
[area
]; ++i
)
17611 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17612 + row
->glyphs
[area
][i
].u
.val
17613 + row
->glyphs
[area
][i
].face_id
17614 + row
->glyphs
[area
][i
].padding_p
17615 + (row
->glyphs
[area
][i
].type
<< 2));
17618 it
->max_ascent
= it
->max_descent
= 0;
17619 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17623 /* Append one space to the glyph row of iterator IT if doing a
17624 window-based redisplay. The space has the same face as
17625 IT->face_id. Value is non-zero if a space was added.
17627 This function is called to make sure that there is always one glyph
17628 at the end of a glyph row that the cursor can be set on under
17629 window-systems. (If there weren't such a glyph we would not know
17630 how wide and tall a box cursor should be displayed).
17632 At the same time this space let's a nicely handle clearing to the
17633 end of the line if the row ends in italic text. */
17636 append_space_for_newline (struct it
*it
, int default_face_p
)
17638 if (FRAME_WINDOW_P (it
->f
))
17640 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17642 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17643 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17645 /* Save some values that must not be changed.
17646 Must save IT->c and IT->len because otherwise
17647 ITERATOR_AT_END_P wouldn't work anymore after
17648 append_space_for_newline has been called. */
17649 enum display_element_type saved_what
= it
->what
;
17650 int saved_c
= it
->c
, saved_len
= it
->len
;
17651 int saved_char_to_display
= it
->char_to_display
;
17652 int saved_x
= it
->current_x
;
17653 int saved_face_id
= it
->face_id
;
17654 struct text_pos saved_pos
;
17655 Lisp_Object saved_object
;
17658 saved_object
= it
->object
;
17659 saved_pos
= it
->position
;
17661 it
->what
= IT_CHARACTER
;
17662 memset (&it
->position
, 0, sizeof it
->position
);
17663 it
->object
= make_number (0);
17664 it
->c
= it
->char_to_display
= ' ';
17667 if (default_face_p
)
17668 it
->face_id
= DEFAULT_FACE_ID
;
17669 else if (it
->face_before_selective_p
)
17670 it
->face_id
= it
->saved_face_id
;
17671 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17672 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17674 PRODUCE_GLYPHS (it
);
17676 it
->override_ascent
= -1;
17677 it
->constrain_row_ascent_descent_p
= 0;
17678 it
->current_x
= saved_x
;
17679 it
->object
= saved_object
;
17680 it
->position
= saved_pos
;
17681 it
->what
= saved_what
;
17682 it
->face_id
= saved_face_id
;
17683 it
->len
= saved_len
;
17685 it
->char_to_display
= saved_char_to_display
;
17694 /* Extend the face of the last glyph in the text area of IT->glyph_row
17695 to the end of the display line. Called from display_line. If the
17696 glyph row is empty, add a space glyph to it so that we know the
17697 face to draw. Set the glyph row flag fill_line_p. If the glyph
17698 row is R2L, prepend a stretch glyph to cover the empty space to the
17699 left of the leftmost glyph. */
17702 extend_face_to_end_of_line (struct it
*it
)
17705 struct frame
*f
= it
->f
;
17707 /* If line is already filled, do nothing. Non window-system frames
17708 get a grace of one more ``pixel'' because their characters are
17709 1-``pixel'' wide, so they hit the equality too early. This grace
17710 is needed only for R2L rows that are not continued, to produce
17711 one extra blank where we could display the cursor. */
17712 if (it
->current_x
>= it
->last_visible_x
17713 + (!FRAME_WINDOW_P (f
)
17714 && it
->glyph_row
->reversed_p
17715 && !it
->glyph_row
->continued_p
))
17718 /* Face extension extends the background and box of IT->face_id
17719 to the end of the line. If the background equals the background
17720 of the frame, we don't have to do anything. */
17721 if (it
->face_before_selective_p
)
17722 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17724 face
= FACE_FROM_ID (f
, it
->face_id
);
17726 if (FRAME_WINDOW_P (f
)
17727 && it
->glyph_row
->displays_text_p
17728 && face
->box
== FACE_NO_BOX
17729 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17731 && !it
->glyph_row
->reversed_p
)
17734 /* Set the glyph row flag indicating that the face of the last glyph
17735 in the text area has to be drawn to the end of the text area. */
17736 it
->glyph_row
->fill_line_p
= 1;
17738 /* If current character of IT is not ASCII, make sure we have the
17739 ASCII face. This will be automatically undone the next time
17740 get_next_display_element returns a multibyte character. Note
17741 that the character will always be single byte in unibyte
17743 if (!ASCII_CHAR_P (it
->c
))
17745 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17748 if (FRAME_WINDOW_P (f
))
17750 /* If the row is empty, add a space with the current face of IT,
17751 so that we know which face to draw. */
17752 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17754 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17755 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17756 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17758 #ifdef HAVE_WINDOW_SYSTEM
17759 if (it
->glyph_row
->reversed_p
)
17761 /* Prepend a stretch glyph to the row, such that the
17762 rightmost glyph will be drawn flushed all the way to the
17763 right margin of the window. The stretch glyph that will
17764 occupy the empty space, if any, to the left of the
17766 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17767 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17768 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17770 int row_width
, stretch_ascent
, stretch_width
;
17771 struct text_pos saved_pos
;
17772 int saved_face_id
, saved_avoid_cursor
;
17774 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17775 row_width
+= g
->pixel_width
;
17776 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17777 if (stretch_width
> 0)
17780 (((it
->ascent
+ it
->descent
)
17781 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17782 saved_pos
= it
->position
;
17783 memset (&it
->position
, 0, sizeof it
->position
);
17784 saved_avoid_cursor
= it
->avoid_cursor_p
;
17785 it
->avoid_cursor_p
= 1;
17786 saved_face_id
= it
->face_id
;
17787 /* The last row's stretch glyph should get the default
17788 face, to avoid painting the rest of the window with
17789 the region face, if the region ends at ZV. */
17790 if (it
->glyph_row
->ends_at_zv_p
)
17791 it
->face_id
= DEFAULT_FACE_ID
;
17793 it
->face_id
= face
->id
;
17794 append_stretch_glyph (it
, make_number (0), stretch_width
,
17795 it
->ascent
+ it
->descent
, stretch_ascent
);
17796 it
->position
= saved_pos
;
17797 it
->avoid_cursor_p
= saved_avoid_cursor
;
17798 it
->face_id
= saved_face_id
;
17801 #endif /* HAVE_WINDOW_SYSTEM */
17805 /* Save some values that must not be changed. */
17806 int saved_x
= it
->current_x
;
17807 struct text_pos saved_pos
;
17808 Lisp_Object saved_object
;
17809 enum display_element_type saved_what
= it
->what
;
17810 int saved_face_id
= it
->face_id
;
17812 saved_object
= it
->object
;
17813 saved_pos
= it
->position
;
17815 it
->what
= IT_CHARACTER
;
17816 memset (&it
->position
, 0, sizeof it
->position
);
17817 it
->object
= make_number (0);
17818 it
->c
= it
->char_to_display
= ' ';
17820 /* The last row's blank glyphs should get the default face, to
17821 avoid painting the rest of the window with the region face,
17822 if the region ends at ZV. */
17823 if (it
->glyph_row
->ends_at_zv_p
)
17824 it
->face_id
= DEFAULT_FACE_ID
;
17826 it
->face_id
= face
->id
;
17828 PRODUCE_GLYPHS (it
);
17830 while (it
->current_x
<= it
->last_visible_x
)
17831 PRODUCE_GLYPHS (it
);
17833 /* Don't count these blanks really. It would let us insert a left
17834 truncation glyph below and make us set the cursor on them, maybe. */
17835 it
->current_x
= saved_x
;
17836 it
->object
= saved_object
;
17837 it
->position
= saved_pos
;
17838 it
->what
= saved_what
;
17839 it
->face_id
= saved_face_id
;
17844 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17845 trailing whitespace. */
17848 trailing_whitespace_p (EMACS_INT charpos
)
17850 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17853 while (bytepos
< ZV_BYTE
17854 && (c
= FETCH_CHAR (bytepos
),
17855 c
== ' ' || c
== '\t'))
17858 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17860 if (bytepos
!= PT_BYTE
)
17867 /* Highlight trailing whitespace, if any, in ROW. */
17870 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17872 int used
= row
->used
[TEXT_AREA
];
17876 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17877 struct glyph
*glyph
= start
+ used
- 1;
17879 if (row
->reversed_p
)
17881 /* Right-to-left rows need to be processed in the opposite
17882 direction, so swap the edge pointers. */
17884 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17887 /* Skip over glyphs inserted to display the cursor at the
17888 end of a line, for extending the face of the last glyph
17889 to the end of the line on terminals, and for truncation
17890 and continuation glyphs. */
17891 if (!row
->reversed_p
)
17893 while (glyph
>= start
17894 && glyph
->type
== CHAR_GLYPH
17895 && INTEGERP (glyph
->object
))
17900 while (glyph
<= start
17901 && glyph
->type
== CHAR_GLYPH
17902 && INTEGERP (glyph
->object
))
17906 /* If last glyph is a space or stretch, and it's trailing
17907 whitespace, set the face of all trailing whitespace glyphs in
17908 IT->glyph_row to `trailing-whitespace'. */
17909 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17910 && BUFFERP (glyph
->object
)
17911 && (glyph
->type
== STRETCH_GLYPH
17912 || (glyph
->type
== CHAR_GLYPH
17913 && glyph
->u
.ch
== ' '))
17914 && trailing_whitespace_p (glyph
->charpos
))
17916 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17920 if (!row
->reversed_p
)
17922 while (glyph
>= start
17923 && BUFFERP (glyph
->object
)
17924 && (glyph
->type
== STRETCH_GLYPH
17925 || (glyph
->type
== CHAR_GLYPH
17926 && glyph
->u
.ch
== ' ')))
17927 (glyph
--)->face_id
= face_id
;
17931 while (glyph
<= start
17932 && BUFFERP (glyph
->object
)
17933 && (glyph
->type
== STRETCH_GLYPH
17934 || (glyph
->type
== CHAR_GLYPH
17935 && glyph
->u
.ch
== ' ')))
17936 (glyph
++)->face_id
= face_id
;
17943 /* Value is non-zero if glyph row ROW should be
17944 used to hold the cursor. */
17947 cursor_row_p (struct glyph_row
*row
)
17951 if (PT
== CHARPOS (row
->end
.pos
))
17953 /* Suppose the row ends on a string.
17954 Unless the row is continued, that means it ends on a newline
17955 in the string. If it's anything other than a display string
17956 (e.g. a before-string from an overlay), we don't want the
17957 cursor there. (This heuristic seems to give the optimal
17958 behavior for the various types of multi-line strings.) */
17959 if (CHARPOS (row
->end
.string_pos
) >= 0)
17961 if (row
->continued_p
)
17965 /* Check for `display' property. */
17966 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17967 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17968 struct glyph
*glyph
;
17971 for (glyph
= end
; glyph
>= beg
; --glyph
)
17972 if (STRINGP (glyph
->object
))
17975 = Fget_char_property (make_number (PT
),
17979 && display_prop_string_p (prop
, glyph
->object
));
17984 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17986 /* If the row ends in middle of a real character,
17987 and the line is continued, we want the cursor here.
17988 That's because CHARPOS (ROW->end.pos) would equal
17989 PT if PT is before the character. */
17990 if (!row
->ends_in_ellipsis_p
)
17991 result
= row
->continued_p
;
17993 /* If the row ends in an ellipsis, then
17994 CHARPOS (ROW->end.pos) will equal point after the
17995 invisible text. We want that position to be displayed
17996 after the ellipsis. */
17999 /* If the row ends at ZV, display the cursor at the end of that
18000 row instead of at the start of the row below. */
18001 else if (row
->ends_at_zv_p
)
18012 /* Push the display property PROP so that it will be rendered at the
18013 current position in IT. Return 1 if PROP was successfully pushed,
18017 push_display_prop (struct it
*it
, Lisp_Object prop
)
18019 xassert (it
->method
== GET_FROM_BUFFER
);
18021 push_it (it
, NULL
);
18023 if (STRINGP (prop
))
18025 if (SCHARS (prop
) == 0)
18032 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18033 it
->current
.overlay_string_index
= -1;
18034 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18035 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18036 it
->method
= GET_FROM_STRING
;
18037 it
->stop_charpos
= 0;
18039 it
->base_level_stop
= 0;
18040 it
->string_from_display_prop_p
= 1;
18041 it
->from_disp_prop_p
= 1;
18043 /* Force paragraph direction to be that of the parent
18045 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18046 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18048 it
->paragraph_embedding
= L2R
;
18050 /* Set up the bidi iterator for this display string. */
18053 it
->bidi_it
.string
.lstring
= it
->string
;
18054 it
->bidi_it
.string
.s
= NULL
;
18055 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18056 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18057 it
->bidi_it
.string
.from_disp_str
= 1;
18058 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18059 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18062 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18064 it
->method
= GET_FROM_STRETCH
;
18067 #ifdef HAVE_WINDOW_SYSTEM
18068 else if (IMAGEP (prop
))
18070 it
->what
= IT_IMAGE
;
18071 it
->image_id
= lookup_image (it
->f
, prop
);
18072 it
->method
= GET_FROM_IMAGE
;
18074 #endif /* HAVE_WINDOW_SYSTEM */
18077 pop_it (it
); /* bogus display property, give up */
18084 /* Return the character-property PROP at the current position in IT. */
18087 get_it_property (struct it
*it
, Lisp_Object prop
)
18089 Lisp_Object position
;
18091 if (STRINGP (it
->object
))
18092 position
= make_number (IT_STRING_CHARPOS (*it
));
18093 else if (BUFFERP (it
->object
))
18094 position
= make_number (IT_CHARPOS (*it
));
18098 return Fget_char_property (position
, prop
, it
->object
);
18101 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18104 handle_line_prefix (struct it
*it
)
18106 Lisp_Object prefix
;
18108 if (it
->continuation_lines_width
> 0)
18110 prefix
= get_it_property (it
, Qwrap_prefix
);
18112 prefix
= Vwrap_prefix
;
18116 prefix
= get_it_property (it
, Qline_prefix
);
18118 prefix
= Vline_prefix
;
18120 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18122 /* If the prefix is wider than the window, and we try to wrap
18123 it, it would acquire its own wrap prefix, and so on till the
18124 iterator stack overflows. So, don't wrap the prefix. */
18125 it
->line_wrap
= TRUNCATE
;
18126 it
->avoid_cursor_p
= 1;
18132 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18133 only for R2L lines from display_line and display_string, when they
18134 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18135 the line/string needs to be continued on the next glyph row. */
18137 unproduce_glyphs (struct it
*it
, int n
)
18139 struct glyph
*glyph
, *end
;
18141 xassert (it
->glyph_row
);
18142 xassert (it
->glyph_row
->reversed_p
);
18143 xassert (it
->area
== TEXT_AREA
);
18144 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18146 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18147 n
= it
->glyph_row
->used
[TEXT_AREA
];
18148 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18149 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18150 for ( ; glyph
< end
; glyph
++)
18151 glyph
[-n
] = *glyph
;
18154 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18155 and ROW->maxpos. */
18157 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18158 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18159 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18161 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18162 lines' rows is implemented for bidi-reordered rows. */
18164 /* ROW->minpos is the value of min_pos, the minimal buffer position
18165 we have in ROW, or ROW->start.pos if that is smaller. */
18166 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18167 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18169 /* We didn't find buffer positions smaller than ROW->start, or
18170 didn't find _any_ valid buffer positions in any of the glyphs,
18171 so we must trust the iterator's computed positions. */
18172 row
->minpos
= row
->start
.pos
;
18175 max_pos
= CHARPOS (it
->current
.pos
);
18176 max_bpos
= BYTEPOS (it
->current
.pos
);
18179 /* Here are the various use-cases for ending the row, and the
18180 corresponding values for ROW->maxpos:
18182 Line ends in a newline from buffer eol_pos + 1
18183 Line is continued from buffer max_pos + 1
18184 Line is truncated on right it->current.pos
18185 Line ends in a newline from string max_pos
18186 Line is continued from string max_pos
18187 Line is continued from display vector max_pos
18188 Line is entirely from a string min_pos == max_pos
18189 Line is entirely from a display vector min_pos == max_pos
18190 Line that ends at ZV ZV
18192 If you discover other use-cases, please add them here as
18194 if (row
->ends_at_zv_p
)
18195 row
->maxpos
= it
->current
.pos
;
18196 else if (row
->used
[TEXT_AREA
])
18198 if (row
->ends_in_newline_from_string_p
)
18199 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18200 else if (CHARPOS (it
->eol_pos
) > 0)
18201 SET_TEXT_POS (row
->maxpos
,
18202 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18203 else if (row
->continued_p
)
18205 /* If max_pos is different from IT's current position, it
18206 means IT->method does not belong to the display element
18207 at max_pos. However, it also means that the display
18208 element at max_pos was displayed in its entirety on this
18209 line, which is equivalent to saying that the next line
18210 starts at the next buffer position. */
18211 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18212 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18215 INC_BOTH (max_pos
, max_bpos
);
18216 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18219 else if (row
->truncated_on_right_p
)
18220 /* display_line already called reseat_at_next_visible_line_start,
18221 which puts the iterator at the beginning of the next line, in
18222 the logical order. */
18223 row
->maxpos
= it
->current
.pos
;
18224 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18225 /* A line that is entirely from a string/image/stretch... */
18226 row
->maxpos
= row
->minpos
;
18231 row
->maxpos
= it
->current
.pos
;
18234 /* Construct the glyph row IT->glyph_row in the desired matrix of
18235 IT->w from text at the current position of IT. See dispextern.h
18236 for an overview of struct it. Value is non-zero if
18237 IT->glyph_row displays text, as opposed to a line displaying ZV
18241 display_line (struct it
*it
)
18243 struct glyph_row
*row
= it
->glyph_row
;
18244 Lisp_Object overlay_arrow_string
;
18246 void *wrap_data
= NULL
;
18247 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18248 int wrap_row_used
= -1;
18249 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18250 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18251 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18252 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18253 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18255 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18256 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18258 /* We always start displaying at hpos zero even if hscrolled. */
18259 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18261 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18262 >= it
->w
->desired_matrix
->nrows
)
18264 it
->w
->nrows_scale_factor
++;
18265 fonts_changed_p
= 1;
18269 /* Is IT->w showing the region? */
18270 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18272 /* Clear the result glyph row and enable it. */
18273 prepare_desired_row (row
);
18275 row
->y
= it
->current_y
;
18276 row
->start
= it
->start
;
18277 row
->continuation_lines_width
= it
->continuation_lines_width
;
18278 row
->displays_text_p
= 1;
18279 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18280 it
->starts_in_middle_of_char_p
= 0;
18282 /* Arrange the overlays nicely for our purposes. Usually, we call
18283 display_line on only one line at a time, in which case this
18284 can't really hurt too much, or we call it on lines which appear
18285 one after another in the buffer, in which case all calls to
18286 recenter_overlay_lists but the first will be pretty cheap. */
18287 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18289 /* Move over display elements that are not visible because we are
18290 hscrolled. This may stop at an x-position < IT->first_visible_x
18291 if the first glyph is partially visible or if we hit a line end. */
18292 if (it
->current_x
< it
->first_visible_x
)
18294 this_line_min_pos
= row
->start
.pos
;
18295 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18296 MOVE_TO_POS
| MOVE_TO_X
);
18297 /* Record the smallest positions seen while we moved over
18298 display elements that are not visible. This is needed by
18299 redisplay_internal for optimizing the case where the cursor
18300 stays inside the same line. The rest of this function only
18301 considers positions that are actually displayed, so
18302 RECORD_MAX_MIN_POS will not otherwise record positions that
18303 are hscrolled to the left of the left edge of the window. */
18304 min_pos
= CHARPOS (this_line_min_pos
);
18305 min_bpos
= BYTEPOS (this_line_min_pos
);
18309 /* We only do this when not calling `move_it_in_display_line_to'
18310 above, because move_it_in_display_line_to calls
18311 handle_line_prefix itself. */
18312 handle_line_prefix (it
);
18315 /* Get the initial row height. This is either the height of the
18316 text hscrolled, if there is any, or zero. */
18317 row
->ascent
= it
->max_ascent
;
18318 row
->height
= it
->max_ascent
+ it
->max_descent
;
18319 row
->phys_ascent
= it
->max_phys_ascent
;
18320 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18321 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18323 /* Utility macro to record max and min buffer positions seen until now. */
18324 #define RECORD_MAX_MIN_POS(IT) \
18327 if (IT_CHARPOS (*(IT)) < min_pos) \
18329 min_pos = IT_CHARPOS (*(IT)); \
18330 min_bpos = IT_BYTEPOS (*(IT)); \
18332 if (IT_CHARPOS (*(IT)) > max_pos) \
18334 max_pos = IT_CHARPOS (*(IT)); \
18335 max_bpos = IT_BYTEPOS (*(IT)); \
18340 /* Loop generating characters. The loop is left with IT on the next
18341 character to display. */
18344 int n_glyphs_before
, hpos_before
, x_before
;
18346 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18348 /* Retrieve the next thing to display. Value is zero if end of
18350 if (!get_next_display_element (it
))
18352 /* Maybe add a space at the end of this line that is used to
18353 display the cursor there under X. Set the charpos of the
18354 first glyph of blank lines not corresponding to any text
18356 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18357 row
->exact_window_width_line_p
= 1;
18358 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18359 || row
->used
[TEXT_AREA
] == 0)
18361 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18362 row
->displays_text_p
= 0;
18364 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18365 && (!MINI_WINDOW_P (it
->w
)
18366 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18367 row
->indicate_empty_line_p
= 1;
18370 it
->continuation_lines_width
= 0;
18371 row
->ends_at_zv_p
= 1;
18372 /* A row that displays right-to-left text must always have
18373 its last face extended all the way to the end of line,
18374 even if this row ends in ZV, because we still write to
18375 the screen left to right. */
18376 if (row
->reversed_p
)
18377 extend_face_to_end_of_line (it
);
18381 /* Now, get the metrics of what we want to display. This also
18382 generates glyphs in `row' (which is IT->glyph_row). */
18383 n_glyphs_before
= row
->used
[TEXT_AREA
];
18386 /* Remember the line height so far in case the next element doesn't
18387 fit on the line. */
18388 if (it
->line_wrap
!= TRUNCATE
)
18390 ascent
= it
->max_ascent
;
18391 descent
= it
->max_descent
;
18392 phys_ascent
= it
->max_phys_ascent
;
18393 phys_descent
= it
->max_phys_descent
;
18395 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18397 if (IT_DISPLAYING_WHITESPACE (it
))
18401 SAVE_IT (wrap_it
, *it
, wrap_data
);
18403 wrap_row_used
= row
->used
[TEXT_AREA
];
18404 wrap_row_ascent
= row
->ascent
;
18405 wrap_row_height
= row
->height
;
18406 wrap_row_phys_ascent
= row
->phys_ascent
;
18407 wrap_row_phys_height
= row
->phys_height
;
18408 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18409 wrap_row_min_pos
= min_pos
;
18410 wrap_row_min_bpos
= min_bpos
;
18411 wrap_row_max_pos
= max_pos
;
18412 wrap_row_max_bpos
= max_bpos
;
18418 PRODUCE_GLYPHS (it
);
18420 /* If this display element was in marginal areas, continue with
18422 if (it
->area
!= TEXT_AREA
)
18424 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18425 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18426 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18427 row
->phys_height
= max (row
->phys_height
,
18428 it
->max_phys_ascent
+ it
->max_phys_descent
);
18429 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18430 it
->max_extra_line_spacing
);
18431 set_iterator_to_next (it
, 1);
18435 /* Does the display element fit on the line? If we truncate
18436 lines, we should draw past the right edge of the window. If
18437 we don't truncate, we want to stop so that we can display the
18438 continuation glyph before the right margin. If lines are
18439 continued, there are two possible strategies for characters
18440 resulting in more than 1 glyph (e.g. tabs): Display as many
18441 glyphs as possible in this line and leave the rest for the
18442 continuation line, or display the whole element in the next
18443 line. Original redisplay did the former, so we do it also. */
18444 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18445 hpos_before
= it
->hpos
;
18448 if (/* Not a newline. */
18450 /* Glyphs produced fit entirely in the line. */
18451 && it
->current_x
< it
->last_visible_x
)
18453 it
->hpos
+= nglyphs
;
18454 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18455 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18456 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18457 row
->phys_height
= max (row
->phys_height
,
18458 it
->max_phys_ascent
+ it
->max_phys_descent
);
18459 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18460 it
->max_extra_line_spacing
);
18461 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18462 row
->x
= x
- it
->first_visible_x
;
18463 /* Record the maximum and minimum buffer positions seen so
18464 far in glyphs that will be displayed by this row. */
18466 RECORD_MAX_MIN_POS (it
);
18471 struct glyph
*glyph
;
18473 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18475 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18476 new_x
= x
+ glyph
->pixel_width
;
18478 if (/* Lines are continued. */
18479 it
->line_wrap
!= TRUNCATE
18480 && (/* Glyph doesn't fit on the line. */
18481 new_x
> it
->last_visible_x
18482 /* Or it fits exactly on a window system frame. */
18483 || (new_x
== it
->last_visible_x
18484 && FRAME_WINDOW_P (it
->f
))))
18486 /* End of a continued line. */
18489 || (new_x
== it
->last_visible_x
18490 && FRAME_WINDOW_P (it
->f
)))
18492 /* Current glyph is the only one on the line or
18493 fits exactly on the line. We must continue
18494 the line because we can't draw the cursor
18495 after the glyph. */
18496 row
->continued_p
= 1;
18497 it
->current_x
= new_x
;
18498 it
->continuation_lines_width
+= new_x
;
18500 /* Record the maximum and minimum buffer
18501 positions seen so far in glyphs that will be
18502 displayed by this row. */
18504 RECORD_MAX_MIN_POS (it
);
18505 if (i
== nglyphs
- 1)
18507 /* If line-wrap is on, check if a previous
18508 wrap point was found. */
18509 if (wrap_row_used
> 0
18510 /* Even if there is a previous wrap
18511 point, continue the line here as
18512 usual, if (i) the previous character
18513 was a space or tab AND (ii) the
18514 current character is not. */
18516 || IT_DISPLAYING_WHITESPACE (it
)))
18519 set_iterator_to_next (it
, 1);
18520 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18522 if (!get_next_display_element (it
))
18524 row
->exact_window_width_line_p
= 1;
18525 it
->continuation_lines_width
= 0;
18526 row
->continued_p
= 0;
18527 row
->ends_at_zv_p
= 1;
18529 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18531 row
->continued_p
= 0;
18532 row
->exact_window_width_line_p
= 1;
18537 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18538 && !FRAME_WINDOW_P (it
->f
))
18540 /* A padding glyph that doesn't fit on this line.
18541 This means the whole character doesn't fit
18543 if (row
->reversed_p
)
18544 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18545 - n_glyphs_before
);
18546 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18548 /* Fill the rest of the row with continuation
18549 glyphs like in 20.x. */
18550 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18551 < row
->glyphs
[1 + TEXT_AREA
])
18552 produce_special_glyphs (it
, IT_CONTINUATION
);
18554 row
->continued_p
= 1;
18555 it
->current_x
= x_before
;
18556 it
->continuation_lines_width
+= x_before
;
18558 /* Restore the height to what it was before the
18559 element not fitting on the line. */
18560 it
->max_ascent
= ascent
;
18561 it
->max_descent
= descent
;
18562 it
->max_phys_ascent
= phys_ascent
;
18563 it
->max_phys_descent
= phys_descent
;
18565 else if (wrap_row_used
> 0)
18568 if (row
->reversed_p
)
18569 unproduce_glyphs (it
,
18570 row
->used
[TEXT_AREA
] - wrap_row_used
);
18571 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18572 it
->continuation_lines_width
+= wrap_x
;
18573 row
->used
[TEXT_AREA
] = wrap_row_used
;
18574 row
->ascent
= wrap_row_ascent
;
18575 row
->height
= wrap_row_height
;
18576 row
->phys_ascent
= wrap_row_phys_ascent
;
18577 row
->phys_height
= wrap_row_phys_height
;
18578 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18579 min_pos
= wrap_row_min_pos
;
18580 min_bpos
= wrap_row_min_bpos
;
18581 max_pos
= wrap_row_max_pos
;
18582 max_bpos
= wrap_row_max_bpos
;
18583 row
->continued_p
= 1;
18584 row
->ends_at_zv_p
= 0;
18585 row
->exact_window_width_line_p
= 0;
18586 it
->continuation_lines_width
+= x
;
18588 /* Make sure that a non-default face is extended
18589 up to the right margin of the window. */
18590 extend_face_to_end_of_line (it
);
18592 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18594 /* A TAB that extends past the right edge of the
18595 window. This produces a single glyph on
18596 window system frames. We leave the glyph in
18597 this row and let it fill the row, but don't
18598 consume the TAB. */
18599 it
->continuation_lines_width
+= it
->last_visible_x
;
18600 row
->ends_in_middle_of_char_p
= 1;
18601 row
->continued_p
= 1;
18602 glyph
->pixel_width
= it
->last_visible_x
- x
;
18603 it
->starts_in_middle_of_char_p
= 1;
18607 /* Something other than a TAB that draws past
18608 the right edge of the window. Restore
18609 positions to values before the element. */
18610 if (row
->reversed_p
)
18611 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18612 - (n_glyphs_before
+ i
));
18613 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18615 /* Display continuation glyphs. */
18616 if (!FRAME_WINDOW_P (it
->f
))
18617 produce_special_glyphs (it
, IT_CONTINUATION
);
18618 row
->continued_p
= 1;
18620 it
->current_x
= x_before
;
18621 it
->continuation_lines_width
+= x
;
18622 extend_face_to_end_of_line (it
);
18624 if (nglyphs
> 1 && i
> 0)
18626 row
->ends_in_middle_of_char_p
= 1;
18627 it
->starts_in_middle_of_char_p
= 1;
18630 /* Restore the height to what it was before the
18631 element not fitting on the line. */
18632 it
->max_ascent
= ascent
;
18633 it
->max_descent
= descent
;
18634 it
->max_phys_ascent
= phys_ascent
;
18635 it
->max_phys_descent
= phys_descent
;
18640 else if (new_x
> it
->first_visible_x
)
18642 /* Increment number of glyphs actually displayed. */
18645 /* Record the maximum and minimum buffer positions
18646 seen so far in glyphs that will be displayed by
18649 RECORD_MAX_MIN_POS (it
);
18651 if (x
< it
->first_visible_x
)
18652 /* Glyph is partially visible, i.e. row starts at
18653 negative X position. */
18654 row
->x
= x
- it
->first_visible_x
;
18658 /* Glyph is completely off the left margin of the
18659 window. This should not happen because of the
18660 move_it_in_display_line at the start of this
18661 function, unless the text display area of the
18662 window is empty. */
18663 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18667 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18668 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18669 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18670 row
->phys_height
= max (row
->phys_height
,
18671 it
->max_phys_ascent
+ it
->max_phys_descent
);
18672 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18673 it
->max_extra_line_spacing
);
18675 /* End of this display line if row is continued. */
18676 if (row
->continued_p
|| row
->ends_at_zv_p
)
18681 /* Is this a line end? If yes, we're also done, after making
18682 sure that a non-default face is extended up to the right
18683 margin of the window. */
18684 if (ITERATOR_AT_END_OF_LINE_P (it
))
18686 int used_before
= row
->used
[TEXT_AREA
];
18688 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18690 /* Add a space at the end of the line that is used to
18691 display the cursor there. */
18692 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18693 append_space_for_newline (it
, 0);
18695 /* Extend the face to the end of the line. */
18696 extend_face_to_end_of_line (it
);
18698 /* Make sure we have the position. */
18699 if (used_before
== 0)
18700 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18702 /* Record the position of the newline, for use in
18704 it
->eol_pos
= it
->current
.pos
;
18706 /* Consume the line end. This skips over invisible lines. */
18707 set_iterator_to_next (it
, 1);
18708 it
->continuation_lines_width
= 0;
18712 /* Proceed with next display element. Note that this skips
18713 over lines invisible because of selective display. */
18714 set_iterator_to_next (it
, 1);
18716 /* If we truncate lines, we are done when the last displayed
18717 glyphs reach past the right margin of the window. */
18718 if (it
->line_wrap
== TRUNCATE
18719 && (FRAME_WINDOW_P (it
->f
)
18720 ? (it
->current_x
>= it
->last_visible_x
)
18721 : (it
->current_x
> it
->last_visible_x
)))
18723 /* Maybe add truncation glyphs. */
18724 if (!FRAME_WINDOW_P (it
->f
))
18728 if (!row
->reversed_p
)
18730 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18731 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18736 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18737 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18739 /* Remove any padding glyphs at the front of ROW, to
18740 make room for the truncation glyphs we will be
18741 adding below. The loop below always inserts at
18742 least one truncation glyph, so also remove the
18743 last glyph added to ROW. */
18744 unproduce_glyphs (it
, i
+ 1);
18745 /* Adjust i for the loop below. */
18746 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18749 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18751 row
->used
[TEXT_AREA
] = i
;
18752 produce_special_glyphs (it
, IT_TRUNCATION
);
18755 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18757 /* Don't truncate if we can overflow newline into fringe. */
18758 if (!get_next_display_element (it
))
18760 it
->continuation_lines_width
= 0;
18761 row
->ends_at_zv_p
= 1;
18762 row
->exact_window_width_line_p
= 1;
18765 if (ITERATOR_AT_END_OF_LINE_P (it
))
18767 row
->exact_window_width_line_p
= 1;
18768 goto at_end_of_line
;
18772 row
->truncated_on_right_p
= 1;
18773 it
->continuation_lines_width
= 0;
18774 reseat_at_next_visible_line_start (it
, 0);
18775 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18776 it
->hpos
= hpos_before
;
18777 it
->current_x
= x_before
;
18782 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18783 at the left window margin. */
18784 if (it
->first_visible_x
18785 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18787 if (!FRAME_WINDOW_P (it
->f
))
18788 insert_left_trunc_glyphs (it
);
18789 row
->truncated_on_left_p
= 1;
18792 /* Remember the position at which this line ends.
18794 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18795 cannot be before the call to find_row_edges below, since that is
18796 where these positions are determined. */
18797 row
->end
= it
->current
;
18800 row
->minpos
= row
->start
.pos
;
18801 row
->maxpos
= row
->end
.pos
;
18805 /* ROW->minpos and ROW->maxpos must be the smallest and
18806 `1 + the largest' buffer positions in ROW. But if ROW was
18807 bidi-reordered, these two positions can be anywhere in the
18808 row, so we must determine them now. */
18809 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18812 /* If the start of this line is the overlay arrow-position, then
18813 mark this glyph row as the one containing the overlay arrow.
18814 This is clearly a mess with variable size fonts. It would be
18815 better to let it be displayed like cursors under X. */
18816 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18817 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18818 !NILP (overlay_arrow_string
)))
18820 /* Overlay arrow in window redisplay is a fringe bitmap. */
18821 if (STRINGP (overlay_arrow_string
))
18823 struct glyph_row
*arrow_row
18824 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18825 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18826 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18827 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18828 struct glyph
*p2
, *end
;
18830 /* Copy the arrow glyphs. */
18831 while (glyph
< arrow_end
)
18834 /* Throw away padding glyphs. */
18836 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18837 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18843 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18848 xassert (INTEGERP (overlay_arrow_string
));
18849 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18851 overlay_arrow_seen
= 1;
18854 /* Compute pixel dimensions of this line. */
18855 compute_line_metrics (it
);
18857 /* Record whether this row ends inside an ellipsis. */
18858 row
->ends_in_ellipsis_p
18859 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18860 && it
->ellipsis_p
);
18862 /* Save fringe bitmaps in this row. */
18863 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18864 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18865 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18866 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18868 it
->left_user_fringe_bitmap
= 0;
18869 it
->left_user_fringe_face_id
= 0;
18870 it
->right_user_fringe_bitmap
= 0;
18871 it
->right_user_fringe_face_id
= 0;
18873 /* Maybe set the cursor. */
18874 cvpos
= it
->w
->cursor
.vpos
;
18876 /* In bidi-reordered rows, keep checking for proper cursor
18877 position even if one has been found already, because buffer
18878 positions in such rows change non-linearly with ROW->VPOS,
18879 when a line is continued. One exception: when we are at ZV,
18880 display cursor on the first suitable glyph row, since all
18881 the empty rows after that also have their position set to ZV. */
18882 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18883 lines' rows is implemented for bidi-reordered rows. */
18885 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18886 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18887 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18888 && cursor_row_p (row
))
18889 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18891 /* Highlight trailing whitespace. */
18892 if (!NILP (Vshow_trailing_whitespace
))
18893 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18895 /* Prepare for the next line. This line starts horizontally at (X
18896 HPOS) = (0 0). Vertical positions are incremented. As a
18897 convenience for the caller, IT->glyph_row is set to the next
18899 it
->current_x
= it
->hpos
= 0;
18900 it
->current_y
+= row
->height
;
18901 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18904 /* The next row should by default use the same value of the
18905 reversed_p flag as this one. set_iterator_to_next decides when
18906 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18907 the flag accordingly. */
18908 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18909 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18910 it
->start
= row
->end
;
18911 return row
->displays_text_p
;
18913 #undef RECORD_MAX_MIN_POS
18916 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18917 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18918 doc
: /* Return paragraph direction at point in BUFFER.
18919 Value is either `left-to-right' or `right-to-left'.
18920 If BUFFER is omitted or nil, it defaults to the current buffer.
18922 Paragraph direction determines how the text in the paragraph is displayed.
18923 In left-to-right paragraphs, text begins at the left margin of the window
18924 and the reading direction is generally left to right. In right-to-left
18925 paragraphs, text begins at the right margin and is read from right to left.
18927 See also `bidi-paragraph-direction'. */)
18928 (Lisp_Object buffer
)
18930 struct buffer
*buf
= current_buffer
;
18931 struct buffer
*old
= buf
;
18933 if (! NILP (buffer
))
18935 CHECK_BUFFER (buffer
);
18936 buf
= XBUFFER (buffer
);
18939 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18940 return Qleft_to_right
;
18941 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18942 return BVAR (buf
, bidi_paragraph_direction
);
18945 /* Determine the direction from buffer text. We could try to
18946 use current_matrix if it is up to date, but this seems fast
18947 enough as it is. */
18948 struct bidi_it itb
;
18949 EMACS_INT pos
= BUF_PT (buf
);
18950 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18953 set_buffer_temp (buf
);
18954 /* bidi_paragraph_init finds the base direction of the paragraph
18955 by searching forward from paragraph start. We need the base
18956 direction of the current or _previous_ paragraph, so we need
18957 to make sure we are within that paragraph. To that end, find
18958 the previous non-empty line. */
18959 if (pos
>= ZV
&& pos
> BEGV
)
18962 bytepos
= CHAR_TO_BYTE (pos
);
18964 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18965 || c
== ' ' || c
== '\t' || c
== '\f')
18967 if (bytepos
<= BEGV_BYTE
)
18972 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18975 itb
.bytepos
= bytepos
;
18977 itb
.string
.s
= NULL
;
18978 itb
.string
.lstring
= Qnil
;
18979 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18981 itb
.separator_limit
= -1;
18982 itb
.paragraph_dir
= NEUTRAL_DIR
;
18984 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18985 set_buffer_temp (old
);
18986 switch (itb
.paragraph_dir
)
18989 return Qleft_to_right
;
18992 return Qright_to_left
;
19002 /***********************************************************************
19004 ***********************************************************************/
19006 /* Redisplay the menu bar in the frame for window W.
19008 The menu bar of X frames that don't have X toolkit support is
19009 displayed in a special window W->frame->menu_bar_window.
19011 The menu bar of terminal frames is treated specially as far as
19012 glyph matrices are concerned. Menu bar lines are not part of
19013 windows, so the update is done directly on the frame matrix rows
19014 for the menu bar. */
19017 display_menu_bar (struct window
*w
)
19019 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19024 /* Don't do all this for graphical frames. */
19026 if (FRAME_W32_P (f
))
19029 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19035 if (FRAME_NS_P (f
))
19037 #endif /* HAVE_NS */
19039 #ifdef USE_X_TOOLKIT
19040 xassert (!FRAME_WINDOW_P (f
));
19041 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19042 it
.first_visible_x
= 0;
19043 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19044 #else /* not USE_X_TOOLKIT */
19045 if (FRAME_WINDOW_P (f
))
19047 /* Menu bar lines are displayed in the desired matrix of the
19048 dummy window menu_bar_window. */
19049 struct window
*menu_w
;
19050 xassert (WINDOWP (f
->menu_bar_window
));
19051 menu_w
= XWINDOW (f
->menu_bar_window
);
19052 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19054 it
.first_visible_x
= 0;
19055 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19059 /* This is a TTY frame, i.e. character hpos/vpos are used as
19061 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19063 it
.first_visible_x
= 0;
19064 it
.last_visible_x
= FRAME_COLS (f
);
19066 #endif /* not USE_X_TOOLKIT */
19068 /* FIXME: This should be controlled by a user option. See the
19069 comments in redisplay_tool_bar and display_mode_line about
19071 it
.paragraph_embedding
= L2R
;
19073 if (! mode_line_inverse_video
)
19074 /* Force the menu-bar to be displayed in the default face. */
19075 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19077 /* Clear all rows of the menu bar. */
19078 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19080 struct glyph_row
*row
= it
.glyph_row
+ i
;
19081 clear_glyph_row (row
);
19082 row
->enabled_p
= 1;
19083 row
->full_width_p
= 1;
19086 /* Display all items of the menu bar. */
19087 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19088 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19090 Lisp_Object string
;
19092 /* Stop at nil string. */
19093 string
= AREF (items
, i
+ 1);
19097 /* Remember where item was displayed. */
19098 ASET (items
, i
+ 3, make_number (it
.hpos
));
19100 /* Display the item, pad with one space. */
19101 if (it
.current_x
< it
.last_visible_x
)
19102 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19103 SCHARS (string
) + 1, 0, 0, -1);
19106 /* Fill out the line with spaces. */
19107 if (it
.current_x
< it
.last_visible_x
)
19108 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19110 /* Compute the total height of the lines. */
19111 compute_line_metrics (&it
);
19116 /***********************************************************************
19118 ***********************************************************************/
19120 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19121 FORCE is non-zero, redisplay mode lines unconditionally.
19122 Otherwise, redisplay only mode lines that are garbaged. Value is
19123 the number of windows whose mode lines were redisplayed. */
19126 redisplay_mode_lines (Lisp_Object window
, int force
)
19130 while (!NILP (window
))
19132 struct window
*w
= XWINDOW (window
);
19134 if (WINDOWP (w
->hchild
))
19135 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19136 else if (WINDOWP (w
->vchild
))
19137 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19139 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19140 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19142 struct text_pos lpoint
;
19143 struct buffer
*old
= current_buffer
;
19145 /* Set the window's buffer for the mode line display. */
19146 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19147 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19149 /* Point refers normally to the selected window. For any
19150 other window, set up appropriate value. */
19151 if (!EQ (window
, selected_window
))
19153 struct text_pos pt
;
19155 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19156 if (CHARPOS (pt
) < BEGV
)
19157 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19158 else if (CHARPOS (pt
) > (ZV
- 1))
19159 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19161 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19164 /* Display mode lines. */
19165 clear_glyph_matrix (w
->desired_matrix
);
19166 if (display_mode_lines (w
))
19169 w
->must_be_updated_p
= 1;
19172 /* Restore old settings. */
19173 set_buffer_internal_1 (old
);
19174 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19184 /* Display the mode and/or header line of window W. Value is the
19185 sum number of mode lines and header lines displayed. */
19188 display_mode_lines (struct window
*w
)
19190 Lisp_Object old_selected_window
, old_selected_frame
;
19193 old_selected_frame
= selected_frame
;
19194 selected_frame
= w
->frame
;
19195 old_selected_window
= selected_window
;
19196 XSETWINDOW (selected_window
, w
);
19198 /* These will be set while the mode line specs are processed. */
19199 line_number_displayed
= 0;
19200 w
->column_number_displayed
= Qnil
;
19202 if (WINDOW_WANTS_MODELINE_P (w
))
19204 struct window
*sel_w
= XWINDOW (old_selected_window
);
19206 /* Select mode line face based on the real selected window. */
19207 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19208 BVAR (current_buffer
, mode_line_format
));
19212 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19214 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19215 BVAR (current_buffer
, header_line_format
));
19219 selected_frame
= old_selected_frame
;
19220 selected_window
= old_selected_window
;
19225 /* Display mode or header line of window W. FACE_ID specifies which
19226 line to display; it is either MODE_LINE_FACE_ID or
19227 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19228 display. Value is the pixel height of the mode/header line
19232 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19236 int count
= SPECPDL_INDEX ();
19238 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19239 /* Don't extend on a previously drawn mode-line.
19240 This may happen if called from pos_visible_p. */
19241 it
.glyph_row
->enabled_p
= 0;
19242 prepare_desired_row (it
.glyph_row
);
19244 it
.glyph_row
->mode_line_p
= 1;
19246 if (! mode_line_inverse_video
)
19247 /* Force the mode-line to be displayed in the default face. */
19248 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19250 /* FIXME: This should be controlled by a user option. But
19251 supporting such an option is not trivial, since the mode line is
19252 made up of many separate strings. */
19253 it
.paragraph_embedding
= L2R
;
19255 record_unwind_protect (unwind_format_mode_line
,
19256 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19258 mode_line_target
= MODE_LINE_DISPLAY
;
19260 /* Temporarily make frame's keyboard the current kboard so that
19261 kboard-local variables in the mode_line_format will get the right
19263 push_kboard (FRAME_KBOARD (it
.f
));
19264 record_unwind_save_match_data ();
19265 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19268 unbind_to (count
, Qnil
);
19270 /* Fill up with spaces. */
19271 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19273 compute_line_metrics (&it
);
19274 it
.glyph_row
->full_width_p
= 1;
19275 it
.glyph_row
->continued_p
= 0;
19276 it
.glyph_row
->truncated_on_left_p
= 0;
19277 it
.glyph_row
->truncated_on_right_p
= 0;
19279 /* Make a 3D mode-line have a shadow at its right end. */
19280 face
= FACE_FROM_ID (it
.f
, face_id
);
19281 extend_face_to_end_of_line (&it
);
19282 if (face
->box
!= FACE_NO_BOX
)
19284 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19285 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19286 last
->right_box_line_p
= 1;
19289 return it
.glyph_row
->height
;
19292 /* Move element ELT in LIST to the front of LIST.
19293 Return the updated list. */
19296 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19298 register Lisp_Object tail
, prev
;
19299 register Lisp_Object tem
;
19303 while (CONSP (tail
))
19309 /* Splice out the link TAIL. */
19311 list
= XCDR (tail
);
19313 Fsetcdr (prev
, XCDR (tail
));
19315 /* Now make it the first. */
19316 Fsetcdr (tail
, list
);
19321 tail
= XCDR (tail
);
19325 /* Not found--return unchanged LIST. */
19329 /* Contribute ELT to the mode line for window IT->w. How it
19330 translates into text depends on its data type.
19332 IT describes the display environment in which we display, as usual.
19334 DEPTH is the depth in recursion. It is used to prevent
19335 infinite recursion here.
19337 FIELD_WIDTH is the number of characters the display of ELT should
19338 occupy in the mode line, and PRECISION is the maximum number of
19339 characters to display from ELT's representation. See
19340 display_string for details.
19342 Returns the hpos of the end of the text generated by ELT.
19344 PROPS is a property list to add to any string we encounter.
19346 If RISKY is nonzero, remove (disregard) any properties in any string
19347 we encounter, and ignore :eval and :propertize.
19349 The global variable `mode_line_target' determines whether the
19350 output is passed to `store_mode_line_noprop',
19351 `store_mode_line_string', or `display_string'. */
19354 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19355 Lisp_Object elt
, Lisp_Object props
, int risky
)
19357 int n
= 0, field
, prec
;
19362 elt
= build_string ("*too-deep*");
19366 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19370 /* A string: output it and check for %-constructs within it. */
19372 EMACS_INT offset
= 0;
19374 if (SCHARS (elt
) > 0
19375 && (!NILP (props
) || risky
))
19377 Lisp_Object oprops
, aelt
;
19378 oprops
= Ftext_properties_at (make_number (0), elt
);
19380 /* If the starting string's properties are not what
19381 we want, translate the string. Also, if the string
19382 is risky, do that anyway. */
19384 if (NILP (Fequal (props
, oprops
)) || risky
)
19386 /* If the starting string has properties,
19387 merge the specified ones onto the existing ones. */
19388 if (! NILP (oprops
) && !risky
)
19392 oprops
= Fcopy_sequence (oprops
);
19394 while (CONSP (tem
))
19396 oprops
= Fplist_put (oprops
, XCAR (tem
),
19397 XCAR (XCDR (tem
)));
19398 tem
= XCDR (XCDR (tem
));
19403 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19404 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19406 /* AELT is what we want. Move it to the front
19407 without consing. */
19409 mode_line_proptrans_alist
19410 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19416 /* If AELT has the wrong props, it is useless.
19417 so get rid of it. */
19419 mode_line_proptrans_alist
19420 = Fdelq (aelt
, mode_line_proptrans_alist
);
19422 elt
= Fcopy_sequence (elt
);
19423 Fset_text_properties (make_number (0), Flength (elt
),
19425 /* Add this item to mode_line_proptrans_alist. */
19426 mode_line_proptrans_alist
19427 = Fcons (Fcons (elt
, props
),
19428 mode_line_proptrans_alist
);
19429 /* Truncate mode_line_proptrans_alist
19430 to at most 50 elements. */
19431 tem
= Fnthcdr (make_number (50),
19432 mode_line_proptrans_alist
);
19434 XSETCDR (tem
, Qnil
);
19443 prec
= precision
- n
;
19444 switch (mode_line_target
)
19446 case MODE_LINE_NOPROP
:
19447 case MODE_LINE_TITLE
:
19448 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19450 case MODE_LINE_STRING
:
19451 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19453 case MODE_LINE_DISPLAY
:
19454 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19455 0, prec
, 0, STRING_MULTIBYTE (elt
));
19462 /* Handle the non-literal case. */
19464 while ((precision
<= 0 || n
< precision
)
19465 && SREF (elt
, offset
) != 0
19466 && (mode_line_target
!= MODE_LINE_DISPLAY
19467 || it
->current_x
< it
->last_visible_x
))
19469 EMACS_INT last_offset
= offset
;
19471 /* Advance to end of string or next format specifier. */
19472 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19475 if (offset
- 1 != last_offset
)
19477 EMACS_INT nchars
, nbytes
;
19479 /* Output to end of string or up to '%'. Field width
19480 is length of string. Don't output more than
19481 PRECISION allows us. */
19484 prec
= c_string_width (SDATA (elt
) + last_offset
,
19485 offset
- last_offset
, precision
- n
,
19488 switch (mode_line_target
)
19490 case MODE_LINE_NOPROP
:
19491 case MODE_LINE_TITLE
:
19492 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19494 case MODE_LINE_STRING
:
19496 EMACS_INT bytepos
= last_offset
;
19497 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19498 EMACS_INT endpos
= (precision
<= 0
19499 ? string_byte_to_char (elt
, offset
)
19500 : charpos
+ nchars
);
19502 n
+= store_mode_line_string (NULL
,
19503 Fsubstring (elt
, make_number (charpos
),
19504 make_number (endpos
)),
19508 case MODE_LINE_DISPLAY
:
19510 EMACS_INT bytepos
= last_offset
;
19511 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19513 if (precision
<= 0)
19514 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19515 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19517 STRING_MULTIBYTE (elt
));
19522 else /* c == '%' */
19524 EMACS_INT percent_position
= offset
;
19526 /* Get the specified minimum width. Zero means
19529 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19530 field
= field
* 10 + c
- '0';
19532 /* Don't pad beyond the total padding allowed. */
19533 if (field_width
- n
> 0 && field
> field_width
- n
)
19534 field
= field_width
- n
;
19536 /* Note that either PRECISION <= 0 or N < PRECISION. */
19537 prec
= precision
- n
;
19540 n
+= display_mode_element (it
, depth
, field
, prec
,
19541 Vglobal_mode_string
, props
,
19546 EMACS_INT bytepos
, charpos
;
19548 Lisp_Object string
;
19550 bytepos
= percent_position
;
19551 charpos
= (STRING_MULTIBYTE (elt
)
19552 ? string_byte_to_char (elt
, bytepos
)
19554 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19555 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19557 switch (mode_line_target
)
19559 case MODE_LINE_NOPROP
:
19560 case MODE_LINE_TITLE
:
19561 n
+= store_mode_line_noprop (spec
, field
, prec
);
19563 case MODE_LINE_STRING
:
19565 Lisp_Object tem
= build_string (spec
);
19566 props
= Ftext_properties_at (make_number (charpos
), elt
);
19567 /* Should only keep face property in props */
19568 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19571 case MODE_LINE_DISPLAY
:
19573 int nglyphs_before
, nwritten
;
19575 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19576 nwritten
= display_string (spec
, string
, elt
,
19581 /* Assign to the glyphs written above the
19582 string where the `%x' came from, position
19586 struct glyph
*glyph
19587 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19591 for (i
= 0; i
< nwritten
; ++i
)
19593 glyph
[i
].object
= elt
;
19594 glyph
[i
].charpos
= charpos
;
19611 /* A symbol: process the value of the symbol recursively
19612 as if it appeared here directly. Avoid error if symbol void.
19613 Special case: if value of symbol is a string, output the string
19616 register Lisp_Object tem
;
19618 /* If the variable is not marked as risky to set
19619 then its contents are risky to use. */
19620 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19623 tem
= Fboundp (elt
);
19626 tem
= Fsymbol_value (elt
);
19627 /* If value is a string, output that string literally:
19628 don't check for % within it. */
19632 if (!EQ (tem
, elt
))
19634 /* Give up right away for nil or t. */
19644 register Lisp_Object car
, tem
;
19646 /* A cons cell: five distinct cases.
19647 If first element is :eval or :propertize, do something special.
19648 If first element is a string or a cons, process all the elements
19649 and effectively concatenate them.
19650 If first element is a negative number, truncate displaying cdr to
19651 at most that many characters. If positive, pad (with spaces)
19652 to at least that many characters.
19653 If first element is a symbol, process the cadr or caddr recursively
19654 according to whether the symbol's value is non-nil or nil. */
19656 if (EQ (car
, QCeval
))
19658 /* An element of the form (:eval FORM) means evaluate FORM
19659 and use the result as mode line elements. */
19664 if (CONSP (XCDR (elt
)))
19667 spec
= safe_eval (XCAR (XCDR (elt
)));
19668 n
+= display_mode_element (it
, depth
, field_width
- n
,
19669 precision
- n
, spec
, props
,
19673 else if (EQ (car
, QCpropertize
))
19675 /* An element of the form (:propertize ELT PROPS...)
19676 means display ELT but applying properties PROPS. */
19681 if (CONSP (XCDR (elt
)))
19682 n
+= display_mode_element (it
, depth
, field_width
- n
,
19683 precision
- n
, XCAR (XCDR (elt
)),
19684 XCDR (XCDR (elt
)), risky
);
19686 else if (SYMBOLP (car
))
19688 tem
= Fboundp (car
);
19692 /* elt is now the cdr, and we know it is a cons cell.
19693 Use its car if CAR has a non-nil value. */
19696 tem
= Fsymbol_value (car
);
19703 /* Symbol's value is nil (or symbol is unbound)
19704 Get the cddr of the original list
19705 and if possible find the caddr and use that. */
19709 else if (!CONSP (elt
))
19714 else if (INTEGERP (car
))
19716 register int lim
= XINT (car
);
19720 /* Negative int means reduce maximum width. */
19721 if (precision
<= 0)
19724 precision
= min (precision
, -lim
);
19728 /* Padding specified. Don't let it be more than
19729 current maximum. */
19731 lim
= min (precision
, lim
);
19733 /* If that's more padding than already wanted, queue it.
19734 But don't reduce padding already specified even if
19735 that is beyond the current truncation point. */
19736 field_width
= max (lim
, field_width
);
19740 else if (STRINGP (car
) || CONSP (car
))
19742 Lisp_Object halftail
= elt
;
19746 && (precision
<= 0 || n
< precision
))
19748 n
+= display_mode_element (it
, depth
,
19749 /* Do padding only after the last
19750 element in the list. */
19751 (! CONSP (XCDR (elt
))
19754 precision
- n
, XCAR (elt
),
19758 if ((len
& 1) == 0)
19759 halftail
= XCDR (halftail
);
19760 /* Check for cycle. */
19761 if (EQ (halftail
, elt
))
19770 elt
= build_string ("*invalid*");
19774 /* Pad to FIELD_WIDTH. */
19775 if (field_width
> 0 && n
< field_width
)
19777 switch (mode_line_target
)
19779 case MODE_LINE_NOPROP
:
19780 case MODE_LINE_TITLE
:
19781 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19783 case MODE_LINE_STRING
:
19784 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19786 case MODE_LINE_DISPLAY
:
19787 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19796 /* Store a mode-line string element in mode_line_string_list.
19798 If STRING is non-null, display that C string. Otherwise, the Lisp
19799 string LISP_STRING is displayed.
19801 FIELD_WIDTH is the minimum number of output glyphs to produce.
19802 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19803 with spaces. FIELD_WIDTH <= 0 means don't pad.
19805 PRECISION is the maximum number of characters to output from
19806 STRING. PRECISION <= 0 means don't truncate the string.
19808 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19809 properties to the string.
19811 PROPS are the properties to add to the string.
19812 The mode_line_string_face face property is always added to the string.
19816 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19817 int field_width
, int precision
, Lisp_Object props
)
19822 if (string
!= NULL
)
19824 len
= strlen (string
);
19825 if (precision
> 0 && len
> precision
)
19827 lisp_string
= make_string (string
, len
);
19829 props
= mode_line_string_face_prop
;
19830 else if (!NILP (mode_line_string_face
))
19832 Lisp_Object face
= Fplist_get (props
, Qface
);
19833 props
= Fcopy_sequence (props
);
19835 face
= mode_line_string_face
;
19837 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19838 props
= Fplist_put (props
, Qface
, face
);
19840 Fadd_text_properties (make_number (0), make_number (len
),
19841 props
, lisp_string
);
19845 len
= XFASTINT (Flength (lisp_string
));
19846 if (precision
> 0 && len
> precision
)
19849 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19852 if (!NILP (mode_line_string_face
))
19856 props
= Ftext_properties_at (make_number (0), lisp_string
);
19857 face
= Fplist_get (props
, Qface
);
19859 face
= mode_line_string_face
;
19861 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19862 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19864 lisp_string
= Fcopy_sequence (lisp_string
);
19867 Fadd_text_properties (make_number (0), make_number (len
),
19868 props
, lisp_string
);
19873 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19877 if (field_width
> len
)
19879 field_width
-= len
;
19880 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19882 Fadd_text_properties (make_number (0), make_number (field_width
),
19883 props
, lisp_string
);
19884 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19892 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19894 doc
: /* Format a string out of a mode line format specification.
19895 First arg FORMAT specifies the mode line format (see `mode-line-format'
19896 for details) to use.
19898 By default, the format is evaluated for the currently selected window.
19900 Optional second arg FACE specifies the face property to put on all
19901 characters for which no face is specified. The value nil means the
19902 default face. The value t means whatever face the window's mode line
19903 currently uses (either `mode-line' or `mode-line-inactive',
19904 depending on whether the window is the selected window or not).
19905 An integer value means the value string has no text
19908 Optional third and fourth args WINDOW and BUFFER specify the window
19909 and buffer to use as the context for the formatting (defaults
19910 are the selected window and the WINDOW's buffer). */)
19911 (Lisp_Object format
, Lisp_Object face
,
19912 Lisp_Object window
, Lisp_Object buffer
)
19917 struct buffer
*old_buffer
= NULL
;
19919 int no_props
= INTEGERP (face
);
19920 int count
= SPECPDL_INDEX ();
19922 int string_start
= 0;
19925 window
= selected_window
;
19926 CHECK_WINDOW (window
);
19927 w
= XWINDOW (window
);
19930 buffer
= w
->buffer
;
19931 CHECK_BUFFER (buffer
);
19933 /* Make formatting the modeline a non-op when noninteractive, otherwise
19934 there will be problems later caused by a partially initialized frame. */
19935 if (NILP (format
) || noninteractive
)
19936 return empty_unibyte_string
;
19941 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19942 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19943 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19944 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19945 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19946 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19947 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19950 if (XBUFFER (buffer
) != current_buffer
)
19951 old_buffer
= current_buffer
;
19953 /* Save things including mode_line_proptrans_alist,
19954 and set that to nil so that we don't alter the outer value. */
19955 record_unwind_protect (unwind_format_mode_line
,
19956 format_mode_line_unwind_data
19957 (old_buffer
, selected_window
, 1));
19958 mode_line_proptrans_alist
= Qnil
;
19960 Fselect_window (window
, Qt
);
19962 set_buffer_internal_1 (XBUFFER (buffer
));
19964 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19968 mode_line_target
= MODE_LINE_NOPROP
;
19969 mode_line_string_face_prop
= Qnil
;
19970 mode_line_string_list
= Qnil
;
19971 string_start
= MODE_LINE_NOPROP_LEN (0);
19975 mode_line_target
= MODE_LINE_STRING
;
19976 mode_line_string_list
= Qnil
;
19977 mode_line_string_face
= face
;
19978 mode_line_string_face_prop
19979 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19982 push_kboard (FRAME_KBOARD (it
.f
));
19983 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19988 len
= MODE_LINE_NOPROP_LEN (string_start
);
19989 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19993 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19994 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19995 empty_unibyte_string
);
19998 unbind_to (count
, Qnil
);
20002 /* Write a null-terminated, right justified decimal representation of
20003 the positive integer D to BUF using a minimal field width WIDTH. */
20006 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20008 register char *p
= buf
;
20016 *p
++ = d
% 10 + '0';
20021 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20032 /* Write a null-terminated, right justified decimal and "human
20033 readable" representation of the nonnegative integer D to BUF using
20034 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20036 static const char power_letter
[] =
20050 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20052 /* We aim to represent the nonnegative integer D as
20053 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20054 EMACS_INT quotient
= d
;
20056 /* -1 means: do not use TENTHS. */
20060 /* Length of QUOTIENT.TENTHS as a string. */
20066 if (1000 <= quotient
)
20068 /* Scale to the appropriate EXPONENT. */
20071 remainder
= quotient
% 1000;
20075 while (1000 <= quotient
);
20077 /* Round to nearest and decide whether to use TENTHS or not. */
20080 tenths
= remainder
/ 100;
20081 if (50 <= remainder
% 100)
20088 if (quotient
== 10)
20096 if (500 <= remainder
)
20098 if (quotient
< 999)
20109 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20110 if (tenths
== -1 && quotient
<= 99)
20117 p
= psuffix
= buf
+ max (width
, length
);
20119 /* Print EXPONENT. */
20120 *psuffix
++ = power_letter
[exponent
];
20123 /* Print TENTHS. */
20126 *--p
= '0' + tenths
;
20130 /* Print QUOTIENT. */
20133 int digit
= quotient
% 10;
20134 *--p
= '0' + digit
;
20136 while ((quotient
/= 10) != 0);
20138 /* Print leading spaces. */
20143 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20144 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20145 type of CODING_SYSTEM. Return updated pointer into BUF. */
20147 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20150 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20153 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20154 const unsigned char *eol_str
;
20156 /* The EOL conversion we are using. */
20157 Lisp_Object eoltype
;
20159 val
= CODING_SYSTEM_SPEC (coding_system
);
20162 if (!VECTORP (val
)) /* Not yet decided. */
20167 eoltype
= eol_mnemonic_undecided
;
20168 /* Don't mention EOL conversion if it isn't decided. */
20173 Lisp_Object eolvalue
;
20175 attrs
= AREF (val
, 0);
20176 eolvalue
= AREF (val
, 2);
20179 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20183 /* The EOL conversion that is normal on this system. */
20185 if (NILP (eolvalue
)) /* Not yet decided. */
20186 eoltype
= eol_mnemonic_undecided
;
20187 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20188 eoltype
= eol_mnemonic_undecided
;
20189 else /* eolvalue is Qunix, Qdos, or Qmac. */
20190 eoltype
= (EQ (eolvalue
, Qunix
)
20191 ? eol_mnemonic_unix
20192 : (EQ (eolvalue
, Qdos
) == 1
20193 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20199 /* Mention the EOL conversion if it is not the usual one. */
20200 if (STRINGP (eoltype
))
20202 eol_str
= SDATA (eoltype
);
20203 eol_str_len
= SBYTES (eoltype
);
20205 else if (CHARACTERP (eoltype
))
20207 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20208 int c
= XFASTINT (eoltype
);
20209 eol_str_len
= CHAR_STRING (c
, tmp
);
20214 eol_str
= invalid_eol_type
;
20215 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20217 memcpy (buf
, eol_str
, eol_str_len
);
20218 buf
+= eol_str_len
;
20224 /* Return a string for the output of a mode line %-spec for window W,
20225 generated by character C. FIELD_WIDTH > 0 means pad the string
20226 returned with spaces to that value. Return a Lisp string in
20227 *STRING if the resulting string is taken from that Lisp string.
20229 Note we operate on the current buffer for most purposes,
20230 the exception being w->base_line_pos. */
20232 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20234 static const char *
20235 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20236 Lisp_Object
*string
)
20239 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20240 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20241 struct buffer
*b
= current_buffer
;
20249 if (!NILP (BVAR (b
, read_only
)))
20251 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20256 /* This differs from %* only for a modified read-only buffer. */
20257 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20259 if (!NILP (BVAR (b
, read_only
)))
20264 /* This differs from %* in ignoring read-only-ness. */
20265 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20277 if (command_loop_level
> 5)
20279 p
= decode_mode_spec_buf
;
20280 for (i
= 0; i
< command_loop_level
; i
++)
20283 return decode_mode_spec_buf
;
20291 if (command_loop_level
> 5)
20293 p
= decode_mode_spec_buf
;
20294 for (i
= 0; i
< command_loop_level
; i
++)
20297 return decode_mode_spec_buf
;
20304 /* Let lots_of_dashes be a string of infinite length. */
20305 if (mode_line_target
== MODE_LINE_NOPROP
||
20306 mode_line_target
== MODE_LINE_STRING
)
20308 if (field_width
<= 0
20309 || field_width
> sizeof (lots_of_dashes
))
20311 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20312 decode_mode_spec_buf
[i
] = '-';
20313 decode_mode_spec_buf
[i
] = '\0';
20314 return decode_mode_spec_buf
;
20317 return lots_of_dashes
;
20321 obj
= BVAR (b
, name
);
20325 /* %c and %l are ignored in `frame-title-format'.
20326 (In redisplay_internal, the frame title is drawn _before_ the
20327 windows are updated, so the stuff which depends on actual
20328 window contents (such as %l) may fail to render properly, or
20329 even crash emacs.) */
20330 if (mode_line_target
== MODE_LINE_TITLE
)
20334 EMACS_INT col
= current_column ();
20335 w
->column_number_displayed
= make_number (col
);
20336 pint2str (decode_mode_spec_buf
, field_width
, col
);
20337 return decode_mode_spec_buf
;
20341 #ifndef SYSTEM_MALLOC
20343 if (NILP (Vmemory_full
))
20346 return "!MEM FULL! ";
20353 /* %F displays the frame name. */
20354 if (!NILP (f
->title
))
20355 return SSDATA (f
->title
);
20356 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20357 return SSDATA (f
->name
);
20361 obj
= BVAR (b
, filename
);
20366 EMACS_INT size
= ZV
- BEGV
;
20367 pint2str (decode_mode_spec_buf
, field_width
, size
);
20368 return decode_mode_spec_buf
;
20373 EMACS_INT size
= ZV
- BEGV
;
20374 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20375 return decode_mode_spec_buf
;
20380 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20381 EMACS_INT topline
, nlines
, height
;
20384 /* %c and %l are ignored in `frame-title-format'. */
20385 if (mode_line_target
== MODE_LINE_TITLE
)
20388 startpos
= XMARKER (w
->start
)->charpos
;
20389 startpos_byte
= marker_byte_position (w
->start
);
20390 height
= WINDOW_TOTAL_LINES (w
);
20392 /* If we decided that this buffer isn't suitable for line numbers,
20393 don't forget that too fast. */
20394 if (EQ (w
->base_line_pos
, w
->buffer
))
20396 /* But do forget it, if the window shows a different buffer now. */
20397 else if (BUFFERP (w
->base_line_pos
))
20398 w
->base_line_pos
= Qnil
;
20400 /* If the buffer is very big, don't waste time. */
20401 if (INTEGERP (Vline_number_display_limit
)
20402 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20404 w
->base_line_pos
= Qnil
;
20405 w
->base_line_number
= Qnil
;
20409 if (INTEGERP (w
->base_line_number
)
20410 && INTEGERP (w
->base_line_pos
)
20411 && XFASTINT (w
->base_line_pos
) <= startpos
)
20413 line
= XFASTINT (w
->base_line_number
);
20414 linepos
= XFASTINT (w
->base_line_pos
);
20415 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20420 linepos
= BUF_BEGV (b
);
20421 linepos_byte
= BUF_BEGV_BYTE (b
);
20424 /* Count lines from base line to window start position. */
20425 nlines
= display_count_lines (linepos_byte
,
20429 topline
= nlines
+ line
;
20431 /* Determine a new base line, if the old one is too close
20432 or too far away, or if we did not have one.
20433 "Too close" means it's plausible a scroll-down would
20434 go back past it. */
20435 if (startpos
== BUF_BEGV (b
))
20437 w
->base_line_number
= make_number (topline
);
20438 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20440 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20441 || linepos
== BUF_BEGV (b
))
20443 EMACS_INT limit
= BUF_BEGV (b
);
20444 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20445 EMACS_INT position
;
20446 EMACS_INT distance
=
20447 (height
* 2 + 30) * line_number_display_limit_width
;
20449 if (startpos
- distance
> limit
)
20451 limit
= startpos
- distance
;
20452 limit_byte
= CHAR_TO_BYTE (limit
);
20455 nlines
= display_count_lines (startpos_byte
,
20457 - (height
* 2 + 30),
20459 /* If we couldn't find the lines we wanted within
20460 line_number_display_limit_width chars per line,
20461 give up on line numbers for this window. */
20462 if (position
== limit_byte
&& limit
== startpos
- distance
)
20464 w
->base_line_pos
= w
->buffer
;
20465 w
->base_line_number
= Qnil
;
20469 w
->base_line_number
= make_number (topline
- nlines
);
20470 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20473 /* Now count lines from the start pos to point. */
20474 nlines
= display_count_lines (startpos_byte
,
20475 PT_BYTE
, PT
, &junk
);
20477 /* Record that we did display the line number. */
20478 line_number_displayed
= 1;
20480 /* Make the string to show. */
20481 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20482 return decode_mode_spec_buf
;
20485 char* p
= decode_mode_spec_buf
;
20486 int pad
= field_width
- 2;
20492 return decode_mode_spec_buf
;
20498 obj
= BVAR (b
, mode_name
);
20502 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20508 EMACS_INT pos
= marker_position (w
->start
);
20509 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20511 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20513 if (pos
<= BUF_BEGV (b
))
20518 else if (pos
<= BUF_BEGV (b
))
20522 if (total
> 1000000)
20523 /* Do it differently for a large value, to avoid overflow. */
20524 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20526 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20527 /* We can't normally display a 3-digit number,
20528 so get us a 2-digit number that is close. */
20531 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20532 return decode_mode_spec_buf
;
20536 /* Display percentage of size above the bottom of the screen. */
20539 EMACS_INT toppos
= marker_position (w
->start
);
20540 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20541 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20543 if (botpos
>= BUF_ZV (b
))
20545 if (toppos
<= BUF_BEGV (b
))
20552 if (total
> 1000000)
20553 /* Do it differently for a large value, to avoid overflow. */
20554 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20556 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20557 /* We can't normally display a 3-digit number,
20558 so get us a 2-digit number that is close. */
20561 if (toppos
<= BUF_BEGV (b
))
20562 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20564 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20565 return decode_mode_spec_buf
;
20570 /* status of process */
20571 obj
= Fget_buffer_process (Fcurrent_buffer ());
20573 return "no process";
20575 obj
= Fsymbol_name (Fprocess_status (obj
));
20581 int count
= inhibit_garbage_collection ();
20582 Lisp_Object val
= call1 (intern ("file-remote-p"),
20583 BVAR (current_buffer
, directory
));
20584 unbind_to (count
, Qnil
);
20592 case 't': /* indicate TEXT or BINARY */
20596 /* coding-system (not including end-of-line format) */
20598 /* coding-system (including end-of-line type) */
20600 int eol_flag
= (c
== 'Z');
20601 char *p
= decode_mode_spec_buf
;
20603 if (! FRAME_WINDOW_P (f
))
20605 /* No need to mention EOL here--the terminal never needs
20606 to do EOL conversion. */
20607 p
= decode_mode_spec_coding (CODING_ID_NAME
20608 (FRAME_KEYBOARD_CODING (f
)->id
),
20610 p
= decode_mode_spec_coding (CODING_ID_NAME
20611 (FRAME_TERMINAL_CODING (f
)->id
),
20614 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20617 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20618 #ifdef subprocesses
20619 obj
= Fget_buffer_process (Fcurrent_buffer ());
20620 if (PROCESSP (obj
))
20622 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20624 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20627 #endif /* subprocesses */
20630 return decode_mode_spec_buf
;
20637 return SSDATA (obj
);
20644 /* Count up to COUNT lines starting from START_BYTE.
20645 But don't go beyond LIMIT_BYTE.
20646 Return the number of lines thus found (always nonnegative).
20648 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20651 display_count_lines (EMACS_INT start_byte
,
20652 EMACS_INT limit_byte
, EMACS_INT count
,
20653 EMACS_INT
*byte_pos_ptr
)
20655 register unsigned char *cursor
;
20656 unsigned char *base
;
20658 register EMACS_INT ceiling
;
20659 register unsigned char *ceiling_addr
;
20660 EMACS_INT orig_count
= count
;
20662 /* If we are not in selective display mode,
20663 check only for newlines. */
20664 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20665 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20669 while (start_byte
< limit_byte
)
20671 ceiling
= BUFFER_CEILING_OF (start_byte
);
20672 ceiling
= min (limit_byte
- 1, ceiling
);
20673 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20674 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20677 if (selective_display
)
20678 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20681 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20684 if (cursor
!= ceiling_addr
)
20688 start_byte
+= cursor
- base
+ 1;
20689 *byte_pos_ptr
= start_byte
;
20693 if (++cursor
== ceiling_addr
)
20699 start_byte
+= cursor
- base
;
20704 while (start_byte
> limit_byte
)
20706 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20707 ceiling
= max (limit_byte
, ceiling
);
20708 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20709 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20712 if (selective_display
)
20713 while (--cursor
!= ceiling_addr
20714 && *cursor
!= '\n' && *cursor
!= 015)
20717 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20720 if (cursor
!= ceiling_addr
)
20724 start_byte
+= cursor
- base
+ 1;
20725 *byte_pos_ptr
= start_byte
;
20726 /* When scanning backwards, we should
20727 not count the newline posterior to which we stop. */
20728 return - orig_count
- 1;
20734 /* Here we add 1 to compensate for the last decrement
20735 of CURSOR, which took it past the valid range. */
20736 start_byte
+= cursor
- base
+ 1;
20740 *byte_pos_ptr
= limit_byte
;
20743 return - orig_count
+ count
;
20744 return orig_count
- count
;
20750 /***********************************************************************
20752 ***********************************************************************/
20754 /* Display a NUL-terminated string, starting with index START.
20756 If STRING is non-null, display that C string. Otherwise, the Lisp
20757 string LISP_STRING is displayed. There's a case that STRING is
20758 non-null and LISP_STRING is not nil. It means STRING is a string
20759 data of LISP_STRING. In that case, we display LISP_STRING while
20760 ignoring its text properties.
20762 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20763 FACE_STRING. Display STRING or LISP_STRING with the face at
20764 FACE_STRING_POS in FACE_STRING:
20766 Display the string in the environment given by IT, but use the
20767 standard display table, temporarily.
20769 FIELD_WIDTH is the minimum number of output glyphs to produce.
20770 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20771 with spaces. If STRING has more characters, more than FIELD_WIDTH
20772 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20774 PRECISION is the maximum number of characters to output from
20775 STRING. PRECISION < 0 means don't truncate the string.
20777 This is roughly equivalent to printf format specifiers:
20779 FIELD_WIDTH PRECISION PRINTF
20780 ----------------------------------------
20786 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20787 display them, and < 0 means obey the current buffer's value of
20788 enable_multibyte_characters.
20790 Value is the number of columns displayed. */
20793 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20794 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20795 int field_width
, int precision
, int max_x
, int multibyte
)
20797 int hpos_at_start
= it
->hpos
;
20798 int saved_face_id
= it
->face_id
;
20799 struct glyph_row
*row
= it
->glyph_row
;
20800 EMACS_INT it_charpos
;
20802 /* Initialize the iterator IT for iteration over STRING beginning
20803 with index START. */
20804 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20805 precision
, field_width
, multibyte
);
20806 if (string
&& STRINGP (lisp_string
))
20807 /* LISP_STRING is the one returned by decode_mode_spec. We should
20808 ignore its text properties. */
20809 it
->stop_charpos
= it
->end_charpos
;
20811 /* If displaying STRING, set up the face of the iterator from
20812 FACE_STRING, if that's given. */
20813 if (STRINGP (face_string
))
20819 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20820 0, it
->region_beg_charpos
,
20821 it
->region_end_charpos
,
20822 &endptr
, it
->base_face_id
, 0);
20823 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20824 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20827 /* Set max_x to the maximum allowed X position. Don't let it go
20828 beyond the right edge of the window. */
20830 max_x
= it
->last_visible_x
;
20832 max_x
= min (max_x
, it
->last_visible_x
);
20834 /* Skip over display elements that are not visible. because IT->w is
20836 if (it
->current_x
< it
->first_visible_x
)
20837 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20838 MOVE_TO_POS
| MOVE_TO_X
);
20840 row
->ascent
= it
->max_ascent
;
20841 row
->height
= it
->max_ascent
+ it
->max_descent
;
20842 row
->phys_ascent
= it
->max_phys_ascent
;
20843 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20844 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20846 if (STRINGP (it
->string
))
20847 it_charpos
= IT_STRING_CHARPOS (*it
);
20849 it_charpos
= IT_CHARPOS (*it
);
20851 /* This condition is for the case that we are called with current_x
20852 past last_visible_x. */
20853 while (it
->current_x
< max_x
)
20855 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20857 /* Get the next display element. */
20858 if (!get_next_display_element (it
))
20861 /* Produce glyphs. */
20862 x_before
= it
->current_x
;
20863 n_glyphs_before
= row
->used
[TEXT_AREA
];
20864 PRODUCE_GLYPHS (it
);
20866 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20869 while (i
< nglyphs
)
20871 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20873 if (it
->line_wrap
!= TRUNCATE
20874 && x
+ glyph
->pixel_width
> max_x
)
20876 /* End of continued line or max_x reached. */
20877 if (CHAR_GLYPH_PADDING_P (*glyph
))
20879 /* A wide character is unbreakable. */
20880 if (row
->reversed_p
)
20881 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20882 - n_glyphs_before
);
20883 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20884 it
->current_x
= x_before
;
20888 if (row
->reversed_p
)
20889 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20890 - (n_glyphs_before
+ i
));
20891 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20896 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20898 /* Glyph is at least partially visible. */
20900 if (x
< it
->first_visible_x
)
20901 row
->x
= x
- it
->first_visible_x
;
20905 /* Glyph is off the left margin of the display area.
20906 Should not happen. */
20910 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20911 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20912 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20913 row
->phys_height
= max (row
->phys_height
,
20914 it
->max_phys_ascent
+ it
->max_phys_descent
);
20915 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20916 it
->max_extra_line_spacing
);
20917 x
+= glyph
->pixel_width
;
20921 /* Stop if max_x reached. */
20925 /* Stop at line ends. */
20926 if (ITERATOR_AT_END_OF_LINE_P (it
))
20928 it
->continuation_lines_width
= 0;
20932 set_iterator_to_next (it
, 1);
20933 if (STRINGP (it
->string
))
20934 it_charpos
= IT_STRING_CHARPOS (*it
);
20936 it_charpos
= IT_CHARPOS (*it
);
20938 /* Stop if truncating at the right edge. */
20939 if (it
->line_wrap
== TRUNCATE
20940 && it
->current_x
>= it
->last_visible_x
)
20942 /* Add truncation mark, but don't do it if the line is
20943 truncated at a padding space. */
20944 if (it_charpos
< it
->string_nchars
)
20946 if (!FRAME_WINDOW_P (it
->f
))
20950 if (it
->current_x
> it
->last_visible_x
)
20952 if (!row
->reversed_p
)
20954 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20955 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20960 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
20961 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20963 unproduce_glyphs (it
, ii
+ 1);
20964 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
20966 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20968 row
->used
[TEXT_AREA
] = ii
;
20969 produce_special_glyphs (it
, IT_TRUNCATION
);
20972 produce_special_glyphs (it
, IT_TRUNCATION
);
20974 row
->truncated_on_right_p
= 1;
20980 /* Maybe insert a truncation at the left. */
20981 if (it
->first_visible_x
20984 if (!FRAME_WINDOW_P (it
->f
))
20985 insert_left_trunc_glyphs (it
);
20986 row
->truncated_on_left_p
= 1;
20989 it
->face_id
= saved_face_id
;
20991 /* Value is number of columns displayed. */
20992 return it
->hpos
- hpos_at_start
;
20997 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20998 appears as an element of LIST or as the car of an element of LIST.
20999 If PROPVAL is a list, compare each element against LIST in that
21000 way, and return 1/2 if any element of PROPVAL is found in LIST.
21001 Otherwise return 0. This function cannot quit.
21002 The return value is 2 if the text is invisible but with an ellipsis
21003 and 1 if it's invisible and without an ellipsis. */
21006 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21008 register Lisp_Object tail
, proptail
;
21010 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21012 register Lisp_Object tem
;
21014 if (EQ (propval
, tem
))
21016 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21017 return NILP (XCDR (tem
)) ? 1 : 2;
21020 if (CONSP (propval
))
21022 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21024 Lisp_Object propelt
;
21025 propelt
= XCAR (proptail
);
21026 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21028 register Lisp_Object tem
;
21030 if (EQ (propelt
, tem
))
21032 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21033 return NILP (XCDR (tem
)) ? 1 : 2;
21041 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21042 doc
: /* Non-nil if the property makes the text invisible.
21043 POS-OR-PROP can be a marker or number, in which case it is taken to be
21044 a position in the current buffer and the value of the `invisible' property
21045 is checked; or it can be some other value, which is then presumed to be the
21046 value of the `invisible' property of the text of interest.
21047 The non-nil value returned can be t for truly invisible text or something
21048 else if the text is replaced by an ellipsis. */)
21049 (Lisp_Object pos_or_prop
)
21052 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21053 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21055 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21056 return (invis
== 0 ? Qnil
21058 : make_number (invis
));
21061 /* Calculate a width or height in pixels from a specification using
21062 the following elements:
21065 NUM - a (fractional) multiple of the default font width/height
21066 (NUM) - specifies exactly NUM pixels
21067 UNIT - a fixed number of pixels, see below.
21068 ELEMENT - size of a display element in pixels, see below.
21069 (NUM . SPEC) - equals NUM * SPEC
21070 (+ SPEC SPEC ...) - add pixel values
21071 (- SPEC SPEC ...) - subtract pixel values
21072 (- SPEC) - negate pixel value
21075 INT or FLOAT - a number constant
21076 SYMBOL - use symbol's (buffer local) variable binding.
21079 in - pixels per inch *)
21080 mm - pixels per 1/1000 meter *)
21081 cm - pixels per 1/100 meter *)
21082 width - width of current font in pixels.
21083 height - height of current font in pixels.
21085 *) using the ratio(s) defined in display-pixels-per-inch.
21089 left-fringe - left fringe width in pixels
21090 right-fringe - right fringe width in pixels
21092 left-margin - left margin width in pixels
21093 right-margin - right margin width in pixels
21095 scroll-bar - scroll-bar area width in pixels
21099 Pixels corresponding to 5 inches:
21102 Total width of non-text areas on left side of window (if scroll-bar is on left):
21103 '(space :width (+ left-fringe left-margin scroll-bar))
21105 Align to first text column (in header line):
21106 '(space :align-to 0)
21108 Align to middle of text area minus half the width of variable `my-image'
21109 containing a loaded image:
21110 '(space :align-to (0.5 . (- text my-image)))
21112 Width of left margin minus width of 1 character in the default font:
21113 '(space :width (- left-margin 1))
21115 Width of left margin minus width of 2 characters in the current font:
21116 '(space :width (- left-margin (2 . width)))
21118 Center 1 character over left-margin (in header line):
21119 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21121 Different ways to express width of left fringe plus left margin minus one pixel:
21122 '(space :width (- (+ left-fringe left-margin) (1)))
21123 '(space :width (+ left-fringe left-margin (- (1))))
21124 '(space :width (+ left-fringe left-margin (-1)))
21128 #define NUMVAL(X) \
21129 ((INTEGERP (X) || FLOATP (X)) \
21134 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21135 struct font
*font
, int width_p
, int *align_to
)
21139 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21140 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21143 return OK_PIXELS (0);
21145 xassert (FRAME_LIVE_P (it
->f
));
21147 if (SYMBOLP (prop
))
21149 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21151 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21153 if (unit
[0] == 'i' && unit
[1] == 'n')
21155 else if (unit
[0] == 'm' && unit
[1] == 'm')
21157 else if (unit
[0] == 'c' && unit
[1] == 'm')
21164 #ifdef HAVE_WINDOW_SYSTEM
21165 if (FRAME_WINDOW_P (it
->f
)
21167 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21168 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21170 return OK_PIXELS (ppi
/ pixels
);
21173 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21174 || (CONSP (Vdisplay_pixels_per_inch
)
21176 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21177 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21179 return OK_PIXELS (ppi
/ pixels
);
21185 #ifdef HAVE_WINDOW_SYSTEM
21186 if (EQ (prop
, Qheight
))
21187 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21188 if (EQ (prop
, Qwidth
))
21189 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21191 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21192 return OK_PIXELS (1);
21195 if (EQ (prop
, Qtext
))
21196 return OK_PIXELS (width_p
21197 ? window_box_width (it
->w
, TEXT_AREA
)
21198 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21200 if (align_to
&& *align_to
< 0)
21203 if (EQ (prop
, Qleft
))
21204 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21205 if (EQ (prop
, Qright
))
21206 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21207 if (EQ (prop
, Qcenter
))
21208 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21209 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21210 if (EQ (prop
, Qleft_fringe
))
21211 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21212 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21213 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21214 if (EQ (prop
, Qright_fringe
))
21215 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21216 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21217 : window_box_right_offset (it
->w
, TEXT_AREA
));
21218 if (EQ (prop
, Qleft_margin
))
21219 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21220 if (EQ (prop
, Qright_margin
))
21221 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21222 if (EQ (prop
, Qscroll_bar
))
21223 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21225 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21226 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21227 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21232 if (EQ (prop
, Qleft_fringe
))
21233 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21234 if (EQ (prop
, Qright_fringe
))
21235 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21236 if (EQ (prop
, Qleft_margin
))
21237 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21238 if (EQ (prop
, Qright_margin
))
21239 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21240 if (EQ (prop
, Qscroll_bar
))
21241 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21244 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21247 if (INTEGERP (prop
) || FLOATP (prop
))
21249 int base_unit
= (width_p
21250 ? FRAME_COLUMN_WIDTH (it
->f
)
21251 : FRAME_LINE_HEIGHT (it
->f
));
21252 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21257 Lisp_Object car
= XCAR (prop
);
21258 Lisp_Object cdr
= XCDR (prop
);
21262 #ifdef HAVE_WINDOW_SYSTEM
21263 if (FRAME_WINDOW_P (it
->f
)
21264 && valid_image_p (prop
))
21266 int id
= lookup_image (it
->f
, prop
);
21267 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21269 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21272 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21278 while (CONSP (cdr
))
21280 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21281 font
, width_p
, align_to
))
21284 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21289 if (EQ (car
, Qminus
))
21291 return OK_PIXELS (pixels
);
21294 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21297 if (INTEGERP (car
) || FLOATP (car
))
21300 pixels
= XFLOATINT (car
);
21302 return OK_PIXELS (pixels
);
21303 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21304 font
, width_p
, align_to
))
21305 return OK_PIXELS (pixels
* fact
);
21316 /***********************************************************************
21318 ***********************************************************************/
21320 #ifdef HAVE_WINDOW_SYSTEM
21325 dump_glyph_string (struct glyph_string
*s
)
21327 fprintf (stderr
, "glyph string\n");
21328 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21329 s
->x
, s
->y
, s
->width
, s
->height
);
21330 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21331 fprintf (stderr
, " hl = %d\n", s
->hl
);
21332 fprintf (stderr
, " left overhang = %d, right = %d\n",
21333 s
->left_overhang
, s
->right_overhang
);
21334 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21335 fprintf (stderr
, " extends to end of line = %d\n",
21336 s
->extends_to_end_of_line_p
);
21337 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21338 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21341 #endif /* GLYPH_DEBUG */
21343 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21344 of XChar2b structures for S; it can't be allocated in
21345 init_glyph_string because it must be allocated via `alloca'. W
21346 is the window on which S is drawn. ROW and AREA are the glyph row
21347 and area within the row from which S is constructed. START is the
21348 index of the first glyph structure covered by S. HL is a
21349 face-override for drawing S. */
21352 #define OPTIONAL_HDC(hdc) HDC hdc,
21353 #define DECLARE_HDC(hdc) HDC hdc;
21354 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21355 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21358 #ifndef OPTIONAL_HDC
21359 #define OPTIONAL_HDC(hdc)
21360 #define DECLARE_HDC(hdc)
21361 #define ALLOCATE_HDC(hdc, f)
21362 #define RELEASE_HDC(hdc, f)
21366 init_glyph_string (struct glyph_string
*s
,
21368 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21369 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21371 memset (s
, 0, sizeof *s
);
21373 s
->f
= XFRAME (w
->frame
);
21377 s
->display
= FRAME_X_DISPLAY (s
->f
);
21378 s
->window
= FRAME_X_WINDOW (s
->f
);
21379 s
->char2b
= char2b
;
21383 s
->first_glyph
= row
->glyphs
[area
] + start
;
21384 s
->height
= row
->height
;
21385 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21386 s
->ybase
= s
->y
+ row
->ascent
;
21390 /* Append the list of glyph strings with head H and tail T to the list
21391 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21394 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21395 struct glyph_string
*h
, struct glyph_string
*t
)
21409 /* Prepend the list of glyph strings with head H and tail T to the
21410 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21414 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21415 struct glyph_string
*h
, struct glyph_string
*t
)
21429 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21430 Set *HEAD and *TAIL to the resulting list. */
21433 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21434 struct glyph_string
*s
)
21436 s
->next
= s
->prev
= NULL
;
21437 append_glyph_string_lists (head
, tail
, s
, s
);
21441 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21442 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21443 make sure that X resources for the face returned are allocated.
21444 Value is a pointer to a realized face that is ready for display if
21445 DISPLAY_P is non-zero. */
21447 static inline struct face
*
21448 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21449 XChar2b
*char2b
, int display_p
)
21451 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21455 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21457 if (code
!= FONT_INVALID_CODE
)
21458 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21460 STORE_XCHAR2B (char2b
, 0, 0);
21463 /* Make sure X resources of the face are allocated. */
21464 #ifdef HAVE_X_WINDOWS
21468 xassert (face
!= NULL
);
21469 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21476 /* Get face and two-byte form of character glyph GLYPH on frame F.
21477 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21478 a pointer to a realized face that is ready for display. */
21480 static inline struct face
*
21481 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21482 XChar2b
*char2b
, int *two_byte_p
)
21486 xassert (glyph
->type
== CHAR_GLYPH
);
21487 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21496 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21497 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21499 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21501 if (code
!= FONT_INVALID_CODE
)
21502 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21504 STORE_XCHAR2B (char2b
, 0, 0);
21507 /* Make sure X resources of the face are allocated. */
21508 xassert (face
!= NULL
);
21509 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21514 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21515 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21518 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21522 if (CHAR_BYTE8_P (c
))
21523 code
= CHAR_TO_BYTE8 (c
);
21525 code
= font
->driver
->encode_char (font
, c
);
21527 if (code
== FONT_INVALID_CODE
)
21529 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21534 /* Fill glyph string S with composition components specified by S->cmp.
21536 BASE_FACE is the base face of the composition.
21537 S->cmp_from is the index of the first component for S.
21539 OVERLAPS non-zero means S should draw the foreground only, and use
21540 its physical height for clipping. See also draw_glyphs.
21542 Value is the index of a component not in S. */
21545 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21549 /* For all glyphs of this composition, starting at the offset
21550 S->cmp_from, until we reach the end of the definition or encounter a
21551 glyph that requires the different face, add it to S. */
21556 s
->for_overlaps
= overlaps
;
21559 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21561 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21565 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21568 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21575 s
->font
= s
->face
->font
;
21577 else if (s
->face
!= face
)
21585 /* All glyph strings for the same composition has the same width,
21586 i.e. the width set for the first component of the composition. */
21587 s
->width
= s
->first_glyph
->pixel_width
;
21589 /* If the specified font could not be loaded, use the frame's
21590 default font, but record the fact that we couldn't load it in
21591 the glyph string so that we can draw rectangles for the
21592 characters of the glyph string. */
21593 if (s
->font
== NULL
)
21595 s
->font_not_found_p
= 1;
21596 s
->font
= FRAME_FONT (s
->f
);
21599 /* Adjust base line for subscript/superscript text. */
21600 s
->ybase
+= s
->first_glyph
->voffset
;
21602 /* This glyph string must always be drawn with 16-bit functions. */
21609 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21610 int start
, int end
, int overlaps
)
21612 struct glyph
*glyph
, *last
;
21613 Lisp_Object lgstring
;
21616 s
->for_overlaps
= overlaps
;
21617 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21618 last
= s
->row
->glyphs
[s
->area
] + end
;
21619 s
->cmp_id
= glyph
->u
.cmp
.id
;
21620 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21621 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21622 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21623 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21624 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21626 while (glyph
< last
21627 && glyph
->u
.cmp
.automatic
21628 && glyph
->u
.cmp
.id
== s
->cmp_id
21629 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21630 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21632 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21634 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21635 unsigned code
= LGLYPH_CODE (lglyph
);
21637 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21639 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21640 return glyph
- s
->row
->glyphs
[s
->area
];
21644 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21645 See the comment of fill_glyph_string for arguments.
21646 Value is the index of the first glyph not in S. */
21650 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21651 int start
, int end
, int overlaps
)
21653 struct glyph
*glyph
, *last
;
21656 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21657 s
->for_overlaps
= overlaps
;
21658 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21659 last
= s
->row
->glyphs
[s
->area
] + end
;
21660 voffset
= glyph
->voffset
;
21661 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21662 s
->font
= s
->face
->font
;
21664 s
->width
= glyph
->pixel_width
;
21666 while (glyph
< last
21667 && glyph
->type
== GLYPHLESS_GLYPH
21668 && glyph
->voffset
== voffset
21669 && glyph
->face_id
== face_id
)
21672 s
->width
+= glyph
->pixel_width
;
21675 s
->ybase
+= voffset
;
21676 return glyph
- s
->row
->glyphs
[s
->area
];
21680 /* Fill glyph string S from a sequence of character glyphs.
21682 FACE_ID is the face id of the string. START is the index of the
21683 first glyph to consider, END is the index of the last + 1.
21684 OVERLAPS non-zero means S should draw the foreground only, and use
21685 its physical height for clipping. See also draw_glyphs.
21687 Value is the index of the first glyph not in S. */
21690 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21691 int start
, int end
, int overlaps
)
21693 struct glyph
*glyph
, *last
;
21695 int glyph_not_available_p
;
21697 xassert (s
->f
== XFRAME (s
->w
->frame
));
21698 xassert (s
->nchars
== 0);
21699 xassert (start
>= 0 && end
> start
);
21701 s
->for_overlaps
= overlaps
;
21702 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21703 last
= s
->row
->glyphs
[s
->area
] + end
;
21704 voffset
= glyph
->voffset
;
21705 s
->padding_p
= glyph
->padding_p
;
21706 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21708 while (glyph
< last
21709 && glyph
->type
== CHAR_GLYPH
21710 && glyph
->voffset
== voffset
21711 /* Same face id implies same font, nowadays. */
21712 && glyph
->face_id
== face_id
21713 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21717 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21718 s
->char2b
+ s
->nchars
,
21720 s
->two_byte_p
= two_byte_p
;
21722 xassert (s
->nchars
<= end
- start
);
21723 s
->width
+= glyph
->pixel_width
;
21724 if (glyph
++->padding_p
!= s
->padding_p
)
21728 s
->font
= s
->face
->font
;
21730 /* If the specified font could not be loaded, use the frame's font,
21731 but record the fact that we couldn't load it in
21732 S->font_not_found_p so that we can draw rectangles for the
21733 characters of the glyph string. */
21734 if (s
->font
== NULL
|| glyph_not_available_p
)
21736 s
->font_not_found_p
= 1;
21737 s
->font
= FRAME_FONT (s
->f
);
21740 /* Adjust base line for subscript/superscript text. */
21741 s
->ybase
+= voffset
;
21743 xassert (s
->face
&& s
->face
->gc
);
21744 return glyph
- s
->row
->glyphs
[s
->area
];
21748 /* Fill glyph string S from image glyph S->first_glyph. */
21751 fill_image_glyph_string (struct glyph_string
*s
)
21753 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21754 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21756 s
->slice
= s
->first_glyph
->slice
.img
;
21757 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21758 s
->font
= s
->face
->font
;
21759 s
->width
= s
->first_glyph
->pixel_width
;
21761 /* Adjust base line for subscript/superscript text. */
21762 s
->ybase
+= s
->first_glyph
->voffset
;
21766 /* Fill glyph string S from a sequence of stretch glyphs.
21768 START is the index of the first glyph to consider,
21769 END is the index of the last + 1.
21771 Value is the index of the first glyph not in S. */
21774 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21776 struct glyph
*glyph
, *last
;
21777 int voffset
, face_id
;
21779 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21781 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21782 last
= s
->row
->glyphs
[s
->area
] + end
;
21783 face_id
= glyph
->face_id
;
21784 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21785 s
->font
= s
->face
->font
;
21786 s
->width
= glyph
->pixel_width
;
21788 voffset
= glyph
->voffset
;
21792 && glyph
->type
== STRETCH_GLYPH
21793 && glyph
->voffset
== voffset
21794 && glyph
->face_id
== face_id
);
21796 s
->width
+= glyph
->pixel_width
;
21798 /* Adjust base line for subscript/superscript text. */
21799 s
->ybase
+= voffset
;
21801 /* The case that face->gc == 0 is handled when drawing the glyph
21802 string by calling PREPARE_FACE_FOR_DISPLAY. */
21804 return glyph
- s
->row
->glyphs
[s
->area
];
21807 static struct font_metrics
*
21808 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21810 static struct font_metrics metrics
;
21811 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21813 if (! font
|| code
== FONT_INVALID_CODE
)
21815 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21820 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21821 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21822 assumed to be zero. */
21825 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21827 *left
= *right
= 0;
21829 if (glyph
->type
== CHAR_GLYPH
)
21833 struct font_metrics
*pcm
;
21835 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21836 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21838 if (pcm
->rbearing
> pcm
->width
)
21839 *right
= pcm
->rbearing
- pcm
->width
;
21840 if (pcm
->lbearing
< 0)
21841 *left
= -pcm
->lbearing
;
21844 else if (glyph
->type
== COMPOSITE_GLYPH
)
21846 if (! glyph
->u
.cmp
.automatic
)
21848 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21850 if (cmp
->rbearing
> cmp
->pixel_width
)
21851 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21852 if (cmp
->lbearing
< 0)
21853 *left
= - cmp
->lbearing
;
21857 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21858 struct font_metrics metrics
;
21860 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21861 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21862 if (metrics
.rbearing
> metrics
.width
)
21863 *right
= metrics
.rbearing
- metrics
.width
;
21864 if (metrics
.lbearing
< 0)
21865 *left
= - metrics
.lbearing
;
21871 /* Return the index of the first glyph preceding glyph string S that
21872 is overwritten by S because of S's left overhang. Value is -1
21873 if no glyphs are overwritten. */
21876 left_overwritten (struct glyph_string
*s
)
21880 if (s
->left_overhang
)
21883 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21884 int first
= s
->first_glyph
- glyphs
;
21886 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21887 x
-= glyphs
[i
].pixel_width
;
21898 /* Return the index of the first glyph preceding glyph string S that
21899 is overwriting S because of its right overhang. Value is -1 if no
21900 glyph in front of S overwrites S. */
21903 left_overwriting (struct glyph_string
*s
)
21906 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21907 int first
= s
->first_glyph
- glyphs
;
21911 for (i
= first
- 1; i
>= 0; --i
)
21914 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21917 x
-= glyphs
[i
].pixel_width
;
21924 /* Return the index of the last glyph following glyph string S that is
21925 overwritten by S because of S's right overhang. Value is -1 if
21926 no such glyph is found. */
21929 right_overwritten (struct glyph_string
*s
)
21933 if (s
->right_overhang
)
21936 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21937 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21938 int end
= s
->row
->used
[s
->area
];
21940 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21941 x
+= glyphs
[i
].pixel_width
;
21950 /* Return the index of the last glyph following glyph string S that
21951 overwrites S because of its left overhang. Value is negative
21952 if no such glyph is found. */
21955 right_overwriting (struct glyph_string
*s
)
21958 int end
= s
->row
->used
[s
->area
];
21959 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21960 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21964 for (i
= first
; i
< end
; ++i
)
21967 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21970 x
+= glyphs
[i
].pixel_width
;
21977 /* Set background width of glyph string S. START is the index of the
21978 first glyph following S. LAST_X is the right-most x-position + 1
21979 in the drawing area. */
21982 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21984 /* If the face of this glyph string has to be drawn to the end of
21985 the drawing area, set S->extends_to_end_of_line_p. */
21987 if (start
== s
->row
->used
[s
->area
]
21988 && s
->area
== TEXT_AREA
21989 && ((s
->row
->fill_line_p
21990 && (s
->hl
== DRAW_NORMAL_TEXT
21991 || s
->hl
== DRAW_IMAGE_RAISED
21992 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21993 || s
->hl
== DRAW_MOUSE_FACE
))
21994 s
->extends_to_end_of_line_p
= 1;
21996 /* If S extends its face to the end of the line, set its
21997 background_width to the distance to the right edge of the drawing
21999 if (s
->extends_to_end_of_line_p
)
22000 s
->background_width
= last_x
- s
->x
+ 1;
22002 s
->background_width
= s
->width
;
22006 /* Compute overhangs and x-positions for glyph string S and its
22007 predecessors, or successors. X is the starting x-position for S.
22008 BACKWARD_P non-zero means process predecessors. */
22011 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22017 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22018 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22028 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22029 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22039 /* The following macros are only called from draw_glyphs below.
22040 They reference the following parameters of that function directly:
22041 `w', `row', `area', and `overlap_p'
22042 as well as the following local variables:
22043 `s', `f', and `hdc' (in W32) */
22046 /* On W32, silently add local `hdc' variable to argument list of
22047 init_glyph_string. */
22048 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22049 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22051 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22052 init_glyph_string (s, char2b, w, row, area, start, hl)
22055 /* Add a glyph string for a stretch glyph to the list of strings
22056 between HEAD and TAIL. START is the index of the stretch glyph in
22057 row area AREA of glyph row ROW. END is the index of the last glyph
22058 in that glyph row area. X is the current output position assigned
22059 to the new glyph string constructed. HL overrides that face of the
22060 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22061 is the right-most x-position of the drawing area. */
22063 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22064 and below -- keep them on one line. */
22065 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22068 s = (struct glyph_string *) alloca (sizeof *s); \
22069 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22070 START = fill_stretch_glyph_string (s, START, END); \
22071 append_glyph_string (&HEAD, &TAIL, s); \
22077 /* Add a glyph string for an image glyph to the list of strings
22078 between HEAD and TAIL. START is the index of the image glyph in
22079 row area AREA of glyph row ROW. END is the index of the last glyph
22080 in that glyph row area. X is the current output position assigned
22081 to the new glyph string constructed. HL overrides that face of the
22082 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22083 is the right-most x-position of the drawing area. */
22085 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22088 s = (struct glyph_string *) alloca (sizeof *s); \
22089 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22090 fill_image_glyph_string (s); \
22091 append_glyph_string (&HEAD, &TAIL, s); \
22098 /* Add a glyph string for a sequence of character glyphs to the list
22099 of strings between HEAD and TAIL. START is the index of the first
22100 glyph in row area AREA of glyph row ROW that is part of the new
22101 glyph string. END is the index of the last glyph in that glyph row
22102 area. X is the current output position assigned to the new glyph
22103 string constructed. HL overrides that face of the glyph; e.g. it
22104 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22105 right-most x-position of the drawing area. */
22107 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22113 face_id = (row)->glyphs[area][START].face_id; \
22115 s = (struct glyph_string *) alloca (sizeof *s); \
22116 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22117 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22118 append_glyph_string (&HEAD, &TAIL, s); \
22120 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22125 /* Add a glyph string for a composite sequence to the list of strings
22126 between HEAD and TAIL. START is the index of the first glyph in
22127 row area AREA of glyph row ROW that is part of the new glyph
22128 string. END is the index of the last glyph in that glyph row area.
22129 X is the current output position assigned to the new glyph string
22130 constructed. HL overrides that face of the glyph; e.g. it is
22131 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22132 x-position of the drawing area. */
22134 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22136 int face_id = (row)->glyphs[area][START].face_id; \
22137 struct face *base_face = FACE_FROM_ID (f, face_id); \
22138 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22139 struct composition *cmp = composition_table[cmp_id]; \
22141 struct glyph_string *first_s IF_LINT (= NULL); \
22144 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22146 /* Make glyph_strings for each glyph sequence that is drawable by \
22147 the same face, and append them to HEAD/TAIL. */ \
22148 for (n = 0; n < cmp->glyph_len;) \
22150 s = (struct glyph_string *) alloca (sizeof *s); \
22151 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22152 append_glyph_string (&(HEAD), &(TAIL), s); \
22158 n = fill_composite_glyph_string (s, base_face, overlaps); \
22166 /* Add a glyph string for a glyph-string sequence to the list of strings
22167 between HEAD and TAIL. */
22169 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22173 Lisp_Object gstring; \
22175 face_id = (row)->glyphs[area][START].face_id; \
22176 gstring = (composition_gstring_from_id \
22177 ((row)->glyphs[area][START].u.cmp.id)); \
22178 s = (struct glyph_string *) alloca (sizeof *s); \
22179 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22180 * LGSTRING_GLYPH_LEN (gstring)); \
22181 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22182 append_glyph_string (&(HEAD), &(TAIL), s); \
22184 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22188 /* Add a glyph string for a sequence of glyphless character's glyphs
22189 to the list of strings between HEAD and TAIL. The meanings of
22190 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22192 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22197 face_id = (row)->glyphs[area][START].face_id; \
22199 s = (struct glyph_string *) alloca (sizeof *s); \
22200 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22201 append_glyph_string (&HEAD, &TAIL, s); \
22203 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22209 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22210 of AREA of glyph row ROW on window W between indices START and END.
22211 HL overrides the face for drawing glyph strings, e.g. it is
22212 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22213 x-positions of the drawing area.
22215 This is an ugly monster macro construct because we must use alloca
22216 to allocate glyph strings (because draw_glyphs can be called
22217 asynchronously). */
22219 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22222 HEAD = TAIL = NULL; \
22223 while (START < END) \
22225 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22226 switch (first_glyph->type) \
22229 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22233 case COMPOSITE_GLYPH: \
22234 if (first_glyph->u.cmp.automatic) \
22235 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22238 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22242 case STRETCH_GLYPH: \
22243 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22247 case IMAGE_GLYPH: \
22248 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22252 case GLYPHLESS_GLYPH: \
22253 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22263 set_glyph_string_background_width (s, START, LAST_X); \
22270 /* Draw glyphs between START and END in AREA of ROW on window W,
22271 starting at x-position X. X is relative to AREA in W. HL is a
22272 face-override with the following meaning:
22274 DRAW_NORMAL_TEXT draw normally
22275 DRAW_CURSOR draw in cursor face
22276 DRAW_MOUSE_FACE draw in mouse face.
22277 DRAW_INVERSE_VIDEO draw in mode line face
22278 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22279 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22281 If OVERLAPS is non-zero, draw only the foreground of characters and
22282 clip to the physical height of ROW. Non-zero value also defines
22283 the overlapping part to be drawn:
22285 OVERLAPS_PRED overlap with preceding rows
22286 OVERLAPS_SUCC overlap with succeeding rows
22287 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22288 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22290 Value is the x-position reached, relative to AREA of W. */
22293 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22294 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22295 enum draw_glyphs_face hl
, int overlaps
)
22297 struct glyph_string
*head
, *tail
;
22298 struct glyph_string
*s
;
22299 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22300 int i
, j
, x_reached
, last_x
, area_left
= 0;
22301 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22304 ALLOCATE_HDC (hdc
, f
);
22306 /* Let's rather be paranoid than getting a SEGV. */
22307 end
= min (end
, row
->used
[area
]);
22308 start
= max (0, start
);
22309 start
= min (end
, start
);
22311 /* Translate X to frame coordinates. Set last_x to the right
22312 end of the drawing area. */
22313 if (row
->full_width_p
)
22315 /* X is relative to the left edge of W, without scroll bars
22317 area_left
= WINDOW_LEFT_EDGE_X (w
);
22318 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22322 area_left
= window_box_left (w
, area
);
22323 last_x
= area_left
+ window_box_width (w
, area
);
22327 /* Build a doubly-linked list of glyph_string structures between
22328 head and tail from what we have to draw. Note that the macro
22329 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22330 the reason we use a separate variable `i'. */
22332 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22334 x_reached
= tail
->x
+ tail
->background_width
;
22338 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22339 the row, redraw some glyphs in front or following the glyph
22340 strings built above. */
22341 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22343 struct glyph_string
*h
, *t
;
22344 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22345 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22346 int check_mouse_face
= 0;
22349 /* If mouse highlighting is on, we may need to draw adjacent
22350 glyphs using mouse-face highlighting. */
22351 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22353 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22355 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22356 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22358 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22360 check_mouse_face
= 1;
22361 mouse_beg_col
= (row
== mouse_beg_row
)
22362 ? hlinfo
->mouse_face_beg_col
: 0;
22363 mouse_end_col
= (row
== mouse_end_row
)
22364 ? hlinfo
->mouse_face_end_col
22365 : row
->used
[TEXT_AREA
];
22369 /* Compute overhangs for all glyph strings. */
22370 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22371 for (s
= head
; s
; s
= s
->next
)
22372 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22374 /* Prepend glyph strings for glyphs in front of the first glyph
22375 string that are overwritten because of the first glyph
22376 string's left overhang. The background of all strings
22377 prepended must be drawn because the first glyph string
22379 i
= left_overwritten (head
);
22382 enum draw_glyphs_face overlap_hl
;
22384 /* If this row contains mouse highlighting, attempt to draw
22385 the overlapped glyphs with the correct highlight. This
22386 code fails if the overlap encompasses more than one glyph
22387 and mouse-highlight spans only some of these glyphs.
22388 However, making it work perfectly involves a lot more
22389 code, and I don't know if the pathological case occurs in
22390 practice, so we'll stick to this for now. --- cyd */
22391 if (check_mouse_face
22392 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22393 overlap_hl
= DRAW_MOUSE_FACE
;
22395 overlap_hl
= DRAW_NORMAL_TEXT
;
22398 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22399 overlap_hl
, dummy_x
, last_x
);
22401 compute_overhangs_and_x (t
, head
->x
, 1);
22402 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22406 /* Prepend glyph strings for glyphs in front of the first glyph
22407 string that overwrite that glyph string because of their
22408 right overhang. For these strings, only the foreground must
22409 be drawn, because it draws over the glyph string at `head'.
22410 The background must not be drawn because this would overwrite
22411 right overhangs of preceding glyphs for which no glyph
22413 i
= left_overwriting (head
);
22416 enum draw_glyphs_face overlap_hl
;
22418 if (check_mouse_face
22419 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22420 overlap_hl
= DRAW_MOUSE_FACE
;
22422 overlap_hl
= DRAW_NORMAL_TEXT
;
22425 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22426 overlap_hl
, dummy_x
, last_x
);
22427 for (s
= h
; s
; s
= s
->next
)
22428 s
->background_filled_p
= 1;
22429 compute_overhangs_and_x (t
, head
->x
, 1);
22430 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22433 /* Append glyphs strings for glyphs following the last glyph
22434 string tail that are overwritten by tail. The background of
22435 these strings has to be drawn because tail's foreground draws
22437 i
= right_overwritten (tail
);
22440 enum draw_glyphs_face overlap_hl
;
22442 if (check_mouse_face
22443 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22444 overlap_hl
= DRAW_MOUSE_FACE
;
22446 overlap_hl
= DRAW_NORMAL_TEXT
;
22448 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22449 overlap_hl
, x
, last_x
);
22450 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22451 we don't have `end = i;' here. */
22452 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22453 append_glyph_string_lists (&head
, &tail
, h
, t
);
22457 /* Append glyph strings for glyphs following the last glyph
22458 string tail that overwrite tail. The foreground of such
22459 glyphs has to be drawn because it writes into the background
22460 of tail. The background must not be drawn because it could
22461 paint over the foreground of following glyphs. */
22462 i
= right_overwriting (tail
);
22465 enum draw_glyphs_face overlap_hl
;
22466 if (check_mouse_face
22467 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22468 overlap_hl
= DRAW_MOUSE_FACE
;
22470 overlap_hl
= DRAW_NORMAL_TEXT
;
22473 i
++; /* We must include the Ith glyph. */
22474 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22475 overlap_hl
, x
, last_x
);
22476 for (s
= h
; s
; s
= s
->next
)
22477 s
->background_filled_p
= 1;
22478 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22479 append_glyph_string_lists (&head
, &tail
, h
, t
);
22481 if (clip_head
|| clip_tail
)
22482 for (s
= head
; s
; s
= s
->next
)
22484 s
->clip_head
= clip_head
;
22485 s
->clip_tail
= clip_tail
;
22489 /* Draw all strings. */
22490 for (s
= head
; s
; s
= s
->next
)
22491 FRAME_RIF (f
)->draw_glyph_string (s
);
22494 /* When focus a sole frame and move horizontally, this sets on_p to 0
22495 causing a failure to erase prev cursor position. */
22496 if (area
== TEXT_AREA
22497 && !row
->full_width_p
22498 /* When drawing overlapping rows, only the glyph strings'
22499 foreground is drawn, which doesn't erase a cursor
22503 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22504 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22505 : (tail
? tail
->x
+ tail
->background_width
: x
));
22509 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22510 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22514 /* Value is the x-position up to which drawn, relative to AREA of W.
22515 This doesn't include parts drawn because of overhangs. */
22516 if (row
->full_width_p
)
22517 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22519 x_reached
-= area_left
;
22521 RELEASE_HDC (hdc
, f
);
22526 /* Expand row matrix if too narrow. Don't expand if area
22529 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22531 if (!fonts_changed_p \
22532 && (it->glyph_row->glyphs[area] \
22533 < it->glyph_row->glyphs[area + 1])) \
22535 it->w->ncols_scale_factor++; \
22536 fonts_changed_p = 1; \
22540 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22541 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22544 append_glyph (struct it
*it
)
22546 struct glyph
*glyph
;
22547 enum glyph_row_area area
= it
->area
;
22549 xassert (it
->glyph_row
);
22550 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22552 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22553 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22555 /* If the glyph row is reversed, we need to prepend the glyph
22556 rather than append it. */
22557 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22561 /* Make room for the additional glyph. */
22562 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22564 glyph
= it
->glyph_row
->glyphs
[area
];
22566 glyph
->charpos
= CHARPOS (it
->position
);
22567 glyph
->object
= it
->object
;
22568 if (it
->pixel_width
> 0)
22570 glyph
->pixel_width
= it
->pixel_width
;
22571 glyph
->padding_p
= 0;
22575 /* Assure at least 1-pixel width. Otherwise, cursor can't
22576 be displayed correctly. */
22577 glyph
->pixel_width
= 1;
22578 glyph
->padding_p
= 1;
22580 glyph
->ascent
= it
->ascent
;
22581 glyph
->descent
= it
->descent
;
22582 glyph
->voffset
= it
->voffset
;
22583 glyph
->type
= CHAR_GLYPH
;
22584 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22585 glyph
->multibyte_p
= it
->multibyte_p
;
22586 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22587 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22588 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22589 || it
->phys_descent
> it
->descent
);
22590 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22591 glyph
->face_id
= it
->face_id
;
22592 glyph
->u
.ch
= it
->char_to_display
;
22593 glyph
->slice
.img
= null_glyph_slice
;
22594 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22597 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22598 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22600 glyph
->bidi_type
= it
->bidi_it
.type
;
22604 glyph
->resolved_level
= 0;
22605 glyph
->bidi_type
= UNKNOWN_BT
;
22607 ++it
->glyph_row
->used
[area
];
22610 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22613 /* Store one glyph for the composition IT->cmp_it.id in
22614 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22618 append_composite_glyph (struct it
*it
)
22620 struct glyph
*glyph
;
22621 enum glyph_row_area area
= it
->area
;
22623 xassert (it
->glyph_row
);
22625 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22626 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22628 /* If the glyph row is reversed, we need to prepend the glyph
22629 rather than append it. */
22630 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22634 /* Make room for the new glyph. */
22635 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22637 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22639 glyph
->charpos
= it
->cmp_it
.charpos
;
22640 glyph
->object
= it
->object
;
22641 glyph
->pixel_width
= it
->pixel_width
;
22642 glyph
->ascent
= it
->ascent
;
22643 glyph
->descent
= it
->descent
;
22644 glyph
->voffset
= it
->voffset
;
22645 glyph
->type
= COMPOSITE_GLYPH
;
22646 if (it
->cmp_it
.ch
< 0)
22648 glyph
->u
.cmp
.automatic
= 0;
22649 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22650 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22654 glyph
->u
.cmp
.automatic
= 1;
22655 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22656 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22657 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22659 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22660 glyph
->multibyte_p
= it
->multibyte_p
;
22661 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22662 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22663 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22664 || it
->phys_descent
> it
->descent
);
22665 glyph
->padding_p
= 0;
22666 glyph
->glyph_not_available_p
= 0;
22667 glyph
->face_id
= it
->face_id
;
22668 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22671 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22672 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22674 glyph
->bidi_type
= it
->bidi_it
.type
;
22676 ++it
->glyph_row
->used
[area
];
22679 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22683 /* Change IT->ascent and IT->height according to the setting of
22687 take_vertical_position_into_account (struct it
*it
)
22691 if (it
->voffset
< 0)
22692 /* Increase the ascent so that we can display the text higher
22694 it
->ascent
-= it
->voffset
;
22696 /* Increase the descent so that we can display the text lower
22698 it
->descent
+= it
->voffset
;
22703 /* Produce glyphs/get display metrics for the image IT is loaded with.
22704 See the description of struct display_iterator in dispextern.h for
22705 an overview of struct display_iterator. */
22708 produce_image_glyph (struct it
*it
)
22712 int glyph_ascent
, crop
;
22713 struct glyph_slice slice
;
22715 xassert (it
->what
== IT_IMAGE
);
22717 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22719 /* Make sure X resources of the face is loaded. */
22720 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22722 if (it
->image_id
< 0)
22724 /* Fringe bitmap. */
22725 it
->ascent
= it
->phys_ascent
= 0;
22726 it
->descent
= it
->phys_descent
= 0;
22727 it
->pixel_width
= 0;
22732 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22734 /* Make sure X resources of the image is loaded. */
22735 prepare_image_for_display (it
->f
, img
);
22737 slice
.x
= slice
.y
= 0;
22738 slice
.width
= img
->width
;
22739 slice
.height
= img
->height
;
22741 if (INTEGERP (it
->slice
.x
))
22742 slice
.x
= XINT (it
->slice
.x
);
22743 else if (FLOATP (it
->slice
.x
))
22744 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22746 if (INTEGERP (it
->slice
.y
))
22747 slice
.y
= XINT (it
->slice
.y
);
22748 else if (FLOATP (it
->slice
.y
))
22749 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22751 if (INTEGERP (it
->slice
.width
))
22752 slice
.width
= XINT (it
->slice
.width
);
22753 else if (FLOATP (it
->slice
.width
))
22754 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22756 if (INTEGERP (it
->slice
.height
))
22757 slice
.height
= XINT (it
->slice
.height
);
22758 else if (FLOATP (it
->slice
.height
))
22759 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22761 if (slice
.x
>= img
->width
)
22762 slice
.x
= img
->width
;
22763 if (slice
.y
>= img
->height
)
22764 slice
.y
= img
->height
;
22765 if (slice
.x
+ slice
.width
>= img
->width
)
22766 slice
.width
= img
->width
- slice
.x
;
22767 if (slice
.y
+ slice
.height
> img
->height
)
22768 slice
.height
= img
->height
- slice
.y
;
22770 if (slice
.width
== 0 || slice
.height
== 0)
22773 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22775 it
->descent
= slice
.height
- glyph_ascent
;
22777 it
->descent
+= img
->vmargin
;
22778 if (slice
.y
+ slice
.height
== img
->height
)
22779 it
->descent
+= img
->vmargin
;
22780 it
->phys_descent
= it
->descent
;
22782 it
->pixel_width
= slice
.width
;
22784 it
->pixel_width
+= img
->hmargin
;
22785 if (slice
.x
+ slice
.width
== img
->width
)
22786 it
->pixel_width
+= img
->hmargin
;
22788 /* It's quite possible for images to have an ascent greater than
22789 their height, so don't get confused in that case. */
22790 if (it
->descent
< 0)
22795 if (face
->box
!= FACE_NO_BOX
)
22797 if (face
->box_line_width
> 0)
22800 it
->ascent
+= face
->box_line_width
;
22801 if (slice
.y
+ slice
.height
== img
->height
)
22802 it
->descent
+= face
->box_line_width
;
22805 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22806 it
->pixel_width
+= eabs (face
->box_line_width
);
22807 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22808 it
->pixel_width
+= eabs (face
->box_line_width
);
22811 take_vertical_position_into_account (it
);
22813 /* Automatically crop wide image glyphs at right edge so we can
22814 draw the cursor on same display row. */
22815 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22816 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22818 it
->pixel_width
-= crop
;
22819 slice
.width
-= crop
;
22824 struct glyph
*glyph
;
22825 enum glyph_row_area area
= it
->area
;
22827 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22828 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22830 glyph
->charpos
= CHARPOS (it
->position
);
22831 glyph
->object
= it
->object
;
22832 glyph
->pixel_width
= it
->pixel_width
;
22833 glyph
->ascent
= glyph_ascent
;
22834 glyph
->descent
= it
->descent
;
22835 glyph
->voffset
= it
->voffset
;
22836 glyph
->type
= IMAGE_GLYPH
;
22837 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22838 glyph
->multibyte_p
= it
->multibyte_p
;
22839 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22840 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22841 glyph
->overlaps_vertically_p
= 0;
22842 glyph
->padding_p
= 0;
22843 glyph
->glyph_not_available_p
= 0;
22844 glyph
->face_id
= it
->face_id
;
22845 glyph
->u
.img_id
= img
->id
;
22846 glyph
->slice
.img
= slice
;
22847 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22850 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22851 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22853 glyph
->bidi_type
= it
->bidi_it
.type
;
22855 ++it
->glyph_row
->used
[area
];
22858 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22863 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22864 of the glyph, WIDTH and HEIGHT are the width and height of the
22865 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22868 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22869 int width
, int height
, int ascent
)
22871 struct glyph
*glyph
;
22872 enum glyph_row_area area
= it
->area
;
22874 xassert (ascent
>= 0 && ascent
<= height
);
22876 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22877 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22879 /* If the glyph row is reversed, we need to prepend the glyph
22880 rather than append it. */
22881 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22885 /* Make room for the additional glyph. */
22886 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22888 glyph
= it
->glyph_row
->glyphs
[area
];
22890 glyph
->charpos
= CHARPOS (it
->position
);
22891 glyph
->object
= object
;
22892 glyph
->pixel_width
= width
;
22893 glyph
->ascent
= ascent
;
22894 glyph
->descent
= height
- ascent
;
22895 glyph
->voffset
= it
->voffset
;
22896 glyph
->type
= STRETCH_GLYPH
;
22897 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22898 glyph
->multibyte_p
= it
->multibyte_p
;
22899 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22900 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22901 glyph
->overlaps_vertically_p
= 0;
22902 glyph
->padding_p
= 0;
22903 glyph
->glyph_not_available_p
= 0;
22904 glyph
->face_id
= it
->face_id
;
22905 glyph
->u
.stretch
.ascent
= ascent
;
22906 glyph
->u
.stretch
.height
= height
;
22907 glyph
->slice
.img
= null_glyph_slice
;
22908 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22911 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22912 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22914 glyph
->bidi_type
= it
->bidi_it
.type
;
22918 glyph
->resolved_level
= 0;
22919 glyph
->bidi_type
= UNKNOWN_BT
;
22921 ++it
->glyph_row
->used
[area
];
22924 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22928 /* Produce a stretch glyph for iterator IT. IT->object is the value
22929 of the glyph property displayed. The value must be a list
22930 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22933 1. `:width WIDTH' specifies that the space should be WIDTH *
22934 canonical char width wide. WIDTH may be an integer or floating
22937 2. `:relative-width FACTOR' specifies that the width of the stretch
22938 should be computed from the width of the first character having the
22939 `glyph' property, and should be FACTOR times that width.
22941 3. `:align-to HPOS' specifies that the space should be wide enough
22942 to reach HPOS, a value in canonical character units.
22944 Exactly one of the above pairs must be present.
22946 4. `:height HEIGHT' specifies that the height of the stretch produced
22947 should be HEIGHT, measured in canonical character units.
22949 5. `:relative-height FACTOR' specifies that the height of the
22950 stretch should be FACTOR times the height of the characters having
22951 the glyph property.
22953 Either none or exactly one of 4 or 5 must be present.
22955 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22956 of the stretch should be used for the ascent of the stretch.
22957 ASCENT must be in the range 0 <= ASCENT <= 100. */
22960 produce_stretch_glyph (struct it
*it
)
22962 /* (space :width WIDTH :height HEIGHT ...) */
22963 Lisp_Object prop
, plist
;
22964 int width
= 0, height
= 0, align_to
= -1;
22965 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22968 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22969 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22971 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22973 /* List should start with `space'. */
22974 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22975 plist
= XCDR (it
->object
);
22977 /* Compute the width of the stretch. */
22978 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22979 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22981 /* Absolute width `:width WIDTH' specified and valid. */
22982 zero_width_ok_p
= 1;
22985 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22988 /* Relative width `:relative-width FACTOR' specified and valid.
22989 Compute the width of the characters having the `glyph'
22992 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22995 if (it
->multibyte_p
)
22996 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22999 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23000 if (! ASCII_CHAR_P (it2
.c
))
23001 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23004 it2
.glyph_row
= NULL
;
23005 it2
.what
= IT_CHARACTER
;
23006 x_produce_glyphs (&it2
);
23007 width
= NUMVAL (prop
) * it2
.pixel_width
;
23009 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23010 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23012 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23013 align_to
= (align_to
< 0
23015 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23016 else if (align_to
< 0)
23017 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23018 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23019 zero_width_ok_p
= 1;
23022 /* Nothing specified -> width defaults to canonical char width. */
23023 width
= FRAME_COLUMN_WIDTH (it
->f
);
23025 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23028 /* Compute height. */
23029 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23030 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23033 zero_height_ok_p
= 1;
23035 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23037 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23039 height
= FONT_HEIGHT (font
);
23041 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23044 /* Compute percentage of height used for ascent. If
23045 `:ascent ASCENT' is present and valid, use that. Otherwise,
23046 derive the ascent from the font in use. */
23047 if (prop
= Fplist_get (plist
, QCascent
),
23048 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23049 ascent
= height
* NUMVAL (prop
) / 100.0;
23050 else if (!NILP (prop
)
23051 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23052 ascent
= min (max (0, (int)tem
), height
);
23054 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23056 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23057 && it
->current_x
+ width
> it
->last_visible_x
)
23058 width
= it
->last_visible_x
- it
->current_x
- 1;
23060 if (width
> 0 && height
> 0 && it
->glyph_row
)
23062 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23063 if (!STRINGP (object
))
23064 object
= it
->w
->buffer
;
23065 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23068 it
->pixel_width
= width
;
23069 it
->ascent
= it
->phys_ascent
= ascent
;
23070 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23071 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23073 take_vertical_position_into_account (it
);
23076 /* Calculate line-height and line-spacing properties.
23077 An integer value specifies explicit pixel value.
23078 A float value specifies relative value to current face height.
23079 A cons (float . face-name) specifies relative value to
23080 height of specified face font.
23082 Returns height in pixels, or nil. */
23086 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23087 int boff
, int override
)
23089 Lisp_Object face_name
= Qnil
;
23090 int ascent
, descent
, height
;
23092 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23097 face_name
= XCAR (val
);
23099 if (!NUMBERP (val
))
23100 val
= make_number (1);
23101 if (NILP (face_name
))
23103 height
= it
->ascent
+ it
->descent
;
23108 if (NILP (face_name
))
23110 font
= FRAME_FONT (it
->f
);
23111 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23113 else if (EQ (face_name
, Qt
))
23122 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23124 return make_number (-1);
23126 face
= FACE_FROM_ID (it
->f
, face_id
);
23129 return make_number (-1);
23130 boff
= font
->baseline_offset
;
23131 if (font
->vertical_centering
)
23132 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23135 ascent
= FONT_BASE (font
) + boff
;
23136 descent
= FONT_DESCENT (font
) - boff
;
23140 it
->override_ascent
= ascent
;
23141 it
->override_descent
= descent
;
23142 it
->override_boff
= boff
;
23145 height
= ascent
+ descent
;
23149 height
= (int)(XFLOAT_DATA (val
) * height
);
23150 else if (INTEGERP (val
))
23151 height
*= XINT (val
);
23153 return make_number (height
);
23157 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23158 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23159 and only if this is for a character for which no font was found.
23161 If the display method (it->glyphless_method) is
23162 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23163 length of the acronym or the hexadecimal string, UPPER_XOFF and
23164 UPPER_YOFF are pixel offsets for the upper part of the string,
23165 LOWER_XOFF and LOWER_YOFF are for the lower part.
23167 For the other display methods, LEN through LOWER_YOFF are zero. */
23170 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23171 short upper_xoff
, short upper_yoff
,
23172 short lower_xoff
, short lower_yoff
)
23174 struct glyph
*glyph
;
23175 enum glyph_row_area area
= it
->area
;
23177 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23178 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23180 /* If the glyph row is reversed, we need to prepend the glyph
23181 rather than append it. */
23182 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23186 /* Make room for the additional glyph. */
23187 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23189 glyph
= it
->glyph_row
->glyphs
[area
];
23191 glyph
->charpos
= CHARPOS (it
->position
);
23192 glyph
->object
= it
->object
;
23193 glyph
->pixel_width
= it
->pixel_width
;
23194 glyph
->ascent
= it
->ascent
;
23195 glyph
->descent
= it
->descent
;
23196 glyph
->voffset
= it
->voffset
;
23197 glyph
->type
= GLYPHLESS_GLYPH
;
23198 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23199 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23200 glyph
->u
.glyphless
.len
= len
;
23201 glyph
->u
.glyphless
.ch
= it
->c
;
23202 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23203 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23204 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23205 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23206 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23207 glyph
->multibyte_p
= it
->multibyte_p
;
23208 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23209 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23210 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23211 || it
->phys_descent
> it
->descent
);
23212 glyph
->padding_p
= 0;
23213 glyph
->glyph_not_available_p
= 0;
23214 glyph
->face_id
= face_id
;
23215 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23218 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23219 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23221 glyph
->bidi_type
= it
->bidi_it
.type
;
23223 ++it
->glyph_row
->used
[area
];
23226 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23230 /* Produce a glyph for a glyphless character for iterator IT.
23231 IT->glyphless_method specifies which method to use for displaying
23232 the character. See the description of enum
23233 glyphless_display_method in dispextern.h for the detail.
23235 FOR_NO_FONT is nonzero if and only if this is for a character for
23236 which no font was found. ACRONYM, if non-nil, is an acronym string
23237 for the character. */
23240 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23245 int base_width
, base_height
, width
, height
;
23246 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23249 /* Get the metrics of the base font. We always refer to the current
23251 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23252 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23253 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23254 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23255 base_height
= it
->ascent
+ it
->descent
;
23256 base_width
= font
->average_width
;
23258 /* Get a face ID for the glyph by utilizing a cache (the same way as
23259 done for `escape-glyph' in get_next_display_element). */
23260 if (it
->f
== last_glyphless_glyph_frame
23261 && it
->face_id
== last_glyphless_glyph_face_id
)
23263 face_id
= last_glyphless_glyph_merged_face_id
;
23267 /* Merge the `glyphless-char' face into the current face. */
23268 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23269 last_glyphless_glyph_frame
= it
->f
;
23270 last_glyphless_glyph_face_id
= it
->face_id
;
23271 last_glyphless_glyph_merged_face_id
= face_id
;
23274 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23276 it
->pixel_width
= THIN_SPACE_WIDTH
;
23278 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23280 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23282 width
= CHAR_WIDTH (it
->c
);
23285 else if (width
> 4)
23287 it
->pixel_width
= base_width
* width
;
23289 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23295 unsigned int code
[6];
23297 int ascent
, descent
;
23298 struct font_metrics metrics_upper
, metrics_lower
;
23300 face
= FACE_FROM_ID (it
->f
, face_id
);
23301 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23302 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23304 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23306 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23307 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23308 if (CONSP (acronym
))
23309 acronym
= XCAR (acronym
);
23310 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23314 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23315 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23318 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23319 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23320 upper_len
= (len
+ 1) / 2;
23321 font
->driver
->text_extents (font
, code
, upper_len
,
23323 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23328 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23329 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23330 upper_xoff
= upper_yoff
= 2; /* the typical case */
23331 if (base_width
>= width
)
23333 /* Align the upper to the left, the lower to the right. */
23334 it
->pixel_width
= base_width
;
23335 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23339 /* Center the shorter one. */
23340 it
->pixel_width
= width
;
23341 if (metrics_upper
.width
>= metrics_lower
.width
)
23342 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23345 /* FIXME: This code doesn't look right. It formerly was
23346 missing the "lower_xoff = 0;", which couldn't have
23347 been right since it left lower_xoff uninitialized. */
23349 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23353 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23354 top, bottom, and between upper and lower strings. */
23355 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23356 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23357 /* Center vertically.
23358 H:base_height, D:base_descent
23359 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23361 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23362 descent = D - H/2 + h/2;
23363 lower_yoff = descent - 2 - ld;
23364 upper_yoff = lower_yoff - la - 1 - ud; */
23365 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23366 descent
= it
->descent
- (base_height
- height
) / 2;
23367 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23368 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23369 - metrics_upper
.descent
);
23370 /* Don't make the height shorter than the base height. */
23371 if (height
> base_height
)
23373 it
->ascent
= ascent
;
23374 it
->descent
= descent
;
23378 it
->phys_ascent
= it
->ascent
;
23379 it
->phys_descent
= it
->descent
;
23381 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23382 upper_xoff
, upper_yoff
,
23383 lower_xoff
, lower_yoff
);
23385 take_vertical_position_into_account (it
);
23390 Produce glyphs/get display metrics for the display element IT is
23391 loaded with. See the description of struct it in dispextern.h
23392 for an overview of struct it. */
23395 x_produce_glyphs (struct it
*it
)
23397 int extra_line_spacing
= it
->extra_line_spacing
;
23399 it
->glyph_not_available_p
= 0;
23401 if (it
->what
== IT_CHARACTER
)
23404 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23405 struct font
*font
= face
->font
;
23406 struct font_metrics
*pcm
= NULL
;
23407 int boff
; /* baseline offset */
23411 /* When no suitable font is found, display this character by
23412 the method specified in the first extra slot of
23413 Vglyphless_char_display. */
23414 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23416 xassert (it
->what
== IT_GLYPHLESS
);
23417 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23421 boff
= font
->baseline_offset
;
23422 if (font
->vertical_centering
)
23423 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23425 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23431 if (it
->override_ascent
>= 0)
23433 it
->ascent
= it
->override_ascent
;
23434 it
->descent
= it
->override_descent
;
23435 boff
= it
->override_boff
;
23439 it
->ascent
= FONT_BASE (font
) + boff
;
23440 it
->descent
= FONT_DESCENT (font
) - boff
;
23443 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23445 pcm
= get_per_char_metric (font
, &char2b
);
23446 if (pcm
->width
== 0
23447 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23453 it
->phys_ascent
= pcm
->ascent
+ boff
;
23454 it
->phys_descent
= pcm
->descent
- boff
;
23455 it
->pixel_width
= pcm
->width
;
23459 it
->glyph_not_available_p
= 1;
23460 it
->phys_ascent
= it
->ascent
;
23461 it
->phys_descent
= it
->descent
;
23462 it
->pixel_width
= font
->space_width
;
23465 if (it
->constrain_row_ascent_descent_p
)
23467 if (it
->descent
> it
->max_descent
)
23469 it
->ascent
+= it
->descent
- it
->max_descent
;
23470 it
->descent
= it
->max_descent
;
23472 if (it
->ascent
> it
->max_ascent
)
23474 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23475 it
->ascent
= it
->max_ascent
;
23477 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23478 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23479 extra_line_spacing
= 0;
23482 /* If this is a space inside a region of text with
23483 `space-width' property, change its width. */
23484 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23486 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23488 /* If face has a box, add the box thickness to the character
23489 height. If character has a box line to the left and/or
23490 right, add the box line width to the character's width. */
23491 if (face
->box
!= FACE_NO_BOX
)
23493 int thick
= face
->box_line_width
;
23497 it
->ascent
+= thick
;
23498 it
->descent
+= thick
;
23503 if (it
->start_of_box_run_p
)
23504 it
->pixel_width
+= thick
;
23505 if (it
->end_of_box_run_p
)
23506 it
->pixel_width
+= thick
;
23509 /* If face has an overline, add the height of the overline
23510 (1 pixel) and a 1 pixel margin to the character height. */
23511 if (face
->overline_p
)
23512 it
->ascent
+= overline_margin
;
23514 if (it
->constrain_row_ascent_descent_p
)
23516 if (it
->ascent
> it
->max_ascent
)
23517 it
->ascent
= it
->max_ascent
;
23518 if (it
->descent
> it
->max_descent
)
23519 it
->descent
= it
->max_descent
;
23522 take_vertical_position_into_account (it
);
23524 /* If we have to actually produce glyphs, do it. */
23529 /* Translate a space with a `space-width' property
23530 into a stretch glyph. */
23531 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23532 / FONT_HEIGHT (font
));
23533 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23534 it
->ascent
+ it
->descent
, ascent
);
23539 /* If characters with lbearing or rbearing are displayed
23540 in this line, record that fact in a flag of the
23541 glyph row. This is used to optimize X output code. */
23542 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23543 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23545 if (! stretched_p
&& it
->pixel_width
== 0)
23546 /* We assure that all visible glyphs have at least 1-pixel
23548 it
->pixel_width
= 1;
23550 else if (it
->char_to_display
== '\n')
23552 /* A newline has no width, but we need the height of the
23553 line. But if previous part of the line sets a height,
23554 don't increase that height */
23556 Lisp_Object height
;
23557 Lisp_Object total_height
= Qnil
;
23559 it
->override_ascent
= -1;
23560 it
->pixel_width
= 0;
23563 height
= get_it_property (it
, Qline_height
);
23564 /* Split (line-height total-height) list */
23566 && CONSP (XCDR (height
))
23567 && NILP (XCDR (XCDR (height
))))
23569 total_height
= XCAR (XCDR (height
));
23570 height
= XCAR (height
);
23572 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23574 if (it
->override_ascent
>= 0)
23576 it
->ascent
= it
->override_ascent
;
23577 it
->descent
= it
->override_descent
;
23578 boff
= it
->override_boff
;
23582 it
->ascent
= FONT_BASE (font
) + boff
;
23583 it
->descent
= FONT_DESCENT (font
) - boff
;
23586 if (EQ (height
, Qt
))
23588 if (it
->descent
> it
->max_descent
)
23590 it
->ascent
+= it
->descent
- it
->max_descent
;
23591 it
->descent
= it
->max_descent
;
23593 if (it
->ascent
> it
->max_ascent
)
23595 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23596 it
->ascent
= it
->max_ascent
;
23598 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23599 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23600 it
->constrain_row_ascent_descent_p
= 1;
23601 extra_line_spacing
= 0;
23605 Lisp_Object spacing
;
23607 it
->phys_ascent
= it
->ascent
;
23608 it
->phys_descent
= it
->descent
;
23610 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23611 && face
->box
!= FACE_NO_BOX
23612 && face
->box_line_width
> 0)
23614 it
->ascent
+= face
->box_line_width
;
23615 it
->descent
+= face
->box_line_width
;
23618 && XINT (height
) > it
->ascent
+ it
->descent
)
23619 it
->ascent
= XINT (height
) - it
->descent
;
23621 if (!NILP (total_height
))
23622 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23625 spacing
= get_it_property (it
, Qline_spacing
);
23626 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23628 if (INTEGERP (spacing
))
23630 extra_line_spacing
= XINT (spacing
);
23631 if (!NILP (total_height
))
23632 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23636 else /* i.e. (it->char_to_display == '\t') */
23638 if (font
->space_width
> 0)
23640 int tab_width
= it
->tab_width
* font
->space_width
;
23641 int x
= it
->current_x
+ it
->continuation_lines_width
;
23642 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23644 /* If the distance from the current position to the next tab
23645 stop is less than a space character width, use the
23646 tab stop after that. */
23647 if (next_tab_x
- x
< font
->space_width
)
23648 next_tab_x
+= tab_width
;
23650 it
->pixel_width
= next_tab_x
- x
;
23652 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23653 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23657 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23658 it
->ascent
+ it
->descent
, it
->ascent
);
23663 it
->pixel_width
= 0;
23668 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23670 /* A static composition.
23672 Note: A composition is represented as one glyph in the
23673 glyph matrix. There are no padding glyphs.
23675 Important note: pixel_width, ascent, and descent are the
23676 values of what is drawn by draw_glyphs (i.e. the values of
23677 the overall glyphs composed). */
23678 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23679 int boff
; /* baseline offset */
23680 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23681 int glyph_len
= cmp
->glyph_len
;
23682 struct font
*font
= face
->font
;
23686 /* If we have not yet calculated pixel size data of glyphs of
23687 the composition for the current face font, calculate them
23688 now. Theoretically, we have to check all fonts for the
23689 glyphs, but that requires much time and memory space. So,
23690 here we check only the font of the first glyph. This may
23691 lead to incorrect display, but it's very rare, and C-l
23692 (recenter-top-bottom) can correct the display anyway. */
23693 if (! cmp
->font
|| cmp
->font
!= font
)
23695 /* Ascent and descent of the font of the first character
23696 of this composition (adjusted by baseline offset).
23697 Ascent and descent of overall glyphs should not be less
23698 than these, respectively. */
23699 int font_ascent
, font_descent
, font_height
;
23700 /* Bounding box of the overall glyphs. */
23701 int leftmost
, rightmost
, lowest
, highest
;
23702 int lbearing
, rbearing
;
23703 int i
, width
, ascent
, descent
;
23704 int left_padded
= 0, right_padded
= 0;
23705 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23707 struct font_metrics
*pcm
;
23708 int font_not_found_p
;
23711 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23712 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23714 if (glyph_len
< cmp
->glyph_len
)
23716 for (i
= 0; i
< glyph_len
; i
++)
23718 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23720 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23725 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23726 : IT_CHARPOS (*it
));
23727 /* If no suitable font is found, use the default font. */
23728 font_not_found_p
= font
== NULL
;
23729 if (font_not_found_p
)
23731 face
= face
->ascii_face
;
23734 boff
= font
->baseline_offset
;
23735 if (font
->vertical_centering
)
23736 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23737 font_ascent
= FONT_BASE (font
) + boff
;
23738 font_descent
= FONT_DESCENT (font
) - boff
;
23739 font_height
= FONT_HEIGHT (font
);
23741 cmp
->font
= (void *) font
;
23744 if (! font_not_found_p
)
23746 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23748 pcm
= get_per_char_metric (font
, &char2b
);
23751 /* Initialize the bounding box. */
23754 width
= pcm
->width
;
23755 ascent
= pcm
->ascent
;
23756 descent
= pcm
->descent
;
23757 lbearing
= pcm
->lbearing
;
23758 rbearing
= pcm
->rbearing
;
23762 width
= font
->space_width
;
23763 ascent
= FONT_BASE (font
);
23764 descent
= FONT_DESCENT (font
);
23771 lowest
= - descent
+ boff
;
23772 highest
= ascent
+ boff
;
23774 if (! font_not_found_p
23775 && font
->default_ascent
23776 && CHAR_TABLE_P (Vuse_default_ascent
)
23777 && !NILP (Faref (Vuse_default_ascent
,
23778 make_number (it
->char_to_display
))))
23779 highest
= font
->default_ascent
+ boff
;
23781 /* Draw the first glyph at the normal position. It may be
23782 shifted to right later if some other glyphs are drawn
23784 cmp
->offsets
[i
* 2] = 0;
23785 cmp
->offsets
[i
* 2 + 1] = boff
;
23786 cmp
->lbearing
= lbearing
;
23787 cmp
->rbearing
= rbearing
;
23789 /* Set cmp->offsets for the remaining glyphs. */
23790 for (i
++; i
< glyph_len
; i
++)
23792 int left
, right
, btm
, top
;
23793 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23795 struct face
*this_face
;
23799 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23800 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23801 font
= this_face
->font
;
23807 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23809 pcm
= get_per_char_metric (font
, &char2b
);
23812 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23815 width
= pcm
->width
;
23816 ascent
= pcm
->ascent
;
23817 descent
= pcm
->descent
;
23818 lbearing
= pcm
->lbearing
;
23819 rbearing
= pcm
->rbearing
;
23820 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23822 /* Relative composition with or without
23823 alternate chars. */
23824 left
= (leftmost
+ rightmost
- width
) / 2;
23825 btm
= - descent
+ boff
;
23826 if (font
->relative_compose
23827 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23828 || NILP (Faref (Vignore_relative_composition
,
23829 make_number (ch
)))))
23832 if (- descent
>= font
->relative_compose
)
23833 /* One extra pixel between two glyphs. */
23835 else if (ascent
<= 0)
23836 /* One extra pixel between two glyphs. */
23837 btm
= lowest
- 1 - ascent
- descent
;
23842 /* A composition rule is specified by an integer
23843 value that encodes global and new reference
23844 points (GREF and NREF). GREF and NREF are
23845 specified by numbers as below:
23847 0---1---2 -- ascent
23851 9--10--11 -- center
23853 ---3---4---5--- baseline
23855 6---7---8 -- descent
23857 int rule
= COMPOSITION_RULE (cmp
, i
);
23858 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23860 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23861 grefx
= gref
% 3, nrefx
= nref
% 3;
23862 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23864 xoff
= font_height
* (xoff
- 128) / 256;
23866 yoff
= font_height
* (yoff
- 128) / 256;
23869 + grefx
* (rightmost
- leftmost
) / 2
23870 - nrefx
* width
/ 2
23873 btm
= ((grefy
== 0 ? highest
23875 : grefy
== 2 ? lowest
23876 : (highest
+ lowest
) / 2)
23877 - (nrefy
== 0 ? ascent
+ descent
23878 : nrefy
== 1 ? descent
- boff
23880 : (ascent
+ descent
) / 2)
23884 cmp
->offsets
[i
* 2] = left
;
23885 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23887 /* Update the bounding box of the overall glyphs. */
23890 right
= left
+ width
;
23891 if (left
< leftmost
)
23893 if (right
> rightmost
)
23896 top
= btm
+ descent
+ ascent
;
23902 if (cmp
->lbearing
> left
+ lbearing
)
23903 cmp
->lbearing
= left
+ lbearing
;
23904 if (cmp
->rbearing
< left
+ rbearing
)
23905 cmp
->rbearing
= left
+ rbearing
;
23909 /* If there are glyphs whose x-offsets are negative,
23910 shift all glyphs to the right and make all x-offsets
23914 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23915 cmp
->offsets
[i
* 2] -= leftmost
;
23916 rightmost
-= leftmost
;
23917 cmp
->lbearing
-= leftmost
;
23918 cmp
->rbearing
-= leftmost
;
23921 if (left_padded
&& cmp
->lbearing
< 0)
23923 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23924 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23925 rightmost
-= cmp
->lbearing
;
23926 cmp
->rbearing
-= cmp
->lbearing
;
23929 if (right_padded
&& rightmost
< cmp
->rbearing
)
23931 rightmost
= cmp
->rbearing
;
23934 cmp
->pixel_width
= rightmost
;
23935 cmp
->ascent
= highest
;
23936 cmp
->descent
= - lowest
;
23937 if (cmp
->ascent
< font_ascent
)
23938 cmp
->ascent
= font_ascent
;
23939 if (cmp
->descent
< font_descent
)
23940 cmp
->descent
= font_descent
;
23944 && (cmp
->lbearing
< 0
23945 || cmp
->rbearing
> cmp
->pixel_width
))
23946 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23948 it
->pixel_width
= cmp
->pixel_width
;
23949 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23950 it
->descent
= it
->phys_descent
= cmp
->descent
;
23951 if (face
->box
!= FACE_NO_BOX
)
23953 int thick
= face
->box_line_width
;
23957 it
->ascent
+= thick
;
23958 it
->descent
+= thick
;
23963 if (it
->start_of_box_run_p
)
23964 it
->pixel_width
+= thick
;
23965 if (it
->end_of_box_run_p
)
23966 it
->pixel_width
+= thick
;
23969 /* If face has an overline, add the height of the overline
23970 (1 pixel) and a 1 pixel margin to the character height. */
23971 if (face
->overline_p
)
23972 it
->ascent
+= overline_margin
;
23974 take_vertical_position_into_account (it
);
23975 if (it
->ascent
< 0)
23977 if (it
->descent
< 0)
23981 append_composite_glyph (it
);
23983 else if (it
->what
== IT_COMPOSITION
)
23985 /* A dynamic (automatic) composition. */
23986 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23987 Lisp_Object gstring
;
23988 struct font_metrics metrics
;
23990 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23992 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23995 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23996 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23997 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23998 it
->descent
= it
->phys_descent
= metrics
.descent
;
23999 if (face
->box
!= FACE_NO_BOX
)
24001 int thick
= face
->box_line_width
;
24005 it
->ascent
+= thick
;
24006 it
->descent
+= thick
;
24011 if (it
->start_of_box_run_p
)
24012 it
->pixel_width
+= thick
;
24013 if (it
->end_of_box_run_p
)
24014 it
->pixel_width
+= thick
;
24016 /* If face has an overline, add the height of the overline
24017 (1 pixel) and a 1 pixel margin to the character height. */
24018 if (face
->overline_p
)
24019 it
->ascent
+= overline_margin
;
24020 take_vertical_position_into_account (it
);
24021 if (it
->ascent
< 0)
24023 if (it
->descent
< 0)
24027 append_composite_glyph (it
);
24029 else if (it
->what
== IT_GLYPHLESS
)
24030 produce_glyphless_glyph (it
, 0, Qnil
);
24031 else if (it
->what
== IT_IMAGE
)
24032 produce_image_glyph (it
);
24033 else if (it
->what
== IT_STRETCH
)
24034 produce_stretch_glyph (it
);
24037 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24038 because this isn't true for images with `:ascent 100'. */
24039 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24040 if (it
->area
== TEXT_AREA
)
24041 it
->current_x
+= it
->pixel_width
;
24043 if (extra_line_spacing
> 0)
24045 it
->descent
+= extra_line_spacing
;
24046 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24047 it
->max_extra_line_spacing
= extra_line_spacing
;
24050 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24051 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24052 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24053 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24057 Output LEN glyphs starting at START at the nominal cursor position.
24058 Advance the nominal cursor over the text. The global variable
24059 updated_window contains the window being updated, updated_row is
24060 the glyph row being updated, and updated_area is the area of that
24061 row being updated. */
24064 x_write_glyphs (struct glyph
*start
, int len
)
24068 xassert (updated_window
&& updated_row
);
24071 /* Write glyphs. */
24073 hpos
= start
- updated_row
->glyphs
[updated_area
];
24074 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24075 updated_row
, updated_area
,
24077 DRAW_NORMAL_TEXT
, 0);
24079 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24080 if (updated_area
== TEXT_AREA
24081 && updated_window
->phys_cursor_on_p
24082 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24083 && updated_window
->phys_cursor
.hpos
>= hpos
24084 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24085 updated_window
->phys_cursor_on_p
= 0;
24089 /* Advance the output cursor. */
24090 output_cursor
.hpos
+= len
;
24091 output_cursor
.x
= x
;
24096 Insert LEN glyphs from START at the nominal cursor position. */
24099 x_insert_glyphs (struct glyph
*start
, int len
)
24103 int line_height
, shift_by_width
, shifted_region_width
;
24104 struct glyph_row
*row
;
24105 struct glyph
*glyph
;
24106 int frame_x
, frame_y
;
24109 xassert (updated_window
&& updated_row
);
24111 w
= updated_window
;
24112 f
= XFRAME (WINDOW_FRAME (w
));
24114 /* Get the height of the line we are in. */
24116 line_height
= row
->height
;
24118 /* Get the width of the glyphs to insert. */
24119 shift_by_width
= 0;
24120 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24121 shift_by_width
+= glyph
->pixel_width
;
24123 /* Get the width of the region to shift right. */
24124 shifted_region_width
= (window_box_width (w
, updated_area
)
24129 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24130 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24132 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24133 line_height
, shift_by_width
);
24135 /* Write the glyphs. */
24136 hpos
= start
- row
->glyphs
[updated_area
];
24137 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24139 DRAW_NORMAL_TEXT
, 0);
24141 /* Advance the output cursor. */
24142 output_cursor
.hpos
+= len
;
24143 output_cursor
.x
+= shift_by_width
;
24149 Erase the current text line from the nominal cursor position
24150 (inclusive) to pixel column TO_X (exclusive). The idea is that
24151 everything from TO_X onward is already erased.
24153 TO_X is a pixel position relative to updated_area of
24154 updated_window. TO_X == -1 means clear to the end of this area. */
24157 x_clear_end_of_line (int to_x
)
24160 struct window
*w
= updated_window
;
24161 int max_x
, min_y
, max_y
;
24162 int from_x
, from_y
, to_y
;
24164 xassert (updated_window
&& updated_row
);
24165 f
= XFRAME (w
->frame
);
24167 if (updated_row
->full_width_p
)
24168 max_x
= WINDOW_TOTAL_WIDTH (w
);
24170 max_x
= window_box_width (w
, updated_area
);
24171 max_y
= window_text_bottom_y (w
);
24173 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24174 of window. For TO_X > 0, truncate to end of drawing area. */
24180 to_x
= min (to_x
, max_x
);
24182 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24184 /* Notice if the cursor will be cleared by this operation. */
24185 if (!updated_row
->full_width_p
)
24186 notice_overwritten_cursor (w
, updated_area
,
24187 output_cursor
.x
, -1,
24189 MATRIX_ROW_BOTTOM_Y (updated_row
));
24191 from_x
= output_cursor
.x
;
24193 /* Translate to frame coordinates. */
24194 if (updated_row
->full_width_p
)
24196 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24197 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24201 int area_left
= window_box_left (w
, updated_area
);
24202 from_x
+= area_left
;
24206 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24207 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24208 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24210 /* Prevent inadvertently clearing to end of the X window. */
24211 if (to_x
> from_x
&& to_y
> from_y
)
24214 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24215 to_x
- from_x
, to_y
- from_y
);
24220 #endif /* HAVE_WINDOW_SYSTEM */
24224 /***********************************************************************
24226 ***********************************************************************/
24228 /* Value is the internal representation of the specified cursor type
24229 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24230 of the bar cursor. */
24232 static enum text_cursor_kinds
24233 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24235 enum text_cursor_kinds type
;
24240 if (EQ (arg
, Qbox
))
24241 return FILLED_BOX_CURSOR
;
24243 if (EQ (arg
, Qhollow
))
24244 return HOLLOW_BOX_CURSOR
;
24246 if (EQ (arg
, Qbar
))
24253 && EQ (XCAR (arg
), Qbar
)
24254 && INTEGERP (XCDR (arg
))
24255 && XINT (XCDR (arg
)) >= 0)
24257 *width
= XINT (XCDR (arg
));
24261 if (EQ (arg
, Qhbar
))
24264 return HBAR_CURSOR
;
24268 && EQ (XCAR (arg
), Qhbar
)
24269 && INTEGERP (XCDR (arg
))
24270 && XINT (XCDR (arg
)) >= 0)
24272 *width
= XINT (XCDR (arg
));
24273 return HBAR_CURSOR
;
24276 /* Treat anything unknown as "hollow box cursor".
24277 It was bad to signal an error; people have trouble fixing
24278 .Xdefaults with Emacs, when it has something bad in it. */
24279 type
= HOLLOW_BOX_CURSOR
;
24284 /* Set the default cursor types for specified frame. */
24286 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24291 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24292 FRAME_CURSOR_WIDTH (f
) = width
;
24294 /* By default, set up the blink-off state depending on the on-state. */
24296 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24299 FRAME_BLINK_OFF_CURSOR (f
)
24300 = get_specified_cursor_type (XCDR (tem
), &width
);
24301 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24304 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24308 #ifdef HAVE_WINDOW_SYSTEM
24310 /* Return the cursor we want to be displayed in window W. Return
24311 width of bar/hbar cursor through WIDTH arg. Return with
24312 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24313 (i.e. if the `system caret' should track this cursor).
24315 In a mini-buffer window, we want the cursor only to appear if we
24316 are reading input from this window. For the selected window, we
24317 want the cursor type given by the frame parameter or buffer local
24318 setting of cursor-type. If explicitly marked off, draw no cursor.
24319 In all other cases, we want a hollow box cursor. */
24321 static enum text_cursor_kinds
24322 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24323 int *active_cursor
)
24325 struct frame
*f
= XFRAME (w
->frame
);
24326 struct buffer
*b
= XBUFFER (w
->buffer
);
24327 int cursor_type
= DEFAULT_CURSOR
;
24328 Lisp_Object alt_cursor
;
24329 int non_selected
= 0;
24331 *active_cursor
= 1;
24334 if (cursor_in_echo_area
24335 && FRAME_HAS_MINIBUF_P (f
)
24336 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24338 if (w
== XWINDOW (echo_area_window
))
24340 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24342 *width
= FRAME_CURSOR_WIDTH (f
);
24343 return FRAME_DESIRED_CURSOR (f
);
24346 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24349 *active_cursor
= 0;
24353 /* Detect a nonselected window or nonselected frame. */
24354 else if (w
!= XWINDOW (f
->selected_window
)
24355 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24357 *active_cursor
= 0;
24359 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24365 /* Never display a cursor in a window in which cursor-type is nil. */
24366 if (NILP (BVAR (b
, cursor_type
)))
24369 /* Get the normal cursor type for this window. */
24370 if (EQ (BVAR (b
, cursor_type
), Qt
))
24372 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24373 *width
= FRAME_CURSOR_WIDTH (f
);
24376 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24378 /* Use cursor-in-non-selected-windows instead
24379 for non-selected window or frame. */
24382 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24383 if (!EQ (Qt
, alt_cursor
))
24384 return get_specified_cursor_type (alt_cursor
, width
);
24385 /* t means modify the normal cursor type. */
24386 if (cursor_type
== FILLED_BOX_CURSOR
)
24387 cursor_type
= HOLLOW_BOX_CURSOR
;
24388 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24390 return cursor_type
;
24393 /* Use normal cursor if not blinked off. */
24394 if (!w
->cursor_off_p
)
24396 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24398 if (cursor_type
== FILLED_BOX_CURSOR
)
24400 /* Using a block cursor on large images can be very annoying.
24401 So use a hollow cursor for "large" images.
24402 If image is not transparent (no mask), also use hollow cursor. */
24403 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24404 if (img
!= NULL
&& IMAGEP (img
->spec
))
24406 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24407 where N = size of default frame font size.
24408 This should cover most of the "tiny" icons people may use. */
24410 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24411 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24412 cursor_type
= HOLLOW_BOX_CURSOR
;
24415 else if (cursor_type
!= NO_CURSOR
)
24417 /* Display current only supports BOX and HOLLOW cursors for images.
24418 So for now, unconditionally use a HOLLOW cursor when cursor is
24419 not a solid box cursor. */
24420 cursor_type
= HOLLOW_BOX_CURSOR
;
24423 return cursor_type
;
24426 /* Cursor is blinked off, so determine how to "toggle" it. */
24428 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24429 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24430 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24432 /* Then see if frame has specified a specific blink off cursor type. */
24433 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24435 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24436 return FRAME_BLINK_OFF_CURSOR (f
);
24440 /* Some people liked having a permanently visible blinking cursor,
24441 while others had very strong opinions against it. So it was
24442 decided to remove it. KFS 2003-09-03 */
24444 /* Finally perform built-in cursor blinking:
24445 filled box <-> hollow box
24446 wide [h]bar <-> narrow [h]bar
24447 narrow [h]bar <-> no cursor
24448 other type <-> no cursor */
24450 if (cursor_type
== FILLED_BOX_CURSOR
)
24451 return HOLLOW_BOX_CURSOR
;
24453 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24456 return cursor_type
;
24464 /* Notice when the text cursor of window W has been completely
24465 overwritten by a drawing operation that outputs glyphs in AREA
24466 starting at X0 and ending at X1 in the line starting at Y0 and
24467 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24468 the rest of the line after X0 has been written. Y coordinates
24469 are window-relative. */
24472 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24473 int x0
, int x1
, int y0
, int y1
)
24475 int cx0
, cx1
, cy0
, cy1
;
24476 struct glyph_row
*row
;
24478 if (!w
->phys_cursor_on_p
)
24480 if (area
!= TEXT_AREA
)
24483 if (w
->phys_cursor
.vpos
< 0
24484 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24485 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24486 !(row
->enabled_p
&& row
->displays_text_p
)))
24489 if (row
->cursor_in_fringe_p
)
24491 row
->cursor_in_fringe_p
= 0;
24492 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24493 w
->phys_cursor_on_p
= 0;
24497 cx0
= w
->phys_cursor
.x
;
24498 cx1
= cx0
+ w
->phys_cursor_width
;
24499 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24502 /* The cursor image will be completely removed from the
24503 screen if the output area intersects the cursor area in
24504 y-direction. When we draw in [y0 y1[, and some part of
24505 the cursor is at y < y0, that part must have been drawn
24506 before. When scrolling, the cursor is erased before
24507 actually scrolling, so we don't come here. When not
24508 scrolling, the rows above the old cursor row must have
24509 changed, and in this case these rows must have written
24510 over the cursor image.
24512 Likewise if part of the cursor is below y1, with the
24513 exception of the cursor being in the first blank row at
24514 the buffer and window end because update_text_area
24515 doesn't draw that row. (Except when it does, but
24516 that's handled in update_text_area.) */
24518 cy0
= w
->phys_cursor
.y
;
24519 cy1
= cy0
+ w
->phys_cursor_height
;
24520 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24523 w
->phys_cursor_on_p
= 0;
24526 #endif /* HAVE_WINDOW_SYSTEM */
24529 /************************************************************************
24531 ************************************************************************/
24533 #ifdef HAVE_WINDOW_SYSTEM
24536 Fix the display of area AREA of overlapping row ROW in window W
24537 with respect to the overlapping part OVERLAPS. */
24540 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24541 enum glyph_row_area area
, int overlaps
)
24548 for (i
= 0; i
< row
->used
[area
];)
24550 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24552 int start
= i
, start_x
= x
;
24556 x
+= row
->glyphs
[area
][i
].pixel_width
;
24559 while (i
< row
->used
[area
]
24560 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24562 draw_glyphs (w
, start_x
, row
, area
,
24564 DRAW_NORMAL_TEXT
, overlaps
);
24568 x
+= row
->glyphs
[area
][i
].pixel_width
;
24578 Draw the cursor glyph of window W in glyph row ROW. See the
24579 comment of draw_glyphs for the meaning of HL. */
24582 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24583 enum draw_glyphs_face hl
)
24585 /* If cursor hpos is out of bounds, don't draw garbage. This can
24586 happen in mini-buffer windows when switching between echo area
24587 glyphs and mini-buffer. */
24588 if ((row
->reversed_p
24589 ? (w
->phys_cursor
.hpos
>= 0)
24590 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24592 int on_p
= w
->phys_cursor_on_p
;
24594 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24595 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24597 w
->phys_cursor_on_p
= on_p
;
24599 if (hl
== DRAW_CURSOR
)
24600 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24601 /* When we erase the cursor, and ROW is overlapped by other
24602 rows, make sure that these overlapping parts of other rows
24604 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24606 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24608 if (row
> w
->current_matrix
->rows
24609 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24610 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24611 OVERLAPS_ERASED_CURSOR
);
24613 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24614 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24615 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24616 OVERLAPS_ERASED_CURSOR
);
24623 Erase the image of a cursor of window W from the screen. */
24626 erase_phys_cursor (struct window
*w
)
24628 struct frame
*f
= XFRAME (w
->frame
);
24629 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24630 int hpos
= w
->phys_cursor
.hpos
;
24631 int vpos
= w
->phys_cursor
.vpos
;
24632 int mouse_face_here_p
= 0;
24633 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24634 struct glyph_row
*cursor_row
;
24635 struct glyph
*cursor_glyph
;
24636 enum draw_glyphs_face hl
;
24638 /* No cursor displayed or row invalidated => nothing to do on the
24640 if (w
->phys_cursor_type
== NO_CURSOR
)
24641 goto mark_cursor_off
;
24643 /* VPOS >= active_glyphs->nrows means that window has been resized.
24644 Don't bother to erase the cursor. */
24645 if (vpos
>= active_glyphs
->nrows
)
24646 goto mark_cursor_off
;
24648 /* If row containing cursor is marked invalid, there is nothing we
24650 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24651 if (!cursor_row
->enabled_p
)
24652 goto mark_cursor_off
;
24654 /* If line spacing is > 0, old cursor may only be partially visible in
24655 window after split-window. So adjust visible height. */
24656 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24657 window_text_bottom_y (w
) - cursor_row
->y
);
24659 /* If row is completely invisible, don't attempt to delete a cursor which
24660 isn't there. This can happen if cursor is at top of a window, and
24661 we switch to a buffer with a header line in that window. */
24662 if (cursor_row
->visible_height
<= 0)
24663 goto mark_cursor_off
;
24665 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24666 if (cursor_row
->cursor_in_fringe_p
)
24668 cursor_row
->cursor_in_fringe_p
= 0;
24669 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24670 goto mark_cursor_off
;
24673 /* This can happen when the new row is shorter than the old one.
24674 In this case, either draw_glyphs or clear_end_of_line
24675 should have cleared the cursor. Note that we wouldn't be
24676 able to erase the cursor in this case because we don't have a
24677 cursor glyph at hand. */
24678 if ((cursor_row
->reversed_p
24679 ? (w
->phys_cursor
.hpos
< 0)
24680 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24681 goto mark_cursor_off
;
24683 /* If the cursor is in the mouse face area, redisplay that when
24684 we clear the cursor. */
24685 if (! NILP (hlinfo
->mouse_face_window
)
24686 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24687 /* Don't redraw the cursor's spot in mouse face if it is at the
24688 end of a line (on a newline). The cursor appears there, but
24689 mouse highlighting does not. */
24690 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24691 mouse_face_here_p
= 1;
24693 /* Maybe clear the display under the cursor. */
24694 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24697 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24700 cursor_glyph
= get_phys_cursor_glyph (w
);
24701 if (cursor_glyph
== NULL
)
24702 goto mark_cursor_off
;
24704 width
= cursor_glyph
->pixel_width
;
24705 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24706 x
= w
->phys_cursor
.x
;
24708 width
-= left_x
- x
;
24709 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24710 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24711 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24714 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24717 /* Erase the cursor by redrawing the character underneath it. */
24718 if (mouse_face_here_p
)
24719 hl
= DRAW_MOUSE_FACE
;
24721 hl
= DRAW_NORMAL_TEXT
;
24722 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24725 w
->phys_cursor_on_p
= 0;
24726 w
->phys_cursor_type
= NO_CURSOR
;
24731 Display or clear cursor of window W. If ON is zero, clear the
24732 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24733 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24736 display_and_set_cursor (struct window
*w
, int on
,
24737 int hpos
, int vpos
, int x
, int y
)
24739 struct frame
*f
= XFRAME (w
->frame
);
24740 int new_cursor_type
;
24741 int new_cursor_width
;
24743 struct glyph_row
*glyph_row
;
24744 struct glyph
*glyph
;
24746 /* This is pointless on invisible frames, and dangerous on garbaged
24747 windows and frames; in the latter case, the frame or window may
24748 be in the midst of changing its size, and x and y may be off the
24750 if (! FRAME_VISIBLE_P (f
)
24751 || FRAME_GARBAGED_P (f
)
24752 || vpos
>= w
->current_matrix
->nrows
24753 || hpos
>= w
->current_matrix
->matrix_w
)
24756 /* If cursor is off and we want it off, return quickly. */
24757 if (!on
&& !w
->phys_cursor_on_p
)
24760 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24761 /* If cursor row is not enabled, we don't really know where to
24762 display the cursor. */
24763 if (!glyph_row
->enabled_p
)
24765 w
->phys_cursor_on_p
= 0;
24770 if (!glyph_row
->exact_window_width_line_p
24771 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24772 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24774 xassert (interrupt_input_blocked
);
24776 /* Set new_cursor_type to the cursor we want to be displayed. */
24777 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24778 &new_cursor_width
, &active_cursor
);
24780 /* If cursor is currently being shown and we don't want it to be or
24781 it is in the wrong place, or the cursor type is not what we want,
24783 if (w
->phys_cursor_on_p
24785 || w
->phys_cursor
.x
!= x
24786 || w
->phys_cursor
.y
!= y
24787 || new_cursor_type
!= w
->phys_cursor_type
24788 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24789 && new_cursor_width
!= w
->phys_cursor_width
)))
24790 erase_phys_cursor (w
);
24792 /* Don't check phys_cursor_on_p here because that flag is only set
24793 to zero in some cases where we know that the cursor has been
24794 completely erased, to avoid the extra work of erasing the cursor
24795 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24796 still not be visible, or it has only been partly erased. */
24799 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24800 w
->phys_cursor_height
= glyph_row
->height
;
24802 /* Set phys_cursor_.* before x_draw_.* is called because some
24803 of them may need the information. */
24804 w
->phys_cursor
.x
= x
;
24805 w
->phys_cursor
.y
= glyph_row
->y
;
24806 w
->phys_cursor
.hpos
= hpos
;
24807 w
->phys_cursor
.vpos
= vpos
;
24810 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24811 new_cursor_type
, new_cursor_width
,
24812 on
, active_cursor
);
24816 /* Switch the display of W's cursor on or off, according to the value
24820 update_window_cursor (struct window
*w
, int on
)
24822 /* Don't update cursor in windows whose frame is in the process
24823 of being deleted. */
24824 if (w
->current_matrix
)
24827 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24828 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24834 /* Call update_window_cursor with parameter ON_P on all leaf windows
24835 in the window tree rooted at W. */
24838 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24842 if (!NILP (w
->hchild
))
24843 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24844 else if (!NILP (w
->vchild
))
24845 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24847 update_window_cursor (w
, on_p
);
24849 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24855 Display the cursor on window W, or clear it, according to ON_P.
24856 Don't change the cursor's position. */
24859 x_update_cursor (struct frame
*f
, int on_p
)
24861 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24866 Clear the cursor of window W to background color, and mark the
24867 cursor as not shown. This is used when the text where the cursor
24868 is about to be rewritten. */
24871 x_clear_cursor (struct window
*w
)
24873 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24874 update_window_cursor (w
, 0);
24877 #endif /* HAVE_WINDOW_SYSTEM */
24879 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24882 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24883 int start_hpos
, int end_hpos
,
24884 enum draw_glyphs_face draw
)
24886 #ifdef HAVE_WINDOW_SYSTEM
24887 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24889 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24893 #if defined (HAVE_GPM) || defined (MSDOS)
24894 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24898 /* Display the active region described by mouse_face_* according to DRAW. */
24901 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24903 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24904 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24906 if (/* If window is in the process of being destroyed, don't bother
24908 w
->current_matrix
!= NULL
24909 /* Don't update mouse highlight if hidden */
24910 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24911 /* Recognize when we are called to operate on rows that don't exist
24912 anymore. This can happen when a window is split. */
24913 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24915 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24916 struct glyph_row
*row
, *first
, *last
;
24918 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24919 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24921 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24923 int start_hpos
, end_hpos
, start_x
;
24925 /* For all but the first row, the highlight starts at column 0. */
24928 /* R2L rows have BEG and END in reversed order, but the
24929 screen drawing geometry is always left to right. So
24930 we need to mirror the beginning and end of the
24931 highlighted area in R2L rows. */
24932 if (!row
->reversed_p
)
24934 start_hpos
= hlinfo
->mouse_face_beg_col
;
24935 start_x
= hlinfo
->mouse_face_beg_x
;
24937 else if (row
== last
)
24939 start_hpos
= hlinfo
->mouse_face_end_col
;
24940 start_x
= hlinfo
->mouse_face_end_x
;
24948 else if (row
->reversed_p
&& row
== last
)
24950 start_hpos
= hlinfo
->mouse_face_end_col
;
24951 start_x
= hlinfo
->mouse_face_end_x
;
24961 if (!row
->reversed_p
)
24962 end_hpos
= hlinfo
->mouse_face_end_col
;
24963 else if (row
== first
)
24964 end_hpos
= hlinfo
->mouse_face_beg_col
;
24967 end_hpos
= row
->used
[TEXT_AREA
];
24968 if (draw
== DRAW_NORMAL_TEXT
)
24969 row
->fill_line_p
= 1; /* Clear to end of line */
24972 else if (row
->reversed_p
&& row
== first
)
24973 end_hpos
= hlinfo
->mouse_face_beg_col
;
24976 end_hpos
= row
->used
[TEXT_AREA
];
24977 if (draw
== DRAW_NORMAL_TEXT
)
24978 row
->fill_line_p
= 1; /* Clear to end of line */
24981 if (end_hpos
> start_hpos
)
24983 draw_row_with_mouse_face (w
, start_x
, row
,
24984 start_hpos
, end_hpos
, draw
);
24987 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24991 #ifdef HAVE_WINDOW_SYSTEM
24992 /* When we've written over the cursor, arrange for it to
24993 be displayed again. */
24994 if (FRAME_WINDOW_P (f
)
24995 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24998 display_and_set_cursor (w
, 1,
24999 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25000 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25003 #endif /* HAVE_WINDOW_SYSTEM */
25006 #ifdef HAVE_WINDOW_SYSTEM
25007 /* Change the mouse cursor. */
25008 if (FRAME_WINDOW_P (f
))
25010 if (draw
== DRAW_NORMAL_TEXT
25011 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25012 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25013 else if (draw
== DRAW_MOUSE_FACE
)
25014 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25016 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25018 #endif /* HAVE_WINDOW_SYSTEM */
25022 Clear out the mouse-highlighted active region.
25023 Redraw it un-highlighted first. Value is non-zero if mouse
25024 face was actually drawn unhighlighted. */
25027 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25031 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25033 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25037 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25038 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25039 hlinfo
->mouse_face_window
= Qnil
;
25040 hlinfo
->mouse_face_overlay
= Qnil
;
25044 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25045 within the mouse face on that window. */
25047 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25049 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25051 /* Quickly resolve the easy cases. */
25052 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25053 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25055 if (vpos
< hlinfo
->mouse_face_beg_row
25056 || vpos
> hlinfo
->mouse_face_end_row
)
25058 if (vpos
> hlinfo
->mouse_face_beg_row
25059 && vpos
< hlinfo
->mouse_face_end_row
)
25062 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25064 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25066 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25069 else if ((vpos
== hlinfo
->mouse_face_beg_row
25070 && hpos
>= hlinfo
->mouse_face_beg_col
)
25071 || (vpos
== hlinfo
->mouse_face_end_row
25072 && hpos
< hlinfo
->mouse_face_end_col
))
25077 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25079 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25082 else if ((vpos
== hlinfo
->mouse_face_beg_row
25083 && hpos
<= hlinfo
->mouse_face_beg_col
)
25084 || (vpos
== hlinfo
->mouse_face_end_row
25085 && hpos
> hlinfo
->mouse_face_end_col
))
25093 Non-zero if physical cursor of window W is within mouse face. */
25096 cursor_in_mouse_face_p (struct window
*w
)
25098 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25103 /* Find the glyph rows START_ROW and END_ROW of window W that display
25104 characters between buffer positions START_CHARPOS and END_CHARPOS
25105 (excluding END_CHARPOS). This is similar to row_containing_pos,
25106 but is more accurate when bidi reordering makes buffer positions
25107 change non-linearly with glyph rows. */
25109 rows_from_pos_range (struct window
*w
,
25110 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25111 struct glyph_row
**start
, struct glyph_row
**end
)
25113 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25114 int last_y
= window_text_bottom_y (w
);
25115 struct glyph_row
*row
;
25120 while (!first
->enabled_p
25121 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25124 /* Find the START row. */
25126 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25129 /* A row can potentially be the START row if the range of the
25130 characters it displays intersects the range
25131 [START_CHARPOS..END_CHARPOS). */
25132 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25133 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25134 /* See the commentary in row_containing_pos, for the
25135 explanation of the complicated way to check whether
25136 some position is beyond the end of the characters
25137 displayed by a row. */
25138 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25139 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25140 && !row
->ends_at_zv_p
25141 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25142 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25143 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25144 && !row
->ends_at_zv_p
25145 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25147 /* Found a candidate row. Now make sure at least one of the
25148 glyphs it displays has a charpos from the range
25149 [START_CHARPOS..END_CHARPOS).
25151 This is not obvious because bidi reordering could make
25152 buffer positions of a row be 1,2,3,102,101,100, and if we
25153 want to highlight characters in [50..60), we don't want
25154 this row, even though [50..60) does intersect [1..103),
25155 the range of character positions given by the row's start
25156 and end positions. */
25157 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25158 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25162 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25163 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25172 /* Find the END row. */
25174 /* If the last row is partially visible, start looking for END
25175 from that row, instead of starting from FIRST. */
25176 && !(row
->enabled_p
25177 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25179 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25181 struct glyph_row
*next
= row
+ 1;
25183 if (!next
->enabled_p
25184 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25185 /* The first row >= START whose range of displayed characters
25186 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25187 is the row END + 1. */
25188 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25189 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25190 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25191 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25192 && !next
->ends_at_zv_p
25193 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25194 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25195 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25196 && !next
->ends_at_zv_p
25197 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25204 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25205 but none of the characters it displays are in the range, it is
25207 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25208 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25212 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25213 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25226 /* This function sets the mouse_face_* elements of HLINFO, assuming
25227 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25228 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25229 for the overlay or run of text properties specifying the mouse
25230 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25231 before-string and after-string that must also be highlighted.
25232 COVER_STRING, if non-nil, is a display string that may cover some
25233 or all of the highlighted text. */
25236 mouse_face_from_buffer_pos (Lisp_Object window
,
25237 Mouse_HLInfo
*hlinfo
,
25238 EMACS_INT mouse_charpos
,
25239 EMACS_INT start_charpos
,
25240 EMACS_INT end_charpos
,
25241 Lisp_Object before_string
,
25242 Lisp_Object after_string
,
25243 Lisp_Object cover_string
)
25245 struct window
*w
= XWINDOW (window
);
25246 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25247 struct glyph_row
*r1
, *r2
;
25248 struct glyph
*glyph
, *end
;
25249 EMACS_INT ignore
, pos
;
25252 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25253 xassert (NILP (before_string
) || STRINGP (before_string
));
25254 xassert (NILP (after_string
) || STRINGP (after_string
));
25256 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25257 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25259 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25260 /* If the before-string or display-string contains newlines,
25261 rows_from_pos_range skips to its last row. Move back. */
25262 if (!NILP (before_string
) || !NILP (cover_string
))
25264 struct glyph_row
*prev
;
25265 while ((prev
= r1
- 1, prev
>= first
)
25266 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25267 && prev
->used
[TEXT_AREA
] > 0)
25269 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25270 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25271 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25273 || !(EQ (glyph
->object
, before_string
)
25274 || EQ (glyph
->object
, cover_string
)))
25281 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25282 hlinfo
->mouse_face_past_end
= 1;
25284 else if (!NILP (after_string
))
25286 /* If the after-string has newlines, advance to its last row. */
25287 struct glyph_row
*next
;
25288 struct glyph_row
*last
25289 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25291 for (next
= r2
+ 1;
25293 && next
->used
[TEXT_AREA
] > 0
25294 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25298 /* The rest of the display engine assumes that mouse_face_beg_row is
25299 either above below mouse_face_end_row or identical to it. But
25300 with bidi-reordered continued lines, the row for START_CHARPOS
25301 could be below the row for END_CHARPOS. If so, swap the rows and
25302 store them in correct order. */
25305 struct glyph_row
*tem
= r2
;
25311 hlinfo
->mouse_face_beg_y
= r1
->y
;
25312 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25313 hlinfo
->mouse_face_end_y
= r2
->y
;
25314 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25316 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25317 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25318 could be anywhere in the row and in any order. The strategy
25319 below is to find the leftmost and the rightmost glyph that
25320 belongs to either of these 3 strings, or whose position is
25321 between START_CHARPOS and END_CHARPOS, and highlight all the
25322 glyphs between those two. This may cover more than just the text
25323 between START_CHARPOS and END_CHARPOS if the range of characters
25324 strides the bidi level boundary, e.g. if the beginning is in R2L
25325 text while the end is in L2R text or vice versa. */
25326 if (!r1
->reversed_p
)
25328 /* This row is in a left to right paragraph. Scan it left to
25330 glyph
= r1
->glyphs
[TEXT_AREA
];
25331 end
= glyph
+ r1
->used
[TEXT_AREA
];
25334 /* Skip truncation glyphs at the start of the glyph row. */
25335 if (r1
->displays_text_p
)
25337 && INTEGERP (glyph
->object
)
25338 && glyph
->charpos
< 0;
25340 x
+= glyph
->pixel_width
;
25342 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25343 or COVER_STRING, and the first glyph from buffer whose
25344 position is between START_CHARPOS and END_CHARPOS. */
25346 && !INTEGERP (glyph
->object
)
25347 && !EQ (glyph
->object
, cover_string
)
25348 && !(BUFFERP (glyph
->object
)
25349 && (glyph
->charpos
>= start_charpos
25350 && glyph
->charpos
< end_charpos
));
25353 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25354 are present at buffer positions between START_CHARPOS and
25355 END_CHARPOS, or if they come from an overlay. */
25356 if (EQ (glyph
->object
, before_string
))
25358 pos
= string_buffer_position (before_string
,
25360 /* If pos == 0, it means before_string came from an
25361 overlay, not from a buffer position. */
25362 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25365 else if (EQ (glyph
->object
, after_string
))
25367 pos
= string_buffer_position (after_string
, end_charpos
);
25368 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25371 x
+= glyph
->pixel_width
;
25373 hlinfo
->mouse_face_beg_x
= x
;
25374 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25378 /* This row is in a right to left paragraph. Scan it right to
25382 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25383 glyph
= end
+ r1
->used
[TEXT_AREA
];
25385 /* Skip truncation glyphs at the start of the glyph row. */
25386 if (r1
->displays_text_p
)
25388 && INTEGERP (glyph
->object
)
25389 && glyph
->charpos
< 0;
25393 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25394 or COVER_STRING, and the first glyph from buffer whose
25395 position is between START_CHARPOS and END_CHARPOS. */
25397 && !INTEGERP (glyph
->object
)
25398 && !EQ (glyph
->object
, cover_string
)
25399 && !(BUFFERP (glyph
->object
)
25400 && (glyph
->charpos
>= start_charpos
25401 && glyph
->charpos
< end_charpos
));
25404 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25405 are present at buffer positions between START_CHARPOS and
25406 END_CHARPOS, or if they come from an overlay. */
25407 if (EQ (glyph
->object
, before_string
))
25409 pos
= string_buffer_position (before_string
, start_charpos
);
25410 /* If pos == 0, it means before_string came from an
25411 overlay, not from a buffer position. */
25412 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25415 else if (EQ (glyph
->object
, after_string
))
25417 pos
= string_buffer_position (after_string
, end_charpos
);
25418 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25423 glyph
++; /* first glyph to the right of the highlighted area */
25424 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25425 x
+= g
->pixel_width
;
25426 hlinfo
->mouse_face_beg_x
= x
;
25427 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25430 /* If the highlight ends in a different row, compute GLYPH and END
25431 for the end row. Otherwise, reuse the values computed above for
25432 the row where the highlight begins. */
25435 if (!r2
->reversed_p
)
25437 glyph
= r2
->glyphs
[TEXT_AREA
];
25438 end
= glyph
+ r2
->used
[TEXT_AREA
];
25443 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25444 glyph
= end
+ r2
->used
[TEXT_AREA
];
25448 if (!r2
->reversed_p
)
25450 /* Skip truncation and continuation glyphs near the end of the
25451 row, and also blanks and stretch glyphs inserted by
25452 extend_face_to_end_of_line. */
25454 && INTEGERP ((end
- 1)->object
)
25455 && (end
- 1)->charpos
<= 0)
25457 /* Scan the rest of the glyph row from the end, looking for the
25458 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25459 COVER_STRING, or whose position is between START_CHARPOS
25463 && !INTEGERP (end
->object
)
25464 && !EQ (end
->object
, cover_string
)
25465 && !(BUFFERP (end
->object
)
25466 && (end
->charpos
>= start_charpos
25467 && end
->charpos
< end_charpos
));
25470 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25471 are present at buffer positions between START_CHARPOS and
25472 END_CHARPOS, or if they come from an overlay. */
25473 if (EQ (end
->object
, before_string
))
25475 pos
= string_buffer_position (before_string
, start_charpos
);
25476 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25479 else if (EQ (end
->object
, after_string
))
25481 pos
= string_buffer_position (after_string
, end_charpos
);
25482 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25486 /* Find the X coordinate of the last glyph to be highlighted. */
25487 for (; glyph
<= end
; ++glyph
)
25488 x
+= glyph
->pixel_width
;
25490 hlinfo
->mouse_face_end_x
= x
;
25491 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25495 /* Skip truncation and continuation glyphs near the end of the
25496 row, and also blanks and stretch glyphs inserted by
25497 extend_face_to_end_of_line. */
25501 && INTEGERP (end
->object
)
25502 && end
->charpos
<= 0)
25504 x
+= end
->pixel_width
;
25507 /* Scan the rest of the glyph row from the end, looking for the
25508 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25509 COVER_STRING, or whose position is between START_CHARPOS
25513 && !INTEGERP (end
->object
)
25514 && !EQ (end
->object
, cover_string
)
25515 && !(BUFFERP (end
->object
)
25516 && (end
->charpos
>= start_charpos
25517 && end
->charpos
< end_charpos
));
25520 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25521 are present at buffer positions between START_CHARPOS and
25522 END_CHARPOS, or if they come from an overlay. */
25523 if (EQ (end
->object
, before_string
))
25525 pos
= string_buffer_position (before_string
, start_charpos
);
25526 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25529 else if (EQ (end
->object
, after_string
))
25531 pos
= string_buffer_position (after_string
, end_charpos
);
25532 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25535 x
+= end
->pixel_width
;
25537 hlinfo
->mouse_face_end_x
= x
;
25538 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25541 hlinfo
->mouse_face_window
= window
;
25542 hlinfo
->mouse_face_face_id
25543 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25545 !hlinfo
->mouse_face_hidden
, -1);
25546 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25549 /* The following function is not used anymore (replaced with
25550 mouse_face_from_string_pos), but I leave it here for the time
25551 being, in case someone would. */
25553 #if 0 /* not used */
25555 /* Find the position of the glyph for position POS in OBJECT in
25556 window W's current matrix, and return in *X, *Y the pixel
25557 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25559 RIGHT_P non-zero means return the position of the right edge of the
25560 glyph, RIGHT_P zero means return the left edge position.
25562 If no glyph for POS exists in the matrix, return the position of
25563 the glyph with the next smaller position that is in the matrix, if
25564 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25565 exists in the matrix, return the position of the glyph with the
25566 next larger position in OBJECT.
25568 Value is non-zero if a glyph was found. */
25571 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25572 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25574 int yb
= window_text_bottom_y (w
);
25575 struct glyph_row
*r
;
25576 struct glyph
*best_glyph
= NULL
;
25577 struct glyph_row
*best_row
= NULL
;
25580 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25581 r
->enabled_p
&& r
->y
< yb
;
25584 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25585 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25588 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25589 if (EQ (g
->object
, object
))
25591 if (g
->charpos
== pos
)
25598 else if (best_glyph
== NULL
25599 || ((eabs (g
->charpos
- pos
)
25600 < eabs (best_glyph
->charpos
- pos
))
25603 : g
->charpos
> pos
)))
25617 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25621 *x
+= best_glyph
->pixel_width
;
25626 *vpos
= best_row
- w
->current_matrix
->rows
;
25629 return best_glyph
!= NULL
;
25631 #endif /* not used */
25633 /* Find the positions of the first and the last glyphs in window W's
25634 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25635 (assumed to be a string), and return in HLINFO's mouse_face_*
25636 members the pixel and column/row coordinates of those glyphs. */
25639 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25640 Lisp_Object object
,
25641 EMACS_INT startpos
, EMACS_INT endpos
)
25643 int yb
= window_text_bottom_y (w
);
25644 struct glyph_row
*r
;
25645 struct glyph
*g
, *e
;
25649 /* Find the glyph row with at least one position in the range
25650 [STARTPOS..ENDPOS], and the first glyph in that row whose
25651 position belongs to that range. */
25652 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25653 r
->enabled_p
&& r
->y
< yb
;
25656 if (!r
->reversed_p
)
25658 g
= r
->glyphs
[TEXT_AREA
];
25659 e
= g
+ r
->used
[TEXT_AREA
];
25660 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25661 if (EQ (g
->object
, object
)
25662 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25664 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25665 hlinfo
->mouse_face_beg_y
= r
->y
;
25666 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25667 hlinfo
->mouse_face_beg_x
= gx
;
25676 e
= r
->glyphs
[TEXT_AREA
];
25677 g
= e
+ r
->used
[TEXT_AREA
];
25678 for ( ; g
> e
; --g
)
25679 if (EQ ((g
-1)->object
, object
)
25680 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25682 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25683 hlinfo
->mouse_face_beg_y
= r
->y
;
25684 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25685 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25686 gx
+= g1
->pixel_width
;
25687 hlinfo
->mouse_face_beg_x
= gx
;
25699 /* Starting with the next row, look for the first row which does NOT
25700 include any glyphs whose positions are in the range. */
25701 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25703 g
= r
->glyphs
[TEXT_AREA
];
25704 e
= g
+ r
->used
[TEXT_AREA
];
25706 for ( ; g
< e
; ++g
)
25707 if (EQ (g
->object
, object
)
25708 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25717 /* The highlighted region ends on the previous row. */
25720 /* Set the end row and its vertical pixel coordinate. */
25721 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25722 hlinfo
->mouse_face_end_y
= r
->y
;
25724 /* Compute and set the end column and the end column's horizontal
25725 pixel coordinate. */
25726 if (!r
->reversed_p
)
25728 g
= r
->glyphs
[TEXT_AREA
];
25729 e
= g
+ r
->used
[TEXT_AREA
];
25730 for ( ; e
> g
; --e
)
25731 if (EQ ((e
-1)->object
, object
)
25732 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25734 hlinfo
->mouse_face_end_col
= e
- g
;
25736 for (gx
= r
->x
; g
< e
; ++g
)
25737 gx
+= g
->pixel_width
;
25738 hlinfo
->mouse_face_end_x
= gx
;
25742 e
= r
->glyphs
[TEXT_AREA
];
25743 g
= e
+ r
->used
[TEXT_AREA
];
25744 for (gx
= r
->x
; e
< g
; ++e
)
25746 if (EQ (e
->object
, object
)
25747 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25749 gx
+= e
->pixel_width
;
25751 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25752 hlinfo
->mouse_face_end_x
= gx
;
25756 #ifdef HAVE_WINDOW_SYSTEM
25758 /* See if position X, Y is within a hot-spot of an image. */
25761 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25763 if (!CONSP (hot_spot
))
25766 if (EQ (XCAR (hot_spot
), Qrect
))
25768 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25769 Lisp_Object rect
= XCDR (hot_spot
);
25773 if (!CONSP (XCAR (rect
)))
25775 if (!CONSP (XCDR (rect
)))
25777 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25779 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25781 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25783 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25787 else if (EQ (XCAR (hot_spot
), Qcircle
))
25789 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25790 Lisp_Object circ
= XCDR (hot_spot
);
25791 Lisp_Object lr
, lx0
, ly0
;
25793 && CONSP (XCAR (circ
))
25794 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25795 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25796 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25798 double r
= XFLOATINT (lr
);
25799 double dx
= XINT (lx0
) - x
;
25800 double dy
= XINT (ly0
) - y
;
25801 return (dx
* dx
+ dy
* dy
<= r
* r
);
25804 else if (EQ (XCAR (hot_spot
), Qpoly
))
25806 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25807 if (VECTORP (XCDR (hot_spot
)))
25809 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25810 Lisp_Object
*poly
= v
->contents
;
25811 int n
= v
->header
.size
;
25814 Lisp_Object lx
, ly
;
25817 /* Need an even number of coordinates, and at least 3 edges. */
25818 if (n
< 6 || n
& 1)
25821 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25822 If count is odd, we are inside polygon. Pixels on edges
25823 may or may not be included depending on actual geometry of the
25825 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25826 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25828 x0
= XINT (lx
), y0
= XINT (ly
);
25829 for (i
= 0; i
< n
; i
+= 2)
25831 int x1
= x0
, y1
= y0
;
25832 if ((lx
= poly
[i
], !INTEGERP (lx
))
25833 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25835 x0
= XINT (lx
), y0
= XINT (ly
);
25837 /* Does this segment cross the X line? */
25845 if (y
> y0
&& y
> y1
)
25847 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25857 find_hot_spot (Lisp_Object map
, int x
, int y
)
25859 while (CONSP (map
))
25861 if (CONSP (XCAR (map
))
25862 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25870 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25872 doc
: /* Lookup in image map MAP coordinates X and Y.
25873 An image map is an alist where each element has the format (AREA ID PLIST).
25874 An AREA is specified as either a rectangle, a circle, or a polygon:
25875 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25876 pixel coordinates of the upper left and bottom right corners.
25877 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25878 and the radius of the circle; r may be a float or integer.
25879 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25880 vector describes one corner in the polygon.
25881 Returns the alist element for the first matching AREA in MAP. */)
25882 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25890 return find_hot_spot (map
, XINT (x
), XINT (y
));
25894 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25896 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25898 /* Do not change cursor shape while dragging mouse. */
25899 if (!NILP (do_mouse_tracking
))
25902 if (!NILP (pointer
))
25904 if (EQ (pointer
, Qarrow
))
25905 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25906 else if (EQ (pointer
, Qhand
))
25907 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25908 else if (EQ (pointer
, Qtext
))
25909 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25910 else if (EQ (pointer
, intern ("hdrag")))
25911 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25912 #ifdef HAVE_X_WINDOWS
25913 else if (EQ (pointer
, intern ("vdrag")))
25914 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25916 else if (EQ (pointer
, intern ("hourglass")))
25917 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25918 else if (EQ (pointer
, Qmodeline
))
25919 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25921 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25924 if (cursor
!= No_Cursor
)
25925 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25928 #endif /* HAVE_WINDOW_SYSTEM */
25930 /* Take proper action when mouse has moved to the mode or header line
25931 or marginal area AREA of window W, x-position X and y-position Y.
25932 X is relative to the start of the text display area of W, so the
25933 width of bitmap areas and scroll bars must be subtracted to get a
25934 position relative to the start of the mode line. */
25937 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25938 enum window_part area
)
25940 struct window
*w
= XWINDOW (window
);
25941 struct frame
*f
= XFRAME (w
->frame
);
25942 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25943 #ifdef HAVE_WINDOW_SYSTEM
25944 Display_Info
*dpyinfo
;
25946 Cursor cursor
= No_Cursor
;
25947 Lisp_Object pointer
= Qnil
;
25948 int dx
, dy
, width
, height
;
25950 Lisp_Object string
, object
= Qnil
;
25951 Lisp_Object pos
, help
;
25953 Lisp_Object mouse_face
;
25954 int original_x_pixel
= x
;
25955 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25956 struct glyph_row
*row
;
25958 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25963 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25964 returns them in row/column units! */
25965 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25966 &object
, &dx
, &dy
, &width
, &height
);
25968 row
= (area
== ON_MODE_LINE
25969 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25970 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25972 /* Find the glyph under the mouse pointer. */
25973 if (row
->mode_line_p
&& row
->enabled_p
)
25975 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25976 end
= glyph
+ row
->used
[TEXT_AREA
];
25978 for (x0
= original_x_pixel
;
25979 glyph
< end
&& x0
>= glyph
->pixel_width
;
25981 x0
-= glyph
->pixel_width
;
25989 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25990 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25991 returns them in row/column units! */
25992 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25993 &object
, &dx
, &dy
, &width
, &height
);
25998 #ifdef HAVE_WINDOW_SYSTEM
25999 if (IMAGEP (object
))
26001 Lisp_Object image_map
, hotspot
;
26002 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26004 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26006 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26010 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26011 If so, we could look for mouse-enter, mouse-leave
26012 properties in PLIST (and do something...). */
26013 hotspot
= XCDR (hotspot
);
26014 if (CONSP (hotspot
)
26015 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26017 pointer
= Fplist_get (plist
, Qpointer
);
26018 if (NILP (pointer
))
26020 help
= Fplist_get (plist
, Qhelp_echo
);
26023 help_echo_string
= help
;
26024 /* Is this correct? ++kfs */
26025 XSETWINDOW (help_echo_window
, w
);
26026 help_echo_object
= w
->buffer
;
26027 help_echo_pos
= charpos
;
26031 if (NILP (pointer
))
26032 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26034 #endif /* HAVE_WINDOW_SYSTEM */
26036 if (STRINGP (string
))
26038 pos
= make_number (charpos
);
26039 /* If we're on a string with `help-echo' text property, arrange
26040 for the help to be displayed. This is done by setting the
26041 global variable help_echo_string to the help string. */
26044 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26047 help_echo_string
= help
;
26048 XSETWINDOW (help_echo_window
, w
);
26049 help_echo_object
= string
;
26050 help_echo_pos
= charpos
;
26054 #ifdef HAVE_WINDOW_SYSTEM
26055 if (FRAME_WINDOW_P (f
))
26057 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26058 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26059 if (NILP (pointer
))
26060 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26062 /* Change the mouse pointer according to what is under X/Y. */
26064 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26067 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26068 if (!KEYMAPP (map
))
26069 map
= Fget_text_property (pos
, Qkeymap
, string
);
26070 if (!KEYMAPP (map
))
26071 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26076 /* Change the mouse face according to what is under X/Y. */
26077 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26078 if (!NILP (mouse_face
)
26079 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26084 struct glyph
* tmp_glyph
;
26088 int total_pixel_width
;
26089 EMACS_INT begpos
, endpos
, ignore
;
26093 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26094 Qmouse_face
, string
, Qnil
);
26100 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26102 endpos
= SCHARS (string
);
26106 /* Calculate the glyph position GPOS of GLYPH in the
26107 displayed string, relative to the beginning of the
26108 highlighted part of the string.
26110 Note: GPOS is different from CHARPOS. CHARPOS is the
26111 position of GLYPH in the internal string object. A mode
26112 line string format has structures which are converted to
26113 a flattened string by the Emacs Lisp interpreter. The
26114 internal string is an element of those structures. The
26115 displayed string is the flattened string. */
26116 tmp_glyph
= row_start_glyph
;
26117 while (tmp_glyph
< glyph
26118 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26119 && begpos
<= tmp_glyph
->charpos
26120 && tmp_glyph
->charpos
< endpos
)))
26122 gpos
= glyph
- tmp_glyph
;
26124 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26125 the highlighted part of the displayed string to which
26126 GLYPH belongs. Note: GSEQ_LENGTH is different from
26127 SCHARS (STRING), because the latter returns the length of
26128 the internal string. */
26129 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26131 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26132 && begpos
<= tmp_glyph
->charpos
26133 && tmp_glyph
->charpos
< endpos
));
26136 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26138 /* Calculate the total pixel width of all the glyphs between
26139 the beginning of the highlighted area and GLYPH. */
26140 total_pixel_width
= 0;
26141 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26142 total_pixel_width
+= tmp_glyph
->pixel_width
;
26144 /* Pre calculation of re-rendering position. Note: X is in
26145 column units here, after the call to mode_line_string or
26146 marginal_area_string. */
26148 vpos
= (area
== ON_MODE_LINE
26149 ? (w
->current_matrix
)->nrows
- 1
26152 /* If GLYPH's position is included in the region that is
26153 already drawn in mouse face, we have nothing to do. */
26154 if ( EQ (window
, hlinfo
->mouse_face_window
)
26155 && (!row
->reversed_p
26156 ? (hlinfo
->mouse_face_beg_col
<= hpos
26157 && hpos
< hlinfo
->mouse_face_end_col
)
26158 /* In R2L rows we swap BEG and END, see below. */
26159 : (hlinfo
->mouse_face_end_col
<= hpos
26160 && hpos
< hlinfo
->mouse_face_beg_col
))
26161 && hlinfo
->mouse_face_beg_row
== vpos
)
26164 if (clear_mouse_face (hlinfo
))
26165 cursor
= No_Cursor
;
26167 if (!row
->reversed_p
)
26169 hlinfo
->mouse_face_beg_col
= hpos
;
26170 hlinfo
->mouse_face_beg_x
= original_x_pixel
26171 - (total_pixel_width
+ dx
);
26172 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26173 hlinfo
->mouse_face_end_x
= 0;
26177 /* In R2L rows, show_mouse_face expects BEG and END
26178 coordinates to be swapped. */
26179 hlinfo
->mouse_face_end_col
= hpos
;
26180 hlinfo
->mouse_face_end_x
= original_x_pixel
26181 - (total_pixel_width
+ dx
);
26182 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26183 hlinfo
->mouse_face_beg_x
= 0;
26186 hlinfo
->mouse_face_beg_row
= vpos
;
26187 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26188 hlinfo
->mouse_face_beg_y
= 0;
26189 hlinfo
->mouse_face_end_y
= 0;
26190 hlinfo
->mouse_face_past_end
= 0;
26191 hlinfo
->mouse_face_window
= window
;
26193 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26199 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26201 if (NILP (pointer
))
26204 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26205 clear_mouse_face (hlinfo
);
26207 #ifdef HAVE_WINDOW_SYSTEM
26208 if (FRAME_WINDOW_P (f
))
26209 define_frame_cursor1 (f
, cursor
, pointer
);
26215 Take proper action when the mouse has moved to position X, Y on
26216 frame F as regards highlighting characters that have mouse-face
26217 properties. Also de-highlighting chars where the mouse was before.
26218 X and Y can be negative or out of range. */
26221 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26223 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26224 enum window_part part
;
26225 Lisp_Object window
;
26227 Cursor cursor
= No_Cursor
;
26228 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26231 /* When a menu is active, don't highlight because this looks odd. */
26232 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26233 if (popup_activated ())
26237 if (NILP (Vmouse_highlight
)
26238 || !f
->glyphs_initialized_p
26239 || f
->pointer_invisible
)
26242 hlinfo
->mouse_face_mouse_x
= x
;
26243 hlinfo
->mouse_face_mouse_y
= y
;
26244 hlinfo
->mouse_face_mouse_frame
= f
;
26246 if (hlinfo
->mouse_face_defer
)
26249 if (gc_in_progress
)
26251 hlinfo
->mouse_face_deferred_gc
= 1;
26255 /* Which window is that in? */
26256 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26258 /* If we were displaying active text in another window, clear that.
26259 Also clear if we move out of text area in same window. */
26260 if (! EQ (window
, hlinfo
->mouse_face_window
)
26261 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26262 && !NILP (hlinfo
->mouse_face_window
)))
26263 clear_mouse_face (hlinfo
);
26265 /* Not on a window -> return. */
26266 if (!WINDOWP (window
))
26269 /* Reset help_echo_string. It will get recomputed below. */
26270 help_echo_string
= Qnil
;
26272 /* Convert to window-relative pixel coordinates. */
26273 w
= XWINDOW (window
);
26274 frame_to_window_pixel_xy (w
, &x
, &y
);
26276 #ifdef HAVE_WINDOW_SYSTEM
26277 /* Handle tool-bar window differently since it doesn't display a
26279 if (EQ (window
, f
->tool_bar_window
))
26281 note_tool_bar_highlight (f
, x
, y
);
26286 /* Mouse is on the mode, header line or margin? */
26287 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26288 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26290 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26294 #ifdef HAVE_WINDOW_SYSTEM
26295 if (part
== ON_VERTICAL_BORDER
)
26297 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26298 help_echo_string
= build_string ("drag-mouse-1: resize");
26300 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26301 || part
== ON_SCROLL_BAR
)
26302 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26304 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26307 /* Are we in a window whose display is up to date?
26308 And verify the buffer's text has not changed. */
26309 b
= XBUFFER (w
->buffer
);
26310 if (part
== ON_TEXT
26311 && EQ (w
->window_end_valid
, w
->buffer
)
26312 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26313 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26315 int hpos
, vpos
, dx
, dy
, area
;
26317 struct glyph
*glyph
;
26318 Lisp_Object object
;
26319 Lisp_Object mouse_face
= Qnil
, position
;
26320 Lisp_Object
*overlay_vec
= NULL
;
26321 ptrdiff_t i
, noverlays
;
26322 struct buffer
*obuf
;
26323 EMACS_INT obegv
, ozv
;
26326 /* Find the glyph under X/Y. */
26327 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26329 #ifdef HAVE_WINDOW_SYSTEM
26330 /* Look for :pointer property on image. */
26331 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26333 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26334 if (img
!= NULL
&& IMAGEP (img
->spec
))
26336 Lisp_Object image_map
, hotspot
;
26337 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26339 && (hotspot
= find_hot_spot (image_map
,
26340 glyph
->slice
.img
.x
+ dx
,
26341 glyph
->slice
.img
.y
+ dy
),
26343 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26347 /* Could check XCAR (hotspot) to see if we enter/leave
26349 If so, we could look for mouse-enter, mouse-leave
26350 properties in PLIST (and do something...). */
26351 hotspot
= XCDR (hotspot
);
26352 if (CONSP (hotspot
)
26353 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26355 pointer
= Fplist_get (plist
, Qpointer
);
26356 if (NILP (pointer
))
26358 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26359 if (!NILP (help_echo_string
))
26361 help_echo_window
= window
;
26362 help_echo_object
= glyph
->object
;
26363 help_echo_pos
= glyph
->charpos
;
26367 if (NILP (pointer
))
26368 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26371 #endif /* HAVE_WINDOW_SYSTEM */
26373 /* Clear mouse face if X/Y not over text. */
26375 || area
!= TEXT_AREA
26376 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26377 /* Glyph's OBJECT is an integer for glyphs inserted by the
26378 display engine for its internal purposes, like truncation
26379 and continuation glyphs and blanks beyond the end of
26380 line's text on text terminals. If we are over such a
26381 glyph, we are not over any text. */
26382 || INTEGERP (glyph
->object
)
26383 /* R2L rows have a stretch glyph at their front, which
26384 stands for no text, whereas L2R rows have no glyphs at
26385 all beyond the end of text. Treat such stretch glyphs
26386 like we do with NULL glyphs in L2R rows. */
26387 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26388 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26389 && glyph
->type
== STRETCH_GLYPH
26390 && glyph
->avoid_cursor_p
))
26392 if (clear_mouse_face (hlinfo
))
26393 cursor
= No_Cursor
;
26394 #ifdef HAVE_WINDOW_SYSTEM
26395 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26397 if (area
!= TEXT_AREA
)
26398 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26400 pointer
= Vvoid_text_area_pointer
;
26406 pos
= glyph
->charpos
;
26407 object
= glyph
->object
;
26408 if (!STRINGP (object
) && !BUFFERP (object
))
26411 /* If we get an out-of-range value, return now; avoid an error. */
26412 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26415 /* Make the window's buffer temporarily current for
26416 overlays_at and compute_char_face. */
26417 obuf
= current_buffer
;
26418 current_buffer
= b
;
26424 /* Is this char mouse-active or does it have help-echo? */
26425 position
= make_number (pos
);
26427 if (BUFFERP (object
))
26429 /* Put all the overlays we want in a vector in overlay_vec. */
26430 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26431 /* Sort overlays into increasing priority order. */
26432 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26437 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26440 cursor
= No_Cursor
;
26442 /* Check mouse-face highlighting. */
26444 /* If there exists an overlay with mouse-face overlapping
26445 the one we are currently highlighting, we have to
26446 check if we enter the overlapping overlay, and then
26447 highlight only that. */
26448 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26449 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26451 /* Find the highest priority overlay with a mouse-face. */
26452 Lisp_Object overlay
= Qnil
;
26453 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26455 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26456 if (!NILP (mouse_face
))
26457 overlay
= overlay_vec
[i
];
26460 /* If we're highlighting the same overlay as before, there's
26461 no need to do that again. */
26462 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26463 goto check_help_echo
;
26464 hlinfo
->mouse_face_overlay
= overlay
;
26466 /* Clear the display of the old active region, if any. */
26467 if (clear_mouse_face (hlinfo
))
26468 cursor
= No_Cursor
;
26470 /* If no overlay applies, get a text property. */
26471 if (NILP (overlay
))
26472 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26474 /* Next, compute the bounds of the mouse highlighting and
26476 if (!NILP (mouse_face
) && STRINGP (object
))
26478 /* The mouse-highlighting comes from a display string
26479 with a mouse-face. */
26483 s
= Fprevious_single_property_change
26484 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26485 e
= Fnext_single_property_change
26486 (position
, Qmouse_face
, object
, Qnil
);
26488 s
= make_number (0);
26490 e
= make_number (SCHARS (object
) - 1);
26491 mouse_face_from_string_pos (w
, hlinfo
, object
,
26492 XINT (s
), XINT (e
));
26493 hlinfo
->mouse_face_past_end
= 0;
26494 hlinfo
->mouse_face_window
= window
;
26495 hlinfo
->mouse_face_face_id
26496 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26497 glyph
->face_id
, 1);
26498 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26499 cursor
= No_Cursor
;
26503 /* The mouse-highlighting, if any, comes from an overlay
26504 or text property in the buffer. */
26505 Lisp_Object buffer
IF_LINT (= Qnil
);
26506 Lisp_Object cover_string
IF_LINT (= Qnil
);
26508 if (STRINGP (object
))
26510 /* If we are on a display string with no mouse-face,
26511 check if the text under it has one. */
26512 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26513 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26514 pos
= string_buffer_position (object
, start
);
26517 mouse_face
= get_char_property_and_overlay
26518 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26519 buffer
= w
->buffer
;
26520 cover_string
= object
;
26526 cover_string
= Qnil
;
26529 if (!NILP (mouse_face
))
26531 Lisp_Object before
, after
;
26532 Lisp_Object before_string
, after_string
;
26533 /* To correctly find the limits of mouse highlight
26534 in a bidi-reordered buffer, we must not use the
26535 optimization of limiting the search in
26536 previous-single-property-change and
26537 next-single-property-change, because
26538 rows_from_pos_range needs the real start and end
26539 positions to DTRT in this case. That's because
26540 the first row visible in a window does not
26541 necessarily display the character whose position
26542 is the smallest. */
26544 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26545 ? Fmarker_position (w
->start
)
26548 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26549 ? make_number (BUF_Z (XBUFFER (buffer
))
26550 - XFASTINT (w
->window_end_pos
))
26553 if (NILP (overlay
))
26555 /* Handle the text property case. */
26556 before
= Fprevious_single_property_change
26557 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26558 after
= Fnext_single_property_change
26559 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26560 before_string
= after_string
= Qnil
;
26564 /* Handle the overlay case. */
26565 before
= Foverlay_start (overlay
);
26566 after
= Foverlay_end (overlay
);
26567 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26568 after_string
= Foverlay_get (overlay
, Qafter_string
);
26570 if (!STRINGP (before_string
)) before_string
= Qnil
;
26571 if (!STRINGP (after_string
)) after_string
= Qnil
;
26574 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26577 before_string
, after_string
,
26579 cursor
= No_Cursor
;
26586 /* Look for a `help-echo' property. */
26587 if (NILP (help_echo_string
)) {
26588 Lisp_Object help
, overlay
;
26590 /* Check overlays first. */
26591 help
= overlay
= Qnil
;
26592 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26594 overlay
= overlay_vec
[i
];
26595 help
= Foverlay_get (overlay
, Qhelp_echo
);
26600 help_echo_string
= help
;
26601 help_echo_window
= window
;
26602 help_echo_object
= overlay
;
26603 help_echo_pos
= pos
;
26607 Lisp_Object obj
= glyph
->object
;
26608 EMACS_INT charpos
= glyph
->charpos
;
26610 /* Try text properties. */
26613 && charpos
< SCHARS (obj
))
26615 help
= Fget_text_property (make_number (charpos
),
26619 /* If the string itself doesn't specify a help-echo,
26620 see if the buffer text ``under'' it does. */
26621 struct glyph_row
*r
26622 = MATRIX_ROW (w
->current_matrix
, vpos
);
26623 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26624 EMACS_INT p
= string_buffer_position (obj
, start
);
26627 help
= Fget_char_property (make_number (p
),
26628 Qhelp_echo
, w
->buffer
);
26637 else if (BUFFERP (obj
)
26640 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26645 help_echo_string
= help
;
26646 help_echo_window
= window
;
26647 help_echo_object
= obj
;
26648 help_echo_pos
= charpos
;
26653 #ifdef HAVE_WINDOW_SYSTEM
26654 /* Look for a `pointer' property. */
26655 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26657 /* Check overlays first. */
26658 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26659 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26661 if (NILP (pointer
))
26663 Lisp_Object obj
= glyph
->object
;
26664 EMACS_INT charpos
= glyph
->charpos
;
26666 /* Try text properties. */
26669 && charpos
< SCHARS (obj
))
26671 pointer
= Fget_text_property (make_number (charpos
),
26673 if (NILP (pointer
))
26675 /* If the string itself doesn't specify a pointer,
26676 see if the buffer text ``under'' it does. */
26677 struct glyph_row
*r
26678 = MATRIX_ROW (w
->current_matrix
, vpos
);
26679 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26680 EMACS_INT p
= string_buffer_position (obj
, start
);
26682 pointer
= Fget_char_property (make_number (p
),
26683 Qpointer
, w
->buffer
);
26686 else if (BUFFERP (obj
)
26689 pointer
= Fget_text_property (make_number (charpos
),
26693 #endif /* HAVE_WINDOW_SYSTEM */
26697 current_buffer
= obuf
;
26702 #ifdef HAVE_WINDOW_SYSTEM
26703 if (FRAME_WINDOW_P (f
))
26704 define_frame_cursor1 (f
, cursor
, pointer
);
26706 /* This is here to prevent a compiler error, about "label at end of
26707 compound statement". */
26714 Clear any mouse-face on window W. This function is part of the
26715 redisplay interface, and is called from try_window_id and similar
26716 functions to ensure the mouse-highlight is off. */
26719 x_clear_window_mouse_face (struct window
*w
)
26721 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26722 Lisp_Object window
;
26725 XSETWINDOW (window
, w
);
26726 if (EQ (window
, hlinfo
->mouse_face_window
))
26727 clear_mouse_face (hlinfo
);
26733 Just discard the mouse face information for frame F, if any.
26734 This is used when the size of F is changed. */
26737 cancel_mouse_face (struct frame
*f
)
26739 Lisp_Object window
;
26740 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26742 window
= hlinfo
->mouse_face_window
;
26743 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26745 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26746 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26747 hlinfo
->mouse_face_window
= Qnil
;
26753 /***********************************************************************
26755 ***********************************************************************/
26757 #ifdef HAVE_WINDOW_SYSTEM
26759 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26760 which intersects rectangle R. R is in window-relative coordinates. */
26763 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26764 enum glyph_row_area area
)
26766 struct glyph
*first
= row
->glyphs
[area
];
26767 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26768 struct glyph
*last
;
26769 int first_x
, start_x
, x
;
26771 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26772 /* If row extends face to end of line write the whole line. */
26773 draw_glyphs (w
, 0, row
, area
,
26774 0, row
->used
[area
],
26775 DRAW_NORMAL_TEXT
, 0);
26778 /* Set START_X to the window-relative start position for drawing glyphs of
26779 AREA. The first glyph of the text area can be partially visible.
26780 The first glyphs of other areas cannot. */
26781 start_x
= window_box_left_offset (w
, area
);
26783 if (area
== TEXT_AREA
)
26786 /* Find the first glyph that must be redrawn. */
26788 && x
+ first
->pixel_width
< r
->x
)
26790 x
+= first
->pixel_width
;
26794 /* Find the last one. */
26798 && x
< r
->x
+ r
->width
)
26800 x
+= last
->pixel_width
;
26806 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26807 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26808 DRAW_NORMAL_TEXT
, 0);
26813 /* Redraw the parts of the glyph row ROW on window W intersecting
26814 rectangle R. R is in window-relative coordinates. Value is
26815 non-zero if mouse-face was overwritten. */
26818 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26820 xassert (row
->enabled_p
);
26822 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26823 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26824 0, row
->used
[TEXT_AREA
],
26825 DRAW_NORMAL_TEXT
, 0);
26828 if (row
->used
[LEFT_MARGIN_AREA
])
26829 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26830 if (row
->used
[TEXT_AREA
])
26831 expose_area (w
, row
, r
, TEXT_AREA
);
26832 if (row
->used
[RIGHT_MARGIN_AREA
])
26833 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26834 draw_row_fringe_bitmaps (w
, row
);
26837 return row
->mouse_face_p
;
26841 /* Redraw those parts of glyphs rows during expose event handling that
26842 overlap other rows. Redrawing of an exposed line writes over parts
26843 of lines overlapping that exposed line; this function fixes that.
26845 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26846 row in W's current matrix that is exposed and overlaps other rows.
26847 LAST_OVERLAPPING_ROW is the last such row. */
26850 expose_overlaps (struct window
*w
,
26851 struct glyph_row
*first_overlapping_row
,
26852 struct glyph_row
*last_overlapping_row
,
26855 struct glyph_row
*row
;
26857 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26858 if (row
->overlapping_p
)
26860 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26863 if (row
->used
[LEFT_MARGIN_AREA
])
26864 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26866 if (row
->used
[TEXT_AREA
])
26867 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26869 if (row
->used
[RIGHT_MARGIN_AREA
])
26870 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26876 /* Return non-zero if W's cursor intersects rectangle R. */
26879 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26881 XRectangle cr
, result
;
26882 struct glyph
*cursor_glyph
;
26883 struct glyph_row
*row
;
26885 if (w
->phys_cursor
.vpos
>= 0
26886 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26887 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26889 && row
->cursor_in_fringe_p
)
26891 /* Cursor is in the fringe. */
26892 cr
.x
= window_box_right_offset (w
,
26893 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26894 ? RIGHT_MARGIN_AREA
26897 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26898 cr
.height
= row
->height
;
26899 return x_intersect_rectangles (&cr
, r
, &result
);
26902 cursor_glyph
= get_phys_cursor_glyph (w
);
26905 /* r is relative to W's box, but w->phys_cursor.x is relative
26906 to left edge of W's TEXT area. Adjust it. */
26907 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26908 cr
.y
= w
->phys_cursor
.y
;
26909 cr
.width
= cursor_glyph
->pixel_width
;
26910 cr
.height
= w
->phys_cursor_height
;
26911 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26912 I assume the effect is the same -- and this is portable. */
26913 return x_intersect_rectangles (&cr
, r
, &result
);
26915 /* If we don't understand the format, pretend we're not in the hot-spot. */
26921 Draw a vertical window border to the right of window W if W doesn't
26922 have vertical scroll bars. */
26925 x_draw_vertical_border (struct window
*w
)
26927 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26929 /* We could do better, if we knew what type of scroll-bar the adjacent
26930 windows (on either side) have... But we don't :-(
26931 However, I think this works ok. ++KFS 2003-04-25 */
26933 /* Redraw borders between horizontally adjacent windows. Don't
26934 do it for frames with vertical scroll bars because either the
26935 right scroll bar of a window, or the left scroll bar of its
26936 neighbor will suffice as a border. */
26937 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26940 if (!WINDOW_RIGHTMOST_P (w
)
26941 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26943 int x0
, x1
, y0
, y1
;
26945 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26948 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26951 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26953 else if (!WINDOW_LEFTMOST_P (w
)
26954 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26956 int x0
, x1
, y0
, y1
;
26958 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26961 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26964 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26969 /* Redraw the part of window W intersection rectangle FR. Pixel
26970 coordinates in FR are frame-relative. Call this function with
26971 input blocked. Value is non-zero if the exposure overwrites
26975 expose_window (struct window
*w
, XRectangle
*fr
)
26977 struct frame
*f
= XFRAME (w
->frame
);
26979 int mouse_face_overwritten_p
= 0;
26981 /* If window is not yet fully initialized, do nothing. This can
26982 happen when toolkit scroll bars are used and a window is split.
26983 Reconfiguring the scroll bar will generate an expose for a newly
26985 if (w
->current_matrix
== NULL
)
26988 /* When we're currently updating the window, display and current
26989 matrix usually don't agree. Arrange for a thorough display
26991 if (w
== updated_window
)
26993 SET_FRAME_GARBAGED (f
);
26997 /* Frame-relative pixel rectangle of W. */
26998 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
26999 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27000 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27001 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27003 if (x_intersect_rectangles (fr
, &wr
, &r
))
27005 int yb
= window_text_bottom_y (w
);
27006 struct glyph_row
*row
;
27007 int cursor_cleared_p
;
27008 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27010 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27011 r
.x
, r
.y
, r
.width
, r
.height
));
27013 /* Convert to window coordinates. */
27014 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27015 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27017 /* Turn off the cursor. */
27018 if (!w
->pseudo_window_p
27019 && phys_cursor_in_rect_p (w
, &r
))
27021 x_clear_cursor (w
);
27022 cursor_cleared_p
= 1;
27025 cursor_cleared_p
= 0;
27027 /* Update lines intersecting rectangle R. */
27028 first_overlapping_row
= last_overlapping_row
= NULL
;
27029 for (row
= w
->current_matrix
->rows
;
27034 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27036 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27037 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27038 || (r
.y
>= y0
&& r
.y
< y1
)
27039 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27041 /* A header line may be overlapping, but there is no need
27042 to fix overlapping areas for them. KFS 2005-02-12 */
27043 if (row
->overlapping_p
&& !row
->mode_line_p
)
27045 if (first_overlapping_row
== NULL
)
27046 first_overlapping_row
= row
;
27047 last_overlapping_row
= row
;
27051 if (expose_line (w
, row
, &r
))
27052 mouse_face_overwritten_p
= 1;
27055 else if (row
->overlapping_p
)
27057 /* We must redraw a row overlapping the exposed area. */
27059 ? y0
+ row
->phys_height
> r
.y
27060 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27062 if (first_overlapping_row
== NULL
)
27063 first_overlapping_row
= row
;
27064 last_overlapping_row
= row
;
27072 /* Display the mode line if there is one. */
27073 if (WINDOW_WANTS_MODELINE_P (w
)
27074 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27076 && row
->y
< r
.y
+ r
.height
)
27078 if (expose_line (w
, row
, &r
))
27079 mouse_face_overwritten_p
= 1;
27082 if (!w
->pseudo_window_p
)
27084 /* Fix the display of overlapping rows. */
27085 if (first_overlapping_row
)
27086 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27089 /* Draw border between windows. */
27090 x_draw_vertical_border (w
);
27092 /* Turn the cursor on again. */
27093 if (cursor_cleared_p
)
27094 update_window_cursor (w
, 1);
27098 return mouse_face_overwritten_p
;
27103 /* Redraw (parts) of all windows in the window tree rooted at W that
27104 intersect R. R contains frame pixel coordinates. Value is
27105 non-zero if the exposure overwrites mouse-face. */
27108 expose_window_tree (struct window
*w
, XRectangle
*r
)
27110 struct frame
*f
= XFRAME (w
->frame
);
27111 int mouse_face_overwritten_p
= 0;
27113 while (w
&& !FRAME_GARBAGED_P (f
))
27115 if (!NILP (w
->hchild
))
27116 mouse_face_overwritten_p
27117 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27118 else if (!NILP (w
->vchild
))
27119 mouse_face_overwritten_p
27120 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27122 mouse_face_overwritten_p
|= expose_window (w
, r
);
27124 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27127 return mouse_face_overwritten_p
;
27132 Redisplay an exposed area of frame F. X and Y are the upper-left
27133 corner of the exposed rectangle. W and H are width and height of
27134 the exposed area. All are pixel values. W or H zero means redraw
27135 the entire frame. */
27138 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27141 int mouse_face_overwritten_p
= 0;
27143 TRACE ((stderr
, "expose_frame "));
27145 /* No need to redraw if frame will be redrawn soon. */
27146 if (FRAME_GARBAGED_P (f
))
27148 TRACE ((stderr
, " garbaged\n"));
27152 /* If basic faces haven't been realized yet, there is no point in
27153 trying to redraw anything. This can happen when we get an expose
27154 event while Emacs is starting, e.g. by moving another window. */
27155 if (FRAME_FACE_CACHE (f
) == NULL
27156 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27158 TRACE ((stderr
, " no faces\n"));
27162 if (w
== 0 || h
== 0)
27165 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27166 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27176 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27177 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27179 if (WINDOWP (f
->tool_bar_window
))
27180 mouse_face_overwritten_p
27181 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27183 #ifdef HAVE_X_WINDOWS
27185 #ifndef USE_X_TOOLKIT
27186 if (WINDOWP (f
->menu_bar_window
))
27187 mouse_face_overwritten_p
27188 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27189 #endif /* not USE_X_TOOLKIT */
27193 /* Some window managers support a focus-follows-mouse style with
27194 delayed raising of frames. Imagine a partially obscured frame,
27195 and moving the mouse into partially obscured mouse-face on that
27196 frame. The visible part of the mouse-face will be highlighted,
27197 then the WM raises the obscured frame. With at least one WM, KDE
27198 2.1, Emacs is not getting any event for the raising of the frame
27199 (even tried with SubstructureRedirectMask), only Expose events.
27200 These expose events will draw text normally, i.e. not
27201 highlighted. Which means we must redo the highlight here.
27202 Subsume it under ``we love X''. --gerd 2001-08-15 */
27203 /* Included in Windows version because Windows most likely does not
27204 do the right thing if any third party tool offers
27205 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27206 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27208 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27209 if (f
== hlinfo
->mouse_face_mouse_frame
)
27211 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27212 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27213 clear_mouse_face (hlinfo
);
27214 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27221 Determine the intersection of two rectangles R1 and R2. Return
27222 the intersection in *RESULT. Value is non-zero if RESULT is not
27226 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27228 XRectangle
*left
, *right
;
27229 XRectangle
*upper
, *lower
;
27230 int intersection_p
= 0;
27232 /* Rearrange so that R1 is the left-most rectangle. */
27234 left
= r1
, right
= r2
;
27236 left
= r2
, right
= r1
;
27238 /* X0 of the intersection is right.x0, if this is inside R1,
27239 otherwise there is no intersection. */
27240 if (right
->x
<= left
->x
+ left
->width
)
27242 result
->x
= right
->x
;
27244 /* The right end of the intersection is the minimum of
27245 the right ends of left and right. */
27246 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27249 /* Same game for Y. */
27251 upper
= r1
, lower
= r2
;
27253 upper
= r2
, lower
= r1
;
27255 /* The upper end of the intersection is lower.y0, if this is inside
27256 of upper. Otherwise, there is no intersection. */
27257 if (lower
->y
<= upper
->y
+ upper
->height
)
27259 result
->y
= lower
->y
;
27261 /* The lower end of the intersection is the minimum of the lower
27262 ends of upper and lower. */
27263 result
->height
= (min (lower
->y
+ lower
->height
,
27264 upper
->y
+ upper
->height
)
27266 intersection_p
= 1;
27270 return intersection_p
;
27273 #endif /* HAVE_WINDOW_SYSTEM */
27276 /***********************************************************************
27278 ***********************************************************************/
27281 syms_of_xdisp (void)
27283 Vwith_echo_area_save_vector
= Qnil
;
27284 staticpro (&Vwith_echo_area_save_vector
);
27286 Vmessage_stack
= Qnil
;
27287 staticpro (&Vmessage_stack
);
27289 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27291 message_dolog_marker1
= Fmake_marker ();
27292 staticpro (&message_dolog_marker1
);
27293 message_dolog_marker2
= Fmake_marker ();
27294 staticpro (&message_dolog_marker2
);
27295 message_dolog_marker3
= Fmake_marker ();
27296 staticpro (&message_dolog_marker3
);
27299 defsubr (&Sdump_frame_glyph_matrix
);
27300 defsubr (&Sdump_glyph_matrix
);
27301 defsubr (&Sdump_glyph_row
);
27302 defsubr (&Sdump_tool_bar_row
);
27303 defsubr (&Strace_redisplay
);
27304 defsubr (&Strace_to_stderr
);
27306 #ifdef HAVE_WINDOW_SYSTEM
27307 defsubr (&Stool_bar_lines_needed
);
27308 defsubr (&Slookup_image_map
);
27310 defsubr (&Sformat_mode_line
);
27311 defsubr (&Sinvisible_p
);
27312 defsubr (&Scurrent_bidi_paragraph_direction
);
27314 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27315 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27316 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27317 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27318 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27319 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27320 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27321 DEFSYM (Qeval
, "eval");
27322 DEFSYM (QCdata
, ":data");
27323 DEFSYM (Qdisplay
, "display");
27324 DEFSYM (Qspace_width
, "space-width");
27325 DEFSYM (Qraise
, "raise");
27326 DEFSYM (Qslice
, "slice");
27327 DEFSYM (Qspace
, "space");
27328 DEFSYM (Qmargin
, "margin");
27329 DEFSYM (Qpointer
, "pointer");
27330 DEFSYM (Qleft_margin
, "left-margin");
27331 DEFSYM (Qright_margin
, "right-margin");
27332 DEFSYM (Qcenter
, "center");
27333 DEFSYM (Qline_height
, "line-height");
27334 DEFSYM (QCalign_to
, ":align-to");
27335 DEFSYM (QCrelative_width
, ":relative-width");
27336 DEFSYM (QCrelative_height
, ":relative-height");
27337 DEFSYM (QCeval
, ":eval");
27338 DEFSYM (QCpropertize
, ":propertize");
27339 DEFSYM (QCfile
, ":file");
27340 DEFSYM (Qfontified
, "fontified");
27341 DEFSYM (Qfontification_functions
, "fontification-functions");
27342 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27343 DEFSYM (Qescape_glyph
, "escape-glyph");
27344 DEFSYM (Qnobreak_space
, "nobreak-space");
27345 DEFSYM (Qimage
, "image");
27346 DEFSYM (Qtext
, "text");
27347 DEFSYM (Qboth
, "both");
27348 DEFSYM (Qboth_horiz
, "both-horiz");
27349 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27350 DEFSYM (QCmap
, ":map");
27351 DEFSYM (QCpointer
, ":pointer");
27352 DEFSYM (Qrect
, "rect");
27353 DEFSYM (Qcircle
, "circle");
27354 DEFSYM (Qpoly
, "poly");
27355 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27356 DEFSYM (Qgrow_only
, "grow-only");
27357 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27358 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27359 DEFSYM (Qposition
, "position");
27360 DEFSYM (Qbuffer_position
, "buffer-position");
27361 DEFSYM (Qobject
, "object");
27362 DEFSYM (Qbar
, "bar");
27363 DEFSYM (Qhbar
, "hbar");
27364 DEFSYM (Qbox
, "box");
27365 DEFSYM (Qhollow
, "hollow");
27366 DEFSYM (Qhand
, "hand");
27367 DEFSYM (Qarrow
, "arrow");
27368 DEFSYM (Qtext
, "text");
27369 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27371 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27372 Fcons (intern_c_string ("void-variable"), Qnil
)),
27374 staticpro (&list_of_error
);
27376 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27377 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27378 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27379 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27381 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27382 staticpro (&echo_buffer
[0]);
27383 staticpro (&echo_buffer
[1]);
27385 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27386 staticpro (&echo_area_buffer
[0]);
27387 staticpro (&echo_area_buffer
[1]);
27389 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27390 staticpro (&Vmessages_buffer_name
);
27392 mode_line_proptrans_alist
= Qnil
;
27393 staticpro (&mode_line_proptrans_alist
);
27394 mode_line_string_list
= Qnil
;
27395 staticpro (&mode_line_string_list
);
27396 mode_line_string_face
= Qnil
;
27397 staticpro (&mode_line_string_face
);
27398 mode_line_string_face_prop
= Qnil
;
27399 staticpro (&mode_line_string_face_prop
);
27400 Vmode_line_unwind_vector
= Qnil
;
27401 staticpro (&Vmode_line_unwind_vector
);
27403 help_echo_string
= Qnil
;
27404 staticpro (&help_echo_string
);
27405 help_echo_object
= Qnil
;
27406 staticpro (&help_echo_object
);
27407 help_echo_window
= Qnil
;
27408 staticpro (&help_echo_window
);
27409 previous_help_echo_string
= Qnil
;
27410 staticpro (&previous_help_echo_string
);
27411 help_echo_pos
= -1;
27413 DEFSYM (Qright_to_left
, "right-to-left");
27414 DEFSYM (Qleft_to_right
, "left-to-right");
27416 #ifdef HAVE_WINDOW_SYSTEM
27417 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27418 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27419 For example, if a block cursor is over a tab, it will be drawn as
27420 wide as that tab on the display. */);
27421 x_stretch_cursor_p
= 0;
27424 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27425 doc
: /* *Non-nil means highlight trailing whitespace.
27426 The face used for trailing whitespace is `trailing-whitespace'. */);
27427 Vshow_trailing_whitespace
= Qnil
;
27429 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27430 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27431 A value of t means highlight the character itself (for nobreak space,
27432 use face `nobreak-space').
27433 A value of nil means no highlighting.
27434 Other values mean display the escape glyph followed by an ordinary
27435 space or ordinary hyphen. */);
27436 Vnobreak_char_display
= Qt
;
27438 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27439 doc
: /* *The pointer shape to show in void text areas.
27440 A value of nil means to show the text pointer. Other options are `arrow',
27441 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27442 Vvoid_text_area_pointer
= Qarrow
;
27444 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27445 doc
: /* Non-nil means don't actually do any redisplay.
27446 This is used for internal purposes. */);
27447 Vinhibit_redisplay
= Qnil
;
27449 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27450 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27451 Vglobal_mode_string
= Qnil
;
27453 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27454 doc
: /* Marker for where to display an arrow on top of the buffer text.
27455 This must be the beginning of a line in order to work.
27456 See also `overlay-arrow-string'. */);
27457 Voverlay_arrow_position
= Qnil
;
27459 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27460 doc
: /* String to display as an arrow in non-window frames.
27461 See also `overlay-arrow-position'. */);
27462 Voverlay_arrow_string
= make_pure_c_string ("=>");
27464 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27465 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27466 The symbols on this list are examined during redisplay to determine
27467 where to display overlay arrows. */);
27468 Voverlay_arrow_variable_list
27469 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27471 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27472 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27473 If that fails to bring point back on frame, point is centered instead.
27474 If this is zero, point is always centered after it moves off frame.
27475 If you want scrolling to always be a line at a time, you should set
27476 `scroll-conservatively' to a large value rather than set this to 1. */);
27478 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27479 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27480 If point moves off-screen, redisplay will scroll by up to
27481 `scroll-conservatively' lines in order to bring point just barely
27482 onto the screen again. If that cannot be done, then redisplay
27483 recenters point as usual.
27485 If the value is greater than 100, redisplay will never recenter point,
27486 but will always scroll just enough text to bring point into view, even
27487 if you move far away.
27489 A value of zero means always recenter point if it moves off screen. */);
27490 scroll_conservatively
= 0;
27492 DEFVAR_INT ("scroll-margin", scroll_margin
,
27493 doc
: /* *Number of lines of margin at the top and bottom of a window.
27494 Recenter the window whenever point gets within this many lines
27495 of the top or bottom of the window. */);
27498 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27499 doc
: /* Pixels per inch value for non-window system displays.
27500 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27501 Vdisplay_pixels_per_inch
= make_float (72.0);
27504 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27507 DEFVAR_LISP ("truncate-partial-width-windows",
27508 Vtruncate_partial_width_windows
,
27509 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27510 For an integer value, truncate lines in each window narrower than the
27511 full frame width, provided the window width is less than that integer;
27512 otherwise, respect the value of `truncate-lines'.
27514 For any other non-nil value, truncate lines in all windows that do
27515 not span the full frame width.
27517 A value of nil means to respect the value of `truncate-lines'.
27519 If `word-wrap' is enabled, you might want to reduce this. */);
27520 Vtruncate_partial_width_windows
= make_number (50);
27522 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27523 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27524 Any other value means to use the appropriate face, `mode-line',
27525 `header-line', or `menu' respectively. */);
27526 mode_line_inverse_video
= 1;
27528 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27529 doc
: /* *Maximum buffer size for which line number should be displayed.
27530 If the buffer is bigger than this, the line number does not appear
27531 in the mode line. A value of nil means no limit. */);
27532 Vline_number_display_limit
= Qnil
;
27534 DEFVAR_INT ("line-number-display-limit-width",
27535 line_number_display_limit_width
,
27536 doc
: /* *Maximum line width (in characters) for line number display.
27537 If the average length of the lines near point is bigger than this, then the
27538 line number may be omitted from the mode line. */);
27539 line_number_display_limit_width
= 200;
27541 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27542 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27543 highlight_nonselected_windows
= 0;
27545 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27546 doc
: /* Non-nil if more than one frame is visible on this display.
27547 Minibuffer-only frames don't count, but iconified frames do.
27548 This variable is not guaranteed to be accurate except while processing
27549 `frame-title-format' and `icon-title-format'. */);
27551 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27552 doc
: /* Template for displaying the title bar of visible frames.
27553 \(Assuming the window manager supports this feature.)
27555 This variable has the same structure as `mode-line-format', except that
27556 the %c and %l constructs are ignored. It is used only on frames for
27557 which no explicit name has been set \(see `modify-frame-parameters'). */);
27559 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27560 doc
: /* Template for displaying the title bar of an iconified frame.
27561 \(Assuming the window manager supports this feature.)
27562 This variable has the same structure as `mode-line-format' (which see),
27563 and is used only on frames for which no explicit name has been set
27564 \(see `modify-frame-parameters'). */);
27566 = Vframe_title_format
27567 = pure_cons (intern_c_string ("multiple-frames"),
27568 pure_cons (make_pure_c_string ("%b"),
27569 pure_cons (pure_cons (empty_unibyte_string
,
27570 pure_cons (intern_c_string ("invocation-name"),
27571 pure_cons (make_pure_c_string ("@"),
27572 pure_cons (intern_c_string ("system-name"),
27576 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27577 doc
: /* Maximum number of lines to keep in the message log buffer.
27578 If nil, disable message logging. If t, log messages but don't truncate
27579 the buffer when it becomes large. */);
27580 Vmessage_log_max
= make_number (100);
27582 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27583 doc
: /* Functions called before redisplay, if window sizes have changed.
27584 The value should be a list of functions that take one argument.
27585 Just before redisplay, for each frame, if any of its windows have changed
27586 size since the last redisplay, or have been split or deleted,
27587 all the functions in the list are called, with the frame as argument. */);
27588 Vwindow_size_change_functions
= Qnil
;
27590 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27591 doc
: /* List of functions to call before redisplaying a window with scrolling.
27592 Each function is called with two arguments, the window and its new
27593 display-start position. Note that these functions are also called by
27594 `set-window-buffer'. Also note that the value of `window-end' is not
27595 valid when these functions are called. */);
27596 Vwindow_scroll_functions
= Qnil
;
27598 DEFVAR_LISP ("window-text-change-functions",
27599 Vwindow_text_change_functions
,
27600 doc
: /* Functions to call in redisplay when text in the window might change. */);
27601 Vwindow_text_change_functions
= Qnil
;
27603 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27604 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27605 Each function is called with two arguments, the window and the end trigger value.
27606 See `set-window-redisplay-end-trigger'. */);
27607 Vredisplay_end_trigger_functions
= Qnil
;
27609 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27610 doc
: /* *Non-nil means autoselect window with mouse pointer.
27611 If nil, do not autoselect windows.
27612 A positive number means delay autoselection by that many seconds: a
27613 window is autoselected only after the mouse has remained in that
27614 window for the duration of the delay.
27615 A negative number has a similar effect, but causes windows to be
27616 autoselected only after the mouse has stopped moving. \(Because of
27617 the way Emacs compares mouse events, you will occasionally wait twice
27618 that time before the window gets selected.\)
27619 Any other value means to autoselect window instantaneously when the
27620 mouse pointer enters it.
27622 Autoselection selects the minibuffer only if it is active, and never
27623 unselects the minibuffer if it is active.
27625 When customizing this variable make sure that the actual value of
27626 `focus-follows-mouse' matches the behavior of your window manager. */);
27627 Vmouse_autoselect_window
= Qnil
;
27629 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27630 doc
: /* *Non-nil means automatically resize tool-bars.
27631 This dynamically changes the tool-bar's height to the minimum height
27632 that is needed to make all tool-bar items visible.
27633 If value is `grow-only', the tool-bar's height is only increased
27634 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27635 Vauto_resize_tool_bars
= Qt
;
27637 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27638 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27639 auto_raise_tool_bar_buttons_p
= 1;
27641 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27642 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27643 make_cursor_line_fully_visible_p
= 1;
27645 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27646 doc
: /* *Border below tool-bar in pixels.
27647 If an integer, use it as the height of the border.
27648 If it is one of `internal-border-width' or `border-width', use the
27649 value of the corresponding frame parameter.
27650 Otherwise, no border is added below the tool-bar. */);
27651 Vtool_bar_border
= Qinternal_border_width
;
27653 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27654 doc
: /* *Margin around tool-bar buttons in pixels.
27655 If an integer, use that for both horizontal and vertical margins.
27656 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27657 HORZ specifying the horizontal margin, and VERT specifying the
27658 vertical margin. */);
27659 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27661 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27662 doc
: /* *Relief thickness of tool-bar buttons. */);
27663 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27665 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27666 doc
: /* Tool bar style to use.
27668 image - show images only
27669 text - show text only
27670 both - show both, text below image
27671 both-horiz - show text to the right of the image
27672 text-image-horiz - show text to the left of the image
27673 any other - use system default or image if no system default. */);
27674 Vtool_bar_style
= Qnil
;
27676 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27677 doc
: /* *Maximum number of characters a label can have to be shown.
27678 The tool bar style must also show labels for this to have any effect, see
27679 `tool-bar-style'. */);
27680 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27682 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27683 doc
: /* List of functions to call to fontify regions of text.
27684 Each function is called with one argument POS. Functions must
27685 fontify a region starting at POS in the current buffer, and give
27686 fontified regions the property `fontified'. */);
27687 Vfontification_functions
= Qnil
;
27688 Fmake_variable_buffer_local (Qfontification_functions
);
27690 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27691 unibyte_display_via_language_environment
,
27692 doc
: /* *Non-nil means display unibyte text according to language environment.
27693 Specifically, this means that raw bytes in the range 160-255 decimal
27694 are displayed by converting them to the equivalent multibyte characters
27695 according to the current language environment. As a result, they are
27696 displayed according to the current fontset.
27698 Note that this variable affects only how these bytes are displayed,
27699 but does not change the fact they are interpreted as raw bytes. */);
27700 unibyte_display_via_language_environment
= 0;
27702 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27703 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27704 If a float, it specifies a fraction of the mini-window frame's height.
27705 If an integer, it specifies a number of lines. */);
27706 Vmax_mini_window_height
= make_float (0.25);
27708 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27709 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27710 A value of nil means don't automatically resize mini-windows.
27711 A value of t means resize them to fit the text displayed in them.
27712 A value of `grow-only', the default, means let mini-windows grow only;
27713 they return to their normal size when the minibuffer is closed, or the
27714 echo area becomes empty. */);
27715 Vresize_mini_windows
= Qgrow_only
;
27717 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27718 doc
: /* Alist specifying how to blink the cursor off.
27719 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27720 `cursor-type' frame-parameter or variable equals ON-STATE,
27721 comparing using `equal', Emacs uses OFF-STATE to specify
27722 how to blink it off. ON-STATE and OFF-STATE are values for
27723 the `cursor-type' frame parameter.
27725 If a frame's ON-STATE has no entry in this list,
27726 the frame's other specifications determine how to blink the cursor off. */);
27727 Vblink_cursor_alist
= Qnil
;
27729 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27730 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27731 If non-nil, windows are automatically scrolled horizontally to make
27732 point visible. */);
27733 automatic_hscrolling_p
= 1;
27734 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27736 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27737 doc
: /* *How many columns away from the window edge point is allowed to get
27738 before automatic hscrolling will horizontally scroll the window. */);
27739 hscroll_margin
= 5;
27741 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27742 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27743 When point is less than `hscroll-margin' columns from the window
27744 edge, automatic hscrolling will scroll the window by the amount of columns
27745 determined by this variable. If its value is a positive integer, scroll that
27746 many columns. If it's a positive floating-point number, it specifies the
27747 fraction of the window's width to scroll. If it's nil or zero, point will be
27748 centered horizontally after the scroll. Any other value, including negative
27749 numbers, are treated as if the value were zero.
27751 Automatic hscrolling always moves point outside the scroll margin, so if
27752 point was more than scroll step columns inside the margin, the window will
27753 scroll more than the value given by the scroll step.
27755 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27756 and `scroll-right' overrides this variable's effect. */);
27757 Vhscroll_step
= make_number (0);
27759 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27760 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27761 Bind this around calls to `message' to let it take effect. */);
27762 message_truncate_lines
= 0;
27764 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27765 doc
: /* Normal hook run to update the menu bar definitions.
27766 Redisplay runs this hook before it redisplays the menu bar.
27767 This is used to update submenus such as Buffers,
27768 whose contents depend on various data. */);
27769 Vmenu_bar_update_hook
= Qnil
;
27771 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27772 doc
: /* Frame for which we are updating a menu.
27773 The enable predicate for a menu binding should check this variable. */);
27774 Vmenu_updating_frame
= Qnil
;
27776 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27777 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27778 inhibit_menubar_update
= 0;
27780 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27781 doc
: /* Prefix prepended to all continuation lines at display time.
27782 The value may be a string, an image, or a stretch-glyph; it is
27783 interpreted in the same way as the value of a `display' text property.
27785 This variable is overridden by any `wrap-prefix' text or overlay
27788 To add a prefix to non-continuation lines, use `line-prefix'. */);
27789 Vwrap_prefix
= Qnil
;
27790 DEFSYM (Qwrap_prefix
, "wrap-prefix");
27791 Fmake_variable_buffer_local (Qwrap_prefix
);
27793 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27794 doc
: /* Prefix prepended to all non-continuation lines at display time.
27795 The value may be a string, an image, or a stretch-glyph; it is
27796 interpreted in the same way as the value of a `display' text property.
27798 This variable is overridden by any `line-prefix' text or overlay
27801 To add a prefix to continuation lines, use `wrap-prefix'. */);
27802 Vline_prefix
= Qnil
;
27803 DEFSYM (Qline_prefix
, "line-prefix");
27804 Fmake_variable_buffer_local (Qline_prefix
);
27806 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27807 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27808 inhibit_eval_during_redisplay
= 0;
27810 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27811 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27812 inhibit_free_realized_faces
= 0;
27815 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27816 doc
: /* Inhibit try_window_id display optimization. */);
27817 inhibit_try_window_id
= 0;
27819 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27820 doc
: /* Inhibit try_window_reusing display optimization. */);
27821 inhibit_try_window_reusing
= 0;
27823 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27824 doc
: /* Inhibit try_cursor_movement display optimization. */);
27825 inhibit_try_cursor_movement
= 0;
27826 #endif /* GLYPH_DEBUG */
27828 DEFVAR_INT ("overline-margin", overline_margin
,
27829 doc
: /* *Space between overline and text, in pixels.
27830 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27831 margin to the caracter height. */);
27832 overline_margin
= 2;
27834 DEFVAR_INT ("underline-minimum-offset",
27835 underline_minimum_offset
,
27836 doc
: /* Minimum distance between baseline and underline.
27837 This can improve legibility of underlined text at small font sizes,
27838 particularly when using variable `x-use-underline-position-properties'
27839 with fonts that specify an UNDERLINE_POSITION relatively close to the
27840 baseline. The default value is 1. */);
27841 underline_minimum_offset
= 1;
27843 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27844 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27845 This feature only works when on a window system that can change
27846 cursor shapes. */);
27847 display_hourglass_p
= 1;
27849 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27850 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27851 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27853 hourglass_atimer
= NULL
;
27854 hourglass_shown_p
= 0;
27856 DEFSYM (Qglyphless_char
, "glyphless-char");
27857 DEFSYM (Qhex_code
, "hex-code");
27858 DEFSYM (Qempty_box
, "empty-box");
27859 DEFSYM (Qthin_space
, "thin-space");
27860 DEFSYM (Qzero_width
, "zero-width");
27862 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27863 /* Intern this now in case it isn't already done.
27864 Setting this variable twice is harmless.
27865 But don't staticpro it here--that is done in alloc.c. */
27866 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27867 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27869 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27870 doc
: /* Char-table defining glyphless characters.
27871 Each element, if non-nil, should be one of the following:
27872 an ASCII acronym string: display this string in a box
27873 `hex-code': display the hexadecimal code of a character in a box
27874 `empty-box': display as an empty box
27875 `thin-space': display as 1-pixel width space
27876 `zero-width': don't display
27877 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27878 display method for graphical terminals and text terminals respectively.
27879 GRAPHICAL and TEXT should each have one of the values listed above.
27881 The char-table has one extra slot to control the display of a character for
27882 which no font is found. This slot only takes effect on graphical terminals.
27883 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27884 `thin-space'. The default is `empty-box'. */);
27885 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27886 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27891 /* Initialize this module when Emacs starts. */
27896 current_header_line_height
= current_mode_line_height
= -1;
27898 CHARPOS (this_line_start_pos
) = 0;
27900 if (!noninteractive
)
27902 struct window
*m
= XWINDOW (minibuf_window
);
27903 Lisp_Object frame
= m
->frame
;
27904 struct frame
*f
= XFRAME (frame
);
27905 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27906 struct window
*r
= XWINDOW (root
);
27909 echo_area_window
= minibuf_window
;
27911 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27912 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27913 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27914 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27915 XSETFASTINT (m
->total_lines
, 1);
27916 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27918 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27919 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27920 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27922 /* The default ellipsis glyphs `...'. */
27923 for (i
= 0; i
< 3; ++i
)
27924 default_invis_vector
[i
] = make_number ('.');
27928 /* Allocate the buffer for frame titles.
27929 Also used for `format-mode-line'. */
27931 mode_line_noprop_buf
= (char *) xmalloc (size
);
27932 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27933 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27934 mode_line_target
= MODE_LINE_DISPLAY
;
27937 help_echo_showing_p
= 0;
27940 /* Since w32 does not support atimers, it defines its own implementation of
27941 the following three functions in w32fns.c. */
27944 /* Platform-independent portion of hourglass implementation. */
27946 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27948 hourglass_started (void)
27950 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27953 /* Cancel a currently active hourglass timer, and start a new one. */
27955 start_hourglass (void)
27957 #if defined (HAVE_WINDOW_SYSTEM)
27959 int secs
, usecs
= 0;
27961 cancel_hourglass ();
27963 if (INTEGERP (Vhourglass_delay
)
27964 && XINT (Vhourglass_delay
) > 0)
27965 secs
= XFASTINT (Vhourglass_delay
);
27966 else if (FLOATP (Vhourglass_delay
)
27967 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27970 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27971 secs
= XFASTINT (tem
);
27972 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27975 secs
= DEFAULT_HOURGLASS_DELAY
;
27977 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27978 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27979 show_hourglass
, NULL
);
27984 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27987 cancel_hourglass (void)
27989 #if defined (HAVE_WINDOW_SYSTEM)
27990 if (hourglass_atimer
)
27992 cancel_atimer (hourglass_atimer
);
27993 hourglass_atimer
= NULL
;
27996 if (hourglass_shown_p
)
28000 #endif /* ! WINDOWSNT */