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) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache(); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
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
))));
1344 bidi_unshelve_cache (it2data
, 1);
1346 bidi_unshelve_cache (itdata
, 0);
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 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2483 /* Are lines in the display truncated? */
2484 if (base_face_id
!= DEFAULT_FACE_ID
2485 || XINT (it
->w
->hscroll
)
2486 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2487 && ((!NILP (Vtruncate_partial_width_windows
)
2488 && !INTEGERP (Vtruncate_partial_width_windows
))
2489 || (INTEGERP (Vtruncate_partial_width_windows
)
2490 && (WINDOW_TOTAL_COLS (it
->w
)
2491 < XINT (Vtruncate_partial_width_windows
))))))
2492 it
->line_wrap
= TRUNCATE
;
2493 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2494 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2495 ? WINDOW_WRAP
: WORD_WRAP
;
2497 it
->line_wrap
= TRUNCATE
;
2499 /* Get dimensions of truncation and continuation glyphs. These are
2500 displayed as fringe bitmaps under X, so we don't need them for such
2502 if (!FRAME_WINDOW_P (it
->f
))
2504 if (it
->line_wrap
== TRUNCATE
)
2506 /* We will need the truncation glyph. */
2507 xassert (it
->glyph_row
== NULL
);
2508 produce_special_glyphs (it
, IT_TRUNCATION
);
2509 it
->truncation_pixel_width
= it
->pixel_width
;
2513 /* We will need the continuation glyph. */
2514 xassert (it
->glyph_row
== NULL
);
2515 produce_special_glyphs (it
, IT_CONTINUATION
);
2516 it
->continuation_pixel_width
= it
->pixel_width
;
2519 /* Reset these values to zero because the produce_special_glyphs
2520 above has changed them. */
2521 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2522 it
->phys_ascent
= it
->phys_descent
= 0;
2525 /* Set this after getting the dimensions of truncation and
2526 continuation glyphs, so that we don't produce glyphs when calling
2527 produce_special_glyphs, above. */
2528 it
->glyph_row
= row
;
2529 it
->area
= TEXT_AREA
;
2531 /* Forget any previous info about this row being reversed. */
2533 it
->glyph_row
->reversed_p
= 0;
2535 /* Get the dimensions of the display area. The display area
2536 consists of the visible window area plus a horizontally scrolled
2537 part to the left of the window. All x-values are relative to the
2538 start of this total display area. */
2539 if (base_face_id
!= DEFAULT_FACE_ID
)
2541 /* Mode lines, menu bar in terminal frames. */
2542 it
->first_visible_x
= 0;
2543 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2548 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2549 it
->last_visible_x
= (it
->first_visible_x
2550 + window_box_width (w
, TEXT_AREA
));
2552 /* If we truncate lines, leave room for the truncator glyph(s) at
2553 the right margin. Otherwise, leave room for the continuation
2554 glyph(s). Truncation and continuation glyphs are not inserted
2555 for window-based redisplay. */
2556 if (!FRAME_WINDOW_P (it
->f
))
2558 if (it
->line_wrap
== TRUNCATE
)
2559 it
->last_visible_x
-= it
->truncation_pixel_width
;
2561 it
->last_visible_x
-= it
->continuation_pixel_width
;
2564 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2565 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2568 /* Leave room for a border glyph. */
2569 if (!FRAME_WINDOW_P (it
->f
)
2570 && !WINDOW_RIGHTMOST_P (it
->w
))
2571 it
->last_visible_x
-= 1;
2573 it
->last_visible_y
= window_text_bottom_y (w
);
2575 /* For mode lines and alike, arrange for the first glyph having a
2576 left box line if the face specifies a box. */
2577 if (base_face_id
!= DEFAULT_FACE_ID
)
2581 it
->face_id
= remapped_base_face_id
;
2583 /* If we have a boxed mode line, make the first character appear
2584 with a left box line. */
2585 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2586 if (face
->box
!= FACE_NO_BOX
)
2587 it
->start_of_box_run_p
= 1;
2590 /* If a buffer position was specified, set the iterator there,
2591 getting overlays and face properties from that position. */
2592 if (charpos
>= BUF_BEG (current_buffer
))
2594 it
->end_charpos
= ZV
;
2596 IT_CHARPOS (*it
) = charpos
;
2598 /* Compute byte position if not specified. */
2599 if (bytepos
< charpos
)
2600 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2602 IT_BYTEPOS (*it
) = bytepos
;
2604 it
->start
= it
->current
;
2605 /* Do we need to reorder bidirectional text? Not if this is a
2606 unibyte buffer: by definition, none of the single-byte
2607 characters are strong R2L, so no reordering is needed. And
2608 bidi.c doesn't support unibyte buffers anyway. */
2610 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2613 /* If we are to reorder bidirectional text, init the bidi
2617 /* Note the paragraph direction that this buffer wants to
2619 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2621 it
->paragraph_embedding
= L2R
;
2622 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= R2L
;
2626 it
->paragraph_embedding
= NEUTRAL_DIR
;
2627 bidi_unshelve_cache (NULL
, 0);
2628 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2632 /* Compute faces etc. */
2633 reseat (it
, it
->current
.pos
, 1);
2640 /* Initialize IT for the display of window W with window start POS. */
2643 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2645 struct glyph_row
*row
;
2646 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2648 row
= w
->desired_matrix
->rows
+ first_vpos
;
2649 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2650 it
->first_vpos
= first_vpos
;
2652 /* Don't reseat to previous visible line start if current start
2653 position is in a string or image. */
2654 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2656 int start_at_line_beg_p
;
2657 int first_y
= it
->current_y
;
2659 /* If window start is not at a line start, skip forward to POS to
2660 get the correct continuation lines width. */
2661 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2662 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2663 if (!start_at_line_beg_p
)
2667 reseat_at_previous_visible_line_start (it
);
2668 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2670 new_x
= it
->current_x
+ it
->pixel_width
;
2672 /* If lines are continued, this line may end in the middle
2673 of a multi-glyph character (e.g. a control character
2674 displayed as \003, or in the middle of an overlay
2675 string). In this case move_it_to above will not have
2676 taken us to the start of the continuation line but to the
2677 end of the continued line. */
2678 if (it
->current_x
> 0
2679 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2680 && (/* And glyph doesn't fit on the line. */
2681 new_x
> it
->last_visible_x
2682 /* Or it fits exactly and we're on a window
2684 || (new_x
== it
->last_visible_x
2685 && FRAME_WINDOW_P (it
->f
))))
2687 if (it
->current
.dpvec_index
>= 0
2688 || it
->current
.overlay_string_index
>= 0)
2690 set_iterator_to_next (it
, 1);
2691 move_it_in_display_line_to (it
, -1, -1, 0);
2694 it
->continuation_lines_width
+= it
->current_x
;
2697 /* We're starting a new display line, not affected by the
2698 height of the continued line, so clear the appropriate
2699 fields in the iterator structure. */
2700 it
->max_ascent
= it
->max_descent
= 0;
2701 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2703 it
->current_y
= first_y
;
2705 it
->current_x
= it
->hpos
= 0;
2711 /* Return 1 if POS is a position in ellipses displayed for invisible
2712 text. W is the window we display, for text property lookup. */
2715 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2717 Lisp_Object prop
, window
;
2719 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2721 /* If POS specifies a position in a display vector, this might
2722 be for an ellipsis displayed for invisible text. We won't
2723 get the iterator set up for delivering that ellipsis unless
2724 we make sure that it gets aware of the invisible text. */
2725 if (pos
->dpvec_index
>= 0
2726 && pos
->overlay_string_index
< 0
2727 && CHARPOS (pos
->string_pos
) < 0
2729 && (XSETWINDOW (window
, w
),
2730 prop
= Fget_char_property (make_number (charpos
),
2731 Qinvisible
, window
),
2732 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2734 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2736 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2743 /* Initialize IT for stepping through current_buffer in window W,
2744 starting at position POS that includes overlay string and display
2745 vector/ control character translation position information. Value
2746 is zero if there are overlay strings with newlines at POS. */
2749 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2751 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2752 int i
, overlay_strings_with_newlines
= 0;
2754 /* If POS specifies a position in a display vector, this might
2755 be for an ellipsis displayed for invisible text. We won't
2756 get the iterator set up for delivering that ellipsis unless
2757 we make sure that it gets aware of the invisible text. */
2758 if (in_ellipses_for_invisible_text_p (pos
, w
))
2764 /* Keep in mind: the call to reseat in init_iterator skips invisible
2765 text, so we might end up at a position different from POS. This
2766 is only a problem when POS is a row start after a newline and an
2767 overlay starts there with an after-string, and the overlay has an
2768 invisible property. Since we don't skip invisible text in
2769 display_line and elsewhere immediately after consuming the
2770 newline before the row start, such a POS will not be in a string,
2771 but the call to init_iterator below will move us to the
2773 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2775 /* This only scans the current chunk -- it should scan all chunks.
2776 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2777 to 16 in 22.1 to make this a lesser problem. */
2778 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2780 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2781 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2783 while (s
< e
&& *s
!= '\n')
2788 overlay_strings_with_newlines
= 1;
2793 /* If position is within an overlay string, set up IT to the right
2795 if (pos
->overlay_string_index
>= 0)
2799 /* If the first overlay string happens to have a `display'
2800 property for an image, the iterator will be set up for that
2801 image, and we have to undo that setup first before we can
2802 correct the overlay string index. */
2803 if (it
->method
== GET_FROM_IMAGE
)
2806 /* We already have the first chunk of overlay strings in
2807 IT->overlay_strings. Load more until the one for
2808 pos->overlay_string_index is in IT->overlay_strings. */
2809 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2811 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2812 it
->current
.overlay_string_index
= 0;
2815 load_overlay_strings (it
, 0);
2816 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2820 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2821 relative_index
= (it
->current
.overlay_string_index
2822 % OVERLAY_STRING_CHUNK_SIZE
);
2823 it
->string
= it
->overlay_strings
[relative_index
];
2824 xassert (STRINGP (it
->string
));
2825 it
->current
.string_pos
= pos
->string_pos
;
2826 it
->method
= GET_FROM_STRING
;
2829 if (CHARPOS (pos
->string_pos
) >= 0)
2831 /* Recorded position is not in an overlay string, but in another
2832 string. This can only be a string from a `display' property.
2833 IT should already be filled with that string. */
2834 it
->current
.string_pos
= pos
->string_pos
;
2835 xassert (STRINGP (it
->string
));
2838 /* Restore position in display vector translations, control
2839 character translations or ellipses. */
2840 if (pos
->dpvec_index
>= 0)
2842 if (it
->dpvec
== NULL
)
2843 get_next_display_element (it
);
2844 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2845 it
->current
.dpvec_index
= pos
->dpvec_index
;
2849 return !overlay_strings_with_newlines
;
2853 /* Initialize IT for stepping through current_buffer in window W
2854 starting at ROW->start. */
2857 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2859 init_from_display_pos (it
, w
, &row
->start
);
2860 it
->start
= row
->start
;
2861 it
->continuation_lines_width
= row
->continuation_lines_width
;
2866 /* Initialize IT for stepping through current_buffer in window W
2867 starting in the line following ROW, i.e. starting at ROW->end.
2868 Value is zero if there are overlay strings with newlines at ROW's
2872 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2876 if (init_from_display_pos (it
, w
, &row
->end
))
2878 if (row
->continued_p
)
2879 it
->continuation_lines_width
2880 = row
->continuation_lines_width
+ row
->pixel_width
;
2891 /***********************************************************************
2893 ***********************************************************************/
2895 /* Called when IT reaches IT->stop_charpos. Handle text property and
2896 overlay changes. Set IT->stop_charpos to the next position where
2900 handle_stop (struct it
*it
)
2902 enum prop_handled handled
;
2903 int handle_overlay_change_p
;
2907 it
->current
.dpvec_index
= -1;
2908 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2909 it
->ignore_overlay_strings_at_pos_p
= 0;
2912 /* Use face of preceding text for ellipsis (if invisible) */
2913 if (it
->selective_display_ellipsis_p
)
2914 it
->saved_face_id
= it
->face_id
;
2918 handled
= HANDLED_NORMALLY
;
2920 /* Call text property handlers. */
2921 for (p
= it_props
; p
->handler
; ++p
)
2923 handled
= p
->handler (it
);
2925 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2927 else if (handled
== HANDLED_RETURN
)
2929 /* We still want to show before and after strings from
2930 overlays even if the actual buffer text is replaced. */
2931 if (!handle_overlay_change_p
2933 || !get_overlay_strings_1 (it
, 0, 0))
2936 setup_for_ellipsis (it
, 0);
2937 /* When handling a display spec, we might load an
2938 empty string. In that case, discard it here. We
2939 used to discard it in handle_single_display_spec,
2940 but that causes get_overlay_strings_1, above, to
2941 ignore overlay strings that we must check. */
2942 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2946 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2950 it
->ignore_overlay_strings_at_pos_p
= 1;
2951 it
->string_from_display_prop_p
= 0;
2952 it
->from_disp_prop_p
= 0;
2953 handle_overlay_change_p
= 0;
2955 handled
= HANDLED_RECOMPUTE_PROPS
;
2958 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2959 handle_overlay_change_p
= 0;
2962 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2964 /* Don't check for overlay strings below when set to deliver
2965 characters from a display vector. */
2966 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2967 handle_overlay_change_p
= 0;
2969 /* Handle overlay changes.
2970 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2971 if it finds overlays. */
2972 if (handle_overlay_change_p
)
2973 handled
= handle_overlay_change (it
);
2978 setup_for_ellipsis (it
, 0);
2982 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2984 /* Determine where to stop next. */
2985 if (handled
== HANDLED_NORMALLY
)
2986 compute_stop_pos (it
);
2990 /* Compute IT->stop_charpos from text property and overlay change
2991 information for IT's current position. */
2994 compute_stop_pos (struct it
*it
)
2996 register INTERVAL iv
, next_iv
;
2997 Lisp_Object object
, limit
, position
;
2998 EMACS_INT charpos
, bytepos
;
3000 /* If nowhere else, stop at the end. */
3001 it
->stop_charpos
= it
->end_charpos
;
3003 if (STRINGP (it
->string
))
3005 /* Strings are usually short, so don't limit the search for
3007 object
= it
->string
;
3009 charpos
= IT_STRING_CHARPOS (*it
);
3010 bytepos
= IT_STRING_BYTEPOS (*it
);
3016 /* If next overlay change is in front of the current stop pos
3017 (which is IT->end_charpos), stop there. Note: value of
3018 next_overlay_change is point-max if no overlay change
3020 charpos
= IT_CHARPOS (*it
);
3021 bytepos
= IT_BYTEPOS (*it
);
3022 pos
= next_overlay_change (charpos
);
3023 if (pos
< it
->stop_charpos
)
3024 it
->stop_charpos
= pos
;
3026 /* If showing the region, we have to stop at the region
3027 start or end because the face might change there. */
3028 if (it
->region_beg_charpos
> 0)
3030 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3031 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3032 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3033 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3036 /* Set up variables for computing the stop position from text
3037 property changes. */
3038 XSETBUFFER (object
, current_buffer
);
3039 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3042 /* Get the interval containing IT's position. Value is a null
3043 interval if there isn't such an interval. */
3044 position
= make_number (charpos
);
3045 iv
= validate_interval_range (object
, &position
, &position
, 0);
3046 if (!NULL_INTERVAL_P (iv
))
3048 Lisp_Object values_here
[LAST_PROP_IDX
];
3051 /* Get properties here. */
3052 for (p
= it_props
; p
->handler
; ++p
)
3053 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3055 /* Look for an interval following iv that has different
3057 for (next_iv
= next_interval (iv
);
3058 (!NULL_INTERVAL_P (next_iv
)
3060 || XFASTINT (limit
) > next_iv
->position
));
3061 next_iv
= next_interval (next_iv
))
3063 for (p
= it_props
; p
->handler
; ++p
)
3065 Lisp_Object new_value
;
3067 new_value
= textget (next_iv
->plist
, *p
->name
);
3068 if (!EQ (values_here
[p
->idx
], new_value
))
3076 if (!NULL_INTERVAL_P (next_iv
))
3078 if (INTEGERP (limit
)
3079 && next_iv
->position
>= XFASTINT (limit
))
3080 /* No text property change up to limit. */
3081 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3083 /* Text properties change in next_iv. */
3084 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3088 if (it
->cmp_it
.id
< 0)
3090 EMACS_INT stoppos
= it
->end_charpos
;
3092 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3094 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3095 stoppos
, it
->string
);
3098 xassert (STRINGP (it
->string
)
3099 || (it
->stop_charpos
>= BEGV
3100 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3104 /* Return the position of the next overlay change after POS in
3105 current_buffer. Value is point-max if no overlay change
3106 follows. This is like `next-overlay-change' but doesn't use
3110 next_overlay_change (EMACS_INT pos
)
3112 ptrdiff_t i
, noverlays
;
3114 Lisp_Object
*overlays
;
3116 /* Get all overlays at the given position. */
3117 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3119 /* If any of these overlays ends before endpos,
3120 use its ending point instead. */
3121 for (i
= 0; i
< noverlays
; ++i
)
3126 oend
= OVERLAY_END (overlays
[i
]);
3127 oendpos
= OVERLAY_POSITION (oend
);
3128 endpos
= min (endpos
, oendpos
);
3134 /* How many characters forward to search for a display property or
3135 display string. Enough for a screenful of 100 lines x 50
3136 characters in a line. */
3137 #define MAX_DISP_SCAN 5000
3139 /* Return the character position of a display string at or after
3140 position specified by POSITION. If no display string exists at or
3141 after POSITION, return ZV. A display string is either an overlay
3142 with `display' property whose value is a string, or a `display'
3143 text property whose value is a string. STRING is data about the
3144 string to iterate; if STRING->lstring is nil, we are iterating a
3145 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3146 on a GUI frame. DISP_PROP is set to zero if we searched
3147 MAX_DISP_SCAN characters forward without finding any display
3148 strings, non-zero otherwise. It is set to 2 if the display string
3149 uses any kind of `(space ...)' spec that will produce a stretch of
3150 white space in the text area. */
3152 compute_display_string_pos (struct text_pos
*position
,
3153 struct bidi_string_data
*string
,
3154 int frame_window_p
, int *disp_prop
)
3156 /* OBJECT = nil means current buffer. */
3157 Lisp_Object object
=
3158 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3159 Lisp_Object pos
, spec
, limpos
;
3160 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3161 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3162 EMACS_INT begb
= string_p
? 0 : BEGV
;
3163 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3165 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3166 struct text_pos tpos
;
3172 /* We don't support display properties whose values are strings
3173 that have display string properties. */
3174 || string
->from_disp_str
3175 /* C strings cannot have display properties. */
3176 || (string
->s
&& !STRINGP (object
)))
3182 /* If the character at CHARPOS is where the display string begins,
3184 pos
= make_number (charpos
);
3185 if (STRINGP (object
))
3186 bufpos
= string
->bufpos
;
3190 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3192 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3195 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3203 /* Look forward for the first character with a `display' property
3204 that will replace the underlying text when displayed. */
3205 limpos
= make_number (lim
);
3207 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3208 CHARPOS (tpos
) = XFASTINT (pos
);
3209 if (CHARPOS (tpos
) >= lim
)
3214 if (STRINGP (object
))
3215 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3217 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3218 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3219 if (!STRINGP (object
))
3220 bufpos
= CHARPOS (tpos
);
3221 } while (NILP (spec
)
3222 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3223 bufpos
, frame_window_p
)));
3227 return CHARPOS (tpos
);
3230 /* Return the character position of the end of the display string that
3231 started at CHARPOS. A display string is either an overlay with
3232 `display' property whose value is a string or a `display' text
3233 property whose value is a string. */
3235 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3237 /* OBJECT = nil means current buffer. */
3238 Lisp_Object object
=
3239 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3240 Lisp_Object pos
= make_number (charpos
);
3242 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3244 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3247 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3250 /* Look forward for the first character where the `display' property
3252 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3254 return XFASTINT (pos
);
3259 /***********************************************************************
3261 ***********************************************************************/
3263 /* Handle changes in the `fontified' property of the current buffer by
3264 calling hook functions from Qfontification_functions to fontify
3267 static enum prop_handled
3268 handle_fontified_prop (struct it
*it
)
3270 Lisp_Object prop
, pos
;
3271 enum prop_handled handled
= HANDLED_NORMALLY
;
3273 if (!NILP (Vmemory_full
))
3276 /* Get the value of the `fontified' property at IT's current buffer
3277 position. (The `fontified' property doesn't have a special
3278 meaning in strings.) If the value is nil, call functions from
3279 Qfontification_functions. */
3280 if (!STRINGP (it
->string
)
3282 && !NILP (Vfontification_functions
)
3283 && !NILP (Vrun_hooks
)
3284 && (pos
= make_number (IT_CHARPOS (*it
)),
3285 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3286 /* Ignore the special cased nil value always present at EOB since
3287 no amount of fontifying will be able to change it. */
3288 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3290 int count
= SPECPDL_INDEX ();
3292 struct buffer
*obuf
= current_buffer
;
3293 int begv
= BEGV
, zv
= ZV
;
3294 int old_clip_changed
= current_buffer
->clip_changed
;
3296 val
= Vfontification_functions
;
3297 specbind (Qfontification_functions
, Qnil
);
3299 xassert (it
->end_charpos
== ZV
);
3301 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3302 safe_call1 (val
, pos
);
3305 Lisp_Object fns
, fn
;
3306 struct gcpro gcpro1
, gcpro2
;
3311 for (; CONSP (val
); val
= XCDR (val
))
3317 /* A value of t indicates this hook has a local
3318 binding; it means to run the global binding too.
3319 In a global value, t should not occur. If it
3320 does, we must ignore it to avoid an endless
3322 for (fns
= Fdefault_value (Qfontification_functions
);
3328 safe_call1 (fn
, pos
);
3332 safe_call1 (fn
, pos
);
3338 unbind_to (count
, Qnil
);
3340 /* Fontification functions routinely call `save-restriction'.
3341 Normally, this tags clip_changed, which can confuse redisplay
3342 (see discussion in Bug#6671). Since we don't perform any
3343 special handling of fontification changes in the case where
3344 `save-restriction' isn't called, there's no point doing so in
3345 this case either. So, if the buffer's restrictions are
3346 actually left unchanged, reset clip_changed. */
3347 if (obuf
== current_buffer
)
3349 if (begv
== BEGV
&& zv
== ZV
)
3350 current_buffer
->clip_changed
= old_clip_changed
;
3352 /* There isn't much we can reasonably do to protect against
3353 misbehaving fontification, but here's a fig leaf. */
3354 else if (!NILP (BVAR (obuf
, name
)))
3355 set_buffer_internal_1 (obuf
);
3357 /* The fontification code may have added/removed text.
3358 It could do even a lot worse, but let's at least protect against
3359 the most obvious case where only the text past `pos' gets changed',
3360 as is/was done in grep.el where some escapes sequences are turned
3361 into face properties (bug#7876). */
3362 it
->end_charpos
= ZV
;
3364 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3365 something. This avoids an endless loop if they failed to
3366 fontify the text for which reason ever. */
3367 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3368 handled
= HANDLED_RECOMPUTE_PROPS
;
3376 /***********************************************************************
3378 ***********************************************************************/
3380 /* Set up iterator IT from face properties at its current position.
3381 Called from handle_stop. */
3383 static enum prop_handled
3384 handle_face_prop (struct it
*it
)
3387 EMACS_INT next_stop
;
3389 if (!STRINGP (it
->string
))
3392 = face_at_buffer_position (it
->w
,
3394 it
->region_beg_charpos
,
3395 it
->region_end_charpos
,
3398 + TEXT_PROP_DISTANCE_LIMIT
),
3399 0, it
->base_face_id
);
3401 /* Is this a start of a run of characters with box face?
3402 Caveat: this can be called for a freshly initialized
3403 iterator; face_id is -1 in this case. We know that the new
3404 face will not change until limit, i.e. if the new face has a
3405 box, all characters up to limit will have one. But, as
3406 usual, we don't know whether limit is really the end. */
3407 if (new_face_id
!= it
->face_id
)
3409 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3411 /* If new face has a box but old face has not, this is
3412 the start of a run of characters with box, i.e. it has
3413 a shadow on the left side. The value of face_id of the
3414 iterator will be -1 if this is the initial call that gets
3415 the face. In this case, we have to look in front of IT's
3416 position and see whether there is a face != new_face_id. */
3417 it
->start_of_box_run_p
3418 = (new_face
->box
!= FACE_NO_BOX
3419 && (it
->face_id
>= 0
3420 || IT_CHARPOS (*it
) == BEG
3421 || new_face_id
!= face_before_it_pos (it
)));
3422 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3430 Lisp_Object from_overlay
3431 = (it
->current
.overlay_string_index
>= 0
3432 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3435 /* See if we got to this string directly or indirectly from
3436 an overlay property. That includes the before-string or
3437 after-string of an overlay, strings in display properties
3438 provided by an overlay, their text properties, etc.
3440 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3441 if (! NILP (from_overlay
))
3442 for (i
= it
->sp
- 1; i
>= 0; i
--)
3444 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3446 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3447 else if (! NILP (it
->stack
[i
].from_overlay
))
3448 from_overlay
= it
->stack
[i
].from_overlay
;
3450 if (!NILP (from_overlay
))
3454 if (! NILP (from_overlay
))
3456 bufpos
= IT_CHARPOS (*it
);
3457 /* For a string from an overlay, the base face depends
3458 only on text properties and ignores overlays. */
3460 = face_for_overlay_string (it
->w
,
3462 it
->region_beg_charpos
,
3463 it
->region_end_charpos
,
3466 + TEXT_PROP_DISTANCE_LIMIT
),
3474 /* For strings from a `display' property, use the face at
3475 IT's current buffer position as the base face to merge
3476 with, so that overlay strings appear in the same face as
3477 surrounding text, unless they specify their own
3479 base_face_id
= underlying_face_id (it
);
3482 new_face_id
= face_at_string_position (it
->w
,
3484 IT_STRING_CHARPOS (*it
),
3486 it
->region_beg_charpos
,
3487 it
->region_end_charpos
,
3491 /* Is this a start of a run of characters with box? Caveat:
3492 this can be called for a freshly allocated iterator; face_id
3493 is -1 is this case. We know that the new face will not
3494 change until the next check pos, i.e. if the new face has a
3495 box, all characters up to that position will have a
3496 box. But, as usual, we don't know whether that position
3497 is really the end. */
3498 if (new_face_id
!= it
->face_id
)
3500 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3501 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3503 /* If new face has a box but old face hasn't, this is the
3504 start of a run of characters with box, i.e. it has a
3505 shadow on the left side. */
3506 it
->start_of_box_run_p
3507 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3508 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3512 it
->face_id
= new_face_id
;
3513 return HANDLED_NORMALLY
;
3517 /* Return the ID of the face ``underlying'' IT's current position,
3518 which is in a string. If the iterator is associated with a
3519 buffer, return the face at IT's current buffer position.
3520 Otherwise, use the iterator's base_face_id. */
3523 underlying_face_id (struct it
*it
)
3525 int face_id
= it
->base_face_id
, i
;
3527 xassert (STRINGP (it
->string
));
3529 for (i
= it
->sp
- 1; i
>= 0; --i
)
3530 if (NILP (it
->stack
[i
].string
))
3531 face_id
= it
->stack
[i
].face_id
;
3537 /* Compute the face one character before or after the current position
3538 of IT, in the visual order. BEFORE_P non-zero means get the face
3539 in front (to the left in L2R paragraphs, to the right in R2L
3540 paragraphs) of IT's screen position. Value is the ID of the face. */
3543 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3546 EMACS_INT next_check_charpos
;
3548 void *it_copy_data
= NULL
;
3550 xassert (it
->s
== NULL
);
3552 if (STRINGP (it
->string
))
3554 EMACS_INT bufpos
, charpos
;
3557 /* No face change past the end of the string (for the case
3558 we are padding with spaces). No face change before the
3560 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3561 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3566 /* Set charpos to the position before or after IT's current
3567 position, in the logical order, which in the non-bidi
3568 case is the same as the visual order. */
3570 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3571 else if (it
->what
== IT_COMPOSITION
)
3572 /* For composition, we must check the character after the
3574 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3576 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3582 /* With bidi iteration, the character before the current
3583 in the visual order cannot be found by simple
3584 iteration, because "reverse" reordering is not
3585 supported. Instead, we need to use the move_it_*
3586 family of functions. */
3587 /* Ignore face changes before the first visible
3588 character on this display line. */
3589 if (it
->current_x
<= it
->first_visible_x
)
3591 SAVE_IT (it_copy
, *it
, it_copy_data
);
3592 /* Implementation note: Since move_it_in_display_line
3593 works in the iterator geometry, and thinks the first
3594 character is always the leftmost, even in R2L lines,
3595 we don't need to distinguish between the R2L and L2R
3597 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3598 it_copy
.current_x
- 1, MOVE_TO_X
);
3599 charpos
= IT_STRING_CHARPOS (it_copy
);
3600 RESTORE_IT (it
, it
, it_copy_data
);
3604 /* Set charpos to the string position of the character
3605 that comes after IT's current position in the visual
3607 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3611 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3613 charpos
= it_copy
.bidi_it
.charpos
;
3616 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3618 if (it
->current
.overlay_string_index
>= 0)
3619 bufpos
= IT_CHARPOS (*it
);
3623 base_face_id
= underlying_face_id (it
);
3625 /* Get the face for ASCII, or unibyte. */
3626 face_id
= face_at_string_position (it
->w
,
3630 it
->region_beg_charpos
,
3631 it
->region_end_charpos
,
3632 &next_check_charpos
,
3635 /* Correct the face for charsets different from ASCII. Do it
3636 for the multibyte case only. The face returned above is
3637 suitable for unibyte text if IT->string is unibyte. */
3638 if (STRING_MULTIBYTE (it
->string
))
3640 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3641 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3643 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3645 c
= string_char_and_length (p
, &len
);
3646 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3651 struct text_pos pos
;
3653 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3654 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3657 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3658 pos
= it
->current
.pos
;
3663 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3666 if (it
->what
== IT_COMPOSITION
)
3668 /* For composition, we must check the position after
3670 pos
.charpos
+= it
->cmp_it
.nchars
;
3671 pos
.bytepos
+= it
->len
;
3674 INC_TEXT_POS (pos
, it
->multibyte_p
);
3681 /* With bidi iteration, the character before the current
3682 in the visual order cannot be found by simple
3683 iteration, because "reverse" reordering is not
3684 supported. Instead, we need to use the move_it_*
3685 family of functions. */
3686 /* Ignore face changes before the first visible
3687 character on this display line. */
3688 if (it
->current_x
<= it
->first_visible_x
)
3690 SAVE_IT (it_copy
, *it
, it_copy_data
);
3691 /* Implementation note: Since move_it_in_display_line
3692 works in the iterator geometry, and thinks the first
3693 character is always the leftmost, even in R2L lines,
3694 we don't need to distinguish between the R2L and L2R
3696 move_it_in_display_line (&it_copy
, ZV
,
3697 it_copy
.current_x
- 1, MOVE_TO_X
);
3698 pos
= it_copy
.current
.pos
;
3699 RESTORE_IT (it
, it
, it_copy_data
);
3703 /* Set charpos to the buffer position of the character
3704 that comes after IT's current position in the visual
3706 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3710 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3713 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3716 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3718 /* Determine face for CHARSET_ASCII, or unibyte. */
3719 face_id
= face_at_buffer_position (it
->w
,
3721 it
->region_beg_charpos
,
3722 it
->region_end_charpos
,
3723 &next_check_charpos
,
3726 /* Correct the face for charsets different from ASCII. Do it
3727 for the multibyte case only. The face returned above is
3728 suitable for unibyte text if current_buffer is unibyte. */
3729 if (it
->multibyte_p
)
3731 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3732 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3733 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3742 /***********************************************************************
3744 ***********************************************************************/
3746 /* Set up iterator IT from invisible properties at its current
3747 position. Called from handle_stop. */
3749 static enum prop_handled
3750 handle_invisible_prop (struct it
*it
)
3752 enum prop_handled handled
= HANDLED_NORMALLY
;
3754 if (STRINGP (it
->string
))
3756 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3758 /* Get the value of the invisible text property at the
3759 current position. Value will be nil if there is no such
3761 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3762 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3765 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3769 handled
= HANDLED_RECOMPUTE_PROPS
;
3771 /* Get the position at which the next change of the
3772 invisible text property can be found in IT->string.
3773 Value will be nil if the property value is the same for
3774 all the rest of IT->string. */
3775 XSETINT (limit
, SCHARS (it
->string
));
3776 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3779 /* Text at current position is invisible. The next
3780 change in the property is at position end_charpos.
3781 Move IT's current position to that position. */
3782 if (INTEGERP (end_charpos
)
3783 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3785 struct text_pos old
;
3788 old
= it
->current
.string_pos
;
3789 oldpos
= CHARPOS (old
);
3792 if (it
->bidi_it
.first_elt
3793 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3794 bidi_paragraph_init (it
->paragraph_embedding
,
3796 /* Bidi-iterate out of the invisible text. */
3799 bidi_move_to_visually_next (&it
->bidi_it
);
3801 while (oldpos
<= it
->bidi_it
.charpos
3802 && it
->bidi_it
.charpos
< endpos
);
3804 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3805 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3806 if (IT_CHARPOS (*it
) >= endpos
)
3807 it
->prev_stop
= endpos
;
3811 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3812 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3817 /* The rest of the string is invisible. If this is an
3818 overlay string, proceed with the next overlay string
3819 or whatever comes and return a character from there. */
3820 if (it
->current
.overlay_string_index
>= 0)
3822 next_overlay_string (it
);
3823 /* Don't check for overlay strings when we just
3824 finished processing them. */
3825 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3829 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3830 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3838 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3839 Lisp_Object pos
, prop
, overlay
;
3841 /* First of all, is there invisible text at this position? */
3842 tem
= start_charpos
= IT_CHARPOS (*it
);
3843 pos
= make_number (tem
);
3844 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3846 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3848 /* If we are on invisible text, skip over it. */
3849 if (invis_p
&& start_charpos
< it
->end_charpos
)
3851 /* Record whether we have to display an ellipsis for the
3853 int display_ellipsis_p
= invis_p
== 2;
3855 handled
= HANDLED_RECOMPUTE_PROPS
;
3857 /* Loop skipping over invisible text. The loop is left at
3858 ZV or with IT on the first char being visible again. */
3861 /* Try to skip some invisible text. Return value is the
3862 position reached which can be equal to where we start
3863 if there is nothing invisible there. This skips both
3864 over invisible text properties and overlays with
3865 invisible property. */
3866 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3868 /* If we skipped nothing at all we weren't at invisible
3869 text in the first place. If everything to the end of
3870 the buffer was skipped, end the loop. */
3871 if (newpos
== tem
|| newpos
>= ZV
)
3875 /* We skipped some characters but not necessarily
3876 all there are. Check if we ended up on visible
3877 text. Fget_char_property returns the property of
3878 the char before the given position, i.e. if we
3879 get invis_p = 0, this means that the char at
3880 newpos is visible. */
3881 pos
= make_number (newpos
);
3882 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3883 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3886 /* If we ended up on invisible text, proceed to
3887 skip starting with next_stop. */
3891 /* If there are adjacent invisible texts, don't lose the
3892 second one's ellipsis. */
3894 display_ellipsis_p
= 1;
3898 /* The position newpos is now either ZV or on visible text. */
3899 if (it
->bidi_p
&& newpos
< ZV
)
3901 /* With bidi iteration, the region of invisible text
3902 could start and/or end in the middle of a non-base
3903 embedding level. Therefore, we need to skip
3904 invisible text using the bidi iterator, starting at
3905 IT's current position, until we find ourselves
3906 outside the invisible text. Skipping invisible text
3907 _after_ bidi iteration avoids affecting the visual
3908 order of the displayed text when invisible properties
3909 are added or removed. */
3910 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3912 /* If we were `reseat'ed to a new paragraph,
3913 determine the paragraph base direction. We need
3914 to do it now because next_element_from_buffer may
3915 not have a chance to do it, if we are going to
3916 skip any text at the beginning, which resets the
3918 bidi_paragraph_init (it
->paragraph_embedding
,
3923 bidi_move_to_visually_next (&it
->bidi_it
);
3925 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3926 && it
->bidi_it
.charpos
< newpos
);
3927 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3928 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3929 /* If we overstepped NEWPOS, record its position in the
3930 iterator, so that we skip invisible text if later the
3931 bidi iteration lands us in the invisible region
3933 if (IT_CHARPOS (*it
) >= newpos
)
3934 it
->prev_stop
= newpos
;
3938 IT_CHARPOS (*it
) = newpos
;
3939 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3942 /* If there are before-strings at the start of invisible
3943 text, and the text is invisible because of a text
3944 property, arrange to show before-strings because 20.x did
3945 it that way. (If the text is invisible because of an
3946 overlay property instead of a text property, this is
3947 already handled in the overlay code.) */
3949 && get_overlay_strings (it
, it
->stop_charpos
))
3951 handled
= HANDLED_RECOMPUTE_PROPS
;
3952 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3954 else if (display_ellipsis_p
)
3956 /* Make sure that the glyphs of the ellipsis will get
3957 correct `charpos' values. If we would not update
3958 it->position here, the glyphs would belong to the
3959 last visible character _before_ the invisible
3960 text, which confuses `set_cursor_from_row'.
3962 We use the last invisible position instead of the
3963 first because this way the cursor is always drawn on
3964 the first "." of the ellipsis, whenever PT is inside
3965 the invisible text. Otherwise the cursor would be
3966 placed _after_ the ellipsis when the point is after the
3967 first invisible character. */
3968 if (!STRINGP (it
->object
))
3970 it
->position
.charpos
= newpos
- 1;
3971 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3974 /* Let the ellipsis display before
3975 considering any properties of the following char.
3976 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3977 handled
= HANDLED_RETURN
;
3986 /* Make iterator IT return `...' next.
3987 Replaces LEN characters from buffer. */
3990 setup_for_ellipsis (struct it
*it
, int len
)
3992 /* Use the display table definition for `...'. Invalid glyphs
3993 will be handled by the method returning elements from dpvec. */
3994 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3996 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3997 it
->dpvec
= v
->contents
;
3998 it
->dpend
= v
->contents
+ v
->header
.size
;
4002 /* Default `...'. */
4003 it
->dpvec
= default_invis_vector
;
4004 it
->dpend
= default_invis_vector
+ 3;
4007 it
->dpvec_char_len
= len
;
4008 it
->current
.dpvec_index
= 0;
4009 it
->dpvec_face_id
= -1;
4011 /* Remember the current face id in case glyphs specify faces.
4012 IT's face is restored in set_iterator_to_next.
4013 saved_face_id was set to preceding char's face in handle_stop. */
4014 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4015 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4017 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4023 /***********************************************************************
4025 ***********************************************************************/
4027 /* Set up iterator IT from `display' property at its current position.
4028 Called from handle_stop.
4029 We return HANDLED_RETURN if some part of the display property
4030 overrides the display of the buffer text itself.
4031 Otherwise we return HANDLED_NORMALLY. */
4033 static enum prop_handled
4034 handle_display_prop (struct it
*it
)
4036 Lisp_Object propval
, object
, overlay
;
4037 struct text_pos
*position
;
4039 /* Nonzero if some property replaces the display of the text itself. */
4040 int display_replaced_p
= 0;
4042 if (STRINGP (it
->string
))
4044 object
= it
->string
;
4045 position
= &it
->current
.string_pos
;
4046 bufpos
= CHARPOS (it
->current
.pos
);
4050 XSETWINDOW (object
, it
->w
);
4051 position
= &it
->current
.pos
;
4052 bufpos
= CHARPOS (*position
);
4055 /* Reset those iterator values set from display property values. */
4056 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4057 it
->space_width
= Qnil
;
4058 it
->font_height
= Qnil
;
4061 /* We don't support recursive `display' properties, i.e. string
4062 values that have a string `display' property, that have a string
4063 `display' property etc. */
4064 if (!it
->string_from_display_prop_p
)
4065 it
->area
= TEXT_AREA
;
4067 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4068 Qdisplay
, object
, &overlay
);
4070 return HANDLED_NORMALLY
;
4071 /* Now OVERLAY is the overlay that gave us this property, or nil
4072 if it was a text property. */
4074 if (!STRINGP (it
->string
))
4075 object
= it
->w
->buffer
;
4077 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4079 FRAME_WINDOW_P (it
->f
));
4081 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4084 /* Subroutine of handle_display_prop. Returns non-zero if the display
4085 specification in SPEC is a replacing specification, i.e. it would
4086 replace the text covered by `display' property with something else,
4087 such as an image or a display string. If SPEC includes any kind or
4088 `(space ...) specification, the value is 2; this is used by
4089 compute_display_string_pos, which see.
4091 See handle_single_display_spec for documentation of arguments.
4092 frame_window_p is non-zero if the window being redisplayed is on a
4093 GUI frame; this argument is used only if IT is NULL, see below.
4095 IT can be NULL, if this is called by the bidi reordering code
4096 through compute_display_string_pos, which see. In that case, this
4097 function only examines SPEC, but does not otherwise "handle" it, in
4098 the sense that it doesn't set up members of IT from the display
4101 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4102 Lisp_Object overlay
, struct text_pos
*position
,
4103 EMACS_INT bufpos
, int frame_window_p
)
4105 int replacing_p
= 0;
4109 /* Simple specerties. */
4110 && !EQ (XCAR (spec
), Qimage
)
4111 && !EQ (XCAR (spec
), Qspace
)
4112 && !EQ (XCAR (spec
), Qwhen
)
4113 && !EQ (XCAR (spec
), Qslice
)
4114 && !EQ (XCAR (spec
), Qspace_width
)
4115 && !EQ (XCAR (spec
), Qheight
)
4116 && !EQ (XCAR (spec
), Qraise
)
4117 /* Marginal area specifications. */
4118 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4119 && !EQ (XCAR (spec
), Qleft_fringe
)
4120 && !EQ (XCAR (spec
), Qright_fringe
)
4121 && !NILP (XCAR (spec
)))
4123 for (; CONSP (spec
); spec
= XCDR (spec
))
4125 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4126 overlay
, position
, bufpos
,
4127 replacing_p
, frame_window_p
)))
4130 /* If some text in a string is replaced, `position' no
4131 longer points to the position of `object'. */
4132 if (!it
|| STRINGP (object
))
4137 else if (VECTORP (spec
))
4140 for (i
= 0; i
< ASIZE (spec
); ++i
)
4141 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4142 overlay
, position
, bufpos
,
4143 replacing_p
, frame_window_p
)))
4146 /* If some text in a string is replaced, `position' no
4147 longer points to the position of `object'. */
4148 if (!it
|| STRINGP (object
))
4154 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4155 position
, bufpos
, 0,
4163 /* Value is the position of the end of the `display' property starting
4164 at START_POS in OBJECT. */
4166 static struct text_pos
4167 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4170 struct text_pos end_pos
;
4172 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4173 Qdisplay
, object
, Qnil
);
4174 CHARPOS (end_pos
) = XFASTINT (end
);
4175 if (STRINGP (object
))
4176 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4178 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4184 /* Set up IT from a single `display' property specification SPEC. OBJECT
4185 is the object in which the `display' property was found. *POSITION
4186 is the position in OBJECT at which the `display' property was found.
4187 BUFPOS is the buffer position of OBJECT (different from POSITION if
4188 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4189 previously saw a display specification which already replaced text
4190 display with something else, for example an image; we ignore such
4191 properties after the first one has been processed.
4193 OVERLAY is the overlay this `display' property came from,
4194 or nil if it was a text property.
4196 If SPEC is a `space' or `image' specification, and in some other
4197 cases too, set *POSITION to the position where the `display'
4200 If IT is NULL, only examine the property specification in SPEC, but
4201 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4202 is intended to be displayed in a window on a GUI frame.
4204 Value is non-zero if something was found which replaces the display
4205 of buffer or string text. */
4208 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4209 Lisp_Object overlay
, struct text_pos
*position
,
4210 EMACS_INT bufpos
, int display_replaced_p
,
4214 Lisp_Object location
, value
;
4215 struct text_pos start_pos
= *position
;
4218 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4219 If the result is non-nil, use VALUE instead of SPEC. */
4221 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4230 if (!NILP (form
) && !EQ (form
, Qt
))
4232 int count
= SPECPDL_INDEX ();
4233 struct gcpro gcpro1
;
4235 /* Bind `object' to the object having the `display' property, a
4236 buffer or string. Bind `position' to the position in the
4237 object where the property was found, and `buffer-position'
4238 to the current position in the buffer. */
4241 XSETBUFFER (object
, current_buffer
);
4242 specbind (Qobject
, object
);
4243 specbind (Qposition
, make_number (CHARPOS (*position
)));
4244 specbind (Qbuffer_position
, make_number (bufpos
));
4246 form
= safe_eval (form
);
4248 unbind_to (count
, Qnil
);
4254 /* Handle `(height HEIGHT)' specifications. */
4256 && EQ (XCAR (spec
), Qheight
)
4257 && CONSP (XCDR (spec
)))
4261 if (!FRAME_WINDOW_P (it
->f
))
4264 it
->font_height
= XCAR (XCDR (spec
));
4265 if (!NILP (it
->font_height
))
4267 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4268 int new_height
= -1;
4270 if (CONSP (it
->font_height
)
4271 && (EQ (XCAR (it
->font_height
), Qplus
)
4272 || EQ (XCAR (it
->font_height
), Qminus
))
4273 && CONSP (XCDR (it
->font_height
))
4274 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4276 /* `(+ N)' or `(- N)' where N is an integer. */
4277 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4278 if (EQ (XCAR (it
->font_height
), Qplus
))
4280 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4282 else if (FUNCTIONP (it
->font_height
))
4284 /* Call function with current height as argument.
4285 Value is the new height. */
4287 height
= safe_call1 (it
->font_height
,
4288 face
->lface
[LFACE_HEIGHT_INDEX
]);
4289 if (NUMBERP (height
))
4290 new_height
= XFLOATINT (height
);
4292 else if (NUMBERP (it
->font_height
))
4294 /* Value is a multiple of the canonical char height. */
4297 f
= FACE_FROM_ID (it
->f
,
4298 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4299 new_height
= (XFLOATINT (it
->font_height
)
4300 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4304 /* Evaluate IT->font_height with `height' bound to the
4305 current specified height to get the new height. */
4306 int count
= SPECPDL_INDEX ();
4308 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4309 value
= safe_eval (it
->font_height
);
4310 unbind_to (count
, Qnil
);
4312 if (NUMBERP (value
))
4313 new_height
= XFLOATINT (value
);
4317 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4324 /* Handle `(space-width WIDTH)'. */
4326 && EQ (XCAR (spec
), Qspace_width
)
4327 && CONSP (XCDR (spec
)))
4331 if (!FRAME_WINDOW_P (it
->f
))
4334 value
= XCAR (XCDR (spec
));
4335 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4336 it
->space_width
= value
;
4342 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4344 && EQ (XCAR (spec
), Qslice
))
4350 if (!FRAME_WINDOW_P (it
->f
))
4353 if (tem
= XCDR (spec
), CONSP (tem
))
4355 it
->slice
.x
= XCAR (tem
);
4356 if (tem
= XCDR (tem
), CONSP (tem
))
4358 it
->slice
.y
= XCAR (tem
);
4359 if (tem
= XCDR (tem
), CONSP (tem
))
4361 it
->slice
.width
= XCAR (tem
);
4362 if (tem
= XCDR (tem
), CONSP (tem
))
4363 it
->slice
.height
= XCAR (tem
);
4372 /* Handle `(raise FACTOR)'. */
4374 && EQ (XCAR (spec
), Qraise
)
4375 && CONSP (XCDR (spec
)))
4379 if (!FRAME_WINDOW_P (it
->f
))
4382 #ifdef HAVE_WINDOW_SYSTEM
4383 value
= XCAR (XCDR (spec
));
4384 if (NUMBERP (value
))
4386 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4387 it
->voffset
= - (XFLOATINT (value
)
4388 * (FONT_HEIGHT (face
->font
)));
4390 #endif /* HAVE_WINDOW_SYSTEM */
4396 /* Don't handle the other kinds of display specifications
4397 inside a string that we got from a `display' property. */
4398 if (it
&& it
->string_from_display_prop_p
)
4401 /* Characters having this form of property are not displayed, so
4402 we have to find the end of the property. */
4405 start_pos
= *position
;
4406 *position
= display_prop_end (it
, object
, start_pos
);
4410 /* Stop the scan at that end position--we assume that all
4411 text properties change there. */
4413 it
->stop_charpos
= position
->charpos
;
4415 /* Handle `(left-fringe BITMAP [FACE])'
4416 and `(right-fringe BITMAP [FACE])'. */
4418 && (EQ (XCAR (spec
), Qleft_fringe
)
4419 || EQ (XCAR (spec
), Qright_fringe
))
4420 && CONSP (XCDR (spec
)))
4426 if (!FRAME_WINDOW_P (it
->f
))
4427 /* If we return here, POSITION has been advanced
4428 across the text with this property. */
4431 else if (!frame_window_p
)
4434 #ifdef HAVE_WINDOW_SYSTEM
4435 value
= XCAR (XCDR (spec
));
4436 if (!SYMBOLP (value
)
4437 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4438 /* If we return here, POSITION has been advanced
4439 across the text with this property. */
4444 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4446 if (CONSP (XCDR (XCDR (spec
))))
4448 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4449 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4455 /* Save current settings of IT so that we can restore them
4456 when we are finished with the glyph property value. */
4457 push_it (it
, position
);
4459 it
->area
= TEXT_AREA
;
4460 it
->what
= IT_IMAGE
;
4461 it
->image_id
= -1; /* no image */
4462 it
->position
= start_pos
;
4463 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4464 it
->method
= GET_FROM_IMAGE
;
4465 it
->from_overlay
= Qnil
;
4466 it
->face_id
= face_id
;
4467 it
->from_disp_prop_p
= 1;
4469 /* Say that we haven't consumed the characters with
4470 `display' property yet. The call to pop_it in
4471 set_iterator_to_next will clean this up. */
4472 *position
= start_pos
;
4474 if (EQ (XCAR (spec
), Qleft_fringe
))
4476 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4477 it
->left_user_fringe_face_id
= face_id
;
4481 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4482 it
->right_user_fringe_face_id
= face_id
;
4485 #endif /* HAVE_WINDOW_SYSTEM */
4489 /* Prepare to handle `((margin left-margin) ...)',
4490 `((margin right-margin) ...)' and `((margin nil) ...)'
4491 prefixes for display specifications. */
4492 location
= Qunbound
;
4493 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4497 value
= XCDR (spec
);
4499 value
= XCAR (value
);
4502 if (EQ (XCAR (tem
), Qmargin
)
4503 && (tem
= XCDR (tem
),
4504 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4506 || EQ (tem
, Qleft_margin
)
4507 || EQ (tem
, Qright_margin
))))
4511 if (EQ (location
, Qunbound
))
4517 /* After this point, VALUE is the property after any
4518 margin prefix has been stripped. It must be a string,
4519 an image specification, or `(space ...)'.
4521 LOCATION specifies where to display: `left-margin',
4522 `right-margin' or nil. */
4524 valid_p
= (STRINGP (value
)
4525 #ifdef HAVE_WINDOW_SYSTEM
4526 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4527 && valid_image_p (value
))
4528 #endif /* not HAVE_WINDOW_SYSTEM */
4529 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4531 if (valid_p
&& !display_replaced_p
)
4537 /* Callers need to know whether the display spec is any kind
4538 of `(space ...)' spec that is about to affect text-area
4540 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4545 /* Save current settings of IT so that we can restore them
4546 when we are finished with the glyph property value. */
4547 push_it (it
, position
);
4548 it
->from_overlay
= overlay
;
4549 it
->from_disp_prop_p
= 1;
4551 if (NILP (location
))
4552 it
->area
= TEXT_AREA
;
4553 else if (EQ (location
, Qleft_margin
))
4554 it
->area
= LEFT_MARGIN_AREA
;
4556 it
->area
= RIGHT_MARGIN_AREA
;
4558 if (STRINGP (value
))
4561 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4562 it
->current
.overlay_string_index
= -1;
4563 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4564 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4565 it
->method
= GET_FROM_STRING
;
4566 it
->stop_charpos
= 0;
4568 it
->base_level_stop
= 0;
4569 it
->string_from_display_prop_p
= 1;
4570 /* Say that we haven't consumed the characters with
4571 `display' property yet. The call to pop_it in
4572 set_iterator_to_next will clean this up. */
4573 if (BUFFERP (object
))
4574 *position
= start_pos
;
4576 /* Force paragraph direction to be that of the parent
4577 object. If the parent object's paragraph direction is
4578 not yet determined, default to L2R. */
4579 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4580 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4582 it
->paragraph_embedding
= L2R
;
4584 /* Set up the bidi iterator for this display string. */
4587 it
->bidi_it
.string
.lstring
= it
->string
;
4588 it
->bidi_it
.string
.s
= NULL
;
4589 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4590 it
->bidi_it
.string
.bufpos
= bufpos
;
4591 it
->bidi_it
.string
.from_disp_str
= 1;
4592 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4593 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4596 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4598 it
->method
= GET_FROM_STRETCH
;
4600 *position
= it
->position
= start_pos
;
4601 retval
= 1 + (it
->area
== TEXT_AREA
);
4603 #ifdef HAVE_WINDOW_SYSTEM
4606 it
->what
= IT_IMAGE
;
4607 it
->image_id
= lookup_image (it
->f
, value
);
4608 it
->position
= start_pos
;
4609 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4610 it
->method
= GET_FROM_IMAGE
;
4612 /* Say that we haven't consumed the characters with
4613 `display' property yet. The call to pop_it in
4614 set_iterator_to_next will clean this up. */
4615 *position
= start_pos
;
4617 #endif /* HAVE_WINDOW_SYSTEM */
4622 /* Invalid property or property not supported. Restore
4623 POSITION to what it was before. */
4624 *position
= start_pos
;
4628 /* Check if PROP is a display property value whose text should be
4629 treated as intangible. OVERLAY is the overlay from which PROP
4630 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4631 specify the buffer position covered by PROP. */
4634 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4635 EMACS_INT charpos
, EMACS_INT bytepos
)
4637 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4638 struct text_pos position
;
4640 SET_TEXT_POS (position
, charpos
, bytepos
);
4641 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4642 &position
, charpos
, frame_window_p
);
4646 /* Return 1 if PROP is a display sub-property value containing STRING.
4648 Implementation note: this and the following function are really
4649 special cases of handle_display_spec and
4650 handle_single_display_spec, and should ideally use the same code.
4651 Until they do, these two pairs must be consistent and must be
4652 modified in sync. */
4655 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4657 if (EQ (string
, prop
))
4660 /* Skip over `when FORM'. */
4661 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4666 /* Actually, the condition following `when' should be eval'ed,
4667 like handle_single_display_spec does, and we should return
4668 zero if it evaluates to nil. However, this function is
4669 called only when the buffer was already displayed and some
4670 glyph in the glyph matrix was found to come from a display
4671 string. Therefore, the condition was already evaluated, and
4672 the result was non-nil, otherwise the display string wouldn't
4673 have been displayed and we would have never been called for
4674 this property. Thus, we can skip the evaluation and assume
4675 its result is non-nil. */
4680 /* Skip over `margin LOCATION'. */
4681 if (EQ (XCAR (prop
), Qmargin
))
4692 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4696 /* Return 1 if STRING appears in the `display' property PROP. */
4699 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4702 && !EQ (XCAR (prop
), Qwhen
)
4703 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4705 /* A list of sub-properties. */
4706 while (CONSP (prop
))
4708 if (single_display_spec_string_p (XCAR (prop
), string
))
4713 else if (VECTORP (prop
))
4715 /* A vector of sub-properties. */
4717 for (i
= 0; i
< ASIZE (prop
); ++i
)
4718 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4722 return single_display_spec_string_p (prop
, string
);
4727 /* Look for STRING in overlays and text properties in the current
4728 buffer, between character positions FROM and TO (excluding TO).
4729 BACK_P non-zero means look back (in this case, TO is supposed to be
4731 Value is the first character position where STRING was found, or
4732 zero if it wasn't found before hitting TO.
4734 This function may only use code that doesn't eval because it is
4735 called asynchronously from note_mouse_highlight. */
4738 string_buffer_position_lim (Lisp_Object string
,
4739 EMACS_INT from
, EMACS_INT to
, int back_p
)
4741 Lisp_Object limit
, prop
, pos
;
4744 pos
= make_number (from
);
4746 if (!back_p
) /* looking forward */
4748 limit
= make_number (min (to
, ZV
));
4749 while (!found
&& !EQ (pos
, limit
))
4751 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4752 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4755 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4759 else /* looking back */
4761 limit
= make_number (max (to
, BEGV
));
4762 while (!found
&& !EQ (pos
, limit
))
4764 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4765 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4768 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4773 return found
? XINT (pos
) : 0;
4776 /* Determine which buffer position in current buffer STRING comes from.
4777 AROUND_CHARPOS is an approximate position where it could come from.
4778 Value is the buffer position or 0 if it couldn't be determined.
4780 This function is necessary because we don't record buffer positions
4781 in glyphs generated from strings (to keep struct glyph small).
4782 This function may only use code that doesn't eval because it is
4783 called asynchronously from note_mouse_highlight. */
4786 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4788 const int MAX_DISTANCE
= 1000;
4789 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4790 around_charpos
+ MAX_DISTANCE
,
4794 found
= string_buffer_position_lim (string
, around_charpos
,
4795 around_charpos
- MAX_DISTANCE
, 1);
4801 /***********************************************************************
4802 `composition' property
4803 ***********************************************************************/
4805 /* Set up iterator IT from `composition' property at its current
4806 position. Called from handle_stop. */
4808 static enum prop_handled
4809 handle_composition_prop (struct it
*it
)
4811 Lisp_Object prop
, string
;
4812 EMACS_INT pos
, pos_byte
, start
, end
;
4814 if (STRINGP (it
->string
))
4818 pos
= IT_STRING_CHARPOS (*it
);
4819 pos_byte
= IT_STRING_BYTEPOS (*it
);
4820 string
= it
->string
;
4821 s
= SDATA (string
) + pos_byte
;
4822 it
->c
= STRING_CHAR (s
);
4826 pos
= IT_CHARPOS (*it
);
4827 pos_byte
= IT_BYTEPOS (*it
);
4829 it
->c
= FETCH_CHAR (pos_byte
);
4832 /* If there's a valid composition and point is not inside of the
4833 composition (in the case that the composition is from the current
4834 buffer), draw a glyph composed from the composition components. */
4835 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4836 && COMPOSITION_VALID_P (start
, end
, prop
)
4837 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4840 /* As we can't handle this situation (perhaps font-lock added
4841 a new composition), we just return here hoping that next
4842 redisplay will detect this composition much earlier. */
4843 return HANDLED_NORMALLY
;
4846 if (STRINGP (it
->string
))
4847 pos_byte
= string_char_to_byte (it
->string
, start
);
4849 pos_byte
= CHAR_TO_BYTE (start
);
4851 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4854 if (it
->cmp_it
.id
>= 0)
4857 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4858 it
->cmp_it
.nglyphs
= -1;
4862 return HANDLED_NORMALLY
;
4867 /***********************************************************************
4869 ***********************************************************************/
4871 /* The following structure is used to record overlay strings for
4872 later sorting in load_overlay_strings. */
4874 struct overlay_entry
4876 Lisp_Object overlay
;
4883 /* Set up iterator IT from overlay strings at its current position.
4884 Called from handle_stop. */
4886 static enum prop_handled
4887 handle_overlay_change (struct it
*it
)
4889 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4890 return HANDLED_RECOMPUTE_PROPS
;
4892 return HANDLED_NORMALLY
;
4896 /* Set up the next overlay string for delivery by IT, if there is an
4897 overlay string to deliver. Called by set_iterator_to_next when the
4898 end of the current overlay string is reached. If there are more
4899 overlay strings to display, IT->string and
4900 IT->current.overlay_string_index are set appropriately here.
4901 Otherwise IT->string is set to nil. */
4904 next_overlay_string (struct it
*it
)
4906 ++it
->current
.overlay_string_index
;
4907 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4909 /* No more overlay strings. Restore IT's settings to what
4910 they were before overlay strings were processed, and
4911 continue to deliver from current_buffer. */
4913 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4916 || (NILP (it
->string
)
4917 && it
->method
== GET_FROM_BUFFER
4918 && it
->stop_charpos
>= BEGV
4919 && it
->stop_charpos
<= it
->end_charpos
));
4920 it
->current
.overlay_string_index
= -1;
4921 it
->n_overlay_strings
= 0;
4922 it
->overlay_strings_charpos
= -1;
4924 /* If we're at the end of the buffer, record that we have
4925 processed the overlay strings there already, so that
4926 next_element_from_buffer doesn't try it again. */
4927 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4928 it
->overlay_strings_at_end_processed_p
= 1;
4932 /* There are more overlay strings to process. If
4933 IT->current.overlay_string_index has advanced to a position
4934 where we must load IT->overlay_strings with more strings, do
4935 it. We must load at the IT->overlay_strings_charpos where
4936 IT->n_overlay_strings was originally computed; when invisible
4937 text is present, this might not be IT_CHARPOS (Bug#7016). */
4938 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4940 if (it
->current
.overlay_string_index
&& i
== 0)
4941 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4943 /* Initialize IT to deliver display elements from the overlay
4945 it
->string
= it
->overlay_strings
[i
];
4946 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4947 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4948 it
->method
= GET_FROM_STRING
;
4949 it
->stop_charpos
= 0;
4950 if (it
->cmp_it
.stop_pos
>= 0)
4951 it
->cmp_it
.stop_pos
= 0;
4953 it
->base_level_stop
= 0;
4955 /* Set up the bidi iterator for this overlay string. */
4958 it
->bidi_it
.string
.lstring
= it
->string
;
4959 it
->bidi_it
.string
.s
= NULL
;
4960 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4961 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4962 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4963 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4964 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4972 /* Compare two overlay_entry structures E1 and E2. Used as a
4973 comparison function for qsort in load_overlay_strings. Overlay
4974 strings for the same position are sorted so that
4976 1. All after-strings come in front of before-strings, except
4977 when they come from the same overlay.
4979 2. Within after-strings, strings are sorted so that overlay strings
4980 from overlays with higher priorities come first.
4982 2. Within before-strings, strings are sorted so that overlay
4983 strings from overlays with higher priorities come last.
4985 Value is analogous to strcmp. */
4989 compare_overlay_entries (const void *e1
, const void *e2
)
4991 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4992 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4995 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4997 /* Let after-strings appear in front of before-strings if
4998 they come from different overlays. */
4999 if (EQ (entry1
->overlay
, entry2
->overlay
))
5000 result
= entry1
->after_string_p
? 1 : -1;
5002 result
= entry1
->after_string_p
? -1 : 1;
5004 else if (entry1
->after_string_p
)
5005 /* After-strings sorted in order of decreasing priority. */
5006 result
= entry2
->priority
- entry1
->priority
;
5008 /* Before-strings sorted in order of increasing priority. */
5009 result
= entry1
->priority
- entry2
->priority
;
5015 /* Load the vector IT->overlay_strings with overlay strings from IT's
5016 current buffer position, or from CHARPOS if that is > 0. Set
5017 IT->n_overlays to the total number of overlay strings found.
5019 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5020 a time. On entry into load_overlay_strings,
5021 IT->current.overlay_string_index gives the number of overlay
5022 strings that have already been loaded by previous calls to this
5025 IT->add_overlay_start contains an additional overlay start
5026 position to consider for taking overlay strings from, if non-zero.
5027 This position comes into play when the overlay has an `invisible'
5028 property, and both before and after-strings. When we've skipped to
5029 the end of the overlay, because of its `invisible' property, we
5030 nevertheless want its before-string to appear.
5031 IT->add_overlay_start will contain the overlay start position
5034 Overlay strings are sorted so that after-string strings come in
5035 front of before-string strings. Within before and after-strings,
5036 strings are sorted by overlay priority. See also function
5037 compare_overlay_entries. */
5040 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5042 Lisp_Object overlay
, window
, str
, invisible
;
5043 struct Lisp_Overlay
*ov
;
5044 EMACS_INT start
, end
;
5046 int n
= 0, i
, j
, invis_p
;
5047 struct overlay_entry
*entries
5048 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5051 charpos
= IT_CHARPOS (*it
);
5053 /* Append the overlay string STRING of overlay OVERLAY to vector
5054 `entries' which has size `size' and currently contains `n'
5055 elements. AFTER_P non-zero means STRING is an after-string of
5057 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5060 Lisp_Object priority; \
5064 int new_size = 2 * size; \
5065 struct overlay_entry *old = entries; \
5067 (struct overlay_entry *) alloca (new_size \
5068 * sizeof *entries); \
5069 memcpy (entries, old, size * sizeof *entries); \
5073 entries[n].string = (STRING); \
5074 entries[n].overlay = (OVERLAY); \
5075 priority = Foverlay_get ((OVERLAY), Qpriority); \
5076 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5077 entries[n].after_string_p = (AFTER_P); \
5082 /* Process overlay before the overlay center. */
5083 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5085 XSETMISC (overlay
, ov
);
5086 xassert (OVERLAYP (overlay
));
5087 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5088 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5093 /* Skip this overlay if it doesn't start or end at IT's current
5095 if (end
!= charpos
&& start
!= charpos
)
5098 /* Skip this overlay if it doesn't apply to IT->w. */
5099 window
= Foverlay_get (overlay
, Qwindow
);
5100 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5103 /* If the text ``under'' the overlay is invisible, both before-
5104 and after-strings from this overlay are visible; start and
5105 end position are indistinguishable. */
5106 invisible
= Foverlay_get (overlay
, Qinvisible
);
5107 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5109 /* If overlay has a non-empty before-string, record it. */
5110 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5111 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5113 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5115 /* If overlay has a non-empty after-string, record it. */
5116 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5117 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5119 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5122 /* Process overlays after the overlay center. */
5123 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5125 XSETMISC (overlay
, ov
);
5126 xassert (OVERLAYP (overlay
));
5127 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5128 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5130 if (start
> charpos
)
5133 /* Skip this overlay if it doesn't start or end at IT's current
5135 if (end
!= charpos
&& start
!= charpos
)
5138 /* Skip this overlay if it doesn't apply to IT->w. */
5139 window
= Foverlay_get (overlay
, Qwindow
);
5140 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5143 /* If the text ``under'' the overlay is invisible, it has a zero
5144 dimension, and both before- and after-strings apply. */
5145 invisible
= Foverlay_get (overlay
, Qinvisible
);
5146 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5148 /* If overlay has a non-empty before-string, record it. */
5149 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5150 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5152 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5154 /* If overlay has a non-empty after-string, record it. */
5155 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5156 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5158 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5161 #undef RECORD_OVERLAY_STRING
5165 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5167 /* Record number of overlay strings, and where we computed it. */
5168 it
->n_overlay_strings
= n
;
5169 it
->overlay_strings_charpos
= charpos
;
5171 /* IT->current.overlay_string_index is the number of overlay strings
5172 that have already been consumed by IT. Copy some of the
5173 remaining overlay strings to IT->overlay_strings. */
5175 j
= it
->current
.overlay_string_index
;
5176 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5178 it
->overlay_strings
[i
] = entries
[j
].string
;
5179 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5186 /* Get the first chunk of overlay strings at IT's current buffer
5187 position, or at CHARPOS if that is > 0. Value is non-zero if at
5188 least one overlay string was found. */
5191 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5193 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5194 process. This fills IT->overlay_strings with strings, and sets
5195 IT->n_overlay_strings to the total number of strings to process.
5196 IT->pos.overlay_string_index has to be set temporarily to zero
5197 because load_overlay_strings needs this; it must be set to -1
5198 when no overlay strings are found because a zero value would
5199 indicate a position in the first overlay string. */
5200 it
->current
.overlay_string_index
= 0;
5201 load_overlay_strings (it
, charpos
);
5203 /* If we found overlay strings, set up IT to deliver display
5204 elements from the first one. Otherwise set up IT to deliver
5205 from current_buffer. */
5206 if (it
->n_overlay_strings
)
5208 /* Make sure we know settings in current_buffer, so that we can
5209 restore meaningful values when we're done with the overlay
5212 compute_stop_pos (it
);
5213 xassert (it
->face_id
>= 0);
5215 /* Save IT's settings. They are restored after all overlay
5216 strings have been processed. */
5217 xassert (!compute_stop_p
|| it
->sp
== 0);
5219 /* When called from handle_stop, there might be an empty display
5220 string loaded. In that case, don't bother saving it. */
5221 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5224 /* Set up IT to deliver display elements from the first overlay
5226 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5227 it
->string
= it
->overlay_strings
[0];
5228 it
->from_overlay
= Qnil
;
5229 it
->stop_charpos
= 0;
5230 xassert (STRINGP (it
->string
));
5231 it
->end_charpos
= SCHARS (it
->string
);
5233 it
->base_level_stop
= 0;
5234 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5235 it
->method
= GET_FROM_STRING
;
5236 it
->from_disp_prop_p
= 0;
5238 /* Force paragraph direction to be that of the parent
5240 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5241 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5243 it
->paragraph_embedding
= L2R
;
5245 /* Set up the bidi iterator for this overlay string. */
5248 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5250 it
->bidi_it
.string
.lstring
= it
->string
;
5251 it
->bidi_it
.string
.s
= NULL
;
5252 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5253 it
->bidi_it
.string
.bufpos
= pos
;
5254 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5255 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5256 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5261 it
->current
.overlay_string_index
= -1;
5266 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5269 it
->method
= GET_FROM_BUFFER
;
5271 (void) get_overlay_strings_1 (it
, charpos
, 1);
5275 /* Value is non-zero if we found at least one overlay string. */
5276 return STRINGP (it
->string
);
5281 /***********************************************************************
5282 Saving and restoring state
5283 ***********************************************************************/
5285 /* Save current settings of IT on IT->stack. Called, for example,
5286 before setting up IT for an overlay string, to be able to restore
5287 IT's settings to what they were after the overlay string has been
5288 processed. If POSITION is non-NULL, it is the position to save on
5289 the stack instead of IT->position. */
5292 push_it (struct it
*it
, struct text_pos
*position
)
5294 struct iterator_stack_entry
*p
;
5296 xassert (it
->sp
< IT_STACK_SIZE
);
5297 p
= it
->stack
+ it
->sp
;
5299 p
->stop_charpos
= it
->stop_charpos
;
5300 p
->prev_stop
= it
->prev_stop
;
5301 p
->base_level_stop
= it
->base_level_stop
;
5302 p
->cmp_it
= it
->cmp_it
;
5303 xassert (it
->face_id
>= 0);
5304 p
->face_id
= it
->face_id
;
5305 p
->string
= it
->string
;
5306 p
->method
= it
->method
;
5307 p
->from_overlay
= it
->from_overlay
;
5310 case GET_FROM_IMAGE
:
5311 p
->u
.image
.object
= it
->object
;
5312 p
->u
.image
.image_id
= it
->image_id
;
5313 p
->u
.image
.slice
= it
->slice
;
5315 case GET_FROM_STRETCH
:
5316 p
->u
.stretch
.object
= it
->object
;
5319 p
->position
= position
? *position
: it
->position
;
5320 p
->current
= it
->current
;
5321 p
->end_charpos
= it
->end_charpos
;
5322 p
->string_nchars
= it
->string_nchars
;
5324 p
->multibyte_p
= it
->multibyte_p
;
5325 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5326 p
->space_width
= it
->space_width
;
5327 p
->font_height
= it
->font_height
;
5328 p
->voffset
= it
->voffset
;
5329 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5330 p
->display_ellipsis_p
= 0;
5331 p
->line_wrap
= it
->line_wrap
;
5332 p
->bidi_p
= it
->bidi_p
;
5333 p
->paragraph_embedding
= it
->paragraph_embedding
;
5334 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5337 /* Save the state of the bidi iterator as well. */
5339 bidi_push_it (&it
->bidi_it
);
5343 iterate_out_of_display_property (struct it
*it
)
5345 int buffer_p
= BUFFERP (it
->object
);
5346 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5347 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5349 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5351 /* Maybe initialize paragraph direction. If we are at the beginning
5352 of a new paragraph, next_element_from_buffer may not have a
5353 chance to do that. */
5354 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5355 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5356 /* prev_stop can be zero, so check against BEGV as well. */
5357 while (it
->bidi_it
.charpos
>= bob
5358 && it
->prev_stop
<= it
->bidi_it
.charpos
5359 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5360 && it
->bidi_it
.charpos
< eob
)
5361 bidi_move_to_visually_next (&it
->bidi_it
);
5362 /* Record the stop_pos we just crossed, for when we cross it
5364 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5365 it
->prev_stop
= CHARPOS (it
->position
);
5366 /* If we ended up not where pop_it put us, resync IT's
5367 positional members with the bidi iterator. */
5368 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5369 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5371 it
->current
.pos
= it
->position
;
5373 it
->current
.string_pos
= it
->position
;
5376 /* Restore IT's settings from IT->stack. Called, for example, when no
5377 more overlay strings must be processed, and we return to delivering
5378 display elements from a buffer, or when the end of a string from a
5379 `display' property is reached and we return to delivering display
5380 elements from an overlay string, or from a buffer. */
5383 pop_it (struct it
*it
)
5385 struct iterator_stack_entry
*p
;
5386 int from_display_prop
= it
->from_disp_prop_p
;
5388 xassert (it
->sp
> 0);
5390 p
= it
->stack
+ it
->sp
;
5391 it
->stop_charpos
= p
->stop_charpos
;
5392 it
->prev_stop
= p
->prev_stop
;
5393 it
->base_level_stop
= p
->base_level_stop
;
5394 it
->cmp_it
= p
->cmp_it
;
5395 it
->face_id
= p
->face_id
;
5396 it
->current
= p
->current
;
5397 it
->position
= p
->position
;
5398 it
->string
= p
->string
;
5399 it
->from_overlay
= p
->from_overlay
;
5400 if (NILP (it
->string
))
5401 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5402 it
->method
= p
->method
;
5405 case GET_FROM_IMAGE
:
5406 it
->image_id
= p
->u
.image
.image_id
;
5407 it
->object
= p
->u
.image
.object
;
5408 it
->slice
= p
->u
.image
.slice
;
5410 case GET_FROM_STRETCH
:
5411 it
->object
= p
->u
.stretch
.object
;
5413 case GET_FROM_BUFFER
:
5414 it
->object
= it
->w
->buffer
;
5416 case GET_FROM_STRING
:
5417 it
->object
= it
->string
;
5419 case GET_FROM_DISPLAY_VECTOR
:
5421 it
->method
= GET_FROM_C_STRING
;
5422 else if (STRINGP (it
->string
))
5423 it
->method
= GET_FROM_STRING
;
5426 it
->method
= GET_FROM_BUFFER
;
5427 it
->object
= it
->w
->buffer
;
5430 it
->end_charpos
= p
->end_charpos
;
5431 it
->string_nchars
= p
->string_nchars
;
5433 it
->multibyte_p
= p
->multibyte_p
;
5434 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5435 it
->space_width
= p
->space_width
;
5436 it
->font_height
= p
->font_height
;
5437 it
->voffset
= p
->voffset
;
5438 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5439 it
->line_wrap
= p
->line_wrap
;
5440 it
->bidi_p
= p
->bidi_p
;
5441 it
->paragraph_embedding
= p
->paragraph_embedding
;
5442 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5445 bidi_pop_it (&it
->bidi_it
);
5446 /* Bidi-iterate until we get out of the portion of text, if any,
5447 covered by a `display' text property or by an overlay with
5448 `display' property. (We cannot just jump there, because the
5449 internal coherency of the bidi iterator state can not be
5450 preserved across such jumps.) We also must determine the
5451 paragraph base direction if the overlay we just processed is
5452 at the beginning of a new paragraph. */
5453 if (from_display_prop
5454 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5455 iterate_out_of_display_property (it
);
5457 xassert ((BUFFERP (it
->object
)
5458 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5459 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5460 || (STRINGP (it
->object
)
5461 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5462 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5468 /***********************************************************************
5470 ***********************************************************************/
5472 /* Set IT's current position to the previous line start. */
5475 back_to_previous_line_start (struct it
*it
)
5477 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5478 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5482 /* Move IT to the next line start.
5484 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5485 we skipped over part of the text (as opposed to moving the iterator
5486 continuously over the text). Otherwise, don't change the value
5489 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5490 iterator on the newline, if it was found.
5492 Newlines may come from buffer text, overlay strings, or strings
5493 displayed via the `display' property. That's the reason we can't
5494 simply use find_next_newline_no_quit.
5496 Note that this function may not skip over invisible text that is so
5497 because of text properties and immediately follows a newline. If
5498 it would, function reseat_at_next_visible_line_start, when called
5499 from set_iterator_to_next, would effectively make invisible
5500 characters following a newline part of the wrong glyph row, which
5501 leads to wrong cursor motion. */
5504 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5505 struct bidi_it
*bidi_it_prev
)
5507 EMACS_INT old_selective
;
5508 int newline_found_p
, n
;
5509 const int MAX_NEWLINE_DISTANCE
= 500;
5511 /* If already on a newline, just consume it to avoid unintended
5512 skipping over invisible text below. */
5513 if (it
->what
== IT_CHARACTER
5515 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5517 if (it
->bidi_p
&& bidi_it_prev
)
5518 *bidi_it_prev
= it
->bidi_it
;
5519 set_iterator_to_next (it
, 0);
5524 /* Don't handle selective display in the following. It's (a)
5525 unnecessary because it's done by the caller, and (b) leads to an
5526 infinite recursion because next_element_from_ellipsis indirectly
5527 calls this function. */
5528 old_selective
= it
->selective
;
5531 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5532 from buffer text. */
5533 for (n
= newline_found_p
= 0;
5534 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5535 n
+= STRINGP (it
->string
) ? 0 : 1)
5537 if (!get_next_display_element (it
))
5539 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5540 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5541 *bidi_it_prev
= it
->bidi_it
;
5542 set_iterator_to_next (it
, 0);
5545 /* If we didn't find a newline near enough, see if we can use a
5547 if (!newline_found_p
)
5549 EMACS_INT start
= IT_CHARPOS (*it
);
5550 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5553 xassert (!STRINGP (it
->string
));
5555 /* If there isn't any `display' property in sight, and no
5556 overlays, we can just use the position of the newline in
5558 if (it
->stop_charpos
>= limit
5559 || ((pos
= Fnext_single_property_change (make_number (start
),
5561 make_number (limit
)),
5563 && next_overlay_change (start
) == ZV
))
5567 IT_CHARPOS (*it
) = limit
;
5568 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5572 struct bidi_it bprev
;
5574 /* Help bidi.c avoid expensive searches for display
5575 properties and overlays, by telling it that there are
5576 none up to `limit'. */
5577 if (it
->bidi_it
.disp_pos
< limit
)
5579 it
->bidi_it
.disp_pos
= limit
;
5580 it
->bidi_it
.disp_prop
= 0;
5583 bprev
= it
->bidi_it
;
5584 bidi_move_to_visually_next (&it
->bidi_it
);
5585 } while (it
->bidi_it
.charpos
!= limit
);
5586 IT_CHARPOS (*it
) = limit
;
5587 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5589 *bidi_it_prev
= bprev
;
5591 *skipped_p
= newline_found_p
= 1;
5595 while (get_next_display_element (it
)
5596 && !newline_found_p
)
5598 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5599 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5600 *bidi_it_prev
= it
->bidi_it
;
5601 set_iterator_to_next (it
, 0);
5606 it
->selective
= old_selective
;
5607 return newline_found_p
;
5611 /* Set IT's current position to the previous visible line start. Skip
5612 invisible text that is so either due to text properties or due to
5613 selective display. Caution: this does not change IT->current_x and
5617 back_to_previous_visible_line_start (struct it
*it
)
5619 while (IT_CHARPOS (*it
) > BEGV
)
5621 back_to_previous_line_start (it
);
5623 if (IT_CHARPOS (*it
) <= BEGV
)
5626 /* If selective > 0, then lines indented more than its value are
5628 if (it
->selective
> 0
5629 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5633 /* Check the newline before point for invisibility. */
5636 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5637 Qinvisible
, it
->window
);
5638 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5642 if (IT_CHARPOS (*it
) <= BEGV
)
5647 void *it2data
= NULL
;
5650 Lisp_Object val
, overlay
;
5652 SAVE_IT (it2
, *it
, it2data
);
5654 /* If newline is part of a composition, continue from start of composition */
5655 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5656 && beg
< IT_CHARPOS (*it
))
5659 /* If newline is replaced by a display property, find start of overlay
5660 or interval and continue search from that point. */
5661 pos
= --IT_CHARPOS (it2
);
5664 bidi_unshelve_cache (NULL
, 0);
5665 it2
.string_from_display_prop_p
= 0;
5666 it2
.from_disp_prop_p
= 0;
5667 if (handle_display_prop (&it2
) == HANDLED_RETURN
5668 && !NILP (val
= get_char_property_and_overlay
5669 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5670 && (OVERLAYP (overlay
)
5671 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5672 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5674 RESTORE_IT (it
, it
, it2data
);
5678 /* Newline is not replaced by anything -- so we are done. */
5679 RESTORE_IT (it
, it
, it2data
);
5685 IT_CHARPOS (*it
) = beg
;
5686 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5690 it
->continuation_lines_width
= 0;
5692 xassert (IT_CHARPOS (*it
) >= BEGV
);
5693 xassert (IT_CHARPOS (*it
) == BEGV
5694 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5699 /* Reseat iterator IT at the previous visible line start. Skip
5700 invisible text that is so either due to text properties or due to
5701 selective display. At the end, update IT's overlay information,
5702 face information etc. */
5705 reseat_at_previous_visible_line_start (struct it
*it
)
5707 back_to_previous_visible_line_start (it
);
5708 reseat (it
, it
->current
.pos
, 1);
5713 /* Reseat iterator IT on the next visible line start in the current
5714 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5715 preceding the line start. Skip over invisible text that is so
5716 because of selective display. Compute faces, overlays etc at the
5717 new position. Note that this function does not skip over text that
5718 is invisible because of text properties. */
5721 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5723 int newline_found_p
, skipped_p
= 0;
5724 struct bidi_it bidi_it_prev
;
5726 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5728 /* Skip over lines that are invisible because they are indented
5729 more than the value of IT->selective. */
5730 if (it
->selective
> 0)
5731 while (IT_CHARPOS (*it
) < ZV
5732 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5735 xassert (IT_BYTEPOS (*it
) == BEGV
5736 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5738 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5741 /* Position on the newline if that's what's requested. */
5742 if (on_newline_p
&& newline_found_p
)
5744 if (STRINGP (it
->string
))
5746 if (IT_STRING_CHARPOS (*it
) > 0)
5750 --IT_STRING_CHARPOS (*it
);
5751 --IT_STRING_BYTEPOS (*it
);
5755 /* We need to restore the bidi iterator to the state
5756 it had on the newline, and resync the IT's
5757 position with that. */
5758 it
->bidi_it
= bidi_it_prev
;
5759 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5760 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5764 else if (IT_CHARPOS (*it
) > BEGV
)
5773 /* We need to restore the bidi iterator to the state it
5774 had on the newline and resync IT with that. */
5775 it
->bidi_it
= bidi_it_prev
;
5776 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5777 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5779 reseat (it
, it
->current
.pos
, 0);
5783 reseat (it
, it
->current
.pos
, 0);
5790 /***********************************************************************
5791 Changing an iterator's position
5792 ***********************************************************************/
5794 /* Change IT's current position to POS in current_buffer. If FORCE_P
5795 is non-zero, always check for text properties at the new position.
5796 Otherwise, text properties are only looked up if POS >=
5797 IT->check_charpos of a property. */
5800 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5802 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5804 reseat_1 (it
, pos
, 0);
5806 /* Determine where to check text properties. Avoid doing it
5807 where possible because text property lookup is very expensive. */
5809 || CHARPOS (pos
) > it
->stop_charpos
5810 || CHARPOS (pos
) < original_pos
)
5814 /* For bidi iteration, we need to prime prev_stop and
5815 base_level_stop with our best estimations. */
5816 /* Implementation note: Of course, POS is not necessarily a
5817 stop position, so assigning prev_pos to it is a lie; we
5818 should have called compute_stop_backwards. However, if
5819 the current buffer does not include any R2L characters,
5820 that call would be a waste of cycles, because the
5821 iterator will never move back, and thus never cross this
5822 "fake" stop position. So we delay that backward search
5823 until the time we really need it, in next_element_from_buffer. */
5824 if (CHARPOS (pos
) != it
->prev_stop
)
5825 it
->prev_stop
= CHARPOS (pos
);
5826 if (CHARPOS (pos
) < it
->base_level_stop
)
5827 it
->base_level_stop
= 0; /* meaning it's unknown */
5833 it
->prev_stop
= it
->base_level_stop
= 0;
5842 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5843 IT->stop_pos to POS, also. */
5846 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5848 /* Don't call this function when scanning a C string. */
5849 xassert (it
->s
== NULL
);
5851 /* POS must be a reasonable value. */
5852 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5854 it
->current
.pos
= it
->position
= pos
;
5855 it
->end_charpos
= ZV
;
5857 it
->current
.dpvec_index
= -1;
5858 it
->current
.overlay_string_index
= -1;
5859 IT_STRING_CHARPOS (*it
) = -1;
5860 IT_STRING_BYTEPOS (*it
) = -1;
5862 it
->method
= GET_FROM_BUFFER
;
5863 it
->object
= it
->w
->buffer
;
5864 it
->area
= TEXT_AREA
;
5865 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5867 it
->string_from_display_prop_p
= 0;
5868 it
->from_disp_prop_p
= 0;
5869 it
->face_before_selective_p
= 0;
5872 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5874 bidi_unshelve_cache (NULL
, 0);
5875 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5876 it
->bidi_it
.string
.s
= NULL
;
5877 it
->bidi_it
.string
.lstring
= Qnil
;
5878 it
->bidi_it
.string
.bufpos
= 0;
5879 it
->bidi_it
.string
.unibyte
= 0;
5884 it
->stop_charpos
= CHARPOS (pos
);
5885 it
->base_level_stop
= CHARPOS (pos
);
5890 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5891 If S is non-null, it is a C string to iterate over. Otherwise,
5892 STRING gives a Lisp string to iterate over.
5894 If PRECISION > 0, don't return more then PRECISION number of
5895 characters from the string.
5897 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5898 characters have been returned. FIELD_WIDTH < 0 means an infinite
5901 MULTIBYTE = 0 means disable processing of multibyte characters,
5902 MULTIBYTE > 0 means enable it,
5903 MULTIBYTE < 0 means use IT->multibyte_p.
5905 IT must be initialized via a prior call to init_iterator before
5906 calling this function. */
5909 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5910 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5913 /* No region in strings. */
5914 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5916 /* No text property checks performed by default, but see below. */
5917 it
->stop_charpos
= -1;
5919 /* Set iterator position and end position. */
5920 memset (&it
->current
, 0, sizeof it
->current
);
5921 it
->current
.overlay_string_index
= -1;
5922 it
->current
.dpvec_index
= -1;
5923 xassert (charpos
>= 0);
5925 /* If STRING is specified, use its multibyteness, otherwise use the
5926 setting of MULTIBYTE, if specified. */
5928 it
->multibyte_p
= multibyte
> 0;
5930 /* Bidirectional reordering of strings is controlled by the default
5931 value of bidi-display-reordering. */
5932 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5936 xassert (STRINGP (string
));
5937 it
->string
= string
;
5939 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5940 it
->method
= GET_FROM_STRING
;
5941 it
->current
.string_pos
= string_pos (charpos
, string
);
5945 it
->bidi_it
.string
.lstring
= string
;
5946 it
->bidi_it
.string
.s
= NULL
;
5947 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5948 it
->bidi_it
.string
.bufpos
= 0;
5949 it
->bidi_it
.string
.from_disp_str
= 0;
5950 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5951 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5952 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5957 it
->s
= (const unsigned char *) s
;
5960 /* Note that we use IT->current.pos, not it->current.string_pos,
5961 for displaying C strings. */
5962 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5963 if (it
->multibyte_p
)
5965 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5966 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5970 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5971 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5976 it
->bidi_it
.string
.lstring
= Qnil
;
5977 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5978 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5979 it
->bidi_it
.string
.bufpos
= 0;
5980 it
->bidi_it
.string
.from_disp_str
= 0;
5981 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5982 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5985 it
->method
= GET_FROM_C_STRING
;
5988 /* PRECISION > 0 means don't return more than PRECISION characters
5990 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5992 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5994 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5997 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5998 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5999 FIELD_WIDTH < 0 means infinite field width. This is useful for
6000 padding with `-' at the end of a mode line. */
6001 if (field_width
< 0)
6002 field_width
= INFINITY
;
6003 /* Implementation note: We deliberately don't enlarge
6004 it->bidi_it.string.schars here to fit it->end_charpos, because
6005 the bidi iterator cannot produce characters out of thin air. */
6006 if (field_width
> it
->end_charpos
- charpos
)
6007 it
->end_charpos
= charpos
+ field_width
;
6009 /* Use the standard display table for displaying strings. */
6010 if (DISP_TABLE_P (Vstandard_display_table
))
6011 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6013 it
->stop_charpos
= charpos
;
6014 it
->prev_stop
= charpos
;
6015 it
->base_level_stop
= 0;
6018 it
->bidi_it
.first_elt
= 1;
6019 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6020 it
->bidi_it
.disp_pos
= -1;
6022 if (s
== NULL
&& it
->multibyte_p
)
6024 EMACS_INT endpos
= SCHARS (it
->string
);
6025 if (endpos
> it
->end_charpos
)
6026 endpos
= it
->end_charpos
;
6027 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6035 /***********************************************************************
6037 ***********************************************************************/
6039 /* Map enum it_method value to corresponding next_element_from_* function. */
6041 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6043 next_element_from_buffer
,
6044 next_element_from_display_vector
,
6045 next_element_from_string
,
6046 next_element_from_c_string
,
6047 next_element_from_image
,
6048 next_element_from_stretch
6051 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6054 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6055 (possibly with the following characters). */
6057 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6058 ((IT)->cmp_it.id >= 0 \
6059 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6060 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6061 END_CHARPOS, (IT)->w, \
6062 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6066 /* Lookup the char-table Vglyphless_char_display for character C (-1
6067 if we want information for no-font case), and return the display
6068 method symbol. By side-effect, update it->what and
6069 it->glyphless_method. This function is called from
6070 get_next_display_element for each character element, and from
6071 x_produce_glyphs when no suitable font was found. */
6074 lookup_glyphless_char_display (int c
, struct it
*it
)
6076 Lisp_Object glyphless_method
= Qnil
;
6078 if (CHAR_TABLE_P (Vglyphless_char_display
)
6079 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6083 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6084 if (CONSP (glyphless_method
))
6085 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6086 ? XCAR (glyphless_method
)
6087 : XCDR (glyphless_method
);
6090 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6094 if (NILP (glyphless_method
))
6097 /* The default is to display the character by a proper font. */
6099 /* The default for the no-font case is to display an empty box. */
6100 glyphless_method
= Qempty_box
;
6102 if (EQ (glyphless_method
, Qzero_width
))
6105 return glyphless_method
;
6106 /* This method can't be used for the no-font case. */
6107 glyphless_method
= Qempty_box
;
6109 if (EQ (glyphless_method
, Qthin_space
))
6110 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6111 else if (EQ (glyphless_method
, Qempty_box
))
6112 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6113 else if (EQ (glyphless_method
, Qhex_code
))
6114 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6115 else if (STRINGP (glyphless_method
))
6116 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6119 /* Invalid value. We use the default method. */
6120 glyphless_method
= Qnil
;
6123 it
->what
= IT_GLYPHLESS
;
6124 return glyphless_method
;
6127 /* Load IT's display element fields with information about the next
6128 display element from the current position of IT. Value is zero if
6129 end of buffer (or C string) is reached. */
6131 static struct frame
*last_escape_glyph_frame
= NULL
;
6132 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6133 static int last_escape_glyph_merged_face_id
= 0;
6135 struct frame
*last_glyphless_glyph_frame
= NULL
;
6136 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6137 int last_glyphless_glyph_merged_face_id
= 0;
6140 get_next_display_element (struct it
*it
)
6142 /* Non-zero means that we found a display element. Zero means that
6143 we hit the end of what we iterate over. Performance note: the
6144 function pointer `method' used here turns out to be faster than
6145 using a sequence of if-statements. */
6149 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6151 if (it
->what
== IT_CHARACTER
)
6153 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6154 and only if (a) the resolved directionality of that character
6156 /* FIXME: Do we need an exception for characters from display
6158 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6159 it
->c
= bidi_mirror_char (it
->c
);
6160 /* Map via display table or translate control characters.
6161 IT->c, IT->len etc. have been set to the next character by
6162 the function call above. If we have a display table, and it
6163 contains an entry for IT->c, translate it. Don't do this if
6164 IT->c itself comes from a display table, otherwise we could
6165 end up in an infinite recursion. (An alternative could be to
6166 count the recursion depth of this function and signal an
6167 error when a certain maximum depth is reached.) Is it worth
6169 if (success_p
&& it
->dpvec
== NULL
)
6172 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6173 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6174 nbsp_or_shy
= char_is_other
;
6175 int c
= it
->c
; /* This is the character to display. */
6177 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6179 xassert (SINGLE_BYTE_CHAR_P (c
));
6180 if (unibyte_display_via_language_environment
)
6182 c
= DECODE_CHAR (unibyte
, c
);
6184 c
= BYTE8_TO_CHAR (it
->c
);
6187 c
= BYTE8_TO_CHAR (it
->c
);
6191 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6194 struct Lisp_Vector
*v
= XVECTOR (dv
);
6196 /* Return the first character from the display table
6197 entry, if not empty. If empty, don't display the
6198 current character. */
6201 it
->dpvec_char_len
= it
->len
;
6202 it
->dpvec
= v
->contents
;
6203 it
->dpend
= v
->contents
+ v
->header
.size
;
6204 it
->current
.dpvec_index
= 0;
6205 it
->dpvec_face_id
= -1;
6206 it
->saved_face_id
= it
->face_id
;
6207 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6212 set_iterator_to_next (it
, 0);
6217 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6219 if (it
->what
== IT_GLYPHLESS
)
6221 /* Don't display this character. */
6222 set_iterator_to_next (it
, 0);
6226 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6227 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6228 : c
== 0xAD ? char_is_soft_hyphen
6231 /* Translate control characters into `\003' or `^C' form.
6232 Control characters coming from a display table entry are
6233 currently not translated because we use IT->dpvec to hold
6234 the translation. This could easily be changed but I
6235 don't believe that it is worth doing.
6237 NBSP and SOFT-HYPEN are property translated too.
6239 Non-printable characters and raw-byte characters are also
6240 translated to octal form. */
6241 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6242 ? (it
->area
!= TEXT_AREA
6243 /* In mode line, treat \n, \t like other crl chars. */
6246 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6247 || (c
!= '\n' && c
!= '\t'))
6250 || ! CHAR_PRINTABLE_P (c
))))
6252 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6253 or a non-printable character which must be displayed
6254 either as '\003' or as `^C' where the '\\' and '^'
6255 can be defined in the display table. Fill
6256 IT->ctl_chars with glyphs for what we have to
6257 display. Then, set IT->dpvec to these glyphs. */
6261 EMACS_INT lface_id
= 0;
6264 /* Handle control characters with ^. */
6266 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6270 g
= '^'; /* default glyph for Control */
6271 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6273 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6274 && GLYPH_CODE_CHAR_VALID_P (gc
))
6276 g
= GLYPH_CODE_CHAR (gc
);
6277 lface_id
= GLYPH_CODE_FACE (gc
);
6281 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6283 else if (it
->f
== last_escape_glyph_frame
6284 && it
->face_id
== last_escape_glyph_face_id
)
6286 face_id
= last_escape_glyph_merged_face_id
;
6290 /* Merge the escape-glyph face into the current face. */
6291 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6293 last_escape_glyph_frame
= it
->f
;
6294 last_escape_glyph_face_id
= it
->face_id
;
6295 last_escape_glyph_merged_face_id
= face_id
;
6298 XSETINT (it
->ctl_chars
[0], g
);
6299 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6301 goto display_control
;
6304 /* Handle non-break space in the mode where it only gets
6307 if (EQ (Vnobreak_char_display
, Qt
)
6308 && nbsp_or_shy
== char_is_nbsp
)
6310 /* Merge the no-break-space face into the current face. */
6311 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6315 XSETINT (it
->ctl_chars
[0], ' ');
6317 goto display_control
;
6320 /* Handle sequences that start with the "escape glyph". */
6322 /* the default escape glyph is \. */
6323 escape_glyph
= '\\';
6326 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6327 && GLYPH_CODE_CHAR_VALID_P (gc
))
6329 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6330 lface_id
= GLYPH_CODE_FACE (gc
);
6334 /* The display table specified a face.
6335 Merge it into face_id and also into escape_glyph. */
6336 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6339 else if (it
->f
== last_escape_glyph_frame
6340 && it
->face_id
== last_escape_glyph_face_id
)
6342 face_id
= last_escape_glyph_merged_face_id
;
6346 /* Merge the escape-glyph face into the current face. */
6347 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6349 last_escape_glyph_frame
= it
->f
;
6350 last_escape_glyph_face_id
= it
->face_id
;
6351 last_escape_glyph_merged_face_id
= face_id
;
6354 /* Handle soft hyphens in the mode where they only get
6357 if (EQ (Vnobreak_char_display
, Qt
)
6358 && nbsp_or_shy
== char_is_soft_hyphen
)
6360 XSETINT (it
->ctl_chars
[0], '-');
6362 goto display_control
;
6365 /* Handle non-break space and soft hyphen
6366 with the escape glyph. */
6370 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6371 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6372 XSETINT (it
->ctl_chars
[1], c
);
6374 goto display_control
;
6381 if (CHAR_BYTE8_P (c
))
6382 /* Display \200 instead of \17777600. */
6383 c
= CHAR_TO_BYTE8 (c
);
6384 len
= sprintf (str
, "%03o", c
);
6386 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6387 for (i
= 0; i
< len
; i
++)
6388 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6393 /* Set up IT->dpvec and return first character from it. */
6394 it
->dpvec_char_len
= it
->len
;
6395 it
->dpvec
= it
->ctl_chars
;
6396 it
->dpend
= it
->dpvec
+ ctl_len
;
6397 it
->current
.dpvec_index
= 0;
6398 it
->dpvec_face_id
= face_id
;
6399 it
->saved_face_id
= it
->face_id
;
6400 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6404 it
->char_to_display
= c
;
6408 it
->char_to_display
= it
->c
;
6412 /* Adjust face id for a multibyte character. There are no multibyte
6413 character in unibyte text. */
6414 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6417 && FRAME_WINDOW_P (it
->f
))
6419 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6421 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6423 /* Automatic composition with glyph-string. */
6424 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6426 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6430 EMACS_INT pos
= (it
->s
? -1
6431 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6432 : IT_CHARPOS (*it
));
6435 if (it
->what
== IT_CHARACTER
)
6436 c
= it
->char_to_display
;
6439 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6443 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6444 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6447 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6452 /* Is this character the last one of a run of characters with
6453 box? If yes, set IT->end_of_box_run_p to 1. */
6457 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6459 int face_id
= underlying_face_id (it
);
6460 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6464 if (face
->box
== FACE_NO_BOX
)
6466 /* If the box comes from face properties in a
6467 display string, check faces in that string. */
6468 int string_face_id
= face_after_it_pos (it
);
6469 it
->end_of_box_run_p
6470 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6473 /* Otherwise, the box comes from the underlying face.
6474 If this is the last string character displayed, check
6475 the next buffer location. */
6476 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6477 && (it
->current
.overlay_string_index
6478 == it
->n_overlay_strings
- 1))
6482 struct text_pos pos
= it
->current
.pos
;
6483 INC_TEXT_POS (pos
, it
->multibyte_p
);
6485 next_face_id
= face_at_buffer_position
6486 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6487 it
->region_end_charpos
, &ignore
,
6488 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6490 it
->end_of_box_run_p
6491 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6498 int face_id
= face_after_it_pos (it
);
6499 it
->end_of_box_run_p
6500 = (face_id
!= it
->face_id
6501 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6505 /* Value is 0 if end of buffer or string reached. */
6510 /* Move IT to the next display element.
6512 RESEAT_P non-zero means if called on a newline in buffer text,
6513 skip to the next visible line start.
6515 Functions get_next_display_element and set_iterator_to_next are
6516 separate because I find this arrangement easier to handle than a
6517 get_next_display_element function that also increments IT's
6518 position. The way it is we can first look at an iterator's current
6519 display element, decide whether it fits on a line, and if it does,
6520 increment the iterator position. The other way around we probably
6521 would either need a flag indicating whether the iterator has to be
6522 incremented the next time, or we would have to implement a
6523 decrement position function which would not be easy to write. */
6526 set_iterator_to_next (struct it
*it
, int reseat_p
)
6528 /* Reset flags indicating start and end of a sequence of characters
6529 with box. Reset them at the start of this function because
6530 moving the iterator to a new position might set them. */
6531 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6535 case GET_FROM_BUFFER
:
6536 /* The current display element of IT is a character from
6537 current_buffer. Advance in the buffer, and maybe skip over
6538 invisible lines that are so because of selective display. */
6539 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6540 reseat_at_next_visible_line_start (it
, 0);
6541 else if (it
->cmp_it
.id
>= 0)
6543 /* We are currently getting glyphs from a composition. */
6548 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6549 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6550 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6552 it
->cmp_it
.from
= it
->cmp_it
.to
;
6557 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6559 it
->end_charpos
, Qnil
);
6562 else if (! it
->cmp_it
.reversed_p
)
6564 /* Composition created while scanning forward. */
6565 /* Update IT's char/byte positions to point to the first
6566 character of the next grapheme cluster, or to the
6567 character visually after the current composition. */
6568 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6569 bidi_move_to_visually_next (&it
->bidi_it
);
6570 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6571 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6573 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6575 /* Proceed to the next grapheme cluster. */
6576 it
->cmp_it
.from
= it
->cmp_it
.to
;
6580 /* No more grapheme clusters in this composition.
6581 Find the next stop position. */
6582 EMACS_INT stop
= it
->end_charpos
;
6583 if (it
->bidi_it
.scan_dir
< 0)
6584 /* Now we are scanning backward and don't know
6587 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6588 IT_BYTEPOS (*it
), stop
, Qnil
);
6593 /* Composition created while scanning backward. */
6594 /* Update IT's char/byte positions to point to the last
6595 character of the previous grapheme cluster, or the
6596 character visually after the current composition. */
6597 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6598 bidi_move_to_visually_next (&it
->bidi_it
);
6599 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6600 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6601 if (it
->cmp_it
.from
> 0)
6603 /* Proceed to the previous grapheme cluster. */
6604 it
->cmp_it
.to
= it
->cmp_it
.from
;
6608 /* No more grapheme clusters in this composition.
6609 Find the next stop position. */
6610 EMACS_INT stop
= it
->end_charpos
;
6611 if (it
->bidi_it
.scan_dir
< 0)
6612 /* Now we are scanning backward and don't know
6615 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6616 IT_BYTEPOS (*it
), stop
, Qnil
);
6622 xassert (it
->len
!= 0);
6626 IT_BYTEPOS (*it
) += it
->len
;
6627 IT_CHARPOS (*it
) += 1;
6631 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6632 /* If this is a new paragraph, determine its base
6633 direction (a.k.a. its base embedding level). */
6634 if (it
->bidi_it
.new_paragraph
)
6635 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6636 bidi_move_to_visually_next (&it
->bidi_it
);
6637 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6638 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6639 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6641 /* As the scan direction was changed, we must
6642 re-compute the stop position for composition. */
6643 EMACS_INT stop
= it
->end_charpos
;
6644 if (it
->bidi_it
.scan_dir
< 0)
6646 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6647 IT_BYTEPOS (*it
), stop
, Qnil
);
6650 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6654 case GET_FROM_C_STRING
:
6655 /* Current display element of IT is from a C string. */
6657 /* If the string position is beyond string's end, it means
6658 next_element_from_c_string is padding the string with
6659 blanks, in which case we bypass the bidi iterator,
6660 because it cannot deal with such virtual characters. */
6661 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6663 IT_BYTEPOS (*it
) += it
->len
;
6664 IT_CHARPOS (*it
) += 1;
6668 bidi_move_to_visually_next (&it
->bidi_it
);
6669 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6670 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6674 case GET_FROM_DISPLAY_VECTOR
:
6675 /* Current display element of IT is from a display table entry.
6676 Advance in the display table definition. Reset it to null if
6677 end reached, and continue with characters from buffers/
6679 ++it
->current
.dpvec_index
;
6681 /* Restore face of the iterator to what they were before the
6682 display vector entry (these entries may contain faces). */
6683 it
->face_id
= it
->saved_face_id
;
6685 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6687 int recheck_faces
= it
->ellipsis_p
;
6690 it
->method
= GET_FROM_C_STRING
;
6691 else if (STRINGP (it
->string
))
6692 it
->method
= GET_FROM_STRING
;
6695 it
->method
= GET_FROM_BUFFER
;
6696 it
->object
= it
->w
->buffer
;
6700 it
->current
.dpvec_index
= -1;
6702 /* Skip over characters which were displayed via IT->dpvec. */
6703 if (it
->dpvec_char_len
< 0)
6704 reseat_at_next_visible_line_start (it
, 1);
6705 else if (it
->dpvec_char_len
> 0)
6707 if (it
->method
== GET_FROM_STRING
6708 && it
->n_overlay_strings
> 0)
6709 it
->ignore_overlay_strings_at_pos_p
= 1;
6710 it
->len
= it
->dpvec_char_len
;
6711 set_iterator_to_next (it
, reseat_p
);
6714 /* Maybe recheck faces after display vector */
6716 it
->stop_charpos
= IT_CHARPOS (*it
);
6720 case GET_FROM_STRING
:
6721 /* Current display element is a character from a Lisp string. */
6722 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6723 if (it
->cmp_it
.id
>= 0)
6729 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6730 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6731 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6732 it
->cmp_it
.from
= it
->cmp_it
.to
;
6736 composition_compute_stop_pos (&it
->cmp_it
,
6737 IT_STRING_CHARPOS (*it
),
6738 IT_STRING_BYTEPOS (*it
),
6739 it
->end_charpos
, it
->string
);
6742 else if (! it
->cmp_it
.reversed_p
)
6744 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6745 bidi_move_to_visually_next (&it
->bidi_it
);
6746 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6747 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6749 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6750 it
->cmp_it
.from
= it
->cmp_it
.to
;
6753 EMACS_INT stop
= it
->end_charpos
;
6754 if (it
->bidi_it
.scan_dir
< 0)
6756 composition_compute_stop_pos (&it
->cmp_it
,
6757 IT_STRING_CHARPOS (*it
),
6758 IT_STRING_BYTEPOS (*it
), stop
,
6764 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6765 bidi_move_to_visually_next (&it
->bidi_it
);
6766 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6767 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6768 if (it
->cmp_it
.from
> 0)
6769 it
->cmp_it
.to
= it
->cmp_it
.from
;
6772 EMACS_INT stop
= it
->end_charpos
;
6773 if (it
->bidi_it
.scan_dir
< 0)
6775 composition_compute_stop_pos (&it
->cmp_it
,
6776 IT_STRING_CHARPOS (*it
),
6777 IT_STRING_BYTEPOS (*it
), stop
,
6785 /* If the string position is beyond string's end, it
6786 means next_element_from_string is padding the string
6787 with blanks, in which case we bypass the bidi
6788 iterator, because it cannot deal with such virtual
6790 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6792 IT_STRING_BYTEPOS (*it
) += it
->len
;
6793 IT_STRING_CHARPOS (*it
) += 1;
6797 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6799 bidi_move_to_visually_next (&it
->bidi_it
);
6800 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6801 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6802 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6804 EMACS_INT stop
= it
->end_charpos
;
6806 if (it
->bidi_it
.scan_dir
< 0)
6808 composition_compute_stop_pos (&it
->cmp_it
,
6809 IT_STRING_CHARPOS (*it
),
6810 IT_STRING_BYTEPOS (*it
), stop
,
6816 consider_string_end
:
6818 if (it
->current
.overlay_string_index
>= 0)
6820 /* IT->string is an overlay string. Advance to the
6821 next, if there is one. */
6822 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6825 next_overlay_string (it
);
6827 setup_for_ellipsis (it
, 0);
6832 /* IT->string is not an overlay string. If we reached
6833 its end, and there is something on IT->stack, proceed
6834 with what is on the stack. This can be either another
6835 string, this time an overlay string, or a buffer. */
6836 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6840 if (it
->method
== GET_FROM_STRING
)
6841 goto consider_string_end
;
6846 case GET_FROM_IMAGE
:
6847 case GET_FROM_STRETCH
:
6848 /* The position etc with which we have to proceed are on
6849 the stack. The position may be at the end of a string,
6850 if the `display' property takes up the whole string. */
6851 xassert (it
->sp
> 0);
6853 if (it
->method
== GET_FROM_STRING
)
6854 goto consider_string_end
;
6858 /* There are no other methods defined, so this should be a bug. */
6862 xassert (it
->method
!= GET_FROM_STRING
6863 || (STRINGP (it
->string
)
6864 && IT_STRING_CHARPOS (*it
) >= 0));
6867 /* Load IT's display element fields with information about the next
6868 display element which comes from a display table entry or from the
6869 result of translating a control character to one of the forms `^C'
6872 IT->dpvec holds the glyphs to return as characters.
6873 IT->saved_face_id holds the face id before the display vector--it
6874 is restored into IT->face_id in set_iterator_to_next. */
6877 next_element_from_display_vector (struct it
*it
)
6882 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6884 it
->face_id
= it
->saved_face_id
;
6886 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6887 That seemed totally bogus - so I changed it... */
6888 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6890 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6892 it
->c
= GLYPH_CODE_CHAR (gc
);
6893 it
->len
= CHAR_BYTES (it
->c
);
6895 /* The entry may contain a face id to use. Such a face id is
6896 the id of a Lisp face, not a realized face. A face id of
6897 zero means no face is specified. */
6898 if (it
->dpvec_face_id
>= 0)
6899 it
->face_id
= it
->dpvec_face_id
;
6902 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6904 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6909 /* Display table entry is invalid. Return a space. */
6910 it
->c
= ' ', it
->len
= 1;
6912 /* Don't change position and object of the iterator here. They are
6913 still the values of the character that had this display table
6914 entry or was translated, and that's what we want. */
6915 it
->what
= IT_CHARACTER
;
6919 /* Get the first element of string/buffer in the visual order, after
6920 being reseated to a new position in a string or a buffer. */
6922 get_visually_first_element (struct it
*it
)
6924 int string_p
= STRINGP (it
->string
) || it
->s
;
6925 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6926 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6928 if (STRINGP (it
->string
))
6930 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6931 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6935 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6936 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6939 if (it
->bidi_it
.charpos
== eob
)
6941 /* Nothing to do, but reset the FIRST_ELT flag, like
6942 bidi_paragraph_init does, because we are not going to
6944 it
->bidi_it
.first_elt
= 0;
6946 else if (it
->bidi_it
.charpos
== bob
6948 /* FIXME: Should support all Unicode line separators. */
6949 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6950 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6952 /* If we are at the beginning of a line/string, we can produce
6953 the next element right away. */
6954 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6955 bidi_move_to_visually_next (&it
->bidi_it
);
6959 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6961 /* We need to prime the bidi iterator starting at the line's or
6962 string's beginning, before we will be able to produce the
6965 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6968 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6970 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6972 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6975 /* Now return to buffer/string position where we were asked
6976 to get the next display element, and produce that. */
6977 bidi_move_to_visually_next (&it
->bidi_it
);
6979 while (it
->bidi_it
.bytepos
!= orig_bytepos
6980 && it
->bidi_it
.charpos
< eob
);
6983 /* Adjust IT's position information to where we ended up. */
6984 if (STRINGP (it
->string
))
6986 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6987 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6991 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6992 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6995 if (STRINGP (it
->string
) || !it
->s
)
6997 EMACS_INT stop
, charpos
, bytepos
;
6999 if (STRINGP (it
->string
))
7002 stop
= SCHARS (it
->string
);
7003 if (stop
> it
->end_charpos
)
7004 stop
= it
->end_charpos
;
7005 charpos
= IT_STRING_CHARPOS (*it
);
7006 bytepos
= IT_STRING_BYTEPOS (*it
);
7010 stop
= it
->end_charpos
;
7011 charpos
= IT_CHARPOS (*it
);
7012 bytepos
= IT_BYTEPOS (*it
);
7014 if (it
->bidi_it
.scan_dir
< 0)
7016 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7021 /* Load IT with the next display element from Lisp string IT->string.
7022 IT->current.string_pos is the current position within the string.
7023 If IT->current.overlay_string_index >= 0, the Lisp string is an
7027 next_element_from_string (struct it
*it
)
7029 struct text_pos position
;
7031 xassert (STRINGP (it
->string
));
7032 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7033 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7034 position
= it
->current
.string_pos
;
7036 /* With bidi reordering, the character to display might not be the
7037 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7038 that we were reseat()ed to a new string, whose paragraph
7039 direction is not known. */
7040 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7042 get_visually_first_element (it
);
7043 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7046 /* Time to check for invisible text? */
7047 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7049 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7052 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7053 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7055 /* With bidi non-linear iteration, we could find
7056 ourselves far beyond the last computed stop_charpos,
7057 with several other stop positions in between that we
7058 missed. Scan them all now, in buffer's logical
7059 order, until we find and handle the last stop_charpos
7060 that precedes our current position. */
7061 handle_stop_backwards (it
, it
->stop_charpos
);
7062 return GET_NEXT_DISPLAY_ELEMENT (it
);
7068 /* Take note of the stop position we just moved
7069 across, for when we will move back across it. */
7070 it
->prev_stop
= it
->stop_charpos
;
7071 /* If we are at base paragraph embedding level, take
7072 note of the last stop position seen at this
7074 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7075 it
->base_level_stop
= it
->stop_charpos
;
7079 /* Since a handler may have changed IT->method, we must
7081 return GET_NEXT_DISPLAY_ELEMENT (it
);
7085 /* If we are before prev_stop, we may have overstepped
7086 on our way backwards a stop_pos, and if so, we need
7087 to handle that stop_pos. */
7088 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7089 /* We can sometimes back up for reasons that have nothing
7090 to do with bidi reordering. E.g., compositions. The
7091 code below is only needed when we are above the base
7092 embedding level, so test for that explicitly. */
7093 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7095 /* If we lost track of base_level_stop, we have no better
7096 place for handle_stop_backwards to start from than string
7097 beginning. This happens, e.g., when we were reseated to
7098 the previous screenful of text by vertical-motion. */
7099 if (it
->base_level_stop
<= 0
7100 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7101 it
->base_level_stop
= 0;
7102 handle_stop_backwards (it
, it
->base_level_stop
);
7103 return GET_NEXT_DISPLAY_ELEMENT (it
);
7107 if (it
->current
.overlay_string_index
>= 0)
7109 /* Get the next character from an overlay string. In overlay
7110 strings, There is no field width or padding with spaces to
7112 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7117 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7118 IT_STRING_BYTEPOS (*it
),
7119 it
->bidi_it
.scan_dir
< 0
7121 : SCHARS (it
->string
))
7122 && next_element_from_composition (it
))
7126 else if (STRING_MULTIBYTE (it
->string
))
7128 const unsigned char *s
= (SDATA (it
->string
)
7129 + IT_STRING_BYTEPOS (*it
));
7130 it
->c
= string_char_and_length (s
, &it
->len
);
7134 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7140 /* Get the next character from a Lisp string that is not an
7141 overlay string. Such strings come from the mode line, for
7142 example. We may have to pad with spaces, or truncate the
7143 string. See also next_element_from_c_string. */
7144 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7149 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7151 /* Pad with spaces. */
7152 it
->c
= ' ', it
->len
= 1;
7153 CHARPOS (position
) = BYTEPOS (position
) = -1;
7155 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7156 IT_STRING_BYTEPOS (*it
),
7157 it
->bidi_it
.scan_dir
< 0
7159 : it
->string_nchars
)
7160 && next_element_from_composition (it
))
7164 else if (STRING_MULTIBYTE (it
->string
))
7166 const unsigned char *s
= (SDATA (it
->string
)
7167 + IT_STRING_BYTEPOS (*it
));
7168 it
->c
= string_char_and_length (s
, &it
->len
);
7172 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7177 /* Record what we have and where it came from. */
7178 it
->what
= IT_CHARACTER
;
7179 it
->object
= it
->string
;
7180 it
->position
= position
;
7185 /* Load IT with next display element from C string IT->s.
7186 IT->string_nchars is the maximum number of characters to return
7187 from the string. IT->end_charpos may be greater than
7188 IT->string_nchars when this function is called, in which case we
7189 may have to return padding spaces. Value is zero if end of string
7190 reached, including padding spaces. */
7193 next_element_from_c_string (struct it
*it
)
7198 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7199 it
->what
= IT_CHARACTER
;
7200 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7203 /* With bidi reordering, the character to display might not be the
7204 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7205 we were reseated to a new string, whose paragraph direction is
7207 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7208 get_visually_first_element (it
);
7210 /* IT's position can be greater than IT->string_nchars in case a
7211 field width or precision has been specified when the iterator was
7213 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7215 /* End of the game. */
7219 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7221 /* Pad with spaces. */
7222 it
->c
= ' ', it
->len
= 1;
7223 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7225 else if (it
->multibyte_p
)
7226 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7228 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7234 /* Set up IT to return characters from an ellipsis, if appropriate.
7235 The definition of the ellipsis glyphs may come from a display table
7236 entry. This function fills IT with the first glyph from the
7237 ellipsis if an ellipsis is to be displayed. */
7240 next_element_from_ellipsis (struct it
*it
)
7242 if (it
->selective_display_ellipsis_p
)
7243 setup_for_ellipsis (it
, it
->len
);
7246 /* The face at the current position may be different from the
7247 face we find after the invisible text. Remember what it
7248 was in IT->saved_face_id, and signal that it's there by
7249 setting face_before_selective_p. */
7250 it
->saved_face_id
= it
->face_id
;
7251 it
->method
= GET_FROM_BUFFER
;
7252 it
->object
= it
->w
->buffer
;
7253 reseat_at_next_visible_line_start (it
, 1);
7254 it
->face_before_selective_p
= 1;
7257 return GET_NEXT_DISPLAY_ELEMENT (it
);
7261 /* Deliver an image display element. The iterator IT is already
7262 filled with image information (done in handle_display_prop). Value
7267 next_element_from_image (struct it
*it
)
7269 it
->what
= IT_IMAGE
;
7270 it
->ignore_overlay_strings_at_pos_p
= 0;
7275 /* Fill iterator IT with next display element from a stretch glyph
7276 property. IT->object is the value of the text property. Value is
7280 next_element_from_stretch (struct it
*it
)
7282 it
->what
= IT_STRETCH
;
7286 /* Scan backwards from IT's current position until we find a stop
7287 position, or until BEGV. This is called when we find ourself
7288 before both the last known prev_stop and base_level_stop while
7289 reordering bidirectional text. */
7292 compute_stop_pos_backwards (struct it
*it
)
7294 const int SCAN_BACK_LIMIT
= 1000;
7295 struct text_pos pos
;
7296 struct display_pos save_current
= it
->current
;
7297 struct text_pos save_position
= it
->position
;
7298 EMACS_INT charpos
= IT_CHARPOS (*it
);
7299 EMACS_INT where_we_are
= charpos
;
7300 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7301 EMACS_INT save_end_pos
= it
->end_charpos
;
7303 xassert (NILP (it
->string
) && !it
->s
);
7304 xassert (it
->bidi_p
);
7308 it
->end_charpos
= min (charpos
+ 1, ZV
);
7309 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7310 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7311 reseat_1 (it
, pos
, 0);
7312 compute_stop_pos (it
);
7313 /* We must advance forward, right? */
7314 if (it
->stop_charpos
<= charpos
)
7317 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7319 if (it
->stop_charpos
<= where_we_are
)
7320 it
->prev_stop
= it
->stop_charpos
;
7322 it
->prev_stop
= BEGV
;
7324 it
->current
= save_current
;
7325 it
->position
= save_position
;
7326 it
->stop_charpos
= save_stop_pos
;
7327 it
->end_charpos
= save_end_pos
;
7330 /* Scan forward from CHARPOS in the current buffer/string, until we
7331 find a stop position > current IT's position. Then handle the stop
7332 position before that. This is called when we bump into a stop
7333 position while reordering bidirectional text. CHARPOS should be
7334 the last previously processed stop_pos (or BEGV/0, if none were
7335 processed yet) whose position is less that IT's current
7339 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7341 int bufp
= !STRINGP (it
->string
);
7342 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7343 struct display_pos save_current
= it
->current
;
7344 struct text_pos save_position
= it
->position
;
7345 struct text_pos pos1
;
7346 EMACS_INT next_stop
;
7348 /* Scan in strict logical order. */
7349 xassert (it
->bidi_p
);
7353 it
->prev_stop
= charpos
;
7356 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7357 reseat_1 (it
, pos1
, 0);
7360 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7361 compute_stop_pos (it
);
7362 /* We must advance forward, right? */
7363 if (it
->stop_charpos
<= it
->prev_stop
)
7365 charpos
= it
->stop_charpos
;
7367 while (charpos
<= where_we_are
);
7370 it
->current
= save_current
;
7371 it
->position
= save_position
;
7372 next_stop
= it
->stop_charpos
;
7373 it
->stop_charpos
= it
->prev_stop
;
7375 it
->stop_charpos
= next_stop
;
7378 /* Load IT with the next display element from current_buffer. Value
7379 is zero if end of buffer reached. IT->stop_charpos is the next
7380 position at which to stop and check for text properties or buffer
7384 next_element_from_buffer (struct it
*it
)
7388 xassert (IT_CHARPOS (*it
) >= BEGV
);
7389 xassert (NILP (it
->string
) && !it
->s
);
7390 xassert (!it
->bidi_p
7391 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7392 && it
->bidi_it
.string
.s
== NULL
));
7394 /* With bidi reordering, the character to display might not be the
7395 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7396 we were reseat()ed to a new buffer position, which is potentially
7397 a different paragraph. */
7398 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7400 get_visually_first_element (it
);
7401 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7404 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7406 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7408 int overlay_strings_follow_p
;
7410 /* End of the game, except when overlay strings follow that
7411 haven't been returned yet. */
7412 if (it
->overlay_strings_at_end_processed_p
)
7413 overlay_strings_follow_p
= 0;
7416 it
->overlay_strings_at_end_processed_p
= 1;
7417 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7420 if (overlay_strings_follow_p
)
7421 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7425 it
->position
= it
->current
.pos
;
7429 else if (!(!it
->bidi_p
7430 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7431 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7433 /* With bidi non-linear iteration, we could find ourselves
7434 far beyond the last computed stop_charpos, with several
7435 other stop positions in between that we missed. Scan
7436 them all now, in buffer's logical order, until we find
7437 and handle the last stop_charpos that precedes our
7438 current position. */
7439 handle_stop_backwards (it
, it
->stop_charpos
);
7440 return GET_NEXT_DISPLAY_ELEMENT (it
);
7446 /* Take note of the stop position we just moved across,
7447 for when we will move back across it. */
7448 it
->prev_stop
= it
->stop_charpos
;
7449 /* If we are at base paragraph embedding level, take
7450 note of the last stop position seen at this
7452 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7453 it
->base_level_stop
= it
->stop_charpos
;
7456 return GET_NEXT_DISPLAY_ELEMENT (it
);
7460 /* If we are before prev_stop, we may have overstepped on
7461 our way backwards a stop_pos, and if so, we need to
7462 handle that stop_pos. */
7463 && IT_CHARPOS (*it
) < it
->prev_stop
7464 /* We can sometimes back up for reasons that have nothing
7465 to do with bidi reordering. E.g., compositions. The
7466 code below is only needed when we are above the base
7467 embedding level, so test for that explicitly. */
7468 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7470 if (it
->base_level_stop
<= 0
7471 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7473 /* If we lost track of base_level_stop, we need to find
7474 prev_stop by looking backwards. This happens, e.g., when
7475 we were reseated to the previous screenful of text by
7477 it
->base_level_stop
= BEGV
;
7478 compute_stop_pos_backwards (it
);
7479 handle_stop_backwards (it
, it
->prev_stop
);
7482 handle_stop_backwards (it
, it
->base_level_stop
);
7483 return GET_NEXT_DISPLAY_ELEMENT (it
);
7487 /* No face changes, overlays etc. in sight, so just return a
7488 character from current_buffer. */
7492 /* Maybe run the redisplay end trigger hook. Performance note:
7493 This doesn't seem to cost measurable time. */
7494 if (it
->redisplay_end_trigger_charpos
7496 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7497 run_redisplay_end_trigger_hook (it
);
7499 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7500 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7502 && next_element_from_composition (it
))
7507 /* Get the next character, maybe multibyte. */
7508 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7509 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7510 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7512 it
->c
= *p
, it
->len
= 1;
7514 /* Record what we have and where it came from. */
7515 it
->what
= IT_CHARACTER
;
7516 it
->object
= it
->w
->buffer
;
7517 it
->position
= it
->current
.pos
;
7519 /* Normally we return the character found above, except when we
7520 really want to return an ellipsis for selective display. */
7525 /* A value of selective > 0 means hide lines indented more
7526 than that number of columns. */
7527 if (it
->selective
> 0
7528 && IT_CHARPOS (*it
) + 1 < ZV
7529 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7530 IT_BYTEPOS (*it
) + 1,
7533 success_p
= next_element_from_ellipsis (it
);
7534 it
->dpvec_char_len
= -1;
7537 else if (it
->c
== '\r' && it
->selective
== -1)
7539 /* A value of selective == -1 means that everything from the
7540 CR to the end of the line is invisible, with maybe an
7541 ellipsis displayed for it. */
7542 success_p
= next_element_from_ellipsis (it
);
7543 it
->dpvec_char_len
= -1;
7548 /* Value is zero if end of buffer reached. */
7549 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7554 /* Run the redisplay end trigger hook for IT. */
7557 run_redisplay_end_trigger_hook (struct it
*it
)
7559 Lisp_Object args
[3];
7561 /* IT->glyph_row should be non-null, i.e. we should be actually
7562 displaying something, or otherwise we should not run the hook. */
7563 xassert (it
->glyph_row
);
7565 /* Set up hook arguments. */
7566 args
[0] = Qredisplay_end_trigger_functions
;
7567 args
[1] = it
->window
;
7568 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7569 it
->redisplay_end_trigger_charpos
= 0;
7571 /* Since we are *trying* to run these functions, don't try to run
7572 them again, even if they get an error. */
7573 it
->w
->redisplay_end_trigger
= Qnil
;
7574 Frun_hook_with_args (3, args
);
7576 /* Notice if it changed the face of the character we are on. */
7577 handle_face_prop (it
);
7581 /* Deliver a composition display element. Unlike the other
7582 next_element_from_XXX, this function is not registered in the array
7583 get_next_element[]. It is called from next_element_from_buffer and
7584 next_element_from_string when necessary. */
7587 next_element_from_composition (struct it
*it
)
7589 it
->what
= IT_COMPOSITION
;
7590 it
->len
= it
->cmp_it
.nbytes
;
7591 if (STRINGP (it
->string
))
7595 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7596 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7599 it
->position
= it
->current
.string_pos
;
7600 it
->object
= it
->string
;
7601 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7602 IT_STRING_BYTEPOS (*it
), it
->string
);
7608 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7609 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7612 if (it
->bidi_it
.new_paragraph
)
7613 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7614 /* Resync the bidi iterator with IT's new position.
7615 FIXME: this doesn't support bidirectional text. */
7616 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7617 bidi_move_to_visually_next (&it
->bidi_it
);
7621 it
->position
= it
->current
.pos
;
7622 it
->object
= it
->w
->buffer
;
7623 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7624 IT_BYTEPOS (*it
), Qnil
);
7631 /***********************************************************************
7632 Moving an iterator without producing glyphs
7633 ***********************************************************************/
7635 /* Check if iterator is at a position corresponding to a valid buffer
7636 position after some move_it_ call. */
7638 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7639 ((it)->method == GET_FROM_STRING \
7640 ? IT_STRING_CHARPOS (*it) == 0 \
7644 /* Move iterator IT to a specified buffer or X position within one
7645 line on the display without producing glyphs.
7647 OP should be a bit mask including some or all of these bits:
7648 MOVE_TO_X: Stop upon reaching x-position TO_X.
7649 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7650 Regardless of OP's value, stop upon reaching the end of the display line.
7652 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7653 This means, in particular, that TO_X includes window's horizontal
7656 The return value has several possible values that
7657 say what condition caused the scan to stop:
7659 MOVE_POS_MATCH_OR_ZV
7660 - when TO_POS or ZV was reached.
7663 -when TO_X was reached before TO_POS or ZV were reached.
7666 - when we reached the end of the display area and the line must
7670 - when we reached the end of the display area and the line is
7674 - when we stopped at a line end, i.e. a newline or a CR and selective
7677 static enum move_it_result
7678 move_it_in_display_line_to (struct it
*it
,
7679 EMACS_INT to_charpos
, int to_x
,
7680 enum move_operation_enum op
)
7682 enum move_it_result result
= MOVE_UNDEFINED
;
7683 struct glyph_row
*saved_glyph_row
;
7684 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7685 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7686 void *ppos_data
= NULL
;
7688 enum it_method prev_method
= it
->method
;
7689 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7690 int saw_smaller_pos
= prev_pos
< to_charpos
;
7692 /* Don't produce glyphs in produce_glyphs. */
7693 saved_glyph_row
= it
->glyph_row
;
7694 it
->glyph_row
= NULL
;
7696 /* Use wrap_it to save a copy of IT wherever a word wrap could
7697 occur. Use atpos_it to save a copy of IT at the desired buffer
7698 position, if found, so that we can scan ahead and check if the
7699 word later overshoots the window edge. Use atx_it similarly, for
7705 /* Use ppos_it under bidi reordering to save a copy of IT for the
7706 position > CHARPOS that is the closest to CHARPOS. We restore
7707 that position in IT when we have scanned the entire display line
7708 without finding a match for CHARPOS and all the character
7709 positions are greater than CHARPOS. */
7712 SAVE_IT (ppos_it
, *it
, ppos_data
);
7713 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7714 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7715 SAVE_IT (ppos_it
, *it
, ppos_data
);
7718 #define BUFFER_POS_REACHED_P() \
7719 ((op & MOVE_TO_POS) != 0 \
7720 && BUFFERP (it->object) \
7721 && (IT_CHARPOS (*it) == to_charpos \
7722 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos) \
7723 || (it->what == IT_COMPOSITION \
7724 && ((IT_CHARPOS (*it) > to_charpos \
7725 && to_charpos >= it->cmp_it.charpos) \
7726 || (IT_CHARPOS (*it) < to_charpos \
7727 && to_charpos <= it->cmp_it.charpos)))) \
7728 && (it->method == GET_FROM_BUFFER \
7729 || (it->method == GET_FROM_DISPLAY_VECTOR \
7730 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7732 /* If there's a line-/wrap-prefix, handle it. */
7733 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7734 && it
->current_y
< it
->last_visible_y
)
7735 handle_line_prefix (it
);
7737 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7738 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7742 int x
, i
, ascent
= 0, descent
= 0;
7744 /* Utility macro to reset an iterator with x, ascent, and descent. */
7745 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7746 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7747 (IT)->max_descent = descent)
7749 /* Stop if we move beyond TO_CHARPOS (after an image or a
7750 display string or stretch glyph). */
7751 if ((op
& MOVE_TO_POS
) != 0
7752 && BUFFERP (it
->object
)
7753 && it
->method
== GET_FROM_BUFFER
7754 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7756 && (prev_method
== GET_FROM_IMAGE
7757 || prev_method
== GET_FROM_STRETCH
7758 || prev_method
== GET_FROM_STRING
)
7759 /* Passed TO_CHARPOS from left to right. */
7760 && ((prev_pos
< to_charpos
7761 && IT_CHARPOS (*it
) > to_charpos
)
7762 /* Passed TO_CHARPOS from right to left. */
7763 || (prev_pos
> to_charpos
7764 && IT_CHARPOS (*it
) < to_charpos
)))))
7766 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7768 result
= MOVE_POS_MATCH_OR_ZV
;
7771 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7772 /* If wrap_it is valid, the current position might be in a
7773 word that is wrapped. So, save the iterator in
7774 atpos_it and continue to see if wrapping happens. */
7775 SAVE_IT (atpos_it
, *it
, atpos_data
);
7778 /* Stop when ZV reached.
7779 We used to stop here when TO_CHARPOS reached as well, but that is
7780 too soon if this glyph does not fit on this line. So we handle it
7781 explicitly below. */
7782 if (!get_next_display_element (it
))
7784 result
= MOVE_POS_MATCH_OR_ZV
;
7788 if (it
->line_wrap
== TRUNCATE
)
7790 if (BUFFER_POS_REACHED_P ())
7792 result
= MOVE_POS_MATCH_OR_ZV
;
7798 if (it
->line_wrap
== WORD_WRAP
)
7800 if (IT_DISPLAYING_WHITESPACE (it
))
7804 /* We have reached a glyph that follows one or more
7805 whitespace characters. If the position is
7806 already found, we are done. */
7807 if (atpos_it
.sp
>= 0)
7809 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7810 result
= MOVE_POS_MATCH_OR_ZV
;
7815 RESTORE_IT (it
, &atx_it
, atx_data
);
7816 result
= MOVE_X_REACHED
;
7819 /* Otherwise, we can wrap here. */
7820 SAVE_IT (wrap_it
, *it
, wrap_data
);
7826 /* Remember the line height for the current line, in case
7827 the next element doesn't fit on the line. */
7828 ascent
= it
->max_ascent
;
7829 descent
= it
->max_descent
;
7831 /* The call to produce_glyphs will get the metrics of the
7832 display element IT is loaded with. Record the x-position
7833 before this display element, in case it doesn't fit on the
7837 PRODUCE_GLYPHS (it
);
7839 if (it
->area
!= TEXT_AREA
)
7841 prev_method
= it
->method
;
7842 if (it
->method
== GET_FROM_BUFFER
)
7843 prev_pos
= IT_CHARPOS (*it
);
7844 set_iterator_to_next (it
, 1);
7845 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7846 SET_TEXT_POS (this_line_min_pos
,
7847 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7849 && (op
& MOVE_TO_POS
)
7850 && IT_CHARPOS (*it
) > to_charpos
7851 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7852 SAVE_IT (ppos_it
, *it
, ppos_data
);
7856 /* The number of glyphs we get back in IT->nglyphs will normally
7857 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7858 character on a terminal frame, or (iii) a line end. For the
7859 second case, IT->nglyphs - 1 padding glyphs will be present.
7860 (On X frames, there is only one glyph produced for a
7861 composite character.)
7863 The behavior implemented below means, for continuation lines,
7864 that as many spaces of a TAB as fit on the current line are
7865 displayed there. For terminal frames, as many glyphs of a
7866 multi-glyph character are displayed in the current line, too.
7867 This is what the old redisplay code did, and we keep it that
7868 way. Under X, the whole shape of a complex character must
7869 fit on the line or it will be completely displayed in the
7872 Note that both for tabs and padding glyphs, all glyphs have
7876 /* More than one glyph or glyph doesn't fit on line. All
7877 glyphs have the same width. */
7878 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7880 int x_before_this_char
= x
;
7881 int hpos_before_this_char
= it
->hpos
;
7883 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7885 new_x
= x
+ single_glyph_width
;
7887 /* We want to leave anything reaching TO_X to the caller. */
7888 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7890 if (BUFFER_POS_REACHED_P ())
7892 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7893 goto buffer_pos_reached
;
7894 if (atpos_it
.sp
< 0)
7896 SAVE_IT (atpos_it
, *it
, atpos_data
);
7897 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7902 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7905 result
= MOVE_X_REACHED
;
7910 SAVE_IT (atx_it
, *it
, atx_data
);
7911 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7916 if (/* Lines are continued. */
7917 it
->line_wrap
!= TRUNCATE
7918 && (/* And glyph doesn't fit on the line. */
7919 new_x
> it
->last_visible_x
7920 /* Or it fits exactly and we're on a window
7922 || (new_x
== it
->last_visible_x
7923 && FRAME_WINDOW_P (it
->f
))))
7925 if (/* IT->hpos == 0 means the very first glyph
7926 doesn't fit on the line, e.g. a wide image. */
7928 || (new_x
== it
->last_visible_x
7929 && FRAME_WINDOW_P (it
->f
)))
7932 it
->current_x
= new_x
;
7934 /* The character's last glyph just barely fits
7936 if (i
== it
->nglyphs
- 1)
7938 /* If this is the destination position,
7939 return a position *before* it in this row,
7940 now that we know it fits in this row. */
7941 if (BUFFER_POS_REACHED_P ())
7943 if (it
->line_wrap
!= WORD_WRAP
7946 it
->hpos
= hpos_before_this_char
;
7947 it
->current_x
= x_before_this_char
;
7948 result
= MOVE_POS_MATCH_OR_ZV
;
7951 if (it
->line_wrap
== WORD_WRAP
7954 SAVE_IT (atpos_it
, *it
, atpos_data
);
7955 atpos_it
.current_x
= x_before_this_char
;
7956 atpos_it
.hpos
= hpos_before_this_char
;
7960 prev_method
= it
->method
;
7961 if (it
->method
== GET_FROM_BUFFER
)
7962 prev_pos
= IT_CHARPOS (*it
);
7963 set_iterator_to_next (it
, 1);
7964 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7965 SET_TEXT_POS (this_line_min_pos
,
7966 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7967 /* On graphical terminals, newlines may
7968 "overflow" into the fringe if
7969 overflow-newline-into-fringe is non-nil.
7970 On text-only terminals, newlines may
7971 overflow into the last glyph on the
7973 if (!FRAME_WINDOW_P (it
->f
)
7974 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7976 if (!get_next_display_element (it
))
7978 result
= MOVE_POS_MATCH_OR_ZV
;
7981 if (BUFFER_POS_REACHED_P ())
7983 if (ITERATOR_AT_END_OF_LINE_P (it
))
7984 result
= MOVE_POS_MATCH_OR_ZV
;
7986 result
= MOVE_LINE_CONTINUED
;
7989 if (ITERATOR_AT_END_OF_LINE_P (it
))
7991 result
= MOVE_NEWLINE_OR_CR
;
7998 IT_RESET_X_ASCENT_DESCENT (it
);
8000 if (wrap_it
.sp
>= 0)
8002 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8007 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8009 result
= MOVE_LINE_CONTINUED
;
8013 if (BUFFER_POS_REACHED_P ())
8015 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8016 goto buffer_pos_reached
;
8017 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8019 SAVE_IT (atpos_it
, *it
, atpos_data
);
8020 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8024 if (new_x
> it
->first_visible_x
)
8026 /* Glyph is visible. Increment number of glyphs that
8027 would be displayed. */
8032 if (result
!= MOVE_UNDEFINED
)
8035 else if (BUFFER_POS_REACHED_P ())
8038 IT_RESET_X_ASCENT_DESCENT (it
);
8039 result
= MOVE_POS_MATCH_OR_ZV
;
8042 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8044 /* Stop when TO_X specified and reached. This check is
8045 necessary here because of lines consisting of a line end,
8046 only. The line end will not produce any glyphs and we
8047 would never get MOVE_X_REACHED. */
8048 xassert (it
->nglyphs
== 0);
8049 result
= MOVE_X_REACHED
;
8053 /* Is this a line end? If yes, we're done. */
8054 if (ITERATOR_AT_END_OF_LINE_P (it
))
8056 /* If we are past TO_CHARPOS, but never saw any character
8057 positions smaller than TO_CHARPOS, return
8058 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8060 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8062 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8064 if (IT_CHARPOS (ppos_it
) < ZV
)
8066 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8067 result
= MOVE_POS_MATCH_OR_ZV
;
8070 goto buffer_pos_reached
;
8072 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8073 && IT_CHARPOS (*it
) > to_charpos
)
8074 goto buffer_pos_reached
;
8076 result
= MOVE_NEWLINE_OR_CR
;
8079 result
= MOVE_NEWLINE_OR_CR
;
8083 prev_method
= it
->method
;
8084 if (it
->method
== GET_FROM_BUFFER
)
8085 prev_pos
= IT_CHARPOS (*it
);
8086 /* The current display element has been consumed. Advance
8088 set_iterator_to_next (it
, 1);
8089 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8090 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8091 if (IT_CHARPOS (*it
) < to_charpos
)
8092 saw_smaller_pos
= 1;
8094 && (op
& MOVE_TO_POS
)
8095 && IT_CHARPOS (*it
) >= to_charpos
8096 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8097 SAVE_IT (ppos_it
, *it
, ppos_data
);
8099 /* Stop if lines are truncated and IT's current x-position is
8100 past the right edge of the window now. */
8101 if (it
->line_wrap
== TRUNCATE
8102 && it
->current_x
>= it
->last_visible_x
)
8104 if (!FRAME_WINDOW_P (it
->f
)
8105 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8109 if ((at_eob_p
= !get_next_display_element (it
))
8110 || BUFFER_POS_REACHED_P ()
8111 /* If we are past TO_CHARPOS, but never saw any
8112 character positions smaller than TO_CHARPOS,
8113 return MOVE_POS_MATCH_OR_ZV, like the
8114 unidirectional display did. */
8115 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8117 && IT_CHARPOS (*it
) > to_charpos
))
8119 if (!at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8120 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8121 result
= MOVE_POS_MATCH_OR_ZV
;
8124 if (ITERATOR_AT_END_OF_LINE_P (it
))
8126 result
= MOVE_NEWLINE_OR_CR
;
8130 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8132 && IT_CHARPOS (*it
) > to_charpos
)
8134 if (IT_CHARPOS (ppos_it
) < ZV
)
8135 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8136 result
= MOVE_POS_MATCH_OR_ZV
;
8139 result
= MOVE_LINE_TRUNCATED
;
8142 #undef IT_RESET_X_ASCENT_DESCENT
8145 #undef BUFFER_POS_REACHED_P
8147 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8148 restore the saved iterator. */
8149 if (atpos_it
.sp
>= 0)
8150 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8151 else if (atx_it
.sp
>= 0)
8152 RESTORE_IT (it
, &atx_it
, atx_data
);
8157 bidi_unshelve_cache (atpos_data
, 1);
8159 bidi_unshelve_cache (atx_data
, 1);
8161 bidi_unshelve_cache (wrap_data
, 1);
8163 bidi_unshelve_cache (ppos_data
, 1);
8165 /* Restore the iterator settings altered at the beginning of this
8167 it
->glyph_row
= saved_glyph_row
;
8171 /* For external use. */
8173 move_it_in_display_line (struct it
*it
,
8174 EMACS_INT to_charpos
, int to_x
,
8175 enum move_operation_enum op
)
8177 if (it
->line_wrap
== WORD_WRAP
8178 && (op
& MOVE_TO_X
))
8181 void *save_data
= NULL
;
8184 SAVE_IT (save_it
, *it
, save_data
);
8185 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8186 /* When word-wrap is on, TO_X may lie past the end
8187 of a wrapped line. Then it->current is the
8188 character on the next line, so backtrack to the
8189 space before the wrap point. */
8190 if (skip
== MOVE_LINE_CONTINUED
)
8192 int prev_x
= max (it
->current_x
- 1, 0);
8193 RESTORE_IT (it
, &save_it
, save_data
);
8194 move_it_in_display_line_to
8195 (it
, -1, prev_x
, MOVE_TO_X
);
8198 bidi_unshelve_cache (save_data
, 1);
8201 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8205 /* Move IT forward until it satisfies one or more of the criteria in
8206 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8208 OP is a bit-mask that specifies where to stop, and in particular,
8209 which of those four position arguments makes a difference. See the
8210 description of enum move_operation_enum.
8212 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8213 screen line, this function will set IT to the next position that is
8214 displayed to the right of TO_CHARPOS on the screen. */
8217 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8219 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8220 int line_height
, line_start_x
= 0, reached
= 0;
8221 void *backup_data
= NULL
;
8225 if (op
& MOVE_TO_VPOS
)
8227 /* If no TO_CHARPOS and no TO_X specified, stop at the
8228 start of the line TO_VPOS. */
8229 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8231 if (it
->vpos
== to_vpos
)
8237 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8241 /* TO_VPOS >= 0 means stop at TO_X in the line at
8242 TO_VPOS, or at TO_POS, whichever comes first. */
8243 if (it
->vpos
== to_vpos
)
8249 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8251 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8256 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8258 /* We have reached TO_X but not in the line we want. */
8259 skip
= move_it_in_display_line_to (it
, to_charpos
,
8261 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8269 else if (op
& MOVE_TO_Y
)
8271 struct it it_backup
;
8273 if (it
->line_wrap
== WORD_WRAP
)
8274 SAVE_IT (it_backup
, *it
, backup_data
);
8276 /* TO_Y specified means stop at TO_X in the line containing
8277 TO_Y---or at TO_CHARPOS if this is reached first. The
8278 problem is that we can't really tell whether the line
8279 contains TO_Y before we have completely scanned it, and
8280 this may skip past TO_X. What we do is to first scan to
8283 If TO_X is not specified, use a TO_X of zero. The reason
8284 is to make the outcome of this function more predictable.
8285 If we didn't use TO_X == 0, we would stop at the end of
8286 the line which is probably not what a caller would expect
8288 skip
= move_it_in_display_line_to
8289 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8290 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8292 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8293 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8295 else if (skip
== MOVE_X_REACHED
)
8297 /* If TO_X was reached, we want to know whether TO_Y is
8298 in the line. We know this is the case if the already
8299 scanned glyphs make the line tall enough. Otherwise,
8300 we must check by scanning the rest of the line. */
8301 line_height
= it
->max_ascent
+ it
->max_descent
;
8302 if (to_y
>= it
->current_y
8303 && to_y
< it
->current_y
+ line_height
)
8308 SAVE_IT (it_backup
, *it
, backup_data
);
8309 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8310 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8312 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8313 line_height
= it
->max_ascent
+ it
->max_descent
;
8314 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8316 if (to_y
>= it
->current_y
8317 && to_y
< it
->current_y
+ line_height
)
8319 /* If TO_Y is in this line and TO_X was reached
8320 above, we scanned too far. We have to restore
8321 IT's settings to the ones before skipping. */
8322 RESTORE_IT (it
, &it_backup
, backup_data
);
8328 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8334 /* Check whether TO_Y is in this line. */
8335 line_height
= it
->max_ascent
+ it
->max_descent
;
8336 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8338 if (to_y
>= it
->current_y
8339 && to_y
< it
->current_y
+ line_height
)
8341 /* When word-wrap is on, TO_X may lie past the end
8342 of a wrapped line. Then it->current is the
8343 character on the next line, so backtrack to the
8344 space before the wrap point. */
8345 if (skip
== MOVE_LINE_CONTINUED
8346 && it
->line_wrap
== WORD_WRAP
)
8348 int prev_x
= max (it
->current_x
- 1, 0);
8349 RESTORE_IT (it
, &it_backup
, backup_data
);
8350 skip
= move_it_in_display_line_to
8351 (it
, -1, prev_x
, MOVE_TO_X
);
8360 else if (BUFFERP (it
->object
)
8361 && (it
->method
== GET_FROM_BUFFER
8362 || it
->method
== GET_FROM_STRETCH
)
8363 && IT_CHARPOS (*it
) >= to_charpos
8364 /* Under bidi iteration, a call to set_iterator_to_next
8365 can scan far beyond to_charpos if the initial
8366 portion of the next line needs to be reordered. In
8367 that case, give move_it_in_display_line_to another
8370 && it
->bidi_it
.scan_dir
== -1))
8371 skip
= MOVE_POS_MATCH_OR_ZV
;
8373 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8377 case MOVE_POS_MATCH_OR_ZV
:
8381 case MOVE_NEWLINE_OR_CR
:
8382 set_iterator_to_next (it
, 1);
8383 it
->continuation_lines_width
= 0;
8386 case MOVE_LINE_TRUNCATED
:
8387 it
->continuation_lines_width
= 0;
8388 reseat_at_next_visible_line_start (it
, 0);
8389 if ((op
& MOVE_TO_POS
) != 0
8390 && IT_CHARPOS (*it
) > to_charpos
)
8397 case MOVE_LINE_CONTINUED
:
8398 /* For continued lines ending in a tab, some of the glyphs
8399 associated with the tab are displayed on the current
8400 line. Since it->current_x does not include these glyphs,
8401 we use it->last_visible_x instead. */
8404 it
->continuation_lines_width
+= it
->last_visible_x
;
8405 /* When moving by vpos, ensure that the iterator really
8406 advances to the next line (bug#847, bug#969). Fixme:
8407 do we need to do this in other circumstances? */
8408 if (it
->current_x
!= it
->last_visible_x
8409 && (op
& MOVE_TO_VPOS
)
8410 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8412 line_start_x
= it
->current_x
+ it
->pixel_width
8413 - it
->last_visible_x
;
8414 set_iterator_to_next (it
, 0);
8418 it
->continuation_lines_width
+= it
->current_x
;
8425 /* Reset/increment for the next run. */
8426 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8427 it
->current_x
= line_start_x
;
8430 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8432 last_height
= it
->max_ascent
+ it
->max_descent
;
8433 last_max_ascent
= it
->max_ascent
;
8434 it
->max_ascent
= it
->max_descent
= 0;
8439 /* On text terminals, we may stop at the end of a line in the middle
8440 of a multi-character glyph. If the glyph itself is continued,
8441 i.e. it is actually displayed on the next line, don't treat this
8442 stopping point as valid; move to the next line instead (unless
8443 that brings us offscreen). */
8444 if (!FRAME_WINDOW_P (it
->f
)
8446 && IT_CHARPOS (*it
) == to_charpos
8447 && it
->what
== IT_CHARACTER
8449 && it
->line_wrap
== WINDOW_WRAP
8450 && it
->current_x
== it
->last_visible_x
- 1
8453 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8455 it
->continuation_lines_width
+= it
->current_x
;
8456 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8457 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8459 last_height
= it
->max_ascent
+ it
->max_descent
;
8460 last_max_ascent
= it
->max_ascent
;
8464 bidi_unshelve_cache (backup_data
, 1);
8466 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8470 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8472 If DY > 0, move IT backward at least that many pixels. DY = 0
8473 means move IT backward to the preceding line start or BEGV. This
8474 function may move over more than DY pixels if IT->current_y - DY
8475 ends up in the middle of a line; in this case IT->current_y will be
8476 set to the top of the line moved to. */
8479 move_it_vertically_backward (struct it
*it
, int dy
)
8483 void *it2data
= NULL
, *it3data
= NULL
;
8484 EMACS_INT start_pos
;
8489 start_pos
= IT_CHARPOS (*it
);
8491 /* Estimate how many newlines we must move back. */
8492 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8494 /* Set the iterator's position that many lines back. */
8495 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8496 back_to_previous_visible_line_start (it
);
8498 /* Reseat the iterator here. When moving backward, we don't want
8499 reseat to skip forward over invisible text, set up the iterator
8500 to deliver from overlay strings at the new position etc. So,
8501 use reseat_1 here. */
8502 reseat_1 (it
, it
->current
.pos
, 1);
8504 /* We are now surely at a line start. */
8505 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8506 reordering is in effect. */
8507 it
->continuation_lines_width
= 0;
8509 /* Move forward and see what y-distance we moved. First move to the
8510 start of the next line so that we get its height. We need this
8511 height to be able to tell whether we reached the specified
8513 SAVE_IT (it2
, *it
, it2data
);
8514 it2
.max_ascent
= it2
.max_descent
= 0;
8517 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8518 MOVE_TO_POS
| MOVE_TO_VPOS
);
8520 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8521 xassert (IT_CHARPOS (*it
) >= BEGV
);
8522 SAVE_IT (it3
, it2
, it3data
);
8524 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8525 xassert (IT_CHARPOS (*it
) >= BEGV
);
8526 /* H is the actual vertical distance from the position in *IT
8527 and the starting position. */
8528 h
= it2
.current_y
- it
->current_y
;
8529 /* NLINES is the distance in number of lines. */
8530 nlines
= it2
.vpos
- it
->vpos
;
8532 /* Correct IT's y and vpos position
8533 so that they are relative to the starting point. */
8539 /* DY == 0 means move to the start of the screen line. The
8540 value of nlines is > 0 if continuation lines were involved,
8541 or if the original IT position was at start of a line. */
8542 RESTORE_IT (it
, it
, it2data
);
8544 move_it_by_lines (it
, nlines
);
8545 /* The above code moves us to some position NLINES down,
8546 usually to its first glyph (leftmost in an L2R line), but
8547 that's not necessarily the start of the line, under bidi
8548 reordering. We want to get to the character position
8549 that is immediately after the newline of the previous
8551 if (it
->bidi_p
&& IT_CHARPOS (*it
) > BEGV
8552 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8555 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8557 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8559 bidi_unshelve_cache (it3data
, 1);
8563 /* The y-position we try to reach, relative to *IT.
8564 Note that H has been subtracted in front of the if-statement. */
8565 int target_y
= it
->current_y
+ h
- dy
;
8566 int y0
= it3
.current_y
;
8570 RESTORE_IT (&it3
, &it3
, it3data
);
8571 y1
= line_bottom_y (&it3
);
8572 line_height
= y1
- y0
;
8573 RESTORE_IT (it
, it
, it2data
);
8574 /* If we did not reach target_y, try to move further backward if
8575 we can. If we moved too far backward, try to move forward. */
8576 if (target_y
< it
->current_y
8577 /* This is heuristic. In a window that's 3 lines high, with
8578 a line height of 13 pixels each, recentering with point
8579 on the bottom line will try to move -39/2 = 19 pixels
8580 backward. Try to avoid moving into the first line. */
8581 && (it
->current_y
- target_y
8582 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8583 && IT_CHARPOS (*it
) > BEGV
)
8585 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8586 target_y
- it
->current_y
));
8587 dy
= it
->current_y
- target_y
;
8588 goto move_further_back
;
8590 else if (target_y
>= it
->current_y
+ line_height
8591 && IT_CHARPOS (*it
) < ZV
)
8593 /* Should move forward by at least one line, maybe more.
8595 Note: Calling move_it_by_lines can be expensive on
8596 terminal frames, where compute_motion is used (via
8597 vmotion) to do the job, when there are very long lines
8598 and truncate-lines is nil. That's the reason for
8599 treating terminal frames specially here. */
8601 if (!FRAME_WINDOW_P (it
->f
))
8602 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8607 move_it_by_lines (it
, 1);
8609 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8616 /* Move IT by a specified amount of pixel lines DY. DY negative means
8617 move backwards. DY = 0 means move to start of screen line. At the
8618 end, IT will be on the start of a screen line. */
8621 move_it_vertically (struct it
*it
, int dy
)
8624 move_it_vertically_backward (it
, -dy
);
8627 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8628 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8629 MOVE_TO_POS
| MOVE_TO_Y
);
8630 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8632 /* If buffer ends in ZV without a newline, move to the start of
8633 the line to satisfy the post-condition. */
8634 if (IT_CHARPOS (*it
) == ZV
8636 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8637 move_it_by_lines (it
, 0);
8642 /* Move iterator IT past the end of the text line it is in. */
8645 move_it_past_eol (struct it
*it
)
8647 enum move_it_result rc
;
8649 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8650 if (rc
== MOVE_NEWLINE_OR_CR
)
8651 set_iterator_to_next (it
, 0);
8655 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8656 negative means move up. DVPOS == 0 means move to the start of the
8659 Optimization idea: If we would know that IT->f doesn't use
8660 a face with proportional font, we could be faster for
8661 truncate-lines nil. */
8664 move_it_by_lines (struct it
*it
, int dvpos
)
8667 /* The commented-out optimization uses vmotion on terminals. This
8668 gives bad results, because elements like it->what, on which
8669 callers such as pos_visible_p rely, aren't updated. */
8670 /* struct position pos;
8671 if (!FRAME_WINDOW_P (it->f))
8673 struct text_pos textpos;
8675 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8676 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8677 reseat (it, textpos, 1);
8678 it->vpos += pos.vpos;
8679 it->current_y += pos.vpos;
8685 /* DVPOS == 0 means move to the start of the screen line. */
8686 move_it_vertically_backward (it
, 0);
8687 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8688 /* Let next call to line_bottom_y calculate real line height */
8693 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8694 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8695 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8700 void *it2data
= NULL
;
8701 EMACS_INT start_charpos
, i
;
8703 /* Start at the beginning of the screen line containing IT's
8704 position. This may actually move vertically backwards,
8705 in case of overlays, so adjust dvpos accordingly. */
8707 move_it_vertically_backward (it
, 0);
8710 /* Go back -DVPOS visible lines and reseat the iterator there. */
8711 start_charpos
= IT_CHARPOS (*it
);
8712 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8713 back_to_previous_visible_line_start (it
);
8714 reseat (it
, it
->current
.pos
, 1);
8716 /* Move further back if we end up in a string or an image. */
8717 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8719 /* First try to move to start of display line. */
8721 move_it_vertically_backward (it
, 0);
8723 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8725 /* If start of line is still in string or image,
8726 move further back. */
8727 back_to_previous_visible_line_start (it
);
8728 reseat (it
, it
->current
.pos
, 1);
8732 it
->current_x
= it
->hpos
= 0;
8734 /* Above call may have moved too far if continuation lines
8735 are involved. Scan forward and see if it did. */
8736 SAVE_IT (it2
, *it
, it2data
);
8737 it2
.vpos
= it2
.current_y
= 0;
8738 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8739 it
->vpos
-= it2
.vpos
;
8740 it
->current_y
-= it2
.current_y
;
8741 it
->current_x
= it
->hpos
= 0;
8743 /* If we moved too far back, move IT some lines forward. */
8744 if (it2
.vpos
> -dvpos
)
8746 int delta
= it2
.vpos
+ dvpos
;
8748 RESTORE_IT (&it2
, &it2
, it2data
);
8749 SAVE_IT (it2
, *it
, it2data
);
8750 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8751 /* Move back again if we got too far ahead. */
8752 if (IT_CHARPOS (*it
) >= start_charpos
)
8753 RESTORE_IT (it
, &it2
, it2data
);
8755 bidi_unshelve_cache (it2data
, 1);
8758 RESTORE_IT (it
, it
, it2data
);
8762 /* Return 1 if IT points into the middle of a display vector. */
8765 in_display_vector_p (struct it
*it
)
8767 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8768 && it
->current
.dpvec_index
> 0
8769 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8773 /***********************************************************************
8775 ***********************************************************************/
8778 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8782 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8784 Lisp_Object args
[3];
8785 Lisp_Object msg
, fmt
;
8788 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8791 /* Do nothing if called asynchronously. Inserting text into
8792 a buffer may call after-change-functions and alike and
8793 that would means running Lisp asynchronously. */
8794 if (handling_signal
)
8798 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8800 args
[0] = fmt
= build_string (format
);
8803 msg
= Fformat (3, args
);
8805 len
= SBYTES (msg
) + 1;
8806 SAFE_ALLOCA (buffer
, char *, len
);
8807 memcpy (buffer
, SDATA (msg
), len
);
8809 message_dolog (buffer
, len
- 1, 1, 0);
8816 /* Output a newline in the *Messages* buffer if "needs" one. */
8819 message_log_maybe_newline (void)
8821 if (message_log_need_newline
)
8822 message_dolog ("", 0, 1, 0);
8826 /* Add a string M of length NBYTES to the message log, optionally
8827 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8828 nonzero, means interpret the contents of M as multibyte. This
8829 function calls low-level routines in order to bypass text property
8830 hooks, etc. which might not be safe to run.
8832 This may GC (insert may run before/after change hooks),
8833 so the buffer M must NOT point to a Lisp string. */
8836 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8838 const unsigned char *msg
= (const unsigned char *) m
;
8840 if (!NILP (Vmemory_full
))
8843 if (!NILP (Vmessage_log_max
))
8845 struct buffer
*oldbuf
;
8846 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8847 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8848 EMACS_INT point_at_end
= 0;
8849 EMACS_INT zv_at_end
= 0;
8850 Lisp_Object old_deactivate_mark
, tem
;
8851 struct gcpro gcpro1
;
8853 old_deactivate_mark
= Vdeactivate_mark
;
8854 oldbuf
= current_buffer
;
8855 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8856 BVAR (current_buffer
, undo_list
) = Qt
;
8858 oldpoint
= message_dolog_marker1
;
8859 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8860 oldbegv
= message_dolog_marker2
;
8861 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8862 oldzv
= message_dolog_marker3
;
8863 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8864 GCPRO1 (old_deactivate_mark
);
8872 BEGV_BYTE
= BEG_BYTE
;
8875 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8877 /* Insert the string--maybe converting multibyte to single byte
8878 or vice versa, so that all the text fits the buffer. */
8880 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8886 /* Convert a multibyte string to single-byte
8887 for the *Message* buffer. */
8888 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8890 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8891 work
[0] = (ASCII_CHAR_P (c
)
8893 : multibyte_char_to_unibyte (c
));
8894 insert_1_both (work
, 1, 1, 1, 0, 0);
8897 else if (! multibyte
8898 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8902 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8903 /* Convert a single-byte string to multibyte
8904 for the *Message* buffer. */
8905 for (i
= 0; i
< nbytes
; i
++)
8908 MAKE_CHAR_MULTIBYTE (c
);
8909 char_bytes
= CHAR_STRING (c
, str
);
8910 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8914 insert_1 (m
, nbytes
, 1, 0, 0);
8918 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8920 insert_1 ("\n", 1, 1, 0, 0);
8922 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8924 this_bol_byte
= PT_BYTE
;
8926 /* See if this line duplicates the previous one.
8927 If so, combine duplicates. */
8930 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8932 prev_bol_byte
= PT_BYTE
;
8934 dups
= message_log_check_duplicate (prev_bol_byte
,
8938 del_range_both (prev_bol
, prev_bol_byte
,
8939 this_bol
, this_bol_byte
, 0);
8942 char dupstr
[sizeof " [ times]"
8943 + INT_STRLEN_BOUND (printmax_t
)];
8946 /* If you change this format, don't forget to also
8947 change message_log_check_duplicate. */
8948 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8949 duplen
= strlen (dupstr
);
8950 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8951 insert_1 (dupstr
, duplen
, 1, 0, 1);
8956 /* If we have more than the desired maximum number of lines
8957 in the *Messages* buffer now, delete the oldest ones.
8958 This is safe because we don't have undo in this buffer. */
8960 if (NATNUMP (Vmessage_log_max
))
8962 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8963 -XFASTINT (Vmessage_log_max
) - 1, 0);
8964 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8967 BEGV
= XMARKER (oldbegv
)->charpos
;
8968 BEGV_BYTE
= marker_byte_position (oldbegv
);
8977 ZV
= XMARKER (oldzv
)->charpos
;
8978 ZV_BYTE
= marker_byte_position (oldzv
);
8982 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8984 /* We can't do Fgoto_char (oldpoint) because it will run some
8986 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8987 XMARKER (oldpoint
)->bytepos
);
8990 unchain_marker (XMARKER (oldpoint
));
8991 unchain_marker (XMARKER (oldbegv
));
8992 unchain_marker (XMARKER (oldzv
));
8994 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8995 set_buffer_internal (oldbuf
);
8997 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8998 message_log_need_newline
= !nlflag
;
8999 Vdeactivate_mark
= old_deactivate_mark
;
9004 /* We are at the end of the buffer after just having inserted a newline.
9005 (Note: We depend on the fact we won't be crossing the gap.)
9006 Check to see if the most recent message looks a lot like the previous one.
9007 Return 0 if different, 1 if the new one should just replace it, or a
9008 value N > 1 if we should also append " [N times]". */
9011 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9014 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9016 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9017 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9019 for (i
= 0; i
< len
; i
++)
9021 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9029 if (*p1
++ == ' ' && *p1
++ == '[')
9032 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9033 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9040 /* Display an echo area message M with a specified length of NBYTES
9041 bytes. The string may include null characters. If M is 0, clear
9042 out any existing message, and let the mini-buffer text show
9045 This may GC, so the buffer M must NOT point to a Lisp string. */
9048 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9050 /* First flush out any partial line written with print. */
9051 message_log_maybe_newline ();
9053 message_dolog (m
, nbytes
, 1, multibyte
);
9054 message2_nolog (m
, nbytes
, multibyte
);
9058 /* The non-logging counterpart of message2. */
9061 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9063 struct frame
*sf
= SELECTED_FRAME ();
9064 message_enable_multibyte
= multibyte
;
9066 if (FRAME_INITIAL_P (sf
))
9068 if (noninteractive_need_newline
)
9069 putc ('\n', stderr
);
9070 noninteractive_need_newline
= 0;
9072 fwrite (m
, nbytes
, 1, stderr
);
9073 if (cursor_in_echo_area
== 0)
9074 fprintf (stderr
, "\n");
9077 /* A null message buffer means that the frame hasn't really been
9078 initialized yet. Error messages get reported properly by
9079 cmd_error, so this must be just an informative message; toss it. */
9080 else if (INTERACTIVE
9081 && sf
->glyphs_initialized_p
9082 && FRAME_MESSAGE_BUF (sf
))
9084 Lisp_Object mini_window
;
9087 /* Get the frame containing the mini-buffer
9088 that the selected frame is using. */
9089 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9090 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9092 FRAME_SAMPLE_VISIBILITY (f
);
9093 if (FRAME_VISIBLE_P (sf
)
9094 && ! FRAME_VISIBLE_P (f
))
9095 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9099 set_message (m
, Qnil
, nbytes
, multibyte
);
9100 if (minibuffer_auto_raise
)
9101 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9104 clear_message (1, 1);
9106 do_pending_window_change (0);
9107 echo_area_display (1);
9108 do_pending_window_change (0);
9109 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9110 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9115 /* Display an echo area message M with a specified length of NBYTES
9116 bytes. The string may include null characters. If M is not a
9117 string, clear out any existing message, and let the mini-buffer
9120 This function cancels echoing. */
9123 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9125 struct gcpro gcpro1
;
9128 clear_message (1,1);
9131 /* First flush out any partial line written with print. */
9132 message_log_maybe_newline ();
9138 SAFE_ALLOCA (buffer
, char *, nbytes
);
9139 memcpy (buffer
, SDATA (m
), nbytes
);
9140 message_dolog (buffer
, nbytes
, 1, multibyte
);
9143 message3_nolog (m
, nbytes
, multibyte
);
9149 /* The non-logging version of message3.
9150 This does not cancel echoing, because it is used for echoing.
9151 Perhaps we need to make a separate function for echoing
9152 and make this cancel echoing. */
9155 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9157 struct frame
*sf
= SELECTED_FRAME ();
9158 message_enable_multibyte
= multibyte
;
9160 if (FRAME_INITIAL_P (sf
))
9162 if (noninteractive_need_newline
)
9163 putc ('\n', stderr
);
9164 noninteractive_need_newline
= 0;
9166 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9167 if (cursor_in_echo_area
== 0)
9168 fprintf (stderr
, "\n");
9171 /* A null message buffer means that the frame hasn't really been
9172 initialized yet. Error messages get reported properly by
9173 cmd_error, so this must be just an informative message; toss it. */
9174 else if (INTERACTIVE
9175 && sf
->glyphs_initialized_p
9176 && FRAME_MESSAGE_BUF (sf
))
9178 Lisp_Object mini_window
;
9182 /* Get the frame containing the mini-buffer
9183 that the selected frame is using. */
9184 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9185 frame
= XWINDOW (mini_window
)->frame
;
9188 FRAME_SAMPLE_VISIBILITY (f
);
9189 if (FRAME_VISIBLE_P (sf
)
9190 && !FRAME_VISIBLE_P (f
))
9191 Fmake_frame_visible (frame
);
9193 if (STRINGP (m
) && SCHARS (m
) > 0)
9195 set_message (NULL
, m
, nbytes
, multibyte
);
9196 if (minibuffer_auto_raise
)
9197 Fraise_frame (frame
);
9198 /* Assume we are not echoing.
9199 (If we are, echo_now will override this.) */
9200 echo_message_buffer
= Qnil
;
9203 clear_message (1, 1);
9205 do_pending_window_change (0);
9206 echo_area_display (1);
9207 do_pending_window_change (0);
9208 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9209 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9214 /* Display a null-terminated echo area message M. If M is 0, clear
9215 out any existing message, and let the mini-buffer text show through.
9217 The buffer M must continue to exist until after the echo area gets
9218 cleared or some other message gets displayed there. Do not pass
9219 text that is stored in a Lisp string. Do not pass text in a buffer
9220 that was alloca'd. */
9223 message1 (const char *m
)
9225 message2 (m
, (m
? strlen (m
) : 0), 0);
9229 /* The non-logging counterpart of message1. */
9232 message1_nolog (const char *m
)
9234 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9237 /* Display a message M which contains a single %s
9238 which gets replaced with STRING. */
9241 message_with_string (const char *m
, Lisp_Object string
, int log
)
9243 CHECK_STRING (string
);
9249 if (noninteractive_need_newline
)
9250 putc ('\n', stderr
);
9251 noninteractive_need_newline
= 0;
9252 fprintf (stderr
, m
, SDATA (string
));
9253 if (!cursor_in_echo_area
)
9254 fprintf (stderr
, "\n");
9258 else if (INTERACTIVE
)
9260 /* The frame whose minibuffer we're going to display the message on.
9261 It may be larger than the selected frame, so we need
9262 to use its buffer, not the selected frame's buffer. */
9263 Lisp_Object mini_window
;
9264 struct frame
*f
, *sf
= SELECTED_FRAME ();
9266 /* Get the frame containing the minibuffer
9267 that the selected frame is using. */
9268 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9269 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9271 /* A null message buffer means that the frame hasn't really been
9272 initialized yet. Error messages get reported properly by
9273 cmd_error, so this must be just an informative message; toss it. */
9274 if (FRAME_MESSAGE_BUF (f
))
9276 Lisp_Object args
[2], msg
;
9277 struct gcpro gcpro1
, gcpro2
;
9279 args
[0] = build_string (m
);
9280 args
[1] = msg
= string
;
9281 GCPRO2 (args
[0], msg
);
9284 msg
= Fformat (2, args
);
9287 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9289 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9293 /* Print should start at the beginning of the message
9294 buffer next time. */
9295 message_buf_print
= 0;
9301 /* Dump an informative message to the minibuf. If M is 0, clear out
9302 any existing message, and let the mini-buffer text show through. */
9305 vmessage (const char *m
, va_list ap
)
9311 if (noninteractive_need_newline
)
9312 putc ('\n', stderr
);
9313 noninteractive_need_newline
= 0;
9314 vfprintf (stderr
, m
, ap
);
9315 if (cursor_in_echo_area
== 0)
9316 fprintf (stderr
, "\n");
9320 else if (INTERACTIVE
)
9322 /* The frame whose mini-buffer we're going to display the message
9323 on. It may be larger than the selected frame, so we need to
9324 use its buffer, not the selected frame's buffer. */
9325 Lisp_Object mini_window
;
9326 struct frame
*f
, *sf
= SELECTED_FRAME ();
9328 /* Get the frame containing the mini-buffer
9329 that the selected frame is using. */
9330 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9331 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9333 /* A null message buffer means that the frame hasn't really been
9334 initialized yet. Error messages get reported properly by
9335 cmd_error, so this must be just an informative message; toss
9337 if (FRAME_MESSAGE_BUF (f
))
9343 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9344 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9346 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9351 /* Print should start at the beginning of the message
9352 buffer next time. */
9353 message_buf_print
= 0;
9359 message (const char *m
, ...)
9369 /* The non-logging version of message. */
9372 message_nolog (const char *m
, ...)
9374 Lisp_Object old_log_max
;
9377 old_log_max
= Vmessage_log_max
;
9378 Vmessage_log_max
= Qnil
;
9380 Vmessage_log_max
= old_log_max
;
9386 /* Display the current message in the current mini-buffer. This is
9387 only called from error handlers in process.c, and is not time
9391 update_echo_area (void)
9393 if (!NILP (echo_area_buffer
[0]))
9396 string
= Fcurrent_message ();
9397 message3 (string
, SBYTES (string
),
9398 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9403 /* Make sure echo area buffers in `echo_buffers' are live.
9404 If they aren't, make new ones. */
9407 ensure_echo_area_buffers (void)
9411 for (i
= 0; i
< 2; ++i
)
9412 if (!BUFFERP (echo_buffer
[i
])
9413 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9416 Lisp_Object old_buffer
;
9419 old_buffer
= echo_buffer
[i
];
9420 sprintf (name
, " *Echo Area %d*", i
);
9421 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9422 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9423 /* to force word wrap in echo area -
9424 it was decided to postpone this*/
9425 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9427 for (j
= 0; j
< 2; ++j
)
9428 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9429 echo_area_buffer
[j
] = echo_buffer
[i
];
9434 /* Call FN with args A1..A4 with either the current or last displayed
9435 echo_area_buffer as current buffer.
9437 WHICH zero means use the current message buffer
9438 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9439 from echo_buffer[] and clear it.
9441 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9442 suitable buffer from echo_buffer[] and clear it.
9444 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9445 that the current message becomes the last displayed one, make
9446 choose a suitable buffer for echo_area_buffer[0], and clear it.
9448 Value is what FN returns. */
9451 with_echo_area_buffer (struct window
*w
, int which
,
9452 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9453 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9456 int this_one
, the_other
, clear_buffer_p
, rc
;
9457 int count
= SPECPDL_INDEX ();
9459 /* If buffers aren't live, make new ones. */
9460 ensure_echo_area_buffers ();
9465 this_one
= 0, the_other
= 1;
9467 this_one
= 1, the_other
= 0;
9470 this_one
= 0, the_other
= 1;
9473 /* We need a fresh one in case the current echo buffer equals
9474 the one containing the last displayed echo area message. */
9475 if (!NILP (echo_area_buffer
[this_one
])
9476 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9477 echo_area_buffer
[this_one
] = Qnil
;
9480 /* Choose a suitable buffer from echo_buffer[] is we don't
9482 if (NILP (echo_area_buffer
[this_one
]))
9484 echo_area_buffer
[this_one
]
9485 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9486 ? echo_buffer
[the_other
]
9487 : echo_buffer
[this_one
]);
9491 buffer
= echo_area_buffer
[this_one
];
9493 /* Don't get confused by reusing the buffer used for echoing
9494 for a different purpose. */
9495 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9498 record_unwind_protect (unwind_with_echo_area_buffer
,
9499 with_echo_area_buffer_unwind_data (w
));
9501 /* Make the echo area buffer current. Note that for display
9502 purposes, it is not necessary that the displayed window's buffer
9503 == current_buffer, except for text property lookup. So, let's
9504 only set that buffer temporarily here without doing a full
9505 Fset_window_buffer. We must also change w->pointm, though,
9506 because otherwise an assertions in unshow_buffer fails, and Emacs
9508 set_buffer_internal_1 (XBUFFER (buffer
));
9512 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9515 BVAR (current_buffer
, undo_list
) = Qt
;
9516 BVAR (current_buffer
, read_only
) = Qnil
;
9517 specbind (Qinhibit_read_only
, Qt
);
9518 specbind (Qinhibit_modification_hooks
, Qt
);
9520 if (clear_buffer_p
&& Z
> BEG
)
9523 xassert (BEGV
>= BEG
);
9524 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9526 rc
= fn (a1
, a2
, a3
, a4
);
9528 xassert (BEGV
>= BEG
);
9529 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9531 unbind_to (count
, Qnil
);
9536 /* Save state that should be preserved around the call to the function
9537 FN called in with_echo_area_buffer. */
9540 with_echo_area_buffer_unwind_data (struct window
*w
)
9543 Lisp_Object vector
, tmp
;
9545 /* Reduce consing by keeping one vector in
9546 Vwith_echo_area_save_vector. */
9547 vector
= Vwith_echo_area_save_vector
;
9548 Vwith_echo_area_save_vector
= Qnil
;
9551 vector
= Fmake_vector (make_number (7), Qnil
);
9553 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9554 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9555 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9559 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9560 ASET (vector
, i
, w
->buffer
); ++i
;
9561 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9562 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9567 for (; i
< end
; ++i
)
9568 ASET (vector
, i
, Qnil
);
9571 xassert (i
== ASIZE (vector
));
9576 /* Restore global state from VECTOR which was created by
9577 with_echo_area_buffer_unwind_data. */
9580 unwind_with_echo_area_buffer (Lisp_Object vector
)
9582 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9583 Vdeactivate_mark
= AREF (vector
, 1);
9584 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9586 if (WINDOWP (AREF (vector
, 3)))
9589 Lisp_Object buffer
, charpos
, bytepos
;
9591 w
= XWINDOW (AREF (vector
, 3));
9592 buffer
= AREF (vector
, 4);
9593 charpos
= AREF (vector
, 5);
9594 bytepos
= AREF (vector
, 6);
9597 set_marker_both (w
->pointm
, buffer
,
9598 XFASTINT (charpos
), XFASTINT (bytepos
));
9601 Vwith_echo_area_save_vector
= vector
;
9606 /* Set up the echo area for use by print functions. MULTIBYTE_P
9607 non-zero means we will print multibyte. */
9610 setup_echo_area_for_printing (int multibyte_p
)
9612 /* If we can't find an echo area any more, exit. */
9613 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9616 ensure_echo_area_buffers ();
9618 if (!message_buf_print
)
9620 /* A message has been output since the last time we printed.
9621 Choose a fresh echo area buffer. */
9622 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9623 echo_area_buffer
[0] = echo_buffer
[1];
9625 echo_area_buffer
[0] = echo_buffer
[0];
9627 /* Switch to that buffer and clear it. */
9628 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9629 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9633 int count
= SPECPDL_INDEX ();
9634 specbind (Qinhibit_read_only
, Qt
);
9635 /* Note that undo recording is always disabled. */
9637 unbind_to (count
, Qnil
);
9639 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9641 /* Set up the buffer for the multibyteness we need. */
9643 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9644 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9646 /* Raise the frame containing the echo area. */
9647 if (minibuffer_auto_raise
)
9649 struct frame
*sf
= SELECTED_FRAME ();
9650 Lisp_Object mini_window
;
9651 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9652 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9655 message_log_maybe_newline ();
9656 message_buf_print
= 1;
9660 if (NILP (echo_area_buffer
[0]))
9662 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9663 echo_area_buffer
[0] = echo_buffer
[1];
9665 echo_area_buffer
[0] = echo_buffer
[0];
9668 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9670 /* Someone switched buffers between print requests. */
9671 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9672 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9678 /* Display an echo area message in window W. Value is non-zero if W's
9679 height is changed. If display_last_displayed_message_p is
9680 non-zero, display the message that was last displayed, otherwise
9681 display the current message. */
9684 display_echo_area (struct window
*w
)
9686 int i
, no_message_p
, window_height_changed_p
, count
;
9688 /* Temporarily disable garbage collections while displaying the echo
9689 area. This is done because a GC can print a message itself.
9690 That message would modify the echo area buffer's contents while a
9691 redisplay of the buffer is going on, and seriously confuse
9693 count
= inhibit_garbage_collection ();
9695 /* If there is no message, we must call display_echo_area_1
9696 nevertheless because it resizes the window. But we will have to
9697 reset the echo_area_buffer in question to nil at the end because
9698 with_echo_area_buffer will sets it to an empty buffer. */
9699 i
= display_last_displayed_message_p
? 1 : 0;
9700 no_message_p
= NILP (echo_area_buffer
[i
]);
9702 window_height_changed_p
9703 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9704 display_echo_area_1
,
9705 (intptr_t) w
, Qnil
, 0, 0);
9708 echo_area_buffer
[i
] = Qnil
;
9710 unbind_to (count
, Qnil
);
9711 return window_height_changed_p
;
9715 /* Helper for display_echo_area. Display the current buffer which
9716 contains the current echo area message in window W, a mini-window,
9717 a pointer to which is passed in A1. A2..A4 are currently not used.
9718 Change the height of W so that all of the message is displayed.
9719 Value is non-zero if height of W was changed. */
9722 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9725 struct window
*w
= (struct window
*) i1
;
9727 struct text_pos start
;
9728 int window_height_changed_p
= 0;
9730 /* Do this before displaying, so that we have a large enough glyph
9731 matrix for the display. If we can't get enough space for the
9732 whole text, display the last N lines. That works by setting w->start. */
9733 window_height_changed_p
= resize_mini_window (w
, 0);
9735 /* Use the starting position chosen by resize_mini_window. */
9736 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9739 clear_glyph_matrix (w
->desired_matrix
);
9740 XSETWINDOW (window
, w
);
9741 try_window (window
, start
, 0);
9743 return window_height_changed_p
;
9747 /* Resize the echo area window to exactly the size needed for the
9748 currently displayed message, if there is one. If a mini-buffer
9749 is active, don't shrink it. */
9752 resize_echo_area_exactly (void)
9754 if (BUFFERP (echo_area_buffer
[0])
9755 && WINDOWP (echo_area_window
))
9757 struct window
*w
= XWINDOW (echo_area_window
);
9759 Lisp_Object resize_exactly
;
9761 if (minibuf_level
== 0)
9762 resize_exactly
= Qt
;
9764 resize_exactly
= Qnil
;
9766 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9767 (intptr_t) w
, resize_exactly
,
9771 ++windows_or_buffers_changed
;
9772 ++update_mode_lines
;
9773 redisplay_internal ();
9779 /* Callback function for with_echo_area_buffer, when used from
9780 resize_echo_area_exactly. A1 contains a pointer to the window to
9781 resize, EXACTLY non-nil means resize the mini-window exactly to the
9782 size of the text displayed. A3 and A4 are not used. Value is what
9783 resize_mini_window returns. */
9786 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9789 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9793 /* Resize mini-window W to fit the size of its contents. EXACT_P
9794 means size the window exactly to the size needed. Otherwise, it's
9795 only enlarged until W's buffer is empty.
9797 Set W->start to the right place to begin display. If the whole
9798 contents fit, start at the beginning. Otherwise, start so as
9799 to make the end of the contents appear. This is particularly
9800 important for y-or-n-p, but seems desirable generally.
9802 Value is non-zero if the window height has been changed. */
9805 resize_mini_window (struct window
*w
, int exact_p
)
9807 struct frame
*f
= XFRAME (w
->frame
);
9808 int window_height_changed_p
= 0;
9810 xassert (MINI_WINDOW_P (w
));
9812 /* By default, start display at the beginning. */
9813 set_marker_both (w
->start
, w
->buffer
,
9814 BUF_BEGV (XBUFFER (w
->buffer
)),
9815 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9817 /* Don't resize windows while redisplaying a window; it would
9818 confuse redisplay functions when the size of the window they are
9819 displaying changes from under them. Such a resizing can happen,
9820 for instance, when which-func prints a long message while
9821 we are running fontification-functions. We're running these
9822 functions with safe_call which binds inhibit-redisplay to t. */
9823 if (!NILP (Vinhibit_redisplay
))
9826 /* Nil means don't try to resize. */
9827 if (NILP (Vresize_mini_windows
)
9828 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9831 if (!FRAME_MINIBUF_ONLY_P (f
))
9834 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9835 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9836 int height
, max_height
;
9837 int unit
= FRAME_LINE_HEIGHT (f
);
9838 struct text_pos start
;
9839 struct buffer
*old_current_buffer
= NULL
;
9841 if (current_buffer
!= XBUFFER (w
->buffer
))
9843 old_current_buffer
= current_buffer
;
9844 set_buffer_internal (XBUFFER (w
->buffer
));
9847 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9849 /* Compute the max. number of lines specified by the user. */
9850 if (FLOATP (Vmax_mini_window_height
))
9851 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9852 else if (INTEGERP (Vmax_mini_window_height
))
9853 max_height
= XINT (Vmax_mini_window_height
);
9855 max_height
= total_height
/ 4;
9857 /* Correct that max. height if it's bogus. */
9858 max_height
= max (1, max_height
);
9859 max_height
= min (total_height
, max_height
);
9861 /* Find out the height of the text in the window. */
9862 if (it
.line_wrap
== TRUNCATE
)
9867 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9868 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9869 height
= it
.current_y
+ last_height
;
9871 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9872 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9873 height
= (height
+ unit
- 1) / unit
;
9876 /* Compute a suitable window start. */
9877 if (height
> max_height
)
9879 height
= max_height
;
9880 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9881 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9882 start
= it
.current
.pos
;
9885 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9886 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9888 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9890 /* Let it grow only, until we display an empty message, in which
9891 case the window shrinks again. */
9892 if (height
> WINDOW_TOTAL_LINES (w
))
9894 int old_height
= WINDOW_TOTAL_LINES (w
);
9895 freeze_window_starts (f
, 1);
9896 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9897 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9899 else if (height
< WINDOW_TOTAL_LINES (w
)
9900 && (exact_p
|| BEGV
== ZV
))
9902 int old_height
= WINDOW_TOTAL_LINES (w
);
9903 freeze_window_starts (f
, 0);
9904 shrink_mini_window (w
);
9905 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9910 /* Always resize to exact size needed. */
9911 if (height
> WINDOW_TOTAL_LINES (w
))
9913 int old_height
= WINDOW_TOTAL_LINES (w
);
9914 freeze_window_starts (f
, 1);
9915 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9916 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9918 else if (height
< WINDOW_TOTAL_LINES (w
))
9920 int old_height
= WINDOW_TOTAL_LINES (w
);
9921 freeze_window_starts (f
, 0);
9922 shrink_mini_window (w
);
9926 freeze_window_starts (f
, 1);
9927 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9930 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9934 if (old_current_buffer
)
9935 set_buffer_internal (old_current_buffer
);
9938 return window_height_changed_p
;
9942 /* Value is the current message, a string, or nil if there is no
9946 current_message (void)
9950 if (!BUFFERP (echo_area_buffer
[0]))
9954 with_echo_area_buffer (0, 0, current_message_1
,
9955 (intptr_t) &msg
, Qnil
, 0, 0);
9957 echo_area_buffer
[0] = Qnil
;
9965 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9968 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9971 *msg
= make_buffer_string (BEG
, Z
, 1);
9978 /* Push the current message on Vmessage_stack for later restauration
9979 by restore_message. Value is non-zero if the current message isn't
9980 empty. This is a relatively infrequent operation, so it's not
9981 worth optimizing. */
9987 msg
= current_message ();
9988 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9989 return STRINGP (msg
);
9993 /* Restore message display from the top of Vmessage_stack. */
9996 restore_message (void)
10000 xassert (CONSP (Vmessage_stack
));
10001 msg
= XCAR (Vmessage_stack
);
10003 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10005 message3_nolog (msg
, 0, 0);
10009 /* Handler for record_unwind_protect calling pop_message. */
10012 pop_message_unwind (Lisp_Object dummy
)
10018 /* Pop the top-most entry off Vmessage_stack. */
10023 xassert (CONSP (Vmessage_stack
));
10024 Vmessage_stack
= XCDR (Vmessage_stack
);
10028 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10029 exits. If the stack is not empty, we have a missing pop_message
10033 check_message_stack (void)
10035 if (!NILP (Vmessage_stack
))
10040 /* Truncate to NCHARS what will be displayed in the echo area the next
10041 time we display it---but don't redisplay it now. */
10044 truncate_echo_area (EMACS_INT nchars
)
10047 echo_area_buffer
[0] = Qnil
;
10048 /* A null message buffer means that the frame hasn't really been
10049 initialized yet. Error messages get reported properly by
10050 cmd_error, so this must be just an informative message; toss it. */
10051 else if (!noninteractive
10053 && !NILP (echo_area_buffer
[0]))
10055 struct frame
*sf
= SELECTED_FRAME ();
10056 if (FRAME_MESSAGE_BUF (sf
))
10057 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10062 /* Helper function for truncate_echo_area. Truncate the current
10063 message to at most NCHARS characters. */
10066 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10068 if (BEG
+ nchars
< Z
)
10069 del_range (BEG
+ nchars
, Z
);
10071 echo_area_buffer
[0] = Qnil
;
10076 /* Set the current message to a substring of S or STRING.
10078 If STRING is a Lisp string, set the message to the first NBYTES
10079 bytes from STRING. NBYTES zero means use the whole string. If
10080 STRING is multibyte, the message will be displayed multibyte.
10082 If S is not null, set the message to the first LEN bytes of S. LEN
10083 zero means use the whole string. MULTIBYTE_P non-zero means S is
10084 multibyte. Display the message multibyte in that case.
10086 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10087 to t before calling set_message_1 (which calls insert).
10091 set_message (const char *s
, Lisp_Object string
,
10092 EMACS_INT nbytes
, int multibyte_p
)
10094 message_enable_multibyte
10095 = ((s
&& multibyte_p
)
10096 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10098 with_echo_area_buffer (0, -1, set_message_1
,
10099 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10100 message_buf_print
= 0;
10101 help_echo_showing_p
= 0;
10105 /* Helper function for set_message. Arguments have the same meaning
10106 as there, with A1 corresponding to S and A2 corresponding to STRING
10107 This function is called with the echo area buffer being
10111 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10114 const char *s
= (const char *) i1
;
10115 const unsigned char *msg
= (const unsigned char *) s
;
10116 Lisp_Object string
= a2
;
10118 /* Change multibyteness of the echo buffer appropriately. */
10119 if (message_enable_multibyte
10120 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10121 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10123 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10124 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10125 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10127 /* Insert new message at BEG. */
10128 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10130 if (STRINGP (string
))
10135 nbytes
= SBYTES (string
);
10136 nchars
= string_byte_to_char (string
, nbytes
);
10138 /* This function takes care of single/multibyte conversion. We
10139 just have to ensure that the echo area buffer has the right
10140 setting of enable_multibyte_characters. */
10141 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10146 nbytes
= strlen (s
);
10148 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10150 /* Convert from multi-byte to single-byte. */
10155 /* Convert a multibyte string to single-byte. */
10156 for (i
= 0; i
< nbytes
; i
+= n
)
10158 c
= string_char_and_length (msg
+ i
, &n
);
10159 work
[0] = (ASCII_CHAR_P (c
)
10161 : multibyte_char_to_unibyte (c
));
10162 insert_1_both (work
, 1, 1, 1, 0, 0);
10165 else if (!multibyte_p
10166 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10168 /* Convert from single-byte to multi-byte. */
10171 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10173 /* Convert a single-byte string to multibyte. */
10174 for (i
= 0; i
< nbytes
; i
++)
10177 MAKE_CHAR_MULTIBYTE (c
);
10178 n
= CHAR_STRING (c
, str
);
10179 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10183 insert_1 (s
, nbytes
, 1, 0, 0);
10190 /* Clear messages. CURRENT_P non-zero means clear the current
10191 message. LAST_DISPLAYED_P non-zero means clear the message
10195 clear_message (int current_p
, int last_displayed_p
)
10199 echo_area_buffer
[0] = Qnil
;
10200 message_cleared_p
= 1;
10203 if (last_displayed_p
)
10204 echo_area_buffer
[1] = Qnil
;
10206 message_buf_print
= 0;
10209 /* Clear garbaged frames.
10211 This function is used where the old redisplay called
10212 redraw_garbaged_frames which in turn called redraw_frame which in
10213 turn called clear_frame. The call to clear_frame was a source of
10214 flickering. I believe a clear_frame is not necessary. It should
10215 suffice in the new redisplay to invalidate all current matrices,
10216 and ensure a complete redisplay of all windows. */
10219 clear_garbaged_frames (void)
10221 if (frame_garbaged
)
10223 Lisp_Object tail
, frame
;
10224 int changed_count
= 0;
10226 FOR_EACH_FRAME (tail
, frame
)
10228 struct frame
*f
= XFRAME (frame
);
10230 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10234 Fredraw_frame (frame
);
10235 f
->force_flush_display_p
= 1;
10237 clear_current_matrices (f
);
10244 frame_garbaged
= 0;
10246 ++windows_or_buffers_changed
;
10251 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10252 is non-zero update selected_frame. Value is non-zero if the
10253 mini-windows height has been changed. */
10256 echo_area_display (int update_frame_p
)
10258 Lisp_Object mini_window
;
10261 int window_height_changed_p
= 0;
10262 struct frame
*sf
= SELECTED_FRAME ();
10264 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10265 w
= XWINDOW (mini_window
);
10266 f
= XFRAME (WINDOW_FRAME (w
));
10268 /* Don't display if frame is invisible or not yet initialized. */
10269 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10272 #ifdef HAVE_WINDOW_SYSTEM
10273 /* When Emacs starts, selected_frame may be the initial terminal
10274 frame. If we let this through, a message would be displayed on
10276 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10278 #endif /* HAVE_WINDOW_SYSTEM */
10280 /* Redraw garbaged frames. */
10281 if (frame_garbaged
)
10282 clear_garbaged_frames ();
10284 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10286 echo_area_window
= mini_window
;
10287 window_height_changed_p
= display_echo_area (w
);
10288 w
->must_be_updated_p
= 1;
10290 /* Update the display, unless called from redisplay_internal.
10291 Also don't update the screen during redisplay itself. The
10292 update will happen at the end of redisplay, and an update
10293 here could cause confusion. */
10294 if (update_frame_p
&& !redisplaying_p
)
10298 /* If the display update has been interrupted by pending
10299 input, update mode lines in the frame. Due to the
10300 pending input, it might have been that redisplay hasn't
10301 been called, so that mode lines above the echo area are
10302 garbaged. This looks odd, so we prevent it here. */
10303 if (!display_completed
)
10304 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10306 if (window_height_changed_p
10307 /* Don't do this if Emacs is shutting down. Redisplay
10308 needs to run hooks. */
10309 && !NILP (Vrun_hooks
))
10311 /* Must update other windows. Likewise as in other
10312 cases, don't let this update be interrupted by
10314 int count
= SPECPDL_INDEX ();
10315 specbind (Qredisplay_dont_pause
, Qt
);
10316 windows_or_buffers_changed
= 1;
10317 redisplay_internal ();
10318 unbind_to (count
, Qnil
);
10320 else if (FRAME_WINDOW_P (f
) && n
== 0)
10322 /* Window configuration is the same as before.
10323 Can do with a display update of the echo area,
10324 unless we displayed some mode lines. */
10325 update_single_window (w
, 1);
10326 FRAME_RIF (f
)->flush_display (f
);
10329 update_frame (f
, 1, 1);
10331 /* If cursor is in the echo area, make sure that the next
10332 redisplay displays the minibuffer, so that the cursor will
10333 be replaced with what the minibuffer wants. */
10334 if (cursor_in_echo_area
)
10335 ++windows_or_buffers_changed
;
10338 else if (!EQ (mini_window
, selected_window
))
10339 windows_or_buffers_changed
++;
10341 /* Last displayed message is now the current message. */
10342 echo_area_buffer
[1] = echo_area_buffer
[0];
10343 /* Inform read_char that we're not echoing. */
10344 echo_message_buffer
= Qnil
;
10346 /* Prevent redisplay optimization in redisplay_internal by resetting
10347 this_line_start_pos. This is done because the mini-buffer now
10348 displays the message instead of its buffer text. */
10349 if (EQ (mini_window
, selected_window
))
10350 CHARPOS (this_line_start_pos
) = 0;
10352 return window_height_changed_p
;
10357 /***********************************************************************
10358 Mode Lines and Frame Titles
10359 ***********************************************************************/
10361 /* A buffer for constructing non-propertized mode-line strings and
10362 frame titles in it; allocated from the heap in init_xdisp and
10363 resized as needed in store_mode_line_noprop_char. */
10365 static char *mode_line_noprop_buf
;
10367 /* The buffer's end, and a current output position in it. */
10369 static char *mode_line_noprop_buf_end
;
10370 static char *mode_line_noprop_ptr
;
10372 #define MODE_LINE_NOPROP_LEN(start) \
10373 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10376 MODE_LINE_DISPLAY
= 0,
10380 } mode_line_target
;
10382 /* Alist that caches the results of :propertize.
10383 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10384 static Lisp_Object mode_line_proptrans_alist
;
10386 /* List of strings making up the mode-line. */
10387 static Lisp_Object mode_line_string_list
;
10389 /* Base face property when building propertized mode line string. */
10390 static Lisp_Object mode_line_string_face
;
10391 static Lisp_Object mode_line_string_face_prop
;
10394 /* Unwind data for mode line strings */
10396 static Lisp_Object Vmode_line_unwind_vector
;
10399 format_mode_line_unwind_data (struct buffer
*obuf
,
10401 int save_proptrans
)
10403 Lisp_Object vector
, tmp
;
10405 /* Reduce consing by keeping one vector in
10406 Vwith_echo_area_save_vector. */
10407 vector
= Vmode_line_unwind_vector
;
10408 Vmode_line_unwind_vector
= Qnil
;
10411 vector
= Fmake_vector (make_number (8), Qnil
);
10413 ASET (vector
, 0, make_number (mode_line_target
));
10414 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10415 ASET (vector
, 2, mode_line_string_list
);
10416 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10417 ASET (vector
, 4, mode_line_string_face
);
10418 ASET (vector
, 5, mode_line_string_face_prop
);
10421 XSETBUFFER (tmp
, obuf
);
10424 ASET (vector
, 6, tmp
);
10425 ASET (vector
, 7, owin
);
10431 unwind_format_mode_line (Lisp_Object vector
)
10433 mode_line_target
= XINT (AREF (vector
, 0));
10434 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10435 mode_line_string_list
= AREF (vector
, 2);
10436 if (! EQ (AREF (vector
, 3), Qt
))
10437 mode_line_proptrans_alist
= AREF (vector
, 3);
10438 mode_line_string_face
= AREF (vector
, 4);
10439 mode_line_string_face_prop
= AREF (vector
, 5);
10441 if (!NILP (AREF (vector
, 7)))
10442 /* Select window before buffer, since it may change the buffer. */
10443 Fselect_window (AREF (vector
, 7), Qt
);
10445 if (!NILP (AREF (vector
, 6)))
10447 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10448 ASET (vector
, 6, Qnil
);
10451 Vmode_line_unwind_vector
= vector
;
10456 /* Store a single character C for the frame title in mode_line_noprop_buf.
10457 Re-allocate mode_line_noprop_buf if necessary. */
10460 store_mode_line_noprop_char (char c
)
10462 /* If output position has reached the end of the allocated buffer,
10463 increase the buffer's size. */
10464 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10466 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10467 ptrdiff_t size
= len
;
10468 mode_line_noprop_buf
=
10469 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10470 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10471 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10474 *mode_line_noprop_ptr
++ = c
;
10478 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10479 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10480 characters that yield more columns than PRECISION; PRECISION <= 0
10481 means copy the whole string. Pad with spaces until FIELD_WIDTH
10482 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10483 pad. Called from display_mode_element when it is used to build a
10487 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10489 const unsigned char *str
= (const unsigned char *) string
;
10491 EMACS_INT dummy
, nbytes
;
10493 /* Copy at most PRECISION chars from STR. */
10494 nbytes
= strlen (string
);
10495 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10497 store_mode_line_noprop_char (*str
++);
10499 /* Fill up with spaces until FIELD_WIDTH reached. */
10500 while (field_width
> 0
10501 && n
< field_width
)
10503 store_mode_line_noprop_char (' ');
10510 /***********************************************************************
10512 ***********************************************************************/
10514 #ifdef HAVE_WINDOW_SYSTEM
10516 /* Set the title of FRAME, if it has changed. The title format is
10517 Vicon_title_format if FRAME is iconified, otherwise it is
10518 frame_title_format. */
10521 x_consider_frame_title (Lisp_Object frame
)
10523 struct frame
*f
= XFRAME (frame
);
10525 if (FRAME_WINDOW_P (f
)
10526 || FRAME_MINIBUF_ONLY_P (f
)
10527 || f
->explicit_name
)
10529 /* Do we have more than one visible frame on this X display? */
10532 ptrdiff_t title_start
;
10536 int count
= SPECPDL_INDEX ();
10538 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10540 Lisp_Object other_frame
= XCAR (tail
);
10541 struct frame
*tf
= XFRAME (other_frame
);
10544 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10545 && !FRAME_MINIBUF_ONLY_P (tf
)
10546 && !EQ (other_frame
, tip_frame
)
10547 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10551 /* Set global variable indicating that multiple frames exist. */
10552 multiple_frames
= CONSP (tail
);
10554 /* Switch to the buffer of selected window of the frame. Set up
10555 mode_line_target so that display_mode_element will output into
10556 mode_line_noprop_buf; then display the title. */
10557 record_unwind_protect (unwind_format_mode_line
,
10558 format_mode_line_unwind_data
10559 (current_buffer
, selected_window
, 0));
10561 Fselect_window (f
->selected_window
, Qt
);
10562 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10563 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10565 mode_line_target
= MODE_LINE_TITLE
;
10566 title_start
= MODE_LINE_NOPROP_LEN (0);
10567 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10568 NULL
, DEFAULT_FACE_ID
);
10569 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10570 len
= MODE_LINE_NOPROP_LEN (title_start
);
10571 title
= mode_line_noprop_buf
+ title_start
;
10572 unbind_to (count
, Qnil
);
10574 /* Set the title only if it's changed. This avoids consing in
10575 the common case where it hasn't. (If it turns out that we've
10576 already wasted too much time by walking through the list with
10577 display_mode_element, then we might need to optimize at a
10578 higher level than this.) */
10579 if (! STRINGP (f
->name
)
10580 || SBYTES (f
->name
) != len
10581 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10582 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10586 #endif /* not HAVE_WINDOW_SYSTEM */
10591 /***********************************************************************
10593 ***********************************************************************/
10596 /* Prepare for redisplay by updating menu-bar item lists when
10597 appropriate. This can call eval. */
10600 prepare_menu_bars (void)
10603 struct gcpro gcpro1
, gcpro2
;
10605 Lisp_Object tooltip_frame
;
10607 #ifdef HAVE_WINDOW_SYSTEM
10608 tooltip_frame
= tip_frame
;
10610 tooltip_frame
= Qnil
;
10613 /* Update all frame titles based on their buffer names, etc. We do
10614 this before the menu bars so that the buffer-menu will show the
10615 up-to-date frame titles. */
10616 #ifdef HAVE_WINDOW_SYSTEM
10617 if (windows_or_buffers_changed
|| update_mode_lines
)
10619 Lisp_Object tail
, frame
;
10621 FOR_EACH_FRAME (tail
, frame
)
10623 f
= XFRAME (frame
);
10624 if (!EQ (frame
, tooltip_frame
)
10625 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10626 x_consider_frame_title (frame
);
10629 #endif /* HAVE_WINDOW_SYSTEM */
10631 /* Update the menu bar item lists, if appropriate. This has to be
10632 done before any actual redisplay or generation of display lines. */
10633 all_windows
= (update_mode_lines
10634 || buffer_shared
> 1
10635 || windows_or_buffers_changed
);
10638 Lisp_Object tail
, frame
;
10639 int count
= SPECPDL_INDEX ();
10640 /* 1 means that update_menu_bar has run its hooks
10641 so any further calls to update_menu_bar shouldn't do so again. */
10642 int menu_bar_hooks_run
= 0;
10644 record_unwind_save_match_data ();
10646 FOR_EACH_FRAME (tail
, frame
)
10648 f
= XFRAME (frame
);
10650 /* Ignore tooltip frame. */
10651 if (EQ (frame
, tooltip_frame
))
10654 /* If a window on this frame changed size, report that to
10655 the user and clear the size-change flag. */
10656 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10658 Lisp_Object functions
;
10660 /* Clear flag first in case we get an error below. */
10661 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10662 functions
= Vwindow_size_change_functions
;
10663 GCPRO2 (tail
, functions
);
10665 while (CONSP (functions
))
10667 if (!EQ (XCAR (functions
), Qt
))
10668 call1 (XCAR (functions
), frame
);
10669 functions
= XCDR (functions
);
10675 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10676 #ifdef HAVE_WINDOW_SYSTEM
10677 update_tool_bar (f
, 0);
10680 if (windows_or_buffers_changed
10682 ns_set_doc_edited (f
, Fbuffer_modified_p
10683 (XWINDOW (f
->selected_window
)->buffer
));
10688 unbind_to (count
, Qnil
);
10692 struct frame
*sf
= SELECTED_FRAME ();
10693 update_menu_bar (sf
, 1, 0);
10694 #ifdef HAVE_WINDOW_SYSTEM
10695 update_tool_bar (sf
, 1);
10701 /* Update the menu bar item list for frame F. This has to be done
10702 before we start to fill in any display lines, because it can call
10705 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10707 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10708 already ran the menu bar hooks for this redisplay, so there
10709 is no need to run them again. The return value is the
10710 updated value of this flag, to pass to the next call. */
10713 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10715 Lisp_Object window
;
10716 register struct window
*w
;
10718 /* If called recursively during a menu update, do nothing. This can
10719 happen when, for instance, an activate-menubar-hook causes a
10721 if (inhibit_menubar_update
)
10724 window
= FRAME_SELECTED_WINDOW (f
);
10725 w
= XWINDOW (window
);
10727 if (FRAME_WINDOW_P (f
)
10729 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10730 || defined (HAVE_NS) || defined (USE_GTK)
10731 FRAME_EXTERNAL_MENU_BAR (f
)
10733 FRAME_MENU_BAR_LINES (f
) > 0
10735 : FRAME_MENU_BAR_LINES (f
) > 0)
10737 /* If the user has switched buffers or windows, we need to
10738 recompute to reflect the new bindings. But we'll
10739 recompute when update_mode_lines is set too; that means
10740 that people can use force-mode-line-update to request
10741 that the menu bar be recomputed. The adverse effect on
10742 the rest of the redisplay algorithm is about the same as
10743 windows_or_buffers_changed anyway. */
10744 if (windows_or_buffers_changed
10745 /* This used to test w->update_mode_line, but we believe
10746 there is no need to recompute the menu in that case. */
10747 || update_mode_lines
10748 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10749 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10750 != !NILP (w
->last_had_star
))
10751 || ((!NILP (Vtransient_mark_mode
)
10752 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10753 != !NILP (w
->region_showing
)))
10755 struct buffer
*prev
= current_buffer
;
10756 int count
= SPECPDL_INDEX ();
10758 specbind (Qinhibit_menubar_update
, Qt
);
10760 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10761 if (save_match_data
)
10762 record_unwind_save_match_data ();
10763 if (NILP (Voverriding_local_map_menu_flag
))
10765 specbind (Qoverriding_terminal_local_map
, Qnil
);
10766 specbind (Qoverriding_local_map
, Qnil
);
10771 /* Run the Lucid hook. */
10772 safe_run_hooks (Qactivate_menubar_hook
);
10774 /* If it has changed current-menubar from previous value,
10775 really recompute the menu-bar from the value. */
10776 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10777 call0 (Qrecompute_lucid_menubar
);
10779 safe_run_hooks (Qmenu_bar_update_hook
);
10784 XSETFRAME (Vmenu_updating_frame
, f
);
10785 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10787 /* Redisplay the menu bar in case we changed it. */
10788 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10789 || defined (HAVE_NS) || defined (USE_GTK)
10790 if (FRAME_WINDOW_P (f
))
10792 #if defined (HAVE_NS)
10793 /* All frames on Mac OS share the same menubar. So only
10794 the selected frame should be allowed to set it. */
10795 if (f
== SELECTED_FRAME ())
10797 set_frame_menubar (f
, 0, 0);
10800 /* On a terminal screen, the menu bar is an ordinary screen
10801 line, and this makes it get updated. */
10802 w
->update_mode_line
= Qt
;
10803 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10804 /* In the non-toolkit version, the menu bar is an ordinary screen
10805 line, and this makes it get updated. */
10806 w
->update_mode_line
= Qt
;
10807 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10809 unbind_to (count
, Qnil
);
10810 set_buffer_internal_1 (prev
);
10819 /***********************************************************************
10821 ***********************************************************************/
10823 #ifdef HAVE_WINDOW_SYSTEM
10826 Nominal cursor position -- where to draw output.
10827 HPOS and VPOS are window relative glyph matrix coordinates.
10828 X and Y are window relative pixel coordinates. */
10830 struct cursor_pos output_cursor
;
10834 Set the global variable output_cursor to CURSOR. All cursor
10835 positions are relative to updated_window. */
10838 set_output_cursor (struct cursor_pos
*cursor
)
10840 output_cursor
.hpos
= cursor
->hpos
;
10841 output_cursor
.vpos
= cursor
->vpos
;
10842 output_cursor
.x
= cursor
->x
;
10843 output_cursor
.y
= cursor
->y
;
10848 Set a nominal cursor position.
10850 HPOS and VPOS are column/row positions in a window glyph matrix. X
10851 and Y are window text area relative pixel positions.
10853 If this is done during an update, updated_window will contain the
10854 window that is being updated and the position is the future output
10855 cursor position for that window. If updated_window is null, use
10856 selected_window and display the cursor at the given position. */
10859 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10863 /* If updated_window is not set, work on selected_window. */
10864 if (updated_window
)
10865 w
= updated_window
;
10867 w
= XWINDOW (selected_window
);
10869 /* Set the output cursor. */
10870 output_cursor
.hpos
= hpos
;
10871 output_cursor
.vpos
= vpos
;
10872 output_cursor
.x
= x
;
10873 output_cursor
.y
= y
;
10875 /* If not called as part of an update, really display the cursor.
10876 This will also set the cursor position of W. */
10877 if (updated_window
== NULL
)
10880 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10881 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10882 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10887 #endif /* HAVE_WINDOW_SYSTEM */
10890 /***********************************************************************
10892 ***********************************************************************/
10894 #ifdef HAVE_WINDOW_SYSTEM
10896 /* Where the mouse was last time we reported a mouse event. */
10898 FRAME_PTR last_mouse_frame
;
10900 /* Tool-bar item index of the item on which a mouse button was pressed
10903 int last_tool_bar_item
;
10907 update_tool_bar_unwind (Lisp_Object frame
)
10909 selected_frame
= frame
;
10913 /* Update the tool-bar item list for frame F. This has to be done
10914 before we start to fill in any display lines. Called from
10915 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10916 and restore it here. */
10919 update_tool_bar (struct frame
*f
, int save_match_data
)
10921 #if defined (USE_GTK) || defined (HAVE_NS)
10922 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10924 int do_update
= WINDOWP (f
->tool_bar_window
)
10925 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10930 Lisp_Object window
;
10933 window
= FRAME_SELECTED_WINDOW (f
);
10934 w
= XWINDOW (window
);
10936 /* If the user has switched buffers or windows, we need to
10937 recompute to reflect the new bindings. But we'll
10938 recompute when update_mode_lines is set too; that means
10939 that people can use force-mode-line-update to request
10940 that the menu bar be recomputed. The adverse effect on
10941 the rest of the redisplay algorithm is about the same as
10942 windows_or_buffers_changed anyway. */
10943 if (windows_or_buffers_changed
10944 || !NILP (w
->update_mode_line
)
10945 || update_mode_lines
10946 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10947 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10948 != !NILP (w
->last_had_star
))
10949 || ((!NILP (Vtransient_mark_mode
)
10950 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10951 != !NILP (w
->region_showing
)))
10953 struct buffer
*prev
= current_buffer
;
10954 int count
= SPECPDL_INDEX ();
10955 Lisp_Object frame
, new_tool_bar
;
10956 int new_n_tool_bar
;
10957 struct gcpro gcpro1
;
10959 /* Set current_buffer to the buffer of the selected
10960 window of the frame, so that we get the right local
10962 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10964 /* Save match data, if we must. */
10965 if (save_match_data
)
10966 record_unwind_save_match_data ();
10968 /* Make sure that we don't accidentally use bogus keymaps. */
10969 if (NILP (Voverriding_local_map_menu_flag
))
10971 specbind (Qoverriding_terminal_local_map
, Qnil
);
10972 specbind (Qoverriding_local_map
, Qnil
);
10975 GCPRO1 (new_tool_bar
);
10977 /* We must temporarily set the selected frame to this frame
10978 before calling tool_bar_items, because the calculation of
10979 the tool-bar keymap uses the selected frame (see
10980 `tool-bar-make-keymap' in tool-bar.el). */
10981 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10982 XSETFRAME (frame
, f
);
10983 selected_frame
= frame
;
10985 /* Build desired tool-bar items from keymaps. */
10986 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10989 /* Redisplay the tool-bar if we changed it. */
10990 if (new_n_tool_bar
!= f
->n_tool_bar_items
10991 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10993 /* Redisplay that happens asynchronously due to an expose event
10994 may access f->tool_bar_items. Make sure we update both
10995 variables within BLOCK_INPUT so no such event interrupts. */
10997 f
->tool_bar_items
= new_tool_bar
;
10998 f
->n_tool_bar_items
= new_n_tool_bar
;
10999 w
->update_mode_line
= Qt
;
11005 unbind_to (count
, Qnil
);
11006 set_buffer_internal_1 (prev
);
11012 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11013 F's desired tool-bar contents. F->tool_bar_items must have
11014 been set up previously by calling prepare_menu_bars. */
11017 build_desired_tool_bar_string (struct frame
*f
)
11019 int i
, size
, size_needed
;
11020 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11021 Lisp_Object image
, plist
, props
;
11023 image
= plist
= props
= Qnil
;
11024 GCPRO3 (image
, plist
, props
);
11026 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11027 Otherwise, make a new string. */
11029 /* The size of the string we might be able to reuse. */
11030 size
= (STRINGP (f
->desired_tool_bar_string
)
11031 ? SCHARS (f
->desired_tool_bar_string
)
11034 /* We need one space in the string for each image. */
11035 size_needed
= f
->n_tool_bar_items
;
11037 /* Reuse f->desired_tool_bar_string, if possible. */
11038 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11039 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11040 make_number (' '));
11043 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11044 Fremove_text_properties (make_number (0), make_number (size
),
11045 props
, f
->desired_tool_bar_string
);
11048 /* Put a `display' property on the string for the images to display,
11049 put a `menu_item' property on tool-bar items with a value that
11050 is the index of the item in F's tool-bar item vector. */
11051 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11053 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11055 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11056 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11057 int hmargin
, vmargin
, relief
, idx
, end
;
11059 /* If image is a vector, choose the image according to the
11061 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11062 if (VECTORP (image
))
11066 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11067 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11070 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11071 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11073 xassert (ASIZE (image
) >= idx
);
11074 image
= AREF (image
, idx
);
11079 /* Ignore invalid image specifications. */
11080 if (!valid_image_p (image
))
11083 /* Display the tool-bar button pressed, or depressed. */
11084 plist
= Fcopy_sequence (XCDR (image
));
11086 /* Compute margin and relief to draw. */
11087 relief
= (tool_bar_button_relief
>= 0
11088 ? tool_bar_button_relief
11089 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11090 hmargin
= vmargin
= relief
;
11092 if (INTEGERP (Vtool_bar_button_margin
)
11093 && XINT (Vtool_bar_button_margin
) > 0)
11095 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11096 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11098 else if (CONSP (Vtool_bar_button_margin
))
11100 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11101 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11102 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11104 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11105 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11106 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11109 if (auto_raise_tool_bar_buttons_p
)
11111 /* Add a `:relief' property to the image spec if the item is
11115 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11122 /* If image is selected, display it pressed, i.e. with a
11123 negative relief. If it's not selected, display it with a
11125 plist
= Fplist_put (plist
, QCrelief
,
11127 ? make_number (-relief
)
11128 : make_number (relief
)));
11133 /* Put a margin around the image. */
11134 if (hmargin
|| vmargin
)
11136 if (hmargin
== vmargin
)
11137 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11139 plist
= Fplist_put (plist
, QCmargin
,
11140 Fcons (make_number (hmargin
),
11141 make_number (vmargin
)));
11144 /* If button is not enabled, and we don't have special images
11145 for the disabled state, make the image appear disabled by
11146 applying an appropriate algorithm to it. */
11147 if (!enabled_p
&& idx
< 0)
11148 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11150 /* Put a `display' text property on the string for the image to
11151 display. Put a `menu-item' property on the string that gives
11152 the start of this item's properties in the tool-bar items
11154 image
= Fcons (Qimage
, plist
);
11155 props
= list4 (Qdisplay
, image
,
11156 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11158 /* Let the last image hide all remaining spaces in the tool bar
11159 string. The string can be longer than needed when we reuse a
11160 previous string. */
11161 if (i
+ 1 == f
->n_tool_bar_items
)
11162 end
= SCHARS (f
->desired_tool_bar_string
);
11165 Fadd_text_properties (make_number (i
), make_number (end
),
11166 props
, f
->desired_tool_bar_string
);
11174 /* Display one line of the tool-bar of frame IT->f.
11176 HEIGHT specifies the desired height of the tool-bar line.
11177 If the actual height of the glyph row is less than HEIGHT, the
11178 row's height is increased to HEIGHT, and the icons are centered
11179 vertically in the new height.
11181 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11182 count a final empty row in case the tool-bar width exactly matches
11187 display_tool_bar_line (struct it
*it
, int height
)
11189 struct glyph_row
*row
= it
->glyph_row
;
11190 int max_x
= it
->last_visible_x
;
11191 struct glyph
*last
;
11193 prepare_desired_row (row
);
11194 row
->y
= it
->current_y
;
11196 /* Note that this isn't made use of if the face hasn't a box,
11197 so there's no need to check the face here. */
11198 it
->start_of_box_run_p
= 1;
11200 while (it
->current_x
< max_x
)
11202 int x
, n_glyphs_before
, i
, nglyphs
;
11203 struct it it_before
;
11205 /* Get the next display element. */
11206 if (!get_next_display_element (it
))
11208 /* Don't count empty row if we are counting needed tool-bar lines. */
11209 if (height
< 0 && !it
->hpos
)
11214 /* Produce glyphs. */
11215 n_glyphs_before
= row
->used
[TEXT_AREA
];
11218 PRODUCE_GLYPHS (it
);
11220 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11222 x
= it_before
.current_x
;
11223 while (i
< nglyphs
)
11225 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11227 if (x
+ glyph
->pixel_width
> max_x
)
11229 /* Glyph doesn't fit on line. Backtrack. */
11230 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11232 /* If this is the only glyph on this line, it will never fit on the
11233 tool-bar, so skip it. But ensure there is at least one glyph,
11234 so we don't accidentally disable the tool-bar. */
11235 if (n_glyphs_before
== 0
11236 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11242 x
+= glyph
->pixel_width
;
11246 /* Stop at line end. */
11247 if (ITERATOR_AT_END_OF_LINE_P (it
))
11250 set_iterator_to_next (it
, 1);
11255 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11257 /* Use default face for the border below the tool bar.
11259 FIXME: When auto-resize-tool-bars is grow-only, there is
11260 no additional border below the possibly empty tool-bar lines.
11261 So to make the extra empty lines look "normal", we have to
11262 use the tool-bar face for the border too. */
11263 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11264 it
->face_id
= DEFAULT_FACE_ID
;
11266 extend_face_to_end_of_line (it
);
11267 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11268 last
->right_box_line_p
= 1;
11269 if (last
== row
->glyphs
[TEXT_AREA
])
11270 last
->left_box_line_p
= 1;
11272 /* Make line the desired height and center it vertically. */
11273 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11275 /* Don't add more than one line height. */
11276 height
%= FRAME_LINE_HEIGHT (it
->f
);
11277 it
->max_ascent
+= height
/ 2;
11278 it
->max_descent
+= (height
+ 1) / 2;
11281 compute_line_metrics (it
);
11283 /* If line is empty, make it occupy the rest of the tool-bar. */
11284 if (!row
->displays_text_p
)
11286 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11287 row
->visible_height
= row
->height
;
11288 row
->ascent
= row
->phys_ascent
= 0;
11289 row
->extra_line_spacing
= 0;
11292 row
->full_width_p
= 1;
11293 row
->continued_p
= 0;
11294 row
->truncated_on_left_p
= 0;
11295 row
->truncated_on_right_p
= 0;
11297 it
->current_x
= it
->hpos
= 0;
11298 it
->current_y
+= row
->height
;
11304 /* Max tool-bar height. */
11306 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11307 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11309 /* Value is the number of screen lines needed to make all tool-bar
11310 items of frame F visible. The number of actual rows needed is
11311 returned in *N_ROWS if non-NULL. */
11314 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11316 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11318 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11319 the desired matrix, so use (unused) mode-line row as temporary row to
11320 avoid destroying the first tool-bar row. */
11321 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11323 /* Initialize an iterator for iteration over
11324 F->desired_tool_bar_string in the tool-bar window of frame F. */
11325 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11326 it
.first_visible_x
= 0;
11327 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11328 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11329 it
.paragraph_embedding
= L2R
;
11331 while (!ITERATOR_AT_END_P (&it
))
11333 clear_glyph_row (temp_row
);
11334 it
.glyph_row
= temp_row
;
11335 display_tool_bar_line (&it
, -1);
11337 clear_glyph_row (temp_row
);
11339 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11341 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11343 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11347 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11349 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11350 (Lisp_Object frame
)
11357 frame
= selected_frame
;
11359 CHECK_FRAME (frame
);
11360 f
= XFRAME (frame
);
11362 if (WINDOWP (f
->tool_bar_window
)
11363 && (w
= XWINDOW (f
->tool_bar_window
),
11364 WINDOW_TOTAL_LINES (w
) > 0))
11366 update_tool_bar (f
, 1);
11367 if (f
->n_tool_bar_items
)
11369 build_desired_tool_bar_string (f
);
11370 nlines
= tool_bar_lines_needed (f
, NULL
);
11374 return make_number (nlines
);
11378 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11379 height should be changed. */
11382 redisplay_tool_bar (struct frame
*f
)
11386 struct glyph_row
*row
;
11388 #if defined (USE_GTK) || defined (HAVE_NS)
11389 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11390 update_frame_tool_bar (f
);
11394 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11395 do anything. This means you must start with tool-bar-lines
11396 non-zero to get the auto-sizing effect. Or in other words, you
11397 can turn off tool-bars by specifying tool-bar-lines zero. */
11398 if (!WINDOWP (f
->tool_bar_window
)
11399 || (w
= XWINDOW (f
->tool_bar_window
),
11400 WINDOW_TOTAL_LINES (w
) == 0))
11403 /* Set up an iterator for the tool-bar window. */
11404 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11405 it
.first_visible_x
= 0;
11406 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11407 row
= it
.glyph_row
;
11409 /* Build a string that represents the contents of the tool-bar. */
11410 build_desired_tool_bar_string (f
);
11411 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11412 /* FIXME: This should be controlled by a user option. But it
11413 doesn't make sense to have an R2L tool bar if the menu bar cannot
11414 be drawn also R2L, and making the menu bar R2L is tricky due
11415 toolkit-specific code that implements it. If an R2L tool bar is
11416 ever supported, display_tool_bar_line should also be augmented to
11417 call unproduce_glyphs like display_line and display_string
11419 it
.paragraph_embedding
= L2R
;
11421 if (f
->n_tool_bar_rows
== 0)
11425 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11426 nlines
!= WINDOW_TOTAL_LINES (w
)))
11429 int old_height
= WINDOW_TOTAL_LINES (w
);
11431 XSETFRAME (frame
, f
);
11432 Fmodify_frame_parameters (frame
,
11433 Fcons (Fcons (Qtool_bar_lines
,
11434 make_number (nlines
)),
11436 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11438 clear_glyph_matrix (w
->desired_matrix
);
11439 fonts_changed_p
= 1;
11445 /* Display as many lines as needed to display all tool-bar items. */
11447 if (f
->n_tool_bar_rows
> 0)
11449 int border
, rows
, height
, extra
;
11451 if (INTEGERP (Vtool_bar_border
))
11452 border
= XINT (Vtool_bar_border
);
11453 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11454 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11455 else if (EQ (Vtool_bar_border
, Qborder_width
))
11456 border
= f
->border_width
;
11462 rows
= f
->n_tool_bar_rows
;
11463 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11464 extra
= it
.last_visible_y
- border
- height
* rows
;
11466 while (it
.current_y
< it
.last_visible_y
)
11469 if (extra
> 0 && rows
-- > 0)
11471 h
= (extra
+ rows
- 1) / rows
;
11474 display_tool_bar_line (&it
, height
+ h
);
11479 while (it
.current_y
< it
.last_visible_y
)
11480 display_tool_bar_line (&it
, 0);
11483 /* It doesn't make much sense to try scrolling in the tool-bar
11484 window, so don't do it. */
11485 w
->desired_matrix
->no_scrolling_p
= 1;
11486 w
->must_be_updated_p
= 1;
11488 if (!NILP (Vauto_resize_tool_bars
))
11490 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11491 int change_height_p
= 0;
11493 /* If we couldn't display everything, change the tool-bar's
11494 height if there is room for more. */
11495 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11496 && it
.current_y
< max_tool_bar_height
)
11497 change_height_p
= 1;
11499 row
= it
.glyph_row
- 1;
11501 /* If there are blank lines at the end, except for a partially
11502 visible blank line at the end that is smaller than
11503 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11504 if (!row
->displays_text_p
11505 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11506 change_height_p
= 1;
11508 /* If row displays tool-bar items, but is partially visible,
11509 change the tool-bar's height. */
11510 if (row
->displays_text_p
11511 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11512 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11513 change_height_p
= 1;
11515 /* Resize windows as needed by changing the `tool-bar-lines'
11516 frame parameter. */
11517 if (change_height_p
)
11520 int old_height
= WINDOW_TOTAL_LINES (w
);
11522 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11524 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11525 && !f
->minimize_tool_bar_window_p
)
11526 ? (nlines
> old_height
)
11527 : (nlines
!= old_height
));
11528 f
->minimize_tool_bar_window_p
= 0;
11530 if (change_height_p
)
11532 XSETFRAME (frame
, f
);
11533 Fmodify_frame_parameters (frame
,
11534 Fcons (Fcons (Qtool_bar_lines
,
11535 make_number (nlines
)),
11537 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11539 clear_glyph_matrix (w
->desired_matrix
);
11540 f
->n_tool_bar_rows
= nrows
;
11541 fonts_changed_p
= 1;
11548 f
->minimize_tool_bar_window_p
= 0;
11553 /* Get information about the tool-bar item which is displayed in GLYPH
11554 on frame F. Return in *PROP_IDX the index where tool-bar item
11555 properties start in F->tool_bar_items. Value is zero if
11556 GLYPH doesn't display a tool-bar item. */
11559 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11565 /* This function can be called asynchronously, which means we must
11566 exclude any possibility that Fget_text_property signals an
11568 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11569 charpos
= max (0, charpos
);
11571 /* Get the text property `menu-item' at pos. The value of that
11572 property is the start index of this item's properties in
11573 F->tool_bar_items. */
11574 prop
= Fget_text_property (make_number (charpos
),
11575 Qmenu_item
, f
->current_tool_bar_string
);
11576 if (INTEGERP (prop
))
11578 *prop_idx
= XINT (prop
);
11588 /* Get information about the tool-bar item at position X/Y on frame F.
11589 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11590 the current matrix of the tool-bar window of F, or NULL if not
11591 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11592 item in F->tool_bar_items. Value is
11594 -1 if X/Y is not on a tool-bar item
11595 0 if X/Y is on the same item that was highlighted before.
11599 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11600 int *hpos
, int *vpos
, int *prop_idx
)
11602 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11603 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11606 /* Find the glyph under X/Y. */
11607 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11608 if (*glyph
== NULL
)
11611 /* Get the start of this tool-bar item's properties in
11612 f->tool_bar_items. */
11613 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11616 /* Is mouse on the highlighted item? */
11617 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11618 && *vpos
>= hlinfo
->mouse_face_beg_row
11619 && *vpos
<= hlinfo
->mouse_face_end_row
11620 && (*vpos
> hlinfo
->mouse_face_beg_row
11621 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11622 && (*vpos
< hlinfo
->mouse_face_end_row
11623 || *hpos
< hlinfo
->mouse_face_end_col
11624 || hlinfo
->mouse_face_past_end
))
11632 Handle mouse button event on the tool-bar of frame F, at
11633 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11634 0 for button release. MODIFIERS is event modifiers for button
11638 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11639 unsigned int modifiers
)
11641 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11642 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11643 int hpos
, vpos
, prop_idx
;
11644 struct glyph
*glyph
;
11645 Lisp_Object enabled_p
;
11647 /* If not on the highlighted tool-bar item, return. */
11648 frame_to_window_pixel_xy (w
, &x
, &y
);
11649 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11652 /* If item is disabled, do nothing. */
11653 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11654 if (NILP (enabled_p
))
11659 /* Show item in pressed state. */
11660 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11661 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11662 last_tool_bar_item
= prop_idx
;
11666 Lisp_Object key
, frame
;
11667 struct input_event event
;
11668 EVENT_INIT (event
);
11670 /* Show item in released state. */
11671 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11672 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11674 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11676 XSETFRAME (frame
, f
);
11677 event
.kind
= TOOL_BAR_EVENT
;
11678 event
.frame_or_window
= frame
;
11680 kbd_buffer_store_event (&event
);
11682 event
.kind
= TOOL_BAR_EVENT
;
11683 event
.frame_or_window
= frame
;
11685 event
.modifiers
= modifiers
;
11686 kbd_buffer_store_event (&event
);
11687 last_tool_bar_item
= -1;
11692 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11693 tool-bar window-relative coordinates X/Y. Called from
11694 note_mouse_highlight. */
11697 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11699 Lisp_Object window
= f
->tool_bar_window
;
11700 struct window
*w
= XWINDOW (window
);
11701 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11702 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11704 struct glyph
*glyph
;
11705 struct glyph_row
*row
;
11707 Lisp_Object enabled_p
;
11709 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11710 int mouse_down_p
, rc
;
11712 /* Function note_mouse_highlight is called with negative X/Y
11713 values when mouse moves outside of the frame. */
11714 if (x
<= 0 || y
<= 0)
11716 clear_mouse_face (hlinfo
);
11720 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11723 /* Not on tool-bar item. */
11724 clear_mouse_face (hlinfo
);
11728 /* On same tool-bar item as before. */
11729 goto set_help_echo
;
11731 clear_mouse_face (hlinfo
);
11733 /* Mouse is down, but on different tool-bar item? */
11734 mouse_down_p
= (dpyinfo
->grabbed
11735 && f
== last_mouse_frame
11736 && FRAME_LIVE_P (f
));
11738 && last_tool_bar_item
!= prop_idx
)
11741 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11742 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11744 /* If tool-bar item is not enabled, don't highlight it. */
11745 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11746 if (!NILP (enabled_p
))
11748 /* Compute the x-position of the glyph. In front and past the
11749 image is a space. We include this in the highlighted area. */
11750 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11751 for (i
= x
= 0; i
< hpos
; ++i
)
11752 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11754 /* Record this as the current active region. */
11755 hlinfo
->mouse_face_beg_col
= hpos
;
11756 hlinfo
->mouse_face_beg_row
= vpos
;
11757 hlinfo
->mouse_face_beg_x
= x
;
11758 hlinfo
->mouse_face_beg_y
= row
->y
;
11759 hlinfo
->mouse_face_past_end
= 0;
11761 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11762 hlinfo
->mouse_face_end_row
= vpos
;
11763 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11764 hlinfo
->mouse_face_end_y
= row
->y
;
11765 hlinfo
->mouse_face_window
= window
;
11766 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11768 /* Display it as active. */
11769 show_mouse_face (hlinfo
, draw
);
11770 hlinfo
->mouse_face_image_state
= draw
;
11775 /* Set help_echo_string to a help string to display for this tool-bar item.
11776 XTread_socket does the rest. */
11777 help_echo_object
= help_echo_window
= Qnil
;
11778 help_echo_pos
= -1;
11779 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11780 if (NILP (help_echo_string
))
11781 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11784 #endif /* HAVE_WINDOW_SYSTEM */
11788 /************************************************************************
11789 Horizontal scrolling
11790 ************************************************************************/
11792 static int hscroll_window_tree (Lisp_Object
);
11793 static int hscroll_windows (Lisp_Object
);
11795 /* For all leaf windows in the window tree rooted at WINDOW, set their
11796 hscroll value so that PT is (i) visible in the window, and (ii) so
11797 that it is not within a certain margin at the window's left and
11798 right border. Value is non-zero if any window's hscroll has been
11802 hscroll_window_tree (Lisp_Object window
)
11804 int hscrolled_p
= 0;
11805 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11806 int hscroll_step_abs
= 0;
11807 double hscroll_step_rel
= 0;
11809 if (hscroll_relative_p
)
11811 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11812 if (hscroll_step_rel
< 0)
11814 hscroll_relative_p
= 0;
11815 hscroll_step_abs
= 0;
11818 else if (INTEGERP (Vhscroll_step
))
11820 hscroll_step_abs
= XINT (Vhscroll_step
);
11821 if (hscroll_step_abs
< 0)
11822 hscroll_step_abs
= 0;
11825 hscroll_step_abs
= 0;
11827 while (WINDOWP (window
))
11829 struct window
*w
= XWINDOW (window
);
11831 if (WINDOWP (w
->hchild
))
11832 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11833 else if (WINDOWP (w
->vchild
))
11834 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11835 else if (w
->cursor
.vpos
>= 0)
11838 int text_area_width
;
11839 struct glyph_row
*current_cursor_row
11840 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11841 struct glyph_row
*desired_cursor_row
11842 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11843 struct glyph_row
*cursor_row
11844 = (desired_cursor_row
->enabled_p
11845 ? desired_cursor_row
11846 : current_cursor_row
);
11848 text_area_width
= window_box_width (w
, TEXT_AREA
);
11850 /* Scroll when cursor is inside this scroll margin. */
11851 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11853 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11854 && ((XFASTINT (w
->hscroll
)
11855 && w
->cursor
.x
<= h_margin
)
11856 || (cursor_row
->enabled_p
11857 && cursor_row
->truncated_on_right_p
11858 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11862 struct buffer
*saved_current_buffer
;
11866 /* Find point in a display of infinite width. */
11867 saved_current_buffer
= current_buffer
;
11868 current_buffer
= XBUFFER (w
->buffer
);
11870 if (w
== XWINDOW (selected_window
))
11874 pt
= marker_position (w
->pointm
);
11875 pt
= max (BEGV
, pt
);
11879 /* Move iterator to pt starting at cursor_row->start in
11880 a line with infinite width. */
11881 init_to_row_start (&it
, w
, cursor_row
);
11882 it
.last_visible_x
= INFINITY
;
11883 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11884 current_buffer
= saved_current_buffer
;
11886 /* Position cursor in window. */
11887 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11888 hscroll
= max (0, (it
.current_x
11889 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11890 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11891 : (text_area_width
/ 2))))
11892 / FRAME_COLUMN_WIDTH (it
.f
);
11893 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11895 if (hscroll_relative_p
)
11896 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11899 wanted_x
= text_area_width
11900 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11903 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11907 if (hscroll_relative_p
)
11908 wanted_x
= text_area_width
* hscroll_step_rel
11911 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11914 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11916 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11918 /* Don't call Fset_window_hscroll if value hasn't
11919 changed because it will prevent redisplay
11921 if (XFASTINT (w
->hscroll
) != hscroll
)
11923 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11924 w
->hscroll
= make_number (hscroll
);
11933 /* Value is non-zero if hscroll of any leaf window has been changed. */
11934 return hscrolled_p
;
11938 /* Set hscroll so that cursor is visible and not inside horizontal
11939 scroll margins for all windows in the tree rooted at WINDOW. See
11940 also hscroll_window_tree above. Value is non-zero if any window's
11941 hscroll has been changed. If it has, desired matrices on the frame
11942 of WINDOW are cleared. */
11945 hscroll_windows (Lisp_Object window
)
11947 int hscrolled_p
= hscroll_window_tree (window
);
11949 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11950 return hscrolled_p
;
11955 /************************************************************************
11957 ************************************************************************/
11959 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11960 to a non-zero value. This is sometimes handy to have in a debugger
11965 /* First and last unchanged row for try_window_id. */
11967 static int debug_first_unchanged_at_end_vpos
;
11968 static int debug_last_unchanged_at_beg_vpos
;
11970 /* Delta vpos and y. */
11972 static int debug_dvpos
, debug_dy
;
11974 /* Delta in characters and bytes for try_window_id. */
11976 static EMACS_INT debug_delta
, debug_delta_bytes
;
11978 /* Values of window_end_pos and window_end_vpos at the end of
11981 static EMACS_INT debug_end_vpos
;
11983 /* Append a string to W->desired_matrix->method. FMT is a printf
11984 format string. If trace_redisplay_p is non-zero also printf the
11985 resulting string to stderr. */
11987 static void debug_method_add (struct window
*, char const *, ...)
11988 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11991 debug_method_add (struct window
*w
, char const *fmt
, ...)
11994 char *method
= w
->desired_matrix
->method
;
11995 int len
= strlen (method
);
11996 int size
= sizeof w
->desired_matrix
->method
;
11997 int remaining
= size
- len
- 1;
12000 va_start (ap
, fmt
);
12001 vsprintf (buffer
, fmt
, ap
);
12003 if (len
&& remaining
)
12006 --remaining
, ++len
;
12009 strncpy (method
+ len
, buffer
, remaining
);
12011 if (trace_redisplay_p
)
12012 fprintf (stderr
, "%p (%s): %s\n",
12014 ((BUFFERP (w
->buffer
)
12015 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12016 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12021 #endif /* GLYPH_DEBUG */
12024 /* Value is non-zero if all changes in window W, which displays
12025 current_buffer, are in the text between START and END. START is a
12026 buffer position, END is given as a distance from Z. Used in
12027 redisplay_internal for display optimization. */
12030 text_outside_line_unchanged_p (struct window
*w
,
12031 EMACS_INT start
, EMACS_INT end
)
12033 int unchanged_p
= 1;
12035 /* If text or overlays have changed, see where. */
12036 if (XFASTINT (w
->last_modified
) < MODIFF
12037 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12039 /* Gap in the line? */
12040 if (GPT
< start
|| Z
- GPT
< end
)
12043 /* Changes start in front of the line, or end after it? */
12045 && (BEG_UNCHANGED
< start
- 1
12046 || END_UNCHANGED
< end
))
12049 /* If selective display, can't optimize if changes start at the
12050 beginning of the line. */
12052 && INTEGERP (BVAR (current_buffer
, selective_display
))
12053 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12054 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12057 /* If there are overlays at the start or end of the line, these
12058 may have overlay strings with newlines in them. A change at
12059 START, for instance, may actually concern the display of such
12060 overlay strings as well, and they are displayed on different
12061 lines. So, quickly rule out this case. (For the future, it
12062 might be desirable to implement something more telling than
12063 just BEG/END_UNCHANGED.) */
12066 if (BEG
+ BEG_UNCHANGED
== start
12067 && overlay_touches_p (start
))
12069 if (END_UNCHANGED
== end
12070 && overlay_touches_p (Z
- end
))
12074 /* Under bidi reordering, adding or deleting a character in the
12075 beginning of a paragraph, before the first strong directional
12076 character, can change the base direction of the paragraph (unless
12077 the buffer specifies a fixed paragraph direction), which will
12078 require to redisplay the whole paragraph. It might be worthwhile
12079 to find the paragraph limits and widen the range of redisplayed
12080 lines to that, but for now just give up this optimization. */
12081 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12082 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12086 return unchanged_p
;
12090 /* Do a frame update, taking possible shortcuts into account. This is
12091 the main external entry point for redisplay.
12093 If the last redisplay displayed an echo area message and that message
12094 is no longer requested, we clear the echo area or bring back the
12095 mini-buffer if that is in use. */
12100 redisplay_internal ();
12105 overlay_arrow_string_or_property (Lisp_Object var
)
12109 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12112 return Voverlay_arrow_string
;
12115 /* Return 1 if there are any overlay-arrows in current_buffer. */
12117 overlay_arrow_in_current_buffer_p (void)
12121 for (vlist
= Voverlay_arrow_variable_list
;
12123 vlist
= XCDR (vlist
))
12125 Lisp_Object var
= XCAR (vlist
);
12128 if (!SYMBOLP (var
))
12130 val
= find_symbol_value (var
);
12132 && current_buffer
== XMARKER (val
)->buffer
)
12139 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12143 overlay_arrows_changed_p (void)
12147 for (vlist
= Voverlay_arrow_variable_list
;
12149 vlist
= XCDR (vlist
))
12151 Lisp_Object var
= XCAR (vlist
);
12152 Lisp_Object val
, pstr
;
12154 if (!SYMBOLP (var
))
12156 val
= find_symbol_value (var
);
12157 if (!MARKERP (val
))
12159 if (! EQ (COERCE_MARKER (val
),
12160 Fget (var
, Qlast_arrow_position
))
12161 || ! (pstr
= overlay_arrow_string_or_property (var
),
12162 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12168 /* Mark overlay arrows to be updated on next redisplay. */
12171 update_overlay_arrows (int up_to_date
)
12175 for (vlist
= Voverlay_arrow_variable_list
;
12177 vlist
= XCDR (vlist
))
12179 Lisp_Object var
= XCAR (vlist
);
12181 if (!SYMBOLP (var
))
12184 if (up_to_date
> 0)
12186 Lisp_Object val
= find_symbol_value (var
);
12187 Fput (var
, Qlast_arrow_position
,
12188 COERCE_MARKER (val
));
12189 Fput (var
, Qlast_arrow_string
,
12190 overlay_arrow_string_or_property (var
));
12192 else if (up_to_date
< 0
12193 || !NILP (Fget (var
, Qlast_arrow_position
)))
12195 Fput (var
, Qlast_arrow_position
, Qt
);
12196 Fput (var
, Qlast_arrow_string
, Qt
);
12202 /* Return overlay arrow string to display at row.
12203 Return integer (bitmap number) for arrow bitmap in left fringe.
12204 Return nil if no overlay arrow. */
12207 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12211 for (vlist
= Voverlay_arrow_variable_list
;
12213 vlist
= XCDR (vlist
))
12215 Lisp_Object var
= XCAR (vlist
);
12218 if (!SYMBOLP (var
))
12221 val
= find_symbol_value (var
);
12224 && current_buffer
== XMARKER (val
)->buffer
12225 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12227 if (FRAME_WINDOW_P (it
->f
)
12228 /* FIXME: if ROW->reversed_p is set, this should test
12229 the right fringe, not the left one. */
12230 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12232 #ifdef HAVE_WINDOW_SYSTEM
12233 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12236 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12237 return make_number (fringe_bitmap
);
12240 return make_number (-1); /* Use default arrow bitmap */
12242 return overlay_arrow_string_or_property (var
);
12249 /* Return 1 if point moved out of or into a composition. Otherwise
12250 return 0. PREV_BUF and PREV_PT are the last point buffer and
12251 position. BUF and PT are the current point buffer and position. */
12254 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12255 struct buffer
*buf
, EMACS_INT pt
)
12257 EMACS_INT start
, end
;
12259 Lisp_Object buffer
;
12261 XSETBUFFER (buffer
, buf
);
12262 /* Check a composition at the last point if point moved within the
12264 if (prev_buf
== buf
)
12267 /* Point didn't move. */
12270 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12271 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12272 && COMPOSITION_VALID_P (start
, end
, prop
)
12273 && start
< prev_pt
&& end
> prev_pt
)
12274 /* The last point was within the composition. Return 1 iff
12275 point moved out of the composition. */
12276 return (pt
<= start
|| pt
>= end
);
12279 /* Check a composition at the current point. */
12280 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12281 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12282 && COMPOSITION_VALID_P (start
, end
, prop
)
12283 && start
< pt
&& end
> pt
);
12287 /* Reconsider the setting of B->clip_changed which is displayed
12291 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12293 if (b
->clip_changed
12294 && !NILP (w
->window_end_valid
)
12295 && w
->current_matrix
->buffer
== b
12296 && w
->current_matrix
->zv
== BUF_ZV (b
)
12297 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12298 b
->clip_changed
= 0;
12300 /* If display wasn't paused, and W is not a tool bar window, see if
12301 point has been moved into or out of a composition. In that case,
12302 we set b->clip_changed to 1 to force updating the screen. If
12303 b->clip_changed has already been set to 1, we can skip this
12305 if (!b
->clip_changed
12306 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12310 if (w
== XWINDOW (selected_window
))
12313 pt
= marker_position (w
->pointm
);
12315 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12316 || pt
!= XINT (w
->last_point
))
12317 && check_point_in_composition (w
->current_matrix
->buffer
,
12318 XINT (w
->last_point
),
12319 XBUFFER (w
->buffer
), pt
))
12320 b
->clip_changed
= 1;
12325 /* Select FRAME to forward the values of frame-local variables into C
12326 variables so that the redisplay routines can access those values
12330 select_frame_for_redisplay (Lisp_Object frame
)
12332 Lisp_Object tail
, tem
;
12333 Lisp_Object old
= selected_frame
;
12334 struct Lisp_Symbol
*sym
;
12336 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12338 selected_frame
= frame
;
12341 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12342 if (CONSP (XCAR (tail
))
12343 && (tem
= XCAR (XCAR (tail
)),
12345 && (sym
= indirect_variable (XSYMBOL (tem
)),
12346 sym
->redirect
== SYMBOL_LOCALIZED
)
12347 && sym
->val
.blv
->frame_local
)
12348 /* Use find_symbol_value rather than Fsymbol_value
12349 to avoid an error if it is void. */
12350 find_symbol_value (tem
);
12351 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12355 #define STOP_POLLING \
12356 do { if (! polling_stopped_here) stop_polling (); \
12357 polling_stopped_here = 1; } while (0)
12359 #define RESUME_POLLING \
12360 do { if (polling_stopped_here) start_polling (); \
12361 polling_stopped_here = 0; } while (0)
12364 /* Perhaps in the future avoid recentering windows if it
12365 is not necessary; currently that causes some problems. */
12368 redisplay_internal (void)
12370 struct window
*w
= XWINDOW (selected_window
);
12374 int must_finish
= 0;
12375 struct text_pos tlbufpos
, tlendpos
;
12376 int number_of_visible_frames
;
12379 int polling_stopped_here
= 0;
12380 Lisp_Object old_frame
= selected_frame
;
12382 /* Non-zero means redisplay has to consider all windows on all
12383 frames. Zero means, only selected_window is considered. */
12384 int consider_all_windows_p
;
12386 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12388 /* No redisplay if running in batch mode or frame is not yet fully
12389 initialized, or redisplay is explicitly turned off by setting
12390 Vinhibit_redisplay. */
12391 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12392 || !NILP (Vinhibit_redisplay
))
12395 /* Don't examine these until after testing Vinhibit_redisplay.
12396 When Emacs is shutting down, perhaps because its connection to
12397 X has dropped, we should not look at them at all. */
12398 fr
= XFRAME (w
->frame
);
12399 sf
= SELECTED_FRAME ();
12401 if (!fr
->glyphs_initialized_p
)
12404 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12405 if (popup_activated ())
12409 /* I don't think this happens but let's be paranoid. */
12410 if (redisplaying_p
)
12413 /* Record a function that resets redisplaying_p to its old value
12414 when we leave this function. */
12415 count
= SPECPDL_INDEX ();
12416 record_unwind_protect (unwind_redisplay
,
12417 Fcons (make_number (redisplaying_p
), selected_frame
));
12419 specbind (Qinhibit_free_realized_faces
, Qnil
);
12422 Lisp_Object tail
, frame
;
12424 FOR_EACH_FRAME (tail
, frame
)
12426 struct frame
*f
= XFRAME (frame
);
12427 f
->already_hscrolled_p
= 0;
12432 /* Remember the currently selected window. */
12435 if (!EQ (old_frame
, selected_frame
)
12436 && FRAME_LIVE_P (XFRAME (old_frame
)))
12437 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12438 selected_frame and selected_window to be temporarily out-of-sync so
12439 when we come back here via `goto retry', we need to resync because we
12440 may need to run Elisp code (via prepare_menu_bars). */
12441 select_frame_for_redisplay (old_frame
);
12444 reconsider_clip_changes (w
, current_buffer
);
12445 last_escape_glyph_frame
= NULL
;
12446 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12447 last_glyphless_glyph_frame
= NULL
;
12448 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12450 /* If new fonts have been loaded that make a glyph matrix adjustment
12451 necessary, do it. */
12452 if (fonts_changed_p
)
12454 adjust_glyphs (NULL
);
12455 ++windows_or_buffers_changed
;
12456 fonts_changed_p
= 0;
12459 /* If face_change_count is non-zero, init_iterator will free all
12460 realized faces, which includes the faces referenced from current
12461 matrices. So, we can't reuse current matrices in this case. */
12462 if (face_change_count
)
12463 ++windows_or_buffers_changed
;
12465 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12466 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12468 /* Since frames on a single ASCII terminal share the same
12469 display area, displaying a different frame means redisplay
12470 the whole thing. */
12471 windows_or_buffers_changed
++;
12472 SET_FRAME_GARBAGED (sf
);
12474 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12476 FRAME_TTY (sf
)->previous_frame
= sf
;
12479 /* Set the visible flags for all frames. Do this before checking
12480 for resized or garbaged frames; they want to know if their frames
12481 are visible. See the comment in frame.h for
12482 FRAME_SAMPLE_VISIBILITY. */
12484 Lisp_Object tail
, frame
;
12486 number_of_visible_frames
= 0;
12488 FOR_EACH_FRAME (tail
, frame
)
12490 struct frame
*f
= XFRAME (frame
);
12492 FRAME_SAMPLE_VISIBILITY (f
);
12493 if (FRAME_VISIBLE_P (f
))
12494 ++number_of_visible_frames
;
12495 clear_desired_matrices (f
);
12499 /* Notice any pending interrupt request to change frame size. */
12500 do_pending_window_change (1);
12502 /* do_pending_window_change could change the selected_window due to
12503 frame resizing which makes the selected window too small. */
12504 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12507 reconsider_clip_changes (w
, current_buffer
);
12510 /* Clear frames marked as garbaged. */
12511 if (frame_garbaged
)
12512 clear_garbaged_frames ();
12514 /* Build menubar and tool-bar items. */
12515 if (NILP (Vmemory_full
))
12516 prepare_menu_bars ();
12518 if (windows_or_buffers_changed
)
12519 update_mode_lines
++;
12521 /* Detect case that we need to write or remove a star in the mode line. */
12522 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12524 w
->update_mode_line
= Qt
;
12525 if (buffer_shared
> 1)
12526 update_mode_lines
++;
12529 /* Avoid invocation of point motion hooks by `current_column' below. */
12530 count1
= SPECPDL_INDEX ();
12531 specbind (Qinhibit_point_motion_hooks
, Qt
);
12533 /* If %c is in the mode line, update it if needed. */
12534 if (!NILP (w
->column_number_displayed
)
12535 /* This alternative quickly identifies a common case
12536 where no change is needed. */
12537 && !(PT
== XFASTINT (w
->last_point
)
12538 && XFASTINT (w
->last_modified
) >= MODIFF
12539 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12540 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12541 w
->update_mode_line
= Qt
;
12543 unbind_to (count1
, Qnil
);
12545 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12547 /* The variable buffer_shared is set in redisplay_window and
12548 indicates that we redisplay a buffer in different windows. See
12550 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12551 || cursor_type_changed
);
12553 /* If specs for an arrow have changed, do thorough redisplay
12554 to ensure we remove any arrow that should no longer exist. */
12555 if (overlay_arrows_changed_p ())
12556 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12558 /* Normally the message* functions will have already displayed and
12559 updated the echo area, but the frame may have been trashed, or
12560 the update may have been preempted, so display the echo area
12561 again here. Checking message_cleared_p captures the case that
12562 the echo area should be cleared. */
12563 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12564 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12565 || (message_cleared_p
12566 && minibuf_level
== 0
12567 /* If the mini-window is currently selected, this means the
12568 echo-area doesn't show through. */
12569 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12571 int window_height_changed_p
= echo_area_display (0);
12574 /* If we don't display the current message, don't clear the
12575 message_cleared_p flag, because, if we did, we wouldn't clear
12576 the echo area in the next redisplay which doesn't preserve
12578 if (!display_last_displayed_message_p
)
12579 message_cleared_p
= 0;
12581 if (fonts_changed_p
)
12583 else if (window_height_changed_p
)
12585 consider_all_windows_p
= 1;
12586 ++update_mode_lines
;
12587 ++windows_or_buffers_changed
;
12589 /* If window configuration was changed, frames may have been
12590 marked garbaged. Clear them or we will experience
12591 surprises wrt scrolling. */
12592 if (frame_garbaged
)
12593 clear_garbaged_frames ();
12596 else if (EQ (selected_window
, minibuf_window
)
12597 && (current_buffer
->clip_changed
12598 || XFASTINT (w
->last_modified
) < MODIFF
12599 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12600 && resize_mini_window (w
, 0))
12602 /* Resized active mini-window to fit the size of what it is
12603 showing if its contents might have changed. */
12605 /* FIXME: this causes all frames to be updated, which seems unnecessary
12606 since only the current frame needs to be considered. This function needs
12607 to be rewritten with two variables, consider_all_windows and
12608 consider_all_frames. */
12609 consider_all_windows_p
= 1;
12610 ++windows_or_buffers_changed
;
12611 ++update_mode_lines
;
12613 /* If window configuration was changed, frames may have been
12614 marked garbaged. Clear them or we will experience
12615 surprises wrt scrolling. */
12616 if (frame_garbaged
)
12617 clear_garbaged_frames ();
12621 /* If showing the region, and mark has changed, we must redisplay
12622 the whole window. The assignment to this_line_start_pos prevents
12623 the optimization directly below this if-statement. */
12624 if (((!NILP (Vtransient_mark_mode
)
12625 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12626 != !NILP (w
->region_showing
))
12627 || (!NILP (w
->region_showing
)
12628 && !EQ (w
->region_showing
,
12629 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12630 CHARPOS (this_line_start_pos
) = 0;
12632 /* Optimize the case that only the line containing the cursor in the
12633 selected window has changed. Variables starting with this_ are
12634 set in display_line and record information about the line
12635 containing the cursor. */
12636 tlbufpos
= this_line_start_pos
;
12637 tlendpos
= this_line_end_pos
;
12638 if (!consider_all_windows_p
12639 && CHARPOS (tlbufpos
) > 0
12640 && NILP (w
->update_mode_line
)
12641 && !current_buffer
->clip_changed
12642 && !current_buffer
->prevent_redisplay_optimizations_p
12643 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12644 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12645 /* Make sure recorded data applies to current buffer, etc. */
12646 && this_line_buffer
== current_buffer
12647 && current_buffer
== XBUFFER (w
->buffer
)
12648 && NILP (w
->force_start
)
12649 && NILP (w
->optional_new_start
)
12650 /* Point must be on the line that we have info recorded about. */
12651 && PT
>= CHARPOS (tlbufpos
)
12652 && PT
<= Z
- CHARPOS (tlendpos
)
12653 /* All text outside that line, including its final newline,
12654 must be unchanged. */
12655 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12656 CHARPOS (tlendpos
)))
12658 if (CHARPOS (tlbufpos
) > BEGV
12659 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12660 && (CHARPOS (tlbufpos
) == ZV
12661 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12662 /* Former continuation line has disappeared by becoming empty. */
12664 else if (XFASTINT (w
->last_modified
) < MODIFF
12665 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12666 || MINI_WINDOW_P (w
))
12668 /* We have to handle the case of continuation around a
12669 wide-column character (see the comment in indent.c around
12672 For instance, in the following case:
12674 -------- Insert --------
12675 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12676 J_I_ ==> J_I_ `^^' are cursors.
12680 As we have to redraw the line above, we cannot use this
12684 int line_height_before
= this_line_pixel_height
;
12686 /* Note that start_display will handle the case that the
12687 line starting at tlbufpos is a continuation line. */
12688 start_display (&it
, w
, tlbufpos
);
12690 /* Implementation note: It this still necessary? */
12691 if (it
.current_x
!= this_line_start_x
)
12694 TRACE ((stderr
, "trying display optimization 1\n"));
12695 w
->cursor
.vpos
= -1;
12696 overlay_arrow_seen
= 0;
12697 it
.vpos
= this_line_vpos
;
12698 it
.current_y
= this_line_y
;
12699 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12700 display_line (&it
);
12702 /* If line contains point, is not continued,
12703 and ends at same distance from eob as before, we win. */
12704 if (w
->cursor
.vpos
>= 0
12705 /* Line is not continued, otherwise this_line_start_pos
12706 would have been set to 0 in display_line. */
12707 && CHARPOS (this_line_start_pos
)
12708 /* Line ends as before. */
12709 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12710 /* Line has same height as before. Otherwise other lines
12711 would have to be shifted up or down. */
12712 && this_line_pixel_height
== line_height_before
)
12714 /* If this is not the window's last line, we must adjust
12715 the charstarts of the lines below. */
12716 if (it
.current_y
< it
.last_visible_y
)
12718 struct glyph_row
*row
12719 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12720 EMACS_INT delta
, delta_bytes
;
12722 /* We used to distinguish between two cases here,
12723 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12724 when the line ends in a newline or the end of the
12725 buffer's accessible portion. But both cases did
12726 the same, so they were collapsed. */
12728 - CHARPOS (tlendpos
)
12729 - MATRIX_ROW_START_CHARPOS (row
));
12730 delta_bytes
= (Z_BYTE
12731 - BYTEPOS (tlendpos
)
12732 - MATRIX_ROW_START_BYTEPOS (row
));
12734 increment_matrix_positions (w
->current_matrix
,
12735 this_line_vpos
+ 1,
12736 w
->current_matrix
->nrows
,
12737 delta
, delta_bytes
);
12740 /* If this row displays text now but previously didn't,
12741 or vice versa, w->window_end_vpos may have to be
12743 if ((it
.glyph_row
- 1)->displays_text_p
)
12745 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12746 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12748 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12749 && this_line_vpos
> 0)
12750 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12751 w
->window_end_valid
= Qnil
;
12753 /* Update hint: No need to try to scroll in update_window. */
12754 w
->desired_matrix
->no_scrolling_p
= 1;
12757 *w
->desired_matrix
->method
= 0;
12758 debug_method_add (w
, "optimization 1");
12760 #ifdef HAVE_WINDOW_SYSTEM
12761 update_window_fringes (w
, 0);
12768 else if (/* Cursor position hasn't changed. */
12769 PT
== XFASTINT (w
->last_point
)
12770 /* Make sure the cursor was last displayed
12771 in this window. Otherwise we have to reposition it. */
12772 && 0 <= w
->cursor
.vpos
12773 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12777 do_pending_window_change (1);
12778 /* If selected_window changed, redisplay again. */
12779 if (WINDOWP (selected_window
)
12780 && (w
= XWINDOW (selected_window
)) != sw
)
12783 /* We used to always goto end_of_redisplay here, but this
12784 isn't enough if we have a blinking cursor. */
12785 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12786 goto end_of_redisplay
;
12790 /* If highlighting the region, or if the cursor is in the echo area,
12791 then we can't just move the cursor. */
12792 else if (! (!NILP (Vtransient_mark_mode
)
12793 && !NILP (BVAR (current_buffer
, mark_active
)))
12794 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12795 || highlight_nonselected_windows
)
12796 && NILP (w
->region_showing
)
12797 && NILP (Vshow_trailing_whitespace
)
12798 && !cursor_in_echo_area
)
12801 struct glyph_row
*row
;
12803 /* Skip from tlbufpos to PT and see where it is. Note that
12804 PT may be in invisible text. If so, we will end at the
12805 next visible position. */
12806 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12807 NULL
, DEFAULT_FACE_ID
);
12808 it
.current_x
= this_line_start_x
;
12809 it
.current_y
= this_line_y
;
12810 it
.vpos
= this_line_vpos
;
12812 /* The call to move_it_to stops in front of PT, but
12813 moves over before-strings. */
12814 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12816 if (it
.vpos
== this_line_vpos
12817 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12820 xassert (this_line_vpos
== it
.vpos
);
12821 xassert (this_line_y
== it
.current_y
);
12822 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12824 *w
->desired_matrix
->method
= 0;
12825 debug_method_add (w
, "optimization 3");
12834 /* Text changed drastically or point moved off of line. */
12835 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12838 CHARPOS (this_line_start_pos
) = 0;
12839 consider_all_windows_p
|= buffer_shared
> 1;
12840 ++clear_face_cache_count
;
12841 #ifdef HAVE_WINDOW_SYSTEM
12842 ++clear_image_cache_count
;
12845 /* Build desired matrices, and update the display. If
12846 consider_all_windows_p is non-zero, do it for all windows on all
12847 frames. Otherwise do it for selected_window, only. */
12849 if (consider_all_windows_p
)
12851 Lisp_Object tail
, frame
;
12853 FOR_EACH_FRAME (tail
, frame
)
12854 XFRAME (frame
)->updated_p
= 0;
12856 /* Recompute # windows showing selected buffer. This will be
12857 incremented each time such a window is displayed. */
12860 FOR_EACH_FRAME (tail
, frame
)
12862 struct frame
*f
= XFRAME (frame
);
12864 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12866 if (! EQ (frame
, selected_frame
))
12867 /* Select the frame, for the sake of frame-local
12869 select_frame_for_redisplay (frame
);
12871 /* Mark all the scroll bars to be removed; we'll redeem
12872 the ones we want when we redisplay their windows. */
12873 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12874 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12876 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12877 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12879 /* The X error handler may have deleted that frame. */
12880 if (!FRAME_LIVE_P (f
))
12883 /* Any scroll bars which redisplay_windows should have
12884 nuked should now go away. */
12885 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12886 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12888 /* If fonts changed, display again. */
12889 /* ??? rms: I suspect it is a mistake to jump all the way
12890 back to retry here. It should just retry this frame. */
12891 if (fonts_changed_p
)
12894 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12896 /* See if we have to hscroll. */
12897 if (!f
->already_hscrolled_p
)
12899 f
->already_hscrolled_p
= 1;
12900 if (hscroll_windows (f
->root_window
))
12904 /* Prevent various kinds of signals during display
12905 update. stdio is not robust about handling
12906 signals, which can cause an apparent I/O
12908 if (interrupt_input
)
12909 unrequest_sigio ();
12912 /* Update the display. */
12913 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12914 pending
|= update_frame (f
, 0, 0);
12920 if (!EQ (old_frame
, selected_frame
)
12921 && FRAME_LIVE_P (XFRAME (old_frame
)))
12922 /* We played a bit fast-and-loose above and allowed selected_frame
12923 and selected_window to be temporarily out-of-sync but let's make
12924 sure this stays contained. */
12925 select_frame_for_redisplay (old_frame
);
12926 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12930 /* Do the mark_window_display_accurate after all windows have
12931 been redisplayed because this call resets flags in buffers
12932 which are needed for proper redisplay. */
12933 FOR_EACH_FRAME (tail
, frame
)
12935 struct frame
*f
= XFRAME (frame
);
12938 mark_window_display_accurate (f
->root_window
, 1);
12939 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12940 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12945 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12947 Lisp_Object mini_window
;
12948 struct frame
*mini_frame
;
12950 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12951 /* Use list_of_error, not Qerror, so that
12952 we catch only errors and don't run the debugger. */
12953 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12955 redisplay_window_error
);
12957 /* Compare desired and current matrices, perform output. */
12960 /* If fonts changed, display again. */
12961 if (fonts_changed_p
)
12964 /* Prevent various kinds of signals during display update.
12965 stdio is not robust about handling signals,
12966 which can cause an apparent I/O error. */
12967 if (interrupt_input
)
12968 unrequest_sigio ();
12971 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12973 if (hscroll_windows (selected_window
))
12976 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12977 pending
= update_frame (sf
, 0, 0);
12980 /* We may have called echo_area_display at the top of this
12981 function. If the echo area is on another frame, that may
12982 have put text on a frame other than the selected one, so the
12983 above call to update_frame would not have caught it. Catch
12985 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12986 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12988 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12990 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12991 pending
|= update_frame (mini_frame
, 0, 0);
12992 if (!pending
&& hscroll_windows (mini_window
))
12997 /* If display was paused because of pending input, make sure we do a
12998 thorough update the next time. */
13001 /* Prevent the optimization at the beginning of
13002 redisplay_internal that tries a single-line update of the
13003 line containing the cursor in the selected window. */
13004 CHARPOS (this_line_start_pos
) = 0;
13006 /* Let the overlay arrow be updated the next time. */
13007 update_overlay_arrows (0);
13009 /* If we pause after scrolling, some rows in the current
13010 matrices of some windows are not valid. */
13011 if (!WINDOW_FULL_WIDTH_P (w
)
13012 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13013 update_mode_lines
= 1;
13017 if (!consider_all_windows_p
)
13019 /* This has already been done above if
13020 consider_all_windows_p is set. */
13021 mark_window_display_accurate_1 (w
, 1);
13023 /* Say overlay arrows are up to date. */
13024 update_overlay_arrows (1);
13026 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13027 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13030 update_mode_lines
= 0;
13031 windows_or_buffers_changed
= 0;
13032 cursor_type_changed
= 0;
13035 /* Start SIGIO interrupts coming again. Having them off during the
13036 code above makes it less likely one will discard output, but not
13037 impossible, since there might be stuff in the system buffer here.
13038 But it is much hairier to try to do anything about that. */
13039 if (interrupt_input
)
13043 /* If a frame has become visible which was not before, redisplay
13044 again, so that we display it. Expose events for such a frame
13045 (which it gets when becoming visible) don't call the parts of
13046 redisplay constructing glyphs, so simply exposing a frame won't
13047 display anything in this case. So, we have to display these
13048 frames here explicitly. */
13051 Lisp_Object tail
, frame
;
13054 FOR_EACH_FRAME (tail
, frame
)
13056 int this_is_visible
= 0;
13058 if (XFRAME (frame
)->visible
)
13059 this_is_visible
= 1;
13060 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13061 if (XFRAME (frame
)->visible
)
13062 this_is_visible
= 1;
13064 if (this_is_visible
)
13068 if (new_count
!= number_of_visible_frames
)
13069 windows_or_buffers_changed
++;
13072 /* Change frame size now if a change is pending. */
13073 do_pending_window_change (1);
13075 /* If we just did a pending size change, or have additional
13076 visible frames, or selected_window changed, redisplay again. */
13077 if ((windows_or_buffers_changed
&& !pending
)
13078 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13081 /* Clear the face and image caches.
13083 We used to do this only if consider_all_windows_p. But the cache
13084 needs to be cleared if a timer creates images in the current
13085 buffer (e.g. the test case in Bug#6230). */
13087 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13089 clear_face_cache (0);
13090 clear_face_cache_count
= 0;
13093 #ifdef HAVE_WINDOW_SYSTEM
13094 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13096 clear_image_caches (Qnil
);
13097 clear_image_cache_count
= 0;
13099 #endif /* HAVE_WINDOW_SYSTEM */
13102 unbind_to (count
, Qnil
);
13107 /* Redisplay, but leave alone any recent echo area message unless
13108 another message has been requested in its place.
13110 This is useful in situations where you need to redisplay but no
13111 user action has occurred, making it inappropriate for the message
13112 area to be cleared. See tracking_off and
13113 wait_reading_process_output for examples of these situations.
13115 FROM_WHERE is an integer saying from where this function was
13116 called. This is useful for debugging. */
13119 redisplay_preserve_echo_area (int from_where
)
13121 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13123 if (!NILP (echo_area_buffer
[1]))
13125 /* We have a previously displayed message, but no current
13126 message. Redisplay the previous message. */
13127 display_last_displayed_message_p
= 1;
13128 redisplay_internal ();
13129 display_last_displayed_message_p
= 0;
13132 redisplay_internal ();
13134 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13135 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13136 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13140 /* Function registered with record_unwind_protect in
13141 redisplay_internal. Reset redisplaying_p to the value it had
13142 before redisplay_internal was called, and clear
13143 prevent_freeing_realized_faces_p. It also selects the previously
13144 selected frame, unless it has been deleted (by an X connection
13145 failure during redisplay, for example). */
13148 unwind_redisplay (Lisp_Object val
)
13150 Lisp_Object old_redisplaying_p
, old_frame
;
13152 old_redisplaying_p
= XCAR (val
);
13153 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13154 old_frame
= XCDR (val
);
13155 if (! EQ (old_frame
, selected_frame
)
13156 && FRAME_LIVE_P (XFRAME (old_frame
)))
13157 select_frame_for_redisplay (old_frame
);
13162 /* Mark the display of window W as accurate or inaccurate. If
13163 ACCURATE_P is non-zero mark display of W as accurate. If
13164 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13165 redisplay_internal is called. */
13168 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13170 if (BUFFERP (w
->buffer
))
13172 struct buffer
*b
= XBUFFER (w
->buffer
);
13175 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13176 w
->last_overlay_modified
13177 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13179 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13183 b
->clip_changed
= 0;
13184 b
->prevent_redisplay_optimizations_p
= 0;
13186 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13187 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13188 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13189 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13191 w
->current_matrix
->buffer
= b
;
13192 w
->current_matrix
->begv
= BUF_BEGV (b
);
13193 w
->current_matrix
->zv
= BUF_ZV (b
);
13195 w
->last_cursor
= w
->cursor
;
13196 w
->last_cursor_off_p
= w
->cursor_off_p
;
13198 if (w
== XWINDOW (selected_window
))
13199 w
->last_point
= make_number (BUF_PT (b
));
13201 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13207 w
->window_end_valid
= w
->buffer
;
13208 w
->update_mode_line
= Qnil
;
13213 /* Mark the display of windows in the window tree rooted at WINDOW as
13214 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13215 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13216 be redisplayed the next time redisplay_internal is called. */
13219 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13223 for (; !NILP (window
); window
= w
->next
)
13225 w
= XWINDOW (window
);
13226 mark_window_display_accurate_1 (w
, accurate_p
);
13228 if (!NILP (w
->vchild
))
13229 mark_window_display_accurate (w
->vchild
, accurate_p
);
13230 if (!NILP (w
->hchild
))
13231 mark_window_display_accurate (w
->hchild
, accurate_p
);
13236 update_overlay_arrows (1);
13240 /* Force a thorough redisplay the next time by setting
13241 last_arrow_position and last_arrow_string to t, which is
13242 unequal to any useful value of Voverlay_arrow_... */
13243 update_overlay_arrows (-1);
13248 /* Return value in display table DP (Lisp_Char_Table *) for character
13249 C. Since a display table doesn't have any parent, we don't have to
13250 follow parent. Do not call this function directly but use the
13251 macro DISP_CHAR_VECTOR. */
13254 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13258 if (ASCII_CHAR_P (c
))
13261 if (SUB_CHAR_TABLE_P (val
))
13262 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13268 XSETCHAR_TABLE (table
, dp
);
13269 val
= char_table_ref (table
, c
);
13278 /***********************************************************************
13280 ***********************************************************************/
13282 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13285 redisplay_windows (Lisp_Object window
)
13287 while (!NILP (window
))
13289 struct window
*w
= XWINDOW (window
);
13291 if (!NILP (w
->hchild
))
13292 redisplay_windows (w
->hchild
);
13293 else if (!NILP (w
->vchild
))
13294 redisplay_windows (w
->vchild
);
13295 else if (!NILP (w
->buffer
))
13297 displayed_buffer
= XBUFFER (w
->buffer
);
13298 /* Use list_of_error, not Qerror, so that
13299 we catch only errors and don't run the debugger. */
13300 internal_condition_case_1 (redisplay_window_0
, window
,
13302 redisplay_window_error
);
13310 redisplay_window_error (Lisp_Object ignore
)
13312 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13317 redisplay_window_0 (Lisp_Object window
)
13319 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13320 redisplay_window (window
, 0);
13325 redisplay_window_1 (Lisp_Object window
)
13327 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13328 redisplay_window (window
, 1);
13333 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13334 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13335 which positions recorded in ROW differ from current buffer
13338 Return 0 if cursor is not on this row, 1 otherwise. */
13341 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13342 struct glyph_matrix
*matrix
,
13343 EMACS_INT delta
, EMACS_INT delta_bytes
,
13346 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13347 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13348 struct glyph
*cursor
= NULL
;
13349 /* The last known character position in row. */
13350 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13352 EMACS_INT pt_old
= PT
- delta
;
13353 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13354 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13355 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13356 /* A glyph beyond the edge of TEXT_AREA which we should never
13358 struct glyph
*glyphs_end
= end
;
13359 /* Non-zero means we've found a match for cursor position, but that
13360 glyph has the avoid_cursor_p flag set. */
13361 int match_with_avoid_cursor
= 0;
13362 /* Non-zero means we've seen at least one glyph that came from a
13364 int string_seen
= 0;
13365 /* Largest and smalles buffer positions seen so far during scan of
13367 EMACS_INT bpos_max
= pos_before
;
13368 EMACS_INT bpos_min
= pos_after
;
13369 /* Last buffer position covered by an overlay string with an integer
13370 `cursor' property. */
13371 EMACS_INT bpos_covered
= 0;
13372 /* Non-zero means the display string on which to display the cursor
13373 comes from a text property, not from an overlay. */
13374 int string_from_text_prop
= 0;
13376 /* Skip over glyphs not having an object at the start and the end of
13377 the row. These are special glyphs like truncation marks on
13378 terminal frames. */
13379 if (row
->displays_text_p
)
13381 if (!row
->reversed_p
)
13384 && INTEGERP (glyph
->object
)
13385 && glyph
->charpos
< 0)
13387 x
+= glyph
->pixel_width
;
13391 && INTEGERP ((end
- 1)->object
)
13392 /* CHARPOS is zero for blanks and stretch glyphs
13393 inserted by extend_face_to_end_of_line. */
13394 && (end
- 1)->charpos
<= 0)
13396 glyph_before
= glyph
- 1;
13403 /* If the glyph row is reversed, we need to process it from back
13404 to front, so swap the edge pointers. */
13405 glyphs_end
= end
= glyph
- 1;
13406 glyph
+= row
->used
[TEXT_AREA
] - 1;
13408 while (glyph
> end
+ 1
13409 && INTEGERP (glyph
->object
)
13410 && glyph
->charpos
< 0)
13413 x
-= glyph
->pixel_width
;
13415 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13417 /* By default, in reversed rows we put the cursor on the
13418 rightmost (first in the reading order) glyph. */
13419 for (g
= end
+ 1; g
< glyph
; g
++)
13420 x
+= g
->pixel_width
;
13422 && INTEGERP ((end
+ 1)->object
)
13423 && (end
+ 1)->charpos
<= 0)
13425 glyph_before
= glyph
+ 1;
13429 else if (row
->reversed_p
)
13431 /* In R2L rows that don't display text, put the cursor on the
13432 rightmost glyph. Case in point: an empty last line that is
13433 part of an R2L paragraph. */
13435 /* Avoid placing the cursor on the last glyph of the row, where
13436 on terminal frames we hold the vertical border between
13437 adjacent windows. */
13438 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13439 && !WINDOW_RIGHTMOST_P (w
)
13440 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13442 x
= -1; /* will be computed below, at label compute_x */
13445 /* Step 1: Try to find the glyph whose character position
13446 corresponds to point. If that's not possible, find 2 glyphs
13447 whose character positions are the closest to point, one before
13448 point, the other after it. */
13449 if (!row
->reversed_p
)
13450 while (/* not marched to end of glyph row */
13452 /* glyph was not inserted by redisplay for internal purposes */
13453 && !INTEGERP (glyph
->object
))
13455 if (BUFFERP (glyph
->object
))
13457 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13459 if (glyph
->charpos
> bpos_max
)
13460 bpos_max
= glyph
->charpos
;
13461 if (glyph
->charpos
< bpos_min
)
13462 bpos_min
= glyph
->charpos
;
13463 if (!glyph
->avoid_cursor_p
)
13465 /* If we hit point, we've found the glyph on which to
13466 display the cursor. */
13469 match_with_avoid_cursor
= 0;
13472 /* See if we've found a better approximation to
13473 POS_BEFORE or to POS_AFTER. Note that we want the
13474 first (leftmost) glyph of all those that are the
13475 closest from below, and the last (rightmost) of all
13476 those from above. */
13477 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13479 pos_before
= glyph
->charpos
;
13480 glyph_before
= glyph
;
13482 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13484 pos_after
= glyph
->charpos
;
13485 glyph_after
= glyph
;
13488 else if (dpos
== 0)
13489 match_with_avoid_cursor
= 1;
13491 else if (STRINGP (glyph
->object
))
13493 Lisp_Object chprop
;
13494 EMACS_INT glyph_pos
= glyph
->charpos
;
13496 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13498 if (INTEGERP (chprop
))
13500 bpos_covered
= bpos_max
+ XINT (chprop
);
13501 /* If the `cursor' property covers buffer positions up
13502 to and including point, we should display cursor on
13503 this glyph. Note that overlays and text properties
13504 with string values stop bidi reordering, so every
13505 buffer position to the left of the string is always
13506 smaller than any position to the right of the
13507 string. Therefore, if a `cursor' property on one
13508 of the string's characters has an integer value, we
13509 will break out of the loop below _before_ we get to
13510 the position match above. IOW, integer values of
13511 the `cursor' property override the "exact match for
13512 point" strategy of positioning the cursor. */
13513 /* Implementation note: bpos_max == pt_old when, e.g.,
13514 we are in an empty line, where bpos_max is set to
13515 MATRIX_ROW_START_CHARPOS, see above. */
13516 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13525 x
+= glyph
->pixel_width
;
13528 else if (glyph
> end
) /* row is reversed */
13529 while (!INTEGERP (glyph
->object
))
13531 if (BUFFERP (glyph
->object
))
13533 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13535 if (glyph
->charpos
> bpos_max
)
13536 bpos_max
= glyph
->charpos
;
13537 if (glyph
->charpos
< bpos_min
)
13538 bpos_min
= glyph
->charpos
;
13539 if (!glyph
->avoid_cursor_p
)
13543 match_with_avoid_cursor
= 0;
13546 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13548 pos_before
= glyph
->charpos
;
13549 glyph_before
= glyph
;
13551 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13553 pos_after
= glyph
->charpos
;
13554 glyph_after
= glyph
;
13557 else if (dpos
== 0)
13558 match_with_avoid_cursor
= 1;
13560 else if (STRINGP (glyph
->object
))
13562 Lisp_Object chprop
;
13563 EMACS_INT glyph_pos
= glyph
->charpos
;
13565 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13567 if (INTEGERP (chprop
))
13569 bpos_covered
= bpos_max
+ XINT (chprop
);
13570 /* If the `cursor' property covers buffer positions up
13571 to and including point, we should display cursor on
13573 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13582 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13584 x
--; /* can't use any pixel_width */
13587 x
-= glyph
->pixel_width
;
13590 /* Step 2: If we didn't find an exact match for point, we need to
13591 look for a proper place to put the cursor among glyphs between
13592 GLYPH_BEFORE and GLYPH_AFTER. */
13593 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13594 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13595 && bpos_covered
< pt_old
)
13597 /* An empty line has a single glyph whose OBJECT is zero and
13598 whose CHARPOS is the position of a newline on that line.
13599 Note that on a TTY, there are more glyphs after that, which
13600 were produced by extend_face_to_end_of_line, but their
13601 CHARPOS is zero or negative. */
13603 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13604 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13606 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13608 EMACS_INT ellipsis_pos
;
13610 /* Scan back over the ellipsis glyphs. */
13611 if (!row
->reversed_p
)
13613 ellipsis_pos
= (glyph
- 1)->charpos
;
13614 while (glyph
> row
->glyphs
[TEXT_AREA
]
13615 && (glyph
- 1)->charpos
== ellipsis_pos
)
13616 glyph
--, x
-= glyph
->pixel_width
;
13617 /* That loop always goes one position too far, including
13618 the glyph before the ellipsis. So scan forward over
13620 x
+= glyph
->pixel_width
;
13623 else /* row is reversed */
13625 ellipsis_pos
= (glyph
+ 1)->charpos
;
13626 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13627 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13628 glyph
++, x
+= glyph
->pixel_width
;
13629 x
-= glyph
->pixel_width
;
13633 else if (match_with_avoid_cursor
13634 /* A truncated row may not include PT among its
13635 character positions. Setting the cursor inside the
13636 scroll margin will trigger recalculation of hscroll
13637 in hscroll_window_tree. */
13638 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13639 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13640 /* Zero-width characters produce no glyphs. */
13643 && (row
->reversed_p
13644 ? glyph_after
> glyphs_end
13645 : glyph_after
< glyphs_end
)))
13647 cursor
= glyph_after
;
13650 else if (string_seen
)
13652 int incr
= row
->reversed_p
? -1 : +1;
13654 /* Need to find the glyph that came out of a string which is
13655 present at point. That glyph is somewhere between
13656 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13657 positioned between POS_BEFORE and POS_AFTER in the
13659 struct glyph
*start
, *stop
;
13660 EMACS_INT pos
= pos_before
;
13664 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13665 correspond to POS_BEFORE and POS_AFTER, respectively. We
13666 need START and STOP in the order that corresponds to the
13667 row's direction as given by its reversed_p flag. If the
13668 directionality of characters between POS_BEFORE and
13669 POS_AFTER is the opposite of the row's base direction,
13670 these characters will have been reordered for display,
13671 and we need to reverse START and STOP. */
13672 if (!row
->reversed_p
)
13674 start
= min (glyph_before
, glyph_after
);
13675 stop
= max (glyph_before
, glyph_after
);
13679 start
= max (glyph_before
, glyph_after
);
13680 stop
= min (glyph_before
, glyph_after
);
13682 for (glyph
= start
+ incr
;
13683 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13686 /* Any glyphs that come from the buffer are here because
13687 of bidi reordering. Skip them, and only pay
13688 attention to glyphs that came from some string. */
13689 if (STRINGP (glyph
->object
))
13693 /* If the display property covers the newline, we
13694 need to search for it one position farther. */
13695 EMACS_INT lim
= pos_after
13696 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13698 string_from_text_prop
= 0;
13699 str
= glyph
->object
;
13700 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13701 if (tem
== 0 /* from overlay */
13704 /* If the string from which this glyph came is
13705 found in the buffer at point, then we've
13706 found the glyph we've been looking for. If
13707 it comes from an overlay (tem == 0), and it
13708 has the `cursor' property on one of its
13709 glyphs, record that glyph as a candidate for
13710 displaying the cursor. (As in the
13711 unidirectional version, we will display the
13712 cursor on the last candidate we find.) */
13713 if (tem
== 0 || tem
== pt_old
)
13715 /* The glyphs from this string could have
13716 been reordered. Find the one with the
13717 smallest string position. Or there could
13718 be a character in the string with the
13719 `cursor' property, which means display
13720 cursor on that character's glyph. */
13721 EMACS_INT strpos
= glyph
->charpos
;
13726 string_from_text_prop
= 1;
13729 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13730 && EQ (glyph
->object
, str
);
13734 EMACS_INT gpos
= glyph
->charpos
;
13736 cprop
= Fget_char_property (make_number (gpos
),
13744 if (tem
&& glyph
->charpos
< strpos
)
13746 strpos
= glyph
->charpos
;
13755 pos
= tem
+ 1; /* don't find previous instances */
13757 /* This string is not what we want; skip all of the
13758 glyphs that came from it. */
13759 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13760 && EQ (glyph
->object
, str
))
13767 /* If we reached the end of the line, and END was from a string,
13768 the cursor is not on this line. */
13770 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13771 && STRINGP (end
->object
)
13772 && row
->continued_p
)
13778 if (cursor
!= NULL
)
13784 /* Need to compute x that corresponds to GLYPH. */
13785 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13787 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13789 x
+= g
->pixel_width
;
13793 /* ROW could be part of a continued line, which, under bidi
13794 reordering, might have other rows whose start and end charpos
13795 occlude point. Only set w->cursor if we found a better
13796 approximation to the cursor position than we have from previously
13797 examined candidate rows belonging to the same continued line. */
13798 if (/* we already have a candidate row */
13799 w
->cursor
.vpos
>= 0
13800 /* that candidate is not the row we are processing */
13801 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13802 /* Make sure cursor.vpos specifies a row whose start and end
13803 charpos occlude point, and it is valid candidate for being a
13804 cursor-row. This is because some callers of this function
13805 leave cursor.vpos at the row where the cursor was displayed
13806 during the last redisplay cycle. */
13807 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13808 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13809 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13812 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13814 /* Don't consider glyphs that are outside TEXT_AREA. */
13815 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13817 /* Keep the candidate whose buffer position is the closest to
13818 point or has the `cursor' property. */
13819 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13820 w
->cursor
.hpos
>= 0
13821 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13822 && ((BUFFERP (g1
->object
)
13823 && (g1
->charpos
== pt_old
/* an exact match always wins */
13824 || (BUFFERP (glyph
->object
)
13825 && eabs (g1
->charpos
- pt_old
)
13826 < eabs (glyph
->charpos
- pt_old
))))
13827 /* previous candidate is a glyph from a string that has
13828 a non-nil `cursor' property */
13829 || (STRINGP (g1
->object
)
13830 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
13831 Qcursor
, g1
->object
))
13832 /* pevious candidate is from the same display
13833 string as this one, and the display string
13834 came from a text property */
13835 || (EQ (g1
->object
, glyph
->object
)
13836 && string_from_text_prop
)
13837 /* this candidate is from newline and its
13838 position is not an exact match */
13839 || (INTEGERP (glyph
->object
)
13840 && glyph
->charpos
!= pt_old
)))))
13842 /* If this candidate gives an exact match, use that. */
13843 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13844 /* If this candidate is a glyph created for the
13845 terminating newline of a line, and point is on that
13846 newline, it wins because it's an exact match. */
13847 || (!row
->continued_p
13848 && INTEGERP (glyph
->object
)
13849 && glyph
->charpos
== 0
13850 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
13851 /* Otherwise, keep the candidate that comes from a row
13852 spanning less buffer positions. This may win when one or
13853 both candidate positions are on glyphs that came from
13854 display strings, for which we cannot compare buffer
13856 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13857 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13858 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13861 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13863 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13864 w
->cursor
.y
= row
->y
+ dy
;
13866 if (w
== XWINDOW (selected_window
))
13868 if (!row
->continued_p
13869 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13872 this_line_buffer
= XBUFFER (w
->buffer
);
13874 CHARPOS (this_line_start_pos
)
13875 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13876 BYTEPOS (this_line_start_pos
)
13877 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13879 CHARPOS (this_line_end_pos
)
13880 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13881 BYTEPOS (this_line_end_pos
)
13882 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13884 this_line_y
= w
->cursor
.y
;
13885 this_line_pixel_height
= row
->height
;
13886 this_line_vpos
= w
->cursor
.vpos
;
13887 this_line_start_x
= row
->x
;
13890 CHARPOS (this_line_start_pos
) = 0;
13897 /* Run window scroll functions, if any, for WINDOW with new window
13898 start STARTP. Sets the window start of WINDOW to that position.
13900 We assume that the window's buffer is really current. */
13902 static inline struct text_pos
13903 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13905 struct window
*w
= XWINDOW (window
);
13906 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13908 if (current_buffer
!= XBUFFER (w
->buffer
))
13911 if (!NILP (Vwindow_scroll_functions
))
13913 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13914 make_number (CHARPOS (startp
)));
13915 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13916 /* In case the hook functions switch buffers. */
13917 if (current_buffer
!= XBUFFER (w
->buffer
))
13918 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13925 /* Make sure the line containing the cursor is fully visible.
13926 A value of 1 means there is nothing to be done.
13927 (Either the line is fully visible, or it cannot be made so,
13928 or we cannot tell.)
13930 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13931 is higher than window.
13933 A value of 0 means the caller should do scrolling
13934 as if point had gone off the screen. */
13937 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13939 struct glyph_matrix
*matrix
;
13940 struct glyph_row
*row
;
13943 if (!make_cursor_line_fully_visible_p
)
13946 /* It's not always possible to find the cursor, e.g, when a window
13947 is full of overlay strings. Don't do anything in that case. */
13948 if (w
->cursor
.vpos
< 0)
13951 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13952 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13954 /* If the cursor row is not partially visible, there's nothing to do. */
13955 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13958 /* If the row the cursor is in is taller than the window's height,
13959 it's not clear what to do, so do nothing. */
13960 window_height
= window_box_height (w
);
13961 if (row
->height
>= window_height
)
13963 if (!force_p
|| MINI_WINDOW_P (w
)
13964 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13971 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13972 non-zero means only WINDOW is redisplayed in redisplay_internal.
13973 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13974 in redisplay_window to bring a partially visible line into view in
13975 the case that only the cursor has moved.
13977 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13978 last screen line's vertical height extends past the end of the screen.
13982 1 if scrolling succeeded
13984 0 if scrolling didn't find point.
13986 -1 if new fonts have been loaded so that we must interrupt
13987 redisplay, adjust glyph matrices, and try again. */
13993 SCROLLING_NEED_LARGER_MATRICES
13996 /* If scroll-conservatively is more than this, never recenter.
13998 If you change this, don't forget to update the doc string of
13999 `scroll-conservatively' and the Emacs manual. */
14000 #define SCROLL_LIMIT 100
14003 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14004 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14005 int temp_scroll_step
, int last_line_misfit
)
14007 struct window
*w
= XWINDOW (window
);
14008 struct frame
*f
= XFRAME (w
->frame
);
14009 struct text_pos pos
, startp
;
14011 int this_scroll_margin
, scroll_max
, rc
, height
;
14012 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14013 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14014 Lisp_Object aggressive
;
14015 /* We will never try scrolling more than this number of lines. */
14016 int scroll_limit
= SCROLL_LIMIT
;
14019 debug_method_add (w
, "try_scrolling");
14022 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14024 /* Compute scroll margin height in pixels. We scroll when point is
14025 within this distance from the top or bottom of the window. */
14026 if (scroll_margin
> 0)
14027 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14028 * FRAME_LINE_HEIGHT (f
);
14030 this_scroll_margin
= 0;
14032 /* Force arg_scroll_conservatively to have a reasonable value, to
14033 avoid scrolling too far away with slow move_it_* functions. Note
14034 that the user can supply scroll-conservatively equal to
14035 `most-positive-fixnum', which can be larger than INT_MAX. */
14036 if (arg_scroll_conservatively
> scroll_limit
)
14038 arg_scroll_conservatively
= scroll_limit
+ 1;
14039 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14041 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14042 /* Compute how much we should try to scroll maximally to bring
14043 point into view. */
14044 scroll_max
= (max (scroll_step
,
14045 max (arg_scroll_conservatively
, temp_scroll_step
))
14046 * FRAME_LINE_HEIGHT (f
));
14047 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14048 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14049 /* We're trying to scroll because of aggressive scrolling but no
14050 scroll_step is set. Choose an arbitrary one. */
14051 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14057 /* Decide whether to scroll down. */
14058 if (PT
> CHARPOS (startp
))
14060 int scroll_margin_y
;
14062 /* Compute the pixel ypos of the scroll margin, then move it to
14063 either that ypos or PT, whichever comes first. */
14064 start_display (&it
, w
, startp
);
14065 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14066 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14067 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14068 (MOVE_TO_POS
| MOVE_TO_Y
));
14070 if (PT
> CHARPOS (it
.current
.pos
))
14072 int y0
= line_bottom_y (&it
);
14073 /* Compute how many pixels below window bottom to stop searching
14074 for PT. This avoids costly search for PT that is far away if
14075 the user limited scrolling by a small number of lines, but
14076 always finds PT if scroll_conservatively is set to a large
14077 number, such as most-positive-fixnum. */
14078 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14079 int y_to_move
= it
.last_visible_y
+ slack
;
14081 /* Compute the distance from the scroll margin to PT or to
14082 the scroll limit, whichever comes first. This should
14083 include the height of the cursor line, to make that line
14085 move_it_to (&it
, PT
, -1, y_to_move
,
14086 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14087 dy
= line_bottom_y (&it
) - y0
;
14089 if (dy
> scroll_max
)
14090 return SCROLLING_FAILED
;
14098 /* Point is in or below the bottom scroll margin, so move the
14099 window start down. If scrolling conservatively, move it just
14100 enough down to make point visible. If scroll_step is set,
14101 move it down by scroll_step. */
14102 if (arg_scroll_conservatively
)
14104 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14105 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14106 else if (scroll_step
|| temp_scroll_step
)
14107 amount_to_scroll
= scroll_max
;
14110 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14111 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14112 if (NUMBERP (aggressive
))
14114 double float_amount
= XFLOATINT (aggressive
) * height
;
14115 amount_to_scroll
= float_amount
;
14116 if (amount_to_scroll
== 0 && float_amount
> 0)
14117 amount_to_scroll
= 1;
14118 /* Don't let point enter the scroll margin near top of
14120 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14121 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14125 if (amount_to_scroll
<= 0)
14126 return SCROLLING_FAILED
;
14128 start_display (&it
, w
, startp
);
14129 if (arg_scroll_conservatively
<= scroll_limit
)
14130 move_it_vertically (&it
, amount_to_scroll
);
14133 /* Extra precision for users who set scroll-conservatively
14134 to a large number: make sure the amount we scroll
14135 the window start is never less than amount_to_scroll,
14136 which was computed as distance from window bottom to
14137 point. This matters when lines at window top and lines
14138 below window bottom have different height. */
14140 void *it1data
= NULL
;
14141 /* We use a temporary it1 because line_bottom_y can modify
14142 its argument, if it moves one line down; see there. */
14145 SAVE_IT (it1
, it
, it1data
);
14146 start_y
= line_bottom_y (&it1
);
14148 RESTORE_IT (&it
, &it
, it1data
);
14149 move_it_by_lines (&it
, 1);
14150 SAVE_IT (it1
, it
, it1data
);
14151 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14154 /* If STARTP is unchanged, move it down another screen line. */
14155 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14156 move_it_by_lines (&it
, 1);
14157 startp
= it
.current
.pos
;
14161 struct text_pos scroll_margin_pos
= startp
;
14163 /* See if point is inside the scroll margin at the top of the
14165 if (this_scroll_margin
)
14167 start_display (&it
, w
, startp
);
14168 move_it_vertically (&it
, this_scroll_margin
);
14169 scroll_margin_pos
= it
.current
.pos
;
14172 if (PT
< CHARPOS (scroll_margin_pos
))
14174 /* Point is in the scroll margin at the top of the window or
14175 above what is displayed in the window. */
14178 /* Compute the vertical distance from PT to the scroll
14179 margin position. Move as far as scroll_max allows, or
14180 one screenful, or 10 screen lines, whichever is largest.
14181 Give up if distance is greater than scroll_max. */
14182 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14183 start_display (&it
, w
, pos
);
14185 y_to_move
= max (it
.last_visible_y
,
14186 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14187 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14189 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14190 dy
= it
.current_y
- y0
;
14191 if (dy
> scroll_max
)
14192 return SCROLLING_FAILED
;
14194 /* Compute new window start. */
14195 start_display (&it
, w
, startp
);
14197 if (arg_scroll_conservatively
)
14198 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14199 max (scroll_step
, temp_scroll_step
));
14200 else if (scroll_step
|| temp_scroll_step
)
14201 amount_to_scroll
= scroll_max
;
14204 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14205 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14206 if (NUMBERP (aggressive
))
14208 double float_amount
= XFLOATINT (aggressive
) * height
;
14209 amount_to_scroll
= float_amount
;
14210 if (amount_to_scroll
== 0 && float_amount
> 0)
14211 amount_to_scroll
= 1;
14212 amount_to_scroll
-=
14213 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14214 /* Don't let point enter the scroll margin near
14215 bottom of the window. */
14216 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14217 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14221 if (amount_to_scroll
<= 0)
14222 return SCROLLING_FAILED
;
14224 move_it_vertically_backward (&it
, amount_to_scroll
);
14225 startp
= it
.current
.pos
;
14229 /* Run window scroll functions. */
14230 startp
= run_window_scroll_functions (window
, startp
);
14232 /* Display the window. Give up if new fonts are loaded, or if point
14234 if (!try_window (window
, startp
, 0))
14235 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14236 else if (w
->cursor
.vpos
< 0)
14238 clear_glyph_matrix (w
->desired_matrix
);
14239 rc
= SCROLLING_FAILED
;
14243 /* Maybe forget recorded base line for line number display. */
14244 if (!just_this_one_p
14245 || current_buffer
->clip_changed
14246 || BEG_UNCHANGED
< CHARPOS (startp
))
14247 w
->base_line_number
= Qnil
;
14249 /* If cursor ends up on a partially visible line,
14250 treat that as being off the bottom of the screen. */
14251 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14252 /* It's possible that the cursor is on the first line of the
14253 buffer, which is partially obscured due to a vscroll
14254 (Bug#7537). In that case, avoid looping forever . */
14255 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14257 clear_glyph_matrix (w
->desired_matrix
);
14258 ++extra_scroll_margin_lines
;
14261 rc
= SCROLLING_SUCCESS
;
14268 /* Compute a suitable window start for window W if display of W starts
14269 on a continuation line. Value is non-zero if a new window start
14272 The new window start will be computed, based on W's width, starting
14273 from the start of the continued line. It is the start of the
14274 screen line with the minimum distance from the old start W->start. */
14277 compute_window_start_on_continuation_line (struct window
*w
)
14279 struct text_pos pos
, start_pos
;
14280 int window_start_changed_p
= 0;
14282 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14284 /* If window start is on a continuation line... Window start may be
14285 < BEGV in case there's invisible text at the start of the
14286 buffer (M-x rmail, for example). */
14287 if (CHARPOS (start_pos
) > BEGV
14288 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14291 struct glyph_row
*row
;
14293 /* Handle the case that the window start is out of range. */
14294 if (CHARPOS (start_pos
) < BEGV
)
14295 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14296 else if (CHARPOS (start_pos
) > ZV
)
14297 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14299 /* Find the start of the continued line. This should be fast
14300 because scan_buffer is fast (newline cache). */
14301 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14302 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14303 row
, DEFAULT_FACE_ID
);
14304 reseat_at_previous_visible_line_start (&it
);
14306 /* If the line start is "too far" away from the window start,
14307 say it takes too much time to compute a new window start. */
14308 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14309 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14311 int min_distance
, distance
;
14313 /* Move forward by display lines to find the new window
14314 start. If window width was enlarged, the new start can
14315 be expected to be > the old start. If window width was
14316 decreased, the new window start will be < the old start.
14317 So, we're looking for the display line start with the
14318 minimum distance from the old window start. */
14319 pos
= it
.current
.pos
;
14320 min_distance
= INFINITY
;
14321 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14322 distance
< min_distance
)
14324 min_distance
= distance
;
14325 pos
= it
.current
.pos
;
14326 move_it_by_lines (&it
, 1);
14329 /* Set the window start there. */
14330 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14331 window_start_changed_p
= 1;
14335 return window_start_changed_p
;
14339 /* Try cursor movement in case text has not changed in window WINDOW,
14340 with window start STARTP. Value is
14342 CURSOR_MOVEMENT_SUCCESS if successful
14344 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14346 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14347 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14348 we want to scroll as if scroll-step were set to 1. See the code.
14350 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14351 which case we have to abort this redisplay, and adjust matrices
14356 CURSOR_MOVEMENT_SUCCESS
,
14357 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14358 CURSOR_MOVEMENT_MUST_SCROLL
,
14359 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14363 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14365 struct window
*w
= XWINDOW (window
);
14366 struct frame
*f
= XFRAME (w
->frame
);
14367 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14370 if (inhibit_try_cursor_movement
)
14374 /* Handle case where text has not changed, only point, and it has
14375 not moved off the frame. */
14376 if (/* Point may be in this window. */
14377 PT
>= CHARPOS (startp
)
14378 /* Selective display hasn't changed. */
14379 && !current_buffer
->clip_changed
14380 /* Function force-mode-line-update is used to force a thorough
14381 redisplay. It sets either windows_or_buffers_changed or
14382 update_mode_lines. So don't take a shortcut here for these
14384 && !update_mode_lines
14385 && !windows_or_buffers_changed
14386 && !cursor_type_changed
14387 /* Can't use this case if highlighting a region. When a
14388 region exists, cursor movement has to do more than just
14390 && !(!NILP (Vtransient_mark_mode
)
14391 && !NILP (BVAR (current_buffer
, mark_active
)))
14392 && NILP (w
->region_showing
)
14393 && NILP (Vshow_trailing_whitespace
)
14394 /* Right after splitting windows, last_point may be nil. */
14395 && INTEGERP (w
->last_point
)
14396 /* This code is not used for mini-buffer for the sake of the case
14397 of redisplaying to replace an echo area message; since in
14398 that case the mini-buffer contents per se are usually
14399 unchanged. This code is of no real use in the mini-buffer
14400 since the handling of this_line_start_pos, etc., in redisplay
14401 handles the same cases. */
14402 && !EQ (window
, minibuf_window
)
14403 /* When splitting windows or for new windows, it happens that
14404 redisplay is called with a nil window_end_vpos or one being
14405 larger than the window. This should really be fixed in
14406 window.c. I don't have this on my list, now, so we do
14407 approximately the same as the old redisplay code. --gerd. */
14408 && INTEGERP (w
->window_end_vpos
)
14409 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14410 && (FRAME_WINDOW_P (f
)
14411 || !overlay_arrow_in_current_buffer_p ()))
14413 int this_scroll_margin
, top_scroll_margin
;
14414 struct glyph_row
*row
= NULL
;
14417 debug_method_add (w
, "cursor movement");
14420 /* Scroll if point within this distance from the top or bottom
14421 of the window. This is a pixel value. */
14422 if (scroll_margin
> 0)
14424 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14425 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14428 this_scroll_margin
= 0;
14430 top_scroll_margin
= this_scroll_margin
;
14431 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14432 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14434 /* Start with the row the cursor was displayed during the last
14435 not paused redisplay. Give up if that row is not valid. */
14436 if (w
->last_cursor
.vpos
< 0
14437 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14438 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14441 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14442 if (row
->mode_line_p
)
14444 if (!row
->enabled_p
)
14445 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14448 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14450 int scroll_p
= 0, must_scroll
= 0;
14451 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14453 if (PT
> XFASTINT (w
->last_point
))
14455 /* Point has moved forward. */
14456 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14457 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14459 xassert (row
->enabled_p
);
14463 /* If the end position of a row equals the start
14464 position of the next row, and PT is at that position,
14465 we would rather display cursor in the next line. */
14466 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14467 && MATRIX_ROW_END_CHARPOS (row
) == PT
14468 && row
< w
->current_matrix
->rows
14469 + w
->current_matrix
->nrows
- 1
14470 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14471 && !cursor_row_p (row
))
14474 /* If within the scroll margin, scroll. Note that
14475 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14476 the next line would be drawn, and that
14477 this_scroll_margin can be zero. */
14478 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14479 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14480 /* Line is completely visible last line in window
14481 and PT is to be set in the next line. */
14482 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14483 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14484 && !row
->ends_at_zv_p
14485 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14488 else if (PT
< XFASTINT (w
->last_point
))
14490 /* Cursor has to be moved backward. Note that PT >=
14491 CHARPOS (startp) because of the outer if-statement. */
14492 while (!row
->mode_line_p
14493 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14494 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14495 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14496 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14497 row
> w
->current_matrix
->rows
14498 && (row
-1)->ends_in_newline_from_string_p
))))
14499 && (row
->y
> top_scroll_margin
14500 || CHARPOS (startp
) == BEGV
))
14502 xassert (row
->enabled_p
);
14506 /* Consider the following case: Window starts at BEGV,
14507 there is invisible, intangible text at BEGV, so that
14508 display starts at some point START > BEGV. It can
14509 happen that we are called with PT somewhere between
14510 BEGV and START. Try to handle that case. */
14511 if (row
< w
->current_matrix
->rows
14512 || row
->mode_line_p
)
14514 row
= w
->current_matrix
->rows
;
14515 if (row
->mode_line_p
)
14519 /* Due to newlines in overlay strings, we may have to
14520 skip forward over overlay strings. */
14521 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14522 && MATRIX_ROW_END_CHARPOS (row
) == PT
14523 && !cursor_row_p (row
))
14526 /* If within the scroll margin, scroll. */
14527 if (row
->y
< top_scroll_margin
14528 && CHARPOS (startp
) != BEGV
)
14533 /* Cursor did not move. So don't scroll even if cursor line
14534 is partially visible, as it was so before. */
14535 rc
= CURSOR_MOVEMENT_SUCCESS
;
14538 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14539 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14541 /* if PT is not in the glyph row, give up. */
14542 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14545 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14546 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14548 /* If rows are bidi-reordered and point moved, back up
14549 until we find a row that does not belong to a
14550 continuation line. This is because we must consider
14551 all rows of a continued line as candidates for the
14552 new cursor positioning, since row start and end
14553 positions change non-linearly with vertical position
14555 /* FIXME: Revisit this when glyph ``spilling'' in
14556 continuation lines' rows is implemented for
14557 bidi-reordered rows. */
14558 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14560 xassert (row
->enabled_p
);
14562 /* If we hit the beginning of the displayed portion
14563 without finding the first row of a continued
14565 if (row
<= w
->current_matrix
->rows
)
14567 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14575 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14576 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14577 && make_cursor_line_fully_visible_p
)
14579 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14580 && !row
->ends_at_zv_p
14581 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14582 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14583 else if (row
->height
> window_box_height (w
))
14585 /* If we end up in a partially visible line, let's
14586 make it fully visible, except when it's taller
14587 than the window, in which case we can't do much
14590 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14594 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14595 if (!cursor_row_fully_visible_p (w
, 0, 1))
14596 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14598 rc
= CURSOR_MOVEMENT_SUCCESS
;
14602 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14603 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14604 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14606 /* With bidi-reordered rows, there could be more than
14607 one candidate row whose start and end positions
14608 occlude point. We need to let set_cursor_from_row
14609 find the best candidate. */
14610 /* FIXME: Revisit this when glyph ``spilling'' in
14611 continuation lines' rows is implemented for
14612 bidi-reordered rows. */
14617 int at_zv_p
= 0, exact_match_p
= 0;
14619 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14620 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14621 && cursor_row_p (row
))
14622 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14624 /* As soon as we've found the exact match for point,
14625 or the first suitable row whose ends_at_zv_p flag
14626 is set, we are done. */
14628 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14631 struct glyph_row
*candidate
=
14632 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14634 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14635 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14638 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14639 || (INTEGERP (g
->object
)
14640 && (g
->charpos
== PT
14641 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14643 if (rv
&& (at_zv_p
|| exact_match_p
))
14645 rc
= CURSOR_MOVEMENT_SUCCESS
;
14648 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14652 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14653 || row
->continued_p
)
14654 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14655 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14656 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14657 /* If we didn't find any candidate rows, or exited the
14658 loop before all the candidates were examined, signal
14659 to the caller that this method failed. */
14660 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14662 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14663 && !row
->continued_p
))
14664 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14666 rc
= CURSOR_MOVEMENT_SUCCESS
;
14672 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14674 rc
= CURSOR_MOVEMENT_SUCCESS
;
14679 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14680 && MATRIX_ROW_START_CHARPOS (row
) == PT
14681 && cursor_row_p (row
));
14689 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14693 set_vertical_scroll_bar (struct window
*w
)
14695 EMACS_INT start
, end
, whole
;
14697 /* Calculate the start and end positions for the current window.
14698 At some point, it would be nice to choose between scrollbars
14699 which reflect the whole buffer size, with special markers
14700 indicating narrowing, and scrollbars which reflect only the
14703 Note that mini-buffers sometimes aren't displaying any text. */
14704 if (!MINI_WINDOW_P (w
)
14705 || (w
== XWINDOW (minibuf_window
)
14706 && NILP (echo_area_buffer
[0])))
14708 struct buffer
*buf
= XBUFFER (w
->buffer
);
14709 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14710 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14711 /* I don't think this is guaranteed to be right. For the
14712 moment, we'll pretend it is. */
14713 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14717 if (whole
< (end
- start
))
14718 whole
= end
- start
;
14721 start
= end
= whole
= 0;
14723 /* Indicate what this scroll bar ought to be displaying now. */
14724 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14725 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14726 (w
, end
- start
, whole
, start
);
14730 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14731 selected_window is redisplayed.
14733 We can return without actually redisplaying the window if
14734 fonts_changed_p is nonzero. In that case, redisplay_internal will
14738 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14740 struct window
*w
= XWINDOW (window
);
14741 struct frame
*f
= XFRAME (w
->frame
);
14742 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14743 struct buffer
*old
= current_buffer
;
14744 struct text_pos lpoint
, opoint
, startp
;
14745 int update_mode_line
;
14748 /* Record it now because it's overwritten. */
14749 int current_matrix_up_to_date_p
= 0;
14750 int used_current_matrix_p
= 0;
14751 /* This is less strict than current_matrix_up_to_date_p.
14752 It indictes that the buffer contents and narrowing are unchanged. */
14753 int buffer_unchanged_p
= 0;
14754 int temp_scroll_step
= 0;
14755 int count
= SPECPDL_INDEX ();
14757 int centering_position
= -1;
14758 int last_line_misfit
= 0;
14759 EMACS_INT beg_unchanged
, end_unchanged
;
14761 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14764 /* W must be a leaf window here. */
14765 xassert (!NILP (w
->buffer
));
14767 *w
->desired_matrix
->method
= 0;
14771 reconsider_clip_changes (w
, buffer
);
14773 /* Has the mode line to be updated? */
14774 update_mode_line
= (!NILP (w
->update_mode_line
)
14775 || update_mode_lines
14776 || buffer
->clip_changed
14777 || buffer
->prevent_redisplay_optimizations_p
);
14779 if (MINI_WINDOW_P (w
))
14781 if (w
== XWINDOW (echo_area_window
)
14782 && !NILP (echo_area_buffer
[0]))
14784 if (update_mode_line
)
14785 /* We may have to update a tty frame's menu bar or a
14786 tool-bar. Example `M-x C-h C-h C-g'. */
14787 goto finish_menu_bars
;
14789 /* We've already displayed the echo area glyphs in this window. */
14790 goto finish_scroll_bars
;
14792 else if ((w
!= XWINDOW (minibuf_window
)
14793 || minibuf_level
== 0)
14794 /* When buffer is nonempty, redisplay window normally. */
14795 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14796 /* Quail displays non-mini buffers in minibuffer window.
14797 In that case, redisplay the window normally. */
14798 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14800 /* W is a mini-buffer window, but it's not active, so clear
14802 int yb
= window_text_bottom_y (w
);
14803 struct glyph_row
*row
;
14806 for (y
= 0, row
= w
->desired_matrix
->rows
;
14808 y
+= row
->height
, ++row
)
14809 blank_row (w
, row
, y
);
14810 goto finish_scroll_bars
;
14813 clear_glyph_matrix (w
->desired_matrix
);
14816 /* Otherwise set up data on this window; select its buffer and point
14818 /* Really select the buffer, for the sake of buffer-local
14820 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14822 current_matrix_up_to_date_p
14823 = (!NILP (w
->window_end_valid
)
14824 && !current_buffer
->clip_changed
14825 && !current_buffer
->prevent_redisplay_optimizations_p
14826 && XFASTINT (w
->last_modified
) >= MODIFF
14827 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14829 /* Run the window-bottom-change-functions
14830 if it is possible that the text on the screen has changed
14831 (either due to modification of the text, or any other reason). */
14832 if (!current_matrix_up_to_date_p
14833 && !NILP (Vwindow_text_change_functions
))
14835 safe_run_hooks (Qwindow_text_change_functions
);
14839 beg_unchanged
= BEG_UNCHANGED
;
14840 end_unchanged
= END_UNCHANGED
;
14842 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14844 specbind (Qinhibit_point_motion_hooks
, Qt
);
14847 = (!NILP (w
->window_end_valid
)
14848 && !current_buffer
->clip_changed
14849 && XFASTINT (w
->last_modified
) >= MODIFF
14850 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14852 /* When windows_or_buffers_changed is non-zero, we can't rely on
14853 the window end being valid, so set it to nil there. */
14854 if (windows_or_buffers_changed
)
14856 /* If window starts on a continuation line, maybe adjust the
14857 window start in case the window's width changed. */
14858 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14859 compute_window_start_on_continuation_line (w
);
14861 w
->window_end_valid
= Qnil
;
14864 /* Some sanity checks. */
14865 CHECK_WINDOW_END (w
);
14866 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14868 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14871 /* If %c is in mode line, update it if needed. */
14872 if (!NILP (w
->column_number_displayed
)
14873 /* This alternative quickly identifies a common case
14874 where no change is needed. */
14875 && !(PT
== XFASTINT (w
->last_point
)
14876 && XFASTINT (w
->last_modified
) >= MODIFF
14877 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14878 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14879 update_mode_line
= 1;
14881 /* Count number of windows showing the selected buffer. An indirect
14882 buffer counts as its base buffer. */
14883 if (!just_this_one_p
)
14885 struct buffer
*current_base
, *window_base
;
14886 current_base
= current_buffer
;
14887 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14888 if (current_base
->base_buffer
)
14889 current_base
= current_base
->base_buffer
;
14890 if (window_base
->base_buffer
)
14891 window_base
= window_base
->base_buffer
;
14892 if (current_base
== window_base
)
14896 /* Point refers normally to the selected window. For any other
14897 window, set up appropriate value. */
14898 if (!EQ (window
, selected_window
))
14900 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14901 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14905 new_pt_byte
= BEGV_BYTE
;
14906 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14908 else if (new_pt
> (ZV
- 1))
14911 new_pt_byte
= ZV_BYTE
;
14912 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14915 /* We don't use SET_PT so that the point-motion hooks don't run. */
14916 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14919 /* If any of the character widths specified in the display table
14920 have changed, invalidate the width run cache. It's true that
14921 this may be a bit late to catch such changes, but the rest of
14922 redisplay goes (non-fatally) haywire when the display table is
14923 changed, so why should we worry about doing any better? */
14924 if (current_buffer
->width_run_cache
)
14926 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14928 if (! disptab_matches_widthtab (disptab
,
14929 XVECTOR (BVAR (current_buffer
, width_table
))))
14931 invalidate_region_cache (current_buffer
,
14932 current_buffer
->width_run_cache
,
14934 recompute_width_table (current_buffer
, disptab
);
14938 /* If window-start is screwed up, choose a new one. */
14939 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14942 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14944 /* If someone specified a new starting point but did not insist,
14945 check whether it can be used. */
14946 if (!NILP (w
->optional_new_start
)
14947 && CHARPOS (startp
) >= BEGV
14948 && CHARPOS (startp
) <= ZV
)
14950 w
->optional_new_start
= Qnil
;
14951 start_display (&it
, w
, startp
);
14952 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14953 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14954 if (IT_CHARPOS (it
) == PT
)
14955 w
->force_start
= Qt
;
14956 /* IT may overshoot PT if text at PT is invisible. */
14957 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14958 w
->force_start
= Qt
;
14963 /* Handle case where place to start displaying has been specified,
14964 unless the specified location is outside the accessible range. */
14965 if (!NILP (w
->force_start
)
14966 || w
->frozen_window_start_p
)
14968 /* We set this later on if we have to adjust point. */
14971 w
->force_start
= Qnil
;
14973 w
->window_end_valid
= Qnil
;
14975 /* Forget any recorded base line for line number display. */
14976 if (!buffer_unchanged_p
)
14977 w
->base_line_number
= Qnil
;
14979 /* Redisplay the mode line. Select the buffer properly for that.
14980 Also, run the hook window-scroll-functions
14981 because we have scrolled. */
14982 /* Note, we do this after clearing force_start because
14983 if there's an error, it is better to forget about force_start
14984 than to get into an infinite loop calling the hook functions
14985 and having them get more errors. */
14986 if (!update_mode_line
14987 || ! NILP (Vwindow_scroll_functions
))
14989 update_mode_line
= 1;
14990 w
->update_mode_line
= Qt
;
14991 startp
= run_window_scroll_functions (window
, startp
);
14994 w
->last_modified
= make_number (0);
14995 w
->last_overlay_modified
= make_number (0);
14996 if (CHARPOS (startp
) < BEGV
)
14997 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14998 else if (CHARPOS (startp
) > ZV
)
14999 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15001 /* Redisplay, then check if cursor has been set during the
15002 redisplay. Give up if new fonts were loaded. */
15003 /* We used to issue a CHECK_MARGINS argument to try_window here,
15004 but this causes scrolling to fail when point begins inside
15005 the scroll margin (bug#148) -- cyd */
15006 if (!try_window (window
, startp
, 0))
15008 w
->force_start
= Qt
;
15009 clear_glyph_matrix (w
->desired_matrix
);
15010 goto need_larger_matrices
;
15013 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15015 /* If point does not appear, try to move point so it does
15016 appear. The desired matrix has been built above, so we
15017 can use it here. */
15018 new_vpos
= window_box_height (w
) / 2;
15021 if (!cursor_row_fully_visible_p (w
, 0, 0))
15023 /* Point does appear, but on a line partly visible at end of window.
15024 Move it back to a fully-visible line. */
15025 new_vpos
= window_box_height (w
);
15028 /* If we need to move point for either of the above reasons,
15029 now actually do it. */
15032 struct glyph_row
*row
;
15034 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15035 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15038 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15039 MATRIX_ROW_START_BYTEPOS (row
));
15041 if (w
!= XWINDOW (selected_window
))
15042 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15043 else if (current_buffer
== old
)
15044 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15046 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15048 /* If we are highlighting the region, then we just changed
15049 the region, so redisplay to show it. */
15050 if (!NILP (Vtransient_mark_mode
)
15051 && !NILP (BVAR (current_buffer
, mark_active
)))
15053 clear_glyph_matrix (w
->desired_matrix
);
15054 if (!try_window (window
, startp
, 0))
15055 goto need_larger_matrices
;
15060 debug_method_add (w
, "forced window start");
15065 /* Handle case where text has not changed, only point, and it has
15066 not moved off the frame, and we are not retrying after hscroll.
15067 (current_matrix_up_to_date_p is nonzero when retrying.) */
15068 if (current_matrix_up_to_date_p
15069 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15070 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15074 case CURSOR_MOVEMENT_SUCCESS
:
15075 used_current_matrix_p
= 1;
15078 case CURSOR_MOVEMENT_MUST_SCROLL
:
15079 goto try_to_scroll
;
15085 /* If current starting point was originally the beginning of a line
15086 but no longer is, find a new starting point. */
15087 else if (!NILP (w
->start_at_line_beg
)
15088 && !(CHARPOS (startp
) <= BEGV
15089 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15092 debug_method_add (w
, "recenter 1");
15097 /* Try scrolling with try_window_id. Value is > 0 if update has
15098 been done, it is -1 if we know that the same window start will
15099 not work. It is 0 if unsuccessful for some other reason. */
15100 else if ((tem
= try_window_id (w
)) != 0)
15103 debug_method_add (w
, "try_window_id %d", tem
);
15106 if (fonts_changed_p
)
15107 goto need_larger_matrices
;
15111 /* Otherwise try_window_id has returned -1 which means that we
15112 don't want the alternative below this comment to execute. */
15114 else if (CHARPOS (startp
) >= BEGV
15115 && CHARPOS (startp
) <= ZV
15116 && PT
>= CHARPOS (startp
)
15117 && (CHARPOS (startp
) < ZV
15118 /* Avoid starting at end of buffer. */
15119 || CHARPOS (startp
) == BEGV
15120 || (XFASTINT (w
->last_modified
) >= MODIFF
15121 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15123 int d1
, d2
, d3
, d4
, d5
, d6
;
15125 /* If first window line is a continuation line, and window start
15126 is inside the modified region, but the first change is before
15127 current window start, we must select a new window start.
15129 However, if this is the result of a down-mouse event (e.g. by
15130 extending the mouse-drag-overlay), we don't want to select a
15131 new window start, since that would change the position under
15132 the mouse, resulting in an unwanted mouse-movement rather
15133 than a simple mouse-click. */
15134 if (NILP (w
->start_at_line_beg
)
15135 && NILP (do_mouse_tracking
)
15136 && CHARPOS (startp
) > BEGV
15137 && CHARPOS (startp
) > BEG
+ beg_unchanged
15138 && CHARPOS (startp
) <= Z
- end_unchanged
15139 /* Even if w->start_at_line_beg is nil, a new window may
15140 start at a line_beg, since that's how set_buffer_window
15141 sets it. So, we need to check the return value of
15142 compute_window_start_on_continuation_line. (See also
15144 && XMARKER (w
->start
)->buffer
== current_buffer
15145 && compute_window_start_on_continuation_line (w
)
15146 /* It doesn't make sense to force the window start like we
15147 do at label force_start if it is already known that point
15148 will not be visible in the resulting window, because
15149 doing so will move point from its correct position
15150 instead of scrolling the window to bring point into view.
15152 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15154 w
->force_start
= Qt
;
15155 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15160 debug_method_add (w
, "same window start");
15163 /* Try to redisplay starting at same place as before.
15164 If point has not moved off frame, accept the results. */
15165 if (!current_matrix_up_to_date_p
15166 /* Don't use try_window_reusing_current_matrix in this case
15167 because a window scroll function can have changed the
15169 || !NILP (Vwindow_scroll_functions
)
15170 || MINI_WINDOW_P (w
)
15171 || !(used_current_matrix_p
15172 = try_window_reusing_current_matrix (w
)))
15174 IF_DEBUG (debug_method_add (w
, "1"));
15175 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15176 /* -1 means we need to scroll.
15177 0 means we need new matrices, but fonts_changed_p
15178 is set in that case, so we will detect it below. */
15179 goto try_to_scroll
;
15182 if (fonts_changed_p
)
15183 goto need_larger_matrices
;
15185 if (w
->cursor
.vpos
>= 0)
15187 if (!just_this_one_p
15188 || current_buffer
->clip_changed
15189 || BEG_UNCHANGED
< CHARPOS (startp
))
15190 /* Forget any recorded base line for line number display. */
15191 w
->base_line_number
= Qnil
;
15193 if (!cursor_row_fully_visible_p (w
, 1, 0))
15195 clear_glyph_matrix (w
->desired_matrix
);
15196 last_line_misfit
= 1;
15198 /* Drop through and scroll. */
15203 clear_glyph_matrix (w
->desired_matrix
);
15208 w
->last_modified
= make_number (0);
15209 w
->last_overlay_modified
= make_number (0);
15211 /* Redisplay the mode line. Select the buffer properly for that. */
15212 if (!update_mode_line
)
15214 update_mode_line
= 1;
15215 w
->update_mode_line
= Qt
;
15218 /* Try to scroll by specified few lines. */
15219 if ((scroll_conservatively
15220 || emacs_scroll_step
15221 || temp_scroll_step
15222 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15223 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15224 && CHARPOS (startp
) >= BEGV
15225 && CHARPOS (startp
) <= ZV
)
15227 /* The function returns -1 if new fonts were loaded, 1 if
15228 successful, 0 if not successful. */
15229 int ss
= try_scrolling (window
, just_this_one_p
,
15230 scroll_conservatively
,
15232 temp_scroll_step
, last_line_misfit
);
15235 case SCROLLING_SUCCESS
:
15238 case SCROLLING_NEED_LARGER_MATRICES
:
15239 goto need_larger_matrices
;
15241 case SCROLLING_FAILED
:
15249 /* Finally, just choose a place to start which positions point
15250 according to user preferences. */
15255 debug_method_add (w
, "recenter");
15258 /* w->vscroll = 0; */
15260 /* Forget any previously recorded base line for line number display. */
15261 if (!buffer_unchanged_p
)
15262 w
->base_line_number
= Qnil
;
15264 /* Determine the window start relative to point. */
15265 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15266 it
.current_y
= it
.last_visible_y
;
15267 if (centering_position
< 0)
15271 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15273 EMACS_INT margin_pos
= CHARPOS (startp
);
15275 Lisp_Object aggressive
;
15277 /* If there is a scroll margin at the top of the window, find
15278 its character position. */
15280 /* Cannot call start_display if startp is not in the
15281 accessible region of the buffer. This can happen when we
15282 have just switched to a different buffer and/or changed
15283 its restriction. In that case, startp is initialized to
15284 the character position 1 (BEG) because we did not yet
15285 have chance to display the buffer even once. */
15286 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15289 void *it1data
= NULL
;
15291 SAVE_IT (it1
, it
, it1data
);
15292 start_display (&it1
, w
, startp
);
15293 move_it_vertically (&it1
, margin
);
15294 margin_pos
= IT_CHARPOS (it1
);
15295 RESTORE_IT (&it
, &it
, it1data
);
15297 scrolling_up
= PT
> margin_pos
;
15300 ? BVAR (current_buffer
, scroll_up_aggressively
)
15301 : BVAR (current_buffer
, scroll_down_aggressively
);
15303 if (!MINI_WINDOW_P (w
)
15304 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15308 /* Setting scroll-conservatively overrides
15309 scroll-*-aggressively. */
15310 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15312 double float_amount
= XFLOATINT (aggressive
);
15314 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15315 if (pt_offset
== 0 && float_amount
> 0)
15320 /* Compute how much to move the window start backward from
15321 point so that point will be displayed where the user
15325 centering_position
= it
.last_visible_y
;
15327 centering_position
-= pt_offset
;
15328 centering_position
-=
15329 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15330 + WINDOW_HEADER_LINE_HEIGHT (w
);
15331 /* Don't let point enter the scroll margin near top of
15333 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15334 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15337 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15340 /* Set the window start half the height of the window backward
15342 centering_position
= window_box_height (w
) / 2;
15344 move_it_vertically_backward (&it
, centering_position
);
15346 xassert (IT_CHARPOS (it
) >= BEGV
);
15348 /* The function move_it_vertically_backward may move over more
15349 than the specified y-distance. If it->w is small, e.g. a
15350 mini-buffer window, we may end up in front of the window's
15351 display area. Start displaying at the start of the line
15352 containing PT in this case. */
15353 if (it
.current_y
<= 0)
15355 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15356 move_it_vertically_backward (&it
, 0);
15360 it
.current_x
= it
.hpos
= 0;
15362 /* Set the window start position here explicitly, to avoid an
15363 infinite loop in case the functions in window-scroll-functions
15365 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15367 /* Run scroll hooks. */
15368 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15370 /* Redisplay the window. */
15371 if (!current_matrix_up_to_date_p
15372 || windows_or_buffers_changed
15373 || cursor_type_changed
15374 /* Don't use try_window_reusing_current_matrix in this case
15375 because it can have changed the buffer. */
15376 || !NILP (Vwindow_scroll_functions
)
15377 || !just_this_one_p
15378 || MINI_WINDOW_P (w
)
15379 || !(used_current_matrix_p
15380 = try_window_reusing_current_matrix (w
)))
15381 try_window (window
, startp
, 0);
15383 /* If new fonts have been loaded (due to fontsets), give up. We
15384 have to start a new redisplay since we need to re-adjust glyph
15386 if (fonts_changed_p
)
15387 goto need_larger_matrices
;
15389 /* If cursor did not appear assume that the middle of the window is
15390 in the first line of the window. Do it again with the next line.
15391 (Imagine a window of height 100, displaying two lines of height
15392 60. Moving back 50 from it->last_visible_y will end in the first
15394 if (w
->cursor
.vpos
< 0)
15396 if (!NILP (w
->window_end_valid
)
15397 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15399 clear_glyph_matrix (w
->desired_matrix
);
15400 move_it_by_lines (&it
, 1);
15401 try_window (window
, it
.current
.pos
, 0);
15403 else if (PT
< IT_CHARPOS (it
))
15405 clear_glyph_matrix (w
->desired_matrix
);
15406 move_it_by_lines (&it
, -1);
15407 try_window (window
, it
.current
.pos
, 0);
15411 /* Not much we can do about it. */
15415 /* Consider the following case: Window starts at BEGV, there is
15416 invisible, intangible text at BEGV, so that display starts at
15417 some point START > BEGV. It can happen that we are called with
15418 PT somewhere between BEGV and START. Try to handle that case. */
15419 if (w
->cursor
.vpos
< 0)
15421 struct glyph_row
*row
= w
->current_matrix
->rows
;
15422 if (row
->mode_line_p
)
15424 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15427 if (!cursor_row_fully_visible_p (w
, 0, 0))
15429 /* If vscroll is enabled, disable it and try again. */
15433 clear_glyph_matrix (w
->desired_matrix
);
15437 /* If centering point failed to make the whole line visible,
15438 put point at the top instead. That has to make the whole line
15439 visible, if it can be done. */
15440 if (centering_position
== 0)
15443 clear_glyph_matrix (w
->desired_matrix
);
15444 centering_position
= 0;
15450 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15451 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15452 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15455 /* Display the mode line, if we must. */
15456 if ((update_mode_line
15457 /* If window not full width, must redo its mode line
15458 if (a) the window to its side is being redone and
15459 (b) we do a frame-based redisplay. This is a consequence
15460 of how inverted lines are drawn in frame-based redisplay. */
15461 || (!just_this_one_p
15462 && !FRAME_WINDOW_P (f
)
15463 && !WINDOW_FULL_WIDTH_P (w
))
15464 /* Line number to display. */
15465 || INTEGERP (w
->base_line_pos
)
15466 /* Column number is displayed and different from the one displayed. */
15467 || (!NILP (w
->column_number_displayed
)
15468 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15469 /* This means that the window has a mode line. */
15470 && (WINDOW_WANTS_MODELINE_P (w
)
15471 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15473 display_mode_lines (w
);
15475 /* If mode line height has changed, arrange for a thorough
15476 immediate redisplay using the correct mode line height. */
15477 if (WINDOW_WANTS_MODELINE_P (w
)
15478 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15480 fonts_changed_p
= 1;
15481 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15482 = DESIRED_MODE_LINE_HEIGHT (w
);
15485 /* If header line height has changed, arrange for a thorough
15486 immediate redisplay using the correct header line height. */
15487 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15488 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15490 fonts_changed_p
= 1;
15491 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15492 = DESIRED_HEADER_LINE_HEIGHT (w
);
15495 if (fonts_changed_p
)
15496 goto need_larger_matrices
;
15499 if (!line_number_displayed
15500 && !BUFFERP (w
->base_line_pos
))
15502 w
->base_line_pos
= Qnil
;
15503 w
->base_line_number
= Qnil
;
15508 /* When we reach a frame's selected window, redo the frame's menu bar. */
15509 if (update_mode_line
15510 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15512 int redisplay_menu_p
= 0;
15514 if (FRAME_WINDOW_P (f
))
15516 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15517 || defined (HAVE_NS) || defined (USE_GTK)
15518 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15520 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15524 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15526 if (redisplay_menu_p
)
15527 display_menu_bar (w
);
15529 #ifdef HAVE_WINDOW_SYSTEM
15530 if (FRAME_WINDOW_P (f
))
15532 #if defined (USE_GTK) || defined (HAVE_NS)
15533 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15534 redisplay_tool_bar (f
);
15536 if (WINDOWP (f
->tool_bar_window
)
15537 && (FRAME_TOOL_BAR_LINES (f
) > 0
15538 || !NILP (Vauto_resize_tool_bars
))
15539 && redisplay_tool_bar (f
))
15540 ignore_mouse_drag_p
= 1;
15546 #ifdef HAVE_WINDOW_SYSTEM
15547 if (FRAME_WINDOW_P (f
)
15548 && update_window_fringes (w
, (just_this_one_p
15549 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15550 || w
->pseudo_window_p
)))
15554 if (draw_window_fringes (w
, 1))
15555 x_draw_vertical_border (w
);
15559 #endif /* HAVE_WINDOW_SYSTEM */
15561 /* We go to this label, with fonts_changed_p nonzero,
15562 if it is necessary to try again using larger glyph matrices.
15563 We have to redeem the scroll bar even in this case,
15564 because the loop in redisplay_internal expects that. */
15565 need_larger_matrices
:
15567 finish_scroll_bars
:
15569 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15571 /* Set the thumb's position and size. */
15572 set_vertical_scroll_bar (w
);
15574 /* Note that we actually used the scroll bar attached to this
15575 window, so it shouldn't be deleted at the end of redisplay. */
15576 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15577 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15580 /* Restore current_buffer and value of point in it. The window
15581 update may have changed the buffer, so first make sure `opoint'
15582 is still valid (Bug#6177). */
15583 if (CHARPOS (opoint
) < BEGV
)
15584 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15585 else if (CHARPOS (opoint
) > ZV
)
15586 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15588 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15590 set_buffer_internal_1 (old
);
15591 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15592 shorter. This can be caused by log truncation in *Messages*. */
15593 if (CHARPOS (lpoint
) <= ZV
)
15594 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15596 unbind_to (count
, Qnil
);
15600 /* Build the complete desired matrix of WINDOW with a window start
15601 buffer position POS.
15603 Value is 1 if successful. It is zero if fonts were loaded during
15604 redisplay which makes re-adjusting glyph matrices necessary, and -1
15605 if point would appear in the scroll margins.
15606 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15607 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15611 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15613 struct window
*w
= XWINDOW (window
);
15615 struct glyph_row
*last_text_row
= NULL
;
15616 struct frame
*f
= XFRAME (w
->frame
);
15618 /* Make POS the new window start. */
15619 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15621 /* Mark cursor position as unknown. No overlay arrow seen. */
15622 w
->cursor
.vpos
= -1;
15623 overlay_arrow_seen
= 0;
15625 /* Initialize iterator and info to start at POS. */
15626 start_display (&it
, w
, pos
);
15628 /* Display all lines of W. */
15629 while (it
.current_y
< it
.last_visible_y
)
15631 if (display_line (&it
))
15632 last_text_row
= it
.glyph_row
- 1;
15633 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15637 /* Don't let the cursor end in the scroll margins. */
15638 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15639 && !MINI_WINDOW_P (w
))
15641 int this_scroll_margin
;
15643 if (scroll_margin
> 0)
15645 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15646 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15649 this_scroll_margin
= 0;
15651 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15652 && w
->cursor
.y
< this_scroll_margin
15653 && CHARPOS (pos
) > BEGV
15654 && IT_CHARPOS (it
) < ZV
)
15655 /* rms: considering make_cursor_line_fully_visible_p here
15656 seems to give wrong results. We don't want to recenter
15657 when the last line is partly visible, we want to allow
15658 that case to be handled in the usual way. */
15659 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15661 w
->cursor
.vpos
= -1;
15662 clear_glyph_matrix (w
->desired_matrix
);
15667 /* If bottom moved off end of frame, change mode line percentage. */
15668 if (XFASTINT (w
->window_end_pos
) <= 0
15669 && Z
!= IT_CHARPOS (it
))
15670 w
->update_mode_line
= Qt
;
15672 /* Set window_end_pos to the offset of the last character displayed
15673 on the window from the end of current_buffer. Set
15674 window_end_vpos to its row number. */
15677 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15678 w
->window_end_bytepos
15679 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15681 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15683 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15684 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15685 ->displays_text_p
);
15689 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15690 w
->window_end_pos
= make_number (Z
- ZV
);
15691 w
->window_end_vpos
= make_number (0);
15694 /* But that is not valid info until redisplay finishes. */
15695 w
->window_end_valid
= Qnil
;
15701 /************************************************************************
15702 Window redisplay reusing current matrix when buffer has not changed
15703 ************************************************************************/
15705 /* Try redisplay of window W showing an unchanged buffer with a
15706 different window start than the last time it was displayed by
15707 reusing its current matrix. Value is non-zero if successful.
15708 W->start is the new window start. */
15711 try_window_reusing_current_matrix (struct window
*w
)
15713 struct frame
*f
= XFRAME (w
->frame
);
15714 struct glyph_row
*bottom_row
;
15717 struct text_pos start
, new_start
;
15718 int nrows_scrolled
, i
;
15719 struct glyph_row
*last_text_row
;
15720 struct glyph_row
*last_reused_text_row
;
15721 struct glyph_row
*start_row
;
15722 int start_vpos
, min_y
, max_y
;
15725 if (inhibit_try_window_reusing
)
15729 if (/* This function doesn't handle terminal frames. */
15730 !FRAME_WINDOW_P (f
)
15731 /* Don't try to reuse the display if windows have been split
15733 || windows_or_buffers_changed
15734 || cursor_type_changed
)
15737 /* Can't do this if region may have changed. */
15738 if ((!NILP (Vtransient_mark_mode
)
15739 && !NILP (BVAR (current_buffer
, mark_active
)))
15740 || !NILP (w
->region_showing
)
15741 || !NILP (Vshow_trailing_whitespace
))
15744 /* If top-line visibility has changed, give up. */
15745 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15746 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15749 /* Give up if old or new display is scrolled vertically. We could
15750 make this function handle this, but right now it doesn't. */
15751 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15752 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15755 /* The variable new_start now holds the new window start. The old
15756 start `start' can be determined from the current matrix. */
15757 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15758 start
= start_row
->minpos
;
15759 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15761 /* Clear the desired matrix for the display below. */
15762 clear_glyph_matrix (w
->desired_matrix
);
15764 if (CHARPOS (new_start
) <= CHARPOS (start
))
15766 /* Don't use this method if the display starts with an ellipsis
15767 displayed for invisible text. It's not easy to handle that case
15768 below, and it's certainly not worth the effort since this is
15769 not a frequent case. */
15770 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15773 IF_DEBUG (debug_method_add (w
, "twu1"));
15775 /* Display up to a row that can be reused. The variable
15776 last_text_row is set to the last row displayed that displays
15777 text. Note that it.vpos == 0 if or if not there is a
15778 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15779 start_display (&it
, w
, new_start
);
15780 w
->cursor
.vpos
= -1;
15781 last_text_row
= last_reused_text_row
= NULL
;
15783 while (it
.current_y
< it
.last_visible_y
15784 && !fonts_changed_p
)
15786 /* If we have reached into the characters in the START row,
15787 that means the line boundaries have changed. So we
15788 can't start copying with the row START. Maybe it will
15789 work to start copying with the following row. */
15790 while (IT_CHARPOS (it
) > CHARPOS (start
))
15792 /* Advance to the next row as the "start". */
15794 start
= start_row
->minpos
;
15795 /* If there are no more rows to try, or just one, give up. */
15796 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15797 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15798 || CHARPOS (start
) == ZV
)
15800 clear_glyph_matrix (w
->desired_matrix
);
15804 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15806 /* If we have reached alignment,
15807 we can copy the rest of the rows. */
15808 if (IT_CHARPOS (it
) == CHARPOS (start
))
15811 if (display_line (&it
))
15812 last_text_row
= it
.glyph_row
- 1;
15815 /* A value of current_y < last_visible_y means that we stopped
15816 at the previous window start, which in turn means that we
15817 have at least one reusable row. */
15818 if (it
.current_y
< it
.last_visible_y
)
15820 struct glyph_row
*row
;
15822 /* IT.vpos always starts from 0; it counts text lines. */
15823 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15825 /* Find PT if not already found in the lines displayed. */
15826 if (w
->cursor
.vpos
< 0)
15828 int dy
= it
.current_y
- start_row
->y
;
15830 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15831 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15833 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15834 dy
, nrows_scrolled
);
15837 clear_glyph_matrix (w
->desired_matrix
);
15842 /* Scroll the display. Do it before the current matrix is
15843 changed. The problem here is that update has not yet
15844 run, i.e. part of the current matrix is not up to date.
15845 scroll_run_hook will clear the cursor, and use the
15846 current matrix to get the height of the row the cursor is
15848 run
.current_y
= start_row
->y
;
15849 run
.desired_y
= it
.current_y
;
15850 run
.height
= it
.last_visible_y
- it
.current_y
;
15852 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15855 FRAME_RIF (f
)->update_window_begin_hook (w
);
15856 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15857 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15858 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15862 /* Shift current matrix down by nrows_scrolled lines. */
15863 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15864 rotate_matrix (w
->current_matrix
,
15866 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15869 /* Disable lines that must be updated. */
15870 for (i
= 0; i
< nrows_scrolled
; ++i
)
15871 (start_row
+ i
)->enabled_p
= 0;
15873 /* Re-compute Y positions. */
15874 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15875 max_y
= it
.last_visible_y
;
15876 for (row
= start_row
+ nrows_scrolled
;
15880 row
->y
= it
.current_y
;
15881 row
->visible_height
= row
->height
;
15883 if (row
->y
< min_y
)
15884 row
->visible_height
-= min_y
- row
->y
;
15885 if (row
->y
+ row
->height
> max_y
)
15886 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15887 if (row
->fringe_bitmap_periodic_p
)
15888 row
->redraw_fringe_bitmaps_p
= 1;
15890 it
.current_y
+= row
->height
;
15892 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15893 last_reused_text_row
= row
;
15894 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15898 /* Disable lines in the current matrix which are now
15899 below the window. */
15900 for (++row
; row
< bottom_row
; ++row
)
15901 row
->enabled_p
= row
->mode_line_p
= 0;
15904 /* Update window_end_pos etc.; last_reused_text_row is the last
15905 reused row from the current matrix containing text, if any.
15906 The value of last_text_row is the last displayed line
15907 containing text. */
15908 if (last_reused_text_row
)
15910 w
->window_end_bytepos
15911 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15913 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15915 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15916 w
->current_matrix
));
15918 else if (last_text_row
)
15920 w
->window_end_bytepos
15921 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15923 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15925 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15929 /* This window must be completely empty. */
15930 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15931 w
->window_end_pos
= make_number (Z
- ZV
);
15932 w
->window_end_vpos
= make_number (0);
15934 w
->window_end_valid
= Qnil
;
15936 /* Update hint: don't try scrolling again in update_window. */
15937 w
->desired_matrix
->no_scrolling_p
= 1;
15940 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15944 else if (CHARPOS (new_start
) > CHARPOS (start
))
15946 struct glyph_row
*pt_row
, *row
;
15947 struct glyph_row
*first_reusable_row
;
15948 struct glyph_row
*first_row_to_display
;
15950 int yb
= window_text_bottom_y (w
);
15952 /* Find the row starting at new_start, if there is one. Don't
15953 reuse a partially visible line at the end. */
15954 first_reusable_row
= start_row
;
15955 while (first_reusable_row
->enabled_p
15956 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15957 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15958 < CHARPOS (new_start
)))
15959 ++first_reusable_row
;
15961 /* Give up if there is no row to reuse. */
15962 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15963 || !first_reusable_row
->enabled_p
15964 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15965 != CHARPOS (new_start
)))
15968 /* We can reuse fully visible rows beginning with
15969 first_reusable_row to the end of the window. Set
15970 first_row_to_display to the first row that cannot be reused.
15971 Set pt_row to the row containing point, if there is any. */
15973 for (first_row_to_display
= first_reusable_row
;
15974 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15975 ++first_row_to_display
)
15977 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15978 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15979 pt_row
= first_row_to_display
;
15982 /* Start displaying at the start of first_row_to_display. */
15983 xassert (first_row_to_display
->y
< yb
);
15984 init_to_row_start (&it
, w
, first_row_to_display
);
15986 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15988 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15990 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15991 + WINDOW_HEADER_LINE_HEIGHT (w
));
15993 /* Display lines beginning with first_row_to_display in the
15994 desired matrix. Set last_text_row to the last row displayed
15995 that displays text. */
15996 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15997 if (pt_row
== NULL
)
15998 w
->cursor
.vpos
= -1;
15999 last_text_row
= NULL
;
16000 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16001 if (display_line (&it
))
16002 last_text_row
= it
.glyph_row
- 1;
16004 /* If point is in a reused row, adjust y and vpos of the cursor
16008 w
->cursor
.vpos
-= nrows_scrolled
;
16009 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16012 /* Give up if point isn't in a row displayed or reused. (This
16013 also handles the case where w->cursor.vpos < nrows_scrolled
16014 after the calls to display_line, which can happen with scroll
16015 margins. See bug#1295.) */
16016 if (w
->cursor
.vpos
< 0)
16018 clear_glyph_matrix (w
->desired_matrix
);
16022 /* Scroll the display. */
16023 run
.current_y
= first_reusable_row
->y
;
16024 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16025 run
.height
= it
.last_visible_y
- run
.current_y
;
16026 dy
= run
.current_y
- run
.desired_y
;
16031 FRAME_RIF (f
)->update_window_begin_hook (w
);
16032 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16033 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16034 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16038 /* Adjust Y positions of reused rows. */
16039 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16040 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16041 max_y
= it
.last_visible_y
;
16042 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16045 row
->visible_height
= row
->height
;
16046 if (row
->y
< min_y
)
16047 row
->visible_height
-= min_y
- row
->y
;
16048 if (row
->y
+ row
->height
> max_y
)
16049 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16050 if (row
->fringe_bitmap_periodic_p
)
16051 row
->redraw_fringe_bitmaps_p
= 1;
16054 /* Scroll the current matrix. */
16055 xassert (nrows_scrolled
> 0);
16056 rotate_matrix (w
->current_matrix
,
16058 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16061 /* Disable rows not reused. */
16062 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16063 row
->enabled_p
= 0;
16065 /* Point may have moved to a different line, so we cannot assume that
16066 the previous cursor position is valid; locate the correct row. */
16069 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16070 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16074 w
->cursor
.y
= row
->y
;
16076 if (row
< bottom_row
)
16078 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16079 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
16081 /* Can't use this optimization with bidi-reordered glyph
16082 rows, unless cursor is already at point. */
16083 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16085 if (!(w
->cursor
.hpos
>= 0
16086 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16087 && BUFFERP (glyph
->object
)
16088 && glyph
->charpos
== PT
))
16093 && (!BUFFERP (glyph
->object
)
16094 || glyph
->charpos
< PT
);
16098 w
->cursor
.x
+= glyph
->pixel_width
;
16103 /* Adjust window end. A null value of last_text_row means that
16104 the window end is in reused rows which in turn means that
16105 only its vpos can have changed. */
16108 w
->window_end_bytepos
16109 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16111 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16113 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16118 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16121 w
->window_end_valid
= Qnil
;
16122 w
->desired_matrix
->no_scrolling_p
= 1;
16125 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16135 /************************************************************************
16136 Window redisplay reusing current matrix when buffer has changed
16137 ************************************************************************/
16139 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16140 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16141 EMACS_INT
*, EMACS_INT
*);
16142 static struct glyph_row
*
16143 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16144 struct glyph_row
*);
16147 /* Return the last row in MATRIX displaying text. If row START is
16148 non-null, start searching with that row. IT gives the dimensions
16149 of the display. Value is null if matrix is empty; otherwise it is
16150 a pointer to the row found. */
16152 static struct glyph_row
*
16153 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16154 struct glyph_row
*start
)
16156 struct glyph_row
*row
, *row_found
;
16158 /* Set row_found to the last row in IT->w's current matrix
16159 displaying text. The loop looks funny but think of partially
16162 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16163 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16165 xassert (row
->enabled_p
);
16167 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16176 /* Return the last row in the current matrix of W that is not affected
16177 by changes at the start of current_buffer that occurred since W's
16178 current matrix was built. Value is null if no such row exists.
16180 BEG_UNCHANGED us the number of characters unchanged at the start of
16181 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16182 first changed character in current_buffer. Characters at positions <
16183 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16184 when the current matrix was built. */
16186 static struct glyph_row
*
16187 find_last_unchanged_at_beg_row (struct window
*w
)
16189 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16190 struct glyph_row
*row
;
16191 struct glyph_row
*row_found
= NULL
;
16192 int yb
= window_text_bottom_y (w
);
16194 /* Find the last row displaying unchanged text. */
16195 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16196 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16197 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16200 if (/* If row ends before first_changed_pos, it is unchanged,
16201 except in some case. */
16202 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16203 /* When row ends in ZV and we write at ZV it is not
16205 && !row
->ends_at_zv_p
16206 /* When first_changed_pos is the end of a continued line,
16207 row is not unchanged because it may be no longer
16209 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16210 && (row
->continued_p
16211 || row
->exact_window_width_line_p
)))
16214 /* Stop if last visible row. */
16215 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16223 /* Find the first glyph row in the current matrix of W that is not
16224 affected by changes at the end of current_buffer since the
16225 time W's current matrix was built.
16227 Return in *DELTA the number of chars by which buffer positions in
16228 unchanged text at the end of current_buffer must be adjusted.
16230 Return in *DELTA_BYTES the corresponding number of bytes.
16232 Value is null if no such row exists, i.e. all rows are affected by
16235 static struct glyph_row
*
16236 find_first_unchanged_at_end_row (struct window
*w
,
16237 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16239 struct glyph_row
*row
;
16240 struct glyph_row
*row_found
= NULL
;
16242 *delta
= *delta_bytes
= 0;
16244 /* Display must not have been paused, otherwise the current matrix
16245 is not up to date. */
16246 eassert (!NILP (w
->window_end_valid
));
16248 /* A value of window_end_pos >= END_UNCHANGED means that the window
16249 end is in the range of changed text. If so, there is no
16250 unchanged row at the end of W's current matrix. */
16251 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16254 /* Set row to the last row in W's current matrix displaying text. */
16255 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16257 /* If matrix is entirely empty, no unchanged row exists. */
16258 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16260 /* The value of row is the last glyph row in the matrix having a
16261 meaningful buffer position in it. The end position of row
16262 corresponds to window_end_pos. This allows us to translate
16263 buffer positions in the current matrix to current buffer
16264 positions for characters not in changed text. */
16266 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16267 EMACS_INT Z_BYTE_old
=
16268 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16269 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16270 struct glyph_row
*first_text_row
16271 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16273 *delta
= Z
- Z_old
;
16274 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16276 /* Set last_unchanged_pos to the buffer position of the last
16277 character in the buffer that has not been changed. Z is the
16278 index + 1 of the last character in current_buffer, i.e. by
16279 subtracting END_UNCHANGED we get the index of the last
16280 unchanged character, and we have to add BEG to get its buffer
16282 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16283 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16285 /* Search backward from ROW for a row displaying a line that
16286 starts at a minimum position >= last_unchanged_pos_old. */
16287 for (; row
> first_text_row
; --row
)
16289 /* This used to abort, but it can happen.
16290 It is ok to just stop the search instead here. KFS. */
16291 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16294 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16299 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16305 /* Make sure that glyph rows in the current matrix of window W
16306 reference the same glyph memory as corresponding rows in the
16307 frame's frame matrix. This function is called after scrolling W's
16308 current matrix on a terminal frame in try_window_id and
16309 try_window_reusing_current_matrix. */
16312 sync_frame_with_window_matrix_rows (struct window
*w
)
16314 struct frame
*f
= XFRAME (w
->frame
);
16315 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16317 /* Preconditions: W must be a leaf window and full-width. Its frame
16318 must have a frame matrix. */
16319 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16320 xassert (WINDOW_FULL_WIDTH_P (w
));
16321 xassert (!FRAME_WINDOW_P (f
));
16323 /* If W is a full-width window, glyph pointers in W's current matrix
16324 have, by definition, to be the same as glyph pointers in the
16325 corresponding frame matrix. Note that frame matrices have no
16326 marginal areas (see build_frame_matrix). */
16327 window_row
= w
->current_matrix
->rows
;
16328 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16329 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16330 while (window_row
< window_row_end
)
16332 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16333 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16335 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16336 frame_row
->glyphs
[TEXT_AREA
] = start
;
16337 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16338 frame_row
->glyphs
[LAST_AREA
] = end
;
16340 /* Disable frame rows whose corresponding window rows have
16341 been disabled in try_window_id. */
16342 if (!window_row
->enabled_p
)
16343 frame_row
->enabled_p
= 0;
16345 ++window_row
, ++frame_row
;
16350 /* Find the glyph row in window W containing CHARPOS. Consider all
16351 rows between START and END (not inclusive). END null means search
16352 all rows to the end of the display area of W. Value is the row
16353 containing CHARPOS or null. */
16356 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16357 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16359 struct glyph_row
*row
= start
;
16360 struct glyph_row
*best_row
= NULL
;
16361 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16364 /* If we happen to start on a header-line, skip that. */
16365 if (row
->mode_line_p
)
16368 if ((end
&& row
>= end
) || !row
->enabled_p
)
16371 last_y
= window_text_bottom_y (w
) - dy
;
16375 /* Give up if we have gone too far. */
16376 if (end
&& row
>= end
)
16378 /* This formerly returned if they were equal.
16379 I think that both quantities are of a "last plus one" type;
16380 if so, when they are equal, the row is within the screen. -- rms. */
16381 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16384 /* If it is in this row, return this row. */
16385 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16386 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16387 /* The end position of a row equals the start
16388 position of the next row. If CHARPOS is there, we
16389 would rather display it in the next line, except
16390 when this line ends in ZV. */
16391 && !row
->ends_at_zv_p
16392 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16393 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16397 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16398 || (!best_row
&& !row
->continued_p
))
16400 /* In bidi-reordered rows, there could be several rows
16401 occluding point, all of them belonging to the same
16402 continued line. We need to find the row which fits
16403 CHARPOS the best. */
16404 for (g
= row
->glyphs
[TEXT_AREA
];
16405 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16408 if (!STRINGP (g
->object
))
16410 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16412 mindif
= eabs (g
->charpos
- charpos
);
16414 /* Exact match always wins. */
16421 else if (best_row
&& !row
->continued_p
)
16428 /* Try to redisplay window W by reusing its existing display. W's
16429 current matrix must be up to date when this function is called,
16430 i.e. window_end_valid must not be nil.
16434 1 if display has been updated
16435 0 if otherwise unsuccessful
16436 -1 if redisplay with same window start is known not to succeed
16438 The following steps are performed:
16440 1. Find the last row in the current matrix of W that is not
16441 affected by changes at the start of current_buffer. If no such row
16444 2. Find the first row in W's current matrix that is not affected by
16445 changes at the end of current_buffer. Maybe there is no such row.
16447 3. Display lines beginning with the row + 1 found in step 1 to the
16448 row found in step 2 or, if step 2 didn't find a row, to the end of
16451 4. If cursor is not known to appear on the window, give up.
16453 5. If display stopped at the row found in step 2, scroll the
16454 display and current matrix as needed.
16456 6. Maybe display some lines at the end of W, if we must. This can
16457 happen under various circumstances, like a partially visible line
16458 becoming fully visible, or because newly displayed lines are displayed
16459 in smaller font sizes.
16461 7. Update W's window end information. */
16464 try_window_id (struct window
*w
)
16466 struct frame
*f
= XFRAME (w
->frame
);
16467 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16468 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16469 struct glyph_row
*last_unchanged_at_beg_row
;
16470 struct glyph_row
*first_unchanged_at_end_row
;
16471 struct glyph_row
*row
;
16472 struct glyph_row
*bottom_row
;
16475 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16477 struct text_pos start_pos
;
16479 int first_unchanged_at_end_vpos
= 0;
16480 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16481 struct text_pos start
;
16482 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16485 if (inhibit_try_window_id
)
16489 /* This is handy for debugging. */
16491 #define GIVE_UP(X) \
16493 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16497 #define GIVE_UP(X) return 0
16500 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16502 /* Don't use this for mini-windows because these can show
16503 messages and mini-buffers, and we don't handle that here. */
16504 if (MINI_WINDOW_P (w
))
16507 /* This flag is used to prevent redisplay optimizations. */
16508 if (windows_or_buffers_changed
|| cursor_type_changed
)
16511 /* Verify that narrowing has not changed.
16512 Also verify that we were not told to prevent redisplay optimizations.
16513 It would be nice to further
16514 reduce the number of cases where this prevents try_window_id. */
16515 if (current_buffer
->clip_changed
16516 || current_buffer
->prevent_redisplay_optimizations_p
)
16519 /* Window must either use window-based redisplay or be full width. */
16520 if (!FRAME_WINDOW_P (f
)
16521 && (!FRAME_LINE_INS_DEL_OK (f
)
16522 || !WINDOW_FULL_WIDTH_P (w
)))
16525 /* Give up if point is known NOT to appear in W. */
16526 if (PT
< CHARPOS (start
))
16529 /* Another way to prevent redisplay optimizations. */
16530 if (XFASTINT (w
->last_modified
) == 0)
16533 /* Verify that window is not hscrolled. */
16534 if (XFASTINT (w
->hscroll
) != 0)
16537 /* Verify that display wasn't paused. */
16538 if (NILP (w
->window_end_valid
))
16541 /* Can't use this if highlighting a region because a cursor movement
16542 will do more than just set the cursor. */
16543 if (!NILP (Vtransient_mark_mode
)
16544 && !NILP (BVAR (current_buffer
, mark_active
)))
16547 /* Likewise if highlighting trailing whitespace. */
16548 if (!NILP (Vshow_trailing_whitespace
))
16551 /* Likewise if showing a region. */
16552 if (!NILP (w
->region_showing
))
16555 /* Can't use this if overlay arrow position and/or string have
16557 if (overlay_arrows_changed_p ())
16560 /* When word-wrap is on, adding a space to the first word of a
16561 wrapped line can change the wrap position, altering the line
16562 above it. It might be worthwhile to handle this more
16563 intelligently, but for now just redisplay from scratch. */
16564 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16567 /* Under bidi reordering, adding or deleting a character in the
16568 beginning of a paragraph, before the first strong directional
16569 character, can change the base direction of the paragraph (unless
16570 the buffer specifies a fixed paragraph direction), which will
16571 require to redisplay the whole paragraph. It might be worthwhile
16572 to find the paragraph limits and widen the range of redisplayed
16573 lines to that, but for now just give up this optimization and
16574 redisplay from scratch. */
16575 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16576 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16579 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16580 only if buffer has really changed. The reason is that the gap is
16581 initially at Z for freshly visited files. The code below would
16582 set end_unchanged to 0 in that case. */
16583 if (MODIFF
> SAVE_MODIFF
16584 /* This seems to happen sometimes after saving a buffer. */
16585 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16587 if (GPT
- BEG
< BEG_UNCHANGED
)
16588 BEG_UNCHANGED
= GPT
- BEG
;
16589 if (Z
- GPT
< END_UNCHANGED
)
16590 END_UNCHANGED
= Z
- GPT
;
16593 /* The position of the first and last character that has been changed. */
16594 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16595 last_changed_charpos
= Z
- END_UNCHANGED
;
16597 /* If window starts after a line end, and the last change is in
16598 front of that newline, then changes don't affect the display.
16599 This case happens with stealth-fontification. Note that although
16600 the display is unchanged, glyph positions in the matrix have to
16601 be adjusted, of course. */
16602 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16603 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16604 && ((last_changed_charpos
< CHARPOS (start
)
16605 && CHARPOS (start
) == BEGV
)
16606 || (last_changed_charpos
< CHARPOS (start
) - 1
16607 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16609 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16610 struct glyph_row
*r0
;
16612 /* Compute how many chars/bytes have been added to or removed
16613 from the buffer. */
16614 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16615 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16616 Z_delta
= Z
- Z_old
;
16617 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16619 /* Give up if PT is not in the window. Note that it already has
16620 been checked at the start of try_window_id that PT is not in
16621 front of the window start. */
16622 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16625 /* If window start is unchanged, we can reuse the whole matrix
16626 as is, after adjusting glyph positions. No need to compute
16627 the window end again, since its offset from Z hasn't changed. */
16628 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16629 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16630 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16631 /* PT must not be in a partially visible line. */
16632 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16633 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16635 /* Adjust positions in the glyph matrix. */
16636 if (Z_delta
|| Z_delta_bytes
)
16638 struct glyph_row
*r1
16639 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16640 increment_matrix_positions (w
->current_matrix
,
16641 MATRIX_ROW_VPOS (r0
, current_matrix
),
16642 MATRIX_ROW_VPOS (r1
, current_matrix
),
16643 Z_delta
, Z_delta_bytes
);
16646 /* Set the cursor. */
16647 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16649 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16656 /* Handle the case that changes are all below what is displayed in
16657 the window, and that PT is in the window. This shortcut cannot
16658 be taken if ZV is visible in the window, and text has been added
16659 there that is visible in the window. */
16660 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16661 /* ZV is not visible in the window, or there are no
16662 changes at ZV, actually. */
16663 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16664 || first_changed_charpos
== last_changed_charpos
))
16666 struct glyph_row
*r0
;
16668 /* Give up if PT is not in the window. Note that it already has
16669 been checked at the start of try_window_id that PT is not in
16670 front of the window start. */
16671 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16674 /* If window start is unchanged, we can reuse the whole matrix
16675 as is, without changing glyph positions since no text has
16676 been added/removed in front of the window end. */
16677 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16678 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16679 /* PT must not be in a partially visible line. */
16680 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16681 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16683 /* We have to compute the window end anew since text
16684 could have been added/removed after it. */
16686 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16687 w
->window_end_bytepos
16688 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16690 /* Set the cursor. */
16691 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16693 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16700 /* Give up if window start is in the changed area.
16702 The condition used to read
16704 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16706 but why that was tested escapes me at the moment. */
16707 if (CHARPOS (start
) >= first_changed_charpos
16708 && CHARPOS (start
) <= last_changed_charpos
)
16711 /* Check that window start agrees with the start of the first glyph
16712 row in its current matrix. Check this after we know the window
16713 start is not in changed text, otherwise positions would not be
16715 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16716 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16719 /* Give up if the window ends in strings. Overlay strings
16720 at the end are difficult to handle, so don't try. */
16721 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16722 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16725 /* Compute the position at which we have to start displaying new
16726 lines. Some of the lines at the top of the window might be
16727 reusable because they are not displaying changed text. Find the
16728 last row in W's current matrix not affected by changes at the
16729 start of current_buffer. Value is null if changes start in the
16730 first line of window. */
16731 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16732 if (last_unchanged_at_beg_row
)
16734 /* Avoid starting to display in the moddle of a character, a TAB
16735 for instance. This is easier than to set up the iterator
16736 exactly, and it's not a frequent case, so the additional
16737 effort wouldn't really pay off. */
16738 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16739 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16740 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16741 --last_unchanged_at_beg_row
;
16743 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16746 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16748 start_pos
= it
.current
.pos
;
16750 /* Start displaying new lines in the desired matrix at the same
16751 vpos we would use in the current matrix, i.e. below
16752 last_unchanged_at_beg_row. */
16753 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16755 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16756 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16758 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16762 /* There are no reusable lines at the start of the window.
16763 Start displaying in the first text line. */
16764 start_display (&it
, w
, start
);
16765 it
.vpos
= it
.first_vpos
;
16766 start_pos
= it
.current
.pos
;
16769 /* Find the first row that is not affected by changes at the end of
16770 the buffer. Value will be null if there is no unchanged row, in
16771 which case we must redisplay to the end of the window. delta
16772 will be set to the value by which buffer positions beginning with
16773 first_unchanged_at_end_row have to be adjusted due to text
16775 first_unchanged_at_end_row
16776 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16777 IF_DEBUG (debug_delta
= delta
);
16778 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16780 /* Set stop_pos to the buffer position up to which we will have to
16781 display new lines. If first_unchanged_at_end_row != NULL, this
16782 is the buffer position of the start of the line displayed in that
16783 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16784 that we don't stop at a buffer position. */
16786 if (first_unchanged_at_end_row
)
16788 xassert (last_unchanged_at_beg_row
== NULL
16789 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16791 /* If this is a continuation line, move forward to the next one
16792 that isn't. Changes in lines above affect this line.
16793 Caution: this may move first_unchanged_at_end_row to a row
16794 not displaying text. */
16795 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16796 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16797 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16798 < it
.last_visible_y
))
16799 ++first_unchanged_at_end_row
;
16801 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16802 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16803 >= it
.last_visible_y
))
16804 first_unchanged_at_end_row
= NULL
;
16807 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16809 first_unchanged_at_end_vpos
16810 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16811 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16814 else if (last_unchanged_at_beg_row
== NULL
)
16820 /* Either there is no unchanged row at the end, or the one we have
16821 now displays text. This is a necessary condition for the window
16822 end pos calculation at the end of this function. */
16823 xassert (first_unchanged_at_end_row
== NULL
16824 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16826 debug_last_unchanged_at_beg_vpos
16827 = (last_unchanged_at_beg_row
16828 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16830 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16832 #endif /* GLYPH_DEBUG != 0 */
16835 /* Display new lines. Set last_text_row to the last new line
16836 displayed which has text on it, i.e. might end up as being the
16837 line where the window_end_vpos is. */
16838 w
->cursor
.vpos
= -1;
16839 last_text_row
= NULL
;
16840 overlay_arrow_seen
= 0;
16841 while (it
.current_y
< it
.last_visible_y
16842 && !fonts_changed_p
16843 && (first_unchanged_at_end_row
== NULL
16844 || IT_CHARPOS (it
) < stop_pos
))
16846 if (display_line (&it
))
16847 last_text_row
= it
.glyph_row
- 1;
16850 if (fonts_changed_p
)
16854 /* Compute differences in buffer positions, y-positions etc. for
16855 lines reused at the bottom of the window. Compute what we can
16857 if (first_unchanged_at_end_row
16858 /* No lines reused because we displayed everything up to the
16859 bottom of the window. */
16860 && it
.current_y
< it
.last_visible_y
)
16863 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16865 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16866 run
.current_y
= first_unchanged_at_end_row
->y
;
16867 run
.desired_y
= run
.current_y
+ dy
;
16868 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16872 delta
= delta_bytes
= dvpos
= dy
16873 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16874 first_unchanged_at_end_row
= NULL
;
16876 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16879 /* Find the cursor if not already found. We have to decide whether
16880 PT will appear on this window (it sometimes doesn't, but this is
16881 not a very frequent case.) This decision has to be made before
16882 the current matrix is altered. A value of cursor.vpos < 0 means
16883 that PT is either in one of the lines beginning at
16884 first_unchanged_at_end_row or below the window. Don't care for
16885 lines that might be displayed later at the window end; as
16886 mentioned, this is not a frequent case. */
16887 if (w
->cursor
.vpos
< 0)
16889 /* Cursor in unchanged rows at the top? */
16890 if (PT
< CHARPOS (start_pos
)
16891 && last_unchanged_at_beg_row
)
16893 row
= row_containing_pos (w
, PT
,
16894 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16895 last_unchanged_at_beg_row
+ 1, 0);
16897 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16900 /* Start from first_unchanged_at_end_row looking for PT. */
16901 else if (first_unchanged_at_end_row
)
16903 row
= row_containing_pos (w
, PT
- delta
,
16904 first_unchanged_at_end_row
, NULL
, 0);
16906 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16907 delta_bytes
, dy
, dvpos
);
16910 /* Give up if cursor was not found. */
16911 if (w
->cursor
.vpos
< 0)
16913 clear_glyph_matrix (w
->desired_matrix
);
16918 /* Don't let the cursor end in the scroll margins. */
16920 int this_scroll_margin
, cursor_height
;
16922 this_scroll_margin
= max (0, scroll_margin
);
16923 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16924 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16925 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16927 if ((w
->cursor
.y
< this_scroll_margin
16928 && CHARPOS (start
) > BEGV
)
16929 /* Old redisplay didn't take scroll margin into account at the bottom,
16930 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16931 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16932 ? cursor_height
+ this_scroll_margin
16933 : 1)) > it
.last_visible_y
)
16935 w
->cursor
.vpos
= -1;
16936 clear_glyph_matrix (w
->desired_matrix
);
16941 /* Scroll the display. Do it before changing the current matrix so
16942 that xterm.c doesn't get confused about where the cursor glyph is
16944 if (dy
&& run
.height
)
16948 if (FRAME_WINDOW_P (f
))
16950 FRAME_RIF (f
)->update_window_begin_hook (w
);
16951 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16952 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16953 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16957 /* Terminal frame. In this case, dvpos gives the number of
16958 lines to scroll by; dvpos < 0 means scroll up. */
16960 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16961 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16962 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16963 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16964 + window_internal_height (w
));
16966 #if defined (HAVE_GPM) || defined (MSDOS)
16967 x_clear_window_mouse_face (w
);
16969 /* Perform the operation on the screen. */
16972 /* Scroll last_unchanged_at_beg_row to the end of the
16973 window down dvpos lines. */
16974 set_terminal_window (f
, end
);
16976 /* On dumb terminals delete dvpos lines at the end
16977 before inserting dvpos empty lines. */
16978 if (!FRAME_SCROLL_REGION_OK (f
))
16979 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16981 /* Insert dvpos empty lines in front of
16982 last_unchanged_at_beg_row. */
16983 ins_del_lines (f
, from
, dvpos
);
16985 else if (dvpos
< 0)
16987 /* Scroll up last_unchanged_at_beg_vpos to the end of
16988 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16989 set_terminal_window (f
, end
);
16991 /* Delete dvpos lines in front of
16992 last_unchanged_at_beg_vpos. ins_del_lines will set
16993 the cursor to the given vpos and emit |dvpos| delete
16995 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16997 /* On a dumb terminal insert dvpos empty lines at the
16999 if (!FRAME_SCROLL_REGION_OK (f
))
17000 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17003 set_terminal_window (f
, 0);
17009 /* Shift reused rows of the current matrix to the right position.
17010 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17012 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17013 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17016 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17017 bottom_vpos
, dvpos
);
17018 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17021 else if (dvpos
> 0)
17023 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17024 bottom_vpos
, dvpos
);
17025 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17026 first_unchanged_at_end_vpos
+ dvpos
, 0);
17029 /* For frame-based redisplay, make sure that current frame and window
17030 matrix are in sync with respect to glyph memory. */
17031 if (!FRAME_WINDOW_P (f
))
17032 sync_frame_with_window_matrix_rows (w
);
17034 /* Adjust buffer positions in reused rows. */
17035 if (delta
|| delta_bytes
)
17036 increment_matrix_positions (current_matrix
,
17037 first_unchanged_at_end_vpos
+ dvpos
,
17038 bottom_vpos
, delta
, delta_bytes
);
17040 /* Adjust Y positions. */
17042 shift_glyph_matrix (w
, current_matrix
,
17043 first_unchanged_at_end_vpos
+ dvpos
,
17046 if (first_unchanged_at_end_row
)
17048 first_unchanged_at_end_row
+= dvpos
;
17049 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17050 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17051 first_unchanged_at_end_row
= NULL
;
17054 /* If scrolling up, there may be some lines to display at the end of
17056 last_text_row_at_end
= NULL
;
17059 /* Scrolling up can leave for example a partially visible line
17060 at the end of the window to be redisplayed. */
17061 /* Set last_row to the glyph row in the current matrix where the
17062 window end line is found. It has been moved up or down in
17063 the matrix by dvpos. */
17064 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17065 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17067 /* If last_row is the window end line, it should display text. */
17068 xassert (last_row
->displays_text_p
);
17070 /* If window end line was partially visible before, begin
17071 displaying at that line. Otherwise begin displaying with the
17072 line following it. */
17073 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17075 init_to_row_start (&it
, w
, last_row
);
17076 it
.vpos
= last_vpos
;
17077 it
.current_y
= last_row
->y
;
17081 init_to_row_end (&it
, w
, last_row
);
17082 it
.vpos
= 1 + last_vpos
;
17083 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17087 /* We may start in a continuation line. If so, we have to
17088 get the right continuation_lines_width and current_x. */
17089 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17090 it
.hpos
= it
.current_x
= 0;
17092 /* Display the rest of the lines at the window end. */
17093 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17094 while (it
.current_y
< it
.last_visible_y
17095 && !fonts_changed_p
)
17097 /* Is it always sure that the display agrees with lines in
17098 the current matrix? I don't think so, so we mark rows
17099 displayed invalid in the current matrix by setting their
17100 enabled_p flag to zero. */
17101 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17102 if (display_line (&it
))
17103 last_text_row_at_end
= it
.glyph_row
- 1;
17107 /* Update window_end_pos and window_end_vpos. */
17108 if (first_unchanged_at_end_row
17109 && !last_text_row_at_end
)
17111 /* Window end line if one of the preserved rows from the current
17112 matrix. Set row to the last row displaying text in current
17113 matrix starting at first_unchanged_at_end_row, after
17115 xassert (first_unchanged_at_end_row
->displays_text_p
);
17116 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17117 first_unchanged_at_end_row
);
17118 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17120 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17121 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17123 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17124 xassert (w
->window_end_bytepos
>= 0);
17125 IF_DEBUG (debug_method_add (w
, "A"));
17127 else if (last_text_row_at_end
)
17130 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17131 w
->window_end_bytepos
17132 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17134 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17135 xassert (w
->window_end_bytepos
>= 0);
17136 IF_DEBUG (debug_method_add (w
, "B"));
17138 else if (last_text_row
)
17140 /* We have displayed either to the end of the window or at the
17141 end of the window, i.e. the last row with text is to be found
17142 in the desired matrix. */
17144 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17145 w
->window_end_bytepos
17146 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17148 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17149 xassert (w
->window_end_bytepos
>= 0);
17151 else if (first_unchanged_at_end_row
== NULL
17152 && last_text_row
== NULL
17153 && last_text_row_at_end
== NULL
)
17155 /* Displayed to end of window, but no line containing text was
17156 displayed. Lines were deleted at the end of the window. */
17157 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17158 int vpos
= XFASTINT (w
->window_end_vpos
);
17159 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17160 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17163 row
== NULL
&& vpos
>= first_vpos
;
17164 --vpos
, --current_row
, --desired_row
)
17166 if (desired_row
->enabled_p
)
17168 if (desired_row
->displays_text_p
)
17171 else if (current_row
->displays_text_p
)
17175 xassert (row
!= NULL
);
17176 w
->window_end_vpos
= make_number (vpos
+ 1);
17177 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17178 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17179 xassert (w
->window_end_bytepos
>= 0);
17180 IF_DEBUG (debug_method_add (w
, "C"));
17185 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17186 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17188 /* Record that display has not been completed. */
17189 w
->window_end_valid
= Qnil
;
17190 w
->desired_matrix
->no_scrolling_p
= 1;
17198 /***********************************************************************
17199 More debugging support
17200 ***********************************************************************/
17204 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17205 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17206 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17209 /* Dump the contents of glyph matrix MATRIX on stderr.
17211 GLYPHS 0 means don't show glyph contents.
17212 GLYPHS 1 means show glyphs in short form
17213 GLYPHS > 1 means show glyphs in long form. */
17216 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17219 for (i
= 0; i
< matrix
->nrows
; ++i
)
17220 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17224 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17225 the glyph row and area where the glyph comes from. */
17228 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17230 if (glyph
->type
== CHAR_GLYPH
)
17233 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17234 glyph
- row
->glyphs
[TEXT_AREA
],
17237 (BUFFERP (glyph
->object
)
17239 : (STRINGP (glyph
->object
)
17242 glyph
->pixel_width
,
17244 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17248 glyph
->left_box_line_p
,
17249 glyph
->right_box_line_p
);
17251 else if (glyph
->type
== STRETCH_GLYPH
)
17254 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17255 glyph
- row
->glyphs
[TEXT_AREA
],
17258 (BUFFERP (glyph
->object
)
17260 : (STRINGP (glyph
->object
)
17263 glyph
->pixel_width
,
17267 glyph
->left_box_line_p
,
17268 glyph
->right_box_line_p
);
17270 else if (glyph
->type
== IMAGE_GLYPH
)
17273 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17274 glyph
- row
->glyphs
[TEXT_AREA
],
17277 (BUFFERP (glyph
->object
)
17279 : (STRINGP (glyph
->object
)
17282 glyph
->pixel_width
,
17286 glyph
->left_box_line_p
,
17287 glyph
->right_box_line_p
);
17289 else if (glyph
->type
== COMPOSITE_GLYPH
)
17292 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17293 glyph
- row
->glyphs
[TEXT_AREA
],
17296 (BUFFERP (glyph
->object
)
17298 : (STRINGP (glyph
->object
)
17301 glyph
->pixel_width
,
17303 if (glyph
->u
.cmp
.automatic
)
17306 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17307 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17309 glyph
->left_box_line_p
,
17310 glyph
->right_box_line_p
);
17315 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17316 GLYPHS 0 means don't show glyph contents.
17317 GLYPHS 1 means show glyphs in short form
17318 GLYPHS > 1 means show glyphs in long form. */
17321 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17325 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17326 fprintf (stderr
, "======================================================================\n");
17328 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17329 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17331 MATRIX_ROW_START_CHARPOS (row
),
17332 MATRIX_ROW_END_CHARPOS (row
),
17333 row
->used
[TEXT_AREA
],
17334 row
->contains_overlapping_glyphs_p
,
17336 row
->truncated_on_left_p
,
17337 row
->truncated_on_right_p
,
17339 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17340 row
->displays_text_p
,
17343 row
->ends_in_middle_of_char_p
,
17344 row
->starts_in_middle_of_char_p
,
17350 row
->visible_height
,
17353 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17354 row
->end
.overlay_string_index
,
17355 row
->continuation_lines_width
);
17356 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17357 CHARPOS (row
->start
.string_pos
),
17358 CHARPOS (row
->end
.string_pos
));
17359 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17360 row
->end
.dpvec_index
);
17367 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17369 struct glyph
*glyph
= row
->glyphs
[area
];
17370 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17372 /* Glyph for a line end in text. */
17373 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17376 if (glyph
< glyph_end
)
17377 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17379 for (; glyph
< glyph_end
; ++glyph
)
17380 dump_glyph (row
, glyph
, area
);
17383 else if (glyphs
== 1)
17387 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17389 char *s
= (char *) alloca (row
->used
[area
] + 1);
17392 for (i
= 0; i
< row
->used
[area
]; ++i
)
17394 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17395 if (glyph
->type
== CHAR_GLYPH
17396 && glyph
->u
.ch
< 0x80
17397 && glyph
->u
.ch
>= ' ')
17398 s
[i
] = glyph
->u
.ch
;
17404 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17410 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17411 Sdump_glyph_matrix
, 0, 1, "p",
17412 doc
: /* Dump the current matrix of the selected window to stderr.
17413 Shows contents of glyph row structures. With non-nil
17414 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17415 glyphs in short form, otherwise show glyphs in long form. */)
17416 (Lisp_Object glyphs
)
17418 struct window
*w
= XWINDOW (selected_window
);
17419 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17421 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17422 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17423 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17424 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17425 fprintf (stderr
, "=============================================\n");
17426 dump_glyph_matrix (w
->current_matrix
,
17427 NILP (glyphs
) ? 0 : XINT (glyphs
));
17432 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17433 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17436 struct frame
*f
= XFRAME (selected_frame
);
17437 dump_glyph_matrix (f
->current_matrix
, 1);
17442 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17443 doc
: /* Dump glyph row ROW to stderr.
17444 GLYPH 0 means don't dump glyphs.
17445 GLYPH 1 means dump glyphs in short form.
17446 GLYPH > 1 or omitted means dump glyphs in long form. */)
17447 (Lisp_Object row
, Lisp_Object glyphs
)
17449 struct glyph_matrix
*matrix
;
17452 CHECK_NUMBER (row
);
17453 matrix
= XWINDOW (selected_window
)->current_matrix
;
17455 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17456 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17458 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17463 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17464 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17465 GLYPH 0 means don't dump glyphs.
17466 GLYPH 1 means dump glyphs in short form.
17467 GLYPH > 1 or omitted means dump glyphs in long form. */)
17468 (Lisp_Object row
, Lisp_Object glyphs
)
17470 struct frame
*sf
= SELECTED_FRAME ();
17471 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17474 CHECK_NUMBER (row
);
17476 if (vpos
>= 0 && vpos
< m
->nrows
)
17477 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17478 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17483 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17484 doc
: /* Toggle tracing of redisplay.
17485 With ARG, turn tracing on if and only if ARG is positive. */)
17489 trace_redisplay_p
= !trace_redisplay_p
;
17492 arg
= Fprefix_numeric_value (arg
);
17493 trace_redisplay_p
= XINT (arg
) > 0;
17500 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17501 doc
: /* Like `format', but print result to stderr.
17502 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17503 (ptrdiff_t nargs
, Lisp_Object
*args
)
17505 Lisp_Object s
= Fformat (nargs
, args
);
17506 fprintf (stderr
, "%s", SDATA (s
));
17510 #endif /* GLYPH_DEBUG */
17514 /***********************************************************************
17515 Building Desired Matrix Rows
17516 ***********************************************************************/
17518 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17519 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17521 static struct glyph_row
*
17522 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17524 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17525 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17526 struct buffer
*old
= current_buffer
;
17527 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17528 int arrow_len
= SCHARS (overlay_arrow_string
);
17529 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17530 const unsigned char *p
;
17533 int n_glyphs_before
;
17535 set_buffer_temp (buffer
);
17536 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17537 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17538 SET_TEXT_POS (it
.position
, 0, 0);
17540 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17542 while (p
< arrow_end
)
17544 Lisp_Object face
, ilisp
;
17546 /* Get the next character. */
17548 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17551 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17552 if (! ASCII_CHAR_P (it
.c
))
17553 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17557 /* Get its face. */
17558 ilisp
= make_number (p
- arrow_string
);
17559 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17560 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17562 /* Compute its width, get its glyphs. */
17563 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17564 SET_TEXT_POS (it
.position
, -1, -1);
17565 PRODUCE_GLYPHS (&it
);
17567 /* If this character doesn't fit any more in the line, we have
17568 to remove some glyphs. */
17569 if (it
.current_x
> it
.last_visible_x
)
17571 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17576 set_buffer_temp (old
);
17577 return it
.glyph_row
;
17581 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17582 glyphs are only inserted for terminal frames since we can't really
17583 win with truncation glyphs when partially visible glyphs are
17584 involved. Which glyphs to insert is determined by
17585 produce_special_glyphs. */
17588 insert_left_trunc_glyphs (struct it
*it
)
17590 struct it truncate_it
;
17591 struct glyph
*from
, *end
, *to
, *toend
;
17593 xassert (!FRAME_WINDOW_P (it
->f
));
17595 /* Get the truncation glyphs. */
17597 truncate_it
.current_x
= 0;
17598 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17599 truncate_it
.glyph_row
= &scratch_glyph_row
;
17600 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17601 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17602 truncate_it
.object
= make_number (0);
17603 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17605 /* Overwrite glyphs from IT with truncation glyphs. */
17606 if (!it
->glyph_row
->reversed_p
)
17608 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17609 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17610 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17611 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17616 /* There may be padding glyphs left over. Overwrite them too. */
17617 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17619 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17625 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17629 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17630 that back to front. */
17631 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17632 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17633 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17634 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17636 while (from
>= end
&& to
>= toend
)
17638 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17641 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17642 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17643 while (from
>= end
&& to
>= toend
)
17648 /* Need to free some room before prepending additional
17650 int move_by
= from
- end
+ 1;
17651 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17652 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17654 for ( ; g
>= g0
; g
--)
17656 while (from
>= end
)
17658 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17664 /* Compute the pixel height and width of IT->glyph_row.
17666 Most of the time, ascent and height of a display line will be equal
17667 to the max_ascent and max_height values of the display iterator
17668 structure. This is not the case if
17670 1. We hit ZV without displaying anything. In this case, max_ascent
17671 and max_height will be zero.
17673 2. We have some glyphs that don't contribute to the line height.
17674 (The glyph row flag contributes_to_line_height_p is for future
17675 pixmap extensions).
17677 The first case is easily covered by using default values because in
17678 these cases, the line height does not really matter, except that it
17679 must not be zero. */
17682 compute_line_metrics (struct it
*it
)
17684 struct glyph_row
*row
= it
->glyph_row
;
17686 if (FRAME_WINDOW_P (it
->f
))
17688 int i
, min_y
, max_y
;
17690 /* The line may consist of one space only, that was added to
17691 place the cursor on it. If so, the row's height hasn't been
17693 if (row
->height
== 0)
17695 if (it
->max_ascent
+ it
->max_descent
== 0)
17696 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17697 row
->ascent
= it
->max_ascent
;
17698 row
->height
= it
->max_ascent
+ it
->max_descent
;
17699 row
->phys_ascent
= it
->max_phys_ascent
;
17700 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17701 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17704 /* Compute the width of this line. */
17705 row
->pixel_width
= row
->x
;
17706 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17707 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17709 xassert (row
->pixel_width
>= 0);
17710 xassert (row
->ascent
>= 0 && row
->height
> 0);
17712 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17713 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17715 /* If first line's physical ascent is larger than its logical
17716 ascent, use the physical ascent, and make the row taller.
17717 This makes accented characters fully visible. */
17718 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17719 && row
->phys_ascent
> row
->ascent
)
17721 row
->height
+= row
->phys_ascent
- row
->ascent
;
17722 row
->ascent
= row
->phys_ascent
;
17725 /* Compute how much of the line is visible. */
17726 row
->visible_height
= row
->height
;
17728 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17729 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17731 if (row
->y
< min_y
)
17732 row
->visible_height
-= min_y
- row
->y
;
17733 if (row
->y
+ row
->height
> max_y
)
17734 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17738 row
->pixel_width
= row
->used
[TEXT_AREA
];
17739 if (row
->continued_p
)
17740 row
->pixel_width
-= it
->continuation_pixel_width
;
17741 else if (row
->truncated_on_right_p
)
17742 row
->pixel_width
-= it
->truncation_pixel_width
;
17743 row
->ascent
= row
->phys_ascent
= 0;
17744 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17745 row
->extra_line_spacing
= 0;
17748 /* Compute a hash code for this row. */
17752 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17753 for (i
= 0; i
< row
->used
[area
]; ++i
)
17754 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17755 + row
->glyphs
[area
][i
].u
.val
17756 + row
->glyphs
[area
][i
].face_id
17757 + row
->glyphs
[area
][i
].padding_p
17758 + (row
->glyphs
[area
][i
].type
<< 2));
17761 it
->max_ascent
= it
->max_descent
= 0;
17762 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17766 /* Append one space to the glyph row of iterator IT if doing a
17767 window-based redisplay. The space has the same face as
17768 IT->face_id. Value is non-zero if a space was added.
17770 This function is called to make sure that there is always one glyph
17771 at the end of a glyph row that the cursor can be set on under
17772 window-systems. (If there weren't such a glyph we would not know
17773 how wide and tall a box cursor should be displayed).
17775 At the same time this space let's a nicely handle clearing to the
17776 end of the line if the row ends in italic text. */
17779 append_space_for_newline (struct it
*it
, int default_face_p
)
17781 if (FRAME_WINDOW_P (it
->f
))
17783 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17785 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17786 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17788 /* Save some values that must not be changed.
17789 Must save IT->c and IT->len because otherwise
17790 ITERATOR_AT_END_P wouldn't work anymore after
17791 append_space_for_newline has been called. */
17792 enum display_element_type saved_what
= it
->what
;
17793 int saved_c
= it
->c
, saved_len
= it
->len
;
17794 int saved_char_to_display
= it
->char_to_display
;
17795 int saved_x
= it
->current_x
;
17796 int saved_face_id
= it
->face_id
;
17797 struct text_pos saved_pos
;
17798 Lisp_Object saved_object
;
17801 saved_object
= it
->object
;
17802 saved_pos
= it
->position
;
17804 it
->what
= IT_CHARACTER
;
17805 memset (&it
->position
, 0, sizeof it
->position
);
17806 it
->object
= make_number (0);
17807 it
->c
= it
->char_to_display
= ' ';
17810 if (default_face_p
)
17811 it
->face_id
= DEFAULT_FACE_ID
;
17812 else if (it
->face_before_selective_p
)
17813 it
->face_id
= it
->saved_face_id
;
17814 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17815 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17817 PRODUCE_GLYPHS (it
);
17819 it
->override_ascent
= -1;
17820 it
->constrain_row_ascent_descent_p
= 0;
17821 it
->current_x
= saved_x
;
17822 it
->object
= saved_object
;
17823 it
->position
= saved_pos
;
17824 it
->what
= saved_what
;
17825 it
->face_id
= saved_face_id
;
17826 it
->len
= saved_len
;
17828 it
->char_to_display
= saved_char_to_display
;
17837 /* Extend the face of the last glyph in the text area of IT->glyph_row
17838 to the end of the display line. Called from display_line. If the
17839 glyph row is empty, add a space glyph to it so that we know the
17840 face to draw. Set the glyph row flag fill_line_p. If the glyph
17841 row is R2L, prepend a stretch glyph to cover the empty space to the
17842 left of the leftmost glyph. */
17845 extend_face_to_end_of_line (struct it
*it
)
17848 struct frame
*f
= it
->f
;
17850 /* If line is already filled, do nothing. Non window-system frames
17851 get a grace of one more ``pixel'' because their characters are
17852 1-``pixel'' wide, so they hit the equality too early. This grace
17853 is needed only for R2L rows that are not continued, to produce
17854 one extra blank where we could display the cursor. */
17855 if (it
->current_x
>= it
->last_visible_x
17856 + (!FRAME_WINDOW_P (f
)
17857 && it
->glyph_row
->reversed_p
17858 && !it
->glyph_row
->continued_p
))
17861 /* Face extension extends the background and box of IT->face_id
17862 to the end of the line. If the background equals the background
17863 of the frame, we don't have to do anything. */
17864 if (it
->face_before_selective_p
)
17865 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17867 face
= FACE_FROM_ID (f
, it
->face_id
);
17869 if (FRAME_WINDOW_P (f
)
17870 && it
->glyph_row
->displays_text_p
17871 && face
->box
== FACE_NO_BOX
17872 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17874 && !it
->glyph_row
->reversed_p
)
17877 /* Set the glyph row flag indicating that the face of the last glyph
17878 in the text area has to be drawn to the end of the text area. */
17879 it
->glyph_row
->fill_line_p
= 1;
17881 /* If current character of IT is not ASCII, make sure we have the
17882 ASCII face. This will be automatically undone the next time
17883 get_next_display_element returns a multibyte character. Note
17884 that the character will always be single byte in unibyte
17886 if (!ASCII_CHAR_P (it
->c
))
17888 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17891 if (FRAME_WINDOW_P (f
))
17893 /* If the row is empty, add a space with the current face of IT,
17894 so that we know which face to draw. */
17895 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17897 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17898 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17899 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17901 #ifdef HAVE_WINDOW_SYSTEM
17902 if (it
->glyph_row
->reversed_p
)
17904 /* Prepend a stretch glyph to the row, such that the
17905 rightmost glyph will be drawn flushed all the way to the
17906 right margin of the window. The stretch glyph that will
17907 occupy the empty space, if any, to the left of the
17909 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17910 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17911 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17913 int row_width
, stretch_ascent
, stretch_width
;
17914 struct text_pos saved_pos
;
17915 int saved_face_id
, saved_avoid_cursor
;
17917 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17918 row_width
+= g
->pixel_width
;
17919 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17920 if (stretch_width
> 0)
17923 (((it
->ascent
+ it
->descent
)
17924 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17925 saved_pos
= it
->position
;
17926 memset (&it
->position
, 0, sizeof it
->position
);
17927 saved_avoid_cursor
= it
->avoid_cursor_p
;
17928 it
->avoid_cursor_p
= 1;
17929 saved_face_id
= it
->face_id
;
17930 /* The last row's stretch glyph should get the default
17931 face, to avoid painting the rest of the window with
17932 the region face, if the region ends at ZV. */
17933 if (it
->glyph_row
->ends_at_zv_p
)
17934 it
->face_id
= DEFAULT_FACE_ID
;
17936 it
->face_id
= face
->id
;
17937 append_stretch_glyph (it
, make_number (0), stretch_width
,
17938 it
->ascent
+ it
->descent
, stretch_ascent
);
17939 it
->position
= saved_pos
;
17940 it
->avoid_cursor_p
= saved_avoid_cursor
;
17941 it
->face_id
= saved_face_id
;
17944 #endif /* HAVE_WINDOW_SYSTEM */
17948 /* Save some values that must not be changed. */
17949 int saved_x
= it
->current_x
;
17950 struct text_pos saved_pos
;
17951 Lisp_Object saved_object
;
17952 enum display_element_type saved_what
= it
->what
;
17953 int saved_face_id
= it
->face_id
;
17955 saved_object
= it
->object
;
17956 saved_pos
= it
->position
;
17958 it
->what
= IT_CHARACTER
;
17959 memset (&it
->position
, 0, sizeof it
->position
);
17960 it
->object
= make_number (0);
17961 it
->c
= it
->char_to_display
= ' ';
17963 /* The last row's blank glyphs should get the default face, to
17964 avoid painting the rest of the window with the region face,
17965 if the region ends at ZV. */
17966 if (it
->glyph_row
->ends_at_zv_p
)
17967 it
->face_id
= DEFAULT_FACE_ID
;
17969 it
->face_id
= face
->id
;
17971 PRODUCE_GLYPHS (it
);
17973 while (it
->current_x
<= it
->last_visible_x
)
17974 PRODUCE_GLYPHS (it
);
17976 /* Don't count these blanks really. It would let us insert a left
17977 truncation glyph below and make us set the cursor on them, maybe. */
17978 it
->current_x
= saved_x
;
17979 it
->object
= saved_object
;
17980 it
->position
= saved_pos
;
17981 it
->what
= saved_what
;
17982 it
->face_id
= saved_face_id
;
17987 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17988 trailing whitespace. */
17991 trailing_whitespace_p (EMACS_INT charpos
)
17993 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17996 while (bytepos
< ZV_BYTE
17997 && (c
= FETCH_CHAR (bytepos
),
17998 c
== ' ' || c
== '\t'))
18001 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18003 if (bytepos
!= PT_BYTE
)
18010 /* Highlight trailing whitespace, if any, in ROW. */
18013 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18015 int used
= row
->used
[TEXT_AREA
];
18019 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18020 struct glyph
*glyph
= start
+ used
- 1;
18022 if (row
->reversed_p
)
18024 /* Right-to-left rows need to be processed in the opposite
18025 direction, so swap the edge pointers. */
18027 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18030 /* Skip over glyphs inserted to display the cursor at the
18031 end of a line, for extending the face of the last glyph
18032 to the end of the line on terminals, and for truncation
18033 and continuation glyphs. */
18034 if (!row
->reversed_p
)
18036 while (glyph
>= start
18037 && glyph
->type
== CHAR_GLYPH
18038 && INTEGERP (glyph
->object
))
18043 while (glyph
<= start
18044 && glyph
->type
== CHAR_GLYPH
18045 && INTEGERP (glyph
->object
))
18049 /* If last glyph is a space or stretch, and it's trailing
18050 whitespace, set the face of all trailing whitespace glyphs in
18051 IT->glyph_row to `trailing-whitespace'. */
18052 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18053 && BUFFERP (glyph
->object
)
18054 && (glyph
->type
== STRETCH_GLYPH
18055 || (glyph
->type
== CHAR_GLYPH
18056 && glyph
->u
.ch
== ' '))
18057 && trailing_whitespace_p (glyph
->charpos
))
18059 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18063 if (!row
->reversed_p
)
18065 while (glyph
>= start
18066 && BUFFERP (glyph
->object
)
18067 && (glyph
->type
== STRETCH_GLYPH
18068 || (glyph
->type
== CHAR_GLYPH
18069 && glyph
->u
.ch
== ' ')))
18070 (glyph
--)->face_id
= face_id
;
18074 while (glyph
<= start
18075 && BUFFERP (glyph
->object
)
18076 && (glyph
->type
== STRETCH_GLYPH
18077 || (glyph
->type
== CHAR_GLYPH
18078 && glyph
->u
.ch
== ' ')))
18079 (glyph
++)->face_id
= face_id
;
18086 /* Value is non-zero if glyph row ROW should be
18087 used to hold the cursor. */
18090 cursor_row_p (struct glyph_row
*row
)
18094 if (PT
== CHARPOS (row
->end
.pos
)
18095 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18097 /* Suppose the row ends on a string.
18098 Unless the row is continued, that means it ends on a newline
18099 in the string. If it's anything other than a display string
18100 (e.g. a before-string from an overlay), we don't want the
18101 cursor there. (This heuristic seems to give the optimal
18102 behavior for the various types of multi-line strings.) */
18103 if (CHARPOS (row
->end
.string_pos
) >= 0)
18105 if (row
->continued_p
)
18109 /* Check for `display' property. */
18110 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18111 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18112 struct glyph
*glyph
;
18115 for (glyph
= end
; glyph
>= beg
; --glyph
)
18116 if (STRINGP (glyph
->object
))
18119 = Fget_char_property (make_number (PT
),
18123 && display_prop_string_p (prop
, glyph
->object
));
18128 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18130 /* If the row ends in middle of a real character,
18131 and the line is continued, we want the cursor here.
18132 That's because CHARPOS (ROW->end.pos) would equal
18133 PT if PT is before the character. */
18134 if (!row
->ends_in_ellipsis_p
)
18135 result
= row
->continued_p
;
18137 /* If the row ends in an ellipsis, then
18138 CHARPOS (ROW->end.pos) will equal point after the
18139 invisible text. We want that position to be displayed
18140 after the ellipsis. */
18143 /* If the row ends at ZV, display the cursor at the end of that
18144 row instead of at the start of the row below. */
18145 else if (row
->ends_at_zv_p
)
18156 /* Push the property PROP so that it will be rendered at the current
18157 position in IT. Return 1 if PROP was successfully pushed, 0
18158 otherwise. Called from handle_line_prefix to handle the
18159 `line-prefix' and `wrap-prefix' properties. */
18162 push_display_prop (struct it
*it
, Lisp_Object prop
)
18164 struct text_pos pos
=
18165 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18167 xassert (it
->method
== GET_FROM_BUFFER
18168 || it
->method
== GET_FROM_STRING
);
18170 /* We need to save the current buffer/string position, so it will be
18171 restored by pop_it, because iterate_out_of_display_property
18172 depends on that being set correctly, but some situations leave
18173 it->position not yet set when this function is called. */
18174 push_it (it
, &pos
);
18176 if (STRINGP (prop
))
18178 if (SCHARS (prop
) == 0)
18185 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18186 it
->current
.overlay_string_index
= -1;
18187 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18188 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18189 it
->method
= GET_FROM_STRING
;
18190 it
->stop_charpos
= 0;
18192 it
->base_level_stop
= 0;
18194 /* Force paragraph direction to be that of the parent
18196 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18197 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18199 it
->paragraph_embedding
= L2R
;
18201 /* Set up the bidi iterator for this display string. */
18204 it
->bidi_it
.string
.lstring
= it
->string
;
18205 it
->bidi_it
.string
.s
= NULL
;
18206 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18207 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18208 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18209 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18210 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18213 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18215 it
->method
= GET_FROM_STRETCH
;
18218 #ifdef HAVE_WINDOW_SYSTEM
18219 else if (IMAGEP (prop
))
18221 it
->what
= IT_IMAGE
;
18222 it
->image_id
= lookup_image (it
->f
, prop
);
18223 it
->method
= GET_FROM_IMAGE
;
18225 #endif /* HAVE_WINDOW_SYSTEM */
18228 pop_it (it
); /* bogus display property, give up */
18235 /* Return the character-property PROP at the current position in IT. */
18238 get_it_property (struct it
*it
, Lisp_Object prop
)
18240 Lisp_Object position
;
18242 if (STRINGP (it
->object
))
18243 position
= make_number (IT_STRING_CHARPOS (*it
));
18244 else if (BUFFERP (it
->object
))
18245 position
= make_number (IT_CHARPOS (*it
));
18249 return Fget_char_property (position
, prop
, it
->object
);
18252 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18255 handle_line_prefix (struct it
*it
)
18257 Lisp_Object prefix
;
18259 if (it
->continuation_lines_width
> 0)
18261 prefix
= get_it_property (it
, Qwrap_prefix
);
18263 prefix
= Vwrap_prefix
;
18267 prefix
= get_it_property (it
, Qline_prefix
);
18269 prefix
= Vline_prefix
;
18271 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18273 /* If the prefix is wider than the window, and we try to wrap
18274 it, it would acquire its own wrap prefix, and so on till the
18275 iterator stack overflows. So, don't wrap the prefix. */
18276 it
->line_wrap
= TRUNCATE
;
18277 it
->avoid_cursor_p
= 1;
18283 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18284 only for R2L lines from display_line and display_string, when they
18285 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18286 the line/string needs to be continued on the next glyph row. */
18288 unproduce_glyphs (struct it
*it
, int n
)
18290 struct glyph
*glyph
, *end
;
18292 xassert (it
->glyph_row
);
18293 xassert (it
->glyph_row
->reversed_p
);
18294 xassert (it
->area
== TEXT_AREA
);
18295 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18297 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18298 n
= it
->glyph_row
->used
[TEXT_AREA
];
18299 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18300 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18301 for ( ; glyph
< end
; glyph
++)
18302 glyph
[-n
] = *glyph
;
18305 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18306 and ROW->maxpos. */
18308 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18309 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18310 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18312 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18313 lines' rows is implemented for bidi-reordered rows. */
18315 /* ROW->minpos is the value of min_pos, the minimal buffer position
18316 we have in ROW, or ROW->start.pos if that is smaller. */
18317 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18318 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18320 /* We didn't find buffer positions smaller than ROW->start, or
18321 didn't find _any_ valid buffer positions in any of the glyphs,
18322 so we must trust the iterator's computed positions. */
18323 row
->minpos
= row
->start
.pos
;
18326 max_pos
= CHARPOS (it
->current
.pos
);
18327 max_bpos
= BYTEPOS (it
->current
.pos
);
18330 /* Here are the various use-cases for ending the row, and the
18331 corresponding values for ROW->maxpos:
18333 Line ends in a newline from buffer eol_pos + 1
18334 Line is continued from buffer max_pos + 1
18335 Line is truncated on right it->current.pos
18336 Line ends in a newline from string max_pos
18337 Line is continued from string max_pos
18338 Line is continued from display vector max_pos
18339 Line is entirely from a string min_pos == max_pos
18340 Line is entirely from a display vector min_pos == max_pos
18341 Line that ends at ZV ZV
18343 If you discover other use-cases, please add them here as
18345 if (row
->ends_at_zv_p
)
18346 row
->maxpos
= it
->current
.pos
;
18347 else if (row
->used
[TEXT_AREA
])
18349 if (row
->ends_in_newline_from_string_p
)
18350 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18351 else if (CHARPOS (it
->eol_pos
) > 0)
18352 SET_TEXT_POS (row
->maxpos
,
18353 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18354 else if (row
->continued_p
)
18356 /* If max_pos is different from IT's current position, it
18357 means IT->method does not belong to the display element
18358 at max_pos. However, it also means that the display
18359 element at max_pos was displayed in its entirety on this
18360 line, which is equivalent to saying that the next line
18361 starts at the next buffer position. */
18362 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18363 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18366 INC_BOTH (max_pos
, max_bpos
);
18367 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18370 else if (row
->truncated_on_right_p
)
18371 /* display_line already called reseat_at_next_visible_line_start,
18372 which puts the iterator at the beginning of the next line, in
18373 the logical order. */
18374 row
->maxpos
= it
->current
.pos
;
18375 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18376 /* A line that is entirely from a string/image/stretch... */
18377 row
->maxpos
= row
->minpos
;
18382 row
->maxpos
= it
->current
.pos
;
18385 /* Construct the glyph row IT->glyph_row in the desired matrix of
18386 IT->w from text at the current position of IT. See dispextern.h
18387 for an overview of struct it. Value is non-zero if
18388 IT->glyph_row displays text, as opposed to a line displaying ZV
18392 display_line (struct it
*it
)
18394 struct glyph_row
*row
= it
->glyph_row
;
18395 Lisp_Object overlay_arrow_string
;
18397 void *wrap_data
= NULL
;
18398 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18399 int wrap_row_used
= -1;
18400 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18401 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18402 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18403 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18404 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18406 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18407 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18409 /* We always start displaying at hpos zero even if hscrolled. */
18410 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18412 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18413 >= it
->w
->desired_matrix
->nrows
)
18415 it
->w
->nrows_scale_factor
++;
18416 fonts_changed_p
= 1;
18420 /* Is IT->w showing the region? */
18421 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18423 /* Clear the result glyph row and enable it. */
18424 prepare_desired_row (row
);
18426 row
->y
= it
->current_y
;
18427 row
->start
= it
->start
;
18428 row
->continuation_lines_width
= it
->continuation_lines_width
;
18429 row
->displays_text_p
= 1;
18430 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18431 it
->starts_in_middle_of_char_p
= 0;
18433 /* Arrange the overlays nicely for our purposes. Usually, we call
18434 display_line on only one line at a time, in which case this
18435 can't really hurt too much, or we call it on lines which appear
18436 one after another in the buffer, in which case all calls to
18437 recenter_overlay_lists but the first will be pretty cheap. */
18438 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18440 /* Move over display elements that are not visible because we are
18441 hscrolled. This may stop at an x-position < IT->first_visible_x
18442 if the first glyph is partially visible or if we hit a line end. */
18443 if (it
->current_x
< it
->first_visible_x
)
18445 this_line_min_pos
= row
->start
.pos
;
18446 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18447 MOVE_TO_POS
| MOVE_TO_X
);
18448 /* Record the smallest positions seen while we moved over
18449 display elements that are not visible. This is needed by
18450 redisplay_internal for optimizing the case where the cursor
18451 stays inside the same line. The rest of this function only
18452 considers positions that are actually displayed, so
18453 RECORD_MAX_MIN_POS will not otherwise record positions that
18454 are hscrolled to the left of the left edge of the window. */
18455 min_pos
= CHARPOS (this_line_min_pos
);
18456 min_bpos
= BYTEPOS (this_line_min_pos
);
18460 /* We only do this when not calling `move_it_in_display_line_to'
18461 above, because move_it_in_display_line_to calls
18462 handle_line_prefix itself. */
18463 handle_line_prefix (it
);
18466 /* Get the initial row height. This is either the height of the
18467 text hscrolled, if there is any, or zero. */
18468 row
->ascent
= it
->max_ascent
;
18469 row
->height
= it
->max_ascent
+ it
->max_descent
;
18470 row
->phys_ascent
= it
->max_phys_ascent
;
18471 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18472 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18474 /* Utility macro to record max and min buffer positions seen until now. */
18475 #define RECORD_MAX_MIN_POS(IT) \
18478 int composition_p = (IT)->what == IT_COMPOSITION; \
18479 EMACS_INT current_pos = \
18480 composition_p ? (IT)->cmp_it.charpos \
18481 : IT_CHARPOS (*(IT)); \
18482 EMACS_INT current_bpos = \
18483 composition_p ? CHAR_TO_BYTE (current_pos) \
18484 : IT_BYTEPOS (*(IT)); \
18485 if (current_pos < min_pos) \
18487 min_pos = current_pos; \
18488 min_bpos = current_bpos; \
18490 if (IT_CHARPOS (*it) > max_pos) \
18492 max_pos = IT_CHARPOS (*it); \
18493 max_bpos = IT_BYTEPOS (*it); \
18498 /* Loop generating characters. The loop is left with IT on the next
18499 character to display. */
18502 int n_glyphs_before
, hpos_before
, x_before
;
18504 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18506 /* Retrieve the next thing to display. Value is zero if end of
18508 if (!get_next_display_element (it
))
18510 /* Maybe add a space at the end of this line that is used to
18511 display the cursor there under X. Set the charpos of the
18512 first glyph of blank lines not corresponding to any text
18514 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18515 row
->exact_window_width_line_p
= 1;
18516 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18517 || row
->used
[TEXT_AREA
] == 0)
18519 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18520 row
->displays_text_p
= 0;
18522 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18523 && (!MINI_WINDOW_P (it
->w
)
18524 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18525 row
->indicate_empty_line_p
= 1;
18528 it
->continuation_lines_width
= 0;
18529 row
->ends_at_zv_p
= 1;
18530 /* A row that displays right-to-left text must always have
18531 its last face extended all the way to the end of line,
18532 even if this row ends in ZV, because we still write to
18533 the screen left to right. */
18534 if (row
->reversed_p
)
18535 extend_face_to_end_of_line (it
);
18539 /* Now, get the metrics of what we want to display. This also
18540 generates glyphs in `row' (which is IT->glyph_row). */
18541 n_glyphs_before
= row
->used
[TEXT_AREA
];
18544 /* Remember the line height so far in case the next element doesn't
18545 fit on the line. */
18546 if (it
->line_wrap
!= TRUNCATE
)
18548 ascent
= it
->max_ascent
;
18549 descent
= it
->max_descent
;
18550 phys_ascent
= it
->max_phys_ascent
;
18551 phys_descent
= it
->max_phys_descent
;
18553 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18555 if (IT_DISPLAYING_WHITESPACE (it
))
18559 SAVE_IT (wrap_it
, *it
, wrap_data
);
18561 wrap_row_used
= row
->used
[TEXT_AREA
];
18562 wrap_row_ascent
= row
->ascent
;
18563 wrap_row_height
= row
->height
;
18564 wrap_row_phys_ascent
= row
->phys_ascent
;
18565 wrap_row_phys_height
= row
->phys_height
;
18566 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18567 wrap_row_min_pos
= min_pos
;
18568 wrap_row_min_bpos
= min_bpos
;
18569 wrap_row_max_pos
= max_pos
;
18570 wrap_row_max_bpos
= max_bpos
;
18576 PRODUCE_GLYPHS (it
);
18578 /* If this display element was in marginal areas, continue with
18580 if (it
->area
!= TEXT_AREA
)
18582 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18583 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18584 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18585 row
->phys_height
= max (row
->phys_height
,
18586 it
->max_phys_ascent
+ it
->max_phys_descent
);
18587 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18588 it
->max_extra_line_spacing
);
18589 set_iterator_to_next (it
, 1);
18593 /* Does the display element fit on the line? If we truncate
18594 lines, we should draw past the right edge of the window. If
18595 we don't truncate, we want to stop so that we can display the
18596 continuation glyph before the right margin. If lines are
18597 continued, there are two possible strategies for characters
18598 resulting in more than 1 glyph (e.g. tabs): Display as many
18599 glyphs as possible in this line and leave the rest for the
18600 continuation line, or display the whole element in the next
18601 line. Original redisplay did the former, so we do it also. */
18602 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18603 hpos_before
= it
->hpos
;
18606 if (/* Not a newline. */
18608 /* Glyphs produced fit entirely in the line. */
18609 && it
->current_x
< it
->last_visible_x
)
18611 it
->hpos
+= nglyphs
;
18612 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18613 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18614 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18615 row
->phys_height
= max (row
->phys_height
,
18616 it
->max_phys_ascent
+ it
->max_phys_descent
);
18617 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18618 it
->max_extra_line_spacing
);
18619 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18620 row
->x
= x
- it
->first_visible_x
;
18621 /* Record the maximum and minimum buffer positions seen so
18622 far in glyphs that will be displayed by this row. */
18624 RECORD_MAX_MIN_POS (it
);
18629 struct glyph
*glyph
;
18631 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18633 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18634 new_x
= x
+ glyph
->pixel_width
;
18636 if (/* Lines are continued. */
18637 it
->line_wrap
!= TRUNCATE
18638 && (/* Glyph doesn't fit on the line. */
18639 new_x
> it
->last_visible_x
18640 /* Or it fits exactly on a window system frame. */
18641 || (new_x
== it
->last_visible_x
18642 && FRAME_WINDOW_P (it
->f
))))
18644 /* End of a continued line. */
18647 || (new_x
== it
->last_visible_x
18648 && FRAME_WINDOW_P (it
->f
)))
18650 /* Current glyph is the only one on the line or
18651 fits exactly on the line. We must continue
18652 the line because we can't draw the cursor
18653 after the glyph. */
18654 row
->continued_p
= 1;
18655 it
->current_x
= new_x
;
18656 it
->continuation_lines_width
+= new_x
;
18658 /* Record the maximum and minimum buffer
18659 positions seen so far in glyphs that will be
18660 displayed by this row. */
18662 RECORD_MAX_MIN_POS (it
);
18663 if (i
== nglyphs
- 1)
18665 /* If line-wrap is on, check if a previous
18666 wrap point was found. */
18667 if (wrap_row_used
> 0
18668 /* Even if there is a previous wrap
18669 point, continue the line here as
18670 usual, if (i) the previous character
18671 was a space or tab AND (ii) the
18672 current character is not. */
18674 || IT_DISPLAYING_WHITESPACE (it
)))
18677 set_iterator_to_next (it
, 1);
18678 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18680 if (!get_next_display_element (it
))
18682 row
->exact_window_width_line_p
= 1;
18683 it
->continuation_lines_width
= 0;
18684 row
->continued_p
= 0;
18685 row
->ends_at_zv_p
= 1;
18687 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18689 row
->continued_p
= 0;
18690 row
->exact_window_width_line_p
= 1;
18695 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18696 && !FRAME_WINDOW_P (it
->f
))
18698 /* A padding glyph that doesn't fit on this line.
18699 This means the whole character doesn't fit
18701 if (row
->reversed_p
)
18702 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18703 - n_glyphs_before
);
18704 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18706 /* Fill the rest of the row with continuation
18707 glyphs like in 20.x. */
18708 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18709 < row
->glyphs
[1 + TEXT_AREA
])
18710 produce_special_glyphs (it
, IT_CONTINUATION
);
18712 row
->continued_p
= 1;
18713 it
->current_x
= x_before
;
18714 it
->continuation_lines_width
+= x_before
;
18716 /* Restore the height to what it was before the
18717 element not fitting on the line. */
18718 it
->max_ascent
= ascent
;
18719 it
->max_descent
= descent
;
18720 it
->max_phys_ascent
= phys_ascent
;
18721 it
->max_phys_descent
= phys_descent
;
18723 else if (wrap_row_used
> 0)
18726 if (row
->reversed_p
)
18727 unproduce_glyphs (it
,
18728 row
->used
[TEXT_AREA
] - wrap_row_used
);
18729 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18730 it
->continuation_lines_width
+= wrap_x
;
18731 row
->used
[TEXT_AREA
] = wrap_row_used
;
18732 row
->ascent
= wrap_row_ascent
;
18733 row
->height
= wrap_row_height
;
18734 row
->phys_ascent
= wrap_row_phys_ascent
;
18735 row
->phys_height
= wrap_row_phys_height
;
18736 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18737 min_pos
= wrap_row_min_pos
;
18738 min_bpos
= wrap_row_min_bpos
;
18739 max_pos
= wrap_row_max_pos
;
18740 max_bpos
= wrap_row_max_bpos
;
18741 row
->continued_p
= 1;
18742 row
->ends_at_zv_p
= 0;
18743 row
->exact_window_width_line_p
= 0;
18744 it
->continuation_lines_width
+= x
;
18746 /* Make sure that a non-default face is extended
18747 up to the right margin of the window. */
18748 extend_face_to_end_of_line (it
);
18750 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18752 /* A TAB that extends past the right edge of the
18753 window. This produces a single glyph on
18754 window system frames. We leave the glyph in
18755 this row and let it fill the row, but don't
18756 consume the TAB. */
18757 it
->continuation_lines_width
+= it
->last_visible_x
;
18758 row
->ends_in_middle_of_char_p
= 1;
18759 row
->continued_p
= 1;
18760 glyph
->pixel_width
= it
->last_visible_x
- x
;
18761 it
->starts_in_middle_of_char_p
= 1;
18765 /* Something other than a TAB that draws past
18766 the right edge of the window. Restore
18767 positions to values before the element. */
18768 if (row
->reversed_p
)
18769 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18770 - (n_glyphs_before
+ i
));
18771 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18773 /* Display continuation glyphs. */
18774 if (!FRAME_WINDOW_P (it
->f
))
18775 produce_special_glyphs (it
, IT_CONTINUATION
);
18776 row
->continued_p
= 1;
18778 it
->current_x
= x_before
;
18779 it
->continuation_lines_width
+= x
;
18780 extend_face_to_end_of_line (it
);
18782 if (nglyphs
> 1 && i
> 0)
18784 row
->ends_in_middle_of_char_p
= 1;
18785 it
->starts_in_middle_of_char_p
= 1;
18788 /* Restore the height to what it was before the
18789 element not fitting on the line. */
18790 it
->max_ascent
= ascent
;
18791 it
->max_descent
= descent
;
18792 it
->max_phys_ascent
= phys_ascent
;
18793 it
->max_phys_descent
= phys_descent
;
18798 else if (new_x
> it
->first_visible_x
)
18800 /* Increment number of glyphs actually displayed. */
18803 /* Record the maximum and minimum buffer positions
18804 seen so far in glyphs that will be displayed by
18807 RECORD_MAX_MIN_POS (it
);
18809 if (x
< it
->first_visible_x
)
18810 /* Glyph is partially visible, i.e. row starts at
18811 negative X position. */
18812 row
->x
= x
- it
->first_visible_x
;
18816 /* Glyph is completely off the left margin of the
18817 window. This should not happen because of the
18818 move_it_in_display_line at the start of this
18819 function, unless the text display area of the
18820 window is empty. */
18821 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18825 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18826 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18827 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18828 row
->phys_height
= max (row
->phys_height
,
18829 it
->max_phys_ascent
+ it
->max_phys_descent
);
18830 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18831 it
->max_extra_line_spacing
);
18833 /* End of this display line if row is continued. */
18834 if (row
->continued_p
|| row
->ends_at_zv_p
)
18839 /* Is this a line end? If yes, we're also done, after making
18840 sure that a non-default face is extended up to the right
18841 margin of the window. */
18842 if (ITERATOR_AT_END_OF_LINE_P (it
))
18844 int used_before
= row
->used
[TEXT_AREA
];
18846 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18848 /* Add a space at the end of the line that is used to
18849 display the cursor there. */
18850 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18851 append_space_for_newline (it
, 0);
18853 /* Extend the face to the end of the line. */
18854 extend_face_to_end_of_line (it
);
18856 /* Make sure we have the position. */
18857 if (used_before
== 0)
18858 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18860 /* Record the position of the newline, for use in
18862 it
->eol_pos
= it
->current
.pos
;
18864 /* Consume the line end. This skips over invisible lines. */
18865 set_iterator_to_next (it
, 1);
18866 it
->continuation_lines_width
= 0;
18870 /* Proceed with next display element. Note that this skips
18871 over lines invisible because of selective display. */
18872 set_iterator_to_next (it
, 1);
18874 /* If we truncate lines, we are done when the last displayed
18875 glyphs reach past the right margin of the window. */
18876 if (it
->line_wrap
== TRUNCATE
18877 && (FRAME_WINDOW_P (it
->f
)
18878 ? (it
->current_x
>= it
->last_visible_x
)
18879 : (it
->current_x
> it
->last_visible_x
)))
18881 /* Maybe add truncation glyphs. */
18882 if (!FRAME_WINDOW_P (it
->f
))
18886 if (!row
->reversed_p
)
18888 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18889 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18894 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18895 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18897 /* Remove any padding glyphs at the front of ROW, to
18898 make room for the truncation glyphs we will be
18899 adding below. The loop below always inserts at
18900 least one truncation glyph, so also remove the
18901 last glyph added to ROW. */
18902 unproduce_glyphs (it
, i
+ 1);
18903 /* Adjust i for the loop below. */
18904 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18907 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18909 row
->used
[TEXT_AREA
] = i
;
18910 produce_special_glyphs (it
, IT_TRUNCATION
);
18913 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18915 /* Don't truncate if we can overflow newline into fringe. */
18916 if (!get_next_display_element (it
))
18918 it
->continuation_lines_width
= 0;
18919 row
->ends_at_zv_p
= 1;
18920 row
->exact_window_width_line_p
= 1;
18923 if (ITERATOR_AT_END_OF_LINE_P (it
))
18925 row
->exact_window_width_line_p
= 1;
18926 goto at_end_of_line
;
18930 row
->truncated_on_right_p
= 1;
18931 it
->continuation_lines_width
= 0;
18932 reseat_at_next_visible_line_start (it
, 0);
18933 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18934 it
->hpos
= hpos_before
;
18935 it
->current_x
= x_before
;
18941 bidi_unshelve_cache (wrap_data
, 1);
18943 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18944 at the left window margin. */
18945 if (it
->first_visible_x
18946 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18948 if (!FRAME_WINDOW_P (it
->f
))
18949 insert_left_trunc_glyphs (it
);
18950 row
->truncated_on_left_p
= 1;
18953 /* Remember the position at which this line ends.
18955 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18956 cannot be before the call to find_row_edges below, since that is
18957 where these positions are determined. */
18958 row
->end
= it
->current
;
18961 row
->minpos
= row
->start
.pos
;
18962 row
->maxpos
= row
->end
.pos
;
18966 /* ROW->minpos and ROW->maxpos must be the smallest and
18967 `1 + the largest' buffer positions in ROW. But if ROW was
18968 bidi-reordered, these two positions can be anywhere in the
18969 row, so we must determine them now. */
18970 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18973 /* If the start of this line is the overlay arrow-position, then
18974 mark this glyph row as the one containing the overlay arrow.
18975 This is clearly a mess with variable size fonts. It would be
18976 better to let it be displayed like cursors under X. */
18977 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18978 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18979 !NILP (overlay_arrow_string
)))
18981 /* Overlay arrow in window redisplay is a fringe bitmap. */
18982 if (STRINGP (overlay_arrow_string
))
18984 struct glyph_row
*arrow_row
18985 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18986 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18987 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18988 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18989 struct glyph
*p2
, *end
;
18991 /* Copy the arrow glyphs. */
18992 while (glyph
< arrow_end
)
18995 /* Throw away padding glyphs. */
18997 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18998 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19004 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19009 xassert (INTEGERP (overlay_arrow_string
));
19010 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19012 overlay_arrow_seen
= 1;
19015 /* Compute pixel dimensions of this line. */
19016 compute_line_metrics (it
);
19018 /* Record whether this row ends inside an ellipsis. */
19019 row
->ends_in_ellipsis_p
19020 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19021 && it
->ellipsis_p
);
19023 /* Save fringe bitmaps in this row. */
19024 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19025 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19026 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19027 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19029 it
->left_user_fringe_bitmap
= 0;
19030 it
->left_user_fringe_face_id
= 0;
19031 it
->right_user_fringe_bitmap
= 0;
19032 it
->right_user_fringe_face_id
= 0;
19034 /* Maybe set the cursor. */
19035 cvpos
= it
->w
->cursor
.vpos
;
19037 /* In bidi-reordered rows, keep checking for proper cursor
19038 position even if one has been found already, because buffer
19039 positions in such rows change non-linearly with ROW->VPOS,
19040 when a line is continued. One exception: when we are at ZV,
19041 display cursor on the first suitable glyph row, since all
19042 the empty rows after that also have their position set to ZV. */
19043 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19044 lines' rows is implemented for bidi-reordered rows. */
19046 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19047 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19048 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19049 && cursor_row_p (row
))
19050 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19052 /* Highlight trailing whitespace. */
19053 if (!NILP (Vshow_trailing_whitespace
))
19054 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19056 /* Prepare for the next line. This line starts horizontally at (X
19057 HPOS) = (0 0). Vertical positions are incremented. As a
19058 convenience for the caller, IT->glyph_row is set to the next
19060 it
->current_x
= it
->hpos
= 0;
19061 it
->current_y
+= row
->height
;
19062 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19065 /* The next row should by default use the same value of the
19066 reversed_p flag as this one. set_iterator_to_next decides when
19067 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19068 the flag accordingly. */
19069 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19070 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19071 it
->start
= row
->end
;
19072 return row
->displays_text_p
;
19074 #undef RECORD_MAX_MIN_POS
19077 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19078 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19079 doc
: /* Return paragraph direction at point in BUFFER.
19080 Value is either `left-to-right' or `right-to-left'.
19081 If BUFFER is omitted or nil, it defaults to the current buffer.
19083 Paragraph direction determines how the text in the paragraph is displayed.
19084 In left-to-right paragraphs, text begins at the left margin of the window
19085 and the reading direction is generally left to right. In right-to-left
19086 paragraphs, text begins at the right margin and is read from right to left.
19088 See also `bidi-paragraph-direction'. */)
19089 (Lisp_Object buffer
)
19091 struct buffer
*buf
= current_buffer
;
19092 struct buffer
*old
= buf
;
19094 if (! NILP (buffer
))
19096 CHECK_BUFFER (buffer
);
19097 buf
= XBUFFER (buffer
);
19100 if (NILP (BVAR (buf
, bidi_display_reordering
))
19101 || NILP (BVAR (buf
, enable_multibyte_characters
)))
19102 return Qleft_to_right
;
19103 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19104 return BVAR (buf
, bidi_paragraph_direction
);
19107 /* Determine the direction from buffer text. We could try to
19108 use current_matrix if it is up to date, but this seems fast
19109 enough as it is. */
19110 struct bidi_it itb
;
19111 EMACS_INT pos
= BUF_PT (buf
);
19112 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19115 set_buffer_temp (buf
);
19116 /* bidi_paragraph_init finds the base direction of the paragraph
19117 by searching forward from paragraph start. We need the base
19118 direction of the current or _previous_ paragraph, so we need
19119 to make sure we are within that paragraph. To that end, find
19120 the previous non-empty line. */
19121 if (pos
>= ZV
&& pos
> BEGV
)
19124 bytepos
= CHAR_TO_BYTE (pos
);
19126 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19127 || c
== ' ' || c
== '\t' || c
== '\f')
19129 if (bytepos
<= BEGV_BYTE
)
19134 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19137 itb
.bytepos
= bytepos
;
19139 itb
.string
.s
= NULL
;
19140 itb
.string
.lstring
= Qnil
;
19141 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
19143 itb
.separator_limit
= -1;
19144 itb
.paragraph_dir
= NEUTRAL_DIR
;
19146 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19147 set_buffer_temp (old
);
19148 switch (itb
.paragraph_dir
)
19151 return Qleft_to_right
;
19154 return Qright_to_left
;
19164 /***********************************************************************
19166 ***********************************************************************/
19168 /* Redisplay the menu bar in the frame for window W.
19170 The menu bar of X frames that don't have X toolkit support is
19171 displayed in a special window W->frame->menu_bar_window.
19173 The menu bar of terminal frames is treated specially as far as
19174 glyph matrices are concerned. Menu bar lines are not part of
19175 windows, so the update is done directly on the frame matrix rows
19176 for the menu bar. */
19179 display_menu_bar (struct window
*w
)
19181 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19186 /* Don't do all this for graphical frames. */
19188 if (FRAME_W32_P (f
))
19191 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19197 if (FRAME_NS_P (f
))
19199 #endif /* HAVE_NS */
19201 #ifdef USE_X_TOOLKIT
19202 xassert (!FRAME_WINDOW_P (f
));
19203 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19204 it
.first_visible_x
= 0;
19205 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19206 #else /* not USE_X_TOOLKIT */
19207 if (FRAME_WINDOW_P (f
))
19209 /* Menu bar lines are displayed in the desired matrix of the
19210 dummy window menu_bar_window. */
19211 struct window
*menu_w
;
19212 xassert (WINDOWP (f
->menu_bar_window
));
19213 menu_w
= XWINDOW (f
->menu_bar_window
);
19214 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19216 it
.first_visible_x
= 0;
19217 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19221 /* This is a TTY frame, i.e. character hpos/vpos are used as
19223 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19225 it
.first_visible_x
= 0;
19226 it
.last_visible_x
= FRAME_COLS (f
);
19228 #endif /* not USE_X_TOOLKIT */
19230 /* FIXME: This should be controlled by a user option. See the
19231 comments in redisplay_tool_bar and display_mode_line about
19233 it
.paragraph_embedding
= L2R
;
19235 if (! mode_line_inverse_video
)
19236 /* Force the menu-bar to be displayed in the default face. */
19237 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19239 /* Clear all rows of the menu bar. */
19240 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19242 struct glyph_row
*row
= it
.glyph_row
+ i
;
19243 clear_glyph_row (row
);
19244 row
->enabled_p
= 1;
19245 row
->full_width_p
= 1;
19248 /* Display all items of the menu bar. */
19249 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19250 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19252 Lisp_Object string
;
19254 /* Stop at nil string. */
19255 string
= AREF (items
, i
+ 1);
19259 /* Remember where item was displayed. */
19260 ASET (items
, i
+ 3, make_number (it
.hpos
));
19262 /* Display the item, pad with one space. */
19263 if (it
.current_x
< it
.last_visible_x
)
19264 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19265 SCHARS (string
) + 1, 0, 0, -1);
19268 /* Fill out the line with spaces. */
19269 if (it
.current_x
< it
.last_visible_x
)
19270 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19272 /* Compute the total height of the lines. */
19273 compute_line_metrics (&it
);
19278 /***********************************************************************
19280 ***********************************************************************/
19282 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19283 FORCE is non-zero, redisplay mode lines unconditionally.
19284 Otherwise, redisplay only mode lines that are garbaged. Value is
19285 the number of windows whose mode lines were redisplayed. */
19288 redisplay_mode_lines (Lisp_Object window
, int force
)
19292 while (!NILP (window
))
19294 struct window
*w
= XWINDOW (window
);
19296 if (WINDOWP (w
->hchild
))
19297 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19298 else if (WINDOWP (w
->vchild
))
19299 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19301 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19302 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19304 struct text_pos lpoint
;
19305 struct buffer
*old
= current_buffer
;
19307 /* Set the window's buffer for the mode line display. */
19308 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19309 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19311 /* Point refers normally to the selected window. For any
19312 other window, set up appropriate value. */
19313 if (!EQ (window
, selected_window
))
19315 struct text_pos pt
;
19317 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19318 if (CHARPOS (pt
) < BEGV
)
19319 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19320 else if (CHARPOS (pt
) > (ZV
- 1))
19321 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19323 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19326 /* Display mode lines. */
19327 clear_glyph_matrix (w
->desired_matrix
);
19328 if (display_mode_lines (w
))
19331 w
->must_be_updated_p
= 1;
19334 /* Restore old settings. */
19335 set_buffer_internal_1 (old
);
19336 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19346 /* Display the mode and/or header line of window W. Value is the
19347 sum number of mode lines and header lines displayed. */
19350 display_mode_lines (struct window
*w
)
19352 Lisp_Object old_selected_window
, old_selected_frame
;
19355 old_selected_frame
= selected_frame
;
19356 selected_frame
= w
->frame
;
19357 old_selected_window
= selected_window
;
19358 XSETWINDOW (selected_window
, w
);
19360 /* These will be set while the mode line specs are processed. */
19361 line_number_displayed
= 0;
19362 w
->column_number_displayed
= Qnil
;
19364 if (WINDOW_WANTS_MODELINE_P (w
))
19366 struct window
*sel_w
= XWINDOW (old_selected_window
);
19368 /* Select mode line face based on the real selected window. */
19369 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19370 BVAR (current_buffer
, mode_line_format
));
19374 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19376 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19377 BVAR (current_buffer
, header_line_format
));
19381 selected_frame
= old_selected_frame
;
19382 selected_window
= old_selected_window
;
19387 /* Display mode or header line of window W. FACE_ID specifies which
19388 line to display; it is either MODE_LINE_FACE_ID or
19389 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19390 display. Value is the pixel height of the mode/header line
19394 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19398 int count
= SPECPDL_INDEX ();
19400 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19401 /* Don't extend on a previously drawn mode-line.
19402 This may happen if called from pos_visible_p. */
19403 it
.glyph_row
->enabled_p
= 0;
19404 prepare_desired_row (it
.glyph_row
);
19406 it
.glyph_row
->mode_line_p
= 1;
19408 if (! mode_line_inverse_video
)
19409 /* Force the mode-line to be displayed in the default face. */
19410 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19412 /* FIXME: This should be controlled by a user option. But
19413 supporting such an option is not trivial, since the mode line is
19414 made up of many separate strings. */
19415 it
.paragraph_embedding
= L2R
;
19417 record_unwind_protect (unwind_format_mode_line
,
19418 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19420 mode_line_target
= MODE_LINE_DISPLAY
;
19422 /* Temporarily make frame's keyboard the current kboard so that
19423 kboard-local variables in the mode_line_format will get the right
19425 push_kboard (FRAME_KBOARD (it
.f
));
19426 record_unwind_save_match_data ();
19427 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19430 unbind_to (count
, Qnil
);
19432 /* Fill up with spaces. */
19433 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19435 compute_line_metrics (&it
);
19436 it
.glyph_row
->full_width_p
= 1;
19437 it
.glyph_row
->continued_p
= 0;
19438 it
.glyph_row
->truncated_on_left_p
= 0;
19439 it
.glyph_row
->truncated_on_right_p
= 0;
19441 /* Make a 3D mode-line have a shadow at its right end. */
19442 face
= FACE_FROM_ID (it
.f
, face_id
);
19443 extend_face_to_end_of_line (&it
);
19444 if (face
->box
!= FACE_NO_BOX
)
19446 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19447 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19448 last
->right_box_line_p
= 1;
19451 return it
.glyph_row
->height
;
19454 /* Move element ELT in LIST to the front of LIST.
19455 Return the updated list. */
19458 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19460 register Lisp_Object tail
, prev
;
19461 register Lisp_Object tem
;
19465 while (CONSP (tail
))
19471 /* Splice out the link TAIL. */
19473 list
= XCDR (tail
);
19475 Fsetcdr (prev
, XCDR (tail
));
19477 /* Now make it the first. */
19478 Fsetcdr (tail
, list
);
19483 tail
= XCDR (tail
);
19487 /* Not found--return unchanged LIST. */
19491 /* Contribute ELT to the mode line for window IT->w. How it
19492 translates into text depends on its data type.
19494 IT describes the display environment in which we display, as usual.
19496 DEPTH is the depth in recursion. It is used to prevent
19497 infinite recursion here.
19499 FIELD_WIDTH is the number of characters the display of ELT should
19500 occupy in the mode line, and PRECISION is the maximum number of
19501 characters to display from ELT's representation. See
19502 display_string for details.
19504 Returns the hpos of the end of the text generated by ELT.
19506 PROPS is a property list to add to any string we encounter.
19508 If RISKY is nonzero, remove (disregard) any properties in any string
19509 we encounter, and ignore :eval and :propertize.
19511 The global variable `mode_line_target' determines whether the
19512 output is passed to `store_mode_line_noprop',
19513 `store_mode_line_string', or `display_string'. */
19516 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19517 Lisp_Object elt
, Lisp_Object props
, int risky
)
19519 int n
= 0, field
, prec
;
19524 elt
= build_string ("*too-deep*");
19528 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19532 /* A string: output it and check for %-constructs within it. */
19534 EMACS_INT offset
= 0;
19536 if (SCHARS (elt
) > 0
19537 && (!NILP (props
) || risky
))
19539 Lisp_Object oprops
, aelt
;
19540 oprops
= Ftext_properties_at (make_number (0), elt
);
19542 /* If the starting string's properties are not what
19543 we want, translate the string. Also, if the string
19544 is risky, do that anyway. */
19546 if (NILP (Fequal (props
, oprops
)) || risky
)
19548 /* If the starting string has properties,
19549 merge the specified ones onto the existing ones. */
19550 if (! NILP (oprops
) && !risky
)
19554 oprops
= Fcopy_sequence (oprops
);
19556 while (CONSP (tem
))
19558 oprops
= Fplist_put (oprops
, XCAR (tem
),
19559 XCAR (XCDR (tem
)));
19560 tem
= XCDR (XCDR (tem
));
19565 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19566 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19568 /* AELT is what we want. Move it to the front
19569 without consing. */
19571 mode_line_proptrans_alist
19572 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19578 /* If AELT has the wrong props, it is useless.
19579 so get rid of it. */
19581 mode_line_proptrans_alist
19582 = Fdelq (aelt
, mode_line_proptrans_alist
);
19584 elt
= Fcopy_sequence (elt
);
19585 Fset_text_properties (make_number (0), Flength (elt
),
19587 /* Add this item to mode_line_proptrans_alist. */
19588 mode_line_proptrans_alist
19589 = Fcons (Fcons (elt
, props
),
19590 mode_line_proptrans_alist
);
19591 /* Truncate mode_line_proptrans_alist
19592 to at most 50 elements. */
19593 tem
= Fnthcdr (make_number (50),
19594 mode_line_proptrans_alist
);
19596 XSETCDR (tem
, Qnil
);
19605 prec
= precision
- n
;
19606 switch (mode_line_target
)
19608 case MODE_LINE_NOPROP
:
19609 case MODE_LINE_TITLE
:
19610 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19612 case MODE_LINE_STRING
:
19613 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19615 case MODE_LINE_DISPLAY
:
19616 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19617 0, prec
, 0, STRING_MULTIBYTE (elt
));
19624 /* Handle the non-literal case. */
19626 while ((precision
<= 0 || n
< precision
)
19627 && SREF (elt
, offset
) != 0
19628 && (mode_line_target
!= MODE_LINE_DISPLAY
19629 || it
->current_x
< it
->last_visible_x
))
19631 EMACS_INT last_offset
= offset
;
19633 /* Advance to end of string or next format specifier. */
19634 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19637 if (offset
- 1 != last_offset
)
19639 EMACS_INT nchars
, nbytes
;
19641 /* Output to end of string or up to '%'. Field width
19642 is length of string. Don't output more than
19643 PRECISION allows us. */
19646 prec
= c_string_width (SDATA (elt
) + last_offset
,
19647 offset
- last_offset
, precision
- n
,
19650 switch (mode_line_target
)
19652 case MODE_LINE_NOPROP
:
19653 case MODE_LINE_TITLE
:
19654 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19656 case MODE_LINE_STRING
:
19658 EMACS_INT bytepos
= last_offset
;
19659 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19660 EMACS_INT endpos
= (precision
<= 0
19661 ? string_byte_to_char (elt
, offset
)
19662 : charpos
+ nchars
);
19664 n
+= store_mode_line_string (NULL
,
19665 Fsubstring (elt
, make_number (charpos
),
19666 make_number (endpos
)),
19670 case MODE_LINE_DISPLAY
:
19672 EMACS_INT bytepos
= last_offset
;
19673 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19675 if (precision
<= 0)
19676 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19677 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19679 STRING_MULTIBYTE (elt
));
19684 else /* c == '%' */
19686 EMACS_INT percent_position
= offset
;
19688 /* Get the specified minimum width. Zero means
19691 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19692 field
= field
* 10 + c
- '0';
19694 /* Don't pad beyond the total padding allowed. */
19695 if (field_width
- n
> 0 && field
> field_width
- n
)
19696 field
= field_width
- n
;
19698 /* Note that either PRECISION <= 0 or N < PRECISION. */
19699 prec
= precision
- n
;
19702 n
+= display_mode_element (it
, depth
, field
, prec
,
19703 Vglobal_mode_string
, props
,
19708 EMACS_INT bytepos
, charpos
;
19710 Lisp_Object string
;
19712 bytepos
= percent_position
;
19713 charpos
= (STRING_MULTIBYTE (elt
)
19714 ? string_byte_to_char (elt
, bytepos
)
19716 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19717 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19719 switch (mode_line_target
)
19721 case MODE_LINE_NOPROP
:
19722 case MODE_LINE_TITLE
:
19723 n
+= store_mode_line_noprop (spec
, field
, prec
);
19725 case MODE_LINE_STRING
:
19727 Lisp_Object tem
= build_string (spec
);
19728 props
= Ftext_properties_at (make_number (charpos
), elt
);
19729 /* Should only keep face property in props */
19730 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19733 case MODE_LINE_DISPLAY
:
19735 int nglyphs_before
, nwritten
;
19737 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19738 nwritten
= display_string (spec
, string
, elt
,
19743 /* Assign to the glyphs written above the
19744 string where the `%x' came from, position
19748 struct glyph
*glyph
19749 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19753 for (i
= 0; i
< nwritten
; ++i
)
19755 glyph
[i
].object
= elt
;
19756 glyph
[i
].charpos
= charpos
;
19773 /* A symbol: process the value of the symbol recursively
19774 as if it appeared here directly. Avoid error if symbol void.
19775 Special case: if value of symbol is a string, output the string
19778 register Lisp_Object tem
;
19780 /* If the variable is not marked as risky to set
19781 then its contents are risky to use. */
19782 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19785 tem
= Fboundp (elt
);
19788 tem
= Fsymbol_value (elt
);
19789 /* If value is a string, output that string literally:
19790 don't check for % within it. */
19794 if (!EQ (tem
, elt
))
19796 /* Give up right away for nil or t. */
19806 register Lisp_Object car
, tem
;
19808 /* A cons cell: five distinct cases.
19809 If first element is :eval or :propertize, do something special.
19810 If first element is a string or a cons, process all the elements
19811 and effectively concatenate them.
19812 If first element is a negative number, truncate displaying cdr to
19813 at most that many characters. If positive, pad (with spaces)
19814 to at least that many characters.
19815 If first element is a symbol, process the cadr or caddr recursively
19816 according to whether the symbol's value is non-nil or nil. */
19818 if (EQ (car
, QCeval
))
19820 /* An element of the form (:eval FORM) means evaluate FORM
19821 and use the result as mode line elements. */
19826 if (CONSP (XCDR (elt
)))
19829 spec
= safe_eval (XCAR (XCDR (elt
)));
19830 n
+= display_mode_element (it
, depth
, field_width
- n
,
19831 precision
- n
, spec
, props
,
19835 else if (EQ (car
, QCpropertize
))
19837 /* An element of the form (:propertize ELT PROPS...)
19838 means display ELT but applying properties PROPS. */
19843 if (CONSP (XCDR (elt
)))
19844 n
+= display_mode_element (it
, depth
, field_width
- n
,
19845 precision
- n
, XCAR (XCDR (elt
)),
19846 XCDR (XCDR (elt
)), risky
);
19848 else if (SYMBOLP (car
))
19850 tem
= Fboundp (car
);
19854 /* elt is now the cdr, and we know it is a cons cell.
19855 Use its car if CAR has a non-nil value. */
19858 tem
= Fsymbol_value (car
);
19865 /* Symbol's value is nil (or symbol is unbound)
19866 Get the cddr of the original list
19867 and if possible find the caddr and use that. */
19871 else if (!CONSP (elt
))
19876 else if (INTEGERP (car
))
19878 register int lim
= XINT (car
);
19882 /* Negative int means reduce maximum width. */
19883 if (precision
<= 0)
19886 precision
= min (precision
, -lim
);
19890 /* Padding specified. Don't let it be more than
19891 current maximum. */
19893 lim
= min (precision
, lim
);
19895 /* If that's more padding than already wanted, queue it.
19896 But don't reduce padding already specified even if
19897 that is beyond the current truncation point. */
19898 field_width
= max (lim
, field_width
);
19902 else if (STRINGP (car
) || CONSP (car
))
19904 Lisp_Object halftail
= elt
;
19908 && (precision
<= 0 || n
< precision
))
19910 n
+= display_mode_element (it
, depth
,
19911 /* Do padding only after the last
19912 element in the list. */
19913 (! CONSP (XCDR (elt
))
19916 precision
- n
, XCAR (elt
),
19920 if ((len
& 1) == 0)
19921 halftail
= XCDR (halftail
);
19922 /* Check for cycle. */
19923 if (EQ (halftail
, elt
))
19932 elt
= build_string ("*invalid*");
19936 /* Pad to FIELD_WIDTH. */
19937 if (field_width
> 0 && n
< field_width
)
19939 switch (mode_line_target
)
19941 case MODE_LINE_NOPROP
:
19942 case MODE_LINE_TITLE
:
19943 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19945 case MODE_LINE_STRING
:
19946 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19948 case MODE_LINE_DISPLAY
:
19949 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19958 /* Store a mode-line string element in mode_line_string_list.
19960 If STRING is non-null, display that C string. Otherwise, the Lisp
19961 string LISP_STRING is displayed.
19963 FIELD_WIDTH is the minimum number of output glyphs to produce.
19964 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19965 with spaces. FIELD_WIDTH <= 0 means don't pad.
19967 PRECISION is the maximum number of characters to output from
19968 STRING. PRECISION <= 0 means don't truncate the string.
19970 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19971 properties to the string.
19973 PROPS are the properties to add to the string.
19974 The mode_line_string_face face property is always added to the string.
19978 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19979 int field_width
, int precision
, Lisp_Object props
)
19984 if (string
!= NULL
)
19986 len
= strlen (string
);
19987 if (precision
> 0 && len
> precision
)
19989 lisp_string
= make_string (string
, len
);
19991 props
= mode_line_string_face_prop
;
19992 else if (!NILP (mode_line_string_face
))
19994 Lisp_Object face
= Fplist_get (props
, Qface
);
19995 props
= Fcopy_sequence (props
);
19997 face
= mode_line_string_face
;
19999 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20000 props
= Fplist_put (props
, Qface
, face
);
20002 Fadd_text_properties (make_number (0), make_number (len
),
20003 props
, lisp_string
);
20007 len
= XFASTINT (Flength (lisp_string
));
20008 if (precision
> 0 && len
> precision
)
20011 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20014 if (!NILP (mode_line_string_face
))
20018 props
= Ftext_properties_at (make_number (0), lisp_string
);
20019 face
= Fplist_get (props
, Qface
);
20021 face
= mode_line_string_face
;
20023 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20024 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20026 lisp_string
= Fcopy_sequence (lisp_string
);
20029 Fadd_text_properties (make_number (0), make_number (len
),
20030 props
, lisp_string
);
20035 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20039 if (field_width
> len
)
20041 field_width
-= len
;
20042 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20044 Fadd_text_properties (make_number (0), make_number (field_width
),
20045 props
, lisp_string
);
20046 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20054 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20056 doc
: /* Format a string out of a mode line format specification.
20057 First arg FORMAT specifies the mode line format (see `mode-line-format'
20058 for details) to use.
20060 By default, the format is evaluated for the currently selected window.
20062 Optional second arg FACE specifies the face property to put on all
20063 characters for which no face is specified. The value nil means the
20064 default face. The value t means whatever face the window's mode line
20065 currently uses (either `mode-line' or `mode-line-inactive',
20066 depending on whether the window is the selected window or not).
20067 An integer value means the value string has no text
20070 Optional third and fourth args WINDOW and BUFFER specify the window
20071 and buffer to use as the context for the formatting (defaults
20072 are the selected window and the WINDOW's buffer). */)
20073 (Lisp_Object format
, Lisp_Object face
,
20074 Lisp_Object window
, Lisp_Object buffer
)
20079 struct buffer
*old_buffer
= NULL
;
20081 int no_props
= INTEGERP (face
);
20082 int count
= SPECPDL_INDEX ();
20084 int string_start
= 0;
20087 window
= selected_window
;
20088 CHECK_WINDOW (window
);
20089 w
= XWINDOW (window
);
20092 buffer
= w
->buffer
;
20093 CHECK_BUFFER (buffer
);
20095 /* Make formatting the modeline a non-op when noninteractive, otherwise
20096 there will be problems later caused by a partially initialized frame. */
20097 if (NILP (format
) || noninteractive
)
20098 return empty_unibyte_string
;
20103 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20104 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20105 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20106 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20107 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20108 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20109 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20112 if (XBUFFER (buffer
) != current_buffer
)
20113 old_buffer
= current_buffer
;
20115 /* Save things including mode_line_proptrans_alist,
20116 and set that to nil so that we don't alter the outer value. */
20117 record_unwind_protect (unwind_format_mode_line
,
20118 format_mode_line_unwind_data
20119 (old_buffer
, selected_window
, 1));
20120 mode_line_proptrans_alist
= Qnil
;
20122 Fselect_window (window
, Qt
);
20124 set_buffer_internal_1 (XBUFFER (buffer
));
20126 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20130 mode_line_target
= MODE_LINE_NOPROP
;
20131 mode_line_string_face_prop
= Qnil
;
20132 mode_line_string_list
= Qnil
;
20133 string_start
= MODE_LINE_NOPROP_LEN (0);
20137 mode_line_target
= MODE_LINE_STRING
;
20138 mode_line_string_list
= Qnil
;
20139 mode_line_string_face
= face
;
20140 mode_line_string_face_prop
20141 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20144 push_kboard (FRAME_KBOARD (it
.f
));
20145 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20150 len
= MODE_LINE_NOPROP_LEN (string_start
);
20151 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20155 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20156 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20157 empty_unibyte_string
);
20160 unbind_to (count
, Qnil
);
20164 /* Write a null-terminated, right justified decimal representation of
20165 the positive integer D to BUF using a minimal field width WIDTH. */
20168 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20170 register char *p
= buf
;
20178 *p
++ = d
% 10 + '0';
20183 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20194 /* Write a null-terminated, right justified decimal and "human
20195 readable" representation of the nonnegative integer D to BUF using
20196 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20198 static const char power_letter
[] =
20212 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20214 /* We aim to represent the nonnegative integer D as
20215 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20216 EMACS_INT quotient
= d
;
20218 /* -1 means: do not use TENTHS. */
20222 /* Length of QUOTIENT.TENTHS as a string. */
20228 if (1000 <= quotient
)
20230 /* Scale to the appropriate EXPONENT. */
20233 remainder
= quotient
% 1000;
20237 while (1000 <= quotient
);
20239 /* Round to nearest and decide whether to use TENTHS or not. */
20242 tenths
= remainder
/ 100;
20243 if (50 <= remainder
% 100)
20250 if (quotient
== 10)
20258 if (500 <= remainder
)
20260 if (quotient
< 999)
20271 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20272 if (tenths
== -1 && quotient
<= 99)
20279 p
= psuffix
= buf
+ max (width
, length
);
20281 /* Print EXPONENT. */
20282 *psuffix
++ = power_letter
[exponent
];
20285 /* Print TENTHS. */
20288 *--p
= '0' + tenths
;
20292 /* Print QUOTIENT. */
20295 int digit
= quotient
% 10;
20296 *--p
= '0' + digit
;
20298 while ((quotient
/= 10) != 0);
20300 /* Print leading spaces. */
20305 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20306 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20307 type of CODING_SYSTEM. Return updated pointer into BUF. */
20309 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20312 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20315 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20316 const unsigned char *eol_str
;
20318 /* The EOL conversion we are using. */
20319 Lisp_Object eoltype
;
20321 val
= CODING_SYSTEM_SPEC (coding_system
);
20324 if (!VECTORP (val
)) /* Not yet decided. */
20329 eoltype
= eol_mnemonic_undecided
;
20330 /* Don't mention EOL conversion if it isn't decided. */
20335 Lisp_Object eolvalue
;
20337 attrs
= AREF (val
, 0);
20338 eolvalue
= AREF (val
, 2);
20341 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20345 /* The EOL conversion that is normal on this system. */
20347 if (NILP (eolvalue
)) /* Not yet decided. */
20348 eoltype
= eol_mnemonic_undecided
;
20349 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20350 eoltype
= eol_mnemonic_undecided
;
20351 else /* eolvalue is Qunix, Qdos, or Qmac. */
20352 eoltype
= (EQ (eolvalue
, Qunix
)
20353 ? eol_mnemonic_unix
20354 : (EQ (eolvalue
, Qdos
) == 1
20355 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20361 /* Mention the EOL conversion if it is not the usual one. */
20362 if (STRINGP (eoltype
))
20364 eol_str
= SDATA (eoltype
);
20365 eol_str_len
= SBYTES (eoltype
);
20367 else if (CHARACTERP (eoltype
))
20369 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20370 int c
= XFASTINT (eoltype
);
20371 eol_str_len
= CHAR_STRING (c
, tmp
);
20376 eol_str
= invalid_eol_type
;
20377 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20379 memcpy (buf
, eol_str
, eol_str_len
);
20380 buf
+= eol_str_len
;
20386 /* Return a string for the output of a mode line %-spec for window W,
20387 generated by character C. FIELD_WIDTH > 0 means pad the string
20388 returned with spaces to that value. Return a Lisp string in
20389 *STRING if the resulting string is taken from that Lisp string.
20391 Note we operate on the current buffer for most purposes,
20392 the exception being w->base_line_pos. */
20394 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20396 static const char *
20397 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20398 Lisp_Object
*string
)
20401 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20402 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20403 struct buffer
*b
= current_buffer
;
20411 if (!NILP (BVAR (b
, read_only
)))
20413 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20418 /* This differs from %* only for a modified read-only buffer. */
20419 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20421 if (!NILP (BVAR (b
, read_only
)))
20426 /* This differs from %* in ignoring read-only-ness. */
20427 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20439 if (command_loop_level
> 5)
20441 p
= decode_mode_spec_buf
;
20442 for (i
= 0; i
< command_loop_level
; i
++)
20445 return decode_mode_spec_buf
;
20453 if (command_loop_level
> 5)
20455 p
= decode_mode_spec_buf
;
20456 for (i
= 0; i
< command_loop_level
; i
++)
20459 return decode_mode_spec_buf
;
20466 /* Let lots_of_dashes be a string of infinite length. */
20467 if (mode_line_target
== MODE_LINE_NOPROP
||
20468 mode_line_target
== MODE_LINE_STRING
)
20470 if (field_width
<= 0
20471 || field_width
> sizeof (lots_of_dashes
))
20473 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20474 decode_mode_spec_buf
[i
] = '-';
20475 decode_mode_spec_buf
[i
] = '\0';
20476 return decode_mode_spec_buf
;
20479 return lots_of_dashes
;
20483 obj
= BVAR (b
, name
);
20487 /* %c and %l are ignored in `frame-title-format'.
20488 (In redisplay_internal, the frame title is drawn _before_ the
20489 windows are updated, so the stuff which depends on actual
20490 window contents (such as %l) may fail to render properly, or
20491 even crash emacs.) */
20492 if (mode_line_target
== MODE_LINE_TITLE
)
20496 EMACS_INT col
= current_column ();
20497 w
->column_number_displayed
= make_number (col
);
20498 pint2str (decode_mode_spec_buf
, field_width
, col
);
20499 return decode_mode_spec_buf
;
20503 #ifndef SYSTEM_MALLOC
20505 if (NILP (Vmemory_full
))
20508 return "!MEM FULL! ";
20515 /* %F displays the frame name. */
20516 if (!NILP (f
->title
))
20517 return SSDATA (f
->title
);
20518 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20519 return SSDATA (f
->name
);
20523 obj
= BVAR (b
, filename
);
20528 EMACS_INT size
= ZV
- BEGV
;
20529 pint2str (decode_mode_spec_buf
, field_width
, size
);
20530 return decode_mode_spec_buf
;
20535 EMACS_INT size
= ZV
- BEGV
;
20536 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20537 return decode_mode_spec_buf
;
20542 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20543 EMACS_INT topline
, nlines
, height
;
20546 /* %c and %l are ignored in `frame-title-format'. */
20547 if (mode_line_target
== MODE_LINE_TITLE
)
20550 startpos
= XMARKER (w
->start
)->charpos
;
20551 startpos_byte
= marker_byte_position (w
->start
);
20552 height
= WINDOW_TOTAL_LINES (w
);
20554 /* If we decided that this buffer isn't suitable for line numbers,
20555 don't forget that too fast. */
20556 if (EQ (w
->base_line_pos
, w
->buffer
))
20558 /* But do forget it, if the window shows a different buffer now. */
20559 else if (BUFFERP (w
->base_line_pos
))
20560 w
->base_line_pos
= Qnil
;
20562 /* If the buffer is very big, don't waste time. */
20563 if (INTEGERP (Vline_number_display_limit
)
20564 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20566 w
->base_line_pos
= Qnil
;
20567 w
->base_line_number
= Qnil
;
20571 if (INTEGERP (w
->base_line_number
)
20572 && INTEGERP (w
->base_line_pos
)
20573 && XFASTINT (w
->base_line_pos
) <= startpos
)
20575 line
= XFASTINT (w
->base_line_number
);
20576 linepos
= XFASTINT (w
->base_line_pos
);
20577 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20582 linepos
= BUF_BEGV (b
);
20583 linepos_byte
= BUF_BEGV_BYTE (b
);
20586 /* Count lines from base line to window start position. */
20587 nlines
= display_count_lines (linepos_byte
,
20591 topline
= nlines
+ line
;
20593 /* Determine a new base line, if the old one is too close
20594 or too far away, or if we did not have one.
20595 "Too close" means it's plausible a scroll-down would
20596 go back past it. */
20597 if (startpos
== BUF_BEGV (b
))
20599 w
->base_line_number
= make_number (topline
);
20600 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20602 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20603 || linepos
== BUF_BEGV (b
))
20605 EMACS_INT limit
= BUF_BEGV (b
);
20606 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20607 EMACS_INT position
;
20608 EMACS_INT distance
=
20609 (height
* 2 + 30) * line_number_display_limit_width
;
20611 if (startpos
- distance
> limit
)
20613 limit
= startpos
- distance
;
20614 limit_byte
= CHAR_TO_BYTE (limit
);
20617 nlines
= display_count_lines (startpos_byte
,
20619 - (height
* 2 + 30),
20621 /* If we couldn't find the lines we wanted within
20622 line_number_display_limit_width chars per line,
20623 give up on line numbers for this window. */
20624 if (position
== limit_byte
&& limit
== startpos
- distance
)
20626 w
->base_line_pos
= w
->buffer
;
20627 w
->base_line_number
= Qnil
;
20631 w
->base_line_number
= make_number (topline
- nlines
);
20632 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20635 /* Now count lines from the start pos to point. */
20636 nlines
= display_count_lines (startpos_byte
,
20637 PT_BYTE
, PT
, &junk
);
20639 /* Record that we did display the line number. */
20640 line_number_displayed
= 1;
20642 /* Make the string to show. */
20643 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20644 return decode_mode_spec_buf
;
20647 char* p
= decode_mode_spec_buf
;
20648 int pad
= field_width
- 2;
20654 return decode_mode_spec_buf
;
20660 obj
= BVAR (b
, mode_name
);
20664 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20670 EMACS_INT pos
= marker_position (w
->start
);
20671 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20673 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20675 if (pos
<= BUF_BEGV (b
))
20680 else if (pos
<= BUF_BEGV (b
))
20684 if (total
> 1000000)
20685 /* Do it differently for a large value, to avoid overflow. */
20686 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20688 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20689 /* We can't normally display a 3-digit number,
20690 so get us a 2-digit number that is close. */
20693 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20694 return decode_mode_spec_buf
;
20698 /* Display percentage of size above the bottom of the screen. */
20701 EMACS_INT toppos
= marker_position (w
->start
);
20702 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20703 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20705 if (botpos
>= BUF_ZV (b
))
20707 if (toppos
<= BUF_BEGV (b
))
20714 if (total
> 1000000)
20715 /* Do it differently for a large value, to avoid overflow. */
20716 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20718 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20719 /* We can't normally display a 3-digit number,
20720 so get us a 2-digit number that is close. */
20723 if (toppos
<= BUF_BEGV (b
))
20724 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20726 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20727 return decode_mode_spec_buf
;
20732 /* status of process */
20733 obj
= Fget_buffer_process (Fcurrent_buffer ());
20735 return "no process";
20737 obj
= Fsymbol_name (Fprocess_status (obj
));
20743 int count
= inhibit_garbage_collection ();
20744 Lisp_Object val
= call1 (intern ("file-remote-p"),
20745 BVAR (current_buffer
, directory
));
20746 unbind_to (count
, Qnil
);
20754 case 't': /* indicate TEXT or BINARY */
20758 /* coding-system (not including end-of-line format) */
20760 /* coding-system (including end-of-line type) */
20762 int eol_flag
= (c
== 'Z');
20763 char *p
= decode_mode_spec_buf
;
20765 if (! FRAME_WINDOW_P (f
))
20767 /* No need to mention EOL here--the terminal never needs
20768 to do EOL conversion. */
20769 p
= decode_mode_spec_coding (CODING_ID_NAME
20770 (FRAME_KEYBOARD_CODING (f
)->id
),
20772 p
= decode_mode_spec_coding (CODING_ID_NAME
20773 (FRAME_TERMINAL_CODING (f
)->id
),
20776 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20779 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20780 #ifdef subprocesses
20781 obj
= Fget_buffer_process (Fcurrent_buffer ());
20782 if (PROCESSP (obj
))
20784 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20786 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20789 #endif /* subprocesses */
20792 return decode_mode_spec_buf
;
20799 return SSDATA (obj
);
20806 /* Count up to COUNT lines starting from START_BYTE.
20807 But don't go beyond LIMIT_BYTE.
20808 Return the number of lines thus found (always nonnegative).
20810 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20813 display_count_lines (EMACS_INT start_byte
,
20814 EMACS_INT limit_byte
, EMACS_INT count
,
20815 EMACS_INT
*byte_pos_ptr
)
20817 register unsigned char *cursor
;
20818 unsigned char *base
;
20820 register EMACS_INT ceiling
;
20821 register unsigned char *ceiling_addr
;
20822 EMACS_INT orig_count
= count
;
20824 /* If we are not in selective display mode,
20825 check only for newlines. */
20826 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20827 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20831 while (start_byte
< limit_byte
)
20833 ceiling
= BUFFER_CEILING_OF (start_byte
);
20834 ceiling
= min (limit_byte
- 1, ceiling
);
20835 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20836 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20839 if (selective_display
)
20840 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20843 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20846 if (cursor
!= ceiling_addr
)
20850 start_byte
+= cursor
- base
+ 1;
20851 *byte_pos_ptr
= start_byte
;
20855 if (++cursor
== ceiling_addr
)
20861 start_byte
+= cursor
- base
;
20866 while (start_byte
> limit_byte
)
20868 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20869 ceiling
= max (limit_byte
, ceiling
);
20870 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20871 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20874 if (selective_display
)
20875 while (--cursor
!= ceiling_addr
20876 && *cursor
!= '\n' && *cursor
!= 015)
20879 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20882 if (cursor
!= ceiling_addr
)
20886 start_byte
+= cursor
- base
+ 1;
20887 *byte_pos_ptr
= start_byte
;
20888 /* When scanning backwards, we should
20889 not count the newline posterior to which we stop. */
20890 return - orig_count
- 1;
20896 /* Here we add 1 to compensate for the last decrement
20897 of CURSOR, which took it past the valid range. */
20898 start_byte
+= cursor
- base
+ 1;
20902 *byte_pos_ptr
= limit_byte
;
20905 return - orig_count
+ count
;
20906 return orig_count
- count
;
20912 /***********************************************************************
20914 ***********************************************************************/
20916 /* Display a NUL-terminated string, starting with index START.
20918 If STRING is non-null, display that C string. Otherwise, the Lisp
20919 string LISP_STRING is displayed. There's a case that STRING is
20920 non-null and LISP_STRING is not nil. It means STRING is a string
20921 data of LISP_STRING. In that case, we display LISP_STRING while
20922 ignoring its text properties.
20924 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20925 FACE_STRING. Display STRING or LISP_STRING with the face at
20926 FACE_STRING_POS in FACE_STRING:
20928 Display the string in the environment given by IT, but use the
20929 standard display table, temporarily.
20931 FIELD_WIDTH is the minimum number of output glyphs to produce.
20932 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20933 with spaces. If STRING has more characters, more than FIELD_WIDTH
20934 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20936 PRECISION is the maximum number of characters to output from
20937 STRING. PRECISION < 0 means don't truncate the string.
20939 This is roughly equivalent to printf format specifiers:
20941 FIELD_WIDTH PRECISION PRINTF
20942 ----------------------------------------
20948 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20949 display them, and < 0 means obey the current buffer's value of
20950 enable_multibyte_characters.
20952 Value is the number of columns displayed. */
20955 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20956 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20957 int field_width
, int precision
, int max_x
, int multibyte
)
20959 int hpos_at_start
= it
->hpos
;
20960 int saved_face_id
= it
->face_id
;
20961 struct glyph_row
*row
= it
->glyph_row
;
20962 EMACS_INT it_charpos
;
20964 /* Initialize the iterator IT for iteration over STRING beginning
20965 with index START. */
20966 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20967 precision
, field_width
, multibyte
);
20968 if (string
&& STRINGP (lisp_string
))
20969 /* LISP_STRING is the one returned by decode_mode_spec. We should
20970 ignore its text properties. */
20971 it
->stop_charpos
= it
->end_charpos
;
20973 /* If displaying STRING, set up the face of the iterator from
20974 FACE_STRING, if that's given. */
20975 if (STRINGP (face_string
))
20981 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20982 0, it
->region_beg_charpos
,
20983 it
->region_end_charpos
,
20984 &endptr
, it
->base_face_id
, 0);
20985 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20986 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20989 /* Set max_x to the maximum allowed X position. Don't let it go
20990 beyond the right edge of the window. */
20992 max_x
= it
->last_visible_x
;
20994 max_x
= min (max_x
, it
->last_visible_x
);
20996 /* Skip over display elements that are not visible. because IT->w is
20998 if (it
->current_x
< it
->first_visible_x
)
20999 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21000 MOVE_TO_POS
| MOVE_TO_X
);
21002 row
->ascent
= it
->max_ascent
;
21003 row
->height
= it
->max_ascent
+ it
->max_descent
;
21004 row
->phys_ascent
= it
->max_phys_ascent
;
21005 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21006 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21008 if (STRINGP (it
->string
))
21009 it_charpos
= IT_STRING_CHARPOS (*it
);
21011 it_charpos
= IT_CHARPOS (*it
);
21013 /* This condition is for the case that we are called with current_x
21014 past last_visible_x. */
21015 while (it
->current_x
< max_x
)
21017 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21019 /* Get the next display element. */
21020 if (!get_next_display_element (it
))
21023 /* Produce glyphs. */
21024 x_before
= it
->current_x
;
21025 n_glyphs_before
= row
->used
[TEXT_AREA
];
21026 PRODUCE_GLYPHS (it
);
21028 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21031 while (i
< nglyphs
)
21033 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21035 if (it
->line_wrap
!= TRUNCATE
21036 && x
+ glyph
->pixel_width
> max_x
)
21038 /* End of continued line or max_x reached. */
21039 if (CHAR_GLYPH_PADDING_P (*glyph
))
21041 /* A wide character is unbreakable. */
21042 if (row
->reversed_p
)
21043 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21044 - n_glyphs_before
);
21045 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21046 it
->current_x
= x_before
;
21050 if (row
->reversed_p
)
21051 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21052 - (n_glyphs_before
+ i
));
21053 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21058 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21060 /* Glyph is at least partially visible. */
21062 if (x
< it
->first_visible_x
)
21063 row
->x
= x
- it
->first_visible_x
;
21067 /* Glyph is off the left margin of the display area.
21068 Should not happen. */
21072 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21073 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21074 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21075 row
->phys_height
= max (row
->phys_height
,
21076 it
->max_phys_ascent
+ it
->max_phys_descent
);
21077 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21078 it
->max_extra_line_spacing
);
21079 x
+= glyph
->pixel_width
;
21083 /* Stop if max_x reached. */
21087 /* Stop at line ends. */
21088 if (ITERATOR_AT_END_OF_LINE_P (it
))
21090 it
->continuation_lines_width
= 0;
21094 set_iterator_to_next (it
, 1);
21095 if (STRINGP (it
->string
))
21096 it_charpos
= IT_STRING_CHARPOS (*it
);
21098 it_charpos
= IT_CHARPOS (*it
);
21100 /* Stop if truncating at the right edge. */
21101 if (it
->line_wrap
== TRUNCATE
21102 && it
->current_x
>= it
->last_visible_x
)
21104 /* Add truncation mark, but don't do it if the line is
21105 truncated at a padding space. */
21106 if (it_charpos
< it
->string_nchars
)
21108 if (!FRAME_WINDOW_P (it
->f
))
21112 if (it
->current_x
> it
->last_visible_x
)
21114 if (!row
->reversed_p
)
21116 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21117 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21122 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21123 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21125 unproduce_glyphs (it
, ii
+ 1);
21126 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21128 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21130 row
->used
[TEXT_AREA
] = ii
;
21131 produce_special_glyphs (it
, IT_TRUNCATION
);
21134 produce_special_glyphs (it
, IT_TRUNCATION
);
21136 row
->truncated_on_right_p
= 1;
21142 /* Maybe insert a truncation at the left. */
21143 if (it
->first_visible_x
21146 if (!FRAME_WINDOW_P (it
->f
))
21147 insert_left_trunc_glyphs (it
);
21148 row
->truncated_on_left_p
= 1;
21151 it
->face_id
= saved_face_id
;
21153 /* Value is number of columns displayed. */
21154 return it
->hpos
- hpos_at_start
;
21159 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21160 appears as an element of LIST or as the car of an element of LIST.
21161 If PROPVAL is a list, compare each element against LIST in that
21162 way, and return 1/2 if any element of PROPVAL is found in LIST.
21163 Otherwise return 0. This function cannot quit.
21164 The return value is 2 if the text is invisible but with an ellipsis
21165 and 1 if it's invisible and without an ellipsis. */
21168 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21170 register Lisp_Object tail
, proptail
;
21172 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21174 register Lisp_Object tem
;
21176 if (EQ (propval
, tem
))
21178 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21179 return NILP (XCDR (tem
)) ? 1 : 2;
21182 if (CONSP (propval
))
21184 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21186 Lisp_Object propelt
;
21187 propelt
= XCAR (proptail
);
21188 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21190 register Lisp_Object tem
;
21192 if (EQ (propelt
, tem
))
21194 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21195 return NILP (XCDR (tem
)) ? 1 : 2;
21203 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21204 doc
: /* Non-nil if the property makes the text invisible.
21205 POS-OR-PROP can be a marker or number, in which case it is taken to be
21206 a position in the current buffer and the value of the `invisible' property
21207 is checked; or it can be some other value, which is then presumed to be the
21208 value of the `invisible' property of the text of interest.
21209 The non-nil value returned can be t for truly invisible text or something
21210 else if the text is replaced by an ellipsis. */)
21211 (Lisp_Object pos_or_prop
)
21214 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21215 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21217 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21218 return (invis
== 0 ? Qnil
21220 : make_number (invis
));
21223 /* Calculate a width or height in pixels from a specification using
21224 the following elements:
21227 NUM - a (fractional) multiple of the default font width/height
21228 (NUM) - specifies exactly NUM pixels
21229 UNIT - a fixed number of pixels, see below.
21230 ELEMENT - size of a display element in pixels, see below.
21231 (NUM . SPEC) - equals NUM * SPEC
21232 (+ SPEC SPEC ...) - add pixel values
21233 (- SPEC SPEC ...) - subtract pixel values
21234 (- SPEC) - negate pixel value
21237 INT or FLOAT - a number constant
21238 SYMBOL - use symbol's (buffer local) variable binding.
21241 in - pixels per inch *)
21242 mm - pixels per 1/1000 meter *)
21243 cm - pixels per 1/100 meter *)
21244 width - width of current font in pixels.
21245 height - height of current font in pixels.
21247 *) using the ratio(s) defined in display-pixels-per-inch.
21251 left-fringe - left fringe width in pixels
21252 right-fringe - right fringe width in pixels
21254 left-margin - left margin width in pixels
21255 right-margin - right margin width in pixels
21257 scroll-bar - scroll-bar area width in pixels
21261 Pixels corresponding to 5 inches:
21264 Total width of non-text areas on left side of window (if scroll-bar is on left):
21265 '(space :width (+ left-fringe left-margin scroll-bar))
21267 Align to first text column (in header line):
21268 '(space :align-to 0)
21270 Align to middle of text area minus half the width of variable `my-image'
21271 containing a loaded image:
21272 '(space :align-to (0.5 . (- text my-image)))
21274 Width of left margin minus width of 1 character in the default font:
21275 '(space :width (- left-margin 1))
21277 Width of left margin minus width of 2 characters in the current font:
21278 '(space :width (- left-margin (2 . width)))
21280 Center 1 character over left-margin (in header line):
21281 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21283 Different ways to express width of left fringe plus left margin minus one pixel:
21284 '(space :width (- (+ left-fringe left-margin) (1)))
21285 '(space :width (+ left-fringe left-margin (- (1))))
21286 '(space :width (+ left-fringe left-margin (-1)))
21290 #define NUMVAL(X) \
21291 ((INTEGERP (X) || FLOATP (X)) \
21296 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21297 struct font
*font
, int width_p
, int *align_to
)
21301 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21302 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21305 return OK_PIXELS (0);
21307 xassert (FRAME_LIVE_P (it
->f
));
21309 if (SYMBOLP (prop
))
21311 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21313 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21315 if (unit
[0] == 'i' && unit
[1] == 'n')
21317 else if (unit
[0] == 'm' && unit
[1] == 'm')
21319 else if (unit
[0] == 'c' && unit
[1] == 'm')
21326 #ifdef HAVE_WINDOW_SYSTEM
21327 if (FRAME_WINDOW_P (it
->f
)
21329 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21330 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21332 return OK_PIXELS (ppi
/ pixels
);
21335 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21336 || (CONSP (Vdisplay_pixels_per_inch
)
21338 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21339 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21341 return OK_PIXELS (ppi
/ pixels
);
21347 #ifdef HAVE_WINDOW_SYSTEM
21348 if (EQ (prop
, Qheight
))
21349 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21350 if (EQ (prop
, Qwidth
))
21351 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21353 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21354 return OK_PIXELS (1);
21357 if (EQ (prop
, Qtext
))
21358 return OK_PIXELS (width_p
21359 ? window_box_width (it
->w
, TEXT_AREA
)
21360 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21362 if (align_to
&& *align_to
< 0)
21365 if (EQ (prop
, Qleft
))
21366 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21367 if (EQ (prop
, Qright
))
21368 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21369 if (EQ (prop
, Qcenter
))
21370 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21371 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21372 if (EQ (prop
, Qleft_fringe
))
21373 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21374 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21375 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21376 if (EQ (prop
, Qright_fringe
))
21377 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21378 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21379 : window_box_right_offset (it
->w
, TEXT_AREA
));
21380 if (EQ (prop
, Qleft_margin
))
21381 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21382 if (EQ (prop
, Qright_margin
))
21383 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21384 if (EQ (prop
, Qscroll_bar
))
21385 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21387 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21388 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21389 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21394 if (EQ (prop
, Qleft_fringe
))
21395 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21396 if (EQ (prop
, Qright_fringe
))
21397 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21398 if (EQ (prop
, Qleft_margin
))
21399 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21400 if (EQ (prop
, Qright_margin
))
21401 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21402 if (EQ (prop
, Qscroll_bar
))
21403 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21406 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21409 if (INTEGERP (prop
) || FLOATP (prop
))
21411 int base_unit
= (width_p
21412 ? FRAME_COLUMN_WIDTH (it
->f
)
21413 : FRAME_LINE_HEIGHT (it
->f
));
21414 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21419 Lisp_Object car
= XCAR (prop
);
21420 Lisp_Object cdr
= XCDR (prop
);
21424 #ifdef HAVE_WINDOW_SYSTEM
21425 if (FRAME_WINDOW_P (it
->f
)
21426 && valid_image_p (prop
))
21428 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21429 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21431 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21434 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21440 while (CONSP (cdr
))
21442 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21443 font
, width_p
, align_to
))
21446 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21451 if (EQ (car
, Qminus
))
21453 return OK_PIXELS (pixels
);
21456 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21459 if (INTEGERP (car
) || FLOATP (car
))
21462 pixels
= XFLOATINT (car
);
21464 return OK_PIXELS (pixels
);
21465 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21466 font
, width_p
, align_to
))
21467 return OK_PIXELS (pixels
* fact
);
21478 /***********************************************************************
21480 ***********************************************************************/
21482 #ifdef HAVE_WINDOW_SYSTEM
21487 dump_glyph_string (struct glyph_string
*s
)
21489 fprintf (stderr
, "glyph string\n");
21490 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21491 s
->x
, s
->y
, s
->width
, s
->height
);
21492 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21493 fprintf (stderr
, " hl = %d\n", s
->hl
);
21494 fprintf (stderr
, " left overhang = %d, right = %d\n",
21495 s
->left_overhang
, s
->right_overhang
);
21496 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21497 fprintf (stderr
, " extends to end of line = %d\n",
21498 s
->extends_to_end_of_line_p
);
21499 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21500 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21503 #endif /* GLYPH_DEBUG */
21505 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21506 of XChar2b structures for S; it can't be allocated in
21507 init_glyph_string because it must be allocated via `alloca'. W
21508 is the window on which S is drawn. ROW and AREA are the glyph row
21509 and area within the row from which S is constructed. START is the
21510 index of the first glyph structure covered by S. HL is a
21511 face-override for drawing S. */
21514 #define OPTIONAL_HDC(hdc) HDC hdc,
21515 #define DECLARE_HDC(hdc) HDC hdc;
21516 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21517 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21520 #ifndef OPTIONAL_HDC
21521 #define OPTIONAL_HDC(hdc)
21522 #define DECLARE_HDC(hdc)
21523 #define ALLOCATE_HDC(hdc, f)
21524 #define RELEASE_HDC(hdc, f)
21528 init_glyph_string (struct glyph_string
*s
,
21530 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21531 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21533 memset (s
, 0, sizeof *s
);
21535 s
->f
= XFRAME (w
->frame
);
21539 s
->display
= FRAME_X_DISPLAY (s
->f
);
21540 s
->window
= FRAME_X_WINDOW (s
->f
);
21541 s
->char2b
= char2b
;
21545 s
->first_glyph
= row
->glyphs
[area
] + start
;
21546 s
->height
= row
->height
;
21547 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21548 s
->ybase
= s
->y
+ row
->ascent
;
21552 /* Append the list of glyph strings with head H and tail T to the list
21553 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21556 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21557 struct glyph_string
*h
, struct glyph_string
*t
)
21571 /* Prepend the list of glyph strings with head H and tail T to the
21572 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21576 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21577 struct glyph_string
*h
, struct glyph_string
*t
)
21591 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21592 Set *HEAD and *TAIL to the resulting list. */
21595 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21596 struct glyph_string
*s
)
21598 s
->next
= s
->prev
= NULL
;
21599 append_glyph_string_lists (head
, tail
, s
, s
);
21603 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21604 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21605 make sure that X resources for the face returned are allocated.
21606 Value is a pointer to a realized face that is ready for display if
21607 DISPLAY_P is non-zero. */
21609 static inline struct face
*
21610 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21611 XChar2b
*char2b
, int display_p
)
21613 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21617 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21619 if (code
!= FONT_INVALID_CODE
)
21620 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21622 STORE_XCHAR2B (char2b
, 0, 0);
21625 /* Make sure X resources of the face are allocated. */
21626 #ifdef HAVE_X_WINDOWS
21630 xassert (face
!= NULL
);
21631 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21638 /* Get face and two-byte form of character glyph GLYPH on frame F.
21639 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21640 a pointer to a realized face that is ready for display. */
21642 static inline struct face
*
21643 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21644 XChar2b
*char2b
, int *two_byte_p
)
21648 xassert (glyph
->type
== CHAR_GLYPH
);
21649 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21658 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21659 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21661 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21663 if (code
!= FONT_INVALID_CODE
)
21664 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21666 STORE_XCHAR2B (char2b
, 0, 0);
21669 /* Make sure X resources of the face are allocated. */
21670 xassert (face
!= NULL
);
21671 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21676 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21677 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21680 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21684 if (CHAR_BYTE8_P (c
))
21685 code
= CHAR_TO_BYTE8 (c
);
21687 code
= font
->driver
->encode_char (font
, c
);
21689 if (code
== FONT_INVALID_CODE
)
21691 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21696 /* Fill glyph string S with composition components specified by S->cmp.
21698 BASE_FACE is the base face of the composition.
21699 S->cmp_from is the index of the first component for S.
21701 OVERLAPS non-zero means S should draw the foreground only, and use
21702 its physical height for clipping. See also draw_glyphs.
21704 Value is the index of a component not in S. */
21707 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21711 /* For all glyphs of this composition, starting at the offset
21712 S->cmp_from, until we reach the end of the definition or encounter a
21713 glyph that requires the different face, add it to S. */
21718 s
->for_overlaps
= overlaps
;
21721 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21723 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21727 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21730 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21737 s
->font
= s
->face
->font
;
21739 else if (s
->face
!= face
)
21747 /* All glyph strings for the same composition has the same width,
21748 i.e. the width set for the first component of the composition. */
21749 s
->width
= s
->first_glyph
->pixel_width
;
21751 /* If the specified font could not be loaded, use the frame's
21752 default font, but record the fact that we couldn't load it in
21753 the glyph string so that we can draw rectangles for the
21754 characters of the glyph string. */
21755 if (s
->font
== NULL
)
21757 s
->font_not_found_p
= 1;
21758 s
->font
= FRAME_FONT (s
->f
);
21761 /* Adjust base line for subscript/superscript text. */
21762 s
->ybase
+= s
->first_glyph
->voffset
;
21764 /* This glyph string must always be drawn with 16-bit functions. */
21771 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21772 int start
, int end
, int overlaps
)
21774 struct glyph
*glyph
, *last
;
21775 Lisp_Object lgstring
;
21778 s
->for_overlaps
= overlaps
;
21779 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21780 last
= s
->row
->glyphs
[s
->area
] + end
;
21781 s
->cmp_id
= glyph
->u
.cmp
.id
;
21782 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21783 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21784 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21785 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21786 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21788 while (glyph
< last
21789 && glyph
->u
.cmp
.automatic
21790 && glyph
->u
.cmp
.id
== s
->cmp_id
21791 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21792 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21794 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21796 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21797 unsigned code
= LGLYPH_CODE (lglyph
);
21799 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21801 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21802 return glyph
- s
->row
->glyphs
[s
->area
];
21806 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21807 See the comment of fill_glyph_string for arguments.
21808 Value is the index of the first glyph not in S. */
21812 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21813 int start
, int end
, int overlaps
)
21815 struct glyph
*glyph
, *last
;
21818 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21819 s
->for_overlaps
= overlaps
;
21820 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21821 last
= s
->row
->glyphs
[s
->area
] + end
;
21822 voffset
= glyph
->voffset
;
21823 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21824 s
->font
= s
->face
->font
;
21826 s
->width
= glyph
->pixel_width
;
21828 while (glyph
< last
21829 && glyph
->type
== GLYPHLESS_GLYPH
21830 && glyph
->voffset
== voffset
21831 && glyph
->face_id
== face_id
)
21834 s
->width
+= glyph
->pixel_width
;
21837 s
->ybase
+= voffset
;
21838 return glyph
- s
->row
->glyphs
[s
->area
];
21842 /* Fill glyph string S from a sequence of character glyphs.
21844 FACE_ID is the face id of the string. START is the index of the
21845 first glyph to consider, END is the index of the last + 1.
21846 OVERLAPS non-zero means S should draw the foreground only, and use
21847 its physical height for clipping. See also draw_glyphs.
21849 Value is the index of the first glyph not in S. */
21852 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21853 int start
, int end
, int overlaps
)
21855 struct glyph
*glyph
, *last
;
21857 int glyph_not_available_p
;
21859 xassert (s
->f
== XFRAME (s
->w
->frame
));
21860 xassert (s
->nchars
== 0);
21861 xassert (start
>= 0 && end
> start
);
21863 s
->for_overlaps
= overlaps
;
21864 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21865 last
= s
->row
->glyphs
[s
->area
] + end
;
21866 voffset
= glyph
->voffset
;
21867 s
->padding_p
= glyph
->padding_p
;
21868 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21870 while (glyph
< last
21871 && glyph
->type
== CHAR_GLYPH
21872 && glyph
->voffset
== voffset
21873 /* Same face id implies same font, nowadays. */
21874 && glyph
->face_id
== face_id
21875 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21879 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21880 s
->char2b
+ s
->nchars
,
21882 s
->two_byte_p
= two_byte_p
;
21884 xassert (s
->nchars
<= end
- start
);
21885 s
->width
+= glyph
->pixel_width
;
21886 if (glyph
++->padding_p
!= s
->padding_p
)
21890 s
->font
= s
->face
->font
;
21892 /* If the specified font could not be loaded, use the frame's font,
21893 but record the fact that we couldn't load it in
21894 S->font_not_found_p so that we can draw rectangles for the
21895 characters of the glyph string. */
21896 if (s
->font
== NULL
|| glyph_not_available_p
)
21898 s
->font_not_found_p
= 1;
21899 s
->font
= FRAME_FONT (s
->f
);
21902 /* Adjust base line for subscript/superscript text. */
21903 s
->ybase
+= voffset
;
21905 xassert (s
->face
&& s
->face
->gc
);
21906 return glyph
- s
->row
->glyphs
[s
->area
];
21910 /* Fill glyph string S from image glyph S->first_glyph. */
21913 fill_image_glyph_string (struct glyph_string
*s
)
21915 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21916 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21918 s
->slice
= s
->first_glyph
->slice
.img
;
21919 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21920 s
->font
= s
->face
->font
;
21921 s
->width
= s
->first_glyph
->pixel_width
;
21923 /* Adjust base line for subscript/superscript text. */
21924 s
->ybase
+= s
->first_glyph
->voffset
;
21928 /* Fill glyph string S from a sequence of stretch glyphs.
21930 START is the index of the first glyph to consider,
21931 END is the index of the last + 1.
21933 Value is the index of the first glyph not in S. */
21936 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21938 struct glyph
*glyph
, *last
;
21939 int voffset
, face_id
;
21941 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21943 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21944 last
= s
->row
->glyphs
[s
->area
] + end
;
21945 face_id
= glyph
->face_id
;
21946 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21947 s
->font
= s
->face
->font
;
21948 s
->width
= glyph
->pixel_width
;
21950 voffset
= glyph
->voffset
;
21954 && glyph
->type
== STRETCH_GLYPH
21955 && glyph
->voffset
== voffset
21956 && glyph
->face_id
== face_id
);
21958 s
->width
+= glyph
->pixel_width
;
21960 /* Adjust base line for subscript/superscript text. */
21961 s
->ybase
+= voffset
;
21963 /* The case that face->gc == 0 is handled when drawing the glyph
21964 string by calling PREPARE_FACE_FOR_DISPLAY. */
21966 return glyph
- s
->row
->glyphs
[s
->area
];
21969 static struct font_metrics
*
21970 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21972 static struct font_metrics metrics
;
21973 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21975 if (! font
|| code
== FONT_INVALID_CODE
)
21977 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21982 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21983 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21984 assumed to be zero. */
21987 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21989 *left
= *right
= 0;
21991 if (glyph
->type
== CHAR_GLYPH
)
21995 struct font_metrics
*pcm
;
21997 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21998 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22000 if (pcm
->rbearing
> pcm
->width
)
22001 *right
= pcm
->rbearing
- pcm
->width
;
22002 if (pcm
->lbearing
< 0)
22003 *left
= -pcm
->lbearing
;
22006 else if (glyph
->type
== COMPOSITE_GLYPH
)
22008 if (! glyph
->u
.cmp
.automatic
)
22010 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22012 if (cmp
->rbearing
> cmp
->pixel_width
)
22013 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22014 if (cmp
->lbearing
< 0)
22015 *left
= - cmp
->lbearing
;
22019 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22020 struct font_metrics metrics
;
22022 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22023 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22024 if (metrics
.rbearing
> metrics
.width
)
22025 *right
= metrics
.rbearing
- metrics
.width
;
22026 if (metrics
.lbearing
< 0)
22027 *left
= - metrics
.lbearing
;
22033 /* Return the index of the first glyph preceding glyph string S that
22034 is overwritten by S because of S's left overhang. Value is -1
22035 if no glyphs are overwritten. */
22038 left_overwritten (struct glyph_string
*s
)
22042 if (s
->left_overhang
)
22045 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22046 int first
= s
->first_glyph
- glyphs
;
22048 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22049 x
-= glyphs
[i
].pixel_width
;
22060 /* Return the index of the first glyph preceding glyph string S that
22061 is overwriting S because of its right overhang. Value is -1 if no
22062 glyph in front of S overwrites S. */
22065 left_overwriting (struct glyph_string
*s
)
22068 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22069 int first
= s
->first_glyph
- glyphs
;
22073 for (i
= first
- 1; i
>= 0; --i
)
22076 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22079 x
-= glyphs
[i
].pixel_width
;
22086 /* Return the index of the last glyph following glyph string S that is
22087 overwritten by S because of S's right overhang. Value is -1 if
22088 no such glyph is found. */
22091 right_overwritten (struct glyph_string
*s
)
22095 if (s
->right_overhang
)
22098 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22099 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22100 int end
= s
->row
->used
[s
->area
];
22102 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22103 x
+= glyphs
[i
].pixel_width
;
22112 /* Return the index of the last glyph following glyph string S that
22113 overwrites S because of its left overhang. Value is negative
22114 if no such glyph is found. */
22117 right_overwriting (struct glyph_string
*s
)
22120 int end
= s
->row
->used
[s
->area
];
22121 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22122 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22126 for (i
= first
; i
< end
; ++i
)
22129 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22132 x
+= glyphs
[i
].pixel_width
;
22139 /* Set background width of glyph string S. START is the index of the
22140 first glyph following S. LAST_X is the right-most x-position + 1
22141 in the drawing area. */
22144 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22146 /* If the face of this glyph string has to be drawn to the end of
22147 the drawing area, set S->extends_to_end_of_line_p. */
22149 if (start
== s
->row
->used
[s
->area
]
22150 && s
->area
== TEXT_AREA
22151 && ((s
->row
->fill_line_p
22152 && (s
->hl
== DRAW_NORMAL_TEXT
22153 || s
->hl
== DRAW_IMAGE_RAISED
22154 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22155 || s
->hl
== DRAW_MOUSE_FACE
))
22156 s
->extends_to_end_of_line_p
= 1;
22158 /* If S extends its face to the end of the line, set its
22159 background_width to the distance to the right edge of the drawing
22161 if (s
->extends_to_end_of_line_p
)
22162 s
->background_width
= last_x
- s
->x
+ 1;
22164 s
->background_width
= s
->width
;
22168 /* Compute overhangs and x-positions for glyph string S and its
22169 predecessors, or successors. X is the starting x-position for S.
22170 BACKWARD_P non-zero means process predecessors. */
22173 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22179 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22180 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22190 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22191 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22201 /* The following macros are only called from draw_glyphs below.
22202 They reference the following parameters of that function directly:
22203 `w', `row', `area', and `overlap_p'
22204 as well as the following local variables:
22205 `s', `f', and `hdc' (in W32) */
22208 /* On W32, silently add local `hdc' variable to argument list of
22209 init_glyph_string. */
22210 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22211 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22213 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22214 init_glyph_string (s, char2b, w, row, area, start, hl)
22217 /* Add a glyph string for a stretch glyph to the list of strings
22218 between HEAD and TAIL. START is the index of the stretch glyph in
22219 row area AREA of glyph row ROW. END is the index of the last glyph
22220 in that glyph row area. X is the current output position assigned
22221 to the new glyph string constructed. HL overrides that face of the
22222 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22223 is the right-most x-position of the drawing area. */
22225 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22226 and below -- keep them on one line. */
22227 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22230 s = (struct glyph_string *) alloca (sizeof *s); \
22231 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22232 START = fill_stretch_glyph_string (s, START, END); \
22233 append_glyph_string (&HEAD, &TAIL, s); \
22239 /* Add a glyph string for an image glyph to the list of strings
22240 between HEAD and TAIL. START is the index of the image glyph in
22241 row area AREA of glyph row ROW. END is the index of the last glyph
22242 in that glyph row area. X is the current output position assigned
22243 to the new glyph string constructed. HL overrides that face of the
22244 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22245 is the right-most x-position of the drawing area. */
22247 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22250 s = (struct glyph_string *) alloca (sizeof *s); \
22251 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22252 fill_image_glyph_string (s); \
22253 append_glyph_string (&HEAD, &TAIL, s); \
22260 /* Add a glyph string for a sequence of character glyphs to the list
22261 of strings between HEAD and TAIL. START is the index of the first
22262 glyph in row area AREA of glyph row ROW that is part of the new
22263 glyph string. END is the index of the last glyph in that glyph row
22264 area. X is the current output position assigned to the new glyph
22265 string constructed. HL overrides that face of the glyph; e.g. it
22266 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22267 right-most x-position of the drawing area. */
22269 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22275 face_id = (row)->glyphs[area][START].face_id; \
22277 s = (struct glyph_string *) alloca (sizeof *s); \
22278 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22279 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22280 append_glyph_string (&HEAD, &TAIL, s); \
22282 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22287 /* Add a glyph string for a composite sequence to the list of strings
22288 between HEAD and TAIL. START is the index of the first glyph in
22289 row area AREA of glyph row ROW that is part of the new glyph
22290 string. END is the index of the last glyph in that glyph row area.
22291 X is the current output position assigned to the new glyph string
22292 constructed. HL overrides that face of the glyph; e.g. it is
22293 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22294 x-position of the drawing area. */
22296 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22298 int face_id = (row)->glyphs[area][START].face_id; \
22299 struct face *base_face = FACE_FROM_ID (f, face_id); \
22300 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22301 struct composition *cmp = composition_table[cmp_id]; \
22303 struct glyph_string *first_s IF_LINT (= NULL); \
22306 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22308 /* Make glyph_strings for each glyph sequence that is drawable by \
22309 the same face, and append them to HEAD/TAIL. */ \
22310 for (n = 0; n < cmp->glyph_len;) \
22312 s = (struct glyph_string *) alloca (sizeof *s); \
22313 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22314 append_glyph_string (&(HEAD), &(TAIL), s); \
22320 n = fill_composite_glyph_string (s, base_face, overlaps); \
22328 /* Add a glyph string for a glyph-string sequence to the list of strings
22329 between HEAD and TAIL. */
22331 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22335 Lisp_Object gstring; \
22337 face_id = (row)->glyphs[area][START].face_id; \
22338 gstring = (composition_gstring_from_id \
22339 ((row)->glyphs[area][START].u.cmp.id)); \
22340 s = (struct glyph_string *) alloca (sizeof *s); \
22341 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22342 * LGSTRING_GLYPH_LEN (gstring)); \
22343 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22344 append_glyph_string (&(HEAD), &(TAIL), s); \
22346 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22350 /* Add a glyph string for a sequence of glyphless character's glyphs
22351 to the list of strings between HEAD and TAIL. The meanings of
22352 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22354 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22359 face_id = (row)->glyphs[area][START].face_id; \
22361 s = (struct glyph_string *) alloca (sizeof *s); \
22362 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22363 append_glyph_string (&HEAD, &TAIL, s); \
22365 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22371 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22372 of AREA of glyph row ROW on window W between indices START and END.
22373 HL overrides the face for drawing glyph strings, e.g. it is
22374 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22375 x-positions of the drawing area.
22377 This is an ugly monster macro construct because we must use alloca
22378 to allocate glyph strings (because draw_glyphs can be called
22379 asynchronously). */
22381 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22384 HEAD = TAIL = NULL; \
22385 while (START < END) \
22387 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22388 switch (first_glyph->type) \
22391 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22395 case COMPOSITE_GLYPH: \
22396 if (first_glyph->u.cmp.automatic) \
22397 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22400 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22404 case STRETCH_GLYPH: \
22405 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22409 case IMAGE_GLYPH: \
22410 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22414 case GLYPHLESS_GLYPH: \
22415 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22425 set_glyph_string_background_width (s, START, LAST_X); \
22432 /* Draw glyphs between START and END in AREA of ROW on window W,
22433 starting at x-position X. X is relative to AREA in W. HL is a
22434 face-override with the following meaning:
22436 DRAW_NORMAL_TEXT draw normally
22437 DRAW_CURSOR draw in cursor face
22438 DRAW_MOUSE_FACE draw in mouse face.
22439 DRAW_INVERSE_VIDEO draw in mode line face
22440 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22441 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22443 If OVERLAPS is non-zero, draw only the foreground of characters and
22444 clip to the physical height of ROW. Non-zero value also defines
22445 the overlapping part to be drawn:
22447 OVERLAPS_PRED overlap with preceding rows
22448 OVERLAPS_SUCC overlap with succeeding rows
22449 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22450 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22452 Value is the x-position reached, relative to AREA of W. */
22455 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22456 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22457 enum draw_glyphs_face hl
, int overlaps
)
22459 struct glyph_string
*head
, *tail
;
22460 struct glyph_string
*s
;
22461 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22462 int i
, j
, x_reached
, last_x
, area_left
= 0;
22463 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22466 ALLOCATE_HDC (hdc
, f
);
22468 /* Let's rather be paranoid than getting a SEGV. */
22469 end
= min (end
, row
->used
[area
]);
22470 start
= max (0, start
);
22471 start
= min (end
, start
);
22473 /* Translate X to frame coordinates. Set last_x to the right
22474 end of the drawing area. */
22475 if (row
->full_width_p
)
22477 /* X is relative to the left edge of W, without scroll bars
22479 area_left
= WINDOW_LEFT_EDGE_X (w
);
22480 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22484 area_left
= window_box_left (w
, area
);
22485 last_x
= area_left
+ window_box_width (w
, area
);
22489 /* Build a doubly-linked list of glyph_string structures between
22490 head and tail from what we have to draw. Note that the macro
22491 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22492 the reason we use a separate variable `i'. */
22494 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22496 x_reached
= tail
->x
+ tail
->background_width
;
22500 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22501 the row, redraw some glyphs in front or following the glyph
22502 strings built above. */
22503 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22505 struct glyph_string
*h
, *t
;
22506 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22507 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22508 int check_mouse_face
= 0;
22511 /* If mouse highlighting is on, we may need to draw adjacent
22512 glyphs using mouse-face highlighting. */
22513 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22515 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22517 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22518 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22520 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22522 check_mouse_face
= 1;
22523 mouse_beg_col
= (row
== mouse_beg_row
)
22524 ? hlinfo
->mouse_face_beg_col
: 0;
22525 mouse_end_col
= (row
== mouse_end_row
)
22526 ? hlinfo
->mouse_face_end_col
22527 : row
->used
[TEXT_AREA
];
22531 /* Compute overhangs for all glyph strings. */
22532 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22533 for (s
= head
; s
; s
= s
->next
)
22534 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22536 /* Prepend glyph strings for glyphs in front of the first glyph
22537 string that are overwritten because of the first glyph
22538 string's left overhang. The background of all strings
22539 prepended must be drawn because the first glyph string
22541 i
= left_overwritten (head
);
22544 enum draw_glyphs_face overlap_hl
;
22546 /* If this row contains mouse highlighting, attempt to draw
22547 the overlapped glyphs with the correct highlight. This
22548 code fails if the overlap encompasses more than one glyph
22549 and mouse-highlight spans only some of these glyphs.
22550 However, making it work perfectly involves a lot more
22551 code, and I don't know if the pathological case occurs in
22552 practice, so we'll stick to this for now. --- cyd */
22553 if (check_mouse_face
22554 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22555 overlap_hl
= DRAW_MOUSE_FACE
;
22557 overlap_hl
= DRAW_NORMAL_TEXT
;
22560 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22561 overlap_hl
, dummy_x
, last_x
);
22563 compute_overhangs_and_x (t
, head
->x
, 1);
22564 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22568 /* Prepend glyph strings for glyphs in front of the first glyph
22569 string that overwrite that glyph string because of their
22570 right overhang. For these strings, only the foreground must
22571 be drawn, because it draws over the glyph string at `head'.
22572 The background must not be drawn because this would overwrite
22573 right overhangs of preceding glyphs for which no glyph
22575 i
= left_overwriting (head
);
22578 enum draw_glyphs_face overlap_hl
;
22580 if (check_mouse_face
22581 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22582 overlap_hl
= DRAW_MOUSE_FACE
;
22584 overlap_hl
= DRAW_NORMAL_TEXT
;
22587 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22588 overlap_hl
, dummy_x
, last_x
);
22589 for (s
= h
; s
; s
= s
->next
)
22590 s
->background_filled_p
= 1;
22591 compute_overhangs_and_x (t
, head
->x
, 1);
22592 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22595 /* Append glyphs strings for glyphs following the last glyph
22596 string tail that are overwritten by tail. The background of
22597 these strings has to be drawn because tail's foreground draws
22599 i
= right_overwritten (tail
);
22602 enum draw_glyphs_face overlap_hl
;
22604 if (check_mouse_face
22605 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22606 overlap_hl
= DRAW_MOUSE_FACE
;
22608 overlap_hl
= DRAW_NORMAL_TEXT
;
22610 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22611 overlap_hl
, x
, last_x
);
22612 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22613 we don't have `end = i;' here. */
22614 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22615 append_glyph_string_lists (&head
, &tail
, h
, t
);
22619 /* Append glyph strings for glyphs following the last glyph
22620 string tail that overwrite tail. The foreground of such
22621 glyphs has to be drawn because it writes into the background
22622 of tail. The background must not be drawn because it could
22623 paint over the foreground of following glyphs. */
22624 i
= right_overwriting (tail
);
22627 enum draw_glyphs_face overlap_hl
;
22628 if (check_mouse_face
22629 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22630 overlap_hl
= DRAW_MOUSE_FACE
;
22632 overlap_hl
= DRAW_NORMAL_TEXT
;
22635 i
++; /* We must include the Ith glyph. */
22636 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22637 overlap_hl
, x
, last_x
);
22638 for (s
= h
; s
; s
= s
->next
)
22639 s
->background_filled_p
= 1;
22640 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22641 append_glyph_string_lists (&head
, &tail
, h
, t
);
22643 if (clip_head
|| clip_tail
)
22644 for (s
= head
; s
; s
= s
->next
)
22646 s
->clip_head
= clip_head
;
22647 s
->clip_tail
= clip_tail
;
22651 /* Draw all strings. */
22652 for (s
= head
; s
; s
= s
->next
)
22653 FRAME_RIF (f
)->draw_glyph_string (s
);
22656 /* When focus a sole frame and move horizontally, this sets on_p to 0
22657 causing a failure to erase prev cursor position. */
22658 if (area
== TEXT_AREA
22659 && !row
->full_width_p
22660 /* When drawing overlapping rows, only the glyph strings'
22661 foreground is drawn, which doesn't erase a cursor
22665 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22666 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22667 : (tail
? tail
->x
+ tail
->background_width
: x
));
22671 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22672 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22676 /* Value is the x-position up to which drawn, relative to AREA of W.
22677 This doesn't include parts drawn because of overhangs. */
22678 if (row
->full_width_p
)
22679 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22681 x_reached
-= area_left
;
22683 RELEASE_HDC (hdc
, f
);
22688 /* Expand row matrix if too narrow. Don't expand if area
22691 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22693 if (!fonts_changed_p \
22694 && (it->glyph_row->glyphs[area] \
22695 < it->glyph_row->glyphs[area + 1])) \
22697 it->w->ncols_scale_factor++; \
22698 fonts_changed_p = 1; \
22702 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22703 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22706 append_glyph (struct it
*it
)
22708 struct glyph
*glyph
;
22709 enum glyph_row_area area
= it
->area
;
22711 xassert (it
->glyph_row
);
22712 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22714 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22715 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22717 /* If the glyph row is reversed, we need to prepend the glyph
22718 rather than append it. */
22719 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22723 /* Make room for the additional glyph. */
22724 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22726 glyph
= it
->glyph_row
->glyphs
[area
];
22728 glyph
->charpos
= CHARPOS (it
->position
);
22729 glyph
->object
= it
->object
;
22730 if (it
->pixel_width
> 0)
22732 glyph
->pixel_width
= it
->pixel_width
;
22733 glyph
->padding_p
= 0;
22737 /* Assure at least 1-pixel width. Otherwise, cursor can't
22738 be displayed correctly. */
22739 glyph
->pixel_width
= 1;
22740 glyph
->padding_p
= 1;
22742 glyph
->ascent
= it
->ascent
;
22743 glyph
->descent
= it
->descent
;
22744 glyph
->voffset
= it
->voffset
;
22745 glyph
->type
= CHAR_GLYPH
;
22746 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22747 glyph
->multibyte_p
= it
->multibyte_p
;
22748 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22749 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22750 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22751 || it
->phys_descent
> it
->descent
);
22752 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22753 glyph
->face_id
= it
->face_id
;
22754 glyph
->u
.ch
= it
->char_to_display
;
22755 glyph
->slice
.img
= null_glyph_slice
;
22756 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22759 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22760 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22762 glyph
->bidi_type
= it
->bidi_it
.type
;
22766 glyph
->resolved_level
= 0;
22767 glyph
->bidi_type
= UNKNOWN_BT
;
22769 ++it
->glyph_row
->used
[area
];
22772 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22775 /* Store one glyph for the composition IT->cmp_it.id in
22776 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22780 append_composite_glyph (struct it
*it
)
22782 struct glyph
*glyph
;
22783 enum glyph_row_area area
= it
->area
;
22785 xassert (it
->glyph_row
);
22787 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22788 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22790 /* If the glyph row is reversed, we need to prepend the glyph
22791 rather than append it. */
22792 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22796 /* Make room for the new glyph. */
22797 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22799 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22801 glyph
->charpos
= it
->cmp_it
.charpos
;
22802 glyph
->object
= it
->object
;
22803 glyph
->pixel_width
= it
->pixel_width
;
22804 glyph
->ascent
= it
->ascent
;
22805 glyph
->descent
= it
->descent
;
22806 glyph
->voffset
= it
->voffset
;
22807 glyph
->type
= COMPOSITE_GLYPH
;
22808 if (it
->cmp_it
.ch
< 0)
22810 glyph
->u
.cmp
.automatic
= 0;
22811 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22812 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22816 glyph
->u
.cmp
.automatic
= 1;
22817 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22818 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22819 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22821 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22822 glyph
->multibyte_p
= it
->multibyte_p
;
22823 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22824 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22825 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22826 || it
->phys_descent
> it
->descent
);
22827 glyph
->padding_p
= 0;
22828 glyph
->glyph_not_available_p
= 0;
22829 glyph
->face_id
= it
->face_id
;
22830 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22833 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22834 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22836 glyph
->bidi_type
= it
->bidi_it
.type
;
22838 ++it
->glyph_row
->used
[area
];
22841 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22845 /* Change IT->ascent and IT->height according to the setting of
22849 take_vertical_position_into_account (struct it
*it
)
22853 if (it
->voffset
< 0)
22854 /* Increase the ascent so that we can display the text higher
22856 it
->ascent
-= it
->voffset
;
22858 /* Increase the descent so that we can display the text lower
22860 it
->descent
+= it
->voffset
;
22865 /* Produce glyphs/get display metrics for the image IT is loaded with.
22866 See the description of struct display_iterator in dispextern.h for
22867 an overview of struct display_iterator. */
22870 produce_image_glyph (struct it
*it
)
22874 int glyph_ascent
, crop
;
22875 struct glyph_slice slice
;
22877 xassert (it
->what
== IT_IMAGE
);
22879 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22881 /* Make sure X resources of the face is loaded. */
22882 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22884 if (it
->image_id
< 0)
22886 /* Fringe bitmap. */
22887 it
->ascent
= it
->phys_ascent
= 0;
22888 it
->descent
= it
->phys_descent
= 0;
22889 it
->pixel_width
= 0;
22894 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22896 /* Make sure X resources of the image is loaded. */
22897 prepare_image_for_display (it
->f
, img
);
22899 slice
.x
= slice
.y
= 0;
22900 slice
.width
= img
->width
;
22901 slice
.height
= img
->height
;
22903 if (INTEGERP (it
->slice
.x
))
22904 slice
.x
= XINT (it
->slice
.x
);
22905 else if (FLOATP (it
->slice
.x
))
22906 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22908 if (INTEGERP (it
->slice
.y
))
22909 slice
.y
= XINT (it
->slice
.y
);
22910 else if (FLOATP (it
->slice
.y
))
22911 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22913 if (INTEGERP (it
->slice
.width
))
22914 slice
.width
= XINT (it
->slice
.width
);
22915 else if (FLOATP (it
->slice
.width
))
22916 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22918 if (INTEGERP (it
->slice
.height
))
22919 slice
.height
= XINT (it
->slice
.height
);
22920 else if (FLOATP (it
->slice
.height
))
22921 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22923 if (slice
.x
>= img
->width
)
22924 slice
.x
= img
->width
;
22925 if (slice
.y
>= img
->height
)
22926 slice
.y
= img
->height
;
22927 if (slice
.x
+ slice
.width
>= img
->width
)
22928 slice
.width
= img
->width
- slice
.x
;
22929 if (slice
.y
+ slice
.height
> img
->height
)
22930 slice
.height
= img
->height
- slice
.y
;
22932 if (slice
.width
== 0 || slice
.height
== 0)
22935 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22937 it
->descent
= slice
.height
- glyph_ascent
;
22939 it
->descent
+= img
->vmargin
;
22940 if (slice
.y
+ slice
.height
== img
->height
)
22941 it
->descent
+= img
->vmargin
;
22942 it
->phys_descent
= it
->descent
;
22944 it
->pixel_width
= slice
.width
;
22946 it
->pixel_width
+= img
->hmargin
;
22947 if (slice
.x
+ slice
.width
== img
->width
)
22948 it
->pixel_width
+= img
->hmargin
;
22950 /* It's quite possible for images to have an ascent greater than
22951 their height, so don't get confused in that case. */
22952 if (it
->descent
< 0)
22957 if (face
->box
!= FACE_NO_BOX
)
22959 if (face
->box_line_width
> 0)
22962 it
->ascent
+= face
->box_line_width
;
22963 if (slice
.y
+ slice
.height
== img
->height
)
22964 it
->descent
+= face
->box_line_width
;
22967 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22968 it
->pixel_width
+= eabs (face
->box_line_width
);
22969 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22970 it
->pixel_width
+= eabs (face
->box_line_width
);
22973 take_vertical_position_into_account (it
);
22975 /* Automatically crop wide image glyphs at right edge so we can
22976 draw the cursor on same display row. */
22977 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22978 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22980 it
->pixel_width
-= crop
;
22981 slice
.width
-= crop
;
22986 struct glyph
*glyph
;
22987 enum glyph_row_area area
= it
->area
;
22989 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22990 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22992 glyph
->charpos
= CHARPOS (it
->position
);
22993 glyph
->object
= it
->object
;
22994 glyph
->pixel_width
= it
->pixel_width
;
22995 glyph
->ascent
= glyph_ascent
;
22996 glyph
->descent
= it
->descent
;
22997 glyph
->voffset
= it
->voffset
;
22998 glyph
->type
= IMAGE_GLYPH
;
22999 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23000 glyph
->multibyte_p
= it
->multibyte_p
;
23001 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23002 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23003 glyph
->overlaps_vertically_p
= 0;
23004 glyph
->padding_p
= 0;
23005 glyph
->glyph_not_available_p
= 0;
23006 glyph
->face_id
= it
->face_id
;
23007 glyph
->u
.img_id
= img
->id
;
23008 glyph
->slice
.img
= slice
;
23009 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23012 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23013 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23015 glyph
->bidi_type
= it
->bidi_it
.type
;
23017 ++it
->glyph_row
->used
[area
];
23020 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23025 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23026 of the glyph, WIDTH and HEIGHT are the width and height of the
23027 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23030 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23031 int width
, int height
, int ascent
)
23033 struct glyph
*glyph
;
23034 enum glyph_row_area area
= it
->area
;
23036 xassert (ascent
>= 0 && ascent
<= height
);
23038 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23039 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23041 /* If the glyph row is reversed, we need to prepend the glyph
23042 rather than append it. */
23043 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23047 /* Make room for the additional glyph. */
23048 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23050 glyph
= it
->glyph_row
->glyphs
[area
];
23052 glyph
->charpos
= CHARPOS (it
->position
);
23053 glyph
->object
= object
;
23054 glyph
->pixel_width
= width
;
23055 glyph
->ascent
= ascent
;
23056 glyph
->descent
= height
- ascent
;
23057 glyph
->voffset
= it
->voffset
;
23058 glyph
->type
= STRETCH_GLYPH
;
23059 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23060 glyph
->multibyte_p
= it
->multibyte_p
;
23061 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23062 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23063 glyph
->overlaps_vertically_p
= 0;
23064 glyph
->padding_p
= 0;
23065 glyph
->glyph_not_available_p
= 0;
23066 glyph
->face_id
= it
->face_id
;
23067 glyph
->u
.stretch
.ascent
= ascent
;
23068 glyph
->u
.stretch
.height
= height
;
23069 glyph
->slice
.img
= null_glyph_slice
;
23070 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23073 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23074 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23076 glyph
->bidi_type
= it
->bidi_it
.type
;
23080 glyph
->resolved_level
= 0;
23081 glyph
->bidi_type
= UNKNOWN_BT
;
23083 ++it
->glyph_row
->used
[area
];
23086 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23090 /* Produce a stretch glyph for iterator IT. IT->object is the value
23091 of the glyph property displayed. The value must be a list
23092 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23095 1. `:width WIDTH' specifies that the space should be WIDTH *
23096 canonical char width wide. WIDTH may be an integer or floating
23099 2. `:relative-width FACTOR' specifies that the width of the stretch
23100 should be computed from the width of the first character having the
23101 `glyph' property, and should be FACTOR times that width.
23103 3. `:align-to HPOS' specifies that the space should be wide enough
23104 to reach HPOS, a value in canonical character units.
23106 Exactly one of the above pairs must be present.
23108 4. `:height HEIGHT' specifies that the height of the stretch produced
23109 should be HEIGHT, measured in canonical character units.
23111 5. `:relative-height FACTOR' specifies that the height of the
23112 stretch should be FACTOR times the height of the characters having
23113 the glyph property.
23115 Either none or exactly one of 4 or 5 must be present.
23117 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23118 of the stretch should be used for the ascent of the stretch.
23119 ASCENT must be in the range 0 <= ASCENT <= 100. */
23122 produce_stretch_glyph (struct it
*it
)
23124 /* (space :width WIDTH :height HEIGHT ...) */
23125 Lisp_Object prop
, plist
;
23126 int width
= 0, height
= 0, align_to
= -1;
23127 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
23130 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23131 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23133 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23135 /* List should start with `space'. */
23136 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23137 plist
= XCDR (it
->object
);
23139 /* Compute the width of the stretch. */
23140 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23141 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23143 /* Absolute width `:width WIDTH' specified and valid. */
23144 zero_width_ok_p
= 1;
23147 else if (prop
= Fplist_get (plist
, QCrelative_width
),
23150 /* Relative width `:relative-width FACTOR' specified and valid.
23151 Compute the width of the characters having the `glyph'
23154 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23157 if (it
->multibyte_p
)
23158 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23161 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23162 if (! ASCII_CHAR_P (it2
.c
))
23163 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23166 it2
.glyph_row
= NULL
;
23167 it2
.what
= IT_CHARACTER
;
23168 x_produce_glyphs (&it2
);
23169 width
= NUMVAL (prop
) * it2
.pixel_width
;
23171 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23172 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23174 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23175 align_to
= (align_to
< 0
23177 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23178 else if (align_to
< 0)
23179 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23180 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23181 zero_width_ok_p
= 1;
23184 /* Nothing specified -> width defaults to canonical char width. */
23185 width
= FRAME_COLUMN_WIDTH (it
->f
);
23187 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23190 /* Compute height. */
23191 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23192 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23195 zero_height_ok_p
= 1;
23197 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23199 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23201 height
= FONT_HEIGHT (font
);
23203 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23206 /* Compute percentage of height used for ascent. If
23207 `:ascent ASCENT' is present and valid, use that. Otherwise,
23208 derive the ascent from the font in use. */
23209 if (prop
= Fplist_get (plist
, QCascent
),
23210 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23211 ascent
= height
* NUMVAL (prop
) / 100.0;
23212 else if (!NILP (prop
)
23213 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23214 ascent
= min (max (0, (int)tem
), height
);
23216 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23218 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23219 && it
->current_x
+ width
> it
->last_visible_x
)
23220 width
= it
->last_visible_x
- it
->current_x
- 1;
23222 if (width
> 0 && height
> 0 && it
->glyph_row
)
23224 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23225 if (!STRINGP (object
))
23226 object
= it
->w
->buffer
;
23227 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23230 it
->pixel_width
= width
;
23231 it
->ascent
= it
->phys_ascent
= ascent
;
23232 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23233 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23235 take_vertical_position_into_account (it
);
23238 /* Calculate line-height and line-spacing properties.
23239 An integer value specifies explicit pixel value.
23240 A float value specifies relative value to current face height.
23241 A cons (float . face-name) specifies relative value to
23242 height of specified face font.
23244 Returns height in pixels, or nil. */
23248 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23249 int boff
, int override
)
23251 Lisp_Object face_name
= Qnil
;
23252 int ascent
, descent
, height
;
23254 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23259 face_name
= XCAR (val
);
23261 if (!NUMBERP (val
))
23262 val
= make_number (1);
23263 if (NILP (face_name
))
23265 height
= it
->ascent
+ it
->descent
;
23270 if (NILP (face_name
))
23272 font
= FRAME_FONT (it
->f
);
23273 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23275 else if (EQ (face_name
, Qt
))
23284 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23286 return make_number (-1);
23288 face
= FACE_FROM_ID (it
->f
, face_id
);
23291 return make_number (-1);
23292 boff
= font
->baseline_offset
;
23293 if (font
->vertical_centering
)
23294 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23297 ascent
= FONT_BASE (font
) + boff
;
23298 descent
= FONT_DESCENT (font
) - boff
;
23302 it
->override_ascent
= ascent
;
23303 it
->override_descent
= descent
;
23304 it
->override_boff
= boff
;
23307 height
= ascent
+ descent
;
23311 height
= (int)(XFLOAT_DATA (val
) * height
);
23312 else if (INTEGERP (val
))
23313 height
*= XINT (val
);
23315 return make_number (height
);
23319 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23320 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23321 and only if this is for a character for which no font was found.
23323 If the display method (it->glyphless_method) is
23324 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23325 length of the acronym or the hexadecimal string, UPPER_XOFF and
23326 UPPER_YOFF are pixel offsets for the upper part of the string,
23327 LOWER_XOFF and LOWER_YOFF are for the lower part.
23329 For the other display methods, LEN through LOWER_YOFF are zero. */
23332 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23333 short upper_xoff
, short upper_yoff
,
23334 short lower_xoff
, short lower_yoff
)
23336 struct glyph
*glyph
;
23337 enum glyph_row_area area
= it
->area
;
23339 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23340 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23342 /* If the glyph row is reversed, we need to prepend the glyph
23343 rather than append it. */
23344 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23348 /* Make room for the additional glyph. */
23349 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23351 glyph
= it
->glyph_row
->glyphs
[area
];
23353 glyph
->charpos
= CHARPOS (it
->position
);
23354 glyph
->object
= it
->object
;
23355 glyph
->pixel_width
= it
->pixel_width
;
23356 glyph
->ascent
= it
->ascent
;
23357 glyph
->descent
= it
->descent
;
23358 glyph
->voffset
= it
->voffset
;
23359 glyph
->type
= GLYPHLESS_GLYPH
;
23360 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23361 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23362 glyph
->u
.glyphless
.len
= len
;
23363 glyph
->u
.glyphless
.ch
= it
->c
;
23364 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23365 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23366 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23367 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23368 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23369 glyph
->multibyte_p
= it
->multibyte_p
;
23370 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23371 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23372 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23373 || it
->phys_descent
> it
->descent
);
23374 glyph
->padding_p
= 0;
23375 glyph
->glyph_not_available_p
= 0;
23376 glyph
->face_id
= face_id
;
23377 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23380 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23381 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23383 glyph
->bidi_type
= it
->bidi_it
.type
;
23385 ++it
->glyph_row
->used
[area
];
23388 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23392 /* Produce a glyph for a glyphless character for iterator IT.
23393 IT->glyphless_method specifies which method to use for displaying
23394 the character. See the description of enum
23395 glyphless_display_method in dispextern.h for the detail.
23397 FOR_NO_FONT is nonzero if and only if this is for a character for
23398 which no font was found. ACRONYM, if non-nil, is an acronym string
23399 for the character. */
23402 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23407 int base_width
, base_height
, width
, height
;
23408 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23411 /* Get the metrics of the base font. We always refer to the current
23413 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23414 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23415 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23416 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23417 base_height
= it
->ascent
+ it
->descent
;
23418 base_width
= font
->average_width
;
23420 /* Get a face ID for the glyph by utilizing a cache (the same way as
23421 done for `escape-glyph' in get_next_display_element). */
23422 if (it
->f
== last_glyphless_glyph_frame
23423 && it
->face_id
== last_glyphless_glyph_face_id
)
23425 face_id
= last_glyphless_glyph_merged_face_id
;
23429 /* Merge the `glyphless-char' face into the current face. */
23430 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23431 last_glyphless_glyph_frame
= it
->f
;
23432 last_glyphless_glyph_face_id
= it
->face_id
;
23433 last_glyphless_glyph_merged_face_id
= face_id
;
23436 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23438 it
->pixel_width
= THIN_SPACE_WIDTH
;
23440 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23442 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23444 width
= CHAR_WIDTH (it
->c
);
23447 else if (width
> 4)
23449 it
->pixel_width
= base_width
* width
;
23451 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23457 unsigned int code
[6];
23459 int ascent
, descent
;
23460 struct font_metrics metrics_upper
, metrics_lower
;
23462 face
= FACE_FROM_ID (it
->f
, face_id
);
23463 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23464 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23466 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23468 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23469 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23470 if (CONSP (acronym
))
23471 acronym
= XCAR (acronym
);
23472 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23476 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23477 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23480 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23481 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23482 upper_len
= (len
+ 1) / 2;
23483 font
->driver
->text_extents (font
, code
, upper_len
,
23485 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23490 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23491 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23492 upper_xoff
= upper_yoff
= 2; /* the typical case */
23493 if (base_width
>= width
)
23495 /* Align the upper to the left, the lower to the right. */
23496 it
->pixel_width
= base_width
;
23497 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23501 /* Center the shorter one. */
23502 it
->pixel_width
= width
;
23503 if (metrics_upper
.width
>= metrics_lower
.width
)
23504 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23507 /* FIXME: This code doesn't look right. It formerly was
23508 missing the "lower_xoff = 0;", which couldn't have
23509 been right since it left lower_xoff uninitialized. */
23511 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23515 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23516 top, bottom, and between upper and lower strings. */
23517 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23518 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23519 /* Center vertically.
23520 H:base_height, D:base_descent
23521 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23523 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23524 descent = D - H/2 + h/2;
23525 lower_yoff = descent - 2 - ld;
23526 upper_yoff = lower_yoff - la - 1 - ud; */
23527 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23528 descent
= it
->descent
- (base_height
- height
) / 2;
23529 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23530 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23531 - metrics_upper
.descent
);
23532 /* Don't make the height shorter than the base height. */
23533 if (height
> base_height
)
23535 it
->ascent
= ascent
;
23536 it
->descent
= descent
;
23540 it
->phys_ascent
= it
->ascent
;
23541 it
->phys_descent
= it
->descent
;
23543 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23544 upper_xoff
, upper_yoff
,
23545 lower_xoff
, lower_yoff
);
23547 take_vertical_position_into_account (it
);
23552 Produce glyphs/get display metrics for the display element IT is
23553 loaded with. See the description of struct it in dispextern.h
23554 for an overview of struct it. */
23557 x_produce_glyphs (struct it
*it
)
23559 int extra_line_spacing
= it
->extra_line_spacing
;
23561 it
->glyph_not_available_p
= 0;
23563 if (it
->what
== IT_CHARACTER
)
23566 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23567 struct font
*font
= face
->font
;
23568 struct font_metrics
*pcm
= NULL
;
23569 int boff
; /* baseline offset */
23573 /* When no suitable font is found, display this character by
23574 the method specified in the first extra slot of
23575 Vglyphless_char_display. */
23576 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23578 xassert (it
->what
== IT_GLYPHLESS
);
23579 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23583 boff
= font
->baseline_offset
;
23584 if (font
->vertical_centering
)
23585 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23587 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23593 if (it
->override_ascent
>= 0)
23595 it
->ascent
= it
->override_ascent
;
23596 it
->descent
= it
->override_descent
;
23597 boff
= it
->override_boff
;
23601 it
->ascent
= FONT_BASE (font
) + boff
;
23602 it
->descent
= FONT_DESCENT (font
) - boff
;
23605 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23607 pcm
= get_per_char_metric (font
, &char2b
);
23608 if (pcm
->width
== 0
23609 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23615 it
->phys_ascent
= pcm
->ascent
+ boff
;
23616 it
->phys_descent
= pcm
->descent
- boff
;
23617 it
->pixel_width
= pcm
->width
;
23621 it
->glyph_not_available_p
= 1;
23622 it
->phys_ascent
= it
->ascent
;
23623 it
->phys_descent
= it
->descent
;
23624 it
->pixel_width
= font
->space_width
;
23627 if (it
->constrain_row_ascent_descent_p
)
23629 if (it
->descent
> it
->max_descent
)
23631 it
->ascent
+= it
->descent
- it
->max_descent
;
23632 it
->descent
= it
->max_descent
;
23634 if (it
->ascent
> it
->max_ascent
)
23636 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23637 it
->ascent
= it
->max_ascent
;
23639 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23640 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23641 extra_line_spacing
= 0;
23644 /* If this is a space inside a region of text with
23645 `space-width' property, change its width. */
23646 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23648 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23650 /* If face has a box, add the box thickness to the character
23651 height. If character has a box line to the left and/or
23652 right, add the box line width to the character's width. */
23653 if (face
->box
!= FACE_NO_BOX
)
23655 int thick
= face
->box_line_width
;
23659 it
->ascent
+= thick
;
23660 it
->descent
+= thick
;
23665 if (it
->start_of_box_run_p
)
23666 it
->pixel_width
+= thick
;
23667 if (it
->end_of_box_run_p
)
23668 it
->pixel_width
+= thick
;
23671 /* If face has an overline, add the height of the overline
23672 (1 pixel) and a 1 pixel margin to the character height. */
23673 if (face
->overline_p
)
23674 it
->ascent
+= overline_margin
;
23676 if (it
->constrain_row_ascent_descent_p
)
23678 if (it
->ascent
> it
->max_ascent
)
23679 it
->ascent
= it
->max_ascent
;
23680 if (it
->descent
> it
->max_descent
)
23681 it
->descent
= it
->max_descent
;
23684 take_vertical_position_into_account (it
);
23686 /* If we have to actually produce glyphs, do it. */
23691 /* Translate a space with a `space-width' property
23692 into a stretch glyph. */
23693 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23694 / FONT_HEIGHT (font
));
23695 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23696 it
->ascent
+ it
->descent
, ascent
);
23701 /* If characters with lbearing or rbearing are displayed
23702 in this line, record that fact in a flag of the
23703 glyph row. This is used to optimize X output code. */
23704 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23705 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23707 if (! stretched_p
&& it
->pixel_width
== 0)
23708 /* We assure that all visible glyphs have at least 1-pixel
23710 it
->pixel_width
= 1;
23712 else if (it
->char_to_display
== '\n')
23714 /* A newline has no width, but we need the height of the
23715 line. But if previous part of the line sets a height,
23716 don't increase that height */
23718 Lisp_Object height
;
23719 Lisp_Object total_height
= Qnil
;
23721 it
->override_ascent
= -1;
23722 it
->pixel_width
= 0;
23725 height
= get_it_property (it
, Qline_height
);
23726 /* Split (line-height total-height) list */
23728 && CONSP (XCDR (height
))
23729 && NILP (XCDR (XCDR (height
))))
23731 total_height
= XCAR (XCDR (height
));
23732 height
= XCAR (height
);
23734 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23736 if (it
->override_ascent
>= 0)
23738 it
->ascent
= it
->override_ascent
;
23739 it
->descent
= it
->override_descent
;
23740 boff
= it
->override_boff
;
23744 it
->ascent
= FONT_BASE (font
) + boff
;
23745 it
->descent
= FONT_DESCENT (font
) - boff
;
23748 if (EQ (height
, Qt
))
23750 if (it
->descent
> it
->max_descent
)
23752 it
->ascent
+= it
->descent
- it
->max_descent
;
23753 it
->descent
= it
->max_descent
;
23755 if (it
->ascent
> it
->max_ascent
)
23757 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23758 it
->ascent
= it
->max_ascent
;
23760 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23761 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23762 it
->constrain_row_ascent_descent_p
= 1;
23763 extra_line_spacing
= 0;
23767 Lisp_Object spacing
;
23769 it
->phys_ascent
= it
->ascent
;
23770 it
->phys_descent
= it
->descent
;
23772 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23773 && face
->box
!= FACE_NO_BOX
23774 && face
->box_line_width
> 0)
23776 it
->ascent
+= face
->box_line_width
;
23777 it
->descent
+= face
->box_line_width
;
23780 && XINT (height
) > it
->ascent
+ it
->descent
)
23781 it
->ascent
= XINT (height
) - it
->descent
;
23783 if (!NILP (total_height
))
23784 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23787 spacing
= get_it_property (it
, Qline_spacing
);
23788 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23790 if (INTEGERP (spacing
))
23792 extra_line_spacing
= XINT (spacing
);
23793 if (!NILP (total_height
))
23794 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23798 else /* i.e. (it->char_to_display == '\t') */
23800 if (font
->space_width
> 0)
23802 int tab_width
= it
->tab_width
* font
->space_width
;
23803 int x
= it
->current_x
+ it
->continuation_lines_width
;
23804 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23806 /* If the distance from the current position to the next tab
23807 stop is less than a space character width, use the
23808 tab stop after that. */
23809 if (next_tab_x
- x
< font
->space_width
)
23810 next_tab_x
+= tab_width
;
23812 it
->pixel_width
= next_tab_x
- x
;
23814 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23815 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23819 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23820 it
->ascent
+ it
->descent
, it
->ascent
);
23825 it
->pixel_width
= 0;
23830 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23832 /* A static composition.
23834 Note: A composition is represented as one glyph in the
23835 glyph matrix. There are no padding glyphs.
23837 Important note: pixel_width, ascent, and descent are the
23838 values of what is drawn by draw_glyphs (i.e. the values of
23839 the overall glyphs composed). */
23840 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23841 int boff
; /* baseline offset */
23842 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23843 int glyph_len
= cmp
->glyph_len
;
23844 struct font
*font
= face
->font
;
23848 /* If we have not yet calculated pixel size data of glyphs of
23849 the composition for the current face font, calculate them
23850 now. Theoretically, we have to check all fonts for the
23851 glyphs, but that requires much time and memory space. So,
23852 here we check only the font of the first glyph. This may
23853 lead to incorrect display, but it's very rare, and C-l
23854 (recenter-top-bottom) can correct the display anyway. */
23855 if (! cmp
->font
|| cmp
->font
!= font
)
23857 /* Ascent and descent of the font of the first character
23858 of this composition (adjusted by baseline offset).
23859 Ascent and descent of overall glyphs should not be less
23860 than these, respectively. */
23861 int font_ascent
, font_descent
, font_height
;
23862 /* Bounding box of the overall glyphs. */
23863 int leftmost
, rightmost
, lowest
, highest
;
23864 int lbearing
, rbearing
;
23865 int i
, width
, ascent
, descent
;
23866 int left_padded
= 0, right_padded
= 0;
23867 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23869 struct font_metrics
*pcm
;
23870 int font_not_found_p
;
23873 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23874 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23876 if (glyph_len
< cmp
->glyph_len
)
23878 for (i
= 0; i
< glyph_len
; i
++)
23880 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23882 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23887 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23888 : IT_CHARPOS (*it
));
23889 /* If no suitable font is found, use the default font. */
23890 font_not_found_p
= font
== NULL
;
23891 if (font_not_found_p
)
23893 face
= face
->ascii_face
;
23896 boff
= font
->baseline_offset
;
23897 if (font
->vertical_centering
)
23898 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23899 font_ascent
= FONT_BASE (font
) + boff
;
23900 font_descent
= FONT_DESCENT (font
) - boff
;
23901 font_height
= FONT_HEIGHT (font
);
23903 cmp
->font
= (void *) font
;
23906 if (! font_not_found_p
)
23908 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23910 pcm
= get_per_char_metric (font
, &char2b
);
23913 /* Initialize the bounding box. */
23916 width
= pcm
->width
;
23917 ascent
= pcm
->ascent
;
23918 descent
= pcm
->descent
;
23919 lbearing
= pcm
->lbearing
;
23920 rbearing
= pcm
->rbearing
;
23924 width
= font
->space_width
;
23925 ascent
= FONT_BASE (font
);
23926 descent
= FONT_DESCENT (font
);
23933 lowest
= - descent
+ boff
;
23934 highest
= ascent
+ boff
;
23936 if (! font_not_found_p
23937 && font
->default_ascent
23938 && CHAR_TABLE_P (Vuse_default_ascent
)
23939 && !NILP (Faref (Vuse_default_ascent
,
23940 make_number (it
->char_to_display
))))
23941 highest
= font
->default_ascent
+ boff
;
23943 /* Draw the first glyph at the normal position. It may be
23944 shifted to right later if some other glyphs are drawn
23946 cmp
->offsets
[i
* 2] = 0;
23947 cmp
->offsets
[i
* 2 + 1] = boff
;
23948 cmp
->lbearing
= lbearing
;
23949 cmp
->rbearing
= rbearing
;
23951 /* Set cmp->offsets for the remaining glyphs. */
23952 for (i
++; i
< glyph_len
; i
++)
23954 int left
, right
, btm
, top
;
23955 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23957 struct face
*this_face
;
23961 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23962 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23963 font
= this_face
->font
;
23969 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23971 pcm
= get_per_char_metric (font
, &char2b
);
23974 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23977 width
= pcm
->width
;
23978 ascent
= pcm
->ascent
;
23979 descent
= pcm
->descent
;
23980 lbearing
= pcm
->lbearing
;
23981 rbearing
= pcm
->rbearing
;
23982 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23984 /* Relative composition with or without
23985 alternate chars. */
23986 left
= (leftmost
+ rightmost
- width
) / 2;
23987 btm
= - descent
+ boff
;
23988 if (font
->relative_compose
23989 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23990 || NILP (Faref (Vignore_relative_composition
,
23991 make_number (ch
)))))
23994 if (- descent
>= font
->relative_compose
)
23995 /* One extra pixel between two glyphs. */
23997 else if (ascent
<= 0)
23998 /* One extra pixel between two glyphs. */
23999 btm
= lowest
- 1 - ascent
- descent
;
24004 /* A composition rule is specified by an integer
24005 value that encodes global and new reference
24006 points (GREF and NREF). GREF and NREF are
24007 specified by numbers as below:
24009 0---1---2 -- ascent
24013 9--10--11 -- center
24015 ---3---4---5--- baseline
24017 6---7---8 -- descent
24019 int rule
= COMPOSITION_RULE (cmp
, i
);
24020 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24022 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24023 grefx
= gref
% 3, nrefx
= nref
% 3;
24024 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24026 xoff
= font_height
* (xoff
- 128) / 256;
24028 yoff
= font_height
* (yoff
- 128) / 256;
24031 + grefx
* (rightmost
- leftmost
) / 2
24032 - nrefx
* width
/ 2
24035 btm
= ((grefy
== 0 ? highest
24037 : grefy
== 2 ? lowest
24038 : (highest
+ lowest
) / 2)
24039 - (nrefy
== 0 ? ascent
+ descent
24040 : nrefy
== 1 ? descent
- boff
24042 : (ascent
+ descent
) / 2)
24046 cmp
->offsets
[i
* 2] = left
;
24047 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24049 /* Update the bounding box of the overall glyphs. */
24052 right
= left
+ width
;
24053 if (left
< leftmost
)
24055 if (right
> rightmost
)
24058 top
= btm
+ descent
+ ascent
;
24064 if (cmp
->lbearing
> left
+ lbearing
)
24065 cmp
->lbearing
= left
+ lbearing
;
24066 if (cmp
->rbearing
< left
+ rbearing
)
24067 cmp
->rbearing
= left
+ rbearing
;
24071 /* If there are glyphs whose x-offsets are negative,
24072 shift all glyphs to the right and make all x-offsets
24076 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24077 cmp
->offsets
[i
* 2] -= leftmost
;
24078 rightmost
-= leftmost
;
24079 cmp
->lbearing
-= leftmost
;
24080 cmp
->rbearing
-= leftmost
;
24083 if (left_padded
&& cmp
->lbearing
< 0)
24085 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24086 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24087 rightmost
-= cmp
->lbearing
;
24088 cmp
->rbearing
-= cmp
->lbearing
;
24091 if (right_padded
&& rightmost
< cmp
->rbearing
)
24093 rightmost
= cmp
->rbearing
;
24096 cmp
->pixel_width
= rightmost
;
24097 cmp
->ascent
= highest
;
24098 cmp
->descent
= - lowest
;
24099 if (cmp
->ascent
< font_ascent
)
24100 cmp
->ascent
= font_ascent
;
24101 if (cmp
->descent
< font_descent
)
24102 cmp
->descent
= font_descent
;
24106 && (cmp
->lbearing
< 0
24107 || cmp
->rbearing
> cmp
->pixel_width
))
24108 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24110 it
->pixel_width
= cmp
->pixel_width
;
24111 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24112 it
->descent
= it
->phys_descent
= cmp
->descent
;
24113 if (face
->box
!= FACE_NO_BOX
)
24115 int thick
= face
->box_line_width
;
24119 it
->ascent
+= thick
;
24120 it
->descent
+= thick
;
24125 if (it
->start_of_box_run_p
)
24126 it
->pixel_width
+= thick
;
24127 if (it
->end_of_box_run_p
)
24128 it
->pixel_width
+= thick
;
24131 /* If face has an overline, add the height of the overline
24132 (1 pixel) and a 1 pixel margin to the character height. */
24133 if (face
->overline_p
)
24134 it
->ascent
+= overline_margin
;
24136 take_vertical_position_into_account (it
);
24137 if (it
->ascent
< 0)
24139 if (it
->descent
< 0)
24143 append_composite_glyph (it
);
24145 else if (it
->what
== IT_COMPOSITION
)
24147 /* A dynamic (automatic) composition. */
24148 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24149 Lisp_Object gstring
;
24150 struct font_metrics metrics
;
24154 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24156 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24159 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24160 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24161 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24162 it
->descent
= it
->phys_descent
= metrics
.descent
;
24163 if (face
->box
!= FACE_NO_BOX
)
24165 int thick
= face
->box_line_width
;
24169 it
->ascent
+= thick
;
24170 it
->descent
+= thick
;
24175 if (it
->start_of_box_run_p
)
24176 it
->pixel_width
+= thick
;
24177 if (it
->end_of_box_run_p
)
24178 it
->pixel_width
+= thick
;
24180 /* If face has an overline, add the height of the overline
24181 (1 pixel) and a 1 pixel margin to the character height. */
24182 if (face
->overline_p
)
24183 it
->ascent
+= overline_margin
;
24184 take_vertical_position_into_account (it
);
24185 if (it
->ascent
< 0)
24187 if (it
->descent
< 0)
24191 append_composite_glyph (it
);
24193 else if (it
->what
== IT_GLYPHLESS
)
24194 produce_glyphless_glyph (it
, 0, Qnil
);
24195 else if (it
->what
== IT_IMAGE
)
24196 produce_image_glyph (it
);
24197 else if (it
->what
== IT_STRETCH
)
24198 produce_stretch_glyph (it
);
24201 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24202 because this isn't true for images with `:ascent 100'. */
24203 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24204 if (it
->area
== TEXT_AREA
)
24205 it
->current_x
+= it
->pixel_width
;
24207 if (extra_line_spacing
> 0)
24209 it
->descent
+= extra_line_spacing
;
24210 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24211 it
->max_extra_line_spacing
= extra_line_spacing
;
24214 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24215 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24216 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24217 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24221 Output LEN glyphs starting at START at the nominal cursor position.
24222 Advance the nominal cursor over the text. The global variable
24223 updated_window contains the window being updated, updated_row is
24224 the glyph row being updated, and updated_area is the area of that
24225 row being updated. */
24228 x_write_glyphs (struct glyph
*start
, int len
)
24232 xassert (updated_window
&& updated_row
);
24235 /* Write glyphs. */
24237 hpos
= start
- updated_row
->glyphs
[updated_area
];
24238 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24239 updated_row
, updated_area
,
24241 DRAW_NORMAL_TEXT
, 0);
24243 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24244 if (updated_area
== TEXT_AREA
24245 && updated_window
->phys_cursor_on_p
24246 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24247 && updated_window
->phys_cursor
.hpos
>= hpos
24248 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24249 updated_window
->phys_cursor_on_p
= 0;
24253 /* Advance the output cursor. */
24254 output_cursor
.hpos
+= len
;
24255 output_cursor
.x
= x
;
24260 Insert LEN glyphs from START at the nominal cursor position. */
24263 x_insert_glyphs (struct glyph
*start
, int len
)
24267 int line_height
, shift_by_width
, shifted_region_width
;
24268 struct glyph_row
*row
;
24269 struct glyph
*glyph
;
24270 int frame_x
, frame_y
;
24273 xassert (updated_window
&& updated_row
);
24275 w
= updated_window
;
24276 f
= XFRAME (WINDOW_FRAME (w
));
24278 /* Get the height of the line we are in. */
24280 line_height
= row
->height
;
24282 /* Get the width of the glyphs to insert. */
24283 shift_by_width
= 0;
24284 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24285 shift_by_width
+= glyph
->pixel_width
;
24287 /* Get the width of the region to shift right. */
24288 shifted_region_width
= (window_box_width (w
, updated_area
)
24293 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24294 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24296 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24297 line_height
, shift_by_width
);
24299 /* Write the glyphs. */
24300 hpos
= start
- row
->glyphs
[updated_area
];
24301 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24303 DRAW_NORMAL_TEXT
, 0);
24305 /* Advance the output cursor. */
24306 output_cursor
.hpos
+= len
;
24307 output_cursor
.x
+= shift_by_width
;
24313 Erase the current text line from the nominal cursor position
24314 (inclusive) to pixel column TO_X (exclusive). The idea is that
24315 everything from TO_X onward is already erased.
24317 TO_X is a pixel position relative to updated_area of
24318 updated_window. TO_X == -1 means clear to the end of this area. */
24321 x_clear_end_of_line (int to_x
)
24324 struct window
*w
= updated_window
;
24325 int max_x
, min_y
, max_y
;
24326 int from_x
, from_y
, to_y
;
24328 xassert (updated_window
&& updated_row
);
24329 f
= XFRAME (w
->frame
);
24331 if (updated_row
->full_width_p
)
24332 max_x
= WINDOW_TOTAL_WIDTH (w
);
24334 max_x
= window_box_width (w
, updated_area
);
24335 max_y
= window_text_bottom_y (w
);
24337 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24338 of window. For TO_X > 0, truncate to end of drawing area. */
24344 to_x
= min (to_x
, max_x
);
24346 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24348 /* Notice if the cursor will be cleared by this operation. */
24349 if (!updated_row
->full_width_p
)
24350 notice_overwritten_cursor (w
, updated_area
,
24351 output_cursor
.x
, -1,
24353 MATRIX_ROW_BOTTOM_Y (updated_row
));
24355 from_x
= output_cursor
.x
;
24357 /* Translate to frame coordinates. */
24358 if (updated_row
->full_width_p
)
24360 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24361 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24365 int area_left
= window_box_left (w
, updated_area
);
24366 from_x
+= area_left
;
24370 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24371 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24372 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24374 /* Prevent inadvertently clearing to end of the X window. */
24375 if (to_x
> from_x
&& to_y
> from_y
)
24378 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24379 to_x
- from_x
, to_y
- from_y
);
24384 #endif /* HAVE_WINDOW_SYSTEM */
24388 /***********************************************************************
24390 ***********************************************************************/
24392 /* Value is the internal representation of the specified cursor type
24393 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24394 of the bar cursor. */
24396 static enum text_cursor_kinds
24397 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24399 enum text_cursor_kinds type
;
24404 if (EQ (arg
, Qbox
))
24405 return FILLED_BOX_CURSOR
;
24407 if (EQ (arg
, Qhollow
))
24408 return HOLLOW_BOX_CURSOR
;
24410 if (EQ (arg
, Qbar
))
24417 && EQ (XCAR (arg
), Qbar
)
24418 && INTEGERP (XCDR (arg
))
24419 && XINT (XCDR (arg
)) >= 0)
24421 *width
= XINT (XCDR (arg
));
24425 if (EQ (arg
, Qhbar
))
24428 return HBAR_CURSOR
;
24432 && EQ (XCAR (arg
), Qhbar
)
24433 && INTEGERP (XCDR (arg
))
24434 && XINT (XCDR (arg
)) >= 0)
24436 *width
= XINT (XCDR (arg
));
24437 return HBAR_CURSOR
;
24440 /* Treat anything unknown as "hollow box cursor".
24441 It was bad to signal an error; people have trouble fixing
24442 .Xdefaults with Emacs, when it has something bad in it. */
24443 type
= HOLLOW_BOX_CURSOR
;
24448 /* Set the default cursor types for specified frame. */
24450 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24455 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24456 FRAME_CURSOR_WIDTH (f
) = width
;
24458 /* By default, set up the blink-off state depending on the on-state. */
24460 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24463 FRAME_BLINK_OFF_CURSOR (f
)
24464 = get_specified_cursor_type (XCDR (tem
), &width
);
24465 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24468 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24472 #ifdef HAVE_WINDOW_SYSTEM
24474 /* Return the cursor we want to be displayed in window W. Return
24475 width of bar/hbar cursor through WIDTH arg. Return with
24476 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24477 (i.e. if the `system caret' should track this cursor).
24479 In a mini-buffer window, we want the cursor only to appear if we
24480 are reading input from this window. For the selected window, we
24481 want the cursor type given by the frame parameter or buffer local
24482 setting of cursor-type. If explicitly marked off, draw no cursor.
24483 In all other cases, we want a hollow box cursor. */
24485 static enum text_cursor_kinds
24486 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24487 int *active_cursor
)
24489 struct frame
*f
= XFRAME (w
->frame
);
24490 struct buffer
*b
= XBUFFER (w
->buffer
);
24491 int cursor_type
= DEFAULT_CURSOR
;
24492 Lisp_Object alt_cursor
;
24493 int non_selected
= 0;
24495 *active_cursor
= 1;
24498 if (cursor_in_echo_area
24499 && FRAME_HAS_MINIBUF_P (f
)
24500 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24502 if (w
== XWINDOW (echo_area_window
))
24504 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24506 *width
= FRAME_CURSOR_WIDTH (f
);
24507 return FRAME_DESIRED_CURSOR (f
);
24510 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24513 *active_cursor
= 0;
24517 /* Detect a nonselected window or nonselected frame. */
24518 else if (w
!= XWINDOW (f
->selected_window
)
24519 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24521 *active_cursor
= 0;
24523 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24529 /* Never display a cursor in a window in which cursor-type is nil. */
24530 if (NILP (BVAR (b
, cursor_type
)))
24533 /* Get the normal cursor type for this window. */
24534 if (EQ (BVAR (b
, cursor_type
), Qt
))
24536 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24537 *width
= FRAME_CURSOR_WIDTH (f
);
24540 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24542 /* Use cursor-in-non-selected-windows instead
24543 for non-selected window or frame. */
24546 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24547 if (!EQ (Qt
, alt_cursor
))
24548 return get_specified_cursor_type (alt_cursor
, width
);
24549 /* t means modify the normal cursor type. */
24550 if (cursor_type
== FILLED_BOX_CURSOR
)
24551 cursor_type
= HOLLOW_BOX_CURSOR
;
24552 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24554 return cursor_type
;
24557 /* Use normal cursor if not blinked off. */
24558 if (!w
->cursor_off_p
)
24560 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24562 if (cursor_type
== FILLED_BOX_CURSOR
)
24564 /* Using a block cursor on large images can be very annoying.
24565 So use a hollow cursor for "large" images.
24566 If image is not transparent (no mask), also use hollow cursor. */
24567 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24568 if (img
!= NULL
&& IMAGEP (img
->spec
))
24570 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24571 where N = size of default frame font size.
24572 This should cover most of the "tiny" icons people may use. */
24574 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24575 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24576 cursor_type
= HOLLOW_BOX_CURSOR
;
24579 else if (cursor_type
!= NO_CURSOR
)
24581 /* Display current only supports BOX and HOLLOW cursors for images.
24582 So for now, unconditionally use a HOLLOW cursor when cursor is
24583 not a solid box cursor. */
24584 cursor_type
= HOLLOW_BOX_CURSOR
;
24587 return cursor_type
;
24590 /* Cursor is blinked off, so determine how to "toggle" it. */
24592 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24593 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24594 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24596 /* Then see if frame has specified a specific blink off cursor type. */
24597 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24599 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24600 return FRAME_BLINK_OFF_CURSOR (f
);
24604 /* Some people liked having a permanently visible blinking cursor,
24605 while others had very strong opinions against it. So it was
24606 decided to remove it. KFS 2003-09-03 */
24608 /* Finally perform built-in cursor blinking:
24609 filled box <-> hollow box
24610 wide [h]bar <-> narrow [h]bar
24611 narrow [h]bar <-> no cursor
24612 other type <-> no cursor */
24614 if (cursor_type
== FILLED_BOX_CURSOR
)
24615 return HOLLOW_BOX_CURSOR
;
24617 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24620 return cursor_type
;
24628 /* Notice when the text cursor of window W has been completely
24629 overwritten by a drawing operation that outputs glyphs in AREA
24630 starting at X0 and ending at X1 in the line starting at Y0 and
24631 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24632 the rest of the line after X0 has been written. Y coordinates
24633 are window-relative. */
24636 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24637 int x0
, int x1
, int y0
, int y1
)
24639 int cx0
, cx1
, cy0
, cy1
;
24640 struct glyph_row
*row
;
24642 if (!w
->phys_cursor_on_p
)
24644 if (area
!= TEXT_AREA
)
24647 if (w
->phys_cursor
.vpos
< 0
24648 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24649 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24650 !(row
->enabled_p
&& row
->displays_text_p
)))
24653 if (row
->cursor_in_fringe_p
)
24655 row
->cursor_in_fringe_p
= 0;
24656 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24657 w
->phys_cursor_on_p
= 0;
24661 cx0
= w
->phys_cursor
.x
;
24662 cx1
= cx0
+ w
->phys_cursor_width
;
24663 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24666 /* The cursor image will be completely removed from the
24667 screen if the output area intersects the cursor area in
24668 y-direction. When we draw in [y0 y1[, and some part of
24669 the cursor is at y < y0, that part must have been drawn
24670 before. When scrolling, the cursor is erased before
24671 actually scrolling, so we don't come here. When not
24672 scrolling, the rows above the old cursor row must have
24673 changed, and in this case these rows must have written
24674 over the cursor image.
24676 Likewise if part of the cursor is below y1, with the
24677 exception of the cursor being in the first blank row at
24678 the buffer and window end because update_text_area
24679 doesn't draw that row. (Except when it does, but
24680 that's handled in update_text_area.) */
24682 cy0
= w
->phys_cursor
.y
;
24683 cy1
= cy0
+ w
->phys_cursor_height
;
24684 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24687 w
->phys_cursor_on_p
= 0;
24690 #endif /* HAVE_WINDOW_SYSTEM */
24693 /************************************************************************
24695 ************************************************************************/
24697 #ifdef HAVE_WINDOW_SYSTEM
24700 Fix the display of area AREA of overlapping row ROW in window W
24701 with respect to the overlapping part OVERLAPS. */
24704 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24705 enum glyph_row_area area
, int overlaps
)
24712 for (i
= 0; i
< row
->used
[area
];)
24714 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24716 int start
= i
, start_x
= x
;
24720 x
+= row
->glyphs
[area
][i
].pixel_width
;
24723 while (i
< row
->used
[area
]
24724 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24726 draw_glyphs (w
, start_x
, row
, area
,
24728 DRAW_NORMAL_TEXT
, overlaps
);
24732 x
+= row
->glyphs
[area
][i
].pixel_width
;
24742 Draw the cursor glyph of window W in glyph row ROW. See the
24743 comment of draw_glyphs for the meaning of HL. */
24746 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24747 enum draw_glyphs_face hl
)
24749 /* If cursor hpos is out of bounds, don't draw garbage. This can
24750 happen in mini-buffer windows when switching between echo area
24751 glyphs and mini-buffer. */
24752 if ((row
->reversed_p
24753 ? (w
->phys_cursor
.hpos
>= 0)
24754 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24756 int on_p
= w
->phys_cursor_on_p
;
24758 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24759 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24761 w
->phys_cursor_on_p
= on_p
;
24763 if (hl
== DRAW_CURSOR
)
24764 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24765 /* When we erase the cursor, and ROW is overlapped by other
24766 rows, make sure that these overlapping parts of other rows
24768 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24770 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24772 if (row
> w
->current_matrix
->rows
24773 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24774 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24775 OVERLAPS_ERASED_CURSOR
);
24777 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24778 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24779 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24780 OVERLAPS_ERASED_CURSOR
);
24787 Erase the image of a cursor of window W from the screen. */
24790 erase_phys_cursor (struct window
*w
)
24792 struct frame
*f
= XFRAME (w
->frame
);
24793 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24794 int hpos
= w
->phys_cursor
.hpos
;
24795 int vpos
= w
->phys_cursor
.vpos
;
24796 int mouse_face_here_p
= 0;
24797 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24798 struct glyph_row
*cursor_row
;
24799 struct glyph
*cursor_glyph
;
24800 enum draw_glyphs_face hl
;
24802 /* No cursor displayed or row invalidated => nothing to do on the
24804 if (w
->phys_cursor_type
== NO_CURSOR
)
24805 goto mark_cursor_off
;
24807 /* VPOS >= active_glyphs->nrows means that window has been resized.
24808 Don't bother to erase the cursor. */
24809 if (vpos
>= active_glyphs
->nrows
)
24810 goto mark_cursor_off
;
24812 /* If row containing cursor is marked invalid, there is nothing we
24814 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24815 if (!cursor_row
->enabled_p
)
24816 goto mark_cursor_off
;
24818 /* If line spacing is > 0, old cursor may only be partially visible in
24819 window after split-window. So adjust visible height. */
24820 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24821 window_text_bottom_y (w
) - cursor_row
->y
);
24823 /* If row is completely invisible, don't attempt to delete a cursor which
24824 isn't there. This can happen if cursor is at top of a window, and
24825 we switch to a buffer with a header line in that window. */
24826 if (cursor_row
->visible_height
<= 0)
24827 goto mark_cursor_off
;
24829 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24830 if (cursor_row
->cursor_in_fringe_p
)
24832 cursor_row
->cursor_in_fringe_p
= 0;
24833 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24834 goto mark_cursor_off
;
24837 /* This can happen when the new row is shorter than the old one.
24838 In this case, either draw_glyphs or clear_end_of_line
24839 should have cleared the cursor. Note that we wouldn't be
24840 able to erase the cursor in this case because we don't have a
24841 cursor glyph at hand. */
24842 if ((cursor_row
->reversed_p
24843 ? (w
->phys_cursor
.hpos
< 0)
24844 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24845 goto mark_cursor_off
;
24847 /* If the cursor is in the mouse face area, redisplay that when
24848 we clear the cursor. */
24849 if (! NILP (hlinfo
->mouse_face_window
)
24850 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24851 /* Don't redraw the cursor's spot in mouse face if it is at the
24852 end of a line (on a newline). The cursor appears there, but
24853 mouse highlighting does not. */
24854 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24855 mouse_face_here_p
= 1;
24857 /* Maybe clear the display under the cursor. */
24858 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24861 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24864 cursor_glyph
= get_phys_cursor_glyph (w
);
24865 if (cursor_glyph
== NULL
)
24866 goto mark_cursor_off
;
24868 width
= cursor_glyph
->pixel_width
;
24869 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24870 x
= w
->phys_cursor
.x
;
24872 width
-= left_x
- x
;
24873 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24874 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24875 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24878 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24881 /* Erase the cursor by redrawing the character underneath it. */
24882 if (mouse_face_here_p
)
24883 hl
= DRAW_MOUSE_FACE
;
24885 hl
= DRAW_NORMAL_TEXT
;
24886 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24889 w
->phys_cursor_on_p
= 0;
24890 w
->phys_cursor_type
= NO_CURSOR
;
24895 Display or clear cursor of window W. If ON is zero, clear the
24896 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24897 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24900 display_and_set_cursor (struct window
*w
, int on
,
24901 int hpos
, int vpos
, int x
, int y
)
24903 struct frame
*f
= XFRAME (w
->frame
);
24904 int new_cursor_type
;
24905 int new_cursor_width
;
24907 struct glyph_row
*glyph_row
;
24908 struct glyph
*glyph
;
24910 /* This is pointless on invisible frames, and dangerous on garbaged
24911 windows and frames; in the latter case, the frame or window may
24912 be in the midst of changing its size, and x and y may be off the
24914 if (! FRAME_VISIBLE_P (f
)
24915 || FRAME_GARBAGED_P (f
)
24916 || vpos
>= w
->current_matrix
->nrows
24917 || hpos
>= w
->current_matrix
->matrix_w
)
24920 /* If cursor is off and we want it off, return quickly. */
24921 if (!on
&& !w
->phys_cursor_on_p
)
24924 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24925 /* If cursor row is not enabled, we don't really know where to
24926 display the cursor. */
24927 if (!glyph_row
->enabled_p
)
24929 w
->phys_cursor_on_p
= 0;
24934 if (!glyph_row
->exact_window_width_line_p
24935 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24936 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24938 xassert (interrupt_input_blocked
);
24940 /* Set new_cursor_type to the cursor we want to be displayed. */
24941 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24942 &new_cursor_width
, &active_cursor
);
24944 /* If cursor is currently being shown and we don't want it to be or
24945 it is in the wrong place, or the cursor type is not what we want,
24947 if (w
->phys_cursor_on_p
24949 || w
->phys_cursor
.x
!= x
24950 || w
->phys_cursor
.y
!= y
24951 || new_cursor_type
!= w
->phys_cursor_type
24952 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24953 && new_cursor_width
!= w
->phys_cursor_width
)))
24954 erase_phys_cursor (w
);
24956 /* Don't check phys_cursor_on_p here because that flag is only set
24957 to zero in some cases where we know that the cursor has been
24958 completely erased, to avoid the extra work of erasing the cursor
24959 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24960 still not be visible, or it has only been partly erased. */
24963 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24964 w
->phys_cursor_height
= glyph_row
->height
;
24966 /* Set phys_cursor_.* before x_draw_.* is called because some
24967 of them may need the information. */
24968 w
->phys_cursor
.x
= x
;
24969 w
->phys_cursor
.y
= glyph_row
->y
;
24970 w
->phys_cursor
.hpos
= hpos
;
24971 w
->phys_cursor
.vpos
= vpos
;
24974 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24975 new_cursor_type
, new_cursor_width
,
24976 on
, active_cursor
);
24980 /* Switch the display of W's cursor on or off, according to the value
24984 update_window_cursor (struct window
*w
, int on
)
24986 /* Don't update cursor in windows whose frame is in the process
24987 of being deleted. */
24988 if (w
->current_matrix
)
24991 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24992 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24998 /* Call update_window_cursor with parameter ON_P on all leaf windows
24999 in the window tree rooted at W. */
25002 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25006 if (!NILP (w
->hchild
))
25007 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25008 else if (!NILP (w
->vchild
))
25009 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25011 update_window_cursor (w
, on_p
);
25013 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25019 Display the cursor on window W, or clear it, according to ON_P.
25020 Don't change the cursor's position. */
25023 x_update_cursor (struct frame
*f
, int on_p
)
25025 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25030 Clear the cursor of window W to background color, and mark the
25031 cursor as not shown. This is used when the text where the cursor
25032 is about to be rewritten. */
25035 x_clear_cursor (struct window
*w
)
25037 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25038 update_window_cursor (w
, 0);
25041 #endif /* HAVE_WINDOW_SYSTEM */
25043 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25046 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25047 int start_hpos
, int end_hpos
,
25048 enum draw_glyphs_face draw
)
25050 #ifdef HAVE_WINDOW_SYSTEM
25051 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25053 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25057 #if defined (HAVE_GPM) || defined (MSDOS)
25058 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25062 /* Display the active region described by mouse_face_* according to DRAW. */
25065 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25067 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25068 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25070 if (/* If window is in the process of being destroyed, don't bother
25072 w
->current_matrix
!= NULL
25073 /* Don't update mouse highlight if hidden */
25074 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25075 /* Recognize when we are called to operate on rows that don't exist
25076 anymore. This can happen when a window is split. */
25077 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25079 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25080 struct glyph_row
*row
, *first
, *last
;
25082 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25083 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25085 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25087 int start_hpos
, end_hpos
, start_x
;
25089 /* For all but the first row, the highlight starts at column 0. */
25092 /* R2L rows have BEG and END in reversed order, but the
25093 screen drawing geometry is always left to right. So
25094 we need to mirror the beginning and end of the
25095 highlighted area in R2L rows. */
25096 if (!row
->reversed_p
)
25098 start_hpos
= hlinfo
->mouse_face_beg_col
;
25099 start_x
= hlinfo
->mouse_face_beg_x
;
25101 else if (row
== last
)
25103 start_hpos
= hlinfo
->mouse_face_end_col
;
25104 start_x
= hlinfo
->mouse_face_end_x
;
25112 else if (row
->reversed_p
&& row
== last
)
25114 start_hpos
= hlinfo
->mouse_face_end_col
;
25115 start_x
= hlinfo
->mouse_face_end_x
;
25125 if (!row
->reversed_p
)
25126 end_hpos
= hlinfo
->mouse_face_end_col
;
25127 else if (row
== first
)
25128 end_hpos
= hlinfo
->mouse_face_beg_col
;
25131 end_hpos
= row
->used
[TEXT_AREA
];
25132 if (draw
== DRAW_NORMAL_TEXT
)
25133 row
->fill_line_p
= 1; /* Clear to end of line */
25136 else if (row
->reversed_p
&& row
== first
)
25137 end_hpos
= hlinfo
->mouse_face_beg_col
;
25140 end_hpos
= row
->used
[TEXT_AREA
];
25141 if (draw
== DRAW_NORMAL_TEXT
)
25142 row
->fill_line_p
= 1; /* Clear to end of line */
25145 if (end_hpos
> start_hpos
)
25147 draw_row_with_mouse_face (w
, start_x
, row
,
25148 start_hpos
, end_hpos
, draw
);
25151 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25155 #ifdef HAVE_WINDOW_SYSTEM
25156 /* When we've written over the cursor, arrange for it to
25157 be displayed again. */
25158 if (FRAME_WINDOW_P (f
)
25159 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25162 display_and_set_cursor (w
, 1,
25163 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25164 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25167 #endif /* HAVE_WINDOW_SYSTEM */
25170 #ifdef HAVE_WINDOW_SYSTEM
25171 /* Change the mouse cursor. */
25172 if (FRAME_WINDOW_P (f
))
25174 if (draw
== DRAW_NORMAL_TEXT
25175 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25176 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25177 else if (draw
== DRAW_MOUSE_FACE
)
25178 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25180 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25182 #endif /* HAVE_WINDOW_SYSTEM */
25186 Clear out the mouse-highlighted active region.
25187 Redraw it un-highlighted first. Value is non-zero if mouse
25188 face was actually drawn unhighlighted. */
25191 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25195 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25197 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25201 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25202 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25203 hlinfo
->mouse_face_window
= Qnil
;
25204 hlinfo
->mouse_face_overlay
= Qnil
;
25208 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25209 within the mouse face on that window. */
25211 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25213 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25215 /* Quickly resolve the easy cases. */
25216 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25217 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25219 if (vpos
< hlinfo
->mouse_face_beg_row
25220 || vpos
> hlinfo
->mouse_face_end_row
)
25222 if (vpos
> hlinfo
->mouse_face_beg_row
25223 && vpos
< hlinfo
->mouse_face_end_row
)
25226 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25228 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25230 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25233 else if ((vpos
== hlinfo
->mouse_face_beg_row
25234 && hpos
>= hlinfo
->mouse_face_beg_col
)
25235 || (vpos
== hlinfo
->mouse_face_end_row
25236 && hpos
< hlinfo
->mouse_face_end_col
))
25241 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25243 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25246 else if ((vpos
== hlinfo
->mouse_face_beg_row
25247 && hpos
<= hlinfo
->mouse_face_beg_col
)
25248 || (vpos
== hlinfo
->mouse_face_end_row
25249 && hpos
> hlinfo
->mouse_face_end_col
))
25257 Non-zero if physical cursor of window W is within mouse face. */
25260 cursor_in_mouse_face_p (struct window
*w
)
25262 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25267 /* Find the glyph rows START_ROW and END_ROW of window W that display
25268 characters between buffer positions START_CHARPOS and END_CHARPOS
25269 (excluding END_CHARPOS). This is similar to row_containing_pos,
25270 but is more accurate when bidi reordering makes buffer positions
25271 change non-linearly with glyph rows. */
25273 rows_from_pos_range (struct window
*w
,
25274 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25275 struct glyph_row
**start
, struct glyph_row
**end
)
25277 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25278 int last_y
= window_text_bottom_y (w
);
25279 struct glyph_row
*row
;
25284 while (!first
->enabled_p
25285 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25288 /* Find the START row. */
25290 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25293 /* A row can potentially be the START row if the range of the
25294 characters it displays intersects the range
25295 [START_CHARPOS..END_CHARPOS). */
25296 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25297 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25298 /* See the commentary in row_containing_pos, for the
25299 explanation of the complicated way to check whether
25300 some position is beyond the end of the characters
25301 displayed by a row. */
25302 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25303 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25304 && !row
->ends_at_zv_p
25305 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25306 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25307 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25308 && !row
->ends_at_zv_p
25309 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25311 /* Found a candidate row. Now make sure at least one of the
25312 glyphs it displays has a charpos from the range
25313 [START_CHARPOS..END_CHARPOS).
25315 This is not obvious because bidi reordering could make
25316 buffer positions of a row be 1,2,3,102,101,100, and if we
25317 want to highlight characters in [50..60), we don't want
25318 this row, even though [50..60) does intersect [1..103),
25319 the range of character positions given by the row's start
25320 and end positions. */
25321 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25322 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25326 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25327 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25336 /* Find the END row. */
25338 /* If the last row is partially visible, start looking for END
25339 from that row, instead of starting from FIRST. */
25340 && !(row
->enabled_p
25341 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25343 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25345 struct glyph_row
*next
= row
+ 1;
25347 if (!next
->enabled_p
25348 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25349 /* The first row >= START whose range of displayed characters
25350 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25351 is the row END + 1. */
25352 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25353 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25354 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25355 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25356 && !next
->ends_at_zv_p
25357 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25358 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25359 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25360 && !next
->ends_at_zv_p
25361 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25368 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25369 but none of the characters it displays are in the range, it is
25371 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25372 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25376 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25377 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25390 /* This function sets the mouse_face_* elements of HLINFO, assuming
25391 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25392 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25393 for the overlay or run of text properties specifying the mouse
25394 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25395 before-string and after-string that must also be highlighted.
25396 COVER_STRING, if non-nil, is a display string that may cover some
25397 or all of the highlighted text. */
25400 mouse_face_from_buffer_pos (Lisp_Object window
,
25401 Mouse_HLInfo
*hlinfo
,
25402 EMACS_INT mouse_charpos
,
25403 EMACS_INT start_charpos
,
25404 EMACS_INT end_charpos
,
25405 Lisp_Object before_string
,
25406 Lisp_Object after_string
,
25407 Lisp_Object cover_string
)
25409 struct window
*w
= XWINDOW (window
);
25410 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25411 struct glyph_row
*r1
, *r2
;
25412 struct glyph
*glyph
, *end
;
25413 EMACS_INT ignore
, pos
;
25416 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25417 xassert (NILP (before_string
) || STRINGP (before_string
));
25418 xassert (NILP (after_string
) || STRINGP (after_string
));
25420 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25421 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25423 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25424 /* If the before-string or display-string contains newlines,
25425 rows_from_pos_range skips to its last row. Move back. */
25426 if (!NILP (before_string
) || !NILP (cover_string
))
25428 struct glyph_row
*prev
;
25429 while ((prev
= r1
- 1, prev
>= first
)
25430 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25431 && prev
->used
[TEXT_AREA
] > 0)
25433 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25434 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25435 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25437 || !(EQ (glyph
->object
, before_string
)
25438 || EQ (glyph
->object
, cover_string
)))
25445 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25446 hlinfo
->mouse_face_past_end
= 1;
25448 else if (!NILP (after_string
))
25450 /* If the after-string has newlines, advance to its last row. */
25451 struct glyph_row
*next
;
25452 struct glyph_row
*last
25453 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25455 for (next
= r2
+ 1;
25457 && next
->used
[TEXT_AREA
] > 0
25458 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25462 /* The rest of the display engine assumes that mouse_face_beg_row is
25463 either above below mouse_face_end_row or identical to it. But
25464 with bidi-reordered continued lines, the row for START_CHARPOS
25465 could be below the row for END_CHARPOS. If so, swap the rows and
25466 store them in correct order. */
25469 struct glyph_row
*tem
= r2
;
25475 hlinfo
->mouse_face_beg_y
= r1
->y
;
25476 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25477 hlinfo
->mouse_face_end_y
= r2
->y
;
25478 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25480 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25481 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25482 could be anywhere in the row and in any order. The strategy
25483 below is to find the leftmost and the rightmost glyph that
25484 belongs to either of these 3 strings, or whose position is
25485 between START_CHARPOS and END_CHARPOS, and highlight all the
25486 glyphs between those two. This may cover more than just the text
25487 between START_CHARPOS and END_CHARPOS if the range of characters
25488 strides the bidi level boundary, e.g. if the beginning is in R2L
25489 text while the end is in L2R text or vice versa. */
25490 if (!r1
->reversed_p
)
25492 /* This row is in a left to right paragraph. Scan it left to
25494 glyph
= r1
->glyphs
[TEXT_AREA
];
25495 end
= glyph
+ r1
->used
[TEXT_AREA
];
25498 /* Skip truncation glyphs at the start of the glyph row. */
25499 if (r1
->displays_text_p
)
25501 && INTEGERP (glyph
->object
)
25502 && glyph
->charpos
< 0;
25504 x
+= glyph
->pixel_width
;
25506 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25507 or COVER_STRING, and the first glyph from buffer whose
25508 position is between START_CHARPOS and END_CHARPOS. */
25510 && !INTEGERP (glyph
->object
)
25511 && !EQ (glyph
->object
, cover_string
)
25512 && !(BUFFERP (glyph
->object
)
25513 && (glyph
->charpos
>= start_charpos
25514 && glyph
->charpos
< end_charpos
));
25517 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25518 are present at buffer positions between START_CHARPOS and
25519 END_CHARPOS, or if they come from an overlay. */
25520 if (EQ (glyph
->object
, before_string
))
25522 pos
= string_buffer_position (before_string
,
25524 /* If pos == 0, it means before_string came from an
25525 overlay, not from a buffer position. */
25526 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25529 else if (EQ (glyph
->object
, after_string
))
25531 pos
= string_buffer_position (after_string
, end_charpos
);
25532 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25535 x
+= glyph
->pixel_width
;
25537 hlinfo
->mouse_face_beg_x
= x
;
25538 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25542 /* This row is in a right to left paragraph. Scan it right to
25546 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25547 glyph
= end
+ r1
->used
[TEXT_AREA
];
25549 /* Skip truncation glyphs at the start of the glyph row. */
25550 if (r1
->displays_text_p
)
25552 && INTEGERP (glyph
->object
)
25553 && glyph
->charpos
< 0;
25557 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25558 or COVER_STRING, and the first glyph from buffer whose
25559 position is between START_CHARPOS and END_CHARPOS. */
25561 && !INTEGERP (glyph
->object
)
25562 && !EQ (glyph
->object
, cover_string
)
25563 && !(BUFFERP (glyph
->object
)
25564 && (glyph
->charpos
>= start_charpos
25565 && glyph
->charpos
< end_charpos
));
25568 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25569 are present at buffer positions between START_CHARPOS and
25570 END_CHARPOS, or if they come from an overlay. */
25571 if (EQ (glyph
->object
, before_string
))
25573 pos
= string_buffer_position (before_string
, start_charpos
);
25574 /* If pos == 0, it means before_string came from an
25575 overlay, not from a buffer position. */
25576 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25579 else if (EQ (glyph
->object
, after_string
))
25581 pos
= string_buffer_position (after_string
, end_charpos
);
25582 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25587 glyph
++; /* first glyph to the right of the highlighted area */
25588 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25589 x
+= g
->pixel_width
;
25590 hlinfo
->mouse_face_beg_x
= x
;
25591 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25594 /* If the highlight ends in a different row, compute GLYPH and END
25595 for the end row. Otherwise, reuse the values computed above for
25596 the row where the highlight begins. */
25599 if (!r2
->reversed_p
)
25601 glyph
= r2
->glyphs
[TEXT_AREA
];
25602 end
= glyph
+ r2
->used
[TEXT_AREA
];
25607 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25608 glyph
= end
+ r2
->used
[TEXT_AREA
];
25612 if (!r2
->reversed_p
)
25614 /* Skip truncation and continuation glyphs near the end of the
25615 row, and also blanks and stretch glyphs inserted by
25616 extend_face_to_end_of_line. */
25618 && INTEGERP ((end
- 1)->object
)
25619 && (end
- 1)->charpos
<= 0)
25621 /* Scan the rest of the glyph row from the end, looking for the
25622 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25623 COVER_STRING, or whose position is between START_CHARPOS
25627 && !INTEGERP (end
->object
)
25628 && !EQ (end
->object
, cover_string
)
25629 && !(BUFFERP (end
->object
)
25630 && (end
->charpos
>= start_charpos
25631 && end
->charpos
< end_charpos
));
25634 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25635 are present at buffer positions between START_CHARPOS and
25636 END_CHARPOS, or if they come from an overlay. */
25637 if (EQ (end
->object
, before_string
))
25639 pos
= string_buffer_position (before_string
, start_charpos
);
25640 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25643 else if (EQ (end
->object
, after_string
))
25645 pos
= string_buffer_position (after_string
, end_charpos
);
25646 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25650 /* Find the X coordinate of the last glyph to be highlighted. */
25651 for (; glyph
<= end
; ++glyph
)
25652 x
+= glyph
->pixel_width
;
25654 hlinfo
->mouse_face_end_x
= x
;
25655 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25659 /* Skip truncation and continuation glyphs near the end of the
25660 row, and also blanks and stretch glyphs inserted by
25661 extend_face_to_end_of_line. */
25665 && INTEGERP (end
->object
)
25666 && end
->charpos
<= 0)
25668 x
+= end
->pixel_width
;
25671 /* Scan the rest of the glyph row from the end, looking for the
25672 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25673 COVER_STRING, or whose position is between START_CHARPOS
25677 && !INTEGERP (end
->object
)
25678 && !EQ (end
->object
, cover_string
)
25679 && !(BUFFERP (end
->object
)
25680 && (end
->charpos
>= start_charpos
25681 && end
->charpos
< end_charpos
));
25684 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25685 are present at buffer positions between START_CHARPOS and
25686 END_CHARPOS, or if they come from an overlay. */
25687 if (EQ (end
->object
, before_string
))
25689 pos
= string_buffer_position (before_string
, start_charpos
);
25690 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25693 else if (EQ (end
->object
, after_string
))
25695 pos
= string_buffer_position (after_string
, end_charpos
);
25696 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25699 x
+= end
->pixel_width
;
25701 hlinfo
->mouse_face_end_x
= x
;
25702 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25705 hlinfo
->mouse_face_window
= window
;
25706 hlinfo
->mouse_face_face_id
25707 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25709 !hlinfo
->mouse_face_hidden
, -1);
25710 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25713 /* The following function is not used anymore (replaced with
25714 mouse_face_from_string_pos), but I leave it here for the time
25715 being, in case someone would. */
25717 #if 0 /* not used */
25719 /* Find the position of the glyph for position POS in OBJECT in
25720 window W's current matrix, and return in *X, *Y the pixel
25721 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25723 RIGHT_P non-zero means return the position of the right edge of the
25724 glyph, RIGHT_P zero means return the left edge position.
25726 If no glyph for POS exists in the matrix, return the position of
25727 the glyph with the next smaller position that is in the matrix, if
25728 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25729 exists in the matrix, return the position of the glyph with the
25730 next larger position in OBJECT.
25732 Value is non-zero if a glyph was found. */
25735 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25736 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25738 int yb
= window_text_bottom_y (w
);
25739 struct glyph_row
*r
;
25740 struct glyph
*best_glyph
= NULL
;
25741 struct glyph_row
*best_row
= NULL
;
25744 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25745 r
->enabled_p
&& r
->y
< yb
;
25748 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25749 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25752 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25753 if (EQ (g
->object
, object
))
25755 if (g
->charpos
== pos
)
25762 else if (best_glyph
== NULL
25763 || ((eabs (g
->charpos
- pos
)
25764 < eabs (best_glyph
->charpos
- pos
))
25767 : g
->charpos
> pos
)))
25781 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25785 *x
+= best_glyph
->pixel_width
;
25790 *vpos
= best_row
- w
->current_matrix
->rows
;
25793 return best_glyph
!= NULL
;
25795 #endif /* not used */
25797 /* Find the positions of the first and the last glyphs in window W's
25798 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25799 (assumed to be a string), and return in HLINFO's mouse_face_*
25800 members the pixel and column/row coordinates of those glyphs. */
25803 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25804 Lisp_Object object
,
25805 EMACS_INT startpos
, EMACS_INT endpos
)
25807 int yb
= window_text_bottom_y (w
);
25808 struct glyph_row
*r
;
25809 struct glyph
*g
, *e
;
25813 /* Find the glyph row with at least one position in the range
25814 [STARTPOS..ENDPOS], and the first glyph in that row whose
25815 position belongs to that range. */
25816 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25817 r
->enabled_p
&& r
->y
< yb
;
25820 if (!r
->reversed_p
)
25822 g
= r
->glyphs
[TEXT_AREA
];
25823 e
= g
+ r
->used
[TEXT_AREA
];
25824 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25825 if (EQ (g
->object
, object
)
25826 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25828 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25829 hlinfo
->mouse_face_beg_y
= r
->y
;
25830 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25831 hlinfo
->mouse_face_beg_x
= gx
;
25840 e
= r
->glyphs
[TEXT_AREA
];
25841 g
= e
+ r
->used
[TEXT_AREA
];
25842 for ( ; g
> e
; --g
)
25843 if (EQ ((g
-1)->object
, object
)
25844 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25846 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25847 hlinfo
->mouse_face_beg_y
= r
->y
;
25848 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25849 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25850 gx
+= g1
->pixel_width
;
25851 hlinfo
->mouse_face_beg_x
= gx
;
25863 /* Starting with the next row, look for the first row which does NOT
25864 include any glyphs whose positions are in the range. */
25865 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25867 g
= r
->glyphs
[TEXT_AREA
];
25868 e
= g
+ r
->used
[TEXT_AREA
];
25870 for ( ; g
< e
; ++g
)
25871 if (EQ (g
->object
, object
)
25872 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25881 /* The highlighted region ends on the previous row. */
25884 /* Set the end row and its vertical pixel coordinate. */
25885 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25886 hlinfo
->mouse_face_end_y
= r
->y
;
25888 /* Compute and set the end column and the end column's horizontal
25889 pixel coordinate. */
25890 if (!r
->reversed_p
)
25892 g
= r
->glyphs
[TEXT_AREA
];
25893 e
= g
+ r
->used
[TEXT_AREA
];
25894 for ( ; e
> g
; --e
)
25895 if (EQ ((e
-1)->object
, object
)
25896 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25898 hlinfo
->mouse_face_end_col
= e
- g
;
25900 for (gx
= r
->x
; g
< e
; ++g
)
25901 gx
+= g
->pixel_width
;
25902 hlinfo
->mouse_face_end_x
= gx
;
25906 e
= r
->glyphs
[TEXT_AREA
];
25907 g
= e
+ r
->used
[TEXT_AREA
];
25908 for (gx
= r
->x
; e
< g
; ++e
)
25910 if (EQ (e
->object
, object
)
25911 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25913 gx
+= e
->pixel_width
;
25915 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25916 hlinfo
->mouse_face_end_x
= gx
;
25920 #ifdef HAVE_WINDOW_SYSTEM
25922 /* See if position X, Y is within a hot-spot of an image. */
25925 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25927 if (!CONSP (hot_spot
))
25930 if (EQ (XCAR (hot_spot
), Qrect
))
25932 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25933 Lisp_Object rect
= XCDR (hot_spot
);
25937 if (!CONSP (XCAR (rect
)))
25939 if (!CONSP (XCDR (rect
)))
25941 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25943 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25945 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25947 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25951 else if (EQ (XCAR (hot_spot
), Qcircle
))
25953 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25954 Lisp_Object circ
= XCDR (hot_spot
);
25955 Lisp_Object lr
, lx0
, ly0
;
25957 && CONSP (XCAR (circ
))
25958 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25959 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25960 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25962 double r
= XFLOATINT (lr
);
25963 double dx
= XINT (lx0
) - x
;
25964 double dy
= XINT (ly0
) - y
;
25965 return (dx
* dx
+ dy
* dy
<= r
* r
);
25968 else if (EQ (XCAR (hot_spot
), Qpoly
))
25970 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25971 if (VECTORP (XCDR (hot_spot
)))
25973 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25974 Lisp_Object
*poly
= v
->contents
;
25975 int n
= v
->header
.size
;
25978 Lisp_Object lx
, ly
;
25981 /* Need an even number of coordinates, and at least 3 edges. */
25982 if (n
< 6 || n
& 1)
25985 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25986 If count is odd, we are inside polygon. Pixels on edges
25987 may or may not be included depending on actual geometry of the
25989 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25990 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25992 x0
= XINT (lx
), y0
= XINT (ly
);
25993 for (i
= 0; i
< n
; i
+= 2)
25995 int x1
= x0
, y1
= y0
;
25996 if ((lx
= poly
[i
], !INTEGERP (lx
))
25997 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25999 x0
= XINT (lx
), y0
= XINT (ly
);
26001 /* Does this segment cross the X line? */
26009 if (y
> y0
&& y
> y1
)
26011 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26021 find_hot_spot (Lisp_Object map
, int x
, int y
)
26023 while (CONSP (map
))
26025 if (CONSP (XCAR (map
))
26026 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26034 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26036 doc
: /* Lookup in image map MAP coordinates X and Y.
26037 An image map is an alist where each element has the format (AREA ID PLIST).
26038 An AREA is specified as either a rectangle, a circle, or a polygon:
26039 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26040 pixel coordinates of the upper left and bottom right corners.
26041 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26042 and the radius of the circle; r may be a float or integer.
26043 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26044 vector describes one corner in the polygon.
26045 Returns the alist element for the first matching AREA in MAP. */)
26046 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26054 return find_hot_spot (map
, XINT (x
), XINT (y
));
26058 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26060 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26062 /* Do not change cursor shape while dragging mouse. */
26063 if (!NILP (do_mouse_tracking
))
26066 if (!NILP (pointer
))
26068 if (EQ (pointer
, Qarrow
))
26069 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26070 else if (EQ (pointer
, Qhand
))
26071 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26072 else if (EQ (pointer
, Qtext
))
26073 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26074 else if (EQ (pointer
, intern ("hdrag")))
26075 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26076 #ifdef HAVE_X_WINDOWS
26077 else if (EQ (pointer
, intern ("vdrag")))
26078 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26080 else if (EQ (pointer
, intern ("hourglass")))
26081 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26082 else if (EQ (pointer
, Qmodeline
))
26083 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26085 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26088 if (cursor
!= No_Cursor
)
26089 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26092 #endif /* HAVE_WINDOW_SYSTEM */
26094 /* Take proper action when mouse has moved to the mode or header line
26095 or marginal area AREA of window W, x-position X and y-position Y.
26096 X is relative to the start of the text display area of W, so the
26097 width of bitmap areas and scroll bars must be subtracted to get a
26098 position relative to the start of the mode line. */
26101 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26102 enum window_part area
)
26104 struct window
*w
= XWINDOW (window
);
26105 struct frame
*f
= XFRAME (w
->frame
);
26106 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26107 #ifdef HAVE_WINDOW_SYSTEM
26108 Display_Info
*dpyinfo
;
26110 Cursor cursor
= No_Cursor
;
26111 Lisp_Object pointer
= Qnil
;
26112 int dx
, dy
, width
, height
;
26114 Lisp_Object string
, object
= Qnil
;
26115 Lisp_Object pos
, help
;
26117 Lisp_Object mouse_face
;
26118 int original_x_pixel
= x
;
26119 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26120 struct glyph_row
*row
;
26122 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26127 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26128 returns them in row/column units! */
26129 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26130 &object
, &dx
, &dy
, &width
, &height
);
26132 row
= (area
== ON_MODE_LINE
26133 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26134 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26136 /* Find the glyph under the mouse pointer. */
26137 if (row
->mode_line_p
&& row
->enabled_p
)
26139 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26140 end
= glyph
+ row
->used
[TEXT_AREA
];
26142 for (x0
= original_x_pixel
;
26143 glyph
< end
&& x0
>= glyph
->pixel_width
;
26145 x0
-= glyph
->pixel_width
;
26153 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26154 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26155 returns them in row/column units! */
26156 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26157 &object
, &dx
, &dy
, &width
, &height
);
26162 #ifdef HAVE_WINDOW_SYSTEM
26163 if (IMAGEP (object
))
26165 Lisp_Object image_map
, hotspot
;
26166 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26168 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26170 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26174 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26175 If so, we could look for mouse-enter, mouse-leave
26176 properties in PLIST (and do something...). */
26177 hotspot
= XCDR (hotspot
);
26178 if (CONSP (hotspot
)
26179 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26181 pointer
= Fplist_get (plist
, Qpointer
);
26182 if (NILP (pointer
))
26184 help
= Fplist_get (plist
, Qhelp_echo
);
26187 help_echo_string
= help
;
26188 /* Is this correct? ++kfs */
26189 XSETWINDOW (help_echo_window
, w
);
26190 help_echo_object
= w
->buffer
;
26191 help_echo_pos
= charpos
;
26195 if (NILP (pointer
))
26196 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26198 #endif /* HAVE_WINDOW_SYSTEM */
26200 if (STRINGP (string
))
26202 pos
= make_number (charpos
);
26203 /* If we're on a string with `help-echo' text property, arrange
26204 for the help to be displayed. This is done by setting the
26205 global variable help_echo_string to the help string. */
26208 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26211 help_echo_string
= help
;
26212 XSETWINDOW (help_echo_window
, w
);
26213 help_echo_object
= string
;
26214 help_echo_pos
= charpos
;
26218 #ifdef HAVE_WINDOW_SYSTEM
26219 if (FRAME_WINDOW_P (f
))
26221 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26222 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26223 if (NILP (pointer
))
26224 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26226 /* Change the mouse pointer according to what is under X/Y. */
26228 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26231 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26232 if (!KEYMAPP (map
))
26233 map
= Fget_text_property (pos
, Qkeymap
, string
);
26234 if (!KEYMAPP (map
))
26235 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26240 /* Change the mouse face according to what is under X/Y. */
26241 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26242 if (!NILP (mouse_face
)
26243 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26248 struct glyph
* tmp_glyph
;
26252 int total_pixel_width
;
26253 EMACS_INT begpos
, endpos
, ignore
;
26257 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26258 Qmouse_face
, string
, Qnil
);
26264 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26266 endpos
= SCHARS (string
);
26270 /* Calculate the glyph position GPOS of GLYPH in the
26271 displayed string, relative to the beginning of the
26272 highlighted part of the string.
26274 Note: GPOS is different from CHARPOS. CHARPOS is the
26275 position of GLYPH in the internal string object. A mode
26276 line string format has structures which are converted to
26277 a flattened string by the Emacs Lisp interpreter. The
26278 internal string is an element of those structures. The
26279 displayed string is the flattened string. */
26280 tmp_glyph
= row_start_glyph
;
26281 while (tmp_glyph
< glyph
26282 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26283 && begpos
<= tmp_glyph
->charpos
26284 && tmp_glyph
->charpos
< endpos
)))
26286 gpos
= glyph
- tmp_glyph
;
26288 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26289 the highlighted part of the displayed string to which
26290 GLYPH belongs. Note: GSEQ_LENGTH is different from
26291 SCHARS (STRING), because the latter returns the length of
26292 the internal string. */
26293 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26295 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26296 && begpos
<= tmp_glyph
->charpos
26297 && tmp_glyph
->charpos
< endpos
));
26300 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26302 /* Calculate the total pixel width of all the glyphs between
26303 the beginning of the highlighted area and GLYPH. */
26304 total_pixel_width
= 0;
26305 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26306 total_pixel_width
+= tmp_glyph
->pixel_width
;
26308 /* Pre calculation of re-rendering position. Note: X is in
26309 column units here, after the call to mode_line_string or
26310 marginal_area_string. */
26312 vpos
= (area
== ON_MODE_LINE
26313 ? (w
->current_matrix
)->nrows
- 1
26316 /* If GLYPH's position is included in the region that is
26317 already drawn in mouse face, we have nothing to do. */
26318 if ( EQ (window
, hlinfo
->mouse_face_window
)
26319 && (!row
->reversed_p
26320 ? (hlinfo
->mouse_face_beg_col
<= hpos
26321 && hpos
< hlinfo
->mouse_face_end_col
)
26322 /* In R2L rows we swap BEG and END, see below. */
26323 : (hlinfo
->mouse_face_end_col
<= hpos
26324 && hpos
< hlinfo
->mouse_face_beg_col
))
26325 && hlinfo
->mouse_face_beg_row
== vpos
)
26328 if (clear_mouse_face (hlinfo
))
26329 cursor
= No_Cursor
;
26331 if (!row
->reversed_p
)
26333 hlinfo
->mouse_face_beg_col
= hpos
;
26334 hlinfo
->mouse_face_beg_x
= original_x_pixel
26335 - (total_pixel_width
+ dx
);
26336 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26337 hlinfo
->mouse_face_end_x
= 0;
26341 /* In R2L rows, show_mouse_face expects BEG and END
26342 coordinates to be swapped. */
26343 hlinfo
->mouse_face_end_col
= hpos
;
26344 hlinfo
->mouse_face_end_x
= original_x_pixel
26345 - (total_pixel_width
+ dx
);
26346 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26347 hlinfo
->mouse_face_beg_x
= 0;
26350 hlinfo
->mouse_face_beg_row
= vpos
;
26351 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26352 hlinfo
->mouse_face_beg_y
= 0;
26353 hlinfo
->mouse_face_end_y
= 0;
26354 hlinfo
->mouse_face_past_end
= 0;
26355 hlinfo
->mouse_face_window
= window
;
26357 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26363 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26365 if (NILP (pointer
))
26368 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26369 clear_mouse_face (hlinfo
);
26371 #ifdef HAVE_WINDOW_SYSTEM
26372 if (FRAME_WINDOW_P (f
))
26373 define_frame_cursor1 (f
, cursor
, pointer
);
26379 Take proper action when the mouse has moved to position X, Y on
26380 frame F as regards highlighting characters that have mouse-face
26381 properties. Also de-highlighting chars where the mouse was before.
26382 X and Y can be negative or out of range. */
26385 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26387 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26388 enum window_part part
;
26389 Lisp_Object window
;
26391 Cursor cursor
= No_Cursor
;
26392 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26395 /* When a menu is active, don't highlight because this looks odd. */
26396 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26397 if (popup_activated ())
26401 if (NILP (Vmouse_highlight
)
26402 || !f
->glyphs_initialized_p
26403 || f
->pointer_invisible
)
26406 hlinfo
->mouse_face_mouse_x
= x
;
26407 hlinfo
->mouse_face_mouse_y
= y
;
26408 hlinfo
->mouse_face_mouse_frame
= f
;
26410 if (hlinfo
->mouse_face_defer
)
26413 if (gc_in_progress
)
26415 hlinfo
->mouse_face_deferred_gc
= 1;
26419 /* Which window is that in? */
26420 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26422 /* If we were displaying active text in another window, clear that.
26423 Also clear if we move out of text area in same window. */
26424 if (! EQ (window
, hlinfo
->mouse_face_window
)
26425 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26426 && !NILP (hlinfo
->mouse_face_window
)))
26427 clear_mouse_face (hlinfo
);
26429 /* Not on a window -> return. */
26430 if (!WINDOWP (window
))
26433 /* Reset help_echo_string. It will get recomputed below. */
26434 help_echo_string
= Qnil
;
26436 /* Convert to window-relative pixel coordinates. */
26437 w
= XWINDOW (window
);
26438 frame_to_window_pixel_xy (w
, &x
, &y
);
26440 #ifdef HAVE_WINDOW_SYSTEM
26441 /* Handle tool-bar window differently since it doesn't display a
26443 if (EQ (window
, f
->tool_bar_window
))
26445 note_tool_bar_highlight (f
, x
, y
);
26450 /* Mouse is on the mode, header line or margin? */
26451 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26452 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26454 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26458 #ifdef HAVE_WINDOW_SYSTEM
26459 if (part
== ON_VERTICAL_BORDER
)
26461 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26462 help_echo_string
= build_string ("drag-mouse-1: resize");
26464 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26465 || part
== ON_SCROLL_BAR
)
26466 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26468 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26471 /* Are we in a window whose display is up to date?
26472 And verify the buffer's text has not changed. */
26473 b
= XBUFFER (w
->buffer
);
26474 if (part
== ON_TEXT
26475 && EQ (w
->window_end_valid
, w
->buffer
)
26476 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26477 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26479 int hpos
, vpos
, dx
, dy
, area
;
26481 struct glyph
*glyph
;
26482 Lisp_Object object
;
26483 Lisp_Object mouse_face
= Qnil
, position
;
26484 Lisp_Object
*overlay_vec
= NULL
;
26485 ptrdiff_t i
, noverlays
;
26486 struct buffer
*obuf
;
26487 EMACS_INT obegv
, ozv
;
26490 /* Find the glyph under X/Y. */
26491 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26493 #ifdef HAVE_WINDOW_SYSTEM
26494 /* Look for :pointer property on image. */
26495 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26497 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26498 if (img
!= NULL
&& IMAGEP (img
->spec
))
26500 Lisp_Object image_map
, hotspot
;
26501 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26503 && (hotspot
= find_hot_spot (image_map
,
26504 glyph
->slice
.img
.x
+ dx
,
26505 glyph
->slice
.img
.y
+ dy
),
26507 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26511 /* Could check XCAR (hotspot) to see if we enter/leave
26513 If so, we could look for mouse-enter, mouse-leave
26514 properties in PLIST (and do something...). */
26515 hotspot
= XCDR (hotspot
);
26516 if (CONSP (hotspot
)
26517 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26519 pointer
= Fplist_get (plist
, Qpointer
);
26520 if (NILP (pointer
))
26522 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26523 if (!NILP (help_echo_string
))
26525 help_echo_window
= window
;
26526 help_echo_object
= glyph
->object
;
26527 help_echo_pos
= glyph
->charpos
;
26531 if (NILP (pointer
))
26532 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26535 #endif /* HAVE_WINDOW_SYSTEM */
26537 /* Clear mouse face if X/Y not over text. */
26539 || area
!= TEXT_AREA
26540 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26541 /* Glyph's OBJECT is an integer for glyphs inserted by the
26542 display engine for its internal purposes, like truncation
26543 and continuation glyphs and blanks beyond the end of
26544 line's text on text terminals. If we are over such a
26545 glyph, we are not over any text. */
26546 || INTEGERP (glyph
->object
)
26547 /* R2L rows have a stretch glyph at their front, which
26548 stands for no text, whereas L2R rows have no glyphs at
26549 all beyond the end of text. Treat such stretch glyphs
26550 like we do with NULL glyphs in L2R rows. */
26551 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26552 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26553 && glyph
->type
== STRETCH_GLYPH
26554 && glyph
->avoid_cursor_p
))
26556 if (clear_mouse_face (hlinfo
))
26557 cursor
= No_Cursor
;
26558 #ifdef HAVE_WINDOW_SYSTEM
26559 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26561 if (area
!= TEXT_AREA
)
26562 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26564 pointer
= Vvoid_text_area_pointer
;
26570 pos
= glyph
->charpos
;
26571 object
= glyph
->object
;
26572 if (!STRINGP (object
) && !BUFFERP (object
))
26575 /* If we get an out-of-range value, return now; avoid an error. */
26576 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26579 /* Make the window's buffer temporarily current for
26580 overlays_at and compute_char_face. */
26581 obuf
= current_buffer
;
26582 current_buffer
= b
;
26588 /* Is this char mouse-active or does it have help-echo? */
26589 position
= make_number (pos
);
26591 if (BUFFERP (object
))
26593 /* Put all the overlays we want in a vector in overlay_vec. */
26594 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26595 /* Sort overlays into increasing priority order. */
26596 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26601 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26604 cursor
= No_Cursor
;
26606 /* Check mouse-face highlighting. */
26608 /* If there exists an overlay with mouse-face overlapping
26609 the one we are currently highlighting, we have to
26610 check if we enter the overlapping overlay, and then
26611 highlight only that. */
26612 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26613 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26615 /* Find the highest priority overlay with a mouse-face. */
26616 Lisp_Object overlay
= Qnil
;
26617 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26619 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26620 if (!NILP (mouse_face
))
26621 overlay
= overlay_vec
[i
];
26624 /* If we're highlighting the same overlay as before, there's
26625 no need to do that again. */
26626 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26627 goto check_help_echo
;
26628 hlinfo
->mouse_face_overlay
= overlay
;
26630 /* Clear the display of the old active region, if any. */
26631 if (clear_mouse_face (hlinfo
))
26632 cursor
= No_Cursor
;
26634 /* If no overlay applies, get a text property. */
26635 if (NILP (overlay
))
26636 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26638 /* Next, compute the bounds of the mouse highlighting and
26640 if (!NILP (mouse_face
) && STRINGP (object
))
26642 /* The mouse-highlighting comes from a display string
26643 with a mouse-face. */
26647 s
= Fprevious_single_property_change
26648 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26649 e
= Fnext_single_property_change
26650 (position
, Qmouse_face
, object
, Qnil
);
26652 s
= make_number (0);
26654 e
= make_number (SCHARS (object
) - 1);
26655 mouse_face_from_string_pos (w
, hlinfo
, object
,
26656 XINT (s
), XINT (e
));
26657 hlinfo
->mouse_face_past_end
= 0;
26658 hlinfo
->mouse_face_window
= window
;
26659 hlinfo
->mouse_face_face_id
26660 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26661 glyph
->face_id
, 1);
26662 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26663 cursor
= No_Cursor
;
26667 /* The mouse-highlighting, if any, comes from an overlay
26668 or text property in the buffer. */
26669 Lisp_Object buffer
IF_LINT (= Qnil
);
26670 Lisp_Object cover_string
IF_LINT (= Qnil
);
26672 if (STRINGP (object
))
26674 /* If we are on a display string with no mouse-face,
26675 check if the text under it has one. */
26676 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26677 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26678 pos
= string_buffer_position (object
, start
);
26681 mouse_face
= get_char_property_and_overlay
26682 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26683 buffer
= w
->buffer
;
26684 cover_string
= object
;
26690 cover_string
= Qnil
;
26693 if (!NILP (mouse_face
))
26695 Lisp_Object before
, after
;
26696 Lisp_Object before_string
, after_string
;
26697 /* To correctly find the limits of mouse highlight
26698 in a bidi-reordered buffer, we must not use the
26699 optimization of limiting the search in
26700 previous-single-property-change and
26701 next-single-property-change, because
26702 rows_from_pos_range needs the real start and end
26703 positions to DTRT in this case. That's because
26704 the first row visible in a window does not
26705 necessarily display the character whose position
26706 is the smallest. */
26708 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26709 ? Fmarker_position (w
->start
)
26712 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26713 ? make_number (BUF_Z (XBUFFER (buffer
))
26714 - XFASTINT (w
->window_end_pos
))
26717 if (NILP (overlay
))
26719 /* Handle the text property case. */
26720 before
= Fprevious_single_property_change
26721 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26722 after
= Fnext_single_property_change
26723 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26724 before_string
= after_string
= Qnil
;
26728 /* Handle the overlay case. */
26729 before
= Foverlay_start (overlay
);
26730 after
= Foverlay_end (overlay
);
26731 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26732 after_string
= Foverlay_get (overlay
, Qafter_string
);
26734 if (!STRINGP (before_string
)) before_string
= Qnil
;
26735 if (!STRINGP (after_string
)) after_string
= Qnil
;
26738 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26741 before_string
, after_string
,
26743 cursor
= No_Cursor
;
26750 /* Look for a `help-echo' property. */
26751 if (NILP (help_echo_string
)) {
26752 Lisp_Object help
, overlay
;
26754 /* Check overlays first. */
26755 help
= overlay
= Qnil
;
26756 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26758 overlay
= overlay_vec
[i
];
26759 help
= Foverlay_get (overlay
, Qhelp_echo
);
26764 help_echo_string
= help
;
26765 help_echo_window
= window
;
26766 help_echo_object
= overlay
;
26767 help_echo_pos
= pos
;
26771 Lisp_Object obj
= glyph
->object
;
26772 EMACS_INT charpos
= glyph
->charpos
;
26774 /* Try text properties. */
26777 && charpos
< SCHARS (obj
))
26779 help
= Fget_text_property (make_number (charpos
),
26783 /* If the string itself doesn't specify a help-echo,
26784 see if the buffer text ``under'' it does. */
26785 struct glyph_row
*r
26786 = MATRIX_ROW (w
->current_matrix
, vpos
);
26787 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26788 EMACS_INT p
= string_buffer_position (obj
, start
);
26791 help
= Fget_char_property (make_number (p
),
26792 Qhelp_echo
, w
->buffer
);
26801 else if (BUFFERP (obj
)
26804 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26809 help_echo_string
= help
;
26810 help_echo_window
= window
;
26811 help_echo_object
= obj
;
26812 help_echo_pos
= charpos
;
26817 #ifdef HAVE_WINDOW_SYSTEM
26818 /* Look for a `pointer' property. */
26819 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26821 /* Check overlays first. */
26822 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26823 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26825 if (NILP (pointer
))
26827 Lisp_Object obj
= glyph
->object
;
26828 EMACS_INT charpos
= glyph
->charpos
;
26830 /* Try text properties. */
26833 && charpos
< SCHARS (obj
))
26835 pointer
= Fget_text_property (make_number (charpos
),
26837 if (NILP (pointer
))
26839 /* If the string itself doesn't specify a pointer,
26840 see if the buffer text ``under'' it does. */
26841 struct glyph_row
*r
26842 = MATRIX_ROW (w
->current_matrix
, vpos
);
26843 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26844 EMACS_INT p
= string_buffer_position (obj
, start
);
26846 pointer
= Fget_char_property (make_number (p
),
26847 Qpointer
, w
->buffer
);
26850 else if (BUFFERP (obj
)
26853 pointer
= Fget_text_property (make_number (charpos
),
26857 #endif /* HAVE_WINDOW_SYSTEM */
26861 current_buffer
= obuf
;
26866 #ifdef HAVE_WINDOW_SYSTEM
26867 if (FRAME_WINDOW_P (f
))
26868 define_frame_cursor1 (f
, cursor
, pointer
);
26870 /* This is here to prevent a compiler error, about "label at end of
26871 compound statement". */
26878 Clear any mouse-face on window W. This function is part of the
26879 redisplay interface, and is called from try_window_id and similar
26880 functions to ensure the mouse-highlight is off. */
26883 x_clear_window_mouse_face (struct window
*w
)
26885 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26886 Lisp_Object window
;
26889 XSETWINDOW (window
, w
);
26890 if (EQ (window
, hlinfo
->mouse_face_window
))
26891 clear_mouse_face (hlinfo
);
26897 Just discard the mouse face information for frame F, if any.
26898 This is used when the size of F is changed. */
26901 cancel_mouse_face (struct frame
*f
)
26903 Lisp_Object window
;
26904 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26906 window
= hlinfo
->mouse_face_window
;
26907 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26909 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26910 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26911 hlinfo
->mouse_face_window
= Qnil
;
26917 /***********************************************************************
26919 ***********************************************************************/
26921 #ifdef HAVE_WINDOW_SYSTEM
26923 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26924 which intersects rectangle R. R is in window-relative coordinates. */
26927 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26928 enum glyph_row_area area
)
26930 struct glyph
*first
= row
->glyphs
[area
];
26931 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26932 struct glyph
*last
;
26933 int first_x
, start_x
, x
;
26935 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26936 /* If row extends face to end of line write the whole line. */
26937 draw_glyphs (w
, 0, row
, area
,
26938 0, row
->used
[area
],
26939 DRAW_NORMAL_TEXT
, 0);
26942 /* Set START_X to the window-relative start position for drawing glyphs of
26943 AREA. The first glyph of the text area can be partially visible.
26944 The first glyphs of other areas cannot. */
26945 start_x
= window_box_left_offset (w
, area
);
26947 if (area
== TEXT_AREA
)
26950 /* Find the first glyph that must be redrawn. */
26952 && x
+ first
->pixel_width
< r
->x
)
26954 x
+= first
->pixel_width
;
26958 /* Find the last one. */
26962 && x
< r
->x
+ r
->width
)
26964 x
+= last
->pixel_width
;
26970 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26971 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26972 DRAW_NORMAL_TEXT
, 0);
26977 /* Redraw the parts of the glyph row ROW on window W intersecting
26978 rectangle R. R is in window-relative coordinates. Value is
26979 non-zero if mouse-face was overwritten. */
26982 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26984 xassert (row
->enabled_p
);
26986 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26987 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26988 0, row
->used
[TEXT_AREA
],
26989 DRAW_NORMAL_TEXT
, 0);
26992 if (row
->used
[LEFT_MARGIN_AREA
])
26993 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26994 if (row
->used
[TEXT_AREA
])
26995 expose_area (w
, row
, r
, TEXT_AREA
);
26996 if (row
->used
[RIGHT_MARGIN_AREA
])
26997 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26998 draw_row_fringe_bitmaps (w
, row
);
27001 return row
->mouse_face_p
;
27005 /* Redraw those parts of glyphs rows during expose event handling that
27006 overlap other rows. Redrawing of an exposed line writes over parts
27007 of lines overlapping that exposed line; this function fixes that.
27009 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27010 row in W's current matrix that is exposed and overlaps other rows.
27011 LAST_OVERLAPPING_ROW is the last such row. */
27014 expose_overlaps (struct window
*w
,
27015 struct glyph_row
*first_overlapping_row
,
27016 struct glyph_row
*last_overlapping_row
,
27019 struct glyph_row
*row
;
27021 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27022 if (row
->overlapping_p
)
27024 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27027 if (row
->used
[LEFT_MARGIN_AREA
])
27028 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27030 if (row
->used
[TEXT_AREA
])
27031 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27033 if (row
->used
[RIGHT_MARGIN_AREA
])
27034 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27040 /* Return non-zero if W's cursor intersects rectangle R. */
27043 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27045 XRectangle cr
, result
;
27046 struct glyph
*cursor_glyph
;
27047 struct glyph_row
*row
;
27049 if (w
->phys_cursor
.vpos
>= 0
27050 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27051 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27053 && row
->cursor_in_fringe_p
)
27055 /* Cursor is in the fringe. */
27056 cr
.x
= window_box_right_offset (w
,
27057 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27058 ? RIGHT_MARGIN_AREA
27061 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27062 cr
.height
= row
->height
;
27063 return x_intersect_rectangles (&cr
, r
, &result
);
27066 cursor_glyph
= get_phys_cursor_glyph (w
);
27069 /* r is relative to W's box, but w->phys_cursor.x is relative
27070 to left edge of W's TEXT area. Adjust it. */
27071 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27072 cr
.y
= w
->phys_cursor
.y
;
27073 cr
.width
= cursor_glyph
->pixel_width
;
27074 cr
.height
= w
->phys_cursor_height
;
27075 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27076 I assume the effect is the same -- and this is portable. */
27077 return x_intersect_rectangles (&cr
, r
, &result
);
27079 /* If we don't understand the format, pretend we're not in the hot-spot. */
27085 Draw a vertical window border to the right of window W if W doesn't
27086 have vertical scroll bars. */
27089 x_draw_vertical_border (struct window
*w
)
27091 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27093 /* We could do better, if we knew what type of scroll-bar the adjacent
27094 windows (on either side) have... But we don't :-(
27095 However, I think this works ok. ++KFS 2003-04-25 */
27097 /* Redraw borders between horizontally adjacent windows. Don't
27098 do it for frames with vertical scroll bars because either the
27099 right scroll bar of a window, or the left scroll bar of its
27100 neighbor will suffice as a border. */
27101 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27104 if (!WINDOW_RIGHTMOST_P (w
)
27105 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27107 int x0
, x1
, y0
, y1
;
27109 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27112 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27115 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27117 else if (!WINDOW_LEFTMOST_P (w
)
27118 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27120 int x0
, x1
, y0
, y1
;
27122 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27125 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27128 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27133 /* Redraw the part of window W intersection rectangle FR. Pixel
27134 coordinates in FR are frame-relative. Call this function with
27135 input blocked. Value is non-zero if the exposure overwrites
27139 expose_window (struct window
*w
, XRectangle
*fr
)
27141 struct frame
*f
= XFRAME (w
->frame
);
27143 int mouse_face_overwritten_p
= 0;
27145 /* If window is not yet fully initialized, do nothing. This can
27146 happen when toolkit scroll bars are used and a window is split.
27147 Reconfiguring the scroll bar will generate an expose for a newly
27149 if (w
->current_matrix
== NULL
)
27152 /* When we're currently updating the window, display and current
27153 matrix usually don't agree. Arrange for a thorough display
27155 if (w
== updated_window
)
27157 SET_FRAME_GARBAGED (f
);
27161 /* Frame-relative pixel rectangle of W. */
27162 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27163 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27164 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27165 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27167 if (x_intersect_rectangles (fr
, &wr
, &r
))
27169 int yb
= window_text_bottom_y (w
);
27170 struct glyph_row
*row
;
27171 int cursor_cleared_p
;
27172 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27174 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27175 r
.x
, r
.y
, r
.width
, r
.height
));
27177 /* Convert to window coordinates. */
27178 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27179 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27181 /* Turn off the cursor. */
27182 if (!w
->pseudo_window_p
27183 && phys_cursor_in_rect_p (w
, &r
))
27185 x_clear_cursor (w
);
27186 cursor_cleared_p
= 1;
27189 cursor_cleared_p
= 0;
27191 /* Update lines intersecting rectangle R. */
27192 first_overlapping_row
= last_overlapping_row
= NULL
;
27193 for (row
= w
->current_matrix
->rows
;
27198 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27200 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27201 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27202 || (r
.y
>= y0
&& r
.y
< y1
)
27203 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27205 /* A header line may be overlapping, but there is no need
27206 to fix overlapping areas for them. KFS 2005-02-12 */
27207 if (row
->overlapping_p
&& !row
->mode_line_p
)
27209 if (first_overlapping_row
== NULL
)
27210 first_overlapping_row
= row
;
27211 last_overlapping_row
= row
;
27215 if (expose_line (w
, row
, &r
))
27216 mouse_face_overwritten_p
= 1;
27219 else if (row
->overlapping_p
)
27221 /* We must redraw a row overlapping the exposed area. */
27223 ? y0
+ row
->phys_height
> r
.y
27224 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27226 if (first_overlapping_row
== NULL
)
27227 first_overlapping_row
= row
;
27228 last_overlapping_row
= row
;
27236 /* Display the mode line if there is one. */
27237 if (WINDOW_WANTS_MODELINE_P (w
)
27238 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27240 && row
->y
< r
.y
+ r
.height
)
27242 if (expose_line (w
, row
, &r
))
27243 mouse_face_overwritten_p
= 1;
27246 if (!w
->pseudo_window_p
)
27248 /* Fix the display of overlapping rows. */
27249 if (first_overlapping_row
)
27250 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27253 /* Draw border between windows. */
27254 x_draw_vertical_border (w
);
27256 /* Turn the cursor on again. */
27257 if (cursor_cleared_p
)
27258 update_window_cursor (w
, 1);
27262 return mouse_face_overwritten_p
;
27267 /* Redraw (parts) of all windows in the window tree rooted at W that
27268 intersect R. R contains frame pixel coordinates. Value is
27269 non-zero if the exposure overwrites mouse-face. */
27272 expose_window_tree (struct window
*w
, XRectangle
*r
)
27274 struct frame
*f
= XFRAME (w
->frame
);
27275 int mouse_face_overwritten_p
= 0;
27277 while (w
&& !FRAME_GARBAGED_P (f
))
27279 if (!NILP (w
->hchild
))
27280 mouse_face_overwritten_p
27281 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27282 else if (!NILP (w
->vchild
))
27283 mouse_face_overwritten_p
27284 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27286 mouse_face_overwritten_p
|= expose_window (w
, r
);
27288 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27291 return mouse_face_overwritten_p
;
27296 Redisplay an exposed area of frame F. X and Y are the upper-left
27297 corner of the exposed rectangle. W and H are width and height of
27298 the exposed area. All are pixel values. W or H zero means redraw
27299 the entire frame. */
27302 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27305 int mouse_face_overwritten_p
= 0;
27307 TRACE ((stderr
, "expose_frame "));
27309 /* No need to redraw if frame will be redrawn soon. */
27310 if (FRAME_GARBAGED_P (f
))
27312 TRACE ((stderr
, " garbaged\n"));
27316 /* If basic faces haven't been realized yet, there is no point in
27317 trying to redraw anything. This can happen when we get an expose
27318 event while Emacs is starting, e.g. by moving another window. */
27319 if (FRAME_FACE_CACHE (f
) == NULL
27320 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27322 TRACE ((stderr
, " no faces\n"));
27326 if (w
== 0 || h
== 0)
27329 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27330 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27340 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27341 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27343 if (WINDOWP (f
->tool_bar_window
))
27344 mouse_face_overwritten_p
27345 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27347 #ifdef HAVE_X_WINDOWS
27349 #ifndef USE_X_TOOLKIT
27350 if (WINDOWP (f
->menu_bar_window
))
27351 mouse_face_overwritten_p
27352 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27353 #endif /* not USE_X_TOOLKIT */
27357 /* Some window managers support a focus-follows-mouse style with
27358 delayed raising of frames. Imagine a partially obscured frame,
27359 and moving the mouse into partially obscured mouse-face on that
27360 frame. The visible part of the mouse-face will be highlighted,
27361 then the WM raises the obscured frame. With at least one WM, KDE
27362 2.1, Emacs is not getting any event for the raising of the frame
27363 (even tried with SubstructureRedirectMask), only Expose events.
27364 These expose events will draw text normally, i.e. not
27365 highlighted. Which means we must redo the highlight here.
27366 Subsume it under ``we love X''. --gerd 2001-08-15 */
27367 /* Included in Windows version because Windows most likely does not
27368 do the right thing if any third party tool offers
27369 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27370 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27372 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27373 if (f
== hlinfo
->mouse_face_mouse_frame
)
27375 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27376 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27377 clear_mouse_face (hlinfo
);
27378 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27385 Determine the intersection of two rectangles R1 and R2. Return
27386 the intersection in *RESULT. Value is non-zero if RESULT is not
27390 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27392 XRectangle
*left
, *right
;
27393 XRectangle
*upper
, *lower
;
27394 int intersection_p
= 0;
27396 /* Rearrange so that R1 is the left-most rectangle. */
27398 left
= r1
, right
= r2
;
27400 left
= r2
, right
= r1
;
27402 /* X0 of the intersection is right.x0, if this is inside R1,
27403 otherwise there is no intersection. */
27404 if (right
->x
<= left
->x
+ left
->width
)
27406 result
->x
= right
->x
;
27408 /* The right end of the intersection is the minimum of
27409 the right ends of left and right. */
27410 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27413 /* Same game for Y. */
27415 upper
= r1
, lower
= r2
;
27417 upper
= r2
, lower
= r1
;
27419 /* The upper end of the intersection is lower.y0, if this is inside
27420 of upper. Otherwise, there is no intersection. */
27421 if (lower
->y
<= upper
->y
+ upper
->height
)
27423 result
->y
= lower
->y
;
27425 /* The lower end of the intersection is the minimum of the lower
27426 ends of upper and lower. */
27427 result
->height
= (min (lower
->y
+ lower
->height
,
27428 upper
->y
+ upper
->height
)
27430 intersection_p
= 1;
27434 return intersection_p
;
27437 #endif /* HAVE_WINDOW_SYSTEM */
27440 /***********************************************************************
27442 ***********************************************************************/
27445 syms_of_xdisp (void)
27447 Vwith_echo_area_save_vector
= Qnil
;
27448 staticpro (&Vwith_echo_area_save_vector
);
27450 Vmessage_stack
= Qnil
;
27451 staticpro (&Vmessage_stack
);
27453 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27455 message_dolog_marker1
= Fmake_marker ();
27456 staticpro (&message_dolog_marker1
);
27457 message_dolog_marker2
= Fmake_marker ();
27458 staticpro (&message_dolog_marker2
);
27459 message_dolog_marker3
= Fmake_marker ();
27460 staticpro (&message_dolog_marker3
);
27463 defsubr (&Sdump_frame_glyph_matrix
);
27464 defsubr (&Sdump_glyph_matrix
);
27465 defsubr (&Sdump_glyph_row
);
27466 defsubr (&Sdump_tool_bar_row
);
27467 defsubr (&Strace_redisplay
);
27468 defsubr (&Strace_to_stderr
);
27470 #ifdef HAVE_WINDOW_SYSTEM
27471 defsubr (&Stool_bar_lines_needed
);
27472 defsubr (&Slookup_image_map
);
27474 defsubr (&Sformat_mode_line
);
27475 defsubr (&Sinvisible_p
);
27476 defsubr (&Scurrent_bidi_paragraph_direction
);
27478 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27479 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27480 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27481 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27482 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27483 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27484 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27485 DEFSYM (Qeval
, "eval");
27486 DEFSYM (QCdata
, ":data");
27487 DEFSYM (Qdisplay
, "display");
27488 DEFSYM (Qspace_width
, "space-width");
27489 DEFSYM (Qraise
, "raise");
27490 DEFSYM (Qslice
, "slice");
27491 DEFSYM (Qspace
, "space");
27492 DEFSYM (Qmargin
, "margin");
27493 DEFSYM (Qpointer
, "pointer");
27494 DEFSYM (Qleft_margin
, "left-margin");
27495 DEFSYM (Qright_margin
, "right-margin");
27496 DEFSYM (Qcenter
, "center");
27497 DEFSYM (Qline_height
, "line-height");
27498 DEFSYM (QCalign_to
, ":align-to");
27499 DEFSYM (QCrelative_width
, ":relative-width");
27500 DEFSYM (QCrelative_height
, ":relative-height");
27501 DEFSYM (QCeval
, ":eval");
27502 DEFSYM (QCpropertize
, ":propertize");
27503 DEFSYM (QCfile
, ":file");
27504 DEFSYM (Qfontified
, "fontified");
27505 DEFSYM (Qfontification_functions
, "fontification-functions");
27506 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27507 DEFSYM (Qescape_glyph
, "escape-glyph");
27508 DEFSYM (Qnobreak_space
, "nobreak-space");
27509 DEFSYM (Qimage
, "image");
27510 DEFSYM (Qtext
, "text");
27511 DEFSYM (Qboth
, "both");
27512 DEFSYM (Qboth_horiz
, "both-horiz");
27513 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27514 DEFSYM (QCmap
, ":map");
27515 DEFSYM (QCpointer
, ":pointer");
27516 DEFSYM (Qrect
, "rect");
27517 DEFSYM (Qcircle
, "circle");
27518 DEFSYM (Qpoly
, "poly");
27519 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27520 DEFSYM (Qgrow_only
, "grow-only");
27521 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27522 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27523 DEFSYM (Qposition
, "position");
27524 DEFSYM (Qbuffer_position
, "buffer-position");
27525 DEFSYM (Qobject
, "object");
27526 DEFSYM (Qbar
, "bar");
27527 DEFSYM (Qhbar
, "hbar");
27528 DEFSYM (Qbox
, "box");
27529 DEFSYM (Qhollow
, "hollow");
27530 DEFSYM (Qhand
, "hand");
27531 DEFSYM (Qarrow
, "arrow");
27532 DEFSYM (Qtext
, "text");
27533 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27535 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27536 Fcons (intern_c_string ("void-variable"), Qnil
)),
27538 staticpro (&list_of_error
);
27540 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27541 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27542 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27543 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27545 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27546 staticpro (&echo_buffer
[0]);
27547 staticpro (&echo_buffer
[1]);
27549 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27550 staticpro (&echo_area_buffer
[0]);
27551 staticpro (&echo_area_buffer
[1]);
27553 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27554 staticpro (&Vmessages_buffer_name
);
27556 mode_line_proptrans_alist
= Qnil
;
27557 staticpro (&mode_line_proptrans_alist
);
27558 mode_line_string_list
= Qnil
;
27559 staticpro (&mode_line_string_list
);
27560 mode_line_string_face
= Qnil
;
27561 staticpro (&mode_line_string_face
);
27562 mode_line_string_face_prop
= Qnil
;
27563 staticpro (&mode_line_string_face_prop
);
27564 Vmode_line_unwind_vector
= Qnil
;
27565 staticpro (&Vmode_line_unwind_vector
);
27567 help_echo_string
= Qnil
;
27568 staticpro (&help_echo_string
);
27569 help_echo_object
= Qnil
;
27570 staticpro (&help_echo_object
);
27571 help_echo_window
= Qnil
;
27572 staticpro (&help_echo_window
);
27573 previous_help_echo_string
= Qnil
;
27574 staticpro (&previous_help_echo_string
);
27575 help_echo_pos
= -1;
27577 DEFSYM (Qright_to_left
, "right-to-left");
27578 DEFSYM (Qleft_to_right
, "left-to-right");
27580 #ifdef HAVE_WINDOW_SYSTEM
27581 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27582 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27583 For example, if a block cursor is over a tab, it will be drawn as
27584 wide as that tab on the display. */);
27585 x_stretch_cursor_p
= 0;
27588 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27589 doc
: /* *Non-nil means highlight trailing whitespace.
27590 The face used for trailing whitespace is `trailing-whitespace'. */);
27591 Vshow_trailing_whitespace
= Qnil
;
27593 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27594 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27595 A value of t means highlight the character itself (for nobreak space,
27596 use face `nobreak-space').
27597 A value of nil means no highlighting.
27598 Other values mean display the escape glyph followed by an ordinary
27599 space or ordinary hyphen. */);
27600 Vnobreak_char_display
= Qt
;
27602 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27603 doc
: /* *The pointer shape to show in void text areas.
27604 A value of nil means to show the text pointer. Other options are `arrow',
27605 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27606 Vvoid_text_area_pointer
= Qarrow
;
27608 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27609 doc
: /* Non-nil means don't actually do any redisplay.
27610 This is used for internal purposes. */);
27611 Vinhibit_redisplay
= Qnil
;
27613 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27614 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27615 Vglobal_mode_string
= Qnil
;
27617 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27618 doc
: /* Marker for where to display an arrow on top of the buffer text.
27619 This must be the beginning of a line in order to work.
27620 See also `overlay-arrow-string'. */);
27621 Voverlay_arrow_position
= Qnil
;
27623 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27624 doc
: /* String to display as an arrow in non-window frames.
27625 See also `overlay-arrow-position'. */);
27626 Voverlay_arrow_string
= make_pure_c_string ("=>");
27628 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27629 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27630 The symbols on this list are examined during redisplay to determine
27631 where to display overlay arrows. */);
27632 Voverlay_arrow_variable_list
27633 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27635 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27636 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27637 If that fails to bring point back on frame, point is centered instead.
27638 If this is zero, point is always centered after it moves off frame.
27639 If you want scrolling to always be a line at a time, you should set
27640 `scroll-conservatively' to a large value rather than set this to 1. */);
27642 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27643 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27644 If point moves off-screen, redisplay will scroll by up to
27645 `scroll-conservatively' lines in order to bring point just barely
27646 onto the screen again. If that cannot be done, then redisplay
27647 recenters point as usual.
27649 If the value is greater than 100, redisplay will never recenter point,
27650 but will always scroll just enough text to bring point into view, even
27651 if you move far away.
27653 A value of zero means always recenter point if it moves off screen. */);
27654 scroll_conservatively
= 0;
27656 DEFVAR_INT ("scroll-margin", scroll_margin
,
27657 doc
: /* *Number of lines of margin at the top and bottom of a window.
27658 Recenter the window whenever point gets within this many lines
27659 of the top or bottom of the window. */);
27662 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27663 doc
: /* Pixels per inch value for non-window system displays.
27664 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27665 Vdisplay_pixels_per_inch
= make_float (72.0);
27668 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27671 DEFVAR_LISP ("truncate-partial-width-windows",
27672 Vtruncate_partial_width_windows
,
27673 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27674 For an integer value, truncate lines in each window narrower than the
27675 full frame width, provided the window width is less than that integer;
27676 otherwise, respect the value of `truncate-lines'.
27678 For any other non-nil value, truncate lines in all windows that do
27679 not span the full frame width.
27681 A value of nil means to respect the value of `truncate-lines'.
27683 If `word-wrap' is enabled, you might want to reduce this. */);
27684 Vtruncate_partial_width_windows
= make_number (50);
27686 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27687 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27688 Any other value means to use the appropriate face, `mode-line',
27689 `header-line', or `menu' respectively. */);
27690 mode_line_inverse_video
= 1;
27692 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27693 doc
: /* *Maximum buffer size for which line number should be displayed.
27694 If the buffer is bigger than this, the line number does not appear
27695 in the mode line. A value of nil means no limit. */);
27696 Vline_number_display_limit
= Qnil
;
27698 DEFVAR_INT ("line-number-display-limit-width",
27699 line_number_display_limit_width
,
27700 doc
: /* *Maximum line width (in characters) for line number display.
27701 If the average length of the lines near point is bigger than this, then the
27702 line number may be omitted from the mode line. */);
27703 line_number_display_limit_width
= 200;
27705 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27706 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27707 highlight_nonselected_windows
= 0;
27709 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27710 doc
: /* Non-nil if more than one frame is visible on this display.
27711 Minibuffer-only frames don't count, but iconified frames do.
27712 This variable is not guaranteed to be accurate except while processing
27713 `frame-title-format' and `icon-title-format'. */);
27715 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27716 doc
: /* Template for displaying the title bar of visible frames.
27717 \(Assuming the window manager supports this feature.)
27719 This variable has the same structure as `mode-line-format', except that
27720 the %c and %l constructs are ignored. It is used only on frames for
27721 which no explicit name has been set \(see `modify-frame-parameters'). */);
27723 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27724 doc
: /* Template for displaying the title bar of an iconified frame.
27725 \(Assuming the window manager supports this feature.)
27726 This variable has the same structure as `mode-line-format' (which see),
27727 and is used only on frames for which no explicit name has been set
27728 \(see `modify-frame-parameters'). */);
27730 = Vframe_title_format
27731 = pure_cons (intern_c_string ("multiple-frames"),
27732 pure_cons (make_pure_c_string ("%b"),
27733 pure_cons (pure_cons (empty_unibyte_string
,
27734 pure_cons (intern_c_string ("invocation-name"),
27735 pure_cons (make_pure_c_string ("@"),
27736 pure_cons (intern_c_string ("system-name"),
27740 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27741 doc
: /* Maximum number of lines to keep in the message log buffer.
27742 If nil, disable message logging. If t, log messages but don't truncate
27743 the buffer when it becomes large. */);
27744 Vmessage_log_max
= make_number (100);
27746 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27747 doc
: /* Functions called before redisplay, if window sizes have changed.
27748 The value should be a list of functions that take one argument.
27749 Just before redisplay, for each frame, if any of its windows have changed
27750 size since the last redisplay, or have been split or deleted,
27751 all the functions in the list are called, with the frame as argument. */);
27752 Vwindow_size_change_functions
= Qnil
;
27754 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27755 doc
: /* List of functions to call before redisplaying a window with scrolling.
27756 Each function is called with two arguments, the window and its new
27757 display-start position. Note that these functions are also called by
27758 `set-window-buffer'. Also note that the value of `window-end' is not
27759 valid when these functions are called. */);
27760 Vwindow_scroll_functions
= Qnil
;
27762 DEFVAR_LISP ("window-text-change-functions",
27763 Vwindow_text_change_functions
,
27764 doc
: /* Functions to call in redisplay when text in the window might change. */);
27765 Vwindow_text_change_functions
= Qnil
;
27767 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27768 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27769 Each function is called with two arguments, the window and the end trigger value.
27770 See `set-window-redisplay-end-trigger'. */);
27771 Vredisplay_end_trigger_functions
= Qnil
;
27773 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27774 doc
: /* *Non-nil means autoselect window with mouse pointer.
27775 If nil, do not autoselect windows.
27776 A positive number means delay autoselection by that many seconds: a
27777 window is autoselected only after the mouse has remained in that
27778 window for the duration of the delay.
27779 A negative number has a similar effect, but causes windows to be
27780 autoselected only after the mouse has stopped moving. \(Because of
27781 the way Emacs compares mouse events, you will occasionally wait twice
27782 that time before the window gets selected.\)
27783 Any other value means to autoselect window instantaneously when the
27784 mouse pointer enters it.
27786 Autoselection selects the minibuffer only if it is active, and never
27787 unselects the minibuffer if it is active.
27789 When customizing this variable make sure that the actual value of
27790 `focus-follows-mouse' matches the behavior of your window manager. */);
27791 Vmouse_autoselect_window
= Qnil
;
27793 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27794 doc
: /* *Non-nil means automatically resize tool-bars.
27795 This dynamically changes the tool-bar's height to the minimum height
27796 that is needed to make all tool-bar items visible.
27797 If value is `grow-only', the tool-bar's height is only increased
27798 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27799 Vauto_resize_tool_bars
= Qt
;
27801 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27802 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27803 auto_raise_tool_bar_buttons_p
= 1;
27805 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27806 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27807 make_cursor_line_fully_visible_p
= 1;
27809 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27810 doc
: /* *Border below tool-bar in pixels.
27811 If an integer, use it as the height of the border.
27812 If it is one of `internal-border-width' or `border-width', use the
27813 value of the corresponding frame parameter.
27814 Otherwise, no border is added below the tool-bar. */);
27815 Vtool_bar_border
= Qinternal_border_width
;
27817 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27818 doc
: /* *Margin around tool-bar buttons in pixels.
27819 If an integer, use that for both horizontal and vertical margins.
27820 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27821 HORZ specifying the horizontal margin, and VERT specifying the
27822 vertical margin. */);
27823 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27825 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27826 doc
: /* *Relief thickness of tool-bar buttons. */);
27827 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27829 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27830 doc
: /* Tool bar style to use.
27832 image - show images only
27833 text - show text only
27834 both - show both, text below image
27835 both-horiz - show text to the right of the image
27836 text-image-horiz - show text to the left of the image
27837 any other - use system default or image if no system default. */);
27838 Vtool_bar_style
= Qnil
;
27840 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27841 doc
: /* *Maximum number of characters a label can have to be shown.
27842 The tool bar style must also show labels for this to have any effect, see
27843 `tool-bar-style'. */);
27844 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27846 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27847 doc
: /* List of functions to call to fontify regions of text.
27848 Each function is called with one argument POS. Functions must
27849 fontify a region starting at POS in the current buffer, and give
27850 fontified regions the property `fontified'. */);
27851 Vfontification_functions
= Qnil
;
27852 Fmake_variable_buffer_local (Qfontification_functions
);
27854 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27855 unibyte_display_via_language_environment
,
27856 doc
: /* *Non-nil means display unibyte text according to language environment.
27857 Specifically, this means that raw bytes in the range 160-255 decimal
27858 are displayed by converting them to the equivalent multibyte characters
27859 according to the current language environment. As a result, they are
27860 displayed according to the current fontset.
27862 Note that this variable affects only how these bytes are displayed,
27863 but does not change the fact they are interpreted as raw bytes. */);
27864 unibyte_display_via_language_environment
= 0;
27866 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27867 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27868 If a float, it specifies a fraction of the mini-window frame's height.
27869 If an integer, it specifies a number of lines. */);
27870 Vmax_mini_window_height
= make_float (0.25);
27872 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27873 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27874 A value of nil means don't automatically resize mini-windows.
27875 A value of t means resize them to fit the text displayed in them.
27876 A value of `grow-only', the default, means let mini-windows grow only;
27877 they return to their normal size when the minibuffer is closed, or the
27878 echo area becomes empty. */);
27879 Vresize_mini_windows
= Qgrow_only
;
27881 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27882 doc
: /* Alist specifying how to blink the cursor off.
27883 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27884 `cursor-type' frame-parameter or variable equals ON-STATE,
27885 comparing using `equal', Emacs uses OFF-STATE to specify
27886 how to blink it off. ON-STATE and OFF-STATE are values for
27887 the `cursor-type' frame parameter.
27889 If a frame's ON-STATE has no entry in this list,
27890 the frame's other specifications determine how to blink the cursor off. */);
27891 Vblink_cursor_alist
= Qnil
;
27893 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27894 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27895 If non-nil, windows are automatically scrolled horizontally to make
27896 point visible. */);
27897 automatic_hscrolling_p
= 1;
27898 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27900 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27901 doc
: /* *How many columns away from the window edge point is allowed to get
27902 before automatic hscrolling will horizontally scroll the window. */);
27903 hscroll_margin
= 5;
27905 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27906 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27907 When point is less than `hscroll-margin' columns from the window
27908 edge, automatic hscrolling will scroll the window by the amount of columns
27909 determined by this variable. If its value is a positive integer, scroll that
27910 many columns. If it's a positive floating-point number, it specifies the
27911 fraction of the window's width to scroll. If it's nil or zero, point will be
27912 centered horizontally after the scroll. Any other value, including negative
27913 numbers, are treated as if the value were zero.
27915 Automatic hscrolling always moves point outside the scroll margin, so if
27916 point was more than scroll step columns inside the margin, the window will
27917 scroll more than the value given by the scroll step.
27919 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27920 and `scroll-right' overrides this variable's effect. */);
27921 Vhscroll_step
= make_number (0);
27923 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27924 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27925 Bind this around calls to `message' to let it take effect. */);
27926 message_truncate_lines
= 0;
27928 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27929 doc
: /* Normal hook run to update the menu bar definitions.
27930 Redisplay runs this hook before it redisplays the menu bar.
27931 This is used to update submenus such as Buffers,
27932 whose contents depend on various data. */);
27933 Vmenu_bar_update_hook
= Qnil
;
27935 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27936 doc
: /* Frame for which we are updating a menu.
27937 The enable predicate for a menu binding should check this variable. */);
27938 Vmenu_updating_frame
= Qnil
;
27940 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27941 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27942 inhibit_menubar_update
= 0;
27944 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27945 doc
: /* Prefix prepended to all continuation lines at display time.
27946 The value may be a string, an image, or a stretch-glyph; it is
27947 interpreted in the same way as the value of a `display' text property.
27949 This variable is overridden by any `wrap-prefix' text or overlay
27952 To add a prefix to non-continuation lines, use `line-prefix'. */);
27953 Vwrap_prefix
= Qnil
;
27954 DEFSYM (Qwrap_prefix
, "wrap-prefix");
27955 Fmake_variable_buffer_local (Qwrap_prefix
);
27957 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27958 doc
: /* Prefix prepended to all non-continuation lines at display time.
27959 The value may be a string, an image, or a stretch-glyph; it is
27960 interpreted in the same way as the value of a `display' text property.
27962 This variable is overridden by any `line-prefix' text or overlay
27965 To add a prefix to continuation lines, use `wrap-prefix'. */);
27966 Vline_prefix
= Qnil
;
27967 DEFSYM (Qline_prefix
, "line-prefix");
27968 Fmake_variable_buffer_local (Qline_prefix
);
27970 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27971 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27972 inhibit_eval_during_redisplay
= 0;
27974 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27975 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27976 inhibit_free_realized_faces
= 0;
27979 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27980 doc
: /* Inhibit try_window_id display optimization. */);
27981 inhibit_try_window_id
= 0;
27983 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27984 doc
: /* Inhibit try_window_reusing display optimization. */);
27985 inhibit_try_window_reusing
= 0;
27987 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27988 doc
: /* Inhibit try_cursor_movement display optimization. */);
27989 inhibit_try_cursor_movement
= 0;
27990 #endif /* GLYPH_DEBUG */
27992 DEFVAR_INT ("overline-margin", overline_margin
,
27993 doc
: /* *Space between overline and text, in pixels.
27994 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27995 margin to the caracter height. */);
27996 overline_margin
= 2;
27998 DEFVAR_INT ("underline-minimum-offset",
27999 underline_minimum_offset
,
28000 doc
: /* Minimum distance between baseline and underline.
28001 This can improve legibility of underlined text at small font sizes,
28002 particularly when using variable `x-use-underline-position-properties'
28003 with fonts that specify an UNDERLINE_POSITION relatively close to the
28004 baseline. The default value is 1. */);
28005 underline_minimum_offset
= 1;
28007 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28008 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28009 This feature only works when on a window system that can change
28010 cursor shapes. */);
28011 display_hourglass_p
= 1;
28013 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28014 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28015 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28017 hourglass_atimer
= NULL
;
28018 hourglass_shown_p
= 0;
28020 DEFSYM (Qglyphless_char
, "glyphless-char");
28021 DEFSYM (Qhex_code
, "hex-code");
28022 DEFSYM (Qempty_box
, "empty-box");
28023 DEFSYM (Qthin_space
, "thin-space");
28024 DEFSYM (Qzero_width
, "zero-width");
28026 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28027 /* Intern this now in case it isn't already done.
28028 Setting this variable twice is harmless.
28029 But don't staticpro it here--that is done in alloc.c. */
28030 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28031 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28033 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28034 doc
: /* Char-table defining glyphless characters.
28035 Each element, if non-nil, should be one of the following:
28036 an ASCII acronym string: display this string in a box
28037 `hex-code': display the hexadecimal code of a character in a box
28038 `empty-box': display as an empty box
28039 `thin-space': display as 1-pixel width space
28040 `zero-width': don't display
28041 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28042 display method for graphical terminals and text terminals respectively.
28043 GRAPHICAL and TEXT should each have one of the values listed above.
28045 The char-table has one extra slot to control the display of a character for
28046 which no font is found. This slot only takes effect on graphical terminals.
28047 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28048 `thin-space'. The default is `empty-box'. */);
28049 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28050 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28055 /* Initialize this module when Emacs starts. */
28060 current_header_line_height
= current_mode_line_height
= -1;
28062 CHARPOS (this_line_start_pos
) = 0;
28064 if (!noninteractive
)
28066 struct window
*m
= XWINDOW (minibuf_window
);
28067 Lisp_Object frame
= m
->frame
;
28068 struct frame
*f
= XFRAME (frame
);
28069 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28070 struct window
*r
= XWINDOW (root
);
28073 echo_area_window
= minibuf_window
;
28075 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28076 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28077 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28078 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28079 XSETFASTINT (m
->total_lines
, 1);
28080 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28082 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28083 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28084 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28086 /* The default ellipsis glyphs `...'. */
28087 for (i
= 0; i
< 3; ++i
)
28088 default_invis_vector
[i
] = make_number ('.');
28092 /* Allocate the buffer for frame titles.
28093 Also used for `format-mode-line'. */
28095 mode_line_noprop_buf
= (char *) xmalloc (size
);
28096 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28097 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28098 mode_line_target
= MODE_LINE_DISPLAY
;
28101 help_echo_showing_p
= 0;
28104 /* Since w32 does not support atimers, it defines its own implementation of
28105 the following three functions in w32fns.c. */
28108 /* Platform-independent portion of hourglass implementation. */
28110 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28112 hourglass_started (void)
28114 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28117 /* Cancel a currently active hourglass timer, and start a new one. */
28119 start_hourglass (void)
28121 #if defined (HAVE_WINDOW_SYSTEM)
28123 int secs
, usecs
= 0;
28125 cancel_hourglass ();
28127 if (INTEGERP (Vhourglass_delay
)
28128 && XINT (Vhourglass_delay
) > 0)
28129 secs
= XFASTINT (Vhourglass_delay
);
28130 else if (FLOATP (Vhourglass_delay
)
28131 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28134 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28135 secs
= XFASTINT (tem
);
28136 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28139 secs
= DEFAULT_HOURGLASS_DELAY
;
28141 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28142 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28143 show_hourglass
, NULL
);
28148 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28151 cancel_hourglass (void)
28153 #if defined (HAVE_WINDOW_SYSTEM)
28154 if (hourglass_atimer
)
28156 cancel_atimer (hourglass_atimer
);
28157 hourglass_atimer
= NULL
;
28160 if (hourglass_shown_p
)
28164 #endif /* ! WINDOWSNT */