1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache(); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1344 bidi_unshelve_cache (it2data
, 1);
1346 bidi_unshelve_cache (itdata
, 0);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 EMACS_INT rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 EMACS_INT charpos
, EMACS_INT bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? XINT (BVAR (current_buffer
, selective_display
))
2433 : (!NILP (BVAR (current_buffer
, selective_display
))
2435 it
->selective_display_ellipsis_p
2436 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2438 /* Display table to use. */
2439 it
->dp
= window_display_table (w
);
2441 /* Are multibyte characters enabled in current_buffer? */
2442 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2444 /* Non-zero if we should highlight the region. */
2446 = (!NILP (Vtransient_mark_mode
)
2447 && !NILP (BVAR (current_buffer
, mark_active
))
2448 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2450 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2451 start and end of a visible region in window IT->w. Set both to
2452 -1 to indicate no region. */
2453 if (highlight_region_p
2454 /* Maybe highlight only in selected window. */
2455 && (/* Either show region everywhere. */
2456 highlight_nonselected_windows
2457 /* Or show region in the selected window. */
2458 || w
== XWINDOW (selected_window
)
2459 /* Or show the region if we are in the mini-buffer and W is
2460 the window the mini-buffer refers to. */
2461 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2462 && WINDOWP (minibuf_selected_window
)
2463 && w
== XWINDOW (minibuf_selected_window
))))
2465 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2466 it
->region_beg_charpos
= min (PT
, markpos
);
2467 it
->region_end_charpos
= max (PT
, markpos
);
2470 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2472 /* Get the position at which the redisplay_end_trigger hook should
2473 be run, if it is to be run at all. */
2474 if (MARKERP (w
->redisplay_end_trigger
)
2475 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2476 it
->redisplay_end_trigger_charpos
2477 = marker_position (w
->redisplay_end_trigger
);
2478 else if (INTEGERP (w
->redisplay_end_trigger
))
2479 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2481 /* Correct bogus values of tab_width. */
2482 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2483 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2486 /* Are lines in the display truncated? */
2487 if (base_face_id
!= DEFAULT_FACE_ID
2488 || XINT (it
->w
->hscroll
)
2489 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2490 && ((!NILP (Vtruncate_partial_width_windows
)
2491 && !INTEGERP (Vtruncate_partial_width_windows
))
2492 || (INTEGERP (Vtruncate_partial_width_windows
)
2493 && (WINDOW_TOTAL_COLS (it
->w
)
2494 < XINT (Vtruncate_partial_width_windows
))))))
2495 it
->line_wrap
= TRUNCATE
;
2496 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2497 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2498 ? WINDOW_WRAP
: WORD_WRAP
;
2500 it
->line_wrap
= TRUNCATE
;
2502 /* Get dimensions of truncation and continuation glyphs. These are
2503 displayed as fringe bitmaps under X, so we don't need them for such
2505 if (!FRAME_WINDOW_P (it
->f
))
2507 if (it
->line_wrap
== TRUNCATE
)
2509 /* We will need the truncation glyph. */
2510 xassert (it
->glyph_row
== NULL
);
2511 produce_special_glyphs (it
, IT_TRUNCATION
);
2512 it
->truncation_pixel_width
= it
->pixel_width
;
2516 /* We will need the continuation glyph. */
2517 xassert (it
->glyph_row
== NULL
);
2518 produce_special_glyphs (it
, IT_CONTINUATION
);
2519 it
->continuation_pixel_width
= it
->pixel_width
;
2522 /* Reset these values to zero because the produce_special_glyphs
2523 above has changed them. */
2524 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2525 it
->phys_ascent
= it
->phys_descent
= 0;
2528 /* Set this after getting the dimensions of truncation and
2529 continuation glyphs, so that we don't produce glyphs when calling
2530 produce_special_glyphs, above. */
2531 it
->glyph_row
= row
;
2532 it
->area
= TEXT_AREA
;
2534 /* Forget any previous info about this row being reversed. */
2536 it
->glyph_row
->reversed_p
= 0;
2538 /* Get the dimensions of the display area. The display area
2539 consists of the visible window area plus a horizontally scrolled
2540 part to the left of the window. All x-values are relative to the
2541 start of this total display area. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2544 /* Mode lines, menu bar in terminal frames. */
2545 it
->first_visible_x
= 0;
2546 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2551 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2552 it
->last_visible_x
= (it
->first_visible_x
2553 + window_box_width (w
, TEXT_AREA
));
2555 /* If we truncate lines, leave room for the truncator glyph(s) at
2556 the right margin. Otherwise, leave room for the continuation
2557 glyph(s). Truncation and continuation glyphs are not inserted
2558 for window-based redisplay. */
2559 if (!FRAME_WINDOW_P (it
->f
))
2561 if (it
->line_wrap
== TRUNCATE
)
2562 it
->last_visible_x
-= it
->truncation_pixel_width
;
2564 it
->last_visible_x
-= it
->continuation_pixel_width
;
2567 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2568 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2571 /* Leave room for a border glyph. */
2572 if (!FRAME_WINDOW_P (it
->f
)
2573 && !WINDOW_RIGHTMOST_P (it
->w
))
2574 it
->last_visible_x
-= 1;
2576 it
->last_visible_y
= window_text_bottom_y (w
);
2578 /* For mode lines and alike, arrange for the first glyph having a
2579 left box line if the face specifies a box. */
2580 if (base_face_id
!= DEFAULT_FACE_ID
)
2584 it
->face_id
= remapped_base_face_id
;
2586 /* If we have a boxed mode line, make the first character appear
2587 with a left box line. */
2588 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2589 if (face
->box
!= FACE_NO_BOX
)
2590 it
->start_of_box_run_p
= 1;
2593 /* If a buffer position was specified, set the iterator there,
2594 getting overlays and face properties from that position. */
2595 if (charpos
>= BUF_BEG (current_buffer
))
2597 it
->end_charpos
= ZV
;
2599 IT_CHARPOS (*it
) = charpos
;
2601 /* Compute byte position if not specified. */
2602 if (bytepos
< charpos
)
2603 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2605 IT_BYTEPOS (*it
) = bytepos
;
2607 it
->start
= it
->current
;
2608 /* Do we need to reorder bidirectional text? Not if this is a
2609 unibyte buffer: by definition, none of the single-byte
2610 characters are strong R2L, so no reordering is needed. And
2611 bidi.c doesn't support unibyte buffers anyway. */
2613 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2616 /* If we are to reorder bidirectional text, init the bidi
2620 /* Note the paragraph direction that this buffer wants to
2622 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= L2R
;
2625 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2627 it
->paragraph_embedding
= R2L
;
2629 it
->paragraph_embedding
= NEUTRAL_DIR
;
2630 bidi_unshelve_cache (NULL
, 0);
2631 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2635 /* Compute faces etc. */
2636 reseat (it
, it
->current
.pos
, 1);
2643 /* Initialize IT for the display of window W with window start POS. */
2646 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2648 struct glyph_row
*row
;
2649 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2651 row
= w
->desired_matrix
->rows
+ first_vpos
;
2652 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2653 it
->first_vpos
= first_vpos
;
2655 /* Don't reseat to previous visible line start if current start
2656 position is in a string or image. */
2657 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2659 int start_at_line_beg_p
;
2660 int first_y
= it
->current_y
;
2662 /* If window start is not at a line start, skip forward to POS to
2663 get the correct continuation lines width. */
2664 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2665 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2666 if (!start_at_line_beg_p
)
2670 reseat_at_previous_visible_line_start (it
);
2671 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2673 new_x
= it
->current_x
+ it
->pixel_width
;
2675 /* If lines are continued, this line may end in the middle
2676 of a multi-glyph character (e.g. a control character
2677 displayed as \003, or in the middle of an overlay
2678 string). In this case move_it_to above will not have
2679 taken us to the start of the continuation line but to the
2680 end of the continued line. */
2681 if (it
->current_x
> 0
2682 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2683 && (/* And glyph doesn't fit on the line. */
2684 new_x
> it
->last_visible_x
2685 /* Or it fits exactly and we're on a window
2687 || (new_x
== it
->last_visible_x
2688 && FRAME_WINDOW_P (it
->f
))))
2690 if (it
->current
.dpvec_index
>= 0
2691 || it
->current
.overlay_string_index
>= 0)
2693 set_iterator_to_next (it
, 1);
2694 move_it_in_display_line_to (it
, -1, -1, 0);
2697 it
->continuation_lines_width
+= it
->current_x
;
2700 /* We're starting a new display line, not affected by the
2701 height of the continued line, so clear the appropriate
2702 fields in the iterator structure. */
2703 it
->max_ascent
= it
->max_descent
= 0;
2704 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2706 it
->current_y
= first_y
;
2708 it
->current_x
= it
->hpos
= 0;
2714 /* Return 1 if POS is a position in ellipses displayed for invisible
2715 text. W is the window we display, for text property lookup. */
2718 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2720 Lisp_Object prop
, window
;
2722 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2724 /* If POS specifies a position in a display vector, this might
2725 be for an ellipsis displayed for invisible text. We won't
2726 get the iterator set up for delivering that ellipsis unless
2727 we make sure that it gets aware of the invisible text. */
2728 if (pos
->dpvec_index
>= 0
2729 && pos
->overlay_string_index
< 0
2730 && CHARPOS (pos
->string_pos
) < 0
2732 && (XSETWINDOW (window
, w
),
2733 prop
= Fget_char_property (make_number (charpos
),
2734 Qinvisible
, window
),
2735 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2737 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2739 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2746 /* Initialize IT for stepping through current_buffer in window W,
2747 starting at position POS that includes overlay string and display
2748 vector/ control character translation position information. Value
2749 is zero if there are overlay strings with newlines at POS. */
2752 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2754 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2755 int i
, overlay_strings_with_newlines
= 0;
2757 /* If POS specifies a position in a display vector, this might
2758 be for an ellipsis displayed for invisible text. We won't
2759 get the iterator set up for delivering that ellipsis unless
2760 we make sure that it gets aware of the invisible text. */
2761 if (in_ellipses_for_invisible_text_p (pos
, w
))
2767 /* Keep in mind: the call to reseat in init_iterator skips invisible
2768 text, so we might end up at a position different from POS. This
2769 is only a problem when POS is a row start after a newline and an
2770 overlay starts there with an after-string, and the overlay has an
2771 invisible property. Since we don't skip invisible text in
2772 display_line and elsewhere immediately after consuming the
2773 newline before the row start, such a POS will not be in a string,
2774 but the call to init_iterator below will move us to the
2776 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2778 /* This only scans the current chunk -- it should scan all chunks.
2779 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2780 to 16 in 22.1 to make this a lesser problem. */
2781 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2783 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2784 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2786 while (s
< e
&& *s
!= '\n')
2791 overlay_strings_with_newlines
= 1;
2796 /* If position is within an overlay string, set up IT to the right
2798 if (pos
->overlay_string_index
>= 0)
2802 /* If the first overlay string happens to have a `display'
2803 property for an image, the iterator will be set up for that
2804 image, and we have to undo that setup first before we can
2805 correct the overlay string index. */
2806 if (it
->method
== GET_FROM_IMAGE
)
2809 /* We already have the first chunk of overlay strings in
2810 IT->overlay_strings. Load more until the one for
2811 pos->overlay_string_index is in IT->overlay_strings. */
2812 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2814 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2815 it
->current
.overlay_string_index
= 0;
2818 load_overlay_strings (it
, 0);
2819 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2823 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2824 relative_index
= (it
->current
.overlay_string_index
2825 % OVERLAY_STRING_CHUNK_SIZE
);
2826 it
->string
= it
->overlay_strings
[relative_index
];
2827 xassert (STRINGP (it
->string
));
2828 it
->current
.string_pos
= pos
->string_pos
;
2829 it
->method
= GET_FROM_STRING
;
2832 if (CHARPOS (pos
->string_pos
) >= 0)
2834 /* Recorded position is not in an overlay string, but in another
2835 string. This can only be a string from a `display' property.
2836 IT should already be filled with that string. */
2837 it
->current
.string_pos
= pos
->string_pos
;
2838 xassert (STRINGP (it
->string
));
2841 /* Restore position in display vector translations, control
2842 character translations or ellipses. */
2843 if (pos
->dpvec_index
>= 0)
2845 if (it
->dpvec
== NULL
)
2846 get_next_display_element (it
);
2847 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2848 it
->current
.dpvec_index
= pos
->dpvec_index
;
2852 return !overlay_strings_with_newlines
;
2856 /* Initialize IT for stepping through current_buffer in window W
2857 starting at ROW->start. */
2860 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2862 init_from_display_pos (it
, w
, &row
->start
);
2863 it
->start
= row
->start
;
2864 it
->continuation_lines_width
= row
->continuation_lines_width
;
2869 /* Initialize IT for stepping through current_buffer in window W
2870 starting in the line following ROW, i.e. starting at ROW->end.
2871 Value is zero if there are overlay strings with newlines at ROW's
2875 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2879 if (init_from_display_pos (it
, w
, &row
->end
))
2881 if (row
->continued_p
)
2882 it
->continuation_lines_width
2883 = row
->continuation_lines_width
+ row
->pixel_width
;
2894 /***********************************************************************
2896 ***********************************************************************/
2898 /* Called when IT reaches IT->stop_charpos. Handle text property and
2899 overlay changes. Set IT->stop_charpos to the next position where
2903 handle_stop (struct it
*it
)
2905 enum prop_handled handled
;
2906 int handle_overlay_change_p
;
2910 it
->current
.dpvec_index
= -1;
2911 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2912 it
->ignore_overlay_strings_at_pos_p
= 0;
2915 /* Use face of preceding text for ellipsis (if invisible) */
2916 if (it
->selective_display_ellipsis_p
)
2917 it
->saved_face_id
= it
->face_id
;
2921 handled
= HANDLED_NORMALLY
;
2923 /* Call text property handlers. */
2924 for (p
= it_props
; p
->handler
; ++p
)
2926 handled
= p
->handler (it
);
2928 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2930 else if (handled
== HANDLED_RETURN
)
2932 /* We still want to show before and after strings from
2933 overlays even if the actual buffer text is replaced. */
2934 if (!handle_overlay_change_p
2936 || !get_overlay_strings_1 (it
, 0, 0))
2939 setup_for_ellipsis (it
, 0);
2940 /* When handling a display spec, we might load an
2941 empty string. In that case, discard it here. We
2942 used to discard it in handle_single_display_spec,
2943 but that causes get_overlay_strings_1, above, to
2944 ignore overlay strings that we must check. */
2945 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2949 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2953 it
->ignore_overlay_strings_at_pos_p
= 1;
2954 it
->string_from_display_prop_p
= 0;
2955 it
->from_disp_prop_p
= 0;
2956 handle_overlay_change_p
= 0;
2958 handled
= HANDLED_RECOMPUTE_PROPS
;
2961 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2962 handle_overlay_change_p
= 0;
2965 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2967 /* Don't check for overlay strings below when set to deliver
2968 characters from a display vector. */
2969 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2970 handle_overlay_change_p
= 0;
2972 /* Handle overlay changes.
2973 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2974 if it finds overlays. */
2975 if (handle_overlay_change_p
)
2976 handled
= handle_overlay_change (it
);
2981 setup_for_ellipsis (it
, 0);
2985 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2987 /* Determine where to stop next. */
2988 if (handled
== HANDLED_NORMALLY
)
2989 compute_stop_pos (it
);
2993 /* Compute IT->stop_charpos from text property and overlay change
2994 information for IT's current position. */
2997 compute_stop_pos (struct it
*it
)
2999 register INTERVAL iv
, next_iv
;
3000 Lisp_Object object
, limit
, position
;
3001 EMACS_INT charpos
, bytepos
;
3003 /* If nowhere else, stop at the end. */
3004 it
->stop_charpos
= it
->end_charpos
;
3006 if (STRINGP (it
->string
))
3008 /* Strings are usually short, so don't limit the search for
3010 object
= it
->string
;
3012 charpos
= IT_STRING_CHARPOS (*it
);
3013 bytepos
= IT_STRING_BYTEPOS (*it
);
3019 /* If next overlay change is in front of the current stop pos
3020 (which is IT->end_charpos), stop there. Note: value of
3021 next_overlay_change is point-max if no overlay change
3023 charpos
= IT_CHARPOS (*it
);
3024 bytepos
= IT_BYTEPOS (*it
);
3025 pos
= next_overlay_change (charpos
);
3026 if (pos
< it
->stop_charpos
)
3027 it
->stop_charpos
= pos
;
3029 /* If showing the region, we have to stop at the region
3030 start or end because the face might change there. */
3031 if (it
->region_beg_charpos
> 0)
3033 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3034 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3035 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3036 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3039 /* Set up variables for computing the stop position from text
3040 property changes. */
3041 XSETBUFFER (object
, current_buffer
);
3042 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3045 /* Get the interval containing IT's position. Value is a null
3046 interval if there isn't such an interval. */
3047 position
= make_number (charpos
);
3048 iv
= validate_interval_range (object
, &position
, &position
, 0);
3049 if (!NULL_INTERVAL_P (iv
))
3051 Lisp_Object values_here
[LAST_PROP_IDX
];
3054 /* Get properties here. */
3055 for (p
= it_props
; p
->handler
; ++p
)
3056 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3058 /* Look for an interval following iv that has different
3060 for (next_iv
= next_interval (iv
);
3061 (!NULL_INTERVAL_P (next_iv
)
3063 || XFASTINT (limit
) > next_iv
->position
));
3064 next_iv
= next_interval (next_iv
))
3066 for (p
= it_props
; p
->handler
; ++p
)
3068 Lisp_Object new_value
;
3070 new_value
= textget (next_iv
->plist
, *p
->name
);
3071 if (!EQ (values_here
[p
->idx
], new_value
))
3079 if (!NULL_INTERVAL_P (next_iv
))
3081 if (INTEGERP (limit
)
3082 && next_iv
->position
>= XFASTINT (limit
))
3083 /* No text property change up to limit. */
3084 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3086 /* Text properties change in next_iv. */
3087 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3091 if (it
->cmp_it
.id
< 0)
3093 EMACS_INT stoppos
= it
->end_charpos
;
3095 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3097 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3098 stoppos
, it
->string
);
3101 xassert (STRINGP (it
->string
)
3102 || (it
->stop_charpos
>= BEGV
3103 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3107 /* Return the position of the next overlay change after POS in
3108 current_buffer. Value is point-max if no overlay change
3109 follows. This is like `next-overlay-change' but doesn't use
3113 next_overlay_change (EMACS_INT pos
)
3115 ptrdiff_t i
, noverlays
;
3117 Lisp_Object
*overlays
;
3119 /* Get all overlays at the given position. */
3120 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3122 /* If any of these overlays ends before endpos,
3123 use its ending point instead. */
3124 for (i
= 0; i
< noverlays
; ++i
)
3129 oend
= OVERLAY_END (overlays
[i
]);
3130 oendpos
= OVERLAY_POSITION (oend
);
3131 endpos
= min (endpos
, oendpos
);
3137 /* How many characters forward to search for a display property or
3138 display string. Enough for a screenful of 100 lines x 50
3139 characters in a line. */
3140 #define MAX_DISP_SCAN 5000
3142 /* Return the character position of a display string at or after
3143 position specified by POSITION. If no display string exists at or
3144 after POSITION, return ZV. A display string is either an overlay
3145 with `display' property whose value is a string, or a `display'
3146 text property whose value is a string. STRING is data about the
3147 string to iterate; if STRING->lstring is nil, we are iterating a
3148 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3151 compute_display_string_pos (struct text_pos
*position
,
3152 struct bidi_string_data
*string
,
3153 int frame_window_p
, int *disp_prop_p
)
3155 /* OBJECT = nil means current buffer. */
3156 Lisp_Object object
=
3157 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3158 Lisp_Object pos
, spec
, limpos
;
3159 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3160 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3161 EMACS_INT begb
= string_p
? 0 : BEGV
;
3162 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3164 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3165 struct text_pos tpos
;
3170 /* We don't support display properties whose values are strings
3171 that have display string properties. */
3172 || string
->from_disp_str
3173 /* C strings cannot have display properties. */
3174 || (string
->s
&& !STRINGP (object
)))
3180 /* If the character at CHARPOS is where the display string begins,
3182 pos
= make_number (charpos
);
3183 if (STRINGP (object
))
3184 bufpos
= string
->bufpos
;
3188 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3190 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3193 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3199 /* Look forward for the first character with a `display' property
3200 that will replace the underlying text when displayed. */
3201 limpos
= make_number (lim
);
3203 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3204 CHARPOS (tpos
) = XFASTINT (pos
);
3205 if (CHARPOS (tpos
) >= lim
)
3210 if (STRINGP (object
))
3211 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3213 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3214 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3215 if (!STRINGP (object
))
3216 bufpos
= CHARPOS (tpos
);
3217 } while (NILP (spec
)
3218 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3221 return CHARPOS (tpos
);
3224 /* Return the character position of the end of the display string that
3225 started at CHARPOS. A display string is either an overlay with
3226 `display' property whose value is a string or a `display' text
3227 property whose value is a string. */
3229 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3231 /* OBJECT = nil means current buffer. */
3232 Lisp_Object object
=
3233 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3234 Lisp_Object pos
= make_number (charpos
);
3236 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3238 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3241 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3244 /* Look forward for the first character where the `display' property
3246 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3248 return XFASTINT (pos
);
3253 /***********************************************************************
3255 ***********************************************************************/
3257 /* Handle changes in the `fontified' property of the current buffer by
3258 calling hook functions from Qfontification_functions to fontify
3261 static enum prop_handled
3262 handle_fontified_prop (struct it
*it
)
3264 Lisp_Object prop
, pos
;
3265 enum prop_handled handled
= HANDLED_NORMALLY
;
3267 if (!NILP (Vmemory_full
))
3270 /* Get the value of the `fontified' property at IT's current buffer
3271 position. (The `fontified' property doesn't have a special
3272 meaning in strings.) If the value is nil, call functions from
3273 Qfontification_functions. */
3274 if (!STRINGP (it
->string
)
3276 && !NILP (Vfontification_functions
)
3277 && !NILP (Vrun_hooks
)
3278 && (pos
= make_number (IT_CHARPOS (*it
)),
3279 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3280 /* Ignore the special cased nil value always present at EOB since
3281 no amount of fontifying will be able to change it. */
3282 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3284 int count
= SPECPDL_INDEX ();
3286 struct buffer
*obuf
= current_buffer
;
3287 int begv
= BEGV
, zv
= ZV
;
3288 int old_clip_changed
= current_buffer
->clip_changed
;
3290 val
= Vfontification_functions
;
3291 specbind (Qfontification_functions
, Qnil
);
3293 xassert (it
->end_charpos
== ZV
);
3295 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3296 safe_call1 (val
, pos
);
3299 Lisp_Object fns
, fn
;
3300 struct gcpro gcpro1
, gcpro2
;
3305 for (; CONSP (val
); val
= XCDR (val
))
3311 /* A value of t indicates this hook has a local
3312 binding; it means to run the global binding too.
3313 In a global value, t should not occur. If it
3314 does, we must ignore it to avoid an endless
3316 for (fns
= Fdefault_value (Qfontification_functions
);
3322 safe_call1 (fn
, pos
);
3326 safe_call1 (fn
, pos
);
3332 unbind_to (count
, Qnil
);
3334 /* Fontification functions routinely call `save-restriction'.
3335 Normally, this tags clip_changed, which can confuse redisplay
3336 (see discussion in Bug#6671). Since we don't perform any
3337 special handling of fontification changes in the case where
3338 `save-restriction' isn't called, there's no point doing so in
3339 this case either. So, if the buffer's restrictions are
3340 actually left unchanged, reset clip_changed. */
3341 if (obuf
== current_buffer
)
3343 if (begv
== BEGV
&& zv
== ZV
)
3344 current_buffer
->clip_changed
= old_clip_changed
;
3346 /* There isn't much we can reasonably do to protect against
3347 misbehaving fontification, but here's a fig leaf. */
3348 else if (!NILP (BVAR (obuf
, name
)))
3349 set_buffer_internal_1 (obuf
);
3351 /* The fontification code may have added/removed text.
3352 It could do even a lot worse, but let's at least protect against
3353 the most obvious case where only the text past `pos' gets changed',
3354 as is/was done in grep.el where some escapes sequences are turned
3355 into face properties (bug#7876). */
3356 it
->end_charpos
= ZV
;
3358 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3359 something. This avoids an endless loop if they failed to
3360 fontify the text for which reason ever. */
3361 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3362 handled
= HANDLED_RECOMPUTE_PROPS
;
3370 /***********************************************************************
3372 ***********************************************************************/
3374 /* Set up iterator IT from face properties at its current position.
3375 Called from handle_stop. */
3377 static enum prop_handled
3378 handle_face_prop (struct it
*it
)
3381 EMACS_INT next_stop
;
3383 if (!STRINGP (it
->string
))
3386 = face_at_buffer_position (it
->w
,
3388 it
->region_beg_charpos
,
3389 it
->region_end_charpos
,
3392 + TEXT_PROP_DISTANCE_LIMIT
),
3393 0, it
->base_face_id
);
3395 /* Is this a start of a run of characters with box face?
3396 Caveat: this can be called for a freshly initialized
3397 iterator; face_id is -1 in this case. We know that the new
3398 face will not change until limit, i.e. if the new face has a
3399 box, all characters up to limit will have one. But, as
3400 usual, we don't know whether limit is really the end. */
3401 if (new_face_id
!= it
->face_id
)
3403 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3405 /* If new face has a box but old face has not, this is
3406 the start of a run of characters with box, i.e. it has
3407 a shadow on the left side. The value of face_id of the
3408 iterator will be -1 if this is the initial call that gets
3409 the face. In this case, we have to look in front of IT's
3410 position and see whether there is a face != new_face_id. */
3411 it
->start_of_box_run_p
3412 = (new_face
->box
!= FACE_NO_BOX
3413 && (it
->face_id
>= 0
3414 || IT_CHARPOS (*it
) == BEG
3415 || new_face_id
!= face_before_it_pos (it
)));
3416 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3424 Lisp_Object from_overlay
3425 = (it
->current
.overlay_string_index
>= 0
3426 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3429 /* See if we got to this string directly or indirectly from
3430 an overlay property. That includes the before-string or
3431 after-string of an overlay, strings in display properties
3432 provided by an overlay, their text properties, etc.
3434 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3435 if (! NILP (from_overlay
))
3436 for (i
= it
->sp
- 1; i
>= 0; i
--)
3438 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3440 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3441 else if (! NILP (it
->stack
[i
].from_overlay
))
3442 from_overlay
= it
->stack
[i
].from_overlay
;
3444 if (!NILP (from_overlay
))
3448 if (! NILP (from_overlay
))
3450 bufpos
= IT_CHARPOS (*it
);
3451 /* For a string from an overlay, the base face depends
3452 only on text properties and ignores overlays. */
3454 = face_for_overlay_string (it
->w
,
3456 it
->region_beg_charpos
,
3457 it
->region_end_charpos
,
3460 + TEXT_PROP_DISTANCE_LIMIT
),
3468 /* For strings from a `display' property, use the face at
3469 IT's current buffer position as the base face to merge
3470 with, so that overlay strings appear in the same face as
3471 surrounding text, unless they specify their own
3473 base_face_id
= underlying_face_id (it
);
3476 new_face_id
= face_at_string_position (it
->w
,
3478 IT_STRING_CHARPOS (*it
),
3480 it
->region_beg_charpos
,
3481 it
->region_end_charpos
,
3485 /* Is this a start of a run of characters with box? Caveat:
3486 this can be called for a freshly allocated iterator; face_id
3487 is -1 is this case. We know that the new face will not
3488 change until the next check pos, i.e. if the new face has a
3489 box, all characters up to that position will have a
3490 box. But, as usual, we don't know whether that position
3491 is really the end. */
3492 if (new_face_id
!= it
->face_id
)
3494 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3495 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3497 /* If new face has a box but old face hasn't, this is the
3498 start of a run of characters with box, i.e. it has a
3499 shadow on the left side. */
3500 it
->start_of_box_run_p
3501 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3502 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3506 it
->face_id
= new_face_id
;
3507 return HANDLED_NORMALLY
;
3511 /* Return the ID of the face ``underlying'' IT's current position,
3512 which is in a string. If the iterator is associated with a
3513 buffer, return the face at IT's current buffer position.
3514 Otherwise, use the iterator's base_face_id. */
3517 underlying_face_id (struct it
*it
)
3519 int face_id
= it
->base_face_id
, i
;
3521 xassert (STRINGP (it
->string
));
3523 for (i
= it
->sp
- 1; i
>= 0; --i
)
3524 if (NILP (it
->stack
[i
].string
))
3525 face_id
= it
->stack
[i
].face_id
;
3531 /* Compute the face one character before or after the current position
3532 of IT, in the visual order. BEFORE_P non-zero means get the face
3533 in front (to the left in L2R paragraphs, to the right in R2L
3534 paragraphs) of IT's screen position. Value is the ID of the face. */
3537 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3540 EMACS_INT next_check_charpos
;
3542 void *it_copy_data
= NULL
;
3544 xassert (it
->s
== NULL
);
3546 if (STRINGP (it
->string
))
3548 EMACS_INT bufpos
, charpos
;
3551 /* No face change past the end of the string (for the case
3552 we are padding with spaces). No face change before the
3554 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3555 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3560 /* Set charpos to the position before or after IT's current
3561 position, in the logical order, which in the non-bidi
3562 case is the same as the visual order. */
3564 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3565 else if (it
->what
== IT_COMPOSITION
)
3566 /* For composition, we must check the character after the
3568 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3570 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3576 /* With bidi iteration, the character before the current
3577 in the visual order cannot be found by simple
3578 iteration, because "reverse" reordering is not
3579 supported. Instead, we need to use the move_it_*
3580 family of functions. */
3581 /* Ignore face changes before the first visible
3582 character on this display line. */
3583 if (it
->current_x
<= it
->first_visible_x
)
3585 SAVE_IT (it_copy
, *it
, it_copy_data
);
3586 /* Implementation note: Since move_it_in_display_line
3587 works in the iterator geometry, and thinks the first
3588 character is always the leftmost, even in R2L lines,
3589 we don't need to distinguish between the R2L and L2R
3591 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3592 it_copy
.current_x
- 1, MOVE_TO_X
);
3593 charpos
= IT_STRING_CHARPOS (it_copy
);
3594 RESTORE_IT (it
, it
, it_copy_data
);
3598 /* Set charpos to the string position of the character
3599 that comes after IT's current position in the visual
3601 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3605 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3607 charpos
= it_copy
.bidi_it
.charpos
;
3610 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3612 if (it
->current
.overlay_string_index
>= 0)
3613 bufpos
= IT_CHARPOS (*it
);
3617 base_face_id
= underlying_face_id (it
);
3619 /* Get the face for ASCII, or unibyte. */
3620 face_id
= face_at_string_position (it
->w
,
3624 it
->region_beg_charpos
,
3625 it
->region_end_charpos
,
3626 &next_check_charpos
,
3629 /* Correct the face for charsets different from ASCII. Do it
3630 for the multibyte case only. The face returned above is
3631 suitable for unibyte text if IT->string is unibyte. */
3632 if (STRING_MULTIBYTE (it
->string
))
3634 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3635 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3637 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3639 c
= string_char_and_length (p
, &len
);
3640 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3645 struct text_pos pos
;
3647 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3648 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3651 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3652 pos
= it
->current
.pos
;
3657 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3660 if (it
->what
== IT_COMPOSITION
)
3662 /* For composition, we must check the position after
3664 pos
.charpos
+= it
->cmp_it
.nchars
;
3665 pos
.bytepos
+= it
->len
;
3668 INC_TEXT_POS (pos
, it
->multibyte_p
);
3675 /* With bidi iteration, the character before the current
3676 in the visual order cannot be found by simple
3677 iteration, because "reverse" reordering is not
3678 supported. Instead, we need to use the move_it_*
3679 family of functions. */
3680 /* Ignore face changes before the first visible
3681 character on this display line. */
3682 if (it
->current_x
<= it
->first_visible_x
)
3684 SAVE_IT (it_copy
, *it
, it_copy_data
);
3685 /* Implementation note: Since move_it_in_display_line
3686 works in the iterator geometry, and thinks the first
3687 character is always the leftmost, even in R2L lines,
3688 we don't need to distinguish between the R2L and L2R
3690 move_it_in_display_line (&it_copy
, ZV
,
3691 it_copy
.current_x
- 1, MOVE_TO_X
);
3692 pos
= it_copy
.current
.pos
;
3693 RESTORE_IT (it
, it
, it_copy_data
);
3697 /* Set charpos to the buffer position of the character
3698 that comes after IT's current position in the visual
3700 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3704 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3707 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3710 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3712 /* Determine face for CHARSET_ASCII, or unibyte. */
3713 face_id
= face_at_buffer_position (it
->w
,
3715 it
->region_beg_charpos
,
3716 it
->region_end_charpos
,
3717 &next_check_charpos
,
3720 /* Correct the face for charsets different from ASCII. Do it
3721 for the multibyte case only. The face returned above is
3722 suitable for unibyte text if current_buffer is unibyte. */
3723 if (it
->multibyte_p
)
3725 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3726 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3727 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3736 /***********************************************************************
3738 ***********************************************************************/
3740 /* Set up iterator IT from invisible properties at its current
3741 position. Called from handle_stop. */
3743 static enum prop_handled
3744 handle_invisible_prop (struct it
*it
)
3746 enum prop_handled handled
= HANDLED_NORMALLY
;
3748 if (STRINGP (it
->string
))
3750 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3752 /* Get the value of the invisible text property at the
3753 current position. Value will be nil if there is no such
3755 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3756 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3759 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3763 handled
= HANDLED_RECOMPUTE_PROPS
;
3765 /* Get the position at which the next change of the
3766 invisible text property can be found in IT->string.
3767 Value will be nil if the property value is the same for
3768 all the rest of IT->string. */
3769 XSETINT (limit
, SCHARS (it
->string
));
3770 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3773 /* Text at current position is invisible. The next
3774 change in the property is at position end_charpos.
3775 Move IT's current position to that position. */
3776 if (INTEGERP (end_charpos
)
3777 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3779 struct text_pos old
;
3782 old
= it
->current
.string_pos
;
3783 oldpos
= CHARPOS (old
);
3786 if (it
->bidi_it
.first_elt
3787 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3788 bidi_paragraph_init (it
->paragraph_embedding
,
3790 /* Bidi-iterate out of the invisible text. */
3793 bidi_move_to_visually_next (&it
->bidi_it
);
3795 while (oldpos
<= it
->bidi_it
.charpos
3796 && it
->bidi_it
.charpos
< endpos
);
3798 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3799 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3800 if (IT_CHARPOS (*it
) >= endpos
)
3801 it
->prev_stop
= endpos
;
3805 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3806 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3811 /* The rest of the string is invisible. If this is an
3812 overlay string, proceed with the next overlay string
3813 or whatever comes and return a character from there. */
3814 if (it
->current
.overlay_string_index
>= 0)
3816 next_overlay_string (it
);
3817 /* Don't check for overlay strings when we just
3818 finished processing them. */
3819 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3823 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3824 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3832 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3833 Lisp_Object pos
, prop
, overlay
;
3835 /* First of all, is there invisible text at this position? */
3836 tem
= start_charpos
= IT_CHARPOS (*it
);
3837 pos
= make_number (tem
);
3838 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3840 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3842 /* If we are on invisible text, skip over it. */
3843 if (invis_p
&& start_charpos
< it
->end_charpos
)
3845 /* Record whether we have to display an ellipsis for the
3847 int display_ellipsis_p
= invis_p
== 2;
3849 handled
= HANDLED_RECOMPUTE_PROPS
;
3851 /* Loop skipping over invisible text. The loop is left at
3852 ZV or with IT on the first char being visible again. */
3855 /* Try to skip some invisible text. Return value is the
3856 position reached which can be equal to where we start
3857 if there is nothing invisible there. This skips both
3858 over invisible text properties and overlays with
3859 invisible property. */
3860 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3862 /* If we skipped nothing at all we weren't at invisible
3863 text in the first place. If everything to the end of
3864 the buffer was skipped, end the loop. */
3865 if (newpos
== tem
|| newpos
>= ZV
)
3869 /* We skipped some characters but not necessarily
3870 all there are. Check if we ended up on visible
3871 text. Fget_char_property returns the property of
3872 the char before the given position, i.e. if we
3873 get invis_p = 0, this means that the char at
3874 newpos is visible. */
3875 pos
= make_number (newpos
);
3876 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3877 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3880 /* If we ended up on invisible text, proceed to
3881 skip starting with next_stop. */
3885 /* If there are adjacent invisible texts, don't lose the
3886 second one's ellipsis. */
3888 display_ellipsis_p
= 1;
3892 /* The position newpos is now either ZV or on visible text. */
3893 if (it
->bidi_p
&& newpos
< ZV
)
3895 /* With bidi iteration, the region of invisible text
3896 could start and/or end in the middle of a non-base
3897 embedding level. Therefore, we need to skip
3898 invisible text using the bidi iterator, starting at
3899 IT's current position, until we find ourselves
3900 outside the invisible text. Skipping invisible text
3901 _after_ bidi iteration avoids affecting the visual
3902 order of the displayed text when invisible properties
3903 are added or removed. */
3904 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3906 /* If we were `reseat'ed to a new paragraph,
3907 determine the paragraph base direction. We need
3908 to do it now because next_element_from_buffer may
3909 not have a chance to do it, if we are going to
3910 skip any text at the beginning, which resets the
3912 bidi_paragraph_init (it
->paragraph_embedding
,
3917 bidi_move_to_visually_next (&it
->bidi_it
);
3919 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3920 && it
->bidi_it
.charpos
< newpos
);
3921 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3922 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3923 /* If we overstepped NEWPOS, record its position in the
3924 iterator, so that we skip invisible text if later the
3925 bidi iteration lands us in the invisible region
3927 if (IT_CHARPOS (*it
) >= newpos
)
3928 it
->prev_stop
= newpos
;
3932 IT_CHARPOS (*it
) = newpos
;
3933 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3936 /* If there are before-strings at the start of invisible
3937 text, and the text is invisible because of a text
3938 property, arrange to show before-strings because 20.x did
3939 it that way. (If the text is invisible because of an
3940 overlay property instead of a text property, this is
3941 already handled in the overlay code.) */
3943 && get_overlay_strings (it
, it
->stop_charpos
))
3945 handled
= HANDLED_RECOMPUTE_PROPS
;
3946 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3948 else if (display_ellipsis_p
)
3950 /* Make sure that the glyphs of the ellipsis will get
3951 correct `charpos' values. If we would not update
3952 it->position here, the glyphs would belong to the
3953 last visible character _before_ the invisible
3954 text, which confuses `set_cursor_from_row'.
3956 We use the last invisible position instead of the
3957 first because this way the cursor is always drawn on
3958 the first "." of the ellipsis, whenever PT is inside
3959 the invisible text. Otherwise the cursor would be
3960 placed _after_ the ellipsis when the point is after the
3961 first invisible character. */
3962 if (!STRINGP (it
->object
))
3964 it
->position
.charpos
= newpos
- 1;
3965 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3968 /* Let the ellipsis display before
3969 considering any properties of the following char.
3970 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3971 handled
= HANDLED_RETURN
;
3980 /* Make iterator IT return `...' next.
3981 Replaces LEN characters from buffer. */
3984 setup_for_ellipsis (struct it
*it
, int len
)
3986 /* Use the display table definition for `...'. Invalid glyphs
3987 will be handled by the method returning elements from dpvec. */
3988 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3990 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3991 it
->dpvec
= v
->contents
;
3992 it
->dpend
= v
->contents
+ v
->header
.size
;
3996 /* Default `...'. */
3997 it
->dpvec
= default_invis_vector
;
3998 it
->dpend
= default_invis_vector
+ 3;
4001 it
->dpvec_char_len
= len
;
4002 it
->current
.dpvec_index
= 0;
4003 it
->dpvec_face_id
= -1;
4005 /* Remember the current face id in case glyphs specify faces.
4006 IT's face is restored in set_iterator_to_next.
4007 saved_face_id was set to preceding char's face in handle_stop. */
4008 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4009 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4011 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4017 /***********************************************************************
4019 ***********************************************************************/
4021 /* Set up iterator IT from `display' property at its current position.
4022 Called from handle_stop.
4023 We return HANDLED_RETURN if some part of the display property
4024 overrides the display of the buffer text itself.
4025 Otherwise we return HANDLED_NORMALLY. */
4027 static enum prop_handled
4028 handle_display_prop (struct it
*it
)
4030 Lisp_Object propval
, object
, overlay
;
4031 struct text_pos
*position
;
4033 /* Nonzero if some property replaces the display of the text itself. */
4034 int display_replaced_p
= 0;
4036 if (STRINGP (it
->string
))
4038 object
= it
->string
;
4039 position
= &it
->current
.string_pos
;
4040 bufpos
= CHARPOS (it
->current
.pos
);
4044 XSETWINDOW (object
, it
->w
);
4045 position
= &it
->current
.pos
;
4046 bufpos
= CHARPOS (*position
);
4049 /* Reset those iterator values set from display property values. */
4050 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4051 it
->space_width
= Qnil
;
4052 it
->font_height
= Qnil
;
4055 /* We don't support recursive `display' properties, i.e. string
4056 values that have a string `display' property, that have a string
4057 `display' property etc. */
4058 if (!it
->string_from_display_prop_p
)
4059 it
->area
= TEXT_AREA
;
4061 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4062 Qdisplay
, object
, &overlay
);
4064 return HANDLED_NORMALLY
;
4065 /* Now OVERLAY is the overlay that gave us this property, or nil
4066 if it was a text property. */
4068 if (!STRINGP (it
->string
))
4069 object
= it
->w
->buffer
;
4071 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4073 FRAME_WINDOW_P (it
->f
));
4075 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4078 /* Subroutine of handle_display_prop. Returns non-zero if the display
4079 specification in SPEC is a replacing specification, i.e. it would
4080 replace the text covered by `display' property with something else,
4081 such as an image or a display string.
4083 See handle_single_display_spec for documentation of arguments.
4084 frame_window_p is non-zero if the window being redisplayed is on a
4085 GUI frame; this argument is used only if IT is NULL, see below.
4087 IT can be NULL, if this is called by the bidi reordering code
4088 through compute_display_string_pos, which see. In that case, this
4089 function only examines SPEC, but does not otherwise "handle" it, in
4090 the sense that it doesn't set up members of IT from the display
4093 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4094 Lisp_Object overlay
, struct text_pos
*position
,
4095 EMACS_INT bufpos
, int frame_window_p
)
4097 int replacing_p
= 0;
4100 /* Simple specerties. */
4101 && !EQ (XCAR (spec
), Qimage
)
4102 && !EQ (XCAR (spec
), Qspace
)
4103 && !EQ (XCAR (spec
), Qwhen
)
4104 && !EQ (XCAR (spec
), Qslice
)
4105 && !EQ (XCAR (spec
), Qspace_width
)
4106 && !EQ (XCAR (spec
), Qheight
)
4107 && !EQ (XCAR (spec
), Qraise
)
4108 /* Marginal area specifications. */
4109 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4110 && !EQ (XCAR (spec
), Qleft_fringe
)
4111 && !EQ (XCAR (spec
), Qright_fringe
)
4112 && !NILP (XCAR (spec
)))
4114 for (; CONSP (spec
); spec
= XCDR (spec
))
4116 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4117 position
, bufpos
, replacing_p
,
4121 /* If some text in a string is replaced, `position' no
4122 longer points to the position of `object'. */
4123 if (!it
|| STRINGP (object
))
4128 else if (VECTORP (spec
))
4131 for (i
= 0; i
< ASIZE (spec
); ++i
)
4132 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4133 position
, bufpos
, replacing_p
,
4137 /* If some text in a string is replaced, `position' no
4138 longer points to the position of `object'. */
4139 if (!it
|| STRINGP (object
))
4145 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4146 position
, bufpos
, 0, frame_window_p
))
4153 /* Value is the position of the end of the `display' property starting
4154 at START_POS in OBJECT. */
4156 static struct text_pos
4157 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4160 struct text_pos end_pos
;
4162 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4163 Qdisplay
, object
, Qnil
);
4164 CHARPOS (end_pos
) = XFASTINT (end
);
4165 if (STRINGP (object
))
4166 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4168 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4174 /* Set up IT from a single `display' property specification SPEC. OBJECT
4175 is the object in which the `display' property was found. *POSITION
4176 is the position in OBJECT at which the `display' property was found.
4177 BUFPOS is the buffer position of OBJECT (different from POSITION if
4178 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4179 previously saw a display specification which already replaced text
4180 display with something else, for example an image; we ignore such
4181 properties after the first one has been processed.
4183 OVERLAY is the overlay this `display' property came from,
4184 or nil if it was a text property.
4186 If SPEC is a `space' or `image' specification, and in some other
4187 cases too, set *POSITION to the position where the `display'
4190 If IT is NULL, only examine the property specification in SPEC, but
4191 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4192 is intended to be displayed in a window on a GUI frame.
4194 Value is non-zero if something was found which replaces the display
4195 of buffer or string text. */
4198 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4199 Lisp_Object overlay
, struct text_pos
*position
,
4200 EMACS_INT bufpos
, int display_replaced_p
,
4204 Lisp_Object location
, value
;
4205 struct text_pos start_pos
= *position
;
4208 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4209 If the result is non-nil, use VALUE instead of SPEC. */
4211 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4220 if (!NILP (form
) && !EQ (form
, Qt
))
4222 int count
= SPECPDL_INDEX ();
4223 struct gcpro gcpro1
;
4225 /* Bind `object' to the object having the `display' property, a
4226 buffer or string. Bind `position' to the position in the
4227 object where the property was found, and `buffer-position'
4228 to the current position in the buffer. */
4231 XSETBUFFER (object
, current_buffer
);
4232 specbind (Qobject
, object
);
4233 specbind (Qposition
, make_number (CHARPOS (*position
)));
4234 specbind (Qbuffer_position
, make_number (bufpos
));
4236 form
= safe_eval (form
);
4238 unbind_to (count
, Qnil
);
4244 /* Handle `(height HEIGHT)' specifications. */
4246 && EQ (XCAR (spec
), Qheight
)
4247 && CONSP (XCDR (spec
)))
4251 if (!FRAME_WINDOW_P (it
->f
))
4254 it
->font_height
= XCAR (XCDR (spec
));
4255 if (!NILP (it
->font_height
))
4257 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4258 int new_height
= -1;
4260 if (CONSP (it
->font_height
)
4261 && (EQ (XCAR (it
->font_height
), Qplus
)
4262 || EQ (XCAR (it
->font_height
), Qminus
))
4263 && CONSP (XCDR (it
->font_height
))
4264 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4266 /* `(+ N)' or `(- N)' where N is an integer. */
4267 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4268 if (EQ (XCAR (it
->font_height
), Qplus
))
4270 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4272 else if (FUNCTIONP (it
->font_height
))
4274 /* Call function with current height as argument.
4275 Value is the new height. */
4277 height
= safe_call1 (it
->font_height
,
4278 face
->lface
[LFACE_HEIGHT_INDEX
]);
4279 if (NUMBERP (height
))
4280 new_height
= XFLOATINT (height
);
4282 else if (NUMBERP (it
->font_height
))
4284 /* Value is a multiple of the canonical char height. */
4287 f
= FACE_FROM_ID (it
->f
,
4288 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4289 new_height
= (XFLOATINT (it
->font_height
)
4290 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4294 /* Evaluate IT->font_height with `height' bound to the
4295 current specified height to get the new height. */
4296 int count
= SPECPDL_INDEX ();
4298 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4299 value
= safe_eval (it
->font_height
);
4300 unbind_to (count
, Qnil
);
4302 if (NUMBERP (value
))
4303 new_height
= XFLOATINT (value
);
4307 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4314 /* Handle `(space-width WIDTH)'. */
4316 && EQ (XCAR (spec
), Qspace_width
)
4317 && CONSP (XCDR (spec
)))
4321 if (!FRAME_WINDOW_P (it
->f
))
4324 value
= XCAR (XCDR (spec
));
4325 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4326 it
->space_width
= value
;
4332 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4334 && EQ (XCAR (spec
), Qslice
))
4340 if (!FRAME_WINDOW_P (it
->f
))
4343 if (tem
= XCDR (spec
), CONSP (tem
))
4345 it
->slice
.x
= XCAR (tem
);
4346 if (tem
= XCDR (tem
), CONSP (tem
))
4348 it
->slice
.y
= XCAR (tem
);
4349 if (tem
= XCDR (tem
), CONSP (tem
))
4351 it
->slice
.width
= XCAR (tem
);
4352 if (tem
= XCDR (tem
), CONSP (tem
))
4353 it
->slice
.height
= XCAR (tem
);
4362 /* Handle `(raise FACTOR)'. */
4364 && EQ (XCAR (spec
), Qraise
)
4365 && CONSP (XCDR (spec
)))
4369 if (!FRAME_WINDOW_P (it
->f
))
4372 #ifdef HAVE_WINDOW_SYSTEM
4373 value
= XCAR (XCDR (spec
));
4374 if (NUMBERP (value
))
4376 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4377 it
->voffset
= - (XFLOATINT (value
)
4378 * (FONT_HEIGHT (face
->font
)));
4380 #endif /* HAVE_WINDOW_SYSTEM */
4386 /* Don't handle the other kinds of display specifications
4387 inside a string that we got from a `display' property. */
4388 if (it
&& it
->string_from_display_prop_p
)
4391 /* Characters having this form of property are not displayed, so
4392 we have to find the end of the property. */
4395 start_pos
= *position
;
4396 *position
= display_prop_end (it
, object
, start_pos
);
4400 /* Stop the scan at that end position--we assume that all
4401 text properties change there. */
4403 it
->stop_charpos
= position
->charpos
;
4405 /* Handle `(left-fringe BITMAP [FACE])'
4406 and `(right-fringe BITMAP [FACE])'. */
4408 && (EQ (XCAR (spec
), Qleft_fringe
)
4409 || EQ (XCAR (spec
), Qright_fringe
))
4410 && CONSP (XCDR (spec
)))
4416 if (!FRAME_WINDOW_P (it
->f
))
4417 /* If we return here, POSITION has been advanced
4418 across the text with this property. */
4421 else if (!frame_window_p
)
4424 #ifdef HAVE_WINDOW_SYSTEM
4425 value
= XCAR (XCDR (spec
));
4426 if (!SYMBOLP (value
)
4427 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4428 /* If we return here, POSITION has been advanced
4429 across the text with this property. */
4434 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4436 if (CONSP (XCDR (XCDR (spec
))))
4438 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4439 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4445 /* Save current settings of IT so that we can restore them
4446 when we are finished with the glyph property value. */
4447 push_it (it
, position
);
4449 it
->area
= TEXT_AREA
;
4450 it
->what
= IT_IMAGE
;
4451 it
->image_id
= -1; /* no image */
4452 it
->position
= start_pos
;
4453 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4454 it
->method
= GET_FROM_IMAGE
;
4455 it
->from_overlay
= Qnil
;
4456 it
->face_id
= face_id
;
4457 it
->from_disp_prop_p
= 1;
4459 /* Say that we haven't consumed the characters with
4460 `display' property yet. The call to pop_it in
4461 set_iterator_to_next will clean this up. */
4462 *position
= start_pos
;
4464 if (EQ (XCAR (spec
), Qleft_fringe
))
4466 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4467 it
->left_user_fringe_face_id
= face_id
;
4471 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4472 it
->right_user_fringe_face_id
= face_id
;
4475 #endif /* HAVE_WINDOW_SYSTEM */
4479 /* Prepare to handle `((margin left-margin) ...)',
4480 `((margin right-margin) ...)' and `((margin nil) ...)'
4481 prefixes for display specifications. */
4482 location
= Qunbound
;
4483 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4487 value
= XCDR (spec
);
4489 value
= XCAR (value
);
4492 if (EQ (XCAR (tem
), Qmargin
)
4493 && (tem
= XCDR (tem
),
4494 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4496 || EQ (tem
, Qleft_margin
)
4497 || EQ (tem
, Qright_margin
))))
4501 if (EQ (location
, Qunbound
))
4507 /* After this point, VALUE is the property after any
4508 margin prefix has been stripped. It must be a string,
4509 an image specification, or `(space ...)'.
4511 LOCATION specifies where to display: `left-margin',
4512 `right-margin' or nil. */
4514 valid_p
= (STRINGP (value
)
4515 #ifdef HAVE_WINDOW_SYSTEM
4516 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4517 && valid_image_p (value
))
4518 #endif /* not HAVE_WINDOW_SYSTEM */
4519 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4521 if (valid_p
&& !display_replaced_p
)
4526 /* Save current settings of IT so that we can restore them
4527 when we are finished with the glyph property value. */
4528 push_it (it
, position
);
4529 it
->from_overlay
= overlay
;
4530 it
->from_disp_prop_p
= 1;
4532 if (NILP (location
))
4533 it
->area
= TEXT_AREA
;
4534 else if (EQ (location
, Qleft_margin
))
4535 it
->area
= LEFT_MARGIN_AREA
;
4537 it
->area
= RIGHT_MARGIN_AREA
;
4539 if (STRINGP (value
))
4542 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4543 it
->current
.overlay_string_index
= -1;
4544 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4545 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4546 it
->method
= GET_FROM_STRING
;
4547 it
->stop_charpos
= 0;
4549 it
->base_level_stop
= 0;
4550 it
->string_from_display_prop_p
= 1;
4551 /* Say that we haven't consumed the characters with
4552 `display' property yet. The call to pop_it in
4553 set_iterator_to_next will clean this up. */
4554 if (BUFFERP (object
))
4555 *position
= start_pos
;
4557 /* Force paragraph direction to be that of the parent
4558 object. If the parent object's paragraph direction is
4559 not yet determined, default to L2R. */
4560 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4561 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4563 it
->paragraph_embedding
= L2R
;
4565 /* Set up the bidi iterator for this display string. */
4568 it
->bidi_it
.string
.lstring
= it
->string
;
4569 it
->bidi_it
.string
.s
= NULL
;
4570 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4571 it
->bidi_it
.string
.bufpos
= bufpos
;
4572 it
->bidi_it
.string
.from_disp_str
= 1;
4573 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4574 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4577 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4579 it
->method
= GET_FROM_STRETCH
;
4581 *position
= it
->position
= start_pos
;
4583 #ifdef HAVE_WINDOW_SYSTEM
4586 it
->what
= IT_IMAGE
;
4587 it
->image_id
= lookup_image (it
->f
, value
);
4588 it
->position
= start_pos
;
4589 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4590 it
->method
= GET_FROM_IMAGE
;
4592 /* Say that we haven't consumed the characters with
4593 `display' property yet. The call to pop_it in
4594 set_iterator_to_next will clean this up. */
4595 *position
= start_pos
;
4597 #endif /* HAVE_WINDOW_SYSTEM */
4602 /* Invalid property or property not supported. Restore
4603 POSITION to what it was before. */
4604 *position
= start_pos
;
4608 /* Check if PROP is a display property value whose text should be
4609 treated as intangible. OVERLAY is the overlay from which PROP
4610 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4611 specify the buffer position covered by PROP. */
4614 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4615 EMACS_INT charpos
, EMACS_INT bytepos
)
4617 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4618 struct text_pos position
;
4620 SET_TEXT_POS (position
, charpos
, bytepos
);
4621 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4622 &position
, charpos
, frame_window_p
);
4626 /* Return 1 if PROP is a display sub-property value containing STRING.
4628 Implementation note: this and the following function are really
4629 special cases of handle_display_spec and
4630 handle_single_display_spec, and should ideally use the same code.
4631 Until they do, these two pairs must be consistent and must be
4632 modified in sync. */
4635 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4637 if (EQ (string
, prop
))
4640 /* Skip over `when FORM'. */
4641 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4646 /* Actually, the condition following `when' should be eval'ed,
4647 like handle_single_display_spec does, and we should return
4648 zero if it evaluates to nil. However, this function is
4649 called only when the buffer was already displayed and some
4650 glyph in the glyph matrix was found to come from a display
4651 string. Therefore, the condition was already evaluated, and
4652 the result was non-nil, otherwise the display string wouldn't
4653 have been displayed and we would have never been called for
4654 this property. Thus, we can skip the evaluation and assume
4655 its result is non-nil. */
4660 /* Skip over `margin LOCATION'. */
4661 if (EQ (XCAR (prop
), Qmargin
))
4672 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4676 /* Return 1 if STRING appears in the `display' property PROP. */
4679 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4682 && !EQ (XCAR (prop
), Qwhen
)
4683 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4685 /* A list of sub-properties. */
4686 while (CONSP (prop
))
4688 if (single_display_spec_string_p (XCAR (prop
), string
))
4693 else if (VECTORP (prop
))
4695 /* A vector of sub-properties. */
4697 for (i
= 0; i
< ASIZE (prop
); ++i
)
4698 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4702 return single_display_spec_string_p (prop
, string
);
4707 /* Look for STRING in overlays and text properties in the current
4708 buffer, between character positions FROM and TO (excluding TO).
4709 BACK_P non-zero means look back (in this case, TO is supposed to be
4711 Value is the first character position where STRING was found, or
4712 zero if it wasn't found before hitting TO.
4714 This function may only use code that doesn't eval because it is
4715 called asynchronously from note_mouse_highlight. */
4718 string_buffer_position_lim (Lisp_Object string
,
4719 EMACS_INT from
, EMACS_INT to
, int back_p
)
4721 Lisp_Object limit
, prop
, pos
;
4724 pos
= make_number (from
);
4726 if (!back_p
) /* looking forward */
4728 limit
= make_number (min (to
, ZV
));
4729 while (!found
&& !EQ (pos
, limit
))
4731 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4732 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4735 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4739 else /* looking back */
4741 limit
= make_number (max (to
, BEGV
));
4742 while (!found
&& !EQ (pos
, limit
))
4744 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4745 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4748 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4753 return found
? XINT (pos
) : 0;
4756 /* Determine which buffer position in current buffer STRING comes from.
4757 AROUND_CHARPOS is an approximate position where it could come from.
4758 Value is the buffer position or 0 if it couldn't be determined.
4760 This function is necessary because we don't record buffer positions
4761 in glyphs generated from strings (to keep struct glyph small).
4762 This function may only use code that doesn't eval because it is
4763 called asynchronously from note_mouse_highlight. */
4766 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4768 const int MAX_DISTANCE
= 1000;
4769 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4770 around_charpos
+ MAX_DISTANCE
,
4774 found
= string_buffer_position_lim (string
, around_charpos
,
4775 around_charpos
- MAX_DISTANCE
, 1);
4781 /***********************************************************************
4782 `composition' property
4783 ***********************************************************************/
4785 /* Set up iterator IT from `composition' property at its current
4786 position. Called from handle_stop. */
4788 static enum prop_handled
4789 handle_composition_prop (struct it
*it
)
4791 Lisp_Object prop
, string
;
4792 EMACS_INT pos
, pos_byte
, start
, end
;
4794 if (STRINGP (it
->string
))
4798 pos
= IT_STRING_CHARPOS (*it
);
4799 pos_byte
= IT_STRING_BYTEPOS (*it
);
4800 string
= it
->string
;
4801 s
= SDATA (string
) + pos_byte
;
4802 it
->c
= STRING_CHAR (s
);
4806 pos
= IT_CHARPOS (*it
);
4807 pos_byte
= IT_BYTEPOS (*it
);
4809 it
->c
= FETCH_CHAR (pos_byte
);
4812 /* If there's a valid composition and point is not inside of the
4813 composition (in the case that the composition is from the current
4814 buffer), draw a glyph composed from the composition components. */
4815 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4816 && COMPOSITION_VALID_P (start
, end
, prop
)
4817 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4820 /* As we can't handle this situation (perhaps font-lock added
4821 a new composition), we just return here hoping that next
4822 redisplay will detect this composition much earlier. */
4823 return HANDLED_NORMALLY
;
4826 if (STRINGP (it
->string
))
4827 pos_byte
= string_char_to_byte (it
->string
, start
);
4829 pos_byte
= CHAR_TO_BYTE (start
);
4831 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4834 if (it
->cmp_it
.id
>= 0)
4837 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4838 it
->cmp_it
.nglyphs
= -1;
4842 return HANDLED_NORMALLY
;
4847 /***********************************************************************
4849 ***********************************************************************/
4851 /* The following structure is used to record overlay strings for
4852 later sorting in load_overlay_strings. */
4854 struct overlay_entry
4856 Lisp_Object overlay
;
4863 /* Set up iterator IT from overlay strings at its current position.
4864 Called from handle_stop. */
4866 static enum prop_handled
4867 handle_overlay_change (struct it
*it
)
4869 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4870 return HANDLED_RECOMPUTE_PROPS
;
4872 return HANDLED_NORMALLY
;
4876 /* Set up the next overlay string for delivery by IT, if there is an
4877 overlay string to deliver. Called by set_iterator_to_next when the
4878 end of the current overlay string is reached. If there are more
4879 overlay strings to display, IT->string and
4880 IT->current.overlay_string_index are set appropriately here.
4881 Otherwise IT->string is set to nil. */
4884 next_overlay_string (struct it
*it
)
4886 ++it
->current
.overlay_string_index
;
4887 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4889 /* No more overlay strings. Restore IT's settings to what
4890 they were before overlay strings were processed, and
4891 continue to deliver from current_buffer. */
4893 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4896 || (NILP (it
->string
)
4897 && it
->method
== GET_FROM_BUFFER
4898 && it
->stop_charpos
>= BEGV
4899 && it
->stop_charpos
<= it
->end_charpos
));
4900 it
->current
.overlay_string_index
= -1;
4901 it
->n_overlay_strings
= 0;
4902 it
->overlay_strings_charpos
= -1;
4904 /* If we're at the end of the buffer, record that we have
4905 processed the overlay strings there already, so that
4906 next_element_from_buffer doesn't try it again. */
4907 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4908 it
->overlay_strings_at_end_processed_p
= 1;
4912 /* There are more overlay strings to process. If
4913 IT->current.overlay_string_index has advanced to a position
4914 where we must load IT->overlay_strings with more strings, do
4915 it. We must load at the IT->overlay_strings_charpos where
4916 IT->n_overlay_strings was originally computed; when invisible
4917 text is present, this might not be IT_CHARPOS (Bug#7016). */
4918 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4920 if (it
->current
.overlay_string_index
&& i
== 0)
4921 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4923 /* Initialize IT to deliver display elements from the overlay
4925 it
->string
= it
->overlay_strings
[i
];
4926 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4927 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4928 it
->method
= GET_FROM_STRING
;
4929 it
->stop_charpos
= 0;
4930 if (it
->cmp_it
.stop_pos
>= 0)
4931 it
->cmp_it
.stop_pos
= 0;
4933 it
->base_level_stop
= 0;
4935 /* Set up the bidi iterator for this overlay string. */
4938 it
->bidi_it
.string
.lstring
= it
->string
;
4939 it
->bidi_it
.string
.s
= NULL
;
4940 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4941 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4942 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4943 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4944 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4952 /* Compare two overlay_entry structures E1 and E2. Used as a
4953 comparison function for qsort in load_overlay_strings. Overlay
4954 strings for the same position are sorted so that
4956 1. All after-strings come in front of before-strings, except
4957 when they come from the same overlay.
4959 2. Within after-strings, strings are sorted so that overlay strings
4960 from overlays with higher priorities come first.
4962 2. Within before-strings, strings are sorted so that overlay
4963 strings from overlays with higher priorities come last.
4965 Value is analogous to strcmp. */
4969 compare_overlay_entries (const void *e1
, const void *e2
)
4971 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4972 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4975 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4977 /* Let after-strings appear in front of before-strings if
4978 they come from different overlays. */
4979 if (EQ (entry1
->overlay
, entry2
->overlay
))
4980 result
= entry1
->after_string_p
? 1 : -1;
4982 result
= entry1
->after_string_p
? -1 : 1;
4984 else if (entry1
->after_string_p
)
4985 /* After-strings sorted in order of decreasing priority. */
4986 result
= entry2
->priority
- entry1
->priority
;
4988 /* Before-strings sorted in order of increasing priority. */
4989 result
= entry1
->priority
- entry2
->priority
;
4995 /* Load the vector IT->overlay_strings with overlay strings from IT's
4996 current buffer position, or from CHARPOS if that is > 0. Set
4997 IT->n_overlays to the total number of overlay strings found.
4999 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5000 a time. On entry into load_overlay_strings,
5001 IT->current.overlay_string_index gives the number of overlay
5002 strings that have already been loaded by previous calls to this
5005 IT->add_overlay_start contains an additional overlay start
5006 position to consider for taking overlay strings from, if non-zero.
5007 This position comes into play when the overlay has an `invisible'
5008 property, and both before and after-strings. When we've skipped to
5009 the end of the overlay, because of its `invisible' property, we
5010 nevertheless want its before-string to appear.
5011 IT->add_overlay_start will contain the overlay start position
5014 Overlay strings are sorted so that after-string strings come in
5015 front of before-string strings. Within before and after-strings,
5016 strings are sorted by overlay priority. See also function
5017 compare_overlay_entries. */
5020 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5022 Lisp_Object overlay
, window
, str
, invisible
;
5023 struct Lisp_Overlay
*ov
;
5024 EMACS_INT start
, end
;
5026 int n
= 0, i
, j
, invis_p
;
5027 struct overlay_entry
*entries
5028 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5031 charpos
= IT_CHARPOS (*it
);
5033 /* Append the overlay string STRING of overlay OVERLAY to vector
5034 `entries' which has size `size' and currently contains `n'
5035 elements. AFTER_P non-zero means STRING is an after-string of
5037 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5040 Lisp_Object priority; \
5044 int new_size = 2 * size; \
5045 struct overlay_entry *old = entries; \
5047 (struct overlay_entry *) alloca (new_size \
5048 * sizeof *entries); \
5049 memcpy (entries, old, size * sizeof *entries); \
5053 entries[n].string = (STRING); \
5054 entries[n].overlay = (OVERLAY); \
5055 priority = Foverlay_get ((OVERLAY), Qpriority); \
5056 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5057 entries[n].after_string_p = (AFTER_P); \
5062 /* Process overlay before the overlay center. */
5063 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5065 XSETMISC (overlay
, ov
);
5066 xassert (OVERLAYP (overlay
));
5067 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5068 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5073 /* Skip this overlay if it doesn't start or end at IT's current
5075 if (end
!= charpos
&& start
!= charpos
)
5078 /* Skip this overlay if it doesn't apply to IT->w. */
5079 window
= Foverlay_get (overlay
, Qwindow
);
5080 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5083 /* If the text ``under'' the overlay is invisible, both before-
5084 and after-strings from this overlay are visible; start and
5085 end position are indistinguishable. */
5086 invisible
= Foverlay_get (overlay
, Qinvisible
);
5087 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5089 /* If overlay has a non-empty before-string, record it. */
5090 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5091 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5093 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5095 /* If overlay has a non-empty after-string, record it. */
5096 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5097 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5099 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5102 /* Process overlays after the overlay center. */
5103 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5105 XSETMISC (overlay
, ov
);
5106 xassert (OVERLAYP (overlay
));
5107 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5108 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5110 if (start
> charpos
)
5113 /* Skip this overlay if it doesn't start or end at IT's current
5115 if (end
!= charpos
&& start
!= charpos
)
5118 /* Skip this overlay if it doesn't apply to IT->w. */
5119 window
= Foverlay_get (overlay
, Qwindow
);
5120 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5123 /* If the text ``under'' the overlay is invisible, it has a zero
5124 dimension, and both before- and after-strings apply. */
5125 invisible
= Foverlay_get (overlay
, Qinvisible
);
5126 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5128 /* If overlay has a non-empty before-string, record it. */
5129 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5130 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5132 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5134 /* If overlay has a non-empty after-string, record it. */
5135 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5136 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5138 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5141 #undef RECORD_OVERLAY_STRING
5145 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5147 /* Record number of overlay strings, and where we computed it. */
5148 it
->n_overlay_strings
= n
;
5149 it
->overlay_strings_charpos
= charpos
;
5151 /* IT->current.overlay_string_index is the number of overlay strings
5152 that have already been consumed by IT. Copy some of the
5153 remaining overlay strings to IT->overlay_strings. */
5155 j
= it
->current
.overlay_string_index
;
5156 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5158 it
->overlay_strings
[i
] = entries
[j
].string
;
5159 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5166 /* Get the first chunk of overlay strings at IT's current buffer
5167 position, or at CHARPOS if that is > 0. Value is non-zero if at
5168 least one overlay string was found. */
5171 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5173 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5174 process. This fills IT->overlay_strings with strings, and sets
5175 IT->n_overlay_strings to the total number of strings to process.
5176 IT->pos.overlay_string_index has to be set temporarily to zero
5177 because load_overlay_strings needs this; it must be set to -1
5178 when no overlay strings are found because a zero value would
5179 indicate a position in the first overlay string. */
5180 it
->current
.overlay_string_index
= 0;
5181 load_overlay_strings (it
, charpos
);
5183 /* If we found overlay strings, set up IT to deliver display
5184 elements from the first one. Otherwise set up IT to deliver
5185 from current_buffer. */
5186 if (it
->n_overlay_strings
)
5188 /* Make sure we know settings in current_buffer, so that we can
5189 restore meaningful values when we're done with the overlay
5192 compute_stop_pos (it
);
5193 xassert (it
->face_id
>= 0);
5195 /* Save IT's settings. They are restored after all overlay
5196 strings have been processed. */
5197 xassert (!compute_stop_p
|| it
->sp
== 0);
5199 /* When called from handle_stop, there might be an empty display
5200 string loaded. In that case, don't bother saving it. */
5201 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5204 /* Set up IT to deliver display elements from the first overlay
5206 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5207 it
->string
= it
->overlay_strings
[0];
5208 it
->from_overlay
= Qnil
;
5209 it
->stop_charpos
= 0;
5210 xassert (STRINGP (it
->string
));
5211 it
->end_charpos
= SCHARS (it
->string
);
5213 it
->base_level_stop
= 0;
5214 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5215 it
->method
= GET_FROM_STRING
;
5216 it
->from_disp_prop_p
= 0;
5218 /* Force paragraph direction to be that of the parent
5220 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5221 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5223 it
->paragraph_embedding
= L2R
;
5225 /* Set up the bidi iterator for this overlay string. */
5228 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5230 it
->bidi_it
.string
.lstring
= it
->string
;
5231 it
->bidi_it
.string
.s
= NULL
;
5232 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5233 it
->bidi_it
.string
.bufpos
= pos
;
5234 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5235 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5236 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5241 it
->current
.overlay_string_index
= -1;
5246 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5249 it
->method
= GET_FROM_BUFFER
;
5251 (void) get_overlay_strings_1 (it
, charpos
, 1);
5255 /* Value is non-zero if we found at least one overlay string. */
5256 return STRINGP (it
->string
);
5261 /***********************************************************************
5262 Saving and restoring state
5263 ***********************************************************************/
5265 /* Save current settings of IT on IT->stack. Called, for example,
5266 before setting up IT for an overlay string, to be able to restore
5267 IT's settings to what they were after the overlay string has been
5268 processed. If POSITION is non-NULL, it is the position to save on
5269 the stack instead of IT->position. */
5272 push_it (struct it
*it
, struct text_pos
*position
)
5274 struct iterator_stack_entry
*p
;
5276 xassert (it
->sp
< IT_STACK_SIZE
);
5277 p
= it
->stack
+ it
->sp
;
5279 p
->stop_charpos
= it
->stop_charpos
;
5280 p
->prev_stop
= it
->prev_stop
;
5281 p
->base_level_stop
= it
->base_level_stop
;
5282 p
->cmp_it
= it
->cmp_it
;
5283 xassert (it
->face_id
>= 0);
5284 p
->face_id
= it
->face_id
;
5285 p
->string
= it
->string
;
5286 p
->method
= it
->method
;
5287 p
->from_overlay
= it
->from_overlay
;
5290 case GET_FROM_IMAGE
:
5291 p
->u
.image
.object
= it
->object
;
5292 p
->u
.image
.image_id
= it
->image_id
;
5293 p
->u
.image
.slice
= it
->slice
;
5295 case GET_FROM_STRETCH
:
5296 p
->u
.stretch
.object
= it
->object
;
5299 p
->position
= position
? *position
: it
->position
;
5300 p
->current
= it
->current
;
5301 p
->end_charpos
= it
->end_charpos
;
5302 p
->string_nchars
= it
->string_nchars
;
5304 p
->multibyte_p
= it
->multibyte_p
;
5305 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5306 p
->space_width
= it
->space_width
;
5307 p
->font_height
= it
->font_height
;
5308 p
->voffset
= it
->voffset
;
5309 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5310 p
->display_ellipsis_p
= 0;
5311 p
->line_wrap
= it
->line_wrap
;
5312 p
->bidi_p
= it
->bidi_p
;
5313 p
->paragraph_embedding
= it
->paragraph_embedding
;
5314 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5317 /* Save the state of the bidi iterator as well. */
5319 bidi_push_it (&it
->bidi_it
);
5323 iterate_out_of_display_property (struct it
*it
)
5325 int buffer_p
= BUFFERP (it
->object
);
5326 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5327 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5329 /* Maybe initialize paragraph direction. If we are at the beginning
5330 of a new paragraph, next_element_from_buffer may not have a
5331 chance to do that. */
5332 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5333 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5334 /* prev_stop can be zero, so check against BEGV as well. */
5335 while (it
->bidi_it
.charpos
>= bob
5336 && it
->prev_stop
<= it
->bidi_it
.charpos
5337 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5338 bidi_move_to_visually_next (&it
->bidi_it
);
5339 /* Record the stop_pos we just crossed, for when we cross it
5341 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5342 it
->prev_stop
= CHARPOS (it
->position
);
5343 /* If we ended up not where pop_it put us, resync IT's
5344 positional members with the bidi iterator. */
5345 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5347 SET_TEXT_POS (it
->position
,
5348 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5350 it
->current
.pos
= it
->position
;
5352 it
->current
.string_pos
= it
->position
;
5356 /* Restore IT's settings from IT->stack. Called, for example, when no
5357 more overlay strings must be processed, and we return to delivering
5358 display elements from a buffer, or when the end of a string from a
5359 `display' property is reached and we return to delivering display
5360 elements from an overlay string, or from a buffer. */
5363 pop_it (struct it
*it
)
5365 struct iterator_stack_entry
*p
;
5366 int from_display_prop
= it
->from_disp_prop_p
;
5368 xassert (it
->sp
> 0);
5370 p
= it
->stack
+ it
->sp
;
5371 it
->stop_charpos
= p
->stop_charpos
;
5372 it
->prev_stop
= p
->prev_stop
;
5373 it
->base_level_stop
= p
->base_level_stop
;
5374 it
->cmp_it
= p
->cmp_it
;
5375 it
->face_id
= p
->face_id
;
5376 it
->current
= p
->current
;
5377 it
->position
= p
->position
;
5378 it
->string
= p
->string
;
5379 it
->from_overlay
= p
->from_overlay
;
5380 if (NILP (it
->string
))
5381 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5382 it
->method
= p
->method
;
5385 case GET_FROM_IMAGE
:
5386 it
->image_id
= p
->u
.image
.image_id
;
5387 it
->object
= p
->u
.image
.object
;
5388 it
->slice
= p
->u
.image
.slice
;
5390 case GET_FROM_STRETCH
:
5391 it
->object
= p
->u
.stretch
.object
;
5393 case GET_FROM_BUFFER
:
5394 it
->object
= it
->w
->buffer
;
5396 case GET_FROM_STRING
:
5397 it
->object
= it
->string
;
5399 case GET_FROM_DISPLAY_VECTOR
:
5401 it
->method
= GET_FROM_C_STRING
;
5402 else if (STRINGP (it
->string
))
5403 it
->method
= GET_FROM_STRING
;
5406 it
->method
= GET_FROM_BUFFER
;
5407 it
->object
= it
->w
->buffer
;
5410 it
->end_charpos
= p
->end_charpos
;
5411 it
->string_nchars
= p
->string_nchars
;
5413 it
->multibyte_p
= p
->multibyte_p
;
5414 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5415 it
->space_width
= p
->space_width
;
5416 it
->font_height
= p
->font_height
;
5417 it
->voffset
= p
->voffset
;
5418 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5419 it
->line_wrap
= p
->line_wrap
;
5420 it
->bidi_p
= p
->bidi_p
;
5421 it
->paragraph_embedding
= p
->paragraph_embedding
;
5422 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5425 bidi_pop_it (&it
->bidi_it
);
5426 /* Bidi-iterate until we get out of the portion of text, if any,
5427 covered by a `display' text property or by an overlay with
5428 `display' property. (We cannot just jump there, because the
5429 internal coherency of the bidi iterator state can not be
5430 preserved across such jumps.) We also must determine the
5431 paragraph base direction if the overlay we just processed is
5432 at the beginning of a new paragraph. */
5433 if (from_display_prop
5434 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5435 iterate_out_of_display_property (it
);
5437 xassert ((BUFFERP (it
->object
)
5438 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5439 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5440 || (STRINGP (it
->object
)
5441 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5442 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5448 /***********************************************************************
5450 ***********************************************************************/
5452 /* Set IT's current position to the previous line start. */
5455 back_to_previous_line_start (struct it
*it
)
5457 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5458 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5462 /* Move IT to the next line start.
5464 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5465 we skipped over part of the text (as opposed to moving the iterator
5466 continuously over the text). Otherwise, don't change the value
5469 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5470 iterator on the newline, if it was found.
5472 Newlines may come from buffer text, overlay strings, or strings
5473 displayed via the `display' property. That's the reason we can't
5474 simply use find_next_newline_no_quit.
5476 Note that this function may not skip over invisible text that is so
5477 because of text properties and immediately follows a newline. If
5478 it would, function reseat_at_next_visible_line_start, when called
5479 from set_iterator_to_next, would effectively make invisible
5480 characters following a newline part of the wrong glyph row, which
5481 leads to wrong cursor motion. */
5484 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5485 struct bidi_it
*bidi_it_prev
)
5487 EMACS_INT old_selective
;
5488 int newline_found_p
, n
;
5489 const int MAX_NEWLINE_DISTANCE
= 500;
5491 /* If already on a newline, just consume it to avoid unintended
5492 skipping over invisible text below. */
5493 if (it
->what
== IT_CHARACTER
5495 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5497 if (it
->bidi_p
&& bidi_it_prev
)
5498 *bidi_it_prev
= it
->bidi_it
;
5499 set_iterator_to_next (it
, 0);
5504 /* Don't handle selective display in the following. It's (a)
5505 unnecessary because it's done by the caller, and (b) leads to an
5506 infinite recursion because next_element_from_ellipsis indirectly
5507 calls this function. */
5508 old_selective
= it
->selective
;
5511 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5512 from buffer text. */
5513 for (n
= newline_found_p
= 0;
5514 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5515 n
+= STRINGP (it
->string
) ? 0 : 1)
5517 if (!get_next_display_element (it
))
5519 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5520 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5521 *bidi_it_prev
= it
->bidi_it
;
5522 set_iterator_to_next (it
, 0);
5525 /* If we didn't find a newline near enough, see if we can use a
5527 if (!newline_found_p
)
5529 EMACS_INT start
= IT_CHARPOS (*it
);
5530 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5533 xassert (!STRINGP (it
->string
));
5535 /* If we are not bidi-reordering, and there isn't any `display'
5536 property in sight, and no overlays, we can just use the
5537 position of the newline in buffer text. */
5539 && (it
->stop_charpos
>= limit
5540 || ((pos
= Fnext_single_property_change (make_number (start
),
5542 make_number (limit
)),
5544 && next_overlay_change (start
) == ZV
)))
5546 IT_CHARPOS (*it
) = limit
;
5547 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5548 *skipped_p
= newline_found_p
= 1;
5552 while (get_next_display_element (it
)
5553 && !newline_found_p
)
5555 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5556 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5557 *bidi_it_prev
= it
->bidi_it
;
5558 set_iterator_to_next (it
, 0);
5563 it
->selective
= old_selective
;
5564 return newline_found_p
;
5568 /* Set IT's current position to the previous visible line start. Skip
5569 invisible text that is so either due to text properties or due to
5570 selective display. Caution: this does not change IT->current_x and
5574 back_to_previous_visible_line_start (struct it
*it
)
5576 while (IT_CHARPOS (*it
) > BEGV
)
5578 back_to_previous_line_start (it
);
5580 if (IT_CHARPOS (*it
) <= BEGV
)
5583 /* If selective > 0, then lines indented more than its value are
5585 if (it
->selective
> 0
5586 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5590 /* Check the newline before point for invisibility. */
5593 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5594 Qinvisible
, it
->window
);
5595 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5599 if (IT_CHARPOS (*it
) <= BEGV
)
5604 void *it2data
= NULL
;
5607 Lisp_Object val
, overlay
;
5609 SAVE_IT (it2
, *it
, it2data
);
5611 /* If newline is part of a composition, continue from start of composition */
5612 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5613 && beg
< IT_CHARPOS (*it
))
5616 /* If newline is replaced by a display property, find start of overlay
5617 or interval and continue search from that point. */
5618 pos
= --IT_CHARPOS (it2
);
5621 bidi_unshelve_cache (NULL
, 0);
5622 it2
.string_from_display_prop_p
= 0;
5623 it2
.from_disp_prop_p
= 0;
5624 if (handle_display_prop (&it2
) == HANDLED_RETURN
5625 && !NILP (val
= get_char_property_and_overlay
5626 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5627 && (OVERLAYP (overlay
)
5628 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5629 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5631 RESTORE_IT (it
, it
, it2data
);
5635 /* Newline is not replaced by anything -- so we are done. */
5636 RESTORE_IT (it
, it
, it2data
);
5642 IT_CHARPOS (*it
) = beg
;
5643 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5647 it
->continuation_lines_width
= 0;
5649 xassert (IT_CHARPOS (*it
) >= BEGV
);
5650 xassert (IT_CHARPOS (*it
) == BEGV
5651 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5656 /* Reseat iterator IT at the previous visible line start. Skip
5657 invisible text that is so either due to text properties or due to
5658 selective display. At the end, update IT's overlay information,
5659 face information etc. */
5662 reseat_at_previous_visible_line_start (struct it
*it
)
5664 back_to_previous_visible_line_start (it
);
5665 reseat (it
, it
->current
.pos
, 1);
5670 /* Reseat iterator IT on the next visible line start in the current
5671 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5672 preceding the line start. Skip over invisible text that is so
5673 because of selective display. Compute faces, overlays etc at the
5674 new position. Note that this function does not skip over text that
5675 is invisible because of text properties. */
5678 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5680 int newline_found_p
, skipped_p
= 0;
5681 struct bidi_it bidi_it_prev
;
5683 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5685 /* Skip over lines that are invisible because they are indented
5686 more than the value of IT->selective. */
5687 if (it
->selective
> 0)
5688 while (IT_CHARPOS (*it
) < ZV
5689 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5692 xassert (IT_BYTEPOS (*it
) == BEGV
5693 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5695 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5698 /* Position on the newline if that's what's requested. */
5699 if (on_newline_p
&& newline_found_p
)
5701 if (STRINGP (it
->string
))
5703 if (IT_STRING_CHARPOS (*it
) > 0)
5707 --IT_STRING_CHARPOS (*it
);
5708 --IT_STRING_BYTEPOS (*it
);
5712 /* We need to restore the bidi iterator to the state
5713 it had on the newline, and resync the IT's
5714 position with that. */
5715 it
->bidi_it
= bidi_it_prev
;
5716 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5717 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5721 else if (IT_CHARPOS (*it
) > BEGV
)
5730 /* We need to restore the bidi iterator to the state it
5731 had on the newline and resync IT with that. */
5732 it
->bidi_it
= bidi_it_prev
;
5733 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5734 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5736 reseat (it
, it
->current
.pos
, 0);
5740 reseat (it
, it
->current
.pos
, 0);
5747 /***********************************************************************
5748 Changing an iterator's position
5749 ***********************************************************************/
5751 /* Change IT's current position to POS in current_buffer. If FORCE_P
5752 is non-zero, always check for text properties at the new position.
5753 Otherwise, text properties are only looked up if POS >=
5754 IT->check_charpos of a property. */
5757 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5759 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5761 reseat_1 (it
, pos
, 0);
5763 /* Determine where to check text properties. Avoid doing it
5764 where possible because text property lookup is very expensive. */
5766 || CHARPOS (pos
) > it
->stop_charpos
5767 || CHARPOS (pos
) < original_pos
)
5771 /* For bidi iteration, we need to prime prev_stop and
5772 base_level_stop with our best estimations. */
5773 /* Implementation note: Of course, POS is not necessarily a
5774 stop position, so assigning prev_pos to it is a lie; we
5775 should have called compute_stop_backwards. However, if
5776 the current buffer does not include any R2L characters,
5777 that call would be a waste of cycles, because the
5778 iterator will never move back, and thus never cross this
5779 "fake" stop position. So we delay that backward search
5780 until the time we really need it, in next_element_from_buffer. */
5781 if (CHARPOS (pos
) != it
->prev_stop
)
5782 it
->prev_stop
= CHARPOS (pos
);
5783 if (CHARPOS (pos
) < it
->base_level_stop
)
5784 it
->base_level_stop
= 0; /* meaning it's unknown */
5790 it
->prev_stop
= it
->base_level_stop
= 0;
5799 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5800 IT->stop_pos to POS, also. */
5803 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5805 /* Don't call this function when scanning a C string. */
5806 xassert (it
->s
== NULL
);
5808 /* POS must be a reasonable value. */
5809 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5811 it
->current
.pos
= it
->position
= pos
;
5812 it
->end_charpos
= ZV
;
5814 it
->current
.dpvec_index
= -1;
5815 it
->current
.overlay_string_index
= -1;
5816 IT_STRING_CHARPOS (*it
) = -1;
5817 IT_STRING_BYTEPOS (*it
) = -1;
5819 it
->method
= GET_FROM_BUFFER
;
5820 it
->object
= it
->w
->buffer
;
5821 it
->area
= TEXT_AREA
;
5822 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5824 it
->string_from_display_prop_p
= 0;
5825 it
->from_disp_prop_p
= 0;
5826 it
->face_before_selective_p
= 0;
5829 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5831 bidi_unshelve_cache (NULL
, 0);
5832 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5833 it
->bidi_it
.string
.s
= NULL
;
5834 it
->bidi_it
.string
.lstring
= Qnil
;
5835 it
->bidi_it
.string
.bufpos
= 0;
5836 it
->bidi_it
.string
.unibyte
= 0;
5841 it
->stop_charpos
= CHARPOS (pos
);
5842 it
->base_level_stop
= CHARPOS (pos
);
5847 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5848 If S is non-null, it is a C string to iterate over. Otherwise,
5849 STRING gives a Lisp string to iterate over.
5851 If PRECISION > 0, don't return more then PRECISION number of
5852 characters from the string.
5854 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5855 characters have been returned. FIELD_WIDTH < 0 means an infinite
5858 MULTIBYTE = 0 means disable processing of multibyte characters,
5859 MULTIBYTE > 0 means enable it,
5860 MULTIBYTE < 0 means use IT->multibyte_p.
5862 IT must be initialized via a prior call to init_iterator before
5863 calling this function. */
5866 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5867 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5870 /* No region in strings. */
5871 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5873 /* No text property checks performed by default, but see below. */
5874 it
->stop_charpos
= -1;
5876 /* Set iterator position and end position. */
5877 memset (&it
->current
, 0, sizeof it
->current
);
5878 it
->current
.overlay_string_index
= -1;
5879 it
->current
.dpvec_index
= -1;
5880 xassert (charpos
>= 0);
5882 /* If STRING is specified, use its multibyteness, otherwise use the
5883 setting of MULTIBYTE, if specified. */
5885 it
->multibyte_p
= multibyte
> 0;
5887 /* Bidirectional reordering of strings is controlled by the default
5888 value of bidi-display-reordering. */
5889 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5893 xassert (STRINGP (string
));
5894 it
->string
= string
;
5896 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5897 it
->method
= GET_FROM_STRING
;
5898 it
->current
.string_pos
= string_pos (charpos
, string
);
5902 it
->bidi_it
.string
.lstring
= string
;
5903 it
->bidi_it
.string
.s
= NULL
;
5904 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5905 it
->bidi_it
.string
.bufpos
= 0;
5906 it
->bidi_it
.string
.from_disp_str
= 0;
5907 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5908 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5909 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5914 it
->s
= (const unsigned char *) s
;
5917 /* Note that we use IT->current.pos, not it->current.string_pos,
5918 for displaying C strings. */
5919 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5920 if (it
->multibyte_p
)
5922 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5923 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5927 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5928 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5933 it
->bidi_it
.string
.lstring
= Qnil
;
5934 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5935 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5936 it
->bidi_it
.string
.bufpos
= 0;
5937 it
->bidi_it
.string
.from_disp_str
= 0;
5938 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5939 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5942 it
->method
= GET_FROM_C_STRING
;
5945 /* PRECISION > 0 means don't return more than PRECISION characters
5947 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5949 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5951 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5954 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5955 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5956 FIELD_WIDTH < 0 means infinite field width. This is useful for
5957 padding with `-' at the end of a mode line. */
5958 if (field_width
< 0)
5959 field_width
= INFINITY
;
5960 /* Implementation note: We deliberately don't enlarge
5961 it->bidi_it.string.schars here to fit it->end_charpos, because
5962 the bidi iterator cannot produce characters out of thin air. */
5963 if (field_width
> it
->end_charpos
- charpos
)
5964 it
->end_charpos
= charpos
+ field_width
;
5966 /* Use the standard display table for displaying strings. */
5967 if (DISP_TABLE_P (Vstandard_display_table
))
5968 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5970 it
->stop_charpos
= charpos
;
5971 it
->prev_stop
= charpos
;
5972 it
->base_level_stop
= 0;
5975 it
->bidi_it
.first_elt
= 1;
5976 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5977 it
->bidi_it
.disp_pos
= -1;
5979 if (s
== NULL
&& it
->multibyte_p
)
5981 EMACS_INT endpos
= SCHARS (it
->string
);
5982 if (endpos
> it
->end_charpos
)
5983 endpos
= it
->end_charpos
;
5984 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5992 /***********************************************************************
5994 ***********************************************************************/
5996 /* Map enum it_method value to corresponding next_element_from_* function. */
5998 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6000 next_element_from_buffer
,
6001 next_element_from_display_vector
,
6002 next_element_from_string
,
6003 next_element_from_c_string
,
6004 next_element_from_image
,
6005 next_element_from_stretch
6008 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6011 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6012 (possibly with the following characters). */
6014 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6015 ((IT)->cmp_it.id >= 0 \
6016 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6017 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6018 END_CHARPOS, (IT)->w, \
6019 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6023 /* Lookup the char-table Vglyphless_char_display for character C (-1
6024 if we want information for no-font case), and return the display
6025 method symbol. By side-effect, update it->what and
6026 it->glyphless_method. This function is called from
6027 get_next_display_element for each character element, and from
6028 x_produce_glyphs when no suitable font was found. */
6031 lookup_glyphless_char_display (int c
, struct it
*it
)
6033 Lisp_Object glyphless_method
= Qnil
;
6035 if (CHAR_TABLE_P (Vglyphless_char_display
)
6036 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6040 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6041 if (CONSP (glyphless_method
))
6042 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6043 ? XCAR (glyphless_method
)
6044 : XCDR (glyphless_method
);
6047 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6051 if (NILP (glyphless_method
))
6054 /* The default is to display the character by a proper font. */
6056 /* The default for the no-font case is to display an empty box. */
6057 glyphless_method
= Qempty_box
;
6059 if (EQ (glyphless_method
, Qzero_width
))
6062 return glyphless_method
;
6063 /* This method can't be used for the no-font case. */
6064 glyphless_method
= Qempty_box
;
6066 if (EQ (glyphless_method
, Qthin_space
))
6067 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6068 else if (EQ (glyphless_method
, Qempty_box
))
6069 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6070 else if (EQ (glyphless_method
, Qhex_code
))
6071 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6072 else if (STRINGP (glyphless_method
))
6073 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6076 /* Invalid value. We use the default method. */
6077 glyphless_method
= Qnil
;
6080 it
->what
= IT_GLYPHLESS
;
6081 return glyphless_method
;
6084 /* Load IT's display element fields with information about the next
6085 display element from the current position of IT. Value is zero if
6086 end of buffer (or C string) is reached. */
6088 static struct frame
*last_escape_glyph_frame
= NULL
;
6089 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6090 static int last_escape_glyph_merged_face_id
= 0;
6092 struct frame
*last_glyphless_glyph_frame
= NULL
;
6093 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6094 int last_glyphless_glyph_merged_face_id
= 0;
6097 get_next_display_element (struct it
*it
)
6099 /* Non-zero means that we found a display element. Zero means that
6100 we hit the end of what we iterate over. Performance note: the
6101 function pointer `method' used here turns out to be faster than
6102 using a sequence of if-statements. */
6106 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6108 if (it
->what
== IT_CHARACTER
)
6110 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6111 and only if (a) the resolved directionality of that character
6113 /* FIXME: Do we need an exception for characters from display
6115 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6116 it
->c
= bidi_mirror_char (it
->c
);
6117 /* Map via display table or translate control characters.
6118 IT->c, IT->len etc. have been set to the next character by
6119 the function call above. If we have a display table, and it
6120 contains an entry for IT->c, translate it. Don't do this if
6121 IT->c itself comes from a display table, otherwise we could
6122 end up in an infinite recursion. (An alternative could be to
6123 count the recursion depth of this function and signal an
6124 error when a certain maximum depth is reached.) Is it worth
6126 if (success_p
&& it
->dpvec
== NULL
)
6129 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6130 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6131 nbsp_or_shy
= char_is_other
;
6132 int c
= it
->c
; /* This is the character to display. */
6134 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6136 xassert (SINGLE_BYTE_CHAR_P (c
));
6137 if (unibyte_display_via_language_environment
)
6139 c
= DECODE_CHAR (unibyte
, c
);
6141 c
= BYTE8_TO_CHAR (it
->c
);
6144 c
= BYTE8_TO_CHAR (it
->c
);
6148 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6151 struct Lisp_Vector
*v
= XVECTOR (dv
);
6153 /* Return the first character from the display table
6154 entry, if not empty. If empty, don't display the
6155 current character. */
6158 it
->dpvec_char_len
= it
->len
;
6159 it
->dpvec
= v
->contents
;
6160 it
->dpend
= v
->contents
+ v
->header
.size
;
6161 it
->current
.dpvec_index
= 0;
6162 it
->dpvec_face_id
= -1;
6163 it
->saved_face_id
= it
->face_id
;
6164 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6169 set_iterator_to_next (it
, 0);
6174 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6176 if (it
->what
== IT_GLYPHLESS
)
6178 /* Don't display this character. */
6179 set_iterator_to_next (it
, 0);
6183 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6184 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6185 : c
== 0xAD ? char_is_soft_hyphen
6188 /* Translate control characters into `\003' or `^C' form.
6189 Control characters coming from a display table entry are
6190 currently not translated because we use IT->dpvec to hold
6191 the translation. This could easily be changed but I
6192 don't believe that it is worth doing.
6194 NBSP and SOFT-HYPEN are property translated too.
6196 Non-printable characters and raw-byte characters are also
6197 translated to octal form. */
6198 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6199 ? (it
->area
!= TEXT_AREA
6200 /* In mode line, treat \n, \t like other crl chars. */
6203 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6204 || (c
!= '\n' && c
!= '\t'))
6207 || ! CHAR_PRINTABLE_P (c
))))
6209 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6210 or a non-printable character which must be displayed
6211 either as '\003' or as `^C' where the '\\' and '^'
6212 can be defined in the display table. Fill
6213 IT->ctl_chars with glyphs for what we have to
6214 display. Then, set IT->dpvec to these glyphs. */
6218 EMACS_INT lface_id
= 0;
6221 /* Handle control characters with ^. */
6223 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6227 g
= '^'; /* default glyph for Control */
6228 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6230 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6231 && GLYPH_CODE_CHAR_VALID_P (gc
))
6233 g
= GLYPH_CODE_CHAR (gc
);
6234 lface_id
= GLYPH_CODE_FACE (gc
);
6238 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6240 else if (it
->f
== last_escape_glyph_frame
6241 && it
->face_id
== last_escape_glyph_face_id
)
6243 face_id
= last_escape_glyph_merged_face_id
;
6247 /* Merge the escape-glyph face into the current face. */
6248 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6250 last_escape_glyph_frame
= it
->f
;
6251 last_escape_glyph_face_id
= it
->face_id
;
6252 last_escape_glyph_merged_face_id
= face_id
;
6255 XSETINT (it
->ctl_chars
[0], g
);
6256 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6258 goto display_control
;
6261 /* Handle non-break space in the mode where it only gets
6264 if (EQ (Vnobreak_char_display
, Qt
)
6265 && nbsp_or_shy
== char_is_nbsp
)
6267 /* Merge the no-break-space face into the current face. */
6268 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6272 XSETINT (it
->ctl_chars
[0], ' ');
6274 goto display_control
;
6277 /* Handle sequences that start with the "escape glyph". */
6279 /* the default escape glyph is \. */
6280 escape_glyph
= '\\';
6283 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6284 && GLYPH_CODE_CHAR_VALID_P (gc
))
6286 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6287 lface_id
= GLYPH_CODE_FACE (gc
);
6291 /* The display table specified a face.
6292 Merge it into face_id and also into escape_glyph. */
6293 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6296 else if (it
->f
== last_escape_glyph_frame
6297 && it
->face_id
== last_escape_glyph_face_id
)
6299 face_id
= last_escape_glyph_merged_face_id
;
6303 /* Merge the escape-glyph face into the current face. */
6304 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6306 last_escape_glyph_frame
= it
->f
;
6307 last_escape_glyph_face_id
= it
->face_id
;
6308 last_escape_glyph_merged_face_id
= face_id
;
6311 /* Handle soft hyphens in the mode where they only get
6314 if (EQ (Vnobreak_char_display
, Qt
)
6315 && nbsp_or_shy
== char_is_soft_hyphen
)
6317 XSETINT (it
->ctl_chars
[0], '-');
6319 goto display_control
;
6322 /* Handle non-break space and soft hyphen
6323 with the escape glyph. */
6327 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6328 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6329 XSETINT (it
->ctl_chars
[1], c
);
6331 goto display_control
;
6338 if (CHAR_BYTE8_P (c
))
6339 /* Display \200 instead of \17777600. */
6340 c
= CHAR_TO_BYTE8 (c
);
6341 len
= sprintf (str
, "%03o", c
);
6343 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6344 for (i
= 0; i
< len
; i
++)
6345 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6350 /* Set up IT->dpvec and return first character from it. */
6351 it
->dpvec_char_len
= it
->len
;
6352 it
->dpvec
= it
->ctl_chars
;
6353 it
->dpend
= it
->dpvec
+ ctl_len
;
6354 it
->current
.dpvec_index
= 0;
6355 it
->dpvec_face_id
= face_id
;
6356 it
->saved_face_id
= it
->face_id
;
6357 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6361 it
->char_to_display
= c
;
6365 it
->char_to_display
= it
->c
;
6369 /* Adjust face id for a multibyte character. There are no multibyte
6370 character in unibyte text. */
6371 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6374 && FRAME_WINDOW_P (it
->f
))
6376 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6378 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6380 /* Automatic composition with glyph-string. */
6381 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6383 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6387 EMACS_INT pos
= (it
->s
? -1
6388 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6389 : IT_CHARPOS (*it
));
6392 if (it
->what
== IT_CHARACTER
)
6393 c
= it
->char_to_display
;
6396 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6400 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6401 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6404 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6409 /* Is this character the last one of a run of characters with
6410 box? If yes, set IT->end_of_box_run_p to 1. */
6414 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6416 int face_id
= underlying_face_id (it
);
6417 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6421 if (face
->box
== FACE_NO_BOX
)
6423 /* If the box comes from face properties in a
6424 display string, check faces in that string. */
6425 int string_face_id
= face_after_it_pos (it
);
6426 it
->end_of_box_run_p
6427 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6430 /* Otherwise, the box comes from the underlying face.
6431 If this is the last string character displayed, check
6432 the next buffer location. */
6433 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6434 && (it
->current
.overlay_string_index
6435 == it
->n_overlay_strings
- 1))
6439 struct text_pos pos
= it
->current
.pos
;
6440 INC_TEXT_POS (pos
, it
->multibyte_p
);
6442 next_face_id
= face_at_buffer_position
6443 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6444 it
->region_end_charpos
, &ignore
,
6445 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6447 it
->end_of_box_run_p
6448 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6455 int face_id
= face_after_it_pos (it
);
6456 it
->end_of_box_run_p
6457 = (face_id
!= it
->face_id
6458 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6462 /* Value is 0 if end of buffer or string reached. */
6467 /* Move IT to the next display element.
6469 RESEAT_P non-zero means if called on a newline in buffer text,
6470 skip to the next visible line start.
6472 Functions get_next_display_element and set_iterator_to_next are
6473 separate because I find this arrangement easier to handle than a
6474 get_next_display_element function that also increments IT's
6475 position. The way it is we can first look at an iterator's current
6476 display element, decide whether it fits on a line, and if it does,
6477 increment the iterator position. The other way around we probably
6478 would either need a flag indicating whether the iterator has to be
6479 incremented the next time, or we would have to implement a
6480 decrement position function which would not be easy to write. */
6483 set_iterator_to_next (struct it
*it
, int reseat_p
)
6485 /* Reset flags indicating start and end of a sequence of characters
6486 with box. Reset them at the start of this function because
6487 moving the iterator to a new position might set them. */
6488 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6492 case GET_FROM_BUFFER
:
6493 /* The current display element of IT is a character from
6494 current_buffer. Advance in the buffer, and maybe skip over
6495 invisible lines that are so because of selective display. */
6496 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6497 reseat_at_next_visible_line_start (it
, 0);
6498 else if (it
->cmp_it
.id
>= 0)
6500 /* We are currently getting glyphs from a composition. */
6505 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6506 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6507 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6509 it
->cmp_it
.from
= it
->cmp_it
.to
;
6514 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6516 it
->end_charpos
, Qnil
);
6519 else if (! it
->cmp_it
.reversed_p
)
6521 /* Composition created while scanning forward. */
6522 /* Update IT's char/byte positions to point to the first
6523 character of the next grapheme cluster, or to the
6524 character visually after the current composition. */
6525 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6526 bidi_move_to_visually_next (&it
->bidi_it
);
6527 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6528 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6530 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6532 /* Proceed to the next grapheme cluster. */
6533 it
->cmp_it
.from
= it
->cmp_it
.to
;
6537 /* No more grapheme clusters in this composition.
6538 Find the next stop position. */
6539 EMACS_INT stop
= it
->end_charpos
;
6540 if (it
->bidi_it
.scan_dir
< 0)
6541 /* Now we are scanning backward and don't know
6544 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6545 IT_BYTEPOS (*it
), stop
, Qnil
);
6550 /* Composition created while scanning backward. */
6551 /* Update IT's char/byte positions to point to the last
6552 character of the previous grapheme cluster, or the
6553 character visually after the current composition. */
6554 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6555 bidi_move_to_visually_next (&it
->bidi_it
);
6556 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6557 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6558 if (it
->cmp_it
.from
> 0)
6560 /* Proceed to the previous grapheme cluster. */
6561 it
->cmp_it
.to
= it
->cmp_it
.from
;
6565 /* No more grapheme clusters in this composition.
6566 Find the next stop position. */
6567 EMACS_INT stop
= it
->end_charpos
;
6568 if (it
->bidi_it
.scan_dir
< 0)
6569 /* Now we are scanning backward and don't know
6572 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6573 IT_BYTEPOS (*it
), stop
, Qnil
);
6579 xassert (it
->len
!= 0);
6583 IT_BYTEPOS (*it
) += it
->len
;
6584 IT_CHARPOS (*it
) += 1;
6588 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6589 /* If this is a new paragraph, determine its base
6590 direction (a.k.a. its base embedding level). */
6591 if (it
->bidi_it
.new_paragraph
)
6592 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6593 bidi_move_to_visually_next (&it
->bidi_it
);
6594 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6595 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6596 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6598 /* As the scan direction was changed, we must
6599 re-compute the stop position for composition. */
6600 EMACS_INT stop
= it
->end_charpos
;
6601 if (it
->bidi_it
.scan_dir
< 0)
6603 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6604 IT_BYTEPOS (*it
), stop
, Qnil
);
6607 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6611 case GET_FROM_C_STRING
:
6612 /* Current display element of IT is from a C string. */
6614 /* If the string position is beyond string's end, it means
6615 next_element_from_c_string is padding the string with
6616 blanks, in which case we bypass the bidi iterator,
6617 because it cannot deal with such virtual characters. */
6618 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6620 IT_BYTEPOS (*it
) += it
->len
;
6621 IT_CHARPOS (*it
) += 1;
6625 bidi_move_to_visually_next (&it
->bidi_it
);
6626 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6627 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6631 case GET_FROM_DISPLAY_VECTOR
:
6632 /* Current display element of IT is from a display table entry.
6633 Advance in the display table definition. Reset it to null if
6634 end reached, and continue with characters from buffers/
6636 ++it
->current
.dpvec_index
;
6638 /* Restore face of the iterator to what they were before the
6639 display vector entry (these entries may contain faces). */
6640 it
->face_id
= it
->saved_face_id
;
6642 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6644 int recheck_faces
= it
->ellipsis_p
;
6647 it
->method
= GET_FROM_C_STRING
;
6648 else if (STRINGP (it
->string
))
6649 it
->method
= GET_FROM_STRING
;
6652 it
->method
= GET_FROM_BUFFER
;
6653 it
->object
= it
->w
->buffer
;
6657 it
->current
.dpvec_index
= -1;
6659 /* Skip over characters which were displayed via IT->dpvec. */
6660 if (it
->dpvec_char_len
< 0)
6661 reseat_at_next_visible_line_start (it
, 1);
6662 else if (it
->dpvec_char_len
> 0)
6664 if (it
->method
== GET_FROM_STRING
6665 && it
->n_overlay_strings
> 0)
6666 it
->ignore_overlay_strings_at_pos_p
= 1;
6667 it
->len
= it
->dpvec_char_len
;
6668 set_iterator_to_next (it
, reseat_p
);
6671 /* Maybe recheck faces after display vector */
6673 it
->stop_charpos
= IT_CHARPOS (*it
);
6677 case GET_FROM_STRING
:
6678 /* Current display element is a character from a Lisp string. */
6679 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6680 if (it
->cmp_it
.id
>= 0)
6686 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6687 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6688 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6689 it
->cmp_it
.from
= it
->cmp_it
.to
;
6693 composition_compute_stop_pos (&it
->cmp_it
,
6694 IT_STRING_CHARPOS (*it
),
6695 IT_STRING_BYTEPOS (*it
),
6696 it
->end_charpos
, it
->string
);
6699 else if (! it
->cmp_it
.reversed_p
)
6701 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6702 bidi_move_to_visually_next (&it
->bidi_it
);
6703 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6704 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6706 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6707 it
->cmp_it
.from
= it
->cmp_it
.to
;
6710 EMACS_INT stop
= it
->end_charpos
;
6711 if (it
->bidi_it
.scan_dir
< 0)
6713 composition_compute_stop_pos (&it
->cmp_it
,
6714 IT_STRING_CHARPOS (*it
),
6715 IT_STRING_BYTEPOS (*it
), stop
,
6721 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6722 bidi_move_to_visually_next (&it
->bidi_it
);
6723 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6724 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6725 if (it
->cmp_it
.from
> 0)
6726 it
->cmp_it
.to
= it
->cmp_it
.from
;
6729 EMACS_INT stop
= it
->end_charpos
;
6730 if (it
->bidi_it
.scan_dir
< 0)
6732 composition_compute_stop_pos (&it
->cmp_it
,
6733 IT_STRING_CHARPOS (*it
),
6734 IT_STRING_BYTEPOS (*it
), stop
,
6742 /* If the string position is beyond string's end, it
6743 means next_element_from_string is padding the string
6744 with blanks, in which case we bypass the bidi
6745 iterator, because it cannot deal with such virtual
6747 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6749 IT_STRING_BYTEPOS (*it
) += it
->len
;
6750 IT_STRING_CHARPOS (*it
) += 1;
6754 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6756 bidi_move_to_visually_next (&it
->bidi_it
);
6757 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6758 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6759 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6761 EMACS_INT stop
= it
->end_charpos
;
6763 if (it
->bidi_it
.scan_dir
< 0)
6765 composition_compute_stop_pos (&it
->cmp_it
,
6766 IT_STRING_CHARPOS (*it
),
6767 IT_STRING_BYTEPOS (*it
), stop
,
6773 consider_string_end
:
6775 if (it
->current
.overlay_string_index
>= 0)
6777 /* IT->string is an overlay string. Advance to the
6778 next, if there is one. */
6779 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6782 next_overlay_string (it
);
6784 setup_for_ellipsis (it
, 0);
6789 /* IT->string is not an overlay string. If we reached
6790 its end, and there is something on IT->stack, proceed
6791 with what is on the stack. This can be either another
6792 string, this time an overlay string, or a buffer. */
6793 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6797 if (it
->method
== GET_FROM_STRING
)
6798 goto consider_string_end
;
6803 case GET_FROM_IMAGE
:
6804 case GET_FROM_STRETCH
:
6805 /* The position etc with which we have to proceed are on
6806 the stack. The position may be at the end of a string,
6807 if the `display' property takes up the whole string. */
6808 xassert (it
->sp
> 0);
6810 if (it
->method
== GET_FROM_STRING
)
6811 goto consider_string_end
;
6815 /* There are no other methods defined, so this should be a bug. */
6819 xassert (it
->method
!= GET_FROM_STRING
6820 || (STRINGP (it
->string
)
6821 && IT_STRING_CHARPOS (*it
) >= 0));
6824 /* Load IT's display element fields with information about the next
6825 display element which comes from a display table entry or from the
6826 result of translating a control character to one of the forms `^C'
6829 IT->dpvec holds the glyphs to return as characters.
6830 IT->saved_face_id holds the face id before the display vector--it
6831 is restored into IT->face_id in set_iterator_to_next. */
6834 next_element_from_display_vector (struct it
*it
)
6839 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6841 it
->face_id
= it
->saved_face_id
;
6843 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6844 That seemed totally bogus - so I changed it... */
6845 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6847 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6849 it
->c
= GLYPH_CODE_CHAR (gc
);
6850 it
->len
= CHAR_BYTES (it
->c
);
6852 /* The entry may contain a face id to use. Such a face id is
6853 the id of a Lisp face, not a realized face. A face id of
6854 zero means no face is specified. */
6855 if (it
->dpvec_face_id
>= 0)
6856 it
->face_id
= it
->dpvec_face_id
;
6859 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6861 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6866 /* Display table entry is invalid. Return a space. */
6867 it
->c
= ' ', it
->len
= 1;
6869 /* Don't change position and object of the iterator here. They are
6870 still the values of the character that had this display table
6871 entry or was translated, and that's what we want. */
6872 it
->what
= IT_CHARACTER
;
6876 /* Get the first element of string/buffer in the visual order, after
6877 being reseated to a new position in a string or a buffer. */
6879 get_visually_first_element (struct it
*it
)
6881 int string_p
= STRINGP (it
->string
) || it
->s
;
6882 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6883 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6885 if (STRINGP (it
->string
))
6887 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6888 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6892 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6893 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6896 if (it
->bidi_it
.charpos
== eob
)
6898 /* Nothing to do, but reset the FIRST_ELT flag, like
6899 bidi_paragraph_init does, because we are not going to
6901 it
->bidi_it
.first_elt
= 0;
6903 else if (it
->bidi_it
.charpos
== bob
6905 /* FIXME: Should support all Unicode line separators. */
6906 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6907 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6909 /* If we are at the beginning of a line/string, we can produce
6910 the next element right away. */
6911 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6912 bidi_move_to_visually_next (&it
->bidi_it
);
6916 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6918 /* We need to prime the bidi iterator starting at the line's or
6919 string's beginning, before we will be able to produce the
6922 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6925 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6927 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6929 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6932 /* Now return to buffer/string position where we were asked
6933 to get the next display element, and produce that. */
6934 bidi_move_to_visually_next (&it
->bidi_it
);
6936 while (it
->bidi_it
.bytepos
!= orig_bytepos
6937 && it
->bidi_it
.charpos
< eob
);
6940 /* Adjust IT's position information to where we ended up. */
6941 if (STRINGP (it
->string
))
6943 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6944 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6948 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6949 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6952 if (STRINGP (it
->string
) || !it
->s
)
6954 EMACS_INT stop
, charpos
, bytepos
;
6956 if (STRINGP (it
->string
))
6959 stop
= SCHARS (it
->string
);
6960 if (stop
> it
->end_charpos
)
6961 stop
= it
->end_charpos
;
6962 charpos
= IT_STRING_CHARPOS (*it
);
6963 bytepos
= IT_STRING_BYTEPOS (*it
);
6967 stop
= it
->end_charpos
;
6968 charpos
= IT_CHARPOS (*it
);
6969 bytepos
= IT_BYTEPOS (*it
);
6971 if (it
->bidi_it
.scan_dir
< 0)
6973 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6978 /* Load IT with the next display element from Lisp string IT->string.
6979 IT->current.string_pos is the current position within the string.
6980 If IT->current.overlay_string_index >= 0, the Lisp string is an
6984 next_element_from_string (struct it
*it
)
6986 struct text_pos position
;
6988 xassert (STRINGP (it
->string
));
6989 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
6990 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6991 position
= it
->current
.string_pos
;
6993 /* With bidi reordering, the character to display might not be the
6994 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
6995 that we were reseat()ed to a new string, whose paragraph
6996 direction is not known. */
6997 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6999 get_visually_first_element (it
);
7000 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7003 /* Time to check for invisible text? */
7004 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7006 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7009 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7010 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7012 /* With bidi non-linear iteration, we could find
7013 ourselves far beyond the last computed stop_charpos,
7014 with several other stop positions in between that we
7015 missed. Scan them all now, in buffer's logical
7016 order, until we find and handle the last stop_charpos
7017 that precedes our current position. */
7018 handle_stop_backwards (it
, it
->stop_charpos
);
7019 return GET_NEXT_DISPLAY_ELEMENT (it
);
7025 /* Take note of the stop position we just moved
7026 across, for when we will move back across it. */
7027 it
->prev_stop
= it
->stop_charpos
;
7028 /* If we are at base paragraph embedding level, take
7029 note of the last stop position seen at this
7031 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7032 it
->base_level_stop
= it
->stop_charpos
;
7036 /* Since a handler may have changed IT->method, we must
7038 return GET_NEXT_DISPLAY_ELEMENT (it
);
7042 /* If we are before prev_stop, we may have overstepped
7043 on our way backwards a stop_pos, and if so, we need
7044 to handle that stop_pos. */
7045 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7046 /* We can sometimes back up for reasons that have nothing
7047 to do with bidi reordering. E.g., compositions. The
7048 code below is only needed when we are above the base
7049 embedding level, so test for that explicitly. */
7050 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7052 /* If we lost track of base_level_stop, we have no better
7053 place for handle_stop_backwards to start from than string
7054 beginning. This happens, e.g., when we were reseated to
7055 the previous screenful of text by vertical-motion. */
7056 if (it
->base_level_stop
<= 0
7057 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7058 it
->base_level_stop
= 0;
7059 handle_stop_backwards (it
, it
->base_level_stop
);
7060 return GET_NEXT_DISPLAY_ELEMENT (it
);
7064 if (it
->current
.overlay_string_index
>= 0)
7066 /* Get the next character from an overlay string. In overlay
7067 strings, There is no field width or padding with spaces to
7069 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7074 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7075 IT_STRING_BYTEPOS (*it
),
7076 it
->bidi_it
.scan_dir
< 0
7078 : SCHARS (it
->string
))
7079 && next_element_from_composition (it
))
7083 else if (STRING_MULTIBYTE (it
->string
))
7085 const unsigned char *s
= (SDATA (it
->string
)
7086 + IT_STRING_BYTEPOS (*it
));
7087 it
->c
= string_char_and_length (s
, &it
->len
);
7091 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7097 /* Get the next character from a Lisp string that is not an
7098 overlay string. Such strings come from the mode line, for
7099 example. We may have to pad with spaces, or truncate the
7100 string. See also next_element_from_c_string. */
7101 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7106 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7108 /* Pad with spaces. */
7109 it
->c
= ' ', it
->len
= 1;
7110 CHARPOS (position
) = BYTEPOS (position
) = -1;
7112 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7113 IT_STRING_BYTEPOS (*it
),
7114 it
->bidi_it
.scan_dir
< 0
7116 : it
->string_nchars
)
7117 && next_element_from_composition (it
))
7121 else if (STRING_MULTIBYTE (it
->string
))
7123 const unsigned char *s
= (SDATA (it
->string
)
7124 + IT_STRING_BYTEPOS (*it
));
7125 it
->c
= string_char_and_length (s
, &it
->len
);
7129 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7134 /* Record what we have and where it came from. */
7135 it
->what
= IT_CHARACTER
;
7136 it
->object
= it
->string
;
7137 it
->position
= position
;
7142 /* Load IT with next display element from C string IT->s.
7143 IT->string_nchars is the maximum number of characters to return
7144 from the string. IT->end_charpos may be greater than
7145 IT->string_nchars when this function is called, in which case we
7146 may have to return padding spaces. Value is zero if end of string
7147 reached, including padding spaces. */
7150 next_element_from_c_string (struct it
*it
)
7155 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7156 it
->what
= IT_CHARACTER
;
7157 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7160 /* With bidi reordering, the character to display might not be the
7161 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7162 we were reseated to a new string, whose paragraph direction is
7164 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7165 get_visually_first_element (it
);
7167 /* IT's position can be greater than IT->string_nchars in case a
7168 field width or precision has been specified when the iterator was
7170 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7172 /* End of the game. */
7176 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7178 /* Pad with spaces. */
7179 it
->c
= ' ', it
->len
= 1;
7180 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7182 else if (it
->multibyte_p
)
7183 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7185 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7191 /* Set up IT to return characters from an ellipsis, if appropriate.
7192 The definition of the ellipsis glyphs may come from a display table
7193 entry. This function fills IT with the first glyph from the
7194 ellipsis if an ellipsis is to be displayed. */
7197 next_element_from_ellipsis (struct it
*it
)
7199 if (it
->selective_display_ellipsis_p
)
7200 setup_for_ellipsis (it
, it
->len
);
7203 /* The face at the current position may be different from the
7204 face we find after the invisible text. Remember what it
7205 was in IT->saved_face_id, and signal that it's there by
7206 setting face_before_selective_p. */
7207 it
->saved_face_id
= it
->face_id
;
7208 it
->method
= GET_FROM_BUFFER
;
7209 it
->object
= it
->w
->buffer
;
7210 reseat_at_next_visible_line_start (it
, 1);
7211 it
->face_before_selective_p
= 1;
7214 return GET_NEXT_DISPLAY_ELEMENT (it
);
7218 /* Deliver an image display element. The iterator IT is already
7219 filled with image information (done in handle_display_prop). Value
7224 next_element_from_image (struct it
*it
)
7226 it
->what
= IT_IMAGE
;
7227 it
->ignore_overlay_strings_at_pos_p
= 0;
7232 /* Fill iterator IT with next display element from a stretch glyph
7233 property. IT->object is the value of the text property. Value is
7237 next_element_from_stretch (struct it
*it
)
7239 it
->what
= IT_STRETCH
;
7243 /* Scan backwards from IT's current position until we find a stop
7244 position, or until BEGV. This is called when we find ourself
7245 before both the last known prev_stop and base_level_stop while
7246 reordering bidirectional text. */
7249 compute_stop_pos_backwards (struct it
*it
)
7251 const int SCAN_BACK_LIMIT
= 1000;
7252 struct text_pos pos
;
7253 struct display_pos save_current
= it
->current
;
7254 struct text_pos save_position
= it
->position
;
7255 EMACS_INT charpos
= IT_CHARPOS (*it
);
7256 EMACS_INT where_we_are
= charpos
;
7257 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7258 EMACS_INT save_end_pos
= it
->end_charpos
;
7260 xassert (NILP (it
->string
) && !it
->s
);
7261 xassert (it
->bidi_p
);
7265 it
->end_charpos
= min (charpos
+ 1, ZV
);
7266 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7267 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7268 reseat_1 (it
, pos
, 0);
7269 compute_stop_pos (it
);
7270 /* We must advance forward, right? */
7271 if (it
->stop_charpos
<= charpos
)
7274 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7276 if (it
->stop_charpos
<= where_we_are
)
7277 it
->prev_stop
= it
->stop_charpos
;
7279 it
->prev_stop
= BEGV
;
7281 it
->current
= save_current
;
7282 it
->position
= save_position
;
7283 it
->stop_charpos
= save_stop_pos
;
7284 it
->end_charpos
= save_end_pos
;
7287 /* Scan forward from CHARPOS in the current buffer/string, until we
7288 find a stop position > current IT's position. Then handle the stop
7289 position before that. This is called when we bump into a stop
7290 position while reordering bidirectional text. CHARPOS should be
7291 the last previously processed stop_pos (or BEGV/0, if none were
7292 processed yet) whose position is less that IT's current
7296 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7298 int bufp
= !STRINGP (it
->string
);
7299 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7300 struct display_pos save_current
= it
->current
;
7301 struct text_pos save_position
= it
->position
;
7302 struct text_pos pos1
;
7303 EMACS_INT next_stop
;
7305 /* Scan in strict logical order. */
7306 xassert (it
->bidi_p
);
7310 it
->prev_stop
= charpos
;
7313 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7314 reseat_1 (it
, pos1
, 0);
7317 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7318 compute_stop_pos (it
);
7319 /* We must advance forward, right? */
7320 if (it
->stop_charpos
<= it
->prev_stop
)
7322 charpos
= it
->stop_charpos
;
7324 while (charpos
<= where_we_are
);
7327 it
->current
= save_current
;
7328 it
->position
= save_position
;
7329 next_stop
= it
->stop_charpos
;
7330 it
->stop_charpos
= it
->prev_stop
;
7332 it
->stop_charpos
= next_stop
;
7335 /* Load IT with the next display element from current_buffer. Value
7336 is zero if end of buffer reached. IT->stop_charpos is the next
7337 position at which to stop and check for text properties or buffer
7341 next_element_from_buffer (struct it
*it
)
7345 xassert (IT_CHARPOS (*it
) >= BEGV
);
7346 xassert (NILP (it
->string
) && !it
->s
);
7347 xassert (!it
->bidi_p
7348 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7349 && it
->bidi_it
.string
.s
== NULL
));
7351 /* With bidi reordering, the character to display might not be the
7352 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7353 we were reseat()ed to a new buffer position, which is potentially
7354 a different paragraph. */
7355 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7357 get_visually_first_element (it
);
7358 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7361 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7363 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7365 int overlay_strings_follow_p
;
7367 /* End of the game, except when overlay strings follow that
7368 haven't been returned yet. */
7369 if (it
->overlay_strings_at_end_processed_p
)
7370 overlay_strings_follow_p
= 0;
7373 it
->overlay_strings_at_end_processed_p
= 1;
7374 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7377 if (overlay_strings_follow_p
)
7378 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7382 it
->position
= it
->current
.pos
;
7386 else if (!(!it
->bidi_p
7387 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7388 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7390 /* With bidi non-linear iteration, we could find ourselves
7391 far beyond the last computed stop_charpos, with several
7392 other stop positions in between that we missed. Scan
7393 them all now, in buffer's logical order, until we find
7394 and handle the last stop_charpos that precedes our
7395 current position. */
7396 handle_stop_backwards (it
, it
->stop_charpos
);
7397 return GET_NEXT_DISPLAY_ELEMENT (it
);
7403 /* Take note of the stop position we just moved across,
7404 for when we will move back across it. */
7405 it
->prev_stop
= it
->stop_charpos
;
7406 /* If we are at base paragraph embedding level, take
7407 note of the last stop position seen at this
7409 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7410 it
->base_level_stop
= it
->stop_charpos
;
7413 return GET_NEXT_DISPLAY_ELEMENT (it
);
7417 /* If we are before prev_stop, we may have overstepped on
7418 our way backwards a stop_pos, and if so, we need to
7419 handle that stop_pos. */
7420 && IT_CHARPOS (*it
) < it
->prev_stop
7421 /* We can sometimes back up for reasons that have nothing
7422 to do with bidi reordering. E.g., compositions. The
7423 code below is only needed when we are above the base
7424 embedding level, so test for that explicitly. */
7425 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7427 if (it
->base_level_stop
<= 0
7428 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7430 /* If we lost track of base_level_stop, we need to find
7431 prev_stop by looking backwards. This happens, e.g., when
7432 we were reseated to the previous screenful of text by
7434 it
->base_level_stop
= BEGV
;
7435 compute_stop_pos_backwards (it
);
7436 handle_stop_backwards (it
, it
->prev_stop
);
7439 handle_stop_backwards (it
, it
->base_level_stop
);
7440 return GET_NEXT_DISPLAY_ELEMENT (it
);
7444 /* No face changes, overlays etc. in sight, so just return a
7445 character from current_buffer. */
7449 /* Maybe run the redisplay end trigger hook. Performance note:
7450 This doesn't seem to cost measurable time. */
7451 if (it
->redisplay_end_trigger_charpos
7453 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7454 run_redisplay_end_trigger_hook (it
);
7456 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7457 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7459 && next_element_from_composition (it
))
7464 /* Get the next character, maybe multibyte. */
7465 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7466 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7467 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7469 it
->c
= *p
, it
->len
= 1;
7471 /* Record what we have and where it came from. */
7472 it
->what
= IT_CHARACTER
;
7473 it
->object
= it
->w
->buffer
;
7474 it
->position
= it
->current
.pos
;
7476 /* Normally we return the character found above, except when we
7477 really want to return an ellipsis for selective display. */
7482 /* A value of selective > 0 means hide lines indented more
7483 than that number of columns. */
7484 if (it
->selective
> 0
7485 && IT_CHARPOS (*it
) + 1 < ZV
7486 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7487 IT_BYTEPOS (*it
) + 1,
7490 success_p
= next_element_from_ellipsis (it
);
7491 it
->dpvec_char_len
= -1;
7494 else if (it
->c
== '\r' && it
->selective
== -1)
7496 /* A value of selective == -1 means that everything from the
7497 CR to the end of the line is invisible, with maybe an
7498 ellipsis displayed for it. */
7499 success_p
= next_element_from_ellipsis (it
);
7500 it
->dpvec_char_len
= -1;
7505 /* Value is zero if end of buffer reached. */
7506 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7511 /* Run the redisplay end trigger hook for IT. */
7514 run_redisplay_end_trigger_hook (struct it
*it
)
7516 Lisp_Object args
[3];
7518 /* IT->glyph_row should be non-null, i.e. we should be actually
7519 displaying something, or otherwise we should not run the hook. */
7520 xassert (it
->glyph_row
);
7522 /* Set up hook arguments. */
7523 args
[0] = Qredisplay_end_trigger_functions
;
7524 args
[1] = it
->window
;
7525 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7526 it
->redisplay_end_trigger_charpos
= 0;
7528 /* Since we are *trying* to run these functions, don't try to run
7529 them again, even if they get an error. */
7530 it
->w
->redisplay_end_trigger
= Qnil
;
7531 Frun_hook_with_args (3, args
);
7533 /* Notice if it changed the face of the character we are on. */
7534 handle_face_prop (it
);
7538 /* Deliver a composition display element. Unlike the other
7539 next_element_from_XXX, this function is not registered in the array
7540 get_next_element[]. It is called from next_element_from_buffer and
7541 next_element_from_string when necessary. */
7544 next_element_from_composition (struct it
*it
)
7546 it
->what
= IT_COMPOSITION
;
7547 it
->len
= it
->cmp_it
.nbytes
;
7548 if (STRINGP (it
->string
))
7552 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7553 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7556 it
->position
= it
->current
.string_pos
;
7557 it
->object
= it
->string
;
7558 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7559 IT_STRING_BYTEPOS (*it
), it
->string
);
7565 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7566 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7569 if (it
->bidi_it
.new_paragraph
)
7570 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7571 /* Resync the bidi iterator with IT's new position.
7572 FIXME: this doesn't support bidirectional text. */
7573 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7574 bidi_move_to_visually_next (&it
->bidi_it
);
7578 it
->position
= it
->current
.pos
;
7579 it
->object
= it
->w
->buffer
;
7580 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7581 IT_BYTEPOS (*it
), Qnil
);
7588 /***********************************************************************
7589 Moving an iterator without producing glyphs
7590 ***********************************************************************/
7592 /* Check if iterator is at a position corresponding to a valid buffer
7593 position after some move_it_ call. */
7595 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7596 ((it)->method == GET_FROM_STRING \
7597 ? IT_STRING_CHARPOS (*it) == 0 \
7601 /* Move iterator IT to a specified buffer or X position within one
7602 line on the display without producing glyphs.
7604 OP should be a bit mask including some or all of these bits:
7605 MOVE_TO_X: Stop upon reaching x-position TO_X.
7606 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7607 Regardless of OP's value, stop upon reaching the end of the display line.
7609 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7610 This means, in particular, that TO_X includes window's horizontal
7613 The return value has several possible values that
7614 say what condition caused the scan to stop:
7616 MOVE_POS_MATCH_OR_ZV
7617 - when TO_POS or ZV was reached.
7620 -when TO_X was reached before TO_POS or ZV were reached.
7623 - when we reached the end of the display area and the line must
7627 - when we reached the end of the display area and the line is
7631 - when we stopped at a line end, i.e. a newline or a CR and selective
7634 static enum move_it_result
7635 move_it_in_display_line_to (struct it
*it
,
7636 EMACS_INT to_charpos
, int to_x
,
7637 enum move_operation_enum op
)
7639 enum move_it_result result
= MOVE_UNDEFINED
;
7640 struct glyph_row
*saved_glyph_row
;
7641 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7642 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7643 void *ppos_data
= NULL
;
7645 enum it_method prev_method
= it
->method
;
7646 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7647 int saw_smaller_pos
= prev_pos
< to_charpos
;
7649 /* Don't produce glyphs in produce_glyphs. */
7650 saved_glyph_row
= it
->glyph_row
;
7651 it
->glyph_row
= NULL
;
7653 /* Use wrap_it to save a copy of IT wherever a word wrap could
7654 occur. Use atpos_it to save a copy of IT at the desired buffer
7655 position, if found, so that we can scan ahead and check if the
7656 word later overshoots the window edge. Use atx_it similarly, for
7662 /* Use ppos_it under bidi reordering to save a copy of IT for the
7663 position > CHARPOS that is the closest to CHARPOS. We restore
7664 that position in IT when we have scanned the entire display line
7665 without finding a match for CHARPOS and all the character
7666 positions are greater than CHARPOS. */
7669 SAVE_IT (ppos_it
, *it
, ppos_data
);
7670 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7671 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7672 SAVE_IT (ppos_it
, *it
, ppos_data
);
7675 #define BUFFER_POS_REACHED_P() \
7676 ((op & MOVE_TO_POS) != 0 \
7677 && BUFFERP (it->object) \
7678 && (IT_CHARPOS (*it) == to_charpos \
7679 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7680 && (it->method == GET_FROM_BUFFER \
7681 || (it->method == GET_FROM_DISPLAY_VECTOR \
7682 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7684 /* If there's a line-/wrap-prefix, handle it. */
7685 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7686 && it
->current_y
< it
->last_visible_y
)
7687 handle_line_prefix (it
);
7689 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7690 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7694 int x
, i
, ascent
= 0, descent
= 0;
7696 /* Utility macro to reset an iterator with x, ascent, and descent. */
7697 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7698 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7699 (IT)->max_descent = descent)
7701 /* Stop if we move beyond TO_CHARPOS (after an image or a
7702 display string or stretch glyph). */
7703 if ((op
& MOVE_TO_POS
) != 0
7704 && BUFFERP (it
->object
)
7705 && it
->method
== GET_FROM_BUFFER
7706 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7708 && (prev_method
== GET_FROM_IMAGE
7709 || prev_method
== GET_FROM_STRETCH
7710 || prev_method
== GET_FROM_STRING
)
7711 /* Passed TO_CHARPOS from left to right. */
7712 && ((prev_pos
< to_charpos
7713 && IT_CHARPOS (*it
) > to_charpos
)
7714 /* Passed TO_CHARPOS from right to left. */
7715 || (prev_pos
> to_charpos
7716 && IT_CHARPOS (*it
) < to_charpos
)))))
7718 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7720 result
= MOVE_POS_MATCH_OR_ZV
;
7723 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7724 /* If wrap_it is valid, the current position might be in a
7725 word that is wrapped. So, save the iterator in
7726 atpos_it and continue to see if wrapping happens. */
7727 SAVE_IT (atpos_it
, *it
, atpos_data
);
7730 /* Stop when ZV reached.
7731 We used to stop here when TO_CHARPOS reached as well, but that is
7732 too soon if this glyph does not fit on this line. So we handle it
7733 explicitly below. */
7734 if (!get_next_display_element (it
))
7736 result
= MOVE_POS_MATCH_OR_ZV
;
7740 if (it
->line_wrap
== TRUNCATE
)
7742 if (BUFFER_POS_REACHED_P ())
7744 result
= MOVE_POS_MATCH_OR_ZV
;
7750 if (it
->line_wrap
== WORD_WRAP
)
7752 if (IT_DISPLAYING_WHITESPACE (it
))
7756 /* We have reached a glyph that follows one or more
7757 whitespace characters. If the position is
7758 already found, we are done. */
7759 if (atpos_it
.sp
>= 0)
7761 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7762 result
= MOVE_POS_MATCH_OR_ZV
;
7767 RESTORE_IT (it
, &atx_it
, atx_data
);
7768 result
= MOVE_X_REACHED
;
7771 /* Otherwise, we can wrap here. */
7772 SAVE_IT (wrap_it
, *it
, wrap_data
);
7778 /* Remember the line height for the current line, in case
7779 the next element doesn't fit on the line. */
7780 ascent
= it
->max_ascent
;
7781 descent
= it
->max_descent
;
7783 /* The call to produce_glyphs will get the metrics of the
7784 display element IT is loaded with. Record the x-position
7785 before this display element, in case it doesn't fit on the
7789 PRODUCE_GLYPHS (it
);
7791 if (it
->area
!= TEXT_AREA
)
7793 prev_method
= it
->method
;
7794 if (it
->method
== GET_FROM_BUFFER
)
7795 prev_pos
= IT_CHARPOS (*it
);
7796 set_iterator_to_next (it
, 1);
7797 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7798 SET_TEXT_POS (this_line_min_pos
,
7799 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7801 && (op
& MOVE_TO_POS
)
7802 && IT_CHARPOS (*it
) > to_charpos
7803 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7804 SAVE_IT (ppos_it
, *it
, ppos_data
);
7808 /* The number of glyphs we get back in IT->nglyphs will normally
7809 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7810 character on a terminal frame, or (iii) a line end. For the
7811 second case, IT->nglyphs - 1 padding glyphs will be present.
7812 (On X frames, there is only one glyph produced for a
7813 composite character.)
7815 The behavior implemented below means, for continuation lines,
7816 that as many spaces of a TAB as fit on the current line are
7817 displayed there. For terminal frames, as many glyphs of a
7818 multi-glyph character are displayed in the current line, too.
7819 This is what the old redisplay code did, and we keep it that
7820 way. Under X, the whole shape of a complex character must
7821 fit on the line or it will be completely displayed in the
7824 Note that both for tabs and padding glyphs, all glyphs have
7828 /* More than one glyph or glyph doesn't fit on line. All
7829 glyphs have the same width. */
7830 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7832 int x_before_this_char
= x
;
7833 int hpos_before_this_char
= it
->hpos
;
7835 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7837 new_x
= x
+ single_glyph_width
;
7839 /* We want to leave anything reaching TO_X to the caller. */
7840 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7842 if (BUFFER_POS_REACHED_P ())
7844 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7845 goto buffer_pos_reached
;
7846 if (atpos_it
.sp
< 0)
7848 SAVE_IT (atpos_it
, *it
, atpos_data
);
7849 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7854 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7857 result
= MOVE_X_REACHED
;
7862 SAVE_IT (atx_it
, *it
, atx_data
);
7863 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7868 if (/* Lines are continued. */
7869 it
->line_wrap
!= TRUNCATE
7870 && (/* And glyph doesn't fit on the line. */
7871 new_x
> it
->last_visible_x
7872 /* Or it fits exactly and we're on a window
7874 || (new_x
== it
->last_visible_x
7875 && FRAME_WINDOW_P (it
->f
))))
7877 if (/* IT->hpos == 0 means the very first glyph
7878 doesn't fit on the line, e.g. a wide image. */
7880 || (new_x
== it
->last_visible_x
7881 && FRAME_WINDOW_P (it
->f
)))
7884 it
->current_x
= new_x
;
7886 /* The character's last glyph just barely fits
7888 if (i
== it
->nglyphs
- 1)
7890 /* If this is the destination position,
7891 return a position *before* it in this row,
7892 now that we know it fits in this row. */
7893 if (BUFFER_POS_REACHED_P ())
7895 if (it
->line_wrap
!= WORD_WRAP
7898 it
->hpos
= hpos_before_this_char
;
7899 it
->current_x
= x_before_this_char
;
7900 result
= MOVE_POS_MATCH_OR_ZV
;
7903 if (it
->line_wrap
== WORD_WRAP
7906 SAVE_IT (atpos_it
, *it
, atpos_data
);
7907 atpos_it
.current_x
= x_before_this_char
;
7908 atpos_it
.hpos
= hpos_before_this_char
;
7912 prev_method
= it
->method
;
7913 if (it
->method
== GET_FROM_BUFFER
)
7914 prev_pos
= IT_CHARPOS (*it
);
7915 set_iterator_to_next (it
, 1);
7916 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7917 SET_TEXT_POS (this_line_min_pos
,
7918 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7919 /* On graphical terminals, newlines may
7920 "overflow" into the fringe if
7921 overflow-newline-into-fringe is non-nil.
7922 On text-only terminals, newlines may
7923 overflow into the last glyph on the
7925 if (!FRAME_WINDOW_P (it
->f
)
7926 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7928 if (!get_next_display_element (it
))
7930 result
= MOVE_POS_MATCH_OR_ZV
;
7933 if (BUFFER_POS_REACHED_P ())
7935 if (ITERATOR_AT_END_OF_LINE_P (it
))
7936 result
= MOVE_POS_MATCH_OR_ZV
;
7938 result
= MOVE_LINE_CONTINUED
;
7941 if (ITERATOR_AT_END_OF_LINE_P (it
))
7943 result
= MOVE_NEWLINE_OR_CR
;
7950 IT_RESET_X_ASCENT_DESCENT (it
);
7952 if (wrap_it
.sp
>= 0)
7954 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7959 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7961 result
= MOVE_LINE_CONTINUED
;
7965 if (BUFFER_POS_REACHED_P ())
7967 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7968 goto buffer_pos_reached
;
7969 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7971 SAVE_IT (atpos_it
, *it
, atpos_data
);
7972 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7976 if (new_x
> it
->first_visible_x
)
7978 /* Glyph is visible. Increment number of glyphs that
7979 would be displayed. */
7984 if (result
!= MOVE_UNDEFINED
)
7987 else if (BUFFER_POS_REACHED_P ())
7990 IT_RESET_X_ASCENT_DESCENT (it
);
7991 result
= MOVE_POS_MATCH_OR_ZV
;
7994 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7996 /* Stop when TO_X specified and reached. This check is
7997 necessary here because of lines consisting of a line end,
7998 only. The line end will not produce any glyphs and we
7999 would never get MOVE_X_REACHED. */
8000 xassert (it
->nglyphs
== 0);
8001 result
= MOVE_X_REACHED
;
8005 /* Is this a line end? If yes, we're done. */
8006 if (ITERATOR_AT_END_OF_LINE_P (it
))
8008 /* If we are past TO_CHARPOS, but never saw any character
8009 positions smaller than TO_CHARPOS, return
8010 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8012 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8014 && IT_CHARPOS (*it
) > to_charpos
)
8016 if (IT_CHARPOS (ppos_it
) < ZV
)
8017 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8018 goto buffer_pos_reached
;
8021 result
= MOVE_NEWLINE_OR_CR
;
8025 prev_method
= it
->method
;
8026 if (it
->method
== GET_FROM_BUFFER
)
8027 prev_pos
= IT_CHARPOS (*it
);
8028 /* The current display element has been consumed. Advance
8030 set_iterator_to_next (it
, 1);
8031 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8032 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8033 if (IT_CHARPOS (*it
) < to_charpos
)
8034 saw_smaller_pos
= 1;
8036 && (op
& MOVE_TO_POS
)
8037 && IT_CHARPOS (*it
) >= to_charpos
8038 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8039 SAVE_IT (ppos_it
, *it
, ppos_data
);
8041 /* Stop if lines are truncated and IT's current x-position is
8042 past the right edge of the window now. */
8043 if (it
->line_wrap
== TRUNCATE
8044 && it
->current_x
>= it
->last_visible_x
)
8046 if (!FRAME_WINDOW_P (it
->f
)
8047 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8051 if ((at_eob_p
= !get_next_display_element (it
))
8052 || BUFFER_POS_REACHED_P ()
8053 /* If we are past TO_CHARPOS, but never saw any
8054 character positions smaller than TO_CHARPOS,
8055 return MOVE_POS_MATCH_OR_ZV, like the
8056 unidirectional display did. */
8057 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8059 && IT_CHARPOS (*it
) > to_charpos
))
8061 if (!at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8062 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8063 goto buffer_pos_reached
;
8065 if (ITERATOR_AT_END_OF_LINE_P (it
))
8067 result
= MOVE_NEWLINE_OR_CR
;
8071 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8073 && IT_CHARPOS (*it
) > to_charpos
)
8075 if (IT_CHARPOS (ppos_it
) < ZV
)
8076 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8077 goto buffer_pos_reached
;
8079 result
= MOVE_LINE_TRUNCATED
;
8082 #undef IT_RESET_X_ASCENT_DESCENT
8085 #undef BUFFER_POS_REACHED_P
8087 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8088 restore the saved iterator. */
8089 if (atpos_it
.sp
>= 0)
8090 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8091 else if (atx_it
.sp
>= 0)
8092 RESTORE_IT (it
, &atx_it
, atx_data
);
8097 bidi_unshelve_cache (atpos_data
, 1);
8099 bidi_unshelve_cache (atx_data
, 1);
8101 bidi_unshelve_cache (wrap_data
, 1);
8103 bidi_unshelve_cache (ppos_data
, 1);
8105 /* Restore the iterator settings altered at the beginning of this
8107 it
->glyph_row
= saved_glyph_row
;
8111 /* For external use. */
8113 move_it_in_display_line (struct it
*it
,
8114 EMACS_INT to_charpos
, int to_x
,
8115 enum move_operation_enum op
)
8117 if (it
->line_wrap
== WORD_WRAP
8118 && (op
& MOVE_TO_X
))
8121 void *save_data
= NULL
;
8124 SAVE_IT (save_it
, *it
, save_data
);
8125 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8126 /* When word-wrap is on, TO_X may lie past the end
8127 of a wrapped line. Then it->current is the
8128 character on the next line, so backtrack to the
8129 space before the wrap point. */
8130 if (skip
== MOVE_LINE_CONTINUED
)
8132 int prev_x
= max (it
->current_x
- 1, 0);
8133 RESTORE_IT (it
, &save_it
, save_data
);
8134 move_it_in_display_line_to
8135 (it
, -1, prev_x
, MOVE_TO_X
);
8138 bidi_unshelve_cache (save_data
, 1);
8141 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8145 /* Move IT forward until it satisfies one or more of the criteria in
8146 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8148 OP is a bit-mask that specifies where to stop, and in particular,
8149 which of those four position arguments makes a difference. See the
8150 description of enum move_operation_enum.
8152 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8153 screen line, this function will set IT to the next position that is
8154 displayed to the right of TO_CHARPOS on the screen. */
8157 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8159 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8160 int line_height
, line_start_x
= 0, reached
= 0;
8161 void *backup_data
= NULL
;
8165 if (op
& MOVE_TO_VPOS
)
8167 /* If no TO_CHARPOS and no TO_X specified, stop at the
8168 start of the line TO_VPOS. */
8169 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8171 if (it
->vpos
== to_vpos
)
8177 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8181 /* TO_VPOS >= 0 means stop at TO_X in the line at
8182 TO_VPOS, or at TO_POS, whichever comes first. */
8183 if (it
->vpos
== to_vpos
)
8189 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8191 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8196 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8198 /* We have reached TO_X but not in the line we want. */
8199 skip
= move_it_in_display_line_to (it
, to_charpos
,
8201 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8209 else if (op
& MOVE_TO_Y
)
8211 struct it it_backup
;
8213 if (it
->line_wrap
== WORD_WRAP
)
8214 SAVE_IT (it_backup
, *it
, backup_data
);
8216 /* TO_Y specified means stop at TO_X in the line containing
8217 TO_Y---or at TO_CHARPOS if this is reached first. The
8218 problem is that we can't really tell whether the line
8219 contains TO_Y before we have completely scanned it, and
8220 this may skip past TO_X. What we do is to first scan to
8223 If TO_X is not specified, use a TO_X of zero. The reason
8224 is to make the outcome of this function more predictable.
8225 If we didn't use TO_X == 0, we would stop at the end of
8226 the line which is probably not what a caller would expect
8228 skip
= move_it_in_display_line_to
8229 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8230 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8232 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8233 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8235 else if (skip
== MOVE_X_REACHED
)
8237 /* If TO_X was reached, we want to know whether TO_Y is
8238 in the line. We know this is the case if the already
8239 scanned glyphs make the line tall enough. Otherwise,
8240 we must check by scanning the rest of the line. */
8241 line_height
= it
->max_ascent
+ it
->max_descent
;
8242 if (to_y
>= it
->current_y
8243 && to_y
< it
->current_y
+ line_height
)
8248 SAVE_IT (it_backup
, *it
, backup_data
);
8249 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8250 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8252 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8253 line_height
= it
->max_ascent
+ it
->max_descent
;
8254 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8256 if (to_y
>= it
->current_y
8257 && to_y
< it
->current_y
+ line_height
)
8259 /* If TO_Y is in this line and TO_X was reached
8260 above, we scanned too far. We have to restore
8261 IT's settings to the ones before skipping. */
8262 RESTORE_IT (it
, &it_backup
, backup_data
);
8268 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8274 /* Check whether TO_Y is in this line. */
8275 line_height
= it
->max_ascent
+ it
->max_descent
;
8276 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8278 if (to_y
>= it
->current_y
8279 && to_y
< it
->current_y
+ line_height
)
8281 /* When word-wrap is on, TO_X may lie past the end
8282 of a wrapped line. Then it->current is the
8283 character on the next line, so backtrack to the
8284 space before the wrap point. */
8285 if (skip
== MOVE_LINE_CONTINUED
8286 && it
->line_wrap
== WORD_WRAP
)
8288 int prev_x
= max (it
->current_x
- 1, 0);
8289 RESTORE_IT (it
, &it_backup
, backup_data
);
8290 skip
= move_it_in_display_line_to
8291 (it
, -1, prev_x
, MOVE_TO_X
);
8300 else if (BUFFERP (it
->object
)
8301 && (it
->method
== GET_FROM_BUFFER
8302 || it
->method
== GET_FROM_STRETCH
)
8303 && IT_CHARPOS (*it
) >= to_charpos
)
8304 skip
= MOVE_POS_MATCH_OR_ZV
;
8306 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8310 case MOVE_POS_MATCH_OR_ZV
:
8314 case MOVE_NEWLINE_OR_CR
:
8315 set_iterator_to_next (it
, 1);
8316 it
->continuation_lines_width
= 0;
8319 case MOVE_LINE_TRUNCATED
:
8320 it
->continuation_lines_width
= 0;
8321 reseat_at_next_visible_line_start (it
, 0);
8322 if ((op
& MOVE_TO_POS
) != 0
8323 && IT_CHARPOS (*it
) > to_charpos
)
8330 case MOVE_LINE_CONTINUED
:
8331 /* For continued lines ending in a tab, some of the glyphs
8332 associated with the tab are displayed on the current
8333 line. Since it->current_x does not include these glyphs,
8334 we use it->last_visible_x instead. */
8337 it
->continuation_lines_width
+= it
->last_visible_x
;
8338 /* When moving by vpos, ensure that the iterator really
8339 advances to the next line (bug#847, bug#969). Fixme:
8340 do we need to do this in other circumstances? */
8341 if (it
->current_x
!= it
->last_visible_x
8342 && (op
& MOVE_TO_VPOS
)
8343 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8345 line_start_x
= it
->current_x
+ it
->pixel_width
8346 - it
->last_visible_x
;
8347 set_iterator_to_next (it
, 0);
8351 it
->continuation_lines_width
+= it
->current_x
;
8358 /* Reset/increment for the next run. */
8359 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8360 it
->current_x
= line_start_x
;
8363 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8365 last_height
= it
->max_ascent
+ it
->max_descent
;
8366 last_max_ascent
= it
->max_ascent
;
8367 it
->max_ascent
= it
->max_descent
= 0;
8372 /* On text terminals, we may stop at the end of a line in the middle
8373 of a multi-character glyph. If the glyph itself is continued,
8374 i.e. it is actually displayed on the next line, don't treat this
8375 stopping point as valid; move to the next line instead (unless
8376 that brings us offscreen). */
8377 if (!FRAME_WINDOW_P (it
->f
)
8379 && IT_CHARPOS (*it
) == to_charpos
8380 && it
->what
== IT_CHARACTER
8382 && it
->line_wrap
== WINDOW_WRAP
8383 && it
->current_x
== it
->last_visible_x
- 1
8386 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8388 it
->continuation_lines_width
+= it
->current_x
;
8389 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8390 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8392 last_height
= it
->max_ascent
+ it
->max_descent
;
8393 last_max_ascent
= it
->max_ascent
;
8397 bidi_unshelve_cache (backup_data
, 1);
8399 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8403 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8405 If DY > 0, move IT backward at least that many pixels. DY = 0
8406 means move IT backward to the preceding line start or BEGV. This
8407 function may move over more than DY pixels if IT->current_y - DY
8408 ends up in the middle of a line; in this case IT->current_y will be
8409 set to the top of the line moved to. */
8412 move_it_vertically_backward (struct it
*it
, int dy
)
8416 void *it2data
= NULL
, *it3data
= NULL
;
8417 EMACS_INT start_pos
;
8422 start_pos
= IT_CHARPOS (*it
);
8424 /* Estimate how many newlines we must move back. */
8425 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8427 /* Set the iterator's position that many lines back. */
8428 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8429 back_to_previous_visible_line_start (it
);
8431 /* Reseat the iterator here. When moving backward, we don't want
8432 reseat to skip forward over invisible text, set up the iterator
8433 to deliver from overlay strings at the new position etc. So,
8434 use reseat_1 here. */
8435 reseat_1 (it
, it
->current
.pos
, 1);
8437 /* We are now surely at a line start. */
8438 it
->current_x
= it
->hpos
= 0;
8439 it
->continuation_lines_width
= 0;
8441 /* Move forward and see what y-distance we moved. First move to the
8442 start of the next line so that we get its height. We need this
8443 height to be able to tell whether we reached the specified
8445 SAVE_IT (it2
, *it
, it2data
);
8446 it2
.max_ascent
= it2
.max_descent
= 0;
8449 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8450 MOVE_TO_POS
| MOVE_TO_VPOS
);
8452 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8453 xassert (IT_CHARPOS (*it
) >= BEGV
);
8454 SAVE_IT (it3
, it2
, it3data
);
8456 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8457 xassert (IT_CHARPOS (*it
) >= BEGV
);
8458 /* H is the actual vertical distance from the position in *IT
8459 and the starting position. */
8460 h
= it2
.current_y
- it
->current_y
;
8461 /* NLINES is the distance in number of lines. */
8462 nlines
= it2
.vpos
- it
->vpos
;
8464 /* Correct IT's y and vpos position
8465 so that they are relative to the starting point. */
8471 /* DY == 0 means move to the start of the screen line. The
8472 value of nlines is > 0 if continuation lines were involved. */
8473 RESTORE_IT (it
, it
, it2data
);
8475 move_it_by_lines (it
, nlines
);
8476 bidi_unshelve_cache (it3data
, 1);
8480 /* The y-position we try to reach, relative to *IT.
8481 Note that H has been subtracted in front of the if-statement. */
8482 int target_y
= it
->current_y
+ h
- dy
;
8483 int y0
= it3
.current_y
;
8487 RESTORE_IT (&it3
, &it3
, it3data
);
8488 y1
= line_bottom_y (&it3
);
8489 line_height
= y1
- y0
;
8490 RESTORE_IT (it
, it
, it2data
);
8491 /* If we did not reach target_y, try to move further backward if
8492 we can. If we moved too far backward, try to move forward. */
8493 if (target_y
< it
->current_y
8494 /* This is heuristic. In a window that's 3 lines high, with
8495 a line height of 13 pixels each, recentering with point
8496 on the bottom line will try to move -39/2 = 19 pixels
8497 backward. Try to avoid moving into the first line. */
8498 && (it
->current_y
- target_y
8499 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8500 && IT_CHARPOS (*it
) > BEGV
)
8502 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8503 target_y
- it
->current_y
));
8504 dy
= it
->current_y
- target_y
;
8505 goto move_further_back
;
8507 else if (target_y
>= it
->current_y
+ line_height
8508 && IT_CHARPOS (*it
) < ZV
)
8510 /* Should move forward by at least one line, maybe more.
8512 Note: Calling move_it_by_lines can be expensive on
8513 terminal frames, where compute_motion is used (via
8514 vmotion) to do the job, when there are very long lines
8515 and truncate-lines is nil. That's the reason for
8516 treating terminal frames specially here. */
8518 if (!FRAME_WINDOW_P (it
->f
))
8519 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8524 move_it_by_lines (it
, 1);
8526 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8533 /* Move IT by a specified amount of pixel lines DY. DY negative means
8534 move backwards. DY = 0 means move to start of screen line. At the
8535 end, IT will be on the start of a screen line. */
8538 move_it_vertically (struct it
*it
, int dy
)
8541 move_it_vertically_backward (it
, -dy
);
8544 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8545 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8546 MOVE_TO_POS
| MOVE_TO_Y
);
8547 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8549 /* If buffer ends in ZV without a newline, move to the start of
8550 the line to satisfy the post-condition. */
8551 if (IT_CHARPOS (*it
) == ZV
8553 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8554 move_it_by_lines (it
, 0);
8559 /* Move iterator IT past the end of the text line it is in. */
8562 move_it_past_eol (struct it
*it
)
8564 enum move_it_result rc
;
8566 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8567 if (rc
== MOVE_NEWLINE_OR_CR
)
8568 set_iterator_to_next (it
, 0);
8572 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8573 negative means move up. DVPOS == 0 means move to the start of the
8576 Optimization idea: If we would know that IT->f doesn't use
8577 a face with proportional font, we could be faster for
8578 truncate-lines nil. */
8581 move_it_by_lines (struct it
*it
, int dvpos
)
8584 /* The commented-out optimization uses vmotion on terminals. This
8585 gives bad results, because elements like it->what, on which
8586 callers such as pos_visible_p rely, aren't updated. */
8587 /* struct position pos;
8588 if (!FRAME_WINDOW_P (it->f))
8590 struct text_pos textpos;
8592 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8593 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8594 reseat (it, textpos, 1);
8595 it->vpos += pos.vpos;
8596 it->current_y += pos.vpos;
8602 /* DVPOS == 0 means move to the start of the screen line. */
8603 move_it_vertically_backward (it
, 0);
8604 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8605 /* Let next call to line_bottom_y calculate real line height */
8610 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8611 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8612 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8617 void *it2data
= NULL
;
8618 EMACS_INT start_charpos
, i
;
8620 /* Start at the beginning of the screen line containing IT's
8621 position. This may actually move vertically backwards,
8622 in case of overlays, so adjust dvpos accordingly. */
8624 move_it_vertically_backward (it
, 0);
8627 /* Go back -DVPOS visible lines and reseat the iterator there. */
8628 start_charpos
= IT_CHARPOS (*it
);
8629 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8630 back_to_previous_visible_line_start (it
);
8631 reseat (it
, it
->current
.pos
, 1);
8633 /* Move further back if we end up in a string or an image. */
8634 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8636 /* First try to move to start of display line. */
8638 move_it_vertically_backward (it
, 0);
8640 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8642 /* If start of line is still in string or image,
8643 move further back. */
8644 back_to_previous_visible_line_start (it
);
8645 reseat (it
, it
->current
.pos
, 1);
8649 it
->current_x
= it
->hpos
= 0;
8651 /* Above call may have moved too far if continuation lines
8652 are involved. Scan forward and see if it did. */
8653 SAVE_IT (it2
, *it
, it2data
);
8654 it2
.vpos
= it2
.current_y
= 0;
8655 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8656 it
->vpos
-= it2
.vpos
;
8657 it
->current_y
-= it2
.current_y
;
8658 it
->current_x
= it
->hpos
= 0;
8660 /* If we moved too far back, move IT some lines forward. */
8661 if (it2
.vpos
> -dvpos
)
8663 int delta
= it2
.vpos
+ dvpos
;
8665 RESTORE_IT (&it2
, &it2
, it2data
);
8666 SAVE_IT (it2
, *it
, it2data
);
8667 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8668 /* Move back again if we got too far ahead. */
8669 if (IT_CHARPOS (*it
) >= start_charpos
)
8670 RESTORE_IT (it
, &it2
, it2data
);
8672 bidi_unshelve_cache (it2data
, 1);
8675 RESTORE_IT (it
, it
, it2data
);
8679 /* Return 1 if IT points into the middle of a display vector. */
8682 in_display_vector_p (struct it
*it
)
8684 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8685 && it
->current
.dpvec_index
> 0
8686 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8690 /***********************************************************************
8692 ***********************************************************************/
8695 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8699 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8701 Lisp_Object args
[3];
8702 Lisp_Object msg
, fmt
;
8705 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8708 /* Do nothing if called asynchronously. Inserting text into
8709 a buffer may call after-change-functions and alike and
8710 that would means running Lisp asynchronously. */
8711 if (handling_signal
)
8715 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8717 args
[0] = fmt
= build_string (format
);
8720 msg
= Fformat (3, args
);
8722 len
= SBYTES (msg
) + 1;
8723 SAFE_ALLOCA (buffer
, char *, len
);
8724 memcpy (buffer
, SDATA (msg
), len
);
8726 message_dolog (buffer
, len
- 1, 1, 0);
8733 /* Output a newline in the *Messages* buffer if "needs" one. */
8736 message_log_maybe_newline (void)
8738 if (message_log_need_newline
)
8739 message_dolog ("", 0, 1, 0);
8743 /* Add a string M of length NBYTES to the message log, optionally
8744 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8745 nonzero, means interpret the contents of M as multibyte. This
8746 function calls low-level routines in order to bypass text property
8747 hooks, etc. which might not be safe to run.
8749 This may GC (insert may run before/after change hooks),
8750 so the buffer M must NOT point to a Lisp string. */
8753 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8755 const unsigned char *msg
= (const unsigned char *) m
;
8757 if (!NILP (Vmemory_full
))
8760 if (!NILP (Vmessage_log_max
))
8762 struct buffer
*oldbuf
;
8763 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8764 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8765 EMACS_INT point_at_end
= 0;
8766 EMACS_INT zv_at_end
= 0;
8767 Lisp_Object old_deactivate_mark
, tem
;
8768 struct gcpro gcpro1
;
8770 old_deactivate_mark
= Vdeactivate_mark
;
8771 oldbuf
= current_buffer
;
8772 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8773 BVAR (current_buffer
, undo_list
) = Qt
;
8775 oldpoint
= message_dolog_marker1
;
8776 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8777 oldbegv
= message_dolog_marker2
;
8778 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8779 oldzv
= message_dolog_marker3
;
8780 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8781 GCPRO1 (old_deactivate_mark
);
8789 BEGV_BYTE
= BEG_BYTE
;
8792 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8794 /* Insert the string--maybe converting multibyte to single byte
8795 or vice versa, so that all the text fits the buffer. */
8797 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8803 /* Convert a multibyte string to single-byte
8804 for the *Message* buffer. */
8805 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8807 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8808 work
[0] = (ASCII_CHAR_P (c
)
8810 : multibyte_char_to_unibyte (c
));
8811 insert_1_both (work
, 1, 1, 1, 0, 0);
8814 else if (! multibyte
8815 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8819 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8820 /* Convert a single-byte string to multibyte
8821 for the *Message* buffer. */
8822 for (i
= 0; i
< nbytes
; i
++)
8825 MAKE_CHAR_MULTIBYTE (c
);
8826 char_bytes
= CHAR_STRING (c
, str
);
8827 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8831 insert_1 (m
, nbytes
, 1, 0, 0);
8835 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8837 insert_1 ("\n", 1, 1, 0, 0);
8839 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8841 this_bol_byte
= PT_BYTE
;
8843 /* See if this line duplicates the previous one.
8844 If so, combine duplicates. */
8847 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8849 prev_bol_byte
= PT_BYTE
;
8851 dups
= message_log_check_duplicate (prev_bol_byte
,
8855 del_range_both (prev_bol
, prev_bol_byte
,
8856 this_bol
, this_bol_byte
, 0);
8859 char dupstr
[sizeof " [ times]"
8860 + INT_STRLEN_BOUND (printmax_t
)];
8863 /* If you change this format, don't forget to also
8864 change message_log_check_duplicate. */
8865 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8866 duplen
= strlen (dupstr
);
8867 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8868 insert_1 (dupstr
, duplen
, 1, 0, 1);
8873 /* If we have more than the desired maximum number of lines
8874 in the *Messages* buffer now, delete the oldest ones.
8875 This is safe because we don't have undo in this buffer. */
8877 if (NATNUMP (Vmessage_log_max
))
8879 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8880 -XFASTINT (Vmessage_log_max
) - 1, 0);
8881 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8884 BEGV
= XMARKER (oldbegv
)->charpos
;
8885 BEGV_BYTE
= marker_byte_position (oldbegv
);
8894 ZV
= XMARKER (oldzv
)->charpos
;
8895 ZV_BYTE
= marker_byte_position (oldzv
);
8899 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8901 /* We can't do Fgoto_char (oldpoint) because it will run some
8903 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8904 XMARKER (oldpoint
)->bytepos
);
8907 unchain_marker (XMARKER (oldpoint
));
8908 unchain_marker (XMARKER (oldbegv
));
8909 unchain_marker (XMARKER (oldzv
));
8911 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8912 set_buffer_internal (oldbuf
);
8914 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8915 message_log_need_newline
= !nlflag
;
8916 Vdeactivate_mark
= old_deactivate_mark
;
8921 /* We are at the end of the buffer after just having inserted a newline.
8922 (Note: We depend on the fact we won't be crossing the gap.)
8923 Check to see if the most recent message looks a lot like the previous one.
8924 Return 0 if different, 1 if the new one should just replace it, or a
8925 value N > 1 if we should also append " [N times]". */
8928 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8931 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8933 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8934 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8936 for (i
= 0; i
< len
; i
++)
8938 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8946 if (*p1
++ == ' ' && *p1
++ == '[')
8949 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8950 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8957 /* Display an echo area message M with a specified length of NBYTES
8958 bytes. The string may include null characters. If M is 0, clear
8959 out any existing message, and let the mini-buffer text show
8962 This may GC, so the buffer M must NOT point to a Lisp string. */
8965 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8967 /* First flush out any partial line written with print. */
8968 message_log_maybe_newline ();
8970 message_dolog (m
, nbytes
, 1, multibyte
);
8971 message2_nolog (m
, nbytes
, multibyte
);
8975 /* The non-logging counterpart of message2. */
8978 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8980 struct frame
*sf
= SELECTED_FRAME ();
8981 message_enable_multibyte
= multibyte
;
8983 if (FRAME_INITIAL_P (sf
))
8985 if (noninteractive_need_newline
)
8986 putc ('\n', stderr
);
8987 noninteractive_need_newline
= 0;
8989 fwrite (m
, nbytes
, 1, stderr
);
8990 if (cursor_in_echo_area
== 0)
8991 fprintf (stderr
, "\n");
8994 /* A null message buffer means that the frame hasn't really been
8995 initialized yet. Error messages get reported properly by
8996 cmd_error, so this must be just an informative message; toss it. */
8997 else if (INTERACTIVE
8998 && sf
->glyphs_initialized_p
8999 && FRAME_MESSAGE_BUF (sf
))
9001 Lisp_Object mini_window
;
9004 /* Get the frame containing the mini-buffer
9005 that the selected frame is using. */
9006 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9007 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9009 FRAME_SAMPLE_VISIBILITY (f
);
9010 if (FRAME_VISIBLE_P (sf
)
9011 && ! FRAME_VISIBLE_P (f
))
9012 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9016 set_message (m
, Qnil
, nbytes
, multibyte
);
9017 if (minibuffer_auto_raise
)
9018 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9021 clear_message (1, 1);
9023 do_pending_window_change (0);
9024 echo_area_display (1);
9025 do_pending_window_change (0);
9026 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9027 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9032 /* Display an echo area message M with a specified length of NBYTES
9033 bytes. The string may include null characters. If M is not a
9034 string, clear out any existing message, and let the mini-buffer
9037 This function cancels echoing. */
9040 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9042 struct gcpro gcpro1
;
9045 clear_message (1,1);
9048 /* First flush out any partial line written with print. */
9049 message_log_maybe_newline ();
9055 SAFE_ALLOCA (buffer
, char *, nbytes
);
9056 memcpy (buffer
, SDATA (m
), nbytes
);
9057 message_dolog (buffer
, nbytes
, 1, multibyte
);
9060 message3_nolog (m
, nbytes
, multibyte
);
9066 /* The non-logging version of message3.
9067 This does not cancel echoing, because it is used for echoing.
9068 Perhaps we need to make a separate function for echoing
9069 and make this cancel echoing. */
9072 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9074 struct frame
*sf
= SELECTED_FRAME ();
9075 message_enable_multibyte
= multibyte
;
9077 if (FRAME_INITIAL_P (sf
))
9079 if (noninteractive_need_newline
)
9080 putc ('\n', stderr
);
9081 noninteractive_need_newline
= 0;
9083 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9084 if (cursor_in_echo_area
== 0)
9085 fprintf (stderr
, "\n");
9088 /* A null message buffer means that the frame hasn't really been
9089 initialized yet. Error messages get reported properly by
9090 cmd_error, so this must be just an informative message; toss it. */
9091 else if (INTERACTIVE
9092 && sf
->glyphs_initialized_p
9093 && FRAME_MESSAGE_BUF (sf
))
9095 Lisp_Object mini_window
;
9099 /* Get the frame containing the mini-buffer
9100 that the selected frame is using. */
9101 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9102 frame
= XWINDOW (mini_window
)->frame
;
9105 FRAME_SAMPLE_VISIBILITY (f
);
9106 if (FRAME_VISIBLE_P (sf
)
9107 && !FRAME_VISIBLE_P (f
))
9108 Fmake_frame_visible (frame
);
9110 if (STRINGP (m
) && SCHARS (m
) > 0)
9112 set_message (NULL
, m
, nbytes
, multibyte
);
9113 if (minibuffer_auto_raise
)
9114 Fraise_frame (frame
);
9115 /* Assume we are not echoing.
9116 (If we are, echo_now will override this.) */
9117 echo_message_buffer
= Qnil
;
9120 clear_message (1, 1);
9122 do_pending_window_change (0);
9123 echo_area_display (1);
9124 do_pending_window_change (0);
9125 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9126 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9131 /* Display a null-terminated echo area message M. If M is 0, clear
9132 out any existing message, and let the mini-buffer text show through.
9134 The buffer M must continue to exist until after the echo area gets
9135 cleared or some other message gets displayed there. Do not pass
9136 text that is stored in a Lisp string. Do not pass text in a buffer
9137 that was alloca'd. */
9140 message1 (const char *m
)
9142 message2 (m
, (m
? strlen (m
) : 0), 0);
9146 /* The non-logging counterpart of message1. */
9149 message1_nolog (const char *m
)
9151 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9154 /* Display a message M which contains a single %s
9155 which gets replaced with STRING. */
9158 message_with_string (const char *m
, Lisp_Object string
, int log
)
9160 CHECK_STRING (string
);
9166 if (noninteractive_need_newline
)
9167 putc ('\n', stderr
);
9168 noninteractive_need_newline
= 0;
9169 fprintf (stderr
, m
, SDATA (string
));
9170 if (!cursor_in_echo_area
)
9171 fprintf (stderr
, "\n");
9175 else if (INTERACTIVE
)
9177 /* The frame whose minibuffer we're going to display the message on.
9178 It may be larger than the selected frame, so we need
9179 to use its buffer, not the selected frame's buffer. */
9180 Lisp_Object mini_window
;
9181 struct frame
*f
, *sf
= SELECTED_FRAME ();
9183 /* Get the frame containing the minibuffer
9184 that the selected frame is using. */
9185 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9186 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9188 /* A null message buffer means that the frame hasn't really been
9189 initialized yet. Error messages get reported properly by
9190 cmd_error, so this must be just an informative message; toss it. */
9191 if (FRAME_MESSAGE_BUF (f
))
9193 Lisp_Object args
[2], msg
;
9194 struct gcpro gcpro1
, gcpro2
;
9196 args
[0] = build_string (m
);
9197 args
[1] = msg
= string
;
9198 GCPRO2 (args
[0], msg
);
9201 msg
= Fformat (2, args
);
9204 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9206 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9210 /* Print should start at the beginning of the message
9211 buffer next time. */
9212 message_buf_print
= 0;
9218 /* Dump an informative message to the minibuf. If M is 0, clear out
9219 any existing message, and let the mini-buffer text show through. */
9222 vmessage (const char *m
, va_list ap
)
9228 if (noninteractive_need_newline
)
9229 putc ('\n', stderr
);
9230 noninteractive_need_newline
= 0;
9231 vfprintf (stderr
, m
, ap
);
9232 if (cursor_in_echo_area
== 0)
9233 fprintf (stderr
, "\n");
9237 else if (INTERACTIVE
)
9239 /* The frame whose mini-buffer we're going to display the message
9240 on. It may be larger than the selected frame, so we need to
9241 use its buffer, not the selected frame's buffer. */
9242 Lisp_Object mini_window
;
9243 struct frame
*f
, *sf
= SELECTED_FRAME ();
9245 /* Get the frame containing the mini-buffer
9246 that the selected frame is using. */
9247 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9248 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9250 /* A null message buffer means that the frame hasn't really been
9251 initialized yet. Error messages get reported properly by
9252 cmd_error, so this must be just an informative message; toss
9254 if (FRAME_MESSAGE_BUF (f
))
9260 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9261 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9263 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9268 /* Print should start at the beginning of the message
9269 buffer next time. */
9270 message_buf_print
= 0;
9276 message (const char *m
, ...)
9286 /* The non-logging version of message. */
9289 message_nolog (const char *m
, ...)
9291 Lisp_Object old_log_max
;
9294 old_log_max
= Vmessage_log_max
;
9295 Vmessage_log_max
= Qnil
;
9297 Vmessage_log_max
= old_log_max
;
9303 /* Display the current message in the current mini-buffer. This is
9304 only called from error handlers in process.c, and is not time
9308 update_echo_area (void)
9310 if (!NILP (echo_area_buffer
[0]))
9313 string
= Fcurrent_message ();
9314 message3 (string
, SBYTES (string
),
9315 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9320 /* Make sure echo area buffers in `echo_buffers' are live.
9321 If they aren't, make new ones. */
9324 ensure_echo_area_buffers (void)
9328 for (i
= 0; i
< 2; ++i
)
9329 if (!BUFFERP (echo_buffer
[i
])
9330 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9333 Lisp_Object old_buffer
;
9336 old_buffer
= echo_buffer
[i
];
9337 sprintf (name
, " *Echo Area %d*", i
);
9338 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9339 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9340 /* to force word wrap in echo area -
9341 it was decided to postpone this*/
9342 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9344 for (j
= 0; j
< 2; ++j
)
9345 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9346 echo_area_buffer
[j
] = echo_buffer
[i
];
9351 /* Call FN with args A1..A4 with either the current or last displayed
9352 echo_area_buffer as current buffer.
9354 WHICH zero means use the current message buffer
9355 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9356 from echo_buffer[] and clear it.
9358 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9359 suitable buffer from echo_buffer[] and clear it.
9361 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9362 that the current message becomes the last displayed one, make
9363 choose a suitable buffer for echo_area_buffer[0], and clear it.
9365 Value is what FN returns. */
9368 with_echo_area_buffer (struct window
*w
, int which
,
9369 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9370 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9373 int this_one
, the_other
, clear_buffer_p
, rc
;
9374 int count
= SPECPDL_INDEX ();
9376 /* If buffers aren't live, make new ones. */
9377 ensure_echo_area_buffers ();
9382 this_one
= 0, the_other
= 1;
9384 this_one
= 1, the_other
= 0;
9387 this_one
= 0, the_other
= 1;
9390 /* We need a fresh one in case the current echo buffer equals
9391 the one containing the last displayed echo area message. */
9392 if (!NILP (echo_area_buffer
[this_one
])
9393 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9394 echo_area_buffer
[this_one
] = Qnil
;
9397 /* Choose a suitable buffer from echo_buffer[] is we don't
9399 if (NILP (echo_area_buffer
[this_one
]))
9401 echo_area_buffer
[this_one
]
9402 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9403 ? echo_buffer
[the_other
]
9404 : echo_buffer
[this_one
]);
9408 buffer
= echo_area_buffer
[this_one
];
9410 /* Don't get confused by reusing the buffer used for echoing
9411 for a different purpose. */
9412 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9415 record_unwind_protect (unwind_with_echo_area_buffer
,
9416 with_echo_area_buffer_unwind_data (w
));
9418 /* Make the echo area buffer current. Note that for display
9419 purposes, it is not necessary that the displayed window's buffer
9420 == current_buffer, except for text property lookup. So, let's
9421 only set that buffer temporarily here without doing a full
9422 Fset_window_buffer. We must also change w->pointm, though,
9423 because otherwise an assertions in unshow_buffer fails, and Emacs
9425 set_buffer_internal_1 (XBUFFER (buffer
));
9429 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9432 BVAR (current_buffer
, undo_list
) = Qt
;
9433 BVAR (current_buffer
, read_only
) = Qnil
;
9434 specbind (Qinhibit_read_only
, Qt
);
9435 specbind (Qinhibit_modification_hooks
, Qt
);
9437 if (clear_buffer_p
&& Z
> BEG
)
9440 xassert (BEGV
>= BEG
);
9441 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9443 rc
= fn (a1
, a2
, a3
, a4
);
9445 xassert (BEGV
>= BEG
);
9446 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9448 unbind_to (count
, Qnil
);
9453 /* Save state that should be preserved around the call to the function
9454 FN called in with_echo_area_buffer. */
9457 with_echo_area_buffer_unwind_data (struct window
*w
)
9460 Lisp_Object vector
, tmp
;
9462 /* Reduce consing by keeping one vector in
9463 Vwith_echo_area_save_vector. */
9464 vector
= Vwith_echo_area_save_vector
;
9465 Vwith_echo_area_save_vector
= Qnil
;
9468 vector
= Fmake_vector (make_number (7), Qnil
);
9470 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9471 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9472 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9476 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9477 ASET (vector
, i
, w
->buffer
); ++i
;
9478 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9479 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9484 for (; i
< end
; ++i
)
9485 ASET (vector
, i
, Qnil
);
9488 xassert (i
== ASIZE (vector
));
9493 /* Restore global state from VECTOR which was created by
9494 with_echo_area_buffer_unwind_data. */
9497 unwind_with_echo_area_buffer (Lisp_Object vector
)
9499 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9500 Vdeactivate_mark
= AREF (vector
, 1);
9501 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9503 if (WINDOWP (AREF (vector
, 3)))
9506 Lisp_Object buffer
, charpos
, bytepos
;
9508 w
= XWINDOW (AREF (vector
, 3));
9509 buffer
= AREF (vector
, 4);
9510 charpos
= AREF (vector
, 5);
9511 bytepos
= AREF (vector
, 6);
9514 set_marker_both (w
->pointm
, buffer
,
9515 XFASTINT (charpos
), XFASTINT (bytepos
));
9518 Vwith_echo_area_save_vector
= vector
;
9523 /* Set up the echo area for use by print functions. MULTIBYTE_P
9524 non-zero means we will print multibyte. */
9527 setup_echo_area_for_printing (int multibyte_p
)
9529 /* If we can't find an echo area any more, exit. */
9530 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9533 ensure_echo_area_buffers ();
9535 if (!message_buf_print
)
9537 /* A message has been output since the last time we printed.
9538 Choose a fresh echo area buffer. */
9539 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9540 echo_area_buffer
[0] = echo_buffer
[1];
9542 echo_area_buffer
[0] = echo_buffer
[0];
9544 /* Switch to that buffer and clear it. */
9545 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9546 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9550 int count
= SPECPDL_INDEX ();
9551 specbind (Qinhibit_read_only
, Qt
);
9552 /* Note that undo recording is always disabled. */
9554 unbind_to (count
, Qnil
);
9556 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9558 /* Set up the buffer for the multibyteness we need. */
9560 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9561 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9563 /* Raise the frame containing the echo area. */
9564 if (minibuffer_auto_raise
)
9566 struct frame
*sf
= SELECTED_FRAME ();
9567 Lisp_Object mini_window
;
9568 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9569 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9572 message_log_maybe_newline ();
9573 message_buf_print
= 1;
9577 if (NILP (echo_area_buffer
[0]))
9579 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9580 echo_area_buffer
[0] = echo_buffer
[1];
9582 echo_area_buffer
[0] = echo_buffer
[0];
9585 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9587 /* Someone switched buffers between print requests. */
9588 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9589 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9595 /* Display an echo area message in window W. Value is non-zero if W's
9596 height is changed. If display_last_displayed_message_p is
9597 non-zero, display the message that was last displayed, otherwise
9598 display the current message. */
9601 display_echo_area (struct window
*w
)
9603 int i
, no_message_p
, window_height_changed_p
, count
;
9605 /* Temporarily disable garbage collections while displaying the echo
9606 area. This is done because a GC can print a message itself.
9607 That message would modify the echo area buffer's contents while a
9608 redisplay of the buffer is going on, and seriously confuse
9610 count
= inhibit_garbage_collection ();
9612 /* If there is no message, we must call display_echo_area_1
9613 nevertheless because it resizes the window. But we will have to
9614 reset the echo_area_buffer in question to nil at the end because
9615 with_echo_area_buffer will sets it to an empty buffer. */
9616 i
= display_last_displayed_message_p
? 1 : 0;
9617 no_message_p
= NILP (echo_area_buffer
[i
]);
9619 window_height_changed_p
9620 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9621 display_echo_area_1
,
9622 (intptr_t) w
, Qnil
, 0, 0);
9625 echo_area_buffer
[i
] = Qnil
;
9627 unbind_to (count
, Qnil
);
9628 return window_height_changed_p
;
9632 /* Helper for display_echo_area. Display the current buffer which
9633 contains the current echo area message in window W, a mini-window,
9634 a pointer to which is passed in A1. A2..A4 are currently not used.
9635 Change the height of W so that all of the message is displayed.
9636 Value is non-zero if height of W was changed. */
9639 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9642 struct window
*w
= (struct window
*) i1
;
9644 struct text_pos start
;
9645 int window_height_changed_p
= 0;
9647 /* Do this before displaying, so that we have a large enough glyph
9648 matrix for the display. If we can't get enough space for the
9649 whole text, display the last N lines. That works by setting w->start. */
9650 window_height_changed_p
= resize_mini_window (w
, 0);
9652 /* Use the starting position chosen by resize_mini_window. */
9653 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9656 clear_glyph_matrix (w
->desired_matrix
);
9657 XSETWINDOW (window
, w
);
9658 try_window (window
, start
, 0);
9660 return window_height_changed_p
;
9664 /* Resize the echo area window to exactly the size needed for the
9665 currently displayed message, if there is one. If a mini-buffer
9666 is active, don't shrink it. */
9669 resize_echo_area_exactly (void)
9671 if (BUFFERP (echo_area_buffer
[0])
9672 && WINDOWP (echo_area_window
))
9674 struct window
*w
= XWINDOW (echo_area_window
);
9676 Lisp_Object resize_exactly
;
9678 if (minibuf_level
== 0)
9679 resize_exactly
= Qt
;
9681 resize_exactly
= Qnil
;
9683 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9684 (intptr_t) w
, resize_exactly
,
9688 ++windows_or_buffers_changed
;
9689 ++update_mode_lines
;
9690 redisplay_internal ();
9696 /* Callback function for with_echo_area_buffer, when used from
9697 resize_echo_area_exactly. A1 contains a pointer to the window to
9698 resize, EXACTLY non-nil means resize the mini-window exactly to the
9699 size of the text displayed. A3 and A4 are not used. Value is what
9700 resize_mini_window returns. */
9703 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9706 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9710 /* Resize mini-window W to fit the size of its contents. EXACT_P
9711 means size the window exactly to the size needed. Otherwise, it's
9712 only enlarged until W's buffer is empty.
9714 Set W->start to the right place to begin display. If the whole
9715 contents fit, start at the beginning. Otherwise, start so as
9716 to make the end of the contents appear. This is particularly
9717 important for y-or-n-p, but seems desirable generally.
9719 Value is non-zero if the window height has been changed. */
9722 resize_mini_window (struct window
*w
, int exact_p
)
9724 struct frame
*f
= XFRAME (w
->frame
);
9725 int window_height_changed_p
= 0;
9727 xassert (MINI_WINDOW_P (w
));
9729 /* By default, start display at the beginning. */
9730 set_marker_both (w
->start
, w
->buffer
,
9731 BUF_BEGV (XBUFFER (w
->buffer
)),
9732 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9734 /* Don't resize windows while redisplaying a window; it would
9735 confuse redisplay functions when the size of the window they are
9736 displaying changes from under them. Such a resizing can happen,
9737 for instance, when which-func prints a long message while
9738 we are running fontification-functions. We're running these
9739 functions with safe_call which binds inhibit-redisplay to t. */
9740 if (!NILP (Vinhibit_redisplay
))
9743 /* Nil means don't try to resize. */
9744 if (NILP (Vresize_mini_windows
)
9745 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9748 if (!FRAME_MINIBUF_ONLY_P (f
))
9751 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9752 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9753 int height
, max_height
;
9754 int unit
= FRAME_LINE_HEIGHT (f
);
9755 struct text_pos start
;
9756 struct buffer
*old_current_buffer
= NULL
;
9758 if (current_buffer
!= XBUFFER (w
->buffer
))
9760 old_current_buffer
= current_buffer
;
9761 set_buffer_internal (XBUFFER (w
->buffer
));
9764 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9766 /* Compute the max. number of lines specified by the user. */
9767 if (FLOATP (Vmax_mini_window_height
))
9768 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9769 else if (INTEGERP (Vmax_mini_window_height
))
9770 max_height
= XINT (Vmax_mini_window_height
);
9772 max_height
= total_height
/ 4;
9774 /* Correct that max. height if it's bogus. */
9775 max_height
= max (1, max_height
);
9776 max_height
= min (total_height
, max_height
);
9778 /* Find out the height of the text in the window. */
9779 if (it
.line_wrap
== TRUNCATE
)
9784 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9785 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9786 height
= it
.current_y
+ last_height
;
9788 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9789 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9790 height
= (height
+ unit
- 1) / unit
;
9793 /* Compute a suitable window start. */
9794 if (height
> max_height
)
9796 height
= max_height
;
9797 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9798 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9799 start
= it
.current
.pos
;
9802 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9803 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9805 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9807 /* Let it grow only, until we display an empty message, in which
9808 case the window shrinks again. */
9809 if (height
> WINDOW_TOTAL_LINES (w
))
9811 int old_height
= WINDOW_TOTAL_LINES (w
);
9812 freeze_window_starts (f
, 1);
9813 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9814 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9816 else if (height
< WINDOW_TOTAL_LINES (w
)
9817 && (exact_p
|| BEGV
== ZV
))
9819 int old_height
= WINDOW_TOTAL_LINES (w
);
9820 freeze_window_starts (f
, 0);
9821 shrink_mini_window (w
);
9822 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9827 /* Always resize to exact size needed. */
9828 if (height
> WINDOW_TOTAL_LINES (w
))
9830 int old_height
= WINDOW_TOTAL_LINES (w
);
9831 freeze_window_starts (f
, 1);
9832 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9833 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9835 else if (height
< WINDOW_TOTAL_LINES (w
))
9837 int old_height
= WINDOW_TOTAL_LINES (w
);
9838 freeze_window_starts (f
, 0);
9839 shrink_mini_window (w
);
9843 freeze_window_starts (f
, 1);
9844 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9847 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9851 if (old_current_buffer
)
9852 set_buffer_internal (old_current_buffer
);
9855 return window_height_changed_p
;
9859 /* Value is the current message, a string, or nil if there is no
9863 current_message (void)
9867 if (!BUFFERP (echo_area_buffer
[0]))
9871 with_echo_area_buffer (0, 0, current_message_1
,
9872 (intptr_t) &msg
, Qnil
, 0, 0);
9874 echo_area_buffer
[0] = Qnil
;
9882 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9885 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9888 *msg
= make_buffer_string (BEG
, Z
, 1);
9895 /* Push the current message on Vmessage_stack for later restauration
9896 by restore_message. Value is non-zero if the current message isn't
9897 empty. This is a relatively infrequent operation, so it's not
9898 worth optimizing. */
9904 msg
= current_message ();
9905 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9906 return STRINGP (msg
);
9910 /* Restore message display from the top of Vmessage_stack. */
9913 restore_message (void)
9917 xassert (CONSP (Vmessage_stack
));
9918 msg
= XCAR (Vmessage_stack
);
9920 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9922 message3_nolog (msg
, 0, 0);
9926 /* Handler for record_unwind_protect calling pop_message. */
9929 pop_message_unwind (Lisp_Object dummy
)
9935 /* Pop the top-most entry off Vmessage_stack. */
9940 xassert (CONSP (Vmessage_stack
));
9941 Vmessage_stack
= XCDR (Vmessage_stack
);
9945 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9946 exits. If the stack is not empty, we have a missing pop_message
9950 check_message_stack (void)
9952 if (!NILP (Vmessage_stack
))
9957 /* Truncate to NCHARS what will be displayed in the echo area the next
9958 time we display it---but don't redisplay it now. */
9961 truncate_echo_area (EMACS_INT nchars
)
9964 echo_area_buffer
[0] = Qnil
;
9965 /* A null message buffer means that the frame hasn't really been
9966 initialized yet. Error messages get reported properly by
9967 cmd_error, so this must be just an informative message; toss it. */
9968 else if (!noninteractive
9970 && !NILP (echo_area_buffer
[0]))
9972 struct frame
*sf
= SELECTED_FRAME ();
9973 if (FRAME_MESSAGE_BUF (sf
))
9974 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9979 /* Helper function for truncate_echo_area. Truncate the current
9980 message to at most NCHARS characters. */
9983 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9985 if (BEG
+ nchars
< Z
)
9986 del_range (BEG
+ nchars
, Z
);
9988 echo_area_buffer
[0] = Qnil
;
9993 /* Set the current message to a substring of S or STRING.
9995 If STRING is a Lisp string, set the message to the first NBYTES
9996 bytes from STRING. NBYTES zero means use the whole string. If
9997 STRING is multibyte, the message will be displayed multibyte.
9999 If S is not null, set the message to the first LEN bytes of S. LEN
10000 zero means use the whole string. MULTIBYTE_P non-zero means S is
10001 multibyte. Display the message multibyte in that case.
10003 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10004 to t before calling set_message_1 (which calls insert).
10008 set_message (const char *s
, Lisp_Object string
,
10009 EMACS_INT nbytes
, int multibyte_p
)
10011 message_enable_multibyte
10012 = ((s
&& multibyte_p
)
10013 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10015 with_echo_area_buffer (0, -1, set_message_1
,
10016 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10017 message_buf_print
= 0;
10018 help_echo_showing_p
= 0;
10022 /* Helper function for set_message. Arguments have the same meaning
10023 as there, with A1 corresponding to S and A2 corresponding to STRING
10024 This function is called with the echo area buffer being
10028 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10031 const char *s
= (const char *) i1
;
10032 const unsigned char *msg
= (const unsigned char *) s
;
10033 Lisp_Object string
= a2
;
10035 /* Change multibyteness of the echo buffer appropriately. */
10036 if (message_enable_multibyte
10037 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10038 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10040 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10041 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10042 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10044 /* Insert new message at BEG. */
10045 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10047 if (STRINGP (string
))
10052 nbytes
= SBYTES (string
);
10053 nchars
= string_byte_to_char (string
, nbytes
);
10055 /* This function takes care of single/multibyte conversion. We
10056 just have to ensure that the echo area buffer has the right
10057 setting of enable_multibyte_characters. */
10058 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10063 nbytes
= strlen (s
);
10065 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10067 /* Convert from multi-byte to single-byte. */
10072 /* Convert a multibyte string to single-byte. */
10073 for (i
= 0; i
< nbytes
; i
+= n
)
10075 c
= string_char_and_length (msg
+ i
, &n
);
10076 work
[0] = (ASCII_CHAR_P (c
)
10078 : multibyte_char_to_unibyte (c
));
10079 insert_1_both (work
, 1, 1, 1, 0, 0);
10082 else if (!multibyte_p
10083 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10085 /* Convert from single-byte to multi-byte. */
10088 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10090 /* Convert a single-byte string to multibyte. */
10091 for (i
= 0; i
< nbytes
; i
++)
10094 MAKE_CHAR_MULTIBYTE (c
);
10095 n
= CHAR_STRING (c
, str
);
10096 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10100 insert_1 (s
, nbytes
, 1, 0, 0);
10107 /* Clear messages. CURRENT_P non-zero means clear the current
10108 message. LAST_DISPLAYED_P non-zero means clear the message
10112 clear_message (int current_p
, int last_displayed_p
)
10116 echo_area_buffer
[0] = Qnil
;
10117 message_cleared_p
= 1;
10120 if (last_displayed_p
)
10121 echo_area_buffer
[1] = Qnil
;
10123 message_buf_print
= 0;
10126 /* Clear garbaged frames.
10128 This function is used where the old redisplay called
10129 redraw_garbaged_frames which in turn called redraw_frame which in
10130 turn called clear_frame. The call to clear_frame was a source of
10131 flickering. I believe a clear_frame is not necessary. It should
10132 suffice in the new redisplay to invalidate all current matrices,
10133 and ensure a complete redisplay of all windows. */
10136 clear_garbaged_frames (void)
10138 if (frame_garbaged
)
10140 Lisp_Object tail
, frame
;
10141 int changed_count
= 0;
10143 FOR_EACH_FRAME (tail
, frame
)
10145 struct frame
*f
= XFRAME (frame
);
10147 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10151 Fredraw_frame (frame
);
10152 f
->force_flush_display_p
= 1;
10154 clear_current_matrices (f
);
10161 frame_garbaged
= 0;
10163 ++windows_or_buffers_changed
;
10168 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10169 is non-zero update selected_frame. Value is non-zero if the
10170 mini-windows height has been changed. */
10173 echo_area_display (int update_frame_p
)
10175 Lisp_Object mini_window
;
10178 int window_height_changed_p
= 0;
10179 struct frame
*sf
= SELECTED_FRAME ();
10181 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10182 w
= XWINDOW (mini_window
);
10183 f
= XFRAME (WINDOW_FRAME (w
));
10185 /* Don't display if frame is invisible or not yet initialized. */
10186 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10189 #ifdef HAVE_WINDOW_SYSTEM
10190 /* When Emacs starts, selected_frame may be the initial terminal
10191 frame. If we let this through, a message would be displayed on
10193 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10195 #endif /* HAVE_WINDOW_SYSTEM */
10197 /* Redraw garbaged frames. */
10198 if (frame_garbaged
)
10199 clear_garbaged_frames ();
10201 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10203 echo_area_window
= mini_window
;
10204 window_height_changed_p
= display_echo_area (w
);
10205 w
->must_be_updated_p
= 1;
10207 /* Update the display, unless called from redisplay_internal.
10208 Also don't update the screen during redisplay itself. The
10209 update will happen at the end of redisplay, and an update
10210 here could cause confusion. */
10211 if (update_frame_p
&& !redisplaying_p
)
10215 /* If the display update has been interrupted by pending
10216 input, update mode lines in the frame. Due to the
10217 pending input, it might have been that redisplay hasn't
10218 been called, so that mode lines above the echo area are
10219 garbaged. This looks odd, so we prevent it here. */
10220 if (!display_completed
)
10221 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10223 if (window_height_changed_p
10224 /* Don't do this if Emacs is shutting down. Redisplay
10225 needs to run hooks. */
10226 && !NILP (Vrun_hooks
))
10228 /* Must update other windows. Likewise as in other
10229 cases, don't let this update be interrupted by
10231 int count
= SPECPDL_INDEX ();
10232 specbind (Qredisplay_dont_pause
, Qt
);
10233 windows_or_buffers_changed
= 1;
10234 redisplay_internal ();
10235 unbind_to (count
, Qnil
);
10237 else if (FRAME_WINDOW_P (f
) && n
== 0)
10239 /* Window configuration is the same as before.
10240 Can do with a display update of the echo area,
10241 unless we displayed some mode lines. */
10242 update_single_window (w
, 1);
10243 FRAME_RIF (f
)->flush_display (f
);
10246 update_frame (f
, 1, 1);
10248 /* If cursor is in the echo area, make sure that the next
10249 redisplay displays the minibuffer, so that the cursor will
10250 be replaced with what the minibuffer wants. */
10251 if (cursor_in_echo_area
)
10252 ++windows_or_buffers_changed
;
10255 else if (!EQ (mini_window
, selected_window
))
10256 windows_or_buffers_changed
++;
10258 /* Last displayed message is now the current message. */
10259 echo_area_buffer
[1] = echo_area_buffer
[0];
10260 /* Inform read_char that we're not echoing. */
10261 echo_message_buffer
= Qnil
;
10263 /* Prevent redisplay optimization in redisplay_internal by resetting
10264 this_line_start_pos. This is done because the mini-buffer now
10265 displays the message instead of its buffer text. */
10266 if (EQ (mini_window
, selected_window
))
10267 CHARPOS (this_line_start_pos
) = 0;
10269 return window_height_changed_p
;
10274 /***********************************************************************
10275 Mode Lines and Frame Titles
10276 ***********************************************************************/
10278 /* A buffer for constructing non-propertized mode-line strings and
10279 frame titles in it; allocated from the heap in init_xdisp and
10280 resized as needed in store_mode_line_noprop_char. */
10282 static char *mode_line_noprop_buf
;
10284 /* The buffer's end, and a current output position in it. */
10286 static char *mode_line_noprop_buf_end
;
10287 static char *mode_line_noprop_ptr
;
10289 #define MODE_LINE_NOPROP_LEN(start) \
10290 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10293 MODE_LINE_DISPLAY
= 0,
10297 } mode_line_target
;
10299 /* Alist that caches the results of :propertize.
10300 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10301 static Lisp_Object mode_line_proptrans_alist
;
10303 /* List of strings making up the mode-line. */
10304 static Lisp_Object mode_line_string_list
;
10306 /* Base face property when building propertized mode line string. */
10307 static Lisp_Object mode_line_string_face
;
10308 static Lisp_Object mode_line_string_face_prop
;
10311 /* Unwind data for mode line strings */
10313 static Lisp_Object Vmode_line_unwind_vector
;
10316 format_mode_line_unwind_data (struct buffer
*obuf
,
10318 int save_proptrans
)
10320 Lisp_Object vector
, tmp
;
10322 /* Reduce consing by keeping one vector in
10323 Vwith_echo_area_save_vector. */
10324 vector
= Vmode_line_unwind_vector
;
10325 Vmode_line_unwind_vector
= Qnil
;
10328 vector
= Fmake_vector (make_number (8), Qnil
);
10330 ASET (vector
, 0, make_number (mode_line_target
));
10331 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10332 ASET (vector
, 2, mode_line_string_list
);
10333 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10334 ASET (vector
, 4, mode_line_string_face
);
10335 ASET (vector
, 5, mode_line_string_face_prop
);
10338 XSETBUFFER (tmp
, obuf
);
10341 ASET (vector
, 6, tmp
);
10342 ASET (vector
, 7, owin
);
10348 unwind_format_mode_line (Lisp_Object vector
)
10350 mode_line_target
= XINT (AREF (vector
, 0));
10351 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10352 mode_line_string_list
= AREF (vector
, 2);
10353 if (! EQ (AREF (vector
, 3), Qt
))
10354 mode_line_proptrans_alist
= AREF (vector
, 3);
10355 mode_line_string_face
= AREF (vector
, 4);
10356 mode_line_string_face_prop
= AREF (vector
, 5);
10358 if (!NILP (AREF (vector
, 7)))
10359 /* Select window before buffer, since it may change the buffer. */
10360 Fselect_window (AREF (vector
, 7), Qt
);
10362 if (!NILP (AREF (vector
, 6)))
10364 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10365 ASET (vector
, 6, Qnil
);
10368 Vmode_line_unwind_vector
= vector
;
10373 /* Store a single character C for the frame title in mode_line_noprop_buf.
10374 Re-allocate mode_line_noprop_buf if necessary. */
10377 store_mode_line_noprop_char (char c
)
10379 /* If output position has reached the end of the allocated buffer,
10380 double the buffer's size. */
10381 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10383 int len
= MODE_LINE_NOPROP_LEN (0);
10384 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
10385 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10386 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10387 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10390 *mode_line_noprop_ptr
++ = c
;
10394 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10395 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10396 characters that yield more columns than PRECISION; PRECISION <= 0
10397 means copy the whole string. Pad with spaces until FIELD_WIDTH
10398 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10399 pad. Called from display_mode_element when it is used to build a
10403 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10405 const unsigned char *str
= (const unsigned char *) string
;
10407 EMACS_INT dummy
, nbytes
;
10409 /* Copy at most PRECISION chars from STR. */
10410 nbytes
= strlen (string
);
10411 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10413 store_mode_line_noprop_char (*str
++);
10415 /* Fill up with spaces until FIELD_WIDTH reached. */
10416 while (field_width
> 0
10417 && n
< field_width
)
10419 store_mode_line_noprop_char (' ');
10426 /***********************************************************************
10428 ***********************************************************************/
10430 #ifdef HAVE_WINDOW_SYSTEM
10432 /* Set the title of FRAME, if it has changed. The title format is
10433 Vicon_title_format if FRAME is iconified, otherwise it is
10434 frame_title_format. */
10437 x_consider_frame_title (Lisp_Object frame
)
10439 struct frame
*f
= XFRAME (frame
);
10441 if (FRAME_WINDOW_P (f
)
10442 || FRAME_MINIBUF_ONLY_P (f
)
10443 || f
->explicit_name
)
10445 /* Do we have more than one visible frame on this X display? */
10452 int count
= SPECPDL_INDEX ();
10454 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10456 Lisp_Object other_frame
= XCAR (tail
);
10457 struct frame
*tf
= XFRAME (other_frame
);
10460 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10461 && !FRAME_MINIBUF_ONLY_P (tf
)
10462 && !EQ (other_frame
, tip_frame
)
10463 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10467 /* Set global variable indicating that multiple frames exist. */
10468 multiple_frames
= CONSP (tail
);
10470 /* Switch to the buffer of selected window of the frame. Set up
10471 mode_line_target so that display_mode_element will output into
10472 mode_line_noprop_buf; then display the title. */
10473 record_unwind_protect (unwind_format_mode_line
,
10474 format_mode_line_unwind_data
10475 (current_buffer
, selected_window
, 0));
10477 Fselect_window (f
->selected_window
, Qt
);
10478 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10479 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10481 mode_line_target
= MODE_LINE_TITLE
;
10482 title_start
= MODE_LINE_NOPROP_LEN (0);
10483 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10484 NULL
, DEFAULT_FACE_ID
);
10485 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10486 len
= MODE_LINE_NOPROP_LEN (title_start
);
10487 title
= mode_line_noprop_buf
+ title_start
;
10488 unbind_to (count
, Qnil
);
10490 /* Set the title only if it's changed. This avoids consing in
10491 the common case where it hasn't. (If it turns out that we've
10492 already wasted too much time by walking through the list with
10493 display_mode_element, then we might need to optimize at a
10494 higher level than this.) */
10495 if (! STRINGP (f
->name
)
10496 || SBYTES (f
->name
) != len
10497 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10498 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10502 #endif /* not HAVE_WINDOW_SYSTEM */
10507 /***********************************************************************
10509 ***********************************************************************/
10512 /* Prepare for redisplay by updating menu-bar item lists when
10513 appropriate. This can call eval. */
10516 prepare_menu_bars (void)
10519 struct gcpro gcpro1
, gcpro2
;
10521 Lisp_Object tooltip_frame
;
10523 #ifdef HAVE_WINDOW_SYSTEM
10524 tooltip_frame
= tip_frame
;
10526 tooltip_frame
= Qnil
;
10529 /* Update all frame titles based on their buffer names, etc. We do
10530 this before the menu bars so that the buffer-menu will show the
10531 up-to-date frame titles. */
10532 #ifdef HAVE_WINDOW_SYSTEM
10533 if (windows_or_buffers_changed
|| update_mode_lines
)
10535 Lisp_Object tail
, frame
;
10537 FOR_EACH_FRAME (tail
, frame
)
10539 f
= XFRAME (frame
);
10540 if (!EQ (frame
, tooltip_frame
)
10541 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10542 x_consider_frame_title (frame
);
10545 #endif /* HAVE_WINDOW_SYSTEM */
10547 /* Update the menu bar item lists, if appropriate. This has to be
10548 done before any actual redisplay or generation of display lines. */
10549 all_windows
= (update_mode_lines
10550 || buffer_shared
> 1
10551 || windows_or_buffers_changed
);
10554 Lisp_Object tail
, frame
;
10555 int count
= SPECPDL_INDEX ();
10556 /* 1 means that update_menu_bar has run its hooks
10557 so any further calls to update_menu_bar shouldn't do so again. */
10558 int menu_bar_hooks_run
= 0;
10560 record_unwind_save_match_data ();
10562 FOR_EACH_FRAME (tail
, frame
)
10564 f
= XFRAME (frame
);
10566 /* Ignore tooltip frame. */
10567 if (EQ (frame
, tooltip_frame
))
10570 /* If a window on this frame changed size, report that to
10571 the user and clear the size-change flag. */
10572 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10574 Lisp_Object functions
;
10576 /* Clear flag first in case we get an error below. */
10577 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10578 functions
= Vwindow_size_change_functions
;
10579 GCPRO2 (tail
, functions
);
10581 while (CONSP (functions
))
10583 if (!EQ (XCAR (functions
), Qt
))
10584 call1 (XCAR (functions
), frame
);
10585 functions
= XCDR (functions
);
10591 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10592 #ifdef HAVE_WINDOW_SYSTEM
10593 update_tool_bar (f
, 0);
10596 if (windows_or_buffers_changed
10598 ns_set_doc_edited (f
, Fbuffer_modified_p
10599 (XWINDOW (f
->selected_window
)->buffer
));
10604 unbind_to (count
, Qnil
);
10608 struct frame
*sf
= SELECTED_FRAME ();
10609 update_menu_bar (sf
, 1, 0);
10610 #ifdef HAVE_WINDOW_SYSTEM
10611 update_tool_bar (sf
, 1);
10617 /* Update the menu bar item list for frame F. This has to be done
10618 before we start to fill in any display lines, because it can call
10621 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10623 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10624 already ran the menu bar hooks for this redisplay, so there
10625 is no need to run them again. The return value is the
10626 updated value of this flag, to pass to the next call. */
10629 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10631 Lisp_Object window
;
10632 register struct window
*w
;
10634 /* If called recursively during a menu update, do nothing. This can
10635 happen when, for instance, an activate-menubar-hook causes a
10637 if (inhibit_menubar_update
)
10640 window
= FRAME_SELECTED_WINDOW (f
);
10641 w
= XWINDOW (window
);
10643 if (FRAME_WINDOW_P (f
)
10645 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10646 || defined (HAVE_NS) || defined (USE_GTK)
10647 FRAME_EXTERNAL_MENU_BAR (f
)
10649 FRAME_MENU_BAR_LINES (f
) > 0
10651 : FRAME_MENU_BAR_LINES (f
) > 0)
10653 /* If the user has switched buffers or windows, we need to
10654 recompute to reflect the new bindings. But we'll
10655 recompute when update_mode_lines is set too; that means
10656 that people can use force-mode-line-update to request
10657 that the menu bar be recomputed. The adverse effect on
10658 the rest of the redisplay algorithm is about the same as
10659 windows_or_buffers_changed anyway. */
10660 if (windows_or_buffers_changed
10661 /* This used to test w->update_mode_line, but we believe
10662 there is no need to recompute the menu in that case. */
10663 || update_mode_lines
10664 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10665 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10666 != !NILP (w
->last_had_star
))
10667 || ((!NILP (Vtransient_mark_mode
)
10668 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10669 != !NILP (w
->region_showing
)))
10671 struct buffer
*prev
= current_buffer
;
10672 int count
= SPECPDL_INDEX ();
10674 specbind (Qinhibit_menubar_update
, Qt
);
10676 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10677 if (save_match_data
)
10678 record_unwind_save_match_data ();
10679 if (NILP (Voverriding_local_map_menu_flag
))
10681 specbind (Qoverriding_terminal_local_map
, Qnil
);
10682 specbind (Qoverriding_local_map
, Qnil
);
10687 /* Run the Lucid hook. */
10688 safe_run_hooks (Qactivate_menubar_hook
);
10690 /* If it has changed current-menubar from previous value,
10691 really recompute the menu-bar from the value. */
10692 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10693 call0 (Qrecompute_lucid_menubar
);
10695 safe_run_hooks (Qmenu_bar_update_hook
);
10700 XSETFRAME (Vmenu_updating_frame
, f
);
10701 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10703 /* Redisplay the menu bar in case we changed it. */
10704 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10705 || defined (HAVE_NS) || defined (USE_GTK)
10706 if (FRAME_WINDOW_P (f
))
10708 #if defined (HAVE_NS)
10709 /* All frames on Mac OS share the same menubar. So only
10710 the selected frame should be allowed to set it. */
10711 if (f
== SELECTED_FRAME ())
10713 set_frame_menubar (f
, 0, 0);
10716 /* On a terminal screen, the menu bar is an ordinary screen
10717 line, and this makes it get updated. */
10718 w
->update_mode_line
= Qt
;
10719 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10720 /* In the non-toolkit version, the menu bar is an ordinary screen
10721 line, and this makes it get updated. */
10722 w
->update_mode_line
= Qt
;
10723 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10725 unbind_to (count
, Qnil
);
10726 set_buffer_internal_1 (prev
);
10735 /***********************************************************************
10737 ***********************************************************************/
10739 #ifdef HAVE_WINDOW_SYSTEM
10742 Nominal cursor position -- where to draw output.
10743 HPOS and VPOS are window relative glyph matrix coordinates.
10744 X and Y are window relative pixel coordinates. */
10746 struct cursor_pos output_cursor
;
10750 Set the global variable output_cursor to CURSOR. All cursor
10751 positions are relative to updated_window. */
10754 set_output_cursor (struct cursor_pos
*cursor
)
10756 output_cursor
.hpos
= cursor
->hpos
;
10757 output_cursor
.vpos
= cursor
->vpos
;
10758 output_cursor
.x
= cursor
->x
;
10759 output_cursor
.y
= cursor
->y
;
10764 Set a nominal cursor position.
10766 HPOS and VPOS are column/row positions in a window glyph matrix. X
10767 and Y are window text area relative pixel positions.
10769 If this is done during an update, updated_window will contain the
10770 window that is being updated and the position is the future output
10771 cursor position for that window. If updated_window is null, use
10772 selected_window and display the cursor at the given position. */
10775 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10779 /* If updated_window is not set, work on selected_window. */
10780 if (updated_window
)
10781 w
= updated_window
;
10783 w
= XWINDOW (selected_window
);
10785 /* Set the output cursor. */
10786 output_cursor
.hpos
= hpos
;
10787 output_cursor
.vpos
= vpos
;
10788 output_cursor
.x
= x
;
10789 output_cursor
.y
= y
;
10791 /* If not called as part of an update, really display the cursor.
10792 This will also set the cursor position of W. */
10793 if (updated_window
== NULL
)
10796 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10797 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10798 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10803 #endif /* HAVE_WINDOW_SYSTEM */
10806 /***********************************************************************
10808 ***********************************************************************/
10810 #ifdef HAVE_WINDOW_SYSTEM
10812 /* Where the mouse was last time we reported a mouse event. */
10814 FRAME_PTR last_mouse_frame
;
10816 /* Tool-bar item index of the item on which a mouse button was pressed
10819 int last_tool_bar_item
;
10823 update_tool_bar_unwind (Lisp_Object frame
)
10825 selected_frame
= frame
;
10829 /* Update the tool-bar item list for frame F. This has to be done
10830 before we start to fill in any display lines. Called from
10831 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10832 and restore it here. */
10835 update_tool_bar (struct frame
*f
, int save_match_data
)
10837 #if defined (USE_GTK) || defined (HAVE_NS)
10838 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10840 int do_update
= WINDOWP (f
->tool_bar_window
)
10841 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10846 Lisp_Object window
;
10849 window
= FRAME_SELECTED_WINDOW (f
);
10850 w
= XWINDOW (window
);
10852 /* If the user has switched buffers or windows, we need to
10853 recompute to reflect the new bindings. But we'll
10854 recompute when update_mode_lines is set too; that means
10855 that people can use force-mode-line-update to request
10856 that the menu bar be recomputed. The adverse effect on
10857 the rest of the redisplay algorithm is about the same as
10858 windows_or_buffers_changed anyway. */
10859 if (windows_or_buffers_changed
10860 || !NILP (w
->update_mode_line
)
10861 || update_mode_lines
10862 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10863 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10864 != !NILP (w
->last_had_star
))
10865 || ((!NILP (Vtransient_mark_mode
)
10866 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10867 != !NILP (w
->region_showing
)))
10869 struct buffer
*prev
= current_buffer
;
10870 int count
= SPECPDL_INDEX ();
10871 Lisp_Object frame
, new_tool_bar
;
10872 int new_n_tool_bar
;
10873 struct gcpro gcpro1
;
10875 /* Set current_buffer to the buffer of the selected
10876 window of the frame, so that we get the right local
10878 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10880 /* Save match data, if we must. */
10881 if (save_match_data
)
10882 record_unwind_save_match_data ();
10884 /* Make sure that we don't accidentally use bogus keymaps. */
10885 if (NILP (Voverriding_local_map_menu_flag
))
10887 specbind (Qoverriding_terminal_local_map
, Qnil
);
10888 specbind (Qoverriding_local_map
, Qnil
);
10891 GCPRO1 (new_tool_bar
);
10893 /* We must temporarily set the selected frame to this frame
10894 before calling tool_bar_items, because the calculation of
10895 the tool-bar keymap uses the selected frame (see
10896 `tool-bar-make-keymap' in tool-bar.el). */
10897 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10898 XSETFRAME (frame
, f
);
10899 selected_frame
= frame
;
10901 /* Build desired tool-bar items from keymaps. */
10902 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10905 /* Redisplay the tool-bar if we changed it. */
10906 if (new_n_tool_bar
!= f
->n_tool_bar_items
10907 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10909 /* Redisplay that happens asynchronously due to an expose event
10910 may access f->tool_bar_items. Make sure we update both
10911 variables within BLOCK_INPUT so no such event interrupts. */
10913 f
->tool_bar_items
= new_tool_bar
;
10914 f
->n_tool_bar_items
= new_n_tool_bar
;
10915 w
->update_mode_line
= Qt
;
10921 unbind_to (count
, Qnil
);
10922 set_buffer_internal_1 (prev
);
10928 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10929 F's desired tool-bar contents. F->tool_bar_items must have
10930 been set up previously by calling prepare_menu_bars. */
10933 build_desired_tool_bar_string (struct frame
*f
)
10935 int i
, size
, size_needed
;
10936 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10937 Lisp_Object image
, plist
, props
;
10939 image
= plist
= props
= Qnil
;
10940 GCPRO3 (image
, plist
, props
);
10942 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10943 Otherwise, make a new string. */
10945 /* The size of the string we might be able to reuse. */
10946 size
= (STRINGP (f
->desired_tool_bar_string
)
10947 ? SCHARS (f
->desired_tool_bar_string
)
10950 /* We need one space in the string for each image. */
10951 size_needed
= f
->n_tool_bar_items
;
10953 /* Reuse f->desired_tool_bar_string, if possible. */
10954 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10955 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10956 make_number (' '));
10959 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10960 Fremove_text_properties (make_number (0), make_number (size
),
10961 props
, f
->desired_tool_bar_string
);
10964 /* Put a `display' property on the string for the images to display,
10965 put a `menu_item' property on tool-bar items with a value that
10966 is the index of the item in F's tool-bar item vector. */
10967 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10969 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10971 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10972 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10973 int hmargin
, vmargin
, relief
, idx
, end
;
10975 /* If image is a vector, choose the image according to the
10977 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10978 if (VECTORP (image
))
10982 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10983 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10986 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10987 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10989 xassert (ASIZE (image
) >= idx
);
10990 image
= AREF (image
, idx
);
10995 /* Ignore invalid image specifications. */
10996 if (!valid_image_p (image
))
10999 /* Display the tool-bar button pressed, or depressed. */
11000 plist
= Fcopy_sequence (XCDR (image
));
11002 /* Compute margin and relief to draw. */
11003 relief
= (tool_bar_button_relief
>= 0
11004 ? tool_bar_button_relief
11005 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11006 hmargin
= vmargin
= relief
;
11008 if (INTEGERP (Vtool_bar_button_margin
)
11009 && XINT (Vtool_bar_button_margin
) > 0)
11011 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11012 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11014 else if (CONSP (Vtool_bar_button_margin
))
11016 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11017 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11018 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11020 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11021 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11022 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11025 if (auto_raise_tool_bar_buttons_p
)
11027 /* Add a `:relief' property to the image spec if the item is
11031 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11038 /* If image is selected, display it pressed, i.e. with a
11039 negative relief. If it's not selected, display it with a
11041 plist
= Fplist_put (plist
, QCrelief
,
11043 ? make_number (-relief
)
11044 : make_number (relief
)));
11049 /* Put a margin around the image. */
11050 if (hmargin
|| vmargin
)
11052 if (hmargin
== vmargin
)
11053 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11055 plist
= Fplist_put (plist
, QCmargin
,
11056 Fcons (make_number (hmargin
),
11057 make_number (vmargin
)));
11060 /* If button is not enabled, and we don't have special images
11061 for the disabled state, make the image appear disabled by
11062 applying an appropriate algorithm to it. */
11063 if (!enabled_p
&& idx
< 0)
11064 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11066 /* Put a `display' text property on the string for the image to
11067 display. Put a `menu-item' property on the string that gives
11068 the start of this item's properties in the tool-bar items
11070 image
= Fcons (Qimage
, plist
);
11071 props
= list4 (Qdisplay
, image
,
11072 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11074 /* Let the last image hide all remaining spaces in the tool bar
11075 string. The string can be longer than needed when we reuse a
11076 previous string. */
11077 if (i
+ 1 == f
->n_tool_bar_items
)
11078 end
= SCHARS (f
->desired_tool_bar_string
);
11081 Fadd_text_properties (make_number (i
), make_number (end
),
11082 props
, f
->desired_tool_bar_string
);
11090 /* Display one line of the tool-bar of frame IT->f.
11092 HEIGHT specifies the desired height of the tool-bar line.
11093 If the actual height of the glyph row is less than HEIGHT, the
11094 row's height is increased to HEIGHT, and the icons are centered
11095 vertically in the new height.
11097 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11098 count a final empty row in case the tool-bar width exactly matches
11103 display_tool_bar_line (struct it
*it
, int height
)
11105 struct glyph_row
*row
= it
->glyph_row
;
11106 int max_x
= it
->last_visible_x
;
11107 struct glyph
*last
;
11109 prepare_desired_row (row
);
11110 row
->y
= it
->current_y
;
11112 /* Note that this isn't made use of if the face hasn't a box,
11113 so there's no need to check the face here. */
11114 it
->start_of_box_run_p
= 1;
11116 while (it
->current_x
< max_x
)
11118 int x
, n_glyphs_before
, i
, nglyphs
;
11119 struct it it_before
;
11121 /* Get the next display element. */
11122 if (!get_next_display_element (it
))
11124 /* Don't count empty row if we are counting needed tool-bar lines. */
11125 if (height
< 0 && !it
->hpos
)
11130 /* Produce glyphs. */
11131 n_glyphs_before
= row
->used
[TEXT_AREA
];
11134 PRODUCE_GLYPHS (it
);
11136 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11138 x
= it_before
.current_x
;
11139 while (i
< nglyphs
)
11141 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11143 if (x
+ glyph
->pixel_width
> max_x
)
11145 /* Glyph doesn't fit on line. Backtrack. */
11146 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11148 /* If this is the only glyph on this line, it will never fit on the
11149 tool-bar, so skip it. But ensure there is at least one glyph,
11150 so we don't accidentally disable the tool-bar. */
11151 if (n_glyphs_before
== 0
11152 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11158 x
+= glyph
->pixel_width
;
11162 /* Stop at line end. */
11163 if (ITERATOR_AT_END_OF_LINE_P (it
))
11166 set_iterator_to_next (it
, 1);
11171 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11173 /* Use default face for the border below the tool bar.
11175 FIXME: When auto-resize-tool-bars is grow-only, there is
11176 no additional border below the possibly empty tool-bar lines.
11177 So to make the extra empty lines look "normal", we have to
11178 use the tool-bar face for the border too. */
11179 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11180 it
->face_id
= DEFAULT_FACE_ID
;
11182 extend_face_to_end_of_line (it
);
11183 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11184 last
->right_box_line_p
= 1;
11185 if (last
== row
->glyphs
[TEXT_AREA
])
11186 last
->left_box_line_p
= 1;
11188 /* Make line the desired height and center it vertically. */
11189 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11191 /* Don't add more than one line height. */
11192 height
%= FRAME_LINE_HEIGHT (it
->f
);
11193 it
->max_ascent
+= height
/ 2;
11194 it
->max_descent
+= (height
+ 1) / 2;
11197 compute_line_metrics (it
);
11199 /* If line is empty, make it occupy the rest of the tool-bar. */
11200 if (!row
->displays_text_p
)
11202 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11203 row
->visible_height
= row
->height
;
11204 row
->ascent
= row
->phys_ascent
= 0;
11205 row
->extra_line_spacing
= 0;
11208 row
->full_width_p
= 1;
11209 row
->continued_p
= 0;
11210 row
->truncated_on_left_p
= 0;
11211 row
->truncated_on_right_p
= 0;
11213 it
->current_x
= it
->hpos
= 0;
11214 it
->current_y
+= row
->height
;
11220 /* Max tool-bar height. */
11222 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11223 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11225 /* Value is the number of screen lines needed to make all tool-bar
11226 items of frame F visible. The number of actual rows needed is
11227 returned in *N_ROWS if non-NULL. */
11230 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11232 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11234 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11235 the desired matrix, so use (unused) mode-line row as temporary row to
11236 avoid destroying the first tool-bar row. */
11237 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11239 /* Initialize an iterator for iteration over
11240 F->desired_tool_bar_string in the tool-bar window of frame F. */
11241 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11242 it
.first_visible_x
= 0;
11243 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11244 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11245 it
.paragraph_embedding
= L2R
;
11247 while (!ITERATOR_AT_END_P (&it
))
11249 clear_glyph_row (temp_row
);
11250 it
.glyph_row
= temp_row
;
11251 display_tool_bar_line (&it
, -1);
11253 clear_glyph_row (temp_row
);
11255 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11257 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11259 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11263 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11265 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11266 (Lisp_Object frame
)
11273 frame
= selected_frame
;
11275 CHECK_FRAME (frame
);
11276 f
= XFRAME (frame
);
11278 if (WINDOWP (f
->tool_bar_window
)
11279 && (w
= XWINDOW (f
->tool_bar_window
),
11280 WINDOW_TOTAL_LINES (w
) > 0))
11282 update_tool_bar (f
, 1);
11283 if (f
->n_tool_bar_items
)
11285 build_desired_tool_bar_string (f
);
11286 nlines
= tool_bar_lines_needed (f
, NULL
);
11290 return make_number (nlines
);
11294 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11295 height should be changed. */
11298 redisplay_tool_bar (struct frame
*f
)
11302 struct glyph_row
*row
;
11304 #if defined (USE_GTK) || defined (HAVE_NS)
11305 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11306 update_frame_tool_bar (f
);
11310 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11311 do anything. This means you must start with tool-bar-lines
11312 non-zero to get the auto-sizing effect. Or in other words, you
11313 can turn off tool-bars by specifying tool-bar-lines zero. */
11314 if (!WINDOWP (f
->tool_bar_window
)
11315 || (w
= XWINDOW (f
->tool_bar_window
),
11316 WINDOW_TOTAL_LINES (w
) == 0))
11319 /* Set up an iterator for the tool-bar window. */
11320 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11321 it
.first_visible_x
= 0;
11322 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11323 row
= it
.glyph_row
;
11325 /* Build a string that represents the contents of the tool-bar. */
11326 build_desired_tool_bar_string (f
);
11327 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11328 /* FIXME: This should be controlled by a user option. But it
11329 doesn't make sense to have an R2L tool bar if the menu bar cannot
11330 be drawn also R2L, and making the menu bar R2L is tricky due
11331 toolkit-specific code that implements it. If an R2L tool bar is
11332 ever supported, display_tool_bar_line should also be augmented to
11333 call unproduce_glyphs like display_line and display_string
11335 it
.paragraph_embedding
= L2R
;
11337 if (f
->n_tool_bar_rows
== 0)
11341 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11342 nlines
!= WINDOW_TOTAL_LINES (w
)))
11345 int old_height
= WINDOW_TOTAL_LINES (w
);
11347 XSETFRAME (frame
, f
);
11348 Fmodify_frame_parameters (frame
,
11349 Fcons (Fcons (Qtool_bar_lines
,
11350 make_number (nlines
)),
11352 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11354 clear_glyph_matrix (w
->desired_matrix
);
11355 fonts_changed_p
= 1;
11361 /* Display as many lines as needed to display all tool-bar items. */
11363 if (f
->n_tool_bar_rows
> 0)
11365 int border
, rows
, height
, extra
;
11367 if (INTEGERP (Vtool_bar_border
))
11368 border
= XINT (Vtool_bar_border
);
11369 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11370 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11371 else if (EQ (Vtool_bar_border
, Qborder_width
))
11372 border
= f
->border_width
;
11378 rows
= f
->n_tool_bar_rows
;
11379 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11380 extra
= it
.last_visible_y
- border
- height
* rows
;
11382 while (it
.current_y
< it
.last_visible_y
)
11385 if (extra
> 0 && rows
-- > 0)
11387 h
= (extra
+ rows
- 1) / rows
;
11390 display_tool_bar_line (&it
, height
+ h
);
11395 while (it
.current_y
< it
.last_visible_y
)
11396 display_tool_bar_line (&it
, 0);
11399 /* It doesn't make much sense to try scrolling in the tool-bar
11400 window, so don't do it. */
11401 w
->desired_matrix
->no_scrolling_p
= 1;
11402 w
->must_be_updated_p
= 1;
11404 if (!NILP (Vauto_resize_tool_bars
))
11406 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11407 int change_height_p
= 0;
11409 /* If we couldn't display everything, change the tool-bar's
11410 height if there is room for more. */
11411 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11412 && it
.current_y
< max_tool_bar_height
)
11413 change_height_p
= 1;
11415 row
= it
.glyph_row
- 1;
11417 /* If there are blank lines at the end, except for a partially
11418 visible blank line at the end that is smaller than
11419 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11420 if (!row
->displays_text_p
11421 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11422 change_height_p
= 1;
11424 /* If row displays tool-bar items, but is partially visible,
11425 change the tool-bar's height. */
11426 if (row
->displays_text_p
11427 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11428 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11429 change_height_p
= 1;
11431 /* Resize windows as needed by changing the `tool-bar-lines'
11432 frame parameter. */
11433 if (change_height_p
)
11436 int old_height
= WINDOW_TOTAL_LINES (w
);
11438 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11440 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11441 && !f
->minimize_tool_bar_window_p
)
11442 ? (nlines
> old_height
)
11443 : (nlines
!= old_height
));
11444 f
->minimize_tool_bar_window_p
= 0;
11446 if (change_height_p
)
11448 XSETFRAME (frame
, f
);
11449 Fmodify_frame_parameters (frame
,
11450 Fcons (Fcons (Qtool_bar_lines
,
11451 make_number (nlines
)),
11453 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11455 clear_glyph_matrix (w
->desired_matrix
);
11456 f
->n_tool_bar_rows
= nrows
;
11457 fonts_changed_p
= 1;
11464 f
->minimize_tool_bar_window_p
= 0;
11469 /* Get information about the tool-bar item which is displayed in GLYPH
11470 on frame F. Return in *PROP_IDX the index where tool-bar item
11471 properties start in F->tool_bar_items. Value is zero if
11472 GLYPH doesn't display a tool-bar item. */
11475 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11481 /* This function can be called asynchronously, which means we must
11482 exclude any possibility that Fget_text_property signals an
11484 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11485 charpos
= max (0, charpos
);
11487 /* Get the text property `menu-item' at pos. The value of that
11488 property is the start index of this item's properties in
11489 F->tool_bar_items. */
11490 prop
= Fget_text_property (make_number (charpos
),
11491 Qmenu_item
, f
->current_tool_bar_string
);
11492 if (INTEGERP (prop
))
11494 *prop_idx
= XINT (prop
);
11504 /* Get information about the tool-bar item at position X/Y on frame F.
11505 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11506 the current matrix of the tool-bar window of F, or NULL if not
11507 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11508 item in F->tool_bar_items. Value is
11510 -1 if X/Y is not on a tool-bar item
11511 0 if X/Y is on the same item that was highlighted before.
11515 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11516 int *hpos
, int *vpos
, int *prop_idx
)
11518 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11519 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11522 /* Find the glyph under X/Y. */
11523 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11524 if (*glyph
== NULL
)
11527 /* Get the start of this tool-bar item's properties in
11528 f->tool_bar_items. */
11529 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11532 /* Is mouse on the highlighted item? */
11533 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11534 && *vpos
>= hlinfo
->mouse_face_beg_row
11535 && *vpos
<= hlinfo
->mouse_face_end_row
11536 && (*vpos
> hlinfo
->mouse_face_beg_row
11537 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11538 && (*vpos
< hlinfo
->mouse_face_end_row
11539 || *hpos
< hlinfo
->mouse_face_end_col
11540 || hlinfo
->mouse_face_past_end
))
11548 Handle mouse button event on the tool-bar of frame F, at
11549 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11550 0 for button release. MODIFIERS is event modifiers for button
11554 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11555 unsigned int modifiers
)
11557 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11558 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11559 int hpos
, vpos
, prop_idx
;
11560 struct glyph
*glyph
;
11561 Lisp_Object enabled_p
;
11563 /* If not on the highlighted tool-bar item, return. */
11564 frame_to_window_pixel_xy (w
, &x
, &y
);
11565 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11568 /* If item is disabled, do nothing. */
11569 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11570 if (NILP (enabled_p
))
11575 /* Show item in pressed state. */
11576 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11577 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11578 last_tool_bar_item
= prop_idx
;
11582 Lisp_Object key
, frame
;
11583 struct input_event event
;
11584 EVENT_INIT (event
);
11586 /* Show item in released state. */
11587 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11588 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11590 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11592 XSETFRAME (frame
, f
);
11593 event
.kind
= TOOL_BAR_EVENT
;
11594 event
.frame_or_window
= frame
;
11596 kbd_buffer_store_event (&event
);
11598 event
.kind
= TOOL_BAR_EVENT
;
11599 event
.frame_or_window
= frame
;
11601 event
.modifiers
= modifiers
;
11602 kbd_buffer_store_event (&event
);
11603 last_tool_bar_item
= -1;
11608 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11609 tool-bar window-relative coordinates X/Y. Called from
11610 note_mouse_highlight. */
11613 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11615 Lisp_Object window
= f
->tool_bar_window
;
11616 struct window
*w
= XWINDOW (window
);
11617 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11618 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11620 struct glyph
*glyph
;
11621 struct glyph_row
*row
;
11623 Lisp_Object enabled_p
;
11625 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11626 int mouse_down_p
, rc
;
11628 /* Function note_mouse_highlight is called with negative X/Y
11629 values when mouse moves outside of the frame. */
11630 if (x
<= 0 || y
<= 0)
11632 clear_mouse_face (hlinfo
);
11636 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11639 /* Not on tool-bar item. */
11640 clear_mouse_face (hlinfo
);
11644 /* On same tool-bar item as before. */
11645 goto set_help_echo
;
11647 clear_mouse_face (hlinfo
);
11649 /* Mouse is down, but on different tool-bar item? */
11650 mouse_down_p
= (dpyinfo
->grabbed
11651 && f
== last_mouse_frame
11652 && FRAME_LIVE_P (f
));
11654 && last_tool_bar_item
!= prop_idx
)
11657 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11658 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11660 /* If tool-bar item is not enabled, don't highlight it. */
11661 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11662 if (!NILP (enabled_p
))
11664 /* Compute the x-position of the glyph. In front and past the
11665 image is a space. We include this in the highlighted area. */
11666 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11667 for (i
= x
= 0; i
< hpos
; ++i
)
11668 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11670 /* Record this as the current active region. */
11671 hlinfo
->mouse_face_beg_col
= hpos
;
11672 hlinfo
->mouse_face_beg_row
= vpos
;
11673 hlinfo
->mouse_face_beg_x
= x
;
11674 hlinfo
->mouse_face_beg_y
= row
->y
;
11675 hlinfo
->mouse_face_past_end
= 0;
11677 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11678 hlinfo
->mouse_face_end_row
= vpos
;
11679 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11680 hlinfo
->mouse_face_end_y
= row
->y
;
11681 hlinfo
->mouse_face_window
= window
;
11682 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11684 /* Display it as active. */
11685 show_mouse_face (hlinfo
, draw
);
11686 hlinfo
->mouse_face_image_state
= draw
;
11691 /* Set help_echo_string to a help string to display for this tool-bar item.
11692 XTread_socket does the rest. */
11693 help_echo_object
= help_echo_window
= Qnil
;
11694 help_echo_pos
= -1;
11695 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11696 if (NILP (help_echo_string
))
11697 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11700 #endif /* HAVE_WINDOW_SYSTEM */
11704 /************************************************************************
11705 Horizontal scrolling
11706 ************************************************************************/
11708 static int hscroll_window_tree (Lisp_Object
);
11709 static int hscroll_windows (Lisp_Object
);
11711 /* For all leaf windows in the window tree rooted at WINDOW, set their
11712 hscroll value so that PT is (i) visible in the window, and (ii) so
11713 that it is not within a certain margin at the window's left and
11714 right border. Value is non-zero if any window's hscroll has been
11718 hscroll_window_tree (Lisp_Object window
)
11720 int hscrolled_p
= 0;
11721 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11722 int hscroll_step_abs
= 0;
11723 double hscroll_step_rel
= 0;
11725 if (hscroll_relative_p
)
11727 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11728 if (hscroll_step_rel
< 0)
11730 hscroll_relative_p
= 0;
11731 hscroll_step_abs
= 0;
11734 else if (INTEGERP (Vhscroll_step
))
11736 hscroll_step_abs
= XINT (Vhscroll_step
);
11737 if (hscroll_step_abs
< 0)
11738 hscroll_step_abs
= 0;
11741 hscroll_step_abs
= 0;
11743 while (WINDOWP (window
))
11745 struct window
*w
= XWINDOW (window
);
11747 if (WINDOWP (w
->hchild
))
11748 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11749 else if (WINDOWP (w
->vchild
))
11750 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11751 else if (w
->cursor
.vpos
>= 0)
11754 int text_area_width
;
11755 struct glyph_row
*current_cursor_row
11756 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11757 struct glyph_row
*desired_cursor_row
11758 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11759 struct glyph_row
*cursor_row
11760 = (desired_cursor_row
->enabled_p
11761 ? desired_cursor_row
11762 : current_cursor_row
);
11764 text_area_width
= window_box_width (w
, TEXT_AREA
);
11766 /* Scroll when cursor is inside this scroll margin. */
11767 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11769 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11770 && ((XFASTINT (w
->hscroll
)
11771 && w
->cursor
.x
<= h_margin
)
11772 || (cursor_row
->enabled_p
11773 && cursor_row
->truncated_on_right_p
11774 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11778 struct buffer
*saved_current_buffer
;
11782 /* Find point in a display of infinite width. */
11783 saved_current_buffer
= current_buffer
;
11784 current_buffer
= XBUFFER (w
->buffer
);
11786 if (w
== XWINDOW (selected_window
))
11790 pt
= marker_position (w
->pointm
);
11791 pt
= max (BEGV
, pt
);
11795 /* Move iterator to pt starting at cursor_row->start in
11796 a line with infinite width. */
11797 init_to_row_start (&it
, w
, cursor_row
);
11798 it
.last_visible_x
= INFINITY
;
11799 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11800 current_buffer
= saved_current_buffer
;
11802 /* Position cursor in window. */
11803 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11804 hscroll
= max (0, (it
.current_x
11805 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11806 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11807 : (text_area_width
/ 2))))
11808 / FRAME_COLUMN_WIDTH (it
.f
);
11809 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11811 if (hscroll_relative_p
)
11812 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11815 wanted_x
= text_area_width
11816 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11819 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11823 if (hscroll_relative_p
)
11824 wanted_x
= text_area_width
* hscroll_step_rel
11827 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11830 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11832 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11834 /* Don't call Fset_window_hscroll if value hasn't
11835 changed because it will prevent redisplay
11837 if (XFASTINT (w
->hscroll
) != hscroll
)
11839 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11840 w
->hscroll
= make_number (hscroll
);
11849 /* Value is non-zero if hscroll of any leaf window has been changed. */
11850 return hscrolled_p
;
11854 /* Set hscroll so that cursor is visible and not inside horizontal
11855 scroll margins for all windows in the tree rooted at WINDOW. See
11856 also hscroll_window_tree above. Value is non-zero if any window's
11857 hscroll has been changed. If it has, desired matrices on the frame
11858 of WINDOW are cleared. */
11861 hscroll_windows (Lisp_Object window
)
11863 int hscrolled_p
= hscroll_window_tree (window
);
11865 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11866 return hscrolled_p
;
11871 /************************************************************************
11873 ************************************************************************/
11875 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11876 to a non-zero value. This is sometimes handy to have in a debugger
11881 /* First and last unchanged row for try_window_id. */
11883 static int debug_first_unchanged_at_end_vpos
;
11884 static int debug_last_unchanged_at_beg_vpos
;
11886 /* Delta vpos and y. */
11888 static int debug_dvpos
, debug_dy
;
11890 /* Delta in characters and bytes for try_window_id. */
11892 static EMACS_INT debug_delta
, debug_delta_bytes
;
11894 /* Values of window_end_pos and window_end_vpos at the end of
11897 static EMACS_INT debug_end_vpos
;
11899 /* Append a string to W->desired_matrix->method. FMT is a printf
11900 format string. If trace_redisplay_p is non-zero also printf the
11901 resulting string to stderr. */
11903 static void debug_method_add (struct window
*, char const *, ...)
11904 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11907 debug_method_add (struct window
*w
, char const *fmt
, ...)
11910 char *method
= w
->desired_matrix
->method
;
11911 int len
= strlen (method
);
11912 int size
= sizeof w
->desired_matrix
->method
;
11913 int remaining
= size
- len
- 1;
11916 va_start (ap
, fmt
);
11917 vsprintf (buffer
, fmt
, ap
);
11919 if (len
&& remaining
)
11922 --remaining
, ++len
;
11925 strncpy (method
+ len
, buffer
, remaining
);
11927 if (trace_redisplay_p
)
11928 fprintf (stderr
, "%p (%s): %s\n",
11930 ((BUFFERP (w
->buffer
)
11931 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11932 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11937 #endif /* GLYPH_DEBUG */
11940 /* Value is non-zero if all changes in window W, which displays
11941 current_buffer, are in the text between START and END. START is a
11942 buffer position, END is given as a distance from Z. Used in
11943 redisplay_internal for display optimization. */
11946 text_outside_line_unchanged_p (struct window
*w
,
11947 EMACS_INT start
, EMACS_INT end
)
11949 int unchanged_p
= 1;
11951 /* If text or overlays have changed, see where. */
11952 if (XFASTINT (w
->last_modified
) < MODIFF
11953 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11955 /* Gap in the line? */
11956 if (GPT
< start
|| Z
- GPT
< end
)
11959 /* Changes start in front of the line, or end after it? */
11961 && (BEG_UNCHANGED
< start
- 1
11962 || END_UNCHANGED
< end
))
11965 /* If selective display, can't optimize if changes start at the
11966 beginning of the line. */
11968 && INTEGERP (BVAR (current_buffer
, selective_display
))
11969 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11970 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11973 /* If there are overlays at the start or end of the line, these
11974 may have overlay strings with newlines in them. A change at
11975 START, for instance, may actually concern the display of such
11976 overlay strings as well, and they are displayed on different
11977 lines. So, quickly rule out this case. (For the future, it
11978 might be desirable to implement something more telling than
11979 just BEG/END_UNCHANGED.) */
11982 if (BEG
+ BEG_UNCHANGED
== start
11983 && overlay_touches_p (start
))
11985 if (END_UNCHANGED
== end
11986 && overlay_touches_p (Z
- end
))
11990 /* Under bidi reordering, adding or deleting a character in the
11991 beginning of a paragraph, before the first strong directional
11992 character, can change the base direction of the paragraph (unless
11993 the buffer specifies a fixed paragraph direction), which will
11994 require to redisplay the whole paragraph. It might be worthwhile
11995 to find the paragraph limits and widen the range of redisplayed
11996 lines to that, but for now just give up this optimization. */
11997 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
11998 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12002 return unchanged_p
;
12006 /* Do a frame update, taking possible shortcuts into account. This is
12007 the main external entry point for redisplay.
12009 If the last redisplay displayed an echo area message and that message
12010 is no longer requested, we clear the echo area or bring back the
12011 mini-buffer if that is in use. */
12016 redisplay_internal ();
12021 overlay_arrow_string_or_property (Lisp_Object var
)
12025 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12028 return Voverlay_arrow_string
;
12031 /* Return 1 if there are any overlay-arrows in current_buffer. */
12033 overlay_arrow_in_current_buffer_p (void)
12037 for (vlist
= Voverlay_arrow_variable_list
;
12039 vlist
= XCDR (vlist
))
12041 Lisp_Object var
= XCAR (vlist
);
12044 if (!SYMBOLP (var
))
12046 val
= find_symbol_value (var
);
12048 && current_buffer
== XMARKER (val
)->buffer
)
12055 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12059 overlay_arrows_changed_p (void)
12063 for (vlist
= Voverlay_arrow_variable_list
;
12065 vlist
= XCDR (vlist
))
12067 Lisp_Object var
= XCAR (vlist
);
12068 Lisp_Object val
, pstr
;
12070 if (!SYMBOLP (var
))
12072 val
= find_symbol_value (var
);
12073 if (!MARKERP (val
))
12075 if (! EQ (COERCE_MARKER (val
),
12076 Fget (var
, Qlast_arrow_position
))
12077 || ! (pstr
= overlay_arrow_string_or_property (var
),
12078 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12084 /* Mark overlay arrows to be updated on next redisplay. */
12087 update_overlay_arrows (int up_to_date
)
12091 for (vlist
= Voverlay_arrow_variable_list
;
12093 vlist
= XCDR (vlist
))
12095 Lisp_Object var
= XCAR (vlist
);
12097 if (!SYMBOLP (var
))
12100 if (up_to_date
> 0)
12102 Lisp_Object val
= find_symbol_value (var
);
12103 Fput (var
, Qlast_arrow_position
,
12104 COERCE_MARKER (val
));
12105 Fput (var
, Qlast_arrow_string
,
12106 overlay_arrow_string_or_property (var
));
12108 else if (up_to_date
< 0
12109 || !NILP (Fget (var
, Qlast_arrow_position
)))
12111 Fput (var
, Qlast_arrow_position
, Qt
);
12112 Fput (var
, Qlast_arrow_string
, Qt
);
12118 /* Return overlay arrow string to display at row.
12119 Return integer (bitmap number) for arrow bitmap in left fringe.
12120 Return nil if no overlay arrow. */
12123 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12127 for (vlist
= Voverlay_arrow_variable_list
;
12129 vlist
= XCDR (vlist
))
12131 Lisp_Object var
= XCAR (vlist
);
12134 if (!SYMBOLP (var
))
12137 val
= find_symbol_value (var
);
12140 && current_buffer
== XMARKER (val
)->buffer
12141 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12143 if (FRAME_WINDOW_P (it
->f
)
12144 /* FIXME: if ROW->reversed_p is set, this should test
12145 the right fringe, not the left one. */
12146 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12148 #ifdef HAVE_WINDOW_SYSTEM
12149 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12152 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12153 return make_number (fringe_bitmap
);
12156 return make_number (-1); /* Use default arrow bitmap */
12158 return overlay_arrow_string_or_property (var
);
12165 /* Return 1 if point moved out of or into a composition. Otherwise
12166 return 0. PREV_BUF and PREV_PT are the last point buffer and
12167 position. BUF and PT are the current point buffer and position. */
12170 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12171 struct buffer
*buf
, EMACS_INT pt
)
12173 EMACS_INT start
, end
;
12175 Lisp_Object buffer
;
12177 XSETBUFFER (buffer
, buf
);
12178 /* Check a composition at the last point if point moved within the
12180 if (prev_buf
== buf
)
12183 /* Point didn't move. */
12186 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12187 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12188 && COMPOSITION_VALID_P (start
, end
, prop
)
12189 && start
< prev_pt
&& end
> prev_pt
)
12190 /* The last point was within the composition. Return 1 iff
12191 point moved out of the composition. */
12192 return (pt
<= start
|| pt
>= end
);
12195 /* Check a composition at the current point. */
12196 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12197 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12198 && COMPOSITION_VALID_P (start
, end
, prop
)
12199 && start
< pt
&& end
> pt
);
12203 /* Reconsider the setting of B->clip_changed which is displayed
12207 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12209 if (b
->clip_changed
12210 && !NILP (w
->window_end_valid
)
12211 && w
->current_matrix
->buffer
== b
12212 && w
->current_matrix
->zv
== BUF_ZV (b
)
12213 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12214 b
->clip_changed
= 0;
12216 /* If display wasn't paused, and W is not a tool bar window, see if
12217 point has been moved into or out of a composition. In that case,
12218 we set b->clip_changed to 1 to force updating the screen. If
12219 b->clip_changed has already been set to 1, we can skip this
12221 if (!b
->clip_changed
12222 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12226 if (w
== XWINDOW (selected_window
))
12229 pt
= marker_position (w
->pointm
);
12231 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12232 || pt
!= XINT (w
->last_point
))
12233 && check_point_in_composition (w
->current_matrix
->buffer
,
12234 XINT (w
->last_point
),
12235 XBUFFER (w
->buffer
), pt
))
12236 b
->clip_changed
= 1;
12241 /* Select FRAME to forward the values of frame-local variables into C
12242 variables so that the redisplay routines can access those values
12246 select_frame_for_redisplay (Lisp_Object frame
)
12248 Lisp_Object tail
, tem
;
12249 Lisp_Object old
= selected_frame
;
12250 struct Lisp_Symbol
*sym
;
12252 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12254 selected_frame
= frame
;
12257 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12258 if (CONSP (XCAR (tail
))
12259 && (tem
= XCAR (XCAR (tail
)),
12261 && (sym
= indirect_variable (XSYMBOL (tem
)),
12262 sym
->redirect
== SYMBOL_LOCALIZED
)
12263 && sym
->val
.blv
->frame_local
)
12264 /* Use find_symbol_value rather than Fsymbol_value
12265 to avoid an error if it is void. */
12266 find_symbol_value (tem
);
12267 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12271 #define STOP_POLLING \
12272 do { if (! polling_stopped_here) stop_polling (); \
12273 polling_stopped_here = 1; } while (0)
12275 #define RESUME_POLLING \
12276 do { if (polling_stopped_here) start_polling (); \
12277 polling_stopped_here = 0; } while (0)
12280 /* Perhaps in the future avoid recentering windows if it
12281 is not necessary; currently that causes some problems. */
12284 redisplay_internal (void)
12286 struct window
*w
= XWINDOW (selected_window
);
12290 int must_finish
= 0;
12291 struct text_pos tlbufpos
, tlendpos
;
12292 int number_of_visible_frames
;
12295 int polling_stopped_here
= 0;
12296 Lisp_Object old_frame
= selected_frame
;
12298 /* Non-zero means redisplay has to consider all windows on all
12299 frames. Zero means, only selected_window is considered. */
12300 int consider_all_windows_p
;
12302 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12304 /* No redisplay if running in batch mode or frame is not yet fully
12305 initialized, or redisplay is explicitly turned off by setting
12306 Vinhibit_redisplay. */
12307 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12308 || !NILP (Vinhibit_redisplay
))
12311 /* Don't examine these until after testing Vinhibit_redisplay.
12312 When Emacs is shutting down, perhaps because its connection to
12313 X has dropped, we should not look at them at all. */
12314 fr
= XFRAME (w
->frame
);
12315 sf
= SELECTED_FRAME ();
12317 if (!fr
->glyphs_initialized_p
)
12320 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12321 if (popup_activated ())
12325 /* I don't think this happens but let's be paranoid. */
12326 if (redisplaying_p
)
12329 /* Record a function that resets redisplaying_p to its old value
12330 when we leave this function. */
12331 count
= SPECPDL_INDEX ();
12332 record_unwind_protect (unwind_redisplay
,
12333 Fcons (make_number (redisplaying_p
), selected_frame
));
12335 specbind (Qinhibit_free_realized_faces
, Qnil
);
12338 Lisp_Object tail
, frame
;
12340 FOR_EACH_FRAME (tail
, frame
)
12342 struct frame
*f
= XFRAME (frame
);
12343 f
->already_hscrolled_p
= 0;
12348 /* Remember the currently selected window. */
12351 if (!EQ (old_frame
, selected_frame
)
12352 && FRAME_LIVE_P (XFRAME (old_frame
)))
12353 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12354 selected_frame and selected_window to be temporarily out-of-sync so
12355 when we come back here via `goto retry', we need to resync because we
12356 may need to run Elisp code (via prepare_menu_bars). */
12357 select_frame_for_redisplay (old_frame
);
12360 reconsider_clip_changes (w
, current_buffer
);
12361 last_escape_glyph_frame
= NULL
;
12362 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12363 last_glyphless_glyph_frame
= NULL
;
12364 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12366 /* If new fonts have been loaded that make a glyph matrix adjustment
12367 necessary, do it. */
12368 if (fonts_changed_p
)
12370 adjust_glyphs (NULL
);
12371 ++windows_or_buffers_changed
;
12372 fonts_changed_p
= 0;
12375 /* If face_change_count is non-zero, init_iterator will free all
12376 realized faces, which includes the faces referenced from current
12377 matrices. So, we can't reuse current matrices in this case. */
12378 if (face_change_count
)
12379 ++windows_or_buffers_changed
;
12381 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12382 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12384 /* Since frames on a single ASCII terminal share the same
12385 display area, displaying a different frame means redisplay
12386 the whole thing. */
12387 windows_or_buffers_changed
++;
12388 SET_FRAME_GARBAGED (sf
);
12390 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12392 FRAME_TTY (sf
)->previous_frame
= sf
;
12395 /* Set the visible flags for all frames. Do this before checking
12396 for resized or garbaged frames; they want to know if their frames
12397 are visible. See the comment in frame.h for
12398 FRAME_SAMPLE_VISIBILITY. */
12400 Lisp_Object tail
, frame
;
12402 number_of_visible_frames
= 0;
12404 FOR_EACH_FRAME (tail
, frame
)
12406 struct frame
*f
= XFRAME (frame
);
12408 FRAME_SAMPLE_VISIBILITY (f
);
12409 if (FRAME_VISIBLE_P (f
))
12410 ++number_of_visible_frames
;
12411 clear_desired_matrices (f
);
12415 /* Notice any pending interrupt request to change frame size. */
12416 do_pending_window_change (1);
12418 /* do_pending_window_change could change the selected_window due to
12419 frame resizing which makes the selected window too small. */
12420 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12423 reconsider_clip_changes (w
, current_buffer
);
12426 /* Clear frames marked as garbaged. */
12427 if (frame_garbaged
)
12428 clear_garbaged_frames ();
12430 /* Build menubar and tool-bar items. */
12431 if (NILP (Vmemory_full
))
12432 prepare_menu_bars ();
12434 if (windows_or_buffers_changed
)
12435 update_mode_lines
++;
12437 /* Detect case that we need to write or remove a star in the mode line. */
12438 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12440 w
->update_mode_line
= Qt
;
12441 if (buffer_shared
> 1)
12442 update_mode_lines
++;
12445 /* Avoid invocation of point motion hooks by `current_column' below. */
12446 count1
= SPECPDL_INDEX ();
12447 specbind (Qinhibit_point_motion_hooks
, Qt
);
12449 /* If %c is in the mode line, update it if needed. */
12450 if (!NILP (w
->column_number_displayed
)
12451 /* This alternative quickly identifies a common case
12452 where no change is needed. */
12453 && !(PT
== XFASTINT (w
->last_point
)
12454 && XFASTINT (w
->last_modified
) >= MODIFF
12455 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12456 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12457 w
->update_mode_line
= Qt
;
12459 unbind_to (count1
, Qnil
);
12461 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12463 /* The variable buffer_shared is set in redisplay_window and
12464 indicates that we redisplay a buffer in different windows. See
12466 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12467 || cursor_type_changed
);
12469 /* If specs for an arrow have changed, do thorough redisplay
12470 to ensure we remove any arrow that should no longer exist. */
12471 if (overlay_arrows_changed_p ())
12472 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12474 /* Normally the message* functions will have already displayed and
12475 updated the echo area, but the frame may have been trashed, or
12476 the update may have been preempted, so display the echo area
12477 again here. Checking message_cleared_p captures the case that
12478 the echo area should be cleared. */
12479 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12480 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12481 || (message_cleared_p
12482 && minibuf_level
== 0
12483 /* If the mini-window is currently selected, this means the
12484 echo-area doesn't show through. */
12485 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12487 int window_height_changed_p
= echo_area_display (0);
12490 /* If we don't display the current message, don't clear the
12491 message_cleared_p flag, because, if we did, we wouldn't clear
12492 the echo area in the next redisplay which doesn't preserve
12494 if (!display_last_displayed_message_p
)
12495 message_cleared_p
= 0;
12497 if (fonts_changed_p
)
12499 else if (window_height_changed_p
)
12501 consider_all_windows_p
= 1;
12502 ++update_mode_lines
;
12503 ++windows_or_buffers_changed
;
12505 /* If window configuration was changed, frames may have been
12506 marked garbaged. Clear them or we will experience
12507 surprises wrt scrolling. */
12508 if (frame_garbaged
)
12509 clear_garbaged_frames ();
12512 else if (EQ (selected_window
, minibuf_window
)
12513 && (current_buffer
->clip_changed
12514 || XFASTINT (w
->last_modified
) < MODIFF
12515 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12516 && resize_mini_window (w
, 0))
12518 /* Resized active mini-window to fit the size of what it is
12519 showing if its contents might have changed. */
12521 /* FIXME: this causes all frames to be updated, which seems unnecessary
12522 since only the current frame needs to be considered. This function needs
12523 to be rewritten with two variables, consider_all_windows and
12524 consider_all_frames. */
12525 consider_all_windows_p
= 1;
12526 ++windows_or_buffers_changed
;
12527 ++update_mode_lines
;
12529 /* If window configuration was changed, frames may have been
12530 marked garbaged. Clear them or we will experience
12531 surprises wrt scrolling. */
12532 if (frame_garbaged
)
12533 clear_garbaged_frames ();
12537 /* If showing the region, and mark has changed, we must redisplay
12538 the whole window. The assignment to this_line_start_pos prevents
12539 the optimization directly below this if-statement. */
12540 if (((!NILP (Vtransient_mark_mode
)
12541 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12542 != !NILP (w
->region_showing
))
12543 || (!NILP (w
->region_showing
)
12544 && !EQ (w
->region_showing
,
12545 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12546 CHARPOS (this_line_start_pos
) = 0;
12548 /* Optimize the case that only the line containing the cursor in the
12549 selected window has changed. Variables starting with this_ are
12550 set in display_line and record information about the line
12551 containing the cursor. */
12552 tlbufpos
= this_line_start_pos
;
12553 tlendpos
= this_line_end_pos
;
12554 if (!consider_all_windows_p
12555 && CHARPOS (tlbufpos
) > 0
12556 && NILP (w
->update_mode_line
)
12557 && !current_buffer
->clip_changed
12558 && !current_buffer
->prevent_redisplay_optimizations_p
12559 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12560 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12561 /* Make sure recorded data applies to current buffer, etc. */
12562 && this_line_buffer
== current_buffer
12563 && current_buffer
== XBUFFER (w
->buffer
)
12564 && NILP (w
->force_start
)
12565 && NILP (w
->optional_new_start
)
12566 /* Point must be on the line that we have info recorded about. */
12567 && PT
>= CHARPOS (tlbufpos
)
12568 && PT
<= Z
- CHARPOS (tlendpos
)
12569 /* All text outside that line, including its final newline,
12570 must be unchanged. */
12571 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12572 CHARPOS (tlendpos
)))
12574 if (CHARPOS (tlbufpos
) > BEGV
12575 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12576 && (CHARPOS (tlbufpos
) == ZV
12577 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12578 /* Former continuation line has disappeared by becoming empty. */
12580 else if (XFASTINT (w
->last_modified
) < MODIFF
12581 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12582 || MINI_WINDOW_P (w
))
12584 /* We have to handle the case of continuation around a
12585 wide-column character (see the comment in indent.c around
12588 For instance, in the following case:
12590 -------- Insert --------
12591 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12592 J_I_ ==> J_I_ `^^' are cursors.
12596 As we have to redraw the line above, we cannot use this
12600 int line_height_before
= this_line_pixel_height
;
12602 /* Note that start_display will handle the case that the
12603 line starting at tlbufpos is a continuation line. */
12604 start_display (&it
, w
, tlbufpos
);
12606 /* Implementation note: It this still necessary? */
12607 if (it
.current_x
!= this_line_start_x
)
12610 TRACE ((stderr
, "trying display optimization 1\n"));
12611 w
->cursor
.vpos
= -1;
12612 overlay_arrow_seen
= 0;
12613 it
.vpos
= this_line_vpos
;
12614 it
.current_y
= this_line_y
;
12615 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12616 display_line (&it
);
12618 /* If line contains point, is not continued,
12619 and ends at same distance from eob as before, we win. */
12620 if (w
->cursor
.vpos
>= 0
12621 /* Line is not continued, otherwise this_line_start_pos
12622 would have been set to 0 in display_line. */
12623 && CHARPOS (this_line_start_pos
)
12624 /* Line ends as before. */
12625 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12626 /* Line has same height as before. Otherwise other lines
12627 would have to be shifted up or down. */
12628 && this_line_pixel_height
== line_height_before
)
12630 /* If this is not the window's last line, we must adjust
12631 the charstarts of the lines below. */
12632 if (it
.current_y
< it
.last_visible_y
)
12634 struct glyph_row
*row
12635 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12636 EMACS_INT delta
, delta_bytes
;
12638 /* We used to distinguish between two cases here,
12639 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12640 when the line ends in a newline or the end of the
12641 buffer's accessible portion. But both cases did
12642 the same, so they were collapsed. */
12644 - CHARPOS (tlendpos
)
12645 - MATRIX_ROW_START_CHARPOS (row
));
12646 delta_bytes
= (Z_BYTE
12647 - BYTEPOS (tlendpos
)
12648 - MATRIX_ROW_START_BYTEPOS (row
));
12650 increment_matrix_positions (w
->current_matrix
,
12651 this_line_vpos
+ 1,
12652 w
->current_matrix
->nrows
,
12653 delta
, delta_bytes
);
12656 /* If this row displays text now but previously didn't,
12657 or vice versa, w->window_end_vpos may have to be
12659 if ((it
.glyph_row
- 1)->displays_text_p
)
12661 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12662 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12664 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12665 && this_line_vpos
> 0)
12666 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12667 w
->window_end_valid
= Qnil
;
12669 /* Update hint: No need to try to scroll in update_window. */
12670 w
->desired_matrix
->no_scrolling_p
= 1;
12673 *w
->desired_matrix
->method
= 0;
12674 debug_method_add (w
, "optimization 1");
12676 #ifdef HAVE_WINDOW_SYSTEM
12677 update_window_fringes (w
, 0);
12684 else if (/* Cursor position hasn't changed. */
12685 PT
== XFASTINT (w
->last_point
)
12686 /* Make sure the cursor was last displayed
12687 in this window. Otherwise we have to reposition it. */
12688 && 0 <= w
->cursor
.vpos
12689 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12693 do_pending_window_change (1);
12694 /* If selected_window changed, redisplay again. */
12695 if (WINDOWP (selected_window
)
12696 && (w
= XWINDOW (selected_window
)) != sw
)
12699 /* We used to always goto end_of_redisplay here, but this
12700 isn't enough if we have a blinking cursor. */
12701 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12702 goto end_of_redisplay
;
12706 /* If highlighting the region, or if the cursor is in the echo area,
12707 then we can't just move the cursor. */
12708 else if (! (!NILP (Vtransient_mark_mode
)
12709 && !NILP (BVAR (current_buffer
, mark_active
)))
12710 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12711 || highlight_nonselected_windows
)
12712 && NILP (w
->region_showing
)
12713 && NILP (Vshow_trailing_whitespace
)
12714 && !cursor_in_echo_area
)
12717 struct glyph_row
*row
;
12719 /* Skip from tlbufpos to PT and see where it is. Note that
12720 PT may be in invisible text. If so, we will end at the
12721 next visible position. */
12722 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12723 NULL
, DEFAULT_FACE_ID
);
12724 it
.current_x
= this_line_start_x
;
12725 it
.current_y
= this_line_y
;
12726 it
.vpos
= this_line_vpos
;
12728 /* The call to move_it_to stops in front of PT, but
12729 moves over before-strings. */
12730 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12732 if (it
.vpos
== this_line_vpos
12733 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12736 xassert (this_line_vpos
== it
.vpos
);
12737 xassert (this_line_y
== it
.current_y
);
12738 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12740 *w
->desired_matrix
->method
= 0;
12741 debug_method_add (w
, "optimization 3");
12750 /* Text changed drastically or point moved off of line. */
12751 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12754 CHARPOS (this_line_start_pos
) = 0;
12755 consider_all_windows_p
|= buffer_shared
> 1;
12756 ++clear_face_cache_count
;
12757 #ifdef HAVE_WINDOW_SYSTEM
12758 ++clear_image_cache_count
;
12761 /* Build desired matrices, and update the display. If
12762 consider_all_windows_p is non-zero, do it for all windows on all
12763 frames. Otherwise do it for selected_window, only. */
12765 if (consider_all_windows_p
)
12767 Lisp_Object tail
, frame
;
12769 FOR_EACH_FRAME (tail
, frame
)
12770 XFRAME (frame
)->updated_p
= 0;
12772 /* Recompute # windows showing selected buffer. This will be
12773 incremented each time such a window is displayed. */
12776 FOR_EACH_FRAME (tail
, frame
)
12778 struct frame
*f
= XFRAME (frame
);
12780 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12782 if (! EQ (frame
, selected_frame
))
12783 /* Select the frame, for the sake of frame-local
12785 select_frame_for_redisplay (frame
);
12787 /* Mark all the scroll bars to be removed; we'll redeem
12788 the ones we want when we redisplay their windows. */
12789 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12790 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12792 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12793 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12795 /* The X error handler may have deleted that frame. */
12796 if (!FRAME_LIVE_P (f
))
12799 /* Any scroll bars which redisplay_windows should have
12800 nuked should now go away. */
12801 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12802 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12804 /* If fonts changed, display again. */
12805 /* ??? rms: I suspect it is a mistake to jump all the way
12806 back to retry here. It should just retry this frame. */
12807 if (fonts_changed_p
)
12810 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12812 /* See if we have to hscroll. */
12813 if (!f
->already_hscrolled_p
)
12815 f
->already_hscrolled_p
= 1;
12816 if (hscroll_windows (f
->root_window
))
12820 /* Prevent various kinds of signals during display
12821 update. stdio is not robust about handling
12822 signals, which can cause an apparent I/O
12824 if (interrupt_input
)
12825 unrequest_sigio ();
12828 /* Update the display. */
12829 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12830 pending
|= update_frame (f
, 0, 0);
12836 if (!EQ (old_frame
, selected_frame
)
12837 && FRAME_LIVE_P (XFRAME (old_frame
)))
12838 /* We played a bit fast-and-loose above and allowed selected_frame
12839 and selected_window to be temporarily out-of-sync but let's make
12840 sure this stays contained. */
12841 select_frame_for_redisplay (old_frame
);
12842 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12846 /* Do the mark_window_display_accurate after all windows have
12847 been redisplayed because this call resets flags in buffers
12848 which are needed for proper redisplay. */
12849 FOR_EACH_FRAME (tail
, frame
)
12851 struct frame
*f
= XFRAME (frame
);
12854 mark_window_display_accurate (f
->root_window
, 1);
12855 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12856 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12861 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12863 Lisp_Object mini_window
;
12864 struct frame
*mini_frame
;
12866 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12867 /* Use list_of_error, not Qerror, so that
12868 we catch only errors and don't run the debugger. */
12869 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12871 redisplay_window_error
);
12873 /* Compare desired and current matrices, perform output. */
12876 /* If fonts changed, display again. */
12877 if (fonts_changed_p
)
12880 /* Prevent various kinds of signals during display update.
12881 stdio is not robust about handling signals,
12882 which can cause an apparent I/O error. */
12883 if (interrupt_input
)
12884 unrequest_sigio ();
12887 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12889 if (hscroll_windows (selected_window
))
12892 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12893 pending
= update_frame (sf
, 0, 0);
12896 /* We may have called echo_area_display at the top of this
12897 function. If the echo area is on another frame, that may
12898 have put text on a frame other than the selected one, so the
12899 above call to update_frame would not have caught it. Catch
12901 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12902 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12904 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12906 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12907 pending
|= update_frame (mini_frame
, 0, 0);
12908 if (!pending
&& hscroll_windows (mini_window
))
12913 /* If display was paused because of pending input, make sure we do a
12914 thorough update the next time. */
12917 /* Prevent the optimization at the beginning of
12918 redisplay_internal that tries a single-line update of the
12919 line containing the cursor in the selected window. */
12920 CHARPOS (this_line_start_pos
) = 0;
12922 /* Let the overlay arrow be updated the next time. */
12923 update_overlay_arrows (0);
12925 /* If we pause after scrolling, some rows in the current
12926 matrices of some windows are not valid. */
12927 if (!WINDOW_FULL_WIDTH_P (w
)
12928 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12929 update_mode_lines
= 1;
12933 if (!consider_all_windows_p
)
12935 /* This has already been done above if
12936 consider_all_windows_p is set. */
12937 mark_window_display_accurate_1 (w
, 1);
12939 /* Say overlay arrows are up to date. */
12940 update_overlay_arrows (1);
12942 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12943 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12946 update_mode_lines
= 0;
12947 windows_or_buffers_changed
= 0;
12948 cursor_type_changed
= 0;
12951 /* Start SIGIO interrupts coming again. Having them off during the
12952 code above makes it less likely one will discard output, but not
12953 impossible, since there might be stuff in the system buffer here.
12954 But it is much hairier to try to do anything about that. */
12955 if (interrupt_input
)
12959 /* If a frame has become visible which was not before, redisplay
12960 again, so that we display it. Expose events for such a frame
12961 (which it gets when becoming visible) don't call the parts of
12962 redisplay constructing glyphs, so simply exposing a frame won't
12963 display anything in this case. So, we have to display these
12964 frames here explicitly. */
12967 Lisp_Object tail
, frame
;
12970 FOR_EACH_FRAME (tail
, frame
)
12972 int this_is_visible
= 0;
12974 if (XFRAME (frame
)->visible
)
12975 this_is_visible
= 1;
12976 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12977 if (XFRAME (frame
)->visible
)
12978 this_is_visible
= 1;
12980 if (this_is_visible
)
12984 if (new_count
!= number_of_visible_frames
)
12985 windows_or_buffers_changed
++;
12988 /* Change frame size now if a change is pending. */
12989 do_pending_window_change (1);
12991 /* If we just did a pending size change, or have additional
12992 visible frames, or selected_window changed, redisplay again. */
12993 if ((windows_or_buffers_changed
&& !pending
)
12994 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
12997 /* Clear the face and image caches.
12999 We used to do this only if consider_all_windows_p. But the cache
13000 needs to be cleared if a timer creates images in the current
13001 buffer (e.g. the test case in Bug#6230). */
13003 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13005 clear_face_cache (0);
13006 clear_face_cache_count
= 0;
13009 #ifdef HAVE_WINDOW_SYSTEM
13010 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13012 clear_image_caches (Qnil
);
13013 clear_image_cache_count
= 0;
13015 #endif /* HAVE_WINDOW_SYSTEM */
13018 unbind_to (count
, Qnil
);
13023 /* Redisplay, but leave alone any recent echo area message unless
13024 another message has been requested in its place.
13026 This is useful in situations where you need to redisplay but no
13027 user action has occurred, making it inappropriate for the message
13028 area to be cleared. See tracking_off and
13029 wait_reading_process_output for examples of these situations.
13031 FROM_WHERE is an integer saying from where this function was
13032 called. This is useful for debugging. */
13035 redisplay_preserve_echo_area (int from_where
)
13037 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13039 if (!NILP (echo_area_buffer
[1]))
13041 /* We have a previously displayed message, but no current
13042 message. Redisplay the previous message. */
13043 display_last_displayed_message_p
= 1;
13044 redisplay_internal ();
13045 display_last_displayed_message_p
= 0;
13048 redisplay_internal ();
13050 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13051 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13052 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13056 /* Function registered with record_unwind_protect in
13057 redisplay_internal. Reset redisplaying_p to the value it had
13058 before redisplay_internal was called, and clear
13059 prevent_freeing_realized_faces_p. It also selects the previously
13060 selected frame, unless it has been deleted (by an X connection
13061 failure during redisplay, for example). */
13064 unwind_redisplay (Lisp_Object val
)
13066 Lisp_Object old_redisplaying_p
, old_frame
;
13068 old_redisplaying_p
= XCAR (val
);
13069 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13070 old_frame
= XCDR (val
);
13071 if (! EQ (old_frame
, selected_frame
)
13072 && FRAME_LIVE_P (XFRAME (old_frame
)))
13073 select_frame_for_redisplay (old_frame
);
13078 /* Mark the display of window W as accurate or inaccurate. If
13079 ACCURATE_P is non-zero mark display of W as accurate. If
13080 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13081 redisplay_internal is called. */
13084 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13086 if (BUFFERP (w
->buffer
))
13088 struct buffer
*b
= XBUFFER (w
->buffer
);
13091 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13092 w
->last_overlay_modified
13093 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13095 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13099 b
->clip_changed
= 0;
13100 b
->prevent_redisplay_optimizations_p
= 0;
13102 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13103 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13104 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13105 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13107 w
->current_matrix
->buffer
= b
;
13108 w
->current_matrix
->begv
= BUF_BEGV (b
);
13109 w
->current_matrix
->zv
= BUF_ZV (b
);
13111 w
->last_cursor
= w
->cursor
;
13112 w
->last_cursor_off_p
= w
->cursor_off_p
;
13114 if (w
== XWINDOW (selected_window
))
13115 w
->last_point
= make_number (BUF_PT (b
));
13117 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13123 w
->window_end_valid
= w
->buffer
;
13124 w
->update_mode_line
= Qnil
;
13129 /* Mark the display of windows in the window tree rooted at WINDOW as
13130 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13131 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13132 be redisplayed the next time redisplay_internal is called. */
13135 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13139 for (; !NILP (window
); window
= w
->next
)
13141 w
= XWINDOW (window
);
13142 mark_window_display_accurate_1 (w
, accurate_p
);
13144 if (!NILP (w
->vchild
))
13145 mark_window_display_accurate (w
->vchild
, accurate_p
);
13146 if (!NILP (w
->hchild
))
13147 mark_window_display_accurate (w
->hchild
, accurate_p
);
13152 update_overlay_arrows (1);
13156 /* Force a thorough redisplay the next time by setting
13157 last_arrow_position and last_arrow_string to t, which is
13158 unequal to any useful value of Voverlay_arrow_... */
13159 update_overlay_arrows (-1);
13164 /* Return value in display table DP (Lisp_Char_Table *) for character
13165 C. Since a display table doesn't have any parent, we don't have to
13166 follow parent. Do not call this function directly but use the
13167 macro DISP_CHAR_VECTOR. */
13170 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13174 if (ASCII_CHAR_P (c
))
13177 if (SUB_CHAR_TABLE_P (val
))
13178 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13184 XSETCHAR_TABLE (table
, dp
);
13185 val
= char_table_ref (table
, c
);
13194 /***********************************************************************
13196 ***********************************************************************/
13198 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13201 redisplay_windows (Lisp_Object window
)
13203 while (!NILP (window
))
13205 struct window
*w
= XWINDOW (window
);
13207 if (!NILP (w
->hchild
))
13208 redisplay_windows (w
->hchild
);
13209 else if (!NILP (w
->vchild
))
13210 redisplay_windows (w
->vchild
);
13211 else if (!NILP (w
->buffer
))
13213 displayed_buffer
= XBUFFER (w
->buffer
);
13214 /* Use list_of_error, not Qerror, so that
13215 we catch only errors and don't run the debugger. */
13216 internal_condition_case_1 (redisplay_window_0
, window
,
13218 redisplay_window_error
);
13226 redisplay_window_error (Lisp_Object ignore
)
13228 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13233 redisplay_window_0 (Lisp_Object window
)
13235 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13236 redisplay_window (window
, 0);
13241 redisplay_window_1 (Lisp_Object window
)
13243 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13244 redisplay_window (window
, 1);
13249 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13250 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13251 which positions recorded in ROW differ from current buffer
13254 Return 0 if cursor is not on this row, 1 otherwise. */
13257 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13258 struct glyph_matrix
*matrix
,
13259 EMACS_INT delta
, EMACS_INT delta_bytes
,
13262 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13263 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13264 struct glyph
*cursor
= NULL
;
13265 /* The last known character position in row. */
13266 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13268 EMACS_INT pt_old
= PT
- delta
;
13269 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13270 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13271 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13272 /* A glyph beyond the edge of TEXT_AREA which we should never
13274 struct glyph
*glyphs_end
= end
;
13275 /* Non-zero means we've found a match for cursor position, but that
13276 glyph has the avoid_cursor_p flag set. */
13277 int match_with_avoid_cursor
= 0;
13278 /* Non-zero means we've seen at least one glyph that came from a
13280 int string_seen
= 0;
13281 /* Largest and smalles buffer positions seen so far during scan of
13283 EMACS_INT bpos_max
= pos_before
;
13284 EMACS_INT bpos_min
= pos_after
;
13285 /* Last buffer position covered by an overlay string with an integer
13286 `cursor' property. */
13287 EMACS_INT bpos_covered
= 0;
13289 /* Skip over glyphs not having an object at the start and the end of
13290 the row. These are special glyphs like truncation marks on
13291 terminal frames. */
13292 if (row
->displays_text_p
)
13294 if (!row
->reversed_p
)
13297 && INTEGERP (glyph
->object
)
13298 && glyph
->charpos
< 0)
13300 x
+= glyph
->pixel_width
;
13304 && INTEGERP ((end
- 1)->object
)
13305 /* CHARPOS is zero for blanks and stretch glyphs
13306 inserted by extend_face_to_end_of_line. */
13307 && (end
- 1)->charpos
<= 0)
13309 glyph_before
= glyph
- 1;
13316 /* If the glyph row is reversed, we need to process it from back
13317 to front, so swap the edge pointers. */
13318 glyphs_end
= end
= glyph
- 1;
13319 glyph
+= row
->used
[TEXT_AREA
] - 1;
13321 while (glyph
> end
+ 1
13322 && INTEGERP (glyph
->object
)
13323 && glyph
->charpos
< 0)
13326 x
-= glyph
->pixel_width
;
13328 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13330 /* By default, in reversed rows we put the cursor on the
13331 rightmost (first in the reading order) glyph. */
13332 for (g
= end
+ 1; g
< glyph
; g
++)
13333 x
+= g
->pixel_width
;
13335 && INTEGERP ((end
+ 1)->object
)
13336 && (end
+ 1)->charpos
<= 0)
13338 glyph_before
= glyph
+ 1;
13342 else if (row
->reversed_p
)
13344 /* In R2L rows that don't display text, put the cursor on the
13345 rightmost glyph. Case in point: an empty last line that is
13346 part of an R2L paragraph. */
13348 /* Avoid placing the cursor on the last glyph of the row, where
13349 on terminal frames we hold the vertical border between
13350 adjacent windows. */
13351 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13352 && !WINDOW_RIGHTMOST_P (w
)
13353 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13355 x
= -1; /* will be computed below, at label compute_x */
13358 /* Step 1: Try to find the glyph whose character position
13359 corresponds to point. If that's not possible, find 2 glyphs
13360 whose character positions are the closest to point, one before
13361 point, the other after it. */
13362 if (!row
->reversed_p
)
13363 while (/* not marched to end of glyph row */
13365 /* glyph was not inserted by redisplay for internal purposes */
13366 && !INTEGERP (glyph
->object
))
13368 if (BUFFERP (glyph
->object
))
13370 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13372 if (glyph
->charpos
> bpos_max
)
13373 bpos_max
= glyph
->charpos
;
13374 if (glyph
->charpos
< bpos_min
)
13375 bpos_min
= glyph
->charpos
;
13376 if (!glyph
->avoid_cursor_p
)
13378 /* If we hit point, we've found the glyph on which to
13379 display the cursor. */
13382 match_with_avoid_cursor
= 0;
13385 /* See if we've found a better approximation to
13386 POS_BEFORE or to POS_AFTER. Note that we want the
13387 first (leftmost) glyph of all those that are the
13388 closest from below, and the last (rightmost) of all
13389 those from above. */
13390 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13392 pos_before
= glyph
->charpos
;
13393 glyph_before
= glyph
;
13395 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13397 pos_after
= glyph
->charpos
;
13398 glyph_after
= glyph
;
13401 else if (dpos
== 0)
13402 match_with_avoid_cursor
= 1;
13404 else if (STRINGP (glyph
->object
))
13406 Lisp_Object chprop
;
13407 EMACS_INT glyph_pos
= glyph
->charpos
;
13409 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13411 if (INTEGERP (chprop
))
13413 bpos_covered
= bpos_max
+ XINT (chprop
);
13414 /* If the `cursor' property covers buffer positions up
13415 to and including point, we should display cursor on
13416 this glyph. Note that overlays and text properties
13417 with string values stop bidi reordering, so every
13418 buffer position to the left of the string is always
13419 smaller than any position to the right of the
13420 string. Therefore, if a `cursor' property on one
13421 of the string's characters has an integer value, we
13422 will break out of the loop below _before_ we get to
13423 the position match above. IOW, integer values of
13424 the `cursor' property override the "exact match for
13425 point" strategy of positioning the cursor. */
13426 /* Implementation note: bpos_max == pt_old when, e.g.,
13427 we are in an empty line, where bpos_max is set to
13428 MATRIX_ROW_START_CHARPOS, see above. */
13429 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13438 x
+= glyph
->pixel_width
;
13441 else if (glyph
> end
) /* row is reversed */
13442 while (!INTEGERP (glyph
->object
))
13444 if (BUFFERP (glyph
->object
))
13446 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13448 if (glyph
->charpos
> bpos_max
)
13449 bpos_max
= glyph
->charpos
;
13450 if (glyph
->charpos
< bpos_min
)
13451 bpos_min
= glyph
->charpos
;
13452 if (!glyph
->avoid_cursor_p
)
13456 match_with_avoid_cursor
= 0;
13459 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13461 pos_before
= glyph
->charpos
;
13462 glyph_before
= glyph
;
13464 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13466 pos_after
= glyph
->charpos
;
13467 glyph_after
= glyph
;
13470 else if (dpos
== 0)
13471 match_with_avoid_cursor
= 1;
13473 else if (STRINGP (glyph
->object
))
13475 Lisp_Object chprop
;
13476 EMACS_INT glyph_pos
= glyph
->charpos
;
13478 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13480 if (INTEGERP (chprop
))
13482 bpos_covered
= bpos_max
+ XINT (chprop
);
13483 /* If the `cursor' property covers buffer positions up
13484 to and including point, we should display cursor on
13486 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13495 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13497 x
--; /* can't use any pixel_width */
13500 x
-= glyph
->pixel_width
;
13503 /* Step 2: If we didn't find an exact match for point, we need to
13504 look for a proper place to put the cursor among glyphs between
13505 GLYPH_BEFORE and GLYPH_AFTER. */
13506 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13507 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13508 && bpos_covered
< pt_old
)
13510 /* An empty line has a single glyph whose OBJECT is zero and
13511 whose CHARPOS is the position of a newline on that line.
13512 Note that on a TTY, there are more glyphs after that, which
13513 were produced by extend_face_to_end_of_line, but their
13514 CHARPOS is zero or negative. */
13516 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13517 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13519 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13521 EMACS_INT ellipsis_pos
;
13523 /* Scan back over the ellipsis glyphs. */
13524 if (!row
->reversed_p
)
13526 ellipsis_pos
= (glyph
- 1)->charpos
;
13527 while (glyph
> row
->glyphs
[TEXT_AREA
]
13528 && (glyph
- 1)->charpos
== ellipsis_pos
)
13529 glyph
--, x
-= glyph
->pixel_width
;
13530 /* That loop always goes one position too far, including
13531 the glyph before the ellipsis. So scan forward over
13533 x
+= glyph
->pixel_width
;
13536 else /* row is reversed */
13538 ellipsis_pos
= (glyph
+ 1)->charpos
;
13539 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13540 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13541 glyph
++, x
+= glyph
->pixel_width
;
13542 x
-= glyph
->pixel_width
;
13546 else if (match_with_avoid_cursor
13547 /* A truncated row may not include PT among its
13548 character positions. Setting the cursor inside the
13549 scroll margin will trigger recalculation of hscroll
13550 in hscroll_window_tree. */
13551 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13552 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13553 /* Zero-width characters produce no glyphs. */
13556 && (row
->reversed_p
13557 ? glyph_after
> glyphs_end
13558 : glyph_after
< glyphs_end
)))
13560 cursor
= glyph_after
;
13563 else if (string_seen
)
13565 int incr
= row
->reversed_p
? -1 : +1;
13567 /* Need to find the glyph that came out of a string which is
13568 present at point. That glyph is somewhere between
13569 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13570 positioned between POS_BEFORE and POS_AFTER in the
13572 struct glyph
*start
, *stop
;
13573 EMACS_INT pos
= pos_before
;
13577 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13578 correspond to POS_BEFORE and POS_AFTER, respectively. We
13579 need START and STOP in the order that corresponds to the
13580 row's direction as given by its reversed_p flag. If the
13581 directionality of characters between POS_BEFORE and
13582 POS_AFTER is the opposite of the row's base direction,
13583 these characters will have been reordered for display,
13584 and we need to reverse START and STOP. */
13585 if (!row
->reversed_p
)
13587 start
= min (glyph_before
, glyph_after
);
13588 stop
= max (glyph_before
, glyph_after
);
13592 start
= max (glyph_before
, glyph_after
);
13593 stop
= min (glyph_before
, glyph_after
);
13595 for (glyph
= start
+ incr
;
13596 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13599 /* Any glyphs that come from the buffer are here because
13600 of bidi reordering. Skip them, and only pay
13601 attention to glyphs that came from some string. */
13602 if (STRINGP (glyph
->object
))
13607 str
= glyph
->object
;
13608 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
13609 if (tem
== 0 /* from overlay */
13612 /* If the string from which this glyph came is
13613 found in the buffer at point, then we've
13614 found the glyph we've been looking for. If
13615 it comes from an overlay (tem == 0), and it
13616 has the `cursor' property on one of its
13617 glyphs, record that glyph as a candidate for
13618 displaying the cursor. (As in the
13619 unidirectional version, we will display the
13620 cursor on the last candidate we find.) */
13621 if (tem
== 0 || tem
== pt_old
)
13623 /* The glyphs from this string could have
13624 been reordered. Find the one with the
13625 smallest string position. Or there could
13626 be a character in the string with the
13627 `cursor' property, which means display
13628 cursor on that character's glyph. */
13629 EMACS_INT strpos
= glyph
->charpos
;
13634 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13635 && EQ (glyph
->object
, str
);
13639 EMACS_INT gpos
= glyph
->charpos
;
13641 cprop
= Fget_char_property (make_number (gpos
),
13649 if (tem
&& glyph
->charpos
< strpos
)
13651 strpos
= glyph
->charpos
;
13660 pos
= tem
+ 1; /* don't find previous instances */
13662 /* This string is not what we want; skip all of the
13663 glyphs that came from it. */
13664 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13665 && EQ (glyph
->object
, str
))
13672 /* If we reached the end of the line, and END was from a string,
13673 the cursor is not on this line. */
13675 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13676 && STRINGP (end
->object
)
13677 && row
->continued_p
)
13683 if (cursor
!= NULL
)
13689 /* Need to compute x that corresponds to GLYPH. */
13690 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13692 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13694 x
+= g
->pixel_width
;
13698 /* ROW could be part of a continued line, which, under bidi
13699 reordering, might have other rows whose start and end charpos
13700 occlude point. Only set w->cursor if we found a better
13701 approximation to the cursor position than we have from previously
13702 examined candidate rows belonging to the same continued line. */
13703 if (/* we already have a candidate row */
13704 w
->cursor
.vpos
>= 0
13705 /* that candidate is not the row we are processing */
13706 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13707 /* Make sure cursor.vpos specifies a row whose start and end
13708 charpos occlude point. This is because some callers of this
13709 function leave cursor.vpos at the row where the cursor was
13710 displayed during the last redisplay cycle. */
13711 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13712 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13715 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13717 /* Don't consider glyphs that are outside TEXT_AREA. */
13718 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13720 /* Keep the candidate whose buffer position is the closest to
13721 point or has the `cursor' property. */
13722 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13723 w
->cursor
.hpos
>= 0
13724 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13725 && ((BUFFERP (g1
->object
)
13726 && (g1
->charpos
== pt_old
/* an exact match always wins */
13727 || (BUFFERP (glyph
->object
)
13728 && eabs (g1
->charpos
- pt_old
)
13729 < eabs (glyph
->charpos
- pt_old
))))
13730 /* previous candidate is a glyph from a string that has
13731 a non-nil `cursor' property */
13732 || (STRINGP (g1
->object
)
13733 && !NILP (Fget_char_property (make_number (g1
->charpos
),
13734 Qcursor
, g1
->object
)))))
13736 /* If this candidate gives an exact match, use that. */
13737 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13738 /* Otherwise, keep the candidate that comes from a row
13739 spanning less buffer positions. This may win when one or
13740 both candidate positions are on glyphs that came from
13741 display strings, for which we cannot compare buffer
13743 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13744 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13745 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13748 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13750 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13751 w
->cursor
.y
= row
->y
+ dy
;
13753 if (w
== XWINDOW (selected_window
))
13755 if (!row
->continued_p
13756 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13759 this_line_buffer
= XBUFFER (w
->buffer
);
13761 CHARPOS (this_line_start_pos
)
13762 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13763 BYTEPOS (this_line_start_pos
)
13764 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13766 CHARPOS (this_line_end_pos
)
13767 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13768 BYTEPOS (this_line_end_pos
)
13769 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13771 this_line_y
= w
->cursor
.y
;
13772 this_line_pixel_height
= row
->height
;
13773 this_line_vpos
= w
->cursor
.vpos
;
13774 this_line_start_x
= row
->x
;
13777 CHARPOS (this_line_start_pos
) = 0;
13784 /* Run window scroll functions, if any, for WINDOW with new window
13785 start STARTP. Sets the window start of WINDOW to that position.
13787 We assume that the window's buffer is really current. */
13789 static inline struct text_pos
13790 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13792 struct window
*w
= XWINDOW (window
);
13793 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13795 if (current_buffer
!= XBUFFER (w
->buffer
))
13798 if (!NILP (Vwindow_scroll_functions
))
13800 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13801 make_number (CHARPOS (startp
)));
13802 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13803 /* In case the hook functions switch buffers. */
13804 if (current_buffer
!= XBUFFER (w
->buffer
))
13805 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13812 /* Make sure the line containing the cursor is fully visible.
13813 A value of 1 means there is nothing to be done.
13814 (Either the line is fully visible, or it cannot be made so,
13815 or we cannot tell.)
13817 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13818 is higher than window.
13820 A value of 0 means the caller should do scrolling
13821 as if point had gone off the screen. */
13824 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13826 struct glyph_matrix
*matrix
;
13827 struct glyph_row
*row
;
13830 if (!make_cursor_line_fully_visible_p
)
13833 /* It's not always possible to find the cursor, e.g, when a window
13834 is full of overlay strings. Don't do anything in that case. */
13835 if (w
->cursor
.vpos
< 0)
13838 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13839 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13841 /* If the cursor row is not partially visible, there's nothing to do. */
13842 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13845 /* If the row the cursor is in is taller than the window's height,
13846 it's not clear what to do, so do nothing. */
13847 window_height
= window_box_height (w
);
13848 if (row
->height
>= window_height
)
13850 if (!force_p
|| MINI_WINDOW_P (w
)
13851 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13858 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13859 non-zero means only WINDOW is redisplayed in redisplay_internal.
13860 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13861 in redisplay_window to bring a partially visible line into view in
13862 the case that only the cursor has moved.
13864 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13865 last screen line's vertical height extends past the end of the screen.
13869 1 if scrolling succeeded
13871 0 if scrolling didn't find point.
13873 -1 if new fonts have been loaded so that we must interrupt
13874 redisplay, adjust glyph matrices, and try again. */
13880 SCROLLING_NEED_LARGER_MATRICES
13883 /* If scroll-conservatively is more than this, never recenter.
13885 If you change this, don't forget to update the doc string of
13886 `scroll-conservatively' and the Emacs manual. */
13887 #define SCROLL_LIMIT 100
13890 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13891 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13892 int temp_scroll_step
, int last_line_misfit
)
13894 struct window
*w
= XWINDOW (window
);
13895 struct frame
*f
= XFRAME (w
->frame
);
13896 struct text_pos pos
, startp
;
13898 int this_scroll_margin
, scroll_max
, rc
, height
;
13899 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13900 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13901 Lisp_Object aggressive
;
13902 /* We will never try scrolling more than this number of lines. */
13903 int scroll_limit
= SCROLL_LIMIT
;
13906 debug_method_add (w
, "try_scrolling");
13909 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13911 /* Compute scroll margin height in pixels. We scroll when point is
13912 within this distance from the top or bottom of the window. */
13913 if (scroll_margin
> 0)
13914 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13915 * FRAME_LINE_HEIGHT (f
);
13917 this_scroll_margin
= 0;
13919 /* Force arg_scroll_conservatively to have a reasonable value, to
13920 avoid scrolling too far away with slow move_it_* functions. Note
13921 that the user can supply scroll-conservatively equal to
13922 `most-positive-fixnum', which can be larger than INT_MAX. */
13923 if (arg_scroll_conservatively
> scroll_limit
)
13925 arg_scroll_conservatively
= scroll_limit
+ 1;
13926 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13928 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13929 /* Compute how much we should try to scroll maximally to bring
13930 point into view. */
13931 scroll_max
= (max (scroll_step
,
13932 max (arg_scroll_conservatively
, temp_scroll_step
))
13933 * FRAME_LINE_HEIGHT (f
));
13934 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13935 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13936 /* We're trying to scroll because of aggressive scrolling but no
13937 scroll_step is set. Choose an arbitrary one. */
13938 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13944 /* Decide whether to scroll down. */
13945 if (PT
> CHARPOS (startp
))
13947 int scroll_margin_y
;
13949 /* Compute the pixel ypos of the scroll margin, then move it to
13950 either that ypos or PT, whichever comes first. */
13951 start_display (&it
, w
, startp
);
13952 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13953 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13954 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13955 (MOVE_TO_POS
| MOVE_TO_Y
));
13957 if (PT
> CHARPOS (it
.current
.pos
))
13959 int y0
= line_bottom_y (&it
);
13960 /* Compute how many pixels below window bottom to stop searching
13961 for PT. This avoids costly search for PT that is far away if
13962 the user limited scrolling by a small number of lines, but
13963 always finds PT if scroll_conservatively is set to a large
13964 number, such as most-positive-fixnum. */
13965 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13966 int y_to_move
= it
.last_visible_y
+ slack
;
13968 /* Compute the distance from the scroll margin to PT or to
13969 the scroll limit, whichever comes first. This should
13970 include the height of the cursor line, to make that line
13972 move_it_to (&it
, PT
, -1, y_to_move
,
13973 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13974 dy
= line_bottom_y (&it
) - y0
;
13976 if (dy
> scroll_max
)
13977 return SCROLLING_FAILED
;
13985 /* Point is in or below the bottom scroll margin, so move the
13986 window start down. If scrolling conservatively, move it just
13987 enough down to make point visible. If scroll_step is set,
13988 move it down by scroll_step. */
13989 if (arg_scroll_conservatively
)
13991 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13992 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
13993 else if (scroll_step
|| temp_scroll_step
)
13994 amount_to_scroll
= scroll_max
;
13997 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
13998 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13999 if (NUMBERP (aggressive
))
14001 double float_amount
= XFLOATINT (aggressive
) * height
;
14002 amount_to_scroll
= float_amount
;
14003 if (amount_to_scroll
== 0 && float_amount
> 0)
14004 amount_to_scroll
= 1;
14005 /* Don't let point enter the scroll margin near top of
14007 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14008 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14012 if (amount_to_scroll
<= 0)
14013 return SCROLLING_FAILED
;
14015 start_display (&it
, w
, startp
);
14016 if (arg_scroll_conservatively
<= scroll_limit
)
14017 move_it_vertically (&it
, amount_to_scroll
);
14020 /* Extra precision for users who set scroll-conservatively
14021 to a large number: make sure the amount we scroll
14022 the window start is never less than amount_to_scroll,
14023 which was computed as distance from window bottom to
14024 point. This matters when lines at window top and lines
14025 below window bottom have different height. */
14027 void *it1data
= NULL
;
14028 /* We use a temporary it1 because line_bottom_y can modify
14029 its argument, if it moves one line down; see there. */
14032 SAVE_IT (it1
, it
, it1data
);
14033 start_y
= line_bottom_y (&it1
);
14035 RESTORE_IT (&it
, &it
, it1data
);
14036 move_it_by_lines (&it
, 1);
14037 SAVE_IT (it1
, it
, it1data
);
14038 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14041 /* If STARTP is unchanged, move it down another screen line. */
14042 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14043 move_it_by_lines (&it
, 1);
14044 startp
= it
.current
.pos
;
14048 struct text_pos scroll_margin_pos
= startp
;
14050 /* See if point is inside the scroll margin at the top of the
14052 if (this_scroll_margin
)
14054 start_display (&it
, w
, startp
);
14055 move_it_vertically (&it
, this_scroll_margin
);
14056 scroll_margin_pos
= it
.current
.pos
;
14059 if (PT
< CHARPOS (scroll_margin_pos
))
14061 /* Point is in the scroll margin at the top of the window or
14062 above what is displayed in the window. */
14065 /* Compute the vertical distance from PT to the scroll
14066 margin position. Move as far as scroll_max allows, or
14067 one screenful, or 10 screen lines, whichever is largest.
14068 Give up if distance is greater than scroll_max. */
14069 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14070 start_display (&it
, w
, pos
);
14072 y_to_move
= max (it
.last_visible_y
,
14073 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14074 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14076 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14077 dy
= it
.current_y
- y0
;
14078 if (dy
> scroll_max
)
14079 return SCROLLING_FAILED
;
14081 /* Compute new window start. */
14082 start_display (&it
, w
, startp
);
14084 if (arg_scroll_conservatively
)
14085 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14086 max (scroll_step
, temp_scroll_step
));
14087 else if (scroll_step
|| temp_scroll_step
)
14088 amount_to_scroll
= scroll_max
;
14091 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14092 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14093 if (NUMBERP (aggressive
))
14095 double float_amount
= XFLOATINT (aggressive
) * height
;
14096 amount_to_scroll
= float_amount
;
14097 if (amount_to_scroll
== 0 && float_amount
> 0)
14098 amount_to_scroll
= 1;
14099 amount_to_scroll
-=
14100 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14101 /* Don't let point enter the scroll margin near
14102 bottom of the window. */
14103 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14104 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14108 if (amount_to_scroll
<= 0)
14109 return SCROLLING_FAILED
;
14111 move_it_vertically_backward (&it
, amount_to_scroll
);
14112 startp
= it
.current
.pos
;
14116 /* Run window scroll functions. */
14117 startp
= run_window_scroll_functions (window
, startp
);
14119 /* Display the window. Give up if new fonts are loaded, or if point
14121 if (!try_window (window
, startp
, 0))
14122 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14123 else if (w
->cursor
.vpos
< 0)
14125 clear_glyph_matrix (w
->desired_matrix
);
14126 rc
= SCROLLING_FAILED
;
14130 /* Maybe forget recorded base line for line number display. */
14131 if (!just_this_one_p
14132 || current_buffer
->clip_changed
14133 || BEG_UNCHANGED
< CHARPOS (startp
))
14134 w
->base_line_number
= Qnil
;
14136 /* If cursor ends up on a partially visible line,
14137 treat that as being off the bottom of the screen. */
14138 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14139 /* It's possible that the cursor is on the first line of the
14140 buffer, which is partially obscured due to a vscroll
14141 (Bug#7537). In that case, avoid looping forever . */
14142 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14144 clear_glyph_matrix (w
->desired_matrix
);
14145 ++extra_scroll_margin_lines
;
14148 rc
= SCROLLING_SUCCESS
;
14155 /* Compute a suitable window start for window W if display of W starts
14156 on a continuation line. Value is non-zero if a new window start
14159 The new window start will be computed, based on W's width, starting
14160 from the start of the continued line. It is the start of the
14161 screen line with the minimum distance from the old start W->start. */
14164 compute_window_start_on_continuation_line (struct window
*w
)
14166 struct text_pos pos
, start_pos
;
14167 int window_start_changed_p
= 0;
14169 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14171 /* If window start is on a continuation line... Window start may be
14172 < BEGV in case there's invisible text at the start of the
14173 buffer (M-x rmail, for example). */
14174 if (CHARPOS (start_pos
) > BEGV
14175 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14178 struct glyph_row
*row
;
14180 /* Handle the case that the window start is out of range. */
14181 if (CHARPOS (start_pos
) < BEGV
)
14182 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14183 else if (CHARPOS (start_pos
) > ZV
)
14184 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14186 /* Find the start of the continued line. This should be fast
14187 because scan_buffer is fast (newline cache). */
14188 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14189 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14190 row
, DEFAULT_FACE_ID
);
14191 reseat_at_previous_visible_line_start (&it
);
14193 /* If the line start is "too far" away from the window start,
14194 say it takes too much time to compute a new window start. */
14195 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14196 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14198 int min_distance
, distance
;
14200 /* Move forward by display lines to find the new window
14201 start. If window width was enlarged, the new start can
14202 be expected to be > the old start. If window width was
14203 decreased, the new window start will be < the old start.
14204 So, we're looking for the display line start with the
14205 minimum distance from the old window start. */
14206 pos
= it
.current
.pos
;
14207 min_distance
= INFINITY
;
14208 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14209 distance
< min_distance
)
14211 min_distance
= distance
;
14212 pos
= it
.current
.pos
;
14213 move_it_by_lines (&it
, 1);
14216 /* Set the window start there. */
14217 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14218 window_start_changed_p
= 1;
14222 return window_start_changed_p
;
14226 /* Try cursor movement in case text has not changed in window WINDOW,
14227 with window start STARTP. Value is
14229 CURSOR_MOVEMENT_SUCCESS if successful
14231 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14233 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14234 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14235 we want to scroll as if scroll-step were set to 1. See the code.
14237 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14238 which case we have to abort this redisplay, and adjust matrices
14243 CURSOR_MOVEMENT_SUCCESS
,
14244 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14245 CURSOR_MOVEMENT_MUST_SCROLL
,
14246 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14250 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14252 struct window
*w
= XWINDOW (window
);
14253 struct frame
*f
= XFRAME (w
->frame
);
14254 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14257 if (inhibit_try_cursor_movement
)
14261 /* Handle case where text has not changed, only point, and it has
14262 not moved off the frame. */
14263 if (/* Point may be in this window. */
14264 PT
>= CHARPOS (startp
)
14265 /* Selective display hasn't changed. */
14266 && !current_buffer
->clip_changed
14267 /* Function force-mode-line-update is used to force a thorough
14268 redisplay. It sets either windows_or_buffers_changed or
14269 update_mode_lines. So don't take a shortcut here for these
14271 && !update_mode_lines
14272 && !windows_or_buffers_changed
14273 && !cursor_type_changed
14274 /* Can't use this case if highlighting a region. When a
14275 region exists, cursor movement has to do more than just
14277 && !(!NILP (Vtransient_mark_mode
)
14278 && !NILP (BVAR (current_buffer
, mark_active
)))
14279 && NILP (w
->region_showing
)
14280 && NILP (Vshow_trailing_whitespace
)
14281 /* Right after splitting windows, last_point may be nil. */
14282 && INTEGERP (w
->last_point
)
14283 /* This code is not used for mini-buffer for the sake of the case
14284 of redisplaying to replace an echo area message; since in
14285 that case the mini-buffer contents per se are usually
14286 unchanged. This code is of no real use in the mini-buffer
14287 since the handling of this_line_start_pos, etc., in redisplay
14288 handles the same cases. */
14289 && !EQ (window
, minibuf_window
)
14290 /* When splitting windows or for new windows, it happens that
14291 redisplay is called with a nil window_end_vpos or one being
14292 larger than the window. This should really be fixed in
14293 window.c. I don't have this on my list, now, so we do
14294 approximately the same as the old redisplay code. --gerd. */
14295 && INTEGERP (w
->window_end_vpos
)
14296 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14297 && (FRAME_WINDOW_P (f
)
14298 || !overlay_arrow_in_current_buffer_p ()))
14300 int this_scroll_margin
, top_scroll_margin
;
14301 struct glyph_row
*row
= NULL
;
14304 debug_method_add (w
, "cursor movement");
14307 /* Scroll if point within this distance from the top or bottom
14308 of the window. This is a pixel value. */
14309 if (scroll_margin
> 0)
14311 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14312 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14315 this_scroll_margin
= 0;
14317 top_scroll_margin
= this_scroll_margin
;
14318 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14319 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14321 /* Start with the row the cursor was displayed during the last
14322 not paused redisplay. Give up if that row is not valid. */
14323 if (w
->last_cursor
.vpos
< 0
14324 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14325 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14328 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14329 if (row
->mode_line_p
)
14331 if (!row
->enabled_p
)
14332 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14335 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14337 int scroll_p
= 0, must_scroll
= 0;
14338 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14340 if (PT
> XFASTINT (w
->last_point
))
14342 /* Point has moved forward. */
14343 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14344 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14346 xassert (row
->enabled_p
);
14350 /* If the end position of a row equals the start
14351 position of the next row, and PT is at that position,
14352 we would rather display cursor in the next line. */
14353 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14354 && MATRIX_ROW_END_CHARPOS (row
) == PT
14355 && row
< w
->current_matrix
->rows
14356 + w
->current_matrix
->nrows
- 1
14357 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14358 && !cursor_row_p (row
))
14361 /* If within the scroll margin, scroll. Note that
14362 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14363 the next line would be drawn, and that
14364 this_scroll_margin can be zero. */
14365 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14366 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14367 /* Line is completely visible last line in window
14368 and PT is to be set in the next line. */
14369 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14370 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14371 && !row
->ends_at_zv_p
14372 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14375 else if (PT
< XFASTINT (w
->last_point
))
14377 /* Cursor has to be moved backward. Note that PT >=
14378 CHARPOS (startp) because of the outer if-statement. */
14379 while (!row
->mode_line_p
14380 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14381 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14382 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14383 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14384 row
> w
->current_matrix
->rows
14385 && (row
-1)->ends_in_newline_from_string_p
))))
14386 && (row
->y
> top_scroll_margin
14387 || CHARPOS (startp
) == BEGV
))
14389 xassert (row
->enabled_p
);
14393 /* Consider the following case: Window starts at BEGV,
14394 there is invisible, intangible text at BEGV, so that
14395 display starts at some point START > BEGV. It can
14396 happen that we are called with PT somewhere between
14397 BEGV and START. Try to handle that case. */
14398 if (row
< w
->current_matrix
->rows
14399 || row
->mode_line_p
)
14401 row
= w
->current_matrix
->rows
;
14402 if (row
->mode_line_p
)
14406 /* Due to newlines in overlay strings, we may have to
14407 skip forward over overlay strings. */
14408 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14409 && MATRIX_ROW_END_CHARPOS (row
) == PT
14410 && !cursor_row_p (row
))
14413 /* If within the scroll margin, scroll. */
14414 if (row
->y
< top_scroll_margin
14415 && CHARPOS (startp
) != BEGV
)
14420 /* Cursor did not move. So don't scroll even if cursor line
14421 is partially visible, as it was so before. */
14422 rc
= CURSOR_MOVEMENT_SUCCESS
;
14425 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14426 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14428 /* if PT is not in the glyph row, give up. */
14429 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14432 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14433 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14435 /* If rows are bidi-reordered and point moved, back up
14436 until we find a row that does not belong to a
14437 continuation line. This is because we must consider
14438 all rows of a continued line as candidates for the
14439 new cursor positioning, since row start and end
14440 positions change non-linearly with vertical position
14442 /* FIXME: Revisit this when glyph ``spilling'' in
14443 continuation lines' rows is implemented for
14444 bidi-reordered rows. */
14445 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14447 xassert (row
->enabled_p
);
14449 /* If we hit the beginning of the displayed portion
14450 without finding the first row of a continued
14452 if (row
<= w
->current_matrix
->rows
)
14454 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14462 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14463 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14464 && make_cursor_line_fully_visible_p
)
14466 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14467 && !row
->ends_at_zv_p
14468 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14469 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14470 else if (row
->height
> window_box_height (w
))
14472 /* If we end up in a partially visible line, let's
14473 make it fully visible, except when it's taller
14474 than the window, in which case we can't do much
14477 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14481 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14482 if (!cursor_row_fully_visible_p (w
, 0, 1))
14483 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14485 rc
= CURSOR_MOVEMENT_SUCCESS
;
14489 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14490 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14491 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14493 /* With bidi-reordered rows, there could be more than
14494 one candidate row whose start and end positions
14495 occlude point. We need to let set_cursor_from_row
14496 find the best candidate. */
14497 /* FIXME: Revisit this when glyph ``spilling'' in
14498 continuation lines' rows is implemented for
14499 bidi-reordered rows. */
14504 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14505 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14506 && cursor_row_p (row
))
14507 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14509 /* As soon as we've found the first suitable row
14510 whose ends_at_zv_p flag is set, we are done. */
14512 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14514 rc
= CURSOR_MOVEMENT_SUCCESS
;
14519 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14520 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14521 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14522 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14523 /* If we didn't find any candidate rows, or exited the
14524 loop before all the candidates were examined, signal
14525 to the caller that this method failed. */
14526 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14527 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14528 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14530 rc
= CURSOR_MOVEMENT_SUCCESS
;
14536 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14538 rc
= CURSOR_MOVEMENT_SUCCESS
;
14543 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14544 && MATRIX_ROW_START_CHARPOS (row
) == PT
14545 && cursor_row_p (row
));
14553 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14557 set_vertical_scroll_bar (struct window
*w
)
14559 EMACS_INT start
, end
, whole
;
14561 /* Calculate the start and end positions for the current window.
14562 At some point, it would be nice to choose between scrollbars
14563 which reflect the whole buffer size, with special markers
14564 indicating narrowing, and scrollbars which reflect only the
14567 Note that mini-buffers sometimes aren't displaying any text. */
14568 if (!MINI_WINDOW_P (w
)
14569 || (w
== XWINDOW (minibuf_window
)
14570 && NILP (echo_area_buffer
[0])))
14572 struct buffer
*buf
= XBUFFER (w
->buffer
);
14573 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14574 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14575 /* I don't think this is guaranteed to be right. For the
14576 moment, we'll pretend it is. */
14577 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14581 if (whole
< (end
- start
))
14582 whole
= end
- start
;
14585 start
= end
= whole
= 0;
14587 /* Indicate what this scroll bar ought to be displaying now. */
14588 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14589 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14590 (w
, end
- start
, whole
, start
);
14594 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14595 selected_window is redisplayed.
14597 We can return without actually redisplaying the window if
14598 fonts_changed_p is nonzero. In that case, redisplay_internal will
14602 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14604 struct window
*w
= XWINDOW (window
);
14605 struct frame
*f
= XFRAME (w
->frame
);
14606 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14607 struct buffer
*old
= current_buffer
;
14608 struct text_pos lpoint
, opoint
, startp
;
14609 int update_mode_line
;
14612 /* Record it now because it's overwritten. */
14613 int current_matrix_up_to_date_p
= 0;
14614 int used_current_matrix_p
= 0;
14615 /* This is less strict than current_matrix_up_to_date_p.
14616 It indictes that the buffer contents and narrowing are unchanged. */
14617 int buffer_unchanged_p
= 0;
14618 int temp_scroll_step
= 0;
14619 int count
= SPECPDL_INDEX ();
14621 int centering_position
= -1;
14622 int last_line_misfit
= 0;
14623 EMACS_INT beg_unchanged
, end_unchanged
;
14625 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14628 /* W must be a leaf window here. */
14629 xassert (!NILP (w
->buffer
));
14631 *w
->desired_matrix
->method
= 0;
14635 reconsider_clip_changes (w
, buffer
);
14637 /* Has the mode line to be updated? */
14638 update_mode_line
= (!NILP (w
->update_mode_line
)
14639 || update_mode_lines
14640 || buffer
->clip_changed
14641 || buffer
->prevent_redisplay_optimizations_p
);
14643 if (MINI_WINDOW_P (w
))
14645 if (w
== XWINDOW (echo_area_window
)
14646 && !NILP (echo_area_buffer
[0]))
14648 if (update_mode_line
)
14649 /* We may have to update a tty frame's menu bar or a
14650 tool-bar. Example `M-x C-h C-h C-g'. */
14651 goto finish_menu_bars
;
14653 /* We've already displayed the echo area glyphs in this window. */
14654 goto finish_scroll_bars
;
14656 else if ((w
!= XWINDOW (minibuf_window
)
14657 || minibuf_level
== 0)
14658 /* When buffer is nonempty, redisplay window normally. */
14659 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14660 /* Quail displays non-mini buffers in minibuffer window.
14661 In that case, redisplay the window normally. */
14662 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14664 /* W is a mini-buffer window, but it's not active, so clear
14666 int yb
= window_text_bottom_y (w
);
14667 struct glyph_row
*row
;
14670 for (y
= 0, row
= w
->desired_matrix
->rows
;
14672 y
+= row
->height
, ++row
)
14673 blank_row (w
, row
, y
);
14674 goto finish_scroll_bars
;
14677 clear_glyph_matrix (w
->desired_matrix
);
14680 /* Otherwise set up data on this window; select its buffer and point
14682 /* Really select the buffer, for the sake of buffer-local
14684 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14686 current_matrix_up_to_date_p
14687 = (!NILP (w
->window_end_valid
)
14688 && !current_buffer
->clip_changed
14689 && !current_buffer
->prevent_redisplay_optimizations_p
14690 && XFASTINT (w
->last_modified
) >= MODIFF
14691 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14693 /* Run the window-bottom-change-functions
14694 if it is possible that the text on the screen has changed
14695 (either due to modification of the text, or any other reason). */
14696 if (!current_matrix_up_to_date_p
14697 && !NILP (Vwindow_text_change_functions
))
14699 safe_run_hooks (Qwindow_text_change_functions
);
14703 beg_unchanged
= BEG_UNCHANGED
;
14704 end_unchanged
= END_UNCHANGED
;
14706 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14708 specbind (Qinhibit_point_motion_hooks
, Qt
);
14711 = (!NILP (w
->window_end_valid
)
14712 && !current_buffer
->clip_changed
14713 && XFASTINT (w
->last_modified
) >= MODIFF
14714 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14716 /* When windows_or_buffers_changed is non-zero, we can't rely on
14717 the window end being valid, so set it to nil there. */
14718 if (windows_or_buffers_changed
)
14720 /* If window starts on a continuation line, maybe adjust the
14721 window start in case the window's width changed. */
14722 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14723 compute_window_start_on_continuation_line (w
);
14725 w
->window_end_valid
= Qnil
;
14728 /* Some sanity checks. */
14729 CHECK_WINDOW_END (w
);
14730 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14732 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14735 /* If %c is in mode line, update it if needed. */
14736 if (!NILP (w
->column_number_displayed
)
14737 /* This alternative quickly identifies a common case
14738 where no change is needed. */
14739 && !(PT
== XFASTINT (w
->last_point
)
14740 && XFASTINT (w
->last_modified
) >= MODIFF
14741 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14742 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14743 update_mode_line
= 1;
14745 /* Count number of windows showing the selected buffer. An indirect
14746 buffer counts as its base buffer. */
14747 if (!just_this_one_p
)
14749 struct buffer
*current_base
, *window_base
;
14750 current_base
= current_buffer
;
14751 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14752 if (current_base
->base_buffer
)
14753 current_base
= current_base
->base_buffer
;
14754 if (window_base
->base_buffer
)
14755 window_base
= window_base
->base_buffer
;
14756 if (current_base
== window_base
)
14760 /* Point refers normally to the selected window. For any other
14761 window, set up appropriate value. */
14762 if (!EQ (window
, selected_window
))
14764 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14765 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14769 new_pt_byte
= BEGV_BYTE
;
14770 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14772 else if (new_pt
> (ZV
- 1))
14775 new_pt_byte
= ZV_BYTE
;
14776 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14779 /* We don't use SET_PT so that the point-motion hooks don't run. */
14780 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14783 /* If any of the character widths specified in the display table
14784 have changed, invalidate the width run cache. It's true that
14785 this may be a bit late to catch such changes, but the rest of
14786 redisplay goes (non-fatally) haywire when the display table is
14787 changed, so why should we worry about doing any better? */
14788 if (current_buffer
->width_run_cache
)
14790 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14792 if (! disptab_matches_widthtab (disptab
,
14793 XVECTOR (BVAR (current_buffer
, width_table
))))
14795 invalidate_region_cache (current_buffer
,
14796 current_buffer
->width_run_cache
,
14798 recompute_width_table (current_buffer
, disptab
);
14802 /* If window-start is screwed up, choose a new one. */
14803 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14806 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14808 /* If someone specified a new starting point but did not insist,
14809 check whether it can be used. */
14810 if (!NILP (w
->optional_new_start
)
14811 && CHARPOS (startp
) >= BEGV
14812 && CHARPOS (startp
) <= ZV
)
14814 w
->optional_new_start
= Qnil
;
14815 start_display (&it
, w
, startp
);
14816 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14817 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14818 if (IT_CHARPOS (it
) == PT
)
14819 w
->force_start
= Qt
;
14820 /* IT may overshoot PT if text at PT is invisible. */
14821 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14822 w
->force_start
= Qt
;
14827 /* Handle case where place to start displaying has been specified,
14828 unless the specified location is outside the accessible range. */
14829 if (!NILP (w
->force_start
)
14830 || w
->frozen_window_start_p
)
14832 /* We set this later on if we have to adjust point. */
14835 w
->force_start
= Qnil
;
14837 w
->window_end_valid
= Qnil
;
14839 /* Forget any recorded base line for line number display. */
14840 if (!buffer_unchanged_p
)
14841 w
->base_line_number
= Qnil
;
14843 /* Redisplay the mode line. Select the buffer properly for that.
14844 Also, run the hook window-scroll-functions
14845 because we have scrolled. */
14846 /* Note, we do this after clearing force_start because
14847 if there's an error, it is better to forget about force_start
14848 than to get into an infinite loop calling the hook functions
14849 and having them get more errors. */
14850 if (!update_mode_line
14851 || ! NILP (Vwindow_scroll_functions
))
14853 update_mode_line
= 1;
14854 w
->update_mode_line
= Qt
;
14855 startp
= run_window_scroll_functions (window
, startp
);
14858 w
->last_modified
= make_number (0);
14859 w
->last_overlay_modified
= make_number (0);
14860 if (CHARPOS (startp
) < BEGV
)
14861 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14862 else if (CHARPOS (startp
) > ZV
)
14863 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14865 /* Redisplay, then check if cursor has been set during the
14866 redisplay. Give up if new fonts were loaded. */
14867 /* We used to issue a CHECK_MARGINS argument to try_window here,
14868 but this causes scrolling to fail when point begins inside
14869 the scroll margin (bug#148) -- cyd */
14870 if (!try_window (window
, startp
, 0))
14872 w
->force_start
= Qt
;
14873 clear_glyph_matrix (w
->desired_matrix
);
14874 goto need_larger_matrices
;
14877 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14879 /* If point does not appear, try to move point so it does
14880 appear. The desired matrix has been built above, so we
14881 can use it here. */
14882 new_vpos
= window_box_height (w
) / 2;
14885 if (!cursor_row_fully_visible_p (w
, 0, 0))
14887 /* Point does appear, but on a line partly visible at end of window.
14888 Move it back to a fully-visible line. */
14889 new_vpos
= window_box_height (w
);
14892 /* If we need to move point for either of the above reasons,
14893 now actually do it. */
14896 struct glyph_row
*row
;
14898 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14899 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14902 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14903 MATRIX_ROW_START_BYTEPOS (row
));
14905 if (w
!= XWINDOW (selected_window
))
14906 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14907 else if (current_buffer
== old
)
14908 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14910 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14912 /* If we are highlighting the region, then we just changed
14913 the region, so redisplay to show it. */
14914 if (!NILP (Vtransient_mark_mode
)
14915 && !NILP (BVAR (current_buffer
, mark_active
)))
14917 clear_glyph_matrix (w
->desired_matrix
);
14918 if (!try_window (window
, startp
, 0))
14919 goto need_larger_matrices
;
14924 debug_method_add (w
, "forced window start");
14929 /* Handle case where text has not changed, only point, and it has
14930 not moved off the frame, and we are not retrying after hscroll.
14931 (current_matrix_up_to_date_p is nonzero when retrying.) */
14932 if (current_matrix_up_to_date_p
14933 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14934 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14938 case CURSOR_MOVEMENT_SUCCESS
:
14939 used_current_matrix_p
= 1;
14942 case CURSOR_MOVEMENT_MUST_SCROLL
:
14943 goto try_to_scroll
;
14949 /* If current starting point was originally the beginning of a line
14950 but no longer is, find a new starting point. */
14951 else if (!NILP (w
->start_at_line_beg
)
14952 && !(CHARPOS (startp
) <= BEGV
14953 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14956 debug_method_add (w
, "recenter 1");
14961 /* Try scrolling with try_window_id. Value is > 0 if update has
14962 been done, it is -1 if we know that the same window start will
14963 not work. It is 0 if unsuccessful for some other reason. */
14964 else if ((tem
= try_window_id (w
)) != 0)
14967 debug_method_add (w
, "try_window_id %d", tem
);
14970 if (fonts_changed_p
)
14971 goto need_larger_matrices
;
14975 /* Otherwise try_window_id has returned -1 which means that we
14976 don't want the alternative below this comment to execute. */
14978 else if (CHARPOS (startp
) >= BEGV
14979 && CHARPOS (startp
) <= ZV
14980 && PT
>= CHARPOS (startp
)
14981 && (CHARPOS (startp
) < ZV
14982 /* Avoid starting at end of buffer. */
14983 || CHARPOS (startp
) == BEGV
14984 || (XFASTINT (w
->last_modified
) >= MODIFF
14985 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14988 /* If first window line is a continuation line, and window start
14989 is inside the modified region, but the first change is before
14990 current window start, we must select a new window start.
14992 However, if this is the result of a down-mouse event (e.g. by
14993 extending the mouse-drag-overlay), we don't want to select a
14994 new window start, since that would change the position under
14995 the mouse, resulting in an unwanted mouse-movement rather
14996 than a simple mouse-click. */
14997 if (NILP (w
->start_at_line_beg
)
14998 && NILP (do_mouse_tracking
)
14999 && CHARPOS (startp
) > BEGV
15000 && CHARPOS (startp
) > BEG
+ beg_unchanged
15001 && CHARPOS (startp
) <= Z
- end_unchanged
15002 /* Even if w->start_at_line_beg is nil, a new window may
15003 start at a line_beg, since that's how set_buffer_window
15004 sets it. So, we need to check the return value of
15005 compute_window_start_on_continuation_line. (See also
15007 && XMARKER (w
->start
)->buffer
== current_buffer
15008 && compute_window_start_on_continuation_line (w
))
15010 w
->force_start
= Qt
;
15011 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15016 debug_method_add (w
, "same window start");
15019 /* Try to redisplay starting at same place as before.
15020 If point has not moved off frame, accept the results. */
15021 if (!current_matrix_up_to_date_p
15022 /* Don't use try_window_reusing_current_matrix in this case
15023 because a window scroll function can have changed the
15025 || !NILP (Vwindow_scroll_functions
)
15026 || MINI_WINDOW_P (w
)
15027 || !(used_current_matrix_p
15028 = try_window_reusing_current_matrix (w
)))
15030 IF_DEBUG (debug_method_add (w
, "1"));
15031 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15032 /* -1 means we need to scroll.
15033 0 means we need new matrices, but fonts_changed_p
15034 is set in that case, so we will detect it below. */
15035 goto try_to_scroll
;
15038 if (fonts_changed_p
)
15039 goto need_larger_matrices
;
15041 if (w
->cursor
.vpos
>= 0)
15043 if (!just_this_one_p
15044 || current_buffer
->clip_changed
15045 || BEG_UNCHANGED
< CHARPOS (startp
))
15046 /* Forget any recorded base line for line number display. */
15047 w
->base_line_number
= Qnil
;
15049 if (!cursor_row_fully_visible_p (w
, 1, 0))
15051 clear_glyph_matrix (w
->desired_matrix
);
15052 last_line_misfit
= 1;
15054 /* Drop through and scroll. */
15059 clear_glyph_matrix (w
->desired_matrix
);
15064 w
->last_modified
= make_number (0);
15065 w
->last_overlay_modified
= make_number (0);
15067 /* Redisplay the mode line. Select the buffer properly for that. */
15068 if (!update_mode_line
)
15070 update_mode_line
= 1;
15071 w
->update_mode_line
= Qt
;
15074 /* Try to scroll by specified few lines. */
15075 if ((scroll_conservatively
15076 || emacs_scroll_step
15077 || temp_scroll_step
15078 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15079 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15080 && CHARPOS (startp
) >= BEGV
15081 && CHARPOS (startp
) <= ZV
)
15083 /* The function returns -1 if new fonts were loaded, 1 if
15084 successful, 0 if not successful. */
15085 int ss
= try_scrolling (window
, just_this_one_p
,
15086 scroll_conservatively
,
15088 temp_scroll_step
, last_line_misfit
);
15091 case SCROLLING_SUCCESS
:
15094 case SCROLLING_NEED_LARGER_MATRICES
:
15095 goto need_larger_matrices
;
15097 case SCROLLING_FAILED
:
15105 /* Finally, just choose a place to start which positions point
15106 according to user preferences. */
15111 debug_method_add (w
, "recenter");
15114 /* w->vscroll = 0; */
15116 /* Forget any previously recorded base line for line number display. */
15117 if (!buffer_unchanged_p
)
15118 w
->base_line_number
= Qnil
;
15120 /* Determine the window start relative to point. */
15121 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15122 it
.current_y
= it
.last_visible_y
;
15123 if (centering_position
< 0)
15127 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15129 EMACS_INT margin_pos
= CHARPOS (startp
);
15131 Lisp_Object aggressive
;
15133 /* If there is a scroll margin at the top of the window, find
15134 its character position. */
15136 /* Cannot call start_display if startp is not in the
15137 accessible region of the buffer. This can happen when we
15138 have just switched to a different buffer and/or changed
15139 its restriction. In that case, startp is initialized to
15140 the character position 1 (BEG) because we did not yet
15141 have chance to display the buffer even once. */
15142 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15145 void *it1data
= NULL
;
15147 SAVE_IT (it1
, it
, it1data
);
15148 start_display (&it1
, w
, startp
);
15149 move_it_vertically (&it1
, margin
);
15150 margin_pos
= IT_CHARPOS (it1
);
15151 RESTORE_IT (&it
, &it
, it1data
);
15153 scrolling_up
= PT
> margin_pos
;
15156 ? BVAR (current_buffer
, scroll_up_aggressively
)
15157 : BVAR (current_buffer
, scroll_down_aggressively
);
15159 if (!MINI_WINDOW_P (w
)
15160 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15164 /* Setting scroll-conservatively overrides
15165 scroll-*-aggressively. */
15166 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15168 double float_amount
= XFLOATINT (aggressive
);
15170 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15171 if (pt_offset
== 0 && float_amount
> 0)
15176 /* Compute how much to move the window start backward from
15177 point so that point will be displayed where the user
15181 centering_position
= it
.last_visible_y
;
15183 centering_position
-= pt_offset
;
15184 centering_position
-=
15185 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
15186 /* Don't let point enter the scroll margin near top of
15188 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15189 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15192 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15195 /* Set the window start half the height of the window backward
15197 centering_position
= window_box_height (w
) / 2;
15199 move_it_vertically_backward (&it
, centering_position
);
15201 xassert (IT_CHARPOS (it
) >= BEGV
);
15203 /* The function move_it_vertically_backward may move over more
15204 than the specified y-distance. If it->w is small, e.g. a
15205 mini-buffer window, we may end up in front of the window's
15206 display area. Start displaying at the start of the line
15207 containing PT in this case. */
15208 if (it
.current_y
<= 0)
15210 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15211 move_it_vertically_backward (&it
, 0);
15215 it
.current_x
= it
.hpos
= 0;
15217 /* Set the window start position here explicitly, to avoid an
15218 infinite loop in case the functions in window-scroll-functions
15220 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15222 /* Run scroll hooks. */
15223 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15225 /* Redisplay the window. */
15226 if (!current_matrix_up_to_date_p
15227 || windows_or_buffers_changed
15228 || cursor_type_changed
15229 /* Don't use try_window_reusing_current_matrix in this case
15230 because it can have changed the buffer. */
15231 || !NILP (Vwindow_scroll_functions
)
15232 || !just_this_one_p
15233 || MINI_WINDOW_P (w
)
15234 || !(used_current_matrix_p
15235 = try_window_reusing_current_matrix (w
)))
15236 try_window (window
, startp
, 0);
15238 /* If new fonts have been loaded (due to fontsets), give up. We
15239 have to start a new redisplay since we need to re-adjust glyph
15241 if (fonts_changed_p
)
15242 goto need_larger_matrices
;
15244 /* If cursor did not appear assume that the middle of the window is
15245 in the first line of the window. Do it again with the next line.
15246 (Imagine a window of height 100, displaying two lines of height
15247 60. Moving back 50 from it->last_visible_y will end in the first
15249 if (w
->cursor
.vpos
< 0)
15251 if (!NILP (w
->window_end_valid
)
15252 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15254 clear_glyph_matrix (w
->desired_matrix
);
15255 move_it_by_lines (&it
, 1);
15256 try_window (window
, it
.current
.pos
, 0);
15258 else if (PT
< IT_CHARPOS (it
))
15260 clear_glyph_matrix (w
->desired_matrix
);
15261 move_it_by_lines (&it
, -1);
15262 try_window (window
, it
.current
.pos
, 0);
15266 /* Not much we can do about it. */
15270 /* Consider the following case: Window starts at BEGV, there is
15271 invisible, intangible text at BEGV, so that display starts at
15272 some point START > BEGV. It can happen that we are called with
15273 PT somewhere between BEGV and START. Try to handle that case. */
15274 if (w
->cursor
.vpos
< 0)
15276 struct glyph_row
*row
= w
->current_matrix
->rows
;
15277 if (row
->mode_line_p
)
15279 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15282 if (!cursor_row_fully_visible_p (w
, 0, 0))
15284 /* If vscroll is enabled, disable it and try again. */
15288 clear_glyph_matrix (w
->desired_matrix
);
15292 /* If centering point failed to make the whole line visible,
15293 put point at the top instead. That has to make the whole line
15294 visible, if it can be done. */
15295 if (centering_position
== 0)
15298 clear_glyph_matrix (w
->desired_matrix
);
15299 centering_position
= 0;
15305 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15306 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15307 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15310 /* Display the mode line, if we must. */
15311 if ((update_mode_line
15312 /* If window not full width, must redo its mode line
15313 if (a) the window to its side is being redone and
15314 (b) we do a frame-based redisplay. This is a consequence
15315 of how inverted lines are drawn in frame-based redisplay. */
15316 || (!just_this_one_p
15317 && !FRAME_WINDOW_P (f
)
15318 && !WINDOW_FULL_WIDTH_P (w
))
15319 /* Line number to display. */
15320 || INTEGERP (w
->base_line_pos
)
15321 /* Column number is displayed and different from the one displayed. */
15322 || (!NILP (w
->column_number_displayed
)
15323 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15324 /* This means that the window has a mode line. */
15325 && (WINDOW_WANTS_MODELINE_P (w
)
15326 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15328 display_mode_lines (w
);
15330 /* If mode line height has changed, arrange for a thorough
15331 immediate redisplay using the correct mode line height. */
15332 if (WINDOW_WANTS_MODELINE_P (w
)
15333 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15335 fonts_changed_p
= 1;
15336 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15337 = DESIRED_MODE_LINE_HEIGHT (w
);
15340 /* If header line height has changed, arrange for a thorough
15341 immediate redisplay using the correct header line height. */
15342 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15343 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15345 fonts_changed_p
= 1;
15346 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15347 = DESIRED_HEADER_LINE_HEIGHT (w
);
15350 if (fonts_changed_p
)
15351 goto need_larger_matrices
;
15354 if (!line_number_displayed
15355 && !BUFFERP (w
->base_line_pos
))
15357 w
->base_line_pos
= Qnil
;
15358 w
->base_line_number
= Qnil
;
15363 /* When we reach a frame's selected window, redo the frame's menu bar. */
15364 if (update_mode_line
15365 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15367 int redisplay_menu_p
= 0;
15369 if (FRAME_WINDOW_P (f
))
15371 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15372 || defined (HAVE_NS) || defined (USE_GTK)
15373 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15375 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15379 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15381 if (redisplay_menu_p
)
15382 display_menu_bar (w
);
15384 #ifdef HAVE_WINDOW_SYSTEM
15385 if (FRAME_WINDOW_P (f
))
15387 #if defined (USE_GTK) || defined (HAVE_NS)
15388 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15389 redisplay_tool_bar (f
);
15391 if (WINDOWP (f
->tool_bar_window
)
15392 && (FRAME_TOOL_BAR_LINES (f
) > 0
15393 || !NILP (Vauto_resize_tool_bars
))
15394 && redisplay_tool_bar (f
))
15395 ignore_mouse_drag_p
= 1;
15401 #ifdef HAVE_WINDOW_SYSTEM
15402 if (FRAME_WINDOW_P (f
)
15403 && update_window_fringes (w
, (just_this_one_p
15404 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15405 || w
->pseudo_window_p
)))
15409 if (draw_window_fringes (w
, 1))
15410 x_draw_vertical_border (w
);
15414 #endif /* HAVE_WINDOW_SYSTEM */
15416 /* We go to this label, with fonts_changed_p nonzero,
15417 if it is necessary to try again using larger glyph matrices.
15418 We have to redeem the scroll bar even in this case,
15419 because the loop in redisplay_internal expects that. */
15420 need_larger_matrices
:
15422 finish_scroll_bars
:
15424 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15426 /* Set the thumb's position and size. */
15427 set_vertical_scroll_bar (w
);
15429 /* Note that we actually used the scroll bar attached to this
15430 window, so it shouldn't be deleted at the end of redisplay. */
15431 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15432 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15435 /* Restore current_buffer and value of point in it. The window
15436 update may have changed the buffer, so first make sure `opoint'
15437 is still valid (Bug#6177). */
15438 if (CHARPOS (opoint
) < BEGV
)
15439 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15440 else if (CHARPOS (opoint
) > ZV
)
15441 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15443 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15445 set_buffer_internal_1 (old
);
15446 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15447 shorter. This can be caused by log truncation in *Messages*. */
15448 if (CHARPOS (lpoint
) <= ZV
)
15449 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15451 unbind_to (count
, Qnil
);
15455 /* Build the complete desired matrix of WINDOW with a window start
15456 buffer position POS.
15458 Value is 1 if successful. It is zero if fonts were loaded during
15459 redisplay which makes re-adjusting glyph matrices necessary, and -1
15460 if point would appear in the scroll margins.
15461 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15462 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15466 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15468 struct window
*w
= XWINDOW (window
);
15470 struct glyph_row
*last_text_row
= NULL
;
15471 struct frame
*f
= XFRAME (w
->frame
);
15473 /* Make POS the new window start. */
15474 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15476 /* Mark cursor position as unknown. No overlay arrow seen. */
15477 w
->cursor
.vpos
= -1;
15478 overlay_arrow_seen
= 0;
15480 /* Initialize iterator and info to start at POS. */
15481 start_display (&it
, w
, pos
);
15483 /* Display all lines of W. */
15484 while (it
.current_y
< it
.last_visible_y
)
15486 if (display_line (&it
))
15487 last_text_row
= it
.glyph_row
- 1;
15488 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15492 /* Don't let the cursor end in the scroll margins. */
15493 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15494 && !MINI_WINDOW_P (w
))
15496 int this_scroll_margin
;
15498 if (scroll_margin
> 0)
15500 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15501 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15504 this_scroll_margin
= 0;
15506 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15507 && w
->cursor
.y
< this_scroll_margin
15508 && CHARPOS (pos
) > BEGV
15509 && IT_CHARPOS (it
) < ZV
)
15510 /* rms: considering make_cursor_line_fully_visible_p here
15511 seems to give wrong results. We don't want to recenter
15512 when the last line is partly visible, we want to allow
15513 that case to be handled in the usual way. */
15514 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15516 w
->cursor
.vpos
= -1;
15517 clear_glyph_matrix (w
->desired_matrix
);
15522 /* If bottom moved off end of frame, change mode line percentage. */
15523 if (XFASTINT (w
->window_end_pos
) <= 0
15524 && Z
!= IT_CHARPOS (it
))
15525 w
->update_mode_line
= Qt
;
15527 /* Set window_end_pos to the offset of the last character displayed
15528 on the window from the end of current_buffer. Set
15529 window_end_vpos to its row number. */
15532 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15533 w
->window_end_bytepos
15534 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15536 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15538 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15539 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15540 ->displays_text_p
);
15544 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15545 w
->window_end_pos
= make_number (Z
- ZV
);
15546 w
->window_end_vpos
= make_number (0);
15549 /* But that is not valid info until redisplay finishes. */
15550 w
->window_end_valid
= Qnil
;
15556 /************************************************************************
15557 Window redisplay reusing current matrix when buffer has not changed
15558 ************************************************************************/
15560 /* Try redisplay of window W showing an unchanged buffer with a
15561 different window start than the last time it was displayed by
15562 reusing its current matrix. Value is non-zero if successful.
15563 W->start is the new window start. */
15566 try_window_reusing_current_matrix (struct window
*w
)
15568 struct frame
*f
= XFRAME (w
->frame
);
15569 struct glyph_row
*bottom_row
;
15572 struct text_pos start
, new_start
;
15573 int nrows_scrolled
, i
;
15574 struct glyph_row
*last_text_row
;
15575 struct glyph_row
*last_reused_text_row
;
15576 struct glyph_row
*start_row
;
15577 int start_vpos
, min_y
, max_y
;
15580 if (inhibit_try_window_reusing
)
15584 if (/* This function doesn't handle terminal frames. */
15585 !FRAME_WINDOW_P (f
)
15586 /* Don't try to reuse the display if windows have been split
15588 || windows_or_buffers_changed
15589 || cursor_type_changed
)
15592 /* Can't do this if region may have changed. */
15593 if ((!NILP (Vtransient_mark_mode
)
15594 && !NILP (BVAR (current_buffer
, mark_active
)))
15595 || !NILP (w
->region_showing
)
15596 || !NILP (Vshow_trailing_whitespace
))
15599 /* If top-line visibility has changed, give up. */
15600 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15601 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15604 /* Give up if old or new display is scrolled vertically. We could
15605 make this function handle this, but right now it doesn't. */
15606 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15607 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15610 /* The variable new_start now holds the new window start. The old
15611 start `start' can be determined from the current matrix. */
15612 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15613 start
= start_row
->minpos
;
15614 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15616 /* Clear the desired matrix for the display below. */
15617 clear_glyph_matrix (w
->desired_matrix
);
15619 if (CHARPOS (new_start
) <= CHARPOS (start
))
15621 /* Don't use this method if the display starts with an ellipsis
15622 displayed for invisible text. It's not easy to handle that case
15623 below, and it's certainly not worth the effort since this is
15624 not a frequent case. */
15625 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15628 IF_DEBUG (debug_method_add (w
, "twu1"));
15630 /* Display up to a row that can be reused. The variable
15631 last_text_row is set to the last row displayed that displays
15632 text. Note that it.vpos == 0 if or if not there is a
15633 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15634 start_display (&it
, w
, new_start
);
15635 w
->cursor
.vpos
= -1;
15636 last_text_row
= last_reused_text_row
= NULL
;
15638 while (it
.current_y
< it
.last_visible_y
15639 && !fonts_changed_p
)
15641 /* If we have reached into the characters in the START row,
15642 that means the line boundaries have changed. So we
15643 can't start copying with the row START. Maybe it will
15644 work to start copying with the following row. */
15645 while (IT_CHARPOS (it
) > CHARPOS (start
))
15647 /* Advance to the next row as the "start". */
15649 start
= start_row
->minpos
;
15650 /* If there are no more rows to try, or just one, give up. */
15651 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15652 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15653 || CHARPOS (start
) == ZV
)
15655 clear_glyph_matrix (w
->desired_matrix
);
15659 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15661 /* If we have reached alignment,
15662 we can copy the rest of the rows. */
15663 if (IT_CHARPOS (it
) == CHARPOS (start
))
15666 if (display_line (&it
))
15667 last_text_row
= it
.glyph_row
- 1;
15670 /* A value of current_y < last_visible_y means that we stopped
15671 at the previous window start, which in turn means that we
15672 have at least one reusable row. */
15673 if (it
.current_y
< it
.last_visible_y
)
15675 struct glyph_row
*row
;
15677 /* IT.vpos always starts from 0; it counts text lines. */
15678 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15680 /* Find PT if not already found in the lines displayed. */
15681 if (w
->cursor
.vpos
< 0)
15683 int dy
= it
.current_y
- start_row
->y
;
15685 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15686 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15688 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15689 dy
, nrows_scrolled
);
15692 clear_glyph_matrix (w
->desired_matrix
);
15697 /* Scroll the display. Do it before the current matrix is
15698 changed. The problem here is that update has not yet
15699 run, i.e. part of the current matrix is not up to date.
15700 scroll_run_hook will clear the cursor, and use the
15701 current matrix to get the height of the row the cursor is
15703 run
.current_y
= start_row
->y
;
15704 run
.desired_y
= it
.current_y
;
15705 run
.height
= it
.last_visible_y
- it
.current_y
;
15707 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15710 FRAME_RIF (f
)->update_window_begin_hook (w
);
15711 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15712 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15713 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15717 /* Shift current matrix down by nrows_scrolled lines. */
15718 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15719 rotate_matrix (w
->current_matrix
,
15721 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15724 /* Disable lines that must be updated. */
15725 for (i
= 0; i
< nrows_scrolled
; ++i
)
15726 (start_row
+ i
)->enabled_p
= 0;
15728 /* Re-compute Y positions. */
15729 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15730 max_y
= it
.last_visible_y
;
15731 for (row
= start_row
+ nrows_scrolled
;
15735 row
->y
= it
.current_y
;
15736 row
->visible_height
= row
->height
;
15738 if (row
->y
< min_y
)
15739 row
->visible_height
-= min_y
- row
->y
;
15740 if (row
->y
+ row
->height
> max_y
)
15741 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15742 if (row
->fringe_bitmap_periodic_p
)
15743 row
->redraw_fringe_bitmaps_p
= 1;
15745 it
.current_y
+= row
->height
;
15747 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15748 last_reused_text_row
= row
;
15749 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15753 /* Disable lines in the current matrix which are now
15754 below the window. */
15755 for (++row
; row
< bottom_row
; ++row
)
15756 row
->enabled_p
= row
->mode_line_p
= 0;
15759 /* Update window_end_pos etc.; last_reused_text_row is the last
15760 reused row from the current matrix containing text, if any.
15761 The value of last_text_row is the last displayed line
15762 containing text. */
15763 if (last_reused_text_row
)
15765 w
->window_end_bytepos
15766 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15768 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15770 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15771 w
->current_matrix
));
15773 else if (last_text_row
)
15775 w
->window_end_bytepos
15776 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15778 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15780 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15784 /* This window must be completely empty. */
15785 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15786 w
->window_end_pos
= make_number (Z
- ZV
);
15787 w
->window_end_vpos
= make_number (0);
15789 w
->window_end_valid
= Qnil
;
15791 /* Update hint: don't try scrolling again in update_window. */
15792 w
->desired_matrix
->no_scrolling_p
= 1;
15795 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15799 else if (CHARPOS (new_start
) > CHARPOS (start
))
15801 struct glyph_row
*pt_row
, *row
;
15802 struct glyph_row
*first_reusable_row
;
15803 struct glyph_row
*first_row_to_display
;
15805 int yb
= window_text_bottom_y (w
);
15807 /* Find the row starting at new_start, if there is one. Don't
15808 reuse a partially visible line at the end. */
15809 first_reusable_row
= start_row
;
15810 while (first_reusable_row
->enabled_p
15811 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15812 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15813 < CHARPOS (new_start
)))
15814 ++first_reusable_row
;
15816 /* Give up if there is no row to reuse. */
15817 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15818 || !first_reusable_row
->enabled_p
15819 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15820 != CHARPOS (new_start
)))
15823 /* We can reuse fully visible rows beginning with
15824 first_reusable_row to the end of the window. Set
15825 first_row_to_display to the first row that cannot be reused.
15826 Set pt_row to the row containing point, if there is any. */
15828 for (first_row_to_display
= first_reusable_row
;
15829 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15830 ++first_row_to_display
)
15832 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15833 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15834 pt_row
= first_row_to_display
;
15837 /* Start displaying at the start of first_row_to_display. */
15838 xassert (first_row_to_display
->y
< yb
);
15839 init_to_row_start (&it
, w
, first_row_to_display
);
15841 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15843 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15845 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15846 + WINDOW_HEADER_LINE_HEIGHT (w
));
15848 /* Display lines beginning with first_row_to_display in the
15849 desired matrix. Set last_text_row to the last row displayed
15850 that displays text. */
15851 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15852 if (pt_row
== NULL
)
15853 w
->cursor
.vpos
= -1;
15854 last_text_row
= NULL
;
15855 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15856 if (display_line (&it
))
15857 last_text_row
= it
.glyph_row
- 1;
15859 /* If point is in a reused row, adjust y and vpos of the cursor
15863 w
->cursor
.vpos
-= nrows_scrolled
;
15864 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15867 /* Give up if point isn't in a row displayed or reused. (This
15868 also handles the case where w->cursor.vpos < nrows_scrolled
15869 after the calls to display_line, which can happen with scroll
15870 margins. See bug#1295.) */
15871 if (w
->cursor
.vpos
< 0)
15873 clear_glyph_matrix (w
->desired_matrix
);
15877 /* Scroll the display. */
15878 run
.current_y
= first_reusable_row
->y
;
15879 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15880 run
.height
= it
.last_visible_y
- run
.current_y
;
15881 dy
= run
.current_y
- run
.desired_y
;
15886 FRAME_RIF (f
)->update_window_begin_hook (w
);
15887 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15888 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15889 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15893 /* Adjust Y positions of reused rows. */
15894 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15895 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15896 max_y
= it
.last_visible_y
;
15897 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15900 row
->visible_height
= row
->height
;
15901 if (row
->y
< min_y
)
15902 row
->visible_height
-= min_y
- row
->y
;
15903 if (row
->y
+ row
->height
> max_y
)
15904 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15905 if (row
->fringe_bitmap_periodic_p
)
15906 row
->redraw_fringe_bitmaps_p
= 1;
15909 /* Scroll the current matrix. */
15910 xassert (nrows_scrolled
> 0);
15911 rotate_matrix (w
->current_matrix
,
15913 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15916 /* Disable rows not reused. */
15917 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15918 row
->enabled_p
= 0;
15920 /* Point may have moved to a different line, so we cannot assume that
15921 the previous cursor position is valid; locate the correct row. */
15924 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15925 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15929 w
->cursor
.y
= row
->y
;
15931 if (row
< bottom_row
)
15933 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15934 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15936 /* Can't use this optimization with bidi-reordered glyph
15937 rows, unless cursor is already at point. */
15938 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15940 if (!(w
->cursor
.hpos
>= 0
15941 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15942 && BUFFERP (glyph
->object
)
15943 && glyph
->charpos
== PT
))
15948 && (!BUFFERP (glyph
->object
)
15949 || glyph
->charpos
< PT
);
15953 w
->cursor
.x
+= glyph
->pixel_width
;
15958 /* Adjust window end. A null value of last_text_row means that
15959 the window end is in reused rows which in turn means that
15960 only its vpos can have changed. */
15963 w
->window_end_bytepos
15964 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15966 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15968 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15973 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15976 w
->window_end_valid
= Qnil
;
15977 w
->desired_matrix
->no_scrolling_p
= 1;
15980 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15990 /************************************************************************
15991 Window redisplay reusing current matrix when buffer has changed
15992 ************************************************************************/
15994 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15995 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15996 EMACS_INT
*, EMACS_INT
*);
15997 static struct glyph_row
*
15998 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15999 struct glyph_row
*);
16002 /* Return the last row in MATRIX displaying text. If row START is
16003 non-null, start searching with that row. IT gives the dimensions
16004 of the display. Value is null if matrix is empty; otherwise it is
16005 a pointer to the row found. */
16007 static struct glyph_row
*
16008 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16009 struct glyph_row
*start
)
16011 struct glyph_row
*row
, *row_found
;
16013 /* Set row_found to the last row in IT->w's current matrix
16014 displaying text. The loop looks funny but think of partially
16017 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16018 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16020 xassert (row
->enabled_p
);
16022 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16031 /* Return the last row in the current matrix of W that is not affected
16032 by changes at the start of current_buffer that occurred since W's
16033 current matrix was built. Value is null if no such row exists.
16035 BEG_UNCHANGED us the number of characters unchanged at the start of
16036 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16037 first changed character in current_buffer. Characters at positions <
16038 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16039 when the current matrix was built. */
16041 static struct glyph_row
*
16042 find_last_unchanged_at_beg_row (struct window
*w
)
16044 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16045 struct glyph_row
*row
;
16046 struct glyph_row
*row_found
= NULL
;
16047 int yb
= window_text_bottom_y (w
);
16049 /* Find the last row displaying unchanged text. */
16050 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16051 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16052 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16055 if (/* If row ends before first_changed_pos, it is unchanged,
16056 except in some case. */
16057 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16058 /* When row ends in ZV and we write at ZV it is not
16060 && !row
->ends_at_zv_p
16061 /* When first_changed_pos is the end of a continued line,
16062 row is not unchanged because it may be no longer
16064 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16065 && (row
->continued_p
16066 || row
->exact_window_width_line_p
)))
16069 /* Stop if last visible row. */
16070 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16078 /* Find the first glyph row in the current matrix of W that is not
16079 affected by changes at the end of current_buffer since the
16080 time W's current matrix was built.
16082 Return in *DELTA the number of chars by which buffer positions in
16083 unchanged text at the end of current_buffer must be adjusted.
16085 Return in *DELTA_BYTES the corresponding number of bytes.
16087 Value is null if no such row exists, i.e. all rows are affected by
16090 static struct glyph_row
*
16091 find_first_unchanged_at_end_row (struct window
*w
,
16092 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16094 struct glyph_row
*row
;
16095 struct glyph_row
*row_found
= NULL
;
16097 *delta
= *delta_bytes
= 0;
16099 /* Display must not have been paused, otherwise the current matrix
16100 is not up to date. */
16101 eassert (!NILP (w
->window_end_valid
));
16103 /* A value of window_end_pos >= END_UNCHANGED means that the window
16104 end is in the range of changed text. If so, there is no
16105 unchanged row at the end of W's current matrix. */
16106 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16109 /* Set row to the last row in W's current matrix displaying text. */
16110 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16112 /* If matrix is entirely empty, no unchanged row exists. */
16113 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16115 /* The value of row is the last glyph row in the matrix having a
16116 meaningful buffer position in it. The end position of row
16117 corresponds to window_end_pos. This allows us to translate
16118 buffer positions in the current matrix to current buffer
16119 positions for characters not in changed text. */
16121 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16122 EMACS_INT Z_BYTE_old
=
16123 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16124 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16125 struct glyph_row
*first_text_row
16126 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16128 *delta
= Z
- Z_old
;
16129 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16131 /* Set last_unchanged_pos to the buffer position of the last
16132 character in the buffer that has not been changed. Z is the
16133 index + 1 of the last character in current_buffer, i.e. by
16134 subtracting END_UNCHANGED we get the index of the last
16135 unchanged character, and we have to add BEG to get its buffer
16137 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16138 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16140 /* Search backward from ROW for a row displaying a line that
16141 starts at a minimum position >= last_unchanged_pos_old. */
16142 for (; row
> first_text_row
; --row
)
16144 /* This used to abort, but it can happen.
16145 It is ok to just stop the search instead here. KFS. */
16146 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16149 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16154 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16160 /* Make sure that glyph rows in the current matrix of window W
16161 reference the same glyph memory as corresponding rows in the
16162 frame's frame matrix. This function is called after scrolling W's
16163 current matrix on a terminal frame in try_window_id and
16164 try_window_reusing_current_matrix. */
16167 sync_frame_with_window_matrix_rows (struct window
*w
)
16169 struct frame
*f
= XFRAME (w
->frame
);
16170 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16172 /* Preconditions: W must be a leaf window and full-width. Its frame
16173 must have a frame matrix. */
16174 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16175 xassert (WINDOW_FULL_WIDTH_P (w
));
16176 xassert (!FRAME_WINDOW_P (f
));
16178 /* If W is a full-width window, glyph pointers in W's current matrix
16179 have, by definition, to be the same as glyph pointers in the
16180 corresponding frame matrix. Note that frame matrices have no
16181 marginal areas (see build_frame_matrix). */
16182 window_row
= w
->current_matrix
->rows
;
16183 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16184 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16185 while (window_row
< window_row_end
)
16187 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16188 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16190 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16191 frame_row
->glyphs
[TEXT_AREA
] = start
;
16192 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16193 frame_row
->glyphs
[LAST_AREA
] = end
;
16195 /* Disable frame rows whose corresponding window rows have
16196 been disabled in try_window_id. */
16197 if (!window_row
->enabled_p
)
16198 frame_row
->enabled_p
= 0;
16200 ++window_row
, ++frame_row
;
16205 /* Find the glyph row in window W containing CHARPOS. Consider all
16206 rows between START and END (not inclusive). END null means search
16207 all rows to the end of the display area of W. Value is the row
16208 containing CHARPOS or null. */
16211 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16212 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16214 struct glyph_row
*row
= start
;
16215 struct glyph_row
*best_row
= NULL
;
16216 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16219 /* If we happen to start on a header-line, skip that. */
16220 if (row
->mode_line_p
)
16223 if ((end
&& row
>= end
) || !row
->enabled_p
)
16226 last_y
= window_text_bottom_y (w
) - dy
;
16230 /* Give up if we have gone too far. */
16231 if (end
&& row
>= end
)
16233 /* This formerly returned if they were equal.
16234 I think that both quantities are of a "last plus one" type;
16235 if so, when they are equal, the row is within the screen. -- rms. */
16236 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16239 /* If it is in this row, return this row. */
16240 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16241 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16242 /* The end position of a row equals the start
16243 position of the next row. If CHARPOS is there, we
16244 would rather display it in the next line, except
16245 when this line ends in ZV. */
16246 && !row
->ends_at_zv_p
16247 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16248 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16252 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16253 || (!best_row
&& !row
->continued_p
))
16255 /* In bidi-reordered rows, there could be several rows
16256 occluding point, all of them belonging to the same
16257 continued line. We need to find the row which fits
16258 CHARPOS the best. */
16259 for (g
= row
->glyphs
[TEXT_AREA
];
16260 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16263 if (!STRINGP (g
->object
))
16265 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16267 mindif
= eabs (g
->charpos
- charpos
);
16269 /* Exact match always wins. */
16276 else if (best_row
&& !row
->continued_p
)
16283 /* Try to redisplay window W by reusing its existing display. W's
16284 current matrix must be up to date when this function is called,
16285 i.e. window_end_valid must not be nil.
16289 1 if display has been updated
16290 0 if otherwise unsuccessful
16291 -1 if redisplay with same window start is known not to succeed
16293 The following steps are performed:
16295 1. Find the last row in the current matrix of W that is not
16296 affected by changes at the start of current_buffer. If no such row
16299 2. Find the first row in W's current matrix that is not affected by
16300 changes at the end of current_buffer. Maybe there is no such row.
16302 3. Display lines beginning with the row + 1 found in step 1 to the
16303 row found in step 2 or, if step 2 didn't find a row, to the end of
16306 4. If cursor is not known to appear on the window, give up.
16308 5. If display stopped at the row found in step 2, scroll the
16309 display and current matrix as needed.
16311 6. Maybe display some lines at the end of W, if we must. This can
16312 happen under various circumstances, like a partially visible line
16313 becoming fully visible, or because newly displayed lines are displayed
16314 in smaller font sizes.
16316 7. Update W's window end information. */
16319 try_window_id (struct window
*w
)
16321 struct frame
*f
= XFRAME (w
->frame
);
16322 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16323 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16324 struct glyph_row
*last_unchanged_at_beg_row
;
16325 struct glyph_row
*first_unchanged_at_end_row
;
16326 struct glyph_row
*row
;
16327 struct glyph_row
*bottom_row
;
16330 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16332 struct text_pos start_pos
;
16334 int first_unchanged_at_end_vpos
= 0;
16335 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16336 struct text_pos start
;
16337 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16340 if (inhibit_try_window_id
)
16344 /* This is handy for debugging. */
16346 #define GIVE_UP(X) \
16348 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16352 #define GIVE_UP(X) return 0
16355 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16357 /* Don't use this for mini-windows because these can show
16358 messages and mini-buffers, and we don't handle that here. */
16359 if (MINI_WINDOW_P (w
))
16362 /* This flag is used to prevent redisplay optimizations. */
16363 if (windows_or_buffers_changed
|| cursor_type_changed
)
16366 /* Verify that narrowing has not changed.
16367 Also verify that we were not told to prevent redisplay optimizations.
16368 It would be nice to further
16369 reduce the number of cases where this prevents try_window_id. */
16370 if (current_buffer
->clip_changed
16371 || current_buffer
->prevent_redisplay_optimizations_p
)
16374 /* Window must either use window-based redisplay or be full width. */
16375 if (!FRAME_WINDOW_P (f
)
16376 && (!FRAME_LINE_INS_DEL_OK (f
)
16377 || !WINDOW_FULL_WIDTH_P (w
)))
16380 /* Give up if point is known NOT to appear in W. */
16381 if (PT
< CHARPOS (start
))
16384 /* Another way to prevent redisplay optimizations. */
16385 if (XFASTINT (w
->last_modified
) == 0)
16388 /* Verify that window is not hscrolled. */
16389 if (XFASTINT (w
->hscroll
) != 0)
16392 /* Verify that display wasn't paused. */
16393 if (NILP (w
->window_end_valid
))
16396 /* Can't use this if highlighting a region because a cursor movement
16397 will do more than just set the cursor. */
16398 if (!NILP (Vtransient_mark_mode
)
16399 && !NILP (BVAR (current_buffer
, mark_active
)))
16402 /* Likewise if highlighting trailing whitespace. */
16403 if (!NILP (Vshow_trailing_whitespace
))
16406 /* Likewise if showing a region. */
16407 if (!NILP (w
->region_showing
))
16410 /* Can't use this if overlay arrow position and/or string have
16412 if (overlay_arrows_changed_p ())
16415 /* When word-wrap is on, adding a space to the first word of a
16416 wrapped line can change the wrap position, altering the line
16417 above it. It might be worthwhile to handle this more
16418 intelligently, but for now just redisplay from scratch. */
16419 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16422 /* Under bidi reordering, adding or deleting a character in the
16423 beginning of a paragraph, before the first strong directional
16424 character, can change the base direction of the paragraph (unless
16425 the buffer specifies a fixed paragraph direction), which will
16426 require to redisplay the whole paragraph. It might be worthwhile
16427 to find the paragraph limits and widen the range of redisplayed
16428 lines to that, but for now just give up this optimization and
16429 redisplay from scratch. */
16430 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16431 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16434 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16435 only if buffer has really changed. The reason is that the gap is
16436 initially at Z for freshly visited files. The code below would
16437 set end_unchanged to 0 in that case. */
16438 if (MODIFF
> SAVE_MODIFF
16439 /* This seems to happen sometimes after saving a buffer. */
16440 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16442 if (GPT
- BEG
< BEG_UNCHANGED
)
16443 BEG_UNCHANGED
= GPT
- BEG
;
16444 if (Z
- GPT
< END_UNCHANGED
)
16445 END_UNCHANGED
= Z
- GPT
;
16448 /* The position of the first and last character that has been changed. */
16449 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16450 last_changed_charpos
= Z
- END_UNCHANGED
;
16452 /* If window starts after a line end, and the last change is in
16453 front of that newline, then changes don't affect the display.
16454 This case happens with stealth-fontification. Note that although
16455 the display is unchanged, glyph positions in the matrix have to
16456 be adjusted, of course. */
16457 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16458 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16459 && ((last_changed_charpos
< CHARPOS (start
)
16460 && CHARPOS (start
) == BEGV
)
16461 || (last_changed_charpos
< CHARPOS (start
) - 1
16462 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16464 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16465 struct glyph_row
*r0
;
16467 /* Compute how many chars/bytes have been added to or removed
16468 from the buffer. */
16469 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16470 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16471 Z_delta
= Z
- Z_old
;
16472 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16474 /* Give up if PT is not in the window. Note that it already has
16475 been checked at the start of try_window_id that PT is not in
16476 front of the window start. */
16477 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16480 /* If window start is unchanged, we can reuse the whole matrix
16481 as is, after adjusting glyph positions. No need to compute
16482 the window end again, since its offset from Z hasn't changed. */
16483 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16484 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16485 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16486 /* PT must not be in a partially visible line. */
16487 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16488 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16490 /* Adjust positions in the glyph matrix. */
16491 if (Z_delta
|| Z_delta_bytes
)
16493 struct glyph_row
*r1
16494 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16495 increment_matrix_positions (w
->current_matrix
,
16496 MATRIX_ROW_VPOS (r0
, current_matrix
),
16497 MATRIX_ROW_VPOS (r1
, current_matrix
),
16498 Z_delta
, Z_delta_bytes
);
16501 /* Set the cursor. */
16502 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16504 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16511 /* Handle the case that changes are all below what is displayed in
16512 the window, and that PT is in the window. This shortcut cannot
16513 be taken if ZV is visible in the window, and text has been added
16514 there that is visible in the window. */
16515 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16516 /* ZV is not visible in the window, or there are no
16517 changes at ZV, actually. */
16518 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16519 || first_changed_charpos
== last_changed_charpos
))
16521 struct glyph_row
*r0
;
16523 /* Give up if PT is not in the window. Note that it already has
16524 been checked at the start of try_window_id that PT is not in
16525 front of the window start. */
16526 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16529 /* If window start is unchanged, we can reuse the whole matrix
16530 as is, without changing glyph positions since no text has
16531 been added/removed in front of the window end. */
16532 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16533 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16534 /* PT must not be in a partially visible line. */
16535 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16536 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16538 /* We have to compute the window end anew since text
16539 could have been added/removed after it. */
16541 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16542 w
->window_end_bytepos
16543 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16545 /* Set the cursor. */
16546 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16548 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16555 /* Give up if window start is in the changed area.
16557 The condition used to read
16559 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16561 but why that was tested escapes me at the moment. */
16562 if (CHARPOS (start
) >= first_changed_charpos
16563 && CHARPOS (start
) <= last_changed_charpos
)
16566 /* Check that window start agrees with the start of the first glyph
16567 row in its current matrix. Check this after we know the window
16568 start is not in changed text, otherwise positions would not be
16570 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16571 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16574 /* Give up if the window ends in strings. Overlay strings
16575 at the end are difficult to handle, so don't try. */
16576 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16577 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16580 /* Compute the position at which we have to start displaying new
16581 lines. Some of the lines at the top of the window might be
16582 reusable because they are not displaying changed text. Find the
16583 last row in W's current matrix not affected by changes at the
16584 start of current_buffer. Value is null if changes start in the
16585 first line of window. */
16586 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16587 if (last_unchanged_at_beg_row
)
16589 /* Avoid starting to display in the moddle of a character, a TAB
16590 for instance. This is easier than to set up the iterator
16591 exactly, and it's not a frequent case, so the additional
16592 effort wouldn't really pay off. */
16593 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16594 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16595 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16596 --last_unchanged_at_beg_row
;
16598 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16601 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16603 start_pos
= it
.current
.pos
;
16605 /* Start displaying new lines in the desired matrix at the same
16606 vpos we would use in the current matrix, i.e. below
16607 last_unchanged_at_beg_row. */
16608 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16610 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16611 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16613 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16617 /* There are no reusable lines at the start of the window.
16618 Start displaying in the first text line. */
16619 start_display (&it
, w
, start
);
16620 it
.vpos
= it
.first_vpos
;
16621 start_pos
= it
.current
.pos
;
16624 /* Find the first row that is not affected by changes at the end of
16625 the buffer. Value will be null if there is no unchanged row, in
16626 which case we must redisplay to the end of the window. delta
16627 will be set to the value by which buffer positions beginning with
16628 first_unchanged_at_end_row have to be adjusted due to text
16630 first_unchanged_at_end_row
16631 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16632 IF_DEBUG (debug_delta
= delta
);
16633 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16635 /* Set stop_pos to the buffer position up to which we will have to
16636 display new lines. If first_unchanged_at_end_row != NULL, this
16637 is the buffer position of the start of the line displayed in that
16638 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16639 that we don't stop at a buffer position. */
16641 if (first_unchanged_at_end_row
)
16643 xassert (last_unchanged_at_beg_row
== NULL
16644 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16646 /* If this is a continuation line, move forward to the next one
16647 that isn't. Changes in lines above affect this line.
16648 Caution: this may move first_unchanged_at_end_row to a row
16649 not displaying text. */
16650 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16651 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16652 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16653 < it
.last_visible_y
))
16654 ++first_unchanged_at_end_row
;
16656 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16657 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16658 >= it
.last_visible_y
))
16659 first_unchanged_at_end_row
= NULL
;
16662 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16664 first_unchanged_at_end_vpos
16665 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16666 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16669 else if (last_unchanged_at_beg_row
== NULL
)
16675 /* Either there is no unchanged row at the end, or the one we have
16676 now displays text. This is a necessary condition for the window
16677 end pos calculation at the end of this function. */
16678 xassert (first_unchanged_at_end_row
== NULL
16679 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16681 debug_last_unchanged_at_beg_vpos
16682 = (last_unchanged_at_beg_row
16683 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16685 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16687 #endif /* GLYPH_DEBUG != 0 */
16690 /* Display new lines. Set last_text_row to the last new line
16691 displayed which has text on it, i.e. might end up as being the
16692 line where the window_end_vpos is. */
16693 w
->cursor
.vpos
= -1;
16694 last_text_row
= NULL
;
16695 overlay_arrow_seen
= 0;
16696 while (it
.current_y
< it
.last_visible_y
16697 && !fonts_changed_p
16698 && (first_unchanged_at_end_row
== NULL
16699 || IT_CHARPOS (it
) < stop_pos
))
16701 if (display_line (&it
))
16702 last_text_row
= it
.glyph_row
- 1;
16705 if (fonts_changed_p
)
16709 /* Compute differences in buffer positions, y-positions etc. for
16710 lines reused at the bottom of the window. Compute what we can
16712 if (first_unchanged_at_end_row
16713 /* No lines reused because we displayed everything up to the
16714 bottom of the window. */
16715 && it
.current_y
< it
.last_visible_y
)
16718 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16720 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16721 run
.current_y
= first_unchanged_at_end_row
->y
;
16722 run
.desired_y
= run
.current_y
+ dy
;
16723 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16727 delta
= delta_bytes
= dvpos
= dy
16728 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16729 first_unchanged_at_end_row
= NULL
;
16731 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16734 /* Find the cursor if not already found. We have to decide whether
16735 PT will appear on this window (it sometimes doesn't, but this is
16736 not a very frequent case.) This decision has to be made before
16737 the current matrix is altered. A value of cursor.vpos < 0 means
16738 that PT is either in one of the lines beginning at
16739 first_unchanged_at_end_row or below the window. Don't care for
16740 lines that might be displayed later at the window end; as
16741 mentioned, this is not a frequent case. */
16742 if (w
->cursor
.vpos
< 0)
16744 /* Cursor in unchanged rows at the top? */
16745 if (PT
< CHARPOS (start_pos
)
16746 && last_unchanged_at_beg_row
)
16748 row
= row_containing_pos (w
, PT
,
16749 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16750 last_unchanged_at_beg_row
+ 1, 0);
16752 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16755 /* Start from first_unchanged_at_end_row looking for PT. */
16756 else if (first_unchanged_at_end_row
)
16758 row
= row_containing_pos (w
, PT
- delta
,
16759 first_unchanged_at_end_row
, NULL
, 0);
16761 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16762 delta_bytes
, dy
, dvpos
);
16765 /* Give up if cursor was not found. */
16766 if (w
->cursor
.vpos
< 0)
16768 clear_glyph_matrix (w
->desired_matrix
);
16773 /* Don't let the cursor end in the scroll margins. */
16775 int this_scroll_margin
, cursor_height
;
16777 this_scroll_margin
= max (0, scroll_margin
);
16778 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16779 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16780 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16782 if ((w
->cursor
.y
< this_scroll_margin
16783 && CHARPOS (start
) > BEGV
)
16784 /* Old redisplay didn't take scroll margin into account at the bottom,
16785 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16786 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16787 ? cursor_height
+ this_scroll_margin
16788 : 1)) > it
.last_visible_y
)
16790 w
->cursor
.vpos
= -1;
16791 clear_glyph_matrix (w
->desired_matrix
);
16796 /* Scroll the display. Do it before changing the current matrix so
16797 that xterm.c doesn't get confused about where the cursor glyph is
16799 if (dy
&& run
.height
)
16803 if (FRAME_WINDOW_P (f
))
16805 FRAME_RIF (f
)->update_window_begin_hook (w
);
16806 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16807 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16808 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16812 /* Terminal frame. In this case, dvpos gives the number of
16813 lines to scroll by; dvpos < 0 means scroll up. */
16815 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16816 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16817 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16818 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16819 + window_internal_height (w
));
16821 #if defined (HAVE_GPM) || defined (MSDOS)
16822 x_clear_window_mouse_face (w
);
16824 /* Perform the operation on the screen. */
16827 /* Scroll last_unchanged_at_beg_row to the end of the
16828 window down dvpos lines. */
16829 set_terminal_window (f
, end
);
16831 /* On dumb terminals delete dvpos lines at the end
16832 before inserting dvpos empty lines. */
16833 if (!FRAME_SCROLL_REGION_OK (f
))
16834 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16836 /* Insert dvpos empty lines in front of
16837 last_unchanged_at_beg_row. */
16838 ins_del_lines (f
, from
, dvpos
);
16840 else if (dvpos
< 0)
16842 /* Scroll up last_unchanged_at_beg_vpos to the end of
16843 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16844 set_terminal_window (f
, end
);
16846 /* Delete dvpos lines in front of
16847 last_unchanged_at_beg_vpos. ins_del_lines will set
16848 the cursor to the given vpos and emit |dvpos| delete
16850 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16852 /* On a dumb terminal insert dvpos empty lines at the
16854 if (!FRAME_SCROLL_REGION_OK (f
))
16855 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16858 set_terminal_window (f
, 0);
16864 /* Shift reused rows of the current matrix to the right position.
16865 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16867 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16868 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16871 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16872 bottom_vpos
, dvpos
);
16873 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16876 else if (dvpos
> 0)
16878 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16879 bottom_vpos
, dvpos
);
16880 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16881 first_unchanged_at_end_vpos
+ dvpos
, 0);
16884 /* For frame-based redisplay, make sure that current frame and window
16885 matrix are in sync with respect to glyph memory. */
16886 if (!FRAME_WINDOW_P (f
))
16887 sync_frame_with_window_matrix_rows (w
);
16889 /* Adjust buffer positions in reused rows. */
16890 if (delta
|| delta_bytes
)
16891 increment_matrix_positions (current_matrix
,
16892 first_unchanged_at_end_vpos
+ dvpos
,
16893 bottom_vpos
, delta
, delta_bytes
);
16895 /* Adjust Y positions. */
16897 shift_glyph_matrix (w
, current_matrix
,
16898 first_unchanged_at_end_vpos
+ dvpos
,
16901 if (first_unchanged_at_end_row
)
16903 first_unchanged_at_end_row
+= dvpos
;
16904 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16905 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16906 first_unchanged_at_end_row
= NULL
;
16909 /* If scrolling up, there may be some lines to display at the end of
16911 last_text_row_at_end
= NULL
;
16914 /* Scrolling up can leave for example a partially visible line
16915 at the end of the window to be redisplayed. */
16916 /* Set last_row to the glyph row in the current matrix where the
16917 window end line is found. It has been moved up or down in
16918 the matrix by dvpos. */
16919 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16920 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16922 /* If last_row is the window end line, it should display text. */
16923 xassert (last_row
->displays_text_p
);
16925 /* If window end line was partially visible before, begin
16926 displaying at that line. Otherwise begin displaying with the
16927 line following it. */
16928 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16930 init_to_row_start (&it
, w
, last_row
);
16931 it
.vpos
= last_vpos
;
16932 it
.current_y
= last_row
->y
;
16936 init_to_row_end (&it
, w
, last_row
);
16937 it
.vpos
= 1 + last_vpos
;
16938 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16942 /* We may start in a continuation line. If so, we have to
16943 get the right continuation_lines_width and current_x. */
16944 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16945 it
.hpos
= it
.current_x
= 0;
16947 /* Display the rest of the lines at the window end. */
16948 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16949 while (it
.current_y
< it
.last_visible_y
16950 && !fonts_changed_p
)
16952 /* Is it always sure that the display agrees with lines in
16953 the current matrix? I don't think so, so we mark rows
16954 displayed invalid in the current matrix by setting their
16955 enabled_p flag to zero. */
16956 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16957 if (display_line (&it
))
16958 last_text_row_at_end
= it
.glyph_row
- 1;
16962 /* Update window_end_pos and window_end_vpos. */
16963 if (first_unchanged_at_end_row
16964 && !last_text_row_at_end
)
16966 /* Window end line if one of the preserved rows from the current
16967 matrix. Set row to the last row displaying text in current
16968 matrix starting at first_unchanged_at_end_row, after
16970 xassert (first_unchanged_at_end_row
->displays_text_p
);
16971 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16972 first_unchanged_at_end_row
);
16973 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16975 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16976 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16978 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16979 xassert (w
->window_end_bytepos
>= 0);
16980 IF_DEBUG (debug_method_add (w
, "A"));
16982 else if (last_text_row_at_end
)
16985 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16986 w
->window_end_bytepos
16987 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16989 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16990 xassert (w
->window_end_bytepos
>= 0);
16991 IF_DEBUG (debug_method_add (w
, "B"));
16993 else if (last_text_row
)
16995 /* We have displayed either to the end of the window or at the
16996 end of the window, i.e. the last row with text is to be found
16997 in the desired matrix. */
16999 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17000 w
->window_end_bytepos
17001 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17003 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17004 xassert (w
->window_end_bytepos
>= 0);
17006 else if (first_unchanged_at_end_row
== NULL
17007 && last_text_row
== NULL
17008 && last_text_row_at_end
== NULL
)
17010 /* Displayed to end of window, but no line containing text was
17011 displayed. Lines were deleted at the end of the window. */
17012 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17013 int vpos
= XFASTINT (w
->window_end_vpos
);
17014 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17015 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17018 row
== NULL
&& vpos
>= first_vpos
;
17019 --vpos
, --current_row
, --desired_row
)
17021 if (desired_row
->enabled_p
)
17023 if (desired_row
->displays_text_p
)
17026 else if (current_row
->displays_text_p
)
17030 xassert (row
!= NULL
);
17031 w
->window_end_vpos
= make_number (vpos
+ 1);
17032 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17033 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17034 xassert (w
->window_end_bytepos
>= 0);
17035 IF_DEBUG (debug_method_add (w
, "C"));
17040 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17041 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17043 /* Record that display has not been completed. */
17044 w
->window_end_valid
= Qnil
;
17045 w
->desired_matrix
->no_scrolling_p
= 1;
17053 /***********************************************************************
17054 More debugging support
17055 ***********************************************************************/
17059 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17060 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17061 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17064 /* Dump the contents of glyph matrix MATRIX on stderr.
17066 GLYPHS 0 means don't show glyph contents.
17067 GLYPHS 1 means show glyphs in short form
17068 GLYPHS > 1 means show glyphs in long form. */
17071 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17074 for (i
= 0; i
< matrix
->nrows
; ++i
)
17075 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17079 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17080 the glyph row and area where the glyph comes from. */
17083 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17085 if (glyph
->type
== CHAR_GLYPH
)
17088 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17089 glyph
- row
->glyphs
[TEXT_AREA
],
17092 (BUFFERP (glyph
->object
)
17094 : (STRINGP (glyph
->object
)
17097 glyph
->pixel_width
,
17099 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17103 glyph
->left_box_line_p
,
17104 glyph
->right_box_line_p
);
17106 else if (glyph
->type
== STRETCH_GLYPH
)
17109 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17110 glyph
- row
->glyphs
[TEXT_AREA
],
17113 (BUFFERP (glyph
->object
)
17115 : (STRINGP (glyph
->object
)
17118 glyph
->pixel_width
,
17122 glyph
->left_box_line_p
,
17123 glyph
->right_box_line_p
);
17125 else if (glyph
->type
== IMAGE_GLYPH
)
17128 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17129 glyph
- row
->glyphs
[TEXT_AREA
],
17132 (BUFFERP (glyph
->object
)
17134 : (STRINGP (glyph
->object
)
17137 glyph
->pixel_width
,
17141 glyph
->left_box_line_p
,
17142 glyph
->right_box_line_p
);
17144 else if (glyph
->type
== COMPOSITE_GLYPH
)
17147 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17148 glyph
- row
->glyphs
[TEXT_AREA
],
17151 (BUFFERP (glyph
->object
)
17153 : (STRINGP (glyph
->object
)
17156 glyph
->pixel_width
,
17158 if (glyph
->u
.cmp
.automatic
)
17161 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17162 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17164 glyph
->left_box_line_p
,
17165 glyph
->right_box_line_p
);
17170 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17171 GLYPHS 0 means don't show glyph contents.
17172 GLYPHS 1 means show glyphs in short form
17173 GLYPHS > 1 means show glyphs in long form. */
17176 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17180 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17181 fprintf (stderr
, "======================================================================\n");
17183 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17184 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17186 MATRIX_ROW_START_CHARPOS (row
),
17187 MATRIX_ROW_END_CHARPOS (row
),
17188 row
->used
[TEXT_AREA
],
17189 row
->contains_overlapping_glyphs_p
,
17191 row
->truncated_on_left_p
,
17192 row
->truncated_on_right_p
,
17194 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17195 row
->displays_text_p
,
17198 row
->ends_in_middle_of_char_p
,
17199 row
->starts_in_middle_of_char_p
,
17205 row
->visible_height
,
17208 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17209 row
->end
.overlay_string_index
,
17210 row
->continuation_lines_width
);
17211 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17212 CHARPOS (row
->start
.string_pos
),
17213 CHARPOS (row
->end
.string_pos
));
17214 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17215 row
->end
.dpvec_index
);
17222 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17224 struct glyph
*glyph
= row
->glyphs
[area
];
17225 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17227 /* Glyph for a line end in text. */
17228 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17231 if (glyph
< glyph_end
)
17232 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17234 for (; glyph
< glyph_end
; ++glyph
)
17235 dump_glyph (row
, glyph
, area
);
17238 else if (glyphs
== 1)
17242 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17244 char *s
= (char *) alloca (row
->used
[area
] + 1);
17247 for (i
= 0; i
< row
->used
[area
]; ++i
)
17249 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17250 if (glyph
->type
== CHAR_GLYPH
17251 && glyph
->u
.ch
< 0x80
17252 && glyph
->u
.ch
>= ' ')
17253 s
[i
] = glyph
->u
.ch
;
17259 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17265 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17266 Sdump_glyph_matrix
, 0, 1, "p",
17267 doc
: /* Dump the current matrix of the selected window to stderr.
17268 Shows contents of glyph row structures. With non-nil
17269 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17270 glyphs in short form, otherwise show glyphs in long form. */)
17271 (Lisp_Object glyphs
)
17273 struct window
*w
= XWINDOW (selected_window
);
17274 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17276 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17277 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17278 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17279 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17280 fprintf (stderr
, "=============================================\n");
17281 dump_glyph_matrix (w
->current_matrix
,
17282 NILP (glyphs
) ? 0 : XINT (glyphs
));
17287 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17288 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17291 struct frame
*f
= XFRAME (selected_frame
);
17292 dump_glyph_matrix (f
->current_matrix
, 1);
17297 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17298 doc
: /* Dump glyph row ROW to stderr.
17299 GLYPH 0 means don't dump glyphs.
17300 GLYPH 1 means dump glyphs in short form.
17301 GLYPH > 1 or omitted means dump glyphs in long form. */)
17302 (Lisp_Object row
, Lisp_Object glyphs
)
17304 struct glyph_matrix
*matrix
;
17307 CHECK_NUMBER (row
);
17308 matrix
= XWINDOW (selected_window
)->current_matrix
;
17310 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17311 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17313 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17318 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17319 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17320 GLYPH 0 means don't dump glyphs.
17321 GLYPH 1 means dump glyphs in short form.
17322 GLYPH > 1 or omitted means dump glyphs in long form. */)
17323 (Lisp_Object row
, Lisp_Object glyphs
)
17325 struct frame
*sf
= SELECTED_FRAME ();
17326 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17329 CHECK_NUMBER (row
);
17331 if (vpos
>= 0 && vpos
< m
->nrows
)
17332 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17333 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17338 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17339 doc
: /* Toggle tracing of redisplay.
17340 With ARG, turn tracing on if and only if ARG is positive. */)
17344 trace_redisplay_p
= !trace_redisplay_p
;
17347 arg
= Fprefix_numeric_value (arg
);
17348 trace_redisplay_p
= XINT (arg
) > 0;
17355 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17356 doc
: /* Like `format', but print result to stderr.
17357 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17358 (ptrdiff_t nargs
, Lisp_Object
*args
)
17360 Lisp_Object s
= Fformat (nargs
, args
);
17361 fprintf (stderr
, "%s", SDATA (s
));
17365 #endif /* GLYPH_DEBUG */
17369 /***********************************************************************
17370 Building Desired Matrix Rows
17371 ***********************************************************************/
17373 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17374 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17376 static struct glyph_row
*
17377 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17379 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17380 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17381 struct buffer
*old
= current_buffer
;
17382 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17383 int arrow_len
= SCHARS (overlay_arrow_string
);
17384 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17385 const unsigned char *p
;
17388 int n_glyphs_before
;
17390 set_buffer_temp (buffer
);
17391 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17392 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17393 SET_TEXT_POS (it
.position
, 0, 0);
17395 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17397 while (p
< arrow_end
)
17399 Lisp_Object face
, ilisp
;
17401 /* Get the next character. */
17403 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17406 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17407 if (! ASCII_CHAR_P (it
.c
))
17408 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17412 /* Get its face. */
17413 ilisp
= make_number (p
- arrow_string
);
17414 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17415 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17417 /* Compute its width, get its glyphs. */
17418 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17419 SET_TEXT_POS (it
.position
, -1, -1);
17420 PRODUCE_GLYPHS (&it
);
17422 /* If this character doesn't fit any more in the line, we have
17423 to remove some glyphs. */
17424 if (it
.current_x
> it
.last_visible_x
)
17426 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17431 set_buffer_temp (old
);
17432 return it
.glyph_row
;
17436 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17437 glyphs are only inserted for terminal frames since we can't really
17438 win with truncation glyphs when partially visible glyphs are
17439 involved. Which glyphs to insert is determined by
17440 produce_special_glyphs. */
17443 insert_left_trunc_glyphs (struct it
*it
)
17445 struct it truncate_it
;
17446 struct glyph
*from
, *end
, *to
, *toend
;
17448 xassert (!FRAME_WINDOW_P (it
->f
));
17450 /* Get the truncation glyphs. */
17452 truncate_it
.current_x
= 0;
17453 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17454 truncate_it
.glyph_row
= &scratch_glyph_row
;
17455 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17456 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17457 truncate_it
.object
= make_number (0);
17458 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17460 /* Overwrite glyphs from IT with truncation glyphs. */
17461 if (!it
->glyph_row
->reversed_p
)
17463 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17464 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17465 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17466 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17471 /* There may be padding glyphs left over. Overwrite them too. */
17472 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17474 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17480 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17484 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17485 that back to front. */
17486 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17487 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17488 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17489 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17491 while (from
>= end
&& to
>= toend
)
17493 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17496 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17497 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17498 while (from
>= end
&& to
>= toend
)
17503 /* Need to free some room before prepending additional
17505 int move_by
= from
- end
+ 1;
17506 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17507 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17509 for ( ; g
>= g0
; g
--)
17511 while (from
>= end
)
17513 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17519 /* Compute the pixel height and width of IT->glyph_row.
17521 Most of the time, ascent and height of a display line will be equal
17522 to the max_ascent and max_height values of the display iterator
17523 structure. This is not the case if
17525 1. We hit ZV without displaying anything. In this case, max_ascent
17526 and max_height will be zero.
17528 2. We have some glyphs that don't contribute to the line height.
17529 (The glyph row flag contributes_to_line_height_p is for future
17530 pixmap extensions).
17532 The first case is easily covered by using default values because in
17533 these cases, the line height does not really matter, except that it
17534 must not be zero. */
17537 compute_line_metrics (struct it
*it
)
17539 struct glyph_row
*row
= it
->glyph_row
;
17541 if (FRAME_WINDOW_P (it
->f
))
17543 int i
, min_y
, max_y
;
17545 /* The line may consist of one space only, that was added to
17546 place the cursor on it. If so, the row's height hasn't been
17548 if (row
->height
== 0)
17550 if (it
->max_ascent
+ it
->max_descent
== 0)
17551 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17552 row
->ascent
= it
->max_ascent
;
17553 row
->height
= it
->max_ascent
+ it
->max_descent
;
17554 row
->phys_ascent
= it
->max_phys_ascent
;
17555 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17556 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17559 /* Compute the width of this line. */
17560 row
->pixel_width
= row
->x
;
17561 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17562 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17564 xassert (row
->pixel_width
>= 0);
17565 xassert (row
->ascent
>= 0 && row
->height
> 0);
17567 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17568 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17570 /* If first line's physical ascent is larger than its logical
17571 ascent, use the physical ascent, and make the row taller.
17572 This makes accented characters fully visible. */
17573 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17574 && row
->phys_ascent
> row
->ascent
)
17576 row
->height
+= row
->phys_ascent
- row
->ascent
;
17577 row
->ascent
= row
->phys_ascent
;
17580 /* Compute how much of the line is visible. */
17581 row
->visible_height
= row
->height
;
17583 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17584 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17586 if (row
->y
< min_y
)
17587 row
->visible_height
-= min_y
- row
->y
;
17588 if (row
->y
+ row
->height
> max_y
)
17589 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17593 row
->pixel_width
= row
->used
[TEXT_AREA
];
17594 if (row
->continued_p
)
17595 row
->pixel_width
-= it
->continuation_pixel_width
;
17596 else if (row
->truncated_on_right_p
)
17597 row
->pixel_width
-= it
->truncation_pixel_width
;
17598 row
->ascent
= row
->phys_ascent
= 0;
17599 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17600 row
->extra_line_spacing
= 0;
17603 /* Compute a hash code for this row. */
17607 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17608 for (i
= 0; i
< row
->used
[area
]; ++i
)
17609 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17610 + row
->glyphs
[area
][i
].u
.val
17611 + row
->glyphs
[area
][i
].face_id
17612 + row
->glyphs
[area
][i
].padding_p
17613 + (row
->glyphs
[area
][i
].type
<< 2));
17616 it
->max_ascent
= it
->max_descent
= 0;
17617 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17621 /* Append one space to the glyph row of iterator IT if doing a
17622 window-based redisplay. The space has the same face as
17623 IT->face_id. Value is non-zero if a space was added.
17625 This function is called to make sure that there is always one glyph
17626 at the end of a glyph row that the cursor can be set on under
17627 window-systems. (If there weren't such a glyph we would not know
17628 how wide and tall a box cursor should be displayed).
17630 At the same time this space let's a nicely handle clearing to the
17631 end of the line if the row ends in italic text. */
17634 append_space_for_newline (struct it
*it
, int default_face_p
)
17636 if (FRAME_WINDOW_P (it
->f
))
17638 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17640 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17641 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17643 /* Save some values that must not be changed.
17644 Must save IT->c and IT->len because otherwise
17645 ITERATOR_AT_END_P wouldn't work anymore after
17646 append_space_for_newline has been called. */
17647 enum display_element_type saved_what
= it
->what
;
17648 int saved_c
= it
->c
, saved_len
= it
->len
;
17649 int saved_char_to_display
= it
->char_to_display
;
17650 int saved_x
= it
->current_x
;
17651 int saved_face_id
= it
->face_id
;
17652 struct text_pos saved_pos
;
17653 Lisp_Object saved_object
;
17656 saved_object
= it
->object
;
17657 saved_pos
= it
->position
;
17659 it
->what
= IT_CHARACTER
;
17660 memset (&it
->position
, 0, sizeof it
->position
);
17661 it
->object
= make_number (0);
17662 it
->c
= it
->char_to_display
= ' ';
17665 if (default_face_p
)
17666 it
->face_id
= DEFAULT_FACE_ID
;
17667 else if (it
->face_before_selective_p
)
17668 it
->face_id
= it
->saved_face_id
;
17669 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17670 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17672 PRODUCE_GLYPHS (it
);
17674 it
->override_ascent
= -1;
17675 it
->constrain_row_ascent_descent_p
= 0;
17676 it
->current_x
= saved_x
;
17677 it
->object
= saved_object
;
17678 it
->position
= saved_pos
;
17679 it
->what
= saved_what
;
17680 it
->face_id
= saved_face_id
;
17681 it
->len
= saved_len
;
17683 it
->char_to_display
= saved_char_to_display
;
17692 /* Extend the face of the last glyph in the text area of IT->glyph_row
17693 to the end of the display line. Called from display_line. If the
17694 glyph row is empty, add a space glyph to it so that we know the
17695 face to draw. Set the glyph row flag fill_line_p. If the glyph
17696 row is R2L, prepend a stretch glyph to cover the empty space to the
17697 left of the leftmost glyph. */
17700 extend_face_to_end_of_line (struct it
*it
)
17703 struct frame
*f
= it
->f
;
17705 /* If line is already filled, do nothing. Non window-system frames
17706 get a grace of one more ``pixel'' because their characters are
17707 1-``pixel'' wide, so they hit the equality too early. This grace
17708 is needed only for R2L rows that are not continued, to produce
17709 one extra blank where we could display the cursor. */
17710 if (it
->current_x
>= it
->last_visible_x
17711 + (!FRAME_WINDOW_P (f
)
17712 && it
->glyph_row
->reversed_p
17713 && !it
->glyph_row
->continued_p
))
17716 /* Face extension extends the background and box of IT->face_id
17717 to the end of the line. If the background equals the background
17718 of the frame, we don't have to do anything. */
17719 if (it
->face_before_selective_p
)
17720 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17722 face
= FACE_FROM_ID (f
, it
->face_id
);
17724 if (FRAME_WINDOW_P (f
)
17725 && it
->glyph_row
->displays_text_p
17726 && face
->box
== FACE_NO_BOX
17727 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17729 && !it
->glyph_row
->reversed_p
)
17732 /* Set the glyph row flag indicating that the face of the last glyph
17733 in the text area has to be drawn to the end of the text area. */
17734 it
->glyph_row
->fill_line_p
= 1;
17736 /* If current character of IT is not ASCII, make sure we have the
17737 ASCII face. This will be automatically undone the next time
17738 get_next_display_element returns a multibyte character. Note
17739 that the character will always be single byte in unibyte
17741 if (!ASCII_CHAR_P (it
->c
))
17743 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17746 if (FRAME_WINDOW_P (f
))
17748 /* If the row is empty, add a space with the current face of IT,
17749 so that we know which face to draw. */
17750 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17752 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17753 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17754 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17756 #ifdef HAVE_WINDOW_SYSTEM
17757 if (it
->glyph_row
->reversed_p
)
17759 /* Prepend a stretch glyph to the row, such that the
17760 rightmost glyph will be drawn flushed all the way to the
17761 right margin of the window. The stretch glyph that will
17762 occupy the empty space, if any, to the left of the
17764 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17765 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17766 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17768 int row_width
, stretch_ascent
, stretch_width
;
17769 struct text_pos saved_pos
;
17770 int saved_face_id
, saved_avoid_cursor
;
17772 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17773 row_width
+= g
->pixel_width
;
17774 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17775 if (stretch_width
> 0)
17778 (((it
->ascent
+ it
->descent
)
17779 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17780 saved_pos
= it
->position
;
17781 memset (&it
->position
, 0, sizeof it
->position
);
17782 saved_avoid_cursor
= it
->avoid_cursor_p
;
17783 it
->avoid_cursor_p
= 1;
17784 saved_face_id
= it
->face_id
;
17785 /* The last row's stretch glyph should get the default
17786 face, to avoid painting the rest of the window with
17787 the region face, if the region ends at ZV. */
17788 if (it
->glyph_row
->ends_at_zv_p
)
17789 it
->face_id
= DEFAULT_FACE_ID
;
17791 it
->face_id
= face
->id
;
17792 append_stretch_glyph (it
, make_number (0), stretch_width
,
17793 it
->ascent
+ it
->descent
, stretch_ascent
);
17794 it
->position
= saved_pos
;
17795 it
->avoid_cursor_p
= saved_avoid_cursor
;
17796 it
->face_id
= saved_face_id
;
17799 #endif /* HAVE_WINDOW_SYSTEM */
17803 /* Save some values that must not be changed. */
17804 int saved_x
= it
->current_x
;
17805 struct text_pos saved_pos
;
17806 Lisp_Object saved_object
;
17807 enum display_element_type saved_what
= it
->what
;
17808 int saved_face_id
= it
->face_id
;
17810 saved_object
= it
->object
;
17811 saved_pos
= it
->position
;
17813 it
->what
= IT_CHARACTER
;
17814 memset (&it
->position
, 0, sizeof it
->position
);
17815 it
->object
= make_number (0);
17816 it
->c
= it
->char_to_display
= ' ';
17818 /* The last row's blank glyphs should get the default face, to
17819 avoid painting the rest of the window with the region face,
17820 if the region ends at ZV. */
17821 if (it
->glyph_row
->ends_at_zv_p
)
17822 it
->face_id
= DEFAULT_FACE_ID
;
17824 it
->face_id
= face
->id
;
17826 PRODUCE_GLYPHS (it
);
17828 while (it
->current_x
<= it
->last_visible_x
)
17829 PRODUCE_GLYPHS (it
);
17831 /* Don't count these blanks really. It would let us insert a left
17832 truncation glyph below and make us set the cursor on them, maybe. */
17833 it
->current_x
= saved_x
;
17834 it
->object
= saved_object
;
17835 it
->position
= saved_pos
;
17836 it
->what
= saved_what
;
17837 it
->face_id
= saved_face_id
;
17842 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17843 trailing whitespace. */
17846 trailing_whitespace_p (EMACS_INT charpos
)
17848 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17851 while (bytepos
< ZV_BYTE
17852 && (c
= FETCH_CHAR (bytepos
),
17853 c
== ' ' || c
== '\t'))
17856 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17858 if (bytepos
!= PT_BYTE
)
17865 /* Highlight trailing whitespace, if any, in ROW. */
17868 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17870 int used
= row
->used
[TEXT_AREA
];
17874 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17875 struct glyph
*glyph
= start
+ used
- 1;
17877 if (row
->reversed_p
)
17879 /* Right-to-left rows need to be processed in the opposite
17880 direction, so swap the edge pointers. */
17882 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17885 /* Skip over glyphs inserted to display the cursor at the
17886 end of a line, for extending the face of the last glyph
17887 to the end of the line on terminals, and for truncation
17888 and continuation glyphs. */
17889 if (!row
->reversed_p
)
17891 while (glyph
>= start
17892 && glyph
->type
== CHAR_GLYPH
17893 && INTEGERP (glyph
->object
))
17898 while (glyph
<= start
17899 && glyph
->type
== CHAR_GLYPH
17900 && INTEGERP (glyph
->object
))
17904 /* If last glyph is a space or stretch, and it's trailing
17905 whitespace, set the face of all trailing whitespace glyphs in
17906 IT->glyph_row to `trailing-whitespace'. */
17907 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17908 && BUFFERP (glyph
->object
)
17909 && (glyph
->type
== STRETCH_GLYPH
17910 || (glyph
->type
== CHAR_GLYPH
17911 && glyph
->u
.ch
== ' '))
17912 && trailing_whitespace_p (glyph
->charpos
))
17914 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17918 if (!row
->reversed_p
)
17920 while (glyph
>= start
17921 && BUFFERP (glyph
->object
)
17922 && (glyph
->type
== STRETCH_GLYPH
17923 || (glyph
->type
== CHAR_GLYPH
17924 && glyph
->u
.ch
== ' ')))
17925 (glyph
--)->face_id
= face_id
;
17929 while (glyph
<= start
17930 && BUFFERP (glyph
->object
)
17931 && (glyph
->type
== STRETCH_GLYPH
17932 || (glyph
->type
== CHAR_GLYPH
17933 && glyph
->u
.ch
== ' ')))
17934 (glyph
++)->face_id
= face_id
;
17941 /* Value is non-zero if glyph row ROW should be
17942 used to hold the cursor. */
17945 cursor_row_p (struct glyph_row
*row
)
17949 if (PT
== CHARPOS (row
->end
.pos
))
17951 /* Suppose the row ends on a string.
17952 Unless the row is continued, that means it ends on a newline
17953 in the string. If it's anything other than a display string
17954 (e.g. a before-string from an overlay), we don't want the
17955 cursor there. (This heuristic seems to give the optimal
17956 behavior for the various types of multi-line strings.) */
17957 if (CHARPOS (row
->end
.string_pos
) >= 0)
17959 if (row
->continued_p
)
17963 /* Check for `display' property. */
17964 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17965 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17966 struct glyph
*glyph
;
17969 for (glyph
= end
; glyph
>= beg
; --glyph
)
17970 if (STRINGP (glyph
->object
))
17973 = Fget_char_property (make_number (PT
),
17977 && display_prop_string_p (prop
, glyph
->object
));
17982 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17984 /* If the row ends in middle of a real character,
17985 and the line is continued, we want the cursor here.
17986 That's because CHARPOS (ROW->end.pos) would equal
17987 PT if PT is before the character. */
17988 if (!row
->ends_in_ellipsis_p
)
17989 result
= row
->continued_p
;
17991 /* If the row ends in an ellipsis, then
17992 CHARPOS (ROW->end.pos) will equal point after the
17993 invisible text. We want that position to be displayed
17994 after the ellipsis. */
17997 /* If the row ends at ZV, display the cursor at the end of that
17998 row instead of at the start of the row below. */
17999 else if (row
->ends_at_zv_p
)
18010 /* Push the display property PROP so that it will be rendered at the
18011 current position in IT. Return 1 if PROP was successfully pushed,
18015 push_display_prop (struct it
*it
, Lisp_Object prop
)
18017 xassert (it
->method
== GET_FROM_BUFFER
);
18019 push_it (it
, NULL
);
18021 if (STRINGP (prop
))
18023 if (SCHARS (prop
) == 0)
18030 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18031 it
->current
.overlay_string_index
= -1;
18032 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18033 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18034 it
->method
= GET_FROM_STRING
;
18035 it
->stop_charpos
= 0;
18037 it
->base_level_stop
= 0;
18038 it
->string_from_display_prop_p
= 1;
18039 it
->from_disp_prop_p
= 1;
18041 /* Force paragraph direction to be that of the parent
18043 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18044 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18046 it
->paragraph_embedding
= L2R
;
18048 /* Set up the bidi iterator for this display string. */
18051 it
->bidi_it
.string
.lstring
= it
->string
;
18052 it
->bidi_it
.string
.s
= NULL
;
18053 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18054 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18055 it
->bidi_it
.string
.from_disp_str
= 1;
18056 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18057 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18060 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18062 it
->method
= GET_FROM_STRETCH
;
18065 #ifdef HAVE_WINDOW_SYSTEM
18066 else if (IMAGEP (prop
))
18068 it
->what
= IT_IMAGE
;
18069 it
->image_id
= lookup_image (it
->f
, prop
);
18070 it
->method
= GET_FROM_IMAGE
;
18072 #endif /* HAVE_WINDOW_SYSTEM */
18075 pop_it (it
); /* bogus display property, give up */
18082 /* Return the character-property PROP at the current position in IT. */
18085 get_it_property (struct it
*it
, Lisp_Object prop
)
18087 Lisp_Object position
;
18089 if (STRINGP (it
->object
))
18090 position
= make_number (IT_STRING_CHARPOS (*it
));
18091 else if (BUFFERP (it
->object
))
18092 position
= make_number (IT_CHARPOS (*it
));
18096 return Fget_char_property (position
, prop
, it
->object
);
18099 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18102 handle_line_prefix (struct it
*it
)
18104 Lisp_Object prefix
;
18106 if (it
->continuation_lines_width
> 0)
18108 prefix
= get_it_property (it
, Qwrap_prefix
);
18110 prefix
= Vwrap_prefix
;
18114 prefix
= get_it_property (it
, Qline_prefix
);
18116 prefix
= Vline_prefix
;
18118 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18120 /* If the prefix is wider than the window, and we try to wrap
18121 it, it would acquire its own wrap prefix, and so on till the
18122 iterator stack overflows. So, don't wrap the prefix. */
18123 it
->line_wrap
= TRUNCATE
;
18124 it
->avoid_cursor_p
= 1;
18130 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18131 only for R2L lines from display_line and display_string, when they
18132 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18133 the line/string needs to be continued on the next glyph row. */
18135 unproduce_glyphs (struct it
*it
, int n
)
18137 struct glyph
*glyph
, *end
;
18139 xassert (it
->glyph_row
);
18140 xassert (it
->glyph_row
->reversed_p
);
18141 xassert (it
->area
== TEXT_AREA
);
18142 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18144 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18145 n
= it
->glyph_row
->used
[TEXT_AREA
];
18146 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18147 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18148 for ( ; glyph
< end
; glyph
++)
18149 glyph
[-n
] = *glyph
;
18152 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18153 and ROW->maxpos. */
18155 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18156 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18157 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18159 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18160 lines' rows is implemented for bidi-reordered rows. */
18162 /* ROW->minpos is the value of min_pos, the minimal buffer position
18163 we have in ROW, or ROW->start.pos if that is smaller. */
18164 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18165 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18167 /* We didn't find buffer positions smaller than ROW->start, or
18168 didn't find _any_ valid buffer positions in any of the glyphs,
18169 so we must trust the iterator's computed positions. */
18170 row
->minpos
= row
->start
.pos
;
18173 max_pos
= CHARPOS (it
->current
.pos
);
18174 max_bpos
= BYTEPOS (it
->current
.pos
);
18177 /* Here are the various use-cases for ending the row, and the
18178 corresponding values for ROW->maxpos:
18180 Line ends in a newline from buffer eol_pos + 1
18181 Line is continued from buffer max_pos + 1
18182 Line is truncated on right it->current.pos
18183 Line ends in a newline from string max_pos
18184 Line is continued from string max_pos
18185 Line is continued from display vector max_pos
18186 Line is entirely from a string min_pos == max_pos
18187 Line is entirely from a display vector min_pos == max_pos
18188 Line that ends at ZV ZV
18190 If you discover other use-cases, please add them here as
18192 if (row
->ends_at_zv_p
)
18193 row
->maxpos
= it
->current
.pos
;
18194 else if (row
->used
[TEXT_AREA
])
18196 if (row
->ends_in_newline_from_string_p
)
18197 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18198 else if (CHARPOS (it
->eol_pos
) > 0)
18199 SET_TEXT_POS (row
->maxpos
,
18200 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18201 else if (row
->continued_p
)
18203 /* If max_pos is different from IT's current position, it
18204 means IT->method does not belong to the display element
18205 at max_pos. However, it also means that the display
18206 element at max_pos was displayed in its entirety on this
18207 line, which is equivalent to saying that the next line
18208 starts at the next buffer position. */
18209 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18210 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18213 INC_BOTH (max_pos
, max_bpos
);
18214 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18217 else if (row
->truncated_on_right_p
)
18218 /* display_line already called reseat_at_next_visible_line_start,
18219 which puts the iterator at the beginning of the next line, in
18220 the logical order. */
18221 row
->maxpos
= it
->current
.pos
;
18222 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18223 /* A line that is entirely from a string/image/stretch... */
18224 row
->maxpos
= row
->minpos
;
18229 row
->maxpos
= it
->current
.pos
;
18232 /* Construct the glyph row IT->glyph_row in the desired matrix of
18233 IT->w from text at the current position of IT. See dispextern.h
18234 for an overview of struct it. Value is non-zero if
18235 IT->glyph_row displays text, as opposed to a line displaying ZV
18239 display_line (struct it
*it
)
18241 struct glyph_row
*row
= it
->glyph_row
;
18242 Lisp_Object overlay_arrow_string
;
18244 void *wrap_data
= NULL
;
18245 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18246 int wrap_row_used
= -1;
18247 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18248 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18249 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18250 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18251 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18253 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18254 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18256 /* We always start displaying at hpos zero even if hscrolled. */
18257 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18259 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18260 >= it
->w
->desired_matrix
->nrows
)
18262 it
->w
->nrows_scale_factor
++;
18263 fonts_changed_p
= 1;
18267 /* Is IT->w showing the region? */
18268 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18270 /* Clear the result glyph row and enable it. */
18271 prepare_desired_row (row
);
18273 row
->y
= it
->current_y
;
18274 row
->start
= it
->start
;
18275 row
->continuation_lines_width
= it
->continuation_lines_width
;
18276 row
->displays_text_p
= 1;
18277 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18278 it
->starts_in_middle_of_char_p
= 0;
18280 /* Arrange the overlays nicely for our purposes. Usually, we call
18281 display_line on only one line at a time, in which case this
18282 can't really hurt too much, or we call it on lines which appear
18283 one after another in the buffer, in which case all calls to
18284 recenter_overlay_lists but the first will be pretty cheap. */
18285 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18287 /* Move over display elements that are not visible because we are
18288 hscrolled. This may stop at an x-position < IT->first_visible_x
18289 if the first glyph is partially visible or if we hit a line end. */
18290 if (it
->current_x
< it
->first_visible_x
)
18292 this_line_min_pos
= row
->start
.pos
;
18293 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18294 MOVE_TO_POS
| MOVE_TO_X
);
18295 /* Record the smallest positions seen while we moved over
18296 display elements that are not visible. This is needed by
18297 redisplay_internal for optimizing the case where the cursor
18298 stays inside the same line. The rest of this function only
18299 considers positions that are actually displayed, so
18300 RECORD_MAX_MIN_POS will not otherwise record positions that
18301 are hscrolled to the left of the left edge of the window. */
18302 min_pos
= CHARPOS (this_line_min_pos
);
18303 min_bpos
= BYTEPOS (this_line_min_pos
);
18307 /* We only do this when not calling `move_it_in_display_line_to'
18308 above, because move_it_in_display_line_to calls
18309 handle_line_prefix itself. */
18310 handle_line_prefix (it
);
18313 /* Get the initial row height. This is either the height of the
18314 text hscrolled, if there is any, or zero. */
18315 row
->ascent
= it
->max_ascent
;
18316 row
->height
= it
->max_ascent
+ it
->max_descent
;
18317 row
->phys_ascent
= it
->max_phys_ascent
;
18318 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18319 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18321 /* Utility macro to record max and min buffer positions seen until now. */
18322 #define RECORD_MAX_MIN_POS(IT) \
18325 if (IT_CHARPOS (*(IT)) < min_pos) \
18327 min_pos = IT_CHARPOS (*(IT)); \
18328 min_bpos = IT_BYTEPOS (*(IT)); \
18330 if (IT_CHARPOS (*(IT)) > max_pos) \
18332 max_pos = IT_CHARPOS (*(IT)); \
18333 max_bpos = IT_BYTEPOS (*(IT)); \
18338 /* Loop generating characters. The loop is left with IT on the next
18339 character to display. */
18342 int n_glyphs_before
, hpos_before
, x_before
;
18344 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18346 /* Retrieve the next thing to display. Value is zero if end of
18348 if (!get_next_display_element (it
))
18350 /* Maybe add a space at the end of this line that is used to
18351 display the cursor there under X. Set the charpos of the
18352 first glyph of blank lines not corresponding to any text
18354 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18355 row
->exact_window_width_line_p
= 1;
18356 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18357 || row
->used
[TEXT_AREA
] == 0)
18359 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18360 row
->displays_text_p
= 0;
18362 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18363 && (!MINI_WINDOW_P (it
->w
)
18364 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18365 row
->indicate_empty_line_p
= 1;
18368 it
->continuation_lines_width
= 0;
18369 row
->ends_at_zv_p
= 1;
18370 /* A row that displays right-to-left text must always have
18371 its last face extended all the way to the end of line,
18372 even if this row ends in ZV, because we still write to
18373 the screen left to right. */
18374 if (row
->reversed_p
)
18375 extend_face_to_end_of_line (it
);
18379 /* Now, get the metrics of what we want to display. This also
18380 generates glyphs in `row' (which is IT->glyph_row). */
18381 n_glyphs_before
= row
->used
[TEXT_AREA
];
18384 /* Remember the line height so far in case the next element doesn't
18385 fit on the line. */
18386 if (it
->line_wrap
!= TRUNCATE
)
18388 ascent
= it
->max_ascent
;
18389 descent
= it
->max_descent
;
18390 phys_ascent
= it
->max_phys_ascent
;
18391 phys_descent
= it
->max_phys_descent
;
18393 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18395 if (IT_DISPLAYING_WHITESPACE (it
))
18399 SAVE_IT (wrap_it
, *it
, wrap_data
);
18401 wrap_row_used
= row
->used
[TEXT_AREA
];
18402 wrap_row_ascent
= row
->ascent
;
18403 wrap_row_height
= row
->height
;
18404 wrap_row_phys_ascent
= row
->phys_ascent
;
18405 wrap_row_phys_height
= row
->phys_height
;
18406 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18407 wrap_row_min_pos
= min_pos
;
18408 wrap_row_min_bpos
= min_bpos
;
18409 wrap_row_max_pos
= max_pos
;
18410 wrap_row_max_bpos
= max_bpos
;
18416 PRODUCE_GLYPHS (it
);
18418 /* If this display element was in marginal areas, continue with
18420 if (it
->area
!= TEXT_AREA
)
18422 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18423 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18424 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18425 row
->phys_height
= max (row
->phys_height
,
18426 it
->max_phys_ascent
+ it
->max_phys_descent
);
18427 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18428 it
->max_extra_line_spacing
);
18429 set_iterator_to_next (it
, 1);
18433 /* Does the display element fit on the line? If we truncate
18434 lines, we should draw past the right edge of the window. If
18435 we don't truncate, we want to stop so that we can display the
18436 continuation glyph before the right margin. If lines are
18437 continued, there are two possible strategies for characters
18438 resulting in more than 1 glyph (e.g. tabs): Display as many
18439 glyphs as possible in this line and leave the rest for the
18440 continuation line, or display the whole element in the next
18441 line. Original redisplay did the former, so we do it also. */
18442 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18443 hpos_before
= it
->hpos
;
18446 if (/* Not a newline. */
18448 /* Glyphs produced fit entirely in the line. */
18449 && it
->current_x
< it
->last_visible_x
)
18451 it
->hpos
+= nglyphs
;
18452 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18453 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18454 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18455 row
->phys_height
= max (row
->phys_height
,
18456 it
->max_phys_ascent
+ it
->max_phys_descent
);
18457 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18458 it
->max_extra_line_spacing
);
18459 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18460 row
->x
= x
- it
->first_visible_x
;
18461 /* Record the maximum and minimum buffer positions seen so
18462 far in glyphs that will be displayed by this row. */
18464 RECORD_MAX_MIN_POS (it
);
18469 struct glyph
*glyph
;
18471 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18473 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18474 new_x
= x
+ glyph
->pixel_width
;
18476 if (/* Lines are continued. */
18477 it
->line_wrap
!= TRUNCATE
18478 && (/* Glyph doesn't fit on the line. */
18479 new_x
> it
->last_visible_x
18480 /* Or it fits exactly on a window system frame. */
18481 || (new_x
== it
->last_visible_x
18482 && FRAME_WINDOW_P (it
->f
))))
18484 /* End of a continued line. */
18487 || (new_x
== it
->last_visible_x
18488 && FRAME_WINDOW_P (it
->f
)))
18490 /* Current glyph is the only one on the line or
18491 fits exactly on the line. We must continue
18492 the line because we can't draw the cursor
18493 after the glyph. */
18494 row
->continued_p
= 1;
18495 it
->current_x
= new_x
;
18496 it
->continuation_lines_width
+= new_x
;
18498 /* Record the maximum and minimum buffer
18499 positions seen so far in glyphs that will be
18500 displayed by this row. */
18502 RECORD_MAX_MIN_POS (it
);
18503 if (i
== nglyphs
- 1)
18505 /* If line-wrap is on, check if a previous
18506 wrap point was found. */
18507 if (wrap_row_used
> 0
18508 /* Even if there is a previous wrap
18509 point, continue the line here as
18510 usual, if (i) the previous character
18511 was a space or tab AND (ii) the
18512 current character is not. */
18514 || IT_DISPLAYING_WHITESPACE (it
)))
18517 set_iterator_to_next (it
, 1);
18518 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18520 if (!get_next_display_element (it
))
18522 row
->exact_window_width_line_p
= 1;
18523 it
->continuation_lines_width
= 0;
18524 row
->continued_p
= 0;
18525 row
->ends_at_zv_p
= 1;
18527 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18529 row
->continued_p
= 0;
18530 row
->exact_window_width_line_p
= 1;
18535 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18536 && !FRAME_WINDOW_P (it
->f
))
18538 /* A padding glyph that doesn't fit on this line.
18539 This means the whole character doesn't fit
18541 if (row
->reversed_p
)
18542 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18543 - n_glyphs_before
);
18544 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18546 /* Fill the rest of the row with continuation
18547 glyphs like in 20.x. */
18548 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18549 < row
->glyphs
[1 + TEXT_AREA
])
18550 produce_special_glyphs (it
, IT_CONTINUATION
);
18552 row
->continued_p
= 1;
18553 it
->current_x
= x_before
;
18554 it
->continuation_lines_width
+= x_before
;
18556 /* Restore the height to what it was before the
18557 element not fitting on the line. */
18558 it
->max_ascent
= ascent
;
18559 it
->max_descent
= descent
;
18560 it
->max_phys_ascent
= phys_ascent
;
18561 it
->max_phys_descent
= phys_descent
;
18563 else if (wrap_row_used
> 0)
18566 if (row
->reversed_p
)
18567 unproduce_glyphs (it
,
18568 row
->used
[TEXT_AREA
] - wrap_row_used
);
18569 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18570 it
->continuation_lines_width
+= wrap_x
;
18571 row
->used
[TEXT_AREA
] = wrap_row_used
;
18572 row
->ascent
= wrap_row_ascent
;
18573 row
->height
= wrap_row_height
;
18574 row
->phys_ascent
= wrap_row_phys_ascent
;
18575 row
->phys_height
= wrap_row_phys_height
;
18576 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18577 min_pos
= wrap_row_min_pos
;
18578 min_bpos
= wrap_row_min_bpos
;
18579 max_pos
= wrap_row_max_pos
;
18580 max_bpos
= wrap_row_max_bpos
;
18581 row
->continued_p
= 1;
18582 row
->ends_at_zv_p
= 0;
18583 row
->exact_window_width_line_p
= 0;
18584 it
->continuation_lines_width
+= x
;
18586 /* Make sure that a non-default face is extended
18587 up to the right margin of the window. */
18588 extend_face_to_end_of_line (it
);
18590 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18592 /* A TAB that extends past the right edge of the
18593 window. This produces a single glyph on
18594 window system frames. We leave the glyph in
18595 this row and let it fill the row, but don't
18596 consume the TAB. */
18597 it
->continuation_lines_width
+= it
->last_visible_x
;
18598 row
->ends_in_middle_of_char_p
= 1;
18599 row
->continued_p
= 1;
18600 glyph
->pixel_width
= it
->last_visible_x
- x
;
18601 it
->starts_in_middle_of_char_p
= 1;
18605 /* Something other than a TAB that draws past
18606 the right edge of the window. Restore
18607 positions to values before the element. */
18608 if (row
->reversed_p
)
18609 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18610 - (n_glyphs_before
+ i
));
18611 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18613 /* Display continuation glyphs. */
18614 if (!FRAME_WINDOW_P (it
->f
))
18615 produce_special_glyphs (it
, IT_CONTINUATION
);
18616 row
->continued_p
= 1;
18618 it
->current_x
= x_before
;
18619 it
->continuation_lines_width
+= x
;
18620 extend_face_to_end_of_line (it
);
18622 if (nglyphs
> 1 && i
> 0)
18624 row
->ends_in_middle_of_char_p
= 1;
18625 it
->starts_in_middle_of_char_p
= 1;
18628 /* Restore the height to what it was before the
18629 element not fitting on the line. */
18630 it
->max_ascent
= ascent
;
18631 it
->max_descent
= descent
;
18632 it
->max_phys_ascent
= phys_ascent
;
18633 it
->max_phys_descent
= phys_descent
;
18638 else if (new_x
> it
->first_visible_x
)
18640 /* Increment number of glyphs actually displayed. */
18643 /* Record the maximum and minimum buffer positions
18644 seen so far in glyphs that will be displayed by
18647 RECORD_MAX_MIN_POS (it
);
18649 if (x
< it
->first_visible_x
)
18650 /* Glyph is partially visible, i.e. row starts at
18651 negative X position. */
18652 row
->x
= x
- it
->first_visible_x
;
18656 /* Glyph is completely off the left margin of the
18657 window. This should not happen because of the
18658 move_it_in_display_line at the start of this
18659 function, unless the text display area of the
18660 window is empty. */
18661 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18665 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18666 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18667 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18668 row
->phys_height
= max (row
->phys_height
,
18669 it
->max_phys_ascent
+ it
->max_phys_descent
);
18670 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18671 it
->max_extra_line_spacing
);
18673 /* End of this display line if row is continued. */
18674 if (row
->continued_p
|| row
->ends_at_zv_p
)
18679 /* Is this a line end? If yes, we're also done, after making
18680 sure that a non-default face is extended up to the right
18681 margin of the window. */
18682 if (ITERATOR_AT_END_OF_LINE_P (it
))
18684 int used_before
= row
->used
[TEXT_AREA
];
18686 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18688 /* Add a space at the end of the line that is used to
18689 display the cursor there. */
18690 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18691 append_space_for_newline (it
, 0);
18693 /* Extend the face to the end of the line. */
18694 extend_face_to_end_of_line (it
);
18696 /* Make sure we have the position. */
18697 if (used_before
== 0)
18698 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18700 /* Record the position of the newline, for use in
18702 it
->eol_pos
= it
->current
.pos
;
18704 /* Consume the line end. This skips over invisible lines. */
18705 set_iterator_to_next (it
, 1);
18706 it
->continuation_lines_width
= 0;
18710 /* Proceed with next display element. Note that this skips
18711 over lines invisible because of selective display. */
18712 set_iterator_to_next (it
, 1);
18714 /* If we truncate lines, we are done when the last displayed
18715 glyphs reach past the right margin of the window. */
18716 if (it
->line_wrap
== TRUNCATE
18717 && (FRAME_WINDOW_P (it
->f
)
18718 ? (it
->current_x
>= it
->last_visible_x
)
18719 : (it
->current_x
> it
->last_visible_x
)))
18721 /* Maybe add truncation glyphs. */
18722 if (!FRAME_WINDOW_P (it
->f
))
18726 if (!row
->reversed_p
)
18728 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18729 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18734 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18735 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18737 /* Remove any padding glyphs at the front of ROW, to
18738 make room for the truncation glyphs we will be
18739 adding below. The loop below always inserts at
18740 least one truncation glyph, so also remove the
18741 last glyph added to ROW. */
18742 unproduce_glyphs (it
, i
+ 1);
18743 /* Adjust i for the loop below. */
18744 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18747 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18749 row
->used
[TEXT_AREA
] = i
;
18750 produce_special_glyphs (it
, IT_TRUNCATION
);
18753 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18755 /* Don't truncate if we can overflow newline into fringe. */
18756 if (!get_next_display_element (it
))
18758 it
->continuation_lines_width
= 0;
18759 row
->ends_at_zv_p
= 1;
18760 row
->exact_window_width_line_p
= 1;
18763 if (ITERATOR_AT_END_OF_LINE_P (it
))
18765 row
->exact_window_width_line_p
= 1;
18766 goto at_end_of_line
;
18770 row
->truncated_on_right_p
= 1;
18771 it
->continuation_lines_width
= 0;
18772 reseat_at_next_visible_line_start (it
, 0);
18773 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18774 it
->hpos
= hpos_before
;
18775 it
->current_x
= x_before
;
18781 bidi_unshelve_cache (wrap_data
, 1);
18783 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18784 at the left window margin. */
18785 if (it
->first_visible_x
18786 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18788 if (!FRAME_WINDOW_P (it
->f
))
18789 insert_left_trunc_glyphs (it
);
18790 row
->truncated_on_left_p
= 1;
18793 /* Remember the position at which this line ends.
18795 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18796 cannot be before the call to find_row_edges below, since that is
18797 where these positions are determined. */
18798 row
->end
= it
->current
;
18801 row
->minpos
= row
->start
.pos
;
18802 row
->maxpos
= row
->end
.pos
;
18806 /* ROW->minpos and ROW->maxpos must be the smallest and
18807 `1 + the largest' buffer positions in ROW. But if ROW was
18808 bidi-reordered, these two positions can be anywhere in the
18809 row, so we must determine them now. */
18810 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18813 /* If the start of this line is the overlay arrow-position, then
18814 mark this glyph row as the one containing the overlay arrow.
18815 This is clearly a mess with variable size fonts. It would be
18816 better to let it be displayed like cursors under X. */
18817 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18818 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18819 !NILP (overlay_arrow_string
)))
18821 /* Overlay arrow in window redisplay is a fringe bitmap. */
18822 if (STRINGP (overlay_arrow_string
))
18824 struct glyph_row
*arrow_row
18825 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18826 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18827 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18828 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18829 struct glyph
*p2
, *end
;
18831 /* Copy the arrow glyphs. */
18832 while (glyph
< arrow_end
)
18835 /* Throw away padding glyphs. */
18837 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18838 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18844 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18849 xassert (INTEGERP (overlay_arrow_string
));
18850 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18852 overlay_arrow_seen
= 1;
18855 /* Compute pixel dimensions of this line. */
18856 compute_line_metrics (it
);
18858 /* Record whether this row ends inside an ellipsis. */
18859 row
->ends_in_ellipsis_p
18860 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18861 && it
->ellipsis_p
);
18863 /* Save fringe bitmaps in this row. */
18864 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18865 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18866 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18867 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18869 it
->left_user_fringe_bitmap
= 0;
18870 it
->left_user_fringe_face_id
= 0;
18871 it
->right_user_fringe_bitmap
= 0;
18872 it
->right_user_fringe_face_id
= 0;
18874 /* Maybe set the cursor. */
18875 cvpos
= it
->w
->cursor
.vpos
;
18877 /* In bidi-reordered rows, keep checking for proper cursor
18878 position even if one has been found already, because buffer
18879 positions in such rows change non-linearly with ROW->VPOS,
18880 when a line is continued. One exception: when we are at ZV,
18881 display cursor on the first suitable glyph row, since all
18882 the empty rows after that also have their position set to ZV. */
18883 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18884 lines' rows is implemented for bidi-reordered rows. */
18886 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18887 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18888 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18889 && cursor_row_p (row
))
18890 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18892 /* Highlight trailing whitespace. */
18893 if (!NILP (Vshow_trailing_whitespace
))
18894 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18896 /* Prepare for the next line. This line starts horizontally at (X
18897 HPOS) = (0 0). Vertical positions are incremented. As a
18898 convenience for the caller, IT->glyph_row is set to the next
18900 it
->current_x
= it
->hpos
= 0;
18901 it
->current_y
+= row
->height
;
18902 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18905 /* The next row should by default use the same value of the
18906 reversed_p flag as this one. set_iterator_to_next decides when
18907 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18908 the flag accordingly. */
18909 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18910 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18911 it
->start
= row
->end
;
18912 return row
->displays_text_p
;
18914 #undef RECORD_MAX_MIN_POS
18917 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18918 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18919 doc
: /* Return paragraph direction at point in BUFFER.
18920 Value is either `left-to-right' or `right-to-left'.
18921 If BUFFER is omitted or nil, it defaults to the current buffer.
18923 Paragraph direction determines how the text in the paragraph is displayed.
18924 In left-to-right paragraphs, text begins at the left margin of the window
18925 and the reading direction is generally left to right. In right-to-left
18926 paragraphs, text begins at the right margin and is read from right to left.
18928 See also `bidi-paragraph-direction'. */)
18929 (Lisp_Object buffer
)
18931 struct buffer
*buf
= current_buffer
;
18932 struct buffer
*old
= buf
;
18934 if (! NILP (buffer
))
18936 CHECK_BUFFER (buffer
);
18937 buf
= XBUFFER (buffer
);
18940 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18941 return Qleft_to_right
;
18942 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18943 return BVAR (buf
, bidi_paragraph_direction
);
18946 /* Determine the direction from buffer text. We could try to
18947 use current_matrix if it is up to date, but this seems fast
18948 enough as it is. */
18949 struct bidi_it itb
;
18950 EMACS_INT pos
= BUF_PT (buf
);
18951 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18954 set_buffer_temp (buf
);
18955 /* bidi_paragraph_init finds the base direction of the paragraph
18956 by searching forward from paragraph start. We need the base
18957 direction of the current or _previous_ paragraph, so we need
18958 to make sure we are within that paragraph. To that end, find
18959 the previous non-empty line. */
18960 if (pos
>= ZV
&& pos
> BEGV
)
18963 bytepos
= CHAR_TO_BYTE (pos
);
18965 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18966 || c
== ' ' || c
== '\t' || c
== '\f')
18968 if (bytepos
<= BEGV_BYTE
)
18973 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18976 itb
.bytepos
= bytepos
;
18978 itb
.string
.s
= NULL
;
18979 itb
.string
.lstring
= Qnil
;
18980 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18982 itb
.separator_limit
= -1;
18983 itb
.paragraph_dir
= NEUTRAL_DIR
;
18985 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18986 set_buffer_temp (old
);
18987 switch (itb
.paragraph_dir
)
18990 return Qleft_to_right
;
18993 return Qright_to_left
;
19003 /***********************************************************************
19005 ***********************************************************************/
19007 /* Redisplay the menu bar in the frame for window W.
19009 The menu bar of X frames that don't have X toolkit support is
19010 displayed in a special window W->frame->menu_bar_window.
19012 The menu bar of terminal frames is treated specially as far as
19013 glyph matrices are concerned. Menu bar lines are not part of
19014 windows, so the update is done directly on the frame matrix rows
19015 for the menu bar. */
19018 display_menu_bar (struct window
*w
)
19020 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19025 /* Don't do all this for graphical frames. */
19027 if (FRAME_W32_P (f
))
19030 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19036 if (FRAME_NS_P (f
))
19038 #endif /* HAVE_NS */
19040 #ifdef USE_X_TOOLKIT
19041 xassert (!FRAME_WINDOW_P (f
));
19042 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19043 it
.first_visible_x
= 0;
19044 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19045 #else /* not USE_X_TOOLKIT */
19046 if (FRAME_WINDOW_P (f
))
19048 /* Menu bar lines are displayed in the desired matrix of the
19049 dummy window menu_bar_window. */
19050 struct window
*menu_w
;
19051 xassert (WINDOWP (f
->menu_bar_window
));
19052 menu_w
= XWINDOW (f
->menu_bar_window
);
19053 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19055 it
.first_visible_x
= 0;
19056 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19060 /* This is a TTY frame, i.e. character hpos/vpos are used as
19062 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19064 it
.first_visible_x
= 0;
19065 it
.last_visible_x
= FRAME_COLS (f
);
19067 #endif /* not USE_X_TOOLKIT */
19069 /* FIXME: This should be controlled by a user option. See the
19070 comments in redisplay_tool_bar and display_mode_line about
19072 it
.paragraph_embedding
= L2R
;
19074 if (! mode_line_inverse_video
)
19075 /* Force the menu-bar to be displayed in the default face. */
19076 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19078 /* Clear all rows of the menu bar. */
19079 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19081 struct glyph_row
*row
= it
.glyph_row
+ i
;
19082 clear_glyph_row (row
);
19083 row
->enabled_p
= 1;
19084 row
->full_width_p
= 1;
19087 /* Display all items of the menu bar. */
19088 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19089 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19091 Lisp_Object string
;
19093 /* Stop at nil string. */
19094 string
= AREF (items
, i
+ 1);
19098 /* Remember where item was displayed. */
19099 ASET (items
, i
+ 3, make_number (it
.hpos
));
19101 /* Display the item, pad with one space. */
19102 if (it
.current_x
< it
.last_visible_x
)
19103 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19104 SCHARS (string
) + 1, 0, 0, -1);
19107 /* Fill out the line with spaces. */
19108 if (it
.current_x
< it
.last_visible_x
)
19109 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19111 /* Compute the total height of the lines. */
19112 compute_line_metrics (&it
);
19117 /***********************************************************************
19119 ***********************************************************************/
19121 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19122 FORCE is non-zero, redisplay mode lines unconditionally.
19123 Otherwise, redisplay only mode lines that are garbaged. Value is
19124 the number of windows whose mode lines were redisplayed. */
19127 redisplay_mode_lines (Lisp_Object window
, int force
)
19131 while (!NILP (window
))
19133 struct window
*w
= XWINDOW (window
);
19135 if (WINDOWP (w
->hchild
))
19136 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19137 else if (WINDOWP (w
->vchild
))
19138 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19140 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19141 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19143 struct text_pos lpoint
;
19144 struct buffer
*old
= current_buffer
;
19146 /* Set the window's buffer for the mode line display. */
19147 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19148 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19150 /* Point refers normally to the selected window. For any
19151 other window, set up appropriate value. */
19152 if (!EQ (window
, selected_window
))
19154 struct text_pos pt
;
19156 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19157 if (CHARPOS (pt
) < BEGV
)
19158 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19159 else if (CHARPOS (pt
) > (ZV
- 1))
19160 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19162 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19165 /* Display mode lines. */
19166 clear_glyph_matrix (w
->desired_matrix
);
19167 if (display_mode_lines (w
))
19170 w
->must_be_updated_p
= 1;
19173 /* Restore old settings. */
19174 set_buffer_internal_1 (old
);
19175 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19185 /* Display the mode and/or header line of window W. Value is the
19186 sum number of mode lines and header lines displayed. */
19189 display_mode_lines (struct window
*w
)
19191 Lisp_Object old_selected_window
, old_selected_frame
;
19194 old_selected_frame
= selected_frame
;
19195 selected_frame
= w
->frame
;
19196 old_selected_window
= selected_window
;
19197 XSETWINDOW (selected_window
, w
);
19199 /* These will be set while the mode line specs are processed. */
19200 line_number_displayed
= 0;
19201 w
->column_number_displayed
= Qnil
;
19203 if (WINDOW_WANTS_MODELINE_P (w
))
19205 struct window
*sel_w
= XWINDOW (old_selected_window
);
19207 /* Select mode line face based on the real selected window. */
19208 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19209 BVAR (current_buffer
, mode_line_format
));
19213 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19215 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19216 BVAR (current_buffer
, header_line_format
));
19220 selected_frame
= old_selected_frame
;
19221 selected_window
= old_selected_window
;
19226 /* Display mode or header line of window W. FACE_ID specifies which
19227 line to display; it is either MODE_LINE_FACE_ID or
19228 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19229 display. Value is the pixel height of the mode/header line
19233 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19237 int count
= SPECPDL_INDEX ();
19239 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19240 /* Don't extend on a previously drawn mode-line.
19241 This may happen if called from pos_visible_p. */
19242 it
.glyph_row
->enabled_p
= 0;
19243 prepare_desired_row (it
.glyph_row
);
19245 it
.glyph_row
->mode_line_p
= 1;
19247 if (! mode_line_inverse_video
)
19248 /* Force the mode-line to be displayed in the default face. */
19249 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19251 /* FIXME: This should be controlled by a user option. But
19252 supporting such an option is not trivial, since the mode line is
19253 made up of many separate strings. */
19254 it
.paragraph_embedding
= L2R
;
19256 record_unwind_protect (unwind_format_mode_line
,
19257 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19259 mode_line_target
= MODE_LINE_DISPLAY
;
19261 /* Temporarily make frame's keyboard the current kboard so that
19262 kboard-local variables in the mode_line_format will get the right
19264 push_kboard (FRAME_KBOARD (it
.f
));
19265 record_unwind_save_match_data ();
19266 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19269 unbind_to (count
, Qnil
);
19271 /* Fill up with spaces. */
19272 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19274 compute_line_metrics (&it
);
19275 it
.glyph_row
->full_width_p
= 1;
19276 it
.glyph_row
->continued_p
= 0;
19277 it
.glyph_row
->truncated_on_left_p
= 0;
19278 it
.glyph_row
->truncated_on_right_p
= 0;
19280 /* Make a 3D mode-line have a shadow at its right end. */
19281 face
= FACE_FROM_ID (it
.f
, face_id
);
19282 extend_face_to_end_of_line (&it
);
19283 if (face
->box
!= FACE_NO_BOX
)
19285 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19286 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19287 last
->right_box_line_p
= 1;
19290 return it
.glyph_row
->height
;
19293 /* Move element ELT in LIST to the front of LIST.
19294 Return the updated list. */
19297 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19299 register Lisp_Object tail
, prev
;
19300 register Lisp_Object tem
;
19304 while (CONSP (tail
))
19310 /* Splice out the link TAIL. */
19312 list
= XCDR (tail
);
19314 Fsetcdr (prev
, XCDR (tail
));
19316 /* Now make it the first. */
19317 Fsetcdr (tail
, list
);
19322 tail
= XCDR (tail
);
19326 /* Not found--return unchanged LIST. */
19330 /* Contribute ELT to the mode line for window IT->w. How it
19331 translates into text depends on its data type.
19333 IT describes the display environment in which we display, as usual.
19335 DEPTH is the depth in recursion. It is used to prevent
19336 infinite recursion here.
19338 FIELD_WIDTH is the number of characters the display of ELT should
19339 occupy in the mode line, and PRECISION is the maximum number of
19340 characters to display from ELT's representation. See
19341 display_string for details.
19343 Returns the hpos of the end of the text generated by ELT.
19345 PROPS is a property list to add to any string we encounter.
19347 If RISKY is nonzero, remove (disregard) any properties in any string
19348 we encounter, and ignore :eval and :propertize.
19350 The global variable `mode_line_target' determines whether the
19351 output is passed to `store_mode_line_noprop',
19352 `store_mode_line_string', or `display_string'. */
19355 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19356 Lisp_Object elt
, Lisp_Object props
, int risky
)
19358 int n
= 0, field
, prec
;
19363 elt
= build_string ("*too-deep*");
19367 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19371 /* A string: output it and check for %-constructs within it. */
19373 EMACS_INT offset
= 0;
19375 if (SCHARS (elt
) > 0
19376 && (!NILP (props
) || risky
))
19378 Lisp_Object oprops
, aelt
;
19379 oprops
= Ftext_properties_at (make_number (0), elt
);
19381 /* If the starting string's properties are not what
19382 we want, translate the string. Also, if the string
19383 is risky, do that anyway. */
19385 if (NILP (Fequal (props
, oprops
)) || risky
)
19387 /* If the starting string has properties,
19388 merge the specified ones onto the existing ones. */
19389 if (! NILP (oprops
) && !risky
)
19393 oprops
= Fcopy_sequence (oprops
);
19395 while (CONSP (tem
))
19397 oprops
= Fplist_put (oprops
, XCAR (tem
),
19398 XCAR (XCDR (tem
)));
19399 tem
= XCDR (XCDR (tem
));
19404 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19405 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19407 /* AELT is what we want. Move it to the front
19408 without consing. */
19410 mode_line_proptrans_alist
19411 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19417 /* If AELT has the wrong props, it is useless.
19418 so get rid of it. */
19420 mode_line_proptrans_alist
19421 = Fdelq (aelt
, mode_line_proptrans_alist
);
19423 elt
= Fcopy_sequence (elt
);
19424 Fset_text_properties (make_number (0), Flength (elt
),
19426 /* Add this item to mode_line_proptrans_alist. */
19427 mode_line_proptrans_alist
19428 = Fcons (Fcons (elt
, props
),
19429 mode_line_proptrans_alist
);
19430 /* Truncate mode_line_proptrans_alist
19431 to at most 50 elements. */
19432 tem
= Fnthcdr (make_number (50),
19433 mode_line_proptrans_alist
);
19435 XSETCDR (tem
, Qnil
);
19444 prec
= precision
- n
;
19445 switch (mode_line_target
)
19447 case MODE_LINE_NOPROP
:
19448 case MODE_LINE_TITLE
:
19449 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19451 case MODE_LINE_STRING
:
19452 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19454 case MODE_LINE_DISPLAY
:
19455 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19456 0, prec
, 0, STRING_MULTIBYTE (elt
));
19463 /* Handle the non-literal case. */
19465 while ((precision
<= 0 || n
< precision
)
19466 && SREF (elt
, offset
) != 0
19467 && (mode_line_target
!= MODE_LINE_DISPLAY
19468 || it
->current_x
< it
->last_visible_x
))
19470 EMACS_INT last_offset
= offset
;
19472 /* Advance to end of string or next format specifier. */
19473 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19476 if (offset
- 1 != last_offset
)
19478 EMACS_INT nchars
, nbytes
;
19480 /* Output to end of string or up to '%'. Field width
19481 is length of string. Don't output more than
19482 PRECISION allows us. */
19485 prec
= c_string_width (SDATA (elt
) + last_offset
,
19486 offset
- last_offset
, precision
- n
,
19489 switch (mode_line_target
)
19491 case MODE_LINE_NOPROP
:
19492 case MODE_LINE_TITLE
:
19493 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19495 case MODE_LINE_STRING
:
19497 EMACS_INT bytepos
= last_offset
;
19498 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19499 EMACS_INT endpos
= (precision
<= 0
19500 ? string_byte_to_char (elt
, offset
)
19501 : charpos
+ nchars
);
19503 n
+= store_mode_line_string (NULL
,
19504 Fsubstring (elt
, make_number (charpos
),
19505 make_number (endpos
)),
19509 case MODE_LINE_DISPLAY
:
19511 EMACS_INT bytepos
= last_offset
;
19512 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19514 if (precision
<= 0)
19515 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19516 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19518 STRING_MULTIBYTE (elt
));
19523 else /* c == '%' */
19525 EMACS_INT percent_position
= offset
;
19527 /* Get the specified minimum width. Zero means
19530 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19531 field
= field
* 10 + c
- '0';
19533 /* Don't pad beyond the total padding allowed. */
19534 if (field_width
- n
> 0 && field
> field_width
- n
)
19535 field
= field_width
- n
;
19537 /* Note that either PRECISION <= 0 or N < PRECISION. */
19538 prec
= precision
- n
;
19541 n
+= display_mode_element (it
, depth
, field
, prec
,
19542 Vglobal_mode_string
, props
,
19547 EMACS_INT bytepos
, charpos
;
19549 Lisp_Object string
;
19551 bytepos
= percent_position
;
19552 charpos
= (STRING_MULTIBYTE (elt
)
19553 ? string_byte_to_char (elt
, bytepos
)
19555 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19556 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19558 switch (mode_line_target
)
19560 case MODE_LINE_NOPROP
:
19561 case MODE_LINE_TITLE
:
19562 n
+= store_mode_line_noprop (spec
, field
, prec
);
19564 case MODE_LINE_STRING
:
19566 Lisp_Object tem
= build_string (spec
);
19567 props
= Ftext_properties_at (make_number (charpos
), elt
);
19568 /* Should only keep face property in props */
19569 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19572 case MODE_LINE_DISPLAY
:
19574 int nglyphs_before
, nwritten
;
19576 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19577 nwritten
= display_string (spec
, string
, elt
,
19582 /* Assign to the glyphs written above the
19583 string where the `%x' came from, position
19587 struct glyph
*glyph
19588 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19592 for (i
= 0; i
< nwritten
; ++i
)
19594 glyph
[i
].object
= elt
;
19595 glyph
[i
].charpos
= charpos
;
19612 /* A symbol: process the value of the symbol recursively
19613 as if it appeared here directly. Avoid error if symbol void.
19614 Special case: if value of symbol is a string, output the string
19617 register Lisp_Object tem
;
19619 /* If the variable is not marked as risky to set
19620 then its contents are risky to use. */
19621 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19624 tem
= Fboundp (elt
);
19627 tem
= Fsymbol_value (elt
);
19628 /* If value is a string, output that string literally:
19629 don't check for % within it. */
19633 if (!EQ (tem
, elt
))
19635 /* Give up right away for nil or t. */
19645 register Lisp_Object car
, tem
;
19647 /* A cons cell: five distinct cases.
19648 If first element is :eval or :propertize, do something special.
19649 If first element is a string or a cons, process all the elements
19650 and effectively concatenate them.
19651 If first element is a negative number, truncate displaying cdr to
19652 at most that many characters. If positive, pad (with spaces)
19653 to at least that many characters.
19654 If first element is a symbol, process the cadr or caddr recursively
19655 according to whether the symbol's value is non-nil or nil. */
19657 if (EQ (car
, QCeval
))
19659 /* An element of the form (:eval FORM) means evaluate FORM
19660 and use the result as mode line elements. */
19665 if (CONSP (XCDR (elt
)))
19668 spec
= safe_eval (XCAR (XCDR (elt
)));
19669 n
+= display_mode_element (it
, depth
, field_width
- n
,
19670 precision
- n
, spec
, props
,
19674 else if (EQ (car
, QCpropertize
))
19676 /* An element of the form (:propertize ELT PROPS...)
19677 means display ELT but applying properties PROPS. */
19682 if (CONSP (XCDR (elt
)))
19683 n
+= display_mode_element (it
, depth
, field_width
- n
,
19684 precision
- n
, XCAR (XCDR (elt
)),
19685 XCDR (XCDR (elt
)), risky
);
19687 else if (SYMBOLP (car
))
19689 tem
= Fboundp (car
);
19693 /* elt is now the cdr, and we know it is a cons cell.
19694 Use its car if CAR has a non-nil value. */
19697 tem
= Fsymbol_value (car
);
19704 /* Symbol's value is nil (or symbol is unbound)
19705 Get the cddr of the original list
19706 and if possible find the caddr and use that. */
19710 else if (!CONSP (elt
))
19715 else if (INTEGERP (car
))
19717 register int lim
= XINT (car
);
19721 /* Negative int means reduce maximum width. */
19722 if (precision
<= 0)
19725 precision
= min (precision
, -lim
);
19729 /* Padding specified. Don't let it be more than
19730 current maximum. */
19732 lim
= min (precision
, lim
);
19734 /* If that's more padding than already wanted, queue it.
19735 But don't reduce padding already specified even if
19736 that is beyond the current truncation point. */
19737 field_width
= max (lim
, field_width
);
19741 else if (STRINGP (car
) || CONSP (car
))
19743 Lisp_Object halftail
= elt
;
19747 && (precision
<= 0 || n
< precision
))
19749 n
+= display_mode_element (it
, depth
,
19750 /* Do padding only after the last
19751 element in the list. */
19752 (! CONSP (XCDR (elt
))
19755 precision
- n
, XCAR (elt
),
19759 if ((len
& 1) == 0)
19760 halftail
= XCDR (halftail
);
19761 /* Check for cycle. */
19762 if (EQ (halftail
, elt
))
19771 elt
= build_string ("*invalid*");
19775 /* Pad to FIELD_WIDTH. */
19776 if (field_width
> 0 && n
< field_width
)
19778 switch (mode_line_target
)
19780 case MODE_LINE_NOPROP
:
19781 case MODE_LINE_TITLE
:
19782 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19784 case MODE_LINE_STRING
:
19785 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19787 case MODE_LINE_DISPLAY
:
19788 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19797 /* Store a mode-line string element in mode_line_string_list.
19799 If STRING is non-null, display that C string. Otherwise, the Lisp
19800 string LISP_STRING is displayed.
19802 FIELD_WIDTH is the minimum number of output glyphs to produce.
19803 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19804 with spaces. FIELD_WIDTH <= 0 means don't pad.
19806 PRECISION is the maximum number of characters to output from
19807 STRING. PRECISION <= 0 means don't truncate the string.
19809 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19810 properties to the string.
19812 PROPS are the properties to add to the string.
19813 The mode_line_string_face face property is always added to the string.
19817 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19818 int field_width
, int precision
, Lisp_Object props
)
19823 if (string
!= NULL
)
19825 len
= strlen (string
);
19826 if (precision
> 0 && len
> precision
)
19828 lisp_string
= make_string (string
, len
);
19830 props
= mode_line_string_face_prop
;
19831 else if (!NILP (mode_line_string_face
))
19833 Lisp_Object face
= Fplist_get (props
, Qface
);
19834 props
= Fcopy_sequence (props
);
19836 face
= mode_line_string_face
;
19838 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19839 props
= Fplist_put (props
, Qface
, face
);
19841 Fadd_text_properties (make_number (0), make_number (len
),
19842 props
, lisp_string
);
19846 len
= XFASTINT (Flength (lisp_string
));
19847 if (precision
> 0 && len
> precision
)
19850 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19853 if (!NILP (mode_line_string_face
))
19857 props
= Ftext_properties_at (make_number (0), lisp_string
);
19858 face
= Fplist_get (props
, Qface
);
19860 face
= mode_line_string_face
;
19862 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19863 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19865 lisp_string
= Fcopy_sequence (lisp_string
);
19868 Fadd_text_properties (make_number (0), make_number (len
),
19869 props
, lisp_string
);
19874 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19878 if (field_width
> len
)
19880 field_width
-= len
;
19881 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19883 Fadd_text_properties (make_number (0), make_number (field_width
),
19884 props
, lisp_string
);
19885 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19893 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19895 doc
: /* Format a string out of a mode line format specification.
19896 First arg FORMAT specifies the mode line format (see `mode-line-format'
19897 for details) to use.
19899 By default, the format is evaluated for the currently selected window.
19901 Optional second arg FACE specifies the face property to put on all
19902 characters for which no face is specified. The value nil means the
19903 default face. The value t means whatever face the window's mode line
19904 currently uses (either `mode-line' or `mode-line-inactive',
19905 depending on whether the window is the selected window or not).
19906 An integer value means the value string has no text
19909 Optional third and fourth args WINDOW and BUFFER specify the window
19910 and buffer to use as the context for the formatting (defaults
19911 are the selected window and the WINDOW's buffer). */)
19912 (Lisp_Object format
, Lisp_Object face
,
19913 Lisp_Object window
, Lisp_Object buffer
)
19918 struct buffer
*old_buffer
= NULL
;
19920 int no_props
= INTEGERP (face
);
19921 int count
= SPECPDL_INDEX ();
19923 int string_start
= 0;
19926 window
= selected_window
;
19927 CHECK_WINDOW (window
);
19928 w
= XWINDOW (window
);
19931 buffer
= w
->buffer
;
19932 CHECK_BUFFER (buffer
);
19934 /* Make formatting the modeline a non-op when noninteractive, otherwise
19935 there will be problems later caused by a partially initialized frame. */
19936 if (NILP (format
) || noninteractive
)
19937 return empty_unibyte_string
;
19942 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19943 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19944 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19945 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19946 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19947 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19948 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19951 if (XBUFFER (buffer
) != current_buffer
)
19952 old_buffer
= current_buffer
;
19954 /* Save things including mode_line_proptrans_alist,
19955 and set that to nil so that we don't alter the outer value. */
19956 record_unwind_protect (unwind_format_mode_line
,
19957 format_mode_line_unwind_data
19958 (old_buffer
, selected_window
, 1));
19959 mode_line_proptrans_alist
= Qnil
;
19961 Fselect_window (window
, Qt
);
19963 set_buffer_internal_1 (XBUFFER (buffer
));
19965 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19969 mode_line_target
= MODE_LINE_NOPROP
;
19970 mode_line_string_face_prop
= Qnil
;
19971 mode_line_string_list
= Qnil
;
19972 string_start
= MODE_LINE_NOPROP_LEN (0);
19976 mode_line_target
= MODE_LINE_STRING
;
19977 mode_line_string_list
= Qnil
;
19978 mode_line_string_face
= face
;
19979 mode_line_string_face_prop
19980 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19983 push_kboard (FRAME_KBOARD (it
.f
));
19984 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19989 len
= MODE_LINE_NOPROP_LEN (string_start
);
19990 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19994 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19995 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19996 empty_unibyte_string
);
19999 unbind_to (count
, Qnil
);
20003 /* Write a null-terminated, right justified decimal representation of
20004 the positive integer D to BUF using a minimal field width WIDTH. */
20007 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20009 register char *p
= buf
;
20017 *p
++ = d
% 10 + '0';
20022 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20033 /* Write a null-terminated, right justified decimal and "human
20034 readable" representation of the nonnegative integer D to BUF using
20035 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20037 static const char power_letter
[] =
20051 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20053 /* We aim to represent the nonnegative integer D as
20054 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20055 EMACS_INT quotient
= d
;
20057 /* -1 means: do not use TENTHS. */
20061 /* Length of QUOTIENT.TENTHS as a string. */
20067 if (1000 <= quotient
)
20069 /* Scale to the appropriate EXPONENT. */
20072 remainder
= quotient
% 1000;
20076 while (1000 <= quotient
);
20078 /* Round to nearest and decide whether to use TENTHS or not. */
20081 tenths
= remainder
/ 100;
20082 if (50 <= remainder
% 100)
20089 if (quotient
== 10)
20097 if (500 <= remainder
)
20099 if (quotient
< 999)
20110 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20111 if (tenths
== -1 && quotient
<= 99)
20118 p
= psuffix
= buf
+ max (width
, length
);
20120 /* Print EXPONENT. */
20121 *psuffix
++ = power_letter
[exponent
];
20124 /* Print TENTHS. */
20127 *--p
= '0' + tenths
;
20131 /* Print QUOTIENT. */
20134 int digit
= quotient
% 10;
20135 *--p
= '0' + digit
;
20137 while ((quotient
/= 10) != 0);
20139 /* Print leading spaces. */
20144 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20145 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20146 type of CODING_SYSTEM. Return updated pointer into BUF. */
20148 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20151 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20154 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20155 const unsigned char *eol_str
;
20157 /* The EOL conversion we are using. */
20158 Lisp_Object eoltype
;
20160 val
= CODING_SYSTEM_SPEC (coding_system
);
20163 if (!VECTORP (val
)) /* Not yet decided. */
20168 eoltype
= eol_mnemonic_undecided
;
20169 /* Don't mention EOL conversion if it isn't decided. */
20174 Lisp_Object eolvalue
;
20176 attrs
= AREF (val
, 0);
20177 eolvalue
= AREF (val
, 2);
20180 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20184 /* The EOL conversion that is normal on this system. */
20186 if (NILP (eolvalue
)) /* Not yet decided. */
20187 eoltype
= eol_mnemonic_undecided
;
20188 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20189 eoltype
= eol_mnemonic_undecided
;
20190 else /* eolvalue is Qunix, Qdos, or Qmac. */
20191 eoltype
= (EQ (eolvalue
, Qunix
)
20192 ? eol_mnemonic_unix
20193 : (EQ (eolvalue
, Qdos
) == 1
20194 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20200 /* Mention the EOL conversion if it is not the usual one. */
20201 if (STRINGP (eoltype
))
20203 eol_str
= SDATA (eoltype
);
20204 eol_str_len
= SBYTES (eoltype
);
20206 else if (CHARACTERP (eoltype
))
20208 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20209 int c
= XFASTINT (eoltype
);
20210 eol_str_len
= CHAR_STRING (c
, tmp
);
20215 eol_str
= invalid_eol_type
;
20216 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20218 memcpy (buf
, eol_str
, eol_str_len
);
20219 buf
+= eol_str_len
;
20225 /* Return a string for the output of a mode line %-spec for window W,
20226 generated by character C. FIELD_WIDTH > 0 means pad the string
20227 returned with spaces to that value. Return a Lisp string in
20228 *STRING if the resulting string is taken from that Lisp string.
20230 Note we operate on the current buffer for most purposes,
20231 the exception being w->base_line_pos. */
20233 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20235 static const char *
20236 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20237 Lisp_Object
*string
)
20240 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20241 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20242 struct buffer
*b
= current_buffer
;
20250 if (!NILP (BVAR (b
, read_only
)))
20252 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20257 /* This differs from %* only for a modified read-only buffer. */
20258 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20260 if (!NILP (BVAR (b
, read_only
)))
20265 /* This differs from %* in ignoring read-only-ness. */
20266 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20278 if (command_loop_level
> 5)
20280 p
= decode_mode_spec_buf
;
20281 for (i
= 0; i
< command_loop_level
; i
++)
20284 return decode_mode_spec_buf
;
20292 if (command_loop_level
> 5)
20294 p
= decode_mode_spec_buf
;
20295 for (i
= 0; i
< command_loop_level
; i
++)
20298 return decode_mode_spec_buf
;
20305 /* Let lots_of_dashes be a string of infinite length. */
20306 if (mode_line_target
== MODE_LINE_NOPROP
||
20307 mode_line_target
== MODE_LINE_STRING
)
20309 if (field_width
<= 0
20310 || field_width
> sizeof (lots_of_dashes
))
20312 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20313 decode_mode_spec_buf
[i
] = '-';
20314 decode_mode_spec_buf
[i
] = '\0';
20315 return decode_mode_spec_buf
;
20318 return lots_of_dashes
;
20322 obj
= BVAR (b
, name
);
20326 /* %c and %l are ignored in `frame-title-format'.
20327 (In redisplay_internal, the frame title is drawn _before_ the
20328 windows are updated, so the stuff which depends on actual
20329 window contents (such as %l) may fail to render properly, or
20330 even crash emacs.) */
20331 if (mode_line_target
== MODE_LINE_TITLE
)
20335 EMACS_INT col
= current_column ();
20336 w
->column_number_displayed
= make_number (col
);
20337 pint2str (decode_mode_spec_buf
, field_width
, col
);
20338 return decode_mode_spec_buf
;
20342 #ifndef SYSTEM_MALLOC
20344 if (NILP (Vmemory_full
))
20347 return "!MEM FULL! ";
20354 /* %F displays the frame name. */
20355 if (!NILP (f
->title
))
20356 return SSDATA (f
->title
);
20357 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20358 return SSDATA (f
->name
);
20362 obj
= BVAR (b
, filename
);
20367 EMACS_INT size
= ZV
- BEGV
;
20368 pint2str (decode_mode_spec_buf
, field_width
, size
);
20369 return decode_mode_spec_buf
;
20374 EMACS_INT size
= ZV
- BEGV
;
20375 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20376 return decode_mode_spec_buf
;
20381 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20382 EMACS_INT topline
, nlines
, height
;
20385 /* %c and %l are ignored in `frame-title-format'. */
20386 if (mode_line_target
== MODE_LINE_TITLE
)
20389 startpos
= XMARKER (w
->start
)->charpos
;
20390 startpos_byte
= marker_byte_position (w
->start
);
20391 height
= WINDOW_TOTAL_LINES (w
);
20393 /* If we decided that this buffer isn't suitable for line numbers,
20394 don't forget that too fast. */
20395 if (EQ (w
->base_line_pos
, w
->buffer
))
20397 /* But do forget it, if the window shows a different buffer now. */
20398 else if (BUFFERP (w
->base_line_pos
))
20399 w
->base_line_pos
= Qnil
;
20401 /* If the buffer is very big, don't waste time. */
20402 if (INTEGERP (Vline_number_display_limit
)
20403 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20405 w
->base_line_pos
= Qnil
;
20406 w
->base_line_number
= Qnil
;
20410 if (INTEGERP (w
->base_line_number
)
20411 && INTEGERP (w
->base_line_pos
)
20412 && XFASTINT (w
->base_line_pos
) <= startpos
)
20414 line
= XFASTINT (w
->base_line_number
);
20415 linepos
= XFASTINT (w
->base_line_pos
);
20416 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20421 linepos
= BUF_BEGV (b
);
20422 linepos_byte
= BUF_BEGV_BYTE (b
);
20425 /* Count lines from base line to window start position. */
20426 nlines
= display_count_lines (linepos_byte
,
20430 topline
= nlines
+ line
;
20432 /* Determine a new base line, if the old one is too close
20433 or too far away, or if we did not have one.
20434 "Too close" means it's plausible a scroll-down would
20435 go back past it. */
20436 if (startpos
== BUF_BEGV (b
))
20438 w
->base_line_number
= make_number (topline
);
20439 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20441 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20442 || linepos
== BUF_BEGV (b
))
20444 EMACS_INT limit
= BUF_BEGV (b
);
20445 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20446 EMACS_INT position
;
20447 EMACS_INT distance
=
20448 (height
* 2 + 30) * line_number_display_limit_width
;
20450 if (startpos
- distance
> limit
)
20452 limit
= startpos
- distance
;
20453 limit_byte
= CHAR_TO_BYTE (limit
);
20456 nlines
= display_count_lines (startpos_byte
,
20458 - (height
* 2 + 30),
20460 /* If we couldn't find the lines we wanted within
20461 line_number_display_limit_width chars per line,
20462 give up on line numbers for this window. */
20463 if (position
== limit_byte
&& limit
== startpos
- distance
)
20465 w
->base_line_pos
= w
->buffer
;
20466 w
->base_line_number
= Qnil
;
20470 w
->base_line_number
= make_number (topline
- nlines
);
20471 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20474 /* Now count lines from the start pos to point. */
20475 nlines
= display_count_lines (startpos_byte
,
20476 PT_BYTE
, PT
, &junk
);
20478 /* Record that we did display the line number. */
20479 line_number_displayed
= 1;
20481 /* Make the string to show. */
20482 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20483 return decode_mode_spec_buf
;
20486 char* p
= decode_mode_spec_buf
;
20487 int pad
= field_width
- 2;
20493 return decode_mode_spec_buf
;
20499 obj
= BVAR (b
, mode_name
);
20503 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20509 EMACS_INT pos
= marker_position (w
->start
);
20510 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20512 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20514 if (pos
<= BUF_BEGV (b
))
20519 else if (pos
<= BUF_BEGV (b
))
20523 if (total
> 1000000)
20524 /* Do it differently for a large value, to avoid overflow. */
20525 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20527 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20528 /* We can't normally display a 3-digit number,
20529 so get us a 2-digit number that is close. */
20532 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20533 return decode_mode_spec_buf
;
20537 /* Display percentage of size above the bottom of the screen. */
20540 EMACS_INT toppos
= marker_position (w
->start
);
20541 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20542 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20544 if (botpos
>= BUF_ZV (b
))
20546 if (toppos
<= BUF_BEGV (b
))
20553 if (total
> 1000000)
20554 /* Do it differently for a large value, to avoid overflow. */
20555 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20557 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20558 /* We can't normally display a 3-digit number,
20559 so get us a 2-digit number that is close. */
20562 if (toppos
<= BUF_BEGV (b
))
20563 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20565 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20566 return decode_mode_spec_buf
;
20571 /* status of process */
20572 obj
= Fget_buffer_process (Fcurrent_buffer ());
20574 return "no process";
20576 obj
= Fsymbol_name (Fprocess_status (obj
));
20582 int count
= inhibit_garbage_collection ();
20583 Lisp_Object val
= call1 (intern ("file-remote-p"),
20584 BVAR (current_buffer
, directory
));
20585 unbind_to (count
, Qnil
);
20593 case 't': /* indicate TEXT or BINARY */
20597 /* coding-system (not including end-of-line format) */
20599 /* coding-system (including end-of-line type) */
20601 int eol_flag
= (c
== 'Z');
20602 char *p
= decode_mode_spec_buf
;
20604 if (! FRAME_WINDOW_P (f
))
20606 /* No need to mention EOL here--the terminal never needs
20607 to do EOL conversion. */
20608 p
= decode_mode_spec_coding (CODING_ID_NAME
20609 (FRAME_KEYBOARD_CODING (f
)->id
),
20611 p
= decode_mode_spec_coding (CODING_ID_NAME
20612 (FRAME_TERMINAL_CODING (f
)->id
),
20615 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20618 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20619 #ifdef subprocesses
20620 obj
= Fget_buffer_process (Fcurrent_buffer ());
20621 if (PROCESSP (obj
))
20623 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20625 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20628 #endif /* subprocesses */
20631 return decode_mode_spec_buf
;
20638 return SSDATA (obj
);
20645 /* Count up to COUNT lines starting from START_BYTE.
20646 But don't go beyond LIMIT_BYTE.
20647 Return the number of lines thus found (always nonnegative).
20649 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20652 display_count_lines (EMACS_INT start_byte
,
20653 EMACS_INT limit_byte
, EMACS_INT count
,
20654 EMACS_INT
*byte_pos_ptr
)
20656 register unsigned char *cursor
;
20657 unsigned char *base
;
20659 register EMACS_INT ceiling
;
20660 register unsigned char *ceiling_addr
;
20661 EMACS_INT orig_count
= count
;
20663 /* If we are not in selective display mode,
20664 check only for newlines. */
20665 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20666 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20670 while (start_byte
< limit_byte
)
20672 ceiling
= BUFFER_CEILING_OF (start_byte
);
20673 ceiling
= min (limit_byte
- 1, ceiling
);
20674 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20675 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20678 if (selective_display
)
20679 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20682 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20685 if (cursor
!= ceiling_addr
)
20689 start_byte
+= cursor
- base
+ 1;
20690 *byte_pos_ptr
= start_byte
;
20694 if (++cursor
== ceiling_addr
)
20700 start_byte
+= cursor
- base
;
20705 while (start_byte
> limit_byte
)
20707 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20708 ceiling
= max (limit_byte
, ceiling
);
20709 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20710 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20713 if (selective_display
)
20714 while (--cursor
!= ceiling_addr
20715 && *cursor
!= '\n' && *cursor
!= 015)
20718 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20721 if (cursor
!= ceiling_addr
)
20725 start_byte
+= cursor
- base
+ 1;
20726 *byte_pos_ptr
= start_byte
;
20727 /* When scanning backwards, we should
20728 not count the newline posterior to which we stop. */
20729 return - orig_count
- 1;
20735 /* Here we add 1 to compensate for the last decrement
20736 of CURSOR, which took it past the valid range. */
20737 start_byte
+= cursor
- base
+ 1;
20741 *byte_pos_ptr
= limit_byte
;
20744 return - orig_count
+ count
;
20745 return orig_count
- count
;
20751 /***********************************************************************
20753 ***********************************************************************/
20755 /* Display a NUL-terminated string, starting with index START.
20757 If STRING is non-null, display that C string. Otherwise, the Lisp
20758 string LISP_STRING is displayed. There's a case that STRING is
20759 non-null and LISP_STRING is not nil. It means STRING is a string
20760 data of LISP_STRING. In that case, we display LISP_STRING while
20761 ignoring its text properties.
20763 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20764 FACE_STRING. Display STRING or LISP_STRING with the face at
20765 FACE_STRING_POS in FACE_STRING:
20767 Display the string in the environment given by IT, but use the
20768 standard display table, temporarily.
20770 FIELD_WIDTH is the minimum number of output glyphs to produce.
20771 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20772 with spaces. If STRING has more characters, more than FIELD_WIDTH
20773 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20775 PRECISION is the maximum number of characters to output from
20776 STRING. PRECISION < 0 means don't truncate the string.
20778 This is roughly equivalent to printf format specifiers:
20780 FIELD_WIDTH PRECISION PRINTF
20781 ----------------------------------------
20787 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20788 display them, and < 0 means obey the current buffer's value of
20789 enable_multibyte_characters.
20791 Value is the number of columns displayed. */
20794 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20795 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20796 int field_width
, int precision
, int max_x
, int multibyte
)
20798 int hpos_at_start
= it
->hpos
;
20799 int saved_face_id
= it
->face_id
;
20800 struct glyph_row
*row
= it
->glyph_row
;
20801 EMACS_INT it_charpos
;
20803 /* Initialize the iterator IT for iteration over STRING beginning
20804 with index START. */
20805 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20806 precision
, field_width
, multibyte
);
20807 if (string
&& STRINGP (lisp_string
))
20808 /* LISP_STRING is the one returned by decode_mode_spec. We should
20809 ignore its text properties. */
20810 it
->stop_charpos
= it
->end_charpos
;
20812 /* If displaying STRING, set up the face of the iterator from
20813 FACE_STRING, if that's given. */
20814 if (STRINGP (face_string
))
20820 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20821 0, it
->region_beg_charpos
,
20822 it
->region_end_charpos
,
20823 &endptr
, it
->base_face_id
, 0);
20824 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20825 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20828 /* Set max_x to the maximum allowed X position. Don't let it go
20829 beyond the right edge of the window. */
20831 max_x
= it
->last_visible_x
;
20833 max_x
= min (max_x
, it
->last_visible_x
);
20835 /* Skip over display elements that are not visible. because IT->w is
20837 if (it
->current_x
< it
->first_visible_x
)
20838 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20839 MOVE_TO_POS
| MOVE_TO_X
);
20841 row
->ascent
= it
->max_ascent
;
20842 row
->height
= it
->max_ascent
+ it
->max_descent
;
20843 row
->phys_ascent
= it
->max_phys_ascent
;
20844 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20845 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20847 if (STRINGP (it
->string
))
20848 it_charpos
= IT_STRING_CHARPOS (*it
);
20850 it_charpos
= IT_CHARPOS (*it
);
20852 /* This condition is for the case that we are called with current_x
20853 past last_visible_x. */
20854 while (it
->current_x
< max_x
)
20856 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20858 /* Get the next display element. */
20859 if (!get_next_display_element (it
))
20862 /* Produce glyphs. */
20863 x_before
= it
->current_x
;
20864 n_glyphs_before
= row
->used
[TEXT_AREA
];
20865 PRODUCE_GLYPHS (it
);
20867 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20870 while (i
< nglyphs
)
20872 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20874 if (it
->line_wrap
!= TRUNCATE
20875 && x
+ glyph
->pixel_width
> max_x
)
20877 /* End of continued line or max_x reached. */
20878 if (CHAR_GLYPH_PADDING_P (*glyph
))
20880 /* A wide character is unbreakable. */
20881 if (row
->reversed_p
)
20882 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20883 - n_glyphs_before
);
20884 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20885 it
->current_x
= x_before
;
20889 if (row
->reversed_p
)
20890 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20891 - (n_glyphs_before
+ i
));
20892 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20897 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20899 /* Glyph is at least partially visible. */
20901 if (x
< it
->first_visible_x
)
20902 row
->x
= x
- it
->first_visible_x
;
20906 /* Glyph is off the left margin of the display area.
20907 Should not happen. */
20911 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20912 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20913 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20914 row
->phys_height
= max (row
->phys_height
,
20915 it
->max_phys_ascent
+ it
->max_phys_descent
);
20916 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20917 it
->max_extra_line_spacing
);
20918 x
+= glyph
->pixel_width
;
20922 /* Stop if max_x reached. */
20926 /* Stop at line ends. */
20927 if (ITERATOR_AT_END_OF_LINE_P (it
))
20929 it
->continuation_lines_width
= 0;
20933 set_iterator_to_next (it
, 1);
20934 if (STRINGP (it
->string
))
20935 it_charpos
= IT_STRING_CHARPOS (*it
);
20937 it_charpos
= IT_CHARPOS (*it
);
20939 /* Stop if truncating at the right edge. */
20940 if (it
->line_wrap
== TRUNCATE
20941 && it
->current_x
>= it
->last_visible_x
)
20943 /* Add truncation mark, but don't do it if the line is
20944 truncated at a padding space. */
20945 if (it_charpos
< it
->string_nchars
)
20947 if (!FRAME_WINDOW_P (it
->f
))
20951 if (it
->current_x
> it
->last_visible_x
)
20953 if (!row
->reversed_p
)
20955 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20956 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20961 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
20962 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20964 unproduce_glyphs (it
, ii
+ 1);
20965 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
20967 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20969 row
->used
[TEXT_AREA
] = ii
;
20970 produce_special_glyphs (it
, IT_TRUNCATION
);
20973 produce_special_glyphs (it
, IT_TRUNCATION
);
20975 row
->truncated_on_right_p
= 1;
20981 /* Maybe insert a truncation at the left. */
20982 if (it
->first_visible_x
20985 if (!FRAME_WINDOW_P (it
->f
))
20986 insert_left_trunc_glyphs (it
);
20987 row
->truncated_on_left_p
= 1;
20990 it
->face_id
= saved_face_id
;
20992 /* Value is number of columns displayed. */
20993 return it
->hpos
- hpos_at_start
;
20998 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20999 appears as an element of LIST or as the car of an element of LIST.
21000 If PROPVAL is a list, compare each element against LIST in that
21001 way, and return 1/2 if any element of PROPVAL is found in LIST.
21002 Otherwise return 0. This function cannot quit.
21003 The return value is 2 if the text is invisible but with an ellipsis
21004 and 1 if it's invisible and without an ellipsis. */
21007 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21009 register Lisp_Object tail
, proptail
;
21011 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21013 register Lisp_Object tem
;
21015 if (EQ (propval
, tem
))
21017 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21018 return NILP (XCDR (tem
)) ? 1 : 2;
21021 if (CONSP (propval
))
21023 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21025 Lisp_Object propelt
;
21026 propelt
= XCAR (proptail
);
21027 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21029 register Lisp_Object tem
;
21031 if (EQ (propelt
, tem
))
21033 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21034 return NILP (XCDR (tem
)) ? 1 : 2;
21042 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21043 doc
: /* Non-nil if the property makes the text invisible.
21044 POS-OR-PROP can be a marker or number, in which case it is taken to be
21045 a position in the current buffer and the value of the `invisible' property
21046 is checked; or it can be some other value, which is then presumed to be the
21047 value of the `invisible' property of the text of interest.
21048 The non-nil value returned can be t for truly invisible text or something
21049 else if the text is replaced by an ellipsis. */)
21050 (Lisp_Object pos_or_prop
)
21053 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21054 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21056 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21057 return (invis
== 0 ? Qnil
21059 : make_number (invis
));
21062 /* Calculate a width or height in pixels from a specification using
21063 the following elements:
21066 NUM - a (fractional) multiple of the default font width/height
21067 (NUM) - specifies exactly NUM pixels
21068 UNIT - a fixed number of pixels, see below.
21069 ELEMENT - size of a display element in pixels, see below.
21070 (NUM . SPEC) - equals NUM * SPEC
21071 (+ SPEC SPEC ...) - add pixel values
21072 (- SPEC SPEC ...) - subtract pixel values
21073 (- SPEC) - negate pixel value
21076 INT or FLOAT - a number constant
21077 SYMBOL - use symbol's (buffer local) variable binding.
21080 in - pixels per inch *)
21081 mm - pixels per 1/1000 meter *)
21082 cm - pixels per 1/100 meter *)
21083 width - width of current font in pixels.
21084 height - height of current font in pixels.
21086 *) using the ratio(s) defined in display-pixels-per-inch.
21090 left-fringe - left fringe width in pixels
21091 right-fringe - right fringe width in pixels
21093 left-margin - left margin width in pixels
21094 right-margin - right margin width in pixels
21096 scroll-bar - scroll-bar area width in pixels
21100 Pixels corresponding to 5 inches:
21103 Total width of non-text areas on left side of window (if scroll-bar is on left):
21104 '(space :width (+ left-fringe left-margin scroll-bar))
21106 Align to first text column (in header line):
21107 '(space :align-to 0)
21109 Align to middle of text area minus half the width of variable `my-image'
21110 containing a loaded image:
21111 '(space :align-to (0.5 . (- text my-image)))
21113 Width of left margin minus width of 1 character in the default font:
21114 '(space :width (- left-margin 1))
21116 Width of left margin minus width of 2 characters in the current font:
21117 '(space :width (- left-margin (2 . width)))
21119 Center 1 character over left-margin (in header line):
21120 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21122 Different ways to express width of left fringe plus left margin minus one pixel:
21123 '(space :width (- (+ left-fringe left-margin) (1)))
21124 '(space :width (+ left-fringe left-margin (- (1))))
21125 '(space :width (+ left-fringe left-margin (-1)))
21129 #define NUMVAL(X) \
21130 ((INTEGERP (X) || FLOATP (X)) \
21135 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21136 struct font
*font
, int width_p
, int *align_to
)
21140 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21141 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21144 return OK_PIXELS (0);
21146 xassert (FRAME_LIVE_P (it
->f
));
21148 if (SYMBOLP (prop
))
21150 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21152 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21154 if (unit
[0] == 'i' && unit
[1] == 'n')
21156 else if (unit
[0] == 'm' && unit
[1] == 'm')
21158 else if (unit
[0] == 'c' && unit
[1] == 'm')
21165 #ifdef HAVE_WINDOW_SYSTEM
21166 if (FRAME_WINDOW_P (it
->f
)
21168 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21169 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21171 return OK_PIXELS (ppi
/ pixels
);
21174 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21175 || (CONSP (Vdisplay_pixels_per_inch
)
21177 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21178 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21180 return OK_PIXELS (ppi
/ pixels
);
21186 #ifdef HAVE_WINDOW_SYSTEM
21187 if (EQ (prop
, Qheight
))
21188 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21189 if (EQ (prop
, Qwidth
))
21190 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21192 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21193 return OK_PIXELS (1);
21196 if (EQ (prop
, Qtext
))
21197 return OK_PIXELS (width_p
21198 ? window_box_width (it
->w
, TEXT_AREA
)
21199 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21201 if (align_to
&& *align_to
< 0)
21204 if (EQ (prop
, Qleft
))
21205 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21206 if (EQ (prop
, Qright
))
21207 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21208 if (EQ (prop
, Qcenter
))
21209 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21210 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21211 if (EQ (prop
, Qleft_fringe
))
21212 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21213 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21214 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21215 if (EQ (prop
, Qright_fringe
))
21216 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21217 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21218 : window_box_right_offset (it
->w
, TEXT_AREA
));
21219 if (EQ (prop
, Qleft_margin
))
21220 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21221 if (EQ (prop
, Qright_margin
))
21222 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21223 if (EQ (prop
, Qscroll_bar
))
21224 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21226 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21227 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21228 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21233 if (EQ (prop
, Qleft_fringe
))
21234 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21235 if (EQ (prop
, Qright_fringe
))
21236 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21237 if (EQ (prop
, Qleft_margin
))
21238 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21239 if (EQ (prop
, Qright_margin
))
21240 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21241 if (EQ (prop
, Qscroll_bar
))
21242 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21245 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21248 if (INTEGERP (prop
) || FLOATP (prop
))
21250 int base_unit
= (width_p
21251 ? FRAME_COLUMN_WIDTH (it
->f
)
21252 : FRAME_LINE_HEIGHT (it
->f
));
21253 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21258 Lisp_Object car
= XCAR (prop
);
21259 Lisp_Object cdr
= XCDR (prop
);
21263 #ifdef HAVE_WINDOW_SYSTEM
21264 if (FRAME_WINDOW_P (it
->f
)
21265 && valid_image_p (prop
))
21267 int id
= lookup_image (it
->f
, prop
);
21268 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21270 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21273 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21279 while (CONSP (cdr
))
21281 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21282 font
, width_p
, align_to
))
21285 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21290 if (EQ (car
, Qminus
))
21292 return OK_PIXELS (pixels
);
21295 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21298 if (INTEGERP (car
) || FLOATP (car
))
21301 pixels
= XFLOATINT (car
);
21303 return OK_PIXELS (pixels
);
21304 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21305 font
, width_p
, align_to
))
21306 return OK_PIXELS (pixels
* fact
);
21317 /***********************************************************************
21319 ***********************************************************************/
21321 #ifdef HAVE_WINDOW_SYSTEM
21326 dump_glyph_string (struct glyph_string
*s
)
21328 fprintf (stderr
, "glyph string\n");
21329 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21330 s
->x
, s
->y
, s
->width
, s
->height
);
21331 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21332 fprintf (stderr
, " hl = %d\n", s
->hl
);
21333 fprintf (stderr
, " left overhang = %d, right = %d\n",
21334 s
->left_overhang
, s
->right_overhang
);
21335 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21336 fprintf (stderr
, " extends to end of line = %d\n",
21337 s
->extends_to_end_of_line_p
);
21338 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21339 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21342 #endif /* GLYPH_DEBUG */
21344 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21345 of XChar2b structures for S; it can't be allocated in
21346 init_glyph_string because it must be allocated via `alloca'. W
21347 is the window on which S is drawn. ROW and AREA are the glyph row
21348 and area within the row from which S is constructed. START is the
21349 index of the first glyph structure covered by S. HL is a
21350 face-override for drawing S. */
21353 #define OPTIONAL_HDC(hdc) HDC hdc,
21354 #define DECLARE_HDC(hdc) HDC hdc;
21355 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21356 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21359 #ifndef OPTIONAL_HDC
21360 #define OPTIONAL_HDC(hdc)
21361 #define DECLARE_HDC(hdc)
21362 #define ALLOCATE_HDC(hdc, f)
21363 #define RELEASE_HDC(hdc, f)
21367 init_glyph_string (struct glyph_string
*s
,
21369 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21370 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21372 memset (s
, 0, sizeof *s
);
21374 s
->f
= XFRAME (w
->frame
);
21378 s
->display
= FRAME_X_DISPLAY (s
->f
);
21379 s
->window
= FRAME_X_WINDOW (s
->f
);
21380 s
->char2b
= char2b
;
21384 s
->first_glyph
= row
->glyphs
[area
] + start
;
21385 s
->height
= row
->height
;
21386 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21387 s
->ybase
= s
->y
+ row
->ascent
;
21391 /* Append the list of glyph strings with head H and tail T to the list
21392 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21395 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21396 struct glyph_string
*h
, struct glyph_string
*t
)
21410 /* Prepend the list of glyph strings with head H and tail T to the
21411 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21415 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21416 struct glyph_string
*h
, struct glyph_string
*t
)
21430 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21431 Set *HEAD and *TAIL to the resulting list. */
21434 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21435 struct glyph_string
*s
)
21437 s
->next
= s
->prev
= NULL
;
21438 append_glyph_string_lists (head
, tail
, s
, s
);
21442 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21443 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21444 make sure that X resources for the face returned are allocated.
21445 Value is a pointer to a realized face that is ready for display if
21446 DISPLAY_P is non-zero. */
21448 static inline struct face
*
21449 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21450 XChar2b
*char2b
, int display_p
)
21452 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21456 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21458 if (code
!= FONT_INVALID_CODE
)
21459 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21461 STORE_XCHAR2B (char2b
, 0, 0);
21464 /* Make sure X resources of the face are allocated. */
21465 #ifdef HAVE_X_WINDOWS
21469 xassert (face
!= NULL
);
21470 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21477 /* Get face and two-byte form of character glyph GLYPH on frame F.
21478 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21479 a pointer to a realized face that is ready for display. */
21481 static inline struct face
*
21482 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21483 XChar2b
*char2b
, int *two_byte_p
)
21487 xassert (glyph
->type
== CHAR_GLYPH
);
21488 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21497 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21498 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21500 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21502 if (code
!= FONT_INVALID_CODE
)
21503 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21505 STORE_XCHAR2B (char2b
, 0, 0);
21508 /* Make sure X resources of the face are allocated. */
21509 xassert (face
!= NULL
);
21510 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21515 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21516 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21519 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21523 if (CHAR_BYTE8_P (c
))
21524 code
= CHAR_TO_BYTE8 (c
);
21526 code
= font
->driver
->encode_char (font
, c
);
21528 if (code
== FONT_INVALID_CODE
)
21530 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21535 /* Fill glyph string S with composition components specified by S->cmp.
21537 BASE_FACE is the base face of the composition.
21538 S->cmp_from is the index of the first component for S.
21540 OVERLAPS non-zero means S should draw the foreground only, and use
21541 its physical height for clipping. See also draw_glyphs.
21543 Value is the index of a component not in S. */
21546 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21550 /* For all glyphs of this composition, starting at the offset
21551 S->cmp_from, until we reach the end of the definition or encounter a
21552 glyph that requires the different face, add it to S. */
21557 s
->for_overlaps
= overlaps
;
21560 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21562 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21566 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21569 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21576 s
->font
= s
->face
->font
;
21578 else if (s
->face
!= face
)
21586 /* All glyph strings for the same composition has the same width,
21587 i.e. the width set for the first component of the composition. */
21588 s
->width
= s
->first_glyph
->pixel_width
;
21590 /* If the specified font could not be loaded, use the frame's
21591 default font, but record the fact that we couldn't load it in
21592 the glyph string so that we can draw rectangles for the
21593 characters of the glyph string. */
21594 if (s
->font
== NULL
)
21596 s
->font_not_found_p
= 1;
21597 s
->font
= FRAME_FONT (s
->f
);
21600 /* Adjust base line for subscript/superscript text. */
21601 s
->ybase
+= s
->first_glyph
->voffset
;
21603 /* This glyph string must always be drawn with 16-bit functions. */
21610 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21611 int start
, int end
, int overlaps
)
21613 struct glyph
*glyph
, *last
;
21614 Lisp_Object lgstring
;
21617 s
->for_overlaps
= overlaps
;
21618 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21619 last
= s
->row
->glyphs
[s
->area
] + end
;
21620 s
->cmp_id
= glyph
->u
.cmp
.id
;
21621 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21622 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21623 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21624 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21625 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21627 while (glyph
< last
21628 && glyph
->u
.cmp
.automatic
21629 && glyph
->u
.cmp
.id
== s
->cmp_id
21630 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21631 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21633 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21635 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21636 unsigned code
= LGLYPH_CODE (lglyph
);
21638 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21640 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21641 return glyph
- s
->row
->glyphs
[s
->area
];
21645 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21646 See the comment of fill_glyph_string for arguments.
21647 Value is the index of the first glyph not in S. */
21651 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21652 int start
, int end
, int overlaps
)
21654 struct glyph
*glyph
, *last
;
21657 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21658 s
->for_overlaps
= overlaps
;
21659 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21660 last
= s
->row
->glyphs
[s
->area
] + end
;
21661 voffset
= glyph
->voffset
;
21662 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21663 s
->font
= s
->face
->font
;
21665 s
->width
= glyph
->pixel_width
;
21667 while (glyph
< last
21668 && glyph
->type
== GLYPHLESS_GLYPH
21669 && glyph
->voffset
== voffset
21670 && glyph
->face_id
== face_id
)
21673 s
->width
+= glyph
->pixel_width
;
21676 s
->ybase
+= voffset
;
21677 return glyph
- s
->row
->glyphs
[s
->area
];
21681 /* Fill glyph string S from a sequence of character glyphs.
21683 FACE_ID is the face id of the string. START is the index of the
21684 first glyph to consider, END is the index of the last + 1.
21685 OVERLAPS non-zero means S should draw the foreground only, and use
21686 its physical height for clipping. See also draw_glyphs.
21688 Value is the index of the first glyph not in S. */
21691 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21692 int start
, int end
, int overlaps
)
21694 struct glyph
*glyph
, *last
;
21696 int glyph_not_available_p
;
21698 xassert (s
->f
== XFRAME (s
->w
->frame
));
21699 xassert (s
->nchars
== 0);
21700 xassert (start
>= 0 && end
> start
);
21702 s
->for_overlaps
= overlaps
;
21703 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21704 last
= s
->row
->glyphs
[s
->area
] + end
;
21705 voffset
= glyph
->voffset
;
21706 s
->padding_p
= glyph
->padding_p
;
21707 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21709 while (glyph
< last
21710 && glyph
->type
== CHAR_GLYPH
21711 && glyph
->voffset
== voffset
21712 /* Same face id implies same font, nowadays. */
21713 && glyph
->face_id
== face_id
21714 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21718 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21719 s
->char2b
+ s
->nchars
,
21721 s
->two_byte_p
= two_byte_p
;
21723 xassert (s
->nchars
<= end
- start
);
21724 s
->width
+= glyph
->pixel_width
;
21725 if (glyph
++->padding_p
!= s
->padding_p
)
21729 s
->font
= s
->face
->font
;
21731 /* If the specified font could not be loaded, use the frame's font,
21732 but record the fact that we couldn't load it in
21733 S->font_not_found_p so that we can draw rectangles for the
21734 characters of the glyph string. */
21735 if (s
->font
== NULL
|| glyph_not_available_p
)
21737 s
->font_not_found_p
= 1;
21738 s
->font
= FRAME_FONT (s
->f
);
21741 /* Adjust base line for subscript/superscript text. */
21742 s
->ybase
+= voffset
;
21744 xassert (s
->face
&& s
->face
->gc
);
21745 return glyph
- s
->row
->glyphs
[s
->area
];
21749 /* Fill glyph string S from image glyph S->first_glyph. */
21752 fill_image_glyph_string (struct glyph_string
*s
)
21754 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21755 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21757 s
->slice
= s
->first_glyph
->slice
.img
;
21758 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21759 s
->font
= s
->face
->font
;
21760 s
->width
= s
->first_glyph
->pixel_width
;
21762 /* Adjust base line for subscript/superscript text. */
21763 s
->ybase
+= s
->first_glyph
->voffset
;
21767 /* Fill glyph string S from a sequence of stretch glyphs.
21769 START is the index of the first glyph to consider,
21770 END is the index of the last + 1.
21772 Value is the index of the first glyph not in S. */
21775 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21777 struct glyph
*glyph
, *last
;
21778 int voffset
, face_id
;
21780 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21782 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21783 last
= s
->row
->glyphs
[s
->area
] + end
;
21784 face_id
= glyph
->face_id
;
21785 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21786 s
->font
= s
->face
->font
;
21787 s
->width
= glyph
->pixel_width
;
21789 voffset
= glyph
->voffset
;
21793 && glyph
->type
== STRETCH_GLYPH
21794 && glyph
->voffset
== voffset
21795 && glyph
->face_id
== face_id
);
21797 s
->width
+= glyph
->pixel_width
;
21799 /* Adjust base line for subscript/superscript text. */
21800 s
->ybase
+= voffset
;
21802 /* The case that face->gc == 0 is handled when drawing the glyph
21803 string by calling PREPARE_FACE_FOR_DISPLAY. */
21805 return glyph
- s
->row
->glyphs
[s
->area
];
21808 static struct font_metrics
*
21809 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21811 static struct font_metrics metrics
;
21812 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21814 if (! font
|| code
== FONT_INVALID_CODE
)
21816 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21821 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21822 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21823 assumed to be zero. */
21826 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21828 *left
= *right
= 0;
21830 if (glyph
->type
== CHAR_GLYPH
)
21834 struct font_metrics
*pcm
;
21836 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21837 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21839 if (pcm
->rbearing
> pcm
->width
)
21840 *right
= pcm
->rbearing
- pcm
->width
;
21841 if (pcm
->lbearing
< 0)
21842 *left
= -pcm
->lbearing
;
21845 else if (glyph
->type
== COMPOSITE_GLYPH
)
21847 if (! glyph
->u
.cmp
.automatic
)
21849 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21851 if (cmp
->rbearing
> cmp
->pixel_width
)
21852 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21853 if (cmp
->lbearing
< 0)
21854 *left
= - cmp
->lbearing
;
21858 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21859 struct font_metrics metrics
;
21861 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21862 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21863 if (metrics
.rbearing
> metrics
.width
)
21864 *right
= metrics
.rbearing
- metrics
.width
;
21865 if (metrics
.lbearing
< 0)
21866 *left
= - metrics
.lbearing
;
21872 /* Return the index of the first glyph preceding glyph string S that
21873 is overwritten by S because of S's left overhang. Value is -1
21874 if no glyphs are overwritten. */
21877 left_overwritten (struct glyph_string
*s
)
21881 if (s
->left_overhang
)
21884 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21885 int first
= s
->first_glyph
- glyphs
;
21887 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21888 x
-= glyphs
[i
].pixel_width
;
21899 /* Return the index of the first glyph preceding glyph string S that
21900 is overwriting S because of its right overhang. Value is -1 if no
21901 glyph in front of S overwrites S. */
21904 left_overwriting (struct glyph_string
*s
)
21907 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21908 int first
= s
->first_glyph
- glyphs
;
21912 for (i
= first
- 1; i
>= 0; --i
)
21915 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21918 x
-= glyphs
[i
].pixel_width
;
21925 /* Return the index of the last glyph following glyph string S that is
21926 overwritten by S because of S's right overhang. Value is -1 if
21927 no such glyph is found. */
21930 right_overwritten (struct glyph_string
*s
)
21934 if (s
->right_overhang
)
21937 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21938 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21939 int end
= s
->row
->used
[s
->area
];
21941 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21942 x
+= glyphs
[i
].pixel_width
;
21951 /* Return the index of the last glyph following glyph string S that
21952 overwrites S because of its left overhang. Value is negative
21953 if no such glyph is found. */
21956 right_overwriting (struct glyph_string
*s
)
21959 int end
= s
->row
->used
[s
->area
];
21960 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21961 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21965 for (i
= first
; i
< end
; ++i
)
21968 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21971 x
+= glyphs
[i
].pixel_width
;
21978 /* Set background width of glyph string S. START is the index of the
21979 first glyph following S. LAST_X is the right-most x-position + 1
21980 in the drawing area. */
21983 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21985 /* If the face of this glyph string has to be drawn to the end of
21986 the drawing area, set S->extends_to_end_of_line_p. */
21988 if (start
== s
->row
->used
[s
->area
]
21989 && s
->area
== TEXT_AREA
21990 && ((s
->row
->fill_line_p
21991 && (s
->hl
== DRAW_NORMAL_TEXT
21992 || s
->hl
== DRAW_IMAGE_RAISED
21993 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21994 || s
->hl
== DRAW_MOUSE_FACE
))
21995 s
->extends_to_end_of_line_p
= 1;
21997 /* If S extends its face to the end of the line, set its
21998 background_width to the distance to the right edge of the drawing
22000 if (s
->extends_to_end_of_line_p
)
22001 s
->background_width
= last_x
- s
->x
+ 1;
22003 s
->background_width
= s
->width
;
22007 /* Compute overhangs and x-positions for glyph string S and its
22008 predecessors, or successors. X is the starting x-position for S.
22009 BACKWARD_P non-zero means process predecessors. */
22012 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22018 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22019 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22029 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22030 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22040 /* The following macros are only called from draw_glyphs below.
22041 They reference the following parameters of that function directly:
22042 `w', `row', `area', and `overlap_p'
22043 as well as the following local variables:
22044 `s', `f', and `hdc' (in W32) */
22047 /* On W32, silently add local `hdc' variable to argument list of
22048 init_glyph_string. */
22049 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22050 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22052 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22053 init_glyph_string (s, char2b, w, row, area, start, hl)
22056 /* Add a glyph string for a stretch glyph to the list of strings
22057 between HEAD and TAIL. START is the index of the stretch glyph in
22058 row area AREA of glyph row ROW. END is the index of the last glyph
22059 in that glyph row area. X is the current output position assigned
22060 to the new glyph string constructed. HL overrides that face of the
22061 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22062 is the right-most x-position of the drawing area. */
22064 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22065 and below -- keep them on one line. */
22066 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22069 s = (struct glyph_string *) alloca (sizeof *s); \
22070 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22071 START = fill_stretch_glyph_string (s, START, END); \
22072 append_glyph_string (&HEAD, &TAIL, s); \
22078 /* Add a glyph string for an image glyph to the list of strings
22079 between HEAD and TAIL. START is the index of the image glyph in
22080 row area AREA of glyph row ROW. END is the index of the last glyph
22081 in that glyph row area. X is the current output position assigned
22082 to the new glyph string constructed. HL overrides that face of the
22083 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22084 is the right-most x-position of the drawing area. */
22086 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22089 s = (struct glyph_string *) alloca (sizeof *s); \
22090 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22091 fill_image_glyph_string (s); \
22092 append_glyph_string (&HEAD, &TAIL, s); \
22099 /* Add a glyph string for a sequence of character glyphs to the list
22100 of strings between HEAD and TAIL. START is the index of the first
22101 glyph in row area AREA of glyph row ROW that is part of the new
22102 glyph string. END is the index of the last glyph in that glyph row
22103 area. X is the current output position assigned to the new glyph
22104 string constructed. HL overrides that face of the glyph; e.g. it
22105 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22106 right-most x-position of the drawing area. */
22108 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22114 face_id = (row)->glyphs[area][START].face_id; \
22116 s = (struct glyph_string *) alloca (sizeof *s); \
22117 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22118 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22119 append_glyph_string (&HEAD, &TAIL, s); \
22121 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22126 /* Add a glyph string for a composite sequence to the list of strings
22127 between HEAD and TAIL. START is the index of the first glyph in
22128 row area AREA of glyph row ROW that is part of the new glyph
22129 string. END is the index of the last glyph in that glyph row area.
22130 X is the current output position assigned to the new glyph string
22131 constructed. HL overrides that face of the glyph; e.g. it is
22132 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22133 x-position of the drawing area. */
22135 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22137 int face_id = (row)->glyphs[area][START].face_id; \
22138 struct face *base_face = FACE_FROM_ID (f, face_id); \
22139 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22140 struct composition *cmp = composition_table[cmp_id]; \
22142 struct glyph_string *first_s IF_LINT (= NULL); \
22145 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22147 /* Make glyph_strings for each glyph sequence that is drawable by \
22148 the same face, and append them to HEAD/TAIL. */ \
22149 for (n = 0; n < cmp->glyph_len;) \
22151 s = (struct glyph_string *) alloca (sizeof *s); \
22152 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22153 append_glyph_string (&(HEAD), &(TAIL), s); \
22159 n = fill_composite_glyph_string (s, base_face, overlaps); \
22167 /* Add a glyph string for a glyph-string sequence to the list of strings
22168 between HEAD and TAIL. */
22170 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22174 Lisp_Object gstring; \
22176 face_id = (row)->glyphs[area][START].face_id; \
22177 gstring = (composition_gstring_from_id \
22178 ((row)->glyphs[area][START].u.cmp.id)); \
22179 s = (struct glyph_string *) alloca (sizeof *s); \
22180 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22181 * LGSTRING_GLYPH_LEN (gstring)); \
22182 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22183 append_glyph_string (&(HEAD), &(TAIL), s); \
22185 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22189 /* Add a glyph string for a sequence of glyphless character's glyphs
22190 to the list of strings between HEAD and TAIL. The meanings of
22191 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22193 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22198 face_id = (row)->glyphs[area][START].face_id; \
22200 s = (struct glyph_string *) alloca (sizeof *s); \
22201 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22202 append_glyph_string (&HEAD, &TAIL, s); \
22204 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22210 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22211 of AREA of glyph row ROW on window W between indices START and END.
22212 HL overrides the face for drawing glyph strings, e.g. it is
22213 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22214 x-positions of the drawing area.
22216 This is an ugly monster macro construct because we must use alloca
22217 to allocate glyph strings (because draw_glyphs can be called
22218 asynchronously). */
22220 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22223 HEAD = TAIL = NULL; \
22224 while (START < END) \
22226 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22227 switch (first_glyph->type) \
22230 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22234 case COMPOSITE_GLYPH: \
22235 if (first_glyph->u.cmp.automatic) \
22236 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22239 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22243 case STRETCH_GLYPH: \
22244 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22248 case IMAGE_GLYPH: \
22249 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22253 case GLYPHLESS_GLYPH: \
22254 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22264 set_glyph_string_background_width (s, START, LAST_X); \
22271 /* Draw glyphs between START and END in AREA of ROW on window W,
22272 starting at x-position X. X is relative to AREA in W. HL is a
22273 face-override with the following meaning:
22275 DRAW_NORMAL_TEXT draw normally
22276 DRAW_CURSOR draw in cursor face
22277 DRAW_MOUSE_FACE draw in mouse face.
22278 DRAW_INVERSE_VIDEO draw in mode line face
22279 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22280 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22282 If OVERLAPS is non-zero, draw only the foreground of characters and
22283 clip to the physical height of ROW. Non-zero value also defines
22284 the overlapping part to be drawn:
22286 OVERLAPS_PRED overlap with preceding rows
22287 OVERLAPS_SUCC overlap with succeeding rows
22288 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22289 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22291 Value is the x-position reached, relative to AREA of W. */
22294 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22295 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22296 enum draw_glyphs_face hl
, int overlaps
)
22298 struct glyph_string
*head
, *tail
;
22299 struct glyph_string
*s
;
22300 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22301 int i
, j
, x_reached
, last_x
, area_left
= 0;
22302 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22305 ALLOCATE_HDC (hdc
, f
);
22307 /* Let's rather be paranoid than getting a SEGV. */
22308 end
= min (end
, row
->used
[area
]);
22309 start
= max (0, start
);
22310 start
= min (end
, start
);
22312 /* Translate X to frame coordinates. Set last_x to the right
22313 end of the drawing area. */
22314 if (row
->full_width_p
)
22316 /* X is relative to the left edge of W, without scroll bars
22318 area_left
= WINDOW_LEFT_EDGE_X (w
);
22319 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22323 area_left
= window_box_left (w
, area
);
22324 last_x
= area_left
+ window_box_width (w
, area
);
22328 /* Build a doubly-linked list of glyph_string structures between
22329 head and tail from what we have to draw. Note that the macro
22330 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22331 the reason we use a separate variable `i'. */
22333 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22335 x_reached
= tail
->x
+ tail
->background_width
;
22339 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22340 the row, redraw some glyphs in front or following the glyph
22341 strings built above. */
22342 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22344 struct glyph_string
*h
, *t
;
22345 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22346 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22347 int check_mouse_face
= 0;
22350 /* If mouse highlighting is on, we may need to draw adjacent
22351 glyphs using mouse-face highlighting. */
22352 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22354 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22356 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22357 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22359 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22361 check_mouse_face
= 1;
22362 mouse_beg_col
= (row
== mouse_beg_row
)
22363 ? hlinfo
->mouse_face_beg_col
: 0;
22364 mouse_end_col
= (row
== mouse_end_row
)
22365 ? hlinfo
->mouse_face_end_col
22366 : row
->used
[TEXT_AREA
];
22370 /* Compute overhangs for all glyph strings. */
22371 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22372 for (s
= head
; s
; s
= s
->next
)
22373 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22375 /* Prepend glyph strings for glyphs in front of the first glyph
22376 string that are overwritten because of the first glyph
22377 string's left overhang. The background of all strings
22378 prepended must be drawn because the first glyph string
22380 i
= left_overwritten (head
);
22383 enum draw_glyphs_face overlap_hl
;
22385 /* If this row contains mouse highlighting, attempt to draw
22386 the overlapped glyphs with the correct highlight. This
22387 code fails if the overlap encompasses more than one glyph
22388 and mouse-highlight spans only some of these glyphs.
22389 However, making it work perfectly involves a lot more
22390 code, and I don't know if the pathological case occurs in
22391 practice, so we'll stick to this for now. --- cyd */
22392 if (check_mouse_face
22393 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22394 overlap_hl
= DRAW_MOUSE_FACE
;
22396 overlap_hl
= DRAW_NORMAL_TEXT
;
22399 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22400 overlap_hl
, dummy_x
, last_x
);
22402 compute_overhangs_and_x (t
, head
->x
, 1);
22403 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22407 /* Prepend glyph strings for glyphs in front of the first glyph
22408 string that overwrite that glyph string because of their
22409 right overhang. For these strings, only the foreground must
22410 be drawn, because it draws over the glyph string at `head'.
22411 The background must not be drawn because this would overwrite
22412 right overhangs of preceding glyphs for which no glyph
22414 i
= left_overwriting (head
);
22417 enum draw_glyphs_face overlap_hl
;
22419 if (check_mouse_face
22420 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22421 overlap_hl
= DRAW_MOUSE_FACE
;
22423 overlap_hl
= DRAW_NORMAL_TEXT
;
22426 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22427 overlap_hl
, dummy_x
, last_x
);
22428 for (s
= h
; s
; s
= s
->next
)
22429 s
->background_filled_p
= 1;
22430 compute_overhangs_and_x (t
, head
->x
, 1);
22431 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22434 /* Append glyphs strings for glyphs following the last glyph
22435 string tail that are overwritten by tail. The background of
22436 these strings has to be drawn because tail's foreground draws
22438 i
= right_overwritten (tail
);
22441 enum draw_glyphs_face overlap_hl
;
22443 if (check_mouse_face
22444 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22445 overlap_hl
= DRAW_MOUSE_FACE
;
22447 overlap_hl
= DRAW_NORMAL_TEXT
;
22449 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22450 overlap_hl
, x
, last_x
);
22451 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22452 we don't have `end = i;' here. */
22453 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22454 append_glyph_string_lists (&head
, &tail
, h
, t
);
22458 /* Append glyph strings for glyphs following the last glyph
22459 string tail that overwrite tail. The foreground of such
22460 glyphs has to be drawn because it writes into the background
22461 of tail. The background must not be drawn because it could
22462 paint over the foreground of following glyphs. */
22463 i
= right_overwriting (tail
);
22466 enum draw_glyphs_face overlap_hl
;
22467 if (check_mouse_face
22468 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22469 overlap_hl
= DRAW_MOUSE_FACE
;
22471 overlap_hl
= DRAW_NORMAL_TEXT
;
22474 i
++; /* We must include the Ith glyph. */
22475 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22476 overlap_hl
, x
, last_x
);
22477 for (s
= h
; s
; s
= s
->next
)
22478 s
->background_filled_p
= 1;
22479 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22480 append_glyph_string_lists (&head
, &tail
, h
, t
);
22482 if (clip_head
|| clip_tail
)
22483 for (s
= head
; s
; s
= s
->next
)
22485 s
->clip_head
= clip_head
;
22486 s
->clip_tail
= clip_tail
;
22490 /* Draw all strings. */
22491 for (s
= head
; s
; s
= s
->next
)
22492 FRAME_RIF (f
)->draw_glyph_string (s
);
22495 /* When focus a sole frame and move horizontally, this sets on_p to 0
22496 causing a failure to erase prev cursor position. */
22497 if (area
== TEXT_AREA
22498 && !row
->full_width_p
22499 /* When drawing overlapping rows, only the glyph strings'
22500 foreground is drawn, which doesn't erase a cursor
22504 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22505 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22506 : (tail
? tail
->x
+ tail
->background_width
: x
));
22510 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22511 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22515 /* Value is the x-position up to which drawn, relative to AREA of W.
22516 This doesn't include parts drawn because of overhangs. */
22517 if (row
->full_width_p
)
22518 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22520 x_reached
-= area_left
;
22522 RELEASE_HDC (hdc
, f
);
22527 /* Expand row matrix if too narrow. Don't expand if area
22530 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22532 if (!fonts_changed_p \
22533 && (it->glyph_row->glyphs[area] \
22534 < it->glyph_row->glyphs[area + 1])) \
22536 it->w->ncols_scale_factor++; \
22537 fonts_changed_p = 1; \
22541 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22542 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22545 append_glyph (struct it
*it
)
22547 struct glyph
*glyph
;
22548 enum glyph_row_area area
= it
->area
;
22550 xassert (it
->glyph_row
);
22551 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22553 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22554 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22556 /* If the glyph row is reversed, we need to prepend the glyph
22557 rather than append it. */
22558 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22562 /* Make room for the additional glyph. */
22563 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22565 glyph
= it
->glyph_row
->glyphs
[area
];
22567 glyph
->charpos
= CHARPOS (it
->position
);
22568 glyph
->object
= it
->object
;
22569 if (it
->pixel_width
> 0)
22571 glyph
->pixel_width
= it
->pixel_width
;
22572 glyph
->padding_p
= 0;
22576 /* Assure at least 1-pixel width. Otherwise, cursor can't
22577 be displayed correctly. */
22578 glyph
->pixel_width
= 1;
22579 glyph
->padding_p
= 1;
22581 glyph
->ascent
= it
->ascent
;
22582 glyph
->descent
= it
->descent
;
22583 glyph
->voffset
= it
->voffset
;
22584 glyph
->type
= CHAR_GLYPH
;
22585 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22586 glyph
->multibyte_p
= it
->multibyte_p
;
22587 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22588 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22589 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22590 || it
->phys_descent
> it
->descent
);
22591 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22592 glyph
->face_id
= it
->face_id
;
22593 glyph
->u
.ch
= it
->char_to_display
;
22594 glyph
->slice
.img
= null_glyph_slice
;
22595 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22598 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22599 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22601 glyph
->bidi_type
= it
->bidi_it
.type
;
22605 glyph
->resolved_level
= 0;
22606 glyph
->bidi_type
= UNKNOWN_BT
;
22608 ++it
->glyph_row
->used
[area
];
22611 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22614 /* Store one glyph for the composition IT->cmp_it.id in
22615 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22619 append_composite_glyph (struct it
*it
)
22621 struct glyph
*glyph
;
22622 enum glyph_row_area area
= it
->area
;
22624 xassert (it
->glyph_row
);
22626 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22627 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22629 /* If the glyph row is reversed, we need to prepend the glyph
22630 rather than append it. */
22631 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22635 /* Make room for the new glyph. */
22636 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22638 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22640 glyph
->charpos
= it
->cmp_it
.charpos
;
22641 glyph
->object
= it
->object
;
22642 glyph
->pixel_width
= it
->pixel_width
;
22643 glyph
->ascent
= it
->ascent
;
22644 glyph
->descent
= it
->descent
;
22645 glyph
->voffset
= it
->voffset
;
22646 glyph
->type
= COMPOSITE_GLYPH
;
22647 if (it
->cmp_it
.ch
< 0)
22649 glyph
->u
.cmp
.automatic
= 0;
22650 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22651 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22655 glyph
->u
.cmp
.automatic
= 1;
22656 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22657 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22658 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22660 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22661 glyph
->multibyte_p
= it
->multibyte_p
;
22662 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22663 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22664 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22665 || it
->phys_descent
> it
->descent
);
22666 glyph
->padding_p
= 0;
22667 glyph
->glyph_not_available_p
= 0;
22668 glyph
->face_id
= it
->face_id
;
22669 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22672 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22673 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22675 glyph
->bidi_type
= it
->bidi_it
.type
;
22677 ++it
->glyph_row
->used
[area
];
22680 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22684 /* Change IT->ascent and IT->height according to the setting of
22688 take_vertical_position_into_account (struct it
*it
)
22692 if (it
->voffset
< 0)
22693 /* Increase the ascent so that we can display the text higher
22695 it
->ascent
-= it
->voffset
;
22697 /* Increase the descent so that we can display the text lower
22699 it
->descent
+= it
->voffset
;
22704 /* Produce glyphs/get display metrics for the image IT is loaded with.
22705 See the description of struct display_iterator in dispextern.h for
22706 an overview of struct display_iterator. */
22709 produce_image_glyph (struct it
*it
)
22713 int glyph_ascent
, crop
;
22714 struct glyph_slice slice
;
22716 xassert (it
->what
== IT_IMAGE
);
22718 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22720 /* Make sure X resources of the face is loaded. */
22721 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22723 if (it
->image_id
< 0)
22725 /* Fringe bitmap. */
22726 it
->ascent
= it
->phys_ascent
= 0;
22727 it
->descent
= it
->phys_descent
= 0;
22728 it
->pixel_width
= 0;
22733 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22735 /* Make sure X resources of the image is loaded. */
22736 prepare_image_for_display (it
->f
, img
);
22738 slice
.x
= slice
.y
= 0;
22739 slice
.width
= img
->width
;
22740 slice
.height
= img
->height
;
22742 if (INTEGERP (it
->slice
.x
))
22743 slice
.x
= XINT (it
->slice
.x
);
22744 else if (FLOATP (it
->slice
.x
))
22745 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22747 if (INTEGERP (it
->slice
.y
))
22748 slice
.y
= XINT (it
->slice
.y
);
22749 else if (FLOATP (it
->slice
.y
))
22750 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22752 if (INTEGERP (it
->slice
.width
))
22753 slice
.width
= XINT (it
->slice
.width
);
22754 else if (FLOATP (it
->slice
.width
))
22755 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22757 if (INTEGERP (it
->slice
.height
))
22758 slice
.height
= XINT (it
->slice
.height
);
22759 else if (FLOATP (it
->slice
.height
))
22760 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22762 if (slice
.x
>= img
->width
)
22763 slice
.x
= img
->width
;
22764 if (slice
.y
>= img
->height
)
22765 slice
.y
= img
->height
;
22766 if (slice
.x
+ slice
.width
>= img
->width
)
22767 slice
.width
= img
->width
- slice
.x
;
22768 if (slice
.y
+ slice
.height
> img
->height
)
22769 slice
.height
= img
->height
- slice
.y
;
22771 if (slice
.width
== 0 || slice
.height
== 0)
22774 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22776 it
->descent
= slice
.height
- glyph_ascent
;
22778 it
->descent
+= img
->vmargin
;
22779 if (slice
.y
+ slice
.height
== img
->height
)
22780 it
->descent
+= img
->vmargin
;
22781 it
->phys_descent
= it
->descent
;
22783 it
->pixel_width
= slice
.width
;
22785 it
->pixel_width
+= img
->hmargin
;
22786 if (slice
.x
+ slice
.width
== img
->width
)
22787 it
->pixel_width
+= img
->hmargin
;
22789 /* It's quite possible for images to have an ascent greater than
22790 their height, so don't get confused in that case. */
22791 if (it
->descent
< 0)
22796 if (face
->box
!= FACE_NO_BOX
)
22798 if (face
->box_line_width
> 0)
22801 it
->ascent
+= face
->box_line_width
;
22802 if (slice
.y
+ slice
.height
== img
->height
)
22803 it
->descent
+= face
->box_line_width
;
22806 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22807 it
->pixel_width
+= eabs (face
->box_line_width
);
22808 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22809 it
->pixel_width
+= eabs (face
->box_line_width
);
22812 take_vertical_position_into_account (it
);
22814 /* Automatically crop wide image glyphs at right edge so we can
22815 draw the cursor on same display row. */
22816 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22817 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22819 it
->pixel_width
-= crop
;
22820 slice
.width
-= crop
;
22825 struct glyph
*glyph
;
22826 enum glyph_row_area area
= it
->area
;
22828 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22829 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22831 glyph
->charpos
= CHARPOS (it
->position
);
22832 glyph
->object
= it
->object
;
22833 glyph
->pixel_width
= it
->pixel_width
;
22834 glyph
->ascent
= glyph_ascent
;
22835 glyph
->descent
= it
->descent
;
22836 glyph
->voffset
= it
->voffset
;
22837 glyph
->type
= IMAGE_GLYPH
;
22838 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22839 glyph
->multibyte_p
= it
->multibyte_p
;
22840 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22841 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22842 glyph
->overlaps_vertically_p
= 0;
22843 glyph
->padding_p
= 0;
22844 glyph
->glyph_not_available_p
= 0;
22845 glyph
->face_id
= it
->face_id
;
22846 glyph
->u
.img_id
= img
->id
;
22847 glyph
->slice
.img
= slice
;
22848 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22851 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22852 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22854 glyph
->bidi_type
= it
->bidi_it
.type
;
22856 ++it
->glyph_row
->used
[area
];
22859 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22864 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22865 of the glyph, WIDTH and HEIGHT are the width and height of the
22866 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22869 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22870 int width
, int height
, int ascent
)
22872 struct glyph
*glyph
;
22873 enum glyph_row_area area
= it
->area
;
22875 xassert (ascent
>= 0 && ascent
<= height
);
22877 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22878 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22880 /* If the glyph row is reversed, we need to prepend the glyph
22881 rather than append it. */
22882 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22886 /* Make room for the additional glyph. */
22887 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22889 glyph
= it
->glyph_row
->glyphs
[area
];
22891 glyph
->charpos
= CHARPOS (it
->position
);
22892 glyph
->object
= object
;
22893 glyph
->pixel_width
= width
;
22894 glyph
->ascent
= ascent
;
22895 glyph
->descent
= height
- ascent
;
22896 glyph
->voffset
= it
->voffset
;
22897 glyph
->type
= STRETCH_GLYPH
;
22898 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22899 glyph
->multibyte_p
= it
->multibyte_p
;
22900 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22901 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22902 glyph
->overlaps_vertically_p
= 0;
22903 glyph
->padding_p
= 0;
22904 glyph
->glyph_not_available_p
= 0;
22905 glyph
->face_id
= it
->face_id
;
22906 glyph
->u
.stretch
.ascent
= ascent
;
22907 glyph
->u
.stretch
.height
= height
;
22908 glyph
->slice
.img
= null_glyph_slice
;
22909 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22912 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22913 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22915 glyph
->bidi_type
= it
->bidi_it
.type
;
22919 glyph
->resolved_level
= 0;
22920 glyph
->bidi_type
= UNKNOWN_BT
;
22922 ++it
->glyph_row
->used
[area
];
22925 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22929 /* Produce a stretch glyph for iterator IT. IT->object is the value
22930 of the glyph property displayed. The value must be a list
22931 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22934 1. `:width WIDTH' specifies that the space should be WIDTH *
22935 canonical char width wide. WIDTH may be an integer or floating
22938 2. `:relative-width FACTOR' specifies that the width of the stretch
22939 should be computed from the width of the first character having the
22940 `glyph' property, and should be FACTOR times that width.
22942 3. `:align-to HPOS' specifies that the space should be wide enough
22943 to reach HPOS, a value in canonical character units.
22945 Exactly one of the above pairs must be present.
22947 4. `:height HEIGHT' specifies that the height of the stretch produced
22948 should be HEIGHT, measured in canonical character units.
22950 5. `:relative-height FACTOR' specifies that the height of the
22951 stretch should be FACTOR times the height of the characters having
22952 the glyph property.
22954 Either none or exactly one of 4 or 5 must be present.
22956 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22957 of the stretch should be used for the ascent of the stretch.
22958 ASCENT must be in the range 0 <= ASCENT <= 100. */
22961 produce_stretch_glyph (struct it
*it
)
22963 /* (space :width WIDTH :height HEIGHT ...) */
22964 Lisp_Object prop
, plist
;
22965 int width
= 0, height
= 0, align_to
= -1;
22966 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22969 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22970 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22972 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22974 /* List should start with `space'. */
22975 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22976 plist
= XCDR (it
->object
);
22978 /* Compute the width of the stretch. */
22979 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22980 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22982 /* Absolute width `:width WIDTH' specified and valid. */
22983 zero_width_ok_p
= 1;
22986 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22989 /* Relative width `:relative-width FACTOR' specified and valid.
22990 Compute the width of the characters having the `glyph'
22993 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22996 if (it
->multibyte_p
)
22997 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23000 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23001 if (! ASCII_CHAR_P (it2
.c
))
23002 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23005 it2
.glyph_row
= NULL
;
23006 it2
.what
= IT_CHARACTER
;
23007 x_produce_glyphs (&it2
);
23008 width
= NUMVAL (prop
) * it2
.pixel_width
;
23010 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23011 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23013 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23014 align_to
= (align_to
< 0
23016 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23017 else if (align_to
< 0)
23018 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23019 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23020 zero_width_ok_p
= 1;
23023 /* Nothing specified -> width defaults to canonical char width. */
23024 width
= FRAME_COLUMN_WIDTH (it
->f
);
23026 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23029 /* Compute height. */
23030 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23031 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23034 zero_height_ok_p
= 1;
23036 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23038 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23040 height
= FONT_HEIGHT (font
);
23042 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23045 /* Compute percentage of height used for ascent. If
23046 `:ascent ASCENT' is present and valid, use that. Otherwise,
23047 derive the ascent from the font in use. */
23048 if (prop
= Fplist_get (plist
, QCascent
),
23049 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23050 ascent
= height
* NUMVAL (prop
) / 100.0;
23051 else if (!NILP (prop
)
23052 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23053 ascent
= min (max (0, (int)tem
), height
);
23055 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23057 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23058 && it
->current_x
+ width
> it
->last_visible_x
)
23059 width
= it
->last_visible_x
- it
->current_x
- 1;
23061 if (width
> 0 && height
> 0 && it
->glyph_row
)
23063 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23064 if (!STRINGP (object
))
23065 object
= it
->w
->buffer
;
23066 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23069 it
->pixel_width
= width
;
23070 it
->ascent
= it
->phys_ascent
= ascent
;
23071 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23072 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23074 take_vertical_position_into_account (it
);
23077 /* Calculate line-height and line-spacing properties.
23078 An integer value specifies explicit pixel value.
23079 A float value specifies relative value to current face height.
23080 A cons (float . face-name) specifies relative value to
23081 height of specified face font.
23083 Returns height in pixels, or nil. */
23087 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23088 int boff
, int override
)
23090 Lisp_Object face_name
= Qnil
;
23091 int ascent
, descent
, height
;
23093 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23098 face_name
= XCAR (val
);
23100 if (!NUMBERP (val
))
23101 val
= make_number (1);
23102 if (NILP (face_name
))
23104 height
= it
->ascent
+ it
->descent
;
23109 if (NILP (face_name
))
23111 font
= FRAME_FONT (it
->f
);
23112 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23114 else if (EQ (face_name
, Qt
))
23123 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23125 return make_number (-1);
23127 face
= FACE_FROM_ID (it
->f
, face_id
);
23130 return make_number (-1);
23131 boff
= font
->baseline_offset
;
23132 if (font
->vertical_centering
)
23133 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23136 ascent
= FONT_BASE (font
) + boff
;
23137 descent
= FONT_DESCENT (font
) - boff
;
23141 it
->override_ascent
= ascent
;
23142 it
->override_descent
= descent
;
23143 it
->override_boff
= boff
;
23146 height
= ascent
+ descent
;
23150 height
= (int)(XFLOAT_DATA (val
) * height
);
23151 else if (INTEGERP (val
))
23152 height
*= XINT (val
);
23154 return make_number (height
);
23158 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23159 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23160 and only if this is for a character for which no font was found.
23162 If the display method (it->glyphless_method) is
23163 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23164 length of the acronym or the hexadecimal string, UPPER_XOFF and
23165 UPPER_YOFF are pixel offsets for the upper part of the string,
23166 LOWER_XOFF and LOWER_YOFF are for the lower part.
23168 For the other display methods, LEN through LOWER_YOFF are zero. */
23171 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23172 short upper_xoff
, short upper_yoff
,
23173 short lower_xoff
, short lower_yoff
)
23175 struct glyph
*glyph
;
23176 enum glyph_row_area area
= it
->area
;
23178 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23179 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23181 /* If the glyph row is reversed, we need to prepend the glyph
23182 rather than append it. */
23183 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23187 /* Make room for the additional glyph. */
23188 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23190 glyph
= it
->glyph_row
->glyphs
[area
];
23192 glyph
->charpos
= CHARPOS (it
->position
);
23193 glyph
->object
= it
->object
;
23194 glyph
->pixel_width
= it
->pixel_width
;
23195 glyph
->ascent
= it
->ascent
;
23196 glyph
->descent
= it
->descent
;
23197 glyph
->voffset
= it
->voffset
;
23198 glyph
->type
= GLYPHLESS_GLYPH
;
23199 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23200 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23201 glyph
->u
.glyphless
.len
= len
;
23202 glyph
->u
.glyphless
.ch
= it
->c
;
23203 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23204 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23205 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23206 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23207 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23208 glyph
->multibyte_p
= it
->multibyte_p
;
23209 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23210 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23211 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23212 || it
->phys_descent
> it
->descent
);
23213 glyph
->padding_p
= 0;
23214 glyph
->glyph_not_available_p
= 0;
23215 glyph
->face_id
= face_id
;
23216 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23219 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23220 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23222 glyph
->bidi_type
= it
->bidi_it
.type
;
23224 ++it
->glyph_row
->used
[area
];
23227 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23231 /* Produce a glyph for a glyphless character for iterator IT.
23232 IT->glyphless_method specifies which method to use for displaying
23233 the character. See the description of enum
23234 glyphless_display_method in dispextern.h for the detail.
23236 FOR_NO_FONT is nonzero if and only if this is for a character for
23237 which no font was found. ACRONYM, if non-nil, is an acronym string
23238 for the character. */
23241 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23246 int base_width
, base_height
, width
, height
;
23247 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23250 /* Get the metrics of the base font. We always refer to the current
23252 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23253 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23254 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23255 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23256 base_height
= it
->ascent
+ it
->descent
;
23257 base_width
= font
->average_width
;
23259 /* Get a face ID for the glyph by utilizing a cache (the same way as
23260 done for `escape-glyph' in get_next_display_element). */
23261 if (it
->f
== last_glyphless_glyph_frame
23262 && it
->face_id
== last_glyphless_glyph_face_id
)
23264 face_id
= last_glyphless_glyph_merged_face_id
;
23268 /* Merge the `glyphless-char' face into the current face. */
23269 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23270 last_glyphless_glyph_frame
= it
->f
;
23271 last_glyphless_glyph_face_id
= it
->face_id
;
23272 last_glyphless_glyph_merged_face_id
= face_id
;
23275 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23277 it
->pixel_width
= THIN_SPACE_WIDTH
;
23279 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23281 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23283 width
= CHAR_WIDTH (it
->c
);
23286 else if (width
> 4)
23288 it
->pixel_width
= base_width
* width
;
23290 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23296 unsigned int code
[6];
23298 int ascent
, descent
;
23299 struct font_metrics metrics_upper
, metrics_lower
;
23301 face
= FACE_FROM_ID (it
->f
, face_id
);
23302 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23303 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23305 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23307 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23308 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23309 if (CONSP (acronym
))
23310 acronym
= XCAR (acronym
);
23311 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23315 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23316 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23319 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23320 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23321 upper_len
= (len
+ 1) / 2;
23322 font
->driver
->text_extents (font
, code
, upper_len
,
23324 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23329 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23330 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23331 upper_xoff
= upper_yoff
= 2; /* the typical case */
23332 if (base_width
>= width
)
23334 /* Align the upper to the left, the lower to the right. */
23335 it
->pixel_width
= base_width
;
23336 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23340 /* Center the shorter one. */
23341 it
->pixel_width
= width
;
23342 if (metrics_upper
.width
>= metrics_lower
.width
)
23343 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23346 /* FIXME: This code doesn't look right. It formerly was
23347 missing the "lower_xoff = 0;", which couldn't have
23348 been right since it left lower_xoff uninitialized. */
23350 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23354 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23355 top, bottom, and between upper and lower strings. */
23356 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23357 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23358 /* Center vertically.
23359 H:base_height, D:base_descent
23360 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23362 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23363 descent = D - H/2 + h/2;
23364 lower_yoff = descent - 2 - ld;
23365 upper_yoff = lower_yoff - la - 1 - ud; */
23366 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23367 descent
= it
->descent
- (base_height
- height
) / 2;
23368 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23369 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23370 - metrics_upper
.descent
);
23371 /* Don't make the height shorter than the base height. */
23372 if (height
> base_height
)
23374 it
->ascent
= ascent
;
23375 it
->descent
= descent
;
23379 it
->phys_ascent
= it
->ascent
;
23380 it
->phys_descent
= it
->descent
;
23382 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23383 upper_xoff
, upper_yoff
,
23384 lower_xoff
, lower_yoff
);
23386 take_vertical_position_into_account (it
);
23391 Produce glyphs/get display metrics for the display element IT is
23392 loaded with. See the description of struct it in dispextern.h
23393 for an overview of struct it. */
23396 x_produce_glyphs (struct it
*it
)
23398 int extra_line_spacing
= it
->extra_line_spacing
;
23400 it
->glyph_not_available_p
= 0;
23402 if (it
->what
== IT_CHARACTER
)
23405 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23406 struct font
*font
= face
->font
;
23407 struct font_metrics
*pcm
= NULL
;
23408 int boff
; /* baseline offset */
23412 /* When no suitable font is found, display this character by
23413 the method specified in the first extra slot of
23414 Vglyphless_char_display. */
23415 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23417 xassert (it
->what
== IT_GLYPHLESS
);
23418 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23422 boff
= font
->baseline_offset
;
23423 if (font
->vertical_centering
)
23424 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23426 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23432 if (it
->override_ascent
>= 0)
23434 it
->ascent
= it
->override_ascent
;
23435 it
->descent
= it
->override_descent
;
23436 boff
= it
->override_boff
;
23440 it
->ascent
= FONT_BASE (font
) + boff
;
23441 it
->descent
= FONT_DESCENT (font
) - boff
;
23444 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23446 pcm
= get_per_char_metric (font
, &char2b
);
23447 if (pcm
->width
== 0
23448 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23454 it
->phys_ascent
= pcm
->ascent
+ boff
;
23455 it
->phys_descent
= pcm
->descent
- boff
;
23456 it
->pixel_width
= pcm
->width
;
23460 it
->glyph_not_available_p
= 1;
23461 it
->phys_ascent
= it
->ascent
;
23462 it
->phys_descent
= it
->descent
;
23463 it
->pixel_width
= font
->space_width
;
23466 if (it
->constrain_row_ascent_descent_p
)
23468 if (it
->descent
> it
->max_descent
)
23470 it
->ascent
+= it
->descent
- it
->max_descent
;
23471 it
->descent
= it
->max_descent
;
23473 if (it
->ascent
> it
->max_ascent
)
23475 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23476 it
->ascent
= it
->max_ascent
;
23478 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23479 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23480 extra_line_spacing
= 0;
23483 /* If this is a space inside a region of text with
23484 `space-width' property, change its width. */
23485 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23487 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23489 /* If face has a box, add the box thickness to the character
23490 height. If character has a box line to the left and/or
23491 right, add the box line width to the character's width. */
23492 if (face
->box
!= FACE_NO_BOX
)
23494 int thick
= face
->box_line_width
;
23498 it
->ascent
+= thick
;
23499 it
->descent
+= thick
;
23504 if (it
->start_of_box_run_p
)
23505 it
->pixel_width
+= thick
;
23506 if (it
->end_of_box_run_p
)
23507 it
->pixel_width
+= thick
;
23510 /* If face has an overline, add the height of the overline
23511 (1 pixel) and a 1 pixel margin to the character height. */
23512 if (face
->overline_p
)
23513 it
->ascent
+= overline_margin
;
23515 if (it
->constrain_row_ascent_descent_p
)
23517 if (it
->ascent
> it
->max_ascent
)
23518 it
->ascent
= it
->max_ascent
;
23519 if (it
->descent
> it
->max_descent
)
23520 it
->descent
= it
->max_descent
;
23523 take_vertical_position_into_account (it
);
23525 /* If we have to actually produce glyphs, do it. */
23530 /* Translate a space with a `space-width' property
23531 into a stretch glyph. */
23532 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23533 / FONT_HEIGHT (font
));
23534 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23535 it
->ascent
+ it
->descent
, ascent
);
23540 /* If characters with lbearing or rbearing are displayed
23541 in this line, record that fact in a flag of the
23542 glyph row. This is used to optimize X output code. */
23543 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23544 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23546 if (! stretched_p
&& it
->pixel_width
== 0)
23547 /* We assure that all visible glyphs have at least 1-pixel
23549 it
->pixel_width
= 1;
23551 else if (it
->char_to_display
== '\n')
23553 /* A newline has no width, but we need the height of the
23554 line. But if previous part of the line sets a height,
23555 don't increase that height */
23557 Lisp_Object height
;
23558 Lisp_Object total_height
= Qnil
;
23560 it
->override_ascent
= -1;
23561 it
->pixel_width
= 0;
23564 height
= get_it_property (it
, Qline_height
);
23565 /* Split (line-height total-height) list */
23567 && CONSP (XCDR (height
))
23568 && NILP (XCDR (XCDR (height
))))
23570 total_height
= XCAR (XCDR (height
));
23571 height
= XCAR (height
);
23573 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23575 if (it
->override_ascent
>= 0)
23577 it
->ascent
= it
->override_ascent
;
23578 it
->descent
= it
->override_descent
;
23579 boff
= it
->override_boff
;
23583 it
->ascent
= FONT_BASE (font
) + boff
;
23584 it
->descent
= FONT_DESCENT (font
) - boff
;
23587 if (EQ (height
, Qt
))
23589 if (it
->descent
> it
->max_descent
)
23591 it
->ascent
+= it
->descent
- it
->max_descent
;
23592 it
->descent
= it
->max_descent
;
23594 if (it
->ascent
> it
->max_ascent
)
23596 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23597 it
->ascent
= it
->max_ascent
;
23599 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23600 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23601 it
->constrain_row_ascent_descent_p
= 1;
23602 extra_line_spacing
= 0;
23606 Lisp_Object spacing
;
23608 it
->phys_ascent
= it
->ascent
;
23609 it
->phys_descent
= it
->descent
;
23611 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23612 && face
->box
!= FACE_NO_BOX
23613 && face
->box_line_width
> 0)
23615 it
->ascent
+= face
->box_line_width
;
23616 it
->descent
+= face
->box_line_width
;
23619 && XINT (height
) > it
->ascent
+ it
->descent
)
23620 it
->ascent
= XINT (height
) - it
->descent
;
23622 if (!NILP (total_height
))
23623 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23626 spacing
= get_it_property (it
, Qline_spacing
);
23627 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23629 if (INTEGERP (spacing
))
23631 extra_line_spacing
= XINT (spacing
);
23632 if (!NILP (total_height
))
23633 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23637 else /* i.e. (it->char_to_display == '\t') */
23639 if (font
->space_width
> 0)
23641 int tab_width
= it
->tab_width
* font
->space_width
;
23642 int x
= it
->current_x
+ it
->continuation_lines_width
;
23643 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23645 /* If the distance from the current position to the next tab
23646 stop is less than a space character width, use the
23647 tab stop after that. */
23648 if (next_tab_x
- x
< font
->space_width
)
23649 next_tab_x
+= tab_width
;
23651 it
->pixel_width
= next_tab_x
- x
;
23653 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23654 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23658 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23659 it
->ascent
+ it
->descent
, it
->ascent
);
23664 it
->pixel_width
= 0;
23669 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23671 /* A static composition.
23673 Note: A composition is represented as one glyph in the
23674 glyph matrix. There are no padding glyphs.
23676 Important note: pixel_width, ascent, and descent are the
23677 values of what is drawn by draw_glyphs (i.e. the values of
23678 the overall glyphs composed). */
23679 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23680 int boff
; /* baseline offset */
23681 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23682 int glyph_len
= cmp
->glyph_len
;
23683 struct font
*font
= face
->font
;
23687 /* If we have not yet calculated pixel size data of glyphs of
23688 the composition for the current face font, calculate them
23689 now. Theoretically, we have to check all fonts for the
23690 glyphs, but that requires much time and memory space. So,
23691 here we check only the font of the first glyph. This may
23692 lead to incorrect display, but it's very rare, and C-l
23693 (recenter-top-bottom) can correct the display anyway. */
23694 if (! cmp
->font
|| cmp
->font
!= font
)
23696 /* Ascent and descent of the font of the first character
23697 of this composition (adjusted by baseline offset).
23698 Ascent and descent of overall glyphs should not be less
23699 than these, respectively. */
23700 int font_ascent
, font_descent
, font_height
;
23701 /* Bounding box of the overall glyphs. */
23702 int leftmost
, rightmost
, lowest
, highest
;
23703 int lbearing
, rbearing
;
23704 int i
, width
, ascent
, descent
;
23705 int left_padded
= 0, right_padded
= 0;
23706 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23708 struct font_metrics
*pcm
;
23709 int font_not_found_p
;
23712 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23713 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23715 if (glyph_len
< cmp
->glyph_len
)
23717 for (i
= 0; i
< glyph_len
; i
++)
23719 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23721 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23726 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23727 : IT_CHARPOS (*it
));
23728 /* If no suitable font is found, use the default font. */
23729 font_not_found_p
= font
== NULL
;
23730 if (font_not_found_p
)
23732 face
= face
->ascii_face
;
23735 boff
= font
->baseline_offset
;
23736 if (font
->vertical_centering
)
23737 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23738 font_ascent
= FONT_BASE (font
) + boff
;
23739 font_descent
= FONT_DESCENT (font
) - boff
;
23740 font_height
= FONT_HEIGHT (font
);
23742 cmp
->font
= (void *) font
;
23745 if (! font_not_found_p
)
23747 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23749 pcm
= get_per_char_metric (font
, &char2b
);
23752 /* Initialize the bounding box. */
23755 width
= pcm
->width
;
23756 ascent
= pcm
->ascent
;
23757 descent
= pcm
->descent
;
23758 lbearing
= pcm
->lbearing
;
23759 rbearing
= pcm
->rbearing
;
23763 width
= font
->space_width
;
23764 ascent
= FONT_BASE (font
);
23765 descent
= FONT_DESCENT (font
);
23772 lowest
= - descent
+ boff
;
23773 highest
= ascent
+ boff
;
23775 if (! font_not_found_p
23776 && font
->default_ascent
23777 && CHAR_TABLE_P (Vuse_default_ascent
)
23778 && !NILP (Faref (Vuse_default_ascent
,
23779 make_number (it
->char_to_display
))))
23780 highest
= font
->default_ascent
+ boff
;
23782 /* Draw the first glyph at the normal position. It may be
23783 shifted to right later if some other glyphs are drawn
23785 cmp
->offsets
[i
* 2] = 0;
23786 cmp
->offsets
[i
* 2 + 1] = boff
;
23787 cmp
->lbearing
= lbearing
;
23788 cmp
->rbearing
= rbearing
;
23790 /* Set cmp->offsets for the remaining glyphs. */
23791 for (i
++; i
< glyph_len
; i
++)
23793 int left
, right
, btm
, top
;
23794 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23796 struct face
*this_face
;
23800 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23801 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23802 font
= this_face
->font
;
23808 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23810 pcm
= get_per_char_metric (font
, &char2b
);
23813 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23816 width
= pcm
->width
;
23817 ascent
= pcm
->ascent
;
23818 descent
= pcm
->descent
;
23819 lbearing
= pcm
->lbearing
;
23820 rbearing
= pcm
->rbearing
;
23821 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23823 /* Relative composition with or without
23824 alternate chars. */
23825 left
= (leftmost
+ rightmost
- width
) / 2;
23826 btm
= - descent
+ boff
;
23827 if (font
->relative_compose
23828 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23829 || NILP (Faref (Vignore_relative_composition
,
23830 make_number (ch
)))))
23833 if (- descent
>= font
->relative_compose
)
23834 /* One extra pixel between two glyphs. */
23836 else if (ascent
<= 0)
23837 /* One extra pixel between two glyphs. */
23838 btm
= lowest
- 1 - ascent
- descent
;
23843 /* A composition rule is specified by an integer
23844 value that encodes global and new reference
23845 points (GREF and NREF). GREF and NREF are
23846 specified by numbers as below:
23848 0---1---2 -- ascent
23852 9--10--11 -- center
23854 ---3---4---5--- baseline
23856 6---7---8 -- descent
23858 int rule
= COMPOSITION_RULE (cmp
, i
);
23859 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23861 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23862 grefx
= gref
% 3, nrefx
= nref
% 3;
23863 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23865 xoff
= font_height
* (xoff
- 128) / 256;
23867 yoff
= font_height
* (yoff
- 128) / 256;
23870 + grefx
* (rightmost
- leftmost
) / 2
23871 - nrefx
* width
/ 2
23874 btm
= ((grefy
== 0 ? highest
23876 : grefy
== 2 ? lowest
23877 : (highest
+ lowest
) / 2)
23878 - (nrefy
== 0 ? ascent
+ descent
23879 : nrefy
== 1 ? descent
- boff
23881 : (ascent
+ descent
) / 2)
23885 cmp
->offsets
[i
* 2] = left
;
23886 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23888 /* Update the bounding box of the overall glyphs. */
23891 right
= left
+ width
;
23892 if (left
< leftmost
)
23894 if (right
> rightmost
)
23897 top
= btm
+ descent
+ ascent
;
23903 if (cmp
->lbearing
> left
+ lbearing
)
23904 cmp
->lbearing
= left
+ lbearing
;
23905 if (cmp
->rbearing
< left
+ rbearing
)
23906 cmp
->rbearing
= left
+ rbearing
;
23910 /* If there are glyphs whose x-offsets are negative,
23911 shift all glyphs to the right and make all x-offsets
23915 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23916 cmp
->offsets
[i
* 2] -= leftmost
;
23917 rightmost
-= leftmost
;
23918 cmp
->lbearing
-= leftmost
;
23919 cmp
->rbearing
-= leftmost
;
23922 if (left_padded
&& cmp
->lbearing
< 0)
23924 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23925 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23926 rightmost
-= cmp
->lbearing
;
23927 cmp
->rbearing
-= cmp
->lbearing
;
23930 if (right_padded
&& rightmost
< cmp
->rbearing
)
23932 rightmost
= cmp
->rbearing
;
23935 cmp
->pixel_width
= rightmost
;
23936 cmp
->ascent
= highest
;
23937 cmp
->descent
= - lowest
;
23938 if (cmp
->ascent
< font_ascent
)
23939 cmp
->ascent
= font_ascent
;
23940 if (cmp
->descent
< font_descent
)
23941 cmp
->descent
= font_descent
;
23945 && (cmp
->lbearing
< 0
23946 || cmp
->rbearing
> cmp
->pixel_width
))
23947 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23949 it
->pixel_width
= cmp
->pixel_width
;
23950 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23951 it
->descent
= it
->phys_descent
= cmp
->descent
;
23952 if (face
->box
!= FACE_NO_BOX
)
23954 int thick
= face
->box_line_width
;
23958 it
->ascent
+= thick
;
23959 it
->descent
+= thick
;
23964 if (it
->start_of_box_run_p
)
23965 it
->pixel_width
+= thick
;
23966 if (it
->end_of_box_run_p
)
23967 it
->pixel_width
+= thick
;
23970 /* If face has an overline, add the height of the overline
23971 (1 pixel) and a 1 pixel margin to the character height. */
23972 if (face
->overline_p
)
23973 it
->ascent
+= overline_margin
;
23975 take_vertical_position_into_account (it
);
23976 if (it
->ascent
< 0)
23978 if (it
->descent
< 0)
23982 append_composite_glyph (it
);
23984 else if (it
->what
== IT_COMPOSITION
)
23986 /* A dynamic (automatic) composition. */
23987 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23988 Lisp_Object gstring
;
23989 struct font_metrics metrics
;
23991 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23993 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23996 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23997 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23998 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23999 it
->descent
= it
->phys_descent
= metrics
.descent
;
24000 if (face
->box
!= FACE_NO_BOX
)
24002 int thick
= face
->box_line_width
;
24006 it
->ascent
+= thick
;
24007 it
->descent
+= thick
;
24012 if (it
->start_of_box_run_p
)
24013 it
->pixel_width
+= thick
;
24014 if (it
->end_of_box_run_p
)
24015 it
->pixel_width
+= thick
;
24017 /* If face has an overline, add the height of the overline
24018 (1 pixel) and a 1 pixel margin to the character height. */
24019 if (face
->overline_p
)
24020 it
->ascent
+= overline_margin
;
24021 take_vertical_position_into_account (it
);
24022 if (it
->ascent
< 0)
24024 if (it
->descent
< 0)
24028 append_composite_glyph (it
);
24030 else if (it
->what
== IT_GLYPHLESS
)
24031 produce_glyphless_glyph (it
, 0, Qnil
);
24032 else if (it
->what
== IT_IMAGE
)
24033 produce_image_glyph (it
);
24034 else if (it
->what
== IT_STRETCH
)
24035 produce_stretch_glyph (it
);
24038 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24039 because this isn't true for images with `:ascent 100'. */
24040 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24041 if (it
->area
== TEXT_AREA
)
24042 it
->current_x
+= it
->pixel_width
;
24044 if (extra_line_spacing
> 0)
24046 it
->descent
+= extra_line_spacing
;
24047 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24048 it
->max_extra_line_spacing
= extra_line_spacing
;
24051 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24052 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24053 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24054 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24058 Output LEN glyphs starting at START at the nominal cursor position.
24059 Advance the nominal cursor over the text. The global variable
24060 updated_window contains the window being updated, updated_row is
24061 the glyph row being updated, and updated_area is the area of that
24062 row being updated. */
24065 x_write_glyphs (struct glyph
*start
, int len
)
24069 xassert (updated_window
&& updated_row
);
24072 /* Write glyphs. */
24074 hpos
= start
- updated_row
->glyphs
[updated_area
];
24075 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24076 updated_row
, updated_area
,
24078 DRAW_NORMAL_TEXT
, 0);
24080 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24081 if (updated_area
== TEXT_AREA
24082 && updated_window
->phys_cursor_on_p
24083 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24084 && updated_window
->phys_cursor
.hpos
>= hpos
24085 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24086 updated_window
->phys_cursor_on_p
= 0;
24090 /* Advance the output cursor. */
24091 output_cursor
.hpos
+= len
;
24092 output_cursor
.x
= x
;
24097 Insert LEN glyphs from START at the nominal cursor position. */
24100 x_insert_glyphs (struct glyph
*start
, int len
)
24104 int line_height
, shift_by_width
, shifted_region_width
;
24105 struct glyph_row
*row
;
24106 struct glyph
*glyph
;
24107 int frame_x
, frame_y
;
24110 xassert (updated_window
&& updated_row
);
24112 w
= updated_window
;
24113 f
= XFRAME (WINDOW_FRAME (w
));
24115 /* Get the height of the line we are in. */
24117 line_height
= row
->height
;
24119 /* Get the width of the glyphs to insert. */
24120 shift_by_width
= 0;
24121 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24122 shift_by_width
+= glyph
->pixel_width
;
24124 /* Get the width of the region to shift right. */
24125 shifted_region_width
= (window_box_width (w
, updated_area
)
24130 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24131 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24133 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24134 line_height
, shift_by_width
);
24136 /* Write the glyphs. */
24137 hpos
= start
- row
->glyphs
[updated_area
];
24138 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24140 DRAW_NORMAL_TEXT
, 0);
24142 /* Advance the output cursor. */
24143 output_cursor
.hpos
+= len
;
24144 output_cursor
.x
+= shift_by_width
;
24150 Erase the current text line from the nominal cursor position
24151 (inclusive) to pixel column TO_X (exclusive). The idea is that
24152 everything from TO_X onward is already erased.
24154 TO_X is a pixel position relative to updated_area of
24155 updated_window. TO_X == -1 means clear to the end of this area. */
24158 x_clear_end_of_line (int to_x
)
24161 struct window
*w
= updated_window
;
24162 int max_x
, min_y
, max_y
;
24163 int from_x
, from_y
, to_y
;
24165 xassert (updated_window
&& updated_row
);
24166 f
= XFRAME (w
->frame
);
24168 if (updated_row
->full_width_p
)
24169 max_x
= WINDOW_TOTAL_WIDTH (w
);
24171 max_x
= window_box_width (w
, updated_area
);
24172 max_y
= window_text_bottom_y (w
);
24174 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24175 of window. For TO_X > 0, truncate to end of drawing area. */
24181 to_x
= min (to_x
, max_x
);
24183 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24185 /* Notice if the cursor will be cleared by this operation. */
24186 if (!updated_row
->full_width_p
)
24187 notice_overwritten_cursor (w
, updated_area
,
24188 output_cursor
.x
, -1,
24190 MATRIX_ROW_BOTTOM_Y (updated_row
));
24192 from_x
= output_cursor
.x
;
24194 /* Translate to frame coordinates. */
24195 if (updated_row
->full_width_p
)
24197 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24198 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24202 int area_left
= window_box_left (w
, updated_area
);
24203 from_x
+= area_left
;
24207 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24208 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24209 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24211 /* Prevent inadvertently clearing to end of the X window. */
24212 if (to_x
> from_x
&& to_y
> from_y
)
24215 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24216 to_x
- from_x
, to_y
- from_y
);
24221 #endif /* HAVE_WINDOW_SYSTEM */
24225 /***********************************************************************
24227 ***********************************************************************/
24229 /* Value is the internal representation of the specified cursor type
24230 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24231 of the bar cursor. */
24233 static enum text_cursor_kinds
24234 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24236 enum text_cursor_kinds type
;
24241 if (EQ (arg
, Qbox
))
24242 return FILLED_BOX_CURSOR
;
24244 if (EQ (arg
, Qhollow
))
24245 return HOLLOW_BOX_CURSOR
;
24247 if (EQ (arg
, Qbar
))
24254 && EQ (XCAR (arg
), Qbar
)
24255 && INTEGERP (XCDR (arg
))
24256 && XINT (XCDR (arg
)) >= 0)
24258 *width
= XINT (XCDR (arg
));
24262 if (EQ (arg
, Qhbar
))
24265 return HBAR_CURSOR
;
24269 && EQ (XCAR (arg
), Qhbar
)
24270 && INTEGERP (XCDR (arg
))
24271 && XINT (XCDR (arg
)) >= 0)
24273 *width
= XINT (XCDR (arg
));
24274 return HBAR_CURSOR
;
24277 /* Treat anything unknown as "hollow box cursor".
24278 It was bad to signal an error; people have trouble fixing
24279 .Xdefaults with Emacs, when it has something bad in it. */
24280 type
= HOLLOW_BOX_CURSOR
;
24285 /* Set the default cursor types for specified frame. */
24287 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24292 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24293 FRAME_CURSOR_WIDTH (f
) = width
;
24295 /* By default, set up the blink-off state depending on the on-state. */
24297 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24300 FRAME_BLINK_OFF_CURSOR (f
)
24301 = get_specified_cursor_type (XCDR (tem
), &width
);
24302 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24305 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24309 #ifdef HAVE_WINDOW_SYSTEM
24311 /* Return the cursor we want to be displayed in window W. Return
24312 width of bar/hbar cursor through WIDTH arg. Return with
24313 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24314 (i.e. if the `system caret' should track this cursor).
24316 In a mini-buffer window, we want the cursor only to appear if we
24317 are reading input from this window. For the selected window, we
24318 want the cursor type given by the frame parameter or buffer local
24319 setting of cursor-type. If explicitly marked off, draw no cursor.
24320 In all other cases, we want a hollow box cursor. */
24322 static enum text_cursor_kinds
24323 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24324 int *active_cursor
)
24326 struct frame
*f
= XFRAME (w
->frame
);
24327 struct buffer
*b
= XBUFFER (w
->buffer
);
24328 int cursor_type
= DEFAULT_CURSOR
;
24329 Lisp_Object alt_cursor
;
24330 int non_selected
= 0;
24332 *active_cursor
= 1;
24335 if (cursor_in_echo_area
24336 && FRAME_HAS_MINIBUF_P (f
)
24337 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24339 if (w
== XWINDOW (echo_area_window
))
24341 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24343 *width
= FRAME_CURSOR_WIDTH (f
);
24344 return FRAME_DESIRED_CURSOR (f
);
24347 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24350 *active_cursor
= 0;
24354 /* Detect a nonselected window or nonselected frame. */
24355 else if (w
!= XWINDOW (f
->selected_window
)
24356 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24358 *active_cursor
= 0;
24360 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24366 /* Never display a cursor in a window in which cursor-type is nil. */
24367 if (NILP (BVAR (b
, cursor_type
)))
24370 /* Get the normal cursor type for this window. */
24371 if (EQ (BVAR (b
, cursor_type
), Qt
))
24373 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24374 *width
= FRAME_CURSOR_WIDTH (f
);
24377 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24379 /* Use cursor-in-non-selected-windows instead
24380 for non-selected window or frame. */
24383 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24384 if (!EQ (Qt
, alt_cursor
))
24385 return get_specified_cursor_type (alt_cursor
, width
);
24386 /* t means modify the normal cursor type. */
24387 if (cursor_type
== FILLED_BOX_CURSOR
)
24388 cursor_type
= HOLLOW_BOX_CURSOR
;
24389 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24391 return cursor_type
;
24394 /* Use normal cursor if not blinked off. */
24395 if (!w
->cursor_off_p
)
24397 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24399 if (cursor_type
== FILLED_BOX_CURSOR
)
24401 /* Using a block cursor on large images can be very annoying.
24402 So use a hollow cursor for "large" images.
24403 If image is not transparent (no mask), also use hollow cursor. */
24404 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24405 if (img
!= NULL
&& IMAGEP (img
->spec
))
24407 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24408 where N = size of default frame font size.
24409 This should cover most of the "tiny" icons people may use. */
24411 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24412 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24413 cursor_type
= HOLLOW_BOX_CURSOR
;
24416 else if (cursor_type
!= NO_CURSOR
)
24418 /* Display current only supports BOX and HOLLOW cursors for images.
24419 So for now, unconditionally use a HOLLOW cursor when cursor is
24420 not a solid box cursor. */
24421 cursor_type
= HOLLOW_BOX_CURSOR
;
24424 return cursor_type
;
24427 /* Cursor is blinked off, so determine how to "toggle" it. */
24429 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24430 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24431 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24433 /* Then see if frame has specified a specific blink off cursor type. */
24434 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24436 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24437 return FRAME_BLINK_OFF_CURSOR (f
);
24441 /* Some people liked having a permanently visible blinking cursor,
24442 while others had very strong opinions against it. So it was
24443 decided to remove it. KFS 2003-09-03 */
24445 /* Finally perform built-in cursor blinking:
24446 filled box <-> hollow box
24447 wide [h]bar <-> narrow [h]bar
24448 narrow [h]bar <-> no cursor
24449 other type <-> no cursor */
24451 if (cursor_type
== FILLED_BOX_CURSOR
)
24452 return HOLLOW_BOX_CURSOR
;
24454 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24457 return cursor_type
;
24465 /* Notice when the text cursor of window W has been completely
24466 overwritten by a drawing operation that outputs glyphs in AREA
24467 starting at X0 and ending at X1 in the line starting at Y0 and
24468 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24469 the rest of the line after X0 has been written. Y coordinates
24470 are window-relative. */
24473 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24474 int x0
, int x1
, int y0
, int y1
)
24476 int cx0
, cx1
, cy0
, cy1
;
24477 struct glyph_row
*row
;
24479 if (!w
->phys_cursor_on_p
)
24481 if (area
!= TEXT_AREA
)
24484 if (w
->phys_cursor
.vpos
< 0
24485 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24486 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24487 !(row
->enabled_p
&& row
->displays_text_p
)))
24490 if (row
->cursor_in_fringe_p
)
24492 row
->cursor_in_fringe_p
= 0;
24493 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24494 w
->phys_cursor_on_p
= 0;
24498 cx0
= w
->phys_cursor
.x
;
24499 cx1
= cx0
+ w
->phys_cursor_width
;
24500 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24503 /* The cursor image will be completely removed from the
24504 screen if the output area intersects the cursor area in
24505 y-direction. When we draw in [y0 y1[, and some part of
24506 the cursor is at y < y0, that part must have been drawn
24507 before. When scrolling, the cursor is erased before
24508 actually scrolling, so we don't come here. When not
24509 scrolling, the rows above the old cursor row must have
24510 changed, and in this case these rows must have written
24511 over the cursor image.
24513 Likewise if part of the cursor is below y1, with the
24514 exception of the cursor being in the first blank row at
24515 the buffer and window end because update_text_area
24516 doesn't draw that row. (Except when it does, but
24517 that's handled in update_text_area.) */
24519 cy0
= w
->phys_cursor
.y
;
24520 cy1
= cy0
+ w
->phys_cursor_height
;
24521 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24524 w
->phys_cursor_on_p
= 0;
24527 #endif /* HAVE_WINDOW_SYSTEM */
24530 /************************************************************************
24532 ************************************************************************/
24534 #ifdef HAVE_WINDOW_SYSTEM
24537 Fix the display of area AREA of overlapping row ROW in window W
24538 with respect to the overlapping part OVERLAPS. */
24541 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24542 enum glyph_row_area area
, int overlaps
)
24549 for (i
= 0; i
< row
->used
[area
];)
24551 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24553 int start
= i
, start_x
= x
;
24557 x
+= row
->glyphs
[area
][i
].pixel_width
;
24560 while (i
< row
->used
[area
]
24561 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24563 draw_glyphs (w
, start_x
, row
, area
,
24565 DRAW_NORMAL_TEXT
, overlaps
);
24569 x
+= row
->glyphs
[area
][i
].pixel_width
;
24579 Draw the cursor glyph of window W in glyph row ROW. See the
24580 comment of draw_glyphs for the meaning of HL. */
24583 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24584 enum draw_glyphs_face hl
)
24586 /* If cursor hpos is out of bounds, don't draw garbage. This can
24587 happen in mini-buffer windows when switching between echo area
24588 glyphs and mini-buffer. */
24589 if ((row
->reversed_p
24590 ? (w
->phys_cursor
.hpos
>= 0)
24591 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24593 int on_p
= w
->phys_cursor_on_p
;
24595 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24596 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24598 w
->phys_cursor_on_p
= on_p
;
24600 if (hl
== DRAW_CURSOR
)
24601 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24602 /* When we erase the cursor, and ROW is overlapped by other
24603 rows, make sure that these overlapping parts of other rows
24605 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24607 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24609 if (row
> w
->current_matrix
->rows
24610 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24611 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24612 OVERLAPS_ERASED_CURSOR
);
24614 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24615 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24616 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24617 OVERLAPS_ERASED_CURSOR
);
24624 Erase the image of a cursor of window W from the screen. */
24627 erase_phys_cursor (struct window
*w
)
24629 struct frame
*f
= XFRAME (w
->frame
);
24630 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24631 int hpos
= w
->phys_cursor
.hpos
;
24632 int vpos
= w
->phys_cursor
.vpos
;
24633 int mouse_face_here_p
= 0;
24634 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24635 struct glyph_row
*cursor_row
;
24636 struct glyph
*cursor_glyph
;
24637 enum draw_glyphs_face hl
;
24639 /* No cursor displayed or row invalidated => nothing to do on the
24641 if (w
->phys_cursor_type
== NO_CURSOR
)
24642 goto mark_cursor_off
;
24644 /* VPOS >= active_glyphs->nrows means that window has been resized.
24645 Don't bother to erase the cursor. */
24646 if (vpos
>= active_glyphs
->nrows
)
24647 goto mark_cursor_off
;
24649 /* If row containing cursor is marked invalid, there is nothing we
24651 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24652 if (!cursor_row
->enabled_p
)
24653 goto mark_cursor_off
;
24655 /* If line spacing is > 0, old cursor may only be partially visible in
24656 window after split-window. So adjust visible height. */
24657 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24658 window_text_bottom_y (w
) - cursor_row
->y
);
24660 /* If row is completely invisible, don't attempt to delete a cursor which
24661 isn't there. This can happen if cursor is at top of a window, and
24662 we switch to a buffer with a header line in that window. */
24663 if (cursor_row
->visible_height
<= 0)
24664 goto mark_cursor_off
;
24666 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24667 if (cursor_row
->cursor_in_fringe_p
)
24669 cursor_row
->cursor_in_fringe_p
= 0;
24670 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24671 goto mark_cursor_off
;
24674 /* This can happen when the new row is shorter than the old one.
24675 In this case, either draw_glyphs or clear_end_of_line
24676 should have cleared the cursor. Note that we wouldn't be
24677 able to erase the cursor in this case because we don't have a
24678 cursor glyph at hand. */
24679 if ((cursor_row
->reversed_p
24680 ? (w
->phys_cursor
.hpos
< 0)
24681 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24682 goto mark_cursor_off
;
24684 /* If the cursor is in the mouse face area, redisplay that when
24685 we clear the cursor. */
24686 if (! NILP (hlinfo
->mouse_face_window
)
24687 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24688 /* Don't redraw the cursor's spot in mouse face if it is at the
24689 end of a line (on a newline). The cursor appears there, but
24690 mouse highlighting does not. */
24691 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24692 mouse_face_here_p
= 1;
24694 /* Maybe clear the display under the cursor. */
24695 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24698 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24701 cursor_glyph
= get_phys_cursor_glyph (w
);
24702 if (cursor_glyph
== NULL
)
24703 goto mark_cursor_off
;
24705 width
= cursor_glyph
->pixel_width
;
24706 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24707 x
= w
->phys_cursor
.x
;
24709 width
-= left_x
- x
;
24710 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24711 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24712 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24715 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24718 /* Erase the cursor by redrawing the character underneath it. */
24719 if (mouse_face_here_p
)
24720 hl
= DRAW_MOUSE_FACE
;
24722 hl
= DRAW_NORMAL_TEXT
;
24723 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24726 w
->phys_cursor_on_p
= 0;
24727 w
->phys_cursor_type
= NO_CURSOR
;
24732 Display or clear cursor of window W. If ON is zero, clear the
24733 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24734 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24737 display_and_set_cursor (struct window
*w
, int on
,
24738 int hpos
, int vpos
, int x
, int y
)
24740 struct frame
*f
= XFRAME (w
->frame
);
24741 int new_cursor_type
;
24742 int new_cursor_width
;
24744 struct glyph_row
*glyph_row
;
24745 struct glyph
*glyph
;
24747 /* This is pointless on invisible frames, and dangerous on garbaged
24748 windows and frames; in the latter case, the frame or window may
24749 be in the midst of changing its size, and x and y may be off the
24751 if (! FRAME_VISIBLE_P (f
)
24752 || FRAME_GARBAGED_P (f
)
24753 || vpos
>= w
->current_matrix
->nrows
24754 || hpos
>= w
->current_matrix
->matrix_w
)
24757 /* If cursor is off and we want it off, return quickly. */
24758 if (!on
&& !w
->phys_cursor_on_p
)
24761 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24762 /* If cursor row is not enabled, we don't really know where to
24763 display the cursor. */
24764 if (!glyph_row
->enabled_p
)
24766 w
->phys_cursor_on_p
= 0;
24771 if (!glyph_row
->exact_window_width_line_p
24772 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24773 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24775 xassert (interrupt_input_blocked
);
24777 /* Set new_cursor_type to the cursor we want to be displayed. */
24778 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24779 &new_cursor_width
, &active_cursor
);
24781 /* If cursor is currently being shown and we don't want it to be or
24782 it is in the wrong place, or the cursor type is not what we want,
24784 if (w
->phys_cursor_on_p
24786 || w
->phys_cursor
.x
!= x
24787 || w
->phys_cursor
.y
!= y
24788 || new_cursor_type
!= w
->phys_cursor_type
24789 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24790 && new_cursor_width
!= w
->phys_cursor_width
)))
24791 erase_phys_cursor (w
);
24793 /* Don't check phys_cursor_on_p here because that flag is only set
24794 to zero in some cases where we know that the cursor has been
24795 completely erased, to avoid the extra work of erasing the cursor
24796 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24797 still not be visible, or it has only been partly erased. */
24800 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24801 w
->phys_cursor_height
= glyph_row
->height
;
24803 /* Set phys_cursor_.* before x_draw_.* is called because some
24804 of them may need the information. */
24805 w
->phys_cursor
.x
= x
;
24806 w
->phys_cursor
.y
= glyph_row
->y
;
24807 w
->phys_cursor
.hpos
= hpos
;
24808 w
->phys_cursor
.vpos
= vpos
;
24811 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24812 new_cursor_type
, new_cursor_width
,
24813 on
, active_cursor
);
24817 /* Switch the display of W's cursor on or off, according to the value
24821 update_window_cursor (struct window
*w
, int on
)
24823 /* Don't update cursor in windows whose frame is in the process
24824 of being deleted. */
24825 if (w
->current_matrix
)
24828 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24829 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24835 /* Call update_window_cursor with parameter ON_P on all leaf windows
24836 in the window tree rooted at W. */
24839 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24843 if (!NILP (w
->hchild
))
24844 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24845 else if (!NILP (w
->vchild
))
24846 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24848 update_window_cursor (w
, on_p
);
24850 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24856 Display the cursor on window W, or clear it, according to ON_P.
24857 Don't change the cursor's position. */
24860 x_update_cursor (struct frame
*f
, int on_p
)
24862 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24867 Clear the cursor of window W to background color, and mark the
24868 cursor as not shown. This is used when the text where the cursor
24869 is about to be rewritten. */
24872 x_clear_cursor (struct window
*w
)
24874 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24875 update_window_cursor (w
, 0);
24878 #endif /* HAVE_WINDOW_SYSTEM */
24880 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24883 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24884 int start_hpos
, int end_hpos
,
24885 enum draw_glyphs_face draw
)
24887 #ifdef HAVE_WINDOW_SYSTEM
24888 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24890 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24894 #if defined (HAVE_GPM) || defined (MSDOS)
24895 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24899 /* Display the active region described by mouse_face_* according to DRAW. */
24902 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24904 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24905 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24907 if (/* If window is in the process of being destroyed, don't bother
24909 w
->current_matrix
!= NULL
24910 /* Don't update mouse highlight if hidden */
24911 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24912 /* Recognize when we are called to operate on rows that don't exist
24913 anymore. This can happen when a window is split. */
24914 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24916 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24917 struct glyph_row
*row
, *first
, *last
;
24919 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24920 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24922 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24924 int start_hpos
, end_hpos
, start_x
;
24926 /* For all but the first row, the highlight starts at column 0. */
24929 /* R2L rows have BEG and END in reversed order, but the
24930 screen drawing geometry is always left to right. So
24931 we need to mirror the beginning and end of the
24932 highlighted area in R2L rows. */
24933 if (!row
->reversed_p
)
24935 start_hpos
= hlinfo
->mouse_face_beg_col
;
24936 start_x
= hlinfo
->mouse_face_beg_x
;
24938 else if (row
== last
)
24940 start_hpos
= hlinfo
->mouse_face_end_col
;
24941 start_x
= hlinfo
->mouse_face_end_x
;
24949 else if (row
->reversed_p
&& row
== last
)
24951 start_hpos
= hlinfo
->mouse_face_end_col
;
24952 start_x
= hlinfo
->mouse_face_end_x
;
24962 if (!row
->reversed_p
)
24963 end_hpos
= hlinfo
->mouse_face_end_col
;
24964 else if (row
== first
)
24965 end_hpos
= hlinfo
->mouse_face_beg_col
;
24968 end_hpos
= row
->used
[TEXT_AREA
];
24969 if (draw
== DRAW_NORMAL_TEXT
)
24970 row
->fill_line_p
= 1; /* Clear to end of line */
24973 else if (row
->reversed_p
&& row
== first
)
24974 end_hpos
= hlinfo
->mouse_face_beg_col
;
24977 end_hpos
= row
->used
[TEXT_AREA
];
24978 if (draw
== DRAW_NORMAL_TEXT
)
24979 row
->fill_line_p
= 1; /* Clear to end of line */
24982 if (end_hpos
> start_hpos
)
24984 draw_row_with_mouse_face (w
, start_x
, row
,
24985 start_hpos
, end_hpos
, draw
);
24988 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24992 #ifdef HAVE_WINDOW_SYSTEM
24993 /* When we've written over the cursor, arrange for it to
24994 be displayed again. */
24995 if (FRAME_WINDOW_P (f
)
24996 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24999 display_and_set_cursor (w
, 1,
25000 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25001 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25004 #endif /* HAVE_WINDOW_SYSTEM */
25007 #ifdef HAVE_WINDOW_SYSTEM
25008 /* Change the mouse cursor. */
25009 if (FRAME_WINDOW_P (f
))
25011 if (draw
== DRAW_NORMAL_TEXT
25012 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25013 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25014 else if (draw
== DRAW_MOUSE_FACE
)
25015 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25017 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25019 #endif /* HAVE_WINDOW_SYSTEM */
25023 Clear out the mouse-highlighted active region.
25024 Redraw it un-highlighted first. Value is non-zero if mouse
25025 face was actually drawn unhighlighted. */
25028 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25032 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25034 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25038 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25039 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25040 hlinfo
->mouse_face_window
= Qnil
;
25041 hlinfo
->mouse_face_overlay
= Qnil
;
25045 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25046 within the mouse face on that window. */
25048 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25050 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25052 /* Quickly resolve the easy cases. */
25053 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25054 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25056 if (vpos
< hlinfo
->mouse_face_beg_row
25057 || vpos
> hlinfo
->mouse_face_end_row
)
25059 if (vpos
> hlinfo
->mouse_face_beg_row
25060 && vpos
< hlinfo
->mouse_face_end_row
)
25063 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25065 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25067 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25070 else if ((vpos
== hlinfo
->mouse_face_beg_row
25071 && hpos
>= hlinfo
->mouse_face_beg_col
)
25072 || (vpos
== hlinfo
->mouse_face_end_row
25073 && hpos
< hlinfo
->mouse_face_end_col
))
25078 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25080 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25083 else if ((vpos
== hlinfo
->mouse_face_beg_row
25084 && hpos
<= hlinfo
->mouse_face_beg_col
)
25085 || (vpos
== hlinfo
->mouse_face_end_row
25086 && hpos
> hlinfo
->mouse_face_end_col
))
25094 Non-zero if physical cursor of window W is within mouse face. */
25097 cursor_in_mouse_face_p (struct window
*w
)
25099 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25104 /* Find the glyph rows START_ROW and END_ROW of window W that display
25105 characters between buffer positions START_CHARPOS and END_CHARPOS
25106 (excluding END_CHARPOS). This is similar to row_containing_pos,
25107 but is more accurate when bidi reordering makes buffer positions
25108 change non-linearly with glyph rows. */
25110 rows_from_pos_range (struct window
*w
,
25111 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25112 struct glyph_row
**start
, struct glyph_row
**end
)
25114 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25115 int last_y
= window_text_bottom_y (w
);
25116 struct glyph_row
*row
;
25121 while (!first
->enabled_p
25122 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25125 /* Find the START row. */
25127 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25130 /* A row can potentially be the START row if the range of the
25131 characters it displays intersects the range
25132 [START_CHARPOS..END_CHARPOS). */
25133 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25134 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25135 /* See the commentary in row_containing_pos, for the
25136 explanation of the complicated way to check whether
25137 some position is beyond the end of the characters
25138 displayed by a row. */
25139 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25140 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25141 && !row
->ends_at_zv_p
25142 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25143 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25144 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25145 && !row
->ends_at_zv_p
25146 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25148 /* Found a candidate row. Now make sure at least one of the
25149 glyphs it displays has a charpos from the range
25150 [START_CHARPOS..END_CHARPOS).
25152 This is not obvious because bidi reordering could make
25153 buffer positions of a row be 1,2,3,102,101,100, and if we
25154 want to highlight characters in [50..60), we don't want
25155 this row, even though [50..60) does intersect [1..103),
25156 the range of character positions given by the row's start
25157 and end positions. */
25158 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25159 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25163 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25164 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25173 /* Find the END row. */
25175 /* If the last row is partially visible, start looking for END
25176 from that row, instead of starting from FIRST. */
25177 && !(row
->enabled_p
25178 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25180 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25182 struct glyph_row
*next
= row
+ 1;
25184 if (!next
->enabled_p
25185 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25186 /* The first row >= START whose range of displayed characters
25187 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25188 is the row END + 1. */
25189 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25190 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25191 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25192 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25193 && !next
->ends_at_zv_p
25194 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25195 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25196 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25197 && !next
->ends_at_zv_p
25198 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25205 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25206 but none of the characters it displays are in the range, it is
25208 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25209 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25213 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25214 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25227 /* This function sets the mouse_face_* elements of HLINFO, assuming
25228 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25229 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25230 for the overlay or run of text properties specifying the mouse
25231 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25232 before-string and after-string that must also be highlighted.
25233 COVER_STRING, if non-nil, is a display string that may cover some
25234 or all of the highlighted text. */
25237 mouse_face_from_buffer_pos (Lisp_Object window
,
25238 Mouse_HLInfo
*hlinfo
,
25239 EMACS_INT mouse_charpos
,
25240 EMACS_INT start_charpos
,
25241 EMACS_INT end_charpos
,
25242 Lisp_Object before_string
,
25243 Lisp_Object after_string
,
25244 Lisp_Object cover_string
)
25246 struct window
*w
= XWINDOW (window
);
25247 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25248 struct glyph_row
*r1
, *r2
;
25249 struct glyph
*glyph
, *end
;
25250 EMACS_INT ignore
, pos
;
25253 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25254 xassert (NILP (before_string
) || STRINGP (before_string
));
25255 xassert (NILP (after_string
) || STRINGP (after_string
));
25257 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25258 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25260 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25261 /* If the before-string or display-string contains newlines,
25262 rows_from_pos_range skips to its last row. Move back. */
25263 if (!NILP (before_string
) || !NILP (cover_string
))
25265 struct glyph_row
*prev
;
25266 while ((prev
= r1
- 1, prev
>= first
)
25267 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25268 && prev
->used
[TEXT_AREA
] > 0)
25270 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25271 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25272 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25274 || !(EQ (glyph
->object
, before_string
)
25275 || EQ (glyph
->object
, cover_string
)))
25282 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25283 hlinfo
->mouse_face_past_end
= 1;
25285 else if (!NILP (after_string
))
25287 /* If the after-string has newlines, advance to its last row. */
25288 struct glyph_row
*next
;
25289 struct glyph_row
*last
25290 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25292 for (next
= r2
+ 1;
25294 && next
->used
[TEXT_AREA
] > 0
25295 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25299 /* The rest of the display engine assumes that mouse_face_beg_row is
25300 either above below mouse_face_end_row or identical to it. But
25301 with bidi-reordered continued lines, the row for START_CHARPOS
25302 could be below the row for END_CHARPOS. If so, swap the rows and
25303 store them in correct order. */
25306 struct glyph_row
*tem
= r2
;
25312 hlinfo
->mouse_face_beg_y
= r1
->y
;
25313 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25314 hlinfo
->mouse_face_end_y
= r2
->y
;
25315 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25317 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25318 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25319 could be anywhere in the row and in any order. The strategy
25320 below is to find the leftmost and the rightmost glyph that
25321 belongs to either of these 3 strings, or whose position is
25322 between START_CHARPOS and END_CHARPOS, and highlight all the
25323 glyphs between those two. This may cover more than just the text
25324 between START_CHARPOS and END_CHARPOS if the range of characters
25325 strides the bidi level boundary, e.g. if the beginning is in R2L
25326 text while the end is in L2R text or vice versa. */
25327 if (!r1
->reversed_p
)
25329 /* This row is in a left to right paragraph. Scan it left to
25331 glyph
= r1
->glyphs
[TEXT_AREA
];
25332 end
= glyph
+ r1
->used
[TEXT_AREA
];
25335 /* Skip truncation glyphs at the start of the glyph row. */
25336 if (r1
->displays_text_p
)
25338 && INTEGERP (glyph
->object
)
25339 && glyph
->charpos
< 0;
25341 x
+= glyph
->pixel_width
;
25343 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25344 or COVER_STRING, and the first glyph from buffer whose
25345 position is between START_CHARPOS and END_CHARPOS. */
25347 && !INTEGERP (glyph
->object
)
25348 && !EQ (glyph
->object
, cover_string
)
25349 && !(BUFFERP (glyph
->object
)
25350 && (glyph
->charpos
>= start_charpos
25351 && glyph
->charpos
< end_charpos
));
25354 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25355 are present at buffer positions between START_CHARPOS and
25356 END_CHARPOS, or if they come from an overlay. */
25357 if (EQ (glyph
->object
, before_string
))
25359 pos
= string_buffer_position (before_string
,
25361 /* If pos == 0, it means before_string came from an
25362 overlay, not from a buffer position. */
25363 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25366 else if (EQ (glyph
->object
, after_string
))
25368 pos
= string_buffer_position (after_string
, end_charpos
);
25369 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25372 x
+= glyph
->pixel_width
;
25374 hlinfo
->mouse_face_beg_x
= x
;
25375 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25379 /* This row is in a right to left paragraph. Scan it right to
25383 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25384 glyph
= end
+ r1
->used
[TEXT_AREA
];
25386 /* Skip truncation glyphs at the start of the glyph row. */
25387 if (r1
->displays_text_p
)
25389 && INTEGERP (glyph
->object
)
25390 && glyph
->charpos
< 0;
25394 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25395 or COVER_STRING, and the first glyph from buffer whose
25396 position is between START_CHARPOS and END_CHARPOS. */
25398 && !INTEGERP (glyph
->object
)
25399 && !EQ (glyph
->object
, cover_string
)
25400 && !(BUFFERP (glyph
->object
)
25401 && (glyph
->charpos
>= start_charpos
25402 && glyph
->charpos
< end_charpos
));
25405 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25406 are present at buffer positions between START_CHARPOS and
25407 END_CHARPOS, or if they come from an overlay. */
25408 if (EQ (glyph
->object
, before_string
))
25410 pos
= string_buffer_position (before_string
, start_charpos
);
25411 /* If pos == 0, it means before_string came from an
25412 overlay, not from a buffer position. */
25413 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25416 else if (EQ (glyph
->object
, after_string
))
25418 pos
= string_buffer_position (after_string
, end_charpos
);
25419 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25424 glyph
++; /* first glyph to the right of the highlighted area */
25425 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25426 x
+= g
->pixel_width
;
25427 hlinfo
->mouse_face_beg_x
= x
;
25428 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25431 /* If the highlight ends in a different row, compute GLYPH and END
25432 for the end row. Otherwise, reuse the values computed above for
25433 the row where the highlight begins. */
25436 if (!r2
->reversed_p
)
25438 glyph
= r2
->glyphs
[TEXT_AREA
];
25439 end
= glyph
+ r2
->used
[TEXT_AREA
];
25444 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25445 glyph
= end
+ r2
->used
[TEXT_AREA
];
25449 if (!r2
->reversed_p
)
25451 /* Skip truncation and continuation glyphs near the end of the
25452 row, and also blanks and stretch glyphs inserted by
25453 extend_face_to_end_of_line. */
25455 && INTEGERP ((end
- 1)->object
)
25456 && (end
- 1)->charpos
<= 0)
25458 /* Scan the rest of the glyph row from the end, looking for the
25459 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25460 COVER_STRING, or whose position is between START_CHARPOS
25464 && !INTEGERP (end
->object
)
25465 && !EQ (end
->object
, cover_string
)
25466 && !(BUFFERP (end
->object
)
25467 && (end
->charpos
>= start_charpos
25468 && end
->charpos
< end_charpos
));
25471 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25472 are present at buffer positions between START_CHARPOS and
25473 END_CHARPOS, or if they come from an overlay. */
25474 if (EQ (end
->object
, before_string
))
25476 pos
= string_buffer_position (before_string
, start_charpos
);
25477 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25480 else if (EQ (end
->object
, after_string
))
25482 pos
= string_buffer_position (after_string
, end_charpos
);
25483 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25487 /* Find the X coordinate of the last glyph to be highlighted. */
25488 for (; glyph
<= end
; ++glyph
)
25489 x
+= glyph
->pixel_width
;
25491 hlinfo
->mouse_face_end_x
= x
;
25492 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25496 /* Skip truncation and continuation glyphs near the end of the
25497 row, and also blanks and stretch glyphs inserted by
25498 extend_face_to_end_of_line. */
25502 && INTEGERP (end
->object
)
25503 && end
->charpos
<= 0)
25505 x
+= end
->pixel_width
;
25508 /* Scan the rest of the glyph row from the end, looking for the
25509 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25510 COVER_STRING, or whose position is between START_CHARPOS
25514 && !INTEGERP (end
->object
)
25515 && !EQ (end
->object
, cover_string
)
25516 && !(BUFFERP (end
->object
)
25517 && (end
->charpos
>= start_charpos
25518 && end
->charpos
< end_charpos
));
25521 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25522 are present at buffer positions between START_CHARPOS and
25523 END_CHARPOS, or if they come from an overlay. */
25524 if (EQ (end
->object
, before_string
))
25526 pos
= string_buffer_position (before_string
, start_charpos
);
25527 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25530 else if (EQ (end
->object
, after_string
))
25532 pos
= string_buffer_position (after_string
, end_charpos
);
25533 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25536 x
+= end
->pixel_width
;
25538 hlinfo
->mouse_face_end_x
= x
;
25539 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25542 hlinfo
->mouse_face_window
= window
;
25543 hlinfo
->mouse_face_face_id
25544 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25546 !hlinfo
->mouse_face_hidden
, -1);
25547 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25550 /* The following function is not used anymore (replaced with
25551 mouse_face_from_string_pos), but I leave it here for the time
25552 being, in case someone would. */
25554 #if 0 /* not used */
25556 /* Find the position of the glyph for position POS in OBJECT in
25557 window W's current matrix, and return in *X, *Y the pixel
25558 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25560 RIGHT_P non-zero means return the position of the right edge of the
25561 glyph, RIGHT_P zero means return the left edge position.
25563 If no glyph for POS exists in the matrix, return the position of
25564 the glyph with the next smaller position that is in the matrix, if
25565 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25566 exists in the matrix, return the position of the glyph with the
25567 next larger position in OBJECT.
25569 Value is non-zero if a glyph was found. */
25572 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25573 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25575 int yb
= window_text_bottom_y (w
);
25576 struct glyph_row
*r
;
25577 struct glyph
*best_glyph
= NULL
;
25578 struct glyph_row
*best_row
= NULL
;
25581 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25582 r
->enabled_p
&& r
->y
< yb
;
25585 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25586 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25589 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25590 if (EQ (g
->object
, object
))
25592 if (g
->charpos
== pos
)
25599 else if (best_glyph
== NULL
25600 || ((eabs (g
->charpos
- pos
)
25601 < eabs (best_glyph
->charpos
- pos
))
25604 : g
->charpos
> pos
)))
25618 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25622 *x
+= best_glyph
->pixel_width
;
25627 *vpos
= best_row
- w
->current_matrix
->rows
;
25630 return best_glyph
!= NULL
;
25632 #endif /* not used */
25634 /* Find the positions of the first and the last glyphs in window W's
25635 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25636 (assumed to be a string), and return in HLINFO's mouse_face_*
25637 members the pixel and column/row coordinates of those glyphs. */
25640 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25641 Lisp_Object object
,
25642 EMACS_INT startpos
, EMACS_INT endpos
)
25644 int yb
= window_text_bottom_y (w
);
25645 struct glyph_row
*r
;
25646 struct glyph
*g
, *e
;
25650 /* Find the glyph row with at least one position in the range
25651 [STARTPOS..ENDPOS], and the first glyph in that row whose
25652 position belongs to that range. */
25653 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25654 r
->enabled_p
&& r
->y
< yb
;
25657 if (!r
->reversed_p
)
25659 g
= r
->glyphs
[TEXT_AREA
];
25660 e
= g
+ r
->used
[TEXT_AREA
];
25661 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25662 if (EQ (g
->object
, object
)
25663 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25665 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25666 hlinfo
->mouse_face_beg_y
= r
->y
;
25667 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25668 hlinfo
->mouse_face_beg_x
= gx
;
25677 e
= r
->glyphs
[TEXT_AREA
];
25678 g
= e
+ r
->used
[TEXT_AREA
];
25679 for ( ; g
> e
; --g
)
25680 if (EQ ((g
-1)->object
, object
)
25681 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25683 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25684 hlinfo
->mouse_face_beg_y
= r
->y
;
25685 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25686 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25687 gx
+= g1
->pixel_width
;
25688 hlinfo
->mouse_face_beg_x
= gx
;
25700 /* Starting with the next row, look for the first row which does NOT
25701 include any glyphs whose positions are in the range. */
25702 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25704 g
= r
->glyphs
[TEXT_AREA
];
25705 e
= g
+ r
->used
[TEXT_AREA
];
25707 for ( ; g
< e
; ++g
)
25708 if (EQ (g
->object
, object
)
25709 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25718 /* The highlighted region ends on the previous row. */
25721 /* Set the end row and its vertical pixel coordinate. */
25722 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25723 hlinfo
->mouse_face_end_y
= r
->y
;
25725 /* Compute and set the end column and the end column's horizontal
25726 pixel coordinate. */
25727 if (!r
->reversed_p
)
25729 g
= r
->glyphs
[TEXT_AREA
];
25730 e
= g
+ r
->used
[TEXT_AREA
];
25731 for ( ; e
> g
; --e
)
25732 if (EQ ((e
-1)->object
, object
)
25733 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25735 hlinfo
->mouse_face_end_col
= e
- g
;
25737 for (gx
= r
->x
; g
< e
; ++g
)
25738 gx
+= g
->pixel_width
;
25739 hlinfo
->mouse_face_end_x
= gx
;
25743 e
= r
->glyphs
[TEXT_AREA
];
25744 g
= e
+ r
->used
[TEXT_AREA
];
25745 for (gx
= r
->x
; e
< g
; ++e
)
25747 if (EQ (e
->object
, object
)
25748 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25750 gx
+= e
->pixel_width
;
25752 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25753 hlinfo
->mouse_face_end_x
= gx
;
25757 #ifdef HAVE_WINDOW_SYSTEM
25759 /* See if position X, Y is within a hot-spot of an image. */
25762 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25764 if (!CONSP (hot_spot
))
25767 if (EQ (XCAR (hot_spot
), Qrect
))
25769 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25770 Lisp_Object rect
= XCDR (hot_spot
);
25774 if (!CONSP (XCAR (rect
)))
25776 if (!CONSP (XCDR (rect
)))
25778 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25780 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25782 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25784 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25788 else if (EQ (XCAR (hot_spot
), Qcircle
))
25790 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25791 Lisp_Object circ
= XCDR (hot_spot
);
25792 Lisp_Object lr
, lx0
, ly0
;
25794 && CONSP (XCAR (circ
))
25795 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25796 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25797 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25799 double r
= XFLOATINT (lr
);
25800 double dx
= XINT (lx0
) - x
;
25801 double dy
= XINT (ly0
) - y
;
25802 return (dx
* dx
+ dy
* dy
<= r
* r
);
25805 else if (EQ (XCAR (hot_spot
), Qpoly
))
25807 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25808 if (VECTORP (XCDR (hot_spot
)))
25810 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25811 Lisp_Object
*poly
= v
->contents
;
25812 int n
= v
->header
.size
;
25815 Lisp_Object lx
, ly
;
25818 /* Need an even number of coordinates, and at least 3 edges. */
25819 if (n
< 6 || n
& 1)
25822 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25823 If count is odd, we are inside polygon. Pixels on edges
25824 may or may not be included depending on actual geometry of the
25826 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25827 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25829 x0
= XINT (lx
), y0
= XINT (ly
);
25830 for (i
= 0; i
< n
; i
+= 2)
25832 int x1
= x0
, y1
= y0
;
25833 if ((lx
= poly
[i
], !INTEGERP (lx
))
25834 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25836 x0
= XINT (lx
), y0
= XINT (ly
);
25838 /* Does this segment cross the X line? */
25846 if (y
> y0
&& y
> y1
)
25848 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25858 find_hot_spot (Lisp_Object map
, int x
, int y
)
25860 while (CONSP (map
))
25862 if (CONSP (XCAR (map
))
25863 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25871 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25873 doc
: /* Lookup in image map MAP coordinates X and Y.
25874 An image map is an alist where each element has the format (AREA ID PLIST).
25875 An AREA is specified as either a rectangle, a circle, or a polygon:
25876 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25877 pixel coordinates of the upper left and bottom right corners.
25878 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25879 and the radius of the circle; r may be a float or integer.
25880 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25881 vector describes one corner in the polygon.
25882 Returns the alist element for the first matching AREA in MAP. */)
25883 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25891 return find_hot_spot (map
, XINT (x
), XINT (y
));
25895 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25897 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25899 /* Do not change cursor shape while dragging mouse. */
25900 if (!NILP (do_mouse_tracking
))
25903 if (!NILP (pointer
))
25905 if (EQ (pointer
, Qarrow
))
25906 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25907 else if (EQ (pointer
, Qhand
))
25908 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25909 else if (EQ (pointer
, Qtext
))
25910 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25911 else if (EQ (pointer
, intern ("hdrag")))
25912 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25913 #ifdef HAVE_X_WINDOWS
25914 else if (EQ (pointer
, intern ("vdrag")))
25915 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25917 else if (EQ (pointer
, intern ("hourglass")))
25918 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25919 else if (EQ (pointer
, Qmodeline
))
25920 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25922 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25925 if (cursor
!= No_Cursor
)
25926 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25929 #endif /* HAVE_WINDOW_SYSTEM */
25931 /* Take proper action when mouse has moved to the mode or header line
25932 or marginal area AREA of window W, x-position X and y-position Y.
25933 X is relative to the start of the text display area of W, so the
25934 width of bitmap areas and scroll bars must be subtracted to get a
25935 position relative to the start of the mode line. */
25938 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25939 enum window_part area
)
25941 struct window
*w
= XWINDOW (window
);
25942 struct frame
*f
= XFRAME (w
->frame
);
25943 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25944 #ifdef HAVE_WINDOW_SYSTEM
25945 Display_Info
*dpyinfo
;
25947 Cursor cursor
= No_Cursor
;
25948 Lisp_Object pointer
= Qnil
;
25949 int dx
, dy
, width
, height
;
25951 Lisp_Object string
, object
= Qnil
;
25952 Lisp_Object pos
, help
;
25954 Lisp_Object mouse_face
;
25955 int original_x_pixel
= x
;
25956 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25957 struct glyph_row
*row
;
25959 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25964 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25965 returns them in row/column units! */
25966 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25967 &object
, &dx
, &dy
, &width
, &height
);
25969 row
= (area
== ON_MODE_LINE
25970 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25971 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25973 /* Find the glyph under the mouse pointer. */
25974 if (row
->mode_line_p
&& row
->enabled_p
)
25976 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25977 end
= glyph
+ row
->used
[TEXT_AREA
];
25979 for (x0
= original_x_pixel
;
25980 glyph
< end
&& x0
>= glyph
->pixel_width
;
25982 x0
-= glyph
->pixel_width
;
25990 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25991 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25992 returns them in row/column units! */
25993 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25994 &object
, &dx
, &dy
, &width
, &height
);
25999 #ifdef HAVE_WINDOW_SYSTEM
26000 if (IMAGEP (object
))
26002 Lisp_Object image_map
, hotspot
;
26003 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26005 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26007 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26011 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26012 If so, we could look for mouse-enter, mouse-leave
26013 properties in PLIST (and do something...). */
26014 hotspot
= XCDR (hotspot
);
26015 if (CONSP (hotspot
)
26016 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26018 pointer
= Fplist_get (plist
, Qpointer
);
26019 if (NILP (pointer
))
26021 help
= Fplist_get (plist
, Qhelp_echo
);
26024 help_echo_string
= help
;
26025 /* Is this correct? ++kfs */
26026 XSETWINDOW (help_echo_window
, w
);
26027 help_echo_object
= w
->buffer
;
26028 help_echo_pos
= charpos
;
26032 if (NILP (pointer
))
26033 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26035 #endif /* HAVE_WINDOW_SYSTEM */
26037 if (STRINGP (string
))
26039 pos
= make_number (charpos
);
26040 /* If we're on a string with `help-echo' text property, arrange
26041 for the help to be displayed. This is done by setting the
26042 global variable help_echo_string to the help string. */
26045 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26048 help_echo_string
= help
;
26049 XSETWINDOW (help_echo_window
, w
);
26050 help_echo_object
= string
;
26051 help_echo_pos
= charpos
;
26055 #ifdef HAVE_WINDOW_SYSTEM
26056 if (FRAME_WINDOW_P (f
))
26058 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26059 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26060 if (NILP (pointer
))
26061 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26063 /* Change the mouse pointer according to what is under X/Y. */
26065 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26068 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26069 if (!KEYMAPP (map
))
26070 map
= Fget_text_property (pos
, Qkeymap
, string
);
26071 if (!KEYMAPP (map
))
26072 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26077 /* Change the mouse face according to what is under X/Y. */
26078 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26079 if (!NILP (mouse_face
)
26080 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26085 struct glyph
* tmp_glyph
;
26089 int total_pixel_width
;
26090 EMACS_INT begpos
, endpos
, ignore
;
26094 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26095 Qmouse_face
, string
, Qnil
);
26101 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26103 endpos
= SCHARS (string
);
26107 /* Calculate the glyph position GPOS of GLYPH in the
26108 displayed string, relative to the beginning of the
26109 highlighted part of the string.
26111 Note: GPOS is different from CHARPOS. CHARPOS is the
26112 position of GLYPH in the internal string object. A mode
26113 line string format has structures which are converted to
26114 a flattened string by the Emacs Lisp interpreter. The
26115 internal string is an element of those structures. The
26116 displayed string is the flattened string. */
26117 tmp_glyph
= row_start_glyph
;
26118 while (tmp_glyph
< glyph
26119 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26120 && begpos
<= tmp_glyph
->charpos
26121 && tmp_glyph
->charpos
< endpos
)))
26123 gpos
= glyph
- tmp_glyph
;
26125 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26126 the highlighted part of the displayed string to which
26127 GLYPH belongs. Note: GSEQ_LENGTH is different from
26128 SCHARS (STRING), because the latter returns the length of
26129 the internal string. */
26130 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26132 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26133 && begpos
<= tmp_glyph
->charpos
26134 && tmp_glyph
->charpos
< endpos
));
26137 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26139 /* Calculate the total pixel width of all the glyphs between
26140 the beginning of the highlighted area and GLYPH. */
26141 total_pixel_width
= 0;
26142 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26143 total_pixel_width
+= tmp_glyph
->pixel_width
;
26145 /* Pre calculation of re-rendering position. Note: X is in
26146 column units here, after the call to mode_line_string or
26147 marginal_area_string. */
26149 vpos
= (area
== ON_MODE_LINE
26150 ? (w
->current_matrix
)->nrows
- 1
26153 /* If GLYPH's position is included in the region that is
26154 already drawn in mouse face, we have nothing to do. */
26155 if ( EQ (window
, hlinfo
->mouse_face_window
)
26156 && (!row
->reversed_p
26157 ? (hlinfo
->mouse_face_beg_col
<= hpos
26158 && hpos
< hlinfo
->mouse_face_end_col
)
26159 /* In R2L rows we swap BEG and END, see below. */
26160 : (hlinfo
->mouse_face_end_col
<= hpos
26161 && hpos
< hlinfo
->mouse_face_beg_col
))
26162 && hlinfo
->mouse_face_beg_row
== vpos
)
26165 if (clear_mouse_face (hlinfo
))
26166 cursor
= No_Cursor
;
26168 if (!row
->reversed_p
)
26170 hlinfo
->mouse_face_beg_col
= hpos
;
26171 hlinfo
->mouse_face_beg_x
= original_x_pixel
26172 - (total_pixel_width
+ dx
);
26173 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26174 hlinfo
->mouse_face_end_x
= 0;
26178 /* In R2L rows, show_mouse_face expects BEG and END
26179 coordinates to be swapped. */
26180 hlinfo
->mouse_face_end_col
= hpos
;
26181 hlinfo
->mouse_face_end_x
= original_x_pixel
26182 - (total_pixel_width
+ dx
);
26183 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26184 hlinfo
->mouse_face_beg_x
= 0;
26187 hlinfo
->mouse_face_beg_row
= vpos
;
26188 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26189 hlinfo
->mouse_face_beg_y
= 0;
26190 hlinfo
->mouse_face_end_y
= 0;
26191 hlinfo
->mouse_face_past_end
= 0;
26192 hlinfo
->mouse_face_window
= window
;
26194 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26200 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26202 if (NILP (pointer
))
26205 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26206 clear_mouse_face (hlinfo
);
26208 #ifdef HAVE_WINDOW_SYSTEM
26209 if (FRAME_WINDOW_P (f
))
26210 define_frame_cursor1 (f
, cursor
, pointer
);
26216 Take proper action when the mouse has moved to position X, Y on
26217 frame F as regards highlighting characters that have mouse-face
26218 properties. Also de-highlighting chars where the mouse was before.
26219 X and Y can be negative or out of range. */
26222 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26224 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26225 enum window_part part
;
26226 Lisp_Object window
;
26228 Cursor cursor
= No_Cursor
;
26229 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26232 /* When a menu is active, don't highlight because this looks odd. */
26233 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26234 if (popup_activated ())
26238 if (NILP (Vmouse_highlight
)
26239 || !f
->glyphs_initialized_p
26240 || f
->pointer_invisible
)
26243 hlinfo
->mouse_face_mouse_x
= x
;
26244 hlinfo
->mouse_face_mouse_y
= y
;
26245 hlinfo
->mouse_face_mouse_frame
= f
;
26247 if (hlinfo
->mouse_face_defer
)
26250 if (gc_in_progress
)
26252 hlinfo
->mouse_face_deferred_gc
= 1;
26256 /* Which window is that in? */
26257 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26259 /* If we were displaying active text in another window, clear that.
26260 Also clear if we move out of text area in same window. */
26261 if (! EQ (window
, hlinfo
->mouse_face_window
)
26262 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26263 && !NILP (hlinfo
->mouse_face_window
)))
26264 clear_mouse_face (hlinfo
);
26266 /* Not on a window -> return. */
26267 if (!WINDOWP (window
))
26270 /* Reset help_echo_string. It will get recomputed below. */
26271 help_echo_string
= Qnil
;
26273 /* Convert to window-relative pixel coordinates. */
26274 w
= XWINDOW (window
);
26275 frame_to_window_pixel_xy (w
, &x
, &y
);
26277 #ifdef HAVE_WINDOW_SYSTEM
26278 /* Handle tool-bar window differently since it doesn't display a
26280 if (EQ (window
, f
->tool_bar_window
))
26282 note_tool_bar_highlight (f
, x
, y
);
26287 /* Mouse is on the mode, header line or margin? */
26288 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26289 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26291 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26295 #ifdef HAVE_WINDOW_SYSTEM
26296 if (part
== ON_VERTICAL_BORDER
)
26298 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26299 help_echo_string
= build_string ("drag-mouse-1: resize");
26301 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26302 || part
== ON_SCROLL_BAR
)
26303 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26305 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26308 /* Are we in a window whose display is up to date?
26309 And verify the buffer's text has not changed. */
26310 b
= XBUFFER (w
->buffer
);
26311 if (part
== ON_TEXT
26312 && EQ (w
->window_end_valid
, w
->buffer
)
26313 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26314 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26316 int hpos
, vpos
, dx
, dy
, area
;
26318 struct glyph
*glyph
;
26319 Lisp_Object object
;
26320 Lisp_Object mouse_face
= Qnil
, position
;
26321 Lisp_Object
*overlay_vec
= NULL
;
26322 ptrdiff_t i
, noverlays
;
26323 struct buffer
*obuf
;
26324 EMACS_INT obegv
, ozv
;
26327 /* Find the glyph under X/Y. */
26328 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26330 #ifdef HAVE_WINDOW_SYSTEM
26331 /* Look for :pointer property on image. */
26332 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26334 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26335 if (img
!= NULL
&& IMAGEP (img
->spec
))
26337 Lisp_Object image_map
, hotspot
;
26338 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26340 && (hotspot
= find_hot_spot (image_map
,
26341 glyph
->slice
.img
.x
+ dx
,
26342 glyph
->slice
.img
.y
+ dy
),
26344 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26348 /* Could check XCAR (hotspot) to see if we enter/leave
26350 If so, we could look for mouse-enter, mouse-leave
26351 properties in PLIST (and do something...). */
26352 hotspot
= XCDR (hotspot
);
26353 if (CONSP (hotspot
)
26354 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26356 pointer
= Fplist_get (plist
, Qpointer
);
26357 if (NILP (pointer
))
26359 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26360 if (!NILP (help_echo_string
))
26362 help_echo_window
= window
;
26363 help_echo_object
= glyph
->object
;
26364 help_echo_pos
= glyph
->charpos
;
26368 if (NILP (pointer
))
26369 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26372 #endif /* HAVE_WINDOW_SYSTEM */
26374 /* Clear mouse face if X/Y not over text. */
26376 || area
!= TEXT_AREA
26377 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26378 /* Glyph's OBJECT is an integer for glyphs inserted by the
26379 display engine for its internal purposes, like truncation
26380 and continuation glyphs and blanks beyond the end of
26381 line's text on text terminals. If we are over such a
26382 glyph, we are not over any text. */
26383 || INTEGERP (glyph
->object
)
26384 /* R2L rows have a stretch glyph at their front, which
26385 stands for no text, whereas L2R rows have no glyphs at
26386 all beyond the end of text. Treat such stretch glyphs
26387 like we do with NULL glyphs in L2R rows. */
26388 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26389 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26390 && glyph
->type
== STRETCH_GLYPH
26391 && glyph
->avoid_cursor_p
))
26393 if (clear_mouse_face (hlinfo
))
26394 cursor
= No_Cursor
;
26395 #ifdef HAVE_WINDOW_SYSTEM
26396 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26398 if (area
!= TEXT_AREA
)
26399 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26401 pointer
= Vvoid_text_area_pointer
;
26407 pos
= glyph
->charpos
;
26408 object
= glyph
->object
;
26409 if (!STRINGP (object
) && !BUFFERP (object
))
26412 /* If we get an out-of-range value, return now; avoid an error. */
26413 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26416 /* Make the window's buffer temporarily current for
26417 overlays_at and compute_char_face. */
26418 obuf
= current_buffer
;
26419 current_buffer
= b
;
26425 /* Is this char mouse-active or does it have help-echo? */
26426 position
= make_number (pos
);
26428 if (BUFFERP (object
))
26430 /* Put all the overlays we want in a vector in overlay_vec. */
26431 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26432 /* Sort overlays into increasing priority order. */
26433 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26438 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26441 cursor
= No_Cursor
;
26443 /* Check mouse-face highlighting. */
26445 /* If there exists an overlay with mouse-face overlapping
26446 the one we are currently highlighting, we have to
26447 check if we enter the overlapping overlay, and then
26448 highlight only that. */
26449 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26450 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26452 /* Find the highest priority overlay with a mouse-face. */
26453 Lisp_Object overlay
= Qnil
;
26454 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26456 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26457 if (!NILP (mouse_face
))
26458 overlay
= overlay_vec
[i
];
26461 /* If we're highlighting the same overlay as before, there's
26462 no need to do that again. */
26463 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26464 goto check_help_echo
;
26465 hlinfo
->mouse_face_overlay
= overlay
;
26467 /* Clear the display of the old active region, if any. */
26468 if (clear_mouse_face (hlinfo
))
26469 cursor
= No_Cursor
;
26471 /* If no overlay applies, get a text property. */
26472 if (NILP (overlay
))
26473 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26475 /* Next, compute the bounds of the mouse highlighting and
26477 if (!NILP (mouse_face
) && STRINGP (object
))
26479 /* The mouse-highlighting comes from a display string
26480 with a mouse-face. */
26484 s
= Fprevious_single_property_change
26485 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26486 e
= Fnext_single_property_change
26487 (position
, Qmouse_face
, object
, Qnil
);
26489 s
= make_number (0);
26491 e
= make_number (SCHARS (object
) - 1);
26492 mouse_face_from_string_pos (w
, hlinfo
, object
,
26493 XINT (s
), XINT (e
));
26494 hlinfo
->mouse_face_past_end
= 0;
26495 hlinfo
->mouse_face_window
= window
;
26496 hlinfo
->mouse_face_face_id
26497 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26498 glyph
->face_id
, 1);
26499 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26500 cursor
= No_Cursor
;
26504 /* The mouse-highlighting, if any, comes from an overlay
26505 or text property in the buffer. */
26506 Lisp_Object buffer
IF_LINT (= Qnil
);
26507 Lisp_Object cover_string
IF_LINT (= Qnil
);
26509 if (STRINGP (object
))
26511 /* If we are on a display string with no mouse-face,
26512 check if the text under it has one. */
26513 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26514 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26515 pos
= string_buffer_position (object
, start
);
26518 mouse_face
= get_char_property_and_overlay
26519 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26520 buffer
= w
->buffer
;
26521 cover_string
= object
;
26527 cover_string
= Qnil
;
26530 if (!NILP (mouse_face
))
26532 Lisp_Object before
, after
;
26533 Lisp_Object before_string
, after_string
;
26534 /* To correctly find the limits of mouse highlight
26535 in a bidi-reordered buffer, we must not use the
26536 optimization of limiting the search in
26537 previous-single-property-change and
26538 next-single-property-change, because
26539 rows_from_pos_range needs the real start and end
26540 positions to DTRT in this case. That's because
26541 the first row visible in a window does not
26542 necessarily display the character whose position
26543 is the smallest. */
26545 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26546 ? Fmarker_position (w
->start
)
26549 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26550 ? make_number (BUF_Z (XBUFFER (buffer
))
26551 - XFASTINT (w
->window_end_pos
))
26554 if (NILP (overlay
))
26556 /* Handle the text property case. */
26557 before
= Fprevious_single_property_change
26558 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26559 after
= Fnext_single_property_change
26560 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26561 before_string
= after_string
= Qnil
;
26565 /* Handle the overlay case. */
26566 before
= Foverlay_start (overlay
);
26567 after
= Foverlay_end (overlay
);
26568 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26569 after_string
= Foverlay_get (overlay
, Qafter_string
);
26571 if (!STRINGP (before_string
)) before_string
= Qnil
;
26572 if (!STRINGP (after_string
)) after_string
= Qnil
;
26575 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26578 before_string
, after_string
,
26580 cursor
= No_Cursor
;
26587 /* Look for a `help-echo' property. */
26588 if (NILP (help_echo_string
)) {
26589 Lisp_Object help
, overlay
;
26591 /* Check overlays first. */
26592 help
= overlay
= Qnil
;
26593 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26595 overlay
= overlay_vec
[i
];
26596 help
= Foverlay_get (overlay
, Qhelp_echo
);
26601 help_echo_string
= help
;
26602 help_echo_window
= window
;
26603 help_echo_object
= overlay
;
26604 help_echo_pos
= pos
;
26608 Lisp_Object obj
= glyph
->object
;
26609 EMACS_INT charpos
= glyph
->charpos
;
26611 /* Try text properties. */
26614 && charpos
< SCHARS (obj
))
26616 help
= Fget_text_property (make_number (charpos
),
26620 /* If the string itself doesn't specify a help-echo,
26621 see if the buffer text ``under'' it does. */
26622 struct glyph_row
*r
26623 = MATRIX_ROW (w
->current_matrix
, vpos
);
26624 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26625 EMACS_INT p
= string_buffer_position (obj
, start
);
26628 help
= Fget_char_property (make_number (p
),
26629 Qhelp_echo
, w
->buffer
);
26638 else if (BUFFERP (obj
)
26641 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26646 help_echo_string
= help
;
26647 help_echo_window
= window
;
26648 help_echo_object
= obj
;
26649 help_echo_pos
= charpos
;
26654 #ifdef HAVE_WINDOW_SYSTEM
26655 /* Look for a `pointer' property. */
26656 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26658 /* Check overlays first. */
26659 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26660 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26662 if (NILP (pointer
))
26664 Lisp_Object obj
= glyph
->object
;
26665 EMACS_INT charpos
= glyph
->charpos
;
26667 /* Try text properties. */
26670 && charpos
< SCHARS (obj
))
26672 pointer
= Fget_text_property (make_number (charpos
),
26674 if (NILP (pointer
))
26676 /* If the string itself doesn't specify a pointer,
26677 see if the buffer text ``under'' it does. */
26678 struct glyph_row
*r
26679 = MATRIX_ROW (w
->current_matrix
, vpos
);
26680 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26681 EMACS_INT p
= string_buffer_position (obj
, start
);
26683 pointer
= Fget_char_property (make_number (p
),
26684 Qpointer
, w
->buffer
);
26687 else if (BUFFERP (obj
)
26690 pointer
= Fget_text_property (make_number (charpos
),
26694 #endif /* HAVE_WINDOW_SYSTEM */
26698 current_buffer
= obuf
;
26703 #ifdef HAVE_WINDOW_SYSTEM
26704 if (FRAME_WINDOW_P (f
))
26705 define_frame_cursor1 (f
, cursor
, pointer
);
26707 /* This is here to prevent a compiler error, about "label at end of
26708 compound statement". */
26715 Clear any mouse-face on window W. This function is part of the
26716 redisplay interface, and is called from try_window_id and similar
26717 functions to ensure the mouse-highlight is off. */
26720 x_clear_window_mouse_face (struct window
*w
)
26722 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26723 Lisp_Object window
;
26726 XSETWINDOW (window
, w
);
26727 if (EQ (window
, hlinfo
->mouse_face_window
))
26728 clear_mouse_face (hlinfo
);
26734 Just discard the mouse face information for frame F, if any.
26735 This is used when the size of F is changed. */
26738 cancel_mouse_face (struct frame
*f
)
26740 Lisp_Object window
;
26741 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26743 window
= hlinfo
->mouse_face_window
;
26744 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26746 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26747 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26748 hlinfo
->mouse_face_window
= Qnil
;
26754 /***********************************************************************
26756 ***********************************************************************/
26758 #ifdef HAVE_WINDOW_SYSTEM
26760 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26761 which intersects rectangle R. R is in window-relative coordinates. */
26764 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26765 enum glyph_row_area area
)
26767 struct glyph
*first
= row
->glyphs
[area
];
26768 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26769 struct glyph
*last
;
26770 int first_x
, start_x
, x
;
26772 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26773 /* If row extends face to end of line write the whole line. */
26774 draw_glyphs (w
, 0, row
, area
,
26775 0, row
->used
[area
],
26776 DRAW_NORMAL_TEXT
, 0);
26779 /* Set START_X to the window-relative start position for drawing glyphs of
26780 AREA. The first glyph of the text area can be partially visible.
26781 The first glyphs of other areas cannot. */
26782 start_x
= window_box_left_offset (w
, area
);
26784 if (area
== TEXT_AREA
)
26787 /* Find the first glyph that must be redrawn. */
26789 && x
+ first
->pixel_width
< r
->x
)
26791 x
+= first
->pixel_width
;
26795 /* Find the last one. */
26799 && x
< r
->x
+ r
->width
)
26801 x
+= last
->pixel_width
;
26807 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26808 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26809 DRAW_NORMAL_TEXT
, 0);
26814 /* Redraw the parts of the glyph row ROW on window W intersecting
26815 rectangle R. R is in window-relative coordinates. Value is
26816 non-zero if mouse-face was overwritten. */
26819 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26821 xassert (row
->enabled_p
);
26823 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26824 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26825 0, row
->used
[TEXT_AREA
],
26826 DRAW_NORMAL_TEXT
, 0);
26829 if (row
->used
[LEFT_MARGIN_AREA
])
26830 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26831 if (row
->used
[TEXT_AREA
])
26832 expose_area (w
, row
, r
, TEXT_AREA
);
26833 if (row
->used
[RIGHT_MARGIN_AREA
])
26834 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26835 draw_row_fringe_bitmaps (w
, row
);
26838 return row
->mouse_face_p
;
26842 /* Redraw those parts of glyphs rows during expose event handling that
26843 overlap other rows. Redrawing of an exposed line writes over parts
26844 of lines overlapping that exposed line; this function fixes that.
26846 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26847 row in W's current matrix that is exposed and overlaps other rows.
26848 LAST_OVERLAPPING_ROW is the last such row. */
26851 expose_overlaps (struct window
*w
,
26852 struct glyph_row
*first_overlapping_row
,
26853 struct glyph_row
*last_overlapping_row
,
26856 struct glyph_row
*row
;
26858 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26859 if (row
->overlapping_p
)
26861 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26864 if (row
->used
[LEFT_MARGIN_AREA
])
26865 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26867 if (row
->used
[TEXT_AREA
])
26868 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26870 if (row
->used
[RIGHT_MARGIN_AREA
])
26871 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26877 /* Return non-zero if W's cursor intersects rectangle R. */
26880 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26882 XRectangle cr
, result
;
26883 struct glyph
*cursor_glyph
;
26884 struct glyph_row
*row
;
26886 if (w
->phys_cursor
.vpos
>= 0
26887 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26888 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26890 && row
->cursor_in_fringe_p
)
26892 /* Cursor is in the fringe. */
26893 cr
.x
= window_box_right_offset (w
,
26894 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26895 ? RIGHT_MARGIN_AREA
26898 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26899 cr
.height
= row
->height
;
26900 return x_intersect_rectangles (&cr
, r
, &result
);
26903 cursor_glyph
= get_phys_cursor_glyph (w
);
26906 /* r is relative to W's box, but w->phys_cursor.x is relative
26907 to left edge of W's TEXT area. Adjust it. */
26908 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26909 cr
.y
= w
->phys_cursor
.y
;
26910 cr
.width
= cursor_glyph
->pixel_width
;
26911 cr
.height
= w
->phys_cursor_height
;
26912 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26913 I assume the effect is the same -- and this is portable. */
26914 return x_intersect_rectangles (&cr
, r
, &result
);
26916 /* If we don't understand the format, pretend we're not in the hot-spot. */
26922 Draw a vertical window border to the right of window W if W doesn't
26923 have vertical scroll bars. */
26926 x_draw_vertical_border (struct window
*w
)
26928 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26930 /* We could do better, if we knew what type of scroll-bar the adjacent
26931 windows (on either side) have... But we don't :-(
26932 However, I think this works ok. ++KFS 2003-04-25 */
26934 /* Redraw borders between horizontally adjacent windows. Don't
26935 do it for frames with vertical scroll bars because either the
26936 right scroll bar of a window, or the left scroll bar of its
26937 neighbor will suffice as a border. */
26938 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26941 if (!WINDOW_RIGHTMOST_P (w
)
26942 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26944 int x0
, x1
, y0
, y1
;
26946 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26949 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26952 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26954 else if (!WINDOW_LEFTMOST_P (w
)
26955 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26957 int x0
, x1
, y0
, y1
;
26959 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26962 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26965 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26970 /* Redraw the part of window W intersection rectangle FR. Pixel
26971 coordinates in FR are frame-relative. Call this function with
26972 input blocked. Value is non-zero if the exposure overwrites
26976 expose_window (struct window
*w
, XRectangle
*fr
)
26978 struct frame
*f
= XFRAME (w
->frame
);
26980 int mouse_face_overwritten_p
= 0;
26982 /* If window is not yet fully initialized, do nothing. This can
26983 happen when toolkit scroll bars are used and a window is split.
26984 Reconfiguring the scroll bar will generate an expose for a newly
26986 if (w
->current_matrix
== NULL
)
26989 /* When we're currently updating the window, display and current
26990 matrix usually don't agree. Arrange for a thorough display
26992 if (w
== updated_window
)
26994 SET_FRAME_GARBAGED (f
);
26998 /* Frame-relative pixel rectangle of W. */
26999 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27000 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27001 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27002 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27004 if (x_intersect_rectangles (fr
, &wr
, &r
))
27006 int yb
= window_text_bottom_y (w
);
27007 struct glyph_row
*row
;
27008 int cursor_cleared_p
;
27009 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27011 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27012 r
.x
, r
.y
, r
.width
, r
.height
));
27014 /* Convert to window coordinates. */
27015 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27016 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27018 /* Turn off the cursor. */
27019 if (!w
->pseudo_window_p
27020 && phys_cursor_in_rect_p (w
, &r
))
27022 x_clear_cursor (w
);
27023 cursor_cleared_p
= 1;
27026 cursor_cleared_p
= 0;
27028 /* Update lines intersecting rectangle R. */
27029 first_overlapping_row
= last_overlapping_row
= NULL
;
27030 for (row
= w
->current_matrix
->rows
;
27035 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27037 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27038 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27039 || (r
.y
>= y0
&& r
.y
< y1
)
27040 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27042 /* A header line may be overlapping, but there is no need
27043 to fix overlapping areas for them. KFS 2005-02-12 */
27044 if (row
->overlapping_p
&& !row
->mode_line_p
)
27046 if (first_overlapping_row
== NULL
)
27047 first_overlapping_row
= row
;
27048 last_overlapping_row
= row
;
27052 if (expose_line (w
, row
, &r
))
27053 mouse_face_overwritten_p
= 1;
27056 else if (row
->overlapping_p
)
27058 /* We must redraw a row overlapping the exposed area. */
27060 ? y0
+ row
->phys_height
> r
.y
27061 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27063 if (first_overlapping_row
== NULL
)
27064 first_overlapping_row
= row
;
27065 last_overlapping_row
= row
;
27073 /* Display the mode line if there is one. */
27074 if (WINDOW_WANTS_MODELINE_P (w
)
27075 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27077 && row
->y
< r
.y
+ r
.height
)
27079 if (expose_line (w
, row
, &r
))
27080 mouse_face_overwritten_p
= 1;
27083 if (!w
->pseudo_window_p
)
27085 /* Fix the display of overlapping rows. */
27086 if (first_overlapping_row
)
27087 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27090 /* Draw border between windows. */
27091 x_draw_vertical_border (w
);
27093 /* Turn the cursor on again. */
27094 if (cursor_cleared_p
)
27095 update_window_cursor (w
, 1);
27099 return mouse_face_overwritten_p
;
27104 /* Redraw (parts) of all windows in the window tree rooted at W that
27105 intersect R. R contains frame pixel coordinates. Value is
27106 non-zero if the exposure overwrites mouse-face. */
27109 expose_window_tree (struct window
*w
, XRectangle
*r
)
27111 struct frame
*f
= XFRAME (w
->frame
);
27112 int mouse_face_overwritten_p
= 0;
27114 while (w
&& !FRAME_GARBAGED_P (f
))
27116 if (!NILP (w
->hchild
))
27117 mouse_face_overwritten_p
27118 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27119 else if (!NILP (w
->vchild
))
27120 mouse_face_overwritten_p
27121 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27123 mouse_face_overwritten_p
|= expose_window (w
, r
);
27125 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27128 return mouse_face_overwritten_p
;
27133 Redisplay an exposed area of frame F. X and Y are the upper-left
27134 corner of the exposed rectangle. W and H are width and height of
27135 the exposed area. All are pixel values. W or H zero means redraw
27136 the entire frame. */
27139 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27142 int mouse_face_overwritten_p
= 0;
27144 TRACE ((stderr
, "expose_frame "));
27146 /* No need to redraw if frame will be redrawn soon. */
27147 if (FRAME_GARBAGED_P (f
))
27149 TRACE ((stderr
, " garbaged\n"));
27153 /* If basic faces haven't been realized yet, there is no point in
27154 trying to redraw anything. This can happen when we get an expose
27155 event while Emacs is starting, e.g. by moving another window. */
27156 if (FRAME_FACE_CACHE (f
) == NULL
27157 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27159 TRACE ((stderr
, " no faces\n"));
27163 if (w
== 0 || h
== 0)
27166 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27167 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27177 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27178 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27180 if (WINDOWP (f
->tool_bar_window
))
27181 mouse_face_overwritten_p
27182 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27184 #ifdef HAVE_X_WINDOWS
27186 #ifndef USE_X_TOOLKIT
27187 if (WINDOWP (f
->menu_bar_window
))
27188 mouse_face_overwritten_p
27189 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27190 #endif /* not USE_X_TOOLKIT */
27194 /* Some window managers support a focus-follows-mouse style with
27195 delayed raising of frames. Imagine a partially obscured frame,
27196 and moving the mouse into partially obscured mouse-face on that
27197 frame. The visible part of the mouse-face will be highlighted,
27198 then the WM raises the obscured frame. With at least one WM, KDE
27199 2.1, Emacs is not getting any event for the raising of the frame
27200 (even tried with SubstructureRedirectMask), only Expose events.
27201 These expose events will draw text normally, i.e. not
27202 highlighted. Which means we must redo the highlight here.
27203 Subsume it under ``we love X''. --gerd 2001-08-15 */
27204 /* Included in Windows version because Windows most likely does not
27205 do the right thing if any third party tool offers
27206 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27207 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27209 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27210 if (f
== hlinfo
->mouse_face_mouse_frame
)
27212 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27213 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27214 clear_mouse_face (hlinfo
);
27215 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27222 Determine the intersection of two rectangles R1 and R2. Return
27223 the intersection in *RESULT. Value is non-zero if RESULT is not
27227 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27229 XRectangle
*left
, *right
;
27230 XRectangle
*upper
, *lower
;
27231 int intersection_p
= 0;
27233 /* Rearrange so that R1 is the left-most rectangle. */
27235 left
= r1
, right
= r2
;
27237 left
= r2
, right
= r1
;
27239 /* X0 of the intersection is right.x0, if this is inside R1,
27240 otherwise there is no intersection. */
27241 if (right
->x
<= left
->x
+ left
->width
)
27243 result
->x
= right
->x
;
27245 /* The right end of the intersection is the minimum of
27246 the right ends of left and right. */
27247 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27250 /* Same game for Y. */
27252 upper
= r1
, lower
= r2
;
27254 upper
= r2
, lower
= r1
;
27256 /* The upper end of the intersection is lower.y0, if this is inside
27257 of upper. Otherwise, there is no intersection. */
27258 if (lower
->y
<= upper
->y
+ upper
->height
)
27260 result
->y
= lower
->y
;
27262 /* The lower end of the intersection is the minimum of the lower
27263 ends of upper and lower. */
27264 result
->height
= (min (lower
->y
+ lower
->height
,
27265 upper
->y
+ upper
->height
)
27267 intersection_p
= 1;
27271 return intersection_p
;
27274 #endif /* HAVE_WINDOW_SYSTEM */
27277 /***********************************************************************
27279 ***********************************************************************/
27282 syms_of_xdisp (void)
27284 Vwith_echo_area_save_vector
= Qnil
;
27285 staticpro (&Vwith_echo_area_save_vector
);
27287 Vmessage_stack
= Qnil
;
27288 staticpro (&Vmessage_stack
);
27290 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27292 message_dolog_marker1
= Fmake_marker ();
27293 staticpro (&message_dolog_marker1
);
27294 message_dolog_marker2
= Fmake_marker ();
27295 staticpro (&message_dolog_marker2
);
27296 message_dolog_marker3
= Fmake_marker ();
27297 staticpro (&message_dolog_marker3
);
27300 defsubr (&Sdump_frame_glyph_matrix
);
27301 defsubr (&Sdump_glyph_matrix
);
27302 defsubr (&Sdump_glyph_row
);
27303 defsubr (&Sdump_tool_bar_row
);
27304 defsubr (&Strace_redisplay
);
27305 defsubr (&Strace_to_stderr
);
27307 #ifdef HAVE_WINDOW_SYSTEM
27308 defsubr (&Stool_bar_lines_needed
);
27309 defsubr (&Slookup_image_map
);
27311 defsubr (&Sformat_mode_line
);
27312 defsubr (&Sinvisible_p
);
27313 defsubr (&Scurrent_bidi_paragraph_direction
);
27315 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27316 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27317 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27318 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27319 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27320 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27321 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27322 DEFSYM (Qeval
, "eval");
27323 DEFSYM (QCdata
, ":data");
27324 DEFSYM (Qdisplay
, "display");
27325 DEFSYM (Qspace_width
, "space-width");
27326 DEFSYM (Qraise
, "raise");
27327 DEFSYM (Qslice
, "slice");
27328 DEFSYM (Qspace
, "space");
27329 DEFSYM (Qmargin
, "margin");
27330 DEFSYM (Qpointer
, "pointer");
27331 DEFSYM (Qleft_margin
, "left-margin");
27332 DEFSYM (Qright_margin
, "right-margin");
27333 DEFSYM (Qcenter
, "center");
27334 DEFSYM (Qline_height
, "line-height");
27335 DEFSYM (QCalign_to
, ":align-to");
27336 DEFSYM (QCrelative_width
, ":relative-width");
27337 DEFSYM (QCrelative_height
, ":relative-height");
27338 DEFSYM (QCeval
, ":eval");
27339 DEFSYM (QCpropertize
, ":propertize");
27340 DEFSYM (QCfile
, ":file");
27341 DEFSYM (Qfontified
, "fontified");
27342 DEFSYM (Qfontification_functions
, "fontification-functions");
27343 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27344 DEFSYM (Qescape_glyph
, "escape-glyph");
27345 DEFSYM (Qnobreak_space
, "nobreak-space");
27346 DEFSYM (Qimage
, "image");
27347 DEFSYM (Qtext
, "text");
27348 DEFSYM (Qboth
, "both");
27349 DEFSYM (Qboth_horiz
, "both-horiz");
27350 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27351 DEFSYM (QCmap
, ":map");
27352 DEFSYM (QCpointer
, ":pointer");
27353 DEFSYM (Qrect
, "rect");
27354 DEFSYM (Qcircle
, "circle");
27355 DEFSYM (Qpoly
, "poly");
27356 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27357 DEFSYM (Qgrow_only
, "grow-only");
27358 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27359 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27360 DEFSYM (Qposition
, "position");
27361 DEFSYM (Qbuffer_position
, "buffer-position");
27362 DEFSYM (Qobject
, "object");
27363 DEFSYM (Qbar
, "bar");
27364 DEFSYM (Qhbar
, "hbar");
27365 DEFSYM (Qbox
, "box");
27366 DEFSYM (Qhollow
, "hollow");
27367 DEFSYM (Qhand
, "hand");
27368 DEFSYM (Qarrow
, "arrow");
27369 DEFSYM (Qtext
, "text");
27370 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27372 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27373 Fcons (intern_c_string ("void-variable"), Qnil
)),
27375 staticpro (&list_of_error
);
27377 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27378 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27379 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27380 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27382 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27383 staticpro (&echo_buffer
[0]);
27384 staticpro (&echo_buffer
[1]);
27386 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27387 staticpro (&echo_area_buffer
[0]);
27388 staticpro (&echo_area_buffer
[1]);
27390 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27391 staticpro (&Vmessages_buffer_name
);
27393 mode_line_proptrans_alist
= Qnil
;
27394 staticpro (&mode_line_proptrans_alist
);
27395 mode_line_string_list
= Qnil
;
27396 staticpro (&mode_line_string_list
);
27397 mode_line_string_face
= Qnil
;
27398 staticpro (&mode_line_string_face
);
27399 mode_line_string_face_prop
= Qnil
;
27400 staticpro (&mode_line_string_face_prop
);
27401 Vmode_line_unwind_vector
= Qnil
;
27402 staticpro (&Vmode_line_unwind_vector
);
27404 help_echo_string
= Qnil
;
27405 staticpro (&help_echo_string
);
27406 help_echo_object
= Qnil
;
27407 staticpro (&help_echo_object
);
27408 help_echo_window
= Qnil
;
27409 staticpro (&help_echo_window
);
27410 previous_help_echo_string
= Qnil
;
27411 staticpro (&previous_help_echo_string
);
27412 help_echo_pos
= -1;
27414 DEFSYM (Qright_to_left
, "right-to-left");
27415 DEFSYM (Qleft_to_right
, "left-to-right");
27417 #ifdef HAVE_WINDOW_SYSTEM
27418 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27419 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27420 For example, if a block cursor is over a tab, it will be drawn as
27421 wide as that tab on the display. */);
27422 x_stretch_cursor_p
= 0;
27425 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27426 doc
: /* *Non-nil means highlight trailing whitespace.
27427 The face used for trailing whitespace is `trailing-whitespace'. */);
27428 Vshow_trailing_whitespace
= Qnil
;
27430 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27431 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27432 A value of t means highlight the character itself (for nobreak space,
27433 use face `nobreak-space').
27434 A value of nil means no highlighting.
27435 Other values mean display the escape glyph followed by an ordinary
27436 space or ordinary hyphen. */);
27437 Vnobreak_char_display
= Qt
;
27439 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27440 doc
: /* *The pointer shape to show in void text areas.
27441 A value of nil means to show the text pointer. Other options are `arrow',
27442 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27443 Vvoid_text_area_pointer
= Qarrow
;
27445 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27446 doc
: /* Non-nil means don't actually do any redisplay.
27447 This is used for internal purposes. */);
27448 Vinhibit_redisplay
= Qnil
;
27450 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27451 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27452 Vglobal_mode_string
= Qnil
;
27454 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27455 doc
: /* Marker for where to display an arrow on top of the buffer text.
27456 This must be the beginning of a line in order to work.
27457 See also `overlay-arrow-string'. */);
27458 Voverlay_arrow_position
= Qnil
;
27460 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27461 doc
: /* String to display as an arrow in non-window frames.
27462 See also `overlay-arrow-position'. */);
27463 Voverlay_arrow_string
= make_pure_c_string ("=>");
27465 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27466 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27467 The symbols on this list are examined during redisplay to determine
27468 where to display overlay arrows. */);
27469 Voverlay_arrow_variable_list
27470 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27472 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27473 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27474 If that fails to bring point back on frame, point is centered instead.
27475 If this is zero, point is always centered after it moves off frame.
27476 If you want scrolling to always be a line at a time, you should set
27477 `scroll-conservatively' to a large value rather than set this to 1. */);
27479 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27480 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27481 If point moves off-screen, redisplay will scroll by up to
27482 `scroll-conservatively' lines in order to bring point just barely
27483 onto the screen again. If that cannot be done, then redisplay
27484 recenters point as usual.
27486 If the value is greater than 100, redisplay will never recenter point,
27487 but will always scroll just enough text to bring point into view, even
27488 if you move far away.
27490 A value of zero means always recenter point if it moves off screen. */);
27491 scroll_conservatively
= 0;
27493 DEFVAR_INT ("scroll-margin", scroll_margin
,
27494 doc
: /* *Number of lines of margin at the top and bottom of a window.
27495 Recenter the window whenever point gets within this many lines
27496 of the top or bottom of the window. */);
27499 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27500 doc
: /* Pixels per inch value for non-window system displays.
27501 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27502 Vdisplay_pixels_per_inch
= make_float (72.0);
27505 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27508 DEFVAR_LISP ("truncate-partial-width-windows",
27509 Vtruncate_partial_width_windows
,
27510 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27511 For an integer value, truncate lines in each window narrower than the
27512 full frame width, provided the window width is less than that integer;
27513 otherwise, respect the value of `truncate-lines'.
27515 For any other non-nil value, truncate lines in all windows that do
27516 not span the full frame width.
27518 A value of nil means to respect the value of `truncate-lines'.
27520 If `word-wrap' is enabled, you might want to reduce this. */);
27521 Vtruncate_partial_width_windows
= make_number (50);
27523 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27524 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27525 Any other value means to use the appropriate face, `mode-line',
27526 `header-line', or `menu' respectively. */);
27527 mode_line_inverse_video
= 1;
27529 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27530 doc
: /* *Maximum buffer size for which line number should be displayed.
27531 If the buffer is bigger than this, the line number does not appear
27532 in the mode line. A value of nil means no limit. */);
27533 Vline_number_display_limit
= Qnil
;
27535 DEFVAR_INT ("line-number-display-limit-width",
27536 line_number_display_limit_width
,
27537 doc
: /* *Maximum line width (in characters) for line number display.
27538 If the average length of the lines near point is bigger than this, then the
27539 line number may be omitted from the mode line. */);
27540 line_number_display_limit_width
= 200;
27542 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27543 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27544 highlight_nonselected_windows
= 0;
27546 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27547 doc
: /* Non-nil if more than one frame is visible on this display.
27548 Minibuffer-only frames don't count, but iconified frames do.
27549 This variable is not guaranteed to be accurate except while processing
27550 `frame-title-format' and `icon-title-format'. */);
27552 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27553 doc
: /* Template for displaying the title bar of visible frames.
27554 \(Assuming the window manager supports this feature.)
27556 This variable has the same structure as `mode-line-format', except that
27557 the %c and %l constructs are ignored. It is used only on frames for
27558 which no explicit name has been set \(see `modify-frame-parameters'). */);
27560 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27561 doc
: /* Template for displaying the title bar of an iconified frame.
27562 \(Assuming the window manager supports this feature.)
27563 This variable has the same structure as `mode-line-format' (which see),
27564 and is used only on frames for which no explicit name has been set
27565 \(see `modify-frame-parameters'). */);
27567 = Vframe_title_format
27568 = pure_cons (intern_c_string ("multiple-frames"),
27569 pure_cons (make_pure_c_string ("%b"),
27570 pure_cons (pure_cons (empty_unibyte_string
,
27571 pure_cons (intern_c_string ("invocation-name"),
27572 pure_cons (make_pure_c_string ("@"),
27573 pure_cons (intern_c_string ("system-name"),
27577 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27578 doc
: /* Maximum number of lines to keep in the message log buffer.
27579 If nil, disable message logging. If t, log messages but don't truncate
27580 the buffer when it becomes large. */);
27581 Vmessage_log_max
= make_number (100);
27583 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27584 doc
: /* Functions called before redisplay, if window sizes have changed.
27585 The value should be a list of functions that take one argument.
27586 Just before redisplay, for each frame, if any of its windows have changed
27587 size since the last redisplay, or have been split or deleted,
27588 all the functions in the list are called, with the frame as argument. */);
27589 Vwindow_size_change_functions
= Qnil
;
27591 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27592 doc
: /* List of functions to call before redisplaying a window with scrolling.
27593 Each function is called with two arguments, the window and its new
27594 display-start position. Note that these functions are also called by
27595 `set-window-buffer'. Also note that the value of `window-end' is not
27596 valid when these functions are called. */);
27597 Vwindow_scroll_functions
= Qnil
;
27599 DEFVAR_LISP ("window-text-change-functions",
27600 Vwindow_text_change_functions
,
27601 doc
: /* Functions to call in redisplay when text in the window might change. */);
27602 Vwindow_text_change_functions
= Qnil
;
27604 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27605 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27606 Each function is called with two arguments, the window and the end trigger value.
27607 See `set-window-redisplay-end-trigger'. */);
27608 Vredisplay_end_trigger_functions
= Qnil
;
27610 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27611 doc
: /* *Non-nil means autoselect window with mouse pointer.
27612 If nil, do not autoselect windows.
27613 A positive number means delay autoselection by that many seconds: a
27614 window is autoselected only after the mouse has remained in that
27615 window for the duration of the delay.
27616 A negative number has a similar effect, but causes windows to be
27617 autoselected only after the mouse has stopped moving. \(Because of
27618 the way Emacs compares mouse events, you will occasionally wait twice
27619 that time before the window gets selected.\)
27620 Any other value means to autoselect window instantaneously when the
27621 mouse pointer enters it.
27623 Autoselection selects the minibuffer only if it is active, and never
27624 unselects the minibuffer if it is active.
27626 When customizing this variable make sure that the actual value of
27627 `focus-follows-mouse' matches the behavior of your window manager. */);
27628 Vmouse_autoselect_window
= Qnil
;
27630 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27631 doc
: /* *Non-nil means automatically resize tool-bars.
27632 This dynamically changes the tool-bar's height to the minimum height
27633 that is needed to make all tool-bar items visible.
27634 If value is `grow-only', the tool-bar's height is only increased
27635 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27636 Vauto_resize_tool_bars
= Qt
;
27638 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27639 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27640 auto_raise_tool_bar_buttons_p
= 1;
27642 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27643 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27644 make_cursor_line_fully_visible_p
= 1;
27646 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27647 doc
: /* *Border below tool-bar in pixels.
27648 If an integer, use it as the height of the border.
27649 If it is one of `internal-border-width' or `border-width', use the
27650 value of the corresponding frame parameter.
27651 Otherwise, no border is added below the tool-bar. */);
27652 Vtool_bar_border
= Qinternal_border_width
;
27654 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27655 doc
: /* *Margin around tool-bar buttons in pixels.
27656 If an integer, use that for both horizontal and vertical margins.
27657 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27658 HORZ specifying the horizontal margin, and VERT specifying the
27659 vertical margin. */);
27660 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27662 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27663 doc
: /* *Relief thickness of tool-bar buttons. */);
27664 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27666 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27667 doc
: /* Tool bar style to use.
27669 image - show images only
27670 text - show text only
27671 both - show both, text below image
27672 both-horiz - show text to the right of the image
27673 text-image-horiz - show text to the left of the image
27674 any other - use system default or image if no system default. */);
27675 Vtool_bar_style
= Qnil
;
27677 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27678 doc
: /* *Maximum number of characters a label can have to be shown.
27679 The tool bar style must also show labels for this to have any effect, see
27680 `tool-bar-style'. */);
27681 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27683 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27684 doc
: /* List of functions to call to fontify regions of text.
27685 Each function is called with one argument POS. Functions must
27686 fontify a region starting at POS in the current buffer, and give
27687 fontified regions the property `fontified'. */);
27688 Vfontification_functions
= Qnil
;
27689 Fmake_variable_buffer_local (Qfontification_functions
);
27691 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27692 unibyte_display_via_language_environment
,
27693 doc
: /* *Non-nil means display unibyte text according to language environment.
27694 Specifically, this means that raw bytes in the range 160-255 decimal
27695 are displayed by converting them to the equivalent multibyte characters
27696 according to the current language environment. As a result, they are
27697 displayed according to the current fontset.
27699 Note that this variable affects only how these bytes are displayed,
27700 but does not change the fact they are interpreted as raw bytes. */);
27701 unibyte_display_via_language_environment
= 0;
27703 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27704 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27705 If a float, it specifies a fraction of the mini-window frame's height.
27706 If an integer, it specifies a number of lines. */);
27707 Vmax_mini_window_height
= make_float (0.25);
27709 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27710 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27711 A value of nil means don't automatically resize mini-windows.
27712 A value of t means resize them to fit the text displayed in them.
27713 A value of `grow-only', the default, means let mini-windows grow only;
27714 they return to their normal size when the minibuffer is closed, or the
27715 echo area becomes empty. */);
27716 Vresize_mini_windows
= Qgrow_only
;
27718 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27719 doc
: /* Alist specifying how to blink the cursor off.
27720 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27721 `cursor-type' frame-parameter or variable equals ON-STATE,
27722 comparing using `equal', Emacs uses OFF-STATE to specify
27723 how to blink it off. ON-STATE and OFF-STATE are values for
27724 the `cursor-type' frame parameter.
27726 If a frame's ON-STATE has no entry in this list,
27727 the frame's other specifications determine how to blink the cursor off. */);
27728 Vblink_cursor_alist
= Qnil
;
27730 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27731 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27732 If non-nil, windows are automatically scrolled horizontally to make
27733 point visible. */);
27734 automatic_hscrolling_p
= 1;
27735 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27737 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27738 doc
: /* *How many columns away from the window edge point is allowed to get
27739 before automatic hscrolling will horizontally scroll the window. */);
27740 hscroll_margin
= 5;
27742 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27743 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27744 When point is less than `hscroll-margin' columns from the window
27745 edge, automatic hscrolling will scroll the window by the amount of columns
27746 determined by this variable. If its value is a positive integer, scroll that
27747 many columns. If it's a positive floating-point number, it specifies the
27748 fraction of the window's width to scroll. If it's nil or zero, point will be
27749 centered horizontally after the scroll. Any other value, including negative
27750 numbers, are treated as if the value were zero.
27752 Automatic hscrolling always moves point outside the scroll margin, so if
27753 point was more than scroll step columns inside the margin, the window will
27754 scroll more than the value given by the scroll step.
27756 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27757 and `scroll-right' overrides this variable's effect. */);
27758 Vhscroll_step
= make_number (0);
27760 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27761 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27762 Bind this around calls to `message' to let it take effect. */);
27763 message_truncate_lines
= 0;
27765 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27766 doc
: /* Normal hook run to update the menu bar definitions.
27767 Redisplay runs this hook before it redisplays the menu bar.
27768 This is used to update submenus such as Buffers,
27769 whose contents depend on various data. */);
27770 Vmenu_bar_update_hook
= Qnil
;
27772 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27773 doc
: /* Frame for which we are updating a menu.
27774 The enable predicate for a menu binding should check this variable. */);
27775 Vmenu_updating_frame
= Qnil
;
27777 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27778 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27779 inhibit_menubar_update
= 0;
27781 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27782 doc
: /* Prefix prepended to all continuation lines at display time.
27783 The value may be a string, an image, or a stretch-glyph; it is
27784 interpreted in the same way as the value of a `display' text property.
27786 This variable is overridden by any `wrap-prefix' text or overlay
27789 To add a prefix to non-continuation lines, use `line-prefix'. */);
27790 Vwrap_prefix
= Qnil
;
27791 DEFSYM (Qwrap_prefix
, "wrap-prefix");
27792 Fmake_variable_buffer_local (Qwrap_prefix
);
27794 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27795 doc
: /* Prefix prepended to all non-continuation lines at display time.
27796 The value may be a string, an image, or a stretch-glyph; it is
27797 interpreted in the same way as the value of a `display' text property.
27799 This variable is overridden by any `line-prefix' text or overlay
27802 To add a prefix to continuation lines, use `wrap-prefix'. */);
27803 Vline_prefix
= Qnil
;
27804 DEFSYM (Qline_prefix
, "line-prefix");
27805 Fmake_variable_buffer_local (Qline_prefix
);
27807 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27808 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27809 inhibit_eval_during_redisplay
= 0;
27811 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27812 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27813 inhibit_free_realized_faces
= 0;
27816 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27817 doc
: /* Inhibit try_window_id display optimization. */);
27818 inhibit_try_window_id
= 0;
27820 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27821 doc
: /* Inhibit try_window_reusing display optimization. */);
27822 inhibit_try_window_reusing
= 0;
27824 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27825 doc
: /* Inhibit try_cursor_movement display optimization. */);
27826 inhibit_try_cursor_movement
= 0;
27827 #endif /* GLYPH_DEBUG */
27829 DEFVAR_INT ("overline-margin", overline_margin
,
27830 doc
: /* *Space between overline and text, in pixels.
27831 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27832 margin to the caracter height. */);
27833 overline_margin
= 2;
27835 DEFVAR_INT ("underline-minimum-offset",
27836 underline_minimum_offset
,
27837 doc
: /* Minimum distance between baseline and underline.
27838 This can improve legibility of underlined text at small font sizes,
27839 particularly when using variable `x-use-underline-position-properties'
27840 with fonts that specify an UNDERLINE_POSITION relatively close to the
27841 baseline. The default value is 1. */);
27842 underline_minimum_offset
= 1;
27844 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27845 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27846 This feature only works when on a window system that can change
27847 cursor shapes. */);
27848 display_hourglass_p
= 1;
27850 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27851 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27852 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27854 hourglass_atimer
= NULL
;
27855 hourglass_shown_p
= 0;
27857 DEFSYM (Qglyphless_char
, "glyphless-char");
27858 DEFSYM (Qhex_code
, "hex-code");
27859 DEFSYM (Qempty_box
, "empty-box");
27860 DEFSYM (Qthin_space
, "thin-space");
27861 DEFSYM (Qzero_width
, "zero-width");
27863 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27864 /* Intern this now in case it isn't already done.
27865 Setting this variable twice is harmless.
27866 But don't staticpro it here--that is done in alloc.c. */
27867 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27868 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27870 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27871 doc
: /* Char-table defining glyphless characters.
27872 Each element, if non-nil, should be one of the following:
27873 an ASCII acronym string: display this string in a box
27874 `hex-code': display the hexadecimal code of a character in a box
27875 `empty-box': display as an empty box
27876 `thin-space': display as 1-pixel width space
27877 `zero-width': don't display
27878 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27879 display method for graphical terminals and text terminals respectively.
27880 GRAPHICAL and TEXT should each have one of the values listed above.
27882 The char-table has one extra slot to control the display of a character for
27883 which no font is found. This slot only takes effect on graphical terminals.
27884 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27885 `thin-space'. The default is `empty-box'. */);
27886 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27887 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27892 /* Initialize this module when Emacs starts. */
27897 current_header_line_height
= current_mode_line_height
= -1;
27899 CHARPOS (this_line_start_pos
) = 0;
27901 if (!noninteractive
)
27903 struct window
*m
= XWINDOW (minibuf_window
);
27904 Lisp_Object frame
= m
->frame
;
27905 struct frame
*f
= XFRAME (frame
);
27906 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27907 struct window
*r
= XWINDOW (root
);
27910 echo_area_window
= minibuf_window
;
27912 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27913 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27914 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27915 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27916 XSETFASTINT (m
->total_lines
, 1);
27917 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27919 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27920 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27921 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27923 /* The default ellipsis glyphs `...'. */
27924 for (i
= 0; i
< 3; ++i
)
27925 default_invis_vector
[i
] = make_number ('.');
27929 /* Allocate the buffer for frame titles.
27930 Also used for `format-mode-line'. */
27932 mode_line_noprop_buf
= (char *) xmalloc (size
);
27933 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27934 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27935 mode_line_target
= MODE_LINE_DISPLAY
;
27938 help_echo_showing_p
= 0;
27941 /* Since w32 does not support atimers, it defines its own implementation of
27942 the following three functions in w32fns.c. */
27945 /* Platform-independent portion of hourglass implementation. */
27947 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27949 hourglass_started (void)
27951 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27954 /* Cancel a currently active hourglass timer, and start a new one. */
27956 start_hourglass (void)
27958 #if defined (HAVE_WINDOW_SYSTEM)
27960 int secs
, usecs
= 0;
27962 cancel_hourglass ();
27964 if (INTEGERP (Vhourglass_delay
)
27965 && XINT (Vhourglass_delay
) > 0)
27966 secs
= XFASTINT (Vhourglass_delay
);
27967 else if (FLOATP (Vhourglass_delay
)
27968 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27971 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27972 secs
= XFASTINT (tem
);
27973 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27976 secs
= DEFAULT_HOURGLASS_DELAY
;
27978 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27979 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27980 show_hourglass
, NULL
);
27985 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27988 cancel_hourglass (void)
27990 #if defined (HAVE_WINDOW_SYSTEM)
27991 if (hourglass_atimer
)
27993 cancel_atimer (hourglass_atimer
);
27994 hourglass_atimer
= NULL
;
27997 if (hourglass_shown_p
)
28001 #endif /* ! WINDOWSNT */