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
;
1213 /* Subroutine of pos_visible_p below. Extracts a display string, if
1214 any, from the display spec given as its argument. */
1216 string_from_display_spec (Lisp_Object spec
)
1220 while (CONSP (spec
))
1222 if (STRINGP (XCAR (spec
)))
1227 else if (VECTORP (spec
))
1231 for (i
= 0; i
< ASIZE (spec
); i
++)
1233 if (STRINGP (AREF (spec
, i
)))
1234 return AREF (spec
, i
);
1242 /* Return 1 if position CHARPOS is visible in window W.
1243 CHARPOS < 0 means return info about WINDOW_END position.
1244 If visible, set *X and *Y to pixel coordinates of top left corner.
1245 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1246 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1249 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1250 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1253 void *itdata
= bidi_shelve_cache ();
1254 struct text_pos top
;
1256 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->buffer
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1269 /* Compute exact mode line heights. */
1270 if (WINDOW_WANTS_MODELINE_P (w
))
1271 current_mode_line_height
1272 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1273 BVAR (current_buffer
, mode_line_format
));
1275 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1276 current_header_line_height
1277 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1278 BVAR (current_buffer
, header_line_format
));
1280 start_display (&it
, w
, top
);
1281 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1282 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1285 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1286 && IT_CHARPOS (it
) >= charpos
)
1287 /* When scanning backwards under bidi iteration, move_it_to
1288 stops at or _before_ CHARPOS, because it stops at or to
1289 the _right_ of the character at CHARPOS. */
1290 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1291 && IT_CHARPOS (it
) <= charpos
)))
1293 /* We have reached CHARPOS, or passed it. How the call to
1294 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1295 or covered by a display property, move_it_to stops at the end
1296 of the invisible text, to the right of CHARPOS. (ii) If
1297 CHARPOS is in a display vector, move_it_to stops on its last
1299 int top_x
= it
.current_x
;
1300 int top_y
= it
.current_y
;
1301 enum it_method it_method
= it
.method
;
1302 /* Calling line_bottom_y may change it.method, it.position, etc. */
1303 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1304 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1306 if (top_y
< window_top_y
)
1307 visible_p
= bottom_y
> window_top_y
;
1308 else if (top_y
< it
.last_visible_y
)
1312 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1314 /* We stopped on the last glyph of a display vector.
1315 Try and recompute. Hack alert! */
1316 if (charpos
< 2 || top
.charpos
>= charpos
)
1317 top_x
= it
.glyph_row
->x
;
1321 start_display (&it2
, w
, top
);
1322 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1323 get_next_display_element (&it2
);
1324 PRODUCE_GLYPHS (&it2
);
1325 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1326 || it2
.current_x
> it2
.last_visible_x
)
1327 top_x
= it
.glyph_row
->x
;
1330 top_x
= it2
.current_x
;
1331 top_y
= it2
.current_y
;
1335 else if (IT_CHARPOS (it
) != charpos
)
1337 Lisp_Object cpos
= make_number (charpos
);
1338 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1339 Lisp_Object string
= string_from_display_spec (spec
);
1340 int newline_in_string
= 0;
1342 if (STRINGP (string
))
1344 const char *s
= SSDATA (string
);
1345 const char *e
= s
+ SBYTES (string
);
1350 newline_in_string
= 1;
1355 /* The tricky code below is needed because there's a
1356 discrepancy between move_it_to and how we set cursor
1357 when the display line ends in a newline from a
1358 display string. move_it_to will stop _after_ such
1359 display strings, whereas set_cursor_from_row
1360 conspires with cursor_row_p to place the cursor on
1361 the first glyph produced from the display string. */
1363 /* We have overshoot PT because it is covered by a
1364 display property whose value is a string. If the
1365 string includes embedded newlines, we are also in the
1366 wrong display line. Backtrack to the correct line,
1367 where the display string begins. */
1368 if (newline_in_string
)
1370 Lisp_Object startpos
, endpos
;
1371 EMACS_INT start
, end
;
1374 /* Find the first and the last buffer positions
1375 covered by the display string. */
1377 Fnext_single_char_property_change (cpos
, Qdisplay
,
1380 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1382 start
= XFASTINT (startpos
);
1383 end
= XFASTINT (endpos
);
1384 /* Move to the last buffer position before the
1385 display property. */
1386 start_display (&it3
, w
, top
);
1387 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1388 /* Move forward one more line if the position before
1389 the display string is a newline or if it is the
1390 rightmost character on a line that is
1391 continued or word-wrapped. */
1392 if (it3
.method
== GET_FROM_BUFFER
1394 move_it_by_lines (&it3
, 1);
1395 else if (move_it_in_display_line_to (&it3
, -1,
1399 == MOVE_LINE_CONTINUED
)
1401 move_it_by_lines (&it3
, 1);
1402 /* When we are under word-wrap, the #$@%!
1403 move_it_by_lines moves 2 lines, so we need to
1405 if (it3
.line_wrap
== WORD_WRAP
)
1406 move_it_by_lines (&it3
, -1);
1409 /* Record the vertical coordinate of the display
1410 line where we wound up. */
1411 top_y
= it3
.current_y
;
1414 /* When characters are reordered for display,
1415 the character displayed to the left of the
1416 display string could be _after_ the display
1417 property in the logical order. Use the
1418 smallest vertical position of these two. */
1419 start_display (&it3
, w
, top
);
1420 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1421 if (it3
.current_y
< top_y
)
1422 top_y
= it3
.current_y
;
1424 /* Move from the top of the window to the beginning
1425 of the display line where the display string
1427 start_display (&it3
, w
, top
);
1428 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1429 /* Finally, advance the iterator until we hit the
1430 first display element whose character position is
1431 CHARPOS, or until the first newline from the
1432 display string, which signals the end of the
1434 while (get_next_display_element (&it3
))
1436 PRODUCE_GLYPHS (&it3
);
1437 if (IT_CHARPOS (it3
) == charpos
1438 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1440 set_iterator_to_next (&it3
, 0);
1442 top_x
= it3
.current_x
- it3
.pixel_width
;
1443 /* Normally, we would exit the above loop because we
1444 found the display element whose character
1445 position is CHARPOS. For the contingency that we
1446 didn't, and stopped at the first newline from the
1447 display string, move back over the glyphs
1448 produced from the string, until we find the
1449 rightmost glyph not from the string. */
1450 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1452 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1453 + it3
.glyph_row
->used
[TEXT_AREA
];
1455 while (EQ ((g
- 1)->object
, string
))
1458 top_x
-= g
->pixel_width
;
1460 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1461 + it3
.glyph_row
->used
[TEXT_AREA
]);
1467 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1468 *rtop
= max (0, window_top_y
- top_y
);
1469 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1470 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1471 - max (top_y
, window_top_y
)));
1477 /* We were asked to provide info about WINDOW_END. */
1479 void *it2data
= NULL
;
1481 SAVE_IT (it2
, it
, it2data
);
1482 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1483 move_it_by_lines (&it
, 1);
1484 if (charpos
< IT_CHARPOS (it
)
1485 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1488 RESTORE_IT (&it2
, &it2
, it2data
);
1489 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1491 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1492 *rtop
= max (0, -it2
.current_y
);
1493 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1494 - it
.last_visible_y
));
1495 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1497 - max (it2
.current_y
,
1498 WINDOW_HEADER_LINE_HEIGHT (w
))));
1502 bidi_unshelve_cache (it2data
, 1);
1504 bidi_unshelve_cache (itdata
, 0);
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR. Return in *LEN the length of
1528 the character. This is like STRING_CHAR_AND_LENGTH but never
1529 returns an invalid character. If we find one, we return a `?', but
1530 with the length of the invalid character. */
1533 string_char_and_length (const unsigned char *str
, int *len
)
1537 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1538 if (!CHAR_VALID_P (c
))
1539 /* We may not change the length here because other places in Emacs
1540 don't use this function, i.e. they silently accept invalid
1549 /* Given a position POS containing a valid character and byte position
1550 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1552 static struct text_pos
1553 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1555 xassert (STRINGP (string
) && nchars
>= 0);
1557 if (STRING_MULTIBYTE (string
))
1559 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1564 string_char_and_length (p
, &len
);
1567 BYTEPOS (pos
) += len
;
1571 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1577 /* Value is the text position, i.e. character and byte position,
1578 for character position CHARPOS in STRING. */
1580 static inline struct text_pos
1581 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1583 struct text_pos pos
;
1584 xassert (STRINGP (string
));
1585 xassert (charpos
>= 0);
1586 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1591 /* Value is a text position, i.e. character and byte position, for
1592 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1593 means recognize multibyte characters. */
1595 static struct text_pos
1596 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1598 struct text_pos pos
;
1600 xassert (s
!= NULL
);
1601 xassert (charpos
>= 0);
1607 SET_TEXT_POS (pos
, 0, 0);
1610 string_char_and_length ((const unsigned char *) s
, &len
);
1613 BYTEPOS (pos
) += len
;
1617 SET_TEXT_POS (pos
, charpos
, charpos
);
1623 /* Value is the number of characters in C string S. MULTIBYTE_P
1624 non-zero means recognize multibyte characters. */
1627 number_of_chars (const char *s
, int multibyte_p
)
1633 EMACS_INT rest
= strlen (s
);
1635 const unsigned char *p
= (const unsigned char *) s
;
1637 for (nchars
= 0; rest
> 0; ++nchars
)
1639 string_char_and_length (p
, &len
);
1640 rest
-= len
, p
+= len
;
1644 nchars
= strlen (s
);
1650 /* Compute byte position NEWPOS->bytepos corresponding to
1651 NEWPOS->charpos. POS is a known position in string STRING.
1652 NEWPOS->charpos must be >= POS.charpos. */
1655 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1657 xassert (STRINGP (string
));
1658 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1660 if (STRING_MULTIBYTE (string
))
1661 *newpos
= string_pos_nchars_ahead (pos
, string
,
1662 CHARPOS (*newpos
) - CHARPOS (pos
));
1664 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1668 Return an estimation of the pixel height of mode or header lines on
1669 frame F. FACE_ID specifies what line's height to estimate. */
1672 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1674 #ifdef HAVE_WINDOW_SYSTEM
1675 if (FRAME_WINDOW_P (f
))
1677 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1679 /* This function is called so early when Emacs starts that the face
1680 cache and mode line face are not yet initialized. */
1681 if (FRAME_FACE_CACHE (f
))
1683 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1687 height
= FONT_HEIGHT (face
->font
);
1688 if (face
->box_line_width
> 0)
1689 height
+= 2 * face
->box_line_width
;
1700 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1701 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1702 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1703 not force the value into range. */
1706 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1707 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1710 #ifdef HAVE_WINDOW_SYSTEM
1711 if (FRAME_WINDOW_P (f
))
1713 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1714 even for negative values. */
1716 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1718 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1720 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1721 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1724 STORE_NATIVE_RECT (*bounds
,
1725 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1726 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1727 FRAME_COLUMN_WIDTH (f
) - 1,
1728 FRAME_LINE_HEIGHT (f
) - 1);
1734 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1735 pix_x
= FRAME_TOTAL_COLS (f
);
1739 else if (pix_y
> FRAME_LINES (f
))
1740 pix_y
= FRAME_LINES (f
);
1750 /* Find the glyph under window-relative coordinates X/Y in window W.
1751 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1752 strings. Return in *HPOS and *VPOS the row and column number of
1753 the glyph found. Return in *AREA the glyph area containing X.
1754 Value is a pointer to the glyph found or null if X/Y is not on
1755 text, or we can't tell because W's current matrix is not up to
1760 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1761 int *dx
, int *dy
, int *area
)
1763 struct glyph
*glyph
, *end
;
1764 struct glyph_row
*row
= NULL
;
1767 /* Find row containing Y. Give up if some row is not enabled. */
1768 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1770 row
= MATRIX_ROW (w
->current_matrix
, i
);
1771 if (!row
->enabled_p
)
1773 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1780 /* Give up if Y is not in the window. */
1781 if (i
== w
->current_matrix
->nrows
)
1784 /* Get the glyph area containing X. */
1785 if (w
->pseudo_window_p
)
1792 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1794 *area
= LEFT_MARGIN_AREA
;
1795 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1797 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1800 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1804 *area
= RIGHT_MARGIN_AREA
;
1805 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1809 /* Find glyph containing X. */
1810 glyph
= row
->glyphs
[*area
];
1811 end
= glyph
+ row
->used
[*area
];
1813 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1815 x
-= glyph
->pixel_width
;
1825 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1828 *hpos
= glyph
- row
->glyphs
[*area
];
1832 /* Convert frame-relative x/y to coordinates relative to window W.
1833 Takes pseudo-windows into account. */
1836 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1838 if (w
->pseudo_window_p
)
1840 /* A pseudo-window is always full-width, and starts at the
1841 left edge of the frame, plus a frame border. */
1842 struct frame
*f
= XFRAME (w
->frame
);
1843 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1844 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1848 *x
-= WINDOW_LEFT_EDGE_X (w
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 #ifdef HAVE_WINDOW_SYSTEM
1856 Return in RECTS[] at most N clipping rectangles for glyph string S.
1857 Return the number of stored rectangles. */
1860 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1867 if (s
->row
->full_width_p
)
1869 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1870 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1871 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1873 /* Unless displaying a mode or menu bar line, which are always
1874 fully visible, clip to the visible part of the row. */
1875 if (s
->w
->pseudo_window_p
)
1876 r
.height
= s
->row
->visible_height
;
1878 r
.height
= s
->height
;
1882 /* This is a text line that may be partially visible. */
1883 r
.x
= window_box_left (s
->w
, s
->area
);
1884 r
.width
= window_box_width (s
->w
, s
->area
);
1885 r
.height
= s
->row
->visible_height
;
1889 if (r
.x
< s
->clip_head
->x
)
1891 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1892 r
.width
-= s
->clip_head
->x
- r
.x
;
1895 r
.x
= s
->clip_head
->x
;
1898 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1900 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1901 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1906 /* If S draws overlapping rows, it's sufficient to use the top and
1907 bottom of the window for clipping because this glyph string
1908 intentionally draws over other lines. */
1909 if (s
->for_overlaps
)
1911 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1912 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1914 /* Alas, the above simple strategy does not work for the
1915 environments with anti-aliased text: if the same text is
1916 drawn onto the same place multiple times, it gets thicker.
1917 If the overlap we are processing is for the erased cursor, we
1918 take the intersection with the rectagle of the cursor. */
1919 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1921 XRectangle rc
, r_save
= r
;
1923 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1924 rc
.y
= s
->w
->phys_cursor
.y
;
1925 rc
.width
= s
->w
->phys_cursor_width
;
1926 rc
.height
= s
->w
->phys_cursor_height
;
1928 x_intersect_rectangles (&r_save
, &rc
, &r
);
1933 /* Don't use S->y for clipping because it doesn't take partially
1934 visible lines into account. For example, it can be negative for
1935 partially visible lines at the top of a window. */
1936 if (!s
->row
->full_width_p
1937 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1938 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1940 r
.y
= max (0, s
->row
->y
);
1943 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1945 /* If drawing the cursor, don't let glyph draw outside its
1946 advertised boundaries. Cleartype does this under some circumstances. */
1947 if (s
->hl
== DRAW_CURSOR
)
1949 struct glyph
*glyph
= s
->first_glyph
;
1954 r
.width
-= s
->x
- r
.x
;
1957 r
.width
= min (r
.width
, glyph
->pixel_width
);
1959 /* If r.y is below window bottom, ensure that we still see a cursor. */
1960 height
= min (glyph
->ascent
+ glyph
->descent
,
1961 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1962 max_y
= window_text_bottom_y (s
->w
) - height
;
1963 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1964 if (s
->ybase
- glyph
->ascent
> max_y
)
1971 /* Don't draw cursor glyph taller than our actual glyph. */
1972 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1973 if (height
< r
.height
)
1975 max_y
= r
.y
+ r
.height
;
1976 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1977 r
.height
= min (max_y
- r
.y
, height
);
1984 XRectangle r_save
= r
;
1986 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1990 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1991 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1993 #ifdef CONVERT_FROM_XRECT
1994 CONVERT_FROM_XRECT (r
, *rects
);
2002 /* If we are processing overlapping and allowed to return
2003 multiple clipping rectangles, we exclude the row of the glyph
2004 string from the clipping rectangle. This is to avoid drawing
2005 the same text on the environment with anti-aliasing. */
2006 #ifdef CONVERT_FROM_XRECT
2009 XRectangle
*rs
= rects
;
2011 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2013 if (s
->for_overlaps
& OVERLAPS_PRED
)
2016 if (r
.y
+ r
.height
> row_y
)
2019 rs
[i
].height
= row_y
- r
.y
;
2025 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2028 if (r
.y
< row_y
+ s
->row
->visible_height
)
2030 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2032 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2033 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2042 #ifdef CONVERT_FROM_XRECT
2043 for (i
= 0; i
< n
; i
++)
2044 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2051 Return in *NR the clipping rectangle for glyph string S. */
2054 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2056 get_glyph_string_clip_rects (s
, nr
, 1);
2061 Return the position and height of the phys cursor in window W.
2062 Set w->phys_cursor_width to width of phys cursor.
2066 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2067 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2070 int x
, y
, wd
, h
, h0
, y0
;
2072 /* Compute the width of the rectangle to draw. If on a stretch
2073 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2074 rectangle as wide as the glyph, but use a canonical character
2076 wd
= glyph
->pixel_width
- 1;
2077 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2081 x
= w
->phys_cursor
.x
;
2088 if (glyph
->type
== STRETCH_GLYPH
2089 && !x_stretch_cursor_p
)
2090 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2091 w
->phys_cursor_width
= wd
;
2093 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2095 /* If y is below window bottom, ensure that we still see a cursor. */
2096 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2098 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2099 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2101 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2104 h
= max (h
- (y0
- y
) + 1, h0
);
2109 y0
= window_text_bottom_y (w
) - h0
;
2117 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2118 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2123 * Remember which glyph the mouse is over.
2127 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2131 struct glyph_row
*r
, *gr
, *end_row
;
2132 enum window_part part
;
2133 enum glyph_row_area area
;
2134 int x
, y
, width
, height
;
2136 /* Try to determine frame pixel position and size of the glyph under
2137 frame pixel coordinates X/Y on frame F. */
2139 if (!f
->glyphs_initialized_p
2140 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2143 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2144 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2148 w
= XWINDOW (window
);
2149 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2150 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2152 x
= window_relative_x_coord (w
, part
, gx
);
2153 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2155 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2156 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2158 if (w
->pseudo_window_p
)
2161 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2167 case ON_LEFT_MARGIN
:
2168 area
= LEFT_MARGIN_AREA
;
2171 case ON_RIGHT_MARGIN
:
2172 area
= RIGHT_MARGIN_AREA
;
2175 case ON_HEADER_LINE
:
2177 gr
= (part
== ON_HEADER_LINE
2178 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2179 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2182 goto text_glyph_row_found
;
2189 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2190 if (r
->y
+ r
->height
> y
)
2196 text_glyph_row_found
:
2199 struct glyph
*g
= gr
->glyphs
[area
];
2200 struct glyph
*end
= g
+ gr
->used
[area
];
2202 height
= gr
->height
;
2203 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2204 if (gx
+ g
->pixel_width
> x
)
2209 if (g
->type
== IMAGE_GLYPH
)
2211 /* Don't remember when mouse is over image, as
2212 image may have hot-spots. */
2213 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2216 width
= g
->pixel_width
;
2220 /* Use nominal char spacing at end of line. */
2222 gx
+= (x
/ width
) * width
;
2225 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2226 gx
+= window_box_left_offset (w
, area
);
2230 /* Use nominal line height at end of window. */
2231 gx
= (x
/ width
) * width
;
2233 gy
+= (y
/ height
) * height
;
2237 case ON_LEFT_FRINGE
:
2238 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2239 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2240 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2241 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2244 case ON_RIGHT_FRINGE
:
2245 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2246 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2247 : window_box_right_offset (w
, TEXT_AREA
));
2248 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2252 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2254 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2255 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2256 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2258 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2262 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2263 if (r
->y
+ r
->height
> y
)
2270 height
= gr
->height
;
2273 /* Use nominal line height at end of window. */
2275 gy
+= (y
/ height
) * height
;
2282 /* If there is no glyph under the mouse, then we divide the screen
2283 into a grid of the smallest glyph in the frame, and use that
2286 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2287 round down even for negative values. */
2293 gx
= (gx
/ width
) * width
;
2294 gy
= (gy
/ height
) * height
;
2299 gx
+= WINDOW_LEFT_EDGE_X (w
);
2300 gy
+= WINDOW_TOP_EDGE_Y (w
);
2303 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2305 /* Visible feedback for debugging. */
2308 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2309 f
->output_data
.x
->normal_gc
,
2310 gx
, gy
, width
, height
);
2316 #endif /* HAVE_WINDOW_SYSTEM */
2319 /***********************************************************************
2320 Lisp form evaluation
2321 ***********************************************************************/
2323 /* Error handler for safe_eval and safe_call. */
2326 safe_eval_handler (Lisp_Object arg
)
2328 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2333 /* Evaluate SEXPR and return the result, or nil if something went
2334 wrong. Prevent redisplay during the evaluation. */
2336 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2337 Return the result, or nil if something went wrong. Prevent
2338 redisplay during the evaluation. */
2341 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2345 if (inhibit_eval_during_redisplay
)
2349 int count
= SPECPDL_INDEX ();
2350 struct gcpro gcpro1
;
2353 gcpro1
.nvars
= nargs
;
2354 specbind (Qinhibit_redisplay
, Qt
);
2355 /* Use Qt to ensure debugger does not run,
2356 so there is no possibility of wanting to redisplay. */
2357 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2360 val
= unbind_to (count
, val
);
2367 /* Call function FN with one argument ARG.
2368 Return the result, or nil if something went wrong. */
2371 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2373 Lisp_Object args
[2];
2376 return safe_call (2, args
);
2379 static Lisp_Object Qeval
;
2382 safe_eval (Lisp_Object sexpr
)
2384 return safe_call1 (Qeval
, sexpr
);
2387 /* Call function FN with one argument ARG.
2388 Return the result, or nil if something went wrong. */
2391 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2393 Lisp_Object args
[3];
2397 return safe_call (3, args
);
2402 /***********************************************************************
2404 ***********************************************************************/
2408 /* Define CHECK_IT to perform sanity checks on iterators.
2409 This is for debugging. It is too slow to do unconditionally. */
2412 check_it (struct it
*it
)
2414 if (it
->method
== GET_FROM_STRING
)
2416 xassert (STRINGP (it
->string
));
2417 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2421 xassert (IT_STRING_CHARPOS (*it
) < 0);
2422 if (it
->method
== GET_FROM_BUFFER
)
2424 /* Check that character and byte positions agree. */
2425 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2430 xassert (it
->current
.dpvec_index
>= 0);
2432 xassert (it
->current
.dpvec_index
< 0);
2435 #define CHECK_IT(IT) check_it ((IT))
2439 #define CHECK_IT(IT) (void) 0
2444 #if GLYPH_DEBUG && XASSERTS
2446 /* Check that the window end of window W is what we expect it
2447 to be---the last row in the current matrix displaying text. */
2450 check_window_end (struct window
*w
)
2452 if (!MINI_WINDOW_P (w
)
2453 && !NILP (w
->window_end_valid
))
2455 struct glyph_row
*row
;
2456 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2457 XFASTINT (w
->window_end_vpos
)),
2459 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2460 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2464 #define CHECK_WINDOW_END(W) check_window_end ((W))
2468 #define CHECK_WINDOW_END(W) (void) 0
2474 /***********************************************************************
2475 Iterator initialization
2476 ***********************************************************************/
2478 /* Initialize IT for displaying current_buffer in window W, starting
2479 at character position CHARPOS. CHARPOS < 0 means that no buffer
2480 position is specified which is useful when the iterator is assigned
2481 a position later. BYTEPOS is the byte position corresponding to
2482 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2484 If ROW is not null, calls to produce_glyphs with IT as parameter
2485 will produce glyphs in that row.
2487 BASE_FACE_ID is the id of a base face to use. It must be one of
2488 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2489 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2490 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2492 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2493 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2494 will be initialized to use the corresponding mode line glyph row of
2495 the desired matrix of W. */
2498 init_iterator (struct it
*it
, struct window
*w
,
2499 EMACS_INT charpos
, EMACS_INT bytepos
,
2500 struct glyph_row
*row
, enum face_id base_face_id
)
2502 int highlight_region_p
;
2503 enum face_id remapped_base_face_id
= base_face_id
;
2505 /* Some precondition checks. */
2506 xassert (w
!= NULL
&& it
!= NULL
);
2507 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2510 /* If face attributes have been changed since the last redisplay,
2511 free realized faces now because they depend on face definitions
2512 that might have changed. Don't free faces while there might be
2513 desired matrices pending which reference these faces. */
2514 if (face_change_count
&& !inhibit_free_realized_faces
)
2516 face_change_count
= 0;
2517 free_all_realized_faces (Qnil
);
2520 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2521 if (! NILP (Vface_remapping_alist
))
2522 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2524 /* Use one of the mode line rows of W's desired matrix if
2528 if (base_face_id
== MODE_LINE_FACE_ID
2529 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2530 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2531 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2532 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2536 memset (it
, 0, sizeof *it
);
2537 it
->current
.overlay_string_index
= -1;
2538 it
->current
.dpvec_index
= -1;
2539 it
->base_face_id
= remapped_base_face_id
;
2541 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2542 it
->paragraph_embedding
= L2R
;
2543 it
->bidi_it
.string
.lstring
= Qnil
;
2544 it
->bidi_it
.string
.s
= NULL
;
2545 it
->bidi_it
.string
.bufpos
= 0;
2547 /* The window in which we iterate over current_buffer: */
2548 XSETWINDOW (it
->window
, w
);
2550 it
->f
= XFRAME (w
->frame
);
2554 /* Extra space between lines (on window systems only). */
2555 if (base_face_id
== DEFAULT_FACE_ID
2556 && FRAME_WINDOW_P (it
->f
))
2558 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2559 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2560 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2561 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2562 * FRAME_LINE_HEIGHT (it
->f
));
2563 else if (it
->f
->extra_line_spacing
> 0)
2564 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2565 it
->max_extra_line_spacing
= 0;
2568 /* If realized faces have been removed, e.g. because of face
2569 attribute changes of named faces, recompute them. When running
2570 in batch mode, the face cache of the initial frame is null. If
2571 we happen to get called, make a dummy face cache. */
2572 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2573 init_frame_faces (it
->f
);
2574 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2575 recompute_basic_faces (it
->f
);
2577 /* Current value of the `slice', `space-width', and 'height' properties. */
2578 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2579 it
->space_width
= Qnil
;
2580 it
->font_height
= Qnil
;
2581 it
->override_ascent
= -1;
2583 /* Are control characters displayed as `^C'? */
2584 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2586 /* -1 means everything between a CR and the following line end
2587 is invisible. >0 means lines indented more than this value are
2589 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2590 ? XINT (BVAR (current_buffer
, selective_display
))
2591 : (!NILP (BVAR (current_buffer
, selective_display
))
2593 it
->selective_display_ellipsis_p
2594 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2596 /* Display table to use. */
2597 it
->dp
= window_display_table (w
);
2599 /* Are multibyte characters enabled in current_buffer? */
2600 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2602 /* Non-zero if we should highlight the region. */
2604 = (!NILP (Vtransient_mark_mode
)
2605 && !NILP (BVAR (current_buffer
, mark_active
))
2606 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2608 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2609 start and end of a visible region in window IT->w. Set both to
2610 -1 to indicate no region. */
2611 if (highlight_region_p
2612 /* Maybe highlight only in selected window. */
2613 && (/* Either show region everywhere. */
2614 highlight_nonselected_windows
2615 /* Or show region in the selected window. */
2616 || w
== XWINDOW (selected_window
)
2617 /* Or show the region if we are in the mini-buffer and W is
2618 the window the mini-buffer refers to. */
2619 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2620 && WINDOWP (minibuf_selected_window
)
2621 && w
== XWINDOW (minibuf_selected_window
))))
2623 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2624 it
->region_beg_charpos
= min (PT
, markpos
);
2625 it
->region_end_charpos
= max (PT
, markpos
);
2628 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2630 /* Get the position at which the redisplay_end_trigger hook should
2631 be run, if it is to be run at all. */
2632 if (MARKERP (w
->redisplay_end_trigger
)
2633 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2634 it
->redisplay_end_trigger_charpos
2635 = marker_position (w
->redisplay_end_trigger
);
2636 else if (INTEGERP (w
->redisplay_end_trigger
))
2637 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2639 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2641 /* Are lines in the display truncated? */
2642 if (base_face_id
!= DEFAULT_FACE_ID
2643 || XINT (it
->w
->hscroll
)
2644 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2645 && ((!NILP (Vtruncate_partial_width_windows
)
2646 && !INTEGERP (Vtruncate_partial_width_windows
))
2647 || (INTEGERP (Vtruncate_partial_width_windows
)
2648 && (WINDOW_TOTAL_COLS (it
->w
)
2649 < XINT (Vtruncate_partial_width_windows
))))))
2650 it
->line_wrap
= TRUNCATE
;
2651 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2652 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2653 ? WINDOW_WRAP
: WORD_WRAP
;
2655 it
->line_wrap
= TRUNCATE
;
2657 /* Get dimensions of truncation and continuation glyphs. These are
2658 displayed as fringe bitmaps under X, so we don't need them for such
2660 if (!FRAME_WINDOW_P (it
->f
))
2662 if (it
->line_wrap
== TRUNCATE
)
2664 /* We will need the truncation glyph. */
2665 xassert (it
->glyph_row
== NULL
);
2666 produce_special_glyphs (it
, IT_TRUNCATION
);
2667 it
->truncation_pixel_width
= it
->pixel_width
;
2671 /* We will need the continuation glyph. */
2672 xassert (it
->glyph_row
== NULL
);
2673 produce_special_glyphs (it
, IT_CONTINUATION
);
2674 it
->continuation_pixel_width
= it
->pixel_width
;
2677 /* Reset these values to zero because the produce_special_glyphs
2678 above has changed them. */
2679 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2680 it
->phys_ascent
= it
->phys_descent
= 0;
2683 /* Set this after getting the dimensions of truncation and
2684 continuation glyphs, so that we don't produce glyphs when calling
2685 produce_special_glyphs, above. */
2686 it
->glyph_row
= row
;
2687 it
->area
= TEXT_AREA
;
2689 /* Forget any previous info about this row being reversed. */
2691 it
->glyph_row
->reversed_p
= 0;
2693 /* Get the dimensions of the display area. The display area
2694 consists of the visible window area plus a horizontally scrolled
2695 part to the left of the window. All x-values are relative to the
2696 start of this total display area. */
2697 if (base_face_id
!= DEFAULT_FACE_ID
)
2699 /* Mode lines, menu bar in terminal frames. */
2700 it
->first_visible_x
= 0;
2701 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2706 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2707 it
->last_visible_x
= (it
->first_visible_x
2708 + window_box_width (w
, TEXT_AREA
));
2710 /* If we truncate lines, leave room for the truncator glyph(s) at
2711 the right margin. Otherwise, leave room for the continuation
2712 glyph(s). Truncation and continuation glyphs are not inserted
2713 for window-based redisplay. */
2714 if (!FRAME_WINDOW_P (it
->f
))
2716 if (it
->line_wrap
== TRUNCATE
)
2717 it
->last_visible_x
-= it
->truncation_pixel_width
;
2719 it
->last_visible_x
-= it
->continuation_pixel_width
;
2722 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2723 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2726 /* Leave room for a border glyph. */
2727 if (!FRAME_WINDOW_P (it
->f
)
2728 && !WINDOW_RIGHTMOST_P (it
->w
))
2729 it
->last_visible_x
-= 1;
2731 it
->last_visible_y
= window_text_bottom_y (w
);
2733 /* For mode lines and alike, arrange for the first glyph having a
2734 left box line if the face specifies a box. */
2735 if (base_face_id
!= DEFAULT_FACE_ID
)
2739 it
->face_id
= remapped_base_face_id
;
2741 /* If we have a boxed mode line, make the first character appear
2742 with a left box line. */
2743 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2744 if (face
->box
!= FACE_NO_BOX
)
2745 it
->start_of_box_run_p
= 1;
2748 /* If a buffer position was specified, set the iterator there,
2749 getting overlays and face properties from that position. */
2750 if (charpos
>= BUF_BEG (current_buffer
))
2752 it
->end_charpos
= ZV
;
2754 IT_CHARPOS (*it
) = charpos
;
2756 /* Compute byte position if not specified. */
2757 if (bytepos
< charpos
)
2758 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2760 IT_BYTEPOS (*it
) = bytepos
;
2762 it
->start
= it
->current
;
2763 /* Do we need to reorder bidirectional text? Not if this is a
2764 unibyte buffer: by definition, none of the single-byte
2765 characters are strong R2L, so no reordering is needed. And
2766 bidi.c doesn't support unibyte buffers anyway. Also, don't
2767 reorder while we are loading loadup.el, since the tables of
2768 character properties needed for reordering are not yet
2772 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2775 /* If we are to reorder bidirectional text, init the bidi
2779 /* Note the paragraph direction that this buffer wants to
2781 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2783 it
->paragraph_embedding
= L2R
;
2784 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2786 it
->paragraph_embedding
= R2L
;
2788 it
->paragraph_embedding
= NEUTRAL_DIR
;
2789 bidi_unshelve_cache (NULL
, 0);
2790 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2794 /* Compute faces etc. */
2795 reseat (it
, it
->current
.pos
, 1);
2802 /* Initialize IT for the display of window W with window start POS. */
2805 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2807 struct glyph_row
*row
;
2808 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2810 row
= w
->desired_matrix
->rows
+ first_vpos
;
2811 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2812 it
->first_vpos
= first_vpos
;
2814 /* Don't reseat to previous visible line start if current start
2815 position is in a string or image. */
2816 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2818 int start_at_line_beg_p
;
2819 int first_y
= it
->current_y
;
2821 /* If window start is not at a line start, skip forward to POS to
2822 get the correct continuation lines width. */
2823 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2824 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2825 if (!start_at_line_beg_p
)
2829 reseat_at_previous_visible_line_start (it
);
2830 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2832 new_x
= it
->current_x
+ it
->pixel_width
;
2834 /* If lines are continued, this line may end in the middle
2835 of a multi-glyph character (e.g. a control character
2836 displayed as \003, or in the middle of an overlay
2837 string). In this case move_it_to above will not have
2838 taken us to the start of the continuation line but to the
2839 end of the continued line. */
2840 if (it
->current_x
> 0
2841 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2842 && (/* And glyph doesn't fit on the line. */
2843 new_x
> it
->last_visible_x
2844 /* Or it fits exactly and we're on a window
2846 || (new_x
== it
->last_visible_x
2847 && FRAME_WINDOW_P (it
->f
))))
2849 if ((it
->current
.dpvec_index
>= 0
2850 || it
->current
.overlay_string_index
>= 0)
2851 /* If we are on a newline from a display vector or
2852 overlay string, then we are already at the end of
2853 a screen line; no need to go to the next line in
2854 that case, as this line is not really continued.
2855 (If we do go to the next line, C-e will not DTRT.) */
2858 set_iterator_to_next (it
, 1);
2859 move_it_in_display_line_to (it
, -1, -1, 0);
2862 it
->continuation_lines_width
+= it
->current_x
;
2864 /* If the character at POS is displayed via a display
2865 vector, move_it_to above stops at the final glyph of
2866 IT->dpvec. To make the caller redisplay that character
2867 again (a.k.a. start at POS), we need to reset the
2868 dpvec_index to the beginning of IT->dpvec. */
2869 else if (it
->current
.dpvec_index
>= 0)
2870 it
->current
.dpvec_index
= 0;
2872 /* We're starting a new display line, not affected by the
2873 height of the continued line, so clear the appropriate
2874 fields in the iterator structure. */
2875 it
->max_ascent
= it
->max_descent
= 0;
2876 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2878 it
->current_y
= first_y
;
2880 it
->current_x
= it
->hpos
= 0;
2886 /* Return 1 if POS is a position in ellipses displayed for invisible
2887 text. W is the window we display, for text property lookup. */
2890 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2892 Lisp_Object prop
, window
;
2894 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2896 /* If POS specifies a position in a display vector, this might
2897 be for an ellipsis displayed for invisible text. We won't
2898 get the iterator set up for delivering that ellipsis unless
2899 we make sure that it gets aware of the invisible text. */
2900 if (pos
->dpvec_index
>= 0
2901 && pos
->overlay_string_index
< 0
2902 && CHARPOS (pos
->string_pos
) < 0
2904 && (XSETWINDOW (window
, w
),
2905 prop
= Fget_char_property (make_number (charpos
),
2906 Qinvisible
, window
),
2907 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2909 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2911 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2918 /* Initialize IT for stepping through current_buffer in window W,
2919 starting at position POS that includes overlay string and display
2920 vector/ control character translation position information. Value
2921 is zero if there are overlay strings with newlines at POS. */
2924 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2926 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2927 int i
, overlay_strings_with_newlines
= 0;
2929 /* If POS specifies a position in a display vector, this might
2930 be for an ellipsis displayed for invisible text. We won't
2931 get the iterator set up for delivering that ellipsis unless
2932 we make sure that it gets aware of the invisible text. */
2933 if (in_ellipses_for_invisible_text_p (pos
, w
))
2939 /* Keep in mind: the call to reseat in init_iterator skips invisible
2940 text, so we might end up at a position different from POS. This
2941 is only a problem when POS is a row start after a newline and an
2942 overlay starts there with an after-string, and the overlay has an
2943 invisible property. Since we don't skip invisible text in
2944 display_line and elsewhere immediately after consuming the
2945 newline before the row start, such a POS will not be in a string,
2946 but the call to init_iterator below will move us to the
2948 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2950 /* This only scans the current chunk -- it should scan all chunks.
2951 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2952 to 16 in 22.1 to make this a lesser problem. */
2953 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2955 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2956 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2958 while (s
< e
&& *s
!= '\n')
2963 overlay_strings_with_newlines
= 1;
2968 /* If position is within an overlay string, set up IT to the right
2970 if (pos
->overlay_string_index
>= 0)
2974 /* If the first overlay string happens to have a `display'
2975 property for an image, the iterator will be set up for that
2976 image, and we have to undo that setup first before we can
2977 correct the overlay string index. */
2978 if (it
->method
== GET_FROM_IMAGE
)
2981 /* We already have the first chunk of overlay strings in
2982 IT->overlay_strings. Load more until the one for
2983 pos->overlay_string_index is in IT->overlay_strings. */
2984 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2986 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2987 it
->current
.overlay_string_index
= 0;
2990 load_overlay_strings (it
, 0);
2991 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2995 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2996 relative_index
= (it
->current
.overlay_string_index
2997 % OVERLAY_STRING_CHUNK_SIZE
);
2998 it
->string
= it
->overlay_strings
[relative_index
];
2999 xassert (STRINGP (it
->string
));
3000 it
->current
.string_pos
= pos
->string_pos
;
3001 it
->method
= GET_FROM_STRING
;
3004 if (CHARPOS (pos
->string_pos
) >= 0)
3006 /* Recorded position is not in an overlay string, but in another
3007 string. This can only be a string from a `display' property.
3008 IT should already be filled with that string. */
3009 it
->current
.string_pos
= pos
->string_pos
;
3010 xassert (STRINGP (it
->string
));
3013 /* Restore position in display vector translations, control
3014 character translations or ellipses. */
3015 if (pos
->dpvec_index
>= 0)
3017 if (it
->dpvec
== NULL
)
3018 get_next_display_element (it
);
3019 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3020 it
->current
.dpvec_index
= pos
->dpvec_index
;
3024 return !overlay_strings_with_newlines
;
3028 /* Initialize IT for stepping through current_buffer in window W
3029 starting at ROW->start. */
3032 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3034 init_from_display_pos (it
, w
, &row
->start
);
3035 it
->start
= row
->start
;
3036 it
->continuation_lines_width
= row
->continuation_lines_width
;
3041 /* Initialize IT for stepping through current_buffer in window W
3042 starting in the line following ROW, i.e. starting at ROW->end.
3043 Value is zero if there are overlay strings with newlines at ROW's
3047 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3051 if (init_from_display_pos (it
, w
, &row
->end
))
3053 if (row
->continued_p
)
3054 it
->continuation_lines_width
3055 = row
->continuation_lines_width
+ row
->pixel_width
;
3066 /***********************************************************************
3068 ***********************************************************************/
3070 /* Called when IT reaches IT->stop_charpos. Handle text property and
3071 overlay changes. Set IT->stop_charpos to the next position where
3075 handle_stop (struct it
*it
)
3077 enum prop_handled handled
;
3078 int handle_overlay_change_p
;
3082 it
->current
.dpvec_index
= -1;
3083 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3084 it
->ignore_overlay_strings_at_pos_p
= 0;
3087 /* Use face of preceding text for ellipsis (if invisible) */
3088 if (it
->selective_display_ellipsis_p
)
3089 it
->saved_face_id
= it
->face_id
;
3093 handled
= HANDLED_NORMALLY
;
3095 /* Call text property handlers. */
3096 for (p
= it_props
; p
->handler
; ++p
)
3098 handled
= p
->handler (it
);
3100 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3102 else if (handled
== HANDLED_RETURN
)
3104 /* We still want to show before and after strings from
3105 overlays even if the actual buffer text is replaced. */
3106 if (!handle_overlay_change_p
3108 || !get_overlay_strings_1 (it
, 0, 0))
3111 setup_for_ellipsis (it
, 0);
3112 /* When handling a display spec, we might load an
3113 empty string. In that case, discard it here. We
3114 used to discard it in handle_single_display_spec,
3115 but that causes get_overlay_strings_1, above, to
3116 ignore overlay strings that we must check. */
3117 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3121 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3125 it
->ignore_overlay_strings_at_pos_p
= 1;
3126 it
->string_from_display_prop_p
= 0;
3127 it
->from_disp_prop_p
= 0;
3128 handle_overlay_change_p
= 0;
3130 handled
= HANDLED_RECOMPUTE_PROPS
;
3133 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3134 handle_overlay_change_p
= 0;
3137 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3139 /* Don't check for overlay strings below when set to deliver
3140 characters from a display vector. */
3141 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3142 handle_overlay_change_p
= 0;
3144 /* Handle overlay changes.
3145 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3146 if it finds overlays. */
3147 if (handle_overlay_change_p
)
3148 handled
= handle_overlay_change (it
);
3153 setup_for_ellipsis (it
, 0);
3157 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3159 /* Determine where to stop next. */
3160 if (handled
== HANDLED_NORMALLY
)
3161 compute_stop_pos (it
);
3165 /* Compute IT->stop_charpos from text property and overlay change
3166 information for IT's current position. */
3169 compute_stop_pos (struct it
*it
)
3171 register INTERVAL iv
, next_iv
;
3172 Lisp_Object object
, limit
, position
;
3173 EMACS_INT charpos
, bytepos
;
3175 if (STRINGP (it
->string
))
3177 /* Strings are usually short, so don't limit the search for
3179 it
->stop_charpos
= it
->end_charpos
;
3180 object
= it
->string
;
3182 charpos
= IT_STRING_CHARPOS (*it
);
3183 bytepos
= IT_STRING_BYTEPOS (*it
);
3189 /* If end_charpos is out of range for some reason, such as a
3190 misbehaving display function, rationalize it (Bug#5984). */
3191 if (it
->end_charpos
> ZV
)
3192 it
->end_charpos
= ZV
;
3193 it
->stop_charpos
= it
->end_charpos
;
3195 /* If next overlay change is in front of the current stop pos
3196 (which is IT->end_charpos), stop there. Note: value of
3197 next_overlay_change is point-max if no overlay change
3199 charpos
= IT_CHARPOS (*it
);
3200 bytepos
= IT_BYTEPOS (*it
);
3201 pos
= next_overlay_change (charpos
);
3202 if (pos
< it
->stop_charpos
)
3203 it
->stop_charpos
= pos
;
3205 /* If showing the region, we have to stop at the region
3206 start or end because the face might change there. */
3207 if (it
->region_beg_charpos
> 0)
3209 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3210 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3211 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3212 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3215 /* Set up variables for computing the stop position from text
3216 property changes. */
3217 XSETBUFFER (object
, current_buffer
);
3218 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3221 /* Get the interval containing IT's position. Value is a null
3222 interval if there isn't such an interval. */
3223 position
= make_number (charpos
);
3224 iv
= validate_interval_range (object
, &position
, &position
, 0);
3225 if (!NULL_INTERVAL_P (iv
))
3227 Lisp_Object values_here
[LAST_PROP_IDX
];
3230 /* Get properties here. */
3231 for (p
= it_props
; p
->handler
; ++p
)
3232 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3234 /* Look for an interval following iv that has different
3236 for (next_iv
= next_interval (iv
);
3237 (!NULL_INTERVAL_P (next_iv
)
3239 || XFASTINT (limit
) > next_iv
->position
));
3240 next_iv
= next_interval (next_iv
))
3242 for (p
= it_props
; p
->handler
; ++p
)
3244 Lisp_Object new_value
;
3246 new_value
= textget (next_iv
->plist
, *p
->name
);
3247 if (!EQ (values_here
[p
->idx
], new_value
))
3255 if (!NULL_INTERVAL_P (next_iv
))
3257 if (INTEGERP (limit
)
3258 && next_iv
->position
>= XFASTINT (limit
))
3259 /* No text property change up to limit. */
3260 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3262 /* Text properties change in next_iv. */
3263 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3267 if (it
->cmp_it
.id
< 0)
3269 EMACS_INT stoppos
= it
->end_charpos
;
3271 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3273 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3274 stoppos
, it
->string
);
3277 xassert (STRINGP (it
->string
)
3278 || (it
->stop_charpos
>= BEGV
3279 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3283 /* Return the position of the next overlay change after POS in
3284 current_buffer. Value is point-max if no overlay change
3285 follows. This is like `next-overlay-change' but doesn't use
3289 next_overlay_change (EMACS_INT pos
)
3291 ptrdiff_t i
, noverlays
;
3293 Lisp_Object
*overlays
;
3295 /* Get all overlays at the given position. */
3296 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3298 /* If any of these overlays ends before endpos,
3299 use its ending point instead. */
3300 for (i
= 0; i
< noverlays
; ++i
)
3305 oend
= OVERLAY_END (overlays
[i
]);
3306 oendpos
= OVERLAY_POSITION (oend
);
3307 endpos
= min (endpos
, oendpos
);
3313 /* How many characters forward to search for a display property or
3314 display string. Searching too far forward makes the bidi display
3315 sluggish, especially in small windows. */
3316 #define MAX_DISP_SCAN 250
3318 /* Return the character position of a display string at or after
3319 position specified by POSITION. If no display string exists at or
3320 after POSITION, return ZV. A display string is either an overlay
3321 with `display' property whose value is a string, or a `display'
3322 text property whose value is a string. STRING is data about the
3323 string to iterate; if STRING->lstring is nil, we are iterating a
3324 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3325 on a GUI frame. DISP_PROP is set to zero if we searched
3326 MAX_DISP_SCAN characters forward without finding any display
3327 strings, non-zero otherwise. It is set to 2 if the display string
3328 uses any kind of `(space ...)' spec that will produce a stretch of
3329 white space in the text area. */
3331 compute_display_string_pos (struct text_pos
*position
,
3332 struct bidi_string_data
*string
,
3333 int frame_window_p
, int *disp_prop
)
3335 /* OBJECT = nil means current buffer. */
3336 Lisp_Object object
=
3337 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3338 Lisp_Object pos
, spec
, limpos
;
3339 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3340 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3341 EMACS_INT begb
= string_p
? 0 : BEGV
;
3342 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3344 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3345 struct text_pos tpos
;
3351 /* We don't support display properties whose values are strings
3352 that have display string properties. */
3353 || string
->from_disp_str
3354 /* C strings cannot have display properties. */
3355 || (string
->s
&& !STRINGP (object
)))
3361 /* If the character at CHARPOS is where the display string begins,
3363 pos
= make_number (charpos
);
3364 if (STRINGP (object
))
3365 bufpos
= string
->bufpos
;
3369 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3371 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3374 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3382 /* Look forward for the first character with a `display' property
3383 that will replace the underlying text when displayed. */
3384 limpos
= make_number (lim
);
3386 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3387 CHARPOS (tpos
) = XFASTINT (pos
);
3388 if (CHARPOS (tpos
) >= lim
)
3393 if (STRINGP (object
))
3394 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3396 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3397 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3398 if (!STRINGP (object
))
3399 bufpos
= CHARPOS (tpos
);
3400 } while (NILP (spec
)
3401 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3402 bufpos
, frame_window_p
)));
3406 return CHARPOS (tpos
);
3409 /* Return the character position of the end of the display string that
3410 started at CHARPOS. If there's no display string at CHARPOS,
3411 return -1. A display string is either an overlay with `display'
3412 property whose value is a string or a `display' text property whose
3413 value is a string. */
3415 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3417 /* OBJECT = nil means current buffer. */
3418 Lisp_Object object
=
3419 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3420 Lisp_Object pos
= make_number (charpos
);
3422 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3424 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3427 /* It could happen that the display property or overlay was removed
3428 since we found it in compute_display_string_pos above. One way
3429 this can happen is if JIT font-lock was called (through
3430 handle_fontified_prop), and jit-lock-functions remove text
3431 properties or overlays from the portion of buffer that includes
3432 CHARPOS. Muse mode is known to do that, for example. In this
3433 case, we return -1 to the caller, to signal that no display
3434 string is actually present at CHARPOS. See bidi_fetch_char for
3435 how this is handled.
3437 An alternative would be to never look for display properties past
3438 it->stop_charpos. But neither compute_display_string_pos nor
3439 bidi_fetch_char that calls it know or care where the next
3441 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3444 /* Look forward for the first character where the `display' property
3446 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3448 return XFASTINT (pos
);
3453 /***********************************************************************
3455 ***********************************************************************/
3457 /* Handle changes in the `fontified' property of the current buffer by
3458 calling hook functions from Qfontification_functions to fontify
3461 static enum prop_handled
3462 handle_fontified_prop (struct it
*it
)
3464 Lisp_Object prop
, pos
;
3465 enum prop_handled handled
= HANDLED_NORMALLY
;
3467 if (!NILP (Vmemory_full
))
3470 /* Get the value of the `fontified' property at IT's current buffer
3471 position. (The `fontified' property doesn't have a special
3472 meaning in strings.) If the value is nil, call functions from
3473 Qfontification_functions. */
3474 if (!STRINGP (it
->string
)
3476 && !NILP (Vfontification_functions
)
3477 && !NILP (Vrun_hooks
)
3478 && (pos
= make_number (IT_CHARPOS (*it
)),
3479 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3480 /* Ignore the special cased nil value always present at EOB since
3481 no amount of fontifying will be able to change it. */
3482 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3484 int count
= SPECPDL_INDEX ();
3486 struct buffer
*obuf
= current_buffer
;
3487 int begv
= BEGV
, zv
= ZV
;
3488 int old_clip_changed
= current_buffer
->clip_changed
;
3490 val
= Vfontification_functions
;
3491 specbind (Qfontification_functions
, Qnil
);
3493 xassert (it
->end_charpos
== ZV
);
3495 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3496 safe_call1 (val
, pos
);
3499 Lisp_Object fns
, fn
;
3500 struct gcpro gcpro1
, gcpro2
;
3505 for (; CONSP (val
); val
= XCDR (val
))
3511 /* A value of t indicates this hook has a local
3512 binding; it means to run the global binding too.
3513 In a global value, t should not occur. If it
3514 does, we must ignore it to avoid an endless
3516 for (fns
= Fdefault_value (Qfontification_functions
);
3522 safe_call1 (fn
, pos
);
3526 safe_call1 (fn
, pos
);
3532 unbind_to (count
, Qnil
);
3534 /* Fontification functions routinely call `save-restriction'.
3535 Normally, this tags clip_changed, which can confuse redisplay
3536 (see discussion in Bug#6671). Since we don't perform any
3537 special handling of fontification changes in the case where
3538 `save-restriction' isn't called, there's no point doing so in
3539 this case either. So, if the buffer's restrictions are
3540 actually left unchanged, reset clip_changed. */
3541 if (obuf
== current_buffer
)
3543 if (begv
== BEGV
&& zv
== ZV
)
3544 current_buffer
->clip_changed
= old_clip_changed
;
3546 /* There isn't much we can reasonably do to protect against
3547 misbehaving fontification, but here's a fig leaf. */
3548 else if (!NILP (BVAR (obuf
, name
)))
3549 set_buffer_internal_1 (obuf
);
3551 /* The fontification code may have added/removed text.
3552 It could do even a lot worse, but let's at least protect against
3553 the most obvious case where only the text past `pos' gets changed',
3554 as is/was done in grep.el where some escapes sequences are turned
3555 into face properties (bug#7876). */
3556 it
->end_charpos
= ZV
;
3558 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3559 something. This avoids an endless loop if they failed to
3560 fontify the text for which reason ever. */
3561 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3562 handled
= HANDLED_RECOMPUTE_PROPS
;
3570 /***********************************************************************
3572 ***********************************************************************/
3574 /* Set up iterator IT from face properties at its current position.
3575 Called from handle_stop. */
3577 static enum prop_handled
3578 handle_face_prop (struct it
*it
)
3581 EMACS_INT next_stop
;
3583 if (!STRINGP (it
->string
))
3586 = face_at_buffer_position (it
->w
,
3588 it
->region_beg_charpos
,
3589 it
->region_end_charpos
,
3592 + TEXT_PROP_DISTANCE_LIMIT
),
3593 0, it
->base_face_id
);
3595 /* Is this a start of a run of characters with box face?
3596 Caveat: this can be called for a freshly initialized
3597 iterator; face_id is -1 in this case. We know that the new
3598 face will not change until limit, i.e. if the new face has a
3599 box, all characters up to limit will have one. But, as
3600 usual, we don't know whether limit is really the end. */
3601 if (new_face_id
!= it
->face_id
)
3603 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3605 /* If new face has a box but old face has not, this is
3606 the start of a run of characters with box, i.e. it has
3607 a shadow on the left side. The value of face_id of the
3608 iterator will be -1 if this is the initial call that gets
3609 the face. In this case, we have to look in front of IT's
3610 position and see whether there is a face != new_face_id. */
3611 it
->start_of_box_run_p
3612 = (new_face
->box
!= FACE_NO_BOX
3613 && (it
->face_id
>= 0
3614 || IT_CHARPOS (*it
) == BEG
3615 || new_face_id
!= face_before_it_pos (it
)));
3616 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3624 Lisp_Object from_overlay
3625 = (it
->current
.overlay_string_index
>= 0
3626 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3629 /* See if we got to this string directly or indirectly from
3630 an overlay property. That includes the before-string or
3631 after-string of an overlay, strings in display properties
3632 provided by an overlay, their text properties, etc.
3634 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3635 if (! NILP (from_overlay
))
3636 for (i
= it
->sp
- 1; i
>= 0; i
--)
3638 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3640 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3641 else if (! NILP (it
->stack
[i
].from_overlay
))
3642 from_overlay
= it
->stack
[i
].from_overlay
;
3644 if (!NILP (from_overlay
))
3648 if (! NILP (from_overlay
))
3650 bufpos
= IT_CHARPOS (*it
);
3651 /* For a string from an overlay, the base face depends
3652 only on text properties and ignores overlays. */
3654 = face_for_overlay_string (it
->w
,
3656 it
->region_beg_charpos
,
3657 it
->region_end_charpos
,
3660 + TEXT_PROP_DISTANCE_LIMIT
),
3668 /* For strings from a `display' property, use the face at
3669 IT's current buffer position as the base face to merge
3670 with, so that overlay strings appear in the same face as
3671 surrounding text, unless they specify their own
3673 base_face_id
= underlying_face_id (it
);
3676 new_face_id
= face_at_string_position (it
->w
,
3678 IT_STRING_CHARPOS (*it
),
3680 it
->region_beg_charpos
,
3681 it
->region_end_charpos
,
3685 /* Is this a start of a run of characters with box? Caveat:
3686 this can be called for a freshly allocated iterator; face_id
3687 is -1 is this case. We know that the new face will not
3688 change until the next check pos, i.e. if the new face has a
3689 box, all characters up to that position will have a
3690 box. But, as usual, we don't know whether that position
3691 is really the end. */
3692 if (new_face_id
!= it
->face_id
)
3694 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3695 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3697 /* If new face has a box but old face hasn't, this is the
3698 start of a run of characters with box, i.e. it has a
3699 shadow on the left side. */
3700 it
->start_of_box_run_p
3701 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3702 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3706 it
->face_id
= new_face_id
;
3707 return HANDLED_NORMALLY
;
3711 /* Return the ID of the face ``underlying'' IT's current position,
3712 which is in a string. If the iterator is associated with a
3713 buffer, return the face at IT's current buffer position.
3714 Otherwise, use the iterator's base_face_id. */
3717 underlying_face_id (struct it
*it
)
3719 int face_id
= it
->base_face_id
, i
;
3721 xassert (STRINGP (it
->string
));
3723 for (i
= it
->sp
- 1; i
>= 0; --i
)
3724 if (NILP (it
->stack
[i
].string
))
3725 face_id
= it
->stack
[i
].face_id
;
3731 /* Compute the face one character before or after the current position
3732 of IT, in the visual order. BEFORE_P non-zero means get the face
3733 in front (to the left in L2R paragraphs, to the right in R2L
3734 paragraphs) of IT's screen position. Value is the ID of the face. */
3737 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3740 EMACS_INT next_check_charpos
;
3742 void *it_copy_data
= NULL
;
3744 xassert (it
->s
== NULL
);
3746 if (STRINGP (it
->string
))
3748 EMACS_INT bufpos
, charpos
;
3751 /* No face change past the end of the string (for the case
3752 we are padding with spaces). No face change before the
3754 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3755 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3760 /* Set charpos to the position before or after IT's current
3761 position, in the logical order, which in the non-bidi
3762 case is the same as the visual order. */
3764 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3765 else if (it
->what
== IT_COMPOSITION
)
3766 /* For composition, we must check the character after the
3768 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3770 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3776 /* With bidi iteration, the character before the current
3777 in the visual order cannot be found by simple
3778 iteration, because "reverse" reordering is not
3779 supported. Instead, we need to use the move_it_*
3780 family of functions. */
3781 /* Ignore face changes before the first visible
3782 character on this display line. */
3783 if (it
->current_x
<= it
->first_visible_x
)
3785 SAVE_IT (it_copy
, *it
, it_copy_data
);
3786 /* Implementation note: Since move_it_in_display_line
3787 works in the iterator geometry, and thinks the first
3788 character is always the leftmost, even in R2L lines,
3789 we don't need to distinguish between the R2L and L2R
3791 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3792 it_copy
.current_x
- 1, MOVE_TO_X
);
3793 charpos
= IT_STRING_CHARPOS (it_copy
);
3794 RESTORE_IT (it
, it
, it_copy_data
);
3798 /* Set charpos to the string position of the character
3799 that comes after IT's current position in the visual
3801 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3805 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3807 charpos
= it_copy
.bidi_it
.charpos
;
3810 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3812 if (it
->current
.overlay_string_index
>= 0)
3813 bufpos
= IT_CHARPOS (*it
);
3817 base_face_id
= underlying_face_id (it
);
3819 /* Get the face for ASCII, or unibyte. */
3820 face_id
= face_at_string_position (it
->w
,
3824 it
->region_beg_charpos
,
3825 it
->region_end_charpos
,
3826 &next_check_charpos
,
3829 /* Correct the face for charsets different from ASCII. Do it
3830 for the multibyte case only. The face returned above is
3831 suitable for unibyte text if IT->string is unibyte. */
3832 if (STRING_MULTIBYTE (it
->string
))
3834 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3835 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3837 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3839 c
= string_char_and_length (p
, &len
);
3840 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3845 struct text_pos pos
;
3847 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3848 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3851 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3852 pos
= it
->current
.pos
;
3857 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3860 if (it
->what
== IT_COMPOSITION
)
3862 /* For composition, we must check the position after
3864 pos
.charpos
+= it
->cmp_it
.nchars
;
3865 pos
.bytepos
+= it
->len
;
3868 INC_TEXT_POS (pos
, it
->multibyte_p
);
3875 /* With bidi iteration, the character before the current
3876 in the visual order cannot be found by simple
3877 iteration, because "reverse" reordering is not
3878 supported. Instead, we need to use the move_it_*
3879 family of functions. */
3880 /* Ignore face changes before the first visible
3881 character on this display line. */
3882 if (it
->current_x
<= it
->first_visible_x
)
3884 SAVE_IT (it_copy
, *it
, it_copy_data
);
3885 /* Implementation note: Since move_it_in_display_line
3886 works in the iterator geometry, and thinks the first
3887 character is always the leftmost, even in R2L lines,
3888 we don't need to distinguish between the R2L and L2R
3890 move_it_in_display_line (&it_copy
, ZV
,
3891 it_copy
.current_x
- 1, MOVE_TO_X
);
3892 pos
= it_copy
.current
.pos
;
3893 RESTORE_IT (it
, it
, it_copy_data
);
3897 /* Set charpos to the buffer position of the character
3898 that comes after IT's current position in the visual
3900 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3904 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3907 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3910 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3912 /* Determine face for CHARSET_ASCII, or unibyte. */
3913 face_id
= face_at_buffer_position (it
->w
,
3915 it
->region_beg_charpos
,
3916 it
->region_end_charpos
,
3917 &next_check_charpos
,
3920 /* Correct the face for charsets different from ASCII. Do it
3921 for the multibyte case only. The face returned above is
3922 suitable for unibyte text if current_buffer is unibyte. */
3923 if (it
->multibyte_p
)
3925 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3926 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3927 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3936 /***********************************************************************
3938 ***********************************************************************/
3940 /* Set up iterator IT from invisible properties at its current
3941 position. Called from handle_stop. */
3943 static enum prop_handled
3944 handle_invisible_prop (struct it
*it
)
3946 enum prop_handled handled
= HANDLED_NORMALLY
;
3948 if (STRINGP (it
->string
))
3950 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3952 /* Get the value of the invisible text property at the
3953 current position. Value will be nil if there is no such
3955 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3956 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3959 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3963 handled
= HANDLED_RECOMPUTE_PROPS
;
3965 /* Get the position at which the next change of the
3966 invisible text property can be found in IT->string.
3967 Value will be nil if the property value is the same for
3968 all the rest of IT->string. */
3969 XSETINT (limit
, SCHARS (it
->string
));
3970 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3973 /* Text at current position is invisible. The next
3974 change in the property is at position end_charpos.
3975 Move IT's current position to that position. */
3976 if (INTEGERP (end_charpos
)
3977 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3979 struct text_pos old
;
3982 old
= it
->current
.string_pos
;
3983 oldpos
= CHARPOS (old
);
3986 if (it
->bidi_it
.first_elt
3987 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3988 bidi_paragraph_init (it
->paragraph_embedding
,
3990 /* Bidi-iterate out of the invisible text. */
3993 bidi_move_to_visually_next (&it
->bidi_it
);
3995 while (oldpos
<= it
->bidi_it
.charpos
3996 && it
->bidi_it
.charpos
< endpos
);
3998 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3999 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4000 if (IT_CHARPOS (*it
) >= endpos
)
4001 it
->prev_stop
= endpos
;
4005 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4006 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4011 /* The rest of the string is invisible. If this is an
4012 overlay string, proceed with the next overlay string
4013 or whatever comes and return a character from there. */
4014 if (it
->current
.overlay_string_index
>= 0)
4016 next_overlay_string (it
);
4017 /* Don't check for overlay strings when we just
4018 finished processing them. */
4019 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4023 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4024 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4032 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4033 Lisp_Object pos
, prop
, overlay
;
4035 /* First of all, is there invisible text at this position? */
4036 tem
= start_charpos
= IT_CHARPOS (*it
);
4037 pos
= make_number (tem
);
4038 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4040 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4042 /* If we are on invisible text, skip over it. */
4043 if (invis_p
&& start_charpos
< it
->end_charpos
)
4045 /* Record whether we have to display an ellipsis for the
4047 int display_ellipsis_p
= invis_p
== 2;
4049 handled
= HANDLED_RECOMPUTE_PROPS
;
4051 /* Loop skipping over invisible text. The loop is left at
4052 ZV or with IT on the first char being visible again. */
4055 /* Try to skip some invisible text. Return value is the
4056 position reached which can be equal to where we start
4057 if there is nothing invisible there. This skips both
4058 over invisible text properties and overlays with
4059 invisible property. */
4060 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4062 /* If we skipped nothing at all we weren't at invisible
4063 text in the first place. If everything to the end of
4064 the buffer was skipped, end the loop. */
4065 if (newpos
== tem
|| newpos
>= ZV
)
4069 /* We skipped some characters but not necessarily
4070 all there are. Check if we ended up on visible
4071 text. Fget_char_property returns the property of
4072 the char before the given position, i.e. if we
4073 get invis_p = 0, this means that the char at
4074 newpos is visible. */
4075 pos
= make_number (newpos
);
4076 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4077 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4080 /* If we ended up on invisible text, proceed to
4081 skip starting with next_stop. */
4085 /* If there are adjacent invisible texts, don't lose the
4086 second one's ellipsis. */
4088 display_ellipsis_p
= 1;
4092 /* The position newpos is now either ZV or on visible text. */
4093 if (it
->bidi_p
&& newpos
< ZV
)
4095 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4097 if (FETCH_BYTE (bpos
) == '\n'
4098 || (newpos
> BEGV
&& FETCH_BYTE (bpos
- 1) == '\n'))
4100 /* If the invisible text ends on a newline or the
4101 character after a newline, we can avoid the
4102 costly, character by character, bidi iteration to
4103 newpos, and instead simply reseat the iterator
4104 there. That's because all bidi reordering
4105 information is tossed at the newline. This is a
4106 big win for modes that hide complete lines, like
4107 Outline, Org, etc. (Implementation note: the
4108 call to reseat_1 is necessary, because it signals
4109 to the bidi iterator that it needs to reinit its
4110 internal information when the next element for
4111 display is requested. */
4112 struct text_pos tpos
;
4114 SET_TEXT_POS (tpos
, newpos
, bpos
);
4115 reseat_1 (it
, tpos
, 0);
4117 else /* Must use the slow method. */
4119 /* With bidi iteration, the region of invisible text
4120 could start and/or end in the middle of a
4121 non-base embedding level. Therefore, we need to
4122 skip invisible text using the bidi iterator,
4123 starting at IT's current position, until we find
4124 ourselves outside the invisible text. Skipping
4125 invisible text _after_ bidi iteration avoids
4126 affecting the visual order of the displayed text
4127 when invisible properties are added or
4129 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4131 /* If we were `reseat'ed to a new paragraph,
4132 determine the paragraph base direction. We
4133 need to do it now because
4134 next_element_from_buffer may not have a
4135 chance to do it, if we are going to skip any
4136 text at the beginning, which resets the
4138 bidi_paragraph_init (it
->paragraph_embedding
,
4143 bidi_move_to_visually_next (&it
->bidi_it
);
4145 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4146 && it
->bidi_it
.charpos
< newpos
);
4147 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4148 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4149 /* If we overstepped NEWPOS, record its position in
4150 the iterator, so that we skip invisible text if
4151 later the bidi iteration lands us in the
4152 invisible region again. */
4153 if (IT_CHARPOS (*it
) >= newpos
)
4154 it
->prev_stop
= newpos
;
4159 IT_CHARPOS (*it
) = newpos
;
4160 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4163 /* If there are before-strings at the start of invisible
4164 text, and the text is invisible because of a text
4165 property, arrange to show before-strings because 20.x did
4166 it that way. (If the text is invisible because of an
4167 overlay property instead of a text property, this is
4168 already handled in the overlay code.) */
4170 && get_overlay_strings (it
, it
->stop_charpos
))
4172 handled
= HANDLED_RECOMPUTE_PROPS
;
4173 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4175 else if (display_ellipsis_p
)
4177 /* Make sure that the glyphs of the ellipsis will get
4178 correct `charpos' values. If we would not update
4179 it->position here, the glyphs would belong to the
4180 last visible character _before_ the invisible
4181 text, which confuses `set_cursor_from_row'.
4183 We use the last invisible position instead of the
4184 first because this way the cursor is always drawn on
4185 the first "." of the ellipsis, whenever PT is inside
4186 the invisible text. Otherwise the cursor would be
4187 placed _after_ the ellipsis when the point is after the
4188 first invisible character. */
4189 if (!STRINGP (it
->object
))
4191 it
->position
.charpos
= newpos
- 1;
4192 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4195 /* Let the ellipsis display before
4196 considering any properties of the following char.
4197 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4198 handled
= HANDLED_RETURN
;
4207 /* Make iterator IT return `...' next.
4208 Replaces LEN characters from buffer. */
4211 setup_for_ellipsis (struct it
*it
, int len
)
4213 /* Use the display table definition for `...'. Invalid glyphs
4214 will be handled by the method returning elements from dpvec. */
4215 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4217 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4218 it
->dpvec
= v
->contents
;
4219 it
->dpend
= v
->contents
+ v
->header
.size
;
4223 /* Default `...'. */
4224 it
->dpvec
= default_invis_vector
;
4225 it
->dpend
= default_invis_vector
+ 3;
4228 it
->dpvec_char_len
= len
;
4229 it
->current
.dpvec_index
= 0;
4230 it
->dpvec_face_id
= -1;
4232 /* Remember the current face id in case glyphs specify faces.
4233 IT's face is restored in set_iterator_to_next.
4234 saved_face_id was set to preceding char's face in handle_stop. */
4235 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4236 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4238 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4244 /***********************************************************************
4246 ***********************************************************************/
4248 /* Set up iterator IT from `display' property at its current position.
4249 Called from handle_stop.
4250 We return HANDLED_RETURN if some part of the display property
4251 overrides the display of the buffer text itself.
4252 Otherwise we return HANDLED_NORMALLY. */
4254 static enum prop_handled
4255 handle_display_prop (struct it
*it
)
4257 Lisp_Object propval
, object
, overlay
;
4258 struct text_pos
*position
;
4260 /* Nonzero if some property replaces the display of the text itself. */
4261 int display_replaced_p
= 0;
4263 if (STRINGP (it
->string
))
4265 object
= it
->string
;
4266 position
= &it
->current
.string_pos
;
4267 bufpos
= CHARPOS (it
->current
.pos
);
4271 XSETWINDOW (object
, it
->w
);
4272 position
= &it
->current
.pos
;
4273 bufpos
= CHARPOS (*position
);
4276 /* Reset those iterator values set from display property values. */
4277 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4278 it
->space_width
= Qnil
;
4279 it
->font_height
= Qnil
;
4282 /* We don't support recursive `display' properties, i.e. string
4283 values that have a string `display' property, that have a string
4284 `display' property etc. */
4285 if (!it
->string_from_display_prop_p
)
4286 it
->area
= TEXT_AREA
;
4288 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4289 Qdisplay
, object
, &overlay
);
4291 return HANDLED_NORMALLY
;
4292 /* Now OVERLAY is the overlay that gave us this property, or nil
4293 if it was a text property. */
4295 if (!STRINGP (it
->string
))
4296 object
= it
->w
->buffer
;
4298 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4300 FRAME_WINDOW_P (it
->f
));
4302 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4305 /* Subroutine of handle_display_prop. Returns non-zero if the display
4306 specification in SPEC is a replacing specification, i.e. it would
4307 replace the text covered by `display' property with something else,
4308 such as an image or a display string. If SPEC includes any kind or
4309 `(space ...) specification, the value is 2; this is used by
4310 compute_display_string_pos, which see.
4312 See handle_single_display_spec for documentation of arguments.
4313 frame_window_p is non-zero if the window being redisplayed is on a
4314 GUI frame; this argument is used only if IT is NULL, see below.
4316 IT can be NULL, if this is called by the bidi reordering code
4317 through compute_display_string_pos, which see. In that case, this
4318 function only examines SPEC, but does not otherwise "handle" it, in
4319 the sense that it doesn't set up members of IT from the display
4322 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4323 Lisp_Object overlay
, struct text_pos
*position
,
4324 EMACS_INT bufpos
, int frame_window_p
)
4326 int replacing_p
= 0;
4330 /* Simple specerties. */
4331 && !EQ (XCAR (spec
), Qimage
)
4332 && !EQ (XCAR (spec
), Qspace
)
4333 && !EQ (XCAR (spec
), Qwhen
)
4334 && !EQ (XCAR (spec
), Qslice
)
4335 && !EQ (XCAR (spec
), Qspace_width
)
4336 && !EQ (XCAR (spec
), Qheight
)
4337 && !EQ (XCAR (spec
), Qraise
)
4338 /* Marginal area specifications. */
4339 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4340 && !EQ (XCAR (spec
), Qleft_fringe
)
4341 && !EQ (XCAR (spec
), Qright_fringe
)
4342 && !NILP (XCAR (spec
)))
4344 for (; CONSP (spec
); spec
= XCDR (spec
))
4346 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4347 overlay
, position
, bufpos
,
4348 replacing_p
, frame_window_p
)))
4351 /* If some text in a string is replaced, `position' no
4352 longer points to the position of `object'. */
4353 if (!it
|| STRINGP (object
))
4358 else if (VECTORP (spec
))
4361 for (i
= 0; i
< ASIZE (spec
); ++i
)
4362 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4363 overlay
, position
, bufpos
,
4364 replacing_p
, frame_window_p
)))
4367 /* If some text in a string is replaced, `position' no
4368 longer points to the position of `object'. */
4369 if (!it
|| STRINGP (object
))
4375 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4376 position
, bufpos
, 0,
4384 /* Value is the position of the end of the `display' property starting
4385 at START_POS in OBJECT. */
4387 static struct text_pos
4388 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4391 struct text_pos end_pos
;
4393 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4394 Qdisplay
, object
, Qnil
);
4395 CHARPOS (end_pos
) = XFASTINT (end
);
4396 if (STRINGP (object
))
4397 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4399 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4405 /* Set up IT from a single `display' property specification SPEC. OBJECT
4406 is the object in which the `display' property was found. *POSITION
4407 is the position in OBJECT at which the `display' property was found.
4408 BUFPOS is the buffer position of OBJECT (different from POSITION if
4409 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4410 previously saw a display specification which already replaced text
4411 display with something else, for example an image; we ignore such
4412 properties after the first one has been processed.
4414 OVERLAY is the overlay this `display' property came from,
4415 or nil if it was a text property.
4417 If SPEC is a `space' or `image' specification, and in some other
4418 cases too, set *POSITION to the position where the `display'
4421 If IT is NULL, only examine the property specification in SPEC, but
4422 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4423 is intended to be displayed in a window on a GUI frame.
4425 Value is non-zero if something was found which replaces the display
4426 of buffer or string text. */
4429 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4430 Lisp_Object overlay
, struct text_pos
*position
,
4431 EMACS_INT bufpos
, int display_replaced_p
,
4435 Lisp_Object location
, value
;
4436 struct text_pos start_pos
= *position
;
4439 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4440 If the result is non-nil, use VALUE instead of SPEC. */
4442 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4451 if (!NILP (form
) && !EQ (form
, Qt
))
4453 int count
= SPECPDL_INDEX ();
4454 struct gcpro gcpro1
;
4456 /* Bind `object' to the object having the `display' property, a
4457 buffer or string. Bind `position' to the position in the
4458 object where the property was found, and `buffer-position'
4459 to the current position in the buffer. */
4462 XSETBUFFER (object
, current_buffer
);
4463 specbind (Qobject
, object
);
4464 specbind (Qposition
, make_number (CHARPOS (*position
)));
4465 specbind (Qbuffer_position
, make_number (bufpos
));
4467 form
= safe_eval (form
);
4469 unbind_to (count
, Qnil
);
4475 /* Handle `(height HEIGHT)' specifications. */
4477 && EQ (XCAR (spec
), Qheight
)
4478 && CONSP (XCDR (spec
)))
4482 if (!FRAME_WINDOW_P (it
->f
))
4485 it
->font_height
= XCAR (XCDR (spec
));
4486 if (!NILP (it
->font_height
))
4488 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4489 int new_height
= -1;
4491 if (CONSP (it
->font_height
)
4492 && (EQ (XCAR (it
->font_height
), Qplus
)
4493 || EQ (XCAR (it
->font_height
), Qminus
))
4494 && CONSP (XCDR (it
->font_height
))
4495 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4497 /* `(+ N)' or `(- N)' where N is an integer. */
4498 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4499 if (EQ (XCAR (it
->font_height
), Qplus
))
4501 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4503 else if (FUNCTIONP (it
->font_height
))
4505 /* Call function with current height as argument.
4506 Value is the new height. */
4508 height
= safe_call1 (it
->font_height
,
4509 face
->lface
[LFACE_HEIGHT_INDEX
]);
4510 if (NUMBERP (height
))
4511 new_height
= XFLOATINT (height
);
4513 else if (NUMBERP (it
->font_height
))
4515 /* Value is a multiple of the canonical char height. */
4518 f
= FACE_FROM_ID (it
->f
,
4519 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4520 new_height
= (XFLOATINT (it
->font_height
)
4521 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4525 /* Evaluate IT->font_height with `height' bound to the
4526 current specified height to get the new height. */
4527 int count
= SPECPDL_INDEX ();
4529 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4530 value
= safe_eval (it
->font_height
);
4531 unbind_to (count
, Qnil
);
4533 if (NUMBERP (value
))
4534 new_height
= XFLOATINT (value
);
4538 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4545 /* Handle `(space-width WIDTH)'. */
4547 && EQ (XCAR (spec
), Qspace_width
)
4548 && CONSP (XCDR (spec
)))
4552 if (!FRAME_WINDOW_P (it
->f
))
4555 value
= XCAR (XCDR (spec
));
4556 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4557 it
->space_width
= value
;
4563 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4565 && EQ (XCAR (spec
), Qslice
))
4571 if (!FRAME_WINDOW_P (it
->f
))
4574 if (tem
= XCDR (spec
), CONSP (tem
))
4576 it
->slice
.x
= XCAR (tem
);
4577 if (tem
= XCDR (tem
), CONSP (tem
))
4579 it
->slice
.y
= XCAR (tem
);
4580 if (tem
= XCDR (tem
), CONSP (tem
))
4582 it
->slice
.width
= XCAR (tem
);
4583 if (tem
= XCDR (tem
), CONSP (tem
))
4584 it
->slice
.height
= XCAR (tem
);
4593 /* Handle `(raise FACTOR)'. */
4595 && EQ (XCAR (spec
), Qraise
)
4596 && CONSP (XCDR (spec
)))
4600 if (!FRAME_WINDOW_P (it
->f
))
4603 #ifdef HAVE_WINDOW_SYSTEM
4604 value
= XCAR (XCDR (spec
));
4605 if (NUMBERP (value
))
4607 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4608 it
->voffset
= - (XFLOATINT (value
)
4609 * (FONT_HEIGHT (face
->font
)));
4611 #endif /* HAVE_WINDOW_SYSTEM */
4617 /* Don't handle the other kinds of display specifications
4618 inside a string that we got from a `display' property. */
4619 if (it
&& it
->string_from_display_prop_p
)
4622 /* Characters having this form of property are not displayed, so
4623 we have to find the end of the property. */
4626 start_pos
= *position
;
4627 *position
= display_prop_end (it
, object
, start_pos
);
4631 /* Stop the scan at that end position--we assume that all
4632 text properties change there. */
4634 it
->stop_charpos
= position
->charpos
;
4636 /* Handle `(left-fringe BITMAP [FACE])'
4637 and `(right-fringe BITMAP [FACE])'. */
4639 && (EQ (XCAR (spec
), Qleft_fringe
)
4640 || EQ (XCAR (spec
), Qright_fringe
))
4641 && CONSP (XCDR (spec
)))
4647 if (!FRAME_WINDOW_P (it
->f
))
4648 /* If we return here, POSITION has been advanced
4649 across the text with this property. */
4652 else if (!frame_window_p
)
4655 #ifdef HAVE_WINDOW_SYSTEM
4656 value
= XCAR (XCDR (spec
));
4657 if (!SYMBOLP (value
)
4658 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4659 /* If we return here, POSITION has been advanced
4660 across the text with this property. */
4665 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4667 if (CONSP (XCDR (XCDR (spec
))))
4669 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4670 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4676 /* Save current settings of IT so that we can restore them
4677 when we are finished with the glyph property value. */
4678 push_it (it
, position
);
4680 it
->area
= TEXT_AREA
;
4681 it
->what
= IT_IMAGE
;
4682 it
->image_id
= -1; /* no image */
4683 it
->position
= start_pos
;
4684 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4685 it
->method
= GET_FROM_IMAGE
;
4686 it
->from_overlay
= Qnil
;
4687 it
->face_id
= face_id
;
4688 it
->from_disp_prop_p
= 1;
4690 /* Say that we haven't consumed the characters with
4691 `display' property yet. The call to pop_it in
4692 set_iterator_to_next will clean this up. */
4693 *position
= start_pos
;
4695 if (EQ (XCAR (spec
), Qleft_fringe
))
4697 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4698 it
->left_user_fringe_face_id
= face_id
;
4702 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4703 it
->right_user_fringe_face_id
= face_id
;
4706 #endif /* HAVE_WINDOW_SYSTEM */
4710 /* Prepare to handle `((margin left-margin) ...)',
4711 `((margin right-margin) ...)' and `((margin nil) ...)'
4712 prefixes for display specifications. */
4713 location
= Qunbound
;
4714 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4718 value
= XCDR (spec
);
4720 value
= XCAR (value
);
4723 if (EQ (XCAR (tem
), Qmargin
)
4724 && (tem
= XCDR (tem
),
4725 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4727 || EQ (tem
, Qleft_margin
)
4728 || EQ (tem
, Qright_margin
))))
4732 if (EQ (location
, Qunbound
))
4738 /* After this point, VALUE is the property after any
4739 margin prefix has been stripped. It must be a string,
4740 an image specification, or `(space ...)'.
4742 LOCATION specifies where to display: `left-margin',
4743 `right-margin' or nil. */
4745 valid_p
= (STRINGP (value
)
4746 #ifdef HAVE_WINDOW_SYSTEM
4747 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4748 && valid_image_p (value
))
4749 #endif /* not HAVE_WINDOW_SYSTEM */
4750 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4752 if (valid_p
&& !display_replaced_p
)
4758 /* Callers need to know whether the display spec is any kind
4759 of `(space ...)' spec that is about to affect text-area
4761 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4766 /* Save current settings of IT so that we can restore them
4767 when we are finished with the glyph property value. */
4768 push_it (it
, position
);
4769 it
->from_overlay
= overlay
;
4770 it
->from_disp_prop_p
= 1;
4772 if (NILP (location
))
4773 it
->area
= TEXT_AREA
;
4774 else if (EQ (location
, Qleft_margin
))
4775 it
->area
= LEFT_MARGIN_AREA
;
4777 it
->area
= RIGHT_MARGIN_AREA
;
4779 if (STRINGP (value
))
4782 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4783 it
->current
.overlay_string_index
= -1;
4784 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4785 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4786 it
->method
= GET_FROM_STRING
;
4787 it
->stop_charpos
= 0;
4789 it
->base_level_stop
= 0;
4790 it
->string_from_display_prop_p
= 1;
4791 /* Say that we haven't consumed the characters with
4792 `display' property yet. The call to pop_it in
4793 set_iterator_to_next will clean this up. */
4794 if (BUFFERP (object
))
4795 *position
= start_pos
;
4797 /* Force paragraph direction to be that of the parent
4798 object. If the parent object's paragraph direction is
4799 not yet determined, default to L2R. */
4800 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4801 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4803 it
->paragraph_embedding
= L2R
;
4805 /* Set up the bidi iterator for this display string. */
4808 it
->bidi_it
.string
.lstring
= it
->string
;
4809 it
->bidi_it
.string
.s
= NULL
;
4810 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4811 it
->bidi_it
.string
.bufpos
= bufpos
;
4812 it
->bidi_it
.string
.from_disp_str
= 1;
4813 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4814 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4817 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4819 it
->method
= GET_FROM_STRETCH
;
4821 *position
= it
->position
= start_pos
;
4822 retval
= 1 + (it
->area
== TEXT_AREA
);
4824 #ifdef HAVE_WINDOW_SYSTEM
4827 it
->what
= IT_IMAGE
;
4828 it
->image_id
= lookup_image (it
->f
, value
);
4829 it
->position
= start_pos
;
4830 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4831 it
->method
= GET_FROM_IMAGE
;
4833 /* Say that we haven't consumed the characters with
4834 `display' property yet. The call to pop_it in
4835 set_iterator_to_next will clean this up. */
4836 *position
= start_pos
;
4838 #endif /* HAVE_WINDOW_SYSTEM */
4843 /* Invalid property or property not supported. Restore
4844 POSITION to what it was before. */
4845 *position
= start_pos
;
4849 /* Check if PROP is a display property value whose text should be
4850 treated as intangible. OVERLAY is the overlay from which PROP
4851 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4852 specify the buffer position covered by PROP. */
4855 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4856 EMACS_INT charpos
, EMACS_INT bytepos
)
4858 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4859 struct text_pos position
;
4861 SET_TEXT_POS (position
, charpos
, bytepos
);
4862 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4863 &position
, charpos
, frame_window_p
);
4867 /* Return 1 if PROP is a display sub-property value containing STRING.
4869 Implementation note: this and the following function are really
4870 special cases of handle_display_spec and
4871 handle_single_display_spec, and should ideally use the same code.
4872 Until they do, these two pairs must be consistent and must be
4873 modified in sync. */
4876 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4878 if (EQ (string
, prop
))
4881 /* Skip over `when FORM'. */
4882 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4887 /* Actually, the condition following `when' should be eval'ed,
4888 like handle_single_display_spec does, and we should return
4889 zero if it evaluates to nil. However, this function is
4890 called only when the buffer was already displayed and some
4891 glyph in the glyph matrix was found to come from a display
4892 string. Therefore, the condition was already evaluated, and
4893 the result was non-nil, otherwise the display string wouldn't
4894 have been displayed and we would have never been called for
4895 this property. Thus, we can skip the evaluation and assume
4896 its result is non-nil. */
4901 /* Skip over `margin LOCATION'. */
4902 if (EQ (XCAR (prop
), Qmargin
))
4913 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4917 /* Return 1 if STRING appears in the `display' property PROP. */
4920 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4923 && !EQ (XCAR (prop
), Qwhen
)
4924 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4926 /* A list of sub-properties. */
4927 while (CONSP (prop
))
4929 if (single_display_spec_string_p (XCAR (prop
), string
))
4934 else if (VECTORP (prop
))
4936 /* A vector of sub-properties. */
4938 for (i
= 0; i
< ASIZE (prop
); ++i
)
4939 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4943 return single_display_spec_string_p (prop
, string
);
4948 /* Look for STRING in overlays and text properties in the current
4949 buffer, between character positions FROM and TO (excluding TO).
4950 BACK_P non-zero means look back (in this case, TO is supposed to be
4952 Value is the first character position where STRING was found, or
4953 zero if it wasn't found before hitting TO.
4955 This function may only use code that doesn't eval because it is
4956 called asynchronously from note_mouse_highlight. */
4959 string_buffer_position_lim (Lisp_Object string
,
4960 EMACS_INT from
, EMACS_INT to
, int back_p
)
4962 Lisp_Object limit
, prop
, pos
;
4965 pos
= make_number (from
);
4967 if (!back_p
) /* looking forward */
4969 limit
= make_number (min (to
, ZV
));
4970 while (!found
&& !EQ (pos
, limit
))
4972 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4973 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4976 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4980 else /* looking back */
4982 limit
= make_number (max (to
, BEGV
));
4983 while (!found
&& !EQ (pos
, limit
))
4985 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4986 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4989 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4994 return found
? XINT (pos
) : 0;
4997 /* Determine which buffer position in current buffer STRING comes from.
4998 AROUND_CHARPOS is an approximate position where it could come from.
4999 Value is the buffer position or 0 if it couldn't be determined.
5001 This function is necessary because we don't record buffer positions
5002 in glyphs generated from strings (to keep struct glyph small).
5003 This function may only use code that doesn't eval because it is
5004 called asynchronously from note_mouse_highlight. */
5007 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
5009 const int MAX_DISTANCE
= 1000;
5010 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
5011 around_charpos
+ MAX_DISTANCE
,
5015 found
= string_buffer_position_lim (string
, around_charpos
,
5016 around_charpos
- MAX_DISTANCE
, 1);
5022 /***********************************************************************
5023 `composition' property
5024 ***********************************************************************/
5026 /* Set up iterator IT from `composition' property at its current
5027 position. Called from handle_stop. */
5029 static enum prop_handled
5030 handle_composition_prop (struct it
*it
)
5032 Lisp_Object prop
, string
;
5033 EMACS_INT pos
, pos_byte
, start
, end
;
5035 if (STRINGP (it
->string
))
5039 pos
= IT_STRING_CHARPOS (*it
);
5040 pos_byte
= IT_STRING_BYTEPOS (*it
);
5041 string
= it
->string
;
5042 s
= SDATA (string
) + pos_byte
;
5043 it
->c
= STRING_CHAR (s
);
5047 pos
= IT_CHARPOS (*it
);
5048 pos_byte
= IT_BYTEPOS (*it
);
5050 it
->c
= FETCH_CHAR (pos_byte
);
5053 /* If there's a valid composition and point is not inside of the
5054 composition (in the case that the composition is from the current
5055 buffer), draw a glyph composed from the composition components. */
5056 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5057 && COMPOSITION_VALID_P (start
, end
, prop
)
5058 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5061 /* As we can't handle this situation (perhaps font-lock added
5062 a new composition), we just return here hoping that next
5063 redisplay will detect this composition much earlier. */
5064 return HANDLED_NORMALLY
;
5067 if (STRINGP (it
->string
))
5068 pos_byte
= string_char_to_byte (it
->string
, start
);
5070 pos_byte
= CHAR_TO_BYTE (start
);
5072 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5075 if (it
->cmp_it
.id
>= 0)
5078 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5079 it
->cmp_it
.nglyphs
= -1;
5083 return HANDLED_NORMALLY
;
5088 /***********************************************************************
5090 ***********************************************************************/
5092 /* The following structure is used to record overlay strings for
5093 later sorting in load_overlay_strings. */
5095 struct overlay_entry
5097 Lisp_Object overlay
;
5104 /* Set up iterator IT from overlay strings at its current position.
5105 Called from handle_stop. */
5107 static enum prop_handled
5108 handle_overlay_change (struct it
*it
)
5110 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5111 return HANDLED_RECOMPUTE_PROPS
;
5113 return HANDLED_NORMALLY
;
5117 /* Set up the next overlay string for delivery by IT, if there is an
5118 overlay string to deliver. Called by set_iterator_to_next when the
5119 end of the current overlay string is reached. If there are more
5120 overlay strings to display, IT->string and
5121 IT->current.overlay_string_index are set appropriately here.
5122 Otherwise IT->string is set to nil. */
5125 next_overlay_string (struct it
*it
)
5127 ++it
->current
.overlay_string_index
;
5128 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5130 /* No more overlay strings. Restore IT's settings to what
5131 they were before overlay strings were processed, and
5132 continue to deliver from current_buffer. */
5134 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5137 || (NILP (it
->string
)
5138 && it
->method
== GET_FROM_BUFFER
5139 && it
->stop_charpos
>= BEGV
5140 && it
->stop_charpos
<= it
->end_charpos
));
5141 it
->current
.overlay_string_index
= -1;
5142 it
->n_overlay_strings
= 0;
5143 it
->overlay_strings_charpos
= -1;
5145 /* If we're at the end of the buffer, record that we have
5146 processed the overlay strings there already, so that
5147 next_element_from_buffer doesn't try it again. */
5148 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5149 it
->overlay_strings_at_end_processed_p
= 1;
5153 /* There are more overlay strings to process. If
5154 IT->current.overlay_string_index has advanced to a position
5155 where we must load IT->overlay_strings with more strings, do
5156 it. We must load at the IT->overlay_strings_charpos where
5157 IT->n_overlay_strings was originally computed; when invisible
5158 text is present, this might not be IT_CHARPOS (Bug#7016). */
5159 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5161 if (it
->current
.overlay_string_index
&& i
== 0)
5162 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5164 /* Initialize IT to deliver display elements from the overlay
5166 it
->string
= it
->overlay_strings
[i
];
5167 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5168 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5169 it
->method
= GET_FROM_STRING
;
5170 it
->stop_charpos
= 0;
5171 if (it
->cmp_it
.stop_pos
>= 0)
5172 it
->cmp_it
.stop_pos
= 0;
5174 it
->base_level_stop
= 0;
5176 /* Set up the bidi iterator for this overlay string. */
5179 it
->bidi_it
.string
.lstring
= it
->string
;
5180 it
->bidi_it
.string
.s
= NULL
;
5181 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5182 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5183 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5184 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5185 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5193 /* Compare two overlay_entry structures E1 and E2. Used as a
5194 comparison function for qsort in load_overlay_strings. Overlay
5195 strings for the same position are sorted so that
5197 1. All after-strings come in front of before-strings, except
5198 when they come from the same overlay.
5200 2. Within after-strings, strings are sorted so that overlay strings
5201 from overlays with higher priorities come first.
5203 2. Within before-strings, strings are sorted so that overlay
5204 strings from overlays with higher priorities come last.
5206 Value is analogous to strcmp. */
5210 compare_overlay_entries (const void *e1
, const void *e2
)
5212 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5213 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5216 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5218 /* Let after-strings appear in front of before-strings if
5219 they come from different overlays. */
5220 if (EQ (entry1
->overlay
, entry2
->overlay
))
5221 result
= entry1
->after_string_p
? 1 : -1;
5223 result
= entry1
->after_string_p
? -1 : 1;
5225 else if (entry1
->after_string_p
)
5226 /* After-strings sorted in order of decreasing priority. */
5227 result
= entry2
->priority
- entry1
->priority
;
5229 /* Before-strings sorted in order of increasing priority. */
5230 result
= entry1
->priority
- entry2
->priority
;
5236 /* Load the vector IT->overlay_strings with overlay strings from IT's
5237 current buffer position, or from CHARPOS if that is > 0. Set
5238 IT->n_overlays to the total number of overlay strings found.
5240 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5241 a time. On entry into load_overlay_strings,
5242 IT->current.overlay_string_index gives the number of overlay
5243 strings that have already been loaded by previous calls to this
5246 IT->add_overlay_start contains an additional overlay start
5247 position to consider for taking overlay strings from, if non-zero.
5248 This position comes into play when the overlay has an `invisible'
5249 property, and both before and after-strings. When we've skipped to
5250 the end of the overlay, because of its `invisible' property, we
5251 nevertheless want its before-string to appear.
5252 IT->add_overlay_start will contain the overlay start position
5255 Overlay strings are sorted so that after-string strings come in
5256 front of before-string strings. Within before and after-strings,
5257 strings are sorted by overlay priority. See also function
5258 compare_overlay_entries. */
5261 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5263 Lisp_Object overlay
, window
, str
, invisible
;
5264 struct Lisp_Overlay
*ov
;
5265 EMACS_INT start
, end
;
5267 int n
= 0, i
, j
, invis_p
;
5268 struct overlay_entry
*entries
5269 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5272 charpos
= IT_CHARPOS (*it
);
5274 /* Append the overlay string STRING of overlay OVERLAY to vector
5275 `entries' which has size `size' and currently contains `n'
5276 elements. AFTER_P non-zero means STRING is an after-string of
5278 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5281 Lisp_Object priority; \
5285 int new_size = 2 * size; \
5286 struct overlay_entry *old = entries; \
5288 (struct overlay_entry *) alloca (new_size \
5289 * sizeof *entries); \
5290 memcpy (entries, old, size * sizeof *entries); \
5294 entries[n].string = (STRING); \
5295 entries[n].overlay = (OVERLAY); \
5296 priority = Foverlay_get ((OVERLAY), Qpriority); \
5297 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5298 entries[n].after_string_p = (AFTER_P); \
5303 /* Process overlay before the overlay center. */
5304 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5306 XSETMISC (overlay
, ov
);
5307 xassert (OVERLAYP (overlay
));
5308 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5309 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5314 /* Skip this overlay if it doesn't start or end at IT's current
5316 if (end
!= charpos
&& start
!= charpos
)
5319 /* Skip this overlay if it doesn't apply to IT->w. */
5320 window
= Foverlay_get (overlay
, Qwindow
);
5321 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5324 /* If the text ``under'' the overlay is invisible, both before-
5325 and after-strings from this overlay are visible; start and
5326 end position are indistinguishable. */
5327 invisible
= Foverlay_get (overlay
, Qinvisible
);
5328 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5330 /* If overlay has a non-empty before-string, record it. */
5331 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5332 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5334 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5336 /* If overlay has a non-empty after-string, record it. */
5337 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5338 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5340 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5343 /* Process overlays after the overlay center. */
5344 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5346 XSETMISC (overlay
, ov
);
5347 xassert (OVERLAYP (overlay
));
5348 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5349 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5351 if (start
> charpos
)
5354 /* Skip this overlay if it doesn't start or end at IT's current
5356 if (end
!= charpos
&& start
!= charpos
)
5359 /* Skip this overlay if it doesn't apply to IT->w. */
5360 window
= Foverlay_get (overlay
, Qwindow
);
5361 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5364 /* If the text ``under'' the overlay is invisible, it has a zero
5365 dimension, and both before- and after-strings apply. */
5366 invisible
= Foverlay_get (overlay
, Qinvisible
);
5367 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5369 /* If overlay has a non-empty before-string, record it. */
5370 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5371 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5373 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5375 /* If overlay has a non-empty after-string, record it. */
5376 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5377 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5379 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5382 #undef RECORD_OVERLAY_STRING
5386 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5388 /* Record number of overlay strings, and where we computed it. */
5389 it
->n_overlay_strings
= n
;
5390 it
->overlay_strings_charpos
= charpos
;
5392 /* IT->current.overlay_string_index is the number of overlay strings
5393 that have already been consumed by IT. Copy some of the
5394 remaining overlay strings to IT->overlay_strings. */
5396 j
= it
->current
.overlay_string_index
;
5397 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5399 it
->overlay_strings
[i
] = entries
[j
].string
;
5400 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5407 /* Get the first chunk of overlay strings at IT's current buffer
5408 position, or at CHARPOS if that is > 0. Value is non-zero if at
5409 least one overlay string was found. */
5412 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5414 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5415 process. This fills IT->overlay_strings with strings, and sets
5416 IT->n_overlay_strings to the total number of strings to process.
5417 IT->pos.overlay_string_index has to be set temporarily to zero
5418 because load_overlay_strings needs this; it must be set to -1
5419 when no overlay strings are found because a zero value would
5420 indicate a position in the first overlay string. */
5421 it
->current
.overlay_string_index
= 0;
5422 load_overlay_strings (it
, charpos
);
5424 /* If we found overlay strings, set up IT to deliver display
5425 elements from the first one. Otherwise set up IT to deliver
5426 from current_buffer. */
5427 if (it
->n_overlay_strings
)
5429 /* Make sure we know settings in current_buffer, so that we can
5430 restore meaningful values when we're done with the overlay
5433 compute_stop_pos (it
);
5434 xassert (it
->face_id
>= 0);
5436 /* Save IT's settings. They are restored after all overlay
5437 strings have been processed. */
5438 xassert (!compute_stop_p
|| it
->sp
== 0);
5440 /* When called from handle_stop, there might be an empty display
5441 string loaded. In that case, don't bother saving it. */
5442 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5445 /* Set up IT to deliver display elements from the first overlay
5447 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5448 it
->string
= it
->overlay_strings
[0];
5449 it
->from_overlay
= Qnil
;
5450 it
->stop_charpos
= 0;
5451 xassert (STRINGP (it
->string
));
5452 it
->end_charpos
= SCHARS (it
->string
);
5454 it
->base_level_stop
= 0;
5455 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5456 it
->method
= GET_FROM_STRING
;
5457 it
->from_disp_prop_p
= 0;
5459 /* Force paragraph direction to be that of the parent
5461 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5462 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5464 it
->paragraph_embedding
= L2R
;
5466 /* Set up the bidi iterator for this overlay string. */
5469 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5471 it
->bidi_it
.string
.lstring
= it
->string
;
5472 it
->bidi_it
.string
.s
= NULL
;
5473 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5474 it
->bidi_it
.string
.bufpos
= pos
;
5475 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5476 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5477 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5482 it
->current
.overlay_string_index
= -1;
5487 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5490 it
->method
= GET_FROM_BUFFER
;
5492 (void) get_overlay_strings_1 (it
, charpos
, 1);
5496 /* Value is non-zero if we found at least one overlay string. */
5497 return STRINGP (it
->string
);
5502 /***********************************************************************
5503 Saving and restoring state
5504 ***********************************************************************/
5506 /* Save current settings of IT on IT->stack. Called, for example,
5507 before setting up IT for an overlay string, to be able to restore
5508 IT's settings to what they were after the overlay string has been
5509 processed. If POSITION is non-NULL, it is the position to save on
5510 the stack instead of IT->position. */
5513 push_it (struct it
*it
, struct text_pos
*position
)
5515 struct iterator_stack_entry
*p
;
5517 xassert (it
->sp
< IT_STACK_SIZE
);
5518 p
= it
->stack
+ it
->sp
;
5520 p
->stop_charpos
= it
->stop_charpos
;
5521 p
->prev_stop
= it
->prev_stop
;
5522 p
->base_level_stop
= it
->base_level_stop
;
5523 p
->cmp_it
= it
->cmp_it
;
5524 xassert (it
->face_id
>= 0);
5525 p
->face_id
= it
->face_id
;
5526 p
->string
= it
->string
;
5527 p
->method
= it
->method
;
5528 p
->from_overlay
= it
->from_overlay
;
5531 case GET_FROM_IMAGE
:
5532 p
->u
.image
.object
= it
->object
;
5533 p
->u
.image
.image_id
= it
->image_id
;
5534 p
->u
.image
.slice
= it
->slice
;
5536 case GET_FROM_STRETCH
:
5537 p
->u
.stretch
.object
= it
->object
;
5540 p
->position
= position
? *position
: it
->position
;
5541 p
->current
= it
->current
;
5542 p
->end_charpos
= it
->end_charpos
;
5543 p
->string_nchars
= it
->string_nchars
;
5545 p
->multibyte_p
= it
->multibyte_p
;
5546 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5547 p
->space_width
= it
->space_width
;
5548 p
->font_height
= it
->font_height
;
5549 p
->voffset
= it
->voffset
;
5550 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5551 p
->display_ellipsis_p
= 0;
5552 p
->line_wrap
= it
->line_wrap
;
5553 p
->bidi_p
= it
->bidi_p
;
5554 p
->paragraph_embedding
= it
->paragraph_embedding
;
5555 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5558 /* Save the state of the bidi iterator as well. */
5560 bidi_push_it (&it
->bidi_it
);
5564 iterate_out_of_display_property (struct it
*it
)
5566 int buffer_p
= BUFFERP (it
->object
);
5567 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5568 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5570 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5572 /* Maybe initialize paragraph direction. If we are at the beginning
5573 of a new paragraph, next_element_from_buffer may not have a
5574 chance to do that. */
5575 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5576 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5577 /* prev_stop can be zero, so check against BEGV as well. */
5578 while (it
->bidi_it
.charpos
>= bob
5579 && it
->prev_stop
<= it
->bidi_it
.charpos
5580 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5581 && it
->bidi_it
.charpos
< eob
)
5582 bidi_move_to_visually_next (&it
->bidi_it
);
5583 /* Record the stop_pos we just crossed, for when we cross it
5585 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5586 it
->prev_stop
= CHARPOS (it
->position
);
5587 /* If we ended up not where pop_it put us, resync IT's
5588 positional members with the bidi iterator. */
5589 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5590 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5592 it
->current
.pos
= it
->position
;
5594 it
->current
.string_pos
= it
->position
;
5597 /* Restore IT's settings from IT->stack. Called, for example, when no
5598 more overlay strings must be processed, and we return to delivering
5599 display elements from a buffer, or when the end of a string from a
5600 `display' property is reached and we return to delivering display
5601 elements from an overlay string, or from a buffer. */
5604 pop_it (struct it
*it
)
5606 struct iterator_stack_entry
*p
;
5607 int from_display_prop
= it
->from_disp_prop_p
;
5609 xassert (it
->sp
> 0);
5611 p
= it
->stack
+ it
->sp
;
5612 it
->stop_charpos
= p
->stop_charpos
;
5613 it
->prev_stop
= p
->prev_stop
;
5614 it
->base_level_stop
= p
->base_level_stop
;
5615 it
->cmp_it
= p
->cmp_it
;
5616 it
->face_id
= p
->face_id
;
5617 it
->current
= p
->current
;
5618 it
->position
= p
->position
;
5619 it
->string
= p
->string
;
5620 it
->from_overlay
= p
->from_overlay
;
5621 if (NILP (it
->string
))
5622 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5623 it
->method
= p
->method
;
5626 case GET_FROM_IMAGE
:
5627 it
->image_id
= p
->u
.image
.image_id
;
5628 it
->object
= p
->u
.image
.object
;
5629 it
->slice
= p
->u
.image
.slice
;
5631 case GET_FROM_STRETCH
:
5632 it
->object
= p
->u
.stretch
.object
;
5634 case GET_FROM_BUFFER
:
5635 it
->object
= it
->w
->buffer
;
5637 case GET_FROM_STRING
:
5638 it
->object
= it
->string
;
5640 case GET_FROM_DISPLAY_VECTOR
:
5642 it
->method
= GET_FROM_C_STRING
;
5643 else if (STRINGP (it
->string
))
5644 it
->method
= GET_FROM_STRING
;
5647 it
->method
= GET_FROM_BUFFER
;
5648 it
->object
= it
->w
->buffer
;
5651 it
->end_charpos
= p
->end_charpos
;
5652 it
->string_nchars
= p
->string_nchars
;
5654 it
->multibyte_p
= p
->multibyte_p
;
5655 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5656 it
->space_width
= p
->space_width
;
5657 it
->font_height
= p
->font_height
;
5658 it
->voffset
= p
->voffset
;
5659 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5660 it
->line_wrap
= p
->line_wrap
;
5661 it
->bidi_p
= p
->bidi_p
;
5662 it
->paragraph_embedding
= p
->paragraph_embedding
;
5663 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5666 bidi_pop_it (&it
->bidi_it
);
5667 /* Bidi-iterate until we get out of the portion of text, if any,
5668 covered by a `display' text property or by an overlay with
5669 `display' property. (We cannot just jump there, because the
5670 internal coherency of the bidi iterator state can not be
5671 preserved across such jumps.) We also must determine the
5672 paragraph base direction if the overlay we just processed is
5673 at the beginning of a new paragraph. */
5674 if (from_display_prop
5675 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5676 iterate_out_of_display_property (it
);
5678 xassert ((BUFFERP (it
->object
)
5679 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5680 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5681 || (STRINGP (it
->object
)
5682 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5683 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5684 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5690 /***********************************************************************
5692 ***********************************************************************/
5694 /* Set IT's current position to the previous line start. */
5697 back_to_previous_line_start (struct it
*it
)
5699 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5700 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5704 /* Move IT to the next line start.
5706 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5707 we skipped over part of the text (as opposed to moving the iterator
5708 continuously over the text). Otherwise, don't change the value
5711 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5712 iterator on the newline, if it was found.
5714 Newlines may come from buffer text, overlay strings, or strings
5715 displayed via the `display' property. That's the reason we can't
5716 simply use find_next_newline_no_quit.
5718 Note that this function may not skip over invisible text that is so
5719 because of text properties and immediately follows a newline. If
5720 it would, function reseat_at_next_visible_line_start, when called
5721 from set_iterator_to_next, would effectively make invisible
5722 characters following a newline part of the wrong glyph row, which
5723 leads to wrong cursor motion. */
5726 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5727 struct bidi_it
*bidi_it_prev
)
5729 EMACS_INT old_selective
;
5730 int newline_found_p
, n
;
5731 const int MAX_NEWLINE_DISTANCE
= 500;
5733 /* If already on a newline, just consume it to avoid unintended
5734 skipping over invisible text below. */
5735 if (it
->what
== IT_CHARACTER
5737 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5739 if (it
->bidi_p
&& bidi_it_prev
)
5740 *bidi_it_prev
= it
->bidi_it
;
5741 set_iterator_to_next (it
, 0);
5746 /* Don't handle selective display in the following. It's (a)
5747 unnecessary because it's done by the caller, and (b) leads to an
5748 infinite recursion because next_element_from_ellipsis indirectly
5749 calls this function. */
5750 old_selective
= it
->selective
;
5753 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5754 from buffer text. */
5755 for (n
= newline_found_p
= 0;
5756 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5757 n
+= STRINGP (it
->string
) ? 0 : 1)
5759 if (!get_next_display_element (it
))
5761 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5762 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5763 *bidi_it_prev
= it
->bidi_it
;
5764 set_iterator_to_next (it
, 0);
5767 /* If we didn't find a newline near enough, see if we can use a
5769 if (!newline_found_p
)
5771 EMACS_INT start
= IT_CHARPOS (*it
);
5772 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5775 xassert (!STRINGP (it
->string
));
5777 /* If there isn't any `display' property in sight, and no
5778 overlays, we can just use the position of the newline in
5780 if (it
->stop_charpos
>= limit
5781 || ((pos
= Fnext_single_property_change (make_number (start
),
5783 make_number (limit
)),
5785 && next_overlay_change (start
) == ZV
))
5789 IT_CHARPOS (*it
) = limit
;
5790 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5794 struct bidi_it bprev
;
5796 /* Help bidi.c avoid expensive searches for display
5797 properties and overlays, by telling it that there are
5798 none up to `limit'. */
5799 if (it
->bidi_it
.disp_pos
< limit
)
5801 it
->bidi_it
.disp_pos
= limit
;
5802 it
->bidi_it
.disp_prop
= 0;
5805 bprev
= it
->bidi_it
;
5806 bidi_move_to_visually_next (&it
->bidi_it
);
5807 } while (it
->bidi_it
.charpos
!= limit
);
5808 IT_CHARPOS (*it
) = limit
;
5809 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5811 *bidi_it_prev
= bprev
;
5813 *skipped_p
= newline_found_p
= 1;
5817 while (get_next_display_element (it
)
5818 && !newline_found_p
)
5820 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5821 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5822 *bidi_it_prev
= it
->bidi_it
;
5823 set_iterator_to_next (it
, 0);
5828 it
->selective
= old_selective
;
5829 return newline_found_p
;
5833 /* Set IT's current position to the previous visible line start. Skip
5834 invisible text that is so either due to text properties or due to
5835 selective display. Caution: this does not change IT->current_x and
5839 back_to_previous_visible_line_start (struct it
*it
)
5841 while (IT_CHARPOS (*it
) > BEGV
)
5843 back_to_previous_line_start (it
);
5845 if (IT_CHARPOS (*it
) <= BEGV
)
5848 /* If selective > 0, then lines indented more than its value are
5850 if (it
->selective
> 0
5851 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5855 /* Check the newline before point for invisibility. */
5858 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5859 Qinvisible
, it
->window
);
5860 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5864 if (IT_CHARPOS (*it
) <= BEGV
)
5869 void *it2data
= NULL
;
5872 Lisp_Object val
, overlay
;
5874 SAVE_IT (it2
, *it
, it2data
);
5876 /* If newline is part of a composition, continue from start of composition */
5877 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5878 && beg
< IT_CHARPOS (*it
))
5881 /* If newline is replaced by a display property, find start of overlay
5882 or interval and continue search from that point. */
5883 pos
= --IT_CHARPOS (it2
);
5886 bidi_unshelve_cache (NULL
, 0);
5887 it2
.string_from_display_prop_p
= 0;
5888 it2
.from_disp_prop_p
= 0;
5889 if (handle_display_prop (&it2
) == HANDLED_RETURN
5890 && !NILP (val
= get_char_property_and_overlay
5891 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5892 && (OVERLAYP (overlay
)
5893 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5894 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5896 RESTORE_IT (it
, it
, it2data
);
5900 /* Newline is not replaced by anything -- so we are done. */
5901 RESTORE_IT (it
, it
, it2data
);
5907 IT_CHARPOS (*it
) = beg
;
5908 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5912 it
->continuation_lines_width
= 0;
5914 xassert (IT_CHARPOS (*it
) >= BEGV
);
5915 xassert (IT_CHARPOS (*it
) == BEGV
5916 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5921 /* Reseat iterator IT at the previous visible line start. Skip
5922 invisible text that is so either due to text properties or due to
5923 selective display. At the end, update IT's overlay information,
5924 face information etc. */
5927 reseat_at_previous_visible_line_start (struct it
*it
)
5929 back_to_previous_visible_line_start (it
);
5930 reseat (it
, it
->current
.pos
, 1);
5935 /* Reseat iterator IT on the next visible line start in the current
5936 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5937 preceding the line start. Skip over invisible text that is so
5938 because of selective display. Compute faces, overlays etc at the
5939 new position. Note that this function does not skip over text that
5940 is invisible because of text properties. */
5943 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5945 int newline_found_p
, skipped_p
= 0;
5946 struct bidi_it bidi_it_prev
;
5948 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5950 /* Skip over lines that are invisible because they are indented
5951 more than the value of IT->selective. */
5952 if (it
->selective
> 0)
5953 while (IT_CHARPOS (*it
) < ZV
5954 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5957 xassert (IT_BYTEPOS (*it
) == BEGV
5958 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5960 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5963 /* Position on the newline if that's what's requested. */
5964 if (on_newline_p
&& newline_found_p
)
5966 if (STRINGP (it
->string
))
5968 if (IT_STRING_CHARPOS (*it
) > 0)
5972 --IT_STRING_CHARPOS (*it
);
5973 --IT_STRING_BYTEPOS (*it
);
5977 /* We need to restore the bidi iterator to the state
5978 it had on the newline, and resync the IT's
5979 position with that. */
5980 it
->bidi_it
= bidi_it_prev
;
5981 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5982 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5986 else if (IT_CHARPOS (*it
) > BEGV
)
5995 /* We need to restore the bidi iterator to the state it
5996 had on the newline and resync IT with that. */
5997 it
->bidi_it
= bidi_it_prev
;
5998 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5999 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6001 reseat (it
, it
->current
.pos
, 0);
6005 reseat (it
, it
->current
.pos
, 0);
6012 /***********************************************************************
6013 Changing an iterator's position
6014 ***********************************************************************/
6016 /* Change IT's current position to POS in current_buffer. If FORCE_P
6017 is non-zero, always check for text properties at the new position.
6018 Otherwise, text properties are only looked up if POS >=
6019 IT->check_charpos of a property. */
6022 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6024 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6026 reseat_1 (it
, pos
, 0);
6028 /* Determine where to check text properties. Avoid doing it
6029 where possible because text property lookup is very expensive. */
6031 || CHARPOS (pos
) > it
->stop_charpos
6032 || CHARPOS (pos
) < original_pos
)
6036 /* For bidi iteration, we need to prime prev_stop and
6037 base_level_stop with our best estimations. */
6038 /* Implementation note: Of course, POS is not necessarily a
6039 stop position, so assigning prev_pos to it is a lie; we
6040 should have called compute_stop_backwards. However, if
6041 the current buffer does not include any R2L characters,
6042 that call would be a waste of cycles, because the
6043 iterator will never move back, and thus never cross this
6044 "fake" stop position. So we delay that backward search
6045 until the time we really need it, in next_element_from_buffer. */
6046 if (CHARPOS (pos
) != it
->prev_stop
)
6047 it
->prev_stop
= CHARPOS (pos
);
6048 if (CHARPOS (pos
) < it
->base_level_stop
)
6049 it
->base_level_stop
= 0; /* meaning it's unknown */
6055 it
->prev_stop
= it
->base_level_stop
= 0;
6064 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6065 IT->stop_pos to POS, also. */
6068 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6070 /* Don't call this function when scanning a C string. */
6071 xassert (it
->s
== NULL
);
6073 /* POS must be a reasonable value. */
6074 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6076 it
->current
.pos
= it
->position
= pos
;
6077 it
->end_charpos
= ZV
;
6079 it
->current
.dpvec_index
= -1;
6080 it
->current
.overlay_string_index
= -1;
6081 IT_STRING_CHARPOS (*it
) = -1;
6082 IT_STRING_BYTEPOS (*it
) = -1;
6084 it
->method
= GET_FROM_BUFFER
;
6085 it
->object
= it
->w
->buffer
;
6086 it
->area
= TEXT_AREA
;
6087 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6089 it
->string_from_display_prop_p
= 0;
6090 it
->from_disp_prop_p
= 0;
6091 it
->face_before_selective_p
= 0;
6094 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6096 bidi_unshelve_cache (NULL
, 0);
6097 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6098 it
->bidi_it
.string
.s
= NULL
;
6099 it
->bidi_it
.string
.lstring
= Qnil
;
6100 it
->bidi_it
.string
.bufpos
= 0;
6101 it
->bidi_it
.string
.unibyte
= 0;
6106 it
->stop_charpos
= CHARPOS (pos
);
6107 it
->base_level_stop
= CHARPOS (pos
);
6112 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6113 If S is non-null, it is a C string to iterate over. Otherwise,
6114 STRING gives a Lisp string to iterate over.
6116 If PRECISION > 0, don't return more then PRECISION number of
6117 characters from the string.
6119 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6120 characters have been returned. FIELD_WIDTH < 0 means an infinite
6123 MULTIBYTE = 0 means disable processing of multibyte characters,
6124 MULTIBYTE > 0 means enable it,
6125 MULTIBYTE < 0 means use IT->multibyte_p.
6127 IT must be initialized via a prior call to init_iterator before
6128 calling this function. */
6131 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6132 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6135 /* No region in strings. */
6136 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6138 /* No text property checks performed by default, but see below. */
6139 it
->stop_charpos
= -1;
6141 /* Set iterator position and end position. */
6142 memset (&it
->current
, 0, sizeof it
->current
);
6143 it
->current
.overlay_string_index
= -1;
6144 it
->current
.dpvec_index
= -1;
6145 xassert (charpos
>= 0);
6147 /* If STRING is specified, use its multibyteness, otherwise use the
6148 setting of MULTIBYTE, if specified. */
6150 it
->multibyte_p
= multibyte
> 0;
6152 /* Bidirectional reordering of strings is controlled by the default
6153 value of bidi-display-reordering. Don't try to reorder while
6154 loading loadup.el, as the necessary character property tables are
6155 not yet available. */
6158 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6162 xassert (STRINGP (string
));
6163 it
->string
= string
;
6165 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6166 it
->method
= GET_FROM_STRING
;
6167 it
->current
.string_pos
= string_pos (charpos
, string
);
6171 it
->bidi_it
.string
.lstring
= string
;
6172 it
->bidi_it
.string
.s
= NULL
;
6173 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6174 it
->bidi_it
.string
.bufpos
= 0;
6175 it
->bidi_it
.string
.from_disp_str
= 0;
6176 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6177 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6178 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6183 it
->s
= (const unsigned char *) s
;
6186 /* Note that we use IT->current.pos, not it->current.string_pos,
6187 for displaying C strings. */
6188 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6189 if (it
->multibyte_p
)
6191 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6192 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6196 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6197 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6202 it
->bidi_it
.string
.lstring
= Qnil
;
6203 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6204 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6205 it
->bidi_it
.string
.bufpos
= 0;
6206 it
->bidi_it
.string
.from_disp_str
= 0;
6207 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6208 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6211 it
->method
= GET_FROM_C_STRING
;
6214 /* PRECISION > 0 means don't return more than PRECISION characters
6216 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6218 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6220 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6223 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6224 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6225 FIELD_WIDTH < 0 means infinite field width. This is useful for
6226 padding with `-' at the end of a mode line. */
6227 if (field_width
< 0)
6228 field_width
= INFINITY
;
6229 /* Implementation note: We deliberately don't enlarge
6230 it->bidi_it.string.schars here to fit it->end_charpos, because
6231 the bidi iterator cannot produce characters out of thin air. */
6232 if (field_width
> it
->end_charpos
- charpos
)
6233 it
->end_charpos
= charpos
+ field_width
;
6235 /* Use the standard display table for displaying strings. */
6236 if (DISP_TABLE_P (Vstandard_display_table
))
6237 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6239 it
->stop_charpos
= charpos
;
6240 it
->prev_stop
= charpos
;
6241 it
->base_level_stop
= 0;
6244 it
->bidi_it
.first_elt
= 1;
6245 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6246 it
->bidi_it
.disp_pos
= -1;
6248 if (s
== NULL
&& it
->multibyte_p
)
6250 EMACS_INT endpos
= SCHARS (it
->string
);
6251 if (endpos
> it
->end_charpos
)
6252 endpos
= it
->end_charpos
;
6253 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6261 /***********************************************************************
6263 ***********************************************************************/
6265 /* Map enum it_method value to corresponding next_element_from_* function. */
6267 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6269 next_element_from_buffer
,
6270 next_element_from_display_vector
,
6271 next_element_from_string
,
6272 next_element_from_c_string
,
6273 next_element_from_image
,
6274 next_element_from_stretch
6277 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6280 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6281 (possibly with the following characters). */
6283 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6284 ((IT)->cmp_it.id >= 0 \
6285 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6286 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6287 END_CHARPOS, (IT)->w, \
6288 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6292 /* Lookup the char-table Vglyphless_char_display for character C (-1
6293 if we want information for no-font case), and return the display
6294 method symbol. By side-effect, update it->what and
6295 it->glyphless_method. This function is called from
6296 get_next_display_element for each character element, and from
6297 x_produce_glyphs when no suitable font was found. */
6300 lookup_glyphless_char_display (int c
, struct it
*it
)
6302 Lisp_Object glyphless_method
= Qnil
;
6304 if (CHAR_TABLE_P (Vglyphless_char_display
)
6305 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6309 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6310 if (CONSP (glyphless_method
))
6311 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6312 ? XCAR (glyphless_method
)
6313 : XCDR (glyphless_method
);
6316 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6320 if (NILP (glyphless_method
))
6323 /* The default is to display the character by a proper font. */
6325 /* The default for the no-font case is to display an empty box. */
6326 glyphless_method
= Qempty_box
;
6328 if (EQ (glyphless_method
, Qzero_width
))
6331 return glyphless_method
;
6332 /* This method can't be used for the no-font case. */
6333 glyphless_method
= Qempty_box
;
6335 if (EQ (glyphless_method
, Qthin_space
))
6336 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6337 else if (EQ (glyphless_method
, Qempty_box
))
6338 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6339 else if (EQ (glyphless_method
, Qhex_code
))
6340 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6341 else if (STRINGP (glyphless_method
))
6342 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6345 /* Invalid value. We use the default method. */
6346 glyphless_method
= Qnil
;
6349 it
->what
= IT_GLYPHLESS
;
6350 return glyphless_method
;
6353 /* Load IT's display element fields with information about the next
6354 display element from the current position of IT. Value is zero if
6355 end of buffer (or C string) is reached. */
6357 static struct frame
*last_escape_glyph_frame
= NULL
;
6358 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6359 static int last_escape_glyph_merged_face_id
= 0;
6361 struct frame
*last_glyphless_glyph_frame
= NULL
;
6362 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6363 int last_glyphless_glyph_merged_face_id
= 0;
6366 get_next_display_element (struct it
*it
)
6368 /* Non-zero means that we found a display element. Zero means that
6369 we hit the end of what we iterate over. Performance note: the
6370 function pointer `method' used here turns out to be faster than
6371 using a sequence of if-statements. */
6375 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6377 if (it
->what
== IT_CHARACTER
)
6379 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6380 and only if (a) the resolved directionality of that character
6382 /* FIXME: Do we need an exception for characters from display
6384 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6385 it
->c
= bidi_mirror_char (it
->c
);
6386 /* Map via display table or translate control characters.
6387 IT->c, IT->len etc. have been set to the next character by
6388 the function call above. If we have a display table, and it
6389 contains an entry for IT->c, translate it. Don't do this if
6390 IT->c itself comes from a display table, otherwise we could
6391 end up in an infinite recursion. (An alternative could be to
6392 count the recursion depth of this function and signal an
6393 error when a certain maximum depth is reached.) Is it worth
6395 if (success_p
&& it
->dpvec
== NULL
)
6398 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6399 int nonascii_space_p
= 0;
6400 int nonascii_hyphen_p
= 0;
6401 int c
= it
->c
; /* This is the character to display. */
6403 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6405 xassert (SINGLE_BYTE_CHAR_P (c
));
6406 if (unibyte_display_via_language_environment
)
6408 c
= DECODE_CHAR (unibyte
, c
);
6410 c
= BYTE8_TO_CHAR (it
->c
);
6413 c
= BYTE8_TO_CHAR (it
->c
);
6417 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6420 struct Lisp_Vector
*v
= XVECTOR (dv
);
6422 /* Return the first character from the display table
6423 entry, if not empty. If empty, don't display the
6424 current character. */
6427 it
->dpvec_char_len
= it
->len
;
6428 it
->dpvec
= v
->contents
;
6429 it
->dpend
= v
->contents
+ v
->header
.size
;
6430 it
->current
.dpvec_index
= 0;
6431 it
->dpvec_face_id
= -1;
6432 it
->saved_face_id
= it
->face_id
;
6433 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6438 set_iterator_to_next (it
, 0);
6443 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6445 if (it
->what
== IT_GLYPHLESS
)
6447 /* Don't display this character. */
6448 set_iterator_to_next (it
, 0);
6452 /* If `nobreak-char-display' is non-nil, we display
6453 non-ASCII spaces and hyphens specially. */
6454 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6457 nonascii_space_p
= 1;
6458 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6459 nonascii_hyphen_p
= 1;
6462 /* Translate control characters into `\003' or `^C' form.
6463 Control characters coming from a display table entry are
6464 currently not translated because we use IT->dpvec to hold
6465 the translation. This could easily be changed but I
6466 don't believe that it is worth doing.
6468 The characters handled by `nobreak-char-display' must be
6471 Non-printable characters and raw-byte characters are also
6472 translated to octal form. */
6473 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6474 ? (it
->area
!= TEXT_AREA
6475 /* In mode line, treat \n, \t like other crl chars. */
6478 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6479 || (c
!= '\n' && c
!= '\t'))
6481 || nonascii_hyphen_p
6483 || ! CHAR_PRINTABLE_P (c
))))
6485 /* C is a control character, non-ASCII space/hyphen,
6486 raw-byte, or a non-printable character which must be
6487 displayed either as '\003' or as `^C' where the '\\'
6488 and '^' can be defined in the display table. Fill
6489 IT->ctl_chars with glyphs for what we have to
6490 display. Then, set IT->dpvec to these glyphs. */
6494 EMACS_INT lface_id
= 0;
6497 /* Handle control characters with ^. */
6499 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6503 g
= '^'; /* default glyph for Control */
6504 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6506 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6507 && GLYPH_CODE_CHAR_VALID_P (gc
))
6509 g
= GLYPH_CODE_CHAR (gc
);
6510 lface_id
= GLYPH_CODE_FACE (gc
);
6514 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6516 else if (it
->f
== last_escape_glyph_frame
6517 && it
->face_id
== last_escape_glyph_face_id
)
6519 face_id
= last_escape_glyph_merged_face_id
;
6523 /* Merge the escape-glyph face into the current face. */
6524 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6526 last_escape_glyph_frame
= it
->f
;
6527 last_escape_glyph_face_id
= it
->face_id
;
6528 last_escape_glyph_merged_face_id
= face_id
;
6531 XSETINT (it
->ctl_chars
[0], g
);
6532 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6534 goto display_control
;
6537 /* Handle non-ascii space in the mode where it only gets
6540 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6542 /* Merge `nobreak-space' into the current face. */
6543 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6545 XSETINT (it
->ctl_chars
[0], ' ');
6547 goto display_control
;
6550 /* Handle sequences that start with the "escape glyph". */
6552 /* the default escape glyph is \. */
6553 escape_glyph
= '\\';
6556 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6557 && GLYPH_CODE_CHAR_VALID_P (gc
))
6559 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6560 lface_id
= GLYPH_CODE_FACE (gc
);
6564 /* The display table specified a face.
6565 Merge it into face_id and also into escape_glyph. */
6566 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6569 else if (it
->f
== last_escape_glyph_frame
6570 && it
->face_id
== last_escape_glyph_face_id
)
6572 face_id
= last_escape_glyph_merged_face_id
;
6576 /* Merge the escape-glyph face into the current face. */
6577 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6579 last_escape_glyph_frame
= it
->f
;
6580 last_escape_glyph_face_id
= it
->face_id
;
6581 last_escape_glyph_merged_face_id
= face_id
;
6584 /* Draw non-ASCII hyphen with just highlighting: */
6586 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6588 XSETINT (it
->ctl_chars
[0], '-');
6590 goto display_control
;
6593 /* Draw non-ASCII space/hyphen with escape glyph: */
6595 if (nonascii_space_p
|| nonascii_hyphen_p
)
6597 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6598 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6600 goto display_control
;
6607 if (CHAR_BYTE8_P (c
))
6608 /* Display \200 instead of \17777600. */
6609 c
= CHAR_TO_BYTE8 (c
);
6610 len
= sprintf (str
, "%03o", c
);
6612 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6613 for (i
= 0; i
< len
; i
++)
6614 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6619 /* Set up IT->dpvec and return first character from it. */
6620 it
->dpvec_char_len
= it
->len
;
6621 it
->dpvec
= it
->ctl_chars
;
6622 it
->dpend
= it
->dpvec
+ ctl_len
;
6623 it
->current
.dpvec_index
= 0;
6624 it
->dpvec_face_id
= face_id
;
6625 it
->saved_face_id
= it
->face_id
;
6626 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6630 it
->char_to_display
= c
;
6634 it
->char_to_display
= it
->c
;
6638 /* Adjust face id for a multibyte character. There are no multibyte
6639 character in unibyte text. */
6640 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6643 && FRAME_WINDOW_P (it
->f
))
6645 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6647 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6649 /* Automatic composition with glyph-string. */
6650 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6652 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6656 EMACS_INT pos
= (it
->s
? -1
6657 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6658 : IT_CHARPOS (*it
));
6661 if (it
->what
== IT_CHARACTER
)
6662 c
= it
->char_to_display
;
6665 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6669 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6670 /* TAB in a composition means display glyphs with
6671 padding space on the left or right. */
6672 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6675 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6680 /* Is this character the last one of a run of characters with
6681 box? If yes, set IT->end_of_box_run_p to 1. */
6685 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6687 int face_id
= underlying_face_id (it
);
6688 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6692 if (face
->box
== FACE_NO_BOX
)
6694 /* If the box comes from face properties in a
6695 display string, check faces in that string. */
6696 int string_face_id
= face_after_it_pos (it
);
6697 it
->end_of_box_run_p
6698 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6701 /* Otherwise, the box comes from the underlying face.
6702 If this is the last string character displayed, check
6703 the next buffer location. */
6704 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6705 && (it
->current
.overlay_string_index
6706 == it
->n_overlay_strings
- 1))
6710 struct text_pos pos
= it
->current
.pos
;
6711 INC_TEXT_POS (pos
, it
->multibyte_p
);
6713 next_face_id
= face_at_buffer_position
6714 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6715 it
->region_end_charpos
, &ignore
,
6716 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6718 it
->end_of_box_run_p
6719 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6726 int face_id
= face_after_it_pos (it
);
6727 it
->end_of_box_run_p
6728 = (face_id
!= it
->face_id
6729 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6733 /* Value is 0 if end of buffer or string reached. */
6738 /* Move IT to the next display element.
6740 RESEAT_P non-zero means if called on a newline in buffer text,
6741 skip to the next visible line start.
6743 Functions get_next_display_element and set_iterator_to_next are
6744 separate because I find this arrangement easier to handle than a
6745 get_next_display_element function that also increments IT's
6746 position. The way it is we can first look at an iterator's current
6747 display element, decide whether it fits on a line, and if it does,
6748 increment the iterator position. The other way around we probably
6749 would either need a flag indicating whether the iterator has to be
6750 incremented the next time, or we would have to implement a
6751 decrement position function which would not be easy to write. */
6754 set_iterator_to_next (struct it
*it
, int reseat_p
)
6756 /* Reset flags indicating start and end of a sequence of characters
6757 with box. Reset them at the start of this function because
6758 moving the iterator to a new position might set them. */
6759 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6763 case GET_FROM_BUFFER
:
6764 /* The current display element of IT is a character from
6765 current_buffer. Advance in the buffer, and maybe skip over
6766 invisible lines that are so because of selective display. */
6767 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6768 reseat_at_next_visible_line_start (it
, 0);
6769 else if (it
->cmp_it
.id
>= 0)
6771 /* We are currently getting glyphs from a composition. */
6776 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6777 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6778 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6780 it
->cmp_it
.from
= it
->cmp_it
.to
;
6785 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6787 it
->end_charpos
, Qnil
);
6790 else if (! it
->cmp_it
.reversed_p
)
6792 /* Composition created while scanning forward. */
6793 /* Update IT's char/byte positions to point to the first
6794 character of the next grapheme cluster, or to the
6795 character visually after the current composition. */
6796 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6797 bidi_move_to_visually_next (&it
->bidi_it
);
6798 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6799 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6801 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6803 /* Proceed to the next grapheme cluster. */
6804 it
->cmp_it
.from
= it
->cmp_it
.to
;
6808 /* No more grapheme clusters in this composition.
6809 Find the next stop position. */
6810 EMACS_INT stop
= it
->end_charpos
;
6811 if (it
->bidi_it
.scan_dir
< 0)
6812 /* Now we are scanning backward and don't know
6815 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6816 IT_BYTEPOS (*it
), stop
, Qnil
);
6821 /* Composition created while scanning backward. */
6822 /* Update IT's char/byte positions to point to the last
6823 character of the previous grapheme cluster, or the
6824 character visually after the current composition. */
6825 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6826 bidi_move_to_visually_next (&it
->bidi_it
);
6827 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6828 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6829 if (it
->cmp_it
.from
> 0)
6831 /* Proceed to the previous grapheme cluster. */
6832 it
->cmp_it
.to
= it
->cmp_it
.from
;
6836 /* No more grapheme clusters in this composition.
6837 Find the next stop position. */
6838 EMACS_INT stop
= it
->end_charpos
;
6839 if (it
->bidi_it
.scan_dir
< 0)
6840 /* Now we are scanning backward and don't know
6843 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6844 IT_BYTEPOS (*it
), stop
, Qnil
);
6850 xassert (it
->len
!= 0);
6854 IT_BYTEPOS (*it
) += it
->len
;
6855 IT_CHARPOS (*it
) += 1;
6859 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6860 /* If this is a new paragraph, determine its base
6861 direction (a.k.a. its base embedding level). */
6862 if (it
->bidi_it
.new_paragraph
)
6863 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6864 bidi_move_to_visually_next (&it
->bidi_it
);
6865 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6866 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6867 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6869 /* As the scan direction was changed, we must
6870 re-compute the stop position for composition. */
6871 EMACS_INT stop
= it
->end_charpos
;
6872 if (it
->bidi_it
.scan_dir
< 0)
6874 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6875 IT_BYTEPOS (*it
), stop
, Qnil
);
6878 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6882 case GET_FROM_C_STRING
:
6883 /* Current display element of IT is from a C string. */
6885 /* If the string position is beyond string's end, it means
6886 next_element_from_c_string is padding the string with
6887 blanks, in which case we bypass the bidi iterator,
6888 because it cannot deal with such virtual characters. */
6889 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6891 IT_BYTEPOS (*it
) += it
->len
;
6892 IT_CHARPOS (*it
) += 1;
6896 bidi_move_to_visually_next (&it
->bidi_it
);
6897 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6898 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6902 case GET_FROM_DISPLAY_VECTOR
:
6903 /* Current display element of IT is from a display table entry.
6904 Advance in the display table definition. Reset it to null if
6905 end reached, and continue with characters from buffers/
6907 ++it
->current
.dpvec_index
;
6909 /* Restore face of the iterator to what they were before the
6910 display vector entry (these entries may contain faces). */
6911 it
->face_id
= it
->saved_face_id
;
6913 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6915 int recheck_faces
= it
->ellipsis_p
;
6918 it
->method
= GET_FROM_C_STRING
;
6919 else if (STRINGP (it
->string
))
6920 it
->method
= GET_FROM_STRING
;
6923 it
->method
= GET_FROM_BUFFER
;
6924 it
->object
= it
->w
->buffer
;
6928 it
->current
.dpvec_index
= -1;
6930 /* Skip over characters which were displayed via IT->dpvec. */
6931 if (it
->dpvec_char_len
< 0)
6932 reseat_at_next_visible_line_start (it
, 1);
6933 else if (it
->dpvec_char_len
> 0)
6935 if (it
->method
== GET_FROM_STRING
6936 && it
->n_overlay_strings
> 0)
6937 it
->ignore_overlay_strings_at_pos_p
= 1;
6938 it
->len
= it
->dpvec_char_len
;
6939 set_iterator_to_next (it
, reseat_p
);
6942 /* Maybe recheck faces after display vector */
6944 it
->stop_charpos
= IT_CHARPOS (*it
);
6948 case GET_FROM_STRING
:
6949 /* Current display element is a character from a Lisp string. */
6950 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6951 if (it
->cmp_it
.id
>= 0)
6957 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6958 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6959 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6960 it
->cmp_it
.from
= it
->cmp_it
.to
;
6964 composition_compute_stop_pos (&it
->cmp_it
,
6965 IT_STRING_CHARPOS (*it
),
6966 IT_STRING_BYTEPOS (*it
),
6967 it
->end_charpos
, it
->string
);
6970 else if (! it
->cmp_it
.reversed_p
)
6972 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6973 bidi_move_to_visually_next (&it
->bidi_it
);
6974 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6975 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6977 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6978 it
->cmp_it
.from
= it
->cmp_it
.to
;
6981 EMACS_INT stop
= it
->end_charpos
;
6982 if (it
->bidi_it
.scan_dir
< 0)
6984 composition_compute_stop_pos (&it
->cmp_it
,
6985 IT_STRING_CHARPOS (*it
),
6986 IT_STRING_BYTEPOS (*it
), stop
,
6992 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6993 bidi_move_to_visually_next (&it
->bidi_it
);
6994 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6995 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6996 if (it
->cmp_it
.from
> 0)
6997 it
->cmp_it
.to
= it
->cmp_it
.from
;
7000 EMACS_INT stop
= it
->end_charpos
;
7001 if (it
->bidi_it
.scan_dir
< 0)
7003 composition_compute_stop_pos (&it
->cmp_it
,
7004 IT_STRING_CHARPOS (*it
),
7005 IT_STRING_BYTEPOS (*it
), stop
,
7013 /* If the string position is beyond string's end, it
7014 means next_element_from_string is padding the string
7015 with blanks, in which case we bypass the bidi
7016 iterator, because it cannot deal with such virtual
7018 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7020 IT_STRING_BYTEPOS (*it
) += it
->len
;
7021 IT_STRING_CHARPOS (*it
) += 1;
7025 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7027 bidi_move_to_visually_next (&it
->bidi_it
);
7028 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7029 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7030 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7032 EMACS_INT stop
= it
->end_charpos
;
7034 if (it
->bidi_it
.scan_dir
< 0)
7036 composition_compute_stop_pos (&it
->cmp_it
,
7037 IT_STRING_CHARPOS (*it
),
7038 IT_STRING_BYTEPOS (*it
), stop
,
7044 consider_string_end
:
7046 if (it
->current
.overlay_string_index
>= 0)
7048 /* IT->string is an overlay string. Advance to the
7049 next, if there is one. */
7050 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7053 next_overlay_string (it
);
7055 setup_for_ellipsis (it
, 0);
7060 /* IT->string is not an overlay string. If we reached
7061 its end, and there is something on IT->stack, proceed
7062 with what is on the stack. This can be either another
7063 string, this time an overlay string, or a buffer. */
7064 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7068 if (it
->method
== GET_FROM_STRING
)
7069 goto consider_string_end
;
7074 case GET_FROM_IMAGE
:
7075 case GET_FROM_STRETCH
:
7076 /* The position etc with which we have to proceed are on
7077 the stack. The position may be at the end of a string,
7078 if the `display' property takes up the whole string. */
7079 xassert (it
->sp
> 0);
7081 if (it
->method
== GET_FROM_STRING
)
7082 goto consider_string_end
;
7086 /* There are no other methods defined, so this should be a bug. */
7090 xassert (it
->method
!= GET_FROM_STRING
7091 || (STRINGP (it
->string
)
7092 && IT_STRING_CHARPOS (*it
) >= 0));
7095 /* Load IT's display element fields with information about the next
7096 display element which comes from a display table entry or from the
7097 result of translating a control character to one of the forms `^C'
7100 IT->dpvec holds the glyphs to return as characters.
7101 IT->saved_face_id holds the face id before the display vector--it
7102 is restored into IT->face_id in set_iterator_to_next. */
7105 next_element_from_display_vector (struct it
*it
)
7110 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7112 it
->face_id
= it
->saved_face_id
;
7114 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7115 That seemed totally bogus - so I changed it... */
7116 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7118 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7120 it
->c
= GLYPH_CODE_CHAR (gc
);
7121 it
->len
= CHAR_BYTES (it
->c
);
7123 /* The entry may contain a face id to use. Such a face id is
7124 the id of a Lisp face, not a realized face. A face id of
7125 zero means no face is specified. */
7126 if (it
->dpvec_face_id
>= 0)
7127 it
->face_id
= it
->dpvec_face_id
;
7130 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7132 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7137 /* Display table entry is invalid. Return a space. */
7138 it
->c
= ' ', it
->len
= 1;
7140 /* Don't change position and object of the iterator here. They are
7141 still the values of the character that had this display table
7142 entry or was translated, and that's what we want. */
7143 it
->what
= IT_CHARACTER
;
7147 /* Get the first element of string/buffer in the visual order, after
7148 being reseated to a new position in a string or a buffer. */
7150 get_visually_first_element (struct it
*it
)
7152 int string_p
= STRINGP (it
->string
) || it
->s
;
7153 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7154 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7156 if (STRINGP (it
->string
))
7158 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7159 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7163 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7164 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7167 if (it
->bidi_it
.charpos
== eob
)
7169 /* Nothing to do, but reset the FIRST_ELT flag, like
7170 bidi_paragraph_init does, because we are not going to
7172 it
->bidi_it
.first_elt
= 0;
7174 else if (it
->bidi_it
.charpos
== bob
7176 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7177 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7179 /* If we are at the beginning of a line/string, we can produce
7180 the next element right away. */
7181 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7182 bidi_move_to_visually_next (&it
->bidi_it
);
7186 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7188 /* We need to prime the bidi iterator starting at the line's or
7189 string's beginning, before we will be able to produce the
7192 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7195 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7197 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7199 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7202 /* Now return to buffer/string position where we were asked
7203 to get the next display element, and produce that. */
7204 bidi_move_to_visually_next (&it
->bidi_it
);
7206 while (it
->bidi_it
.bytepos
!= orig_bytepos
7207 && it
->bidi_it
.charpos
< eob
);
7210 /* Adjust IT's position information to where we ended up. */
7211 if (STRINGP (it
->string
))
7213 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7214 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7218 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7219 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7222 if (STRINGP (it
->string
) || !it
->s
)
7224 EMACS_INT stop
, charpos
, bytepos
;
7226 if (STRINGP (it
->string
))
7229 stop
= SCHARS (it
->string
);
7230 if (stop
> it
->end_charpos
)
7231 stop
= it
->end_charpos
;
7232 charpos
= IT_STRING_CHARPOS (*it
);
7233 bytepos
= IT_STRING_BYTEPOS (*it
);
7237 stop
= it
->end_charpos
;
7238 charpos
= IT_CHARPOS (*it
);
7239 bytepos
= IT_BYTEPOS (*it
);
7241 if (it
->bidi_it
.scan_dir
< 0)
7243 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7248 /* Load IT with the next display element from Lisp string IT->string.
7249 IT->current.string_pos is the current position within the string.
7250 If IT->current.overlay_string_index >= 0, the Lisp string is an
7254 next_element_from_string (struct it
*it
)
7256 struct text_pos position
;
7258 xassert (STRINGP (it
->string
));
7259 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7260 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7261 position
= it
->current
.string_pos
;
7263 /* With bidi reordering, the character to display might not be the
7264 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7265 that we were reseat()ed to a new string, whose paragraph
7266 direction is not known. */
7267 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7269 get_visually_first_element (it
);
7270 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7273 /* Time to check for invisible text? */
7274 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7276 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7279 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7280 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7282 /* With bidi non-linear iteration, we could find
7283 ourselves far beyond the last computed stop_charpos,
7284 with several other stop positions in between that we
7285 missed. Scan them all now, in buffer's logical
7286 order, until we find and handle the last stop_charpos
7287 that precedes our current position. */
7288 handle_stop_backwards (it
, it
->stop_charpos
);
7289 return GET_NEXT_DISPLAY_ELEMENT (it
);
7295 /* Take note of the stop position we just moved
7296 across, for when we will move back across it. */
7297 it
->prev_stop
= it
->stop_charpos
;
7298 /* If we are at base paragraph embedding level, take
7299 note of the last stop position seen at this
7301 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7302 it
->base_level_stop
= it
->stop_charpos
;
7306 /* Since a handler may have changed IT->method, we must
7308 return GET_NEXT_DISPLAY_ELEMENT (it
);
7312 /* If we are before prev_stop, we may have overstepped
7313 on our way backwards a stop_pos, and if so, we need
7314 to handle that stop_pos. */
7315 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7316 /* We can sometimes back up for reasons that have nothing
7317 to do with bidi reordering. E.g., compositions. The
7318 code below is only needed when we are above the base
7319 embedding level, so test for that explicitly. */
7320 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7322 /* If we lost track of base_level_stop, we have no better
7323 place for handle_stop_backwards to start from than string
7324 beginning. This happens, e.g., when we were reseated to
7325 the previous screenful of text by vertical-motion. */
7326 if (it
->base_level_stop
<= 0
7327 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7328 it
->base_level_stop
= 0;
7329 handle_stop_backwards (it
, it
->base_level_stop
);
7330 return GET_NEXT_DISPLAY_ELEMENT (it
);
7334 if (it
->current
.overlay_string_index
>= 0)
7336 /* Get the next character from an overlay string. In overlay
7337 strings, There is no field width or padding with spaces to
7339 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7344 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7345 IT_STRING_BYTEPOS (*it
),
7346 it
->bidi_it
.scan_dir
< 0
7348 : SCHARS (it
->string
))
7349 && next_element_from_composition (it
))
7353 else if (STRING_MULTIBYTE (it
->string
))
7355 const unsigned char *s
= (SDATA (it
->string
)
7356 + IT_STRING_BYTEPOS (*it
));
7357 it
->c
= string_char_and_length (s
, &it
->len
);
7361 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7367 /* Get the next character from a Lisp string that is not an
7368 overlay string. Such strings come from the mode line, for
7369 example. We may have to pad with spaces, or truncate the
7370 string. See also next_element_from_c_string. */
7371 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7376 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7378 /* Pad with spaces. */
7379 it
->c
= ' ', it
->len
= 1;
7380 CHARPOS (position
) = BYTEPOS (position
) = -1;
7382 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7383 IT_STRING_BYTEPOS (*it
),
7384 it
->bidi_it
.scan_dir
< 0
7386 : it
->string_nchars
)
7387 && next_element_from_composition (it
))
7391 else if (STRING_MULTIBYTE (it
->string
))
7393 const unsigned char *s
= (SDATA (it
->string
)
7394 + IT_STRING_BYTEPOS (*it
));
7395 it
->c
= string_char_and_length (s
, &it
->len
);
7399 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7404 /* Record what we have and where it came from. */
7405 it
->what
= IT_CHARACTER
;
7406 it
->object
= it
->string
;
7407 it
->position
= position
;
7412 /* Load IT with next display element from C string IT->s.
7413 IT->string_nchars is the maximum number of characters to return
7414 from the string. IT->end_charpos may be greater than
7415 IT->string_nchars when this function is called, in which case we
7416 may have to return padding spaces. Value is zero if end of string
7417 reached, including padding spaces. */
7420 next_element_from_c_string (struct it
*it
)
7425 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7426 it
->what
= IT_CHARACTER
;
7427 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7430 /* With bidi reordering, the character to display might not be the
7431 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7432 we were reseated to a new string, whose paragraph direction is
7434 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7435 get_visually_first_element (it
);
7437 /* IT's position can be greater than IT->string_nchars in case a
7438 field width or precision has been specified when the iterator was
7440 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7442 /* End of the game. */
7446 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7448 /* Pad with spaces. */
7449 it
->c
= ' ', it
->len
= 1;
7450 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7452 else if (it
->multibyte_p
)
7453 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7455 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7461 /* Set up IT to return characters from an ellipsis, if appropriate.
7462 The definition of the ellipsis glyphs may come from a display table
7463 entry. This function fills IT with the first glyph from the
7464 ellipsis if an ellipsis is to be displayed. */
7467 next_element_from_ellipsis (struct it
*it
)
7469 if (it
->selective_display_ellipsis_p
)
7470 setup_for_ellipsis (it
, it
->len
);
7473 /* The face at the current position may be different from the
7474 face we find after the invisible text. Remember what it
7475 was in IT->saved_face_id, and signal that it's there by
7476 setting face_before_selective_p. */
7477 it
->saved_face_id
= it
->face_id
;
7478 it
->method
= GET_FROM_BUFFER
;
7479 it
->object
= it
->w
->buffer
;
7480 reseat_at_next_visible_line_start (it
, 1);
7481 it
->face_before_selective_p
= 1;
7484 return GET_NEXT_DISPLAY_ELEMENT (it
);
7488 /* Deliver an image display element. The iterator IT is already
7489 filled with image information (done in handle_display_prop). Value
7494 next_element_from_image (struct it
*it
)
7496 it
->what
= IT_IMAGE
;
7497 it
->ignore_overlay_strings_at_pos_p
= 0;
7502 /* Fill iterator IT with next display element from a stretch glyph
7503 property. IT->object is the value of the text property. Value is
7507 next_element_from_stretch (struct it
*it
)
7509 it
->what
= IT_STRETCH
;
7513 /* Scan backwards from IT's current position until we find a stop
7514 position, or until BEGV. This is called when we find ourself
7515 before both the last known prev_stop and base_level_stop while
7516 reordering bidirectional text. */
7519 compute_stop_pos_backwards (struct it
*it
)
7521 const int SCAN_BACK_LIMIT
= 1000;
7522 struct text_pos pos
;
7523 struct display_pos save_current
= it
->current
;
7524 struct text_pos save_position
= it
->position
;
7525 EMACS_INT charpos
= IT_CHARPOS (*it
);
7526 EMACS_INT where_we_are
= charpos
;
7527 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7528 EMACS_INT save_end_pos
= it
->end_charpos
;
7530 xassert (NILP (it
->string
) && !it
->s
);
7531 xassert (it
->bidi_p
);
7535 it
->end_charpos
= min (charpos
+ 1, ZV
);
7536 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7537 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7538 reseat_1 (it
, pos
, 0);
7539 compute_stop_pos (it
);
7540 /* We must advance forward, right? */
7541 if (it
->stop_charpos
<= charpos
)
7544 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7546 if (it
->stop_charpos
<= where_we_are
)
7547 it
->prev_stop
= it
->stop_charpos
;
7549 it
->prev_stop
= BEGV
;
7551 it
->current
= save_current
;
7552 it
->position
= save_position
;
7553 it
->stop_charpos
= save_stop_pos
;
7554 it
->end_charpos
= save_end_pos
;
7557 /* Scan forward from CHARPOS in the current buffer/string, until we
7558 find a stop position > current IT's position. Then handle the stop
7559 position before that. This is called when we bump into a stop
7560 position while reordering bidirectional text. CHARPOS should be
7561 the last previously processed stop_pos (or BEGV/0, if none were
7562 processed yet) whose position is less that IT's current
7566 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7568 int bufp
= !STRINGP (it
->string
);
7569 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7570 struct display_pos save_current
= it
->current
;
7571 struct text_pos save_position
= it
->position
;
7572 struct text_pos pos1
;
7573 EMACS_INT next_stop
;
7575 /* Scan in strict logical order. */
7576 xassert (it
->bidi_p
);
7580 it
->prev_stop
= charpos
;
7583 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7584 reseat_1 (it
, pos1
, 0);
7587 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7588 compute_stop_pos (it
);
7589 /* We must advance forward, right? */
7590 if (it
->stop_charpos
<= it
->prev_stop
)
7592 charpos
= it
->stop_charpos
;
7594 while (charpos
<= where_we_are
);
7597 it
->current
= save_current
;
7598 it
->position
= save_position
;
7599 next_stop
= it
->stop_charpos
;
7600 it
->stop_charpos
= it
->prev_stop
;
7602 it
->stop_charpos
= next_stop
;
7605 /* Load IT with the next display element from current_buffer. Value
7606 is zero if end of buffer reached. IT->stop_charpos is the next
7607 position at which to stop and check for text properties or buffer
7611 next_element_from_buffer (struct it
*it
)
7615 xassert (IT_CHARPOS (*it
) >= BEGV
);
7616 xassert (NILP (it
->string
) && !it
->s
);
7617 xassert (!it
->bidi_p
7618 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7619 && it
->bidi_it
.string
.s
== NULL
));
7621 /* With bidi reordering, the character to display might not be the
7622 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7623 we were reseat()ed to a new buffer position, which is potentially
7624 a different paragraph. */
7625 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7627 get_visually_first_element (it
);
7628 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7631 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7633 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7635 int overlay_strings_follow_p
;
7637 /* End of the game, except when overlay strings follow that
7638 haven't been returned yet. */
7639 if (it
->overlay_strings_at_end_processed_p
)
7640 overlay_strings_follow_p
= 0;
7643 it
->overlay_strings_at_end_processed_p
= 1;
7644 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7647 if (overlay_strings_follow_p
)
7648 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7652 it
->position
= it
->current
.pos
;
7656 else if (!(!it
->bidi_p
7657 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7658 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7660 /* With bidi non-linear iteration, we could find ourselves
7661 far beyond the last computed stop_charpos, with several
7662 other stop positions in between that we missed. Scan
7663 them all now, in buffer's logical order, until we find
7664 and handle the last stop_charpos that precedes our
7665 current position. */
7666 handle_stop_backwards (it
, it
->stop_charpos
);
7667 return GET_NEXT_DISPLAY_ELEMENT (it
);
7673 /* Take note of the stop position we just moved across,
7674 for when we will move back across it. */
7675 it
->prev_stop
= it
->stop_charpos
;
7676 /* If we are at base paragraph embedding level, take
7677 note of the last stop position seen at this
7679 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7680 it
->base_level_stop
= it
->stop_charpos
;
7683 return GET_NEXT_DISPLAY_ELEMENT (it
);
7687 /* If we are before prev_stop, we may have overstepped on
7688 our way backwards a stop_pos, and if so, we need to
7689 handle that stop_pos. */
7690 && IT_CHARPOS (*it
) < it
->prev_stop
7691 /* We can sometimes back up for reasons that have nothing
7692 to do with bidi reordering. E.g., compositions. The
7693 code below is only needed when we are above the base
7694 embedding level, so test for that explicitly. */
7695 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7697 if (it
->base_level_stop
<= 0
7698 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7700 /* If we lost track of base_level_stop, we need to find
7701 prev_stop by looking backwards. This happens, e.g., when
7702 we were reseated to the previous screenful of text by
7704 it
->base_level_stop
= BEGV
;
7705 compute_stop_pos_backwards (it
);
7706 handle_stop_backwards (it
, it
->prev_stop
);
7709 handle_stop_backwards (it
, it
->base_level_stop
);
7710 return GET_NEXT_DISPLAY_ELEMENT (it
);
7714 /* No face changes, overlays etc. in sight, so just return a
7715 character from current_buffer. */
7719 /* Maybe run the redisplay end trigger hook. Performance note:
7720 This doesn't seem to cost measurable time. */
7721 if (it
->redisplay_end_trigger_charpos
7723 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7724 run_redisplay_end_trigger_hook (it
);
7726 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7727 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7729 && next_element_from_composition (it
))
7734 /* Get the next character, maybe multibyte. */
7735 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7736 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7737 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7739 it
->c
= *p
, it
->len
= 1;
7741 /* Record what we have and where it came from. */
7742 it
->what
= IT_CHARACTER
;
7743 it
->object
= it
->w
->buffer
;
7744 it
->position
= it
->current
.pos
;
7746 /* Normally we return the character found above, except when we
7747 really want to return an ellipsis for selective display. */
7752 /* A value of selective > 0 means hide lines indented more
7753 than that number of columns. */
7754 if (it
->selective
> 0
7755 && IT_CHARPOS (*it
) + 1 < ZV
7756 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7757 IT_BYTEPOS (*it
) + 1,
7760 success_p
= next_element_from_ellipsis (it
);
7761 it
->dpvec_char_len
= -1;
7764 else if (it
->c
== '\r' && it
->selective
== -1)
7766 /* A value of selective == -1 means that everything from the
7767 CR to the end of the line is invisible, with maybe an
7768 ellipsis displayed for it. */
7769 success_p
= next_element_from_ellipsis (it
);
7770 it
->dpvec_char_len
= -1;
7775 /* Value is zero if end of buffer reached. */
7776 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7781 /* Run the redisplay end trigger hook for IT. */
7784 run_redisplay_end_trigger_hook (struct it
*it
)
7786 Lisp_Object args
[3];
7788 /* IT->glyph_row should be non-null, i.e. we should be actually
7789 displaying something, or otherwise we should not run the hook. */
7790 xassert (it
->glyph_row
);
7792 /* Set up hook arguments. */
7793 args
[0] = Qredisplay_end_trigger_functions
;
7794 args
[1] = it
->window
;
7795 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7796 it
->redisplay_end_trigger_charpos
= 0;
7798 /* Since we are *trying* to run these functions, don't try to run
7799 them again, even if they get an error. */
7800 it
->w
->redisplay_end_trigger
= Qnil
;
7801 Frun_hook_with_args (3, args
);
7803 /* Notice if it changed the face of the character we are on. */
7804 handle_face_prop (it
);
7808 /* Deliver a composition display element. Unlike the other
7809 next_element_from_XXX, this function is not registered in the array
7810 get_next_element[]. It is called from next_element_from_buffer and
7811 next_element_from_string when necessary. */
7814 next_element_from_composition (struct it
*it
)
7816 it
->what
= IT_COMPOSITION
;
7817 it
->len
= it
->cmp_it
.nbytes
;
7818 if (STRINGP (it
->string
))
7822 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7823 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7826 it
->position
= it
->current
.string_pos
;
7827 it
->object
= it
->string
;
7828 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7829 IT_STRING_BYTEPOS (*it
), it
->string
);
7835 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7836 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7839 if (it
->bidi_it
.new_paragraph
)
7840 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7841 /* Resync the bidi iterator with IT's new position.
7842 FIXME: this doesn't support bidirectional text. */
7843 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7844 bidi_move_to_visually_next (&it
->bidi_it
);
7848 it
->position
= it
->current
.pos
;
7849 it
->object
= it
->w
->buffer
;
7850 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7851 IT_BYTEPOS (*it
), Qnil
);
7858 /***********************************************************************
7859 Moving an iterator without producing glyphs
7860 ***********************************************************************/
7862 /* Check if iterator is at a position corresponding to a valid buffer
7863 position after some move_it_ call. */
7865 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7866 ((it)->method == GET_FROM_STRING \
7867 ? IT_STRING_CHARPOS (*it) == 0 \
7871 /* Move iterator IT to a specified buffer or X position within one
7872 line on the display without producing glyphs.
7874 OP should be a bit mask including some or all of these bits:
7875 MOVE_TO_X: Stop upon reaching x-position TO_X.
7876 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7877 Regardless of OP's value, stop upon reaching the end of the display line.
7879 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7880 This means, in particular, that TO_X includes window's horizontal
7883 The return value has several possible values that
7884 say what condition caused the scan to stop:
7886 MOVE_POS_MATCH_OR_ZV
7887 - when TO_POS or ZV was reached.
7890 -when TO_X was reached before TO_POS or ZV were reached.
7893 - when we reached the end of the display area and the line must
7897 - when we reached the end of the display area and the line is
7901 - when we stopped at a line end, i.e. a newline or a CR and selective
7904 static enum move_it_result
7905 move_it_in_display_line_to (struct it
*it
,
7906 EMACS_INT to_charpos
, int to_x
,
7907 enum move_operation_enum op
)
7909 enum move_it_result result
= MOVE_UNDEFINED
;
7910 struct glyph_row
*saved_glyph_row
;
7911 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7912 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7913 void *ppos_data
= NULL
;
7915 enum it_method prev_method
= it
->method
;
7916 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7917 int saw_smaller_pos
= prev_pos
< to_charpos
;
7919 /* Don't produce glyphs in produce_glyphs. */
7920 saved_glyph_row
= it
->glyph_row
;
7921 it
->glyph_row
= NULL
;
7923 /* Use wrap_it to save a copy of IT wherever a word wrap could
7924 occur. Use atpos_it to save a copy of IT at the desired buffer
7925 position, if found, so that we can scan ahead and check if the
7926 word later overshoots the window edge. Use atx_it similarly, for
7932 /* Use ppos_it under bidi reordering to save a copy of IT for the
7933 position > CHARPOS that is the closest to CHARPOS. We restore
7934 that position in IT when we have scanned the entire display line
7935 without finding a match for CHARPOS and all the character
7936 positions are greater than CHARPOS. */
7939 SAVE_IT (ppos_it
, *it
, ppos_data
);
7940 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7941 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7942 SAVE_IT (ppos_it
, *it
, ppos_data
);
7945 #define BUFFER_POS_REACHED_P() \
7946 ((op & MOVE_TO_POS) != 0 \
7947 && BUFFERP (it->object) \
7948 && (IT_CHARPOS (*it) == to_charpos \
7950 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7951 && IT_CHARPOS (*it) > to_charpos) \
7952 || (it->what == IT_COMPOSITION \
7953 && ((IT_CHARPOS (*it) > to_charpos \
7954 && to_charpos >= it->cmp_it.charpos) \
7955 || (IT_CHARPOS (*it) < to_charpos \
7956 && to_charpos <= it->cmp_it.charpos)))) \
7957 && (it->method == GET_FROM_BUFFER \
7958 || (it->method == GET_FROM_DISPLAY_VECTOR \
7959 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7961 /* If there's a line-/wrap-prefix, handle it. */
7962 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7963 && it
->current_y
< it
->last_visible_y
)
7964 handle_line_prefix (it
);
7966 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7967 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7971 int x
, i
, ascent
= 0, descent
= 0;
7973 /* Utility macro to reset an iterator with x, ascent, and descent. */
7974 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7975 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7976 (IT)->max_descent = descent)
7978 /* Stop if we move beyond TO_CHARPOS (after an image or a
7979 display string or stretch glyph). */
7980 if ((op
& MOVE_TO_POS
) != 0
7981 && BUFFERP (it
->object
)
7982 && it
->method
== GET_FROM_BUFFER
7984 /* When the iterator is at base embedding level, we
7985 are guaranteed that characters are delivered for
7986 display in strictly increasing order of their
7987 buffer positions. */
7988 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7989 && IT_CHARPOS (*it
) > to_charpos
)
7991 && (prev_method
== GET_FROM_IMAGE
7992 || prev_method
== GET_FROM_STRETCH
7993 || prev_method
== GET_FROM_STRING
)
7994 /* Passed TO_CHARPOS from left to right. */
7995 && ((prev_pos
< to_charpos
7996 && IT_CHARPOS (*it
) > to_charpos
)
7997 /* Passed TO_CHARPOS from right to left. */
7998 || (prev_pos
> to_charpos
7999 && IT_CHARPOS (*it
) < to_charpos
)))))
8001 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8003 result
= MOVE_POS_MATCH_OR_ZV
;
8006 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8007 /* If wrap_it is valid, the current position might be in a
8008 word that is wrapped. So, save the iterator in
8009 atpos_it and continue to see if wrapping happens. */
8010 SAVE_IT (atpos_it
, *it
, atpos_data
);
8013 /* Stop when ZV reached.
8014 We used to stop here when TO_CHARPOS reached as well, but that is
8015 too soon if this glyph does not fit on this line. So we handle it
8016 explicitly below. */
8017 if (!get_next_display_element (it
))
8019 result
= MOVE_POS_MATCH_OR_ZV
;
8023 if (it
->line_wrap
== TRUNCATE
)
8025 if (BUFFER_POS_REACHED_P ())
8027 result
= MOVE_POS_MATCH_OR_ZV
;
8033 if (it
->line_wrap
== WORD_WRAP
)
8035 if (IT_DISPLAYING_WHITESPACE (it
))
8039 /* We have reached a glyph that follows one or more
8040 whitespace characters. If the position is
8041 already found, we are done. */
8042 if (atpos_it
.sp
>= 0)
8044 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8045 result
= MOVE_POS_MATCH_OR_ZV
;
8050 RESTORE_IT (it
, &atx_it
, atx_data
);
8051 result
= MOVE_X_REACHED
;
8054 /* Otherwise, we can wrap here. */
8055 SAVE_IT (wrap_it
, *it
, wrap_data
);
8061 /* Remember the line height for the current line, in case
8062 the next element doesn't fit on the line. */
8063 ascent
= it
->max_ascent
;
8064 descent
= it
->max_descent
;
8066 /* The call to produce_glyphs will get the metrics of the
8067 display element IT is loaded with. Record the x-position
8068 before this display element, in case it doesn't fit on the
8072 PRODUCE_GLYPHS (it
);
8074 if (it
->area
!= TEXT_AREA
)
8076 prev_method
= it
->method
;
8077 if (it
->method
== GET_FROM_BUFFER
)
8078 prev_pos
= IT_CHARPOS (*it
);
8079 set_iterator_to_next (it
, 1);
8080 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8081 SET_TEXT_POS (this_line_min_pos
,
8082 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8084 && (op
& MOVE_TO_POS
)
8085 && IT_CHARPOS (*it
) > to_charpos
8086 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8087 SAVE_IT (ppos_it
, *it
, ppos_data
);
8091 /* The number of glyphs we get back in IT->nglyphs will normally
8092 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8093 character on a terminal frame, or (iii) a line end. For the
8094 second case, IT->nglyphs - 1 padding glyphs will be present.
8095 (On X frames, there is only one glyph produced for a
8096 composite character.)
8098 The behavior implemented below means, for continuation lines,
8099 that as many spaces of a TAB as fit on the current line are
8100 displayed there. For terminal frames, as many glyphs of a
8101 multi-glyph character are displayed in the current line, too.
8102 This is what the old redisplay code did, and we keep it that
8103 way. Under X, the whole shape of a complex character must
8104 fit on the line or it will be completely displayed in the
8107 Note that both for tabs and padding glyphs, all glyphs have
8111 /* More than one glyph or glyph doesn't fit on line. All
8112 glyphs have the same width. */
8113 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8115 int x_before_this_char
= x
;
8116 int hpos_before_this_char
= it
->hpos
;
8118 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8120 new_x
= x
+ single_glyph_width
;
8122 /* We want to leave anything reaching TO_X to the caller. */
8123 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8125 if (BUFFER_POS_REACHED_P ())
8127 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8128 goto buffer_pos_reached
;
8129 if (atpos_it
.sp
< 0)
8131 SAVE_IT (atpos_it
, *it
, atpos_data
);
8132 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8137 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8140 result
= MOVE_X_REACHED
;
8145 SAVE_IT (atx_it
, *it
, atx_data
);
8146 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8151 if (/* Lines are continued. */
8152 it
->line_wrap
!= TRUNCATE
8153 && (/* And glyph doesn't fit on the line. */
8154 new_x
> it
->last_visible_x
8155 /* Or it fits exactly and we're on a window
8157 || (new_x
== it
->last_visible_x
8158 && FRAME_WINDOW_P (it
->f
))))
8160 if (/* IT->hpos == 0 means the very first glyph
8161 doesn't fit on the line, e.g. a wide image. */
8163 || (new_x
== it
->last_visible_x
8164 && FRAME_WINDOW_P (it
->f
)))
8167 it
->current_x
= new_x
;
8169 /* The character's last glyph just barely fits
8171 if (i
== it
->nglyphs
- 1)
8173 /* If this is the destination position,
8174 return a position *before* it in this row,
8175 now that we know it fits in this row. */
8176 if (BUFFER_POS_REACHED_P ())
8178 if (it
->line_wrap
!= WORD_WRAP
8181 it
->hpos
= hpos_before_this_char
;
8182 it
->current_x
= x_before_this_char
;
8183 result
= MOVE_POS_MATCH_OR_ZV
;
8186 if (it
->line_wrap
== WORD_WRAP
8189 SAVE_IT (atpos_it
, *it
, atpos_data
);
8190 atpos_it
.current_x
= x_before_this_char
;
8191 atpos_it
.hpos
= hpos_before_this_char
;
8195 prev_method
= it
->method
;
8196 if (it
->method
== GET_FROM_BUFFER
)
8197 prev_pos
= IT_CHARPOS (*it
);
8198 set_iterator_to_next (it
, 1);
8199 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8200 SET_TEXT_POS (this_line_min_pos
,
8201 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8202 /* On graphical terminals, newlines may
8203 "overflow" into the fringe if
8204 overflow-newline-into-fringe is non-nil.
8205 On text-only terminals, newlines may
8206 overflow into the last glyph on the
8208 if (!FRAME_WINDOW_P (it
->f
)
8209 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8211 if (!get_next_display_element (it
))
8213 result
= MOVE_POS_MATCH_OR_ZV
;
8216 if (BUFFER_POS_REACHED_P ())
8218 if (ITERATOR_AT_END_OF_LINE_P (it
))
8219 result
= MOVE_POS_MATCH_OR_ZV
;
8221 result
= MOVE_LINE_CONTINUED
;
8224 if (ITERATOR_AT_END_OF_LINE_P (it
))
8226 result
= MOVE_NEWLINE_OR_CR
;
8233 IT_RESET_X_ASCENT_DESCENT (it
);
8235 if (wrap_it
.sp
>= 0)
8237 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8242 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8244 result
= MOVE_LINE_CONTINUED
;
8248 if (BUFFER_POS_REACHED_P ())
8250 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8251 goto buffer_pos_reached
;
8252 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8254 SAVE_IT (atpos_it
, *it
, atpos_data
);
8255 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8259 if (new_x
> it
->first_visible_x
)
8261 /* Glyph is visible. Increment number of glyphs that
8262 would be displayed. */
8267 if (result
!= MOVE_UNDEFINED
)
8270 else if (BUFFER_POS_REACHED_P ())
8273 IT_RESET_X_ASCENT_DESCENT (it
);
8274 result
= MOVE_POS_MATCH_OR_ZV
;
8277 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8279 /* Stop when TO_X specified and reached. This check is
8280 necessary here because of lines consisting of a line end,
8281 only. The line end will not produce any glyphs and we
8282 would never get MOVE_X_REACHED. */
8283 xassert (it
->nglyphs
== 0);
8284 result
= MOVE_X_REACHED
;
8288 /* Is this a line end? If yes, we're done. */
8289 if (ITERATOR_AT_END_OF_LINE_P (it
))
8291 /* If we are past TO_CHARPOS, but never saw any character
8292 positions smaller than TO_CHARPOS, return
8293 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8295 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8297 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8299 if (IT_CHARPOS (ppos_it
) < ZV
)
8301 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8302 result
= MOVE_POS_MATCH_OR_ZV
;
8305 goto buffer_pos_reached
;
8307 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8308 && IT_CHARPOS (*it
) > to_charpos
)
8309 goto buffer_pos_reached
;
8311 result
= MOVE_NEWLINE_OR_CR
;
8314 result
= MOVE_NEWLINE_OR_CR
;
8318 prev_method
= it
->method
;
8319 if (it
->method
== GET_FROM_BUFFER
)
8320 prev_pos
= IT_CHARPOS (*it
);
8321 /* The current display element has been consumed. Advance
8323 set_iterator_to_next (it
, 1);
8324 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8325 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8326 if (IT_CHARPOS (*it
) < to_charpos
)
8327 saw_smaller_pos
= 1;
8329 && (op
& MOVE_TO_POS
)
8330 && IT_CHARPOS (*it
) >= to_charpos
8331 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8332 SAVE_IT (ppos_it
, *it
, ppos_data
);
8334 /* Stop if lines are truncated and IT's current x-position is
8335 past the right edge of the window now. */
8336 if (it
->line_wrap
== TRUNCATE
8337 && it
->current_x
>= it
->last_visible_x
)
8339 if (!FRAME_WINDOW_P (it
->f
)
8340 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8344 if ((at_eob_p
= !get_next_display_element (it
))
8345 || BUFFER_POS_REACHED_P ()
8346 /* If we are past TO_CHARPOS, but never saw any
8347 character positions smaller than TO_CHARPOS,
8348 return MOVE_POS_MATCH_OR_ZV, like the
8349 unidirectional display did. */
8350 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8352 && IT_CHARPOS (*it
) > to_charpos
))
8355 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8356 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8357 result
= MOVE_POS_MATCH_OR_ZV
;
8360 if (ITERATOR_AT_END_OF_LINE_P (it
))
8362 result
= MOVE_NEWLINE_OR_CR
;
8366 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8368 && IT_CHARPOS (*it
) > to_charpos
)
8370 if (IT_CHARPOS (ppos_it
) < ZV
)
8371 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8372 result
= MOVE_POS_MATCH_OR_ZV
;
8375 result
= MOVE_LINE_TRUNCATED
;
8378 #undef IT_RESET_X_ASCENT_DESCENT
8381 #undef BUFFER_POS_REACHED_P
8383 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8384 restore the saved iterator. */
8385 if (atpos_it
.sp
>= 0)
8386 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8387 else if (atx_it
.sp
>= 0)
8388 RESTORE_IT (it
, &atx_it
, atx_data
);
8393 bidi_unshelve_cache (atpos_data
, 1);
8395 bidi_unshelve_cache (atx_data
, 1);
8397 bidi_unshelve_cache (wrap_data
, 1);
8399 bidi_unshelve_cache (ppos_data
, 1);
8401 /* Restore the iterator settings altered at the beginning of this
8403 it
->glyph_row
= saved_glyph_row
;
8407 /* For external use. */
8409 move_it_in_display_line (struct it
*it
,
8410 EMACS_INT to_charpos
, int to_x
,
8411 enum move_operation_enum op
)
8413 if (it
->line_wrap
== WORD_WRAP
8414 && (op
& MOVE_TO_X
))
8417 void *save_data
= NULL
;
8420 SAVE_IT (save_it
, *it
, save_data
);
8421 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8422 /* When word-wrap is on, TO_X may lie past the end
8423 of a wrapped line. Then it->current is the
8424 character on the next line, so backtrack to the
8425 space before the wrap point. */
8426 if (skip
== MOVE_LINE_CONTINUED
)
8428 int prev_x
= max (it
->current_x
- 1, 0);
8429 RESTORE_IT (it
, &save_it
, save_data
);
8430 move_it_in_display_line_to
8431 (it
, -1, prev_x
, MOVE_TO_X
);
8434 bidi_unshelve_cache (save_data
, 1);
8437 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8441 /* Move IT forward until it satisfies one or more of the criteria in
8442 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8444 OP is a bit-mask that specifies where to stop, and in particular,
8445 which of those four position arguments makes a difference. See the
8446 description of enum move_operation_enum.
8448 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8449 screen line, this function will set IT to the next position that is
8450 displayed to the right of TO_CHARPOS on the screen. */
8453 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8455 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8456 int line_height
, line_start_x
= 0, reached
= 0;
8457 void *backup_data
= NULL
;
8461 if (op
& MOVE_TO_VPOS
)
8463 /* If no TO_CHARPOS and no TO_X specified, stop at the
8464 start of the line TO_VPOS. */
8465 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8467 if (it
->vpos
== to_vpos
)
8473 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8477 /* TO_VPOS >= 0 means stop at TO_X in the line at
8478 TO_VPOS, or at TO_POS, whichever comes first. */
8479 if (it
->vpos
== to_vpos
)
8485 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8487 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8492 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8494 /* We have reached TO_X but not in the line we want. */
8495 skip
= move_it_in_display_line_to (it
, to_charpos
,
8497 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8505 else if (op
& MOVE_TO_Y
)
8507 struct it it_backup
;
8509 if (it
->line_wrap
== WORD_WRAP
)
8510 SAVE_IT (it_backup
, *it
, backup_data
);
8512 /* TO_Y specified means stop at TO_X in the line containing
8513 TO_Y---or at TO_CHARPOS if this is reached first. The
8514 problem is that we can't really tell whether the line
8515 contains TO_Y before we have completely scanned it, and
8516 this may skip past TO_X. What we do is to first scan to
8519 If TO_X is not specified, use a TO_X of zero. The reason
8520 is to make the outcome of this function more predictable.
8521 If we didn't use TO_X == 0, we would stop at the end of
8522 the line which is probably not what a caller would expect
8524 skip
= move_it_in_display_line_to
8525 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8526 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8528 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8529 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8531 else if (skip
== MOVE_X_REACHED
)
8533 /* If TO_X was reached, we want to know whether TO_Y is
8534 in the line. We know this is the case if the already
8535 scanned glyphs make the line tall enough. Otherwise,
8536 we must check by scanning the rest of the line. */
8537 line_height
= it
->max_ascent
+ it
->max_descent
;
8538 if (to_y
>= it
->current_y
8539 && to_y
< it
->current_y
+ line_height
)
8544 SAVE_IT (it_backup
, *it
, backup_data
);
8545 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8546 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8548 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8549 line_height
= it
->max_ascent
+ it
->max_descent
;
8550 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8552 if (to_y
>= it
->current_y
8553 && to_y
< it
->current_y
+ line_height
)
8555 /* If TO_Y is in this line and TO_X was reached
8556 above, we scanned too far. We have to restore
8557 IT's settings to the ones before skipping. */
8558 RESTORE_IT (it
, &it_backup
, backup_data
);
8564 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8570 /* Check whether TO_Y is in this line. */
8571 line_height
= it
->max_ascent
+ it
->max_descent
;
8572 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8574 if (to_y
>= it
->current_y
8575 && to_y
< it
->current_y
+ line_height
)
8577 /* When word-wrap is on, TO_X may lie past the end
8578 of a wrapped line. Then it->current is the
8579 character on the next line, so backtrack to the
8580 space before the wrap point. */
8581 if (skip
== MOVE_LINE_CONTINUED
8582 && it
->line_wrap
== WORD_WRAP
)
8584 int prev_x
= max (it
->current_x
- 1, 0);
8585 RESTORE_IT (it
, &it_backup
, backup_data
);
8586 skip
= move_it_in_display_line_to
8587 (it
, -1, prev_x
, MOVE_TO_X
);
8596 else if (BUFFERP (it
->object
)
8597 && (it
->method
== GET_FROM_BUFFER
8598 || it
->method
== GET_FROM_STRETCH
)
8599 && IT_CHARPOS (*it
) >= to_charpos
8600 /* Under bidi iteration, a call to set_iterator_to_next
8601 can scan far beyond to_charpos if the initial
8602 portion of the next line needs to be reordered. In
8603 that case, give move_it_in_display_line_to another
8606 && it
->bidi_it
.scan_dir
== -1))
8607 skip
= MOVE_POS_MATCH_OR_ZV
;
8609 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8613 case MOVE_POS_MATCH_OR_ZV
:
8617 case MOVE_NEWLINE_OR_CR
:
8618 set_iterator_to_next (it
, 1);
8619 it
->continuation_lines_width
= 0;
8622 case MOVE_LINE_TRUNCATED
:
8623 it
->continuation_lines_width
= 0;
8624 reseat_at_next_visible_line_start (it
, 0);
8625 if ((op
& MOVE_TO_POS
) != 0
8626 && IT_CHARPOS (*it
) > to_charpos
)
8633 case MOVE_LINE_CONTINUED
:
8634 /* For continued lines ending in a tab, some of the glyphs
8635 associated with the tab are displayed on the current
8636 line. Since it->current_x does not include these glyphs,
8637 we use it->last_visible_x instead. */
8640 it
->continuation_lines_width
+= it
->last_visible_x
;
8641 /* When moving by vpos, ensure that the iterator really
8642 advances to the next line (bug#847, bug#969). Fixme:
8643 do we need to do this in other circumstances? */
8644 if (it
->current_x
!= it
->last_visible_x
8645 && (op
& MOVE_TO_VPOS
)
8646 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8648 line_start_x
= it
->current_x
+ it
->pixel_width
8649 - it
->last_visible_x
;
8650 set_iterator_to_next (it
, 0);
8654 it
->continuation_lines_width
+= it
->current_x
;
8661 /* Reset/increment for the next run. */
8662 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8663 it
->current_x
= line_start_x
;
8666 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8668 last_height
= it
->max_ascent
+ it
->max_descent
;
8669 last_max_ascent
= it
->max_ascent
;
8670 it
->max_ascent
= it
->max_descent
= 0;
8675 /* On text terminals, we may stop at the end of a line in the middle
8676 of a multi-character glyph. If the glyph itself is continued,
8677 i.e. it is actually displayed on the next line, don't treat this
8678 stopping point as valid; move to the next line instead (unless
8679 that brings us offscreen). */
8680 if (!FRAME_WINDOW_P (it
->f
)
8682 && IT_CHARPOS (*it
) == to_charpos
8683 && it
->what
== IT_CHARACTER
8685 && it
->line_wrap
== WINDOW_WRAP
8686 && it
->current_x
== it
->last_visible_x
- 1
8689 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8691 it
->continuation_lines_width
+= it
->current_x
;
8692 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8693 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8695 last_height
= it
->max_ascent
+ it
->max_descent
;
8696 last_max_ascent
= it
->max_ascent
;
8700 bidi_unshelve_cache (backup_data
, 1);
8702 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8706 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8708 If DY > 0, move IT backward at least that many pixels. DY = 0
8709 means move IT backward to the preceding line start or BEGV. This
8710 function may move over more than DY pixels if IT->current_y - DY
8711 ends up in the middle of a line; in this case IT->current_y will be
8712 set to the top of the line moved to. */
8715 move_it_vertically_backward (struct it
*it
, int dy
)
8719 void *it2data
= NULL
, *it3data
= NULL
;
8720 EMACS_INT start_pos
;
8725 start_pos
= IT_CHARPOS (*it
);
8727 /* Estimate how many newlines we must move back. */
8728 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8730 /* Set the iterator's position that many lines back. */
8731 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8732 back_to_previous_visible_line_start (it
);
8734 /* Reseat the iterator here. When moving backward, we don't want
8735 reseat to skip forward over invisible text, set up the iterator
8736 to deliver from overlay strings at the new position etc. So,
8737 use reseat_1 here. */
8738 reseat_1 (it
, it
->current
.pos
, 1);
8740 /* We are now surely at a line start. */
8741 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8742 reordering is in effect. */
8743 it
->continuation_lines_width
= 0;
8745 /* Move forward and see what y-distance we moved. First move to the
8746 start of the next line so that we get its height. We need this
8747 height to be able to tell whether we reached the specified
8749 SAVE_IT (it2
, *it
, it2data
);
8750 it2
.max_ascent
= it2
.max_descent
= 0;
8753 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8754 MOVE_TO_POS
| MOVE_TO_VPOS
);
8756 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8757 /* If we are in a display string which starts at START_POS,
8758 and that display string includes a newline, and we are
8759 right after that newline (i.e. at the beginning of a
8760 display line), exit the loop, because otherwise we will
8761 infloop, since move_it_to will see that it is already at
8762 START_POS and will not move. */
8763 || (it2
.method
== GET_FROM_STRING
8764 && IT_CHARPOS (it2
) == start_pos
8765 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8766 xassert (IT_CHARPOS (*it
) >= BEGV
);
8767 SAVE_IT (it3
, it2
, it3data
);
8769 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8770 xassert (IT_CHARPOS (*it
) >= BEGV
);
8771 /* H is the actual vertical distance from the position in *IT
8772 and the starting position. */
8773 h
= it2
.current_y
- it
->current_y
;
8774 /* NLINES is the distance in number of lines. */
8775 nlines
= it2
.vpos
- it
->vpos
;
8777 /* Correct IT's y and vpos position
8778 so that they are relative to the starting point. */
8784 /* DY == 0 means move to the start of the screen line. The
8785 value of nlines is > 0 if continuation lines were involved,
8786 or if the original IT position was at start of a line. */
8787 RESTORE_IT (it
, it
, it2data
);
8789 move_it_by_lines (it
, nlines
);
8790 /* The above code moves us to some position NLINES down,
8791 usually to its first glyph (leftmost in an L2R line), but
8792 that's not necessarily the start of the line, under bidi
8793 reordering. We want to get to the character position
8794 that is immediately after the newline of the previous
8797 && !it
->continuation_lines_width
8798 && !STRINGP (it
->string
)
8799 && IT_CHARPOS (*it
) > BEGV
8800 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8803 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8805 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8807 bidi_unshelve_cache (it3data
, 1);
8811 /* The y-position we try to reach, relative to *IT.
8812 Note that H has been subtracted in front of the if-statement. */
8813 int target_y
= it
->current_y
+ h
- dy
;
8814 int y0
= it3
.current_y
;
8818 RESTORE_IT (&it3
, &it3
, it3data
);
8819 y1
= line_bottom_y (&it3
);
8820 line_height
= y1
- y0
;
8821 RESTORE_IT (it
, it
, it2data
);
8822 /* If we did not reach target_y, try to move further backward if
8823 we can. If we moved too far backward, try to move forward. */
8824 if (target_y
< it
->current_y
8825 /* This is heuristic. In a window that's 3 lines high, with
8826 a line height of 13 pixels each, recentering with point
8827 on the bottom line will try to move -39/2 = 19 pixels
8828 backward. Try to avoid moving into the first line. */
8829 && (it
->current_y
- target_y
8830 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8831 && IT_CHARPOS (*it
) > BEGV
)
8833 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8834 target_y
- it
->current_y
));
8835 dy
= it
->current_y
- target_y
;
8836 goto move_further_back
;
8838 else if (target_y
>= it
->current_y
+ line_height
8839 && IT_CHARPOS (*it
) < ZV
)
8841 /* Should move forward by at least one line, maybe more.
8843 Note: Calling move_it_by_lines can be expensive on
8844 terminal frames, where compute_motion is used (via
8845 vmotion) to do the job, when there are very long lines
8846 and truncate-lines is nil. That's the reason for
8847 treating terminal frames specially here. */
8849 if (!FRAME_WINDOW_P (it
->f
))
8850 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8855 move_it_by_lines (it
, 1);
8857 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8864 /* Move IT by a specified amount of pixel lines DY. DY negative means
8865 move backwards. DY = 0 means move to start of screen line. At the
8866 end, IT will be on the start of a screen line. */
8869 move_it_vertically (struct it
*it
, int dy
)
8872 move_it_vertically_backward (it
, -dy
);
8875 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8876 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8877 MOVE_TO_POS
| MOVE_TO_Y
);
8878 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8880 /* If buffer ends in ZV without a newline, move to the start of
8881 the line to satisfy the post-condition. */
8882 if (IT_CHARPOS (*it
) == ZV
8884 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8885 move_it_by_lines (it
, 0);
8890 /* Move iterator IT past the end of the text line it is in. */
8893 move_it_past_eol (struct it
*it
)
8895 enum move_it_result rc
;
8897 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8898 if (rc
== MOVE_NEWLINE_OR_CR
)
8899 set_iterator_to_next (it
, 0);
8903 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8904 negative means move up. DVPOS == 0 means move to the start of the
8907 Optimization idea: If we would know that IT->f doesn't use
8908 a face with proportional font, we could be faster for
8909 truncate-lines nil. */
8912 move_it_by_lines (struct it
*it
, int dvpos
)
8915 /* The commented-out optimization uses vmotion on terminals. This
8916 gives bad results, because elements like it->what, on which
8917 callers such as pos_visible_p rely, aren't updated. */
8918 /* struct position pos;
8919 if (!FRAME_WINDOW_P (it->f))
8921 struct text_pos textpos;
8923 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8924 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8925 reseat (it, textpos, 1);
8926 it->vpos += pos.vpos;
8927 it->current_y += pos.vpos;
8933 /* DVPOS == 0 means move to the start of the screen line. */
8934 move_it_vertically_backward (it
, 0);
8935 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8936 /* Let next call to line_bottom_y calculate real line height */
8941 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8942 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8943 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8948 void *it2data
= NULL
;
8949 EMACS_INT start_charpos
, i
;
8951 /* Start at the beginning of the screen line containing IT's
8952 position. This may actually move vertically backwards,
8953 in case of overlays, so adjust dvpos accordingly. */
8955 move_it_vertically_backward (it
, 0);
8958 /* Go back -DVPOS visible lines and reseat the iterator there. */
8959 start_charpos
= IT_CHARPOS (*it
);
8960 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8961 back_to_previous_visible_line_start (it
);
8962 reseat (it
, it
->current
.pos
, 1);
8964 /* Move further back if we end up in a string or an image. */
8965 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8967 /* First try to move to start of display line. */
8969 move_it_vertically_backward (it
, 0);
8971 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8973 /* If start of line is still in string or image,
8974 move further back. */
8975 back_to_previous_visible_line_start (it
);
8976 reseat (it
, it
->current
.pos
, 1);
8980 it
->current_x
= it
->hpos
= 0;
8982 /* Above call may have moved too far if continuation lines
8983 are involved. Scan forward and see if it did. */
8984 SAVE_IT (it2
, *it
, it2data
);
8985 it2
.vpos
= it2
.current_y
= 0;
8986 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8987 it
->vpos
-= it2
.vpos
;
8988 it
->current_y
-= it2
.current_y
;
8989 it
->current_x
= it
->hpos
= 0;
8991 /* If we moved too far back, move IT some lines forward. */
8992 if (it2
.vpos
> -dvpos
)
8994 int delta
= it2
.vpos
+ dvpos
;
8996 RESTORE_IT (&it2
, &it2
, it2data
);
8997 SAVE_IT (it2
, *it
, it2data
);
8998 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8999 /* Move back again if we got too far ahead. */
9000 if (IT_CHARPOS (*it
) >= start_charpos
)
9001 RESTORE_IT (it
, &it2
, it2data
);
9003 bidi_unshelve_cache (it2data
, 1);
9006 RESTORE_IT (it
, it
, it2data
);
9010 /* Return 1 if IT points into the middle of a display vector. */
9013 in_display_vector_p (struct it
*it
)
9015 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9016 && it
->current
.dpvec_index
> 0
9017 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9021 /***********************************************************************
9023 ***********************************************************************/
9026 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9030 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9032 Lisp_Object args
[3];
9033 Lisp_Object msg
, fmt
;
9036 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9039 /* Do nothing if called asynchronously. Inserting text into
9040 a buffer may call after-change-functions and alike and
9041 that would means running Lisp asynchronously. */
9042 if (handling_signal
)
9046 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9048 args
[0] = fmt
= build_string (format
);
9051 msg
= Fformat (3, args
);
9053 len
= SBYTES (msg
) + 1;
9054 SAFE_ALLOCA (buffer
, char *, len
);
9055 memcpy (buffer
, SDATA (msg
), len
);
9057 message_dolog (buffer
, len
- 1, 1, 0);
9064 /* Output a newline in the *Messages* buffer if "needs" one. */
9067 message_log_maybe_newline (void)
9069 if (message_log_need_newline
)
9070 message_dolog ("", 0, 1, 0);
9074 /* Add a string M of length NBYTES to the message log, optionally
9075 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9076 nonzero, means interpret the contents of M as multibyte. This
9077 function calls low-level routines in order to bypass text property
9078 hooks, etc. which might not be safe to run.
9080 This may GC (insert may run before/after change hooks),
9081 so the buffer M must NOT point to a Lisp string. */
9084 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9086 const unsigned char *msg
= (const unsigned char *) m
;
9088 if (!NILP (Vmemory_full
))
9091 if (!NILP (Vmessage_log_max
))
9093 struct buffer
*oldbuf
;
9094 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9095 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9096 EMACS_INT point_at_end
= 0;
9097 EMACS_INT zv_at_end
= 0;
9098 Lisp_Object old_deactivate_mark
, tem
;
9099 struct gcpro gcpro1
;
9101 old_deactivate_mark
= Vdeactivate_mark
;
9102 oldbuf
= current_buffer
;
9103 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9104 BVAR (current_buffer
, undo_list
) = Qt
;
9106 oldpoint
= message_dolog_marker1
;
9107 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9108 oldbegv
= message_dolog_marker2
;
9109 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9110 oldzv
= message_dolog_marker3
;
9111 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9112 GCPRO1 (old_deactivate_mark
);
9120 BEGV_BYTE
= BEG_BYTE
;
9123 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9125 /* Insert the string--maybe converting multibyte to single byte
9126 or vice versa, so that all the text fits the buffer. */
9128 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9134 /* Convert a multibyte string to single-byte
9135 for the *Message* buffer. */
9136 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9138 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9139 work
[0] = (ASCII_CHAR_P (c
)
9141 : multibyte_char_to_unibyte (c
));
9142 insert_1_both (work
, 1, 1, 1, 0, 0);
9145 else if (! multibyte
9146 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9150 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9151 /* Convert a single-byte string to multibyte
9152 for the *Message* buffer. */
9153 for (i
= 0; i
< nbytes
; i
++)
9156 MAKE_CHAR_MULTIBYTE (c
);
9157 char_bytes
= CHAR_STRING (c
, str
);
9158 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9162 insert_1 (m
, nbytes
, 1, 0, 0);
9166 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9168 insert_1 ("\n", 1, 1, 0, 0);
9170 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9172 this_bol_byte
= PT_BYTE
;
9174 /* See if this line duplicates the previous one.
9175 If so, combine duplicates. */
9178 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9180 prev_bol_byte
= PT_BYTE
;
9182 dups
= message_log_check_duplicate (prev_bol_byte
,
9186 del_range_both (prev_bol
, prev_bol_byte
,
9187 this_bol
, this_bol_byte
, 0);
9190 char dupstr
[sizeof " [ times]"
9191 + INT_STRLEN_BOUND (printmax_t
)];
9194 /* If you change this format, don't forget to also
9195 change message_log_check_duplicate. */
9196 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9197 duplen
= strlen (dupstr
);
9198 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9199 insert_1 (dupstr
, duplen
, 1, 0, 1);
9204 /* If we have more than the desired maximum number of lines
9205 in the *Messages* buffer now, delete the oldest ones.
9206 This is safe because we don't have undo in this buffer. */
9208 if (NATNUMP (Vmessage_log_max
))
9210 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9211 -XFASTINT (Vmessage_log_max
) - 1, 0);
9212 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9215 BEGV
= XMARKER (oldbegv
)->charpos
;
9216 BEGV_BYTE
= marker_byte_position (oldbegv
);
9225 ZV
= XMARKER (oldzv
)->charpos
;
9226 ZV_BYTE
= marker_byte_position (oldzv
);
9230 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9232 /* We can't do Fgoto_char (oldpoint) because it will run some
9234 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9235 XMARKER (oldpoint
)->bytepos
);
9238 unchain_marker (XMARKER (oldpoint
));
9239 unchain_marker (XMARKER (oldbegv
));
9240 unchain_marker (XMARKER (oldzv
));
9242 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9243 set_buffer_internal (oldbuf
);
9245 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9246 message_log_need_newline
= !nlflag
;
9247 Vdeactivate_mark
= old_deactivate_mark
;
9252 /* We are at the end of the buffer after just having inserted a newline.
9253 (Note: We depend on the fact we won't be crossing the gap.)
9254 Check to see if the most recent message looks a lot like the previous one.
9255 Return 0 if different, 1 if the new one should just replace it, or a
9256 value N > 1 if we should also append " [N times]". */
9259 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9262 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9264 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9265 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9267 for (i
= 0; i
< len
; i
++)
9269 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9277 if (*p1
++ == ' ' && *p1
++ == '[')
9280 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9281 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9288 /* Display an echo area message M with a specified length of NBYTES
9289 bytes. The string may include null characters. If M is 0, clear
9290 out any existing message, and let the mini-buffer text show
9293 This may GC, so the buffer M must NOT point to a Lisp string. */
9296 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9298 /* First flush out any partial line written with print. */
9299 message_log_maybe_newline ();
9301 message_dolog (m
, nbytes
, 1, multibyte
);
9302 message2_nolog (m
, nbytes
, multibyte
);
9306 /* The non-logging counterpart of message2. */
9309 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9311 struct frame
*sf
= SELECTED_FRAME ();
9312 message_enable_multibyte
= multibyte
;
9314 if (FRAME_INITIAL_P (sf
))
9316 if (noninteractive_need_newline
)
9317 putc ('\n', stderr
);
9318 noninteractive_need_newline
= 0;
9320 fwrite (m
, nbytes
, 1, stderr
);
9321 if (cursor_in_echo_area
== 0)
9322 fprintf (stderr
, "\n");
9325 /* A null message buffer means that the frame hasn't really been
9326 initialized yet. Error messages get reported properly by
9327 cmd_error, so this must be just an informative message; toss it. */
9328 else if (INTERACTIVE
9329 && sf
->glyphs_initialized_p
9330 && FRAME_MESSAGE_BUF (sf
))
9332 Lisp_Object mini_window
;
9335 /* Get the frame containing the mini-buffer
9336 that the selected frame is using. */
9337 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9338 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9340 FRAME_SAMPLE_VISIBILITY (f
);
9341 if (FRAME_VISIBLE_P (sf
)
9342 && ! FRAME_VISIBLE_P (f
))
9343 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9347 set_message (m
, Qnil
, nbytes
, multibyte
);
9348 if (minibuffer_auto_raise
)
9349 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9352 clear_message (1, 1);
9354 do_pending_window_change (0);
9355 echo_area_display (1);
9356 do_pending_window_change (0);
9357 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9358 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9363 /* Display an echo area message M with a specified length of NBYTES
9364 bytes. The string may include null characters. If M is not a
9365 string, clear out any existing message, and let the mini-buffer
9368 This function cancels echoing. */
9371 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9373 struct gcpro gcpro1
;
9376 clear_message (1,1);
9379 /* First flush out any partial line written with print. */
9380 message_log_maybe_newline ();
9386 SAFE_ALLOCA (buffer
, char *, nbytes
);
9387 memcpy (buffer
, SDATA (m
), nbytes
);
9388 message_dolog (buffer
, nbytes
, 1, multibyte
);
9391 message3_nolog (m
, nbytes
, multibyte
);
9397 /* The non-logging version of message3.
9398 This does not cancel echoing, because it is used for echoing.
9399 Perhaps we need to make a separate function for echoing
9400 and make this cancel echoing. */
9403 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9405 struct frame
*sf
= SELECTED_FRAME ();
9406 message_enable_multibyte
= multibyte
;
9408 if (FRAME_INITIAL_P (sf
))
9410 if (noninteractive_need_newline
)
9411 putc ('\n', stderr
);
9412 noninteractive_need_newline
= 0;
9414 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9415 if (cursor_in_echo_area
== 0)
9416 fprintf (stderr
, "\n");
9419 /* A null message buffer means that the frame hasn't really been
9420 initialized yet. Error messages get reported properly by
9421 cmd_error, so this must be just an informative message; toss it. */
9422 else if (INTERACTIVE
9423 && sf
->glyphs_initialized_p
9424 && FRAME_MESSAGE_BUF (sf
))
9426 Lisp_Object mini_window
;
9430 /* Get the frame containing the mini-buffer
9431 that the selected frame is using. */
9432 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9433 frame
= XWINDOW (mini_window
)->frame
;
9436 FRAME_SAMPLE_VISIBILITY (f
);
9437 if (FRAME_VISIBLE_P (sf
)
9438 && !FRAME_VISIBLE_P (f
))
9439 Fmake_frame_visible (frame
);
9441 if (STRINGP (m
) && SCHARS (m
) > 0)
9443 set_message (NULL
, m
, nbytes
, multibyte
);
9444 if (minibuffer_auto_raise
)
9445 Fraise_frame (frame
);
9446 /* Assume we are not echoing.
9447 (If we are, echo_now will override this.) */
9448 echo_message_buffer
= Qnil
;
9451 clear_message (1, 1);
9453 do_pending_window_change (0);
9454 echo_area_display (1);
9455 do_pending_window_change (0);
9456 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9457 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9462 /* Display a null-terminated echo area message M. If M is 0, clear
9463 out any existing message, and let the mini-buffer text show through.
9465 The buffer M must continue to exist until after the echo area gets
9466 cleared or some other message gets displayed there. Do not pass
9467 text that is stored in a Lisp string. Do not pass text in a buffer
9468 that was alloca'd. */
9471 message1 (const char *m
)
9473 message2 (m
, (m
? strlen (m
) : 0), 0);
9477 /* The non-logging counterpart of message1. */
9480 message1_nolog (const char *m
)
9482 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9485 /* Display a message M which contains a single %s
9486 which gets replaced with STRING. */
9489 message_with_string (const char *m
, Lisp_Object string
, int log
)
9491 CHECK_STRING (string
);
9497 if (noninteractive_need_newline
)
9498 putc ('\n', stderr
);
9499 noninteractive_need_newline
= 0;
9500 fprintf (stderr
, m
, SDATA (string
));
9501 if (!cursor_in_echo_area
)
9502 fprintf (stderr
, "\n");
9506 else if (INTERACTIVE
)
9508 /* The frame whose minibuffer we're going to display the message on.
9509 It may be larger than the selected frame, so we need
9510 to use its buffer, not the selected frame's buffer. */
9511 Lisp_Object mini_window
;
9512 struct frame
*f
, *sf
= SELECTED_FRAME ();
9514 /* Get the frame containing the minibuffer
9515 that the selected frame is using. */
9516 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9517 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9519 /* A null message buffer means that the frame hasn't really been
9520 initialized yet. Error messages get reported properly by
9521 cmd_error, so this must be just an informative message; toss it. */
9522 if (FRAME_MESSAGE_BUF (f
))
9524 Lisp_Object args
[2], msg
;
9525 struct gcpro gcpro1
, gcpro2
;
9527 args
[0] = build_string (m
);
9528 args
[1] = msg
= string
;
9529 GCPRO2 (args
[0], msg
);
9532 msg
= Fformat (2, args
);
9535 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9537 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9541 /* Print should start at the beginning of the message
9542 buffer next time. */
9543 message_buf_print
= 0;
9549 /* Dump an informative message to the minibuf. If M is 0, clear out
9550 any existing message, and let the mini-buffer text show through. */
9553 vmessage (const char *m
, va_list ap
)
9559 if (noninteractive_need_newline
)
9560 putc ('\n', stderr
);
9561 noninteractive_need_newline
= 0;
9562 vfprintf (stderr
, m
, ap
);
9563 if (cursor_in_echo_area
== 0)
9564 fprintf (stderr
, "\n");
9568 else if (INTERACTIVE
)
9570 /* The frame whose mini-buffer we're going to display the message
9571 on. It may be larger than the selected frame, so we need to
9572 use its buffer, not the selected frame's buffer. */
9573 Lisp_Object mini_window
;
9574 struct frame
*f
, *sf
= SELECTED_FRAME ();
9576 /* Get the frame containing the mini-buffer
9577 that the selected frame is using. */
9578 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9579 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9581 /* A null message buffer means that the frame hasn't really been
9582 initialized yet. Error messages get reported properly by
9583 cmd_error, so this must be just an informative message; toss
9585 if (FRAME_MESSAGE_BUF (f
))
9591 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9592 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9594 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9599 /* Print should start at the beginning of the message
9600 buffer next time. */
9601 message_buf_print
= 0;
9607 message (const char *m
, ...)
9617 /* The non-logging version of message. */
9620 message_nolog (const char *m
, ...)
9622 Lisp_Object old_log_max
;
9625 old_log_max
= Vmessage_log_max
;
9626 Vmessage_log_max
= Qnil
;
9628 Vmessage_log_max
= old_log_max
;
9634 /* Display the current message in the current mini-buffer. This is
9635 only called from error handlers in process.c, and is not time
9639 update_echo_area (void)
9641 if (!NILP (echo_area_buffer
[0]))
9644 string
= Fcurrent_message ();
9645 message3 (string
, SBYTES (string
),
9646 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9651 /* Make sure echo area buffers in `echo_buffers' are live.
9652 If they aren't, make new ones. */
9655 ensure_echo_area_buffers (void)
9659 for (i
= 0; i
< 2; ++i
)
9660 if (!BUFFERP (echo_buffer
[i
])
9661 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9664 Lisp_Object old_buffer
;
9667 old_buffer
= echo_buffer
[i
];
9668 sprintf (name
, " *Echo Area %d*", i
);
9669 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9670 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9671 /* to force word wrap in echo area -
9672 it was decided to postpone this*/
9673 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9675 for (j
= 0; j
< 2; ++j
)
9676 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9677 echo_area_buffer
[j
] = echo_buffer
[i
];
9682 /* Call FN with args A1..A4 with either the current or last displayed
9683 echo_area_buffer as current buffer.
9685 WHICH zero means use the current message buffer
9686 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9687 from echo_buffer[] and clear it.
9689 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9690 suitable buffer from echo_buffer[] and clear it.
9692 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9693 that the current message becomes the last displayed one, make
9694 choose a suitable buffer for echo_area_buffer[0], and clear it.
9696 Value is what FN returns. */
9699 with_echo_area_buffer (struct window
*w
, int which
,
9700 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9701 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9704 int this_one
, the_other
, clear_buffer_p
, rc
;
9705 int count
= SPECPDL_INDEX ();
9707 /* If buffers aren't live, make new ones. */
9708 ensure_echo_area_buffers ();
9713 this_one
= 0, the_other
= 1;
9715 this_one
= 1, the_other
= 0;
9718 this_one
= 0, the_other
= 1;
9721 /* We need a fresh one in case the current echo buffer equals
9722 the one containing the last displayed echo area message. */
9723 if (!NILP (echo_area_buffer
[this_one
])
9724 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9725 echo_area_buffer
[this_one
] = Qnil
;
9728 /* Choose a suitable buffer from echo_buffer[] is we don't
9730 if (NILP (echo_area_buffer
[this_one
]))
9732 echo_area_buffer
[this_one
]
9733 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9734 ? echo_buffer
[the_other
]
9735 : echo_buffer
[this_one
]);
9739 buffer
= echo_area_buffer
[this_one
];
9741 /* Don't get confused by reusing the buffer used for echoing
9742 for a different purpose. */
9743 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9746 record_unwind_protect (unwind_with_echo_area_buffer
,
9747 with_echo_area_buffer_unwind_data (w
));
9749 /* Make the echo area buffer current. Note that for display
9750 purposes, it is not necessary that the displayed window's buffer
9751 == current_buffer, except for text property lookup. So, let's
9752 only set that buffer temporarily here without doing a full
9753 Fset_window_buffer. We must also change w->pointm, though,
9754 because otherwise an assertions in unshow_buffer fails, and Emacs
9756 set_buffer_internal_1 (XBUFFER (buffer
));
9760 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9763 BVAR (current_buffer
, undo_list
) = Qt
;
9764 BVAR (current_buffer
, read_only
) = Qnil
;
9765 specbind (Qinhibit_read_only
, Qt
);
9766 specbind (Qinhibit_modification_hooks
, Qt
);
9768 if (clear_buffer_p
&& Z
> BEG
)
9771 xassert (BEGV
>= BEG
);
9772 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9774 rc
= fn (a1
, a2
, a3
, a4
);
9776 xassert (BEGV
>= BEG
);
9777 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9779 unbind_to (count
, Qnil
);
9784 /* Save state that should be preserved around the call to the function
9785 FN called in with_echo_area_buffer. */
9788 with_echo_area_buffer_unwind_data (struct window
*w
)
9791 Lisp_Object vector
, tmp
;
9793 /* Reduce consing by keeping one vector in
9794 Vwith_echo_area_save_vector. */
9795 vector
= Vwith_echo_area_save_vector
;
9796 Vwith_echo_area_save_vector
= Qnil
;
9799 vector
= Fmake_vector (make_number (7), Qnil
);
9801 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9802 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9803 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9807 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9808 ASET (vector
, i
, w
->buffer
); ++i
;
9809 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9810 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9815 for (; i
< end
; ++i
)
9816 ASET (vector
, i
, Qnil
);
9819 xassert (i
== ASIZE (vector
));
9824 /* Restore global state from VECTOR which was created by
9825 with_echo_area_buffer_unwind_data. */
9828 unwind_with_echo_area_buffer (Lisp_Object vector
)
9830 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9831 Vdeactivate_mark
= AREF (vector
, 1);
9832 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9834 if (WINDOWP (AREF (vector
, 3)))
9837 Lisp_Object buffer
, charpos
, bytepos
;
9839 w
= XWINDOW (AREF (vector
, 3));
9840 buffer
= AREF (vector
, 4);
9841 charpos
= AREF (vector
, 5);
9842 bytepos
= AREF (vector
, 6);
9845 set_marker_both (w
->pointm
, buffer
,
9846 XFASTINT (charpos
), XFASTINT (bytepos
));
9849 Vwith_echo_area_save_vector
= vector
;
9854 /* Set up the echo area for use by print functions. MULTIBYTE_P
9855 non-zero means we will print multibyte. */
9858 setup_echo_area_for_printing (int multibyte_p
)
9860 /* If we can't find an echo area any more, exit. */
9861 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9864 ensure_echo_area_buffers ();
9866 if (!message_buf_print
)
9868 /* A message has been output since the last time we printed.
9869 Choose a fresh echo area buffer. */
9870 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9871 echo_area_buffer
[0] = echo_buffer
[1];
9873 echo_area_buffer
[0] = echo_buffer
[0];
9875 /* Switch to that buffer and clear it. */
9876 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9877 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9881 int count
= SPECPDL_INDEX ();
9882 specbind (Qinhibit_read_only
, Qt
);
9883 /* Note that undo recording is always disabled. */
9885 unbind_to (count
, Qnil
);
9887 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9889 /* Set up the buffer for the multibyteness we need. */
9891 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9892 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9894 /* Raise the frame containing the echo area. */
9895 if (minibuffer_auto_raise
)
9897 struct frame
*sf
= SELECTED_FRAME ();
9898 Lisp_Object mini_window
;
9899 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9900 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9903 message_log_maybe_newline ();
9904 message_buf_print
= 1;
9908 if (NILP (echo_area_buffer
[0]))
9910 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9911 echo_area_buffer
[0] = echo_buffer
[1];
9913 echo_area_buffer
[0] = echo_buffer
[0];
9916 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9918 /* Someone switched buffers between print requests. */
9919 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9920 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9926 /* Display an echo area message in window W. Value is non-zero if W's
9927 height is changed. If display_last_displayed_message_p is
9928 non-zero, display the message that was last displayed, otherwise
9929 display the current message. */
9932 display_echo_area (struct window
*w
)
9934 int i
, no_message_p
, window_height_changed_p
, count
;
9936 /* Temporarily disable garbage collections while displaying the echo
9937 area. This is done because a GC can print a message itself.
9938 That message would modify the echo area buffer's contents while a
9939 redisplay of the buffer is going on, and seriously confuse
9941 count
= inhibit_garbage_collection ();
9943 /* If there is no message, we must call display_echo_area_1
9944 nevertheless because it resizes the window. But we will have to
9945 reset the echo_area_buffer in question to nil at the end because
9946 with_echo_area_buffer will sets it to an empty buffer. */
9947 i
= display_last_displayed_message_p
? 1 : 0;
9948 no_message_p
= NILP (echo_area_buffer
[i
]);
9950 window_height_changed_p
9951 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9952 display_echo_area_1
,
9953 (intptr_t) w
, Qnil
, 0, 0);
9956 echo_area_buffer
[i
] = Qnil
;
9958 unbind_to (count
, Qnil
);
9959 return window_height_changed_p
;
9963 /* Helper for display_echo_area. Display the current buffer which
9964 contains the current echo area message in window W, a mini-window,
9965 a pointer to which is passed in A1. A2..A4 are currently not used.
9966 Change the height of W so that all of the message is displayed.
9967 Value is non-zero if height of W was changed. */
9970 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9973 struct window
*w
= (struct window
*) i1
;
9975 struct text_pos start
;
9976 int window_height_changed_p
= 0;
9978 /* Do this before displaying, so that we have a large enough glyph
9979 matrix for the display. If we can't get enough space for the
9980 whole text, display the last N lines. That works by setting w->start. */
9981 window_height_changed_p
= resize_mini_window (w
, 0);
9983 /* Use the starting position chosen by resize_mini_window. */
9984 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9987 clear_glyph_matrix (w
->desired_matrix
);
9988 XSETWINDOW (window
, w
);
9989 try_window (window
, start
, 0);
9991 return window_height_changed_p
;
9995 /* Resize the echo area window to exactly the size needed for the
9996 currently displayed message, if there is one. If a mini-buffer
9997 is active, don't shrink it. */
10000 resize_echo_area_exactly (void)
10002 if (BUFFERP (echo_area_buffer
[0])
10003 && WINDOWP (echo_area_window
))
10005 struct window
*w
= XWINDOW (echo_area_window
);
10007 Lisp_Object resize_exactly
;
10009 if (minibuf_level
== 0)
10010 resize_exactly
= Qt
;
10012 resize_exactly
= Qnil
;
10014 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10015 (intptr_t) w
, resize_exactly
,
10019 ++windows_or_buffers_changed
;
10020 ++update_mode_lines
;
10021 redisplay_internal ();
10027 /* Callback function for with_echo_area_buffer, when used from
10028 resize_echo_area_exactly. A1 contains a pointer to the window to
10029 resize, EXACTLY non-nil means resize the mini-window exactly to the
10030 size of the text displayed. A3 and A4 are not used. Value is what
10031 resize_mini_window returns. */
10034 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10037 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10041 /* Resize mini-window W to fit the size of its contents. EXACT_P
10042 means size the window exactly to the size needed. Otherwise, it's
10043 only enlarged until W's buffer is empty.
10045 Set W->start to the right place to begin display. If the whole
10046 contents fit, start at the beginning. Otherwise, start so as
10047 to make the end of the contents appear. This is particularly
10048 important for y-or-n-p, but seems desirable generally.
10050 Value is non-zero if the window height has been changed. */
10053 resize_mini_window (struct window
*w
, int exact_p
)
10055 struct frame
*f
= XFRAME (w
->frame
);
10056 int window_height_changed_p
= 0;
10058 xassert (MINI_WINDOW_P (w
));
10060 /* By default, start display at the beginning. */
10061 set_marker_both (w
->start
, w
->buffer
,
10062 BUF_BEGV (XBUFFER (w
->buffer
)),
10063 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10065 /* Don't resize windows while redisplaying a window; it would
10066 confuse redisplay functions when the size of the window they are
10067 displaying changes from under them. Such a resizing can happen,
10068 for instance, when which-func prints a long message while
10069 we are running fontification-functions. We're running these
10070 functions with safe_call which binds inhibit-redisplay to t. */
10071 if (!NILP (Vinhibit_redisplay
))
10074 /* Nil means don't try to resize. */
10075 if (NILP (Vresize_mini_windows
)
10076 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10079 if (!FRAME_MINIBUF_ONLY_P (f
))
10082 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10083 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10084 int height
, max_height
;
10085 int unit
= FRAME_LINE_HEIGHT (f
);
10086 struct text_pos start
;
10087 struct buffer
*old_current_buffer
= NULL
;
10089 if (current_buffer
!= XBUFFER (w
->buffer
))
10091 old_current_buffer
= current_buffer
;
10092 set_buffer_internal (XBUFFER (w
->buffer
));
10095 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10097 /* Compute the max. number of lines specified by the user. */
10098 if (FLOATP (Vmax_mini_window_height
))
10099 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10100 else if (INTEGERP (Vmax_mini_window_height
))
10101 max_height
= XINT (Vmax_mini_window_height
);
10103 max_height
= total_height
/ 4;
10105 /* Correct that max. height if it's bogus. */
10106 max_height
= max (1, max_height
);
10107 max_height
= min (total_height
, max_height
);
10109 /* Find out the height of the text in the window. */
10110 if (it
.line_wrap
== TRUNCATE
)
10115 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10116 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10117 height
= it
.current_y
+ last_height
;
10119 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10120 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10121 height
= (height
+ unit
- 1) / unit
;
10124 /* Compute a suitable window start. */
10125 if (height
> max_height
)
10127 height
= max_height
;
10128 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10129 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10130 start
= it
.current
.pos
;
10133 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10134 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10136 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10138 /* Let it grow only, until we display an empty message, in which
10139 case the window shrinks again. */
10140 if (height
> WINDOW_TOTAL_LINES (w
))
10142 int old_height
= WINDOW_TOTAL_LINES (w
);
10143 freeze_window_starts (f
, 1);
10144 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10145 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10147 else if (height
< WINDOW_TOTAL_LINES (w
)
10148 && (exact_p
|| BEGV
== ZV
))
10150 int old_height
= WINDOW_TOTAL_LINES (w
);
10151 freeze_window_starts (f
, 0);
10152 shrink_mini_window (w
);
10153 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10158 /* Always resize to exact size needed. */
10159 if (height
> WINDOW_TOTAL_LINES (w
))
10161 int old_height
= WINDOW_TOTAL_LINES (w
);
10162 freeze_window_starts (f
, 1);
10163 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10164 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10166 else if (height
< WINDOW_TOTAL_LINES (w
))
10168 int old_height
= WINDOW_TOTAL_LINES (w
);
10169 freeze_window_starts (f
, 0);
10170 shrink_mini_window (w
);
10174 freeze_window_starts (f
, 1);
10175 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10178 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10182 if (old_current_buffer
)
10183 set_buffer_internal (old_current_buffer
);
10186 return window_height_changed_p
;
10190 /* Value is the current message, a string, or nil if there is no
10191 current message. */
10194 current_message (void)
10198 if (!BUFFERP (echo_area_buffer
[0]))
10202 with_echo_area_buffer (0, 0, current_message_1
,
10203 (intptr_t) &msg
, Qnil
, 0, 0);
10205 echo_area_buffer
[0] = Qnil
;
10213 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10216 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10219 *msg
= make_buffer_string (BEG
, Z
, 1);
10226 /* Push the current message on Vmessage_stack for later restauration
10227 by restore_message. Value is non-zero if the current message isn't
10228 empty. This is a relatively infrequent operation, so it's not
10229 worth optimizing. */
10232 push_message (void)
10235 msg
= current_message ();
10236 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10237 return STRINGP (msg
);
10241 /* Restore message display from the top of Vmessage_stack. */
10244 restore_message (void)
10248 xassert (CONSP (Vmessage_stack
));
10249 msg
= XCAR (Vmessage_stack
);
10251 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10253 message3_nolog (msg
, 0, 0);
10257 /* Handler for record_unwind_protect calling pop_message. */
10260 pop_message_unwind (Lisp_Object dummy
)
10266 /* Pop the top-most entry off Vmessage_stack. */
10271 xassert (CONSP (Vmessage_stack
));
10272 Vmessage_stack
= XCDR (Vmessage_stack
);
10276 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10277 exits. If the stack is not empty, we have a missing pop_message
10281 check_message_stack (void)
10283 if (!NILP (Vmessage_stack
))
10288 /* Truncate to NCHARS what will be displayed in the echo area the next
10289 time we display it---but don't redisplay it now. */
10292 truncate_echo_area (EMACS_INT nchars
)
10295 echo_area_buffer
[0] = Qnil
;
10296 /* A null message buffer means that the frame hasn't really been
10297 initialized yet. Error messages get reported properly by
10298 cmd_error, so this must be just an informative message; toss it. */
10299 else if (!noninteractive
10301 && !NILP (echo_area_buffer
[0]))
10303 struct frame
*sf
= SELECTED_FRAME ();
10304 if (FRAME_MESSAGE_BUF (sf
))
10305 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10310 /* Helper function for truncate_echo_area. Truncate the current
10311 message to at most NCHARS characters. */
10314 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10316 if (BEG
+ nchars
< Z
)
10317 del_range (BEG
+ nchars
, Z
);
10319 echo_area_buffer
[0] = Qnil
;
10324 /* Set the current message to a substring of S or STRING.
10326 If STRING is a Lisp string, set the message to the first NBYTES
10327 bytes from STRING. NBYTES zero means use the whole string. If
10328 STRING is multibyte, the message will be displayed multibyte.
10330 If S is not null, set the message to the first LEN bytes of S. LEN
10331 zero means use the whole string. MULTIBYTE_P non-zero means S is
10332 multibyte. Display the message multibyte in that case.
10334 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10335 to t before calling set_message_1 (which calls insert).
10339 set_message (const char *s
, Lisp_Object string
,
10340 EMACS_INT nbytes
, int multibyte_p
)
10342 message_enable_multibyte
10343 = ((s
&& multibyte_p
)
10344 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10346 with_echo_area_buffer (0, -1, set_message_1
,
10347 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10348 message_buf_print
= 0;
10349 help_echo_showing_p
= 0;
10353 /* Helper function for set_message. Arguments have the same meaning
10354 as there, with A1 corresponding to S and A2 corresponding to STRING
10355 This function is called with the echo area buffer being
10359 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10362 const char *s
= (const char *) i1
;
10363 const unsigned char *msg
= (const unsigned char *) s
;
10364 Lisp_Object string
= a2
;
10366 /* Change multibyteness of the echo buffer appropriately. */
10367 if (message_enable_multibyte
10368 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10369 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10371 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10372 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10373 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10375 /* Insert new message at BEG. */
10376 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10378 if (STRINGP (string
))
10383 nbytes
= SBYTES (string
);
10384 nchars
= string_byte_to_char (string
, nbytes
);
10386 /* This function takes care of single/multibyte conversion. We
10387 just have to ensure that the echo area buffer has the right
10388 setting of enable_multibyte_characters. */
10389 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10394 nbytes
= strlen (s
);
10396 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10398 /* Convert from multi-byte to single-byte. */
10403 /* Convert a multibyte string to single-byte. */
10404 for (i
= 0; i
< nbytes
; i
+= n
)
10406 c
= string_char_and_length (msg
+ i
, &n
);
10407 work
[0] = (ASCII_CHAR_P (c
)
10409 : multibyte_char_to_unibyte (c
));
10410 insert_1_both (work
, 1, 1, 1, 0, 0);
10413 else if (!multibyte_p
10414 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10416 /* Convert from single-byte to multi-byte. */
10419 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10421 /* Convert a single-byte string to multibyte. */
10422 for (i
= 0; i
< nbytes
; i
++)
10425 MAKE_CHAR_MULTIBYTE (c
);
10426 n
= CHAR_STRING (c
, str
);
10427 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10431 insert_1 (s
, nbytes
, 1, 0, 0);
10438 /* Clear messages. CURRENT_P non-zero means clear the current
10439 message. LAST_DISPLAYED_P non-zero means clear the message
10443 clear_message (int current_p
, int last_displayed_p
)
10447 echo_area_buffer
[0] = Qnil
;
10448 message_cleared_p
= 1;
10451 if (last_displayed_p
)
10452 echo_area_buffer
[1] = Qnil
;
10454 message_buf_print
= 0;
10457 /* Clear garbaged frames.
10459 This function is used where the old redisplay called
10460 redraw_garbaged_frames which in turn called redraw_frame which in
10461 turn called clear_frame. The call to clear_frame was a source of
10462 flickering. I believe a clear_frame is not necessary. It should
10463 suffice in the new redisplay to invalidate all current matrices,
10464 and ensure a complete redisplay of all windows. */
10467 clear_garbaged_frames (void)
10469 if (frame_garbaged
)
10471 Lisp_Object tail
, frame
;
10472 int changed_count
= 0;
10474 FOR_EACH_FRAME (tail
, frame
)
10476 struct frame
*f
= XFRAME (frame
);
10478 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10482 Fredraw_frame (frame
);
10483 f
->force_flush_display_p
= 1;
10485 clear_current_matrices (f
);
10492 frame_garbaged
= 0;
10494 ++windows_or_buffers_changed
;
10499 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10500 is non-zero update selected_frame. Value is non-zero if the
10501 mini-windows height has been changed. */
10504 echo_area_display (int update_frame_p
)
10506 Lisp_Object mini_window
;
10509 int window_height_changed_p
= 0;
10510 struct frame
*sf
= SELECTED_FRAME ();
10512 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10513 w
= XWINDOW (mini_window
);
10514 f
= XFRAME (WINDOW_FRAME (w
));
10516 /* Don't display if frame is invisible or not yet initialized. */
10517 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10520 #ifdef HAVE_WINDOW_SYSTEM
10521 /* When Emacs starts, selected_frame may be the initial terminal
10522 frame. If we let this through, a message would be displayed on
10524 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10526 #endif /* HAVE_WINDOW_SYSTEM */
10528 /* Redraw garbaged frames. */
10529 if (frame_garbaged
)
10530 clear_garbaged_frames ();
10532 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10534 echo_area_window
= mini_window
;
10535 window_height_changed_p
= display_echo_area (w
);
10536 w
->must_be_updated_p
= 1;
10538 /* Update the display, unless called from redisplay_internal.
10539 Also don't update the screen during redisplay itself. The
10540 update will happen at the end of redisplay, and an update
10541 here could cause confusion. */
10542 if (update_frame_p
&& !redisplaying_p
)
10546 /* If the display update has been interrupted by pending
10547 input, update mode lines in the frame. Due to the
10548 pending input, it might have been that redisplay hasn't
10549 been called, so that mode lines above the echo area are
10550 garbaged. This looks odd, so we prevent it here. */
10551 if (!display_completed
)
10552 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10554 if (window_height_changed_p
10555 /* Don't do this if Emacs is shutting down. Redisplay
10556 needs to run hooks. */
10557 && !NILP (Vrun_hooks
))
10559 /* Must update other windows. Likewise as in other
10560 cases, don't let this update be interrupted by
10562 int count
= SPECPDL_INDEX ();
10563 specbind (Qredisplay_dont_pause
, Qt
);
10564 windows_or_buffers_changed
= 1;
10565 redisplay_internal ();
10566 unbind_to (count
, Qnil
);
10568 else if (FRAME_WINDOW_P (f
) && n
== 0)
10570 /* Window configuration is the same as before.
10571 Can do with a display update of the echo area,
10572 unless we displayed some mode lines. */
10573 update_single_window (w
, 1);
10574 FRAME_RIF (f
)->flush_display (f
);
10577 update_frame (f
, 1, 1);
10579 /* If cursor is in the echo area, make sure that the next
10580 redisplay displays the minibuffer, so that the cursor will
10581 be replaced with what the minibuffer wants. */
10582 if (cursor_in_echo_area
)
10583 ++windows_or_buffers_changed
;
10586 else if (!EQ (mini_window
, selected_window
))
10587 windows_or_buffers_changed
++;
10589 /* Last displayed message is now the current message. */
10590 echo_area_buffer
[1] = echo_area_buffer
[0];
10591 /* Inform read_char that we're not echoing. */
10592 echo_message_buffer
= Qnil
;
10594 /* Prevent redisplay optimization in redisplay_internal by resetting
10595 this_line_start_pos. This is done because the mini-buffer now
10596 displays the message instead of its buffer text. */
10597 if (EQ (mini_window
, selected_window
))
10598 CHARPOS (this_line_start_pos
) = 0;
10600 return window_height_changed_p
;
10605 /***********************************************************************
10606 Mode Lines and Frame Titles
10607 ***********************************************************************/
10609 /* A buffer for constructing non-propertized mode-line strings and
10610 frame titles in it; allocated from the heap in init_xdisp and
10611 resized as needed in store_mode_line_noprop_char. */
10613 static char *mode_line_noprop_buf
;
10615 /* The buffer's end, and a current output position in it. */
10617 static char *mode_line_noprop_buf_end
;
10618 static char *mode_line_noprop_ptr
;
10620 #define MODE_LINE_NOPROP_LEN(start) \
10621 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10624 MODE_LINE_DISPLAY
= 0,
10628 } mode_line_target
;
10630 /* Alist that caches the results of :propertize.
10631 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10632 static Lisp_Object mode_line_proptrans_alist
;
10634 /* List of strings making up the mode-line. */
10635 static Lisp_Object mode_line_string_list
;
10637 /* Base face property when building propertized mode line string. */
10638 static Lisp_Object mode_line_string_face
;
10639 static Lisp_Object mode_line_string_face_prop
;
10642 /* Unwind data for mode line strings */
10644 static Lisp_Object Vmode_line_unwind_vector
;
10647 format_mode_line_unwind_data (struct buffer
*obuf
,
10649 int save_proptrans
)
10651 Lisp_Object vector
, tmp
;
10653 /* Reduce consing by keeping one vector in
10654 Vwith_echo_area_save_vector. */
10655 vector
= Vmode_line_unwind_vector
;
10656 Vmode_line_unwind_vector
= Qnil
;
10659 vector
= Fmake_vector (make_number (8), Qnil
);
10661 ASET (vector
, 0, make_number (mode_line_target
));
10662 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10663 ASET (vector
, 2, mode_line_string_list
);
10664 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10665 ASET (vector
, 4, mode_line_string_face
);
10666 ASET (vector
, 5, mode_line_string_face_prop
);
10669 XSETBUFFER (tmp
, obuf
);
10672 ASET (vector
, 6, tmp
);
10673 ASET (vector
, 7, owin
);
10679 unwind_format_mode_line (Lisp_Object vector
)
10681 mode_line_target
= XINT (AREF (vector
, 0));
10682 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10683 mode_line_string_list
= AREF (vector
, 2);
10684 if (! EQ (AREF (vector
, 3), Qt
))
10685 mode_line_proptrans_alist
= AREF (vector
, 3);
10686 mode_line_string_face
= AREF (vector
, 4);
10687 mode_line_string_face_prop
= AREF (vector
, 5);
10689 if (!NILP (AREF (vector
, 7)))
10690 /* Select window before buffer, since it may change the buffer. */
10691 Fselect_window (AREF (vector
, 7), Qt
);
10693 if (!NILP (AREF (vector
, 6)))
10695 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10696 ASET (vector
, 6, Qnil
);
10699 Vmode_line_unwind_vector
= vector
;
10704 /* Store a single character C for the frame title in mode_line_noprop_buf.
10705 Re-allocate mode_line_noprop_buf if necessary. */
10708 store_mode_line_noprop_char (char c
)
10710 /* If output position has reached the end of the allocated buffer,
10711 increase the buffer's size. */
10712 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10714 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10715 ptrdiff_t size
= len
;
10716 mode_line_noprop_buf
=
10717 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10718 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10719 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10722 *mode_line_noprop_ptr
++ = c
;
10726 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10727 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10728 characters that yield more columns than PRECISION; PRECISION <= 0
10729 means copy the whole string. Pad with spaces until FIELD_WIDTH
10730 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10731 pad. Called from display_mode_element when it is used to build a
10735 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10737 const unsigned char *str
= (const unsigned char *) string
;
10739 EMACS_INT dummy
, nbytes
;
10741 /* Copy at most PRECISION chars from STR. */
10742 nbytes
= strlen (string
);
10743 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10745 store_mode_line_noprop_char (*str
++);
10747 /* Fill up with spaces until FIELD_WIDTH reached. */
10748 while (field_width
> 0
10749 && n
< field_width
)
10751 store_mode_line_noprop_char (' ');
10758 /***********************************************************************
10760 ***********************************************************************/
10762 #ifdef HAVE_WINDOW_SYSTEM
10764 /* Set the title of FRAME, if it has changed. The title format is
10765 Vicon_title_format if FRAME is iconified, otherwise it is
10766 frame_title_format. */
10769 x_consider_frame_title (Lisp_Object frame
)
10771 struct frame
*f
= XFRAME (frame
);
10773 if (FRAME_WINDOW_P (f
)
10774 || FRAME_MINIBUF_ONLY_P (f
)
10775 || f
->explicit_name
)
10777 /* Do we have more than one visible frame on this X display? */
10780 ptrdiff_t title_start
;
10784 int count
= SPECPDL_INDEX ();
10786 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10788 Lisp_Object other_frame
= XCAR (tail
);
10789 struct frame
*tf
= XFRAME (other_frame
);
10792 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10793 && !FRAME_MINIBUF_ONLY_P (tf
)
10794 && !EQ (other_frame
, tip_frame
)
10795 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10799 /* Set global variable indicating that multiple frames exist. */
10800 multiple_frames
= CONSP (tail
);
10802 /* Switch to the buffer of selected window of the frame. Set up
10803 mode_line_target so that display_mode_element will output into
10804 mode_line_noprop_buf; then display the title. */
10805 record_unwind_protect (unwind_format_mode_line
,
10806 format_mode_line_unwind_data
10807 (current_buffer
, selected_window
, 0));
10809 Fselect_window (f
->selected_window
, Qt
);
10810 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10811 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10813 mode_line_target
= MODE_LINE_TITLE
;
10814 title_start
= MODE_LINE_NOPROP_LEN (0);
10815 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10816 NULL
, DEFAULT_FACE_ID
);
10817 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10818 len
= MODE_LINE_NOPROP_LEN (title_start
);
10819 title
= mode_line_noprop_buf
+ title_start
;
10820 unbind_to (count
, Qnil
);
10822 /* Set the title only if it's changed. This avoids consing in
10823 the common case where it hasn't. (If it turns out that we've
10824 already wasted too much time by walking through the list with
10825 display_mode_element, then we might need to optimize at a
10826 higher level than this.) */
10827 if (! STRINGP (f
->name
)
10828 || SBYTES (f
->name
) != len
10829 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10830 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10834 #endif /* not HAVE_WINDOW_SYSTEM */
10839 /***********************************************************************
10841 ***********************************************************************/
10844 /* Prepare for redisplay by updating menu-bar item lists when
10845 appropriate. This can call eval. */
10848 prepare_menu_bars (void)
10851 struct gcpro gcpro1
, gcpro2
;
10853 Lisp_Object tooltip_frame
;
10855 #ifdef HAVE_WINDOW_SYSTEM
10856 tooltip_frame
= tip_frame
;
10858 tooltip_frame
= Qnil
;
10861 /* Update all frame titles based on their buffer names, etc. We do
10862 this before the menu bars so that the buffer-menu will show the
10863 up-to-date frame titles. */
10864 #ifdef HAVE_WINDOW_SYSTEM
10865 if (windows_or_buffers_changed
|| update_mode_lines
)
10867 Lisp_Object tail
, frame
;
10869 FOR_EACH_FRAME (tail
, frame
)
10871 f
= XFRAME (frame
);
10872 if (!EQ (frame
, tooltip_frame
)
10873 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10874 x_consider_frame_title (frame
);
10877 #endif /* HAVE_WINDOW_SYSTEM */
10879 /* Update the menu bar item lists, if appropriate. This has to be
10880 done before any actual redisplay or generation of display lines. */
10881 all_windows
= (update_mode_lines
10882 || buffer_shared
> 1
10883 || windows_or_buffers_changed
);
10886 Lisp_Object tail
, frame
;
10887 int count
= SPECPDL_INDEX ();
10888 /* 1 means that update_menu_bar has run its hooks
10889 so any further calls to update_menu_bar shouldn't do so again. */
10890 int menu_bar_hooks_run
= 0;
10892 record_unwind_save_match_data ();
10894 FOR_EACH_FRAME (tail
, frame
)
10896 f
= XFRAME (frame
);
10898 /* Ignore tooltip frame. */
10899 if (EQ (frame
, tooltip_frame
))
10902 /* If a window on this frame changed size, report that to
10903 the user and clear the size-change flag. */
10904 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10906 Lisp_Object functions
;
10908 /* Clear flag first in case we get an error below. */
10909 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10910 functions
= Vwindow_size_change_functions
;
10911 GCPRO2 (tail
, functions
);
10913 while (CONSP (functions
))
10915 if (!EQ (XCAR (functions
), Qt
))
10916 call1 (XCAR (functions
), frame
);
10917 functions
= XCDR (functions
);
10923 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10924 #ifdef HAVE_WINDOW_SYSTEM
10925 update_tool_bar (f
, 0);
10928 if (windows_or_buffers_changed
10930 ns_set_doc_edited (f
, Fbuffer_modified_p
10931 (XWINDOW (f
->selected_window
)->buffer
));
10936 unbind_to (count
, Qnil
);
10940 struct frame
*sf
= SELECTED_FRAME ();
10941 update_menu_bar (sf
, 1, 0);
10942 #ifdef HAVE_WINDOW_SYSTEM
10943 update_tool_bar (sf
, 1);
10949 /* Update the menu bar item list for frame F. This has to be done
10950 before we start to fill in any display lines, because it can call
10953 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10955 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10956 already ran the menu bar hooks for this redisplay, so there
10957 is no need to run them again. The return value is the
10958 updated value of this flag, to pass to the next call. */
10961 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10963 Lisp_Object window
;
10964 register struct window
*w
;
10966 /* If called recursively during a menu update, do nothing. This can
10967 happen when, for instance, an activate-menubar-hook causes a
10969 if (inhibit_menubar_update
)
10972 window
= FRAME_SELECTED_WINDOW (f
);
10973 w
= XWINDOW (window
);
10975 if (FRAME_WINDOW_P (f
)
10977 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10978 || defined (HAVE_NS) || defined (USE_GTK)
10979 FRAME_EXTERNAL_MENU_BAR (f
)
10981 FRAME_MENU_BAR_LINES (f
) > 0
10983 : FRAME_MENU_BAR_LINES (f
) > 0)
10985 /* If the user has switched buffers or windows, we need to
10986 recompute to reflect the new bindings. But we'll
10987 recompute when update_mode_lines is set too; that means
10988 that people can use force-mode-line-update to request
10989 that the menu bar be recomputed. The adverse effect on
10990 the rest of the redisplay algorithm is about the same as
10991 windows_or_buffers_changed anyway. */
10992 if (windows_or_buffers_changed
10993 /* This used to test w->update_mode_line, but we believe
10994 there is no need to recompute the menu in that case. */
10995 || update_mode_lines
10996 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10997 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10998 != !NILP (w
->last_had_star
))
10999 || ((!NILP (Vtransient_mark_mode
)
11000 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11001 != !NILP (w
->region_showing
)))
11003 struct buffer
*prev
= current_buffer
;
11004 int count
= SPECPDL_INDEX ();
11006 specbind (Qinhibit_menubar_update
, Qt
);
11008 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11009 if (save_match_data
)
11010 record_unwind_save_match_data ();
11011 if (NILP (Voverriding_local_map_menu_flag
))
11013 specbind (Qoverriding_terminal_local_map
, Qnil
);
11014 specbind (Qoverriding_local_map
, Qnil
);
11019 /* Run the Lucid hook. */
11020 safe_run_hooks (Qactivate_menubar_hook
);
11022 /* If it has changed current-menubar from previous value,
11023 really recompute the menu-bar from the value. */
11024 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11025 call0 (Qrecompute_lucid_menubar
);
11027 safe_run_hooks (Qmenu_bar_update_hook
);
11032 XSETFRAME (Vmenu_updating_frame
, f
);
11033 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11035 /* Redisplay the menu bar in case we changed it. */
11036 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11037 || defined (HAVE_NS) || defined (USE_GTK)
11038 if (FRAME_WINDOW_P (f
))
11040 #if defined (HAVE_NS)
11041 /* All frames on Mac OS share the same menubar. So only
11042 the selected frame should be allowed to set it. */
11043 if (f
== SELECTED_FRAME ())
11045 set_frame_menubar (f
, 0, 0);
11048 /* On a terminal screen, the menu bar is an ordinary screen
11049 line, and this makes it get updated. */
11050 w
->update_mode_line
= Qt
;
11051 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11052 /* In the non-toolkit version, the menu bar is an ordinary screen
11053 line, and this makes it get updated. */
11054 w
->update_mode_line
= Qt
;
11055 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11057 unbind_to (count
, Qnil
);
11058 set_buffer_internal_1 (prev
);
11067 /***********************************************************************
11069 ***********************************************************************/
11071 #ifdef HAVE_WINDOW_SYSTEM
11074 Nominal cursor position -- where to draw output.
11075 HPOS and VPOS are window relative glyph matrix coordinates.
11076 X and Y are window relative pixel coordinates. */
11078 struct cursor_pos output_cursor
;
11082 Set the global variable output_cursor to CURSOR. All cursor
11083 positions are relative to updated_window. */
11086 set_output_cursor (struct cursor_pos
*cursor
)
11088 output_cursor
.hpos
= cursor
->hpos
;
11089 output_cursor
.vpos
= cursor
->vpos
;
11090 output_cursor
.x
= cursor
->x
;
11091 output_cursor
.y
= cursor
->y
;
11096 Set a nominal cursor position.
11098 HPOS and VPOS are column/row positions in a window glyph matrix. X
11099 and Y are window text area relative pixel positions.
11101 If this is done during an update, updated_window will contain the
11102 window that is being updated and the position is the future output
11103 cursor position for that window. If updated_window is null, use
11104 selected_window and display the cursor at the given position. */
11107 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11111 /* If updated_window is not set, work on selected_window. */
11112 if (updated_window
)
11113 w
= updated_window
;
11115 w
= XWINDOW (selected_window
);
11117 /* Set the output cursor. */
11118 output_cursor
.hpos
= hpos
;
11119 output_cursor
.vpos
= vpos
;
11120 output_cursor
.x
= x
;
11121 output_cursor
.y
= y
;
11123 /* If not called as part of an update, really display the cursor.
11124 This will also set the cursor position of W. */
11125 if (updated_window
== NULL
)
11128 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11129 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11130 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11135 #endif /* HAVE_WINDOW_SYSTEM */
11138 /***********************************************************************
11140 ***********************************************************************/
11142 #ifdef HAVE_WINDOW_SYSTEM
11144 /* Where the mouse was last time we reported a mouse event. */
11146 FRAME_PTR last_mouse_frame
;
11148 /* Tool-bar item index of the item on which a mouse button was pressed
11151 int last_tool_bar_item
;
11155 update_tool_bar_unwind (Lisp_Object frame
)
11157 selected_frame
= frame
;
11161 /* Update the tool-bar item list for frame F. This has to be done
11162 before we start to fill in any display lines. Called from
11163 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11164 and restore it here. */
11167 update_tool_bar (struct frame
*f
, int save_match_data
)
11169 #if defined (USE_GTK) || defined (HAVE_NS)
11170 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11172 int do_update
= WINDOWP (f
->tool_bar_window
)
11173 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11178 Lisp_Object window
;
11181 window
= FRAME_SELECTED_WINDOW (f
);
11182 w
= XWINDOW (window
);
11184 /* If the user has switched buffers or windows, we need to
11185 recompute to reflect the new bindings. But we'll
11186 recompute when update_mode_lines is set too; that means
11187 that people can use force-mode-line-update to request
11188 that the menu bar be recomputed. The adverse effect on
11189 the rest of the redisplay algorithm is about the same as
11190 windows_or_buffers_changed anyway. */
11191 if (windows_or_buffers_changed
11192 || !NILP (w
->update_mode_line
)
11193 || update_mode_lines
11194 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11195 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11196 != !NILP (w
->last_had_star
))
11197 || ((!NILP (Vtransient_mark_mode
)
11198 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11199 != !NILP (w
->region_showing
)))
11201 struct buffer
*prev
= current_buffer
;
11202 int count
= SPECPDL_INDEX ();
11203 Lisp_Object frame
, new_tool_bar
;
11204 int new_n_tool_bar
;
11205 struct gcpro gcpro1
;
11207 /* Set current_buffer to the buffer of the selected
11208 window of the frame, so that we get the right local
11210 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11212 /* Save match data, if we must. */
11213 if (save_match_data
)
11214 record_unwind_save_match_data ();
11216 /* Make sure that we don't accidentally use bogus keymaps. */
11217 if (NILP (Voverriding_local_map_menu_flag
))
11219 specbind (Qoverriding_terminal_local_map
, Qnil
);
11220 specbind (Qoverriding_local_map
, Qnil
);
11223 GCPRO1 (new_tool_bar
);
11225 /* We must temporarily set the selected frame to this frame
11226 before calling tool_bar_items, because the calculation of
11227 the tool-bar keymap uses the selected frame (see
11228 `tool-bar-make-keymap' in tool-bar.el). */
11229 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11230 XSETFRAME (frame
, f
);
11231 selected_frame
= frame
;
11233 /* Build desired tool-bar items from keymaps. */
11234 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11237 /* Redisplay the tool-bar if we changed it. */
11238 if (new_n_tool_bar
!= f
->n_tool_bar_items
11239 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11241 /* Redisplay that happens asynchronously due to an expose event
11242 may access f->tool_bar_items. Make sure we update both
11243 variables within BLOCK_INPUT so no such event interrupts. */
11245 f
->tool_bar_items
= new_tool_bar
;
11246 f
->n_tool_bar_items
= new_n_tool_bar
;
11247 w
->update_mode_line
= Qt
;
11253 unbind_to (count
, Qnil
);
11254 set_buffer_internal_1 (prev
);
11260 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11261 F's desired tool-bar contents. F->tool_bar_items must have
11262 been set up previously by calling prepare_menu_bars. */
11265 build_desired_tool_bar_string (struct frame
*f
)
11267 int i
, size
, size_needed
;
11268 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11269 Lisp_Object image
, plist
, props
;
11271 image
= plist
= props
= Qnil
;
11272 GCPRO3 (image
, plist
, props
);
11274 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11275 Otherwise, make a new string. */
11277 /* The size of the string we might be able to reuse. */
11278 size
= (STRINGP (f
->desired_tool_bar_string
)
11279 ? SCHARS (f
->desired_tool_bar_string
)
11282 /* We need one space in the string for each image. */
11283 size_needed
= f
->n_tool_bar_items
;
11285 /* Reuse f->desired_tool_bar_string, if possible. */
11286 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11287 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11288 make_number (' '));
11291 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11292 Fremove_text_properties (make_number (0), make_number (size
),
11293 props
, f
->desired_tool_bar_string
);
11296 /* Put a `display' property on the string for the images to display,
11297 put a `menu_item' property on tool-bar items with a value that
11298 is the index of the item in F's tool-bar item vector. */
11299 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11301 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11303 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11304 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11305 int hmargin
, vmargin
, relief
, idx
, end
;
11307 /* If image is a vector, choose the image according to the
11309 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11310 if (VECTORP (image
))
11314 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11315 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11318 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11319 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11321 xassert (ASIZE (image
) >= idx
);
11322 image
= AREF (image
, idx
);
11327 /* Ignore invalid image specifications. */
11328 if (!valid_image_p (image
))
11331 /* Display the tool-bar button pressed, or depressed. */
11332 plist
= Fcopy_sequence (XCDR (image
));
11334 /* Compute margin and relief to draw. */
11335 relief
= (tool_bar_button_relief
>= 0
11336 ? tool_bar_button_relief
11337 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11338 hmargin
= vmargin
= relief
;
11340 if (INTEGERP (Vtool_bar_button_margin
)
11341 && XINT (Vtool_bar_button_margin
) > 0)
11343 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11344 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11346 else if (CONSP (Vtool_bar_button_margin
))
11348 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11349 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11350 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11352 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11353 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11354 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11357 if (auto_raise_tool_bar_buttons_p
)
11359 /* Add a `:relief' property to the image spec if the item is
11363 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11370 /* If image is selected, display it pressed, i.e. with a
11371 negative relief. If it's not selected, display it with a
11373 plist
= Fplist_put (plist
, QCrelief
,
11375 ? make_number (-relief
)
11376 : make_number (relief
)));
11381 /* Put a margin around the image. */
11382 if (hmargin
|| vmargin
)
11384 if (hmargin
== vmargin
)
11385 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11387 plist
= Fplist_put (plist
, QCmargin
,
11388 Fcons (make_number (hmargin
),
11389 make_number (vmargin
)));
11392 /* If button is not enabled, and we don't have special images
11393 for the disabled state, make the image appear disabled by
11394 applying an appropriate algorithm to it. */
11395 if (!enabled_p
&& idx
< 0)
11396 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11398 /* Put a `display' text property on the string for the image to
11399 display. Put a `menu-item' property on the string that gives
11400 the start of this item's properties in the tool-bar items
11402 image
= Fcons (Qimage
, plist
);
11403 props
= list4 (Qdisplay
, image
,
11404 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11406 /* Let the last image hide all remaining spaces in the tool bar
11407 string. The string can be longer than needed when we reuse a
11408 previous string. */
11409 if (i
+ 1 == f
->n_tool_bar_items
)
11410 end
= SCHARS (f
->desired_tool_bar_string
);
11413 Fadd_text_properties (make_number (i
), make_number (end
),
11414 props
, f
->desired_tool_bar_string
);
11422 /* Display one line of the tool-bar of frame IT->f.
11424 HEIGHT specifies the desired height of the tool-bar line.
11425 If the actual height of the glyph row is less than HEIGHT, the
11426 row's height is increased to HEIGHT, and the icons are centered
11427 vertically in the new height.
11429 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11430 count a final empty row in case the tool-bar width exactly matches
11435 display_tool_bar_line (struct it
*it
, int height
)
11437 struct glyph_row
*row
= it
->glyph_row
;
11438 int max_x
= it
->last_visible_x
;
11439 struct glyph
*last
;
11441 prepare_desired_row (row
);
11442 row
->y
= it
->current_y
;
11444 /* Note that this isn't made use of if the face hasn't a box,
11445 so there's no need to check the face here. */
11446 it
->start_of_box_run_p
= 1;
11448 while (it
->current_x
< max_x
)
11450 int x
, n_glyphs_before
, i
, nglyphs
;
11451 struct it it_before
;
11453 /* Get the next display element. */
11454 if (!get_next_display_element (it
))
11456 /* Don't count empty row if we are counting needed tool-bar lines. */
11457 if (height
< 0 && !it
->hpos
)
11462 /* Produce glyphs. */
11463 n_glyphs_before
= row
->used
[TEXT_AREA
];
11466 PRODUCE_GLYPHS (it
);
11468 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11470 x
= it_before
.current_x
;
11471 while (i
< nglyphs
)
11473 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11475 if (x
+ glyph
->pixel_width
> max_x
)
11477 /* Glyph doesn't fit on line. Backtrack. */
11478 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11480 /* If this is the only glyph on this line, it will never fit on the
11481 tool-bar, so skip it. But ensure there is at least one glyph,
11482 so we don't accidentally disable the tool-bar. */
11483 if (n_glyphs_before
== 0
11484 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11490 x
+= glyph
->pixel_width
;
11494 /* Stop at line end. */
11495 if (ITERATOR_AT_END_OF_LINE_P (it
))
11498 set_iterator_to_next (it
, 1);
11503 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11505 /* Use default face for the border below the tool bar.
11507 FIXME: When auto-resize-tool-bars is grow-only, there is
11508 no additional border below the possibly empty tool-bar lines.
11509 So to make the extra empty lines look "normal", we have to
11510 use the tool-bar face for the border too. */
11511 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11512 it
->face_id
= DEFAULT_FACE_ID
;
11514 extend_face_to_end_of_line (it
);
11515 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11516 last
->right_box_line_p
= 1;
11517 if (last
== row
->glyphs
[TEXT_AREA
])
11518 last
->left_box_line_p
= 1;
11520 /* Make line the desired height and center it vertically. */
11521 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11523 /* Don't add more than one line height. */
11524 height
%= FRAME_LINE_HEIGHT (it
->f
);
11525 it
->max_ascent
+= height
/ 2;
11526 it
->max_descent
+= (height
+ 1) / 2;
11529 compute_line_metrics (it
);
11531 /* If line is empty, make it occupy the rest of the tool-bar. */
11532 if (!row
->displays_text_p
)
11534 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11535 row
->visible_height
= row
->height
;
11536 row
->ascent
= row
->phys_ascent
= 0;
11537 row
->extra_line_spacing
= 0;
11540 row
->full_width_p
= 1;
11541 row
->continued_p
= 0;
11542 row
->truncated_on_left_p
= 0;
11543 row
->truncated_on_right_p
= 0;
11545 it
->current_x
= it
->hpos
= 0;
11546 it
->current_y
+= row
->height
;
11552 /* Max tool-bar height. */
11554 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11555 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11557 /* Value is the number of screen lines needed to make all tool-bar
11558 items of frame F visible. The number of actual rows needed is
11559 returned in *N_ROWS if non-NULL. */
11562 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11564 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11566 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11567 the desired matrix, so use (unused) mode-line row as temporary row to
11568 avoid destroying the first tool-bar row. */
11569 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11571 /* Initialize an iterator for iteration over
11572 F->desired_tool_bar_string in the tool-bar window of frame F. */
11573 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11574 it
.first_visible_x
= 0;
11575 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11576 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11577 it
.paragraph_embedding
= L2R
;
11579 while (!ITERATOR_AT_END_P (&it
))
11581 clear_glyph_row (temp_row
);
11582 it
.glyph_row
= temp_row
;
11583 display_tool_bar_line (&it
, -1);
11585 clear_glyph_row (temp_row
);
11587 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11589 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11591 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11595 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11597 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11598 (Lisp_Object frame
)
11605 frame
= selected_frame
;
11607 CHECK_FRAME (frame
);
11608 f
= XFRAME (frame
);
11610 if (WINDOWP (f
->tool_bar_window
)
11611 && (w
= XWINDOW (f
->tool_bar_window
),
11612 WINDOW_TOTAL_LINES (w
) > 0))
11614 update_tool_bar (f
, 1);
11615 if (f
->n_tool_bar_items
)
11617 build_desired_tool_bar_string (f
);
11618 nlines
= tool_bar_lines_needed (f
, NULL
);
11622 return make_number (nlines
);
11626 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11627 height should be changed. */
11630 redisplay_tool_bar (struct frame
*f
)
11634 struct glyph_row
*row
;
11636 #if defined (USE_GTK) || defined (HAVE_NS)
11637 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11638 update_frame_tool_bar (f
);
11642 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11643 do anything. This means you must start with tool-bar-lines
11644 non-zero to get the auto-sizing effect. Or in other words, you
11645 can turn off tool-bars by specifying tool-bar-lines zero. */
11646 if (!WINDOWP (f
->tool_bar_window
)
11647 || (w
= XWINDOW (f
->tool_bar_window
),
11648 WINDOW_TOTAL_LINES (w
) == 0))
11651 /* Set up an iterator for the tool-bar window. */
11652 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11653 it
.first_visible_x
= 0;
11654 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11655 row
= it
.glyph_row
;
11657 /* Build a string that represents the contents of the tool-bar. */
11658 build_desired_tool_bar_string (f
);
11659 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11660 /* FIXME: This should be controlled by a user option. But it
11661 doesn't make sense to have an R2L tool bar if the menu bar cannot
11662 be drawn also R2L, and making the menu bar R2L is tricky due
11663 toolkit-specific code that implements it. If an R2L tool bar is
11664 ever supported, display_tool_bar_line should also be augmented to
11665 call unproduce_glyphs like display_line and display_string
11667 it
.paragraph_embedding
= L2R
;
11669 if (f
->n_tool_bar_rows
== 0)
11673 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11674 nlines
!= WINDOW_TOTAL_LINES (w
)))
11677 int old_height
= WINDOW_TOTAL_LINES (w
);
11679 XSETFRAME (frame
, f
);
11680 Fmodify_frame_parameters (frame
,
11681 Fcons (Fcons (Qtool_bar_lines
,
11682 make_number (nlines
)),
11684 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11686 clear_glyph_matrix (w
->desired_matrix
);
11687 fonts_changed_p
= 1;
11693 /* Display as many lines as needed to display all tool-bar items. */
11695 if (f
->n_tool_bar_rows
> 0)
11697 int border
, rows
, height
, extra
;
11699 if (INTEGERP (Vtool_bar_border
))
11700 border
= XINT (Vtool_bar_border
);
11701 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11702 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11703 else if (EQ (Vtool_bar_border
, Qborder_width
))
11704 border
= f
->border_width
;
11710 rows
= f
->n_tool_bar_rows
;
11711 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11712 extra
= it
.last_visible_y
- border
- height
* rows
;
11714 while (it
.current_y
< it
.last_visible_y
)
11717 if (extra
> 0 && rows
-- > 0)
11719 h
= (extra
+ rows
- 1) / rows
;
11722 display_tool_bar_line (&it
, height
+ h
);
11727 while (it
.current_y
< it
.last_visible_y
)
11728 display_tool_bar_line (&it
, 0);
11731 /* It doesn't make much sense to try scrolling in the tool-bar
11732 window, so don't do it. */
11733 w
->desired_matrix
->no_scrolling_p
= 1;
11734 w
->must_be_updated_p
= 1;
11736 if (!NILP (Vauto_resize_tool_bars
))
11738 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11739 int change_height_p
= 0;
11741 /* If we couldn't display everything, change the tool-bar's
11742 height if there is room for more. */
11743 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11744 && it
.current_y
< max_tool_bar_height
)
11745 change_height_p
= 1;
11747 row
= it
.glyph_row
- 1;
11749 /* If there are blank lines at the end, except for a partially
11750 visible blank line at the end that is smaller than
11751 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11752 if (!row
->displays_text_p
11753 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11754 change_height_p
= 1;
11756 /* If row displays tool-bar items, but is partially visible,
11757 change the tool-bar's height. */
11758 if (row
->displays_text_p
11759 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11760 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11761 change_height_p
= 1;
11763 /* Resize windows as needed by changing the `tool-bar-lines'
11764 frame parameter. */
11765 if (change_height_p
)
11768 int old_height
= WINDOW_TOTAL_LINES (w
);
11770 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11772 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11773 && !f
->minimize_tool_bar_window_p
)
11774 ? (nlines
> old_height
)
11775 : (nlines
!= old_height
));
11776 f
->minimize_tool_bar_window_p
= 0;
11778 if (change_height_p
)
11780 XSETFRAME (frame
, f
);
11781 Fmodify_frame_parameters (frame
,
11782 Fcons (Fcons (Qtool_bar_lines
,
11783 make_number (nlines
)),
11785 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11787 clear_glyph_matrix (w
->desired_matrix
);
11788 f
->n_tool_bar_rows
= nrows
;
11789 fonts_changed_p
= 1;
11796 f
->minimize_tool_bar_window_p
= 0;
11801 /* Get information about the tool-bar item which is displayed in GLYPH
11802 on frame F. Return in *PROP_IDX the index where tool-bar item
11803 properties start in F->tool_bar_items. Value is zero if
11804 GLYPH doesn't display a tool-bar item. */
11807 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11813 /* This function can be called asynchronously, which means we must
11814 exclude any possibility that Fget_text_property signals an
11816 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11817 charpos
= max (0, charpos
);
11819 /* Get the text property `menu-item' at pos. The value of that
11820 property is the start index of this item's properties in
11821 F->tool_bar_items. */
11822 prop
= Fget_text_property (make_number (charpos
),
11823 Qmenu_item
, f
->current_tool_bar_string
);
11824 if (INTEGERP (prop
))
11826 *prop_idx
= XINT (prop
);
11836 /* Get information about the tool-bar item at position X/Y on frame F.
11837 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11838 the current matrix of the tool-bar window of F, or NULL if not
11839 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11840 item in F->tool_bar_items. Value is
11842 -1 if X/Y is not on a tool-bar item
11843 0 if X/Y is on the same item that was highlighted before.
11847 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11848 int *hpos
, int *vpos
, int *prop_idx
)
11850 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11851 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11854 /* Find the glyph under X/Y. */
11855 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11856 if (*glyph
== NULL
)
11859 /* Get the start of this tool-bar item's properties in
11860 f->tool_bar_items. */
11861 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11864 /* Is mouse on the highlighted item? */
11865 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11866 && *vpos
>= hlinfo
->mouse_face_beg_row
11867 && *vpos
<= hlinfo
->mouse_face_end_row
11868 && (*vpos
> hlinfo
->mouse_face_beg_row
11869 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11870 && (*vpos
< hlinfo
->mouse_face_end_row
11871 || *hpos
< hlinfo
->mouse_face_end_col
11872 || hlinfo
->mouse_face_past_end
))
11880 Handle mouse button event on the tool-bar of frame F, at
11881 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11882 0 for button release. MODIFIERS is event modifiers for button
11886 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11887 unsigned int modifiers
)
11889 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11890 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11891 int hpos
, vpos
, prop_idx
;
11892 struct glyph
*glyph
;
11893 Lisp_Object enabled_p
;
11895 /* If not on the highlighted tool-bar item, return. */
11896 frame_to_window_pixel_xy (w
, &x
, &y
);
11897 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11900 /* If item is disabled, do nothing. */
11901 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11902 if (NILP (enabled_p
))
11907 /* Show item in pressed state. */
11908 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11909 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11910 last_tool_bar_item
= prop_idx
;
11914 Lisp_Object key
, frame
;
11915 struct input_event event
;
11916 EVENT_INIT (event
);
11918 /* Show item in released state. */
11919 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11920 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11922 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11924 XSETFRAME (frame
, f
);
11925 event
.kind
= TOOL_BAR_EVENT
;
11926 event
.frame_or_window
= frame
;
11928 kbd_buffer_store_event (&event
);
11930 event
.kind
= TOOL_BAR_EVENT
;
11931 event
.frame_or_window
= frame
;
11933 event
.modifiers
= modifiers
;
11934 kbd_buffer_store_event (&event
);
11935 last_tool_bar_item
= -1;
11940 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11941 tool-bar window-relative coordinates X/Y. Called from
11942 note_mouse_highlight. */
11945 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11947 Lisp_Object window
= f
->tool_bar_window
;
11948 struct window
*w
= XWINDOW (window
);
11949 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11950 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11952 struct glyph
*glyph
;
11953 struct glyph_row
*row
;
11955 Lisp_Object enabled_p
;
11957 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11958 int mouse_down_p
, rc
;
11960 /* Function note_mouse_highlight is called with negative X/Y
11961 values when mouse moves outside of the frame. */
11962 if (x
<= 0 || y
<= 0)
11964 clear_mouse_face (hlinfo
);
11968 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11971 /* Not on tool-bar item. */
11972 clear_mouse_face (hlinfo
);
11976 /* On same tool-bar item as before. */
11977 goto set_help_echo
;
11979 clear_mouse_face (hlinfo
);
11981 /* Mouse is down, but on different tool-bar item? */
11982 mouse_down_p
= (dpyinfo
->grabbed
11983 && f
== last_mouse_frame
11984 && FRAME_LIVE_P (f
));
11986 && last_tool_bar_item
!= prop_idx
)
11989 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11990 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11992 /* If tool-bar item is not enabled, don't highlight it. */
11993 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11994 if (!NILP (enabled_p
))
11996 /* Compute the x-position of the glyph. In front and past the
11997 image is a space. We include this in the highlighted area. */
11998 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11999 for (i
= x
= 0; i
< hpos
; ++i
)
12000 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12002 /* Record this as the current active region. */
12003 hlinfo
->mouse_face_beg_col
= hpos
;
12004 hlinfo
->mouse_face_beg_row
= vpos
;
12005 hlinfo
->mouse_face_beg_x
= x
;
12006 hlinfo
->mouse_face_beg_y
= row
->y
;
12007 hlinfo
->mouse_face_past_end
= 0;
12009 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12010 hlinfo
->mouse_face_end_row
= vpos
;
12011 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12012 hlinfo
->mouse_face_end_y
= row
->y
;
12013 hlinfo
->mouse_face_window
= window
;
12014 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12016 /* Display it as active. */
12017 show_mouse_face (hlinfo
, draw
);
12018 hlinfo
->mouse_face_image_state
= draw
;
12023 /* Set help_echo_string to a help string to display for this tool-bar item.
12024 XTread_socket does the rest. */
12025 help_echo_object
= help_echo_window
= Qnil
;
12026 help_echo_pos
= -1;
12027 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12028 if (NILP (help_echo_string
))
12029 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12032 #endif /* HAVE_WINDOW_SYSTEM */
12036 /************************************************************************
12037 Horizontal scrolling
12038 ************************************************************************/
12040 static int hscroll_window_tree (Lisp_Object
);
12041 static int hscroll_windows (Lisp_Object
);
12043 /* For all leaf windows in the window tree rooted at WINDOW, set their
12044 hscroll value so that PT is (i) visible in the window, and (ii) so
12045 that it is not within a certain margin at the window's left and
12046 right border. Value is non-zero if any window's hscroll has been
12050 hscroll_window_tree (Lisp_Object window
)
12052 int hscrolled_p
= 0;
12053 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12054 int hscroll_step_abs
= 0;
12055 double hscroll_step_rel
= 0;
12057 if (hscroll_relative_p
)
12059 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12060 if (hscroll_step_rel
< 0)
12062 hscroll_relative_p
= 0;
12063 hscroll_step_abs
= 0;
12066 else if (INTEGERP (Vhscroll_step
))
12068 hscroll_step_abs
= XINT (Vhscroll_step
);
12069 if (hscroll_step_abs
< 0)
12070 hscroll_step_abs
= 0;
12073 hscroll_step_abs
= 0;
12075 while (WINDOWP (window
))
12077 struct window
*w
= XWINDOW (window
);
12079 if (WINDOWP (w
->hchild
))
12080 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12081 else if (WINDOWP (w
->vchild
))
12082 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12083 else if (w
->cursor
.vpos
>= 0)
12086 int text_area_width
;
12087 struct glyph_row
*current_cursor_row
12088 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12089 struct glyph_row
*desired_cursor_row
12090 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12091 struct glyph_row
*cursor_row
12092 = (desired_cursor_row
->enabled_p
12093 ? desired_cursor_row
12094 : current_cursor_row
);
12095 int row_r2l_p
= cursor_row
->reversed_p
;
12097 text_area_width
= window_box_width (w
, TEXT_AREA
);
12099 /* Scroll when cursor is inside this scroll margin. */
12100 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12102 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12103 /* For left-to-right rows, hscroll when cursor is either
12104 (i) inside the right hscroll margin, or (ii) if it is
12105 inside the left margin and the window is already
12108 && ((XFASTINT (w
->hscroll
)
12109 && w
->cursor
.x
<= h_margin
)
12110 || (cursor_row
->enabled_p
12111 && cursor_row
->truncated_on_right_p
12112 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12113 /* For right-to-left rows, the logic is similar,
12114 except that rules for scrolling to left and right
12115 are reversed. E.g., if cursor.x <= h_margin, we
12116 need to hscroll "to the right" unconditionally,
12117 and that will scroll the screen to the left so as
12118 to reveal the next portion of the row. */
12120 && ((cursor_row
->enabled_p
12121 /* FIXME: It is confusing to set the
12122 truncated_on_right_p flag when R2L rows
12123 are actually truncated on the left. */
12124 && cursor_row
->truncated_on_right_p
12125 && w
->cursor
.x
<= h_margin
)
12126 || (XFASTINT (w
->hscroll
)
12127 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12131 struct buffer
*saved_current_buffer
;
12135 /* Find point in a display of infinite width. */
12136 saved_current_buffer
= current_buffer
;
12137 current_buffer
= XBUFFER (w
->buffer
);
12139 if (w
== XWINDOW (selected_window
))
12143 pt
= marker_position (w
->pointm
);
12144 pt
= max (BEGV
, pt
);
12148 /* Move iterator to pt starting at cursor_row->start in
12149 a line with infinite width. */
12150 init_to_row_start (&it
, w
, cursor_row
);
12151 it
.last_visible_x
= INFINITY
;
12152 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12153 current_buffer
= saved_current_buffer
;
12155 /* Position cursor in window. */
12156 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12157 hscroll
= max (0, (it
.current_x
12158 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12159 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12160 : (text_area_width
/ 2))))
12161 / FRAME_COLUMN_WIDTH (it
.f
);
12162 else if ((!row_r2l_p
12163 && w
->cursor
.x
>= text_area_width
- h_margin
)
12164 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12166 if (hscroll_relative_p
)
12167 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12170 wanted_x
= text_area_width
12171 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12174 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12178 if (hscroll_relative_p
)
12179 wanted_x
= text_area_width
* hscroll_step_rel
12182 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12185 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12187 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12189 /* Don't prevent redisplay optimizations if hscroll
12190 hasn't changed, as it will unnecessarily slow down
12192 if (XFASTINT (w
->hscroll
) != hscroll
)
12194 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12195 w
->hscroll
= make_number (hscroll
);
12204 /* Value is non-zero if hscroll of any leaf window has been changed. */
12205 return hscrolled_p
;
12209 /* Set hscroll so that cursor is visible and not inside horizontal
12210 scroll margins for all windows in the tree rooted at WINDOW. See
12211 also hscroll_window_tree above. Value is non-zero if any window's
12212 hscroll has been changed. If it has, desired matrices on the frame
12213 of WINDOW are cleared. */
12216 hscroll_windows (Lisp_Object window
)
12218 int hscrolled_p
= hscroll_window_tree (window
);
12220 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12221 return hscrolled_p
;
12226 /************************************************************************
12228 ************************************************************************/
12230 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12231 to a non-zero value. This is sometimes handy to have in a debugger
12236 /* First and last unchanged row for try_window_id. */
12238 static int debug_first_unchanged_at_end_vpos
;
12239 static int debug_last_unchanged_at_beg_vpos
;
12241 /* Delta vpos and y. */
12243 static int debug_dvpos
, debug_dy
;
12245 /* Delta in characters and bytes for try_window_id. */
12247 static EMACS_INT debug_delta
, debug_delta_bytes
;
12249 /* Values of window_end_pos and window_end_vpos at the end of
12252 static EMACS_INT debug_end_vpos
;
12254 /* Append a string to W->desired_matrix->method. FMT is a printf
12255 format string. If trace_redisplay_p is non-zero also printf the
12256 resulting string to stderr. */
12258 static void debug_method_add (struct window
*, char const *, ...)
12259 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12262 debug_method_add (struct window
*w
, char const *fmt
, ...)
12265 char *method
= w
->desired_matrix
->method
;
12266 int len
= strlen (method
);
12267 int size
= sizeof w
->desired_matrix
->method
;
12268 int remaining
= size
- len
- 1;
12271 va_start (ap
, fmt
);
12272 vsprintf (buffer
, fmt
, ap
);
12274 if (len
&& remaining
)
12277 --remaining
, ++len
;
12280 strncpy (method
+ len
, buffer
, remaining
);
12282 if (trace_redisplay_p
)
12283 fprintf (stderr
, "%p (%s): %s\n",
12285 ((BUFFERP (w
->buffer
)
12286 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12287 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12292 #endif /* GLYPH_DEBUG */
12295 /* Value is non-zero if all changes in window W, which displays
12296 current_buffer, are in the text between START and END. START is a
12297 buffer position, END is given as a distance from Z. Used in
12298 redisplay_internal for display optimization. */
12301 text_outside_line_unchanged_p (struct window
*w
,
12302 EMACS_INT start
, EMACS_INT end
)
12304 int unchanged_p
= 1;
12306 /* If text or overlays have changed, see where. */
12307 if (XFASTINT (w
->last_modified
) < MODIFF
12308 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12310 /* Gap in the line? */
12311 if (GPT
< start
|| Z
- GPT
< end
)
12314 /* Changes start in front of the line, or end after it? */
12316 && (BEG_UNCHANGED
< start
- 1
12317 || END_UNCHANGED
< end
))
12320 /* If selective display, can't optimize if changes start at the
12321 beginning of the line. */
12323 && INTEGERP (BVAR (current_buffer
, selective_display
))
12324 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12325 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12328 /* If there are overlays at the start or end of the line, these
12329 may have overlay strings with newlines in them. A change at
12330 START, for instance, may actually concern the display of such
12331 overlay strings as well, and they are displayed on different
12332 lines. So, quickly rule out this case. (For the future, it
12333 might be desirable to implement something more telling than
12334 just BEG/END_UNCHANGED.) */
12337 if (BEG
+ BEG_UNCHANGED
== start
12338 && overlay_touches_p (start
))
12340 if (END_UNCHANGED
== end
12341 && overlay_touches_p (Z
- end
))
12345 /* Under bidi reordering, adding or deleting a character in the
12346 beginning of a paragraph, before the first strong directional
12347 character, can change the base direction of the paragraph (unless
12348 the buffer specifies a fixed paragraph direction), which will
12349 require to redisplay the whole paragraph. It might be worthwhile
12350 to find the paragraph limits and widen the range of redisplayed
12351 lines to that, but for now just give up this optimization. */
12352 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12353 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12357 return unchanged_p
;
12361 /* Do a frame update, taking possible shortcuts into account. This is
12362 the main external entry point for redisplay.
12364 If the last redisplay displayed an echo area message and that message
12365 is no longer requested, we clear the echo area or bring back the
12366 mini-buffer if that is in use. */
12371 redisplay_internal ();
12376 overlay_arrow_string_or_property (Lisp_Object var
)
12380 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12383 return Voverlay_arrow_string
;
12386 /* Return 1 if there are any overlay-arrows in current_buffer. */
12388 overlay_arrow_in_current_buffer_p (void)
12392 for (vlist
= Voverlay_arrow_variable_list
;
12394 vlist
= XCDR (vlist
))
12396 Lisp_Object var
= XCAR (vlist
);
12399 if (!SYMBOLP (var
))
12401 val
= find_symbol_value (var
);
12403 && current_buffer
== XMARKER (val
)->buffer
)
12410 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12414 overlay_arrows_changed_p (void)
12418 for (vlist
= Voverlay_arrow_variable_list
;
12420 vlist
= XCDR (vlist
))
12422 Lisp_Object var
= XCAR (vlist
);
12423 Lisp_Object val
, pstr
;
12425 if (!SYMBOLP (var
))
12427 val
= find_symbol_value (var
);
12428 if (!MARKERP (val
))
12430 if (! EQ (COERCE_MARKER (val
),
12431 Fget (var
, Qlast_arrow_position
))
12432 || ! (pstr
= overlay_arrow_string_or_property (var
),
12433 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12439 /* Mark overlay arrows to be updated on next redisplay. */
12442 update_overlay_arrows (int up_to_date
)
12446 for (vlist
= Voverlay_arrow_variable_list
;
12448 vlist
= XCDR (vlist
))
12450 Lisp_Object var
= XCAR (vlist
);
12452 if (!SYMBOLP (var
))
12455 if (up_to_date
> 0)
12457 Lisp_Object val
= find_symbol_value (var
);
12458 Fput (var
, Qlast_arrow_position
,
12459 COERCE_MARKER (val
));
12460 Fput (var
, Qlast_arrow_string
,
12461 overlay_arrow_string_or_property (var
));
12463 else if (up_to_date
< 0
12464 || !NILP (Fget (var
, Qlast_arrow_position
)))
12466 Fput (var
, Qlast_arrow_position
, Qt
);
12467 Fput (var
, Qlast_arrow_string
, Qt
);
12473 /* Return overlay arrow string to display at row.
12474 Return integer (bitmap number) for arrow bitmap in left fringe.
12475 Return nil if no overlay arrow. */
12478 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12482 for (vlist
= Voverlay_arrow_variable_list
;
12484 vlist
= XCDR (vlist
))
12486 Lisp_Object var
= XCAR (vlist
);
12489 if (!SYMBOLP (var
))
12492 val
= find_symbol_value (var
);
12495 && current_buffer
== XMARKER (val
)->buffer
12496 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12498 if (FRAME_WINDOW_P (it
->f
)
12499 /* FIXME: if ROW->reversed_p is set, this should test
12500 the right fringe, not the left one. */
12501 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12503 #ifdef HAVE_WINDOW_SYSTEM
12504 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12507 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12508 return make_number (fringe_bitmap
);
12511 return make_number (-1); /* Use default arrow bitmap */
12513 return overlay_arrow_string_or_property (var
);
12520 /* Return 1 if point moved out of or into a composition. Otherwise
12521 return 0. PREV_BUF and PREV_PT are the last point buffer and
12522 position. BUF and PT are the current point buffer and position. */
12525 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12526 struct buffer
*buf
, EMACS_INT pt
)
12528 EMACS_INT start
, end
;
12530 Lisp_Object buffer
;
12532 XSETBUFFER (buffer
, buf
);
12533 /* Check a composition at the last point if point moved within the
12535 if (prev_buf
== buf
)
12538 /* Point didn't move. */
12541 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12542 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12543 && COMPOSITION_VALID_P (start
, end
, prop
)
12544 && start
< prev_pt
&& end
> prev_pt
)
12545 /* The last point was within the composition. Return 1 iff
12546 point moved out of the composition. */
12547 return (pt
<= start
|| pt
>= end
);
12550 /* Check a composition at the current point. */
12551 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12552 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12553 && COMPOSITION_VALID_P (start
, end
, prop
)
12554 && start
< pt
&& end
> pt
);
12558 /* Reconsider the setting of B->clip_changed which is displayed
12562 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12564 if (b
->clip_changed
12565 && !NILP (w
->window_end_valid
)
12566 && w
->current_matrix
->buffer
== b
12567 && w
->current_matrix
->zv
== BUF_ZV (b
)
12568 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12569 b
->clip_changed
= 0;
12571 /* If display wasn't paused, and W is not a tool bar window, see if
12572 point has been moved into or out of a composition. In that case,
12573 we set b->clip_changed to 1 to force updating the screen. If
12574 b->clip_changed has already been set to 1, we can skip this
12576 if (!b
->clip_changed
12577 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12581 if (w
== XWINDOW (selected_window
))
12584 pt
= marker_position (w
->pointm
);
12586 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12587 || pt
!= XINT (w
->last_point
))
12588 && check_point_in_composition (w
->current_matrix
->buffer
,
12589 XINT (w
->last_point
),
12590 XBUFFER (w
->buffer
), pt
))
12591 b
->clip_changed
= 1;
12596 /* Select FRAME to forward the values of frame-local variables into C
12597 variables so that the redisplay routines can access those values
12601 select_frame_for_redisplay (Lisp_Object frame
)
12603 Lisp_Object tail
, tem
;
12604 Lisp_Object old
= selected_frame
;
12605 struct Lisp_Symbol
*sym
;
12607 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12609 selected_frame
= frame
;
12612 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12613 if (CONSP (XCAR (tail
))
12614 && (tem
= XCAR (XCAR (tail
)),
12616 && (sym
= indirect_variable (XSYMBOL (tem
)),
12617 sym
->redirect
== SYMBOL_LOCALIZED
)
12618 && sym
->val
.blv
->frame_local
)
12619 /* Use find_symbol_value rather than Fsymbol_value
12620 to avoid an error if it is void. */
12621 find_symbol_value (tem
);
12622 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12626 #define STOP_POLLING \
12627 do { if (! polling_stopped_here) stop_polling (); \
12628 polling_stopped_here = 1; } while (0)
12630 #define RESUME_POLLING \
12631 do { if (polling_stopped_here) start_polling (); \
12632 polling_stopped_here = 0; } while (0)
12635 /* Perhaps in the future avoid recentering windows if it
12636 is not necessary; currently that causes some problems. */
12639 redisplay_internal (void)
12641 struct window
*w
= XWINDOW (selected_window
);
12645 int must_finish
= 0;
12646 struct text_pos tlbufpos
, tlendpos
;
12647 int number_of_visible_frames
;
12650 int polling_stopped_here
= 0;
12651 Lisp_Object old_frame
= selected_frame
;
12653 /* Non-zero means redisplay has to consider all windows on all
12654 frames. Zero means, only selected_window is considered. */
12655 int consider_all_windows_p
;
12657 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12659 /* No redisplay if running in batch mode or frame is not yet fully
12660 initialized, or redisplay is explicitly turned off by setting
12661 Vinhibit_redisplay. */
12662 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12663 || !NILP (Vinhibit_redisplay
))
12666 /* Don't examine these until after testing Vinhibit_redisplay.
12667 When Emacs is shutting down, perhaps because its connection to
12668 X has dropped, we should not look at them at all. */
12669 fr
= XFRAME (w
->frame
);
12670 sf
= SELECTED_FRAME ();
12672 if (!fr
->glyphs_initialized_p
)
12675 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12676 if (popup_activated ())
12680 /* I don't think this happens but let's be paranoid. */
12681 if (redisplaying_p
)
12684 /* Record a function that resets redisplaying_p to its old value
12685 when we leave this function. */
12686 count
= SPECPDL_INDEX ();
12687 record_unwind_protect (unwind_redisplay
,
12688 Fcons (make_number (redisplaying_p
), selected_frame
));
12690 specbind (Qinhibit_free_realized_faces
, Qnil
);
12693 Lisp_Object tail
, frame
;
12695 FOR_EACH_FRAME (tail
, frame
)
12697 struct frame
*f
= XFRAME (frame
);
12698 f
->already_hscrolled_p
= 0;
12703 /* Remember the currently selected window. */
12706 if (!EQ (old_frame
, selected_frame
)
12707 && FRAME_LIVE_P (XFRAME (old_frame
)))
12708 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12709 selected_frame and selected_window to be temporarily out-of-sync so
12710 when we come back here via `goto retry', we need to resync because we
12711 may need to run Elisp code (via prepare_menu_bars). */
12712 select_frame_for_redisplay (old_frame
);
12715 reconsider_clip_changes (w
, current_buffer
);
12716 last_escape_glyph_frame
= NULL
;
12717 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12718 last_glyphless_glyph_frame
= NULL
;
12719 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12721 /* If new fonts have been loaded that make a glyph matrix adjustment
12722 necessary, do it. */
12723 if (fonts_changed_p
)
12725 adjust_glyphs (NULL
);
12726 ++windows_or_buffers_changed
;
12727 fonts_changed_p
= 0;
12730 /* If face_change_count is non-zero, init_iterator will free all
12731 realized faces, which includes the faces referenced from current
12732 matrices. So, we can't reuse current matrices in this case. */
12733 if (face_change_count
)
12734 ++windows_or_buffers_changed
;
12736 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12737 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12739 /* Since frames on a single ASCII terminal share the same
12740 display area, displaying a different frame means redisplay
12741 the whole thing. */
12742 windows_or_buffers_changed
++;
12743 SET_FRAME_GARBAGED (sf
);
12745 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12747 FRAME_TTY (sf
)->previous_frame
= sf
;
12750 /* Set the visible flags for all frames. Do this before checking
12751 for resized or garbaged frames; they want to know if their frames
12752 are visible. See the comment in frame.h for
12753 FRAME_SAMPLE_VISIBILITY. */
12755 Lisp_Object tail
, frame
;
12757 number_of_visible_frames
= 0;
12759 FOR_EACH_FRAME (tail
, frame
)
12761 struct frame
*f
= XFRAME (frame
);
12763 FRAME_SAMPLE_VISIBILITY (f
);
12764 if (FRAME_VISIBLE_P (f
))
12765 ++number_of_visible_frames
;
12766 clear_desired_matrices (f
);
12770 /* Notice any pending interrupt request to change frame size. */
12771 do_pending_window_change (1);
12773 /* do_pending_window_change could change the selected_window due to
12774 frame resizing which makes the selected window too small. */
12775 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12778 reconsider_clip_changes (w
, current_buffer
);
12781 /* Clear frames marked as garbaged. */
12782 if (frame_garbaged
)
12783 clear_garbaged_frames ();
12785 /* Build menubar and tool-bar items. */
12786 if (NILP (Vmemory_full
))
12787 prepare_menu_bars ();
12789 if (windows_or_buffers_changed
)
12790 update_mode_lines
++;
12792 /* Detect case that we need to write or remove a star in the mode line. */
12793 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12795 w
->update_mode_line
= Qt
;
12796 if (buffer_shared
> 1)
12797 update_mode_lines
++;
12800 /* Avoid invocation of point motion hooks by `current_column' below. */
12801 count1
= SPECPDL_INDEX ();
12802 specbind (Qinhibit_point_motion_hooks
, Qt
);
12804 /* If %c is in the mode line, update it if needed. */
12805 if (!NILP (w
->column_number_displayed
)
12806 /* This alternative quickly identifies a common case
12807 where no change is needed. */
12808 && !(PT
== XFASTINT (w
->last_point
)
12809 && XFASTINT (w
->last_modified
) >= MODIFF
12810 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12811 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12812 w
->update_mode_line
= Qt
;
12814 unbind_to (count1
, Qnil
);
12816 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12818 /* The variable buffer_shared is set in redisplay_window and
12819 indicates that we redisplay a buffer in different windows. See
12821 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12822 || cursor_type_changed
);
12824 /* If specs for an arrow have changed, do thorough redisplay
12825 to ensure we remove any arrow that should no longer exist. */
12826 if (overlay_arrows_changed_p ())
12827 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12829 /* Normally the message* functions will have already displayed and
12830 updated the echo area, but the frame may have been trashed, or
12831 the update may have been preempted, so display the echo area
12832 again here. Checking message_cleared_p captures the case that
12833 the echo area should be cleared. */
12834 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12835 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12836 || (message_cleared_p
12837 && minibuf_level
== 0
12838 /* If the mini-window is currently selected, this means the
12839 echo-area doesn't show through. */
12840 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12842 int window_height_changed_p
= echo_area_display (0);
12845 /* If we don't display the current message, don't clear the
12846 message_cleared_p flag, because, if we did, we wouldn't clear
12847 the echo area in the next redisplay which doesn't preserve
12849 if (!display_last_displayed_message_p
)
12850 message_cleared_p
= 0;
12852 if (fonts_changed_p
)
12854 else if (window_height_changed_p
)
12856 consider_all_windows_p
= 1;
12857 ++update_mode_lines
;
12858 ++windows_or_buffers_changed
;
12860 /* If window configuration was changed, frames may have been
12861 marked garbaged. Clear them or we will experience
12862 surprises wrt scrolling. */
12863 if (frame_garbaged
)
12864 clear_garbaged_frames ();
12867 else if (EQ (selected_window
, minibuf_window
)
12868 && (current_buffer
->clip_changed
12869 || XFASTINT (w
->last_modified
) < MODIFF
12870 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12871 && resize_mini_window (w
, 0))
12873 /* Resized active mini-window to fit the size of what it is
12874 showing if its contents might have changed. */
12876 /* FIXME: this causes all frames to be updated, which seems unnecessary
12877 since only the current frame needs to be considered. This function needs
12878 to be rewritten with two variables, consider_all_windows and
12879 consider_all_frames. */
12880 consider_all_windows_p
= 1;
12881 ++windows_or_buffers_changed
;
12882 ++update_mode_lines
;
12884 /* If window configuration was changed, frames may have been
12885 marked garbaged. Clear them or we will experience
12886 surprises wrt scrolling. */
12887 if (frame_garbaged
)
12888 clear_garbaged_frames ();
12892 /* If showing the region, and mark has changed, we must redisplay
12893 the whole window. The assignment to this_line_start_pos prevents
12894 the optimization directly below this if-statement. */
12895 if (((!NILP (Vtransient_mark_mode
)
12896 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12897 != !NILP (w
->region_showing
))
12898 || (!NILP (w
->region_showing
)
12899 && !EQ (w
->region_showing
,
12900 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12901 CHARPOS (this_line_start_pos
) = 0;
12903 /* Optimize the case that only the line containing the cursor in the
12904 selected window has changed. Variables starting with this_ are
12905 set in display_line and record information about the line
12906 containing the cursor. */
12907 tlbufpos
= this_line_start_pos
;
12908 tlendpos
= this_line_end_pos
;
12909 if (!consider_all_windows_p
12910 && CHARPOS (tlbufpos
) > 0
12911 && NILP (w
->update_mode_line
)
12912 && !current_buffer
->clip_changed
12913 && !current_buffer
->prevent_redisplay_optimizations_p
12914 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12915 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12916 /* Make sure recorded data applies to current buffer, etc. */
12917 && this_line_buffer
== current_buffer
12918 && current_buffer
== XBUFFER (w
->buffer
)
12919 && NILP (w
->force_start
)
12920 && NILP (w
->optional_new_start
)
12921 /* Point must be on the line that we have info recorded about. */
12922 && PT
>= CHARPOS (tlbufpos
)
12923 && PT
<= Z
- CHARPOS (tlendpos
)
12924 /* All text outside that line, including its final newline,
12925 must be unchanged. */
12926 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12927 CHARPOS (tlendpos
)))
12929 if (CHARPOS (tlbufpos
) > BEGV
12930 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12931 && (CHARPOS (tlbufpos
) == ZV
12932 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12933 /* Former continuation line has disappeared by becoming empty. */
12935 else if (XFASTINT (w
->last_modified
) < MODIFF
12936 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12937 || MINI_WINDOW_P (w
))
12939 /* We have to handle the case of continuation around a
12940 wide-column character (see the comment in indent.c around
12943 For instance, in the following case:
12945 -------- Insert --------
12946 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12947 J_I_ ==> J_I_ `^^' are cursors.
12951 As we have to redraw the line above, we cannot use this
12955 int line_height_before
= this_line_pixel_height
;
12957 /* Note that start_display will handle the case that the
12958 line starting at tlbufpos is a continuation line. */
12959 start_display (&it
, w
, tlbufpos
);
12961 /* Implementation note: It this still necessary? */
12962 if (it
.current_x
!= this_line_start_x
)
12965 TRACE ((stderr
, "trying display optimization 1\n"));
12966 w
->cursor
.vpos
= -1;
12967 overlay_arrow_seen
= 0;
12968 it
.vpos
= this_line_vpos
;
12969 it
.current_y
= this_line_y
;
12970 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12971 display_line (&it
);
12973 /* If line contains point, is not continued,
12974 and ends at same distance from eob as before, we win. */
12975 if (w
->cursor
.vpos
>= 0
12976 /* Line is not continued, otherwise this_line_start_pos
12977 would have been set to 0 in display_line. */
12978 && CHARPOS (this_line_start_pos
)
12979 /* Line ends as before. */
12980 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12981 /* Line has same height as before. Otherwise other lines
12982 would have to be shifted up or down. */
12983 && this_line_pixel_height
== line_height_before
)
12985 /* If this is not the window's last line, we must adjust
12986 the charstarts of the lines below. */
12987 if (it
.current_y
< it
.last_visible_y
)
12989 struct glyph_row
*row
12990 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12991 EMACS_INT delta
, delta_bytes
;
12993 /* We used to distinguish between two cases here,
12994 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12995 when the line ends in a newline or the end of the
12996 buffer's accessible portion. But both cases did
12997 the same, so they were collapsed. */
12999 - CHARPOS (tlendpos
)
13000 - MATRIX_ROW_START_CHARPOS (row
));
13001 delta_bytes
= (Z_BYTE
13002 - BYTEPOS (tlendpos
)
13003 - MATRIX_ROW_START_BYTEPOS (row
));
13005 increment_matrix_positions (w
->current_matrix
,
13006 this_line_vpos
+ 1,
13007 w
->current_matrix
->nrows
,
13008 delta
, delta_bytes
);
13011 /* If this row displays text now but previously didn't,
13012 or vice versa, w->window_end_vpos may have to be
13014 if ((it
.glyph_row
- 1)->displays_text_p
)
13016 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13017 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13019 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13020 && this_line_vpos
> 0)
13021 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13022 w
->window_end_valid
= Qnil
;
13024 /* Update hint: No need to try to scroll in update_window. */
13025 w
->desired_matrix
->no_scrolling_p
= 1;
13028 *w
->desired_matrix
->method
= 0;
13029 debug_method_add (w
, "optimization 1");
13031 #ifdef HAVE_WINDOW_SYSTEM
13032 update_window_fringes (w
, 0);
13039 else if (/* Cursor position hasn't changed. */
13040 PT
== XFASTINT (w
->last_point
)
13041 /* Make sure the cursor was last displayed
13042 in this window. Otherwise we have to reposition it. */
13043 && 0 <= w
->cursor
.vpos
13044 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13048 do_pending_window_change (1);
13049 /* If selected_window changed, redisplay again. */
13050 if (WINDOWP (selected_window
)
13051 && (w
= XWINDOW (selected_window
)) != sw
)
13054 /* We used to always goto end_of_redisplay here, but this
13055 isn't enough if we have a blinking cursor. */
13056 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13057 goto end_of_redisplay
;
13061 /* If highlighting the region, or if the cursor is in the echo area,
13062 then we can't just move the cursor. */
13063 else if (! (!NILP (Vtransient_mark_mode
)
13064 && !NILP (BVAR (current_buffer
, mark_active
)))
13065 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13066 || highlight_nonselected_windows
)
13067 && NILP (w
->region_showing
)
13068 && NILP (Vshow_trailing_whitespace
)
13069 && !cursor_in_echo_area
)
13072 struct glyph_row
*row
;
13074 /* Skip from tlbufpos to PT and see where it is. Note that
13075 PT may be in invisible text. If so, we will end at the
13076 next visible position. */
13077 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13078 NULL
, DEFAULT_FACE_ID
);
13079 it
.current_x
= this_line_start_x
;
13080 it
.current_y
= this_line_y
;
13081 it
.vpos
= this_line_vpos
;
13083 /* The call to move_it_to stops in front of PT, but
13084 moves over before-strings. */
13085 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13087 if (it
.vpos
== this_line_vpos
13088 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13091 xassert (this_line_vpos
== it
.vpos
);
13092 xassert (this_line_y
== it
.current_y
);
13093 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13095 *w
->desired_matrix
->method
= 0;
13096 debug_method_add (w
, "optimization 3");
13105 /* Text changed drastically or point moved off of line. */
13106 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13109 CHARPOS (this_line_start_pos
) = 0;
13110 consider_all_windows_p
|= buffer_shared
> 1;
13111 ++clear_face_cache_count
;
13112 #ifdef HAVE_WINDOW_SYSTEM
13113 ++clear_image_cache_count
;
13116 /* Build desired matrices, and update the display. If
13117 consider_all_windows_p is non-zero, do it for all windows on all
13118 frames. Otherwise do it for selected_window, only. */
13120 if (consider_all_windows_p
)
13122 Lisp_Object tail
, frame
;
13124 FOR_EACH_FRAME (tail
, frame
)
13125 XFRAME (frame
)->updated_p
= 0;
13127 /* Recompute # windows showing selected buffer. This will be
13128 incremented each time such a window is displayed. */
13131 FOR_EACH_FRAME (tail
, frame
)
13133 struct frame
*f
= XFRAME (frame
);
13135 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13137 if (! EQ (frame
, selected_frame
))
13138 /* Select the frame, for the sake of frame-local
13140 select_frame_for_redisplay (frame
);
13142 /* Mark all the scroll bars to be removed; we'll redeem
13143 the ones we want when we redisplay their windows. */
13144 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13145 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13147 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13148 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13150 /* The X error handler may have deleted that frame. */
13151 if (!FRAME_LIVE_P (f
))
13154 /* Any scroll bars which redisplay_windows should have
13155 nuked should now go away. */
13156 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13157 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13159 /* If fonts changed, display again. */
13160 /* ??? rms: I suspect it is a mistake to jump all the way
13161 back to retry here. It should just retry this frame. */
13162 if (fonts_changed_p
)
13165 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13167 /* See if we have to hscroll. */
13168 if (!f
->already_hscrolled_p
)
13170 f
->already_hscrolled_p
= 1;
13171 if (hscroll_windows (f
->root_window
))
13175 /* Prevent various kinds of signals during display
13176 update. stdio is not robust about handling
13177 signals, which can cause an apparent I/O
13179 if (interrupt_input
)
13180 unrequest_sigio ();
13183 /* Update the display. */
13184 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13185 pending
|= update_frame (f
, 0, 0);
13191 if (!EQ (old_frame
, selected_frame
)
13192 && FRAME_LIVE_P (XFRAME (old_frame
)))
13193 /* We played a bit fast-and-loose above and allowed selected_frame
13194 and selected_window to be temporarily out-of-sync but let's make
13195 sure this stays contained. */
13196 select_frame_for_redisplay (old_frame
);
13197 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13201 /* Do the mark_window_display_accurate after all windows have
13202 been redisplayed because this call resets flags in buffers
13203 which are needed for proper redisplay. */
13204 FOR_EACH_FRAME (tail
, frame
)
13206 struct frame
*f
= XFRAME (frame
);
13209 mark_window_display_accurate (f
->root_window
, 1);
13210 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13211 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13216 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13218 Lisp_Object mini_window
;
13219 struct frame
*mini_frame
;
13221 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13222 /* Use list_of_error, not Qerror, so that
13223 we catch only errors and don't run the debugger. */
13224 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13226 redisplay_window_error
);
13228 /* Compare desired and current matrices, perform output. */
13231 /* If fonts changed, display again. */
13232 if (fonts_changed_p
)
13235 /* Prevent various kinds of signals during display update.
13236 stdio is not robust about handling signals,
13237 which can cause an apparent I/O error. */
13238 if (interrupt_input
)
13239 unrequest_sigio ();
13242 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13244 if (hscroll_windows (selected_window
))
13247 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13248 pending
= update_frame (sf
, 0, 0);
13251 /* We may have called echo_area_display at the top of this
13252 function. If the echo area is on another frame, that may
13253 have put text on a frame other than the selected one, so the
13254 above call to update_frame would not have caught it. Catch
13256 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13257 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13259 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13261 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13262 pending
|= update_frame (mini_frame
, 0, 0);
13263 if (!pending
&& hscroll_windows (mini_window
))
13268 /* If display was paused because of pending input, make sure we do a
13269 thorough update the next time. */
13272 /* Prevent the optimization at the beginning of
13273 redisplay_internal that tries a single-line update of the
13274 line containing the cursor in the selected window. */
13275 CHARPOS (this_line_start_pos
) = 0;
13277 /* Let the overlay arrow be updated the next time. */
13278 update_overlay_arrows (0);
13280 /* If we pause after scrolling, some rows in the current
13281 matrices of some windows are not valid. */
13282 if (!WINDOW_FULL_WIDTH_P (w
)
13283 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13284 update_mode_lines
= 1;
13288 if (!consider_all_windows_p
)
13290 /* This has already been done above if
13291 consider_all_windows_p is set. */
13292 mark_window_display_accurate_1 (w
, 1);
13294 /* Say overlay arrows are up to date. */
13295 update_overlay_arrows (1);
13297 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13298 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13301 update_mode_lines
= 0;
13302 windows_or_buffers_changed
= 0;
13303 cursor_type_changed
= 0;
13306 /* Start SIGIO interrupts coming again. Having them off during the
13307 code above makes it less likely one will discard output, but not
13308 impossible, since there might be stuff in the system buffer here.
13309 But it is much hairier to try to do anything about that. */
13310 if (interrupt_input
)
13314 /* If a frame has become visible which was not before, redisplay
13315 again, so that we display it. Expose events for such a frame
13316 (which it gets when becoming visible) don't call the parts of
13317 redisplay constructing glyphs, so simply exposing a frame won't
13318 display anything in this case. So, we have to display these
13319 frames here explicitly. */
13322 Lisp_Object tail
, frame
;
13325 FOR_EACH_FRAME (tail
, frame
)
13327 int this_is_visible
= 0;
13329 if (XFRAME (frame
)->visible
)
13330 this_is_visible
= 1;
13331 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13332 if (XFRAME (frame
)->visible
)
13333 this_is_visible
= 1;
13335 if (this_is_visible
)
13339 if (new_count
!= number_of_visible_frames
)
13340 windows_or_buffers_changed
++;
13343 /* Change frame size now if a change is pending. */
13344 do_pending_window_change (1);
13346 /* If we just did a pending size change, or have additional
13347 visible frames, or selected_window changed, redisplay again. */
13348 if ((windows_or_buffers_changed
&& !pending
)
13349 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13352 /* Clear the face and image caches.
13354 We used to do this only if consider_all_windows_p. But the cache
13355 needs to be cleared if a timer creates images in the current
13356 buffer (e.g. the test case in Bug#6230). */
13358 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13360 clear_face_cache (0);
13361 clear_face_cache_count
= 0;
13364 #ifdef HAVE_WINDOW_SYSTEM
13365 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13367 clear_image_caches (Qnil
);
13368 clear_image_cache_count
= 0;
13370 #endif /* HAVE_WINDOW_SYSTEM */
13373 unbind_to (count
, Qnil
);
13378 /* Redisplay, but leave alone any recent echo area message unless
13379 another message has been requested in its place.
13381 This is useful in situations where you need to redisplay but no
13382 user action has occurred, making it inappropriate for the message
13383 area to be cleared. See tracking_off and
13384 wait_reading_process_output for examples of these situations.
13386 FROM_WHERE is an integer saying from where this function was
13387 called. This is useful for debugging. */
13390 redisplay_preserve_echo_area (int from_where
)
13392 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13394 if (!NILP (echo_area_buffer
[1]))
13396 /* We have a previously displayed message, but no current
13397 message. Redisplay the previous message. */
13398 display_last_displayed_message_p
= 1;
13399 redisplay_internal ();
13400 display_last_displayed_message_p
= 0;
13403 redisplay_internal ();
13405 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13406 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13407 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13411 /* Function registered with record_unwind_protect in
13412 redisplay_internal. Reset redisplaying_p to the value it had
13413 before redisplay_internal was called, and clear
13414 prevent_freeing_realized_faces_p. It also selects the previously
13415 selected frame, unless it has been deleted (by an X connection
13416 failure during redisplay, for example). */
13419 unwind_redisplay (Lisp_Object val
)
13421 Lisp_Object old_redisplaying_p
, old_frame
;
13423 old_redisplaying_p
= XCAR (val
);
13424 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13425 old_frame
= XCDR (val
);
13426 if (! EQ (old_frame
, selected_frame
)
13427 && FRAME_LIVE_P (XFRAME (old_frame
)))
13428 select_frame_for_redisplay (old_frame
);
13433 /* Mark the display of window W as accurate or inaccurate. If
13434 ACCURATE_P is non-zero mark display of W as accurate. If
13435 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13436 redisplay_internal is called. */
13439 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13441 if (BUFFERP (w
->buffer
))
13443 struct buffer
*b
= XBUFFER (w
->buffer
);
13446 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13447 w
->last_overlay_modified
13448 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13450 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13454 b
->clip_changed
= 0;
13455 b
->prevent_redisplay_optimizations_p
= 0;
13457 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13458 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13459 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13460 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13462 w
->current_matrix
->buffer
= b
;
13463 w
->current_matrix
->begv
= BUF_BEGV (b
);
13464 w
->current_matrix
->zv
= BUF_ZV (b
);
13466 w
->last_cursor
= w
->cursor
;
13467 w
->last_cursor_off_p
= w
->cursor_off_p
;
13469 if (w
== XWINDOW (selected_window
))
13470 w
->last_point
= make_number (BUF_PT (b
));
13472 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13478 w
->window_end_valid
= w
->buffer
;
13479 w
->update_mode_line
= Qnil
;
13484 /* Mark the display of windows in the window tree rooted at WINDOW as
13485 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13486 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13487 be redisplayed the next time redisplay_internal is called. */
13490 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13494 for (; !NILP (window
); window
= w
->next
)
13496 w
= XWINDOW (window
);
13497 mark_window_display_accurate_1 (w
, accurate_p
);
13499 if (!NILP (w
->vchild
))
13500 mark_window_display_accurate (w
->vchild
, accurate_p
);
13501 if (!NILP (w
->hchild
))
13502 mark_window_display_accurate (w
->hchild
, accurate_p
);
13507 update_overlay_arrows (1);
13511 /* Force a thorough redisplay the next time by setting
13512 last_arrow_position and last_arrow_string to t, which is
13513 unequal to any useful value of Voverlay_arrow_... */
13514 update_overlay_arrows (-1);
13519 /* Return value in display table DP (Lisp_Char_Table *) for character
13520 C. Since a display table doesn't have any parent, we don't have to
13521 follow parent. Do not call this function directly but use the
13522 macro DISP_CHAR_VECTOR. */
13525 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13529 if (ASCII_CHAR_P (c
))
13532 if (SUB_CHAR_TABLE_P (val
))
13533 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13539 XSETCHAR_TABLE (table
, dp
);
13540 val
= char_table_ref (table
, c
);
13549 /***********************************************************************
13551 ***********************************************************************/
13553 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13556 redisplay_windows (Lisp_Object window
)
13558 while (!NILP (window
))
13560 struct window
*w
= XWINDOW (window
);
13562 if (!NILP (w
->hchild
))
13563 redisplay_windows (w
->hchild
);
13564 else if (!NILP (w
->vchild
))
13565 redisplay_windows (w
->vchild
);
13566 else if (!NILP (w
->buffer
))
13568 displayed_buffer
= XBUFFER (w
->buffer
);
13569 /* Use list_of_error, not Qerror, so that
13570 we catch only errors and don't run the debugger. */
13571 internal_condition_case_1 (redisplay_window_0
, window
,
13573 redisplay_window_error
);
13581 redisplay_window_error (Lisp_Object ignore
)
13583 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13588 redisplay_window_0 (Lisp_Object window
)
13590 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13591 redisplay_window (window
, 0);
13596 redisplay_window_1 (Lisp_Object window
)
13598 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13599 redisplay_window (window
, 1);
13604 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13605 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13606 which positions recorded in ROW differ from current buffer
13609 Return 0 if cursor is not on this row, 1 otherwise. */
13612 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13613 struct glyph_matrix
*matrix
,
13614 EMACS_INT delta
, EMACS_INT delta_bytes
,
13617 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13618 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13619 struct glyph
*cursor
= NULL
;
13620 /* The last known character position in row. */
13621 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13623 EMACS_INT pt_old
= PT
- delta
;
13624 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13625 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13626 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13627 /* A glyph beyond the edge of TEXT_AREA which we should never
13629 struct glyph
*glyphs_end
= end
;
13630 /* Non-zero means we've found a match for cursor position, but that
13631 glyph has the avoid_cursor_p flag set. */
13632 int match_with_avoid_cursor
= 0;
13633 /* Non-zero means we've seen at least one glyph that came from a
13635 int string_seen
= 0;
13636 /* Largest and smalles buffer positions seen so far during scan of
13638 EMACS_INT bpos_max
= pos_before
;
13639 EMACS_INT bpos_min
= pos_after
;
13640 /* Last buffer position covered by an overlay string with an integer
13641 `cursor' property. */
13642 EMACS_INT bpos_covered
= 0;
13643 /* Non-zero means the display string on which to display the cursor
13644 comes from a text property, not from an overlay. */
13645 int string_from_text_prop
= 0;
13647 /* Skip over glyphs not having an object at the start and the end of
13648 the row. These are special glyphs like truncation marks on
13649 terminal frames. */
13650 if (row
->displays_text_p
)
13652 if (!row
->reversed_p
)
13655 && INTEGERP (glyph
->object
)
13656 && glyph
->charpos
< 0)
13658 x
+= glyph
->pixel_width
;
13662 && INTEGERP ((end
- 1)->object
)
13663 /* CHARPOS is zero for blanks and stretch glyphs
13664 inserted by extend_face_to_end_of_line. */
13665 && (end
- 1)->charpos
<= 0)
13667 glyph_before
= glyph
- 1;
13674 /* If the glyph row is reversed, we need to process it from back
13675 to front, so swap the edge pointers. */
13676 glyphs_end
= end
= glyph
- 1;
13677 glyph
+= row
->used
[TEXT_AREA
] - 1;
13679 while (glyph
> end
+ 1
13680 && INTEGERP (glyph
->object
)
13681 && glyph
->charpos
< 0)
13684 x
-= glyph
->pixel_width
;
13686 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13688 /* By default, in reversed rows we put the cursor on the
13689 rightmost (first in the reading order) glyph. */
13690 for (g
= end
+ 1; g
< glyph
; g
++)
13691 x
+= g
->pixel_width
;
13693 && INTEGERP ((end
+ 1)->object
)
13694 && (end
+ 1)->charpos
<= 0)
13696 glyph_before
= glyph
+ 1;
13700 else if (row
->reversed_p
)
13702 /* In R2L rows that don't display text, put the cursor on the
13703 rightmost glyph. Case in point: an empty last line that is
13704 part of an R2L paragraph. */
13706 /* Avoid placing the cursor on the last glyph of the row, where
13707 on terminal frames we hold the vertical border between
13708 adjacent windows. */
13709 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13710 && !WINDOW_RIGHTMOST_P (w
)
13711 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13713 x
= -1; /* will be computed below, at label compute_x */
13716 /* Step 1: Try to find the glyph whose character position
13717 corresponds to point. If that's not possible, find 2 glyphs
13718 whose character positions are the closest to point, one before
13719 point, the other after it. */
13720 if (!row
->reversed_p
)
13721 while (/* not marched to end of glyph row */
13723 /* glyph was not inserted by redisplay for internal purposes */
13724 && !INTEGERP (glyph
->object
))
13726 if (BUFFERP (glyph
->object
))
13728 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13730 if (glyph
->charpos
> bpos_max
)
13731 bpos_max
= glyph
->charpos
;
13732 if (glyph
->charpos
< bpos_min
)
13733 bpos_min
= glyph
->charpos
;
13734 if (!glyph
->avoid_cursor_p
)
13736 /* If we hit point, we've found the glyph on which to
13737 display the cursor. */
13740 match_with_avoid_cursor
= 0;
13743 /* See if we've found a better approximation to
13744 POS_BEFORE or to POS_AFTER. Note that we want the
13745 first (leftmost) glyph of all those that are the
13746 closest from below, and the last (rightmost) of all
13747 those from above. */
13748 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13750 pos_before
= glyph
->charpos
;
13751 glyph_before
= glyph
;
13753 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13755 pos_after
= glyph
->charpos
;
13756 glyph_after
= glyph
;
13759 else if (dpos
== 0)
13760 match_with_avoid_cursor
= 1;
13762 else if (STRINGP (glyph
->object
))
13764 Lisp_Object chprop
;
13765 EMACS_INT glyph_pos
= glyph
->charpos
;
13767 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13769 if (INTEGERP (chprop
))
13771 bpos_covered
= bpos_max
+ XINT (chprop
);
13772 /* If the `cursor' property covers buffer positions up
13773 to and including point, we should display cursor on
13774 this glyph. Note that overlays and text properties
13775 with string values stop bidi reordering, so every
13776 buffer position to the left of the string is always
13777 smaller than any position to the right of the
13778 string. Therefore, if a `cursor' property on one
13779 of the string's characters has an integer value, we
13780 will break out of the loop below _before_ we get to
13781 the position match above. IOW, integer values of
13782 the `cursor' property override the "exact match for
13783 point" strategy of positioning the cursor. */
13784 /* Implementation note: bpos_max == pt_old when, e.g.,
13785 we are in an empty line, where bpos_max is set to
13786 MATRIX_ROW_START_CHARPOS, see above. */
13787 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13796 x
+= glyph
->pixel_width
;
13799 else if (glyph
> end
) /* row is reversed */
13800 while (!INTEGERP (glyph
->object
))
13802 if (BUFFERP (glyph
->object
))
13804 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13806 if (glyph
->charpos
> bpos_max
)
13807 bpos_max
= glyph
->charpos
;
13808 if (glyph
->charpos
< bpos_min
)
13809 bpos_min
= glyph
->charpos
;
13810 if (!glyph
->avoid_cursor_p
)
13814 match_with_avoid_cursor
= 0;
13817 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13819 pos_before
= glyph
->charpos
;
13820 glyph_before
= glyph
;
13822 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13824 pos_after
= glyph
->charpos
;
13825 glyph_after
= glyph
;
13828 else if (dpos
== 0)
13829 match_with_avoid_cursor
= 1;
13831 else if (STRINGP (glyph
->object
))
13833 Lisp_Object chprop
;
13834 EMACS_INT glyph_pos
= glyph
->charpos
;
13836 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13838 if (INTEGERP (chprop
))
13840 bpos_covered
= bpos_max
+ XINT (chprop
);
13841 /* If the `cursor' property covers buffer positions up
13842 to and including point, we should display cursor on
13844 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13853 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13855 x
--; /* can't use any pixel_width */
13858 x
-= glyph
->pixel_width
;
13861 /* Step 2: If we didn't find an exact match for point, we need to
13862 look for a proper place to put the cursor among glyphs between
13863 GLYPH_BEFORE and GLYPH_AFTER. */
13864 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13865 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13866 && bpos_covered
< pt_old
)
13868 /* An empty line has a single glyph whose OBJECT is zero and
13869 whose CHARPOS is the position of a newline on that line.
13870 Note that on a TTY, there are more glyphs after that, which
13871 were produced by extend_face_to_end_of_line, but their
13872 CHARPOS is zero or negative. */
13874 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13875 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13877 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13879 EMACS_INT ellipsis_pos
;
13881 /* Scan back over the ellipsis glyphs. */
13882 if (!row
->reversed_p
)
13884 ellipsis_pos
= (glyph
- 1)->charpos
;
13885 while (glyph
> row
->glyphs
[TEXT_AREA
]
13886 && (glyph
- 1)->charpos
== ellipsis_pos
)
13887 glyph
--, x
-= glyph
->pixel_width
;
13888 /* That loop always goes one position too far, including
13889 the glyph before the ellipsis. So scan forward over
13891 x
+= glyph
->pixel_width
;
13894 else /* row is reversed */
13896 ellipsis_pos
= (glyph
+ 1)->charpos
;
13897 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13898 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13899 glyph
++, x
+= glyph
->pixel_width
;
13900 x
-= glyph
->pixel_width
;
13904 else if (match_with_avoid_cursor
)
13906 cursor
= glyph_after
;
13909 else if (string_seen
)
13911 int incr
= row
->reversed_p
? -1 : +1;
13913 /* Need to find the glyph that came out of a string which is
13914 present at point. That glyph is somewhere between
13915 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13916 positioned between POS_BEFORE and POS_AFTER in the
13918 struct glyph
*start
, *stop
;
13919 EMACS_INT pos
= pos_before
;
13923 /* If the row ends in a newline from a display string,
13924 reordering could have moved the glyphs belonging to the
13925 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13926 in this case we extend the search to the last glyph in
13927 the row that was not inserted by redisplay. */
13928 if (row
->ends_in_newline_from_string_p
)
13931 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13934 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13935 correspond to POS_BEFORE and POS_AFTER, respectively. We
13936 need START and STOP in the order that corresponds to the
13937 row's direction as given by its reversed_p flag. If the
13938 directionality of characters between POS_BEFORE and
13939 POS_AFTER is the opposite of the row's base direction,
13940 these characters will have been reordered for display,
13941 and we need to reverse START and STOP. */
13942 if (!row
->reversed_p
)
13944 start
= min (glyph_before
, glyph_after
);
13945 stop
= max (glyph_before
, glyph_after
);
13949 start
= max (glyph_before
, glyph_after
);
13950 stop
= min (glyph_before
, glyph_after
);
13952 for (glyph
= start
+ incr
;
13953 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13956 /* Any glyphs that come from the buffer are here because
13957 of bidi reordering. Skip them, and only pay
13958 attention to glyphs that came from some string. */
13959 if (STRINGP (glyph
->object
))
13963 /* If the display property covers the newline, we
13964 need to search for it one position farther. */
13965 EMACS_INT lim
= pos_after
13966 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13968 string_from_text_prop
= 0;
13969 str
= glyph
->object
;
13970 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13971 if (tem
== 0 /* from overlay */
13974 /* If the string from which this glyph came is
13975 found in the buffer at point, then we've
13976 found the glyph we've been looking for. If
13977 it comes from an overlay (tem == 0), and it
13978 has the `cursor' property on one of its
13979 glyphs, record that glyph as a candidate for
13980 displaying the cursor. (As in the
13981 unidirectional version, we will display the
13982 cursor on the last candidate we find.) */
13983 if (tem
== 0 || tem
== pt_old
)
13985 /* The glyphs from this string could have
13986 been reordered. Find the one with the
13987 smallest string position. Or there could
13988 be a character in the string with the
13989 `cursor' property, which means display
13990 cursor on that character's glyph. */
13991 EMACS_INT strpos
= glyph
->charpos
;
13996 string_from_text_prop
= 1;
13999 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14000 && EQ (glyph
->object
, str
);
14004 EMACS_INT gpos
= glyph
->charpos
;
14006 cprop
= Fget_char_property (make_number (gpos
),
14014 if (tem
&& glyph
->charpos
< strpos
)
14016 strpos
= glyph
->charpos
;
14025 pos
= tem
+ 1; /* don't find previous instances */
14027 /* This string is not what we want; skip all of the
14028 glyphs that came from it. */
14029 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14030 && EQ (glyph
->object
, str
))
14037 /* If we reached the end of the line, and END was from a string,
14038 the cursor is not on this line. */
14040 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14041 && STRINGP (end
->object
)
14042 && row
->continued_p
)
14045 /* A truncated row may not include PT among its character positions.
14046 Setting the cursor inside the scroll margin will trigger
14047 recalculation of hscroll in hscroll_window_tree. But if a
14048 display string covers point, defer to the string-handling
14049 code below to figure this out. */
14050 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14052 cursor
= glyph_before
;
14055 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14056 /* Zero-width characters produce no glyphs. */
14058 && (row
->reversed_p
14059 ? glyph_after
> glyphs_end
14060 : glyph_after
< glyphs_end
)))
14062 cursor
= glyph_after
;
14068 if (cursor
!= NULL
)
14074 /* Need to compute x that corresponds to GLYPH. */
14075 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14077 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14079 x
+= g
->pixel_width
;
14083 /* ROW could be part of a continued line, which, under bidi
14084 reordering, might have other rows whose start and end charpos
14085 occlude point. Only set w->cursor if we found a better
14086 approximation to the cursor position than we have from previously
14087 examined candidate rows belonging to the same continued line. */
14088 if (/* we already have a candidate row */
14089 w
->cursor
.vpos
>= 0
14090 /* that candidate is not the row we are processing */
14091 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14092 /* Make sure cursor.vpos specifies a row whose start and end
14093 charpos occlude point, and it is valid candidate for being a
14094 cursor-row. This is because some callers of this function
14095 leave cursor.vpos at the row where the cursor was displayed
14096 during the last redisplay cycle. */
14097 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14098 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14099 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14102 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14104 /* Don't consider glyphs that are outside TEXT_AREA. */
14105 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14107 /* Keep the candidate whose buffer position is the closest to
14108 point or has the `cursor' property. */
14109 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14110 w
->cursor
.hpos
>= 0
14111 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14112 && ((BUFFERP (g1
->object
)
14113 && (g1
->charpos
== pt_old
/* an exact match always wins */
14114 || (BUFFERP (glyph
->object
)
14115 && eabs (g1
->charpos
- pt_old
)
14116 < eabs (glyph
->charpos
- pt_old
))))
14117 /* previous candidate is a glyph from a string that has
14118 a non-nil `cursor' property */
14119 || (STRINGP (g1
->object
)
14120 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14121 Qcursor
, g1
->object
))
14122 /* previous candidate is from the same display
14123 string as this one, and the display string
14124 came from a text property */
14125 || (EQ (g1
->object
, glyph
->object
)
14126 && string_from_text_prop
)
14127 /* this candidate is from newline and its
14128 position is not an exact match */
14129 || (INTEGERP (glyph
->object
)
14130 && glyph
->charpos
!= pt_old
)))))
14132 /* If this candidate gives an exact match, use that. */
14133 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14134 /* If this candidate is a glyph created for the
14135 terminating newline of a line, and point is on that
14136 newline, it wins because it's an exact match. */
14137 || (!row
->continued_p
14138 && INTEGERP (glyph
->object
)
14139 && glyph
->charpos
== 0
14140 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14141 /* Otherwise, keep the candidate that comes from a row
14142 spanning less buffer positions. This may win when one or
14143 both candidate positions are on glyphs that came from
14144 display strings, for which we cannot compare buffer
14146 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14147 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14148 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14151 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14153 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14154 w
->cursor
.y
= row
->y
+ dy
;
14156 if (w
== XWINDOW (selected_window
))
14158 if (!row
->continued_p
14159 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14162 this_line_buffer
= XBUFFER (w
->buffer
);
14164 CHARPOS (this_line_start_pos
)
14165 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14166 BYTEPOS (this_line_start_pos
)
14167 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14169 CHARPOS (this_line_end_pos
)
14170 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14171 BYTEPOS (this_line_end_pos
)
14172 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14174 this_line_y
= w
->cursor
.y
;
14175 this_line_pixel_height
= row
->height
;
14176 this_line_vpos
= w
->cursor
.vpos
;
14177 this_line_start_x
= row
->x
;
14180 CHARPOS (this_line_start_pos
) = 0;
14187 /* Run window scroll functions, if any, for WINDOW with new window
14188 start STARTP. Sets the window start of WINDOW to that position.
14190 We assume that the window's buffer is really current. */
14192 static inline struct text_pos
14193 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14195 struct window
*w
= XWINDOW (window
);
14196 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14198 if (current_buffer
!= XBUFFER (w
->buffer
))
14201 if (!NILP (Vwindow_scroll_functions
))
14203 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14204 make_number (CHARPOS (startp
)));
14205 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14206 /* In case the hook functions switch buffers. */
14207 if (current_buffer
!= XBUFFER (w
->buffer
))
14208 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14215 /* Make sure the line containing the cursor is fully visible.
14216 A value of 1 means there is nothing to be done.
14217 (Either the line is fully visible, or it cannot be made so,
14218 or we cannot tell.)
14220 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14221 is higher than window.
14223 A value of 0 means the caller should do scrolling
14224 as if point had gone off the screen. */
14227 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14229 struct glyph_matrix
*matrix
;
14230 struct glyph_row
*row
;
14233 if (!make_cursor_line_fully_visible_p
)
14236 /* It's not always possible to find the cursor, e.g, when a window
14237 is full of overlay strings. Don't do anything in that case. */
14238 if (w
->cursor
.vpos
< 0)
14241 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14242 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14244 /* If the cursor row is not partially visible, there's nothing to do. */
14245 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14248 /* If the row the cursor is in is taller than the window's height,
14249 it's not clear what to do, so do nothing. */
14250 window_height
= window_box_height (w
);
14251 if (row
->height
>= window_height
)
14253 if (!force_p
|| MINI_WINDOW_P (w
)
14254 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14261 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14262 non-zero means only WINDOW is redisplayed in redisplay_internal.
14263 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14264 in redisplay_window to bring a partially visible line into view in
14265 the case that only the cursor has moved.
14267 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14268 last screen line's vertical height extends past the end of the screen.
14272 1 if scrolling succeeded
14274 0 if scrolling didn't find point.
14276 -1 if new fonts have been loaded so that we must interrupt
14277 redisplay, adjust glyph matrices, and try again. */
14283 SCROLLING_NEED_LARGER_MATRICES
14286 /* If scroll-conservatively is more than this, never recenter.
14288 If you change this, don't forget to update the doc string of
14289 `scroll-conservatively' and the Emacs manual. */
14290 #define SCROLL_LIMIT 100
14293 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14294 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14295 int temp_scroll_step
, int last_line_misfit
)
14297 struct window
*w
= XWINDOW (window
);
14298 struct frame
*f
= XFRAME (w
->frame
);
14299 struct text_pos pos
, startp
;
14301 int this_scroll_margin
, scroll_max
, rc
, height
;
14302 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14303 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14304 Lisp_Object aggressive
;
14305 /* We will never try scrolling more than this number of lines. */
14306 int scroll_limit
= SCROLL_LIMIT
;
14309 debug_method_add (w
, "try_scrolling");
14312 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14314 /* Compute scroll margin height in pixels. We scroll when point is
14315 within this distance from the top or bottom of the window. */
14316 if (scroll_margin
> 0)
14317 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14318 * FRAME_LINE_HEIGHT (f
);
14320 this_scroll_margin
= 0;
14322 /* Force arg_scroll_conservatively to have a reasonable value, to
14323 avoid scrolling too far away with slow move_it_* functions. Note
14324 that the user can supply scroll-conservatively equal to
14325 `most-positive-fixnum', which can be larger than INT_MAX. */
14326 if (arg_scroll_conservatively
> scroll_limit
)
14328 arg_scroll_conservatively
= scroll_limit
+ 1;
14329 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14331 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14332 /* Compute how much we should try to scroll maximally to bring
14333 point into view. */
14334 scroll_max
= (max (scroll_step
,
14335 max (arg_scroll_conservatively
, temp_scroll_step
))
14336 * FRAME_LINE_HEIGHT (f
));
14337 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14338 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14339 /* We're trying to scroll because of aggressive scrolling but no
14340 scroll_step is set. Choose an arbitrary one. */
14341 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14347 /* Decide whether to scroll down. */
14348 if (PT
> CHARPOS (startp
))
14350 int scroll_margin_y
;
14352 /* Compute the pixel ypos of the scroll margin, then move it to
14353 either that ypos or PT, whichever comes first. */
14354 start_display (&it
, w
, startp
);
14355 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14356 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14357 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14358 (MOVE_TO_POS
| MOVE_TO_Y
));
14360 if (PT
> CHARPOS (it
.current
.pos
))
14362 int y0
= line_bottom_y (&it
);
14363 /* Compute how many pixels below window bottom to stop searching
14364 for PT. This avoids costly search for PT that is far away if
14365 the user limited scrolling by a small number of lines, but
14366 always finds PT if scroll_conservatively is set to a large
14367 number, such as most-positive-fixnum. */
14368 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14369 int y_to_move
= it
.last_visible_y
+ slack
;
14371 /* Compute the distance from the scroll margin to PT or to
14372 the scroll limit, whichever comes first. This should
14373 include the height of the cursor line, to make that line
14375 move_it_to (&it
, PT
, -1, y_to_move
,
14376 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14377 dy
= line_bottom_y (&it
) - y0
;
14379 if (dy
> scroll_max
)
14380 return SCROLLING_FAILED
;
14388 /* Point is in or below the bottom scroll margin, so move the
14389 window start down. If scrolling conservatively, move it just
14390 enough down to make point visible. If scroll_step is set,
14391 move it down by scroll_step. */
14392 if (arg_scroll_conservatively
)
14394 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14395 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14396 else if (scroll_step
|| temp_scroll_step
)
14397 amount_to_scroll
= scroll_max
;
14400 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14401 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14402 if (NUMBERP (aggressive
))
14404 double float_amount
= XFLOATINT (aggressive
) * height
;
14405 amount_to_scroll
= float_amount
;
14406 if (amount_to_scroll
== 0 && float_amount
> 0)
14407 amount_to_scroll
= 1;
14408 /* Don't let point enter the scroll margin near top of
14410 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14411 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14415 if (amount_to_scroll
<= 0)
14416 return SCROLLING_FAILED
;
14418 start_display (&it
, w
, startp
);
14419 if (arg_scroll_conservatively
<= scroll_limit
)
14420 move_it_vertically (&it
, amount_to_scroll
);
14423 /* Extra precision for users who set scroll-conservatively
14424 to a large number: make sure the amount we scroll
14425 the window start is never less than amount_to_scroll,
14426 which was computed as distance from window bottom to
14427 point. This matters when lines at window top and lines
14428 below window bottom have different height. */
14430 void *it1data
= NULL
;
14431 /* We use a temporary it1 because line_bottom_y can modify
14432 its argument, if it moves one line down; see there. */
14435 SAVE_IT (it1
, it
, it1data
);
14436 start_y
= line_bottom_y (&it1
);
14438 RESTORE_IT (&it
, &it
, it1data
);
14439 move_it_by_lines (&it
, 1);
14440 SAVE_IT (it1
, it
, it1data
);
14441 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14444 /* If STARTP is unchanged, move it down another screen line. */
14445 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14446 move_it_by_lines (&it
, 1);
14447 startp
= it
.current
.pos
;
14451 struct text_pos scroll_margin_pos
= startp
;
14453 /* See if point is inside the scroll margin at the top of the
14455 if (this_scroll_margin
)
14457 start_display (&it
, w
, startp
);
14458 move_it_vertically (&it
, this_scroll_margin
);
14459 scroll_margin_pos
= it
.current
.pos
;
14462 if (PT
< CHARPOS (scroll_margin_pos
))
14464 /* Point is in the scroll margin at the top of the window or
14465 above what is displayed in the window. */
14468 /* Compute the vertical distance from PT to the scroll
14469 margin position. Move as far as scroll_max allows, or
14470 one screenful, or 10 screen lines, whichever is largest.
14471 Give up if distance is greater than scroll_max. */
14472 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14473 start_display (&it
, w
, pos
);
14475 y_to_move
= max (it
.last_visible_y
,
14476 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14477 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14479 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14480 dy
= it
.current_y
- y0
;
14481 if (dy
> scroll_max
)
14482 return SCROLLING_FAILED
;
14484 /* Compute new window start. */
14485 start_display (&it
, w
, startp
);
14487 if (arg_scroll_conservatively
)
14488 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14489 max (scroll_step
, temp_scroll_step
));
14490 else if (scroll_step
|| temp_scroll_step
)
14491 amount_to_scroll
= scroll_max
;
14494 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14495 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14496 if (NUMBERP (aggressive
))
14498 double float_amount
= XFLOATINT (aggressive
) * height
;
14499 amount_to_scroll
= float_amount
;
14500 if (amount_to_scroll
== 0 && float_amount
> 0)
14501 amount_to_scroll
= 1;
14502 amount_to_scroll
-=
14503 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14504 /* Don't let point enter the scroll margin near
14505 bottom of the window. */
14506 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14507 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14511 if (amount_to_scroll
<= 0)
14512 return SCROLLING_FAILED
;
14514 move_it_vertically_backward (&it
, amount_to_scroll
);
14515 startp
= it
.current
.pos
;
14519 /* Run window scroll functions. */
14520 startp
= run_window_scroll_functions (window
, startp
);
14522 /* Display the window. Give up if new fonts are loaded, or if point
14524 if (!try_window (window
, startp
, 0))
14525 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14526 else if (w
->cursor
.vpos
< 0)
14528 clear_glyph_matrix (w
->desired_matrix
);
14529 rc
= SCROLLING_FAILED
;
14533 /* Maybe forget recorded base line for line number display. */
14534 if (!just_this_one_p
14535 || current_buffer
->clip_changed
14536 || BEG_UNCHANGED
< CHARPOS (startp
))
14537 w
->base_line_number
= Qnil
;
14539 /* If cursor ends up on a partially visible line,
14540 treat that as being off the bottom of the screen. */
14541 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14542 /* It's possible that the cursor is on the first line of the
14543 buffer, which is partially obscured due to a vscroll
14544 (Bug#7537). In that case, avoid looping forever . */
14545 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14547 clear_glyph_matrix (w
->desired_matrix
);
14548 ++extra_scroll_margin_lines
;
14551 rc
= SCROLLING_SUCCESS
;
14558 /* Compute a suitable window start for window W if display of W starts
14559 on a continuation line. Value is non-zero if a new window start
14562 The new window start will be computed, based on W's width, starting
14563 from the start of the continued line. It is the start of the
14564 screen line with the minimum distance from the old start W->start. */
14567 compute_window_start_on_continuation_line (struct window
*w
)
14569 struct text_pos pos
, start_pos
;
14570 int window_start_changed_p
= 0;
14572 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14574 /* If window start is on a continuation line... Window start may be
14575 < BEGV in case there's invisible text at the start of the
14576 buffer (M-x rmail, for example). */
14577 if (CHARPOS (start_pos
) > BEGV
14578 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14581 struct glyph_row
*row
;
14583 /* Handle the case that the window start is out of range. */
14584 if (CHARPOS (start_pos
) < BEGV
)
14585 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14586 else if (CHARPOS (start_pos
) > ZV
)
14587 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14589 /* Find the start of the continued line. This should be fast
14590 because scan_buffer is fast (newline cache). */
14591 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14592 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14593 row
, DEFAULT_FACE_ID
);
14594 reseat_at_previous_visible_line_start (&it
);
14596 /* If the line start is "too far" away from the window start,
14597 say it takes too much time to compute a new window start. */
14598 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14599 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14601 int min_distance
, distance
;
14603 /* Move forward by display lines to find the new window
14604 start. If window width was enlarged, the new start can
14605 be expected to be > the old start. If window width was
14606 decreased, the new window start will be < the old start.
14607 So, we're looking for the display line start with the
14608 minimum distance from the old window start. */
14609 pos
= it
.current
.pos
;
14610 min_distance
= INFINITY
;
14611 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14612 distance
< min_distance
)
14614 min_distance
= distance
;
14615 pos
= it
.current
.pos
;
14616 move_it_by_lines (&it
, 1);
14619 /* Set the window start there. */
14620 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14621 window_start_changed_p
= 1;
14625 return window_start_changed_p
;
14629 /* Try cursor movement in case text has not changed in window WINDOW,
14630 with window start STARTP. Value is
14632 CURSOR_MOVEMENT_SUCCESS if successful
14634 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14636 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14637 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14638 we want to scroll as if scroll-step were set to 1. See the code.
14640 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14641 which case we have to abort this redisplay, and adjust matrices
14646 CURSOR_MOVEMENT_SUCCESS
,
14647 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14648 CURSOR_MOVEMENT_MUST_SCROLL
,
14649 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14653 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14655 struct window
*w
= XWINDOW (window
);
14656 struct frame
*f
= XFRAME (w
->frame
);
14657 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14660 if (inhibit_try_cursor_movement
)
14664 /* Handle case where text has not changed, only point, and it has
14665 not moved off the frame. */
14666 if (/* Point may be in this window. */
14667 PT
>= CHARPOS (startp
)
14668 /* Selective display hasn't changed. */
14669 && !current_buffer
->clip_changed
14670 /* Function force-mode-line-update is used to force a thorough
14671 redisplay. It sets either windows_or_buffers_changed or
14672 update_mode_lines. So don't take a shortcut here for these
14674 && !update_mode_lines
14675 && !windows_or_buffers_changed
14676 && !cursor_type_changed
14677 /* Can't use this case if highlighting a region. When a
14678 region exists, cursor movement has to do more than just
14680 && !(!NILP (Vtransient_mark_mode
)
14681 && !NILP (BVAR (current_buffer
, mark_active
)))
14682 && NILP (w
->region_showing
)
14683 && NILP (Vshow_trailing_whitespace
)
14684 /* Right after splitting windows, last_point may be nil. */
14685 && INTEGERP (w
->last_point
)
14686 /* This code is not used for mini-buffer for the sake of the case
14687 of redisplaying to replace an echo area message; since in
14688 that case the mini-buffer contents per se are usually
14689 unchanged. This code is of no real use in the mini-buffer
14690 since the handling of this_line_start_pos, etc., in redisplay
14691 handles the same cases. */
14692 && !EQ (window
, minibuf_window
)
14693 /* When splitting windows or for new windows, it happens that
14694 redisplay is called with a nil window_end_vpos or one being
14695 larger than the window. This should really be fixed in
14696 window.c. I don't have this on my list, now, so we do
14697 approximately the same as the old redisplay code. --gerd. */
14698 && INTEGERP (w
->window_end_vpos
)
14699 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14700 && (FRAME_WINDOW_P (f
)
14701 || !overlay_arrow_in_current_buffer_p ()))
14703 int this_scroll_margin
, top_scroll_margin
;
14704 struct glyph_row
*row
= NULL
;
14707 debug_method_add (w
, "cursor movement");
14710 /* Scroll if point within this distance from the top or bottom
14711 of the window. This is a pixel value. */
14712 if (scroll_margin
> 0)
14714 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14715 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14718 this_scroll_margin
= 0;
14720 top_scroll_margin
= this_scroll_margin
;
14721 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14722 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14724 /* Start with the row the cursor was displayed during the last
14725 not paused redisplay. Give up if that row is not valid. */
14726 if (w
->last_cursor
.vpos
< 0
14727 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14728 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14731 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14732 if (row
->mode_line_p
)
14734 if (!row
->enabled_p
)
14735 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14738 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14740 int scroll_p
= 0, must_scroll
= 0;
14741 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14743 if (PT
> XFASTINT (w
->last_point
))
14745 /* Point has moved forward. */
14746 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14747 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14749 xassert (row
->enabled_p
);
14753 /* If the end position of a row equals the start
14754 position of the next row, and PT is at that position,
14755 we would rather display cursor in the next line. */
14756 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14757 && MATRIX_ROW_END_CHARPOS (row
) == PT
14758 && row
< w
->current_matrix
->rows
14759 + w
->current_matrix
->nrows
- 1
14760 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14761 && !cursor_row_p (row
))
14764 /* If within the scroll margin, scroll. Note that
14765 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14766 the next line would be drawn, and that
14767 this_scroll_margin can be zero. */
14768 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14769 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14770 /* Line is completely visible last line in window
14771 and PT is to be set in the next line. */
14772 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14773 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14774 && !row
->ends_at_zv_p
14775 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14778 else if (PT
< XFASTINT (w
->last_point
))
14780 /* Cursor has to be moved backward. Note that PT >=
14781 CHARPOS (startp) because of the outer if-statement. */
14782 while (!row
->mode_line_p
14783 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14784 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14785 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14786 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14787 row
> w
->current_matrix
->rows
14788 && (row
-1)->ends_in_newline_from_string_p
))))
14789 && (row
->y
> top_scroll_margin
14790 || CHARPOS (startp
) == BEGV
))
14792 xassert (row
->enabled_p
);
14796 /* Consider the following case: Window starts at BEGV,
14797 there is invisible, intangible text at BEGV, so that
14798 display starts at some point START > BEGV. It can
14799 happen that we are called with PT somewhere between
14800 BEGV and START. Try to handle that case. */
14801 if (row
< w
->current_matrix
->rows
14802 || row
->mode_line_p
)
14804 row
= w
->current_matrix
->rows
;
14805 if (row
->mode_line_p
)
14809 /* Due to newlines in overlay strings, we may have to
14810 skip forward over overlay strings. */
14811 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14812 && MATRIX_ROW_END_CHARPOS (row
) == PT
14813 && !cursor_row_p (row
))
14816 /* If within the scroll margin, scroll. */
14817 if (row
->y
< top_scroll_margin
14818 && CHARPOS (startp
) != BEGV
)
14823 /* Cursor did not move. So don't scroll even if cursor line
14824 is partially visible, as it was so before. */
14825 rc
= CURSOR_MOVEMENT_SUCCESS
;
14828 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14829 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14831 /* if PT is not in the glyph row, give up. */
14832 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14835 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14836 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14838 /* If rows are bidi-reordered and point moved, back up
14839 until we find a row that does not belong to a
14840 continuation line. This is because we must consider
14841 all rows of a continued line as candidates for the
14842 new cursor positioning, since row start and end
14843 positions change non-linearly with vertical position
14845 /* FIXME: Revisit this when glyph ``spilling'' in
14846 continuation lines' rows is implemented for
14847 bidi-reordered rows. */
14848 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14850 /* If we hit the beginning of the displayed portion
14851 without finding the first row of a continued
14853 if (row
<= w
->current_matrix
->rows
)
14855 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14858 xassert (row
->enabled_p
);
14864 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14865 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14866 && make_cursor_line_fully_visible_p
)
14868 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14869 && !row
->ends_at_zv_p
14870 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14871 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14872 else if (row
->height
> window_box_height (w
))
14874 /* If we end up in a partially visible line, let's
14875 make it fully visible, except when it's taller
14876 than the window, in which case we can't do much
14879 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14883 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14884 if (!cursor_row_fully_visible_p (w
, 0, 1))
14885 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14887 rc
= CURSOR_MOVEMENT_SUCCESS
;
14891 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14892 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14893 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14895 /* With bidi-reordered rows, there could be more than
14896 one candidate row whose start and end positions
14897 occlude point. We need to let set_cursor_from_row
14898 find the best candidate. */
14899 /* FIXME: Revisit this when glyph ``spilling'' in
14900 continuation lines' rows is implemented for
14901 bidi-reordered rows. */
14906 int at_zv_p
= 0, exact_match_p
= 0;
14908 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14909 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14910 && cursor_row_p (row
))
14911 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14913 /* As soon as we've found the exact match for point,
14914 or the first suitable row whose ends_at_zv_p flag
14915 is set, we are done. */
14917 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14919 && w
->cursor
.hpos
>= 0
14920 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14923 struct glyph_row
*candidate
=
14924 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14926 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14927 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14930 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14931 || (INTEGERP (g
->object
)
14932 && (g
->charpos
== PT
14933 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14935 if (rv
&& (at_zv_p
|| exact_match_p
))
14937 rc
= CURSOR_MOVEMENT_SUCCESS
;
14940 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14944 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14945 || row
->continued_p
)
14946 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14947 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14948 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14949 /* If we didn't find any candidate rows, or exited the
14950 loop before all the candidates were examined, signal
14951 to the caller that this method failed. */
14952 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14954 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14955 && !row
->continued_p
))
14956 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14958 rc
= CURSOR_MOVEMENT_SUCCESS
;
14964 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14966 rc
= CURSOR_MOVEMENT_SUCCESS
;
14971 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14972 && MATRIX_ROW_START_CHARPOS (row
) == PT
14973 && cursor_row_p (row
));
14981 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14985 set_vertical_scroll_bar (struct window
*w
)
14987 EMACS_INT start
, end
, whole
;
14989 /* Calculate the start and end positions for the current window.
14990 At some point, it would be nice to choose between scrollbars
14991 which reflect the whole buffer size, with special markers
14992 indicating narrowing, and scrollbars which reflect only the
14995 Note that mini-buffers sometimes aren't displaying any text. */
14996 if (!MINI_WINDOW_P (w
)
14997 || (w
== XWINDOW (minibuf_window
)
14998 && NILP (echo_area_buffer
[0])))
15000 struct buffer
*buf
= XBUFFER (w
->buffer
);
15001 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15002 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15003 /* I don't think this is guaranteed to be right. For the
15004 moment, we'll pretend it is. */
15005 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15009 if (whole
< (end
- start
))
15010 whole
= end
- start
;
15013 start
= end
= whole
= 0;
15015 /* Indicate what this scroll bar ought to be displaying now. */
15016 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15017 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15018 (w
, end
- start
, whole
, start
);
15022 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15023 selected_window is redisplayed.
15025 We can return without actually redisplaying the window if
15026 fonts_changed_p is nonzero. In that case, redisplay_internal will
15030 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15032 struct window
*w
= XWINDOW (window
);
15033 struct frame
*f
= XFRAME (w
->frame
);
15034 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15035 struct buffer
*old
= current_buffer
;
15036 struct text_pos lpoint
, opoint
, startp
;
15037 int update_mode_line
;
15040 /* Record it now because it's overwritten. */
15041 int current_matrix_up_to_date_p
= 0;
15042 int used_current_matrix_p
= 0;
15043 /* This is less strict than current_matrix_up_to_date_p.
15044 It indicates that the buffer contents and narrowing are unchanged. */
15045 int buffer_unchanged_p
= 0;
15046 int temp_scroll_step
= 0;
15047 int count
= SPECPDL_INDEX ();
15049 int centering_position
= -1;
15050 int last_line_misfit
= 0;
15051 EMACS_INT beg_unchanged
, end_unchanged
;
15053 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15056 /* W must be a leaf window here. */
15057 xassert (!NILP (w
->buffer
));
15059 *w
->desired_matrix
->method
= 0;
15063 reconsider_clip_changes (w
, buffer
);
15065 /* Has the mode line to be updated? */
15066 update_mode_line
= (!NILP (w
->update_mode_line
)
15067 || update_mode_lines
15068 || buffer
->clip_changed
15069 || buffer
->prevent_redisplay_optimizations_p
);
15071 if (MINI_WINDOW_P (w
))
15073 if (w
== XWINDOW (echo_area_window
)
15074 && !NILP (echo_area_buffer
[0]))
15076 if (update_mode_line
)
15077 /* We may have to update a tty frame's menu bar or a
15078 tool-bar. Example `M-x C-h C-h C-g'. */
15079 goto finish_menu_bars
;
15081 /* We've already displayed the echo area glyphs in this window. */
15082 goto finish_scroll_bars
;
15084 else if ((w
!= XWINDOW (minibuf_window
)
15085 || minibuf_level
== 0)
15086 /* When buffer is nonempty, redisplay window normally. */
15087 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15088 /* Quail displays non-mini buffers in minibuffer window.
15089 In that case, redisplay the window normally. */
15090 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15092 /* W is a mini-buffer window, but it's not active, so clear
15094 int yb
= window_text_bottom_y (w
);
15095 struct glyph_row
*row
;
15098 for (y
= 0, row
= w
->desired_matrix
->rows
;
15100 y
+= row
->height
, ++row
)
15101 blank_row (w
, row
, y
);
15102 goto finish_scroll_bars
;
15105 clear_glyph_matrix (w
->desired_matrix
);
15108 /* Otherwise set up data on this window; select its buffer and point
15110 /* Really select the buffer, for the sake of buffer-local
15112 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15114 current_matrix_up_to_date_p
15115 = (!NILP (w
->window_end_valid
)
15116 && !current_buffer
->clip_changed
15117 && !current_buffer
->prevent_redisplay_optimizations_p
15118 && XFASTINT (w
->last_modified
) >= MODIFF
15119 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15121 /* Run the window-bottom-change-functions
15122 if it is possible that the text on the screen has changed
15123 (either due to modification of the text, or any other reason). */
15124 if (!current_matrix_up_to_date_p
15125 && !NILP (Vwindow_text_change_functions
))
15127 safe_run_hooks (Qwindow_text_change_functions
);
15131 beg_unchanged
= BEG_UNCHANGED
;
15132 end_unchanged
= END_UNCHANGED
;
15134 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15136 specbind (Qinhibit_point_motion_hooks
, Qt
);
15139 = (!NILP (w
->window_end_valid
)
15140 && !current_buffer
->clip_changed
15141 && XFASTINT (w
->last_modified
) >= MODIFF
15142 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15144 /* When windows_or_buffers_changed is non-zero, we can't rely on
15145 the window end being valid, so set it to nil there. */
15146 if (windows_or_buffers_changed
)
15148 /* If window starts on a continuation line, maybe adjust the
15149 window start in case the window's width changed. */
15150 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15151 compute_window_start_on_continuation_line (w
);
15153 w
->window_end_valid
= Qnil
;
15156 /* Some sanity checks. */
15157 CHECK_WINDOW_END (w
);
15158 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15160 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15163 /* If %c is in mode line, update it if needed. */
15164 if (!NILP (w
->column_number_displayed
)
15165 /* This alternative quickly identifies a common case
15166 where no change is needed. */
15167 && !(PT
== XFASTINT (w
->last_point
)
15168 && XFASTINT (w
->last_modified
) >= MODIFF
15169 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15170 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15171 update_mode_line
= 1;
15173 /* Count number of windows showing the selected buffer. An indirect
15174 buffer counts as its base buffer. */
15175 if (!just_this_one_p
)
15177 struct buffer
*current_base
, *window_base
;
15178 current_base
= current_buffer
;
15179 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15180 if (current_base
->base_buffer
)
15181 current_base
= current_base
->base_buffer
;
15182 if (window_base
->base_buffer
)
15183 window_base
= window_base
->base_buffer
;
15184 if (current_base
== window_base
)
15188 /* Point refers normally to the selected window. For any other
15189 window, set up appropriate value. */
15190 if (!EQ (window
, selected_window
))
15192 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15193 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15197 new_pt_byte
= BEGV_BYTE
;
15198 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15200 else if (new_pt
> (ZV
- 1))
15203 new_pt_byte
= ZV_BYTE
;
15204 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15207 /* We don't use SET_PT so that the point-motion hooks don't run. */
15208 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15211 /* If any of the character widths specified in the display table
15212 have changed, invalidate the width run cache. It's true that
15213 this may be a bit late to catch such changes, but the rest of
15214 redisplay goes (non-fatally) haywire when the display table is
15215 changed, so why should we worry about doing any better? */
15216 if (current_buffer
->width_run_cache
)
15218 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15220 if (! disptab_matches_widthtab (disptab
,
15221 XVECTOR (BVAR (current_buffer
, width_table
))))
15223 invalidate_region_cache (current_buffer
,
15224 current_buffer
->width_run_cache
,
15226 recompute_width_table (current_buffer
, disptab
);
15230 /* If window-start is screwed up, choose a new one. */
15231 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15234 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15236 /* If someone specified a new starting point but did not insist,
15237 check whether it can be used. */
15238 if (!NILP (w
->optional_new_start
)
15239 && CHARPOS (startp
) >= BEGV
15240 && CHARPOS (startp
) <= ZV
)
15242 w
->optional_new_start
= Qnil
;
15243 start_display (&it
, w
, startp
);
15244 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15245 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15246 if (IT_CHARPOS (it
) == PT
)
15247 w
->force_start
= Qt
;
15248 /* IT may overshoot PT if text at PT is invisible. */
15249 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15250 w
->force_start
= Qt
;
15255 /* Handle case where place to start displaying has been specified,
15256 unless the specified location is outside the accessible range. */
15257 if (!NILP (w
->force_start
)
15258 || w
->frozen_window_start_p
)
15260 /* We set this later on if we have to adjust point. */
15263 w
->force_start
= Qnil
;
15265 w
->window_end_valid
= Qnil
;
15267 /* Forget any recorded base line for line number display. */
15268 if (!buffer_unchanged_p
)
15269 w
->base_line_number
= Qnil
;
15271 /* Redisplay the mode line. Select the buffer properly for that.
15272 Also, run the hook window-scroll-functions
15273 because we have scrolled. */
15274 /* Note, we do this after clearing force_start because
15275 if there's an error, it is better to forget about force_start
15276 than to get into an infinite loop calling the hook functions
15277 and having them get more errors. */
15278 if (!update_mode_line
15279 || ! NILP (Vwindow_scroll_functions
))
15281 update_mode_line
= 1;
15282 w
->update_mode_line
= Qt
;
15283 startp
= run_window_scroll_functions (window
, startp
);
15286 w
->last_modified
= make_number (0);
15287 w
->last_overlay_modified
= make_number (0);
15288 if (CHARPOS (startp
) < BEGV
)
15289 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15290 else if (CHARPOS (startp
) > ZV
)
15291 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15293 /* Redisplay, then check if cursor has been set during the
15294 redisplay. Give up if new fonts were loaded. */
15295 /* We used to issue a CHECK_MARGINS argument to try_window here,
15296 but this causes scrolling to fail when point begins inside
15297 the scroll margin (bug#148) -- cyd */
15298 if (!try_window (window
, startp
, 0))
15300 w
->force_start
= Qt
;
15301 clear_glyph_matrix (w
->desired_matrix
);
15302 goto need_larger_matrices
;
15305 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15307 /* If point does not appear, try to move point so it does
15308 appear. The desired matrix has been built above, so we
15309 can use it here. */
15310 new_vpos
= window_box_height (w
) / 2;
15313 if (!cursor_row_fully_visible_p (w
, 0, 0))
15315 /* Point does appear, but on a line partly visible at end of window.
15316 Move it back to a fully-visible line. */
15317 new_vpos
= window_box_height (w
);
15320 /* If we need to move point for either of the above reasons,
15321 now actually do it. */
15324 struct glyph_row
*row
;
15326 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15327 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15330 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15331 MATRIX_ROW_START_BYTEPOS (row
));
15333 if (w
!= XWINDOW (selected_window
))
15334 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15335 else if (current_buffer
== old
)
15336 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15338 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15340 /* If we are highlighting the region, then we just changed
15341 the region, so redisplay to show it. */
15342 if (!NILP (Vtransient_mark_mode
)
15343 && !NILP (BVAR (current_buffer
, mark_active
)))
15345 clear_glyph_matrix (w
->desired_matrix
);
15346 if (!try_window (window
, startp
, 0))
15347 goto need_larger_matrices
;
15352 debug_method_add (w
, "forced window start");
15357 /* Handle case where text has not changed, only point, and it has
15358 not moved off the frame, and we are not retrying after hscroll.
15359 (current_matrix_up_to_date_p is nonzero when retrying.) */
15360 if (current_matrix_up_to_date_p
15361 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15362 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15366 case CURSOR_MOVEMENT_SUCCESS
:
15367 used_current_matrix_p
= 1;
15370 case CURSOR_MOVEMENT_MUST_SCROLL
:
15371 goto try_to_scroll
;
15377 /* If current starting point was originally the beginning of a line
15378 but no longer is, find a new starting point. */
15379 else if (!NILP (w
->start_at_line_beg
)
15380 && !(CHARPOS (startp
) <= BEGV
15381 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15384 debug_method_add (w
, "recenter 1");
15389 /* Try scrolling with try_window_id. Value is > 0 if update has
15390 been done, it is -1 if we know that the same window start will
15391 not work. It is 0 if unsuccessful for some other reason. */
15392 else if ((tem
= try_window_id (w
)) != 0)
15395 debug_method_add (w
, "try_window_id %d", tem
);
15398 if (fonts_changed_p
)
15399 goto need_larger_matrices
;
15403 /* Otherwise try_window_id has returned -1 which means that we
15404 don't want the alternative below this comment to execute. */
15406 else if (CHARPOS (startp
) >= BEGV
15407 && CHARPOS (startp
) <= ZV
15408 && PT
>= CHARPOS (startp
)
15409 && (CHARPOS (startp
) < ZV
15410 /* Avoid starting at end of buffer. */
15411 || CHARPOS (startp
) == BEGV
15412 || (XFASTINT (w
->last_modified
) >= MODIFF
15413 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15415 int d1
, d2
, d3
, d4
, d5
, d6
;
15417 /* If first window line is a continuation line, and window start
15418 is inside the modified region, but the first change is before
15419 current window start, we must select a new window start.
15421 However, if this is the result of a down-mouse event (e.g. by
15422 extending the mouse-drag-overlay), we don't want to select a
15423 new window start, since that would change the position under
15424 the mouse, resulting in an unwanted mouse-movement rather
15425 than a simple mouse-click. */
15426 if (NILP (w
->start_at_line_beg
)
15427 && NILP (do_mouse_tracking
)
15428 && CHARPOS (startp
) > BEGV
15429 && CHARPOS (startp
) > BEG
+ beg_unchanged
15430 && CHARPOS (startp
) <= Z
- end_unchanged
15431 /* Even if w->start_at_line_beg is nil, a new window may
15432 start at a line_beg, since that's how set_buffer_window
15433 sets it. So, we need to check the return value of
15434 compute_window_start_on_continuation_line. (See also
15436 && XMARKER (w
->start
)->buffer
== current_buffer
15437 && compute_window_start_on_continuation_line (w
)
15438 /* It doesn't make sense to force the window start like we
15439 do at label force_start if it is already known that point
15440 will not be visible in the resulting window, because
15441 doing so will move point from its correct position
15442 instead of scrolling the window to bring point into view.
15444 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15446 w
->force_start
= Qt
;
15447 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15452 debug_method_add (w
, "same window start");
15455 /* Try to redisplay starting at same place as before.
15456 If point has not moved off frame, accept the results. */
15457 if (!current_matrix_up_to_date_p
15458 /* Don't use try_window_reusing_current_matrix in this case
15459 because a window scroll function can have changed the
15461 || !NILP (Vwindow_scroll_functions
)
15462 || MINI_WINDOW_P (w
)
15463 || !(used_current_matrix_p
15464 = try_window_reusing_current_matrix (w
)))
15466 IF_DEBUG (debug_method_add (w
, "1"));
15467 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15468 /* -1 means we need to scroll.
15469 0 means we need new matrices, but fonts_changed_p
15470 is set in that case, so we will detect it below. */
15471 goto try_to_scroll
;
15474 if (fonts_changed_p
)
15475 goto need_larger_matrices
;
15477 if (w
->cursor
.vpos
>= 0)
15479 if (!just_this_one_p
15480 || current_buffer
->clip_changed
15481 || BEG_UNCHANGED
< CHARPOS (startp
))
15482 /* Forget any recorded base line for line number display. */
15483 w
->base_line_number
= Qnil
;
15485 if (!cursor_row_fully_visible_p (w
, 1, 0))
15487 clear_glyph_matrix (w
->desired_matrix
);
15488 last_line_misfit
= 1;
15490 /* Drop through and scroll. */
15495 clear_glyph_matrix (w
->desired_matrix
);
15500 w
->last_modified
= make_number (0);
15501 w
->last_overlay_modified
= make_number (0);
15503 /* Redisplay the mode line. Select the buffer properly for that. */
15504 if (!update_mode_line
)
15506 update_mode_line
= 1;
15507 w
->update_mode_line
= Qt
;
15510 /* Try to scroll by specified few lines. */
15511 if ((scroll_conservatively
15512 || emacs_scroll_step
15513 || temp_scroll_step
15514 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15515 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15516 && CHARPOS (startp
) >= BEGV
15517 && CHARPOS (startp
) <= ZV
)
15519 /* The function returns -1 if new fonts were loaded, 1 if
15520 successful, 0 if not successful. */
15521 int ss
= try_scrolling (window
, just_this_one_p
,
15522 scroll_conservatively
,
15524 temp_scroll_step
, last_line_misfit
);
15527 case SCROLLING_SUCCESS
:
15530 case SCROLLING_NEED_LARGER_MATRICES
:
15531 goto need_larger_matrices
;
15533 case SCROLLING_FAILED
:
15541 /* Finally, just choose a place to start which positions point
15542 according to user preferences. */
15547 debug_method_add (w
, "recenter");
15550 /* w->vscroll = 0; */
15552 /* Forget any previously recorded base line for line number display. */
15553 if (!buffer_unchanged_p
)
15554 w
->base_line_number
= Qnil
;
15556 /* Determine the window start relative to point. */
15557 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15558 it
.current_y
= it
.last_visible_y
;
15559 if (centering_position
< 0)
15563 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15565 EMACS_INT margin_pos
= CHARPOS (startp
);
15566 Lisp_Object aggressive
;
15569 /* If there is a scroll margin at the top of the window, find
15570 its character position. */
15572 /* Cannot call start_display if startp is not in the
15573 accessible region of the buffer. This can happen when we
15574 have just switched to a different buffer and/or changed
15575 its restriction. In that case, startp is initialized to
15576 the character position 1 (BEG) because we did not yet
15577 have chance to display the buffer even once. */
15578 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15581 void *it1data
= NULL
;
15583 SAVE_IT (it1
, it
, it1data
);
15584 start_display (&it1
, w
, startp
);
15585 move_it_vertically (&it1
, margin
);
15586 margin_pos
= IT_CHARPOS (it1
);
15587 RESTORE_IT (&it
, &it
, it1data
);
15589 scrolling_up
= PT
> margin_pos
;
15592 ? BVAR (current_buffer
, scroll_up_aggressively
)
15593 : BVAR (current_buffer
, scroll_down_aggressively
);
15595 if (!MINI_WINDOW_P (w
)
15596 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15600 /* Setting scroll-conservatively overrides
15601 scroll-*-aggressively. */
15602 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15604 double float_amount
= XFLOATINT (aggressive
);
15606 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15607 if (pt_offset
== 0 && float_amount
> 0)
15612 /* Compute how much to move the window start backward from
15613 point so that point will be displayed where the user
15617 centering_position
= it
.last_visible_y
;
15619 centering_position
-= pt_offset
;
15620 centering_position
-=
15621 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15622 + WINDOW_HEADER_LINE_HEIGHT (w
);
15623 /* Don't let point enter the scroll margin near top of
15625 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15626 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15629 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15632 /* Set the window start half the height of the window backward
15634 centering_position
= window_box_height (w
) / 2;
15636 move_it_vertically_backward (&it
, centering_position
);
15638 xassert (IT_CHARPOS (it
) >= BEGV
);
15640 /* The function move_it_vertically_backward may move over more
15641 than the specified y-distance. If it->w is small, e.g. a
15642 mini-buffer window, we may end up in front of the window's
15643 display area. Start displaying at the start of the line
15644 containing PT in this case. */
15645 if (it
.current_y
<= 0)
15647 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15648 move_it_vertically_backward (&it
, 0);
15652 it
.current_x
= it
.hpos
= 0;
15654 /* Set the window start position here explicitly, to avoid an
15655 infinite loop in case the functions in window-scroll-functions
15657 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15659 /* Run scroll hooks. */
15660 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15662 /* Redisplay the window. */
15663 if (!current_matrix_up_to_date_p
15664 || windows_or_buffers_changed
15665 || cursor_type_changed
15666 /* Don't use try_window_reusing_current_matrix in this case
15667 because it can have changed the buffer. */
15668 || !NILP (Vwindow_scroll_functions
)
15669 || !just_this_one_p
15670 || MINI_WINDOW_P (w
)
15671 || !(used_current_matrix_p
15672 = try_window_reusing_current_matrix (w
)))
15673 try_window (window
, startp
, 0);
15675 /* If new fonts have been loaded (due to fontsets), give up. We
15676 have to start a new redisplay since we need to re-adjust glyph
15678 if (fonts_changed_p
)
15679 goto need_larger_matrices
;
15681 /* If cursor did not appear assume that the middle of the window is
15682 in the first line of the window. Do it again with the next line.
15683 (Imagine a window of height 100, displaying two lines of height
15684 60. Moving back 50 from it->last_visible_y will end in the first
15686 if (w
->cursor
.vpos
< 0)
15688 if (!NILP (w
->window_end_valid
)
15689 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15691 clear_glyph_matrix (w
->desired_matrix
);
15692 move_it_by_lines (&it
, 1);
15693 try_window (window
, it
.current
.pos
, 0);
15695 else if (PT
< IT_CHARPOS (it
))
15697 clear_glyph_matrix (w
->desired_matrix
);
15698 move_it_by_lines (&it
, -1);
15699 try_window (window
, it
.current
.pos
, 0);
15703 /* Not much we can do about it. */
15707 /* Consider the following case: Window starts at BEGV, there is
15708 invisible, intangible text at BEGV, so that display starts at
15709 some point START > BEGV. It can happen that we are called with
15710 PT somewhere between BEGV and START. Try to handle that case. */
15711 if (w
->cursor
.vpos
< 0)
15713 struct glyph_row
*row
= w
->current_matrix
->rows
;
15714 if (row
->mode_line_p
)
15716 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15719 if (!cursor_row_fully_visible_p (w
, 0, 0))
15721 /* If vscroll is enabled, disable it and try again. */
15725 clear_glyph_matrix (w
->desired_matrix
);
15729 /* Users who set scroll-conservatively to a large number want
15730 point just above/below the scroll margin. If we ended up
15731 with point's row partially visible, move the window start to
15732 make that row fully visible and out of the margin. */
15733 if (scroll_conservatively
> SCROLL_LIMIT
)
15737 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15739 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15741 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15742 clear_glyph_matrix (w
->desired_matrix
);
15743 if (1 == try_window (window
, it
.current
.pos
,
15744 TRY_WINDOW_CHECK_MARGINS
))
15748 /* If centering point failed to make the whole line visible,
15749 put point at the top instead. That has to make the whole line
15750 visible, if it can be done. */
15751 if (centering_position
== 0)
15754 clear_glyph_matrix (w
->desired_matrix
);
15755 centering_position
= 0;
15761 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15762 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15763 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15766 /* Display the mode line, if we must. */
15767 if ((update_mode_line
15768 /* If window not full width, must redo its mode line
15769 if (a) the window to its side is being redone and
15770 (b) we do a frame-based redisplay. This is a consequence
15771 of how inverted lines are drawn in frame-based redisplay. */
15772 || (!just_this_one_p
15773 && !FRAME_WINDOW_P (f
)
15774 && !WINDOW_FULL_WIDTH_P (w
))
15775 /* Line number to display. */
15776 || INTEGERP (w
->base_line_pos
)
15777 /* Column number is displayed and different from the one displayed. */
15778 || (!NILP (w
->column_number_displayed
)
15779 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15780 /* This means that the window has a mode line. */
15781 && (WINDOW_WANTS_MODELINE_P (w
)
15782 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15784 display_mode_lines (w
);
15786 /* If mode line height has changed, arrange for a thorough
15787 immediate redisplay using the correct mode line height. */
15788 if (WINDOW_WANTS_MODELINE_P (w
)
15789 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15791 fonts_changed_p
= 1;
15792 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15793 = DESIRED_MODE_LINE_HEIGHT (w
);
15796 /* If header line height has changed, arrange for a thorough
15797 immediate redisplay using the correct header line height. */
15798 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15799 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15801 fonts_changed_p
= 1;
15802 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15803 = DESIRED_HEADER_LINE_HEIGHT (w
);
15806 if (fonts_changed_p
)
15807 goto need_larger_matrices
;
15810 if (!line_number_displayed
15811 && !BUFFERP (w
->base_line_pos
))
15813 w
->base_line_pos
= Qnil
;
15814 w
->base_line_number
= Qnil
;
15819 /* When we reach a frame's selected window, redo the frame's menu bar. */
15820 if (update_mode_line
15821 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15823 int redisplay_menu_p
= 0;
15825 if (FRAME_WINDOW_P (f
))
15827 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15828 || defined (HAVE_NS) || defined (USE_GTK)
15829 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15831 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15835 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15837 if (redisplay_menu_p
)
15838 display_menu_bar (w
);
15840 #ifdef HAVE_WINDOW_SYSTEM
15841 if (FRAME_WINDOW_P (f
))
15843 #if defined (USE_GTK) || defined (HAVE_NS)
15844 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15845 redisplay_tool_bar (f
);
15847 if (WINDOWP (f
->tool_bar_window
)
15848 && (FRAME_TOOL_BAR_LINES (f
) > 0
15849 || !NILP (Vauto_resize_tool_bars
))
15850 && redisplay_tool_bar (f
))
15851 ignore_mouse_drag_p
= 1;
15857 #ifdef HAVE_WINDOW_SYSTEM
15858 if (FRAME_WINDOW_P (f
)
15859 && update_window_fringes (w
, (just_this_one_p
15860 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15861 || w
->pseudo_window_p
)))
15865 if (draw_window_fringes (w
, 1))
15866 x_draw_vertical_border (w
);
15870 #endif /* HAVE_WINDOW_SYSTEM */
15872 /* We go to this label, with fonts_changed_p nonzero,
15873 if it is necessary to try again using larger glyph matrices.
15874 We have to redeem the scroll bar even in this case,
15875 because the loop in redisplay_internal expects that. */
15876 need_larger_matrices
:
15878 finish_scroll_bars
:
15880 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15882 /* Set the thumb's position and size. */
15883 set_vertical_scroll_bar (w
);
15885 /* Note that we actually used the scroll bar attached to this
15886 window, so it shouldn't be deleted at the end of redisplay. */
15887 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15888 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15891 /* Restore current_buffer and value of point in it. The window
15892 update may have changed the buffer, so first make sure `opoint'
15893 is still valid (Bug#6177). */
15894 if (CHARPOS (opoint
) < BEGV
)
15895 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15896 else if (CHARPOS (opoint
) > ZV
)
15897 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15899 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15901 set_buffer_internal_1 (old
);
15902 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15903 shorter. This can be caused by log truncation in *Messages*. */
15904 if (CHARPOS (lpoint
) <= ZV
)
15905 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15907 unbind_to (count
, Qnil
);
15911 /* Build the complete desired matrix of WINDOW with a window start
15912 buffer position POS.
15914 Value is 1 if successful. It is zero if fonts were loaded during
15915 redisplay which makes re-adjusting glyph matrices necessary, and -1
15916 if point would appear in the scroll margins.
15917 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15918 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15922 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15924 struct window
*w
= XWINDOW (window
);
15926 struct glyph_row
*last_text_row
= NULL
;
15927 struct frame
*f
= XFRAME (w
->frame
);
15929 /* Make POS the new window start. */
15930 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15932 /* Mark cursor position as unknown. No overlay arrow seen. */
15933 w
->cursor
.vpos
= -1;
15934 overlay_arrow_seen
= 0;
15936 /* Initialize iterator and info to start at POS. */
15937 start_display (&it
, w
, pos
);
15939 /* Display all lines of W. */
15940 while (it
.current_y
< it
.last_visible_y
)
15942 if (display_line (&it
))
15943 last_text_row
= it
.glyph_row
- 1;
15944 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15948 /* Don't let the cursor end in the scroll margins. */
15949 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15950 && !MINI_WINDOW_P (w
))
15952 int this_scroll_margin
;
15954 if (scroll_margin
> 0)
15956 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15957 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15960 this_scroll_margin
= 0;
15962 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15963 && w
->cursor
.y
< this_scroll_margin
15964 && CHARPOS (pos
) > BEGV
15965 && IT_CHARPOS (it
) < ZV
)
15966 /* rms: considering make_cursor_line_fully_visible_p here
15967 seems to give wrong results. We don't want to recenter
15968 when the last line is partly visible, we want to allow
15969 that case to be handled in the usual way. */
15970 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15972 w
->cursor
.vpos
= -1;
15973 clear_glyph_matrix (w
->desired_matrix
);
15978 /* If bottom moved off end of frame, change mode line percentage. */
15979 if (XFASTINT (w
->window_end_pos
) <= 0
15980 && Z
!= IT_CHARPOS (it
))
15981 w
->update_mode_line
= Qt
;
15983 /* Set window_end_pos to the offset of the last character displayed
15984 on the window from the end of current_buffer. Set
15985 window_end_vpos to its row number. */
15988 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15989 w
->window_end_bytepos
15990 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15992 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15994 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15995 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15996 ->displays_text_p
);
16000 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16001 w
->window_end_pos
= make_number (Z
- ZV
);
16002 w
->window_end_vpos
= make_number (0);
16005 /* But that is not valid info until redisplay finishes. */
16006 w
->window_end_valid
= Qnil
;
16012 /************************************************************************
16013 Window redisplay reusing current matrix when buffer has not changed
16014 ************************************************************************/
16016 /* Try redisplay of window W showing an unchanged buffer with a
16017 different window start than the last time it was displayed by
16018 reusing its current matrix. Value is non-zero if successful.
16019 W->start is the new window start. */
16022 try_window_reusing_current_matrix (struct window
*w
)
16024 struct frame
*f
= XFRAME (w
->frame
);
16025 struct glyph_row
*bottom_row
;
16028 struct text_pos start
, new_start
;
16029 int nrows_scrolled
, i
;
16030 struct glyph_row
*last_text_row
;
16031 struct glyph_row
*last_reused_text_row
;
16032 struct glyph_row
*start_row
;
16033 int start_vpos
, min_y
, max_y
;
16036 if (inhibit_try_window_reusing
)
16040 if (/* This function doesn't handle terminal frames. */
16041 !FRAME_WINDOW_P (f
)
16042 /* Don't try to reuse the display if windows have been split
16044 || windows_or_buffers_changed
16045 || cursor_type_changed
)
16048 /* Can't do this if region may have changed. */
16049 if ((!NILP (Vtransient_mark_mode
)
16050 && !NILP (BVAR (current_buffer
, mark_active
)))
16051 || !NILP (w
->region_showing
)
16052 || !NILP (Vshow_trailing_whitespace
))
16055 /* If top-line visibility has changed, give up. */
16056 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16057 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16060 /* Give up if old or new display is scrolled vertically. We could
16061 make this function handle this, but right now it doesn't. */
16062 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16063 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16066 /* The variable new_start now holds the new window start. The old
16067 start `start' can be determined from the current matrix. */
16068 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16069 start
= start_row
->minpos
;
16070 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16072 /* Clear the desired matrix for the display below. */
16073 clear_glyph_matrix (w
->desired_matrix
);
16075 if (CHARPOS (new_start
) <= CHARPOS (start
))
16077 /* Don't use this method if the display starts with an ellipsis
16078 displayed for invisible text. It's not easy to handle that case
16079 below, and it's certainly not worth the effort since this is
16080 not a frequent case. */
16081 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16084 IF_DEBUG (debug_method_add (w
, "twu1"));
16086 /* Display up to a row that can be reused. The variable
16087 last_text_row is set to the last row displayed that displays
16088 text. Note that it.vpos == 0 if or if not there is a
16089 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16090 start_display (&it
, w
, new_start
);
16091 w
->cursor
.vpos
= -1;
16092 last_text_row
= last_reused_text_row
= NULL
;
16094 while (it
.current_y
< it
.last_visible_y
16095 && !fonts_changed_p
)
16097 /* If we have reached into the characters in the START row,
16098 that means the line boundaries have changed. So we
16099 can't start copying with the row START. Maybe it will
16100 work to start copying with the following row. */
16101 while (IT_CHARPOS (it
) > CHARPOS (start
))
16103 /* Advance to the next row as the "start". */
16105 start
= start_row
->minpos
;
16106 /* If there are no more rows to try, or just one, give up. */
16107 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16108 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16109 || CHARPOS (start
) == ZV
)
16111 clear_glyph_matrix (w
->desired_matrix
);
16115 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16117 /* If we have reached alignment, we can copy the rest of the
16119 if (IT_CHARPOS (it
) == CHARPOS (start
)
16120 /* Don't accept "alignment" inside a display vector,
16121 since start_row could have started in the middle of
16122 that same display vector (thus their character
16123 positions match), and we have no way of telling if
16124 that is the case. */
16125 && it
.current
.dpvec_index
< 0)
16128 if (display_line (&it
))
16129 last_text_row
= it
.glyph_row
- 1;
16133 /* A value of current_y < last_visible_y means that we stopped
16134 at the previous window start, which in turn means that we
16135 have at least one reusable row. */
16136 if (it
.current_y
< it
.last_visible_y
)
16138 struct glyph_row
*row
;
16140 /* IT.vpos always starts from 0; it counts text lines. */
16141 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16143 /* Find PT if not already found in the lines displayed. */
16144 if (w
->cursor
.vpos
< 0)
16146 int dy
= it
.current_y
- start_row
->y
;
16148 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16149 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16151 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16152 dy
, nrows_scrolled
);
16155 clear_glyph_matrix (w
->desired_matrix
);
16160 /* Scroll the display. Do it before the current matrix is
16161 changed. The problem here is that update has not yet
16162 run, i.e. part of the current matrix is not up to date.
16163 scroll_run_hook will clear the cursor, and use the
16164 current matrix to get the height of the row the cursor is
16166 run
.current_y
= start_row
->y
;
16167 run
.desired_y
= it
.current_y
;
16168 run
.height
= it
.last_visible_y
- it
.current_y
;
16170 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16173 FRAME_RIF (f
)->update_window_begin_hook (w
);
16174 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16175 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16176 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16180 /* Shift current matrix down by nrows_scrolled lines. */
16181 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16182 rotate_matrix (w
->current_matrix
,
16184 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16187 /* Disable lines that must be updated. */
16188 for (i
= 0; i
< nrows_scrolled
; ++i
)
16189 (start_row
+ i
)->enabled_p
= 0;
16191 /* Re-compute Y positions. */
16192 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16193 max_y
= it
.last_visible_y
;
16194 for (row
= start_row
+ nrows_scrolled
;
16198 row
->y
= it
.current_y
;
16199 row
->visible_height
= row
->height
;
16201 if (row
->y
< min_y
)
16202 row
->visible_height
-= min_y
- row
->y
;
16203 if (row
->y
+ row
->height
> max_y
)
16204 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16205 if (row
->fringe_bitmap_periodic_p
)
16206 row
->redraw_fringe_bitmaps_p
= 1;
16208 it
.current_y
+= row
->height
;
16210 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16211 last_reused_text_row
= row
;
16212 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16216 /* Disable lines in the current matrix which are now
16217 below the window. */
16218 for (++row
; row
< bottom_row
; ++row
)
16219 row
->enabled_p
= row
->mode_line_p
= 0;
16222 /* Update window_end_pos etc.; last_reused_text_row is the last
16223 reused row from the current matrix containing text, if any.
16224 The value of last_text_row is the last displayed line
16225 containing text. */
16226 if (last_reused_text_row
)
16228 w
->window_end_bytepos
16229 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16231 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16233 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16234 w
->current_matrix
));
16236 else if (last_text_row
)
16238 w
->window_end_bytepos
16239 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16241 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16243 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16247 /* This window must be completely empty. */
16248 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16249 w
->window_end_pos
= make_number (Z
- ZV
);
16250 w
->window_end_vpos
= make_number (0);
16252 w
->window_end_valid
= Qnil
;
16254 /* Update hint: don't try scrolling again in update_window. */
16255 w
->desired_matrix
->no_scrolling_p
= 1;
16258 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16262 else if (CHARPOS (new_start
) > CHARPOS (start
))
16264 struct glyph_row
*pt_row
, *row
;
16265 struct glyph_row
*first_reusable_row
;
16266 struct glyph_row
*first_row_to_display
;
16268 int yb
= window_text_bottom_y (w
);
16270 /* Find the row starting at new_start, if there is one. Don't
16271 reuse a partially visible line at the end. */
16272 first_reusable_row
= start_row
;
16273 while (first_reusable_row
->enabled_p
16274 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16275 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16276 < CHARPOS (new_start
)))
16277 ++first_reusable_row
;
16279 /* Give up if there is no row to reuse. */
16280 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16281 || !first_reusable_row
->enabled_p
16282 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16283 != CHARPOS (new_start
)))
16286 /* We can reuse fully visible rows beginning with
16287 first_reusable_row to the end of the window. Set
16288 first_row_to_display to the first row that cannot be reused.
16289 Set pt_row to the row containing point, if there is any. */
16291 for (first_row_to_display
= first_reusable_row
;
16292 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16293 ++first_row_to_display
)
16295 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16296 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16297 pt_row
= first_row_to_display
;
16300 /* Start displaying at the start of first_row_to_display. */
16301 xassert (first_row_to_display
->y
< yb
);
16302 init_to_row_start (&it
, w
, first_row_to_display
);
16304 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16306 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16308 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16309 + WINDOW_HEADER_LINE_HEIGHT (w
));
16311 /* Display lines beginning with first_row_to_display in the
16312 desired matrix. Set last_text_row to the last row displayed
16313 that displays text. */
16314 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16315 if (pt_row
== NULL
)
16316 w
->cursor
.vpos
= -1;
16317 last_text_row
= NULL
;
16318 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16319 if (display_line (&it
))
16320 last_text_row
= it
.glyph_row
- 1;
16322 /* If point is in a reused row, adjust y and vpos of the cursor
16326 w
->cursor
.vpos
-= nrows_scrolled
;
16327 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16330 /* Give up if point isn't in a row displayed or reused. (This
16331 also handles the case where w->cursor.vpos < nrows_scrolled
16332 after the calls to display_line, which can happen with scroll
16333 margins. See bug#1295.) */
16334 if (w
->cursor
.vpos
< 0)
16336 clear_glyph_matrix (w
->desired_matrix
);
16340 /* Scroll the display. */
16341 run
.current_y
= first_reusable_row
->y
;
16342 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16343 run
.height
= it
.last_visible_y
- run
.current_y
;
16344 dy
= run
.current_y
- run
.desired_y
;
16349 FRAME_RIF (f
)->update_window_begin_hook (w
);
16350 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16351 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16352 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16356 /* Adjust Y positions of reused rows. */
16357 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16358 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16359 max_y
= it
.last_visible_y
;
16360 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16363 row
->visible_height
= row
->height
;
16364 if (row
->y
< min_y
)
16365 row
->visible_height
-= min_y
- row
->y
;
16366 if (row
->y
+ row
->height
> max_y
)
16367 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16368 if (row
->fringe_bitmap_periodic_p
)
16369 row
->redraw_fringe_bitmaps_p
= 1;
16372 /* Scroll the current matrix. */
16373 xassert (nrows_scrolled
> 0);
16374 rotate_matrix (w
->current_matrix
,
16376 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16379 /* Disable rows not reused. */
16380 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16381 row
->enabled_p
= 0;
16383 /* Point may have moved to a different line, so we cannot assume that
16384 the previous cursor position is valid; locate the correct row. */
16387 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16388 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16392 w
->cursor
.y
= row
->y
;
16394 if (row
< bottom_row
)
16396 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16397 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16399 /* Can't use this optimization with bidi-reordered glyph
16400 rows, unless cursor is already at point. */
16401 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16403 if (!(w
->cursor
.hpos
>= 0
16404 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16405 && BUFFERP (glyph
->object
)
16406 && glyph
->charpos
== PT
))
16411 && (!BUFFERP (glyph
->object
)
16412 || glyph
->charpos
< PT
);
16416 w
->cursor
.x
+= glyph
->pixel_width
;
16421 /* Adjust window end. A null value of last_text_row means that
16422 the window end is in reused rows which in turn means that
16423 only its vpos can have changed. */
16426 w
->window_end_bytepos
16427 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16429 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16431 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16436 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16439 w
->window_end_valid
= Qnil
;
16440 w
->desired_matrix
->no_scrolling_p
= 1;
16443 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16453 /************************************************************************
16454 Window redisplay reusing current matrix when buffer has changed
16455 ************************************************************************/
16457 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16458 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16459 EMACS_INT
*, EMACS_INT
*);
16460 static struct glyph_row
*
16461 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16462 struct glyph_row
*);
16465 /* Return the last row in MATRIX displaying text. If row START is
16466 non-null, start searching with that row. IT gives the dimensions
16467 of the display. Value is null if matrix is empty; otherwise it is
16468 a pointer to the row found. */
16470 static struct glyph_row
*
16471 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16472 struct glyph_row
*start
)
16474 struct glyph_row
*row
, *row_found
;
16476 /* Set row_found to the last row in IT->w's current matrix
16477 displaying text. The loop looks funny but think of partially
16480 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16481 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16483 xassert (row
->enabled_p
);
16485 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16494 /* Return the last row in the current matrix of W that is not affected
16495 by changes at the start of current_buffer that occurred since W's
16496 current matrix was built. Value is null if no such row exists.
16498 BEG_UNCHANGED us the number of characters unchanged at the start of
16499 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16500 first changed character in current_buffer. Characters at positions <
16501 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16502 when the current matrix was built. */
16504 static struct glyph_row
*
16505 find_last_unchanged_at_beg_row (struct window
*w
)
16507 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16508 struct glyph_row
*row
;
16509 struct glyph_row
*row_found
= NULL
;
16510 int yb
= window_text_bottom_y (w
);
16512 /* Find the last row displaying unchanged text. */
16513 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16514 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16515 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16518 if (/* If row ends before first_changed_pos, it is unchanged,
16519 except in some case. */
16520 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16521 /* When row ends in ZV and we write at ZV it is not
16523 && !row
->ends_at_zv_p
16524 /* When first_changed_pos is the end of a continued line,
16525 row is not unchanged because it may be no longer
16527 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16528 && (row
->continued_p
16529 || row
->exact_window_width_line_p
)))
16532 /* Stop if last visible row. */
16533 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16541 /* Find the first glyph row in the current matrix of W that is not
16542 affected by changes at the end of current_buffer since the
16543 time W's current matrix was built.
16545 Return in *DELTA the number of chars by which buffer positions in
16546 unchanged text at the end of current_buffer must be adjusted.
16548 Return in *DELTA_BYTES the corresponding number of bytes.
16550 Value is null if no such row exists, i.e. all rows are affected by
16553 static struct glyph_row
*
16554 find_first_unchanged_at_end_row (struct window
*w
,
16555 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16557 struct glyph_row
*row
;
16558 struct glyph_row
*row_found
= NULL
;
16560 *delta
= *delta_bytes
= 0;
16562 /* Display must not have been paused, otherwise the current matrix
16563 is not up to date. */
16564 eassert (!NILP (w
->window_end_valid
));
16566 /* A value of window_end_pos >= END_UNCHANGED means that the window
16567 end is in the range of changed text. If so, there is no
16568 unchanged row at the end of W's current matrix. */
16569 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16572 /* Set row to the last row in W's current matrix displaying text. */
16573 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16575 /* If matrix is entirely empty, no unchanged row exists. */
16576 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16578 /* The value of row is the last glyph row in the matrix having a
16579 meaningful buffer position in it. The end position of row
16580 corresponds to window_end_pos. This allows us to translate
16581 buffer positions in the current matrix to current buffer
16582 positions for characters not in changed text. */
16584 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16585 EMACS_INT Z_BYTE_old
=
16586 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16587 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16588 struct glyph_row
*first_text_row
16589 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16591 *delta
= Z
- Z_old
;
16592 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16594 /* Set last_unchanged_pos to the buffer position of the last
16595 character in the buffer that has not been changed. Z is the
16596 index + 1 of the last character in current_buffer, i.e. by
16597 subtracting END_UNCHANGED we get the index of the last
16598 unchanged character, and we have to add BEG to get its buffer
16600 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16601 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16603 /* Search backward from ROW for a row displaying a line that
16604 starts at a minimum position >= last_unchanged_pos_old. */
16605 for (; row
> first_text_row
; --row
)
16607 /* This used to abort, but it can happen.
16608 It is ok to just stop the search instead here. KFS. */
16609 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16612 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16617 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16623 /* Make sure that glyph rows in the current matrix of window W
16624 reference the same glyph memory as corresponding rows in the
16625 frame's frame matrix. This function is called after scrolling W's
16626 current matrix on a terminal frame in try_window_id and
16627 try_window_reusing_current_matrix. */
16630 sync_frame_with_window_matrix_rows (struct window
*w
)
16632 struct frame
*f
= XFRAME (w
->frame
);
16633 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16635 /* Preconditions: W must be a leaf window and full-width. Its frame
16636 must have a frame matrix. */
16637 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16638 xassert (WINDOW_FULL_WIDTH_P (w
));
16639 xassert (!FRAME_WINDOW_P (f
));
16641 /* If W is a full-width window, glyph pointers in W's current matrix
16642 have, by definition, to be the same as glyph pointers in the
16643 corresponding frame matrix. Note that frame matrices have no
16644 marginal areas (see build_frame_matrix). */
16645 window_row
= w
->current_matrix
->rows
;
16646 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16647 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16648 while (window_row
< window_row_end
)
16650 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16651 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16653 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16654 frame_row
->glyphs
[TEXT_AREA
] = start
;
16655 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16656 frame_row
->glyphs
[LAST_AREA
] = end
;
16658 /* Disable frame rows whose corresponding window rows have
16659 been disabled in try_window_id. */
16660 if (!window_row
->enabled_p
)
16661 frame_row
->enabled_p
= 0;
16663 ++window_row
, ++frame_row
;
16668 /* Find the glyph row in window W containing CHARPOS. Consider all
16669 rows between START and END (not inclusive). END null means search
16670 all rows to the end of the display area of W. Value is the row
16671 containing CHARPOS or null. */
16674 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16675 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16677 struct glyph_row
*row
= start
;
16678 struct glyph_row
*best_row
= NULL
;
16679 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16682 /* If we happen to start on a header-line, skip that. */
16683 if (row
->mode_line_p
)
16686 if ((end
&& row
>= end
) || !row
->enabled_p
)
16689 last_y
= window_text_bottom_y (w
) - dy
;
16693 /* Give up if we have gone too far. */
16694 if (end
&& row
>= end
)
16696 /* This formerly returned if they were equal.
16697 I think that both quantities are of a "last plus one" type;
16698 if so, when they are equal, the row is within the screen. -- rms. */
16699 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16702 /* If it is in this row, return this row. */
16703 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16704 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16705 /* The end position of a row equals the start
16706 position of the next row. If CHARPOS is there, we
16707 would rather display it in the next line, except
16708 when this line ends in ZV. */
16709 && !row
->ends_at_zv_p
16710 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16711 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16715 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16716 || (!best_row
&& !row
->continued_p
))
16718 /* In bidi-reordered rows, there could be several rows
16719 occluding point, all of them belonging to the same
16720 continued line. We need to find the row which fits
16721 CHARPOS the best. */
16722 for (g
= row
->glyphs
[TEXT_AREA
];
16723 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16726 if (!STRINGP (g
->object
))
16728 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16730 mindif
= eabs (g
->charpos
- charpos
);
16732 /* Exact match always wins. */
16739 else if (best_row
&& !row
->continued_p
)
16746 /* Try to redisplay window W by reusing its existing display. W's
16747 current matrix must be up to date when this function is called,
16748 i.e. window_end_valid must not be nil.
16752 1 if display has been updated
16753 0 if otherwise unsuccessful
16754 -1 if redisplay with same window start is known not to succeed
16756 The following steps are performed:
16758 1. Find the last row in the current matrix of W that is not
16759 affected by changes at the start of current_buffer. If no such row
16762 2. Find the first row in W's current matrix that is not affected by
16763 changes at the end of current_buffer. Maybe there is no such row.
16765 3. Display lines beginning with the row + 1 found in step 1 to the
16766 row found in step 2 or, if step 2 didn't find a row, to the end of
16769 4. If cursor is not known to appear on the window, give up.
16771 5. If display stopped at the row found in step 2, scroll the
16772 display and current matrix as needed.
16774 6. Maybe display some lines at the end of W, if we must. This can
16775 happen under various circumstances, like a partially visible line
16776 becoming fully visible, or because newly displayed lines are displayed
16777 in smaller font sizes.
16779 7. Update W's window end information. */
16782 try_window_id (struct window
*w
)
16784 struct frame
*f
= XFRAME (w
->frame
);
16785 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16786 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16787 struct glyph_row
*last_unchanged_at_beg_row
;
16788 struct glyph_row
*first_unchanged_at_end_row
;
16789 struct glyph_row
*row
;
16790 struct glyph_row
*bottom_row
;
16793 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16795 struct text_pos start_pos
;
16797 int first_unchanged_at_end_vpos
= 0;
16798 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16799 struct text_pos start
;
16800 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16803 if (inhibit_try_window_id
)
16807 /* This is handy for debugging. */
16809 #define GIVE_UP(X) \
16811 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16815 #define GIVE_UP(X) return 0
16818 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16820 /* Don't use this for mini-windows because these can show
16821 messages and mini-buffers, and we don't handle that here. */
16822 if (MINI_WINDOW_P (w
))
16825 /* This flag is used to prevent redisplay optimizations. */
16826 if (windows_or_buffers_changed
|| cursor_type_changed
)
16829 /* Verify that narrowing has not changed.
16830 Also verify that we were not told to prevent redisplay optimizations.
16831 It would be nice to further
16832 reduce the number of cases where this prevents try_window_id. */
16833 if (current_buffer
->clip_changed
16834 || current_buffer
->prevent_redisplay_optimizations_p
)
16837 /* Window must either use window-based redisplay or be full width. */
16838 if (!FRAME_WINDOW_P (f
)
16839 && (!FRAME_LINE_INS_DEL_OK (f
)
16840 || !WINDOW_FULL_WIDTH_P (w
)))
16843 /* Give up if point is known NOT to appear in W. */
16844 if (PT
< CHARPOS (start
))
16847 /* Another way to prevent redisplay optimizations. */
16848 if (XFASTINT (w
->last_modified
) == 0)
16851 /* Verify that window is not hscrolled. */
16852 if (XFASTINT (w
->hscroll
) != 0)
16855 /* Verify that display wasn't paused. */
16856 if (NILP (w
->window_end_valid
))
16859 /* Can't use this if highlighting a region because a cursor movement
16860 will do more than just set the cursor. */
16861 if (!NILP (Vtransient_mark_mode
)
16862 && !NILP (BVAR (current_buffer
, mark_active
)))
16865 /* Likewise if highlighting trailing whitespace. */
16866 if (!NILP (Vshow_trailing_whitespace
))
16869 /* Likewise if showing a region. */
16870 if (!NILP (w
->region_showing
))
16873 /* Can't use this if overlay arrow position and/or string have
16875 if (overlay_arrows_changed_p ())
16878 /* When word-wrap is on, adding a space to the first word of a
16879 wrapped line can change the wrap position, altering the line
16880 above it. It might be worthwhile to handle this more
16881 intelligently, but for now just redisplay from scratch. */
16882 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16885 /* Under bidi reordering, adding or deleting a character in the
16886 beginning of a paragraph, before the first strong directional
16887 character, can change the base direction of the paragraph (unless
16888 the buffer specifies a fixed paragraph direction), which will
16889 require to redisplay the whole paragraph. It might be worthwhile
16890 to find the paragraph limits and widen the range of redisplayed
16891 lines to that, but for now just give up this optimization and
16892 redisplay from scratch. */
16893 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16894 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16897 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16898 only if buffer has really changed. The reason is that the gap is
16899 initially at Z for freshly visited files. The code below would
16900 set end_unchanged to 0 in that case. */
16901 if (MODIFF
> SAVE_MODIFF
16902 /* This seems to happen sometimes after saving a buffer. */
16903 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16905 if (GPT
- BEG
< BEG_UNCHANGED
)
16906 BEG_UNCHANGED
= GPT
- BEG
;
16907 if (Z
- GPT
< END_UNCHANGED
)
16908 END_UNCHANGED
= Z
- GPT
;
16911 /* The position of the first and last character that has been changed. */
16912 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16913 last_changed_charpos
= Z
- END_UNCHANGED
;
16915 /* If window starts after a line end, and the last change is in
16916 front of that newline, then changes don't affect the display.
16917 This case happens with stealth-fontification. Note that although
16918 the display is unchanged, glyph positions in the matrix have to
16919 be adjusted, of course. */
16920 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16921 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16922 && ((last_changed_charpos
< CHARPOS (start
)
16923 && CHARPOS (start
) == BEGV
)
16924 || (last_changed_charpos
< CHARPOS (start
) - 1
16925 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16927 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16928 struct glyph_row
*r0
;
16930 /* Compute how many chars/bytes have been added to or removed
16931 from the buffer. */
16932 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16933 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16934 Z_delta
= Z
- Z_old
;
16935 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16937 /* Give up if PT is not in the window. Note that it already has
16938 been checked at the start of try_window_id that PT is not in
16939 front of the window start. */
16940 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16943 /* If window start is unchanged, we can reuse the whole matrix
16944 as is, after adjusting glyph positions. No need to compute
16945 the window end again, since its offset from Z hasn't changed. */
16946 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16947 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16948 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16949 /* PT must not be in a partially visible line. */
16950 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16951 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16953 /* Adjust positions in the glyph matrix. */
16954 if (Z_delta
|| Z_delta_bytes
)
16956 struct glyph_row
*r1
16957 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16958 increment_matrix_positions (w
->current_matrix
,
16959 MATRIX_ROW_VPOS (r0
, current_matrix
),
16960 MATRIX_ROW_VPOS (r1
, current_matrix
),
16961 Z_delta
, Z_delta_bytes
);
16964 /* Set the cursor. */
16965 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16967 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16974 /* Handle the case that changes are all below what is displayed in
16975 the window, and that PT is in the window. This shortcut cannot
16976 be taken if ZV is visible in the window, and text has been added
16977 there that is visible in the window. */
16978 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16979 /* ZV is not visible in the window, or there are no
16980 changes at ZV, actually. */
16981 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16982 || first_changed_charpos
== last_changed_charpos
))
16984 struct glyph_row
*r0
;
16986 /* Give up if PT is not in the window. Note that it already has
16987 been checked at the start of try_window_id that PT is not in
16988 front of the window start. */
16989 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16992 /* If window start is unchanged, we can reuse the whole matrix
16993 as is, without changing glyph positions since no text has
16994 been added/removed in front of the window end. */
16995 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16996 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16997 /* PT must not be in a partially visible line. */
16998 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16999 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17001 /* We have to compute the window end anew since text
17002 could have been added/removed after it. */
17004 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17005 w
->window_end_bytepos
17006 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17008 /* Set the cursor. */
17009 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17011 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17018 /* Give up if window start is in the changed area.
17020 The condition used to read
17022 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17024 but why that was tested escapes me at the moment. */
17025 if (CHARPOS (start
) >= first_changed_charpos
17026 && CHARPOS (start
) <= last_changed_charpos
)
17029 /* Check that window start agrees with the start of the first glyph
17030 row in its current matrix. Check this after we know the window
17031 start is not in changed text, otherwise positions would not be
17033 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17034 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17037 /* Give up if the window ends in strings. Overlay strings
17038 at the end are difficult to handle, so don't try. */
17039 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17040 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17043 /* Compute the position at which we have to start displaying new
17044 lines. Some of the lines at the top of the window might be
17045 reusable because they are not displaying changed text. Find the
17046 last row in W's current matrix not affected by changes at the
17047 start of current_buffer. Value is null if changes start in the
17048 first line of window. */
17049 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17050 if (last_unchanged_at_beg_row
)
17052 /* Avoid starting to display in the middle of a character, a TAB
17053 for instance. This is easier than to set up the iterator
17054 exactly, and it's not a frequent case, so the additional
17055 effort wouldn't really pay off. */
17056 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17057 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17058 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17059 --last_unchanged_at_beg_row
;
17061 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17064 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17066 start_pos
= it
.current
.pos
;
17068 /* Start displaying new lines in the desired matrix at the same
17069 vpos we would use in the current matrix, i.e. below
17070 last_unchanged_at_beg_row. */
17071 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17073 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17074 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17076 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17080 /* There are no reusable lines at the start of the window.
17081 Start displaying in the first text line. */
17082 start_display (&it
, w
, start
);
17083 it
.vpos
= it
.first_vpos
;
17084 start_pos
= it
.current
.pos
;
17087 /* Find the first row that is not affected by changes at the end of
17088 the buffer. Value will be null if there is no unchanged row, in
17089 which case we must redisplay to the end of the window. delta
17090 will be set to the value by which buffer positions beginning with
17091 first_unchanged_at_end_row have to be adjusted due to text
17093 first_unchanged_at_end_row
17094 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17095 IF_DEBUG (debug_delta
= delta
);
17096 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17098 /* Set stop_pos to the buffer position up to which we will have to
17099 display new lines. If first_unchanged_at_end_row != NULL, this
17100 is the buffer position of the start of the line displayed in that
17101 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17102 that we don't stop at a buffer position. */
17104 if (first_unchanged_at_end_row
)
17106 xassert (last_unchanged_at_beg_row
== NULL
17107 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17109 /* If this is a continuation line, move forward to the next one
17110 that isn't. Changes in lines above affect this line.
17111 Caution: this may move first_unchanged_at_end_row to a row
17112 not displaying text. */
17113 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17114 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17115 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17116 < it
.last_visible_y
))
17117 ++first_unchanged_at_end_row
;
17119 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17120 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17121 >= it
.last_visible_y
))
17122 first_unchanged_at_end_row
= NULL
;
17125 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17127 first_unchanged_at_end_vpos
17128 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17129 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17132 else if (last_unchanged_at_beg_row
== NULL
)
17138 /* Either there is no unchanged row at the end, or the one we have
17139 now displays text. This is a necessary condition for the window
17140 end pos calculation at the end of this function. */
17141 xassert (first_unchanged_at_end_row
== NULL
17142 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17144 debug_last_unchanged_at_beg_vpos
17145 = (last_unchanged_at_beg_row
17146 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17148 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17150 #endif /* GLYPH_DEBUG != 0 */
17153 /* Display new lines. Set last_text_row to the last new line
17154 displayed which has text on it, i.e. might end up as being the
17155 line where the window_end_vpos is. */
17156 w
->cursor
.vpos
= -1;
17157 last_text_row
= NULL
;
17158 overlay_arrow_seen
= 0;
17159 while (it
.current_y
< it
.last_visible_y
17160 && !fonts_changed_p
17161 && (first_unchanged_at_end_row
== NULL
17162 || IT_CHARPOS (it
) < stop_pos
))
17164 if (display_line (&it
))
17165 last_text_row
= it
.glyph_row
- 1;
17168 if (fonts_changed_p
)
17172 /* Compute differences in buffer positions, y-positions etc. for
17173 lines reused at the bottom of the window. Compute what we can
17175 if (first_unchanged_at_end_row
17176 /* No lines reused because we displayed everything up to the
17177 bottom of the window. */
17178 && it
.current_y
< it
.last_visible_y
)
17181 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17183 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17184 run
.current_y
= first_unchanged_at_end_row
->y
;
17185 run
.desired_y
= run
.current_y
+ dy
;
17186 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17190 delta
= delta_bytes
= dvpos
= dy
17191 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17192 first_unchanged_at_end_row
= NULL
;
17194 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17197 /* Find the cursor if not already found. We have to decide whether
17198 PT will appear on this window (it sometimes doesn't, but this is
17199 not a very frequent case.) This decision has to be made before
17200 the current matrix is altered. A value of cursor.vpos < 0 means
17201 that PT is either in one of the lines beginning at
17202 first_unchanged_at_end_row or below the window. Don't care for
17203 lines that might be displayed later at the window end; as
17204 mentioned, this is not a frequent case. */
17205 if (w
->cursor
.vpos
< 0)
17207 /* Cursor in unchanged rows at the top? */
17208 if (PT
< CHARPOS (start_pos
)
17209 && last_unchanged_at_beg_row
)
17211 row
= row_containing_pos (w
, PT
,
17212 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17213 last_unchanged_at_beg_row
+ 1, 0);
17215 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17218 /* Start from first_unchanged_at_end_row looking for PT. */
17219 else if (first_unchanged_at_end_row
)
17221 row
= row_containing_pos (w
, PT
- delta
,
17222 first_unchanged_at_end_row
, NULL
, 0);
17224 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17225 delta_bytes
, dy
, dvpos
);
17228 /* Give up if cursor was not found. */
17229 if (w
->cursor
.vpos
< 0)
17231 clear_glyph_matrix (w
->desired_matrix
);
17236 /* Don't let the cursor end in the scroll margins. */
17238 int this_scroll_margin
, cursor_height
;
17240 this_scroll_margin
=
17241 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17242 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17243 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17245 if ((w
->cursor
.y
< this_scroll_margin
17246 && CHARPOS (start
) > BEGV
)
17247 /* Old redisplay didn't take scroll margin into account at the bottom,
17248 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17249 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17250 ? cursor_height
+ this_scroll_margin
17251 : 1)) > it
.last_visible_y
)
17253 w
->cursor
.vpos
= -1;
17254 clear_glyph_matrix (w
->desired_matrix
);
17259 /* Scroll the display. Do it before changing the current matrix so
17260 that xterm.c doesn't get confused about where the cursor glyph is
17262 if (dy
&& run
.height
)
17266 if (FRAME_WINDOW_P (f
))
17268 FRAME_RIF (f
)->update_window_begin_hook (w
);
17269 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17270 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17271 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17275 /* Terminal frame. In this case, dvpos gives the number of
17276 lines to scroll by; dvpos < 0 means scroll up. */
17278 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17279 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17280 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17281 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17282 + window_internal_height (w
));
17284 #if defined (HAVE_GPM) || defined (MSDOS)
17285 x_clear_window_mouse_face (w
);
17287 /* Perform the operation on the screen. */
17290 /* Scroll last_unchanged_at_beg_row to the end of the
17291 window down dvpos lines. */
17292 set_terminal_window (f
, end
);
17294 /* On dumb terminals delete dvpos lines at the end
17295 before inserting dvpos empty lines. */
17296 if (!FRAME_SCROLL_REGION_OK (f
))
17297 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17299 /* Insert dvpos empty lines in front of
17300 last_unchanged_at_beg_row. */
17301 ins_del_lines (f
, from
, dvpos
);
17303 else if (dvpos
< 0)
17305 /* Scroll up last_unchanged_at_beg_vpos to the end of
17306 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17307 set_terminal_window (f
, end
);
17309 /* Delete dvpos lines in front of
17310 last_unchanged_at_beg_vpos. ins_del_lines will set
17311 the cursor to the given vpos and emit |dvpos| delete
17313 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17315 /* On a dumb terminal insert dvpos empty lines at the
17317 if (!FRAME_SCROLL_REGION_OK (f
))
17318 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17321 set_terminal_window (f
, 0);
17327 /* Shift reused rows of the current matrix to the right position.
17328 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17330 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17331 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17334 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17335 bottom_vpos
, dvpos
);
17336 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17339 else if (dvpos
> 0)
17341 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17342 bottom_vpos
, dvpos
);
17343 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17344 first_unchanged_at_end_vpos
+ dvpos
, 0);
17347 /* For frame-based redisplay, make sure that current frame and window
17348 matrix are in sync with respect to glyph memory. */
17349 if (!FRAME_WINDOW_P (f
))
17350 sync_frame_with_window_matrix_rows (w
);
17352 /* Adjust buffer positions in reused rows. */
17353 if (delta
|| delta_bytes
)
17354 increment_matrix_positions (current_matrix
,
17355 first_unchanged_at_end_vpos
+ dvpos
,
17356 bottom_vpos
, delta
, delta_bytes
);
17358 /* Adjust Y positions. */
17360 shift_glyph_matrix (w
, current_matrix
,
17361 first_unchanged_at_end_vpos
+ dvpos
,
17364 if (first_unchanged_at_end_row
)
17366 first_unchanged_at_end_row
+= dvpos
;
17367 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17368 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17369 first_unchanged_at_end_row
= NULL
;
17372 /* If scrolling up, there may be some lines to display at the end of
17374 last_text_row_at_end
= NULL
;
17377 /* Scrolling up can leave for example a partially visible line
17378 at the end of the window to be redisplayed. */
17379 /* Set last_row to the glyph row in the current matrix where the
17380 window end line is found. It has been moved up or down in
17381 the matrix by dvpos. */
17382 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17383 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17385 /* If last_row is the window end line, it should display text. */
17386 xassert (last_row
->displays_text_p
);
17388 /* If window end line was partially visible before, begin
17389 displaying at that line. Otherwise begin displaying with the
17390 line following it. */
17391 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17393 init_to_row_start (&it
, w
, last_row
);
17394 it
.vpos
= last_vpos
;
17395 it
.current_y
= last_row
->y
;
17399 init_to_row_end (&it
, w
, last_row
);
17400 it
.vpos
= 1 + last_vpos
;
17401 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17405 /* We may start in a continuation line. If so, we have to
17406 get the right continuation_lines_width and current_x. */
17407 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17408 it
.hpos
= it
.current_x
= 0;
17410 /* Display the rest of the lines at the window end. */
17411 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17412 while (it
.current_y
< it
.last_visible_y
17413 && !fonts_changed_p
)
17415 /* Is it always sure that the display agrees with lines in
17416 the current matrix? I don't think so, so we mark rows
17417 displayed invalid in the current matrix by setting their
17418 enabled_p flag to zero. */
17419 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17420 if (display_line (&it
))
17421 last_text_row_at_end
= it
.glyph_row
- 1;
17425 /* Update window_end_pos and window_end_vpos. */
17426 if (first_unchanged_at_end_row
17427 && !last_text_row_at_end
)
17429 /* Window end line if one of the preserved rows from the current
17430 matrix. Set row to the last row displaying text in current
17431 matrix starting at first_unchanged_at_end_row, after
17433 xassert (first_unchanged_at_end_row
->displays_text_p
);
17434 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17435 first_unchanged_at_end_row
);
17436 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17438 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17439 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17441 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17442 xassert (w
->window_end_bytepos
>= 0);
17443 IF_DEBUG (debug_method_add (w
, "A"));
17445 else if (last_text_row_at_end
)
17448 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17449 w
->window_end_bytepos
17450 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17452 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17453 xassert (w
->window_end_bytepos
>= 0);
17454 IF_DEBUG (debug_method_add (w
, "B"));
17456 else if (last_text_row
)
17458 /* We have displayed either to the end of the window or at the
17459 end of the window, i.e. the last row with text is to be found
17460 in the desired matrix. */
17462 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17463 w
->window_end_bytepos
17464 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17466 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17467 xassert (w
->window_end_bytepos
>= 0);
17469 else if (first_unchanged_at_end_row
== NULL
17470 && last_text_row
== NULL
17471 && last_text_row_at_end
== NULL
)
17473 /* Displayed to end of window, but no line containing text was
17474 displayed. Lines were deleted at the end of the window. */
17475 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17476 int vpos
= XFASTINT (w
->window_end_vpos
);
17477 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17478 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17481 row
== NULL
&& vpos
>= first_vpos
;
17482 --vpos
, --current_row
, --desired_row
)
17484 if (desired_row
->enabled_p
)
17486 if (desired_row
->displays_text_p
)
17489 else if (current_row
->displays_text_p
)
17493 xassert (row
!= NULL
);
17494 w
->window_end_vpos
= make_number (vpos
+ 1);
17495 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17496 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17497 xassert (w
->window_end_bytepos
>= 0);
17498 IF_DEBUG (debug_method_add (w
, "C"));
17503 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17504 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17506 /* Record that display has not been completed. */
17507 w
->window_end_valid
= Qnil
;
17508 w
->desired_matrix
->no_scrolling_p
= 1;
17516 /***********************************************************************
17517 More debugging support
17518 ***********************************************************************/
17522 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17523 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17524 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17527 /* Dump the contents of glyph matrix MATRIX on stderr.
17529 GLYPHS 0 means don't show glyph contents.
17530 GLYPHS 1 means show glyphs in short form
17531 GLYPHS > 1 means show glyphs in long form. */
17534 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17537 for (i
= 0; i
< matrix
->nrows
; ++i
)
17538 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17542 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17543 the glyph row and area where the glyph comes from. */
17546 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17548 if (glyph
->type
== CHAR_GLYPH
)
17551 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17552 glyph
- row
->glyphs
[TEXT_AREA
],
17555 (BUFFERP (glyph
->object
)
17557 : (STRINGP (glyph
->object
)
17560 glyph
->pixel_width
,
17562 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17566 glyph
->left_box_line_p
,
17567 glyph
->right_box_line_p
);
17569 else if (glyph
->type
== STRETCH_GLYPH
)
17572 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17573 glyph
- row
->glyphs
[TEXT_AREA
],
17576 (BUFFERP (glyph
->object
)
17578 : (STRINGP (glyph
->object
)
17581 glyph
->pixel_width
,
17585 glyph
->left_box_line_p
,
17586 glyph
->right_box_line_p
);
17588 else if (glyph
->type
== IMAGE_GLYPH
)
17591 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17592 glyph
- row
->glyphs
[TEXT_AREA
],
17595 (BUFFERP (glyph
->object
)
17597 : (STRINGP (glyph
->object
)
17600 glyph
->pixel_width
,
17604 glyph
->left_box_line_p
,
17605 glyph
->right_box_line_p
);
17607 else if (glyph
->type
== COMPOSITE_GLYPH
)
17610 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17611 glyph
- row
->glyphs
[TEXT_AREA
],
17614 (BUFFERP (glyph
->object
)
17616 : (STRINGP (glyph
->object
)
17619 glyph
->pixel_width
,
17621 if (glyph
->u
.cmp
.automatic
)
17624 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17625 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17627 glyph
->left_box_line_p
,
17628 glyph
->right_box_line_p
);
17633 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17634 GLYPHS 0 means don't show glyph contents.
17635 GLYPHS 1 means show glyphs in short form
17636 GLYPHS > 1 means show glyphs in long form. */
17639 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17643 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17644 fprintf (stderr
, "======================================================================\n");
17646 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17647 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17649 MATRIX_ROW_START_CHARPOS (row
),
17650 MATRIX_ROW_END_CHARPOS (row
),
17651 row
->used
[TEXT_AREA
],
17652 row
->contains_overlapping_glyphs_p
,
17654 row
->truncated_on_left_p
,
17655 row
->truncated_on_right_p
,
17657 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17658 row
->displays_text_p
,
17661 row
->ends_in_middle_of_char_p
,
17662 row
->starts_in_middle_of_char_p
,
17668 row
->visible_height
,
17671 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17672 row
->end
.overlay_string_index
,
17673 row
->continuation_lines_width
);
17674 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17675 CHARPOS (row
->start
.string_pos
),
17676 CHARPOS (row
->end
.string_pos
));
17677 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17678 row
->end
.dpvec_index
);
17685 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17687 struct glyph
*glyph
= row
->glyphs
[area
];
17688 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17690 /* Glyph for a line end in text. */
17691 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17694 if (glyph
< glyph_end
)
17695 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17697 for (; glyph
< glyph_end
; ++glyph
)
17698 dump_glyph (row
, glyph
, area
);
17701 else if (glyphs
== 1)
17705 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17707 char *s
= (char *) alloca (row
->used
[area
] + 1);
17710 for (i
= 0; i
< row
->used
[area
]; ++i
)
17712 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17713 if (glyph
->type
== CHAR_GLYPH
17714 && glyph
->u
.ch
< 0x80
17715 && glyph
->u
.ch
>= ' ')
17716 s
[i
] = glyph
->u
.ch
;
17722 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17728 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17729 Sdump_glyph_matrix
, 0, 1, "p",
17730 doc
: /* Dump the current matrix of the selected window to stderr.
17731 Shows contents of glyph row structures. With non-nil
17732 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17733 glyphs in short form, otherwise show glyphs in long form. */)
17734 (Lisp_Object glyphs
)
17736 struct window
*w
= XWINDOW (selected_window
);
17737 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17739 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17740 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17741 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17742 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17743 fprintf (stderr
, "=============================================\n");
17744 dump_glyph_matrix (w
->current_matrix
,
17745 NILP (glyphs
) ? 0 : XINT (glyphs
));
17750 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17751 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17754 struct frame
*f
= XFRAME (selected_frame
);
17755 dump_glyph_matrix (f
->current_matrix
, 1);
17760 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17761 doc
: /* Dump glyph row ROW to stderr.
17762 GLYPH 0 means don't dump glyphs.
17763 GLYPH 1 means dump glyphs in short form.
17764 GLYPH > 1 or omitted means dump glyphs in long form. */)
17765 (Lisp_Object row
, Lisp_Object glyphs
)
17767 struct glyph_matrix
*matrix
;
17770 CHECK_NUMBER (row
);
17771 matrix
= XWINDOW (selected_window
)->current_matrix
;
17773 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17774 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17776 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17781 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17782 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17783 GLYPH 0 means don't dump glyphs.
17784 GLYPH 1 means dump glyphs in short form.
17785 GLYPH > 1 or omitted means dump glyphs in long form. */)
17786 (Lisp_Object row
, Lisp_Object glyphs
)
17788 struct frame
*sf
= SELECTED_FRAME ();
17789 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17792 CHECK_NUMBER (row
);
17794 if (vpos
>= 0 && vpos
< m
->nrows
)
17795 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17796 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17801 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17802 doc
: /* Toggle tracing of redisplay.
17803 With ARG, turn tracing on if and only if ARG is positive. */)
17807 trace_redisplay_p
= !trace_redisplay_p
;
17810 arg
= Fprefix_numeric_value (arg
);
17811 trace_redisplay_p
= XINT (arg
) > 0;
17818 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17819 doc
: /* Like `format', but print result to stderr.
17820 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17821 (ptrdiff_t nargs
, Lisp_Object
*args
)
17823 Lisp_Object s
= Fformat (nargs
, args
);
17824 fprintf (stderr
, "%s", SDATA (s
));
17828 #endif /* GLYPH_DEBUG */
17832 /***********************************************************************
17833 Building Desired Matrix Rows
17834 ***********************************************************************/
17836 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17837 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17839 static struct glyph_row
*
17840 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17842 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17843 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17844 struct buffer
*old
= current_buffer
;
17845 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17846 int arrow_len
= SCHARS (overlay_arrow_string
);
17847 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17848 const unsigned char *p
;
17851 int n_glyphs_before
;
17853 set_buffer_temp (buffer
);
17854 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17855 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17856 SET_TEXT_POS (it
.position
, 0, 0);
17858 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17860 while (p
< arrow_end
)
17862 Lisp_Object face
, ilisp
;
17864 /* Get the next character. */
17866 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17869 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17870 if (! ASCII_CHAR_P (it
.c
))
17871 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17875 /* Get its face. */
17876 ilisp
= make_number (p
- arrow_string
);
17877 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17878 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17880 /* Compute its width, get its glyphs. */
17881 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17882 SET_TEXT_POS (it
.position
, -1, -1);
17883 PRODUCE_GLYPHS (&it
);
17885 /* If this character doesn't fit any more in the line, we have
17886 to remove some glyphs. */
17887 if (it
.current_x
> it
.last_visible_x
)
17889 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17894 set_buffer_temp (old
);
17895 return it
.glyph_row
;
17899 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17900 glyphs are only inserted for terminal frames since we can't really
17901 win with truncation glyphs when partially visible glyphs are
17902 involved. Which glyphs to insert is determined by
17903 produce_special_glyphs. */
17906 insert_left_trunc_glyphs (struct it
*it
)
17908 struct it truncate_it
;
17909 struct glyph
*from
, *end
, *to
, *toend
;
17911 xassert (!FRAME_WINDOW_P (it
->f
));
17913 /* Get the truncation glyphs. */
17915 truncate_it
.current_x
= 0;
17916 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17917 truncate_it
.glyph_row
= &scratch_glyph_row
;
17918 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17919 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17920 truncate_it
.object
= make_number (0);
17921 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17923 /* Overwrite glyphs from IT with truncation glyphs. */
17924 if (!it
->glyph_row
->reversed_p
)
17926 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17927 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17928 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17929 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17934 /* There may be padding glyphs left over. Overwrite them too. */
17935 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17937 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17943 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17947 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17948 that back to front. */
17949 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17950 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17951 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17952 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17954 while (from
>= end
&& to
>= toend
)
17956 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17959 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17960 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17961 while (from
>= end
&& to
>= toend
)
17966 /* Need to free some room before prepending additional
17968 int move_by
= from
- end
+ 1;
17969 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17970 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17972 for ( ; g
>= g0
; g
--)
17974 while (from
>= end
)
17976 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17981 /* Compute the hash code for ROW. */
17983 row_hash (struct glyph_row
*row
)
17986 unsigned hashval
= 0;
17988 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17989 for (k
= 0; k
< row
->used
[area
]; ++k
)
17990 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
17991 + row
->glyphs
[area
][k
].u
.val
17992 + row
->glyphs
[area
][k
].face_id
17993 + row
->glyphs
[area
][k
].padding_p
17994 + (row
->glyphs
[area
][k
].type
<< 2));
17999 /* Compute the pixel height and width of IT->glyph_row.
18001 Most of the time, ascent and height of a display line will be equal
18002 to the max_ascent and max_height values of the display iterator
18003 structure. This is not the case if
18005 1. We hit ZV without displaying anything. In this case, max_ascent
18006 and max_height will be zero.
18008 2. We have some glyphs that don't contribute to the line height.
18009 (The glyph row flag contributes_to_line_height_p is for future
18010 pixmap extensions).
18012 The first case is easily covered by using default values because in
18013 these cases, the line height does not really matter, except that it
18014 must not be zero. */
18017 compute_line_metrics (struct it
*it
)
18019 struct glyph_row
*row
= it
->glyph_row
;
18021 if (FRAME_WINDOW_P (it
->f
))
18023 int i
, min_y
, max_y
;
18025 /* The line may consist of one space only, that was added to
18026 place the cursor on it. If so, the row's height hasn't been
18028 if (row
->height
== 0)
18030 if (it
->max_ascent
+ it
->max_descent
== 0)
18031 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18032 row
->ascent
= it
->max_ascent
;
18033 row
->height
= it
->max_ascent
+ it
->max_descent
;
18034 row
->phys_ascent
= it
->max_phys_ascent
;
18035 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18036 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18039 /* Compute the width of this line. */
18040 row
->pixel_width
= row
->x
;
18041 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18042 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18044 xassert (row
->pixel_width
>= 0);
18045 xassert (row
->ascent
>= 0 && row
->height
> 0);
18047 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18048 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18050 /* If first line's physical ascent is larger than its logical
18051 ascent, use the physical ascent, and make the row taller.
18052 This makes accented characters fully visible. */
18053 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18054 && row
->phys_ascent
> row
->ascent
)
18056 row
->height
+= row
->phys_ascent
- row
->ascent
;
18057 row
->ascent
= row
->phys_ascent
;
18060 /* Compute how much of the line is visible. */
18061 row
->visible_height
= row
->height
;
18063 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18064 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18066 if (row
->y
< min_y
)
18067 row
->visible_height
-= min_y
- row
->y
;
18068 if (row
->y
+ row
->height
> max_y
)
18069 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18073 row
->pixel_width
= row
->used
[TEXT_AREA
];
18074 if (row
->continued_p
)
18075 row
->pixel_width
-= it
->continuation_pixel_width
;
18076 else if (row
->truncated_on_right_p
)
18077 row
->pixel_width
-= it
->truncation_pixel_width
;
18078 row
->ascent
= row
->phys_ascent
= 0;
18079 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18080 row
->extra_line_spacing
= 0;
18083 /* Compute a hash code for this row. */
18084 row
->hash
= row_hash (row
);
18086 it
->max_ascent
= it
->max_descent
= 0;
18087 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18091 /* Append one space to the glyph row of iterator IT if doing a
18092 window-based redisplay. The space has the same face as
18093 IT->face_id. Value is non-zero if a space was added.
18095 This function is called to make sure that there is always one glyph
18096 at the end of a glyph row that the cursor can be set on under
18097 window-systems. (If there weren't such a glyph we would not know
18098 how wide and tall a box cursor should be displayed).
18100 At the same time this space let's a nicely handle clearing to the
18101 end of the line if the row ends in italic text. */
18104 append_space_for_newline (struct it
*it
, int default_face_p
)
18106 if (FRAME_WINDOW_P (it
->f
))
18108 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18110 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18111 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18113 /* Save some values that must not be changed.
18114 Must save IT->c and IT->len because otherwise
18115 ITERATOR_AT_END_P wouldn't work anymore after
18116 append_space_for_newline has been called. */
18117 enum display_element_type saved_what
= it
->what
;
18118 int saved_c
= it
->c
, saved_len
= it
->len
;
18119 int saved_char_to_display
= it
->char_to_display
;
18120 int saved_x
= it
->current_x
;
18121 int saved_face_id
= it
->face_id
;
18122 struct text_pos saved_pos
;
18123 Lisp_Object saved_object
;
18126 saved_object
= it
->object
;
18127 saved_pos
= it
->position
;
18129 it
->what
= IT_CHARACTER
;
18130 memset (&it
->position
, 0, sizeof it
->position
);
18131 it
->object
= make_number (0);
18132 it
->c
= it
->char_to_display
= ' ';
18135 if (default_face_p
)
18136 it
->face_id
= DEFAULT_FACE_ID
;
18137 else if (it
->face_before_selective_p
)
18138 it
->face_id
= it
->saved_face_id
;
18139 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18140 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18142 PRODUCE_GLYPHS (it
);
18144 it
->override_ascent
= -1;
18145 it
->constrain_row_ascent_descent_p
= 0;
18146 it
->current_x
= saved_x
;
18147 it
->object
= saved_object
;
18148 it
->position
= saved_pos
;
18149 it
->what
= saved_what
;
18150 it
->face_id
= saved_face_id
;
18151 it
->len
= saved_len
;
18153 it
->char_to_display
= saved_char_to_display
;
18162 /* Extend the face of the last glyph in the text area of IT->glyph_row
18163 to the end of the display line. Called from display_line. If the
18164 glyph row is empty, add a space glyph to it so that we know the
18165 face to draw. Set the glyph row flag fill_line_p. If the glyph
18166 row is R2L, prepend a stretch glyph to cover the empty space to the
18167 left of the leftmost glyph. */
18170 extend_face_to_end_of_line (struct it
*it
)
18173 struct frame
*f
= it
->f
;
18175 /* If line is already filled, do nothing. Non window-system frames
18176 get a grace of one more ``pixel'' because their characters are
18177 1-``pixel'' wide, so they hit the equality too early. This grace
18178 is needed only for R2L rows that are not continued, to produce
18179 one extra blank where we could display the cursor. */
18180 if (it
->current_x
>= it
->last_visible_x
18181 + (!FRAME_WINDOW_P (f
)
18182 && it
->glyph_row
->reversed_p
18183 && !it
->glyph_row
->continued_p
))
18186 /* Face extension extends the background and box of IT->face_id
18187 to the end of the line. If the background equals the background
18188 of the frame, we don't have to do anything. */
18189 if (it
->face_before_selective_p
)
18190 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18192 face
= FACE_FROM_ID (f
, it
->face_id
);
18194 if (FRAME_WINDOW_P (f
)
18195 && it
->glyph_row
->displays_text_p
18196 && face
->box
== FACE_NO_BOX
18197 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18199 && !it
->glyph_row
->reversed_p
)
18202 /* Set the glyph row flag indicating that the face of the last glyph
18203 in the text area has to be drawn to the end of the text area. */
18204 it
->glyph_row
->fill_line_p
= 1;
18206 /* If current character of IT is not ASCII, make sure we have the
18207 ASCII face. This will be automatically undone the next time
18208 get_next_display_element returns a multibyte character. Note
18209 that the character will always be single byte in unibyte
18211 if (!ASCII_CHAR_P (it
->c
))
18213 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18216 if (FRAME_WINDOW_P (f
))
18218 /* If the row is empty, add a space with the current face of IT,
18219 so that we know which face to draw. */
18220 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18222 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18223 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18224 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18226 #ifdef HAVE_WINDOW_SYSTEM
18227 if (it
->glyph_row
->reversed_p
)
18229 /* Prepend a stretch glyph to the row, such that the
18230 rightmost glyph will be drawn flushed all the way to the
18231 right margin of the window. The stretch glyph that will
18232 occupy the empty space, if any, to the left of the
18234 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18235 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18236 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18238 int row_width
, stretch_ascent
, stretch_width
;
18239 struct text_pos saved_pos
;
18240 int saved_face_id
, saved_avoid_cursor
;
18242 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18243 row_width
+= g
->pixel_width
;
18244 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18245 if (stretch_width
> 0)
18248 (((it
->ascent
+ it
->descent
)
18249 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18250 saved_pos
= it
->position
;
18251 memset (&it
->position
, 0, sizeof it
->position
);
18252 saved_avoid_cursor
= it
->avoid_cursor_p
;
18253 it
->avoid_cursor_p
= 1;
18254 saved_face_id
= it
->face_id
;
18255 /* The last row's stretch glyph should get the default
18256 face, to avoid painting the rest of the window with
18257 the region face, if the region ends at ZV. */
18258 if (it
->glyph_row
->ends_at_zv_p
)
18259 it
->face_id
= DEFAULT_FACE_ID
;
18261 it
->face_id
= face
->id
;
18262 append_stretch_glyph (it
, make_number (0), stretch_width
,
18263 it
->ascent
+ it
->descent
, stretch_ascent
);
18264 it
->position
= saved_pos
;
18265 it
->avoid_cursor_p
= saved_avoid_cursor
;
18266 it
->face_id
= saved_face_id
;
18269 #endif /* HAVE_WINDOW_SYSTEM */
18273 /* Save some values that must not be changed. */
18274 int saved_x
= it
->current_x
;
18275 struct text_pos saved_pos
;
18276 Lisp_Object saved_object
;
18277 enum display_element_type saved_what
= it
->what
;
18278 int saved_face_id
= it
->face_id
;
18280 saved_object
= it
->object
;
18281 saved_pos
= it
->position
;
18283 it
->what
= IT_CHARACTER
;
18284 memset (&it
->position
, 0, sizeof it
->position
);
18285 it
->object
= make_number (0);
18286 it
->c
= it
->char_to_display
= ' ';
18288 /* The last row's blank glyphs should get the default face, to
18289 avoid painting the rest of the window with the region face,
18290 if the region ends at ZV. */
18291 if (it
->glyph_row
->ends_at_zv_p
)
18292 it
->face_id
= DEFAULT_FACE_ID
;
18294 it
->face_id
= face
->id
;
18296 PRODUCE_GLYPHS (it
);
18298 while (it
->current_x
<= it
->last_visible_x
)
18299 PRODUCE_GLYPHS (it
);
18301 /* Don't count these blanks really. It would let us insert a left
18302 truncation glyph below and make us set the cursor on them, maybe. */
18303 it
->current_x
= saved_x
;
18304 it
->object
= saved_object
;
18305 it
->position
= saved_pos
;
18306 it
->what
= saved_what
;
18307 it
->face_id
= saved_face_id
;
18312 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18313 trailing whitespace. */
18316 trailing_whitespace_p (EMACS_INT charpos
)
18318 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18321 while (bytepos
< ZV_BYTE
18322 && (c
= FETCH_CHAR (bytepos
),
18323 c
== ' ' || c
== '\t'))
18326 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18328 if (bytepos
!= PT_BYTE
)
18335 /* Highlight trailing whitespace, if any, in ROW. */
18338 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18340 int used
= row
->used
[TEXT_AREA
];
18344 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18345 struct glyph
*glyph
= start
+ used
- 1;
18347 if (row
->reversed_p
)
18349 /* Right-to-left rows need to be processed in the opposite
18350 direction, so swap the edge pointers. */
18352 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18355 /* Skip over glyphs inserted to display the cursor at the
18356 end of a line, for extending the face of the last glyph
18357 to the end of the line on terminals, and for truncation
18358 and continuation glyphs. */
18359 if (!row
->reversed_p
)
18361 while (glyph
>= start
18362 && glyph
->type
== CHAR_GLYPH
18363 && INTEGERP (glyph
->object
))
18368 while (glyph
<= start
18369 && glyph
->type
== CHAR_GLYPH
18370 && INTEGERP (glyph
->object
))
18374 /* If last glyph is a space or stretch, and it's trailing
18375 whitespace, set the face of all trailing whitespace glyphs in
18376 IT->glyph_row to `trailing-whitespace'. */
18377 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18378 && BUFFERP (glyph
->object
)
18379 && (glyph
->type
== STRETCH_GLYPH
18380 || (glyph
->type
== CHAR_GLYPH
18381 && glyph
->u
.ch
== ' '))
18382 && trailing_whitespace_p (glyph
->charpos
))
18384 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18388 if (!row
->reversed_p
)
18390 while (glyph
>= start
18391 && BUFFERP (glyph
->object
)
18392 && (glyph
->type
== STRETCH_GLYPH
18393 || (glyph
->type
== CHAR_GLYPH
18394 && glyph
->u
.ch
== ' ')))
18395 (glyph
--)->face_id
= face_id
;
18399 while (glyph
<= start
18400 && BUFFERP (glyph
->object
)
18401 && (glyph
->type
== STRETCH_GLYPH
18402 || (glyph
->type
== CHAR_GLYPH
18403 && glyph
->u
.ch
== ' ')))
18404 (glyph
++)->face_id
= face_id
;
18411 /* Value is non-zero if glyph row ROW should be
18412 used to hold the cursor. */
18415 cursor_row_p (struct glyph_row
*row
)
18419 if (PT
== CHARPOS (row
->end
.pos
)
18420 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18422 /* Suppose the row ends on a string.
18423 Unless the row is continued, that means it ends on a newline
18424 in the string. If it's anything other than a display string
18425 (e.g. a before-string from an overlay), we don't want the
18426 cursor there. (This heuristic seems to give the optimal
18427 behavior for the various types of multi-line strings.) */
18428 if (CHARPOS (row
->end
.string_pos
) >= 0)
18430 if (row
->continued_p
)
18434 /* Check for `display' property. */
18435 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18436 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18437 struct glyph
*glyph
;
18440 for (glyph
= end
; glyph
>= beg
; --glyph
)
18441 if (STRINGP (glyph
->object
))
18444 = Fget_char_property (make_number (PT
),
18448 && display_prop_string_p (prop
, glyph
->object
));
18453 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18455 /* If the row ends in middle of a real character,
18456 and the line is continued, we want the cursor here.
18457 That's because CHARPOS (ROW->end.pos) would equal
18458 PT if PT is before the character. */
18459 if (!row
->ends_in_ellipsis_p
)
18460 result
= row
->continued_p
;
18462 /* If the row ends in an ellipsis, then
18463 CHARPOS (ROW->end.pos) will equal point after the
18464 invisible text. We want that position to be displayed
18465 after the ellipsis. */
18468 /* If the row ends at ZV, display the cursor at the end of that
18469 row instead of at the start of the row below. */
18470 else if (row
->ends_at_zv_p
)
18481 /* Push the property PROP so that it will be rendered at the current
18482 position in IT. Return 1 if PROP was successfully pushed, 0
18483 otherwise. Called from handle_line_prefix to handle the
18484 `line-prefix' and `wrap-prefix' properties. */
18487 push_display_prop (struct it
*it
, Lisp_Object prop
)
18489 struct text_pos pos
=
18490 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18492 xassert (it
->method
== GET_FROM_BUFFER
18493 || it
->method
== GET_FROM_DISPLAY_VECTOR
18494 || it
->method
== GET_FROM_STRING
);
18496 /* We need to save the current buffer/string position, so it will be
18497 restored by pop_it, because iterate_out_of_display_property
18498 depends on that being set correctly, but some situations leave
18499 it->position not yet set when this function is called. */
18500 push_it (it
, &pos
);
18502 if (STRINGP (prop
))
18504 if (SCHARS (prop
) == 0)
18511 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18512 it
->current
.overlay_string_index
= -1;
18513 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18514 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18515 it
->method
= GET_FROM_STRING
;
18516 it
->stop_charpos
= 0;
18518 it
->base_level_stop
= 0;
18520 /* Force paragraph direction to be that of the parent
18522 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18523 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18525 it
->paragraph_embedding
= L2R
;
18527 /* Set up the bidi iterator for this display string. */
18530 it
->bidi_it
.string
.lstring
= it
->string
;
18531 it
->bidi_it
.string
.s
= NULL
;
18532 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18533 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18534 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18535 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18536 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18539 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18541 it
->method
= GET_FROM_STRETCH
;
18544 #ifdef HAVE_WINDOW_SYSTEM
18545 else if (IMAGEP (prop
))
18547 it
->what
= IT_IMAGE
;
18548 it
->image_id
= lookup_image (it
->f
, prop
);
18549 it
->method
= GET_FROM_IMAGE
;
18551 #endif /* HAVE_WINDOW_SYSTEM */
18554 pop_it (it
); /* bogus display property, give up */
18561 /* Return the character-property PROP at the current position in IT. */
18564 get_it_property (struct it
*it
, Lisp_Object prop
)
18566 Lisp_Object position
;
18568 if (STRINGP (it
->object
))
18569 position
= make_number (IT_STRING_CHARPOS (*it
));
18570 else if (BUFFERP (it
->object
))
18571 position
= make_number (IT_CHARPOS (*it
));
18575 return Fget_char_property (position
, prop
, it
->object
);
18578 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18581 handle_line_prefix (struct it
*it
)
18583 Lisp_Object prefix
;
18585 if (it
->continuation_lines_width
> 0)
18587 prefix
= get_it_property (it
, Qwrap_prefix
);
18589 prefix
= Vwrap_prefix
;
18593 prefix
= get_it_property (it
, Qline_prefix
);
18595 prefix
= Vline_prefix
;
18597 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18599 /* If the prefix is wider than the window, and we try to wrap
18600 it, it would acquire its own wrap prefix, and so on till the
18601 iterator stack overflows. So, don't wrap the prefix. */
18602 it
->line_wrap
= TRUNCATE
;
18603 it
->avoid_cursor_p
= 1;
18609 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18610 only for R2L lines from display_line and display_string, when they
18611 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18612 the line/string needs to be continued on the next glyph row. */
18614 unproduce_glyphs (struct it
*it
, int n
)
18616 struct glyph
*glyph
, *end
;
18618 xassert (it
->glyph_row
);
18619 xassert (it
->glyph_row
->reversed_p
);
18620 xassert (it
->area
== TEXT_AREA
);
18621 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18623 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18624 n
= it
->glyph_row
->used
[TEXT_AREA
];
18625 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18626 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18627 for ( ; glyph
< end
; glyph
++)
18628 glyph
[-n
] = *glyph
;
18631 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18632 and ROW->maxpos. */
18634 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18635 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18636 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18638 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18639 lines' rows is implemented for bidi-reordered rows. */
18641 /* ROW->minpos is the value of min_pos, the minimal buffer position
18642 we have in ROW, or ROW->start.pos if that is smaller. */
18643 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18644 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18646 /* We didn't find buffer positions smaller than ROW->start, or
18647 didn't find _any_ valid buffer positions in any of the glyphs,
18648 so we must trust the iterator's computed positions. */
18649 row
->minpos
= row
->start
.pos
;
18652 max_pos
= CHARPOS (it
->current
.pos
);
18653 max_bpos
= BYTEPOS (it
->current
.pos
);
18656 /* Here are the various use-cases for ending the row, and the
18657 corresponding values for ROW->maxpos:
18659 Line ends in a newline from buffer eol_pos + 1
18660 Line is continued from buffer max_pos + 1
18661 Line is truncated on right it->current.pos
18662 Line ends in a newline from string max_pos + 1(*)
18663 (*) + 1 only when line ends in a forward scan
18664 Line is continued from string max_pos
18665 Line is continued from display vector max_pos
18666 Line is entirely from a string min_pos == max_pos
18667 Line is entirely from a display vector min_pos == max_pos
18668 Line that ends at ZV ZV
18670 If you discover other use-cases, please add them here as
18672 if (row
->ends_at_zv_p
)
18673 row
->maxpos
= it
->current
.pos
;
18674 else if (row
->used
[TEXT_AREA
])
18676 int seen_this_string
= 0;
18677 struct glyph_row
*r1
= row
- 1;
18679 /* Did we see the same display string on the previous row? */
18680 if (STRINGP (it
->object
)
18681 /* this is not the first row */
18682 && row
> it
->w
->desired_matrix
->rows
18683 /* previous row is not the header line */
18684 && !r1
->mode_line_p
18685 /* previous row also ends in a newline from a string */
18686 && r1
->ends_in_newline_from_string_p
)
18688 struct glyph
*start
, *end
;
18690 /* Search for the last glyph of the previous row that came
18691 from buffer or string. Depending on whether the row is
18692 L2R or R2L, we need to process it front to back or the
18693 other way round. */
18694 if (!r1
->reversed_p
)
18696 start
= r1
->glyphs
[TEXT_AREA
];
18697 end
= start
+ r1
->used
[TEXT_AREA
];
18698 /* Glyphs inserted by redisplay have an integer (zero)
18699 as their object. */
18701 && INTEGERP ((end
- 1)->object
)
18702 && (end
- 1)->charpos
<= 0)
18706 if (EQ ((end
- 1)->object
, it
->object
))
18707 seen_this_string
= 1;
18710 /* If all the glyphs of the previous row were inserted
18711 by redisplay, it means the previous row was
18712 produced from a single newline, which is only
18713 possible if that newline came from the same string
18714 as the one which produced this ROW. */
18715 seen_this_string
= 1;
18719 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18720 start
= end
+ r1
->used
[TEXT_AREA
];
18722 && INTEGERP ((end
+ 1)->object
)
18723 && (end
+ 1)->charpos
<= 0)
18727 if (EQ ((end
+ 1)->object
, it
->object
))
18728 seen_this_string
= 1;
18731 seen_this_string
= 1;
18734 /* Take note of each display string that covers a newline only
18735 once, the first time we see it. This is for when a display
18736 string includes more than one newline in it. */
18737 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18739 /* If we were scanning the buffer forward when we displayed
18740 the string, we want to account for at least one buffer
18741 position that belongs to this row (position covered by
18742 the display string), so that cursor positioning will
18743 consider this row as a candidate when point is at the end
18744 of the visual line represented by this row. This is not
18745 required when scanning back, because max_pos will already
18746 have a much larger value. */
18747 if (CHARPOS (row
->end
.pos
) > max_pos
)
18748 INC_BOTH (max_pos
, max_bpos
);
18749 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18751 else if (CHARPOS (it
->eol_pos
) > 0)
18752 SET_TEXT_POS (row
->maxpos
,
18753 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18754 else if (row
->continued_p
)
18756 /* If max_pos is different from IT's current position, it
18757 means IT->method does not belong to the display element
18758 at max_pos. However, it also means that the display
18759 element at max_pos was displayed in its entirety on this
18760 line, which is equivalent to saying that the next line
18761 starts at the next buffer position. */
18762 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18763 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18766 INC_BOTH (max_pos
, max_bpos
);
18767 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18770 else if (row
->truncated_on_right_p
)
18771 /* display_line already called reseat_at_next_visible_line_start,
18772 which puts the iterator at the beginning of the next line, in
18773 the logical order. */
18774 row
->maxpos
= it
->current
.pos
;
18775 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18776 /* A line that is entirely from a string/image/stretch... */
18777 row
->maxpos
= row
->minpos
;
18782 row
->maxpos
= it
->current
.pos
;
18785 /* Construct the glyph row IT->glyph_row in the desired matrix of
18786 IT->w from text at the current position of IT. See dispextern.h
18787 for an overview of struct it. Value is non-zero if
18788 IT->glyph_row displays text, as opposed to a line displaying ZV
18792 display_line (struct it
*it
)
18794 struct glyph_row
*row
= it
->glyph_row
;
18795 Lisp_Object overlay_arrow_string
;
18797 void *wrap_data
= NULL
;
18798 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18799 int wrap_row_used
= -1;
18800 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18801 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18802 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18803 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18804 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18806 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18807 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18809 /* We always start displaying at hpos zero even if hscrolled. */
18810 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18812 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18813 >= it
->w
->desired_matrix
->nrows
)
18815 it
->w
->nrows_scale_factor
++;
18816 fonts_changed_p
= 1;
18820 /* Is IT->w showing the region? */
18821 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18823 /* Clear the result glyph row and enable it. */
18824 prepare_desired_row (row
);
18826 row
->y
= it
->current_y
;
18827 row
->start
= it
->start
;
18828 row
->continuation_lines_width
= it
->continuation_lines_width
;
18829 row
->displays_text_p
= 1;
18830 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18831 it
->starts_in_middle_of_char_p
= 0;
18833 /* Arrange the overlays nicely for our purposes. Usually, we call
18834 display_line on only one line at a time, in which case this
18835 can't really hurt too much, or we call it on lines which appear
18836 one after another in the buffer, in which case all calls to
18837 recenter_overlay_lists but the first will be pretty cheap. */
18838 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18840 /* Move over display elements that are not visible because we are
18841 hscrolled. This may stop at an x-position < IT->first_visible_x
18842 if the first glyph is partially visible or if we hit a line end. */
18843 if (it
->current_x
< it
->first_visible_x
)
18845 this_line_min_pos
= row
->start
.pos
;
18846 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18847 MOVE_TO_POS
| MOVE_TO_X
);
18848 /* Record the smallest positions seen while we moved over
18849 display elements that are not visible. This is needed by
18850 redisplay_internal for optimizing the case where the cursor
18851 stays inside the same line. The rest of this function only
18852 considers positions that are actually displayed, so
18853 RECORD_MAX_MIN_POS will not otherwise record positions that
18854 are hscrolled to the left of the left edge of the window. */
18855 min_pos
= CHARPOS (this_line_min_pos
);
18856 min_bpos
= BYTEPOS (this_line_min_pos
);
18860 /* We only do this when not calling `move_it_in_display_line_to'
18861 above, because move_it_in_display_line_to calls
18862 handle_line_prefix itself. */
18863 handle_line_prefix (it
);
18866 /* Get the initial row height. This is either the height of the
18867 text hscrolled, if there is any, or zero. */
18868 row
->ascent
= it
->max_ascent
;
18869 row
->height
= it
->max_ascent
+ it
->max_descent
;
18870 row
->phys_ascent
= it
->max_phys_ascent
;
18871 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18872 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18874 /* Utility macro to record max and min buffer positions seen until now. */
18875 #define RECORD_MAX_MIN_POS(IT) \
18878 int composition_p = (IT)->what == IT_COMPOSITION; \
18879 EMACS_INT current_pos = \
18880 composition_p ? (IT)->cmp_it.charpos \
18881 : IT_CHARPOS (*(IT)); \
18882 EMACS_INT current_bpos = \
18883 composition_p ? CHAR_TO_BYTE (current_pos) \
18884 : IT_BYTEPOS (*(IT)); \
18885 if (current_pos < min_pos) \
18887 min_pos = current_pos; \
18888 min_bpos = current_bpos; \
18890 if (IT_CHARPOS (*it) > max_pos) \
18892 max_pos = IT_CHARPOS (*it); \
18893 max_bpos = IT_BYTEPOS (*it); \
18898 /* Loop generating characters. The loop is left with IT on the next
18899 character to display. */
18902 int n_glyphs_before
, hpos_before
, x_before
;
18904 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18906 /* Retrieve the next thing to display. Value is zero if end of
18908 if (!get_next_display_element (it
))
18910 /* Maybe add a space at the end of this line that is used to
18911 display the cursor there under X. Set the charpos of the
18912 first glyph of blank lines not corresponding to any text
18914 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18915 row
->exact_window_width_line_p
= 1;
18916 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18917 || row
->used
[TEXT_AREA
] == 0)
18919 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18920 row
->displays_text_p
= 0;
18922 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18923 && (!MINI_WINDOW_P (it
->w
)
18924 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18925 row
->indicate_empty_line_p
= 1;
18928 it
->continuation_lines_width
= 0;
18929 row
->ends_at_zv_p
= 1;
18930 /* A row that displays right-to-left text must always have
18931 its last face extended all the way to the end of line,
18932 even if this row ends in ZV, because we still write to
18933 the screen left to right. */
18934 if (row
->reversed_p
)
18935 extend_face_to_end_of_line (it
);
18939 /* Now, get the metrics of what we want to display. This also
18940 generates glyphs in `row' (which is IT->glyph_row). */
18941 n_glyphs_before
= row
->used
[TEXT_AREA
];
18944 /* Remember the line height so far in case the next element doesn't
18945 fit on the line. */
18946 if (it
->line_wrap
!= TRUNCATE
)
18948 ascent
= it
->max_ascent
;
18949 descent
= it
->max_descent
;
18950 phys_ascent
= it
->max_phys_ascent
;
18951 phys_descent
= it
->max_phys_descent
;
18953 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18955 if (IT_DISPLAYING_WHITESPACE (it
))
18959 SAVE_IT (wrap_it
, *it
, wrap_data
);
18961 wrap_row_used
= row
->used
[TEXT_AREA
];
18962 wrap_row_ascent
= row
->ascent
;
18963 wrap_row_height
= row
->height
;
18964 wrap_row_phys_ascent
= row
->phys_ascent
;
18965 wrap_row_phys_height
= row
->phys_height
;
18966 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18967 wrap_row_min_pos
= min_pos
;
18968 wrap_row_min_bpos
= min_bpos
;
18969 wrap_row_max_pos
= max_pos
;
18970 wrap_row_max_bpos
= max_bpos
;
18976 PRODUCE_GLYPHS (it
);
18978 /* If this display element was in marginal areas, continue with
18980 if (it
->area
!= TEXT_AREA
)
18982 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18983 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18984 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18985 row
->phys_height
= max (row
->phys_height
,
18986 it
->max_phys_ascent
+ it
->max_phys_descent
);
18987 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18988 it
->max_extra_line_spacing
);
18989 set_iterator_to_next (it
, 1);
18993 /* Does the display element fit on the line? If we truncate
18994 lines, we should draw past the right edge of the window. If
18995 we don't truncate, we want to stop so that we can display the
18996 continuation glyph before the right margin. If lines are
18997 continued, there are two possible strategies for characters
18998 resulting in more than 1 glyph (e.g. tabs): Display as many
18999 glyphs as possible in this line and leave the rest for the
19000 continuation line, or display the whole element in the next
19001 line. Original redisplay did the former, so we do it also. */
19002 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19003 hpos_before
= it
->hpos
;
19006 if (/* Not a newline. */
19008 /* Glyphs produced fit entirely in the line. */
19009 && it
->current_x
< it
->last_visible_x
)
19011 it
->hpos
+= nglyphs
;
19012 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19013 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19014 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19015 row
->phys_height
= max (row
->phys_height
,
19016 it
->max_phys_ascent
+ it
->max_phys_descent
);
19017 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19018 it
->max_extra_line_spacing
);
19019 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19020 row
->x
= x
- it
->first_visible_x
;
19021 /* Record the maximum and minimum buffer positions seen so
19022 far in glyphs that will be displayed by this row. */
19024 RECORD_MAX_MIN_POS (it
);
19029 struct glyph
*glyph
;
19031 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19033 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19034 new_x
= x
+ glyph
->pixel_width
;
19036 if (/* Lines are continued. */
19037 it
->line_wrap
!= TRUNCATE
19038 && (/* Glyph doesn't fit on the line. */
19039 new_x
> it
->last_visible_x
19040 /* Or it fits exactly on a window system frame. */
19041 || (new_x
== it
->last_visible_x
19042 && FRAME_WINDOW_P (it
->f
))))
19044 /* End of a continued line. */
19047 || (new_x
== it
->last_visible_x
19048 && FRAME_WINDOW_P (it
->f
)))
19050 /* Current glyph is the only one on the line or
19051 fits exactly on the line. We must continue
19052 the line because we can't draw the cursor
19053 after the glyph. */
19054 row
->continued_p
= 1;
19055 it
->current_x
= new_x
;
19056 it
->continuation_lines_width
+= new_x
;
19058 if (i
== nglyphs
- 1)
19060 /* If line-wrap is on, check if a previous
19061 wrap point was found. */
19062 if (wrap_row_used
> 0
19063 /* Even if there is a previous wrap
19064 point, continue the line here as
19065 usual, if (i) the previous character
19066 was a space or tab AND (ii) the
19067 current character is not. */
19069 || IT_DISPLAYING_WHITESPACE (it
)))
19072 /* Record the maximum and minimum buffer
19073 positions seen so far in glyphs that will be
19074 displayed by this row. */
19076 RECORD_MAX_MIN_POS (it
);
19077 set_iterator_to_next (it
, 1);
19078 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19080 if (!get_next_display_element (it
))
19082 row
->exact_window_width_line_p
= 1;
19083 it
->continuation_lines_width
= 0;
19084 row
->continued_p
= 0;
19085 row
->ends_at_zv_p
= 1;
19087 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19089 row
->continued_p
= 0;
19090 row
->exact_window_width_line_p
= 1;
19094 else if (it
->bidi_p
)
19095 RECORD_MAX_MIN_POS (it
);
19097 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19098 && !FRAME_WINDOW_P (it
->f
))
19100 /* A padding glyph that doesn't fit on this line.
19101 This means the whole character doesn't fit
19103 if (row
->reversed_p
)
19104 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19105 - n_glyphs_before
);
19106 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19108 /* Fill the rest of the row with continuation
19109 glyphs like in 20.x. */
19110 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19111 < row
->glyphs
[1 + TEXT_AREA
])
19112 produce_special_glyphs (it
, IT_CONTINUATION
);
19114 row
->continued_p
= 1;
19115 it
->current_x
= x_before
;
19116 it
->continuation_lines_width
+= x_before
;
19118 /* Restore the height to what it was before the
19119 element not fitting on the line. */
19120 it
->max_ascent
= ascent
;
19121 it
->max_descent
= descent
;
19122 it
->max_phys_ascent
= phys_ascent
;
19123 it
->max_phys_descent
= phys_descent
;
19125 else if (wrap_row_used
> 0)
19128 if (row
->reversed_p
)
19129 unproduce_glyphs (it
,
19130 row
->used
[TEXT_AREA
] - wrap_row_used
);
19131 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19132 it
->continuation_lines_width
+= wrap_x
;
19133 row
->used
[TEXT_AREA
] = wrap_row_used
;
19134 row
->ascent
= wrap_row_ascent
;
19135 row
->height
= wrap_row_height
;
19136 row
->phys_ascent
= wrap_row_phys_ascent
;
19137 row
->phys_height
= wrap_row_phys_height
;
19138 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19139 min_pos
= wrap_row_min_pos
;
19140 min_bpos
= wrap_row_min_bpos
;
19141 max_pos
= wrap_row_max_pos
;
19142 max_bpos
= wrap_row_max_bpos
;
19143 row
->continued_p
= 1;
19144 row
->ends_at_zv_p
= 0;
19145 row
->exact_window_width_line_p
= 0;
19146 it
->continuation_lines_width
+= x
;
19148 /* Make sure that a non-default face is extended
19149 up to the right margin of the window. */
19150 extend_face_to_end_of_line (it
);
19152 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19154 /* A TAB that extends past the right edge of the
19155 window. This produces a single glyph on
19156 window system frames. We leave the glyph in
19157 this row and let it fill the row, but don't
19158 consume the TAB. */
19159 it
->continuation_lines_width
+= it
->last_visible_x
;
19160 row
->ends_in_middle_of_char_p
= 1;
19161 row
->continued_p
= 1;
19162 glyph
->pixel_width
= it
->last_visible_x
- x
;
19163 it
->starts_in_middle_of_char_p
= 1;
19167 /* Something other than a TAB that draws past
19168 the right edge of the window. Restore
19169 positions to values before the element. */
19170 if (row
->reversed_p
)
19171 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19172 - (n_glyphs_before
+ i
));
19173 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19175 /* Display continuation glyphs. */
19176 if (!FRAME_WINDOW_P (it
->f
))
19177 produce_special_glyphs (it
, IT_CONTINUATION
);
19178 row
->continued_p
= 1;
19180 it
->current_x
= x_before
;
19181 it
->continuation_lines_width
+= x
;
19182 extend_face_to_end_of_line (it
);
19184 if (nglyphs
> 1 && i
> 0)
19186 row
->ends_in_middle_of_char_p
= 1;
19187 it
->starts_in_middle_of_char_p
= 1;
19190 /* Restore the height to what it was before the
19191 element not fitting on the line. */
19192 it
->max_ascent
= ascent
;
19193 it
->max_descent
= descent
;
19194 it
->max_phys_ascent
= phys_ascent
;
19195 it
->max_phys_descent
= phys_descent
;
19200 else if (new_x
> it
->first_visible_x
)
19202 /* Increment number of glyphs actually displayed. */
19205 /* Record the maximum and minimum buffer positions
19206 seen so far in glyphs that will be displayed by
19209 RECORD_MAX_MIN_POS (it
);
19211 if (x
< it
->first_visible_x
)
19212 /* Glyph is partially visible, i.e. row starts at
19213 negative X position. */
19214 row
->x
= x
- it
->first_visible_x
;
19218 /* Glyph is completely off the left margin of the
19219 window. This should not happen because of the
19220 move_it_in_display_line at the start of this
19221 function, unless the text display area of the
19222 window is empty. */
19223 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19226 /* Even if this display element produced no glyphs at all,
19227 we want to record its position. */
19228 if (it
->bidi_p
&& nglyphs
== 0)
19229 RECORD_MAX_MIN_POS (it
);
19231 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19232 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19233 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19234 row
->phys_height
= max (row
->phys_height
,
19235 it
->max_phys_ascent
+ it
->max_phys_descent
);
19236 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19237 it
->max_extra_line_spacing
);
19239 /* End of this display line if row is continued. */
19240 if (row
->continued_p
|| row
->ends_at_zv_p
)
19245 /* Is this a line end? If yes, we're also done, after making
19246 sure that a non-default face is extended up to the right
19247 margin of the window. */
19248 if (ITERATOR_AT_END_OF_LINE_P (it
))
19250 int used_before
= row
->used
[TEXT_AREA
];
19252 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19254 /* Add a space at the end of the line that is used to
19255 display the cursor there. */
19256 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19257 append_space_for_newline (it
, 0);
19259 /* Extend the face to the end of the line. */
19260 extend_face_to_end_of_line (it
);
19262 /* Make sure we have the position. */
19263 if (used_before
== 0)
19264 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19266 /* Record the position of the newline, for use in
19268 it
->eol_pos
= it
->current
.pos
;
19270 /* Consume the line end. This skips over invisible lines. */
19271 set_iterator_to_next (it
, 1);
19272 it
->continuation_lines_width
= 0;
19276 /* Proceed with next display element. Note that this skips
19277 over lines invisible because of selective display. */
19278 set_iterator_to_next (it
, 1);
19280 /* If we truncate lines, we are done when the last displayed
19281 glyphs reach past the right margin of the window. */
19282 if (it
->line_wrap
== TRUNCATE
19283 && (FRAME_WINDOW_P (it
->f
)
19284 ? (it
->current_x
>= it
->last_visible_x
)
19285 : (it
->current_x
> it
->last_visible_x
)))
19287 /* Maybe add truncation glyphs. */
19288 if (!FRAME_WINDOW_P (it
->f
))
19292 if (!row
->reversed_p
)
19294 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19295 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19300 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19301 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19303 /* Remove any padding glyphs at the front of ROW, to
19304 make room for the truncation glyphs we will be
19305 adding below. The loop below always inserts at
19306 least one truncation glyph, so also remove the
19307 last glyph added to ROW. */
19308 unproduce_glyphs (it
, i
+ 1);
19309 /* Adjust i for the loop below. */
19310 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19313 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19315 row
->used
[TEXT_AREA
] = i
;
19316 produce_special_glyphs (it
, IT_TRUNCATION
);
19319 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19321 /* Don't truncate if we can overflow newline into fringe. */
19322 if (!get_next_display_element (it
))
19324 it
->continuation_lines_width
= 0;
19325 row
->ends_at_zv_p
= 1;
19326 row
->exact_window_width_line_p
= 1;
19329 if (ITERATOR_AT_END_OF_LINE_P (it
))
19331 row
->exact_window_width_line_p
= 1;
19332 goto at_end_of_line
;
19336 row
->truncated_on_right_p
= 1;
19337 it
->continuation_lines_width
= 0;
19338 reseat_at_next_visible_line_start (it
, 0);
19339 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19340 it
->hpos
= hpos_before
;
19341 it
->current_x
= x_before
;
19347 bidi_unshelve_cache (wrap_data
, 1);
19349 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19350 at the left window margin. */
19351 if (it
->first_visible_x
19352 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19354 if (!FRAME_WINDOW_P (it
->f
))
19355 insert_left_trunc_glyphs (it
);
19356 row
->truncated_on_left_p
= 1;
19359 /* Remember the position at which this line ends.
19361 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19362 cannot be before the call to find_row_edges below, since that is
19363 where these positions are determined. */
19364 row
->end
= it
->current
;
19367 row
->minpos
= row
->start
.pos
;
19368 row
->maxpos
= row
->end
.pos
;
19372 /* ROW->minpos and ROW->maxpos must be the smallest and
19373 `1 + the largest' buffer positions in ROW. But if ROW was
19374 bidi-reordered, these two positions can be anywhere in the
19375 row, so we must determine them now. */
19376 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19379 /* If the start of this line is the overlay arrow-position, then
19380 mark this glyph row as the one containing the overlay arrow.
19381 This is clearly a mess with variable size fonts. It would be
19382 better to let it be displayed like cursors under X. */
19383 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19384 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19385 !NILP (overlay_arrow_string
)))
19387 /* Overlay arrow in window redisplay is a fringe bitmap. */
19388 if (STRINGP (overlay_arrow_string
))
19390 struct glyph_row
*arrow_row
19391 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19392 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19393 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19394 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19395 struct glyph
*p2
, *end
;
19397 /* Copy the arrow glyphs. */
19398 while (glyph
< arrow_end
)
19401 /* Throw away padding glyphs. */
19403 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19404 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19410 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19415 xassert (INTEGERP (overlay_arrow_string
));
19416 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19418 overlay_arrow_seen
= 1;
19421 /* Highlight trailing whitespace. */
19422 if (!NILP (Vshow_trailing_whitespace
))
19423 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19425 /* Compute pixel dimensions of this line. */
19426 compute_line_metrics (it
);
19428 /* Implementation note: No changes in the glyphs of ROW or in their
19429 faces can be done past this point, because compute_line_metrics
19430 computes ROW's hash value and stores it within the glyph_row
19433 /* Record whether this row ends inside an ellipsis. */
19434 row
->ends_in_ellipsis_p
19435 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19436 && it
->ellipsis_p
);
19438 /* Save fringe bitmaps in this row. */
19439 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19440 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19441 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19442 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19444 it
->left_user_fringe_bitmap
= 0;
19445 it
->left_user_fringe_face_id
= 0;
19446 it
->right_user_fringe_bitmap
= 0;
19447 it
->right_user_fringe_face_id
= 0;
19449 /* Maybe set the cursor. */
19450 cvpos
= it
->w
->cursor
.vpos
;
19452 /* In bidi-reordered rows, keep checking for proper cursor
19453 position even if one has been found already, because buffer
19454 positions in such rows change non-linearly with ROW->VPOS,
19455 when a line is continued. One exception: when we are at ZV,
19456 display cursor on the first suitable glyph row, since all
19457 the empty rows after that also have their position set to ZV. */
19458 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19459 lines' rows is implemented for bidi-reordered rows. */
19461 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19462 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19463 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19464 && cursor_row_p (row
))
19465 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19467 /* Prepare for the next line. This line starts horizontally at (X
19468 HPOS) = (0 0). Vertical positions are incremented. As a
19469 convenience for the caller, IT->glyph_row is set to the next
19471 it
->current_x
= it
->hpos
= 0;
19472 it
->current_y
+= row
->height
;
19473 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19476 /* The next row should by default use the same value of the
19477 reversed_p flag as this one. set_iterator_to_next decides when
19478 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19479 the flag accordingly. */
19480 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19481 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19482 it
->start
= row
->end
;
19483 return row
->displays_text_p
;
19485 #undef RECORD_MAX_MIN_POS
19488 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19489 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19490 doc
: /* Return paragraph direction at point in BUFFER.
19491 Value is either `left-to-right' or `right-to-left'.
19492 If BUFFER is omitted or nil, it defaults to the current buffer.
19494 Paragraph direction determines how the text in the paragraph is displayed.
19495 In left-to-right paragraphs, text begins at the left margin of the window
19496 and the reading direction is generally left to right. In right-to-left
19497 paragraphs, text begins at the right margin and is read from right to left.
19499 See also `bidi-paragraph-direction'. */)
19500 (Lisp_Object buffer
)
19502 struct buffer
*buf
= current_buffer
;
19503 struct buffer
*old
= buf
;
19505 if (! NILP (buffer
))
19507 CHECK_BUFFER (buffer
);
19508 buf
= XBUFFER (buffer
);
19511 if (NILP (BVAR (buf
, bidi_display_reordering
))
19512 || NILP (BVAR (buf
, enable_multibyte_characters
))
19513 /* When we are loading loadup.el, the character property tables
19514 needed for bidi iteration are not yet available. */
19515 || !NILP (Vpurify_flag
))
19516 return Qleft_to_right
;
19517 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19518 return BVAR (buf
, bidi_paragraph_direction
);
19521 /* Determine the direction from buffer text. We could try to
19522 use current_matrix if it is up to date, but this seems fast
19523 enough as it is. */
19524 struct bidi_it itb
;
19525 EMACS_INT pos
= BUF_PT (buf
);
19526 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19528 void *itb_data
= bidi_shelve_cache ();
19530 set_buffer_temp (buf
);
19531 /* bidi_paragraph_init finds the base direction of the paragraph
19532 by searching forward from paragraph start. We need the base
19533 direction of the current or _previous_ paragraph, so we need
19534 to make sure we are within that paragraph. To that end, find
19535 the previous non-empty line. */
19536 if (pos
>= ZV
&& pos
> BEGV
)
19539 bytepos
= CHAR_TO_BYTE (pos
);
19541 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19542 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19544 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19545 || c
== ' ' || c
== '\t' || c
== '\f')
19547 if (bytepos
<= BEGV_BYTE
)
19552 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19555 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19556 itb
.paragraph_dir
= NEUTRAL_DIR
;
19557 itb
.string
.s
= NULL
;
19558 itb
.string
.lstring
= Qnil
;
19559 itb
.string
.bufpos
= 0;
19560 itb
.string
.unibyte
= 0;
19561 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19562 bidi_unshelve_cache (itb_data
, 0);
19563 set_buffer_temp (old
);
19564 switch (itb
.paragraph_dir
)
19567 return Qleft_to_right
;
19570 return Qright_to_left
;
19580 /***********************************************************************
19582 ***********************************************************************/
19584 /* Redisplay the menu bar in the frame for window W.
19586 The menu bar of X frames that don't have X toolkit support is
19587 displayed in a special window W->frame->menu_bar_window.
19589 The menu bar of terminal frames is treated specially as far as
19590 glyph matrices are concerned. Menu bar lines are not part of
19591 windows, so the update is done directly on the frame matrix rows
19592 for the menu bar. */
19595 display_menu_bar (struct window
*w
)
19597 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19602 /* Don't do all this for graphical frames. */
19604 if (FRAME_W32_P (f
))
19607 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19613 if (FRAME_NS_P (f
))
19615 #endif /* HAVE_NS */
19617 #ifdef USE_X_TOOLKIT
19618 xassert (!FRAME_WINDOW_P (f
));
19619 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19620 it
.first_visible_x
= 0;
19621 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19622 #else /* not USE_X_TOOLKIT */
19623 if (FRAME_WINDOW_P (f
))
19625 /* Menu bar lines are displayed in the desired matrix of the
19626 dummy window menu_bar_window. */
19627 struct window
*menu_w
;
19628 xassert (WINDOWP (f
->menu_bar_window
));
19629 menu_w
= XWINDOW (f
->menu_bar_window
);
19630 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19632 it
.first_visible_x
= 0;
19633 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19637 /* This is a TTY frame, i.e. character hpos/vpos are used as
19639 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19641 it
.first_visible_x
= 0;
19642 it
.last_visible_x
= FRAME_COLS (f
);
19644 #endif /* not USE_X_TOOLKIT */
19646 /* FIXME: This should be controlled by a user option. See the
19647 comments in redisplay_tool_bar and display_mode_line about
19649 it
.paragraph_embedding
= L2R
;
19651 if (! mode_line_inverse_video
)
19652 /* Force the menu-bar to be displayed in the default face. */
19653 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19655 /* Clear all rows of the menu bar. */
19656 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19658 struct glyph_row
*row
= it
.glyph_row
+ i
;
19659 clear_glyph_row (row
);
19660 row
->enabled_p
= 1;
19661 row
->full_width_p
= 1;
19664 /* Display all items of the menu bar. */
19665 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19666 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19668 Lisp_Object string
;
19670 /* Stop at nil string. */
19671 string
= AREF (items
, i
+ 1);
19675 /* Remember where item was displayed. */
19676 ASET (items
, i
+ 3, make_number (it
.hpos
));
19678 /* Display the item, pad with one space. */
19679 if (it
.current_x
< it
.last_visible_x
)
19680 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19681 SCHARS (string
) + 1, 0, 0, -1);
19684 /* Fill out the line with spaces. */
19685 if (it
.current_x
< it
.last_visible_x
)
19686 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19688 /* Compute the total height of the lines. */
19689 compute_line_metrics (&it
);
19694 /***********************************************************************
19696 ***********************************************************************/
19698 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19699 FORCE is non-zero, redisplay mode lines unconditionally.
19700 Otherwise, redisplay only mode lines that are garbaged. Value is
19701 the number of windows whose mode lines were redisplayed. */
19704 redisplay_mode_lines (Lisp_Object window
, int force
)
19708 while (!NILP (window
))
19710 struct window
*w
= XWINDOW (window
);
19712 if (WINDOWP (w
->hchild
))
19713 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19714 else if (WINDOWP (w
->vchild
))
19715 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19717 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19718 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19720 struct text_pos lpoint
;
19721 struct buffer
*old
= current_buffer
;
19723 /* Set the window's buffer for the mode line display. */
19724 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19725 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19727 /* Point refers normally to the selected window. For any
19728 other window, set up appropriate value. */
19729 if (!EQ (window
, selected_window
))
19731 struct text_pos pt
;
19733 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19734 if (CHARPOS (pt
) < BEGV
)
19735 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19736 else if (CHARPOS (pt
) > (ZV
- 1))
19737 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19739 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19742 /* Display mode lines. */
19743 clear_glyph_matrix (w
->desired_matrix
);
19744 if (display_mode_lines (w
))
19747 w
->must_be_updated_p
= 1;
19750 /* Restore old settings. */
19751 set_buffer_internal_1 (old
);
19752 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19762 /* Display the mode and/or header line of window W. Value is the
19763 sum number of mode lines and header lines displayed. */
19766 display_mode_lines (struct window
*w
)
19768 Lisp_Object old_selected_window
, old_selected_frame
;
19771 old_selected_frame
= selected_frame
;
19772 selected_frame
= w
->frame
;
19773 old_selected_window
= selected_window
;
19774 XSETWINDOW (selected_window
, w
);
19776 /* These will be set while the mode line specs are processed. */
19777 line_number_displayed
= 0;
19778 w
->column_number_displayed
= Qnil
;
19780 if (WINDOW_WANTS_MODELINE_P (w
))
19782 struct window
*sel_w
= XWINDOW (old_selected_window
);
19784 /* Select mode line face based on the real selected window. */
19785 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19786 BVAR (current_buffer
, mode_line_format
));
19790 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19792 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19793 BVAR (current_buffer
, header_line_format
));
19797 selected_frame
= old_selected_frame
;
19798 selected_window
= old_selected_window
;
19803 /* Display mode or header line of window W. FACE_ID specifies which
19804 line to display; it is either MODE_LINE_FACE_ID or
19805 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19806 display. Value is the pixel height of the mode/header line
19810 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19814 int count
= SPECPDL_INDEX ();
19816 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19817 /* Don't extend on a previously drawn mode-line.
19818 This may happen if called from pos_visible_p. */
19819 it
.glyph_row
->enabled_p
= 0;
19820 prepare_desired_row (it
.glyph_row
);
19822 it
.glyph_row
->mode_line_p
= 1;
19824 if (! mode_line_inverse_video
)
19825 /* Force the mode-line to be displayed in the default face. */
19826 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19828 /* FIXME: This should be controlled by a user option. But
19829 supporting such an option is not trivial, since the mode line is
19830 made up of many separate strings. */
19831 it
.paragraph_embedding
= L2R
;
19833 record_unwind_protect (unwind_format_mode_line
,
19834 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19836 mode_line_target
= MODE_LINE_DISPLAY
;
19838 /* Temporarily make frame's keyboard the current kboard so that
19839 kboard-local variables in the mode_line_format will get the right
19841 push_kboard (FRAME_KBOARD (it
.f
));
19842 record_unwind_save_match_data ();
19843 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19846 unbind_to (count
, Qnil
);
19848 /* Fill up with spaces. */
19849 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19851 compute_line_metrics (&it
);
19852 it
.glyph_row
->full_width_p
= 1;
19853 it
.glyph_row
->continued_p
= 0;
19854 it
.glyph_row
->truncated_on_left_p
= 0;
19855 it
.glyph_row
->truncated_on_right_p
= 0;
19857 /* Make a 3D mode-line have a shadow at its right end. */
19858 face
= FACE_FROM_ID (it
.f
, face_id
);
19859 extend_face_to_end_of_line (&it
);
19860 if (face
->box
!= FACE_NO_BOX
)
19862 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19863 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19864 last
->right_box_line_p
= 1;
19867 return it
.glyph_row
->height
;
19870 /* Move element ELT in LIST to the front of LIST.
19871 Return the updated list. */
19874 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19876 register Lisp_Object tail
, prev
;
19877 register Lisp_Object tem
;
19881 while (CONSP (tail
))
19887 /* Splice out the link TAIL. */
19889 list
= XCDR (tail
);
19891 Fsetcdr (prev
, XCDR (tail
));
19893 /* Now make it the first. */
19894 Fsetcdr (tail
, list
);
19899 tail
= XCDR (tail
);
19903 /* Not found--return unchanged LIST. */
19907 /* Contribute ELT to the mode line for window IT->w. How it
19908 translates into text depends on its data type.
19910 IT describes the display environment in which we display, as usual.
19912 DEPTH is the depth in recursion. It is used to prevent
19913 infinite recursion here.
19915 FIELD_WIDTH is the number of characters the display of ELT should
19916 occupy in the mode line, and PRECISION is the maximum number of
19917 characters to display from ELT's representation. See
19918 display_string for details.
19920 Returns the hpos of the end of the text generated by ELT.
19922 PROPS is a property list to add to any string we encounter.
19924 If RISKY is nonzero, remove (disregard) any properties in any string
19925 we encounter, and ignore :eval and :propertize.
19927 The global variable `mode_line_target' determines whether the
19928 output is passed to `store_mode_line_noprop',
19929 `store_mode_line_string', or `display_string'. */
19932 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19933 Lisp_Object elt
, Lisp_Object props
, int risky
)
19935 int n
= 0, field
, prec
;
19940 elt
= build_string ("*too-deep*");
19944 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19948 /* A string: output it and check for %-constructs within it. */
19950 EMACS_INT offset
= 0;
19952 if (SCHARS (elt
) > 0
19953 && (!NILP (props
) || risky
))
19955 Lisp_Object oprops
, aelt
;
19956 oprops
= Ftext_properties_at (make_number (0), elt
);
19958 /* If the starting string's properties are not what
19959 we want, translate the string. Also, if the string
19960 is risky, do that anyway. */
19962 if (NILP (Fequal (props
, oprops
)) || risky
)
19964 /* If the starting string has properties,
19965 merge the specified ones onto the existing ones. */
19966 if (! NILP (oprops
) && !risky
)
19970 oprops
= Fcopy_sequence (oprops
);
19972 while (CONSP (tem
))
19974 oprops
= Fplist_put (oprops
, XCAR (tem
),
19975 XCAR (XCDR (tem
)));
19976 tem
= XCDR (XCDR (tem
));
19981 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19982 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19984 /* AELT is what we want. Move it to the front
19985 without consing. */
19987 mode_line_proptrans_alist
19988 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19994 /* If AELT has the wrong props, it is useless.
19995 so get rid of it. */
19997 mode_line_proptrans_alist
19998 = Fdelq (aelt
, mode_line_proptrans_alist
);
20000 elt
= Fcopy_sequence (elt
);
20001 Fset_text_properties (make_number (0), Flength (elt
),
20003 /* Add this item to mode_line_proptrans_alist. */
20004 mode_line_proptrans_alist
20005 = Fcons (Fcons (elt
, props
),
20006 mode_line_proptrans_alist
);
20007 /* Truncate mode_line_proptrans_alist
20008 to at most 50 elements. */
20009 tem
= Fnthcdr (make_number (50),
20010 mode_line_proptrans_alist
);
20012 XSETCDR (tem
, Qnil
);
20021 prec
= precision
- n
;
20022 switch (mode_line_target
)
20024 case MODE_LINE_NOPROP
:
20025 case MODE_LINE_TITLE
:
20026 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20028 case MODE_LINE_STRING
:
20029 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20031 case MODE_LINE_DISPLAY
:
20032 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20033 0, prec
, 0, STRING_MULTIBYTE (elt
));
20040 /* Handle the non-literal case. */
20042 while ((precision
<= 0 || n
< precision
)
20043 && SREF (elt
, offset
) != 0
20044 && (mode_line_target
!= MODE_LINE_DISPLAY
20045 || it
->current_x
< it
->last_visible_x
))
20047 EMACS_INT last_offset
= offset
;
20049 /* Advance to end of string or next format specifier. */
20050 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20053 if (offset
- 1 != last_offset
)
20055 EMACS_INT nchars
, nbytes
;
20057 /* Output to end of string or up to '%'. Field width
20058 is length of string. Don't output more than
20059 PRECISION allows us. */
20062 prec
= c_string_width (SDATA (elt
) + last_offset
,
20063 offset
- last_offset
, precision
- n
,
20066 switch (mode_line_target
)
20068 case MODE_LINE_NOPROP
:
20069 case MODE_LINE_TITLE
:
20070 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20072 case MODE_LINE_STRING
:
20074 EMACS_INT bytepos
= last_offset
;
20075 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20076 EMACS_INT endpos
= (precision
<= 0
20077 ? string_byte_to_char (elt
, offset
)
20078 : charpos
+ nchars
);
20080 n
+= store_mode_line_string (NULL
,
20081 Fsubstring (elt
, make_number (charpos
),
20082 make_number (endpos
)),
20086 case MODE_LINE_DISPLAY
:
20088 EMACS_INT bytepos
= last_offset
;
20089 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20091 if (precision
<= 0)
20092 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20093 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20095 STRING_MULTIBYTE (elt
));
20100 else /* c == '%' */
20102 EMACS_INT percent_position
= offset
;
20104 /* Get the specified minimum width. Zero means
20107 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20108 field
= field
* 10 + c
- '0';
20110 /* Don't pad beyond the total padding allowed. */
20111 if (field_width
- n
> 0 && field
> field_width
- n
)
20112 field
= field_width
- n
;
20114 /* Note that either PRECISION <= 0 or N < PRECISION. */
20115 prec
= precision
- n
;
20118 n
+= display_mode_element (it
, depth
, field
, prec
,
20119 Vglobal_mode_string
, props
,
20124 EMACS_INT bytepos
, charpos
;
20126 Lisp_Object string
;
20128 bytepos
= percent_position
;
20129 charpos
= (STRING_MULTIBYTE (elt
)
20130 ? string_byte_to_char (elt
, bytepos
)
20132 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20133 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20135 switch (mode_line_target
)
20137 case MODE_LINE_NOPROP
:
20138 case MODE_LINE_TITLE
:
20139 n
+= store_mode_line_noprop (spec
, field
, prec
);
20141 case MODE_LINE_STRING
:
20143 Lisp_Object tem
= build_string (spec
);
20144 props
= Ftext_properties_at (make_number (charpos
), elt
);
20145 /* Should only keep face property in props */
20146 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20149 case MODE_LINE_DISPLAY
:
20151 int nglyphs_before
, nwritten
;
20153 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20154 nwritten
= display_string (spec
, string
, elt
,
20159 /* Assign to the glyphs written above the
20160 string where the `%x' came from, position
20164 struct glyph
*glyph
20165 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20169 for (i
= 0; i
< nwritten
; ++i
)
20171 glyph
[i
].object
= elt
;
20172 glyph
[i
].charpos
= charpos
;
20189 /* A symbol: process the value of the symbol recursively
20190 as if it appeared here directly. Avoid error if symbol void.
20191 Special case: if value of symbol is a string, output the string
20194 register Lisp_Object tem
;
20196 /* If the variable is not marked as risky to set
20197 then its contents are risky to use. */
20198 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20201 tem
= Fboundp (elt
);
20204 tem
= Fsymbol_value (elt
);
20205 /* If value is a string, output that string literally:
20206 don't check for % within it. */
20210 if (!EQ (tem
, elt
))
20212 /* Give up right away for nil or t. */
20222 register Lisp_Object car
, tem
;
20224 /* A cons cell: five distinct cases.
20225 If first element is :eval or :propertize, do something special.
20226 If first element is a string or a cons, process all the elements
20227 and effectively concatenate them.
20228 If first element is a negative number, truncate displaying cdr to
20229 at most that many characters. If positive, pad (with spaces)
20230 to at least that many characters.
20231 If first element is a symbol, process the cadr or caddr recursively
20232 according to whether the symbol's value is non-nil or nil. */
20234 if (EQ (car
, QCeval
))
20236 /* An element of the form (:eval FORM) means evaluate FORM
20237 and use the result as mode line elements. */
20242 if (CONSP (XCDR (elt
)))
20245 spec
= safe_eval (XCAR (XCDR (elt
)));
20246 n
+= display_mode_element (it
, depth
, field_width
- n
,
20247 precision
- n
, spec
, props
,
20251 else if (EQ (car
, QCpropertize
))
20253 /* An element of the form (:propertize ELT PROPS...)
20254 means display ELT but applying properties PROPS. */
20259 if (CONSP (XCDR (elt
)))
20260 n
+= display_mode_element (it
, depth
, field_width
- n
,
20261 precision
- n
, XCAR (XCDR (elt
)),
20262 XCDR (XCDR (elt
)), risky
);
20264 else if (SYMBOLP (car
))
20266 tem
= Fboundp (car
);
20270 /* elt is now the cdr, and we know it is a cons cell.
20271 Use its car if CAR has a non-nil value. */
20274 tem
= Fsymbol_value (car
);
20281 /* Symbol's value is nil (or symbol is unbound)
20282 Get the cddr of the original list
20283 and if possible find the caddr and use that. */
20287 else if (!CONSP (elt
))
20292 else if (INTEGERP (car
))
20294 register int lim
= XINT (car
);
20298 /* Negative int means reduce maximum width. */
20299 if (precision
<= 0)
20302 precision
= min (precision
, -lim
);
20306 /* Padding specified. Don't let it be more than
20307 current maximum. */
20309 lim
= min (precision
, lim
);
20311 /* If that's more padding than already wanted, queue it.
20312 But don't reduce padding already specified even if
20313 that is beyond the current truncation point. */
20314 field_width
= max (lim
, field_width
);
20318 else if (STRINGP (car
) || CONSP (car
))
20320 Lisp_Object halftail
= elt
;
20324 && (precision
<= 0 || n
< precision
))
20326 n
+= display_mode_element (it
, depth
,
20327 /* Do padding only after the last
20328 element in the list. */
20329 (! CONSP (XCDR (elt
))
20332 precision
- n
, XCAR (elt
),
20336 if ((len
& 1) == 0)
20337 halftail
= XCDR (halftail
);
20338 /* Check for cycle. */
20339 if (EQ (halftail
, elt
))
20348 elt
= build_string ("*invalid*");
20352 /* Pad to FIELD_WIDTH. */
20353 if (field_width
> 0 && n
< field_width
)
20355 switch (mode_line_target
)
20357 case MODE_LINE_NOPROP
:
20358 case MODE_LINE_TITLE
:
20359 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20361 case MODE_LINE_STRING
:
20362 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20364 case MODE_LINE_DISPLAY
:
20365 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20374 /* Store a mode-line string element in mode_line_string_list.
20376 If STRING is non-null, display that C string. Otherwise, the Lisp
20377 string LISP_STRING is displayed.
20379 FIELD_WIDTH is the minimum number of output glyphs to produce.
20380 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20381 with spaces. FIELD_WIDTH <= 0 means don't pad.
20383 PRECISION is the maximum number of characters to output from
20384 STRING. PRECISION <= 0 means don't truncate the string.
20386 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20387 properties to the string.
20389 PROPS are the properties to add to the string.
20390 The mode_line_string_face face property is always added to the string.
20394 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20395 int field_width
, int precision
, Lisp_Object props
)
20400 if (string
!= NULL
)
20402 len
= strlen (string
);
20403 if (precision
> 0 && len
> precision
)
20405 lisp_string
= make_string (string
, len
);
20407 props
= mode_line_string_face_prop
;
20408 else if (!NILP (mode_line_string_face
))
20410 Lisp_Object face
= Fplist_get (props
, Qface
);
20411 props
= Fcopy_sequence (props
);
20413 face
= mode_line_string_face
;
20415 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20416 props
= Fplist_put (props
, Qface
, face
);
20418 Fadd_text_properties (make_number (0), make_number (len
),
20419 props
, lisp_string
);
20423 len
= XFASTINT (Flength (lisp_string
));
20424 if (precision
> 0 && len
> precision
)
20427 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20430 if (!NILP (mode_line_string_face
))
20434 props
= Ftext_properties_at (make_number (0), lisp_string
);
20435 face
= Fplist_get (props
, Qface
);
20437 face
= mode_line_string_face
;
20439 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20440 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20442 lisp_string
= Fcopy_sequence (lisp_string
);
20445 Fadd_text_properties (make_number (0), make_number (len
),
20446 props
, lisp_string
);
20451 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20455 if (field_width
> len
)
20457 field_width
-= len
;
20458 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20460 Fadd_text_properties (make_number (0), make_number (field_width
),
20461 props
, lisp_string
);
20462 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20470 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20472 doc
: /* Format a string out of a mode line format specification.
20473 First arg FORMAT specifies the mode line format (see `mode-line-format'
20474 for details) to use.
20476 By default, the format is evaluated for the currently selected window.
20478 Optional second arg FACE specifies the face property to put on all
20479 characters for which no face is specified. The value nil means the
20480 default face. The value t means whatever face the window's mode line
20481 currently uses (either `mode-line' or `mode-line-inactive',
20482 depending on whether the window is the selected window or not).
20483 An integer value means the value string has no text
20486 Optional third and fourth args WINDOW and BUFFER specify the window
20487 and buffer to use as the context for the formatting (defaults
20488 are the selected window and the WINDOW's buffer). */)
20489 (Lisp_Object format
, Lisp_Object face
,
20490 Lisp_Object window
, Lisp_Object buffer
)
20495 struct buffer
*old_buffer
= NULL
;
20497 int no_props
= INTEGERP (face
);
20498 int count
= SPECPDL_INDEX ();
20500 int string_start
= 0;
20503 window
= selected_window
;
20504 CHECK_WINDOW (window
);
20505 w
= XWINDOW (window
);
20508 buffer
= w
->buffer
;
20509 CHECK_BUFFER (buffer
);
20511 /* Make formatting the modeline a non-op when noninteractive, otherwise
20512 there will be problems later caused by a partially initialized frame. */
20513 if (NILP (format
) || noninteractive
)
20514 return empty_unibyte_string
;
20519 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20520 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20521 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20522 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20523 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20524 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20525 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20528 if (XBUFFER (buffer
) != current_buffer
)
20529 old_buffer
= current_buffer
;
20531 /* Save things including mode_line_proptrans_alist,
20532 and set that to nil so that we don't alter the outer value. */
20533 record_unwind_protect (unwind_format_mode_line
,
20534 format_mode_line_unwind_data
20535 (old_buffer
, selected_window
, 1));
20536 mode_line_proptrans_alist
= Qnil
;
20538 Fselect_window (window
, Qt
);
20540 set_buffer_internal_1 (XBUFFER (buffer
));
20542 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20546 mode_line_target
= MODE_LINE_NOPROP
;
20547 mode_line_string_face_prop
= Qnil
;
20548 mode_line_string_list
= Qnil
;
20549 string_start
= MODE_LINE_NOPROP_LEN (0);
20553 mode_line_target
= MODE_LINE_STRING
;
20554 mode_line_string_list
= Qnil
;
20555 mode_line_string_face
= face
;
20556 mode_line_string_face_prop
20557 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20560 push_kboard (FRAME_KBOARD (it
.f
));
20561 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20566 len
= MODE_LINE_NOPROP_LEN (string_start
);
20567 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20571 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20572 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20573 empty_unibyte_string
);
20576 unbind_to (count
, Qnil
);
20580 /* Write a null-terminated, right justified decimal representation of
20581 the positive integer D to BUF using a minimal field width WIDTH. */
20584 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20586 register char *p
= buf
;
20594 *p
++ = d
% 10 + '0';
20599 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20610 /* Write a null-terminated, right justified decimal and "human
20611 readable" representation of the nonnegative integer D to BUF using
20612 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20614 static const char power_letter
[] =
20628 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20630 /* We aim to represent the nonnegative integer D as
20631 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20632 EMACS_INT quotient
= d
;
20634 /* -1 means: do not use TENTHS. */
20638 /* Length of QUOTIENT.TENTHS as a string. */
20644 if (1000 <= quotient
)
20646 /* Scale to the appropriate EXPONENT. */
20649 remainder
= quotient
% 1000;
20653 while (1000 <= quotient
);
20655 /* Round to nearest and decide whether to use TENTHS or not. */
20658 tenths
= remainder
/ 100;
20659 if (50 <= remainder
% 100)
20666 if (quotient
== 10)
20674 if (500 <= remainder
)
20676 if (quotient
< 999)
20687 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20688 if (tenths
== -1 && quotient
<= 99)
20695 p
= psuffix
= buf
+ max (width
, length
);
20697 /* Print EXPONENT. */
20698 *psuffix
++ = power_letter
[exponent
];
20701 /* Print TENTHS. */
20704 *--p
= '0' + tenths
;
20708 /* Print QUOTIENT. */
20711 int digit
= quotient
% 10;
20712 *--p
= '0' + digit
;
20714 while ((quotient
/= 10) != 0);
20716 /* Print leading spaces. */
20721 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20722 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20723 type of CODING_SYSTEM. Return updated pointer into BUF. */
20725 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20728 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20731 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20732 const unsigned char *eol_str
;
20734 /* The EOL conversion we are using. */
20735 Lisp_Object eoltype
;
20737 val
= CODING_SYSTEM_SPEC (coding_system
);
20740 if (!VECTORP (val
)) /* Not yet decided. */
20745 eoltype
= eol_mnemonic_undecided
;
20746 /* Don't mention EOL conversion if it isn't decided. */
20751 Lisp_Object eolvalue
;
20753 attrs
= AREF (val
, 0);
20754 eolvalue
= AREF (val
, 2);
20757 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20761 /* The EOL conversion that is normal on this system. */
20763 if (NILP (eolvalue
)) /* Not yet decided. */
20764 eoltype
= eol_mnemonic_undecided
;
20765 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20766 eoltype
= eol_mnemonic_undecided
;
20767 else /* eolvalue is Qunix, Qdos, or Qmac. */
20768 eoltype
= (EQ (eolvalue
, Qunix
)
20769 ? eol_mnemonic_unix
20770 : (EQ (eolvalue
, Qdos
) == 1
20771 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20777 /* Mention the EOL conversion if it is not the usual one. */
20778 if (STRINGP (eoltype
))
20780 eol_str
= SDATA (eoltype
);
20781 eol_str_len
= SBYTES (eoltype
);
20783 else if (CHARACTERP (eoltype
))
20785 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20786 int c
= XFASTINT (eoltype
);
20787 eol_str_len
= CHAR_STRING (c
, tmp
);
20792 eol_str
= invalid_eol_type
;
20793 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20795 memcpy (buf
, eol_str
, eol_str_len
);
20796 buf
+= eol_str_len
;
20802 /* Return a string for the output of a mode line %-spec for window W,
20803 generated by character C. FIELD_WIDTH > 0 means pad the string
20804 returned with spaces to that value. Return a Lisp string in
20805 *STRING if the resulting string is taken from that Lisp string.
20807 Note we operate on the current buffer for most purposes,
20808 the exception being w->base_line_pos. */
20810 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20812 static const char *
20813 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20814 Lisp_Object
*string
)
20817 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20818 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20819 struct buffer
*b
= current_buffer
;
20827 if (!NILP (BVAR (b
, read_only
)))
20829 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20834 /* This differs from %* only for a modified read-only buffer. */
20835 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20837 if (!NILP (BVAR (b
, read_only
)))
20842 /* This differs from %* in ignoring read-only-ness. */
20843 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20855 if (command_loop_level
> 5)
20857 p
= decode_mode_spec_buf
;
20858 for (i
= 0; i
< command_loop_level
; i
++)
20861 return decode_mode_spec_buf
;
20869 if (command_loop_level
> 5)
20871 p
= decode_mode_spec_buf
;
20872 for (i
= 0; i
< command_loop_level
; i
++)
20875 return decode_mode_spec_buf
;
20882 /* Let lots_of_dashes be a string of infinite length. */
20883 if (mode_line_target
== MODE_LINE_NOPROP
||
20884 mode_line_target
== MODE_LINE_STRING
)
20886 if (field_width
<= 0
20887 || field_width
> sizeof (lots_of_dashes
))
20889 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20890 decode_mode_spec_buf
[i
] = '-';
20891 decode_mode_spec_buf
[i
] = '\0';
20892 return decode_mode_spec_buf
;
20895 return lots_of_dashes
;
20899 obj
= BVAR (b
, name
);
20903 /* %c and %l are ignored in `frame-title-format'.
20904 (In redisplay_internal, the frame title is drawn _before_ the
20905 windows are updated, so the stuff which depends on actual
20906 window contents (such as %l) may fail to render properly, or
20907 even crash emacs.) */
20908 if (mode_line_target
== MODE_LINE_TITLE
)
20912 EMACS_INT col
= current_column ();
20913 w
->column_number_displayed
= make_number (col
);
20914 pint2str (decode_mode_spec_buf
, field_width
, col
);
20915 return decode_mode_spec_buf
;
20919 #ifndef SYSTEM_MALLOC
20921 if (NILP (Vmemory_full
))
20924 return "!MEM FULL! ";
20931 /* %F displays the frame name. */
20932 if (!NILP (f
->title
))
20933 return SSDATA (f
->title
);
20934 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20935 return SSDATA (f
->name
);
20939 obj
= BVAR (b
, filename
);
20944 EMACS_INT size
= ZV
- BEGV
;
20945 pint2str (decode_mode_spec_buf
, field_width
, size
);
20946 return decode_mode_spec_buf
;
20951 EMACS_INT size
= ZV
- BEGV
;
20952 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20953 return decode_mode_spec_buf
;
20958 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20959 EMACS_INT topline
, nlines
, height
;
20962 /* %c and %l are ignored in `frame-title-format'. */
20963 if (mode_line_target
== MODE_LINE_TITLE
)
20966 startpos
= XMARKER (w
->start
)->charpos
;
20967 startpos_byte
= marker_byte_position (w
->start
);
20968 height
= WINDOW_TOTAL_LINES (w
);
20970 /* If we decided that this buffer isn't suitable for line numbers,
20971 don't forget that too fast. */
20972 if (EQ (w
->base_line_pos
, w
->buffer
))
20974 /* But do forget it, if the window shows a different buffer now. */
20975 else if (BUFFERP (w
->base_line_pos
))
20976 w
->base_line_pos
= Qnil
;
20978 /* If the buffer is very big, don't waste time. */
20979 if (INTEGERP (Vline_number_display_limit
)
20980 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20982 w
->base_line_pos
= Qnil
;
20983 w
->base_line_number
= Qnil
;
20987 if (INTEGERP (w
->base_line_number
)
20988 && INTEGERP (w
->base_line_pos
)
20989 && XFASTINT (w
->base_line_pos
) <= startpos
)
20991 line
= XFASTINT (w
->base_line_number
);
20992 linepos
= XFASTINT (w
->base_line_pos
);
20993 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20998 linepos
= BUF_BEGV (b
);
20999 linepos_byte
= BUF_BEGV_BYTE (b
);
21002 /* Count lines from base line to window start position. */
21003 nlines
= display_count_lines (linepos_byte
,
21007 topline
= nlines
+ line
;
21009 /* Determine a new base line, if the old one is too close
21010 or too far away, or if we did not have one.
21011 "Too close" means it's plausible a scroll-down would
21012 go back past it. */
21013 if (startpos
== BUF_BEGV (b
))
21015 w
->base_line_number
= make_number (topline
);
21016 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21018 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21019 || linepos
== BUF_BEGV (b
))
21021 EMACS_INT limit
= BUF_BEGV (b
);
21022 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
21023 EMACS_INT position
;
21024 EMACS_INT distance
=
21025 (height
* 2 + 30) * line_number_display_limit_width
;
21027 if (startpos
- distance
> limit
)
21029 limit
= startpos
- distance
;
21030 limit_byte
= CHAR_TO_BYTE (limit
);
21033 nlines
= display_count_lines (startpos_byte
,
21035 - (height
* 2 + 30),
21037 /* If we couldn't find the lines we wanted within
21038 line_number_display_limit_width chars per line,
21039 give up on line numbers for this window. */
21040 if (position
== limit_byte
&& limit
== startpos
- distance
)
21042 w
->base_line_pos
= w
->buffer
;
21043 w
->base_line_number
= Qnil
;
21047 w
->base_line_number
= make_number (topline
- nlines
);
21048 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21051 /* Now count lines from the start pos to point. */
21052 nlines
= display_count_lines (startpos_byte
,
21053 PT_BYTE
, PT
, &junk
);
21055 /* Record that we did display the line number. */
21056 line_number_displayed
= 1;
21058 /* Make the string to show. */
21059 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21060 return decode_mode_spec_buf
;
21063 char* p
= decode_mode_spec_buf
;
21064 int pad
= field_width
- 2;
21070 return decode_mode_spec_buf
;
21076 obj
= BVAR (b
, mode_name
);
21080 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21086 EMACS_INT pos
= marker_position (w
->start
);
21087 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21089 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21091 if (pos
<= BUF_BEGV (b
))
21096 else if (pos
<= BUF_BEGV (b
))
21100 if (total
> 1000000)
21101 /* Do it differently for a large value, to avoid overflow. */
21102 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21104 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21105 /* We can't normally display a 3-digit number,
21106 so get us a 2-digit number that is close. */
21109 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21110 return decode_mode_spec_buf
;
21114 /* Display percentage of size above the bottom of the screen. */
21117 EMACS_INT toppos
= marker_position (w
->start
);
21118 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21119 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21121 if (botpos
>= BUF_ZV (b
))
21123 if (toppos
<= BUF_BEGV (b
))
21130 if (total
> 1000000)
21131 /* Do it differently for a large value, to avoid overflow. */
21132 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21134 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21135 /* We can't normally display a 3-digit number,
21136 so get us a 2-digit number that is close. */
21139 if (toppos
<= BUF_BEGV (b
))
21140 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21142 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21143 return decode_mode_spec_buf
;
21148 /* status of process */
21149 obj
= Fget_buffer_process (Fcurrent_buffer ());
21151 return "no process";
21153 obj
= Fsymbol_name (Fprocess_status (obj
));
21159 int count
= inhibit_garbage_collection ();
21160 Lisp_Object val
= call1 (intern ("file-remote-p"),
21161 BVAR (current_buffer
, directory
));
21162 unbind_to (count
, Qnil
);
21170 case 't': /* indicate TEXT or BINARY */
21174 /* coding-system (not including end-of-line format) */
21176 /* coding-system (including end-of-line type) */
21178 int eol_flag
= (c
== 'Z');
21179 char *p
= decode_mode_spec_buf
;
21181 if (! FRAME_WINDOW_P (f
))
21183 /* No need to mention EOL here--the terminal never needs
21184 to do EOL conversion. */
21185 p
= decode_mode_spec_coding (CODING_ID_NAME
21186 (FRAME_KEYBOARD_CODING (f
)->id
),
21188 p
= decode_mode_spec_coding (CODING_ID_NAME
21189 (FRAME_TERMINAL_CODING (f
)->id
),
21192 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21195 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21196 #ifdef subprocesses
21197 obj
= Fget_buffer_process (Fcurrent_buffer ());
21198 if (PROCESSP (obj
))
21200 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21202 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21205 #endif /* subprocesses */
21208 return decode_mode_spec_buf
;
21215 return SSDATA (obj
);
21222 /* Count up to COUNT lines starting from START_BYTE.
21223 But don't go beyond LIMIT_BYTE.
21224 Return the number of lines thus found (always nonnegative).
21226 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21229 display_count_lines (EMACS_INT start_byte
,
21230 EMACS_INT limit_byte
, EMACS_INT count
,
21231 EMACS_INT
*byte_pos_ptr
)
21233 register unsigned char *cursor
;
21234 unsigned char *base
;
21236 register EMACS_INT ceiling
;
21237 register unsigned char *ceiling_addr
;
21238 EMACS_INT orig_count
= count
;
21240 /* If we are not in selective display mode,
21241 check only for newlines. */
21242 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21243 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21247 while (start_byte
< limit_byte
)
21249 ceiling
= BUFFER_CEILING_OF (start_byte
);
21250 ceiling
= min (limit_byte
- 1, ceiling
);
21251 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21252 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21255 if (selective_display
)
21256 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21259 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21262 if (cursor
!= ceiling_addr
)
21266 start_byte
+= cursor
- base
+ 1;
21267 *byte_pos_ptr
= start_byte
;
21271 if (++cursor
== ceiling_addr
)
21277 start_byte
+= cursor
- base
;
21282 while (start_byte
> limit_byte
)
21284 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21285 ceiling
= max (limit_byte
, ceiling
);
21286 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21287 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21290 if (selective_display
)
21291 while (--cursor
!= ceiling_addr
21292 && *cursor
!= '\n' && *cursor
!= 015)
21295 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21298 if (cursor
!= ceiling_addr
)
21302 start_byte
+= cursor
- base
+ 1;
21303 *byte_pos_ptr
= start_byte
;
21304 /* When scanning backwards, we should
21305 not count the newline posterior to which we stop. */
21306 return - orig_count
- 1;
21312 /* Here we add 1 to compensate for the last decrement
21313 of CURSOR, which took it past the valid range. */
21314 start_byte
+= cursor
- base
+ 1;
21318 *byte_pos_ptr
= limit_byte
;
21321 return - orig_count
+ count
;
21322 return orig_count
- count
;
21328 /***********************************************************************
21330 ***********************************************************************/
21332 /* Display a NUL-terminated string, starting with index START.
21334 If STRING is non-null, display that C string. Otherwise, the Lisp
21335 string LISP_STRING is displayed. There's a case that STRING is
21336 non-null and LISP_STRING is not nil. It means STRING is a string
21337 data of LISP_STRING. In that case, we display LISP_STRING while
21338 ignoring its text properties.
21340 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21341 FACE_STRING. Display STRING or LISP_STRING with the face at
21342 FACE_STRING_POS in FACE_STRING:
21344 Display the string in the environment given by IT, but use the
21345 standard display table, temporarily.
21347 FIELD_WIDTH is the minimum number of output glyphs to produce.
21348 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21349 with spaces. If STRING has more characters, more than FIELD_WIDTH
21350 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21352 PRECISION is the maximum number of characters to output from
21353 STRING. PRECISION < 0 means don't truncate the string.
21355 This is roughly equivalent to printf format specifiers:
21357 FIELD_WIDTH PRECISION PRINTF
21358 ----------------------------------------
21364 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21365 display them, and < 0 means obey the current buffer's value of
21366 enable_multibyte_characters.
21368 Value is the number of columns displayed. */
21371 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21372 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21373 int field_width
, int precision
, int max_x
, int multibyte
)
21375 int hpos_at_start
= it
->hpos
;
21376 int saved_face_id
= it
->face_id
;
21377 struct glyph_row
*row
= it
->glyph_row
;
21378 EMACS_INT it_charpos
;
21380 /* Initialize the iterator IT for iteration over STRING beginning
21381 with index START. */
21382 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21383 precision
, field_width
, multibyte
);
21384 if (string
&& STRINGP (lisp_string
))
21385 /* LISP_STRING is the one returned by decode_mode_spec. We should
21386 ignore its text properties. */
21387 it
->stop_charpos
= it
->end_charpos
;
21389 /* If displaying STRING, set up the face of the iterator from
21390 FACE_STRING, if that's given. */
21391 if (STRINGP (face_string
))
21397 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21398 0, it
->region_beg_charpos
,
21399 it
->region_end_charpos
,
21400 &endptr
, it
->base_face_id
, 0);
21401 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21402 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21405 /* Set max_x to the maximum allowed X position. Don't let it go
21406 beyond the right edge of the window. */
21408 max_x
= it
->last_visible_x
;
21410 max_x
= min (max_x
, it
->last_visible_x
);
21412 /* Skip over display elements that are not visible. because IT->w is
21414 if (it
->current_x
< it
->first_visible_x
)
21415 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21416 MOVE_TO_POS
| MOVE_TO_X
);
21418 row
->ascent
= it
->max_ascent
;
21419 row
->height
= it
->max_ascent
+ it
->max_descent
;
21420 row
->phys_ascent
= it
->max_phys_ascent
;
21421 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21422 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21424 if (STRINGP (it
->string
))
21425 it_charpos
= IT_STRING_CHARPOS (*it
);
21427 it_charpos
= IT_CHARPOS (*it
);
21429 /* This condition is for the case that we are called with current_x
21430 past last_visible_x. */
21431 while (it
->current_x
< max_x
)
21433 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21435 /* Get the next display element. */
21436 if (!get_next_display_element (it
))
21439 /* Produce glyphs. */
21440 x_before
= it
->current_x
;
21441 n_glyphs_before
= row
->used
[TEXT_AREA
];
21442 PRODUCE_GLYPHS (it
);
21444 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21447 while (i
< nglyphs
)
21449 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21451 if (it
->line_wrap
!= TRUNCATE
21452 && x
+ glyph
->pixel_width
> max_x
)
21454 /* End of continued line or max_x reached. */
21455 if (CHAR_GLYPH_PADDING_P (*glyph
))
21457 /* A wide character is unbreakable. */
21458 if (row
->reversed_p
)
21459 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21460 - n_glyphs_before
);
21461 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21462 it
->current_x
= x_before
;
21466 if (row
->reversed_p
)
21467 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21468 - (n_glyphs_before
+ i
));
21469 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21474 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21476 /* Glyph is at least partially visible. */
21478 if (x
< it
->first_visible_x
)
21479 row
->x
= x
- it
->first_visible_x
;
21483 /* Glyph is off the left margin of the display area.
21484 Should not happen. */
21488 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21489 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21490 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21491 row
->phys_height
= max (row
->phys_height
,
21492 it
->max_phys_ascent
+ it
->max_phys_descent
);
21493 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21494 it
->max_extra_line_spacing
);
21495 x
+= glyph
->pixel_width
;
21499 /* Stop if max_x reached. */
21503 /* Stop at line ends. */
21504 if (ITERATOR_AT_END_OF_LINE_P (it
))
21506 it
->continuation_lines_width
= 0;
21510 set_iterator_to_next (it
, 1);
21511 if (STRINGP (it
->string
))
21512 it_charpos
= IT_STRING_CHARPOS (*it
);
21514 it_charpos
= IT_CHARPOS (*it
);
21516 /* Stop if truncating at the right edge. */
21517 if (it
->line_wrap
== TRUNCATE
21518 && it
->current_x
>= it
->last_visible_x
)
21520 /* Add truncation mark, but don't do it if the line is
21521 truncated at a padding space. */
21522 if (it_charpos
< it
->string_nchars
)
21524 if (!FRAME_WINDOW_P (it
->f
))
21528 if (it
->current_x
> it
->last_visible_x
)
21530 if (!row
->reversed_p
)
21532 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21533 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21538 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21539 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21541 unproduce_glyphs (it
, ii
+ 1);
21542 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21544 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21546 row
->used
[TEXT_AREA
] = ii
;
21547 produce_special_glyphs (it
, IT_TRUNCATION
);
21550 produce_special_glyphs (it
, IT_TRUNCATION
);
21552 row
->truncated_on_right_p
= 1;
21558 /* Maybe insert a truncation at the left. */
21559 if (it
->first_visible_x
21562 if (!FRAME_WINDOW_P (it
->f
))
21563 insert_left_trunc_glyphs (it
);
21564 row
->truncated_on_left_p
= 1;
21567 it
->face_id
= saved_face_id
;
21569 /* Value is number of columns displayed. */
21570 return it
->hpos
- hpos_at_start
;
21575 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21576 appears as an element of LIST or as the car of an element of LIST.
21577 If PROPVAL is a list, compare each element against LIST in that
21578 way, and return 1/2 if any element of PROPVAL is found in LIST.
21579 Otherwise return 0. This function cannot quit.
21580 The return value is 2 if the text is invisible but with an ellipsis
21581 and 1 if it's invisible and without an ellipsis. */
21584 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21586 register Lisp_Object tail
, proptail
;
21588 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21590 register Lisp_Object tem
;
21592 if (EQ (propval
, tem
))
21594 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21595 return NILP (XCDR (tem
)) ? 1 : 2;
21598 if (CONSP (propval
))
21600 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21602 Lisp_Object propelt
;
21603 propelt
= XCAR (proptail
);
21604 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21606 register Lisp_Object tem
;
21608 if (EQ (propelt
, tem
))
21610 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21611 return NILP (XCDR (tem
)) ? 1 : 2;
21619 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21620 doc
: /* Non-nil if the property makes the text invisible.
21621 POS-OR-PROP can be a marker or number, in which case it is taken to be
21622 a position in the current buffer and the value of the `invisible' property
21623 is checked; or it can be some other value, which is then presumed to be the
21624 value of the `invisible' property of the text of interest.
21625 The non-nil value returned can be t for truly invisible text or something
21626 else if the text is replaced by an ellipsis. */)
21627 (Lisp_Object pos_or_prop
)
21630 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21631 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21633 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21634 return (invis
== 0 ? Qnil
21636 : make_number (invis
));
21639 /* Calculate a width or height in pixels from a specification using
21640 the following elements:
21643 NUM - a (fractional) multiple of the default font width/height
21644 (NUM) - specifies exactly NUM pixels
21645 UNIT - a fixed number of pixels, see below.
21646 ELEMENT - size of a display element in pixels, see below.
21647 (NUM . SPEC) - equals NUM * SPEC
21648 (+ SPEC SPEC ...) - add pixel values
21649 (- SPEC SPEC ...) - subtract pixel values
21650 (- SPEC) - negate pixel value
21653 INT or FLOAT - a number constant
21654 SYMBOL - use symbol's (buffer local) variable binding.
21657 in - pixels per inch *)
21658 mm - pixels per 1/1000 meter *)
21659 cm - pixels per 1/100 meter *)
21660 width - width of current font in pixels.
21661 height - height of current font in pixels.
21663 *) using the ratio(s) defined in display-pixels-per-inch.
21667 left-fringe - left fringe width in pixels
21668 right-fringe - right fringe width in pixels
21670 left-margin - left margin width in pixels
21671 right-margin - right margin width in pixels
21673 scroll-bar - scroll-bar area width in pixels
21677 Pixels corresponding to 5 inches:
21680 Total width of non-text areas on left side of window (if scroll-bar is on left):
21681 '(space :width (+ left-fringe left-margin scroll-bar))
21683 Align to first text column (in header line):
21684 '(space :align-to 0)
21686 Align to middle of text area minus half the width of variable `my-image'
21687 containing a loaded image:
21688 '(space :align-to (0.5 . (- text my-image)))
21690 Width of left margin minus width of 1 character in the default font:
21691 '(space :width (- left-margin 1))
21693 Width of left margin minus width of 2 characters in the current font:
21694 '(space :width (- left-margin (2 . width)))
21696 Center 1 character over left-margin (in header line):
21697 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21699 Different ways to express width of left fringe plus left margin minus one pixel:
21700 '(space :width (- (+ left-fringe left-margin) (1)))
21701 '(space :width (+ left-fringe left-margin (- (1))))
21702 '(space :width (+ left-fringe left-margin (-1)))
21706 #define NUMVAL(X) \
21707 ((INTEGERP (X) || FLOATP (X)) \
21712 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21713 struct font
*font
, int width_p
, int *align_to
)
21717 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21718 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21721 return OK_PIXELS (0);
21723 xassert (FRAME_LIVE_P (it
->f
));
21725 if (SYMBOLP (prop
))
21727 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21729 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21731 if (unit
[0] == 'i' && unit
[1] == 'n')
21733 else if (unit
[0] == 'm' && unit
[1] == 'm')
21735 else if (unit
[0] == 'c' && unit
[1] == 'm')
21742 #ifdef HAVE_WINDOW_SYSTEM
21743 if (FRAME_WINDOW_P (it
->f
)
21745 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21746 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21748 return OK_PIXELS (ppi
/ pixels
);
21751 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21752 || (CONSP (Vdisplay_pixels_per_inch
)
21754 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21755 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21757 return OK_PIXELS (ppi
/ pixels
);
21763 #ifdef HAVE_WINDOW_SYSTEM
21764 if (EQ (prop
, Qheight
))
21765 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21766 if (EQ (prop
, Qwidth
))
21767 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21769 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21770 return OK_PIXELS (1);
21773 if (EQ (prop
, Qtext
))
21774 return OK_PIXELS (width_p
21775 ? window_box_width (it
->w
, TEXT_AREA
)
21776 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21778 if (align_to
&& *align_to
< 0)
21781 if (EQ (prop
, Qleft
))
21782 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21783 if (EQ (prop
, Qright
))
21784 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21785 if (EQ (prop
, Qcenter
))
21786 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21787 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21788 if (EQ (prop
, Qleft_fringe
))
21789 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21790 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21791 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21792 if (EQ (prop
, Qright_fringe
))
21793 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21794 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21795 : window_box_right_offset (it
->w
, TEXT_AREA
));
21796 if (EQ (prop
, Qleft_margin
))
21797 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21798 if (EQ (prop
, Qright_margin
))
21799 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21800 if (EQ (prop
, Qscroll_bar
))
21801 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21803 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21804 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21805 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21810 if (EQ (prop
, Qleft_fringe
))
21811 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21812 if (EQ (prop
, Qright_fringe
))
21813 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21814 if (EQ (prop
, Qleft_margin
))
21815 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21816 if (EQ (prop
, Qright_margin
))
21817 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21818 if (EQ (prop
, Qscroll_bar
))
21819 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21822 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21825 if (INTEGERP (prop
) || FLOATP (prop
))
21827 int base_unit
= (width_p
21828 ? FRAME_COLUMN_WIDTH (it
->f
)
21829 : FRAME_LINE_HEIGHT (it
->f
));
21830 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21835 Lisp_Object car
= XCAR (prop
);
21836 Lisp_Object cdr
= XCDR (prop
);
21840 #ifdef HAVE_WINDOW_SYSTEM
21841 if (FRAME_WINDOW_P (it
->f
)
21842 && valid_image_p (prop
))
21844 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21845 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21847 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21850 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21856 while (CONSP (cdr
))
21858 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21859 font
, width_p
, align_to
))
21862 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21867 if (EQ (car
, Qminus
))
21869 return OK_PIXELS (pixels
);
21872 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21875 if (INTEGERP (car
) || FLOATP (car
))
21878 pixels
= XFLOATINT (car
);
21880 return OK_PIXELS (pixels
);
21881 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21882 font
, width_p
, align_to
))
21883 return OK_PIXELS (pixels
* fact
);
21894 /***********************************************************************
21896 ***********************************************************************/
21898 #ifdef HAVE_WINDOW_SYSTEM
21903 dump_glyph_string (struct glyph_string
*s
)
21905 fprintf (stderr
, "glyph string\n");
21906 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21907 s
->x
, s
->y
, s
->width
, s
->height
);
21908 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21909 fprintf (stderr
, " hl = %d\n", s
->hl
);
21910 fprintf (stderr
, " left overhang = %d, right = %d\n",
21911 s
->left_overhang
, s
->right_overhang
);
21912 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21913 fprintf (stderr
, " extends to end of line = %d\n",
21914 s
->extends_to_end_of_line_p
);
21915 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21916 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21919 #endif /* GLYPH_DEBUG */
21921 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21922 of XChar2b structures for S; it can't be allocated in
21923 init_glyph_string because it must be allocated via `alloca'. W
21924 is the window on which S is drawn. ROW and AREA are the glyph row
21925 and area within the row from which S is constructed. START is the
21926 index of the first glyph structure covered by S. HL is a
21927 face-override for drawing S. */
21930 #define OPTIONAL_HDC(hdc) HDC hdc,
21931 #define DECLARE_HDC(hdc) HDC hdc;
21932 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21933 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21936 #ifndef OPTIONAL_HDC
21937 #define OPTIONAL_HDC(hdc)
21938 #define DECLARE_HDC(hdc)
21939 #define ALLOCATE_HDC(hdc, f)
21940 #define RELEASE_HDC(hdc, f)
21944 init_glyph_string (struct glyph_string
*s
,
21946 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21947 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21949 memset (s
, 0, sizeof *s
);
21951 s
->f
= XFRAME (w
->frame
);
21955 s
->display
= FRAME_X_DISPLAY (s
->f
);
21956 s
->window
= FRAME_X_WINDOW (s
->f
);
21957 s
->char2b
= char2b
;
21961 s
->first_glyph
= row
->glyphs
[area
] + start
;
21962 s
->height
= row
->height
;
21963 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21964 s
->ybase
= s
->y
+ row
->ascent
;
21968 /* Append the list of glyph strings with head H and tail T to the list
21969 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21972 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21973 struct glyph_string
*h
, struct glyph_string
*t
)
21987 /* Prepend the list of glyph strings with head H and tail T to the
21988 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21992 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21993 struct glyph_string
*h
, struct glyph_string
*t
)
22007 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22008 Set *HEAD and *TAIL to the resulting list. */
22011 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22012 struct glyph_string
*s
)
22014 s
->next
= s
->prev
= NULL
;
22015 append_glyph_string_lists (head
, tail
, s
, s
);
22019 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22020 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22021 make sure that X resources for the face returned are allocated.
22022 Value is a pointer to a realized face that is ready for display if
22023 DISPLAY_P is non-zero. */
22025 static inline struct face
*
22026 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22027 XChar2b
*char2b
, int display_p
)
22029 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22033 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22035 if (code
!= FONT_INVALID_CODE
)
22036 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22038 STORE_XCHAR2B (char2b
, 0, 0);
22041 /* Make sure X resources of the face are allocated. */
22042 #ifdef HAVE_X_WINDOWS
22046 xassert (face
!= NULL
);
22047 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22054 /* Get face and two-byte form of character glyph GLYPH on frame F.
22055 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22056 a pointer to a realized face that is ready for display. */
22058 static inline struct face
*
22059 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22060 XChar2b
*char2b
, int *two_byte_p
)
22064 xassert (glyph
->type
== CHAR_GLYPH
);
22065 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22074 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22075 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22077 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22079 if (code
!= FONT_INVALID_CODE
)
22080 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22082 STORE_XCHAR2B (char2b
, 0, 0);
22085 /* Make sure X resources of the face are allocated. */
22086 xassert (face
!= NULL
);
22087 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22092 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22093 Return 1 if FONT has a glyph for C, otherwise return 0. */
22096 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22100 if (CHAR_BYTE8_P (c
))
22101 code
= CHAR_TO_BYTE8 (c
);
22103 code
= font
->driver
->encode_char (font
, c
);
22105 if (code
== FONT_INVALID_CODE
)
22107 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22112 /* Fill glyph string S with composition components specified by S->cmp.
22114 BASE_FACE is the base face of the composition.
22115 S->cmp_from is the index of the first component for S.
22117 OVERLAPS non-zero means S should draw the foreground only, and use
22118 its physical height for clipping. See also draw_glyphs.
22120 Value is the index of a component not in S. */
22123 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22127 /* For all glyphs of this composition, starting at the offset
22128 S->cmp_from, until we reach the end of the definition or encounter a
22129 glyph that requires the different face, add it to S. */
22134 s
->for_overlaps
= overlaps
;
22137 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22139 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22141 /* TAB in a composition means display glyphs with padding space
22142 on the left or right. */
22145 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22148 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22155 s
->font
= s
->face
->font
;
22157 else if (s
->face
!= face
)
22165 if (s
->face
== NULL
)
22167 s
->face
= base_face
->ascii_face
;
22168 s
->font
= s
->face
->font
;
22171 /* All glyph strings for the same composition has the same width,
22172 i.e. the width set for the first component of the composition. */
22173 s
->width
= s
->first_glyph
->pixel_width
;
22175 /* If the specified font could not be loaded, use the frame's
22176 default font, but record the fact that we couldn't load it in
22177 the glyph string so that we can draw rectangles for the
22178 characters of the glyph string. */
22179 if (s
->font
== NULL
)
22181 s
->font_not_found_p
= 1;
22182 s
->font
= FRAME_FONT (s
->f
);
22185 /* Adjust base line for subscript/superscript text. */
22186 s
->ybase
+= s
->first_glyph
->voffset
;
22188 /* This glyph string must always be drawn with 16-bit functions. */
22195 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22196 int start
, int end
, int overlaps
)
22198 struct glyph
*glyph
, *last
;
22199 Lisp_Object lgstring
;
22202 s
->for_overlaps
= overlaps
;
22203 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22204 last
= s
->row
->glyphs
[s
->area
] + end
;
22205 s
->cmp_id
= glyph
->u
.cmp
.id
;
22206 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22207 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22208 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22209 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22210 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22212 while (glyph
< last
22213 && glyph
->u
.cmp
.automatic
22214 && glyph
->u
.cmp
.id
== s
->cmp_id
22215 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22216 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22218 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22220 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22221 unsigned code
= LGLYPH_CODE (lglyph
);
22223 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22225 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22226 return glyph
- s
->row
->glyphs
[s
->area
];
22230 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22231 See the comment of fill_glyph_string for arguments.
22232 Value is the index of the first glyph not in S. */
22236 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22237 int start
, int end
, int overlaps
)
22239 struct glyph
*glyph
, *last
;
22242 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22243 s
->for_overlaps
= overlaps
;
22244 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22245 last
= s
->row
->glyphs
[s
->area
] + end
;
22246 voffset
= glyph
->voffset
;
22247 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22248 s
->font
= s
->face
->font
;
22250 s
->width
= glyph
->pixel_width
;
22252 while (glyph
< last
22253 && glyph
->type
== GLYPHLESS_GLYPH
22254 && glyph
->voffset
== voffset
22255 && glyph
->face_id
== face_id
)
22258 s
->width
+= glyph
->pixel_width
;
22261 s
->ybase
+= voffset
;
22262 return glyph
- s
->row
->glyphs
[s
->area
];
22266 /* Fill glyph string S from a sequence of character glyphs.
22268 FACE_ID is the face id of the string. START is the index of the
22269 first glyph to consider, END is the index of the last + 1.
22270 OVERLAPS non-zero means S should draw the foreground only, and use
22271 its physical height for clipping. See also draw_glyphs.
22273 Value is the index of the first glyph not in S. */
22276 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22277 int start
, int end
, int overlaps
)
22279 struct glyph
*glyph
, *last
;
22281 int glyph_not_available_p
;
22283 xassert (s
->f
== XFRAME (s
->w
->frame
));
22284 xassert (s
->nchars
== 0);
22285 xassert (start
>= 0 && end
> start
);
22287 s
->for_overlaps
= overlaps
;
22288 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22289 last
= s
->row
->glyphs
[s
->area
] + end
;
22290 voffset
= glyph
->voffset
;
22291 s
->padding_p
= glyph
->padding_p
;
22292 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22294 while (glyph
< last
22295 && glyph
->type
== CHAR_GLYPH
22296 && glyph
->voffset
== voffset
22297 /* Same face id implies same font, nowadays. */
22298 && glyph
->face_id
== face_id
22299 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22303 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22304 s
->char2b
+ s
->nchars
,
22306 s
->two_byte_p
= two_byte_p
;
22308 xassert (s
->nchars
<= end
- start
);
22309 s
->width
+= glyph
->pixel_width
;
22310 if (glyph
++->padding_p
!= s
->padding_p
)
22314 s
->font
= s
->face
->font
;
22316 /* If the specified font could not be loaded, use the frame's font,
22317 but record the fact that we couldn't load it in
22318 S->font_not_found_p so that we can draw rectangles for the
22319 characters of the glyph string. */
22320 if (s
->font
== NULL
|| glyph_not_available_p
)
22322 s
->font_not_found_p
= 1;
22323 s
->font
= FRAME_FONT (s
->f
);
22326 /* Adjust base line for subscript/superscript text. */
22327 s
->ybase
+= voffset
;
22329 xassert (s
->face
&& s
->face
->gc
);
22330 return glyph
- s
->row
->glyphs
[s
->area
];
22334 /* Fill glyph string S from image glyph S->first_glyph. */
22337 fill_image_glyph_string (struct glyph_string
*s
)
22339 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22340 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22342 s
->slice
= s
->first_glyph
->slice
.img
;
22343 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22344 s
->font
= s
->face
->font
;
22345 s
->width
= s
->first_glyph
->pixel_width
;
22347 /* Adjust base line for subscript/superscript text. */
22348 s
->ybase
+= s
->first_glyph
->voffset
;
22352 /* Fill glyph string S from a sequence of stretch glyphs.
22354 START is the index of the first glyph to consider,
22355 END is the index of the last + 1.
22357 Value is the index of the first glyph not in S. */
22360 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22362 struct glyph
*glyph
, *last
;
22363 int voffset
, face_id
;
22365 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22367 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22368 last
= s
->row
->glyphs
[s
->area
] + end
;
22369 face_id
= glyph
->face_id
;
22370 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22371 s
->font
= s
->face
->font
;
22372 s
->width
= glyph
->pixel_width
;
22374 voffset
= glyph
->voffset
;
22378 && glyph
->type
== STRETCH_GLYPH
22379 && glyph
->voffset
== voffset
22380 && glyph
->face_id
== face_id
);
22382 s
->width
+= glyph
->pixel_width
;
22384 /* Adjust base line for subscript/superscript text. */
22385 s
->ybase
+= voffset
;
22387 /* The case that face->gc == 0 is handled when drawing the glyph
22388 string by calling PREPARE_FACE_FOR_DISPLAY. */
22390 return glyph
- s
->row
->glyphs
[s
->area
];
22393 static struct font_metrics
*
22394 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22396 static struct font_metrics metrics
;
22397 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22399 if (! font
|| code
== FONT_INVALID_CODE
)
22401 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22406 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22407 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22408 assumed to be zero. */
22411 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22413 *left
= *right
= 0;
22415 if (glyph
->type
== CHAR_GLYPH
)
22419 struct font_metrics
*pcm
;
22421 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22422 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22424 if (pcm
->rbearing
> pcm
->width
)
22425 *right
= pcm
->rbearing
- pcm
->width
;
22426 if (pcm
->lbearing
< 0)
22427 *left
= -pcm
->lbearing
;
22430 else if (glyph
->type
== COMPOSITE_GLYPH
)
22432 if (! glyph
->u
.cmp
.automatic
)
22434 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22436 if (cmp
->rbearing
> cmp
->pixel_width
)
22437 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22438 if (cmp
->lbearing
< 0)
22439 *left
= - cmp
->lbearing
;
22443 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22444 struct font_metrics metrics
;
22446 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22447 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22448 if (metrics
.rbearing
> metrics
.width
)
22449 *right
= metrics
.rbearing
- metrics
.width
;
22450 if (metrics
.lbearing
< 0)
22451 *left
= - metrics
.lbearing
;
22457 /* Return the index of the first glyph preceding glyph string S that
22458 is overwritten by S because of S's left overhang. Value is -1
22459 if no glyphs are overwritten. */
22462 left_overwritten (struct glyph_string
*s
)
22466 if (s
->left_overhang
)
22469 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22470 int first
= s
->first_glyph
- glyphs
;
22472 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22473 x
-= glyphs
[i
].pixel_width
;
22484 /* Return the index of the first glyph preceding glyph string S that
22485 is overwriting S because of its right overhang. Value is -1 if no
22486 glyph in front of S overwrites S. */
22489 left_overwriting (struct glyph_string
*s
)
22492 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22493 int first
= s
->first_glyph
- glyphs
;
22497 for (i
= first
- 1; i
>= 0; --i
)
22500 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22503 x
-= glyphs
[i
].pixel_width
;
22510 /* Return the index of the last glyph following glyph string S that is
22511 overwritten by S because of S's right overhang. Value is -1 if
22512 no such glyph is found. */
22515 right_overwritten (struct glyph_string
*s
)
22519 if (s
->right_overhang
)
22522 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22523 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22524 int end
= s
->row
->used
[s
->area
];
22526 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22527 x
+= glyphs
[i
].pixel_width
;
22536 /* Return the index of the last glyph following glyph string S that
22537 overwrites S because of its left overhang. Value is negative
22538 if no such glyph is found. */
22541 right_overwriting (struct glyph_string
*s
)
22544 int end
= s
->row
->used
[s
->area
];
22545 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22546 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22550 for (i
= first
; i
< end
; ++i
)
22553 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22556 x
+= glyphs
[i
].pixel_width
;
22563 /* Set background width of glyph string S. START is the index of the
22564 first glyph following S. LAST_X is the right-most x-position + 1
22565 in the drawing area. */
22568 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22570 /* If the face of this glyph string has to be drawn to the end of
22571 the drawing area, set S->extends_to_end_of_line_p. */
22573 if (start
== s
->row
->used
[s
->area
]
22574 && s
->area
== TEXT_AREA
22575 && ((s
->row
->fill_line_p
22576 && (s
->hl
== DRAW_NORMAL_TEXT
22577 || s
->hl
== DRAW_IMAGE_RAISED
22578 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22579 || s
->hl
== DRAW_MOUSE_FACE
))
22580 s
->extends_to_end_of_line_p
= 1;
22582 /* If S extends its face to the end of the line, set its
22583 background_width to the distance to the right edge of the drawing
22585 if (s
->extends_to_end_of_line_p
)
22586 s
->background_width
= last_x
- s
->x
+ 1;
22588 s
->background_width
= s
->width
;
22592 /* Compute overhangs and x-positions for glyph string S and its
22593 predecessors, or successors. X is the starting x-position for S.
22594 BACKWARD_P non-zero means process predecessors. */
22597 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22603 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22604 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22614 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22615 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22625 /* The following macros are only called from draw_glyphs below.
22626 They reference the following parameters of that function directly:
22627 `w', `row', `area', and `overlap_p'
22628 as well as the following local variables:
22629 `s', `f', and `hdc' (in W32) */
22632 /* On W32, silently add local `hdc' variable to argument list of
22633 init_glyph_string. */
22634 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22635 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22637 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22638 init_glyph_string (s, char2b, w, row, area, start, hl)
22641 /* Add a glyph string for a stretch glyph to the list of strings
22642 between HEAD and TAIL. START is the index of the stretch glyph in
22643 row area AREA of glyph row ROW. END is the index of the last glyph
22644 in that glyph row area. X is the current output position assigned
22645 to the new glyph string constructed. HL overrides that face of the
22646 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22647 is the right-most x-position of the drawing area. */
22649 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22650 and below -- keep them on one line. */
22651 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22654 s = (struct glyph_string *) alloca (sizeof *s); \
22655 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22656 START = fill_stretch_glyph_string (s, START, END); \
22657 append_glyph_string (&HEAD, &TAIL, s); \
22663 /* Add a glyph string for an image glyph to the list of strings
22664 between HEAD and TAIL. START is the index of the image glyph in
22665 row area AREA of glyph row ROW. END is the index of the last glyph
22666 in that glyph row area. X is the current output position assigned
22667 to the new glyph string constructed. HL overrides that face of the
22668 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22669 is the right-most x-position of the drawing area. */
22671 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22674 s = (struct glyph_string *) alloca (sizeof *s); \
22675 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22676 fill_image_glyph_string (s); \
22677 append_glyph_string (&HEAD, &TAIL, s); \
22684 /* Add a glyph string for a sequence of character glyphs to the list
22685 of strings between HEAD and TAIL. START is the index of the first
22686 glyph in row area AREA of glyph row ROW that is part of the new
22687 glyph string. END is the index of the last glyph in that glyph row
22688 area. X is the current output position assigned to the new glyph
22689 string constructed. HL overrides that face of the glyph; e.g. it
22690 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22691 right-most x-position of the drawing area. */
22693 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22699 face_id = (row)->glyphs[area][START].face_id; \
22701 s = (struct glyph_string *) alloca (sizeof *s); \
22702 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22703 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22704 append_glyph_string (&HEAD, &TAIL, s); \
22706 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22711 /* Add a glyph string for a composite sequence to the list of strings
22712 between HEAD and TAIL. START is the index of the first glyph in
22713 row area AREA of glyph row ROW that is part of the new glyph
22714 string. END is the index of the last glyph in that glyph row area.
22715 X is the current output position assigned to the new glyph string
22716 constructed. HL overrides that face of the glyph; e.g. it is
22717 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22718 x-position of the drawing area. */
22720 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22722 int face_id = (row)->glyphs[area][START].face_id; \
22723 struct face *base_face = FACE_FROM_ID (f, face_id); \
22724 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22725 struct composition *cmp = composition_table[cmp_id]; \
22727 struct glyph_string *first_s IF_LINT (= NULL); \
22730 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22732 /* Make glyph_strings for each glyph sequence that is drawable by \
22733 the same face, and append them to HEAD/TAIL. */ \
22734 for (n = 0; n < cmp->glyph_len;) \
22736 s = (struct glyph_string *) alloca (sizeof *s); \
22737 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22738 append_glyph_string (&(HEAD), &(TAIL), s); \
22744 n = fill_composite_glyph_string (s, base_face, overlaps); \
22752 /* Add a glyph string for a glyph-string sequence to the list of strings
22753 between HEAD and TAIL. */
22755 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22759 Lisp_Object gstring; \
22761 face_id = (row)->glyphs[area][START].face_id; \
22762 gstring = (composition_gstring_from_id \
22763 ((row)->glyphs[area][START].u.cmp.id)); \
22764 s = (struct glyph_string *) alloca (sizeof *s); \
22765 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22766 * LGSTRING_GLYPH_LEN (gstring)); \
22767 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22768 append_glyph_string (&(HEAD), &(TAIL), s); \
22770 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22774 /* Add a glyph string for a sequence of glyphless character's glyphs
22775 to the list of strings between HEAD and TAIL. The meanings of
22776 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22778 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22783 face_id = (row)->glyphs[area][START].face_id; \
22785 s = (struct glyph_string *) alloca (sizeof *s); \
22786 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22787 append_glyph_string (&HEAD, &TAIL, s); \
22789 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22795 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22796 of AREA of glyph row ROW on window W between indices START and END.
22797 HL overrides the face for drawing glyph strings, e.g. it is
22798 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22799 x-positions of the drawing area.
22801 This is an ugly monster macro construct because we must use alloca
22802 to allocate glyph strings (because draw_glyphs can be called
22803 asynchronously). */
22805 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22808 HEAD = TAIL = NULL; \
22809 while (START < END) \
22811 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22812 switch (first_glyph->type) \
22815 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22819 case COMPOSITE_GLYPH: \
22820 if (first_glyph->u.cmp.automatic) \
22821 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22824 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22828 case STRETCH_GLYPH: \
22829 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22833 case IMAGE_GLYPH: \
22834 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22838 case GLYPHLESS_GLYPH: \
22839 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22849 set_glyph_string_background_width (s, START, LAST_X); \
22856 /* Draw glyphs between START and END in AREA of ROW on window W,
22857 starting at x-position X. X is relative to AREA in W. HL is a
22858 face-override with the following meaning:
22860 DRAW_NORMAL_TEXT draw normally
22861 DRAW_CURSOR draw in cursor face
22862 DRAW_MOUSE_FACE draw in mouse face.
22863 DRAW_INVERSE_VIDEO draw in mode line face
22864 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22865 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22867 If OVERLAPS is non-zero, draw only the foreground of characters and
22868 clip to the physical height of ROW. Non-zero value also defines
22869 the overlapping part to be drawn:
22871 OVERLAPS_PRED overlap with preceding rows
22872 OVERLAPS_SUCC overlap with succeeding rows
22873 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22874 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22876 Value is the x-position reached, relative to AREA of W. */
22879 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22880 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22881 enum draw_glyphs_face hl
, int overlaps
)
22883 struct glyph_string
*head
, *tail
;
22884 struct glyph_string
*s
;
22885 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22886 int i
, j
, x_reached
, last_x
, area_left
= 0;
22887 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22890 ALLOCATE_HDC (hdc
, f
);
22892 /* Let's rather be paranoid than getting a SEGV. */
22893 end
= min (end
, row
->used
[area
]);
22894 start
= max (0, start
);
22895 start
= min (end
, start
);
22897 /* Translate X to frame coordinates. Set last_x to the right
22898 end of the drawing area. */
22899 if (row
->full_width_p
)
22901 /* X is relative to the left edge of W, without scroll bars
22903 area_left
= WINDOW_LEFT_EDGE_X (w
);
22904 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22908 area_left
= window_box_left (w
, area
);
22909 last_x
= area_left
+ window_box_width (w
, area
);
22913 /* Build a doubly-linked list of glyph_string structures between
22914 head and tail from what we have to draw. Note that the macro
22915 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22916 the reason we use a separate variable `i'. */
22918 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22920 x_reached
= tail
->x
+ tail
->background_width
;
22924 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22925 the row, redraw some glyphs in front or following the glyph
22926 strings built above. */
22927 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22929 struct glyph_string
*h
, *t
;
22930 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22931 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22932 int check_mouse_face
= 0;
22935 /* If mouse highlighting is on, we may need to draw adjacent
22936 glyphs using mouse-face highlighting. */
22937 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22939 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22941 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22942 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22944 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22946 check_mouse_face
= 1;
22947 mouse_beg_col
= (row
== mouse_beg_row
)
22948 ? hlinfo
->mouse_face_beg_col
: 0;
22949 mouse_end_col
= (row
== mouse_end_row
)
22950 ? hlinfo
->mouse_face_end_col
22951 : row
->used
[TEXT_AREA
];
22955 /* Compute overhangs for all glyph strings. */
22956 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22957 for (s
= head
; s
; s
= s
->next
)
22958 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22960 /* Prepend glyph strings for glyphs in front of the first glyph
22961 string that are overwritten because of the first glyph
22962 string's left overhang. The background of all strings
22963 prepended must be drawn because the first glyph string
22965 i
= left_overwritten (head
);
22968 enum draw_glyphs_face overlap_hl
;
22970 /* If this row contains mouse highlighting, attempt to draw
22971 the overlapped glyphs with the correct highlight. This
22972 code fails if the overlap encompasses more than one glyph
22973 and mouse-highlight spans only some of these glyphs.
22974 However, making it work perfectly involves a lot more
22975 code, and I don't know if the pathological case occurs in
22976 practice, so we'll stick to this for now. --- cyd */
22977 if (check_mouse_face
22978 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22979 overlap_hl
= DRAW_MOUSE_FACE
;
22981 overlap_hl
= DRAW_NORMAL_TEXT
;
22984 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22985 overlap_hl
, dummy_x
, last_x
);
22987 compute_overhangs_and_x (t
, head
->x
, 1);
22988 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22992 /* Prepend glyph strings for glyphs in front of the first glyph
22993 string that overwrite that glyph string because of their
22994 right overhang. For these strings, only the foreground must
22995 be drawn, because it draws over the glyph string at `head'.
22996 The background must not be drawn because this would overwrite
22997 right overhangs of preceding glyphs for which no glyph
22999 i
= left_overwriting (head
);
23002 enum draw_glyphs_face overlap_hl
;
23004 if (check_mouse_face
23005 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23006 overlap_hl
= DRAW_MOUSE_FACE
;
23008 overlap_hl
= DRAW_NORMAL_TEXT
;
23011 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23012 overlap_hl
, dummy_x
, last_x
);
23013 for (s
= h
; s
; s
= s
->next
)
23014 s
->background_filled_p
= 1;
23015 compute_overhangs_and_x (t
, head
->x
, 1);
23016 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23019 /* Append glyphs strings for glyphs following the last glyph
23020 string tail that are overwritten by tail. The background of
23021 these strings has to be drawn because tail's foreground draws
23023 i
= right_overwritten (tail
);
23026 enum draw_glyphs_face overlap_hl
;
23028 if (check_mouse_face
23029 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23030 overlap_hl
= DRAW_MOUSE_FACE
;
23032 overlap_hl
= DRAW_NORMAL_TEXT
;
23034 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23035 overlap_hl
, x
, last_x
);
23036 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23037 we don't have `end = i;' here. */
23038 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23039 append_glyph_string_lists (&head
, &tail
, h
, t
);
23043 /* Append glyph strings for glyphs following the last glyph
23044 string tail that overwrite tail. The foreground of such
23045 glyphs has to be drawn because it writes into the background
23046 of tail. The background must not be drawn because it could
23047 paint over the foreground of following glyphs. */
23048 i
= right_overwriting (tail
);
23051 enum draw_glyphs_face overlap_hl
;
23052 if (check_mouse_face
23053 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23054 overlap_hl
= DRAW_MOUSE_FACE
;
23056 overlap_hl
= DRAW_NORMAL_TEXT
;
23059 i
++; /* We must include the Ith glyph. */
23060 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23061 overlap_hl
, x
, last_x
);
23062 for (s
= h
; s
; s
= s
->next
)
23063 s
->background_filled_p
= 1;
23064 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23065 append_glyph_string_lists (&head
, &tail
, h
, t
);
23067 if (clip_head
|| clip_tail
)
23068 for (s
= head
; s
; s
= s
->next
)
23070 s
->clip_head
= clip_head
;
23071 s
->clip_tail
= clip_tail
;
23075 /* Draw all strings. */
23076 for (s
= head
; s
; s
= s
->next
)
23077 FRAME_RIF (f
)->draw_glyph_string (s
);
23080 /* When focus a sole frame and move horizontally, this sets on_p to 0
23081 causing a failure to erase prev cursor position. */
23082 if (area
== TEXT_AREA
23083 && !row
->full_width_p
23084 /* When drawing overlapping rows, only the glyph strings'
23085 foreground is drawn, which doesn't erase a cursor
23089 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23090 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23091 : (tail
? tail
->x
+ tail
->background_width
: x
));
23095 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23096 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23100 /* Value is the x-position up to which drawn, relative to AREA of W.
23101 This doesn't include parts drawn because of overhangs. */
23102 if (row
->full_width_p
)
23103 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23105 x_reached
-= area_left
;
23107 RELEASE_HDC (hdc
, f
);
23112 /* Expand row matrix if too narrow. Don't expand if area
23115 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23117 if (!fonts_changed_p \
23118 && (it->glyph_row->glyphs[area] \
23119 < it->glyph_row->glyphs[area + 1])) \
23121 it->w->ncols_scale_factor++; \
23122 fonts_changed_p = 1; \
23126 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23127 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23130 append_glyph (struct it
*it
)
23132 struct glyph
*glyph
;
23133 enum glyph_row_area area
= it
->area
;
23135 xassert (it
->glyph_row
);
23136 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23138 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23139 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23141 /* If the glyph row is reversed, we need to prepend the glyph
23142 rather than append it. */
23143 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23147 /* Make room for the additional glyph. */
23148 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23150 glyph
= it
->glyph_row
->glyphs
[area
];
23152 glyph
->charpos
= CHARPOS (it
->position
);
23153 glyph
->object
= it
->object
;
23154 if (it
->pixel_width
> 0)
23156 glyph
->pixel_width
= it
->pixel_width
;
23157 glyph
->padding_p
= 0;
23161 /* Assure at least 1-pixel width. Otherwise, cursor can't
23162 be displayed correctly. */
23163 glyph
->pixel_width
= 1;
23164 glyph
->padding_p
= 1;
23166 glyph
->ascent
= it
->ascent
;
23167 glyph
->descent
= it
->descent
;
23168 glyph
->voffset
= it
->voffset
;
23169 glyph
->type
= CHAR_GLYPH
;
23170 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23171 glyph
->multibyte_p
= it
->multibyte_p
;
23172 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23173 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23174 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23175 || it
->phys_descent
> it
->descent
);
23176 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23177 glyph
->face_id
= it
->face_id
;
23178 glyph
->u
.ch
= it
->char_to_display
;
23179 glyph
->slice
.img
= null_glyph_slice
;
23180 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23183 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23184 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23186 glyph
->bidi_type
= it
->bidi_it
.type
;
23190 glyph
->resolved_level
= 0;
23191 glyph
->bidi_type
= UNKNOWN_BT
;
23193 ++it
->glyph_row
->used
[area
];
23196 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23199 /* Store one glyph for the composition IT->cmp_it.id in
23200 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23204 append_composite_glyph (struct it
*it
)
23206 struct glyph
*glyph
;
23207 enum glyph_row_area area
= it
->area
;
23209 xassert (it
->glyph_row
);
23211 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23212 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23214 /* If the glyph row is reversed, we need to prepend the glyph
23215 rather than append it. */
23216 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23220 /* Make room for the new glyph. */
23221 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23223 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23225 glyph
->charpos
= it
->cmp_it
.charpos
;
23226 glyph
->object
= it
->object
;
23227 glyph
->pixel_width
= it
->pixel_width
;
23228 glyph
->ascent
= it
->ascent
;
23229 glyph
->descent
= it
->descent
;
23230 glyph
->voffset
= it
->voffset
;
23231 glyph
->type
= COMPOSITE_GLYPH
;
23232 if (it
->cmp_it
.ch
< 0)
23234 glyph
->u
.cmp
.automatic
= 0;
23235 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23236 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23240 glyph
->u
.cmp
.automatic
= 1;
23241 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23242 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23243 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23245 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23246 glyph
->multibyte_p
= it
->multibyte_p
;
23247 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23248 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23249 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23250 || it
->phys_descent
> it
->descent
);
23251 glyph
->padding_p
= 0;
23252 glyph
->glyph_not_available_p
= 0;
23253 glyph
->face_id
= it
->face_id
;
23254 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23257 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23258 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23260 glyph
->bidi_type
= it
->bidi_it
.type
;
23262 ++it
->glyph_row
->used
[area
];
23265 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23269 /* Change IT->ascent and IT->height according to the setting of
23273 take_vertical_position_into_account (struct it
*it
)
23277 if (it
->voffset
< 0)
23278 /* Increase the ascent so that we can display the text higher
23280 it
->ascent
-= it
->voffset
;
23282 /* Increase the descent so that we can display the text lower
23284 it
->descent
+= it
->voffset
;
23289 /* Produce glyphs/get display metrics for the image IT is loaded with.
23290 See the description of struct display_iterator in dispextern.h for
23291 an overview of struct display_iterator. */
23294 produce_image_glyph (struct it
*it
)
23298 int glyph_ascent
, crop
;
23299 struct glyph_slice slice
;
23301 xassert (it
->what
== IT_IMAGE
);
23303 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23305 /* Make sure X resources of the face is loaded. */
23306 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23308 if (it
->image_id
< 0)
23310 /* Fringe bitmap. */
23311 it
->ascent
= it
->phys_ascent
= 0;
23312 it
->descent
= it
->phys_descent
= 0;
23313 it
->pixel_width
= 0;
23318 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23320 /* Make sure X resources of the image is loaded. */
23321 prepare_image_for_display (it
->f
, img
);
23323 slice
.x
= slice
.y
= 0;
23324 slice
.width
= img
->width
;
23325 slice
.height
= img
->height
;
23327 if (INTEGERP (it
->slice
.x
))
23328 slice
.x
= XINT (it
->slice
.x
);
23329 else if (FLOATP (it
->slice
.x
))
23330 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23332 if (INTEGERP (it
->slice
.y
))
23333 slice
.y
= XINT (it
->slice
.y
);
23334 else if (FLOATP (it
->slice
.y
))
23335 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23337 if (INTEGERP (it
->slice
.width
))
23338 slice
.width
= XINT (it
->slice
.width
);
23339 else if (FLOATP (it
->slice
.width
))
23340 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23342 if (INTEGERP (it
->slice
.height
))
23343 slice
.height
= XINT (it
->slice
.height
);
23344 else if (FLOATP (it
->slice
.height
))
23345 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23347 if (slice
.x
>= img
->width
)
23348 slice
.x
= img
->width
;
23349 if (slice
.y
>= img
->height
)
23350 slice
.y
= img
->height
;
23351 if (slice
.x
+ slice
.width
>= img
->width
)
23352 slice
.width
= img
->width
- slice
.x
;
23353 if (slice
.y
+ slice
.height
> img
->height
)
23354 slice
.height
= img
->height
- slice
.y
;
23356 if (slice
.width
== 0 || slice
.height
== 0)
23359 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23361 it
->descent
= slice
.height
- glyph_ascent
;
23363 it
->descent
+= img
->vmargin
;
23364 if (slice
.y
+ slice
.height
== img
->height
)
23365 it
->descent
+= img
->vmargin
;
23366 it
->phys_descent
= it
->descent
;
23368 it
->pixel_width
= slice
.width
;
23370 it
->pixel_width
+= img
->hmargin
;
23371 if (slice
.x
+ slice
.width
== img
->width
)
23372 it
->pixel_width
+= img
->hmargin
;
23374 /* It's quite possible for images to have an ascent greater than
23375 their height, so don't get confused in that case. */
23376 if (it
->descent
< 0)
23381 if (face
->box
!= FACE_NO_BOX
)
23383 if (face
->box_line_width
> 0)
23386 it
->ascent
+= face
->box_line_width
;
23387 if (slice
.y
+ slice
.height
== img
->height
)
23388 it
->descent
+= face
->box_line_width
;
23391 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23392 it
->pixel_width
+= eabs (face
->box_line_width
);
23393 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23394 it
->pixel_width
+= eabs (face
->box_line_width
);
23397 take_vertical_position_into_account (it
);
23399 /* Automatically crop wide image glyphs at right edge so we can
23400 draw the cursor on same display row. */
23401 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23402 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23404 it
->pixel_width
-= crop
;
23405 slice
.width
-= crop
;
23410 struct glyph
*glyph
;
23411 enum glyph_row_area area
= it
->area
;
23413 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23414 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23416 glyph
->charpos
= CHARPOS (it
->position
);
23417 glyph
->object
= it
->object
;
23418 glyph
->pixel_width
= it
->pixel_width
;
23419 glyph
->ascent
= glyph_ascent
;
23420 glyph
->descent
= it
->descent
;
23421 glyph
->voffset
= it
->voffset
;
23422 glyph
->type
= IMAGE_GLYPH
;
23423 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23424 glyph
->multibyte_p
= it
->multibyte_p
;
23425 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23426 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23427 glyph
->overlaps_vertically_p
= 0;
23428 glyph
->padding_p
= 0;
23429 glyph
->glyph_not_available_p
= 0;
23430 glyph
->face_id
= it
->face_id
;
23431 glyph
->u
.img_id
= img
->id
;
23432 glyph
->slice
.img
= slice
;
23433 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23436 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23437 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23439 glyph
->bidi_type
= it
->bidi_it
.type
;
23441 ++it
->glyph_row
->used
[area
];
23444 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23449 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23450 of the glyph, WIDTH and HEIGHT are the width and height of the
23451 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23454 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23455 int width
, int height
, int ascent
)
23457 struct glyph
*glyph
;
23458 enum glyph_row_area area
= it
->area
;
23460 xassert (ascent
>= 0 && ascent
<= height
);
23462 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23463 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23465 /* If the glyph row is reversed, we need to prepend the glyph
23466 rather than append it. */
23467 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23471 /* Make room for the additional glyph. */
23472 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23474 glyph
= it
->glyph_row
->glyphs
[area
];
23476 glyph
->charpos
= CHARPOS (it
->position
);
23477 glyph
->object
= object
;
23478 glyph
->pixel_width
= width
;
23479 glyph
->ascent
= ascent
;
23480 glyph
->descent
= height
- ascent
;
23481 glyph
->voffset
= it
->voffset
;
23482 glyph
->type
= STRETCH_GLYPH
;
23483 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23484 glyph
->multibyte_p
= it
->multibyte_p
;
23485 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23486 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23487 glyph
->overlaps_vertically_p
= 0;
23488 glyph
->padding_p
= 0;
23489 glyph
->glyph_not_available_p
= 0;
23490 glyph
->face_id
= it
->face_id
;
23491 glyph
->u
.stretch
.ascent
= ascent
;
23492 glyph
->u
.stretch
.height
= height
;
23493 glyph
->slice
.img
= null_glyph_slice
;
23494 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23497 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23498 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23500 glyph
->bidi_type
= it
->bidi_it
.type
;
23504 glyph
->resolved_level
= 0;
23505 glyph
->bidi_type
= UNKNOWN_BT
;
23507 ++it
->glyph_row
->used
[area
];
23510 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23513 #endif /* HAVE_WINDOW_SYSTEM */
23515 /* Produce a stretch glyph for iterator IT. IT->object is the value
23516 of the glyph property displayed. The value must be a list
23517 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23520 1. `:width WIDTH' specifies that the space should be WIDTH *
23521 canonical char width wide. WIDTH may be an integer or floating
23524 2. `:relative-width FACTOR' specifies that the width of the stretch
23525 should be computed from the width of the first character having the
23526 `glyph' property, and should be FACTOR times that width.
23528 3. `:align-to HPOS' specifies that the space should be wide enough
23529 to reach HPOS, a value in canonical character units.
23531 Exactly one of the above pairs must be present.
23533 4. `:height HEIGHT' specifies that the height of the stretch produced
23534 should be HEIGHT, measured in canonical character units.
23536 5. `:relative-height FACTOR' specifies that the height of the
23537 stretch should be FACTOR times the height of the characters having
23538 the glyph property.
23540 Either none or exactly one of 4 or 5 must be present.
23542 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23543 of the stretch should be used for the ascent of the stretch.
23544 ASCENT must be in the range 0 <= ASCENT <= 100. */
23547 produce_stretch_glyph (struct it
*it
)
23549 /* (space :width WIDTH :height HEIGHT ...) */
23550 Lisp_Object prop
, plist
;
23551 int width
= 0, height
= 0, align_to
= -1;
23552 int zero_width_ok_p
= 0;
23555 struct face
*face
= NULL
;
23556 struct font
*font
= NULL
;
23558 #ifdef HAVE_WINDOW_SYSTEM
23559 int zero_height_ok_p
= 0;
23561 if (FRAME_WINDOW_P (it
->f
))
23563 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23564 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23565 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23569 /* List should start with `space'. */
23570 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23571 plist
= XCDR (it
->object
);
23573 /* Compute the width of the stretch. */
23574 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23575 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23577 /* Absolute width `:width WIDTH' specified and valid. */
23578 zero_width_ok_p
= 1;
23581 #ifdef HAVE_WINDOW_SYSTEM
23582 else if (FRAME_WINDOW_P (it
->f
)
23583 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23585 /* Relative width `:relative-width FACTOR' specified and valid.
23586 Compute the width of the characters having the `glyph'
23589 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23592 if (it
->multibyte_p
)
23593 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23596 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23597 if (! ASCII_CHAR_P (it2
.c
))
23598 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23601 it2
.glyph_row
= NULL
;
23602 it2
.what
= IT_CHARACTER
;
23603 x_produce_glyphs (&it2
);
23604 width
= NUMVAL (prop
) * it2
.pixel_width
;
23606 #endif /* HAVE_WINDOW_SYSTEM */
23607 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23608 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23610 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23611 align_to
= (align_to
< 0
23613 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23614 else if (align_to
< 0)
23615 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23616 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23617 zero_width_ok_p
= 1;
23620 /* Nothing specified -> width defaults to canonical char width. */
23621 width
= FRAME_COLUMN_WIDTH (it
->f
);
23623 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23626 #ifdef HAVE_WINDOW_SYSTEM
23627 /* Compute height. */
23628 if (FRAME_WINDOW_P (it
->f
))
23630 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23631 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23634 zero_height_ok_p
= 1;
23636 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23638 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23640 height
= FONT_HEIGHT (font
);
23642 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23645 /* Compute percentage of height used for ascent. If
23646 `:ascent ASCENT' is present and valid, use that. Otherwise,
23647 derive the ascent from the font in use. */
23648 if (prop
= Fplist_get (plist
, QCascent
),
23649 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23650 ascent
= height
* NUMVAL (prop
) / 100.0;
23651 else if (!NILP (prop
)
23652 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23653 ascent
= min (max (0, (int)tem
), height
);
23655 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23658 #endif /* HAVE_WINDOW_SYSTEM */
23661 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23662 && it
->current_x
+ width
> it
->last_visible_x
)
23664 width
= it
->last_visible_x
- it
->current_x
;
23665 #ifdef HAVE_WINDOW_SYSTEM
23666 /* Subtract one more pixel from the stretch width, but only on
23667 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23668 width
-= FRAME_WINDOW_P (it
->f
);
23672 if (width
> 0 && height
> 0 && it
->glyph_row
)
23674 Lisp_Object o_object
= it
->object
;
23675 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23678 if (!STRINGP (object
))
23679 object
= it
->w
->buffer
;
23680 #ifdef HAVE_WINDOW_SYSTEM
23681 if (FRAME_WINDOW_P (it
->f
))
23682 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23686 it
->object
= object
;
23687 it
->char_to_display
= ' ';
23688 it
->pixel_width
= it
->len
= 1;
23690 tty_append_glyph (it
);
23691 it
->object
= o_object
;
23695 it
->pixel_width
= width
;
23696 #ifdef HAVE_WINDOW_SYSTEM
23697 if (FRAME_WINDOW_P (it
->f
))
23699 it
->ascent
= it
->phys_ascent
= ascent
;
23700 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23701 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23702 take_vertical_position_into_account (it
);
23706 it
->nglyphs
= width
;
23709 #ifdef HAVE_WINDOW_SYSTEM
23711 /* Calculate line-height and line-spacing properties.
23712 An integer value specifies explicit pixel value.
23713 A float value specifies relative value to current face height.
23714 A cons (float . face-name) specifies relative value to
23715 height of specified face font.
23717 Returns height in pixels, or nil. */
23721 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23722 int boff
, int override
)
23724 Lisp_Object face_name
= Qnil
;
23725 int ascent
, descent
, height
;
23727 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23732 face_name
= XCAR (val
);
23734 if (!NUMBERP (val
))
23735 val
= make_number (1);
23736 if (NILP (face_name
))
23738 height
= it
->ascent
+ it
->descent
;
23743 if (NILP (face_name
))
23745 font
= FRAME_FONT (it
->f
);
23746 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23748 else if (EQ (face_name
, Qt
))
23757 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23759 return make_number (-1);
23761 face
= FACE_FROM_ID (it
->f
, face_id
);
23764 return make_number (-1);
23765 boff
= font
->baseline_offset
;
23766 if (font
->vertical_centering
)
23767 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23770 ascent
= FONT_BASE (font
) + boff
;
23771 descent
= FONT_DESCENT (font
) - boff
;
23775 it
->override_ascent
= ascent
;
23776 it
->override_descent
= descent
;
23777 it
->override_boff
= boff
;
23780 height
= ascent
+ descent
;
23784 height
= (int)(XFLOAT_DATA (val
) * height
);
23785 else if (INTEGERP (val
))
23786 height
*= XINT (val
);
23788 return make_number (height
);
23792 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23793 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23794 and only if this is for a character for which no font was found.
23796 If the display method (it->glyphless_method) is
23797 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23798 length of the acronym or the hexadecimal string, UPPER_XOFF and
23799 UPPER_YOFF are pixel offsets for the upper part of the string,
23800 LOWER_XOFF and LOWER_YOFF are for the lower part.
23802 For the other display methods, LEN through LOWER_YOFF are zero. */
23805 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23806 short upper_xoff
, short upper_yoff
,
23807 short lower_xoff
, short lower_yoff
)
23809 struct glyph
*glyph
;
23810 enum glyph_row_area area
= it
->area
;
23812 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23813 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23815 /* If the glyph row is reversed, we need to prepend the glyph
23816 rather than append it. */
23817 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23821 /* Make room for the additional glyph. */
23822 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23824 glyph
= it
->glyph_row
->glyphs
[area
];
23826 glyph
->charpos
= CHARPOS (it
->position
);
23827 glyph
->object
= it
->object
;
23828 glyph
->pixel_width
= it
->pixel_width
;
23829 glyph
->ascent
= it
->ascent
;
23830 glyph
->descent
= it
->descent
;
23831 glyph
->voffset
= it
->voffset
;
23832 glyph
->type
= GLYPHLESS_GLYPH
;
23833 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23834 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23835 glyph
->u
.glyphless
.len
= len
;
23836 glyph
->u
.glyphless
.ch
= it
->c
;
23837 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23838 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23839 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23840 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23841 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23842 glyph
->multibyte_p
= it
->multibyte_p
;
23843 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23844 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23845 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23846 || it
->phys_descent
> it
->descent
);
23847 glyph
->padding_p
= 0;
23848 glyph
->glyph_not_available_p
= 0;
23849 glyph
->face_id
= face_id
;
23850 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23853 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23854 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23856 glyph
->bidi_type
= it
->bidi_it
.type
;
23858 ++it
->glyph_row
->used
[area
];
23861 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23865 /* Produce a glyph for a glyphless character for iterator IT.
23866 IT->glyphless_method specifies which method to use for displaying
23867 the character. See the description of enum
23868 glyphless_display_method in dispextern.h for the detail.
23870 FOR_NO_FONT is nonzero if and only if this is for a character for
23871 which no font was found. ACRONYM, if non-nil, is an acronym string
23872 for the character. */
23875 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23880 int base_width
, base_height
, width
, height
;
23881 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23884 /* Get the metrics of the base font. We always refer to the current
23886 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23887 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23888 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23889 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23890 base_height
= it
->ascent
+ it
->descent
;
23891 base_width
= font
->average_width
;
23893 /* Get a face ID for the glyph by utilizing a cache (the same way as
23894 done for `escape-glyph' in get_next_display_element). */
23895 if (it
->f
== last_glyphless_glyph_frame
23896 && it
->face_id
== last_glyphless_glyph_face_id
)
23898 face_id
= last_glyphless_glyph_merged_face_id
;
23902 /* Merge the `glyphless-char' face into the current face. */
23903 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23904 last_glyphless_glyph_frame
= it
->f
;
23905 last_glyphless_glyph_face_id
= it
->face_id
;
23906 last_glyphless_glyph_merged_face_id
= face_id
;
23909 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23911 it
->pixel_width
= THIN_SPACE_WIDTH
;
23913 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23915 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23917 width
= CHAR_WIDTH (it
->c
);
23920 else if (width
> 4)
23922 it
->pixel_width
= base_width
* width
;
23924 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23930 unsigned int code
[6];
23932 int ascent
, descent
;
23933 struct font_metrics metrics_upper
, metrics_lower
;
23935 face
= FACE_FROM_ID (it
->f
, face_id
);
23936 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23937 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23939 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23941 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23942 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23943 if (CONSP (acronym
))
23944 acronym
= XCAR (acronym
);
23945 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23949 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23950 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23953 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23954 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23955 upper_len
= (len
+ 1) / 2;
23956 font
->driver
->text_extents (font
, code
, upper_len
,
23958 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23963 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23964 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23965 upper_xoff
= upper_yoff
= 2; /* the typical case */
23966 if (base_width
>= width
)
23968 /* Align the upper to the left, the lower to the right. */
23969 it
->pixel_width
= base_width
;
23970 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23974 /* Center the shorter one. */
23975 it
->pixel_width
= width
;
23976 if (metrics_upper
.width
>= metrics_lower
.width
)
23977 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23980 /* FIXME: This code doesn't look right. It formerly was
23981 missing the "lower_xoff = 0;", which couldn't have
23982 been right since it left lower_xoff uninitialized. */
23984 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23988 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23989 top, bottom, and between upper and lower strings. */
23990 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23991 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23992 /* Center vertically.
23993 H:base_height, D:base_descent
23994 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23996 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23997 descent = D - H/2 + h/2;
23998 lower_yoff = descent - 2 - ld;
23999 upper_yoff = lower_yoff - la - 1 - ud; */
24000 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24001 descent
= it
->descent
- (base_height
- height
) / 2;
24002 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24003 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24004 - metrics_upper
.descent
);
24005 /* Don't make the height shorter than the base height. */
24006 if (height
> base_height
)
24008 it
->ascent
= ascent
;
24009 it
->descent
= descent
;
24013 it
->phys_ascent
= it
->ascent
;
24014 it
->phys_descent
= it
->descent
;
24016 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24017 upper_xoff
, upper_yoff
,
24018 lower_xoff
, lower_yoff
);
24020 take_vertical_position_into_account (it
);
24025 Produce glyphs/get display metrics for the display element IT is
24026 loaded with. See the description of struct it in dispextern.h
24027 for an overview of struct it. */
24030 x_produce_glyphs (struct it
*it
)
24032 int extra_line_spacing
= it
->extra_line_spacing
;
24034 it
->glyph_not_available_p
= 0;
24036 if (it
->what
== IT_CHARACTER
)
24039 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24040 struct font
*font
= face
->font
;
24041 struct font_metrics
*pcm
= NULL
;
24042 int boff
; /* baseline offset */
24046 /* When no suitable font is found, display this character by
24047 the method specified in the first extra slot of
24048 Vglyphless_char_display. */
24049 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24051 xassert (it
->what
== IT_GLYPHLESS
);
24052 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24056 boff
= font
->baseline_offset
;
24057 if (font
->vertical_centering
)
24058 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24060 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24066 if (it
->override_ascent
>= 0)
24068 it
->ascent
= it
->override_ascent
;
24069 it
->descent
= it
->override_descent
;
24070 boff
= it
->override_boff
;
24074 it
->ascent
= FONT_BASE (font
) + boff
;
24075 it
->descent
= FONT_DESCENT (font
) - boff
;
24078 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24080 pcm
= get_per_char_metric (font
, &char2b
);
24081 if (pcm
->width
== 0
24082 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24088 it
->phys_ascent
= pcm
->ascent
+ boff
;
24089 it
->phys_descent
= pcm
->descent
- boff
;
24090 it
->pixel_width
= pcm
->width
;
24094 it
->glyph_not_available_p
= 1;
24095 it
->phys_ascent
= it
->ascent
;
24096 it
->phys_descent
= it
->descent
;
24097 it
->pixel_width
= font
->space_width
;
24100 if (it
->constrain_row_ascent_descent_p
)
24102 if (it
->descent
> it
->max_descent
)
24104 it
->ascent
+= it
->descent
- it
->max_descent
;
24105 it
->descent
= it
->max_descent
;
24107 if (it
->ascent
> it
->max_ascent
)
24109 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24110 it
->ascent
= it
->max_ascent
;
24112 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24113 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24114 extra_line_spacing
= 0;
24117 /* If this is a space inside a region of text with
24118 `space-width' property, change its width. */
24119 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24121 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24123 /* If face has a box, add the box thickness to the character
24124 height. If character has a box line to the left and/or
24125 right, add the box line width to the character's width. */
24126 if (face
->box
!= FACE_NO_BOX
)
24128 int thick
= face
->box_line_width
;
24132 it
->ascent
+= thick
;
24133 it
->descent
+= thick
;
24138 if (it
->start_of_box_run_p
)
24139 it
->pixel_width
+= thick
;
24140 if (it
->end_of_box_run_p
)
24141 it
->pixel_width
+= thick
;
24144 /* If face has an overline, add the height of the overline
24145 (1 pixel) and a 1 pixel margin to the character height. */
24146 if (face
->overline_p
)
24147 it
->ascent
+= overline_margin
;
24149 if (it
->constrain_row_ascent_descent_p
)
24151 if (it
->ascent
> it
->max_ascent
)
24152 it
->ascent
= it
->max_ascent
;
24153 if (it
->descent
> it
->max_descent
)
24154 it
->descent
= it
->max_descent
;
24157 take_vertical_position_into_account (it
);
24159 /* If we have to actually produce glyphs, do it. */
24164 /* Translate a space with a `space-width' property
24165 into a stretch glyph. */
24166 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24167 / FONT_HEIGHT (font
));
24168 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24169 it
->ascent
+ it
->descent
, ascent
);
24174 /* If characters with lbearing or rbearing are displayed
24175 in this line, record that fact in a flag of the
24176 glyph row. This is used to optimize X output code. */
24177 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24178 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24180 if (! stretched_p
&& it
->pixel_width
== 0)
24181 /* We assure that all visible glyphs have at least 1-pixel
24183 it
->pixel_width
= 1;
24185 else if (it
->char_to_display
== '\n')
24187 /* A newline has no width, but we need the height of the
24188 line. But if previous part of the line sets a height,
24189 don't increase that height */
24191 Lisp_Object height
;
24192 Lisp_Object total_height
= Qnil
;
24194 it
->override_ascent
= -1;
24195 it
->pixel_width
= 0;
24198 height
= get_it_property (it
, Qline_height
);
24199 /* Split (line-height total-height) list */
24201 && CONSP (XCDR (height
))
24202 && NILP (XCDR (XCDR (height
))))
24204 total_height
= XCAR (XCDR (height
));
24205 height
= XCAR (height
);
24207 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24209 if (it
->override_ascent
>= 0)
24211 it
->ascent
= it
->override_ascent
;
24212 it
->descent
= it
->override_descent
;
24213 boff
= it
->override_boff
;
24217 it
->ascent
= FONT_BASE (font
) + boff
;
24218 it
->descent
= FONT_DESCENT (font
) - boff
;
24221 if (EQ (height
, Qt
))
24223 if (it
->descent
> it
->max_descent
)
24225 it
->ascent
+= it
->descent
- it
->max_descent
;
24226 it
->descent
= it
->max_descent
;
24228 if (it
->ascent
> it
->max_ascent
)
24230 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24231 it
->ascent
= it
->max_ascent
;
24233 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24234 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24235 it
->constrain_row_ascent_descent_p
= 1;
24236 extra_line_spacing
= 0;
24240 Lisp_Object spacing
;
24242 it
->phys_ascent
= it
->ascent
;
24243 it
->phys_descent
= it
->descent
;
24245 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24246 && face
->box
!= FACE_NO_BOX
24247 && face
->box_line_width
> 0)
24249 it
->ascent
+= face
->box_line_width
;
24250 it
->descent
+= face
->box_line_width
;
24253 && XINT (height
) > it
->ascent
+ it
->descent
)
24254 it
->ascent
= XINT (height
) - it
->descent
;
24256 if (!NILP (total_height
))
24257 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24260 spacing
= get_it_property (it
, Qline_spacing
);
24261 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24263 if (INTEGERP (spacing
))
24265 extra_line_spacing
= XINT (spacing
);
24266 if (!NILP (total_height
))
24267 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24271 else /* i.e. (it->char_to_display == '\t') */
24273 if (font
->space_width
> 0)
24275 int tab_width
= it
->tab_width
* font
->space_width
;
24276 int x
= it
->current_x
+ it
->continuation_lines_width
;
24277 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24279 /* If the distance from the current position to the next tab
24280 stop is less than a space character width, use the
24281 tab stop after that. */
24282 if (next_tab_x
- x
< font
->space_width
)
24283 next_tab_x
+= tab_width
;
24285 it
->pixel_width
= next_tab_x
- x
;
24287 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24288 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24292 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24293 it
->ascent
+ it
->descent
, it
->ascent
);
24298 it
->pixel_width
= 0;
24303 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24305 /* A static composition.
24307 Note: A composition is represented as one glyph in the
24308 glyph matrix. There are no padding glyphs.
24310 Important note: pixel_width, ascent, and descent are the
24311 values of what is drawn by draw_glyphs (i.e. the values of
24312 the overall glyphs composed). */
24313 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24314 int boff
; /* baseline offset */
24315 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24316 int glyph_len
= cmp
->glyph_len
;
24317 struct font
*font
= face
->font
;
24321 /* If we have not yet calculated pixel size data of glyphs of
24322 the composition for the current face font, calculate them
24323 now. Theoretically, we have to check all fonts for the
24324 glyphs, but that requires much time and memory space. So,
24325 here we check only the font of the first glyph. This may
24326 lead to incorrect display, but it's very rare, and C-l
24327 (recenter-top-bottom) can correct the display anyway. */
24328 if (! cmp
->font
|| cmp
->font
!= font
)
24330 /* Ascent and descent of the font of the first character
24331 of this composition (adjusted by baseline offset).
24332 Ascent and descent of overall glyphs should not be less
24333 than these, respectively. */
24334 int font_ascent
, font_descent
, font_height
;
24335 /* Bounding box of the overall glyphs. */
24336 int leftmost
, rightmost
, lowest
, highest
;
24337 int lbearing
, rbearing
;
24338 int i
, width
, ascent
, descent
;
24339 int left_padded
= 0, right_padded
= 0;
24340 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24342 struct font_metrics
*pcm
;
24343 int font_not_found_p
;
24346 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24347 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24349 if (glyph_len
< cmp
->glyph_len
)
24351 for (i
= 0; i
< glyph_len
; i
++)
24353 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24355 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24360 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24361 : IT_CHARPOS (*it
));
24362 /* If no suitable font is found, use the default font. */
24363 font_not_found_p
= font
== NULL
;
24364 if (font_not_found_p
)
24366 face
= face
->ascii_face
;
24369 boff
= font
->baseline_offset
;
24370 if (font
->vertical_centering
)
24371 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24372 font_ascent
= FONT_BASE (font
) + boff
;
24373 font_descent
= FONT_DESCENT (font
) - boff
;
24374 font_height
= FONT_HEIGHT (font
);
24376 cmp
->font
= (void *) font
;
24379 if (! font_not_found_p
)
24381 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24383 pcm
= get_per_char_metric (font
, &char2b
);
24386 /* Initialize the bounding box. */
24389 width
= pcm
->width
;
24390 ascent
= pcm
->ascent
;
24391 descent
= pcm
->descent
;
24392 lbearing
= pcm
->lbearing
;
24393 rbearing
= pcm
->rbearing
;
24397 width
= font
->space_width
;
24398 ascent
= FONT_BASE (font
);
24399 descent
= FONT_DESCENT (font
);
24406 lowest
= - descent
+ boff
;
24407 highest
= ascent
+ boff
;
24409 if (! font_not_found_p
24410 && font
->default_ascent
24411 && CHAR_TABLE_P (Vuse_default_ascent
)
24412 && !NILP (Faref (Vuse_default_ascent
,
24413 make_number (it
->char_to_display
))))
24414 highest
= font
->default_ascent
+ boff
;
24416 /* Draw the first glyph at the normal position. It may be
24417 shifted to right later if some other glyphs are drawn
24419 cmp
->offsets
[i
* 2] = 0;
24420 cmp
->offsets
[i
* 2 + 1] = boff
;
24421 cmp
->lbearing
= lbearing
;
24422 cmp
->rbearing
= rbearing
;
24424 /* Set cmp->offsets for the remaining glyphs. */
24425 for (i
++; i
< glyph_len
; i
++)
24427 int left
, right
, btm
, top
;
24428 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24430 struct face
*this_face
;
24434 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24435 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24436 font
= this_face
->font
;
24442 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24444 pcm
= get_per_char_metric (font
, &char2b
);
24447 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24450 width
= pcm
->width
;
24451 ascent
= pcm
->ascent
;
24452 descent
= pcm
->descent
;
24453 lbearing
= pcm
->lbearing
;
24454 rbearing
= pcm
->rbearing
;
24455 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24457 /* Relative composition with or without
24458 alternate chars. */
24459 left
= (leftmost
+ rightmost
- width
) / 2;
24460 btm
= - descent
+ boff
;
24461 if (font
->relative_compose
24462 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24463 || NILP (Faref (Vignore_relative_composition
,
24464 make_number (ch
)))))
24467 if (- descent
>= font
->relative_compose
)
24468 /* One extra pixel between two glyphs. */
24470 else if (ascent
<= 0)
24471 /* One extra pixel between two glyphs. */
24472 btm
= lowest
- 1 - ascent
- descent
;
24477 /* A composition rule is specified by an integer
24478 value that encodes global and new reference
24479 points (GREF and NREF). GREF and NREF are
24480 specified by numbers as below:
24482 0---1---2 -- ascent
24486 9--10--11 -- center
24488 ---3---4---5--- baseline
24490 6---7---8 -- descent
24492 int rule
= COMPOSITION_RULE (cmp
, i
);
24493 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24495 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24496 grefx
= gref
% 3, nrefx
= nref
% 3;
24497 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24499 xoff
= font_height
* (xoff
- 128) / 256;
24501 yoff
= font_height
* (yoff
- 128) / 256;
24504 + grefx
* (rightmost
- leftmost
) / 2
24505 - nrefx
* width
/ 2
24508 btm
= ((grefy
== 0 ? highest
24510 : grefy
== 2 ? lowest
24511 : (highest
+ lowest
) / 2)
24512 - (nrefy
== 0 ? ascent
+ descent
24513 : nrefy
== 1 ? descent
- boff
24515 : (ascent
+ descent
) / 2)
24519 cmp
->offsets
[i
* 2] = left
;
24520 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24522 /* Update the bounding box of the overall glyphs. */
24525 right
= left
+ width
;
24526 if (left
< leftmost
)
24528 if (right
> rightmost
)
24531 top
= btm
+ descent
+ ascent
;
24537 if (cmp
->lbearing
> left
+ lbearing
)
24538 cmp
->lbearing
= left
+ lbearing
;
24539 if (cmp
->rbearing
< left
+ rbearing
)
24540 cmp
->rbearing
= left
+ rbearing
;
24544 /* If there are glyphs whose x-offsets are negative,
24545 shift all glyphs to the right and make all x-offsets
24549 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24550 cmp
->offsets
[i
* 2] -= leftmost
;
24551 rightmost
-= leftmost
;
24552 cmp
->lbearing
-= leftmost
;
24553 cmp
->rbearing
-= leftmost
;
24556 if (left_padded
&& cmp
->lbearing
< 0)
24558 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24559 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24560 rightmost
-= cmp
->lbearing
;
24561 cmp
->rbearing
-= cmp
->lbearing
;
24564 if (right_padded
&& rightmost
< cmp
->rbearing
)
24566 rightmost
= cmp
->rbearing
;
24569 cmp
->pixel_width
= rightmost
;
24570 cmp
->ascent
= highest
;
24571 cmp
->descent
= - lowest
;
24572 if (cmp
->ascent
< font_ascent
)
24573 cmp
->ascent
= font_ascent
;
24574 if (cmp
->descent
< font_descent
)
24575 cmp
->descent
= font_descent
;
24579 && (cmp
->lbearing
< 0
24580 || cmp
->rbearing
> cmp
->pixel_width
))
24581 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24583 it
->pixel_width
= cmp
->pixel_width
;
24584 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24585 it
->descent
= it
->phys_descent
= cmp
->descent
;
24586 if (face
->box
!= FACE_NO_BOX
)
24588 int thick
= face
->box_line_width
;
24592 it
->ascent
+= thick
;
24593 it
->descent
+= thick
;
24598 if (it
->start_of_box_run_p
)
24599 it
->pixel_width
+= thick
;
24600 if (it
->end_of_box_run_p
)
24601 it
->pixel_width
+= thick
;
24604 /* If face has an overline, add the height of the overline
24605 (1 pixel) and a 1 pixel margin to the character height. */
24606 if (face
->overline_p
)
24607 it
->ascent
+= overline_margin
;
24609 take_vertical_position_into_account (it
);
24610 if (it
->ascent
< 0)
24612 if (it
->descent
< 0)
24616 append_composite_glyph (it
);
24618 else if (it
->what
== IT_COMPOSITION
)
24620 /* A dynamic (automatic) composition. */
24621 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24622 Lisp_Object gstring
;
24623 struct font_metrics metrics
;
24627 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24629 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24632 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24633 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24634 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24635 it
->descent
= it
->phys_descent
= metrics
.descent
;
24636 if (face
->box
!= FACE_NO_BOX
)
24638 int thick
= face
->box_line_width
;
24642 it
->ascent
+= thick
;
24643 it
->descent
+= thick
;
24648 if (it
->start_of_box_run_p
)
24649 it
->pixel_width
+= thick
;
24650 if (it
->end_of_box_run_p
)
24651 it
->pixel_width
+= thick
;
24653 /* If face has an overline, add the height of the overline
24654 (1 pixel) and a 1 pixel margin to the character height. */
24655 if (face
->overline_p
)
24656 it
->ascent
+= overline_margin
;
24657 take_vertical_position_into_account (it
);
24658 if (it
->ascent
< 0)
24660 if (it
->descent
< 0)
24664 append_composite_glyph (it
);
24666 else if (it
->what
== IT_GLYPHLESS
)
24667 produce_glyphless_glyph (it
, 0, Qnil
);
24668 else if (it
->what
== IT_IMAGE
)
24669 produce_image_glyph (it
);
24670 else if (it
->what
== IT_STRETCH
)
24671 produce_stretch_glyph (it
);
24674 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24675 because this isn't true for images with `:ascent 100'. */
24676 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24677 if (it
->area
== TEXT_AREA
)
24678 it
->current_x
+= it
->pixel_width
;
24680 if (extra_line_spacing
> 0)
24682 it
->descent
+= extra_line_spacing
;
24683 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24684 it
->max_extra_line_spacing
= extra_line_spacing
;
24687 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24688 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24689 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24690 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24694 Output LEN glyphs starting at START at the nominal cursor position.
24695 Advance the nominal cursor over the text. The global variable
24696 updated_window contains the window being updated, updated_row is
24697 the glyph row being updated, and updated_area is the area of that
24698 row being updated. */
24701 x_write_glyphs (struct glyph
*start
, int len
)
24703 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
24705 xassert (updated_window
&& updated_row
);
24706 /* When the window is hscrolled, cursor hpos can legitimately be out
24707 of bounds, but we draw the cursor at the corresponding window
24708 margin in that case. */
24709 if (!updated_row
->reversed_p
&& chpos
< 0)
24711 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
24712 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
24716 /* Write glyphs. */
24718 hpos
= start
- updated_row
->glyphs
[updated_area
];
24719 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24720 updated_row
, updated_area
,
24722 DRAW_NORMAL_TEXT
, 0);
24724 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24725 if (updated_area
== TEXT_AREA
24726 && updated_window
->phys_cursor_on_p
24727 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24729 && chpos
< hpos
+ len
)
24730 updated_window
->phys_cursor_on_p
= 0;
24734 /* Advance the output cursor. */
24735 output_cursor
.hpos
+= len
;
24736 output_cursor
.x
= x
;
24741 Insert LEN glyphs from START at the nominal cursor position. */
24744 x_insert_glyphs (struct glyph
*start
, int len
)
24748 int line_height
, shift_by_width
, shifted_region_width
;
24749 struct glyph_row
*row
;
24750 struct glyph
*glyph
;
24751 int frame_x
, frame_y
;
24754 xassert (updated_window
&& updated_row
);
24756 w
= updated_window
;
24757 f
= XFRAME (WINDOW_FRAME (w
));
24759 /* Get the height of the line we are in. */
24761 line_height
= row
->height
;
24763 /* Get the width of the glyphs to insert. */
24764 shift_by_width
= 0;
24765 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24766 shift_by_width
+= glyph
->pixel_width
;
24768 /* Get the width of the region to shift right. */
24769 shifted_region_width
= (window_box_width (w
, updated_area
)
24774 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24775 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24777 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24778 line_height
, shift_by_width
);
24780 /* Write the glyphs. */
24781 hpos
= start
- row
->glyphs
[updated_area
];
24782 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24784 DRAW_NORMAL_TEXT
, 0);
24786 /* Advance the output cursor. */
24787 output_cursor
.hpos
+= len
;
24788 output_cursor
.x
+= shift_by_width
;
24794 Erase the current text line from the nominal cursor position
24795 (inclusive) to pixel column TO_X (exclusive). The idea is that
24796 everything from TO_X onward is already erased.
24798 TO_X is a pixel position relative to updated_area of
24799 updated_window. TO_X == -1 means clear to the end of this area. */
24802 x_clear_end_of_line (int to_x
)
24805 struct window
*w
= updated_window
;
24806 int max_x
, min_y
, max_y
;
24807 int from_x
, from_y
, to_y
;
24809 xassert (updated_window
&& updated_row
);
24810 f
= XFRAME (w
->frame
);
24812 if (updated_row
->full_width_p
)
24813 max_x
= WINDOW_TOTAL_WIDTH (w
);
24815 max_x
= window_box_width (w
, updated_area
);
24816 max_y
= window_text_bottom_y (w
);
24818 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24819 of window. For TO_X > 0, truncate to end of drawing area. */
24825 to_x
= min (to_x
, max_x
);
24827 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24829 /* Notice if the cursor will be cleared by this operation. */
24830 if (!updated_row
->full_width_p
)
24831 notice_overwritten_cursor (w
, updated_area
,
24832 output_cursor
.x
, -1,
24834 MATRIX_ROW_BOTTOM_Y (updated_row
));
24836 from_x
= output_cursor
.x
;
24838 /* Translate to frame coordinates. */
24839 if (updated_row
->full_width_p
)
24841 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24842 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24846 int area_left
= window_box_left (w
, updated_area
);
24847 from_x
+= area_left
;
24851 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24852 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24853 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24855 /* Prevent inadvertently clearing to end of the X window. */
24856 if (to_x
> from_x
&& to_y
> from_y
)
24859 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24860 to_x
- from_x
, to_y
- from_y
);
24865 #endif /* HAVE_WINDOW_SYSTEM */
24869 /***********************************************************************
24871 ***********************************************************************/
24873 /* Value is the internal representation of the specified cursor type
24874 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24875 of the bar cursor. */
24877 static enum text_cursor_kinds
24878 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24880 enum text_cursor_kinds type
;
24885 if (EQ (arg
, Qbox
))
24886 return FILLED_BOX_CURSOR
;
24888 if (EQ (arg
, Qhollow
))
24889 return HOLLOW_BOX_CURSOR
;
24891 if (EQ (arg
, Qbar
))
24898 && EQ (XCAR (arg
), Qbar
)
24899 && INTEGERP (XCDR (arg
))
24900 && XINT (XCDR (arg
)) >= 0)
24902 *width
= XINT (XCDR (arg
));
24906 if (EQ (arg
, Qhbar
))
24909 return HBAR_CURSOR
;
24913 && EQ (XCAR (arg
), Qhbar
)
24914 && INTEGERP (XCDR (arg
))
24915 && XINT (XCDR (arg
)) >= 0)
24917 *width
= XINT (XCDR (arg
));
24918 return HBAR_CURSOR
;
24921 /* Treat anything unknown as "hollow box cursor".
24922 It was bad to signal an error; people have trouble fixing
24923 .Xdefaults with Emacs, when it has something bad in it. */
24924 type
= HOLLOW_BOX_CURSOR
;
24929 /* Set the default cursor types for specified frame. */
24931 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24936 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24937 FRAME_CURSOR_WIDTH (f
) = width
;
24939 /* By default, set up the blink-off state depending on the on-state. */
24941 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24944 FRAME_BLINK_OFF_CURSOR (f
)
24945 = get_specified_cursor_type (XCDR (tem
), &width
);
24946 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24949 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24953 #ifdef HAVE_WINDOW_SYSTEM
24955 /* Return the cursor we want to be displayed in window W. Return
24956 width of bar/hbar cursor through WIDTH arg. Return with
24957 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24958 (i.e. if the `system caret' should track this cursor).
24960 In a mini-buffer window, we want the cursor only to appear if we
24961 are reading input from this window. For the selected window, we
24962 want the cursor type given by the frame parameter or buffer local
24963 setting of cursor-type. If explicitly marked off, draw no cursor.
24964 In all other cases, we want a hollow box cursor. */
24966 static enum text_cursor_kinds
24967 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24968 int *active_cursor
)
24970 struct frame
*f
= XFRAME (w
->frame
);
24971 struct buffer
*b
= XBUFFER (w
->buffer
);
24972 int cursor_type
= DEFAULT_CURSOR
;
24973 Lisp_Object alt_cursor
;
24974 int non_selected
= 0;
24976 *active_cursor
= 1;
24979 if (cursor_in_echo_area
24980 && FRAME_HAS_MINIBUF_P (f
)
24981 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24983 if (w
== XWINDOW (echo_area_window
))
24985 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24987 *width
= FRAME_CURSOR_WIDTH (f
);
24988 return FRAME_DESIRED_CURSOR (f
);
24991 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24994 *active_cursor
= 0;
24998 /* Detect a nonselected window or nonselected frame. */
24999 else if (w
!= XWINDOW (f
->selected_window
)
25000 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25002 *active_cursor
= 0;
25004 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25010 /* Never display a cursor in a window in which cursor-type is nil. */
25011 if (NILP (BVAR (b
, cursor_type
)))
25014 /* Get the normal cursor type for this window. */
25015 if (EQ (BVAR (b
, cursor_type
), Qt
))
25017 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25018 *width
= FRAME_CURSOR_WIDTH (f
);
25021 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25023 /* Use cursor-in-non-selected-windows instead
25024 for non-selected window or frame. */
25027 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25028 if (!EQ (Qt
, alt_cursor
))
25029 return get_specified_cursor_type (alt_cursor
, width
);
25030 /* t means modify the normal cursor type. */
25031 if (cursor_type
== FILLED_BOX_CURSOR
)
25032 cursor_type
= HOLLOW_BOX_CURSOR
;
25033 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25035 return cursor_type
;
25038 /* Use normal cursor if not blinked off. */
25039 if (!w
->cursor_off_p
)
25041 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25043 if (cursor_type
== FILLED_BOX_CURSOR
)
25045 /* Using a block cursor on large images can be very annoying.
25046 So use a hollow cursor for "large" images.
25047 If image is not transparent (no mask), also use hollow cursor. */
25048 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25049 if (img
!= NULL
&& IMAGEP (img
->spec
))
25051 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25052 where N = size of default frame font size.
25053 This should cover most of the "tiny" icons people may use. */
25055 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25056 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25057 cursor_type
= HOLLOW_BOX_CURSOR
;
25060 else if (cursor_type
!= NO_CURSOR
)
25062 /* Display current only supports BOX and HOLLOW cursors for images.
25063 So for now, unconditionally use a HOLLOW cursor when cursor is
25064 not a solid box cursor. */
25065 cursor_type
= HOLLOW_BOX_CURSOR
;
25068 return cursor_type
;
25071 /* Cursor is blinked off, so determine how to "toggle" it. */
25073 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25074 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25075 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25077 /* Then see if frame has specified a specific blink off cursor type. */
25078 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25080 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25081 return FRAME_BLINK_OFF_CURSOR (f
);
25085 /* Some people liked having a permanently visible blinking cursor,
25086 while others had very strong opinions against it. So it was
25087 decided to remove it. KFS 2003-09-03 */
25089 /* Finally perform built-in cursor blinking:
25090 filled box <-> hollow box
25091 wide [h]bar <-> narrow [h]bar
25092 narrow [h]bar <-> no cursor
25093 other type <-> no cursor */
25095 if (cursor_type
== FILLED_BOX_CURSOR
)
25096 return HOLLOW_BOX_CURSOR
;
25098 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25101 return cursor_type
;
25109 /* Notice when the text cursor of window W has been completely
25110 overwritten by a drawing operation that outputs glyphs in AREA
25111 starting at X0 and ending at X1 in the line starting at Y0 and
25112 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25113 the rest of the line after X0 has been written. Y coordinates
25114 are window-relative. */
25117 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25118 int x0
, int x1
, int y0
, int y1
)
25120 int cx0
, cx1
, cy0
, cy1
;
25121 struct glyph_row
*row
;
25123 if (!w
->phys_cursor_on_p
)
25125 if (area
!= TEXT_AREA
)
25128 if (w
->phys_cursor
.vpos
< 0
25129 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25130 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25131 !(row
->enabled_p
&& row
->displays_text_p
)))
25134 if (row
->cursor_in_fringe_p
)
25136 row
->cursor_in_fringe_p
= 0;
25137 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25138 w
->phys_cursor_on_p
= 0;
25142 cx0
= w
->phys_cursor
.x
;
25143 cx1
= cx0
+ w
->phys_cursor_width
;
25144 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25147 /* The cursor image will be completely removed from the
25148 screen if the output area intersects the cursor area in
25149 y-direction. When we draw in [y0 y1[, and some part of
25150 the cursor is at y < y0, that part must have been drawn
25151 before. When scrolling, the cursor is erased before
25152 actually scrolling, so we don't come here. When not
25153 scrolling, the rows above the old cursor row must have
25154 changed, and in this case these rows must have written
25155 over the cursor image.
25157 Likewise if part of the cursor is below y1, with the
25158 exception of the cursor being in the first blank row at
25159 the buffer and window end because update_text_area
25160 doesn't draw that row. (Except when it does, but
25161 that's handled in update_text_area.) */
25163 cy0
= w
->phys_cursor
.y
;
25164 cy1
= cy0
+ w
->phys_cursor_height
;
25165 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25168 w
->phys_cursor_on_p
= 0;
25171 #endif /* HAVE_WINDOW_SYSTEM */
25174 /************************************************************************
25176 ************************************************************************/
25178 #ifdef HAVE_WINDOW_SYSTEM
25181 Fix the display of area AREA of overlapping row ROW in window W
25182 with respect to the overlapping part OVERLAPS. */
25185 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25186 enum glyph_row_area area
, int overlaps
)
25193 for (i
= 0; i
< row
->used
[area
];)
25195 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25197 int start
= i
, start_x
= x
;
25201 x
+= row
->glyphs
[area
][i
].pixel_width
;
25204 while (i
< row
->used
[area
]
25205 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25207 draw_glyphs (w
, start_x
, row
, area
,
25209 DRAW_NORMAL_TEXT
, overlaps
);
25213 x
+= row
->glyphs
[area
][i
].pixel_width
;
25223 Draw the cursor glyph of window W in glyph row ROW. See the
25224 comment of draw_glyphs for the meaning of HL. */
25227 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25228 enum draw_glyphs_face hl
)
25230 /* If cursor hpos is out of bounds, don't draw garbage. This can
25231 happen in mini-buffer windows when switching between echo area
25232 glyphs and mini-buffer. */
25233 if ((row
->reversed_p
25234 ? (w
->phys_cursor
.hpos
>= 0)
25235 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25237 int on_p
= w
->phys_cursor_on_p
;
25239 int hpos
= w
->phys_cursor
.hpos
;
25241 /* When the window is hscrolled, cursor hpos can legitimately be
25242 out of bounds, but we draw the cursor at the corresponding
25243 window margin in that case. */
25244 if (!row
->reversed_p
&& hpos
< 0)
25246 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25247 hpos
= row
->used
[TEXT_AREA
] - 1;
25249 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25251 w
->phys_cursor_on_p
= on_p
;
25253 if (hl
== DRAW_CURSOR
)
25254 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25255 /* When we erase the cursor, and ROW is overlapped by other
25256 rows, make sure that these overlapping parts of other rows
25258 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25260 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25262 if (row
> w
->current_matrix
->rows
25263 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25264 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25265 OVERLAPS_ERASED_CURSOR
);
25267 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25268 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25269 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25270 OVERLAPS_ERASED_CURSOR
);
25277 Erase the image of a cursor of window W from the screen. */
25280 erase_phys_cursor (struct window
*w
)
25282 struct frame
*f
= XFRAME (w
->frame
);
25283 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25284 int hpos
= w
->phys_cursor
.hpos
;
25285 int vpos
= w
->phys_cursor
.vpos
;
25286 int mouse_face_here_p
= 0;
25287 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25288 struct glyph_row
*cursor_row
;
25289 struct glyph
*cursor_glyph
;
25290 enum draw_glyphs_face hl
;
25292 /* No cursor displayed or row invalidated => nothing to do on the
25294 if (w
->phys_cursor_type
== NO_CURSOR
)
25295 goto mark_cursor_off
;
25297 /* VPOS >= active_glyphs->nrows means that window has been resized.
25298 Don't bother to erase the cursor. */
25299 if (vpos
>= active_glyphs
->nrows
)
25300 goto mark_cursor_off
;
25302 /* If row containing cursor is marked invalid, there is nothing we
25304 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25305 if (!cursor_row
->enabled_p
)
25306 goto mark_cursor_off
;
25308 /* If line spacing is > 0, old cursor may only be partially visible in
25309 window after split-window. So adjust visible height. */
25310 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25311 window_text_bottom_y (w
) - cursor_row
->y
);
25313 /* If row is completely invisible, don't attempt to delete a cursor which
25314 isn't there. This can happen if cursor is at top of a window, and
25315 we switch to a buffer with a header line in that window. */
25316 if (cursor_row
->visible_height
<= 0)
25317 goto mark_cursor_off
;
25319 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25320 if (cursor_row
->cursor_in_fringe_p
)
25322 cursor_row
->cursor_in_fringe_p
= 0;
25323 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25324 goto mark_cursor_off
;
25327 /* This can happen when the new row is shorter than the old one.
25328 In this case, either draw_glyphs or clear_end_of_line
25329 should have cleared the cursor. Note that we wouldn't be
25330 able to erase the cursor in this case because we don't have a
25331 cursor glyph at hand. */
25332 if ((cursor_row
->reversed_p
25333 ? (w
->phys_cursor
.hpos
< 0)
25334 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25335 goto mark_cursor_off
;
25337 /* When the window is hscrolled, cursor hpos can legitimately be out
25338 of bounds, but we draw the cursor at the corresponding window
25339 margin in that case. */
25340 if (!cursor_row
->reversed_p
&& hpos
< 0)
25342 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25343 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25345 /* If the cursor is in the mouse face area, redisplay that when
25346 we clear the cursor. */
25347 if (! NILP (hlinfo
->mouse_face_window
)
25348 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25349 /* Don't redraw the cursor's spot in mouse face if it is at the
25350 end of a line (on a newline). The cursor appears there, but
25351 mouse highlighting does not. */
25352 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25353 mouse_face_here_p
= 1;
25355 /* Maybe clear the display under the cursor. */
25356 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25359 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25362 cursor_glyph
= get_phys_cursor_glyph (w
);
25363 if (cursor_glyph
== NULL
)
25364 goto mark_cursor_off
;
25366 width
= cursor_glyph
->pixel_width
;
25367 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25368 x
= w
->phys_cursor
.x
;
25370 width
-= left_x
- x
;
25371 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25372 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25373 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25376 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25379 /* Erase the cursor by redrawing the character underneath it. */
25380 if (mouse_face_here_p
)
25381 hl
= DRAW_MOUSE_FACE
;
25383 hl
= DRAW_NORMAL_TEXT
;
25384 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25387 w
->phys_cursor_on_p
= 0;
25388 w
->phys_cursor_type
= NO_CURSOR
;
25393 Display or clear cursor of window W. If ON is zero, clear the
25394 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25395 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25398 display_and_set_cursor (struct window
*w
, int on
,
25399 int hpos
, int vpos
, int x
, int y
)
25401 struct frame
*f
= XFRAME (w
->frame
);
25402 int new_cursor_type
;
25403 int new_cursor_width
;
25405 struct glyph_row
*glyph_row
;
25406 struct glyph
*glyph
;
25408 /* This is pointless on invisible frames, and dangerous on garbaged
25409 windows and frames; in the latter case, the frame or window may
25410 be in the midst of changing its size, and x and y may be off the
25412 if (! FRAME_VISIBLE_P (f
)
25413 || FRAME_GARBAGED_P (f
)
25414 || vpos
>= w
->current_matrix
->nrows
25415 || hpos
>= w
->current_matrix
->matrix_w
)
25418 /* If cursor is off and we want it off, return quickly. */
25419 if (!on
&& !w
->phys_cursor_on_p
)
25422 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25423 /* If cursor row is not enabled, we don't really know where to
25424 display the cursor. */
25425 if (!glyph_row
->enabled_p
)
25427 w
->phys_cursor_on_p
= 0;
25432 if (!glyph_row
->exact_window_width_line_p
25433 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25434 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25436 xassert (interrupt_input_blocked
);
25438 /* Set new_cursor_type to the cursor we want to be displayed. */
25439 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25440 &new_cursor_width
, &active_cursor
);
25442 /* If cursor is currently being shown and we don't want it to be or
25443 it is in the wrong place, or the cursor type is not what we want,
25445 if (w
->phys_cursor_on_p
25447 || w
->phys_cursor
.x
!= x
25448 || w
->phys_cursor
.y
!= y
25449 || new_cursor_type
!= w
->phys_cursor_type
25450 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25451 && new_cursor_width
!= w
->phys_cursor_width
)))
25452 erase_phys_cursor (w
);
25454 /* Don't check phys_cursor_on_p here because that flag is only set
25455 to zero in some cases where we know that the cursor has been
25456 completely erased, to avoid the extra work of erasing the cursor
25457 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25458 still not be visible, or it has only been partly erased. */
25461 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25462 w
->phys_cursor_height
= glyph_row
->height
;
25464 /* Set phys_cursor_.* before x_draw_.* is called because some
25465 of them may need the information. */
25466 w
->phys_cursor
.x
= x
;
25467 w
->phys_cursor
.y
= glyph_row
->y
;
25468 w
->phys_cursor
.hpos
= hpos
;
25469 w
->phys_cursor
.vpos
= vpos
;
25472 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25473 new_cursor_type
, new_cursor_width
,
25474 on
, active_cursor
);
25478 /* Switch the display of W's cursor on or off, according to the value
25482 update_window_cursor (struct window
*w
, int on
)
25484 /* Don't update cursor in windows whose frame is in the process
25485 of being deleted. */
25486 if (w
->current_matrix
)
25488 int hpos
= w
->phys_cursor
.hpos
;
25489 int vpos
= w
->phys_cursor
.vpos
;
25490 struct glyph_row
*row
;
25492 if (vpos
>= w
->current_matrix
->nrows
25493 || hpos
>= w
->current_matrix
->matrix_w
)
25496 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25498 /* When the window is hscrolled, cursor hpos can legitimately be
25499 out of bounds, but we draw the cursor at the corresponding
25500 window margin in that case. */
25501 if (!row
->reversed_p
&& hpos
< 0)
25503 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25504 hpos
= row
->used
[TEXT_AREA
] - 1;
25507 display_and_set_cursor (w
, on
, hpos
, vpos
,
25508 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25514 /* Call update_window_cursor with parameter ON_P on all leaf windows
25515 in the window tree rooted at W. */
25518 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25522 if (!NILP (w
->hchild
))
25523 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25524 else if (!NILP (w
->vchild
))
25525 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25527 update_window_cursor (w
, on_p
);
25529 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25535 Display the cursor on window W, or clear it, according to ON_P.
25536 Don't change the cursor's position. */
25539 x_update_cursor (struct frame
*f
, int on_p
)
25541 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25546 Clear the cursor of window W to background color, and mark the
25547 cursor as not shown. This is used when the text where the cursor
25548 is about to be rewritten. */
25551 x_clear_cursor (struct window
*w
)
25553 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25554 update_window_cursor (w
, 0);
25557 #endif /* HAVE_WINDOW_SYSTEM */
25559 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25562 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25563 int start_hpos
, int end_hpos
,
25564 enum draw_glyphs_face draw
)
25566 #ifdef HAVE_WINDOW_SYSTEM
25567 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25569 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25573 #if defined (HAVE_GPM) || defined (MSDOS)
25574 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25578 /* Display the active region described by mouse_face_* according to DRAW. */
25581 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25583 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25584 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25586 if (/* If window is in the process of being destroyed, don't bother
25588 w
->current_matrix
!= NULL
25589 /* Don't update mouse highlight if hidden */
25590 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25591 /* Recognize when we are called to operate on rows that don't exist
25592 anymore. This can happen when a window is split. */
25593 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25595 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25596 struct glyph_row
*row
, *first
, *last
;
25598 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25599 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25601 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25603 int start_hpos
, end_hpos
, start_x
;
25605 /* For all but the first row, the highlight starts at column 0. */
25608 /* R2L rows have BEG and END in reversed order, but the
25609 screen drawing geometry is always left to right. So
25610 we need to mirror the beginning and end of the
25611 highlighted area in R2L rows. */
25612 if (!row
->reversed_p
)
25614 start_hpos
= hlinfo
->mouse_face_beg_col
;
25615 start_x
= hlinfo
->mouse_face_beg_x
;
25617 else if (row
== last
)
25619 start_hpos
= hlinfo
->mouse_face_end_col
;
25620 start_x
= hlinfo
->mouse_face_end_x
;
25628 else if (row
->reversed_p
&& row
== last
)
25630 start_hpos
= hlinfo
->mouse_face_end_col
;
25631 start_x
= hlinfo
->mouse_face_end_x
;
25641 if (!row
->reversed_p
)
25642 end_hpos
= hlinfo
->mouse_face_end_col
;
25643 else if (row
== first
)
25644 end_hpos
= hlinfo
->mouse_face_beg_col
;
25647 end_hpos
= row
->used
[TEXT_AREA
];
25648 if (draw
== DRAW_NORMAL_TEXT
)
25649 row
->fill_line_p
= 1; /* Clear to end of line */
25652 else if (row
->reversed_p
&& row
== first
)
25653 end_hpos
= hlinfo
->mouse_face_beg_col
;
25656 end_hpos
= row
->used
[TEXT_AREA
];
25657 if (draw
== DRAW_NORMAL_TEXT
)
25658 row
->fill_line_p
= 1; /* Clear to end of line */
25661 if (end_hpos
> start_hpos
)
25663 draw_row_with_mouse_face (w
, start_x
, row
,
25664 start_hpos
, end_hpos
, draw
);
25667 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25671 #ifdef HAVE_WINDOW_SYSTEM
25672 /* When we've written over the cursor, arrange for it to
25673 be displayed again. */
25674 if (FRAME_WINDOW_P (f
)
25675 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25677 int hpos
= w
->phys_cursor
.hpos
;
25679 /* When the window is hscrolled, cursor hpos can legitimately be
25680 out of bounds, but we draw the cursor at the corresponding
25681 window margin in that case. */
25682 if (!row
->reversed_p
&& hpos
< 0)
25684 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25685 hpos
= row
->used
[TEXT_AREA
] - 1;
25688 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
25689 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25692 #endif /* HAVE_WINDOW_SYSTEM */
25695 #ifdef HAVE_WINDOW_SYSTEM
25696 /* Change the mouse cursor. */
25697 if (FRAME_WINDOW_P (f
))
25699 if (draw
== DRAW_NORMAL_TEXT
25700 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25701 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25702 else if (draw
== DRAW_MOUSE_FACE
)
25703 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25705 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25707 #endif /* HAVE_WINDOW_SYSTEM */
25711 Clear out the mouse-highlighted active region.
25712 Redraw it un-highlighted first. Value is non-zero if mouse
25713 face was actually drawn unhighlighted. */
25716 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25720 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25722 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25726 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25727 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25728 hlinfo
->mouse_face_window
= Qnil
;
25729 hlinfo
->mouse_face_overlay
= Qnil
;
25733 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25734 within the mouse face on that window. */
25736 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25738 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25740 /* Quickly resolve the easy cases. */
25741 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25742 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25744 if (vpos
< hlinfo
->mouse_face_beg_row
25745 || vpos
> hlinfo
->mouse_face_end_row
)
25747 if (vpos
> hlinfo
->mouse_face_beg_row
25748 && vpos
< hlinfo
->mouse_face_end_row
)
25751 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25753 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25755 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25758 else if ((vpos
== hlinfo
->mouse_face_beg_row
25759 && hpos
>= hlinfo
->mouse_face_beg_col
)
25760 || (vpos
== hlinfo
->mouse_face_end_row
25761 && hpos
< hlinfo
->mouse_face_end_col
))
25766 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25768 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25771 else if ((vpos
== hlinfo
->mouse_face_beg_row
25772 && hpos
<= hlinfo
->mouse_face_beg_col
)
25773 || (vpos
== hlinfo
->mouse_face_end_row
25774 && hpos
> hlinfo
->mouse_face_end_col
))
25782 Non-zero if physical cursor of window W is within mouse face. */
25785 cursor_in_mouse_face_p (struct window
*w
)
25787 int hpos
= w
->phys_cursor
.hpos
;
25788 int vpos
= w
->phys_cursor
.vpos
;
25789 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25791 /* When the window is hscrolled, cursor hpos can legitimately be out
25792 of bounds, but we draw the cursor at the corresponding window
25793 margin in that case. */
25794 if (!row
->reversed_p
&& hpos
< 0)
25796 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25797 hpos
= row
->used
[TEXT_AREA
] - 1;
25799 return coords_in_mouse_face_p (w
, hpos
, vpos
);
25804 /* Find the glyph rows START_ROW and END_ROW of window W that display
25805 characters between buffer positions START_CHARPOS and END_CHARPOS
25806 (excluding END_CHARPOS). This is similar to row_containing_pos,
25807 but is more accurate when bidi reordering makes buffer positions
25808 change non-linearly with glyph rows. */
25810 rows_from_pos_range (struct window
*w
,
25811 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25812 struct glyph_row
**start
, struct glyph_row
**end
)
25814 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25815 int last_y
= window_text_bottom_y (w
);
25816 struct glyph_row
*row
;
25821 while (!first
->enabled_p
25822 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25825 /* Find the START row. */
25827 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25830 /* A row can potentially be the START row if the range of the
25831 characters it displays intersects the range
25832 [START_CHARPOS..END_CHARPOS). */
25833 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25834 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25835 /* See the commentary in row_containing_pos, for the
25836 explanation of the complicated way to check whether
25837 some position is beyond the end of the characters
25838 displayed by a row. */
25839 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25840 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25841 && !row
->ends_at_zv_p
25842 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25843 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25844 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25845 && !row
->ends_at_zv_p
25846 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25848 /* Found a candidate row. Now make sure at least one of the
25849 glyphs it displays has a charpos from the range
25850 [START_CHARPOS..END_CHARPOS).
25852 This is not obvious because bidi reordering could make
25853 buffer positions of a row be 1,2,3,102,101,100, and if we
25854 want to highlight characters in [50..60), we don't want
25855 this row, even though [50..60) does intersect [1..103),
25856 the range of character positions given by the row's start
25857 and end positions. */
25858 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25859 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25863 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25864 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25873 /* Find the END row. */
25875 /* If the last row is partially visible, start looking for END
25876 from that row, instead of starting from FIRST. */
25877 && !(row
->enabled_p
25878 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25880 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25882 struct glyph_row
*next
= row
+ 1;
25884 if (!next
->enabled_p
25885 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25886 /* The first row >= START whose range of displayed characters
25887 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25888 is the row END + 1. */
25889 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25890 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25891 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25892 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25893 && !next
->ends_at_zv_p
25894 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25895 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25896 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25897 && !next
->ends_at_zv_p
25898 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25905 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25906 but none of the characters it displays are in the range, it is
25908 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25909 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25913 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25914 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25927 /* This function sets the mouse_face_* elements of HLINFO, assuming
25928 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25929 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25930 for the overlay or run of text properties specifying the mouse
25931 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25932 before-string and after-string that must also be highlighted.
25933 DISP_STRING, if non-nil, is a display string that may cover some
25934 or all of the highlighted text. */
25937 mouse_face_from_buffer_pos (Lisp_Object window
,
25938 Mouse_HLInfo
*hlinfo
,
25939 EMACS_INT mouse_charpos
,
25940 EMACS_INT start_charpos
,
25941 EMACS_INT end_charpos
,
25942 Lisp_Object before_string
,
25943 Lisp_Object after_string
,
25944 Lisp_Object disp_string
)
25946 struct window
*w
= XWINDOW (window
);
25947 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25948 struct glyph_row
*r1
, *r2
;
25949 struct glyph
*glyph
, *end
;
25950 EMACS_INT ignore
, pos
;
25953 xassert (NILP (disp_string
) || STRINGP (disp_string
));
25954 xassert (NILP (before_string
) || STRINGP (before_string
));
25955 xassert (NILP (after_string
) || STRINGP (after_string
));
25957 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25958 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25960 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25961 /* If the before-string or display-string contains newlines,
25962 rows_from_pos_range skips to its last row. Move back. */
25963 if (!NILP (before_string
) || !NILP (disp_string
))
25965 struct glyph_row
*prev
;
25966 while ((prev
= r1
- 1, prev
>= first
)
25967 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25968 && prev
->used
[TEXT_AREA
] > 0)
25970 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25971 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25972 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25974 || !(EQ (glyph
->object
, before_string
)
25975 || EQ (glyph
->object
, disp_string
)))
25982 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25983 hlinfo
->mouse_face_past_end
= 1;
25985 else if (!NILP (after_string
))
25987 /* If the after-string has newlines, advance to its last row. */
25988 struct glyph_row
*next
;
25989 struct glyph_row
*last
25990 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25992 for (next
= r2
+ 1;
25994 && next
->used
[TEXT_AREA
] > 0
25995 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25999 /* The rest of the display engine assumes that mouse_face_beg_row is
26000 either above mouse_face_end_row or identical to it. But with
26001 bidi-reordered continued lines, the row for START_CHARPOS could
26002 be below the row for END_CHARPOS. If so, swap the rows and store
26003 them in correct order. */
26006 struct glyph_row
*tem
= r2
;
26012 hlinfo
->mouse_face_beg_y
= r1
->y
;
26013 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26014 hlinfo
->mouse_face_end_y
= r2
->y
;
26015 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26017 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26018 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26019 could be anywhere in the row and in any order. The strategy
26020 below is to find the leftmost and the rightmost glyph that
26021 belongs to either of these 3 strings, or whose position is
26022 between START_CHARPOS and END_CHARPOS, and highlight all the
26023 glyphs between those two. This may cover more than just the text
26024 between START_CHARPOS and END_CHARPOS if the range of characters
26025 strides the bidi level boundary, e.g. if the beginning is in R2L
26026 text while the end is in L2R text or vice versa. */
26027 if (!r1
->reversed_p
)
26029 /* This row is in a left to right paragraph. Scan it left to
26031 glyph
= r1
->glyphs
[TEXT_AREA
];
26032 end
= glyph
+ r1
->used
[TEXT_AREA
];
26035 /* Skip truncation glyphs at the start of the glyph row. */
26036 if (r1
->displays_text_p
)
26038 && INTEGERP (glyph
->object
)
26039 && glyph
->charpos
< 0;
26041 x
+= glyph
->pixel_width
;
26043 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26044 or DISP_STRING, and the first glyph from buffer whose
26045 position is between START_CHARPOS and END_CHARPOS. */
26047 && !INTEGERP (glyph
->object
)
26048 && !EQ (glyph
->object
, disp_string
)
26049 && !(BUFFERP (glyph
->object
)
26050 && (glyph
->charpos
>= start_charpos
26051 && glyph
->charpos
< end_charpos
));
26054 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26055 are present at buffer positions between START_CHARPOS and
26056 END_CHARPOS, or if they come from an overlay. */
26057 if (EQ (glyph
->object
, before_string
))
26059 pos
= string_buffer_position (before_string
,
26061 /* If pos == 0, it means before_string came from an
26062 overlay, not from a buffer position. */
26063 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26066 else if (EQ (glyph
->object
, after_string
))
26068 pos
= string_buffer_position (after_string
, end_charpos
);
26069 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26072 x
+= glyph
->pixel_width
;
26074 hlinfo
->mouse_face_beg_x
= x
;
26075 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26079 /* This row is in a right to left paragraph. Scan it right to
26083 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26084 glyph
= end
+ r1
->used
[TEXT_AREA
];
26086 /* Skip truncation glyphs at the start of the glyph row. */
26087 if (r1
->displays_text_p
)
26089 && INTEGERP (glyph
->object
)
26090 && glyph
->charpos
< 0;
26094 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26095 or DISP_STRING, and the first glyph from buffer whose
26096 position is between START_CHARPOS and END_CHARPOS. */
26098 && !INTEGERP (glyph
->object
)
26099 && !EQ (glyph
->object
, disp_string
)
26100 && !(BUFFERP (glyph
->object
)
26101 && (glyph
->charpos
>= start_charpos
26102 && glyph
->charpos
< end_charpos
));
26105 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26106 are present at buffer positions between START_CHARPOS and
26107 END_CHARPOS, or if they come from an overlay. */
26108 if (EQ (glyph
->object
, before_string
))
26110 pos
= string_buffer_position (before_string
, start_charpos
);
26111 /* If pos == 0, it means before_string came from an
26112 overlay, not from a buffer position. */
26113 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26116 else if (EQ (glyph
->object
, after_string
))
26118 pos
= string_buffer_position (after_string
, end_charpos
);
26119 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26124 glyph
++; /* first glyph to the right of the highlighted area */
26125 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26126 x
+= g
->pixel_width
;
26127 hlinfo
->mouse_face_beg_x
= x
;
26128 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26131 /* If the highlight ends in a different row, compute GLYPH and END
26132 for the end row. Otherwise, reuse the values computed above for
26133 the row where the highlight begins. */
26136 if (!r2
->reversed_p
)
26138 glyph
= r2
->glyphs
[TEXT_AREA
];
26139 end
= glyph
+ r2
->used
[TEXT_AREA
];
26144 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26145 glyph
= end
+ r2
->used
[TEXT_AREA
];
26149 if (!r2
->reversed_p
)
26151 /* Skip truncation and continuation glyphs near the end of the
26152 row, and also blanks and stretch glyphs inserted by
26153 extend_face_to_end_of_line. */
26155 && INTEGERP ((end
- 1)->object
))
26157 /* Scan the rest of the glyph row from the end, looking for the
26158 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26159 DISP_STRING, or whose position is between START_CHARPOS
26163 && !INTEGERP (end
->object
)
26164 && !EQ (end
->object
, disp_string
)
26165 && !(BUFFERP (end
->object
)
26166 && (end
->charpos
>= start_charpos
26167 && end
->charpos
< end_charpos
));
26170 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26171 are present at buffer positions between START_CHARPOS and
26172 END_CHARPOS, or if they come from an overlay. */
26173 if (EQ (end
->object
, before_string
))
26175 pos
= string_buffer_position (before_string
, start_charpos
);
26176 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26179 else if (EQ (end
->object
, after_string
))
26181 pos
= string_buffer_position (after_string
, end_charpos
);
26182 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26186 /* Find the X coordinate of the last glyph to be highlighted. */
26187 for (; glyph
<= end
; ++glyph
)
26188 x
+= glyph
->pixel_width
;
26190 hlinfo
->mouse_face_end_x
= x
;
26191 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26195 /* Skip truncation and continuation glyphs near the end of the
26196 row, and also blanks and stretch glyphs inserted by
26197 extend_face_to_end_of_line. */
26201 && INTEGERP (end
->object
))
26203 x
+= end
->pixel_width
;
26206 /* Scan the rest of the glyph row from the end, looking for the
26207 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26208 DISP_STRING, or whose position is between START_CHARPOS
26212 && !INTEGERP (end
->object
)
26213 && !EQ (end
->object
, disp_string
)
26214 && !(BUFFERP (end
->object
)
26215 && (end
->charpos
>= start_charpos
26216 && end
->charpos
< end_charpos
));
26219 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26220 are present at buffer positions between START_CHARPOS and
26221 END_CHARPOS, or if they come from an overlay. */
26222 if (EQ (end
->object
, before_string
))
26224 pos
= string_buffer_position (before_string
, start_charpos
);
26225 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26228 else if (EQ (end
->object
, after_string
))
26230 pos
= string_buffer_position (after_string
, end_charpos
);
26231 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26234 x
+= end
->pixel_width
;
26236 hlinfo
->mouse_face_end_x
= x
;
26237 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26240 hlinfo
->mouse_face_window
= window
;
26241 hlinfo
->mouse_face_face_id
26242 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26244 !hlinfo
->mouse_face_hidden
, -1);
26245 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26248 /* The following function is not used anymore (replaced with
26249 mouse_face_from_string_pos), but I leave it here for the time
26250 being, in case someone would. */
26252 #if 0 /* not used */
26254 /* Find the position of the glyph for position POS in OBJECT in
26255 window W's current matrix, and return in *X, *Y the pixel
26256 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26258 RIGHT_P non-zero means return the position of the right edge of the
26259 glyph, RIGHT_P zero means return the left edge position.
26261 If no glyph for POS exists in the matrix, return the position of
26262 the glyph with the next smaller position that is in the matrix, if
26263 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26264 exists in the matrix, return the position of the glyph with the
26265 next larger position in OBJECT.
26267 Value is non-zero if a glyph was found. */
26270 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26271 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26273 int yb
= window_text_bottom_y (w
);
26274 struct glyph_row
*r
;
26275 struct glyph
*best_glyph
= NULL
;
26276 struct glyph_row
*best_row
= NULL
;
26279 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26280 r
->enabled_p
&& r
->y
< yb
;
26283 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26284 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26287 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26288 if (EQ (g
->object
, object
))
26290 if (g
->charpos
== pos
)
26297 else if (best_glyph
== NULL
26298 || ((eabs (g
->charpos
- pos
)
26299 < eabs (best_glyph
->charpos
- pos
))
26302 : g
->charpos
> pos
)))
26316 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26320 *x
+= best_glyph
->pixel_width
;
26325 *vpos
= best_row
- w
->current_matrix
->rows
;
26328 return best_glyph
!= NULL
;
26330 #endif /* not used */
26332 /* Find the positions of the first and the last glyphs in window W's
26333 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26334 (assumed to be a string), and return in HLINFO's mouse_face_*
26335 members the pixel and column/row coordinates of those glyphs. */
26338 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26339 Lisp_Object object
,
26340 EMACS_INT startpos
, EMACS_INT endpos
)
26342 int yb
= window_text_bottom_y (w
);
26343 struct glyph_row
*r
;
26344 struct glyph
*g
, *e
;
26348 /* Find the glyph row with at least one position in the range
26349 [STARTPOS..ENDPOS], and the first glyph in that row whose
26350 position belongs to that range. */
26351 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26352 r
->enabled_p
&& r
->y
< yb
;
26355 if (!r
->reversed_p
)
26357 g
= r
->glyphs
[TEXT_AREA
];
26358 e
= g
+ r
->used
[TEXT_AREA
];
26359 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26360 if (EQ (g
->object
, object
)
26361 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26363 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26364 hlinfo
->mouse_face_beg_y
= r
->y
;
26365 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26366 hlinfo
->mouse_face_beg_x
= gx
;
26375 e
= r
->glyphs
[TEXT_AREA
];
26376 g
= e
+ r
->used
[TEXT_AREA
];
26377 for ( ; g
> e
; --g
)
26378 if (EQ ((g
-1)->object
, object
)
26379 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26381 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26382 hlinfo
->mouse_face_beg_y
= r
->y
;
26383 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26384 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26385 gx
+= g1
->pixel_width
;
26386 hlinfo
->mouse_face_beg_x
= gx
;
26398 /* Starting with the next row, look for the first row which does NOT
26399 include any glyphs whose positions are in the range. */
26400 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26402 g
= r
->glyphs
[TEXT_AREA
];
26403 e
= g
+ r
->used
[TEXT_AREA
];
26405 for ( ; g
< e
; ++g
)
26406 if (EQ (g
->object
, object
)
26407 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26416 /* The highlighted region ends on the previous row. */
26419 /* Set the end row and its vertical pixel coordinate. */
26420 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26421 hlinfo
->mouse_face_end_y
= r
->y
;
26423 /* Compute and set the end column and the end column's horizontal
26424 pixel coordinate. */
26425 if (!r
->reversed_p
)
26427 g
= r
->glyphs
[TEXT_AREA
];
26428 e
= g
+ r
->used
[TEXT_AREA
];
26429 for ( ; e
> g
; --e
)
26430 if (EQ ((e
-1)->object
, object
)
26431 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26433 hlinfo
->mouse_face_end_col
= e
- g
;
26435 for (gx
= r
->x
; g
< e
; ++g
)
26436 gx
+= g
->pixel_width
;
26437 hlinfo
->mouse_face_end_x
= gx
;
26441 e
= r
->glyphs
[TEXT_AREA
];
26442 g
= e
+ r
->used
[TEXT_AREA
];
26443 for (gx
= r
->x
; e
< g
; ++e
)
26445 if (EQ (e
->object
, object
)
26446 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26448 gx
+= e
->pixel_width
;
26450 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26451 hlinfo
->mouse_face_end_x
= gx
;
26455 #ifdef HAVE_WINDOW_SYSTEM
26457 /* See if position X, Y is within a hot-spot of an image. */
26460 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26462 if (!CONSP (hot_spot
))
26465 if (EQ (XCAR (hot_spot
), Qrect
))
26467 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26468 Lisp_Object rect
= XCDR (hot_spot
);
26472 if (!CONSP (XCAR (rect
)))
26474 if (!CONSP (XCDR (rect
)))
26476 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26478 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26480 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26482 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26486 else if (EQ (XCAR (hot_spot
), Qcircle
))
26488 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26489 Lisp_Object circ
= XCDR (hot_spot
);
26490 Lisp_Object lr
, lx0
, ly0
;
26492 && CONSP (XCAR (circ
))
26493 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26494 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26495 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26497 double r
= XFLOATINT (lr
);
26498 double dx
= XINT (lx0
) - x
;
26499 double dy
= XINT (ly0
) - y
;
26500 return (dx
* dx
+ dy
* dy
<= r
* r
);
26503 else if (EQ (XCAR (hot_spot
), Qpoly
))
26505 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26506 if (VECTORP (XCDR (hot_spot
)))
26508 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26509 Lisp_Object
*poly
= v
->contents
;
26510 int n
= v
->header
.size
;
26513 Lisp_Object lx
, ly
;
26516 /* Need an even number of coordinates, and at least 3 edges. */
26517 if (n
< 6 || n
& 1)
26520 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26521 If count is odd, we are inside polygon. Pixels on edges
26522 may or may not be included depending on actual geometry of the
26524 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26525 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26527 x0
= XINT (lx
), y0
= XINT (ly
);
26528 for (i
= 0; i
< n
; i
+= 2)
26530 int x1
= x0
, y1
= y0
;
26531 if ((lx
= poly
[i
], !INTEGERP (lx
))
26532 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26534 x0
= XINT (lx
), y0
= XINT (ly
);
26536 /* Does this segment cross the X line? */
26544 if (y
> y0
&& y
> y1
)
26546 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26556 find_hot_spot (Lisp_Object map
, int x
, int y
)
26558 while (CONSP (map
))
26560 if (CONSP (XCAR (map
))
26561 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26569 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26571 doc
: /* Lookup in image map MAP coordinates X and Y.
26572 An image map is an alist where each element has the format (AREA ID PLIST).
26573 An AREA is specified as either a rectangle, a circle, or a polygon:
26574 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26575 pixel coordinates of the upper left and bottom right corners.
26576 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26577 and the radius of the circle; r may be a float or integer.
26578 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26579 vector describes one corner in the polygon.
26580 Returns the alist element for the first matching AREA in MAP. */)
26581 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26589 return find_hot_spot (map
, XINT (x
), XINT (y
));
26593 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26595 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26597 /* Do not change cursor shape while dragging mouse. */
26598 if (!NILP (do_mouse_tracking
))
26601 if (!NILP (pointer
))
26603 if (EQ (pointer
, Qarrow
))
26604 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26605 else if (EQ (pointer
, Qhand
))
26606 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26607 else if (EQ (pointer
, Qtext
))
26608 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26609 else if (EQ (pointer
, intern ("hdrag")))
26610 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26611 #ifdef HAVE_X_WINDOWS
26612 else if (EQ (pointer
, intern ("vdrag")))
26613 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26615 else if (EQ (pointer
, intern ("hourglass")))
26616 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26617 else if (EQ (pointer
, Qmodeline
))
26618 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26620 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26623 if (cursor
!= No_Cursor
)
26624 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26627 #endif /* HAVE_WINDOW_SYSTEM */
26629 /* Take proper action when mouse has moved to the mode or header line
26630 or marginal area AREA of window W, x-position X and y-position Y.
26631 X is relative to the start of the text display area of W, so the
26632 width of bitmap areas and scroll bars must be subtracted to get a
26633 position relative to the start of the mode line. */
26636 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26637 enum window_part area
)
26639 struct window
*w
= XWINDOW (window
);
26640 struct frame
*f
= XFRAME (w
->frame
);
26641 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26642 #ifdef HAVE_WINDOW_SYSTEM
26643 Display_Info
*dpyinfo
;
26645 Cursor cursor
= No_Cursor
;
26646 Lisp_Object pointer
= Qnil
;
26647 int dx
, dy
, width
, height
;
26649 Lisp_Object string
, object
= Qnil
;
26650 Lisp_Object pos
, help
;
26652 Lisp_Object mouse_face
;
26653 int original_x_pixel
= x
;
26654 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26655 struct glyph_row
*row
;
26657 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26662 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26663 returns them in row/column units! */
26664 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26665 &object
, &dx
, &dy
, &width
, &height
);
26667 row
= (area
== ON_MODE_LINE
26668 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26669 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26671 /* Find the glyph under the mouse pointer. */
26672 if (row
->mode_line_p
&& row
->enabled_p
)
26674 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26675 end
= glyph
+ row
->used
[TEXT_AREA
];
26677 for (x0
= original_x_pixel
;
26678 glyph
< end
&& x0
>= glyph
->pixel_width
;
26680 x0
-= glyph
->pixel_width
;
26688 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26689 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26690 returns them in row/column units! */
26691 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26692 &object
, &dx
, &dy
, &width
, &height
);
26697 #ifdef HAVE_WINDOW_SYSTEM
26698 if (IMAGEP (object
))
26700 Lisp_Object image_map
, hotspot
;
26701 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26703 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26705 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26709 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26710 If so, we could look for mouse-enter, mouse-leave
26711 properties in PLIST (and do something...). */
26712 hotspot
= XCDR (hotspot
);
26713 if (CONSP (hotspot
)
26714 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26716 pointer
= Fplist_get (plist
, Qpointer
);
26717 if (NILP (pointer
))
26719 help
= Fplist_get (plist
, Qhelp_echo
);
26722 help_echo_string
= help
;
26723 /* Is this correct? ++kfs */
26724 XSETWINDOW (help_echo_window
, w
);
26725 help_echo_object
= w
->buffer
;
26726 help_echo_pos
= charpos
;
26730 if (NILP (pointer
))
26731 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26733 #endif /* HAVE_WINDOW_SYSTEM */
26735 if (STRINGP (string
))
26737 pos
= make_number (charpos
);
26738 /* If we're on a string with `help-echo' text property, arrange
26739 for the help to be displayed. This is done by setting the
26740 global variable help_echo_string to the help string. */
26743 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26746 help_echo_string
= help
;
26747 XSETWINDOW (help_echo_window
, w
);
26748 help_echo_object
= string
;
26749 help_echo_pos
= charpos
;
26753 #ifdef HAVE_WINDOW_SYSTEM
26754 if (FRAME_WINDOW_P (f
))
26756 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26757 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26758 if (NILP (pointer
))
26759 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26761 /* Change the mouse pointer according to what is under X/Y. */
26763 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26766 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26767 if (!KEYMAPP (map
))
26768 map
= Fget_text_property (pos
, Qkeymap
, string
);
26769 if (!KEYMAPP (map
))
26770 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26775 /* Change the mouse face according to what is under X/Y. */
26776 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26777 if (!NILP (mouse_face
)
26778 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26783 struct glyph
* tmp_glyph
;
26787 int total_pixel_width
;
26788 EMACS_INT begpos
, endpos
, ignore
;
26792 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26793 Qmouse_face
, string
, Qnil
);
26799 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26801 endpos
= SCHARS (string
);
26805 /* Calculate the glyph position GPOS of GLYPH in the
26806 displayed string, relative to the beginning of the
26807 highlighted part of the string.
26809 Note: GPOS is different from CHARPOS. CHARPOS is the
26810 position of GLYPH in the internal string object. A mode
26811 line string format has structures which are converted to
26812 a flattened string by the Emacs Lisp interpreter. The
26813 internal string is an element of those structures. The
26814 displayed string is the flattened string. */
26815 tmp_glyph
= row_start_glyph
;
26816 while (tmp_glyph
< glyph
26817 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26818 && begpos
<= tmp_glyph
->charpos
26819 && tmp_glyph
->charpos
< endpos
)))
26821 gpos
= glyph
- tmp_glyph
;
26823 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26824 the highlighted part of the displayed string to which
26825 GLYPH belongs. Note: GSEQ_LENGTH is different from
26826 SCHARS (STRING), because the latter returns the length of
26827 the internal string. */
26828 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26830 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26831 && begpos
<= tmp_glyph
->charpos
26832 && tmp_glyph
->charpos
< endpos
));
26835 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26837 /* Calculate the total pixel width of all the glyphs between
26838 the beginning of the highlighted area and GLYPH. */
26839 total_pixel_width
= 0;
26840 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26841 total_pixel_width
+= tmp_glyph
->pixel_width
;
26843 /* Pre calculation of re-rendering position. Note: X is in
26844 column units here, after the call to mode_line_string or
26845 marginal_area_string. */
26847 vpos
= (area
== ON_MODE_LINE
26848 ? (w
->current_matrix
)->nrows
- 1
26851 /* If GLYPH's position is included in the region that is
26852 already drawn in mouse face, we have nothing to do. */
26853 if ( EQ (window
, hlinfo
->mouse_face_window
)
26854 && (!row
->reversed_p
26855 ? (hlinfo
->mouse_face_beg_col
<= hpos
26856 && hpos
< hlinfo
->mouse_face_end_col
)
26857 /* In R2L rows we swap BEG and END, see below. */
26858 : (hlinfo
->mouse_face_end_col
<= hpos
26859 && hpos
< hlinfo
->mouse_face_beg_col
))
26860 && hlinfo
->mouse_face_beg_row
== vpos
)
26863 if (clear_mouse_face (hlinfo
))
26864 cursor
= No_Cursor
;
26866 if (!row
->reversed_p
)
26868 hlinfo
->mouse_face_beg_col
= hpos
;
26869 hlinfo
->mouse_face_beg_x
= original_x_pixel
26870 - (total_pixel_width
+ dx
);
26871 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26872 hlinfo
->mouse_face_end_x
= 0;
26876 /* In R2L rows, show_mouse_face expects BEG and END
26877 coordinates to be swapped. */
26878 hlinfo
->mouse_face_end_col
= hpos
;
26879 hlinfo
->mouse_face_end_x
= original_x_pixel
26880 - (total_pixel_width
+ dx
);
26881 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26882 hlinfo
->mouse_face_beg_x
= 0;
26885 hlinfo
->mouse_face_beg_row
= vpos
;
26886 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26887 hlinfo
->mouse_face_beg_y
= 0;
26888 hlinfo
->mouse_face_end_y
= 0;
26889 hlinfo
->mouse_face_past_end
= 0;
26890 hlinfo
->mouse_face_window
= window
;
26892 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26898 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26900 if (NILP (pointer
))
26903 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26904 clear_mouse_face (hlinfo
);
26906 #ifdef HAVE_WINDOW_SYSTEM
26907 if (FRAME_WINDOW_P (f
))
26908 define_frame_cursor1 (f
, cursor
, pointer
);
26914 Take proper action when the mouse has moved to position X, Y on
26915 frame F as regards highlighting characters that have mouse-face
26916 properties. Also de-highlighting chars where the mouse was before.
26917 X and Y can be negative or out of range. */
26920 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26922 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26923 enum window_part part
= ON_NOTHING
;
26924 Lisp_Object window
;
26926 Cursor cursor
= No_Cursor
;
26927 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26930 /* When a menu is active, don't highlight because this looks odd. */
26931 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26932 if (popup_activated ())
26936 if (NILP (Vmouse_highlight
)
26937 || !f
->glyphs_initialized_p
26938 || f
->pointer_invisible
)
26941 hlinfo
->mouse_face_mouse_x
= x
;
26942 hlinfo
->mouse_face_mouse_y
= y
;
26943 hlinfo
->mouse_face_mouse_frame
= f
;
26945 if (hlinfo
->mouse_face_defer
)
26948 if (gc_in_progress
)
26950 hlinfo
->mouse_face_deferred_gc
= 1;
26954 /* Which window is that in? */
26955 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26957 /* If displaying active text in another window, clear that. */
26958 if (! EQ (window
, hlinfo
->mouse_face_window
)
26959 /* Also clear if we move out of text area in same window. */
26960 || (!NILP (hlinfo
->mouse_face_window
)
26963 && part
!= ON_MODE_LINE
26964 && part
!= ON_HEADER_LINE
))
26965 clear_mouse_face (hlinfo
);
26967 /* Not on a window -> return. */
26968 if (!WINDOWP (window
))
26971 /* Reset help_echo_string. It will get recomputed below. */
26972 help_echo_string
= Qnil
;
26974 /* Convert to window-relative pixel coordinates. */
26975 w
= XWINDOW (window
);
26976 frame_to_window_pixel_xy (w
, &x
, &y
);
26978 #ifdef HAVE_WINDOW_SYSTEM
26979 /* Handle tool-bar window differently since it doesn't display a
26981 if (EQ (window
, f
->tool_bar_window
))
26983 note_tool_bar_highlight (f
, x
, y
);
26988 /* Mouse is on the mode, header line or margin? */
26989 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26990 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26992 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26996 #ifdef HAVE_WINDOW_SYSTEM
26997 if (part
== ON_VERTICAL_BORDER
)
26999 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27000 help_echo_string
= build_string ("drag-mouse-1: resize");
27002 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27003 || part
== ON_SCROLL_BAR
)
27004 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27006 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27009 /* Are we in a window whose display is up to date?
27010 And verify the buffer's text has not changed. */
27011 b
= XBUFFER (w
->buffer
);
27012 if (part
== ON_TEXT
27013 && EQ (w
->window_end_valid
, w
->buffer
)
27014 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27015 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27017 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27019 struct glyph
*glyph
;
27020 Lisp_Object object
;
27021 Lisp_Object mouse_face
= Qnil
, position
;
27022 Lisp_Object
*overlay_vec
= NULL
;
27023 ptrdiff_t i
, noverlays
;
27024 struct buffer
*obuf
;
27025 EMACS_INT obegv
, ozv
;
27028 /* Find the glyph under X/Y. */
27029 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27031 #ifdef HAVE_WINDOW_SYSTEM
27032 /* Look for :pointer property on image. */
27033 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27035 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27036 if (img
!= NULL
&& IMAGEP (img
->spec
))
27038 Lisp_Object image_map
, hotspot
;
27039 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27041 && (hotspot
= find_hot_spot (image_map
,
27042 glyph
->slice
.img
.x
+ dx
,
27043 glyph
->slice
.img
.y
+ dy
),
27045 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27049 /* Could check XCAR (hotspot) to see if we enter/leave
27051 If so, we could look for mouse-enter, mouse-leave
27052 properties in PLIST (and do something...). */
27053 hotspot
= XCDR (hotspot
);
27054 if (CONSP (hotspot
)
27055 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27057 pointer
= Fplist_get (plist
, Qpointer
);
27058 if (NILP (pointer
))
27060 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27061 if (!NILP (help_echo_string
))
27063 help_echo_window
= window
;
27064 help_echo_object
= glyph
->object
;
27065 help_echo_pos
= glyph
->charpos
;
27069 if (NILP (pointer
))
27070 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27073 #endif /* HAVE_WINDOW_SYSTEM */
27075 /* Clear mouse face if X/Y not over text. */
27077 || area
!= TEXT_AREA
27078 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27079 /* Glyph's OBJECT is an integer for glyphs inserted by the
27080 display engine for its internal purposes, like truncation
27081 and continuation glyphs and blanks beyond the end of
27082 line's text on text terminals. If we are over such a
27083 glyph, we are not over any text. */
27084 || INTEGERP (glyph
->object
)
27085 /* R2L rows have a stretch glyph at their front, which
27086 stands for no text, whereas L2R rows have no glyphs at
27087 all beyond the end of text. Treat such stretch glyphs
27088 like we do with NULL glyphs in L2R rows. */
27089 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27090 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27091 && glyph
->type
== STRETCH_GLYPH
27092 && glyph
->avoid_cursor_p
))
27094 if (clear_mouse_face (hlinfo
))
27095 cursor
= No_Cursor
;
27096 #ifdef HAVE_WINDOW_SYSTEM
27097 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27099 if (area
!= TEXT_AREA
)
27100 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27102 pointer
= Vvoid_text_area_pointer
;
27108 pos
= glyph
->charpos
;
27109 object
= glyph
->object
;
27110 if (!STRINGP (object
) && !BUFFERP (object
))
27113 /* If we get an out-of-range value, return now; avoid an error. */
27114 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27117 /* Make the window's buffer temporarily current for
27118 overlays_at and compute_char_face. */
27119 obuf
= current_buffer
;
27120 current_buffer
= b
;
27126 /* Is this char mouse-active or does it have help-echo? */
27127 position
= make_number (pos
);
27129 if (BUFFERP (object
))
27131 /* Put all the overlays we want in a vector in overlay_vec. */
27132 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27133 /* Sort overlays into increasing priority order. */
27134 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27139 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27142 cursor
= No_Cursor
;
27144 /* Check mouse-face highlighting. */
27146 /* If there exists an overlay with mouse-face overlapping
27147 the one we are currently highlighting, we have to
27148 check if we enter the overlapping overlay, and then
27149 highlight only that. */
27150 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27151 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27153 /* Find the highest priority overlay with a mouse-face. */
27154 Lisp_Object overlay
= Qnil
;
27155 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27157 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27158 if (!NILP (mouse_face
))
27159 overlay
= overlay_vec
[i
];
27162 /* If we're highlighting the same overlay as before, there's
27163 no need to do that again. */
27164 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27165 goto check_help_echo
;
27166 hlinfo
->mouse_face_overlay
= overlay
;
27168 /* Clear the display of the old active region, if any. */
27169 if (clear_mouse_face (hlinfo
))
27170 cursor
= No_Cursor
;
27172 /* If no overlay applies, get a text property. */
27173 if (NILP (overlay
))
27174 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27176 /* Next, compute the bounds of the mouse highlighting and
27178 if (!NILP (mouse_face
) && STRINGP (object
))
27180 /* The mouse-highlighting comes from a display string
27181 with a mouse-face. */
27185 s
= Fprevious_single_property_change
27186 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27187 e
= Fnext_single_property_change
27188 (position
, Qmouse_face
, object
, Qnil
);
27190 s
= make_number (0);
27192 e
= make_number (SCHARS (object
) - 1);
27193 mouse_face_from_string_pos (w
, hlinfo
, object
,
27194 XINT (s
), XINT (e
));
27195 hlinfo
->mouse_face_past_end
= 0;
27196 hlinfo
->mouse_face_window
= window
;
27197 hlinfo
->mouse_face_face_id
27198 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27199 glyph
->face_id
, 1);
27200 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27201 cursor
= No_Cursor
;
27205 /* The mouse-highlighting, if any, comes from an overlay
27206 or text property in the buffer. */
27207 Lisp_Object buffer
IF_LINT (= Qnil
);
27208 Lisp_Object disp_string
IF_LINT (= Qnil
);
27210 if (STRINGP (object
))
27212 /* If we are on a display string with no mouse-face,
27213 check if the text under it has one. */
27214 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27215 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27216 pos
= string_buffer_position (object
, start
);
27219 mouse_face
= get_char_property_and_overlay
27220 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27221 buffer
= w
->buffer
;
27222 disp_string
= object
;
27228 disp_string
= Qnil
;
27231 if (!NILP (mouse_face
))
27233 Lisp_Object before
, after
;
27234 Lisp_Object before_string
, after_string
;
27235 /* To correctly find the limits of mouse highlight
27236 in a bidi-reordered buffer, we must not use the
27237 optimization of limiting the search in
27238 previous-single-property-change and
27239 next-single-property-change, because
27240 rows_from_pos_range needs the real start and end
27241 positions to DTRT in this case. That's because
27242 the first row visible in a window does not
27243 necessarily display the character whose position
27244 is the smallest. */
27246 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27247 ? Fmarker_position (w
->start
)
27250 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27251 ? make_number (BUF_Z (XBUFFER (buffer
))
27252 - XFASTINT (w
->window_end_pos
))
27255 if (NILP (overlay
))
27257 /* Handle the text property case. */
27258 before
= Fprevious_single_property_change
27259 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27260 after
= Fnext_single_property_change
27261 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27262 before_string
= after_string
= Qnil
;
27266 /* Handle the overlay case. */
27267 before
= Foverlay_start (overlay
);
27268 after
= Foverlay_end (overlay
);
27269 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27270 after_string
= Foverlay_get (overlay
, Qafter_string
);
27272 if (!STRINGP (before_string
)) before_string
= Qnil
;
27273 if (!STRINGP (after_string
)) after_string
= Qnil
;
27276 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27279 : XFASTINT (before
),
27281 ? BUF_Z (XBUFFER (buffer
))
27282 : XFASTINT (after
),
27283 before_string
, after_string
,
27285 cursor
= No_Cursor
;
27292 /* Look for a `help-echo' property. */
27293 if (NILP (help_echo_string
)) {
27294 Lisp_Object help
, overlay
;
27296 /* Check overlays first. */
27297 help
= overlay
= Qnil
;
27298 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27300 overlay
= overlay_vec
[i
];
27301 help
= Foverlay_get (overlay
, Qhelp_echo
);
27306 help_echo_string
= help
;
27307 help_echo_window
= window
;
27308 help_echo_object
= overlay
;
27309 help_echo_pos
= pos
;
27313 Lisp_Object obj
= glyph
->object
;
27314 EMACS_INT charpos
= glyph
->charpos
;
27316 /* Try text properties. */
27319 && charpos
< SCHARS (obj
))
27321 help
= Fget_text_property (make_number (charpos
),
27325 /* If the string itself doesn't specify a help-echo,
27326 see if the buffer text ``under'' it does. */
27327 struct glyph_row
*r
27328 = MATRIX_ROW (w
->current_matrix
, vpos
);
27329 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27330 EMACS_INT p
= string_buffer_position (obj
, start
);
27333 help
= Fget_char_property (make_number (p
),
27334 Qhelp_echo
, w
->buffer
);
27343 else if (BUFFERP (obj
)
27346 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27351 help_echo_string
= help
;
27352 help_echo_window
= window
;
27353 help_echo_object
= obj
;
27354 help_echo_pos
= charpos
;
27359 #ifdef HAVE_WINDOW_SYSTEM
27360 /* Look for a `pointer' property. */
27361 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27363 /* Check overlays first. */
27364 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27365 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27367 if (NILP (pointer
))
27369 Lisp_Object obj
= glyph
->object
;
27370 EMACS_INT charpos
= glyph
->charpos
;
27372 /* Try text properties. */
27375 && charpos
< SCHARS (obj
))
27377 pointer
= Fget_text_property (make_number (charpos
),
27379 if (NILP (pointer
))
27381 /* If the string itself doesn't specify a pointer,
27382 see if the buffer text ``under'' it does. */
27383 struct glyph_row
*r
27384 = MATRIX_ROW (w
->current_matrix
, vpos
);
27385 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27386 EMACS_INT p
= string_buffer_position (obj
, start
);
27388 pointer
= Fget_char_property (make_number (p
),
27389 Qpointer
, w
->buffer
);
27392 else if (BUFFERP (obj
)
27395 pointer
= Fget_text_property (make_number (charpos
),
27399 #endif /* HAVE_WINDOW_SYSTEM */
27403 current_buffer
= obuf
;
27408 #ifdef HAVE_WINDOW_SYSTEM
27409 if (FRAME_WINDOW_P (f
))
27410 define_frame_cursor1 (f
, cursor
, pointer
);
27412 /* This is here to prevent a compiler error, about "label at end of
27413 compound statement". */
27420 Clear any mouse-face on window W. This function is part of the
27421 redisplay interface, and is called from try_window_id and similar
27422 functions to ensure the mouse-highlight is off. */
27425 x_clear_window_mouse_face (struct window
*w
)
27427 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27428 Lisp_Object window
;
27431 XSETWINDOW (window
, w
);
27432 if (EQ (window
, hlinfo
->mouse_face_window
))
27433 clear_mouse_face (hlinfo
);
27439 Just discard the mouse face information for frame F, if any.
27440 This is used when the size of F is changed. */
27443 cancel_mouse_face (struct frame
*f
)
27445 Lisp_Object window
;
27446 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27448 window
= hlinfo
->mouse_face_window
;
27449 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27451 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27452 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27453 hlinfo
->mouse_face_window
= Qnil
;
27459 /***********************************************************************
27461 ***********************************************************************/
27463 #ifdef HAVE_WINDOW_SYSTEM
27465 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27466 which intersects rectangle R. R is in window-relative coordinates. */
27469 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27470 enum glyph_row_area area
)
27472 struct glyph
*first
= row
->glyphs
[area
];
27473 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27474 struct glyph
*last
;
27475 int first_x
, start_x
, x
;
27477 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27478 /* If row extends face to end of line write the whole line. */
27479 draw_glyphs (w
, 0, row
, area
,
27480 0, row
->used
[area
],
27481 DRAW_NORMAL_TEXT
, 0);
27484 /* Set START_X to the window-relative start position for drawing glyphs of
27485 AREA. The first glyph of the text area can be partially visible.
27486 The first glyphs of other areas cannot. */
27487 start_x
= window_box_left_offset (w
, area
);
27489 if (area
== TEXT_AREA
)
27492 /* Find the first glyph that must be redrawn. */
27494 && x
+ first
->pixel_width
< r
->x
)
27496 x
+= first
->pixel_width
;
27500 /* Find the last one. */
27504 && x
< r
->x
+ r
->width
)
27506 x
+= last
->pixel_width
;
27512 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27513 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27514 DRAW_NORMAL_TEXT
, 0);
27519 /* Redraw the parts of the glyph row ROW on window W intersecting
27520 rectangle R. R is in window-relative coordinates. Value is
27521 non-zero if mouse-face was overwritten. */
27524 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27526 xassert (row
->enabled_p
);
27528 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27529 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27530 0, row
->used
[TEXT_AREA
],
27531 DRAW_NORMAL_TEXT
, 0);
27534 if (row
->used
[LEFT_MARGIN_AREA
])
27535 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27536 if (row
->used
[TEXT_AREA
])
27537 expose_area (w
, row
, r
, TEXT_AREA
);
27538 if (row
->used
[RIGHT_MARGIN_AREA
])
27539 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27540 draw_row_fringe_bitmaps (w
, row
);
27543 return row
->mouse_face_p
;
27547 /* Redraw those parts of glyphs rows during expose event handling that
27548 overlap other rows. Redrawing of an exposed line writes over parts
27549 of lines overlapping that exposed line; this function fixes that.
27551 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27552 row in W's current matrix that is exposed and overlaps other rows.
27553 LAST_OVERLAPPING_ROW is the last such row. */
27556 expose_overlaps (struct window
*w
,
27557 struct glyph_row
*first_overlapping_row
,
27558 struct glyph_row
*last_overlapping_row
,
27561 struct glyph_row
*row
;
27563 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27564 if (row
->overlapping_p
)
27566 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27569 if (row
->used
[LEFT_MARGIN_AREA
])
27570 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27572 if (row
->used
[TEXT_AREA
])
27573 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27575 if (row
->used
[RIGHT_MARGIN_AREA
])
27576 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27582 /* Return non-zero if W's cursor intersects rectangle R. */
27585 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27587 XRectangle cr
, result
;
27588 struct glyph
*cursor_glyph
;
27589 struct glyph_row
*row
;
27591 if (w
->phys_cursor
.vpos
>= 0
27592 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27593 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27595 && row
->cursor_in_fringe_p
)
27597 /* Cursor is in the fringe. */
27598 cr
.x
= window_box_right_offset (w
,
27599 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27600 ? RIGHT_MARGIN_AREA
27603 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27604 cr
.height
= row
->height
;
27605 return x_intersect_rectangles (&cr
, r
, &result
);
27608 cursor_glyph
= get_phys_cursor_glyph (w
);
27611 /* r is relative to W's box, but w->phys_cursor.x is relative
27612 to left edge of W's TEXT area. Adjust it. */
27613 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27614 cr
.y
= w
->phys_cursor
.y
;
27615 cr
.width
= cursor_glyph
->pixel_width
;
27616 cr
.height
= w
->phys_cursor_height
;
27617 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27618 I assume the effect is the same -- and this is portable. */
27619 return x_intersect_rectangles (&cr
, r
, &result
);
27621 /* If we don't understand the format, pretend we're not in the hot-spot. */
27627 Draw a vertical window border to the right of window W if W doesn't
27628 have vertical scroll bars. */
27631 x_draw_vertical_border (struct window
*w
)
27633 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27635 /* We could do better, if we knew what type of scroll-bar the adjacent
27636 windows (on either side) have... But we don't :-(
27637 However, I think this works ok. ++KFS 2003-04-25 */
27639 /* Redraw borders between horizontally adjacent windows. Don't
27640 do it for frames with vertical scroll bars because either the
27641 right scroll bar of a window, or the left scroll bar of its
27642 neighbor will suffice as a border. */
27643 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27646 if (!WINDOW_RIGHTMOST_P (w
)
27647 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27649 int x0
, x1
, y0
, y1
;
27651 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27654 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27657 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27659 else if (!WINDOW_LEFTMOST_P (w
)
27660 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27662 int x0
, x1
, y0
, y1
;
27664 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27667 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27670 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27675 /* Redraw the part of window W intersection rectangle FR. Pixel
27676 coordinates in FR are frame-relative. Call this function with
27677 input blocked. Value is non-zero if the exposure overwrites
27681 expose_window (struct window
*w
, XRectangle
*fr
)
27683 struct frame
*f
= XFRAME (w
->frame
);
27685 int mouse_face_overwritten_p
= 0;
27687 /* If window is not yet fully initialized, do nothing. This can
27688 happen when toolkit scroll bars are used and a window is split.
27689 Reconfiguring the scroll bar will generate an expose for a newly
27691 if (w
->current_matrix
== NULL
)
27694 /* When we're currently updating the window, display and current
27695 matrix usually don't agree. Arrange for a thorough display
27697 if (w
== updated_window
)
27699 SET_FRAME_GARBAGED (f
);
27703 /* Frame-relative pixel rectangle of W. */
27704 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27705 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27706 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27707 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27709 if (x_intersect_rectangles (fr
, &wr
, &r
))
27711 int yb
= window_text_bottom_y (w
);
27712 struct glyph_row
*row
;
27713 int cursor_cleared_p
, phys_cursor_on_p
;
27714 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27716 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27717 r
.x
, r
.y
, r
.width
, r
.height
));
27719 /* Convert to window coordinates. */
27720 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27721 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27723 /* Turn off the cursor. */
27724 if (!w
->pseudo_window_p
27725 && phys_cursor_in_rect_p (w
, &r
))
27727 x_clear_cursor (w
);
27728 cursor_cleared_p
= 1;
27731 cursor_cleared_p
= 0;
27733 /* If the row containing the cursor extends face to end of line,
27734 then expose_area might overwrite the cursor outside the
27735 rectangle and thus notice_overwritten_cursor might clear
27736 w->phys_cursor_on_p. We remember the original value and
27737 check later if it is changed. */
27738 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27740 /* Update lines intersecting rectangle R. */
27741 first_overlapping_row
= last_overlapping_row
= NULL
;
27742 for (row
= w
->current_matrix
->rows
;
27747 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27749 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27750 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27751 || (r
.y
>= y0
&& r
.y
< y1
)
27752 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27754 /* A header line may be overlapping, but there is no need
27755 to fix overlapping areas for them. KFS 2005-02-12 */
27756 if (row
->overlapping_p
&& !row
->mode_line_p
)
27758 if (first_overlapping_row
== NULL
)
27759 first_overlapping_row
= row
;
27760 last_overlapping_row
= row
;
27764 if (expose_line (w
, row
, &r
))
27765 mouse_face_overwritten_p
= 1;
27768 else if (row
->overlapping_p
)
27770 /* We must redraw a row overlapping the exposed area. */
27772 ? y0
+ row
->phys_height
> r
.y
27773 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27775 if (first_overlapping_row
== NULL
)
27776 first_overlapping_row
= row
;
27777 last_overlapping_row
= row
;
27785 /* Display the mode line if there is one. */
27786 if (WINDOW_WANTS_MODELINE_P (w
)
27787 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27789 && row
->y
< r
.y
+ r
.height
)
27791 if (expose_line (w
, row
, &r
))
27792 mouse_face_overwritten_p
= 1;
27795 if (!w
->pseudo_window_p
)
27797 /* Fix the display of overlapping rows. */
27798 if (first_overlapping_row
)
27799 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27802 /* Draw border between windows. */
27803 x_draw_vertical_border (w
);
27805 /* Turn the cursor on again. */
27806 if (cursor_cleared_p
27807 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27808 update_window_cursor (w
, 1);
27812 return mouse_face_overwritten_p
;
27817 /* Redraw (parts) of all windows in the window tree rooted at W that
27818 intersect R. R contains frame pixel coordinates. Value is
27819 non-zero if the exposure overwrites mouse-face. */
27822 expose_window_tree (struct window
*w
, XRectangle
*r
)
27824 struct frame
*f
= XFRAME (w
->frame
);
27825 int mouse_face_overwritten_p
= 0;
27827 while (w
&& !FRAME_GARBAGED_P (f
))
27829 if (!NILP (w
->hchild
))
27830 mouse_face_overwritten_p
27831 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27832 else if (!NILP (w
->vchild
))
27833 mouse_face_overwritten_p
27834 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27836 mouse_face_overwritten_p
|= expose_window (w
, r
);
27838 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27841 return mouse_face_overwritten_p
;
27846 Redisplay an exposed area of frame F. X and Y are the upper-left
27847 corner of the exposed rectangle. W and H are width and height of
27848 the exposed area. All are pixel values. W or H zero means redraw
27849 the entire frame. */
27852 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27855 int mouse_face_overwritten_p
= 0;
27857 TRACE ((stderr
, "expose_frame "));
27859 /* No need to redraw if frame will be redrawn soon. */
27860 if (FRAME_GARBAGED_P (f
))
27862 TRACE ((stderr
, " garbaged\n"));
27866 /* If basic faces haven't been realized yet, there is no point in
27867 trying to redraw anything. This can happen when we get an expose
27868 event while Emacs is starting, e.g. by moving another window. */
27869 if (FRAME_FACE_CACHE (f
) == NULL
27870 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27872 TRACE ((stderr
, " no faces\n"));
27876 if (w
== 0 || h
== 0)
27879 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27880 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27890 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27891 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27893 if (WINDOWP (f
->tool_bar_window
))
27894 mouse_face_overwritten_p
27895 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27897 #ifdef HAVE_X_WINDOWS
27899 #ifndef USE_X_TOOLKIT
27900 if (WINDOWP (f
->menu_bar_window
))
27901 mouse_face_overwritten_p
27902 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27903 #endif /* not USE_X_TOOLKIT */
27907 /* Some window managers support a focus-follows-mouse style with
27908 delayed raising of frames. Imagine a partially obscured frame,
27909 and moving the mouse into partially obscured mouse-face on that
27910 frame. The visible part of the mouse-face will be highlighted,
27911 then the WM raises the obscured frame. With at least one WM, KDE
27912 2.1, Emacs is not getting any event for the raising of the frame
27913 (even tried with SubstructureRedirectMask), only Expose events.
27914 These expose events will draw text normally, i.e. not
27915 highlighted. Which means we must redo the highlight here.
27916 Subsume it under ``we love X''. --gerd 2001-08-15 */
27917 /* Included in Windows version because Windows most likely does not
27918 do the right thing if any third party tool offers
27919 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27920 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27922 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27923 if (f
== hlinfo
->mouse_face_mouse_frame
)
27925 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27926 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27927 clear_mouse_face (hlinfo
);
27928 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27935 Determine the intersection of two rectangles R1 and R2. Return
27936 the intersection in *RESULT. Value is non-zero if RESULT is not
27940 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27942 XRectangle
*left
, *right
;
27943 XRectangle
*upper
, *lower
;
27944 int intersection_p
= 0;
27946 /* Rearrange so that R1 is the left-most rectangle. */
27948 left
= r1
, right
= r2
;
27950 left
= r2
, right
= r1
;
27952 /* X0 of the intersection is right.x0, if this is inside R1,
27953 otherwise there is no intersection. */
27954 if (right
->x
<= left
->x
+ left
->width
)
27956 result
->x
= right
->x
;
27958 /* The right end of the intersection is the minimum of
27959 the right ends of left and right. */
27960 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27963 /* Same game for Y. */
27965 upper
= r1
, lower
= r2
;
27967 upper
= r2
, lower
= r1
;
27969 /* The upper end of the intersection is lower.y0, if this is inside
27970 of upper. Otherwise, there is no intersection. */
27971 if (lower
->y
<= upper
->y
+ upper
->height
)
27973 result
->y
= lower
->y
;
27975 /* The lower end of the intersection is the minimum of the lower
27976 ends of upper and lower. */
27977 result
->height
= (min (lower
->y
+ lower
->height
,
27978 upper
->y
+ upper
->height
)
27980 intersection_p
= 1;
27984 return intersection_p
;
27987 #endif /* HAVE_WINDOW_SYSTEM */
27990 /***********************************************************************
27992 ***********************************************************************/
27995 syms_of_xdisp (void)
27997 Vwith_echo_area_save_vector
= Qnil
;
27998 staticpro (&Vwith_echo_area_save_vector
);
28000 Vmessage_stack
= Qnil
;
28001 staticpro (&Vmessage_stack
);
28003 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28005 message_dolog_marker1
= Fmake_marker ();
28006 staticpro (&message_dolog_marker1
);
28007 message_dolog_marker2
= Fmake_marker ();
28008 staticpro (&message_dolog_marker2
);
28009 message_dolog_marker3
= Fmake_marker ();
28010 staticpro (&message_dolog_marker3
);
28013 defsubr (&Sdump_frame_glyph_matrix
);
28014 defsubr (&Sdump_glyph_matrix
);
28015 defsubr (&Sdump_glyph_row
);
28016 defsubr (&Sdump_tool_bar_row
);
28017 defsubr (&Strace_redisplay
);
28018 defsubr (&Strace_to_stderr
);
28020 #ifdef HAVE_WINDOW_SYSTEM
28021 defsubr (&Stool_bar_lines_needed
);
28022 defsubr (&Slookup_image_map
);
28024 defsubr (&Sformat_mode_line
);
28025 defsubr (&Sinvisible_p
);
28026 defsubr (&Scurrent_bidi_paragraph_direction
);
28028 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28029 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28030 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28031 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28032 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28033 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28034 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28035 DEFSYM (Qeval
, "eval");
28036 DEFSYM (QCdata
, ":data");
28037 DEFSYM (Qdisplay
, "display");
28038 DEFSYM (Qspace_width
, "space-width");
28039 DEFSYM (Qraise
, "raise");
28040 DEFSYM (Qslice
, "slice");
28041 DEFSYM (Qspace
, "space");
28042 DEFSYM (Qmargin
, "margin");
28043 DEFSYM (Qpointer
, "pointer");
28044 DEFSYM (Qleft_margin
, "left-margin");
28045 DEFSYM (Qright_margin
, "right-margin");
28046 DEFSYM (Qcenter
, "center");
28047 DEFSYM (Qline_height
, "line-height");
28048 DEFSYM (QCalign_to
, ":align-to");
28049 DEFSYM (QCrelative_width
, ":relative-width");
28050 DEFSYM (QCrelative_height
, ":relative-height");
28051 DEFSYM (QCeval
, ":eval");
28052 DEFSYM (QCpropertize
, ":propertize");
28053 DEFSYM (QCfile
, ":file");
28054 DEFSYM (Qfontified
, "fontified");
28055 DEFSYM (Qfontification_functions
, "fontification-functions");
28056 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28057 DEFSYM (Qescape_glyph
, "escape-glyph");
28058 DEFSYM (Qnobreak_space
, "nobreak-space");
28059 DEFSYM (Qimage
, "image");
28060 DEFSYM (Qtext
, "text");
28061 DEFSYM (Qboth
, "both");
28062 DEFSYM (Qboth_horiz
, "both-horiz");
28063 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28064 DEFSYM (QCmap
, ":map");
28065 DEFSYM (QCpointer
, ":pointer");
28066 DEFSYM (Qrect
, "rect");
28067 DEFSYM (Qcircle
, "circle");
28068 DEFSYM (Qpoly
, "poly");
28069 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28070 DEFSYM (Qgrow_only
, "grow-only");
28071 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28072 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28073 DEFSYM (Qposition
, "position");
28074 DEFSYM (Qbuffer_position
, "buffer-position");
28075 DEFSYM (Qobject
, "object");
28076 DEFSYM (Qbar
, "bar");
28077 DEFSYM (Qhbar
, "hbar");
28078 DEFSYM (Qbox
, "box");
28079 DEFSYM (Qhollow
, "hollow");
28080 DEFSYM (Qhand
, "hand");
28081 DEFSYM (Qarrow
, "arrow");
28082 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28084 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28085 Fcons (intern_c_string ("void-variable"), Qnil
)),
28087 staticpro (&list_of_error
);
28089 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28090 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28091 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28092 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28094 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28095 staticpro (&echo_buffer
[0]);
28096 staticpro (&echo_buffer
[1]);
28098 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28099 staticpro (&echo_area_buffer
[0]);
28100 staticpro (&echo_area_buffer
[1]);
28102 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28103 staticpro (&Vmessages_buffer_name
);
28105 mode_line_proptrans_alist
= Qnil
;
28106 staticpro (&mode_line_proptrans_alist
);
28107 mode_line_string_list
= Qnil
;
28108 staticpro (&mode_line_string_list
);
28109 mode_line_string_face
= Qnil
;
28110 staticpro (&mode_line_string_face
);
28111 mode_line_string_face_prop
= Qnil
;
28112 staticpro (&mode_line_string_face_prop
);
28113 Vmode_line_unwind_vector
= Qnil
;
28114 staticpro (&Vmode_line_unwind_vector
);
28116 help_echo_string
= Qnil
;
28117 staticpro (&help_echo_string
);
28118 help_echo_object
= Qnil
;
28119 staticpro (&help_echo_object
);
28120 help_echo_window
= Qnil
;
28121 staticpro (&help_echo_window
);
28122 previous_help_echo_string
= Qnil
;
28123 staticpro (&previous_help_echo_string
);
28124 help_echo_pos
= -1;
28126 DEFSYM (Qright_to_left
, "right-to-left");
28127 DEFSYM (Qleft_to_right
, "left-to-right");
28129 #ifdef HAVE_WINDOW_SYSTEM
28130 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28131 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
28132 For example, if a block cursor is over a tab, it will be drawn as
28133 wide as that tab on the display. */);
28134 x_stretch_cursor_p
= 0;
28137 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28138 doc
: /* *Non-nil means highlight trailing whitespace.
28139 The face used for trailing whitespace is `trailing-whitespace'. */);
28140 Vshow_trailing_whitespace
= Qnil
;
28142 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28143 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28144 If the value is t, Emacs highlights non-ASCII chars which have the
28145 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28146 or `escape-glyph' face respectively.
28148 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28149 U+2011 (non-breaking hyphen) are affected.
28151 Any other non-nil value means to display these characters as a escape
28152 glyph followed by an ordinary space or hyphen.
28154 A value of nil means no special handling of these characters. */);
28155 Vnobreak_char_display
= Qt
;
28157 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28158 doc
: /* *The pointer shape to show in void text areas.
28159 A value of nil means to show the text pointer. Other options are `arrow',
28160 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28161 Vvoid_text_area_pointer
= Qarrow
;
28163 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28164 doc
: /* Non-nil means don't actually do any redisplay.
28165 This is used for internal purposes. */);
28166 Vinhibit_redisplay
= Qnil
;
28168 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28169 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28170 Vglobal_mode_string
= Qnil
;
28172 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28173 doc
: /* Marker for where to display an arrow on top of the buffer text.
28174 This must be the beginning of a line in order to work.
28175 See also `overlay-arrow-string'. */);
28176 Voverlay_arrow_position
= Qnil
;
28178 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28179 doc
: /* String to display as an arrow in non-window frames.
28180 See also `overlay-arrow-position'. */);
28181 Voverlay_arrow_string
= make_pure_c_string ("=>");
28183 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28184 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28185 The symbols on this list are examined during redisplay to determine
28186 where to display overlay arrows. */);
28187 Voverlay_arrow_variable_list
28188 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28190 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28191 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28192 If that fails to bring point back on frame, point is centered instead.
28193 If this is zero, point is always centered after it moves off frame.
28194 If you want scrolling to always be a line at a time, you should set
28195 `scroll-conservatively' to a large value rather than set this to 1. */);
28197 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28198 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28199 If point moves off-screen, redisplay will scroll by up to
28200 `scroll-conservatively' lines in order to bring point just barely
28201 onto the screen again. If that cannot be done, then redisplay
28202 recenters point as usual.
28204 If the value is greater than 100, redisplay will never recenter point,
28205 but will always scroll just enough text to bring point into view, even
28206 if you move far away.
28208 A value of zero means always recenter point if it moves off screen. */);
28209 scroll_conservatively
= 0;
28211 DEFVAR_INT ("scroll-margin", scroll_margin
,
28212 doc
: /* *Number of lines of margin at the top and bottom of a window.
28213 Recenter the window whenever point gets within this many lines
28214 of the top or bottom of the window. */);
28217 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28218 doc
: /* Pixels per inch value for non-window system displays.
28219 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28220 Vdisplay_pixels_per_inch
= make_float (72.0);
28223 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28226 DEFVAR_LISP ("truncate-partial-width-windows",
28227 Vtruncate_partial_width_windows
,
28228 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28229 For an integer value, truncate lines in each window narrower than the
28230 full frame width, provided the window width is less than that integer;
28231 otherwise, respect the value of `truncate-lines'.
28233 For any other non-nil value, truncate lines in all windows that do
28234 not span the full frame width.
28236 A value of nil means to respect the value of `truncate-lines'.
28238 If `word-wrap' is enabled, you might want to reduce this. */);
28239 Vtruncate_partial_width_windows
= make_number (50);
28241 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28242 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28243 Any other value means to use the appropriate face, `mode-line',
28244 `header-line', or `menu' respectively. */);
28245 mode_line_inverse_video
= 1;
28247 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28248 doc
: /* *Maximum buffer size for which line number should be displayed.
28249 If the buffer is bigger than this, the line number does not appear
28250 in the mode line. A value of nil means no limit. */);
28251 Vline_number_display_limit
= Qnil
;
28253 DEFVAR_INT ("line-number-display-limit-width",
28254 line_number_display_limit_width
,
28255 doc
: /* *Maximum line width (in characters) for line number display.
28256 If the average length of the lines near point is bigger than this, then the
28257 line number may be omitted from the mode line. */);
28258 line_number_display_limit_width
= 200;
28260 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28261 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28262 highlight_nonselected_windows
= 0;
28264 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28265 doc
: /* Non-nil if more than one frame is visible on this display.
28266 Minibuffer-only frames don't count, but iconified frames do.
28267 This variable is not guaranteed to be accurate except while processing
28268 `frame-title-format' and `icon-title-format'. */);
28270 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28271 doc
: /* Template for displaying the title bar of visible frames.
28272 \(Assuming the window manager supports this feature.)
28274 This variable has the same structure as `mode-line-format', except that
28275 the %c and %l constructs are ignored. It is used only on frames for
28276 which no explicit name has been set \(see `modify-frame-parameters'). */);
28278 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28279 doc
: /* Template for displaying the title bar of an iconified frame.
28280 \(Assuming the window manager supports this feature.)
28281 This variable has the same structure as `mode-line-format' (which see),
28282 and is used only on frames for which no explicit name has been set
28283 \(see `modify-frame-parameters'). */);
28285 = Vframe_title_format
28286 = pure_cons (intern_c_string ("multiple-frames"),
28287 pure_cons (make_pure_c_string ("%b"),
28288 pure_cons (pure_cons (empty_unibyte_string
,
28289 pure_cons (intern_c_string ("invocation-name"),
28290 pure_cons (make_pure_c_string ("@"),
28291 pure_cons (intern_c_string ("system-name"),
28295 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28296 doc
: /* Maximum number of lines to keep in the message log buffer.
28297 If nil, disable message logging. If t, log messages but don't truncate
28298 the buffer when it becomes large. */);
28299 Vmessage_log_max
= make_number (100);
28301 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28302 doc
: /* Functions called before redisplay, if window sizes have changed.
28303 The value should be a list of functions that take one argument.
28304 Just before redisplay, for each frame, if any of its windows have changed
28305 size since the last redisplay, or have been split or deleted,
28306 all the functions in the list are called, with the frame as argument. */);
28307 Vwindow_size_change_functions
= Qnil
;
28309 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28310 doc
: /* List of functions to call before redisplaying a window with scrolling.
28311 Each function is called with two arguments, the window and its new
28312 display-start position. Note that these functions are also called by
28313 `set-window-buffer'. Also note that the value of `window-end' is not
28314 valid when these functions are called. */);
28315 Vwindow_scroll_functions
= Qnil
;
28317 DEFVAR_LISP ("window-text-change-functions",
28318 Vwindow_text_change_functions
,
28319 doc
: /* Functions to call in redisplay when text in the window might change. */);
28320 Vwindow_text_change_functions
= Qnil
;
28322 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28323 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28324 Each function is called with two arguments, the window and the end trigger value.
28325 See `set-window-redisplay-end-trigger'. */);
28326 Vredisplay_end_trigger_functions
= Qnil
;
28328 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28329 doc
: /* *Non-nil means autoselect window with mouse pointer.
28330 If nil, do not autoselect windows.
28331 A positive number means delay autoselection by that many seconds: a
28332 window is autoselected only after the mouse has remained in that
28333 window for the duration of the delay.
28334 A negative number has a similar effect, but causes windows to be
28335 autoselected only after the mouse has stopped moving. \(Because of
28336 the way Emacs compares mouse events, you will occasionally wait twice
28337 that time before the window gets selected.\)
28338 Any other value means to autoselect window instantaneously when the
28339 mouse pointer enters it.
28341 Autoselection selects the minibuffer only if it is active, and never
28342 unselects the minibuffer if it is active.
28344 When customizing this variable make sure that the actual value of
28345 `focus-follows-mouse' matches the behavior of your window manager. */);
28346 Vmouse_autoselect_window
= Qnil
;
28348 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28349 doc
: /* *Non-nil means automatically resize tool-bars.
28350 This dynamically changes the tool-bar's height to the minimum height
28351 that is needed to make all tool-bar items visible.
28352 If value is `grow-only', the tool-bar's height is only increased
28353 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28354 Vauto_resize_tool_bars
= Qt
;
28356 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28357 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28358 auto_raise_tool_bar_buttons_p
= 1;
28360 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28361 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28362 make_cursor_line_fully_visible_p
= 1;
28364 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28365 doc
: /* *Border below tool-bar in pixels.
28366 If an integer, use it as the height of the border.
28367 If it is one of `internal-border-width' or `border-width', use the
28368 value of the corresponding frame parameter.
28369 Otherwise, no border is added below the tool-bar. */);
28370 Vtool_bar_border
= Qinternal_border_width
;
28372 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28373 doc
: /* *Margin around tool-bar buttons in pixels.
28374 If an integer, use that for both horizontal and vertical margins.
28375 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28376 HORZ specifying the horizontal margin, and VERT specifying the
28377 vertical margin. */);
28378 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28380 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28381 doc
: /* *Relief thickness of tool-bar buttons. */);
28382 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28384 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28385 doc
: /* Tool bar style to use.
28387 image - show images only
28388 text - show text only
28389 both - show both, text below image
28390 both-horiz - show text to the right of the image
28391 text-image-horiz - show text to the left of the image
28392 any other - use system default or image if no system default. */);
28393 Vtool_bar_style
= Qnil
;
28395 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28396 doc
: /* *Maximum number of characters a label can have to be shown.
28397 The tool bar style must also show labels for this to have any effect, see
28398 `tool-bar-style'. */);
28399 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28401 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28402 doc
: /* List of functions to call to fontify regions of text.
28403 Each function is called with one argument POS. Functions must
28404 fontify a region starting at POS in the current buffer, and give
28405 fontified regions the property `fontified'. */);
28406 Vfontification_functions
= Qnil
;
28407 Fmake_variable_buffer_local (Qfontification_functions
);
28409 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28410 unibyte_display_via_language_environment
,
28411 doc
: /* *Non-nil means display unibyte text according to language environment.
28412 Specifically, this means that raw bytes in the range 160-255 decimal
28413 are displayed by converting them to the equivalent multibyte characters
28414 according to the current language environment. As a result, they are
28415 displayed according to the current fontset.
28417 Note that this variable affects only how these bytes are displayed,
28418 but does not change the fact they are interpreted as raw bytes. */);
28419 unibyte_display_via_language_environment
= 0;
28421 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28422 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28423 If a float, it specifies a fraction of the mini-window frame's height.
28424 If an integer, it specifies a number of lines. */);
28425 Vmax_mini_window_height
= make_float (0.25);
28427 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28428 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28429 A value of nil means don't automatically resize mini-windows.
28430 A value of t means resize them to fit the text displayed in them.
28431 A value of `grow-only', the default, means let mini-windows grow only;
28432 they return to their normal size when the minibuffer is closed, or the
28433 echo area becomes empty. */);
28434 Vresize_mini_windows
= Qgrow_only
;
28436 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28437 doc
: /* Alist specifying how to blink the cursor off.
28438 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28439 `cursor-type' frame-parameter or variable equals ON-STATE,
28440 comparing using `equal', Emacs uses OFF-STATE to specify
28441 how to blink it off. ON-STATE and OFF-STATE are values for
28442 the `cursor-type' frame parameter.
28444 If a frame's ON-STATE has no entry in this list,
28445 the frame's other specifications determine how to blink the cursor off. */);
28446 Vblink_cursor_alist
= Qnil
;
28448 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28449 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28450 If non-nil, windows are automatically scrolled horizontally to make
28451 point visible. */);
28452 automatic_hscrolling_p
= 1;
28453 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28455 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28456 doc
: /* *How many columns away from the window edge point is allowed to get
28457 before automatic hscrolling will horizontally scroll the window. */);
28458 hscroll_margin
= 5;
28460 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28461 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28462 When point is less than `hscroll-margin' columns from the window
28463 edge, automatic hscrolling will scroll the window by the amount of columns
28464 determined by this variable. If its value is a positive integer, scroll that
28465 many columns. If it's a positive floating-point number, it specifies the
28466 fraction of the window's width to scroll. If it's nil or zero, point will be
28467 centered horizontally after the scroll. Any other value, including negative
28468 numbers, are treated as if the value were zero.
28470 Automatic hscrolling always moves point outside the scroll margin, so if
28471 point was more than scroll step columns inside the margin, the window will
28472 scroll more than the value given by the scroll step.
28474 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28475 and `scroll-right' overrides this variable's effect. */);
28476 Vhscroll_step
= make_number (0);
28478 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28479 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28480 Bind this around calls to `message' to let it take effect. */);
28481 message_truncate_lines
= 0;
28483 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28484 doc
: /* Normal hook run to update the menu bar definitions.
28485 Redisplay runs this hook before it redisplays the menu bar.
28486 This is used to update submenus such as Buffers,
28487 whose contents depend on various data. */);
28488 Vmenu_bar_update_hook
= Qnil
;
28490 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28491 doc
: /* Frame for which we are updating a menu.
28492 The enable predicate for a menu binding should check this variable. */);
28493 Vmenu_updating_frame
= Qnil
;
28495 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28496 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28497 inhibit_menubar_update
= 0;
28499 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28500 doc
: /* Prefix prepended to all continuation lines at display time.
28501 The value may be a string, an image, or a stretch-glyph; it is
28502 interpreted in the same way as the value of a `display' text property.
28504 This variable is overridden by any `wrap-prefix' text or overlay
28507 To add a prefix to non-continuation lines, use `line-prefix'. */);
28508 Vwrap_prefix
= Qnil
;
28509 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28510 Fmake_variable_buffer_local (Qwrap_prefix
);
28512 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28513 doc
: /* Prefix prepended to all non-continuation lines at display time.
28514 The value may be a string, an image, or a stretch-glyph; it is
28515 interpreted in the same way as the value of a `display' text property.
28517 This variable is overridden by any `line-prefix' text or overlay
28520 To add a prefix to continuation lines, use `wrap-prefix'. */);
28521 Vline_prefix
= Qnil
;
28522 DEFSYM (Qline_prefix
, "line-prefix");
28523 Fmake_variable_buffer_local (Qline_prefix
);
28525 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28526 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28527 inhibit_eval_during_redisplay
= 0;
28529 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28530 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28531 inhibit_free_realized_faces
= 0;
28534 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28535 doc
: /* Inhibit try_window_id display optimization. */);
28536 inhibit_try_window_id
= 0;
28538 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28539 doc
: /* Inhibit try_window_reusing display optimization. */);
28540 inhibit_try_window_reusing
= 0;
28542 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28543 doc
: /* Inhibit try_cursor_movement display optimization. */);
28544 inhibit_try_cursor_movement
= 0;
28545 #endif /* GLYPH_DEBUG */
28547 DEFVAR_INT ("overline-margin", overline_margin
,
28548 doc
: /* *Space between overline and text, in pixels.
28549 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28550 margin to the character height. */);
28551 overline_margin
= 2;
28553 DEFVAR_INT ("underline-minimum-offset",
28554 underline_minimum_offset
,
28555 doc
: /* Minimum distance between baseline and underline.
28556 This can improve legibility of underlined text at small font sizes,
28557 particularly when using variable `x-use-underline-position-properties'
28558 with fonts that specify an UNDERLINE_POSITION relatively close to the
28559 baseline. The default value is 1. */);
28560 underline_minimum_offset
= 1;
28562 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28563 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28564 This feature only works when on a window system that can change
28565 cursor shapes. */);
28566 display_hourglass_p
= 1;
28568 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28569 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28570 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28572 hourglass_atimer
= NULL
;
28573 hourglass_shown_p
= 0;
28575 DEFSYM (Qglyphless_char
, "glyphless-char");
28576 DEFSYM (Qhex_code
, "hex-code");
28577 DEFSYM (Qempty_box
, "empty-box");
28578 DEFSYM (Qthin_space
, "thin-space");
28579 DEFSYM (Qzero_width
, "zero-width");
28581 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28582 /* Intern this now in case it isn't already done.
28583 Setting this variable twice is harmless.
28584 But don't staticpro it here--that is done in alloc.c. */
28585 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28586 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28588 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28589 doc
: /* Char-table defining glyphless characters.
28590 Each element, if non-nil, should be one of the following:
28591 an ASCII acronym string: display this string in a box
28592 `hex-code': display the hexadecimal code of a character in a box
28593 `empty-box': display as an empty box
28594 `thin-space': display as 1-pixel width space
28595 `zero-width': don't display
28596 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28597 display method for graphical terminals and text terminals respectively.
28598 GRAPHICAL and TEXT should each have one of the values listed above.
28600 The char-table has one extra slot to control the display of a character for
28601 which no font is found. This slot only takes effect on graphical terminals.
28602 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28603 `thin-space'. The default is `empty-box'. */);
28604 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28605 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28610 /* Initialize this module when Emacs starts. */
28615 current_header_line_height
= current_mode_line_height
= -1;
28617 CHARPOS (this_line_start_pos
) = 0;
28619 if (!noninteractive
)
28621 struct window
*m
= XWINDOW (minibuf_window
);
28622 Lisp_Object frame
= m
->frame
;
28623 struct frame
*f
= XFRAME (frame
);
28624 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28625 struct window
*r
= XWINDOW (root
);
28628 echo_area_window
= minibuf_window
;
28630 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28631 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28632 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28633 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28634 XSETFASTINT (m
->total_lines
, 1);
28635 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28637 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28638 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28639 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28641 /* The default ellipsis glyphs `...'. */
28642 for (i
= 0; i
< 3; ++i
)
28643 default_invis_vector
[i
] = make_number ('.');
28647 /* Allocate the buffer for frame titles.
28648 Also used for `format-mode-line'. */
28650 mode_line_noprop_buf
= (char *) xmalloc (size
);
28651 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28652 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28653 mode_line_target
= MODE_LINE_DISPLAY
;
28656 help_echo_showing_p
= 0;
28659 /* Since w32 does not support atimers, it defines its own implementation of
28660 the following three functions in w32fns.c. */
28663 /* Platform-independent portion of hourglass implementation. */
28665 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28667 hourglass_started (void)
28669 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28672 /* Cancel a currently active hourglass timer, and start a new one. */
28674 start_hourglass (void)
28676 #if defined (HAVE_WINDOW_SYSTEM)
28678 int secs
, usecs
= 0;
28680 cancel_hourglass ();
28682 if (INTEGERP (Vhourglass_delay
)
28683 && XINT (Vhourglass_delay
) > 0)
28684 secs
= XFASTINT (Vhourglass_delay
);
28685 else if (FLOATP (Vhourglass_delay
)
28686 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28689 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28690 secs
= XFASTINT (tem
);
28691 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28694 secs
= DEFAULT_HOURGLASS_DELAY
;
28696 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28697 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28698 show_hourglass
, NULL
);
28703 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28706 cancel_hourglass (void)
28708 #if defined (HAVE_WINDOW_SYSTEM)
28709 if (hourglass_atimer
)
28711 cancel_atimer (hourglass_atimer
);
28712 hourglass_atimer
= NULL
;
28715 if (hourglass_shown_p
)
28719 #endif /* ! WINDOWSNT */