1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
609 CACHE = bidi_shelve_cache(); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1346 bidi_unshelve_cache (itdata
);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 EMACS_INT rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 EMACS_INT charpos
, EMACS_INT bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? XINT (BVAR (current_buffer
, selective_display
))
2433 : (!NILP (BVAR (current_buffer
, selective_display
))
2435 it
->selective_display_ellipsis_p
2436 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2438 /* Display table to use. */
2439 it
->dp
= window_display_table (w
);
2441 /* Are multibyte characters enabled in current_buffer? */
2442 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2444 /* Non-zero if we should highlight the region. */
2446 = (!NILP (Vtransient_mark_mode
)
2447 && !NILP (BVAR (current_buffer
, mark_active
))
2448 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2450 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2451 start and end of a visible region in window IT->w. Set both to
2452 -1 to indicate no region. */
2453 if (highlight_region_p
2454 /* Maybe highlight only in selected window. */
2455 && (/* Either show region everywhere. */
2456 highlight_nonselected_windows
2457 /* Or show region in the selected window. */
2458 || w
== XWINDOW (selected_window
)
2459 /* Or show the region if we are in the mini-buffer and W is
2460 the window the mini-buffer refers to. */
2461 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2462 && WINDOWP (minibuf_selected_window
)
2463 && w
== XWINDOW (minibuf_selected_window
))))
2465 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2466 it
->region_beg_charpos
= min (PT
, markpos
);
2467 it
->region_end_charpos
= max (PT
, markpos
);
2470 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2472 /* Get the position at which the redisplay_end_trigger hook should
2473 be run, if it is to be run at all. */
2474 if (MARKERP (w
->redisplay_end_trigger
)
2475 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2476 it
->redisplay_end_trigger_charpos
2477 = marker_position (w
->redisplay_end_trigger
);
2478 else if (INTEGERP (w
->redisplay_end_trigger
))
2479 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2481 /* Correct bogus values of tab_width. */
2482 it
->tab_width
= XINT (BVAR (current_buffer
, tab_width
));
2483 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2486 /* Are lines in the display truncated? */
2487 if (base_face_id
!= DEFAULT_FACE_ID
2488 || XINT (it
->w
->hscroll
)
2489 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2490 && ((!NILP (Vtruncate_partial_width_windows
)
2491 && !INTEGERP (Vtruncate_partial_width_windows
))
2492 || (INTEGERP (Vtruncate_partial_width_windows
)
2493 && (WINDOW_TOTAL_COLS (it
->w
)
2494 < XINT (Vtruncate_partial_width_windows
))))))
2495 it
->line_wrap
= TRUNCATE
;
2496 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2497 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2498 ? WINDOW_WRAP
: WORD_WRAP
;
2500 it
->line_wrap
= TRUNCATE
;
2502 /* Get dimensions of truncation and continuation glyphs. These are
2503 displayed as fringe bitmaps under X, so we don't need them for such
2505 if (!FRAME_WINDOW_P (it
->f
))
2507 if (it
->line_wrap
== TRUNCATE
)
2509 /* We will need the truncation glyph. */
2510 xassert (it
->glyph_row
== NULL
);
2511 produce_special_glyphs (it
, IT_TRUNCATION
);
2512 it
->truncation_pixel_width
= it
->pixel_width
;
2516 /* We will need the continuation glyph. */
2517 xassert (it
->glyph_row
== NULL
);
2518 produce_special_glyphs (it
, IT_CONTINUATION
);
2519 it
->continuation_pixel_width
= it
->pixel_width
;
2522 /* Reset these values to zero because the produce_special_glyphs
2523 above has changed them. */
2524 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2525 it
->phys_ascent
= it
->phys_descent
= 0;
2528 /* Set this after getting the dimensions of truncation and
2529 continuation glyphs, so that we don't produce glyphs when calling
2530 produce_special_glyphs, above. */
2531 it
->glyph_row
= row
;
2532 it
->area
= TEXT_AREA
;
2534 /* Forget any previous info about this row being reversed. */
2536 it
->glyph_row
->reversed_p
= 0;
2538 /* Get the dimensions of the display area. The display area
2539 consists of the visible window area plus a horizontally scrolled
2540 part to the left of the window. All x-values are relative to the
2541 start of this total display area. */
2542 if (base_face_id
!= DEFAULT_FACE_ID
)
2544 /* Mode lines, menu bar in terminal frames. */
2545 it
->first_visible_x
= 0;
2546 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2551 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2552 it
->last_visible_x
= (it
->first_visible_x
2553 + window_box_width (w
, TEXT_AREA
));
2555 /* If we truncate lines, leave room for the truncator glyph(s) at
2556 the right margin. Otherwise, leave room for the continuation
2557 glyph(s). Truncation and continuation glyphs are not inserted
2558 for window-based redisplay. */
2559 if (!FRAME_WINDOW_P (it
->f
))
2561 if (it
->line_wrap
== TRUNCATE
)
2562 it
->last_visible_x
-= it
->truncation_pixel_width
;
2564 it
->last_visible_x
-= it
->continuation_pixel_width
;
2567 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2568 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2571 /* Leave room for a border glyph. */
2572 if (!FRAME_WINDOW_P (it
->f
)
2573 && !WINDOW_RIGHTMOST_P (it
->w
))
2574 it
->last_visible_x
-= 1;
2576 it
->last_visible_y
= window_text_bottom_y (w
);
2578 /* For mode lines and alike, arrange for the first glyph having a
2579 left box line if the face specifies a box. */
2580 if (base_face_id
!= DEFAULT_FACE_ID
)
2584 it
->face_id
= remapped_base_face_id
;
2586 /* If we have a boxed mode line, make the first character appear
2587 with a left box line. */
2588 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2589 if (face
->box
!= FACE_NO_BOX
)
2590 it
->start_of_box_run_p
= 1;
2593 /* If a buffer position was specified, set the iterator there,
2594 getting overlays and face properties from that position. */
2595 if (charpos
>= BUF_BEG (current_buffer
))
2597 it
->end_charpos
= ZV
;
2599 IT_CHARPOS (*it
) = charpos
;
2601 /* Compute byte position if not specified. */
2602 if (bytepos
< charpos
)
2603 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2605 IT_BYTEPOS (*it
) = bytepos
;
2607 it
->start
= it
->current
;
2608 /* Do we need to reorder bidirectional text? Not if this is a
2609 unibyte buffer: by definition, none of the single-byte
2610 characters are strong R2L, so no reordering is needed. And
2611 bidi.c doesn't support unibyte buffers anyway. */
2613 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2616 /* If we are to reorder bidirectional text, init the bidi
2620 /* Note the paragraph direction that this buffer wants to
2622 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= L2R
;
2625 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2627 it
->paragraph_embedding
= R2L
;
2629 it
->paragraph_embedding
= NEUTRAL_DIR
;
2630 bidi_unshelve_cache (NULL
);
2631 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2635 /* Compute faces etc. */
2636 reseat (it
, it
->current
.pos
, 1);
2643 /* Initialize IT for the display of window W with window start POS. */
2646 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2648 struct glyph_row
*row
;
2649 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2651 row
= w
->desired_matrix
->rows
+ first_vpos
;
2652 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2653 it
->first_vpos
= first_vpos
;
2655 /* Don't reseat to previous visible line start if current start
2656 position is in a string or image. */
2657 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2659 int start_at_line_beg_p
;
2660 int first_y
= it
->current_y
;
2662 /* If window start is not at a line start, skip forward to POS to
2663 get the correct continuation lines width. */
2664 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2665 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2666 if (!start_at_line_beg_p
)
2670 reseat_at_previous_visible_line_start (it
);
2671 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2673 new_x
= it
->current_x
+ it
->pixel_width
;
2675 /* If lines are continued, this line may end in the middle
2676 of a multi-glyph character (e.g. a control character
2677 displayed as \003, or in the middle of an overlay
2678 string). In this case move_it_to above will not have
2679 taken us to the start of the continuation line but to the
2680 end of the continued line. */
2681 if (it
->current_x
> 0
2682 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2683 && (/* And glyph doesn't fit on the line. */
2684 new_x
> it
->last_visible_x
2685 /* Or it fits exactly and we're on a window
2687 || (new_x
== it
->last_visible_x
2688 && FRAME_WINDOW_P (it
->f
))))
2690 if (it
->current
.dpvec_index
>= 0
2691 || it
->current
.overlay_string_index
>= 0)
2693 set_iterator_to_next (it
, 1);
2694 move_it_in_display_line_to (it
, -1, -1, 0);
2697 it
->continuation_lines_width
+= it
->current_x
;
2700 /* We're starting a new display line, not affected by the
2701 height of the continued line, so clear the appropriate
2702 fields in the iterator structure. */
2703 it
->max_ascent
= it
->max_descent
= 0;
2704 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2706 it
->current_y
= first_y
;
2708 it
->current_x
= it
->hpos
= 0;
2714 /* Return 1 if POS is a position in ellipses displayed for invisible
2715 text. W is the window we display, for text property lookup. */
2718 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2720 Lisp_Object prop
, window
;
2722 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2724 /* If POS specifies a position in a display vector, this might
2725 be for an ellipsis displayed for invisible text. We won't
2726 get the iterator set up for delivering that ellipsis unless
2727 we make sure that it gets aware of the invisible text. */
2728 if (pos
->dpvec_index
>= 0
2729 && pos
->overlay_string_index
< 0
2730 && CHARPOS (pos
->string_pos
) < 0
2732 && (XSETWINDOW (window
, w
),
2733 prop
= Fget_char_property (make_number (charpos
),
2734 Qinvisible
, window
),
2735 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2737 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2739 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2746 /* Initialize IT for stepping through current_buffer in window W,
2747 starting at position POS that includes overlay string and display
2748 vector/ control character translation position information. Value
2749 is zero if there are overlay strings with newlines at POS. */
2752 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2754 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2755 int i
, overlay_strings_with_newlines
= 0;
2757 /* If POS specifies a position in a display vector, this might
2758 be for an ellipsis displayed for invisible text. We won't
2759 get the iterator set up for delivering that ellipsis unless
2760 we make sure that it gets aware of the invisible text. */
2761 if (in_ellipses_for_invisible_text_p (pos
, w
))
2767 /* Keep in mind: the call to reseat in init_iterator skips invisible
2768 text, so we might end up at a position different from POS. This
2769 is only a problem when POS is a row start after a newline and an
2770 overlay starts there with an after-string, and the overlay has an
2771 invisible property. Since we don't skip invisible text in
2772 display_line and elsewhere immediately after consuming the
2773 newline before the row start, such a POS will not be in a string,
2774 but the call to init_iterator below will move us to the
2776 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2778 /* This only scans the current chunk -- it should scan all chunks.
2779 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2780 to 16 in 22.1 to make this a lesser problem. */
2781 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2783 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2784 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2786 while (s
< e
&& *s
!= '\n')
2791 overlay_strings_with_newlines
= 1;
2796 /* If position is within an overlay string, set up IT to the right
2798 if (pos
->overlay_string_index
>= 0)
2802 /* If the first overlay string happens to have a `display'
2803 property for an image, the iterator will be set up for that
2804 image, and we have to undo that setup first before we can
2805 correct the overlay string index. */
2806 if (it
->method
== GET_FROM_IMAGE
)
2809 /* We already have the first chunk of overlay strings in
2810 IT->overlay_strings. Load more until the one for
2811 pos->overlay_string_index is in IT->overlay_strings. */
2812 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2814 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2815 it
->current
.overlay_string_index
= 0;
2818 load_overlay_strings (it
, 0);
2819 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2823 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2824 relative_index
= (it
->current
.overlay_string_index
2825 % OVERLAY_STRING_CHUNK_SIZE
);
2826 it
->string
= it
->overlay_strings
[relative_index
];
2827 xassert (STRINGP (it
->string
));
2828 it
->current
.string_pos
= pos
->string_pos
;
2829 it
->method
= GET_FROM_STRING
;
2832 if (CHARPOS (pos
->string_pos
) >= 0)
2834 /* Recorded position is not in an overlay string, but in another
2835 string. This can only be a string from a `display' property.
2836 IT should already be filled with that string. */
2837 it
->current
.string_pos
= pos
->string_pos
;
2838 xassert (STRINGP (it
->string
));
2841 /* Restore position in display vector translations, control
2842 character translations or ellipses. */
2843 if (pos
->dpvec_index
>= 0)
2845 if (it
->dpvec
== NULL
)
2846 get_next_display_element (it
);
2847 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2848 it
->current
.dpvec_index
= pos
->dpvec_index
;
2852 return !overlay_strings_with_newlines
;
2856 /* Initialize IT for stepping through current_buffer in window W
2857 starting at ROW->start. */
2860 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2862 init_from_display_pos (it
, w
, &row
->start
);
2863 it
->start
= row
->start
;
2864 it
->continuation_lines_width
= row
->continuation_lines_width
;
2869 /* Initialize IT for stepping through current_buffer in window W
2870 starting in the line following ROW, i.e. starting at ROW->end.
2871 Value is zero if there are overlay strings with newlines at ROW's
2875 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2879 if (init_from_display_pos (it
, w
, &row
->end
))
2881 if (row
->continued_p
)
2882 it
->continuation_lines_width
2883 = row
->continuation_lines_width
+ row
->pixel_width
;
2894 /***********************************************************************
2896 ***********************************************************************/
2898 /* Called when IT reaches IT->stop_charpos. Handle text property and
2899 overlay changes. Set IT->stop_charpos to the next position where
2903 handle_stop (struct it
*it
)
2905 enum prop_handled handled
;
2906 int handle_overlay_change_p
;
2910 it
->current
.dpvec_index
= -1;
2911 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2912 it
->ignore_overlay_strings_at_pos_p
= 0;
2915 /* Use face of preceding text for ellipsis (if invisible) */
2916 if (it
->selective_display_ellipsis_p
)
2917 it
->saved_face_id
= it
->face_id
;
2921 handled
= HANDLED_NORMALLY
;
2923 /* Call text property handlers. */
2924 for (p
= it_props
; p
->handler
; ++p
)
2926 handled
= p
->handler (it
);
2928 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2930 else if (handled
== HANDLED_RETURN
)
2932 /* We still want to show before and after strings from
2933 overlays even if the actual buffer text is replaced. */
2934 if (!handle_overlay_change_p
2936 || !get_overlay_strings_1 (it
, 0, 0))
2939 setup_for_ellipsis (it
, 0);
2940 /* When handling a display spec, we might load an
2941 empty string. In that case, discard it here. We
2942 used to discard it in handle_single_display_spec,
2943 but that causes get_overlay_strings_1, above, to
2944 ignore overlay strings that we must check. */
2945 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2949 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2953 it
->ignore_overlay_strings_at_pos_p
= 1;
2954 it
->string_from_display_prop_p
= 0;
2955 it
->from_disp_prop_p
= 0;
2956 handle_overlay_change_p
= 0;
2958 handled
= HANDLED_RECOMPUTE_PROPS
;
2961 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2962 handle_overlay_change_p
= 0;
2965 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2967 /* Don't check for overlay strings below when set to deliver
2968 characters from a display vector. */
2969 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2970 handle_overlay_change_p
= 0;
2972 /* Handle overlay changes.
2973 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2974 if it finds overlays. */
2975 if (handle_overlay_change_p
)
2976 handled
= handle_overlay_change (it
);
2981 setup_for_ellipsis (it
, 0);
2985 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2987 /* Determine where to stop next. */
2988 if (handled
== HANDLED_NORMALLY
)
2989 compute_stop_pos (it
);
2993 /* Compute IT->stop_charpos from text property and overlay change
2994 information for IT's current position. */
2997 compute_stop_pos (struct it
*it
)
2999 register INTERVAL iv
, next_iv
;
3000 Lisp_Object object
, limit
, position
;
3001 EMACS_INT charpos
, bytepos
;
3003 /* If nowhere else, stop at the end. */
3004 it
->stop_charpos
= it
->end_charpos
;
3006 if (STRINGP (it
->string
))
3008 /* Strings are usually short, so don't limit the search for
3010 object
= it
->string
;
3012 charpos
= IT_STRING_CHARPOS (*it
);
3013 bytepos
= IT_STRING_BYTEPOS (*it
);
3019 /* If next overlay change is in front of the current stop pos
3020 (which is IT->end_charpos), stop there. Note: value of
3021 next_overlay_change is point-max if no overlay change
3023 charpos
= IT_CHARPOS (*it
);
3024 bytepos
= IT_BYTEPOS (*it
);
3025 pos
= next_overlay_change (charpos
);
3026 if (pos
< it
->stop_charpos
)
3027 it
->stop_charpos
= pos
;
3029 /* If showing the region, we have to stop at the region
3030 start or end because the face might change there. */
3031 if (it
->region_beg_charpos
> 0)
3033 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3034 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3035 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3036 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3039 /* Set up variables for computing the stop position from text
3040 property changes. */
3041 XSETBUFFER (object
, current_buffer
);
3042 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3045 /* Get the interval containing IT's position. Value is a null
3046 interval if there isn't such an interval. */
3047 position
= make_number (charpos
);
3048 iv
= validate_interval_range (object
, &position
, &position
, 0);
3049 if (!NULL_INTERVAL_P (iv
))
3051 Lisp_Object values_here
[LAST_PROP_IDX
];
3054 /* Get properties here. */
3055 for (p
= it_props
; p
->handler
; ++p
)
3056 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3058 /* Look for an interval following iv that has different
3060 for (next_iv
= next_interval (iv
);
3061 (!NULL_INTERVAL_P (next_iv
)
3063 || XFASTINT (limit
) > next_iv
->position
));
3064 next_iv
= next_interval (next_iv
))
3066 for (p
= it_props
; p
->handler
; ++p
)
3068 Lisp_Object new_value
;
3070 new_value
= textget (next_iv
->plist
, *p
->name
);
3071 if (!EQ (values_here
[p
->idx
], new_value
))
3079 if (!NULL_INTERVAL_P (next_iv
))
3081 if (INTEGERP (limit
)
3082 && next_iv
->position
>= XFASTINT (limit
))
3083 /* No text property change up to limit. */
3084 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3086 /* Text properties change in next_iv. */
3087 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3091 if (it
->cmp_it
.id
< 0)
3093 EMACS_INT stoppos
= it
->end_charpos
;
3095 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3097 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3098 stoppos
, it
->string
);
3101 xassert (STRINGP (it
->string
)
3102 || (it
->stop_charpos
>= BEGV
3103 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3107 /* Return the position of the next overlay change after POS in
3108 current_buffer. Value is point-max if no overlay change
3109 follows. This is like `next-overlay-change' but doesn't use
3113 next_overlay_change (EMACS_INT pos
)
3115 ptrdiff_t i
, noverlays
;
3117 Lisp_Object
*overlays
;
3119 /* Get all overlays at the given position. */
3120 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3122 /* If any of these overlays ends before endpos,
3123 use its ending point instead. */
3124 for (i
= 0; i
< noverlays
; ++i
)
3129 oend
= OVERLAY_END (overlays
[i
]);
3130 oendpos
= OVERLAY_POSITION (oend
);
3131 endpos
= min (endpos
, oendpos
);
3137 /* Record one cached display string position found recently by
3138 compute_display_string_pos. */
3139 static EMACS_INT cached_disp_pos
;
3140 static EMACS_INT cached_prev_pos
= -1;
3141 static struct buffer
*cached_disp_buffer
;
3142 static int cached_disp_modiff
;
3143 static int cached_disp_overlay_modiff
;
3145 /* Return the character position of a display string at or after
3146 position specified by POSITION. If no display string exists at or
3147 after POSITION, return ZV. A display string is either an overlay
3148 with `display' property whose value is a string, or a `display'
3149 text property whose value is a string. STRING is data about the
3150 string to iterate; if STRING->lstring is nil, we are iterating a
3151 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3154 compute_display_string_pos (struct text_pos
*position
,
3155 struct bidi_string_data
*string
, int frame_window_p
)
3157 /* OBJECT = nil means current buffer. */
3158 Lisp_Object object
=
3159 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3160 Lisp_Object pos
, spec
;
3161 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3162 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3163 EMACS_INT begb
= string_p
? 0 : BEGV
;
3164 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3165 struct text_pos tpos
;
3169 /* We don't support display properties whose values are strings
3170 that have display string properties. */
3171 || string
->from_disp_str
3172 /* C strings cannot have display properties. */
3173 || (string
->s
&& !STRINGP (object
)))
3176 /* Check the cached values. */
3177 if (!STRINGP (object
))
3182 b
= XBUFFER (object
);
3183 if (b
== cached_disp_buffer
3184 && BUF_MODIFF (b
) == cached_disp_modiff
3185 && BUF_OVERLAY_MODIFF (b
) == cached_disp_overlay_modiff
3186 && !b
->clip_changed
)
3188 if (cached_prev_pos
>= 0
3189 && cached_prev_pos
< charpos
&& charpos
<= cached_disp_pos
)
3190 return cached_disp_pos
;
3191 /* Handle overstepping either end of the known interval. */
3192 if (charpos
> cached_disp_pos
)
3193 cached_prev_pos
= cached_disp_pos
;
3194 else /* charpos <= cached_prev_pos */
3195 cached_prev_pos
= max (charpos
- 1, 0);
3198 /* Record new values in the cache. */
3199 if (b
!= cached_disp_buffer
)
3201 cached_disp_buffer
= b
;
3202 cached_prev_pos
= max (charpos
- 1, 0);
3204 cached_disp_modiff
= BUF_MODIFF (b
);
3205 cached_disp_overlay_modiff
= BUF_OVERLAY_MODIFF (b
);
3208 /* If the character at CHARPOS is where the display string begins,
3210 pos
= make_number (charpos
);
3211 if (STRINGP (object
))
3212 bufpos
= string
->bufpos
;
3216 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3218 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3221 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3224 if (!STRINGP (object
))
3225 cached_disp_pos
= charpos
;
3229 /* Look forward for the first character with a `display' property
3230 that will replace the underlying text when displayed. */
3232 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3233 CHARPOS (tpos
) = XFASTINT (pos
);
3234 if (STRINGP (object
))
3235 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3237 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3238 if (CHARPOS (tpos
) >= eob
)
3240 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3241 if (!STRINGP (object
))
3242 bufpos
= CHARPOS (tpos
);
3243 } while (NILP (spec
)
3244 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3247 if (!STRINGP (object
))
3248 cached_disp_pos
= CHARPOS (tpos
);
3249 return CHARPOS (tpos
);
3252 /* Return the character position of the end of the display string that
3253 started at CHARPOS. A display string is either an overlay with
3254 `display' property whose value is a string or a `display' text
3255 property whose value is a string. */
3257 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3259 /* OBJECT = nil means current buffer. */
3260 Lisp_Object object
=
3261 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3262 Lisp_Object pos
= make_number (charpos
);
3264 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3266 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3269 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3272 /* Look forward for the first character where the `display' property
3274 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3276 return XFASTINT (pos
);
3281 /***********************************************************************
3283 ***********************************************************************/
3285 /* Handle changes in the `fontified' property of the current buffer by
3286 calling hook functions from Qfontification_functions to fontify
3289 static enum prop_handled
3290 handle_fontified_prop (struct it
*it
)
3292 Lisp_Object prop
, pos
;
3293 enum prop_handled handled
= HANDLED_NORMALLY
;
3295 if (!NILP (Vmemory_full
))
3298 /* Get the value of the `fontified' property at IT's current buffer
3299 position. (The `fontified' property doesn't have a special
3300 meaning in strings.) If the value is nil, call functions from
3301 Qfontification_functions. */
3302 if (!STRINGP (it
->string
)
3304 && !NILP (Vfontification_functions
)
3305 && !NILP (Vrun_hooks
)
3306 && (pos
= make_number (IT_CHARPOS (*it
)),
3307 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3308 /* Ignore the special cased nil value always present at EOB since
3309 no amount of fontifying will be able to change it. */
3310 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3312 int count
= SPECPDL_INDEX ();
3314 struct buffer
*obuf
= current_buffer
;
3315 int begv
= BEGV
, zv
= ZV
;
3316 int old_clip_changed
= current_buffer
->clip_changed
;
3318 val
= Vfontification_functions
;
3319 specbind (Qfontification_functions
, Qnil
);
3321 xassert (it
->end_charpos
== ZV
);
3323 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3324 safe_call1 (val
, pos
);
3327 Lisp_Object fns
, fn
;
3328 struct gcpro gcpro1
, gcpro2
;
3333 for (; CONSP (val
); val
= XCDR (val
))
3339 /* A value of t indicates this hook has a local
3340 binding; it means to run the global binding too.
3341 In a global value, t should not occur. If it
3342 does, we must ignore it to avoid an endless
3344 for (fns
= Fdefault_value (Qfontification_functions
);
3350 safe_call1 (fn
, pos
);
3354 safe_call1 (fn
, pos
);
3360 unbind_to (count
, Qnil
);
3362 /* Fontification functions routinely call `save-restriction'.
3363 Normally, this tags clip_changed, which can confuse redisplay
3364 (see discussion in Bug#6671). Since we don't perform any
3365 special handling of fontification changes in the case where
3366 `save-restriction' isn't called, there's no point doing so in
3367 this case either. So, if the buffer's restrictions are
3368 actually left unchanged, reset clip_changed. */
3369 if (obuf
== current_buffer
)
3371 if (begv
== BEGV
&& zv
== ZV
)
3372 current_buffer
->clip_changed
= old_clip_changed
;
3374 /* There isn't much we can reasonably do to protect against
3375 misbehaving fontification, but here's a fig leaf. */
3376 else if (!NILP (BVAR (obuf
, name
)))
3377 set_buffer_internal_1 (obuf
);
3379 /* The fontification code may have added/removed text.
3380 It could do even a lot worse, but let's at least protect against
3381 the most obvious case where only the text past `pos' gets changed',
3382 as is/was done in grep.el where some escapes sequences are turned
3383 into face properties (bug#7876). */
3384 it
->end_charpos
= ZV
;
3386 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3387 something. This avoids an endless loop if they failed to
3388 fontify the text for which reason ever. */
3389 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3390 handled
= HANDLED_RECOMPUTE_PROPS
;
3398 /***********************************************************************
3400 ***********************************************************************/
3402 /* Set up iterator IT from face properties at its current position.
3403 Called from handle_stop. */
3405 static enum prop_handled
3406 handle_face_prop (struct it
*it
)
3409 EMACS_INT next_stop
;
3411 if (!STRINGP (it
->string
))
3414 = face_at_buffer_position (it
->w
,
3416 it
->region_beg_charpos
,
3417 it
->region_end_charpos
,
3420 + TEXT_PROP_DISTANCE_LIMIT
),
3421 0, it
->base_face_id
);
3423 /* Is this a start of a run of characters with box face?
3424 Caveat: this can be called for a freshly initialized
3425 iterator; face_id is -1 in this case. We know that the new
3426 face will not change until limit, i.e. if the new face has a
3427 box, all characters up to limit will have one. But, as
3428 usual, we don't know whether limit is really the end. */
3429 if (new_face_id
!= it
->face_id
)
3431 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3433 /* If new face has a box but old face has not, this is
3434 the start of a run of characters with box, i.e. it has
3435 a shadow on the left side. The value of face_id of the
3436 iterator will be -1 if this is the initial call that gets
3437 the face. In this case, we have to look in front of IT's
3438 position and see whether there is a face != new_face_id. */
3439 it
->start_of_box_run_p
3440 = (new_face
->box
!= FACE_NO_BOX
3441 && (it
->face_id
>= 0
3442 || IT_CHARPOS (*it
) == BEG
3443 || new_face_id
!= face_before_it_pos (it
)));
3444 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3452 Lisp_Object from_overlay
3453 = (it
->current
.overlay_string_index
>= 0
3454 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3457 /* See if we got to this string directly or indirectly from
3458 an overlay property. That includes the before-string or
3459 after-string of an overlay, strings in display properties
3460 provided by an overlay, their text properties, etc.
3462 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3463 if (! NILP (from_overlay
))
3464 for (i
= it
->sp
- 1; i
>= 0; i
--)
3466 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3468 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3469 else if (! NILP (it
->stack
[i
].from_overlay
))
3470 from_overlay
= it
->stack
[i
].from_overlay
;
3472 if (!NILP (from_overlay
))
3476 if (! NILP (from_overlay
))
3478 bufpos
= IT_CHARPOS (*it
);
3479 /* For a string from an overlay, the base face depends
3480 only on text properties and ignores overlays. */
3482 = face_for_overlay_string (it
->w
,
3484 it
->region_beg_charpos
,
3485 it
->region_end_charpos
,
3488 + TEXT_PROP_DISTANCE_LIMIT
),
3496 /* For strings from a `display' property, use the face at
3497 IT's current buffer position as the base face to merge
3498 with, so that overlay strings appear in the same face as
3499 surrounding text, unless they specify their own
3501 base_face_id
= underlying_face_id (it
);
3504 new_face_id
= face_at_string_position (it
->w
,
3506 IT_STRING_CHARPOS (*it
),
3508 it
->region_beg_charpos
,
3509 it
->region_end_charpos
,
3513 /* Is this a start of a run of characters with box? Caveat:
3514 this can be called for a freshly allocated iterator; face_id
3515 is -1 is this case. We know that the new face will not
3516 change until the next check pos, i.e. if the new face has a
3517 box, all characters up to that position will have a
3518 box. But, as usual, we don't know whether that position
3519 is really the end. */
3520 if (new_face_id
!= it
->face_id
)
3522 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3523 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3525 /* If new face has a box but old face hasn't, this is the
3526 start of a run of characters with box, i.e. it has a
3527 shadow on the left side. */
3528 it
->start_of_box_run_p
3529 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3530 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3534 it
->face_id
= new_face_id
;
3535 return HANDLED_NORMALLY
;
3539 /* Return the ID of the face ``underlying'' IT's current position,
3540 which is in a string. If the iterator is associated with a
3541 buffer, return the face at IT's current buffer position.
3542 Otherwise, use the iterator's base_face_id. */
3545 underlying_face_id (struct it
*it
)
3547 int face_id
= it
->base_face_id
, i
;
3549 xassert (STRINGP (it
->string
));
3551 for (i
= it
->sp
- 1; i
>= 0; --i
)
3552 if (NILP (it
->stack
[i
].string
))
3553 face_id
= it
->stack
[i
].face_id
;
3559 /* Compute the face one character before or after the current position
3560 of IT, in the visual order. BEFORE_P non-zero means get the face
3561 in front (to the left in L2R paragraphs, to the right in R2L
3562 paragraphs) of IT's screen position. Value is the ID of the face. */
3565 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3568 EMACS_INT next_check_charpos
;
3570 void *it_copy_data
= NULL
;
3572 xassert (it
->s
== NULL
);
3574 if (STRINGP (it
->string
))
3576 EMACS_INT bufpos
, charpos
;
3579 /* No face change past the end of the string (for the case
3580 we are padding with spaces). No face change before the
3582 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3583 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3588 /* Set charpos to the position before or after IT's current
3589 position, in the logical order, which in the non-bidi
3590 case is the same as the visual order. */
3592 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3593 else if (it
->what
== IT_COMPOSITION
)
3594 /* For composition, we must check the character after the
3596 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3598 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3604 /* With bidi iteration, the character before the current
3605 in the visual order cannot be found by simple
3606 iteration, because "reverse" reordering is not
3607 supported. Instead, we need to use the move_it_*
3608 family of functions. */
3609 /* Ignore face changes before the first visible
3610 character on this display line. */
3611 if (it
->current_x
<= it
->first_visible_x
)
3613 SAVE_IT (it_copy
, *it
, it_copy_data
);
3614 /* Implementation note: Since move_it_in_display_line
3615 works in the iterator geometry, and thinks the first
3616 character is always the leftmost, even in R2L lines,
3617 we don't need to distinguish between the R2L and L2R
3619 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3620 it_copy
.current_x
- 1, MOVE_TO_X
);
3621 charpos
= IT_STRING_CHARPOS (it_copy
);
3622 RESTORE_IT (it
, it
, it_copy_data
);
3626 /* Set charpos to the string position of the character
3627 that comes after IT's current position in the visual
3629 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3633 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3635 charpos
= it_copy
.bidi_it
.charpos
;
3638 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3640 if (it
->current
.overlay_string_index
>= 0)
3641 bufpos
= IT_CHARPOS (*it
);
3645 base_face_id
= underlying_face_id (it
);
3647 /* Get the face for ASCII, or unibyte. */
3648 face_id
= face_at_string_position (it
->w
,
3652 it
->region_beg_charpos
,
3653 it
->region_end_charpos
,
3654 &next_check_charpos
,
3657 /* Correct the face for charsets different from ASCII. Do it
3658 for the multibyte case only. The face returned above is
3659 suitable for unibyte text if IT->string is unibyte. */
3660 if (STRING_MULTIBYTE (it
->string
))
3662 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3663 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3665 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3667 c
= string_char_and_length (p
, &len
);
3668 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3673 struct text_pos pos
;
3675 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3676 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3679 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3680 pos
= it
->current
.pos
;
3685 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3688 if (it
->what
== IT_COMPOSITION
)
3690 /* For composition, we must check the position after
3692 pos
.charpos
+= it
->cmp_it
.nchars
;
3693 pos
.bytepos
+= it
->len
;
3696 INC_TEXT_POS (pos
, it
->multibyte_p
);
3703 /* With bidi iteration, the character before the current
3704 in the visual order cannot be found by simple
3705 iteration, because "reverse" reordering is not
3706 supported. Instead, we need to use the move_it_*
3707 family of functions. */
3708 /* Ignore face changes before the first visible
3709 character on this display line. */
3710 if (it
->current_x
<= it
->first_visible_x
)
3712 SAVE_IT (it_copy
, *it
, it_copy_data
);
3713 /* Implementation note: Since move_it_in_display_line
3714 works in the iterator geometry, and thinks the first
3715 character is always the leftmost, even in R2L lines,
3716 we don't need to distinguish between the R2L and L2R
3718 move_it_in_display_line (&it_copy
, ZV
,
3719 it_copy
.current_x
- 1, MOVE_TO_X
);
3720 pos
= it_copy
.current
.pos
;
3721 RESTORE_IT (it
, it
, it_copy_data
);
3725 /* Set charpos to the buffer position of the character
3726 that comes after IT's current position in the visual
3728 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3732 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3735 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3738 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3740 /* Determine face for CHARSET_ASCII, or unibyte. */
3741 face_id
= face_at_buffer_position (it
->w
,
3743 it
->region_beg_charpos
,
3744 it
->region_end_charpos
,
3745 &next_check_charpos
,
3748 /* Correct the face for charsets different from ASCII. Do it
3749 for the multibyte case only. The face returned above is
3750 suitable for unibyte text if current_buffer is unibyte. */
3751 if (it
->multibyte_p
)
3753 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3754 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3755 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3764 /***********************************************************************
3766 ***********************************************************************/
3768 /* Set up iterator IT from invisible properties at its current
3769 position. Called from handle_stop. */
3771 static enum prop_handled
3772 handle_invisible_prop (struct it
*it
)
3774 enum prop_handled handled
= HANDLED_NORMALLY
;
3776 if (STRINGP (it
->string
))
3778 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3780 /* Get the value of the invisible text property at the
3781 current position. Value will be nil if there is no such
3783 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3784 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3787 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3791 handled
= HANDLED_RECOMPUTE_PROPS
;
3793 /* Get the position at which the next change of the
3794 invisible text property can be found in IT->string.
3795 Value will be nil if the property value is the same for
3796 all the rest of IT->string. */
3797 XSETINT (limit
, SCHARS (it
->string
));
3798 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3801 /* Text at current position is invisible. The next
3802 change in the property is at position end_charpos.
3803 Move IT's current position to that position. */
3804 if (INTEGERP (end_charpos
)
3805 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3807 struct text_pos old
;
3810 old
= it
->current
.string_pos
;
3811 oldpos
= CHARPOS (old
);
3814 if (it
->bidi_it
.first_elt
3815 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3816 bidi_paragraph_init (it
->paragraph_embedding
,
3818 /* Bidi-iterate out of the invisible text. */
3821 bidi_move_to_visually_next (&it
->bidi_it
);
3823 while (oldpos
<= it
->bidi_it
.charpos
3824 && it
->bidi_it
.charpos
< endpos
);
3826 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3827 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3828 if (IT_CHARPOS (*it
) >= endpos
)
3829 it
->prev_stop
= endpos
;
3833 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3834 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3839 /* The rest of the string is invisible. If this is an
3840 overlay string, proceed with the next overlay string
3841 or whatever comes and return a character from there. */
3842 if (it
->current
.overlay_string_index
>= 0)
3844 next_overlay_string (it
);
3845 /* Don't check for overlay strings when we just
3846 finished processing them. */
3847 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3851 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3852 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3860 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3861 Lisp_Object pos
, prop
, overlay
;
3863 /* First of all, is there invisible text at this position? */
3864 tem
= start_charpos
= IT_CHARPOS (*it
);
3865 pos
= make_number (tem
);
3866 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3868 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3870 /* If we are on invisible text, skip over it. */
3871 if (invis_p
&& start_charpos
< it
->end_charpos
)
3873 /* Record whether we have to display an ellipsis for the
3875 int display_ellipsis_p
= invis_p
== 2;
3877 handled
= HANDLED_RECOMPUTE_PROPS
;
3879 /* Loop skipping over invisible text. The loop is left at
3880 ZV or with IT on the first char being visible again. */
3883 /* Try to skip some invisible text. Return value is the
3884 position reached which can be equal to where we start
3885 if there is nothing invisible there. This skips both
3886 over invisible text properties and overlays with
3887 invisible property. */
3888 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3890 /* If we skipped nothing at all we weren't at invisible
3891 text in the first place. If everything to the end of
3892 the buffer was skipped, end the loop. */
3893 if (newpos
== tem
|| newpos
>= ZV
)
3897 /* We skipped some characters but not necessarily
3898 all there are. Check if we ended up on visible
3899 text. Fget_char_property returns the property of
3900 the char before the given position, i.e. if we
3901 get invis_p = 0, this means that the char at
3902 newpos is visible. */
3903 pos
= make_number (newpos
);
3904 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3905 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3908 /* If we ended up on invisible text, proceed to
3909 skip starting with next_stop. */
3913 /* If there are adjacent invisible texts, don't lose the
3914 second one's ellipsis. */
3916 display_ellipsis_p
= 1;
3920 /* The position newpos is now either ZV or on visible text. */
3921 if (it
->bidi_p
&& newpos
< ZV
)
3923 /* With bidi iteration, the region of invisible text
3924 could start and/or end in the middle of a non-base
3925 embedding level. Therefore, we need to skip
3926 invisible text using the bidi iterator, starting at
3927 IT's current position, until we find ourselves
3928 outside the invisible text. Skipping invisible text
3929 _after_ bidi iteration avoids affecting the visual
3930 order of the displayed text when invisible properties
3931 are added or removed. */
3932 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3934 /* If we were `reseat'ed to a new paragraph,
3935 determine the paragraph base direction. We need
3936 to do it now because next_element_from_buffer may
3937 not have a chance to do it, if we are going to
3938 skip any text at the beginning, which resets the
3940 bidi_paragraph_init (it
->paragraph_embedding
,
3945 bidi_move_to_visually_next (&it
->bidi_it
);
3947 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3948 && it
->bidi_it
.charpos
< newpos
);
3949 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3950 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3951 /* If we overstepped NEWPOS, record its position in the
3952 iterator, so that we skip invisible text if later the
3953 bidi iteration lands us in the invisible region
3955 if (IT_CHARPOS (*it
) >= newpos
)
3956 it
->prev_stop
= newpos
;
3960 IT_CHARPOS (*it
) = newpos
;
3961 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3964 /* If there are before-strings at the start of invisible
3965 text, and the text is invisible because of a text
3966 property, arrange to show before-strings because 20.x did
3967 it that way. (If the text is invisible because of an
3968 overlay property instead of a text property, this is
3969 already handled in the overlay code.) */
3971 && get_overlay_strings (it
, it
->stop_charpos
))
3973 handled
= HANDLED_RECOMPUTE_PROPS
;
3974 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3976 else if (display_ellipsis_p
)
3978 /* Make sure that the glyphs of the ellipsis will get
3979 correct `charpos' values. If we would not update
3980 it->position here, the glyphs would belong to the
3981 last visible character _before_ the invisible
3982 text, which confuses `set_cursor_from_row'.
3984 We use the last invisible position instead of the
3985 first because this way the cursor is always drawn on
3986 the first "." of the ellipsis, whenever PT is inside
3987 the invisible text. Otherwise the cursor would be
3988 placed _after_ the ellipsis when the point is after the
3989 first invisible character. */
3990 if (!STRINGP (it
->object
))
3992 it
->position
.charpos
= newpos
- 1;
3993 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3996 /* Let the ellipsis display before
3997 considering any properties of the following char.
3998 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3999 handled
= HANDLED_RETURN
;
4008 /* Make iterator IT return `...' next.
4009 Replaces LEN characters from buffer. */
4012 setup_for_ellipsis (struct it
*it
, int len
)
4014 /* Use the display table definition for `...'. Invalid glyphs
4015 will be handled by the method returning elements from dpvec. */
4016 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4018 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4019 it
->dpvec
= v
->contents
;
4020 it
->dpend
= v
->contents
+ v
->header
.size
;
4024 /* Default `...'. */
4025 it
->dpvec
= default_invis_vector
;
4026 it
->dpend
= default_invis_vector
+ 3;
4029 it
->dpvec_char_len
= len
;
4030 it
->current
.dpvec_index
= 0;
4031 it
->dpvec_face_id
= -1;
4033 /* Remember the current face id in case glyphs specify faces.
4034 IT's face is restored in set_iterator_to_next.
4035 saved_face_id was set to preceding char's face in handle_stop. */
4036 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4037 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4039 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4045 /***********************************************************************
4047 ***********************************************************************/
4049 /* Set up iterator IT from `display' property at its current position.
4050 Called from handle_stop.
4051 We return HANDLED_RETURN if some part of the display property
4052 overrides the display of the buffer text itself.
4053 Otherwise we return HANDLED_NORMALLY. */
4055 static enum prop_handled
4056 handle_display_prop (struct it
*it
)
4058 Lisp_Object propval
, object
, overlay
;
4059 struct text_pos
*position
;
4061 /* Nonzero if some property replaces the display of the text itself. */
4062 int display_replaced_p
= 0;
4064 if (STRINGP (it
->string
))
4066 object
= it
->string
;
4067 position
= &it
->current
.string_pos
;
4068 bufpos
= CHARPOS (it
->current
.pos
);
4072 XSETWINDOW (object
, it
->w
);
4073 position
= &it
->current
.pos
;
4074 bufpos
= CHARPOS (*position
);
4077 /* Reset those iterator values set from display property values. */
4078 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4079 it
->space_width
= Qnil
;
4080 it
->font_height
= Qnil
;
4083 /* We don't support recursive `display' properties, i.e. string
4084 values that have a string `display' property, that have a string
4085 `display' property etc. */
4086 if (!it
->string_from_display_prop_p
)
4087 it
->area
= TEXT_AREA
;
4089 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4090 Qdisplay
, object
, &overlay
);
4092 return HANDLED_NORMALLY
;
4093 /* Now OVERLAY is the overlay that gave us this property, or nil
4094 if it was a text property. */
4096 if (!STRINGP (it
->string
))
4097 object
= it
->w
->buffer
;
4099 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4101 FRAME_WINDOW_P (it
->f
));
4103 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4106 /* Subroutine of handle_display_prop. Returns non-zero if the display
4107 specification in SPEC is a replacing specification, i.e. it would
4108 replace the text covered by `display' property with something else,
4109 such as an image or a display string.
4111 See handle_single_display_spec for documentation of arguments.
4112 frame_window_p is non-zero if the window being redisplayed is on a
4113 GUI frame; this argument is used only if IT is NULL, see below.
4115 IT can be NULL, if this is called by the bidi reordering code
4116 through compute_display_string_pos, which see. In that case, this
4117 function only examines SPEC, but does not otherwise "handle" it, in
4118 the sense that it doesn't set up members of IT from the display
4121 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4122 Lisp_Object overlay
, struct text_pos
*position
,
4123 EMACS_INT bufpos
, int frame_window_p
)
4125 int replacing_p
= 0;
4128 /* Simple specerties. */
4129 && !EQ (XCAR (spec
), Qimage
)
4130 && !EQ (XCAR (spec
), Qspace
)
4131 && !EQ (XCAR (spec
), Qwhen
)
4132 && !EQ (XCAR (spec
), Qslice
)
4133 && !EQ (XCAR (spec
), Qspace_width
)
4134 && !EQ (XCAR (spec
), Qheight
)
4135 && !EQ (XCAR (spec
), Qraise
)
4136 /* Marginal area specifications. */
4137 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4138 && !EQ (XCAR (spec
), Qleft_fringe
)
4139 && !EQ (XCAR (spec
), Qright_fringe
)
4140 && !NILP (XCAR (spec
)))
4142 for (; CONSP (spec
); spec
= XCDR (spec
))
4144 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4145 position
, bufpos
, replacing_p
,
4149 /* If some text in a string is replaced, `position' no
4150 longer points to the position of `object'. */
4151 if (!it
|| STRINGP (object
))
4156 else if (VECTORP (spec
))
4159 for (i
= 0; i
< ASIZE (spec
); ++i
)
4160 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4161 position
, bufpos
, replacing_p
,
4165 /* If some text in a string is replaced, `position' no
4166 longer points to the position of `object'. */
4167 if (!it
|| STRINGP (object
))
4173 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4174 position
, bufpos
, 0, frame_window_p
))
4181 /* Value is the position of the end of the `display' property starting
4182 at START_POS in OBJECT. */
4184 static struct text_pos
4185 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4188 struct text_pos end_pos
;
4190 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4191 Qdisplay
, object
, Qnil
);
4192 CHARPOS (end_pos
) = XFASTINT (end
);
4193 if (STRINGP (object
))
4194 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4196 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4202 /* Set up IT from a single `display' property specification SPEC. OBJECT
4203 is the object in which the `display' property was found. *POSITION
4204 is the position in OBJECT at which the `display' property was found.
4205 BUFPOS is the buffer position of OBJECT (different from POSITION if
4206 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4207 previously saw a display specification which already replaced text
4208 display with something else, for example an image; we ignore such
4209 properties after the first one has been processed.
4211 OVERLAY is the overlay this `display' property came from,
4212 or nil if it was a text property.
4214 If SPEC is a `space' or `image' specification, and in some other
4215 cases too, set *POSITION to the position where the `display'
4218 If IT is NULL, only examine the property specification in SPEC, but
4219 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4220 is intended to be displayed in a window on a GUI frame.
4222 Value is non-zero if something was found which replaces the display
4223 of buffer or string text. */
4226 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4227 Lisp_Object overlay
, struct text_pos
*position
,
4228 EMACS_INT bufpos
, int display_replaced_p
,
4232 Lisp_Object location
, value
;
4233 struct text_pos start_pos
= *position
;
4236 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4237 If the result is non-nil, use VALUE instead of SPEC. */
4239 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4248 if (!NILP (form
) && !EQ (form
, Qt
))
4250 int count
= SPECPDL_INDEX ();
4251 struct gcpro gcpro1
;
4253 /* Bind `object' to the object having the `display' property, a
4254 buffer or string. Bind `position' to the position in the
4255 object where the property was found, and `buffer-position'
4256 to the current position in the buffer. */
4259 XSETBUFFER (object
, current_buffer
);
4260 specbind (Qobject
, object
);
4261 specbind (Qposition
, make_number (CHARPOS (*position
)));
4262 specbind (Qbuffer_position
, make_number (bufpos
));
4264 form
= safe_eval (form
);
4266 unbind_to (count
, Qnil
);
4272 /* Handle `(height HEIGHT)' specifications. */
4274 && EQ (XCAR (spec
), Qheight
)
4275 && CONSP (XCDR (spec
)))
4279 if (!FRAME_WINDOW_P (it
->f
))
4282 it
->font_height
= XCAR (XCDR (spec
));
4283 if (!NILP (it
->font_height
))
4285 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4286 int new_height
= -1;
4288 if (CONSP (it
->font_height
)
4289 && (EQ (XCAR (it
->font_height
), Qplus
)
4290 || EQ (XCAR (it
->font_height
), Qminus
))
4291 && CONSP (XCDR (it
->font_height
))
4292 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4294 /* `(+ N)' or `(- N)' where N is an integer. */
4295 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4296 if (EQ (XCAR (it
->font_height
), Qplus
))
4298 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4300 else if (FUNCTIONP (it
->font_height
))
4302 /* Call function with current height as argument.
4303 Value is the new height. */
4305 height
= safe_call1 (it
->font_height
,
4306 face
->lface
[LFACE_HEIGHT_INDEX
]);
4307 if (NUMBERP (height
))
4308 new_height
= XFLOATINT (height
);
4310 else if (NUMBERP (it
->font_height
))
4312 /* Value is a multiple of the canonical char height. */
4315 f
= FACE_FROM_ID (it
->f
,
4316 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4317 new_height
= (XFLOATINT (it
->font_height
)
4318 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4322 /* Evaluate IT->font_height with `height' bound to the
4323 current specified height to get the new height. */
4324 int count
= SPECPDL_INDEX ();
4326 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4327 value
= safe_eval (it
->font_height
);
4328 unbind_to (count
, Qnil
);
4330 if (NUMBERP (value
))
4331 new_height
= XFLOATINT (value
);
4335 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4342 /* Handle `(space-width WIDTH)'. */
4344 && EQ (XCAR (spec
), Qspace_width
)
4345 && CONSP (XCDR (spec
)))
4349 if (!FRAME_WINDOW_P (it
->f
))
4352 value
= XCAR (XCDR (spec
));
4353 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4354 it
->space_width
= value
;
4360 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4362 && EQ (XCAR (spec
), Qslice
))
4368 if (!FRAME_WINDOW_P (it
->f
))
4371 if (tem
= XCDR (spec
), CONSP (tem
))
4373 it
->slice
.x
= XCAR (tem
);
4374 if (tem
= XCDR (tem
), CONSP (tem
))
4376 it
->slice
.y
= XCAR (tem
);
4377 if (tem
= XCDR (tem
), CONSP (tem
))
4379 it
->slice
.width
= XCAR (tem
);
4380 if (tem
= XCDR (tem
), CONSP (tem
))
4381 it
->slice
.height
= XCAR (tem
);
4390 /* Handle `(raise FACTOR)'. */
4392 && EQ (XCAR (spec
), Qraise
)
4393 && CONSP (XCDR (spec
)))
4397 if (!FRAME_WINDOW_P (it
->f
))
4400 #ifdef HAVE_WINDOW_SYSTEM
4401 value
= XCAR (XCDR (spec
));
4402 if (NUMBERP (value
))
4404 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4405 it
->voffset
= - (XFLOATINT (value
)
4406 * (FONT_HEIGHT (face
->font
)));
4408 #endif /* HAVE_WINDOW_SYSTEM */
4414 /* Don't handle the other kinds of display specifications
4415 inside a string that we got from a `display' property. */
4416 if (it
&& it
->string_from_display_prop_p
)
4419 /* Characters having this form of property are not displayed, so
4420 we have to find the end of the property. */
4423 start_pos
= *position
;
4424 *position
= display_prop_end (it
, object
, start_pos
);
4428 /* Stop the scan at that end position--we assume that all
4429 text properties change there. */
4431 it
->stop_charpos
= position
->charpos
;
4433 /* Handle `(left-fringe BITMAP [FACE])'
4434 and `(right-fringe BITMAP [FACE])'. */
4436 && (EQ (XCAR (spec
), Qleft_fringe
)
4437 || EQ (XCAR (spec
), Qright_fringe
))
4438 && CONSP (XCDR (spec
)))
4444 if (!FRAME_WINDOW_P (it
->f
))
4445 /* If we return here, POSITION has been advanced
4446 across the text with this property. */
4449 else if (!frame_window_p
)
4452 #ifdef HAVE_WINDOW_SYSTEM
4453 value
= XCAR (XCDR (spec
));
4454 if (!SYMBOLP (value
)
4455 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4456 /* If we return here, POSITION has been advanced
4457 across the text with this property. */
4462 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4464 if (CONSP (XCDR (XCDR (spec
))))
4466 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4467 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4473 /* Save current settings of IT so that we can restore them
4474 when we are finished with the glyph property value. */
4475 push_it (it
, position
);
4477 it
->area
= TEXT_AREA
;
4478 it
->what
= IT_IMAGE
;
4479 it
->image_id
= -1; /* no image */
4480 it
->position
= start_pos
;
4481 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4482 it
->method
= GET_FROM_IMAGE
;
4483 it
->from_overlay
= Qnil
;
4484 it
->face_id
= face_id
;
4485 it
->from_disp_prop_p
= 1;
4487 /* Say that we haven't consumed the characters with
4488 `display' property yet. The call to pop_it in
4489 set_iterator_to_next will clean this up. */
4490 *position
= start_pos
;
4492 if (EQ (XCAR (spec
), Qleft_fringe
))
4494 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4495 it
->left_user_fringe_face_id
= face_id
;
4499 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4500 it
->right_user_fringe_face_id
= face_id
;
4503 #endif /* HAVE_WINDOW_SYSTEM */
4507 /* Prepare to handle `((margin left-margin) ...)',
4508 `((margin right-margin) ...)' and `((margin nil) ...)'
4509 prefixes for display specifications. */
4510 location
= Qunbound
;
4511 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4515 value
= XCDR (spec
);
4517 value
= XCAR (value
);
4520 if (EQ (XCAR (tem
), Qmargin
)
4521 && (tem
= XCDR (tem
),
4522 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4524 || EQ (tem
, Qleft_margin
)
4525 || EQ (tem
, Qright_margin
))))
4529 if (EQ (location
, Qunbound
))
4535 /* After this point, VALUE is the property after any
4536 margin prefix has been stripped. It must be a string,
4537 an image specification, or `(space ...)'.
4539 LOCATION specifies where to display: `left-margin',
4540 `right-margin' or nil. */
4542 valid_p
= (STRINGP (value
)
4543 #ifdef HAVE_WINDOW_SYSTEM
4544 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4545 && valid_image_p (value
))
4546 #endif /* not HAVE_WINDOW_SYSTEM */
4547 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4549 if (valid_p
&& !display_replaced_p
)
4554 /* Save current settings of IT so that we can restore them
4555 when we are finished with the glyph property value. */
4556 push_it (it
, position
);
4557 it
->from_overlay
= overlay
;
4558 it
->from_disp_prop_p
= 1;
4560 if (NILP (location
))
4561 it
->area
= TEXT_AREA
;
4562 else if (EQ (location
, Qleft_margin
))
4563 it
->area
= LEFT_MARGIN_AREA
;
4565 it
->area
= RIGHT_MARGIN_AREA
;
4567 if (STRINGP (value
))
4570 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4571 it
->current
.overlay_string_index
= -1;
4572 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4573 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4574 it
->method
= GET_FROM_STRING
;
4575 it
->stop_charpos
= 0;
4577 it
->base_level_stop
= 0;
4578 it
->string_from_display_prop_p
= 1;
4579 /* Say that we haven't consumed the characters with
4580 `display' property yet. The call to pop_it in
4581 set_iterator_to_next will clean this up. */
4582 if (BUFFERP (object
))
4583 *position
= start_pos
;
4585 /* Force paragraph direction to be that of the parent
4586 object. If the parent object's paragraph direction is
4587 not yet determined, default to L2R. */
4588 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4589 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4591 it
->paragraph_embedding
= L2R
;
4593 /* Set up the bidi iterator for this display string. */
4596 it
->bidi_it
.string
.lstring
= it
->string
;
4597 it
->bidi_it
.string
.s
= NULL
;
4598 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4599 it
->bidi_it
.string
.bufpos
= bufpos
;
4600 it
->bidi_it
.string
.from_disp_str
= 1;
4601 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4602 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4605 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4607 it
->method
= GET_FROM_STRETCH
;
4609 *position
= it
->position
= start_pos
;
4611 #ifdef HAVE_WINDOW_SYSTEM
4614 it
->what
= IT_IMAGE
;
4615 it
->image_id
= lookup_image (it
->f
, value
);
4616 it
->position
= start_pos
;
4617 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4618 it
->method
= GET_FROM_IMAGE
;
4620 /* Say that we haven't consumed the characters with
4621 `display' property yet. The call to pop_it in
4622 set_iterator_to_next will clean this up. */
4623 *position
= start_pos
;
4625 #endif /* HAVE_WINDOW_SYSTEM */
4630 /* Invalid property or property not supported. Restore
4631 POSITION to what it was before. */
4632 *position
= start_pos
;
4636 /* Check if PROP is a display property value whose text should be
4637 treated as intangible. OVERLAY is the overlay from which PROP
4638 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4639 specify the buffer position covered by PROP. */
4642 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4643 EMACS_INT charpos
, EMACS_INT bytepos
)
4645 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4646 struct text_pos position
;
4648 SET_TEXT_POS (position
, charpos
, bytepos
);
4649 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4650 &position
, charpos
, frame_window_p
);
4654 /* Return 1 if PROP is a display sub-property value containing STRING.
4656 Implementation note: this and the following function are really
4657 special cases of handle_display_spec and
4658 handle_single_display_spec, and should ideally use the same code.
4659 Until they do, these two pairs must be consistent and must be
4660 modified in sync. */
4663 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4665 if (EQ (string
, prop
))
4668 /* Skip over `when FORM'. */
4669 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4674 /* Actually, the condition following `when' should be eval'ed,
4675 like handle_single_display_spec does, and we should return
4676 zero if it evaluates to nil. However, this function is
4677 called only when the buffer was already displayed and some
4678 glyph in the glyph matrix was found to come from a display
4679 string. Therefore, the condition was already evaluated, and
4680 the result was non-nil, otherwise the display string wouldn't
4681 have been displayed and we would have never been called for
4682 this property. Thus, we can skip the evaluation and assume
4683 its result is non-nil. */
4688 /* Skip over `margin LOCATION'. */
4689 if (EQ (XCAR (prop
), Qmargin
))
4700 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4704 /* Return 1 if STRING appears in the `display' property PROP. */
4707 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4710 && !EQ (XCAR (prop
), Qwhen
)
4711 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4713 /* A list of sub-properties. */
4714 while (CONSP (prop
))
4716 if (single_display_spec_string_p (XCAR (prop
), string
))
4721 else if (VECTORP (prop
))
4723 /* A vector of sub-properties. */
4725 for (i
= 0; i
< ASIZE (prop
); ++i
)
4726 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4730 return single_display_spec_string_p (prop
, string
);
4735 /* Look for STRING in overlays and text properties in the current
4736 buffer, between character positions FROM and TO (excluding TO).
4737 BACK_P non-zero means look back (in this case, TO is supposed to be
4739 Value is the first character position where STRING was found, or
4740 zero if it wasn't found before hitting TO.
4742 This function may only use code that doesn't eval because it is
4743 called asynchronously from note_mouse_highlight. */
4746 string_buffer_position_lim (Lisp_Object string
,
4747 EMACS_INT from
, EMACS_INT to
, int back_p
)
4749 Lisp_Object limit
, prop
, pos
;
4752 pos
= make_number (from
);
4754 if (!back_p
) /* looking forward */
4756 limit
= make_number (min (to
, ZV
));
4757 while (!found
&& !EQ (pos
, limit
))
4759 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4760 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4763 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4767 else /* looking back */
4769 limit
= make_number (max (to
, BEGV
));
4770 while (!found
&& !EQ (pos
, limit
))
4772 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4773 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4776 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4781 return found
? XINT (pos
) : 0;
4784 /* Determine which buffer position in current buffer STRING comes from.
4785 AROUND_CHARPOS is an approximate position where it could come from.
4786 Value is the buffer position or 0 if it couldn't be determined.
4788 This function is necessary because we don't record buffer positions
4789 in glyphs generated from strings (to keep struct glyph small).
4790 This function may only use code that doesn't eval because it is
4791 called asynchronously from note_mouse_highlight. */
4794 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4796 const int MAX_DISTANCE
= 1000;
4797 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4798 around_charpos
+ MAX_DISTANCE
,
4802 found
= string_buffer_position_lim (string
, around_charpos
,
4803 around_charpos
- MAX_DISTANCE
, 1);
4809 /***********************************************************************
4810 `composition' property
4811 ***********************************************************************/
4813 /* Set up iterator IT from `composition' property at its current
4814 position. Called from handle_stop. */
4816 static enum prop_handled
4817 handle_composition_prop (struct it
*it
)
4819 Lisp_Object prop
, string
;
4820 EMACS_INT pos
, pos_byte
, start
, end
;
4822 if (STRINGP (it
->string
))
4826 pos
= IT_STRING_CHARPOS (*it
);
4827 pos_byte
= IT_STRING_BYTEPOS (*it
);
4828 string
= it
->string
;
4829 s
= SDATA (string
) + pos_byte
;
4830 it
->c
= STRING_CHAR (s
);
4834 pos
= IT_CHARPOS (*it
);
4835 pos_byte
= IT_BYTEPOS (*it
);
4837 it
->c
= FETCH_CHAR (pos_byte
);
4840 /* If there's a valid composition and point is not inside of the
4841 composition (in the case that the composition is from the current
4842 buffer), draw a glyph composed from the composition components. */
4843 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4844 && COMPOSITION_VALID_P (start
, end
, prop
)
4845 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4848 /* As we can't handle this situation (perhaps font-lock added
4849 a new composition), we just return here hoping that next
4850 redisplay will detect this composition much earlier. */
4851 return HANDLED_NORMALLY
;
4854 if (STRINGP (it
->string
))
4855 pos_byte
= string_char_to_byte (it
->string
, start
);
4857 pos_byte
= CHAR_TO_BYTE (start
);
4859 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4862 if (it
->cmp_it
.id
>= 0)
4865 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4866 it
->cmp_it
.nglyphs
= -1;
4870 return HANDLED_NORMALLY
;
4875 /***********************************************************************
4877 ***********************************************************************/
4879 /* The following structure is used to record overlay strings for
4880 later sorting in load_overlay_strings. */
4882 struct overlay_entry
4884 Lisp_Object overlay
;
4891 /* Set up iterator IT from overlay strings at its current position.
4892 Called from handle_stop. */
4894 static enum prop_handled
4895 handle_overlay_change (struct it
*it
)
4897 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4898 return HANDLED_RECOMPUTE_PROPS
;
4900 return HANDLED_NORMALLY
;
4904 /* Set up the next overlay string for delivery by IT, if there is an
4905 overlay string to deliver. Called by set_iterator_to_next when the
4906 end of the current overlay string is reached. If there are more
4907 overlay strings to display, IT->string and
4908 IT->current.overlay_string_index are set appropriately here.
4909 Otherwise IT->string is set to nil. */
4912 next_overlay_string (struct it
*it
)
4914 ++it
->current
.overlay_string_index
;
4915 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4917 /* No more overlay strings. Restore IT's settings to what
4918 they were before overlay strings were processed, and
4919 continue to deliver from current_buffer. */
4921 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4924 || (NILP (it
->string
)
4925 && it
->method
== GET_FROM_BUFFER
4926 && it
->stop_charpos
>= BEGV
4927 && it
->stop_charpos
<= it
->end_charpos
));
4928 it
->current
.overlay_string_index
= -1;
4929 it
->n_overlay_strings
= 0;
4930 it
->overlay_strings_charpos
= -1;
4932 /* If we're at the end of the buffer, record that we have
4933 processed the overlay strings there already, so that
4934 next_element_from_buffer doesn't try it again. */
4935 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4936 it
->overlay_strings_at_end_processed_p
= 1;
4940 /* There are more overlay strings to process. If
4941 IT->current.overlay_string_index has advanced to a position
4942 where we must load IT->overlay_strings with more strings, do
4943 it. We must load at the IT->overlay_strings_charpos where
4944 IT->n_overlay_strings was originally computed; when invisible
4945 text is present, this might not be IT_CHARPOS (Bug#7016). */
4946 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4948 if (it
->current
.overlay_string_index
&& i
== 0)
4949 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4951 /* Initialize IT to deliver display elements from the overlay
4953 it
->string
= it
->overlay_strings
[i
];
4954 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4955 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4956 it
->method
= GET_FROM_STRING
;
4957 it
->stop_charpos
= 0;
4958 if (it
->cmp_it
.stop_pos
>= 0)
4959 it
->cmp_it
.stop_pos
= 0;
4961 it
->base_level_stop
= 0;
4963 /* Set up the bidi iterator for this overlay string. */
4966 it
->bidi_it
.string
.lstring
= it
->string
;
4967 it
->bidi_it
.string
.s
= NULL
;
4968 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4969 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4970 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4971 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4972 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4980 /* Compare two overlay_entry structures E1 and E2. Used as a
4981 comparison function for qsort in load_overlay_strings. Overlay
4982 strings for the same position are sorted so that
4984 1. All after-strings come in front of before-strings, except
4985 when they come from the same overlay.
4987 2. Within after-strings, strings are sorted so that overlay strings
4988 from overlays with higher priorities come first.
4990 2. Within before-strings, strings are sorted so that overlay
4991 strings from overlays with higher priorities come last.
4993 Value is analogous to strcmp. */
4997 compare_overlay_entries (const void *e1
, const void *e2
)
4999 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5000 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5003 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5005 /* Let after-strings appear in front of before-strings if
5006 they come from different overlays. */
5007 if (EQ (entry1
->overlay
, entry2
->overlay
))
5008 result
= entry1
->after_string_p
? 1 : -1;
5010 result
= entry1
->after_string_p
? -1 : 1;
5012 else if (entry1
->after_string_p
)
5013 /* After-strings sorted in order of decreasing priority. */
5014 result
= entry2
->priority
- entry1
->priority
;
5016 /* Before-strings sorted in order of increasing priority. */
5017 result
= entry1
->priority
- entry2
->priority
;
5023 /* Load the vector IT->overlay_strings with overlay strings from IT's
5024 current buffer position, or from CHARPOS if that is > 0. Set
5025 IT->n_overlays to the total number of overlay strings found.
5027 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5028 a time. On entry into load_overlay_strings,
5029 IT->current.overlay_string_index gives the number of overlay
5030 strings that have already been loaded by previous calls to this
5033 IT->add_overlay_start contains an additional overlay start
5034 position to consider for taking overlay strings from, if non-zero.
5035 This position comes into play when the overlay has an `invisible'
5036 property, and both before and after-strings. When we've skipped to
5037 the end of the overlay, because of its `invisible' property, we
5038 nevertheless want its before-string to appear.
5039 IT->add_overlay_start will contain the overlay start position
5042 Overlay strings are sorted so that after-string strings come in
5043 front of before-string strings. Within before and after-strings,
5044 strings are sorted by overlay priority. See also function
5045 compare_overlay_entries. */
5048 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5050 Lisp_Object overlay
, window
, str
, invisible
;
5051 struct Lisp_Overlay
*ov
;
5052 EMACS_INT start
, end
;
5054 int n
= 0, i
, j
, invis_p
;
5055 struct overlay_entry
*entries
5056 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5059 charpos
= IT_CHARPOS (*it
);
5061 /* Append the overlay string STRING of overlay OVERLAY to vector
5062 `entries' which has size `size' and currently contains `n'
5063 elements. AFTER_P non-zero means STRING is an after-string of
5065 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5068 Lisp_Object priority; \
5072 int new_size = 2 * size; \
5073 struct overlay_entry *old = entries; \
5075 (struct overlay_entry *) alloca (new_size \
5076 * sizeof *entries); \
5077 memcpy (entries, old, size * sizeof *entries); \
5081 entries[n].string = (STRING); \
5082 entries[n].overlay = (OVERLAY); \
5083 priority = Foverlay_get ((OVERLAY), Qpriority); \
5084 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5085 entries[n].after_string_p = (AFTER_P); \
5090 /* Process overlay before the overlay center. */
5091 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5093 XSETMISC (overlay
, ov
);
5094 xassert (OVERLAYP (overlay
));
5095 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5096 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5101 /* Skip this overlay if it doesn't start or end at IT's current
5103 if (end
!= charpos
&& start
!= charpos
)
5106 /* Skip this overlay if it doesn't apply to IT->w. */
5107 window
= Foverlay_get (overlay
, Qwindow
);
5108 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5111 /* If the text ``under'' the overlay is invisible, both before-
5112 and after-strings from this overlay are visible; start and
5113 end position are indistinguishable. */
5114 invisible
= Foverlay_get (overlay
, Qinvisible
);
5115 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5117 /* If overlay has a non-empty before-string, record it. */
5118 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5119 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5121 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5123 /* If overlay has a non-empty after-string, record it. */
5124 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5125 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5127 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5130 /* Process overlays after the overlay center. */
5131 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5133 XSETMISC (overlay
, ov
);
5134 xassert (OVERLAYP (overlay
));
5135 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5136 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5138 if (start
> charpos
)
5141 /* Skip this overlay if it doesn't start or end at IT's current
5143 if (end
!= charpos
&& start
!= charpos
)
5146 /* Skip this overlay if it doesn't apply to IT->w. */
5147 window
= Foverlay_get (overlay
, Qwindow
);
5148 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5151 /* If the text ``under'' the overlay is invisible, it has a zero
5152 dimension, and both before- and after-strings apply. */
5153 invisible
= Foverlay_get (overlay
, Qinvisible
);
5154 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5156 /* If overlay has a non-empty before-string, record it. */
5157 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5158 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5160 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5162 /* If overlay has a non-empty after-string, record it. */
5163 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5164 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5166 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5169 #undef RECORD_OVERLAY_STRING
5173 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5175 /* Record number of overlay strings, and where we computed it. */
5176 it
->n_overlay_strings
= n
;
5177 it
->overlay_strings_charpos
= charpos
;
5179 /* IT->current.overlay_string_index is the number of overlay strings
5180 that have already been consumed by IT. Copy some of the
5181 remaining overlay strings to IT->overlay_strings. */
5183 j
= it
->current
.overlay_string_index
;
5184 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5186 it
->overlay_strings
[i
] = entries
[j
].string
;
5187 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5194 /* Get the first chunk of overlay strings at IT's current buffer
5195 position, or at CHARPOS if that is > 0. Value is non-zero if at
5196 least one overlay string was found. */
5199 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5201 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5202 process. This fills IT->overlay_strings with strings, and sets
5203 IT->n_overlay_strings to the total number of strings to process.
5204 IT->pos.overlay_string_index has to be set temporarily to zero
5205 because load_overlay_strings needs this; it must be set to -1
5206 when no overlay strings are found because a zero value would
5207 indicate a position in the first overlay string. */
5208 it
->current
.overlay_string_index
= 0;
5209 load_overlay_strings (it
, charpos
);
5211 /* If we found overlay strings, set up IT to deliver display
5212 elements from the first one. Otherwise set up IT to deliver
5213 from current_buffer. */
5214 if (it
->n_overlay_strings
)
5216 /* Make sure we know settings in current_buffer, so that we can
5217 restore meaningful values when we're done with the overlay
5220 compute_stop_pos (it
);
5221 xassert (it
->face_id
>= 0);
5223 /* Save IT's settings. They are restored after all overlay
5224 strings have been processed. */
5225 xassert (!compute_stop_p
|| it
->sp
== 0);
5227 /* When called from handle_stop, there might be an empty display
5228 string loaded. In that case, don't bother saving it. */
5229 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5232 /* Set up IT to deliver display elements from the first overlay
5234 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5235 it
->string
= it
->overlay_strings
[0];
5236 it
->from_overlay
= Qnil
;
5237 it
->stop_charpos
= 0;
5238 xassert (STRINGP (it
->string
));
5239 it
->end_charpos
= SCHARS (it
->string
);
5241 it
->base_level_stop
= 0;
5242 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5243 it
->method
= GET_FROM_STRING
;
5244 it
->from_disp_prop_p
= 0;
5246 /* Force paragraph direction to be that of the parent
5248 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5249 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5251 it
->paragraph_embedding
= L2R
;
5253 /* Set up the bidi iterator for this overlay string. */
5256 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5258 it
->bidi_it
.string
.lstring
= it
->string
;
5259 it
->bidi_it
.string
.s
= NULL
;
5260 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5261 it
->bidi_it
.string
.bufpos
= pos
;
5262 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5263 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5264 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5269 it
->current
.overlay_string_index
= -1;
5274 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5277 it
->method
= GET_FROM_BUFFER
;
5279 (void) get_overlay_strings_1 (it
, charpos
, 1);
5283 /* Value is non-zero if we found at least one overlay string. */
5284 return STRINGP (it
->string
);
5289 /***********************************************************************
5290 Saving and restoring state
5291 ***********************************************************************/
5293 /* Save current settings of IT on IT->stack. Called, for example,
5294 before setting up IT for an overlay string, to be able to restore
5295 IT's settings to what they were after the overlay string has been
5296 processed. If POSITION is non-NULL, it is the position to save on
5297 the stack instead of IT->position. */
5300 push_it (struct it
*it
, struct text_pos
*position
)
5302 struct iterator_stack_entry
*p
;
5304 xassert (it
->sp
< IT_STACK_SIZE
);
5305 p
= it
->stack
+ it
->sp
;
5307 p
->stop_charpos
= it
->stop_charpos
;
5308 p
->prev_stop
= it
->prev_stop
;
5309 p
->base_level_stop
= it
->base_level_stop
;
5310 p
->cmp_it
= it
->cmp_it
;
5311 xassert (it
->face_id
>= 0);
5312 p
->face_id
= it
->face_id
;
5313 p
->string
= it
->string
;
5314 p
->method
= it
->method
;
5315 p
->from_overlay
= it
->from_overlay
;
5318 case GET_FROM_IMAGE
:
5319 p
->u
.image
.object
= it
->object
;
5320 p
->u
.image
.image_id
= it
->image_id
;
5321 p
->u
.image
.slice
= it
->slice
;
5323 case GET_FROM_STRETCH
:
5324 p
->u
.stretch
.object
= it
->object
;
5327 p
->position
= position
? *position
: it
->position
;
5328 p
->current
= it
->current
;
5329 p
->end_charpos
= it
->end_charpos
;
5330 p
->string_nchars
= it
->string_nchars
;
5332 p
->multibyte_p
= it
->multibyte_p
;
5333 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5334 p
->space_width
= it
->space_width
;
5335 p
->font_height
= it
->font_height
;
5336 p
->voffset
= it
->voffset
;
5337 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5338 p
->display_ellipsis_p
= 0;
5339 p
->line_wrap
= it
->line_wrap
;
5340 p
->bidi_p
= it
->bidi_p
;
5341 p
->paragraph_embedding
= it
->paragraph_embedding
;
5342 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5345 /* Save the state of the bidi iterator as well. */
5347 bidi_push_it (&it
->bidi_it
);
5351 iterate_out_of_display_property (struct it
*it
)
5353 int buffer_p
= BUFFERP (it
->object
);
5354 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5355 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5357 /* Maybe initialize paragraph direction. If we are at the beginning
5358 of a new paragraph, next_element_from_buffer may not have a
5359 chance to do that. */
5360 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5361 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5362 /* prev_stop can be zero, so check against BEGV as well. */
5363 while (it
->bidi_it
.charpos
>= bob
5364 && it
->prev_stop
<= it
->bidi_it
.charpos
5365 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5366 bidi_move_to_visually_next (&it
->bidi_it
);
5367 /* Record the stop_pos we just crossed, for when we cross it
5369 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5370 it
->prev_stop
= CHARPOS (it
->position
);
5371 /* If we ended up not where pop_it put us, resync IT's
5372 positional members with the bidi iterator. */
5373 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5375 SET_TEXT_POS (it
->position
,
5376 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5378 it
->current
.pos
= it
->position
;
5380 it
->current
.string_pos
= it
->position
;
5384 /* Restore IT's settings from IT->stack. Called, for example, when no
5385 more overlay strings must be processed, and we return to delivering
5386 display elements from a buffer, or when the end of a string from a
5387 `display' property is reached and we return to delivering display
5388 elements from an overlay string, or from a buffer. */
5391 pop_it (struct it
*it
)
5393 struct iterator_stack_entry
*p
;
5394 int from_display_prop
= it
->from_disp_prop_p
;
5396 xassert (it
->sp
> 0);
5398 p
= it
->stack
+ it
->sp
;
5399 it
->stop_charpos
= p
->stop_charpos
;
5400 it
->prev_stop
= p
->prev_stop
;
5401 it
->base_level_stop
= p
->base_level_stop
;
5402 it
->cmp_it
= p
->cmp_it
;
5403 it
->face_id
= p
->face_id
;
5404 it
->current
= p
->current
;
5405 it
->position
= p
->position
;
5406 it
->string
= p
->string
;
5407 it
->from_overlay
= p
->from_overlay
;
5408 if (NILP (it
->string
))
5409 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5410 it
->method
= p
->method
;
5413 case GET_FROM_IMAGE
:
5414 it
->image_id
= p
->u
.image
.image_id
;
5415 it
->object
= p
->u
.image
.object
;
5416 it
->slice
= p
->u
.image
.slice
;
5418 case GET_FROM_STRETCH
:
5419 it
->object
= p
->u
.stretch
.object
;
5421 case GET_FROM_BUFFER
:
5422 it
->object
= it
->w
->buffer
;
5424 case GET_FROM_STRING
:
5425 it
->object
= it
->string
;
5427 case GET_FROM_DISPLAY_VECTOR
:
5429 it
->method
= GET_FROM_C_STRING
;
5430 else if (STRINGP (it
->string
))
5431 it
->method
= GET_FROM_STRING
;
5434 it
->method
= GET_FROM_BUFFER
;
5435 it
->object
= it
->w
->buffer
;
5438 it
->end_charpos
= p
->end_charpos
;
5439 it
->string_nchars
= p
->string_nchars
;
5441 it
->multibyte_p
= p
->multibyte_p
;
5442 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5443 it
->space_width
= p
->space_width
;
5444 it
->font_height
= p
->font_height
;
5445 it
->voffset
= p
->voffset
;
5446 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5447 it
->line_wrap
= p
->line_wrap
;
5448 it
->bidi_p
= p
->bidi_p
;
5449 it
->paragraph_embedding
= p
->paragraph_embedding
;
5450 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5453 bidi_pop_it (&it
->bidi_it
);
5454 /* Bidi-iterate until we get out of the portion of text, if any,
5455 covered by a `display' text property or by an overlay with
5456 `display' property. (We cannot just jump there, because the
5457 internal coherency of the bidi iterator state can not be
5458 preserved across such jumps.) We also must determine the
5459 paragraph base direction if the overlay we just processed is
5460 at the beginning of a new paragraph. */
5461 if (from_display_prop
5462 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5463 iterate_out_of_display_property (it
);
5465 xassert ((BUFFERP (it
->object
)
5466 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5467 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5468 || (STRINGP (it
->object
)
5469 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5470 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5476 /***********************************************************************
5478 ***********************************************************************/
5480 /* Set IT's current position to the previous line start. */
5483 back_to_previous_line_start (struct it
*it
)
5485 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5486 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5490 /* Move IT to the next line start.
5492 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5493 we skipped over part of the text (as opposed to moving the iterator
5494 continuously over the text). Otherwise, don't change the value
5497 Newlines may come from buffer text, overlay strings, or strings
5498 displayed via the `display' property. That's the reason we can't
5499 simply use find_next_newline_no_quit.
5501 Note that this function may not skip over invisible text that is so
5502 because of text properties and immediately follows a newline. If
5503 it would, function reseat_at_next_visible_line_start, when called
5504 from set_iterator_to_next, would effectively make invisible
5505 characters following a newline part of the wrong glyph row, which
5506 leads to wrong cursor motion. */
5509 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5511 EMACS_INT old_selective
;
5512 int newline_found_p
, n
;
5513 const int MAX_NEWLINE_DISTANCE
= 500;
5515 /* If already on a newline, just consume it to avoid unintended
5516 skipping over invisible text below. */
5517 if (it
->what
== IT_CHARACTER
5519 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5521 set_iterator_to_next (it
, 0);
5526 /* Don't handle selective display in the following. It's (a)
5527 unnecessary because it's done by the caller, and (b) leads to an
5528 infinite recursion because next_element_from_ellipsis indirectly
5529 calls this function. */
5530 old_selective
= it
->selective
;
5533 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5534 from buffer text. */
5535 for (n
= newline_found_p
= 0;
5536 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5537 n
+= STRINGP (it
->string
) ? 0 : 1)
5539 if (!get_next_display_element (it
))
5541 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5542 set_iterator_to_next (it
, 0);
5545 /* If we didn't find a newline near enough, see if we can use a
5547 if (!newline_found_p
)
5549 EMACS_INT start
= IT_CHARPOS (*it
);
5550 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5553 xassert (!STRINGP (it
->string
));
5555 /* If we are not bidi-reordering, and there isn't any `display'
5556 property in sight, and no overlays, we can just use the
5557 position of the newline in buffer text. */
5559 && (it
->stop_charpos
>= limit
5560 || ((pos
= Fnext_single_property_change (make_number (start
),
5562 make_number (limit
)),
5564 && next_overlay_change (start
) == ZV
)))
5566 IT_CHARPOS (*it
) = limit
;
5567 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5568 *skipped_p
= newline_found_p
= 1;
5572 while (get_next_display_element (it
)
5573 && !newline_found_p
)
5575 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5576 set_iterator_to_next (it
, 0);
5581 it
->selective
= old_selective
;
5582 return newline_found_p
;
5586 /* Set IT's current position to the previous visible line start. Skip
5587 invisible text that is so either due to text properties or due to
5588 selective display. Caution: this does not change IT->current_x and
5592 back_to_previous_visible_line_start (struct it
*it
)
5594 while (IT_CHARPOS (*it
) > BEGV
)
5596 back_to_previous_line_start (it
);
5598 if (IT_CHARPOS (*it
) <= BEGV
)
5601 /* If selective > 0, then lines indented more than its value are
5603 if (it
->selective
> 0
5604 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5608 /* Check the newline before point for invisibility. */
5611 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5612 Qinvisible
, it
->window
);
5613 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5617 if (IT_CHARPOS (*it
) <= BEGV
)
5622 void *it2data
= NULL
;
5625 Lisp_Object val
, overlay
;
5627 SAVE_IT (it2
, *it
, it2data
);
5629 /* If newline is part of a composition, continue from start of composition */
5630 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5631 && beg
< IT_CHARPOS (*it
))
5634 /* If newline is replaced by a display property, find start of overlay
5635 or interval and continue search from that point. */
5636 pos
= --IT_CHARPOS (it2
);
5639 bidi_unshelve_cache (NULL
);
5640 it2
.string_from_display_prop_p
= 0;
5641 it2
.from_disp_prop_p
= 0;
5642 if (handle_display_prop (&it2
) == HANDLED_RETURN
5643 && !NILP (val
= get_char_property_and_overlay
5644 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5645 && (OVERLAYP (overlay
)
5646 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5647 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5649 RESTORE_IT (it
, it
, it2data
);
5653 /* Newline is not replaced by anything -- so we are done. */
5654 RESTORE_IT (it
, it
, it2data
);
5660 IT_CHARPOS (*it
) = beg
;
5661 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5665 it
->continuation_lines_width
= 0;
5667 xassert (IT_CHARPOS (*it
) >= BEGV
);
5668 xassert (IT_CHARPOS (*it
) == BEGV
5669 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5674 /* Reseat iterator IT at the previous visible line start. Skip
5675 invisible text that is so either due to text properties or due to
5676 selective display. At the end, update IT's overlay information,
5677 face information etc. */
5680 reseat_at_previous_visible_line_start (struct it
*it
)
5682 back_to_previous_visible_line_start (it
);
5683 reseat (it
, it
->current
.pos
, 1);
5688 /* Reseat iterator IT on the next visible line start in the current
5689 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5690 preceding the line start. Skip over invisible text that is so
5691 because of selective display. Compute faces, overlays etc at the
5692 new position. Note that this function does not skip over text that
5693 is invisible because of text properties. */
5696 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5698 int newline_found_p
, skipped_p
= 0;
5700 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5702 /* Skip over lines that are invisible because they are indented
5703 more than the value of IT->selective. */
5704 if (it
->selective
> 0)
5705 while (IT_CHARPOS (*it
) < ZV
5706 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5709 xassert (IT_BYTEPOS (*it
) == BEGV
5710 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5711 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5714 /* Position on the newline if that's what's requested. */
5715 if (on_newline_p
&& newline_found_p
)
5717 if (STRINGP (it
->string
))
5719 if (IT_STRING_CHARPOS (*it
) > 0)
5723 --IT_STRING_CHARPOS (*it
);
5724 --IT_STRING_BYTEPOS (*it
);
5727 /* Setting this flag will cause
5728 bidi_move_to_visually_next not to advance, but
5729 instead deliver the current character (newline),
5730 which is what the ON_NEWLINE_P flag wants. */
5731 it
->bidi_it
.first_elt
= 1;
5734 else if (IT_CHARPOS (*it
) > BEGV
)
5741 /* With bidi iteration, the call to `reseat' will cause
5742 bidi_move_to_visually_next deliver the current character,
5743 the newline, instead of advancing. */
5744 reseat (it
, it
->current
.pos
, 0);
5748 reseat (it
, it
->current
.pos
, 0);
5755 /***********************************************************************
5756 Changing an iterator's position
5757 ***********************************************************************/
5759 /* Change IT's current position to POS in current_buffer. If FORCE_P
5760 is non-zero, always check for text properties at the new position.
5761 Otherwise, text properties are only looked up if POS >=
5762 IT->check_charpos of a property. */
5765 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5767 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5769 reseat_1 (it
, pos
, 0);
5771 /* Determine where to check text properties. Avoid doing it
5772 where possible because text property lookup is very expensive. */
5774 || CHARPOS (pos
) > it
->stop_charpos
5775 || CHARPOS (pos
) < original_pos
)
5779 /* For bidi iteration, we need to prime prev_stop and
5780 base_level_stop with our best estimations. */
5781 /* Implementation note: Of course, POS is not necessarily a
5782 stop position, so assigning prev_pos to it is a lie; we
5783 should have called compute_stop_backwards. However, if
5784 the current buffer does not include any R2L characters,
5785 that call would be a waste of cycles, because the
5786 iterator will never move back, and thus never cross this
5787 "fake" stop position. So we delay that backward search
5788 until the time we really need it, in next_element_from_buffer. */
5789 if (CHARPOS (pos
) != it
->prev_stop
)
5790 it
->prev_stop
= CHARPOS (pos
);
5791 if (CHARPOS (pos
) < it
->base_level_stop
)
5792 it
->base_level_stop
= 0; /* meaning it's unknown */
5798 it
->prev_stop
= it
->base_level_stop
= 0;
5807 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5808 IT->stop_pos to POS, also. */
5811 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5813 /* Don't call this function when scanning a C string. */
5814 xassert (it
->s
== NULL
);
5816 /* POS must be a reasonable value. */
5817 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5819 it
->current
.pos
= it
->position
= pos
;
5820 it
->end_charpos
= ZV
;
5822 it
->current
.dpvec_index
= -1;
5823 it
->current
.overlay_string_index
= -1;
5824 IT_STRING_CHARPOS (*it
) = -1;
5825 IT_STRING_BYTEPOS (*it
) = -1;
5827 it
->method
= GET_FROM_BUFFER
;
5828 it
->object
= it
->w
->buffer
;
5829 it
->area
= TEXT_AREA
;
5830 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5832 it
->string_from_display_prop_p
= 0;
5833 it
->from_disp_prop_p
= 0;
5834 it
->face_before_selective_p
= 0;
5837 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5839 bidi_unshelve_cache (NULL
);
5840 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5841 it
->bidi_it
.string
.s
= NULL
;
5842 it
->bidi_it
.string
.lstring
= Qnil
;
5843 it
->bidi_it
.string
.bufpos
= 0;
5844 it
->bidi_it
.string
.unibyte
= 0;
5849 it
->stop_charpos
= CHARPOS (pos
);
5850 it
->base_level_stop
= CHARPOS (pos
);
5855 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5856 If S is non-null, it is a C string to iterate over. Otherwise,
5857 STRING gives a Lisp string to iterate over.
5859 If PRECISION > 0, don't return more then PRECISION number of
5860 characters from the string.
5862 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5863 characters have been returned. FIELD_WIDTH < 0 means an infinite
5866 MULTIBYTE = 0 means disable processing of multibyte characters,
5867 MULTIBYTE > 0 means enable it,
5868 MULTIBYTE < 0 means use IT->multibyte_p.
5870 IT must be initialized via a prior call to init_iterator before
5871 calling this function. */
5874 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5875 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5878 /* No region in strings. */
5879 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5881 /* No text property checks performed by default, but see below. */
5882 it
->stop_charpos
= -1;
5884 /* Set iterator position and end position. */
5885 memset (&it
->current
, 0, sizeof it
->current
);
5886 it
->current
.overlay_string_index
= -1;
5887 it
->current
.dpvec_index
= -1;
5888 xassert (charpos
>= 0);
5890 /* If STRING is specified, use its multibyteness, otherwise use the
5891 setting of MULTIBYTE, if specified. */
5893 it
->multibyte_p
= multibyte
> 0;
5895 /* Bidirectional reordering of strings is controlled by the default
5896 value of bidi-display-reordering. */
5897 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5901 xassert (STRINGP (string
));
5902 it
->string
= string
;
5904 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5905 it
->method
= GET_FROM_STRING
;
5906 it
->current
.string_pos
= string_pos (charpos
, string
);
5910 it
->bidi_it
.string
.lstring
= string
;
5911 it
->bidi_it
.string
.s
= NULL
;
5912 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5913 it
->bidi_it
.string
.bufpos
= 0;
5914 it
->bidi_it
.string
.from_disp_str
= 0;
5915 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5916 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5917 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5922 it
->s
= (const unsigned char *) s
;
5925 /* Note that we use IT->current.pos, not it->current.string_pos,
5926 for displaying C strings. */
5927 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5928 if (it
->multibyte_p
)
5930 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5931 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5935 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5936 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5941 it
->bidi_it
.string
.lstring
= Qnil
;
5942 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5943 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5944 it
->bidi_it
.string
.bufpos
= 0;
5945 it
->bidi_it
.string
.from_disp_str
= 0;
5946 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5947 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5950 it
->method
= GET_FROM_C_STRING
;
5953 /* PRECISION > 0 means don't return more than PRECISION characters
5955 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5957 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5959 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5962 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5963 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5964 FIELD_WIDTH < 0 means infinite field width. This is useful for
5965 padding with `-' at the end of a mode line. */
5966 if (field_width
< 0)
5967 field_width
= INFINITY
;
5968 /* Implementation note: We deliberately don't enlarge
5969 it->bidi_it.string.schars here to fit it->end_charpos, because
5970 the bidi iterator cannot produce characters out of thin air. */
5971 if (field_width
> it
->end_charpos
- charpos
)
5972 it
->end_charpos
= charpos
+ field_width
;
5974 /* Use the standard display table for displaying strings. */
5975 if (DISP_TABLE_P (Vstandard_display_table
))
5976 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5978 it
->stop_charpos
= charpos
;
5979 it
->prev_stop
= charpos
;
5980 it
->base_level_stop
= 0;
5983 it
->bidi_it
.first_elt
= 1;
5984 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5985 it
->bidi_it
.disp_pos
= -1;
5987 if (s
== NULL
&& it
->multibyte_p
)
5989 EMACS_INT endpos
= SCHARS (it
->string
);
5990 if (endpos
> it
->end_charpos
)
5991 endpos
= it
->end_charpos
;
5992 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6000 /***********************************************************************
6002 ***********************************************************************/
6004 /* Map enum it_method value to corresponding next_element_from_* function. */
6006 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6008 next_element_from_buffer
,
6009 next_element_from_display_vector
,
6010 next_element_from_string
,
6011 next_element_from_c_string
,
6012 next_element_from_image
,
6013 next_element_from_stretch
6016 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6019 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6020 (possibly with the following characters). */
6022 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6023 ((IT)->cmp_it.id >= 0 \
6024 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6025 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6026 END_CHARPOS, (IT)->w, \
6027 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6031 /* Lookup the char-table Vglyphless_char_display for character C (-1
6032 if we want information for no-font case), and return the display
6033 method symbol. By side-effect, update it->what and
6034 it->glyphless_method. This function is called from
6035 get_next_display_element for each character element, and from
6036 x_produce_glyphs when no suitable font was found. */
6039 lookup_glyphless_char_display (int c
, struct it
*it
)
6041 Lisp_Object glyphless_method
= Qnil
;
6043 if (CHAR_TABLE_P (Vglyphless_char_display
)
6044 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6048 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6049 if (CONSP (glyphless_method
))
6050 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6051 ? XCAR (glyphless_method
)
6052 : XCDR (glyphless_method
);
6055 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6059 if (NILP (glyphless_method
))
6062 /* The default is to display the character by a proper font. */
6064 /* The default for the no-font case is to display an empty box. */
6065 glyphless_method
= Qempty_box
;
6067 if (EQ (glyphless_method
, Qzero_width
))
6070 return glyphless_method
;
6071 /* This method can't be used for the no-font case. */
6072 glyphless_method
= Qempty_box
;
6074 if (EQ (glyphless_method
, Qthin_space
))
6075 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6076 else if (EQ (glyphless_method
, Qempty_box
))
6077 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6078 else if (EQ (glyphless_method
, Qhex_code
))
6079 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6080 else if (STRINGP (glyphless_method
))
6081 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6084 /* Invalid value. We use the default method. */
6085 glyphless_method
= Qnil
;
6088 it
->what
= IT_GLYPHLESS
;
6089 return glyphless_method
;
6092 /* Load IT's display element fields with information about the next
6093 display element from the current position of IT. Value is zero if
6094 end of buffer (or C string) is reached. */
6096 static struct frame
*last_escape_glyph_frame
= NULL
;
6097 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6098 static int last_escape_glyph_merged_face_id
= 0;
6100 struct frame
*last_glyphless_glyph_frame
= NULL
;
6101 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6102 int last_glyphless_glyph_merged_face_id
= 0;
6105 get_next_display_element (struct it
*it
)
6107 /* Non-zero means that we found a display element. Zero means that
6108 we hit the end of what we iterate over. Performance note: the
6109 function pointer `method' used here turns out to be faster than
6110 using a sequence of if-statements. */
6114 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6116 if (it
->what
== IT_CHARACTER
)
6118 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6119 and only if (a) the resolved directionality of that character
6121 /* FIXME: Do we need an exception for characters from display
6123 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6124 it
->c
= bidi_mirror_char (it
->c
);
6125 /* Map via display table or translate control characters.
6126 IT->c, IT->len etc. have been set to the next character by
6127 the function call above. If we have a display table, and it
6128 contains an entry for IT->c, translate it. Don't do this if
6129 IT->c itself comes from a display table, otherwise we could
6130 end up in an infinite recursion. (An alternative could be to
6131 count the recursion depth of this function and signal an
6132 error when a certain maximum depth is reached.) Is it worth
6134 if (success_p
&& it
->dpvec
== NULL
)
6137 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6138 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6139 nbsp_or_shy
= char_is_other
;
6140 int c
= it
->c
; /* This is the character to display. */
6142 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6144 xassert (SINGLE_BYTE_CHAR_P (c
));
6145 if (unibyte_display_via_language_environment
)
6147 c
= DECODE_CHAR (unibyte
, c
);
6149 c
= BYTE8_TO_CHAR (it
->c
);
6152 c
= BYTE8_TO_CHAR (it
->c
);
6156 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6159 struct Lisp_Vector
*v
= XVECTOR (dv
);
6161 /* Return the first character from the display table
6162 entry, if not empty. If empty, don't display the
6163 current character. */
6166 it
->dpvec_char_len
= it
->len
;
6167 it
->dpvec
= v
->contents
;
6168 it
->dpend
= v
->contents
+ v
->header
.size
;
6169 it
->current
.dpvec_index
= 0;
6170 it
->dpvec_face_id
= -1;
6171 it
->saved_face_id
= it
->face_id
;
6172 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6177 set_iterator_to_next (it
, 0);
6182 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6184 if (it
->what
== IT_GLYPHLESS
)
6186 /* Don't display this character. */
6187 set_iterator_to_next (it
, 0);
6191 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6192 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6193 : c
== 0xAD ? char_is_soft_hyphen
6196 /* Translate control characters into `\003' or `^C' form.
6197 Control characters coming from a display table entry are
6198 currently not translated because we use IT->dpvec to hold
6199 the translation. This could easily be changed but I
6200 don't believe that it is worth doing.
6202 NBSP and SOFT-HYPEN are property translated too.
6204 Non-printable characters and raw-byte characters are also
6205 translated to octal form. */
6206 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6207 ? (it
->area
!= TEXT_AREA
6208 /* In mode line, treat \n, \t like other crl chars. */
6211 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6212 || (c
!= '\n' && c
!= '\t'))
6215 || ! CHAR_PRINTABLE_P (c
))))
6217 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6218 or a non-printable character which must be displayed
6219 either as '\003' or as `^C' where the '\\' and '^'
6220 can be defined in the display table. Fill
6221 IT->ctl_chars with glyphs for what we have to
6222 display. Then, set IT->dpvec to these glyphs. */
6226 EMACS_INT lface_id
= 0;
6229 /* Handle control characters with ^. */
6231 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6235 g
= '^'; /* default glyph for Control */
6236 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6238 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6239 && GLYPH_CODE_CHAR_VALID_P (gc
))
6241 g
= GLYPH_CODE_CHAR (gc
);
6242 lface_id
= GLYPH_CODE_FACE (gc
);
6246 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6248 else if (it
->f
== last_escape_glyph_frame
6249 && it
->face_id
== last_escape_glyph_face_id
)
6251 face_id
= last_escape_glyph_merged_face_id
;
6255 /* Merge the escape-glyph face into the current face. */
6256 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6258 last_escape_glyph_frame
= it
->f
;
6259 last_escape_glyph_face_id
= it
->face_id
;
6260 last_escape_glyph_merged_face_id
= face_id
;
6263 XSETINT (it
->ctl_chars
[0], g
);
6264 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6266 goto display_control
;
6269 /* Handle non-break space in the mode where it only gets
6272 if (EQ (Vnobreak_char_display
, Qt
)
6273 && nbsp_or_shy
== char_is_nbsp
)
6275 /* Merge the no-break-space face into the current face. */
6276 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6280 XSETINT (it
->ctl_chars
[0], ' ');
6282 goto display_control
;
6285 /* Handle sequences that start with the "escape glyph". */
6287 /* the default escape glyph is \. */
6288 escape_glyph
= '\\';
6291 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6292 && GLYPH_CODE_CHAR_VALID_P (gc
))
6294 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6295 lface_id
= GLYPH_CODE_FACE (gc
);
6299 /* The display table specified a face.
6300 Merge it into face_id and also into escape_glyph. */
6301 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6304 else if (it
->f
== last_escape_glyph_frame
6305 && it
->face_id
== last_escape_glyph_face_id
)
6307 face_id
= last_escape_glyph_merged_face_id
;
6311 /* Merge the escape-glyph face into the current face. */
6312 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6314 last_escape_glyph_frame
= it
->f
;
6315 last_escape_glyph_face_id
= it
->face_id
;
6316 last_escape_glyph_merged_face_id
= face_id
;
6319 /* Handle soft hyphens in the mode where they only get
6322 if (EQ (Vnobreak_char_display
, Qt
)
6323 && nbsp_or_shy
== char_is_soft_hyphen
)
6325 XSETINT (it
->ctl_chars
[0], '-');
6327 goto display_control
;
6330 /* Handle non-break space and soft hyphen
6331 with the escape glyph. */
6335 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6336 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6337 XSETINT (it
->ctl_chars
[1], c
);
6339 goto display_control
;
6346 if (CHAR_BYTE8_P (c
))
6347 /* Display \200 instead of \17777600. */
6348 c
= CHAR_TO_BYTE8 (c
);
6349 len
= sprintf (str
, "%03o", c
);
6351 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6352 for (i
= 0; i
< len
; i
++)
6353 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6358 /* Set up IT->dpvec and return first character from it. */
6359 it
->dpvec_char_len
= it
->len
;
6360 it
->dpvec
= it
->ctl_chars
;
6361 it
->dpend
= it
->dpvec
+ ctl_len
;
6362 it
->current
.dpvec_index
= 0;
6363 it
->dpvec_face_id
= face_id
;
6364 it
->saved_face_id
= it
->face_id
;
6365 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6369 it
->char_to_display
= c
;
6373 it
->char_to_display
= it
->c
;
6377 /* Adjust face id for a multibyte character. There are no multibyte
6378 character in unibyte text. */
6379 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6382 && FRAME_WINDOW_P (it
->f
))
6384 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6386 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6388 /* Automatic composition with glyph-string. */
6389 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6391 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6395 EMACS_INT pos
= (it
->s
? -1
6396 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6397 : IT_CHARPOS (*it
));
6400 if (it
->what
== IT_CHARACTER
)
6401 c
= it
->char_to_display
;
6404 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6408 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6409 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6412 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6417 /* Is this character the last one of a run of characters with
6418 box? If yes, set IT->end_of_box_run_p to 1. */
6422 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6424 int face_id
= underlying_face_id (it
);
6425 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6429 if (face
->box
== FACE_NO_BOX
)
6431 /* If the box comes from face properties in a
6432 display string, check faces in that string. */
6433 int string_face_id
= face_after_it_pos (it
);
6434 it
->end_of_box_run_p
6435 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6438 /* Otherwise, the box comes from the underlying face.
6439 If this is the last string character displayed, check
6440 the next buffer location. */
6441 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6442 && (it
->current
.overlay_string_index
6443 == it
->n_overlay_strings
- 1))
6447 struct text_pos pos
= it
->current
.pos
;
6448 INC_TEXT_POS (pos
, it
->multibyte_p
);
6450 next_face_id
= face_at_buffer_position
6451 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6452 it
->region_end_charpos
, &ignore
,
6453 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6455 it
->end_of_box_run_p
6456 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6463 int face_id
= face_after_it_pos (it
);
6464 it
->end_of_box_run_p
6465 = (face_id
!= it
->face_id
6466 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6470 /* Value is 0 if end of buffer or string reached. */
6475 /* Move IT to the next display element.
6477 RESEAT_P non-zero means if called on a newline in buffer text,
6478 skip to the next visible line start.
6480 Functions get_next_display_element and set_iterator_to_next are
6481 separate because I find this arrangement easier to handle than a
6482 get_next_display_element function that also increments IT's
6483 position. The way it is we can first look at an iterator's current
6484 display element, decide whether it fits on a line, and if it does,
6485 increment the iterator position. The other way around we probably
6486 would either need a flag indicating whether the iterator has to be
6487 incremented the next time, or we would have to implement a
6488 decrement position function which would not be easy to write. */
6491 set_iterator_to_next (struct it
*it
, int reseat_p
)
6493 /* Reset flags indicating start and end of a sequence of characters
6494 with box. Reset them at the start of this function because
6495 moving the iterator to a new position might set them. */
6496 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6500 case GET_FROM_BUFFER
:
6501 /* The current display element of IT is a character from
6502 current_buffer. Advance in the buffer, and maybe skip over
6503 invisible lines that are so because of selective display. */
6504 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6505 reseat_at_next_visible_line_start (it
, 0);
6506 else if (it
->cmp_it
.id
>= 0)
6508 /* We are currently getting glyphs from a composition. */
6513 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6514 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6515 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6517 it
->cmp_it
.from
= it
->cmp_it
.to
;
6522 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6524 it
->end_charpos
, Qnil
);
6527 else if (! it
->cmp_it
.reversed_p
)
6529 /* Composition created while scanning forward. */
6530 /* Update IT's char/byte positions to point to the first
6531 character of the next grapheme cluster, or to the
6532 character visually after the current composition. */
6533 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6534 bidi_move_to_visually_next (&it
->bidi_it
);
6535 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6536 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6538 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6540 /* Proceed to the next grapheme cluster. */
6541 it
->cmp_it
.from
= it
->cmp_it
.to
;
6545 /* No more grapheme clusters in this composition.
6546 Find the next stop position. */
6547 EMACS_INT stop
= it
->end_charpos
;
6548 if (it
->bidi_it
.scan_dir
< 0)
6549 /* Now we are scanning backward and don't know
6552 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6553 IT_BYTEPOS (*it
), stop
, Qnil
);
6558 /* Composition created while scanning backward. */
6559 /* Update IT's char/byte positions to point to the last
6560 character of the previous grapheme cluster, or the
6561 character visually after the current composition. */
6562 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6563 bidi_move_to_visually_next (&it
->bidi_it
);
6564 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6565 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6566 if (it
->cmp_it
.from
> 0)
6568 /* Proceed to the previous grapheme cluster. */
6569 it
->cmp_it
.to
= it
->cmp_it
.from
;
6573 /* No more grapheme clusters in this composition.
6574 Find the next stop position. */
6575 EMACS_INT stop
= it
->end_charpos
;
6576 if (it
->bidi_it
.scan_dir
< 0)
6577 /* Now we are scanning backward and don't know
6580 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6581 IT_BYTEPOS (*it
), stop
, Qnil
);
6587 xassert (it
->len
!= 0);
6591 IT_BYTEPOS (*it
) += it
->len
;
6592 IT_CHARPOS (*it
) += 1;
6596 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6597 /* If this is a new paragraph, determine its base
6598 direction (a.k.a. its base embedding level). */
6599 if (it
->bidi_it
.new_paragraph
)
6600 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6601 bidi_move_to_visually_next (&it
->bidi_it
);
6602 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6603 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6604 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6606 /* As the scan direction was changed, we must
6607 re-compute the stop position for composition. */
6608 EMACS_INT stop
= it
->end_charpos
;
6609 if (it
->bidi_it
.scan_dir
< 0)
6611 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6612 IT_BYTEPOS (*it
), stop
, Qnil
);
6615 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6619 case GET_FROM_C_STRING
:
6620 /* Current display element of IT is from a C string. */
6622 /* If the string position is beyond string's end, it means
6623 next_element_from_c_string is padding the string with
6624 blanks, in which case we bypass the bidi iterator,
6625 because it cannot deal with such virtual characters. */
6626 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6628 IT_BYTEPOS (*it
) += it
->len
;
6629 IT_CHARPOS (*it
) += 1;
6633 bidi_move_to_visually_next (&it
->bidi_it
);
6634 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6635 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6639 case GET_FROM_DISPLAY_VECTOR
:
6640 /* Current display element of IT is from a display table entry.
6641 Advance in the display table definition. Reset it to null if
6642 end reached, and continue with characters from buffers/
6644 ++it
->current
.dpvec_index
;
6646 /* Restore face of the iterator to what they were before the
6647 display vector entry (these entries may contain faces). */
6648 it
->face_id
= it
->saved_face_id
;
6650 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6652 int recheck_faces
= it
->ellipsis_p
;
6655 it
->method
= GET_FROM_C_STRING
;
6656 else if (STRINGP (it
->string
))
6657 it
->method
= GET_FROM_STRING
;
6660 it
->method
= GET_FROM_BUFFER
;
6661 it
->object
= it
->w
->buffer
;
6665 it
->current
.dpvec_index
= -1;
6667 /* Skip over characters which were displayed via IT->dpvec. */
6668 if (it
->dpvec_char_len
< 0)
6669 reseat_at_next_visible_line_start (it
, 1);
6670 else if (it
->dpvec_char_len
> 0)
6672 if (it
->method
== GET_FROM_STRING
6673 && it
->n_overlay_strings
> 0)
6674 it
->ignore_overlay_strings_at_pos_p
= 1;
6675 it
->len
= it
->dpvec_char_len
;
6676 set_iterator_to_next (it
, reseat_p
);
6679 /* Maybe recheck faces after display vector */
6681 it
->stop_charpos
= IT_CHARPOS (*it
);
6685 case GET_FROM_STRING
:
6686 /* Current display element is a character from a Lisp string. */
6687 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6688 if (it
->cmp_it
.id
>= 0)
6694 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6695 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6696 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6697 it
->cmp_it
.from
= it
->cmp_it
.to
;
6701 composition_compute_stop_pos (&it
->cmp_it
,
6702 IT_STRING_CHARPOS (*it
),
6703 IT_STRING_BYTEPOS (*it
),
6704 it
->end_charpos
, it
->string
);
6707 else if (! it
->cmp_it
.reversed_p
)
6709 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6710 bidi_move_to_visually_next (&it
->bidi_it
);
6711 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6712 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6714 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6715 it
->cmp_it
.from
= it
->cmp_it
.to
;
6718 EMACS_INT stop
= it
->end_charpos
;
6719 if (it
->bidi_it
.scan_dir
< 0)
6721 composition_compute_stop_pos (&it
->cmp_it
,
6722 IT_STRING_CHARPOS (*it
),
6723 IT_STRING_BYTEPOS (*it
), stop
,
6729 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6730 bidi_move_to_visually_next (&it
->bidi_it
);
6731 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6732 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6733 if (it
->cmp_it
.from
> 0)
6734 it
->cmp_it
.to
= it
->cmp_it
.from
;
6737 EMACS_INT stop
= it
->end_charpos
;
6738 if (it
->bidi_it
.scan_dir
< 0)
6740 composition_compute_stop_pos (&it
->cmp_it
,
6741 IT_STRING_CHARPOS (*it
),
6742 IT_STRING_BYTEPOS (*it
), stop
,
6750 /* If the string position is beyond string's end, it
6751 means next_element_from_string is padding the string
6752 with blanks, in which case we bypass the bidi
6753 iterator, because it cannot deal with such virtual
6755 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6757 IT_STRING_BYTEPOS (*it
) += it
->len
;
6758 IT_STRING_CHARPOS (*it
) += 1;
6762 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6764 bidi_move_to_visually_next (&it
->bidi_it
);
6765 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6766 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6767 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6769 EMACS_INT stop
= it
->end_charpos
;
6771 if (it
->bidi_it
.scan_dir
< 0)
6773 composition_compute_stop_pos (&it
->cmp_it
,
6774 IT_STRING_CHARPOS (*it
),
6775 IT_STRING_BYTEPOS (*it
), stop
,
6781 consider_string_end
:
6783 if (it
->current
.overlay_string_index
>= 0)
6785 /* IT->string is an overlay string. Advance to the
6786 next, if there is one. */
6787 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6790 next_overlay_string (it
);
6792 setup_for_ellipsis (it
, 0);
6797 /* IT->string is not an overlay string. If we reached
6798 its end, and there is something on IT->stack, proceed
6799 with what is on the stack. This can be either another
6800 string, this time an overlay string, or a buffer. */
6801 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6805 if (it
->method
== GET_FROM_STRING
)
6806 goto consider_string_end
;
6811 case GET_FROM_IMAGE
:
6812 case GET_FROM_STRETCH
:
6813 /* The position etc with which we have to proceed are on
6814 the stack. The position may be at the end of a string,
6815 if the `display' property takes up the whole string. */
6816 xassert (it
->sp
> 0);
6818 if (it
->method
== GET_FROM_STRING
)
6819 goto consider_string_end
;
6823 /* There are no other methods defined, so this should be a bug. */
6827 xassert (it
->method
!= GET_FROM_STRING
6828 || (STRINGP (it
->string
)
6829 && IT_STRING_CHARPOS (*it
) >= 0));
6832 /* Load IT's display element fields with information about the next
6833 display element which comes from a display table entry or from the
6834 result of translating a control character to one of the forms `^C'
6837 IT->dpvec holds the glyphs to return as characters.
6838 IT->saved_face_id holds the face id before the display vector--it
6839 is restored into IT->face_id in set_iterator_to_next. */
6842 next_element_from_display_vector (struct it
*it
)
6847 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6849 it
->face_id
= it
->saved_face_id
;
6851 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6852 That seemed totally bogus - so I changed it... */
6853 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6855 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6857 it
->c
= GLYPH_CODE_CHAR (gc
);
6858 it
->len
= CHAR_BYTES (it
->c
);
6860 /* The entry may contain a face id to use. Such a face id is
6861 the id of a Lisp face, not a realized face. A face id of
6862 zero means no face is specified. */
6863 if (it
->dpvec_face_id
>= 0)
6864 it
->face_id
= it
->dpvec_face_id
;
6867 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6869 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6874 /* Display table entry is invalid. Return a space. */
6875 it
->c
= ' ', it
->len
= 1;
6877 /* Don't change position and object of the iterator here. They are
6878 still the values of the character that had this display table
6879 entry or was translated, and that's what we want. */
6880 it
->what
= IT_CHARACTER
;
6884 /* Get the first element of string/buffer in the visual order, after
6885 being reseated to a new position in a string or a buffer. */
6887 get_visually_first_element (struct it
*it
)
6889 int string_p
= STRINGP (it
->string
) || it
->s
;
6890 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6891 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6893 if (STRINGP (it
->string
))
6895 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6896 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6900 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6901 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6904 if (it
->bidi_it
.charpos
== eob
)
6906 /* Nothing to do, but reset the FIRST_ELT flag, like
6907 bidi_paragraph_init does, because we are not going to
6909 it
->bidi_it
.first_elt
= 0;
6911 else if (it
->bidi_it
.charpos
== bob
6913 /* FIXME: Should support all Unicode line separators. */
6914 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6915 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6917 /* If we are at the beginning of a line/string, we can produce
6918 the next element right away. */
6919 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6920 bidi_move_to_visually_next (&it
->bidi_it
);
6924 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6926 /* We need to prime the bidi iterator starting at the line's or
6927 string's beginning, before we will be able to produce the
6930 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6933 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6935 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6937 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6940 /* Now return to buffer/string position where we were asked
6941 to get the next display element, and produce that. */
6942 bidi_move_to_visually_next (&it
->bidi_it
);
6944 while (it
->bidi_it
.bytepos
!= orig_bytepos
6945 && it
->bidi_it
.charpos
< eob
);
6948 /* Adjust IT's position information to where we ended up. */
6949 if (STRINGP (it
->string
))
6951 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6952 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6956 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6957 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6960 if (STRINGP (it
->string
) || !it
->s
)
6962 EMACS_INT stop
, charpos
, bytepos
;
6964 if (STRINGP (it
->string
))
6967 stop
= SCHARS (it
->string
);
6968 if (stop
> it
->end_charpos
)
6969 stop
= it
->end_charpos
;
6970 charpos
= IT_STRING_CHARPOS (*it
);
6971 bytepos
= IT_STRING_BYTEPOS (*it
);
6975 stop
= it
->end_charpos
;
6976 charpos
= IT_CHARPOS (*it
);
6977 bytepos
= IT_BYTEPOS (*it
);
6979 if (it
->bidi_it
.scan_dir
< 0)
6981 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6986 /* Load IT with the next display element from Lisp string IT->string.
6987 IT->current.string_pos is the current position within the string.
6988 If IT->current.overlay_string_index >= 0, the Lisp string is an
6992 next_element_from_string (struct it
*it
)
6994 struct text_pos position
;
6996 xassert (STRINGP (it
->string
));
6997 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
6998 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6999 position
= it
->current
.string_pos
;
7001 /* With bidi reordering, the character to display might not be the
7002 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7003 that we were reseat()ed to a new string, whose paragraph
7004 direction is not known. */
7005 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7007 get_visually_first_element (it
);
7008 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7011 /* Time to check for invisible text? */
7012 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7014 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7017 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7018 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7020 /* With bidi non-linear iteration, we could find
7021 ourselves far beyond the last computed stop_charpos,
7022 with several other stop positions in between that we
7023 missed. Scan them all now, in buffer's logical
7024 order, until we find and handle the last stop_charpos
7025 that precedes our current position. */
7026 handle_stop_backwards (it
, it
->stop_charpos
);
7027 return GET_NEXT_DISPLAY_ELEMENT (it
);
7033 /* Take note of the stop position we just moved
7034 across, for when we will move back across it. */
7035 it
->prev_stop
= it
->stop_charpos
;
7036 /* If we are at base paragraph embedding level, take
7037 note of the last stop position seen at this
7039 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7040 it
->base_level_stop
= it
->stop_charpos
;
7044 /* Since a handler may have changed IT->method, we must
7046 return GET_NEXT_DISPLAY_ELEMENT (it
);
7050 /* If we are before prev_stop, we may have overstepped
7051 on our way backwards a stop_pos, and if so, we need
7052 to handle that stop_pos. */
7053 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7054 /* We can sometimes back up for reasons that have nothing
7055 to do with bidi reordering. E.g., compositions. The
7056 code below is only needed when we are above the base
7057 embedding level, so test for that explicitly. */
7058 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7060 /* If we lost track of base_level_stop, we have no better
7061 place for handle_stop_backwards to start from than string
7062 beginning. This happens, e.g., when we were reseated to
7063 the previous screenful of text by vertical-motion. */
7064 if (it
->base_level_stop
<= 0
7065 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7066 it
->base_level_stop
= 0;
7067 handle_stop_backwards (it
, it
->base_level_stop
);
7068 return GET_NEXT_DISPLAY_ELEMENT (it
);
7072 if (it
->current
.overlay_string_index
>= 0)
7074 /* Get the next character from an overlay string. In overlay
7075 strings, There is no field width or padding with spaces to
7077 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7082 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7083 IT_STRING_BYTEPOS (*it
),
7084 it
->bidi_it
.scan_dir
< 0
7086 : SCHARS (it
->string
))
7087 && next_element_from_composition (it
))
7091 else if (STRING_MULTIBYTE (it
->string
))
7093 const unsigned char *s
= (SDATA (it
->string
)
7094 + IT_STRING_BYTEPOS (*it
));
7095 it
->c
= string_char_and_length (s
, &it
->len
);
7099 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7105 /* Get the next character from a Lisp string that is not an
7106 overlay string. Such strings come from the mode line, for
7107 example. We may have to pad with spaces, or truncate the
7108 string. See also next_element_from_c_string. */
7109 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7114 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7116 /* Pad with spaces. */
7117 it
->c
= ' ', it
->len
= 1;
7118 CHARPOS (position
) = BYTEPOS (position
) = -1;
7120 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7121 IT_STRING_BYTEPOS (*it
),
7122 it
->bidi_it
.scan_dir
< 0
7124 : it
->string_nchars
)
7125 && next_element_from_composition (it
))
7129 else if (STRING_MULTIBYTE (it
->string
))
7131 const unsigned char *s
= (SDATA (it
->string
)
7132 + IT_STRING_BYTEPOS (*it
));
7133 it
->c
= string_char_and_length (s
, &it
->len
);
7137 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7142 /* Record what we have and where it came from. */
7143 it
->what
= IT_CHARACTER
;
7144 it
->object
= it
->string
;
7145 it
->position
= position
;
7150 /* Load IT with next display element from C string IT->s.
7151 IT->string_nchars is the maximum number of characters to return
7152 from the string. IT->end_charpos may be greater than
7153 IT->string_nchars when this function is called, in which case we
7154 may have to return padding spaces. Value is zero if end of string
7155 reached, including padding spaces. */
7158 next_element_from_c_string (struct it
*it
)
7163 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7164 it
->what
= IT_CHARACTER
;
7165 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7168 /* With bidi reordering, the character to display might not be the
7169 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7170 we were reseated to a new string, whose paragraph direction is
7172 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7173 get_visually_first_element (it
);
7175 /* IT's position can be greater than IT->string_nchars in case a
7176 field width or precision has been specified when the iterator was
7178 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7180 /* End of the game. */
7184 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7186 /* Pad with spaces. */
7187 it
->c
= ' ', it
->len
= 1;
7188 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7190 else if (it
->multibyte_p
)
7191 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7193 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7199 /* Set up IT to return characters from an ellipsis, if appropriate.
7200 The definition of the ellipsis glyphs may come from a display table
7201 entry. This function fills IT with the first glyph from the
7202 ellipsis if an ellipsis is to be displayed. */
7205 next_element_from_ellipsis (struct it
*it
)
7207 if (it
->selective_display_ellipsis_p
)
7208 setup_for_ellipsis (it
, it
->len
);
7211 /* The face at the current position may be different from the
7212 face we find after the invisible text. Remember what it
7213 was in IT->saved_face_id, and signal that it's there by
7214 setting face_before_selective_p. */
7215 it
->saved_face_id
= it
->face_id
;
7216 it
->method
= GET_FROM_BUFFER
;
7217 it
->object
= it
->w
->buffer
;
7218 reseat_at_next_visible_line_start (it
, 1);
7219 it
->face_before_selective_p
= 1;
7222 return GET_NEXT_DISPLAY_ELEMENT (it
);
7226 /* Deliver an image display element. The iterator IT is already
7227 filled with image information (done in handle_display_prop). Value
7232 next_element_from_image (struct it
*it
)
7234 it
->what
= IT_IMAGE
;
7235 it
->ignore_overlay_strings_at_pos_p
= 0;
7240 /* Fill iterator IT with next display element from a stretch glyph
7241 property. IT->object is the value of the text property. Value is
7245 next_element_from_stretch (struct it
*it
)
7247 it
->what
= IT_STRETCH
;
7251 /* Scan backwards from IT's current position until we find a stop
7252 position, or until BEGV. This is called when we find ourself
7253 before both the last known prev_stop and base_level_stop while
7254 reordering bidirectional text. */
7257 compute_stop_pos_backwards (struct it
*it
)
7259 const int SCAN_BACK_LIMIT
= 1000;
7260 struct text_pos pos
;
7261 struct display_pos save_current
= it
->current
;
7262 struct text_pos save_position
= it
->position
;
7263 EMACS_INT charpos
= IT_CHARPOS (*it
);
7264 EMACS_INT where_we_are
= charpos
;
7265 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7266 EMACS_INT save_end_pos
= it
->end_charpos
;
7268 xassert (NILP (it
->string
) && !it
->s
);
7269 xassert (it
->bidi_p
);
7273 it
->end_charpos
= min (charpos
+ 1, ZV
);
7274 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7275 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7276 reseat_1 (it
, pos
, 0);
7277 compute_stop_pos (it
);
7278 /* We must advance forward, right? */
7279 if (it
->stop_charpos
<= charpos
)
7282 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7284 if (it
->stop_charpos
<= where_we_are
)
7285 it
->prev_stop
= it
->stop_charpos
;
7287 it
->prev_stop
= BEGV
;
7289 it
->current
= save_current
;
7290 it
->position
= save_position
;
7291 it
->stop_charpos
= save_stop_pos
;
7292 it
->end_charpos
= save_end_pos
;
7295 /* Scan forward from CHARPOS in the current buffer/string, until we
7296 find a stop position > current IT's position. Then handle the stop
7297 position before that. This is called when we bump into a stop
7298 position while reordering bidirectional text. CHARPOS should be
7299 the last previously processed stop_pos (or BEGV/0, if none were
7300 processed yet) whose position is less that IT's current
7304 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7306 int bufp
= !STRINGP (it
->string
);
7307 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7308 struct display_pos save_current
= it
->current
;
7309 struct text_pos save_position
= it
->position
;
7310 struct text_pos pos1
;
7311 EMACS_INT next_stop
;
7313 /* Scan in strict logical order. */
7314 xassert (it
->bidi_p
);
7318 it
->prev_stop
= charpos
;
7321 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7322 reseat_1 (it
, pos1
, 0);
7325 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7326 compute_stop_pos (it
);
7327 /* We must advance forward, right? */
7328 if (it
->stop_charpos
<= it
->prev_stop
)
7330 charpos
= it
->stop_charpos
;
7332 while (charpos
<= where_we_are
);
7335 it
->current
= save_current
;
7336 it
->position
= save_position
;
7337 next_stop
= it
->stop_charpos
;
7338 it
->stop_charpos
= it
->prev_stop
;
7340 it
->stop_charpos
= next_stop
;
7343 /* Load IT with the next display element from current_buffer. Value
7344 is zero if end of buffer reached. IT->stop_charpos is the next
7345 position at which to stop and check for text properties or buffer
7349 next_element_from_buffer (struct it
*it
)
7353 xassert (IT_CHARPOS (*it
) >= BEGV
);
7354 xassert (NILP (it
->string
) && !it
->s
);
7355 xassert (!it
->bidi_p
7356 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7357 && it
->bidi_it
.string
.s
== NULL
));
7359 /* With bidi reordering, the character to display might not be the
7360 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7361 we were reseat()ed to a new buffer position, which is potentially
7362 a different paragraph. */
7363 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7365 get_visually_first_element (it
);
7366 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7369 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7371 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7373 int overlay_strings_follow_p
;
7375 /* End of the game, except when overlay strings follow that
7376 haven't been returned yet. */
7377 if (it
->overlay_strings_at_end_processed_p
)
7378 overlay_strings_follow_p
= 0;
7381 it
->overlay_strings_at_end_processed_p
= 1;
7382 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7385 if (overlay_strings_follow_p
)
7386 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7390 it
->position
= it
->current
.pos
;
7394 else if (!(!it
->bidi_p
7395 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7396 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7398 /* With bidi non-linear iteration, we could find ourselves
7399 far beyond the last computed stop_charpos, with several
7400 other stop positions in between that we missed. Scan
7401 them all now, in buffer's logical order, until we find
7402 and handle the last stop_charpos that precedes our
7403 current position. */
7404 handle_stop_backwards (it
, it
->stop_charpos
);
7405 return GET_NEXT_DISPLAY_ELEMENT (it
);
7411 /* Take note of the stop position we just moved across,
7412 for when we will move back across it. */
7413 it
->prev_stop
= it
->stop_charpos
;
7414 /* If we are at base paragraph embedding level, take
7415 note of the last stop position seen at this
7417 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7418 it
->base_level_stop
= it
->stop_charpos
;
7421 return GET_NEXT_DISPLAY_ELEMENT (it
);
7425 /* If we are before prev_stop, we may have overstepped on
7426 our way backwards a stop_pos, and if so, we need to
7427 handle that stop_pos. */
7428 && IT_CHARPOS (*it
) < it
->prev_stop
7429 /* We can sometimes back up for reasons that have nothing
7430 to do with bidi reordering. E.g., compositions. The
7431 code below is only needed when we are above the base
7432 embedding level, so test for that explicitly. */
7433 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7435 if (it
->base_level_stop
<= 0
7436 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7438 /* If we lost track of base_level_stop, we need to find
7439 prev_stop by looking backwards. This happens, e.g., when
7440 we were reseated to the previous screenful of text by
7442 it
->base_level_stop
= BEGV
;
7443 compute_stop_pos_backwards (it
);
7444 handle_stop_backwards (it
, it
->prev_stop
);
7447 handle_stop_backwards (it
, it
->base_level_stop
);
7448 return GET_NEXT_DISPLAY_ELEMENT (it
);
7452 /* No face changes, overlays etc. in sight, so just return a
7453 character from current_buffer. */
7457 /* Maybe run the redisplay end trigger hook. Performance note:
7458 This doesn't seem to cost measurable time. */
7459 if (it
->redisplay_end_trigger_charpos
7461 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7462 run_redisplay_end_trigger_hook (it
);
7464 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7465 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7467 && next_element_from_composition (it
))
7472 /* Get the next character, maybe multibyte. */
7473 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7474 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7475 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7477 it
->c
= *p
, it
->len
= 1;
7479 /* Record what we have and where it came from. */
7480 it
->what
= IT_CHARACTER
;
7481 it
->object
= it
->w
->buffer
;
7482 it
->position
= it
->current
.pos
;
7484 /* Normally we return the character found above, except when we
7485 really want to return an ellipsis for selective display. */
7490 /* A value of selective > 0 means hide lines indented more
7491 than that number of columns. */
7492 if (it
->selective
> 0
7493 && IT_CHARPOS (*it
) + 1 < ZV
7494 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7495 IT_BYTEPOS (*it
) + 1,
7498 success_p
= next_element_from_ellipsis (it
);
7499 it
->dpvec_char_len
= -1;
7502 else if (it
->c
== '\r' && it
->selective
== -1)
7504 /* A value of selective == -1 means that everything from the
7505 CR to the end of the line is invisible, with maybe an
7506 ellipsis displayed for it. */
7507 success_p
= next_element_from_ellipsis (it
);
7508 it
->dpvec_char_len
= -1;
7513 /* Value is zero if end of buffer reached. */
7514 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7519 /* Run the redisplay end trigger hook for IT. */
7522 run_redisplay_end_trigger_hook (struct it
*it
)
7524 Lisp_Object args
[3];
7526 /* IT->glyph_row should be non-null, i.e. we should be actually
7527 displaying something, or otherwise we should not run the hook. */
7528 xassert (it
->glyph_row
);
7530 /* Set up hook arguments. */
7531 args
[0] = Qredisplay_end_trigger_functions
;
7532 args
[1] = it
->window
;
7533 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7534 it
->redisplay_end_trigger_charpos
= 0;
7536 /* Since we are *trying* to run these functions, don't try to run
7537 them again, even if they get an error. */
7538 it
->w
->redisplay_end_trigger
= Qnil
;
7539 Frun_hook_with_args (3, args
);
7541 /* Notice if it changed the face of the character we are on. */
7542 handle_face_prop (it
);
7546 /* Deliver a composition display element. Unlike the other
7547 next_element_from_XXX, this function is not registered in the array
7548 get_next_element[]. It is called from next_element_from_buffer and
7549 next_element_from_string when necessary. */
7552 next_element_from_composition (struct it
*it
)
7554 it
->what
= IT_COMPOSITION
;
7555 it
->len
= it
->cmp_it
.nbytes
;
7556 if (STRINGP (it
->string
))
7560 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7561 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7564 it
->position
= it
->current
.string_pos
;
7565 it
->object
= it
->string
;
7566 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7567 IT_STRING_BYTEPOS (*it
), it
->string
);
7573 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7574 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7577 if (it
->bidi_it
.new_paragraph
)
7578 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7579 /* Resync the bidi iterator with IT's new position.
7580 FIXME: this doesn't support bidirectional text. */
7581 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7582 bidi_move_to_visually_next (&it
->bidi_it
);
7586 it
->position
= it
->current
.pos
;
7587 it
->object
= it
->w
->buffer
;
7588 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7589 IT_BYTEPOS (*it
), Qnil
);
7596 /***********************************************************************
7597 Moving an iterator without producing glyphs
7598 ***********************************************************************/
7600 /* Check if iterator is at a position corresponding to a valid buffer
7601 position after some move_it_ call. */
7603 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7604 ((it)->method == GET_FROM_STRING \
7605 ? IT_STRING_CHARPOS (*it) == 0 \
7609 /* Move iterator IT to a specified buffer or X position within one
7610 line on the display without producing glyphs.
7612 OP should be a bit mask including some or all of these bits:
7613 MOVE_TO_X: Stop upon reaching x-position TO_X.
7614 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7615 Regardless of OP's value, stop upon reaching the end of the display line.
7617 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7618 This means, in particular, that TO_X includes window's horizontal
7621 The return value has several possible values that
7622 say what condition caused the scan to stop:
7624 MOVE_POS_MATCH_OR_ZV
7625 - when TO_POS or ZV was reached.
7628 -when TO_X was reached before TO_POS or ZV were reached.
7631 - when we reached the end of the display area and the line must
7635 - when we reached the end of the display area and the line is
7639 - when we stopped at a line end, i.e. a newline or a CR and selective
7642 static enum move_it_result
7643 move_it_in_display_line_to (struct it
*it
,
7644 EMACS_INT to_charpos
, int to_x
,
7645 enum move_operation_enum op
)
7647 enum move_it_result result
= MOVE_UNDEFINED
;
7648 struct glyph_row
*saved_glyph_row
;
7649 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7650 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7651 void *ppos_data
= NULL
;
7653 enum it_method prev_method
= it
->method
;
7654 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7655 int saw_smaller_pos
= prev_pos
< to_charpos
;
7657 /* Don't produce glyphs in produce_glyphs. */
7658 saved_glyph_row
= it
->glyph_row
;
7659 it
->glyph_row
= NULL
;
7661 /* Use wrap_it to save a copy of IT wherever a word wrap could
7662 occur. Use atpos_it to save a copy of IT at the desired buffer
7663 position, if found, so that we can scan ahead and check if the
7664 word later overshoots the window edge. Use atx_it similarly, for
7670 /* Use ppos_it under bidi reordering to save a copy of IT for the
7671 position > CHARPOS that is the closest to CHARPOS. We restore
7672 that position in IT when we have scanned the entire display line
7673 without finding a match for CHARPOS and all the character
7674 positions are greater than CHARPOS. */
7677 SAVE_IT (ppos_it
, *it
, ppos_data
);
7678 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7679 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7680 SAVE_IT (ppos_it
, *it
, ppos_data
);
7683 #define BUFFER_POS_REACHED_P() \
7684 ((op & MOVE_TO_POS) != 0 \
7685 && BUFFERP (it->object) \
7686 && (IT_CHARPOS (*it) == to_charpos \
7687 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7688 && (it->method == GET_FROM_BUFFER \
7689 || (it->method == GET_FROM_DISPLAY_VECTOR \
7690 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7692 /* If there's a line-/wrap-prefix, handle it. */
7693 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7694 && it
->current_y
< it
->last_visible_y
)
7695 handle_line_prefix (it
);
7697 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7698 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7702 int x
, i
, ascent
= 0, descent
= 0;
7704 /* Utility macro to reset an iterator with x, ascent, and descent. */
7705 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7706 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7707 (IT)->max_descent = descent)
7709 /* Stop if we move beyond TO_CHARPOS (after an image or a
7710 display string or stretch glyph). */
7711 if ((op
& MOVE_TO_POS
) != 0
7712 && BUFFERP (it
->object
)
7713 && it
->method
== GET_FROM_BUFFER
7714 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7716 && (prev_method
== GET_FROM_IMAGE
7717 || prev_method
== GET_FROM_STRETCH
7718 || prev_method
== GET_FROM_STRING
)
7719 /* Passed TO_CHARPOS from left to right. */
7720 && ((prev_pos
< to_charpos
7721 && IT_CHARPOS (*it
) > to_charpos
)
7722 /* Passed TO_CHARPOS from right to left. */
7723 || (prev_pos
> to_charpos
7724 && IT_CHARPOS (*it
) < to_charpos
)))))
7726 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7728 result
= MOVE_POS_MATCH_OR_ZV
;
7731 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7732 /* If wrap_it is valid, the current position might be in a
7733 word that is wrapped. So, save the iterator in
7734 atpos_it and continue to see if wrapping happens. */
7735 SAVE_IT (atpos_it
, *it
, atpos_data
);
7738 /* Stop when ZV reached.
7739 We used to stop here when TO_CHARPOS reached as well, but that is
7740 too soon if this glyph does not fit on this line. So we handle it
7741 explicitly below. */
7742 if (!get_next_display_element (it
))
7744 result
= MOVE_POS_MATCH_OR_ZV
;
7748 if (it
->line_wrap
== TRUNCATE
)
7750 if (BUFFER_POS_REACHED_P ())
7752 result
= MOVE_POS_MATCH_OR_ZV
;
7758 if (it
->line_wrap
== WORD_WRAP
)
7760 if (IT_DISPLAYING_WHITESPACE (it
))
7764 /* We have reached a glyph that follows one or more
7765 whitespace characters. If the position is
7766 already found, we are done. */
7767 if (atpos_it
.sp
>= 0)
7769 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7770 result
= MOVE_POS_MATCH_OR_ZV
;
7775 RESTORE_IT (it
, &atx_it
, atx_data
);
7776 result
= MOVE_X_REACHED
;
7779 /* Otherwise, we can wrap here. */
7780 SAVE_IT (wrap_it
, *it
, wrap_data
);
7786 /* Remember the line height for the current line, in case
7787 the next element doesn't fit on the line. */
7788 ascent
= it
->max_ascent
;
7789 descent
= it
->max_descent
;
7791 /* The call to produce_glyphs will get the metrics of the
7792 display element IT is loaded with. Record the x-position
7793 before this display element, in case it doesn't fit on the
7797 PRODUCE_GLYPHS (it
);
7799 if (it
->area
!= TEXT_AREA
)
7801 prev_method
= it
->method
;
7802 if (it
->method
== GET_FROM_BUFFER
)
7803 prev_pos
= IT_CHARPOS (*it
);
7804 set_iterator_to_next (it
, 1);
7805 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7806 SET_TEXT_POS (this_line_min_pos
,
7807 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7809 && (op
& MOVE_TO_POS
)
7810 && IT_CHARPOS (*it
) > to_charpos
7811 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7812 SAVE_IT (ppos_it
, *it
, ppos_data
);
7816 /* The number of glyphs we get back in IT->nglyphs will normally
7817 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7818 character on a terminal frame, or (iii) a line end. For the
7819 second case, IT->nglyphs - 1 padding glyphs will be present.
7820 (On X frames, there is only one glyph produced for a
7821 composite character.)
7823 The behavior implemented below means, for continuation lines,
7824 that as many spaces of a TAB as fit on the current line are
7825 displayed there. For terminal frames, as many glyphs of a
7826 multi-glyph character are displayed in the current line, too.
7827 This is what the old redisplay code did, and we keep it that
7828 way. Under X, the whole shape of a complex character must
7829 fit on the line or it will be completely displayed in the
7832 Note that both for tabs and padding glyphs, all glyphs have
7836 /* More than one glyph or glyph doesn't fit on line. All
7837 glyphs have the same width. */
7838 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7840 int x_before_this_char
= x
;
7841 int hpos_before_this_char
= it
->hpos
;
7843 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7845 new_x
= x
+ single_glyph_width
;
7847 /* We want to leave anything reaching TO_X to the caller. */
7848 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7850 if (BUFFER_POS_REACHED_P ())
7852 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7853 goto buffer_pos_reached
;
7854 if (atpos_it
.sp
< 0)
7856 SAVE_IT (atpos_it
, *it
, atpos_data
);
7857 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7862 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7865 result
= MOVE_X_REACHED
;
7870 SAVE_IT (atx_it
, *it
, atx_data
);
7871 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7876 if (/* Lines are continued. */
7877 it
->line_wrap
!= TRUNCATE
7878 && (/* And glyph doesn't fit on the line. */
7879 new_x
> it
->last_visible_x
7880 /* Or it fits exactly and we're on a window
7882 || (new_x
== it
->last_visible_x
7883 && FRAME_WINDOW_P (it
->f
))))
7885 if (/* IT->hpos == 0 means the very first glyph
7886 doesn't fit on the line, e.g. a wide image. */
7888 || (new_x
== it
->last_visible_x
7889 && FRAME_WINDOW_P (it
->f
)))
7892 it
->current_x
= new_x
;
7894 /* The character's last glyph just barely fits
7896 if (i
== it
->nglyphs
- 1)
7898 /* If this is the destination position,
7899 return a position *before* it in this row,
7900 now that we know it fits in this row. */
7901 if (BUFFER_POS_REACHED_P ())
7903 if (it
->line_wrap
!= WORD_WRAP
7906 it
->hpos
= hpos_before_this_char
;
7907 it
->current_x
= x_before_this_char
;
7908 result
= MOVE_POS_MATCH_OR_ZV
;
7911 if (it
->line_wrap
== WORD_WRAP
7914 SAVE_IT (atpos_it
, *it
, atpos_data
);
7915 atpos_it
.current_x
= x_before_this_char
;
7916 atpos_it
.hpos
= hpos_before_this_char
;
7920 prev_method
= it
->method
;
7921 if (it
->method
== GET_FROM_BUFFER
)
7922 prev_pos
= IT_CHARPOS (*it
);
7923 set_iterator_to_next (it
, 1);
7924 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7925 SET_TEXT_POS (this_line_min_pos
,
7926 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7927 /* On graphical terminals, newlines may
7928 "overflow" into the fringe if
7929 overflow-newline-into-fringe is non-nil.
7930 On text-only terminals, newlines may
7931 overflow into the last glyph on the
7933 if (!FRAME_WINDOW_P (it
->f
)
7934 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7936 if (!get_next_display_element (it
))
7938 result
= MOVE_POS_MATCH_OR_ZV
;
7941 if (BUFFER_POS_REACHED_P ())
7943 if (ITERATOR_AT_END_OF_LINE_P (it
))
7944 result
= MOVE_POS_MATCH_OR_ZV
;
7946 result
= MOVE_LINE_CONTINUED
;
7949 if (ITERATOR_AT_END_OF_LINE_P (it
))
7951 result
= MOVE_NEWLINE_OR_CR
;
7958 IT_RESET_X_ASCENT_DESCENT (it
);
7960 if (wrap_it
.sp
>= 0)
7962 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7967 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7969 result
= MOVE_LINE_CONTINUED
;
7973 if (BUFFER_POS_REACHED_P ())
7975 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7976 goto buffer_pos_reached
;
7977 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7979 SAVE_IT (atpos_it
, *it
, atpos_data
);
7980 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7984 if (new_x
> it
->first_visible_x
)
7986 /* Glyph is visible. Increment number of glyphs that
7987 would be displayed. */
7992 if (result
!= MOVE_UNDEFINED
)
7995 else if (BUFFER_POS_REACHED_P ())
7998 IT_RESET_X_ASCENT_DESCENT (it
);
7999 result
= MOVE_POS_MATCH_OR_ZV
;
8002 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8004 /* Stop when TO_X specified and reached. This check is
8005 necessary here because of lines consisting of a line end,
8006 only. The line end will not produce any glyphs and we
8007 would never get MOVE_X_REACHED. */
8008 xassert (it
->nglyphs
== 0);
8009 result
= MOVE_X_REACHED
;
8013 /* Is this a line end? If yes, we're done. */
8014 if (ITERATOR_AT_END_OF_LINE_P (it
))
8016 /* If we are past TO_CHARPOS, but never saw any character
8017 positions smaller than TO_CHARPOS, return
8018 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8020 if ((op
& MOVE_TO_POS
) != 0
8022 && IT_CHARPOS (*it
) > to_charpos
)
8024 result
= MOVE_POS_MATCH_OR_ZV
;
8025 if (it
->bidi_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8026 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8029 result
= MOVE_NEWLINE_OR_CR
;
8033 prev_method
= it
->method
;
8034 if (it
->method
== GET_FROM_BUFFER
)
8035 prev_pos
= IT_CHARPOS (*it
);
8036 /* The current display element has been consumed. Advance
8038 set_iterator_to_next (it
, 1);
8039 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8040 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8041 if (IT_CHARPOS (*it
) < to_charpos
)
8042 saw_smaller_pos
= 1;
8044 && (op
& MOVE_TO_POS
)
8045 && IT_CHARPOS (*it
) >= to_charpos
8046 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8047 SAVE_IT (ppos_it
, *it
, ppos_data
);
8049 /* Stop if lines are truncated and IT's current x-position is
8050 past the right edge of the window now. */
8051 if (it
->line_wrap
== TRUNCATE
8052 && it
->current_x
>= it
->last_visible_x
)
8054 if (!FRAME_WINDOW_P (it
->f
)
8055 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8059 if ((at_eob_p
= !get_next_display_element (it
))
8060 || BUFFER_POS_REACHED_P ()
8061 /* If we are past TO_CHARPOS, but never saw any
8062 character positions smaller than TO_CHARPOS,
8063 return MOVE_POS_MATCH_OR_ZV, like the
8064 unidirectional display did. */
8065 || ((op
& MOVE_TO_POS
) != 0
8067 && IT_CHARPOS (*it
) > to_charpos
))
8069 result
= MOVE_POS_MATCH_OR_ZV
;
8070 if (it
->bidi_p
&& !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8071 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8074 if (ITERATOR_AT_END_OF_LINE_P (it
))
8076 result
= MOVE_NEWLINE_OR_CR
;
8080 else if ((op
& MOVE_TO_POS
) != 0
8082 && IT_CHARPOS (*it
) > to_charpos
)
8084 result
= MOVE_POS_MATCH_OR_ZV
;
8085 if (it
->bidi_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8086 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8089 result
= MOVE_LINE_TRUNCATED
;
8092 #undef IT_RESET_X_ASCENT_DESCENT
8095 #undef BUFFER_POS_REACHED_P
8097 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8098 restore the saved iterator. */
8099 if (atpos_it
.sp
>= 0)
8100 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8101 else if (atx_it
.sp
>= 0)
8102 RESTORE_IT (it
, &atx_it
, atx_data
);
8115 /* Restore the iterator settings altered at the beginning of this
8117 it
->glyph_row
= saved_glyph_row
;
8121 /* For external use. */
8123 move_it_in_display_line (struct it
*it
,
8124 EMACS_INT to_charpos
, int to_x
,
8125 enum move_operation_enum op
)
8127 if (it
->line_wrap
== WORD_WRAP
8128 && (op
& MOVE_TO_X
))
8131 void *save_data
= NULL
;
8134 SAVE_IT (save_it
, *it
, save_data
);
8135 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8136 /* When word-wrap is on, TO_X may lie past the end
8137 of a wrapped line. Then it->current is the
8138 character on the next line, so backtrack to the
8139 space before the wrap point. */
8140 if (skip
== MOVE_LINE_CONTINUED
)
8142 int prev_x
= max (it
->current_x
- 1, 0);
8143 RESTORE_IT (it
, &save_it
, save_data
);
8144 move_it_in_display_line_to
8145 (it
, -1, prev_x
, MOVE_TO_X
);
8151 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8155 /* Move IT forward until it satisfies one or more of the criteria in
8156 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8158 OP is a bit-mask that specifies where to stop, and in particular,
8159 which of those four position arguments makes a difference. See the
8160 description of enum move_operation_enum.
8162 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8163 screen line, this function will set IT to the next position that is
8164 displayed to the right of TO_CHARPOS on the screen. */
8167 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8169 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8170 int line_height
, line_start_x
= 0, reached
= 0;
8171 void *backup_data
= NULL
;
8175 if (op
& MOVE_TO_VPOS
)
8177 /* If no TO_CHARPOS and no TO_X specified, stop at the
8178 start of the line TO_VPOS. */
8179 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8181 if (it
->vpos
== to_vpos
)
8187 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8191 /* TO_VPOS >= 0 means stop at TO_X in the line at
8192 TO_VPOS, or at TO_POS, whichever comes first. */
8193 if (it
->vpos
== to_vpos
)
8199 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8201 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8206 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8208 /* We have reached TO_X but not in the line we want. */
8209 skip
= move_it_in_display_line_to (it
, to_charpos
,
8211 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8219 else if (op
& MOVE_TO_Y
)
8221 struct it it_backup
;
8223 if (it
->line_wrap
== WORD_WRAP
)
8224 SAVE_IT (it_backup
, *it
, backup_data
);
8226 /* TO_Y specified means stop at TO_X in the line containing
8227 TO_Y---or at TO_CHARPOS if this is reached first. The
8228 problem is that we can't really tell whether the line
8229 contains TO_Y before we have completely scanned it, and
8230 this may skip past TO_X. What we do is to first scan to
8233 If TO_X is not specified, use a TO_X of zero. The reason
8234 is to make the outcome of this function more predictable.
8235 If we didn't use TO_X == 0, we would stop at the end of
8236 the line which is probably not what a caller would expect
8238 skip
= move_it_in_display_line_to
8239 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8240 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8242 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8243 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8245 else if (skip
== MOVE_X_REACHED
)
8247 /* If TO_X was reached, we want to know whether TO_Y is
8248 in the line. We know this is the case if the already
8249 scanned glyphs make the line tall enough. Otherwise,
8250 we must check by scanning the rest of the line. */
8251 line_height
= it
->max_ascent
+ it
->max_descent
;
8252 if (to_y
>= it
->current_y
8253 && to_y
< it
->current_y
+ line_height
)
8258 SAVE_IT (it_backup
, *it
, backup_data
);
8259 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8260 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8262 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8263 line_height
= it
->max_ascent
+ it
->max_descent
;
8264 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8266 if (to_y
>= it
->current_y
8267 && to_y
< it
->current_y
+ line_height
)
8269 /* If TO_Y is in this line and TO_X was reached
8270 above, we scanned too far. We have to restore
8271 IT's settings to the ones before skipping. */
8272 RESTORE_IT (it
, &it_backup
, backup_data
);
8278 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8284 /* Check whether TO_Y is in this line. */
8285 line_height
= it
->max_ascent
+ it
->max_descent
;
8286 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8288 if (to_y
>= it
->current_y
8289 && to_y
< it
->current_y
+ line_height
)
8291 /* When word-wrap is on, TO_X may lie past the end
8292 of a wrapped line. Then it->current is the
8293 character on the next line, so backtrack to the
8294 space before the wrap point. */
8295 if (skip
== MOVE_LINE_CONTINUED
8296 && it
->line_wrap
== WORD_WRAP
)
8298 int prev_x
= max (it
->current_x
- 1, 0);
8299 RESTORE_IT (it
, &it_backup
, backup_data
);
8300 skip
= move_it_in_display_line_to
8301 (it
, -1, prev_x
, MOVE_TO_X
);
8310 else if (BUFFERP (it
->object
)
8311 && (it
->method
== GET_FROM_BUFFER
8312 || it
->method
== GET_FROM_STRETCH
)
8313 && IT_CHARPOS (*it
) >= to_charpos
)
8314 skip
= MOVE_POS_MATCH_OR_ZV
;
8316 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8320 case MOVE_POS_MATCH_OR_ZV
:
8324 case MOVE_NEWLINE_OR_CR
:
8325 set_iterator_to_next (it
, 1);
8326 it
->continuation_lines_width
= 0;
8329 case MOVE_LINE_TRUNCATED
:
8330 it
->continuation_lines_width
= 0;
8331 reseat_at_next_visible_line_start (it
, 0);
8332 if ((op
& MOVE_TO_POS
) != 0
8333 && IT_CHARPOS (*it
) > to_charpos
)
8340 case MOVE_LINE_CONTINUED
:
8341 /* For continued lines ending in a tab, some of the glyphs
8342 associated with the tab are displayed on the current
8343 line. Since it->current_x does not include these glyphs,
8344 we use it->last_visible_x instead. */
8347 it
->continuation_lines_width
+= it
->last_visible_x
;
8348 /* When moving by vpos, ensure that the iterator really
8349 advances to the next line (bug#847, bug#969). Fixme:
8350 do we need to do this in other circumstances? */
8351 if (it
->current_x
!= it
->last_visible_x
8352 && (op
& MOVE_TO_VPOS
)
8353 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8355 line_start_x
= it
->current_x
+ it
->pixel_width
8356 - it
->last_visible_x
;
8357 set_iterator_to_next (it
, 0);
8361 it
->continuation_lines_width
+= it
->current_x
;
8368 /* Reset/increment for the next run. */
8369 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8370 it
->current_x
= line_start_x
;
8373 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8375 last_height
= it
->max_ascent
+ it
->max_descent
;
8376 last_max_ascent
= it
->max_ascent
;
8377 it
->max_ascent
= it
->max_descent
= 0;
8382 /* On text terminals, we may stop at the end of a line in the middle
8383 of a multi-character glyph. If the glyph itself is continued,
8384 i.e. it is actually displayed on the next line, don't treat this
8385 stopping point as valid; move to the next line instead (unless
8386 that brings us offscreen). */
8387 if (!FRAME_WINDOW_P (it
->f
)
8389 && IT_CHARPOS (*it
) == to_charpos
8390 && it
->what
== IT_CHARACTER
8392 && it
->line_wrap
== WINDOW_WRAP
8393 && it
->current_x
== it
->last_visible_x
- 1
8396 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8398 it
->continuation_lines_width
+= it
->current_x
;
8399 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8400 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8402 last_height
= it
->max_ascent
+ it
->max_descent
;
8403 last_max_ascent
= it
->max_ascent
;
8407 xfree (backup_data
);
8409 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8413 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8415 If DY > 0, move IT backward at least that many pixels. DY = 0
8416 means move IT backward to the preceding line start or BEGV. This
8417 function may move over more than DY pixels if IT->current_y - DY
8418 ends up in the middle of a line; in this case IT->current_y will be
8419 set to the top of the line moved to. */
8422 move_it_vertically_backward (struct it
*it
, int dy
)
8426 void *it2data
= NULL
, *it3data
= NULL
;
8427 EMACS_INT start_pos
;
8432 start_pos
= IT_CHARPOS (*it
);
8434 /* Estimate how many newlines we must move back. */
8435 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8437 /* Set the iterator's position that many lines back. */
8438 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8439 back_to_previous_visible_line_start (it
);
8441 /* Reseat the iterator here. When moving backward, we don't want
8442 reseat to skip forward over invisible text, set up the iterator
8443 to deliver from overlay strings at the new position etc. So,
8444 use reseat_1 here. */
8445 reseat_1 (it
, it
->current
.pos
, 1);
8447 /* We are now surely at a line start. */
8448 it
->current_x
= it
->hpos
= 0;
8449 it
->continuation_lines_width
= 0;
8451 /* Move forward and see what y-distance we moved. First move to the
8452 start of the next line so that we get its height. We need this
8453 height to be able to tell whether we reached the specified
8455 SAVE_IT (it2
, *it
, it2data
);
8456 it2
.max_ascent
= it2
.max_descent
= 0;
8459 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8460 MOVE_TO_POS
| MOVE_TO_VPOS
);
8462 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8463 xassert (IT_CHARPOS (*it
) >= BEGV
);
8464 SAVE_IT (it3
, it2
, it3data
);
8466 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8467 xassert (IT_CHARPOS (*it
) >= BEGV
);
8468 /* H is the actual vertical distance from the position in *IT
8469 and the starting position. */
8470 h
= it2
.current_y
- it
->current_y
;
8471 /* NLINES is the distance in number of lines. */
8472 nlines
= it2
.vpos
- it
->vpos
;
8474 /* Correct IT's y and vpos position
8475 so that they are relative to the starting point. */
8481 /* DY == 0 means move to the start of the screen line. The
8482 value of nlines is > 0 if continuation lines were involved. */
8483 RESTORE_IT (it
, it
, it2data
);
8485 move_it_by_lines (it
, nlines
);
8490 /* The y-position we try to reach, relative to *IT.
8491 Note that H has been subtracted in front of the if-statement. */
8492 int target_y
= it
->current_y
+ h
- dy
;
8493 int y0
= it3
.current_y
;
8497 RESTORE_IT (&it3
, &it3
, it3data
);
8498 y1
= line_bottom_y (&it3
);
8499 line_height
= y1
- y0
;
8500 RESTORE_IT (it
, it
, it2data
);
8501 /* If we did not reach target_y, try to move further backward if
8502 we can. If we moved too far backward, try to move forward. */
8503 if (target_y
< it
->current_y
8504 /* This is heuristic. In a window that's 3 lines high, with
8505 a line height of 13 pixels each, recentering with point
8506 on the bottom line will try to move -39/2 = 19 pixels
8507 backward. Try to avoid moving into the first line. */
8508 && (it
->current_y
- target_y
8509 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8510 && IT_CHARPOS (*it
) > BEGV
)
8512 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8513 target_y
- it
->current_y
));
8514 dy
= it
->current_y
- target_y
;
8515 goto move_further_back
;
8517 else if (target_y
>= it
->current_y
+ line_height
8518 && IT_CHARPOS (*it
) < ZV
)
8520 /* Should move forward by at least one line, maybe more.
8522 Note: Calling move_it_by_lines can be expensive on
8523 terminal frames, where compute_motion is used (via
8524 vmotion) to do the job, when there are very long lines
8525 and truncate-lines is nil. That's the reason for
8526 treating terminal frames specially here. */
8528 if (!FRAME_WINDOW_P (it
->f
))
8529 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8534 move_it_by_lines (it
, 1);
8536 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8543 /* Move IT by a specified amount of pixel lines DY. DY negative means
8544 move backwards. DY = 0 means move to start of screen line. At the
8545 end, IT will be on the start of a screen line. */
8548 move_it_vertically (struct it
*it
, int dy
)
8551 move_it_vertically_backward (it
, -dy
);
8554 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8555 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8556 MOVE_TO_POS
| MOVE_TO_Y
);
8557 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8559 /* If buffer ends in ZV without a newline, move to the start of
8560 the line to satisfy the post-condition. */
8561 if (IT_CHARPOS (*it
) == ZV
8563 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8564 move_it_by_lines (it
, 0);
8569 /* Move iterator IT past the end of the text line it is in. */
8572 move_it_past_eol (struct it
*it
)
8574 enum move_it_result rc
;
8576 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8577 if (rc
== MOVE_NEWLINE_OR_CR
)
8578 set_iterator_to_next (it
, 0);
8582 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8583 negative means move up. DVPOS == 0 means move to the start of the
8586 Optimization idea: If we would know that IT->f doesn't use
8587 a face with proportional font, we could be faster for
8588 truncate-lines nil. */
8591 move_it_by_lines (struct it
*it
, int dvpos
)
8594 /* The commented-out optimization uses vmotion on terminals. This
8595 gives bad results, because elements like it->what, on which
8596 callers such as pos_visible_p rely, aren't updated. */
8597 /* struct position pos;
8598 if (!FRAME_WINDOW_P (it->f))
8600 struct text_pos textpos;
8602 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8603 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8604 reseat (it, textpos, 1);
8605 it->vpos += pos.vpos;
8606 it->current_y += pos.vpos;
8612 /* DVPOS == 0 means move to the start of the screen line. */
8613 move_it_vertically_backward (it
, 0);
8614 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8615 /* Let next call to line_bottom_y calculate real line height */
8620 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8621 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8622 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8627 void *it2data
= NULL
;
8628 EMACS_INT start_charpos
, i
;
8630 /* Start at the beginning of the screen line containing IT's
8631 position. This may actually move vertically backwards,
8632 in case of overlays, so adjust dvpos accordingly. */
8634 move_it_vertically_backward (it
, 0);
8637 /* Go back -DVPOS visible lines and reseat the iterator there. */
8638 start_charpos
= IT_CHARPOS (*it
);
8639 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8640 back_to_previous_visible_line_start (it
);
8641 reseat (it
, it
->current
.pos
, 1);
8643 /* Move further back if we end up in a string or an image. */
8644 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8646 /* First try to move to start of display line. */
8648 move_it_vertically_backward (it
, 0);
8650 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8652 /* If start of line is still in string or image,
8653 move further back. */
8654 back_to_previous_visible_line_start (it
);
8655 reseat (it
, it
->current
.pos
, 1);
8659 it
->current_x
= it
->hpos
= 0;
8661 /* Above call may have moved too far if continuation lines
8662 are involved. Scan forward and see if it did. */
8663 SAVE_IT (it2
, *it
, it2data
);
8664 it2
.vpos
= it2
.current_y
= 0;
8665 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8666 it
->vpos
-= it2
.vpos
;
8667 it
->current_y
-= it2
.current_y
;
8668 it
->current_x
= it
->hpos
= 0;
8670 /* If we moved too far back, move IT some lines forward. */
8671 if (it2
.vpos
> -dvpos
)
8673 int delta
= it2
.vpos
+ dvpos
;
8675 RESTORE_IT (&it2
, &it2
, it2data
);
8676 SAVE_IT (it2
, *it
, it2data
);
8677 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8678 /* Move back again if we got too far ahead. */
8679 if (IT_CHARPOS (*it
) >= start_charpos
)
8680 RESTORE_IT (it
, &it2
, it2data
);
8685 RESTORE_IT (it
, it
, it2data
);
8689 /* Return 1 if IT points into the middle of a display vector. */
8692 in_display_vector_p (struct it
*it
)
8694 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8695 && it
->current
.dpvec_index
> 0
8696 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8700 /***********************************************************************
8702 ***********************************************************************/
8705 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8709 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8711 Lisp_Object args
[3];
8712 Lisp_Object msg
, fmt
;
8715 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8718 /* Do nothing if called asynchronously. Inserting text into
8719 a buffer may call after-change-functions and alike and
8720 that would means running Lisp asynchronously. */
8721 if (handling_signal
)
8725 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8727 args
[0] = fmt
= build_string (format
);
8730 msg
= Fformat (3, args
);
8732 len
= SBYTES (msg
) + 1;
8733 SAFE_ALLOCA (buffer
, char *, len
);
8734 memcpy (buffer
, SDATA (msg
), len
);
8736 message_dolog (buffer
, len
- 1, 1, 0);
8743 /* Output a newline in the *Messages* buffer if "needs" one. */
8746 message_log_maybe_newline (void)
8748 if (message_log_need_newline
)
8749 message_dolog ("", 0, 1, 0);
8753 /* Add a string M of length NBYTES to the message log, optionally
8754 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8755 nonzero, means interpret the contents of M as multibyte. This
8756 function calls low-level routines in order to bypass text property
8757 hooks, etc. which might not be safe to run.
8759 This may GC (insert may run before/after change hooks),
8760 so the buffer M must NOT point to a Lisp string. */
8763 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8765 const unsigned char *msg
= (const unsigned char *) m
;
8767 if (!NILP (Vmemory_full
))
8770 if (!NILP (Vmessage_log_max
))
8772 struct buffer
*oldbuf
;
8773 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8774 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8775 EMACS_INT point_at_end
= 0;
8776 EMACS_INT zv_at_end
= 0;
8777 Lisp_Object old_deactivate_mark
, tem
;
8778 struct gcpro gcpro1
;
8780 old_deactivate_mark
= Vdeactivate_mark
;
8781 oldbuf
= current_buffer
;
8782 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8783 BVAR (current_buffer
, undo_list
) = Qt
;
8785 oldpoint
= message_dolog_marker1
;
8786 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8787 oldbegv
= message_dolog_marker2
;
8788 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8789 oldzv
= message_dolog_marker3
;
8790 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8791 GCPRO1 (old_deactivate_mark
);
8799 BEGV_BYTE
= BEG_BYTE
;
8802 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8804 /* Insert the string--maybe converting multibyte to single byte
8805 or vice versa, so that all the text fits the buffer. */
8807 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8813 /* Convert a multibyte string to single-byte
8814 for the *Message* buffer. */
8815 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8817 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8818 work
[0] = (ASCII_CHAR_P (c
)
8820 : multibyte_char_to_unibyte (c
));
8821 insert_1_both (work
, 1, 1, 1, 0, 0);
8824 else if (! multibyte
8825 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8829 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8830 /* Convert a single-byte string to multibyte
8831 for the *Message* buffer. */
8832 for (i
= 0; i
< nbytes
; i
++)
8835 MAKE_CHAR_MULTIBYTE (c
);
8836 char_bytes
= CHAR_STRING (c
, str
);
8837 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8841 insert_1 (m
, nbytes
, 1, 0, 0);
8845 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8847 insert_1 ("\n", 1, 1, 0, 0);
8849 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8851 this_bol_byte
= PT_BYTE
;
8853 /* See if this line duplicates the previous one.
8854 If so, combine duplicates. */
8857 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8859 prev_bol_byte
= PT_BYTE
;
8861 dups
= message_log_check_duplicate (prev_bol_byte
,
8865 del_range_both (prev_bol
, prev_bol_byte
,
8866 this_bol
, this_bol_byte
, 0);
8869 char dupstr
[sizeof " [ times]"
8870 + INT_STRLEN_BOUND (printmax_t
)];
8873 /* If you change this format, don't forget to also
8874 change message_log_check_duplicate. */
8875 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8876 duplen
= strlen (dupstr
);
8877 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8878 insert_1 (dupstr
, duplen
, 1, 0, 1);
8883 /* If we have more than the desired maximum number of lines
8884 in the *Messages* buffer now, delete the oldest ones.
8885 This is safe because we don't have undo in this buffer. */
8887 if (NATNUMP (Vmessage_log_max
))
8889 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8890 -XFASTINT (Vmessage_log_max
) - 1, 0);
8891 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8894 BEGV
= XMARKER (oldbegv
)->charpos
;
8895 BEGV_BYTE
= marker_byte_position (oldbegv
);
8904 ZV
= XMARKER (oldzv
)->charpos
;
8905 ZV_BYTE
= marker_byte_position (oldzv
);
8909 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8911 /* We can't do Fgoto_char (oldpoint) because it will run some
8913 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8914 XMARKER (oldpoint
)->bytepos
);
8917 unchain_marker (XMARKER (oldpoint
));
8918 unchain_marker (XMARKER (oldbegv
));
8919 unchain_marker (XMARKER (oldzv
));
8921 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8922 set_buffer_internal (oldbuf
);
8924 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8925 message_log_need_newline
= !nlflag
;
8926 Vdeactivate_mark
= old_deactivate_mark
;
8931 /* We are at the end of the buffer after just having inserted a newline.
8932 (Note: We depend on the fact we won't be crossing the gap.)
8933 Check to see if the most recent message looks a lot like the previous one.
8934 Return 0 if different, 1 if the new one should just replace it, or a
8935 value N > 1 if we should also append " [N times]". */
8938 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8941 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8943 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8944 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8946 for (i
= 0; i
< len
; i
++)
8948 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8956 if (*p1
++ == ' ' && *p1
++ == '[')
8959 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8960 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8967 /* Display an echo area message M with a specified length of NBYTES
8968 bytes. The string may include null characters. If M is 0, clear
8969 out any existing message, and let the mini-buffer text show
8972 This may GC, so the buffer M must NOT point to a Lisp string. */
8975 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8977 /* First flush out any partial line written with print. */
8978 message_log_maybe_newline ();
8980 message_dolog (m
, nbytes
, 1, multibyte
);
8981 message2_nolog (m
, nbytes
, multibyte
);
8985 /* The non-logging counterpart of message2. */
8988 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8990 struct frame
*sf
= SELECTED_FRAME ();
8991 message_enable_multibyte
= multibyte
;
8993 if (FRAME_INITIAL_P (sf
))
8995 if (noninteractive_need_newline
)
8996 putc ('\n', stderr
);
8997 noninteractive_need_newline
= 0;
8999 fwrite (m
, nbytes
, 1, stderr
);
9000 if (cursor_in_echo_area
== 0)
9001 fprintf (stderr
, "\n");
9004 /* A null message buffer means that the frame hasn't really been
9005 initialized yet. Error messages get reported properly by
9006 cmd_error, so this must be just an informative message; toss it. */
9007 else if (INTERACTIVE
9008 && sf
->glyphs_initialized_p
9009 && FRAME_MESSAGE_BUF (sf
))
9011 Lisp_Object mini_window
;
9014 /* Get the frame containing the mini-buffer
9015 that the selected frame is using. */
9016 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9017 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9019 FRAME_SAMPLE_VISIBILITY (f
);
9020 if (FRAME_VISIBLE_P (sf
)
9021 && ! FRAME_VISIBLE_P (f
))
9022 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9026 set_message (m
, Qnil
, nbytes
, multibyte
);
9027 if (minibuffer_auto_raise
)
9028 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9031 clear_message (1, 1);
9033 do_pending_window_change (0);
9034 echo_area_display (1);
9035 do_pending_window_change (0);
9036 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9037 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9042 /* Display an echo area message M with a specified length of NBYTES
9043 bytes. The string may include null characters. If M is not a
9044 string, clear out any existing message, and let the mini-buffer
9047 This function cancels echoing. */
9050 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9052 struct gcpro gcpro1
;
9055 clear_message (1,1);
9058 /* First flush out any partial line written with print. */
9059 message_log_maybe_newline ();
9065 SAFE_ALLOCA (buffer
, char *, nbytes
);
9066 memcpy (buffer
, SDATA (m
), nbytes
);
9067 message_dolog (buffer
, nbytes
, 1, multibyte
);
9070 message3_nolog (m
, nbytes
, multibyte
);
9076 /* The non-logging version of message3.
9077 This does not cancel echoing, because it is used for echoing.
9078 Perhaps we need to make a separate function for echoing
9079 and make this cancel echoing. */
9082 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9084 struct frame
*sf
= SELECTED_FRAME ();
9085 message_enable_multibyte
= multibyte
;
9087 if (FRAME_INITIAL_P (sf
))
9089 if (noninteractive_need_newline
)
9090 putc ('\n', stderr
);
9091 noninteractive_need_newline
= 0;
9093 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9094 if (cursor_in_echo_area
== 0)
9095 fprintf (stderr
, "\n");
9098 /* A null message buffer means that the frame hasn't really been
9099 initialized yet. Error messages get reported properly by
9100 cmd_error, so this must be just an informative message; toss it. */
9101 else if (INTERACTIVE
9102 && sf
->glyphs_initialized_p
9103 && FRAME_MESSAGE_BUF (sf
))
9105 Lisp_Object mini_window
;
9109 /* Get the frame containing the mini-buffer
9110 that the selected frame is using. */
9111 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9112 frame
= XWINDOW (mini_window
)->frame
;
9115 FRAME_SAMPLE_VISIBILITY (f
);
9116 if (FRAME_VISIBLE_P (sf
)
9117 && !FRAME_VISIBLE_P (f
))
9118 Fmake_frame_visible (frame
);
9120 if (STRINGP (m
) && SCHARS (m
) > 0)
9122 set_message (NULL
, m
, nbytes
, multibyte
);
9123 if (minibuffer_auto_raise
)
9124 Fraise_frame (frame
);
9125 /* Assume we are not echoing.
9126 (If we are, echo_now will override this.) */
9127 echo_message_buffer
= Qnil
;
9130 clear_message (1, 1);
9132 do_pending_window_change (0);
9133 echo_area_display (1);
9134 do_pending_window_change (0);
9135 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9136 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9141 /* Display a null-terminated echo area message M. If M is 0, clear
9142 out any existing message, and let the mini-buffer text show through.
9144 The buffer M must continue to exist until after the echo area gets
9145 cleared or some other message gets displayed there. Do not pass
9146 text that is stored in a Lisp string. Do not pass text in a buffer
9147 that was alloca'd. */
9150 message1 (const char *m
)
9152 message2 (m
, (m
? strlen (m
) : 0), 0);
9156 /* The non-logging counterpart of message1. */
9159 message1_nolog (const char *m
)
9161 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9164 /* Display a message M which contains a single %s
9165 which gets replaced with STRING. */
9168 message_with_string (const char *m
, Lisp_Object string
, int log
)
9170 CHECK_STRING (string
);
9176 if (noninteractive_need_newline
)
9177 putc ('\n', stderr
);
9178 noninteractive_need_newline
= 0;
9179 fprintf (stderr
, m
, SDATA (string
));
9180 if (!cursor_in_echo_area
)
9181 fprintf (stderr
, "\n");
9185 else if (INTERACTIVE
)
9187 /* The frame whose minibuffer we're going to display the message on.
9188 It may be larger than the selected frame, so we need
9189 to use its buffer, not the selected frame's buffer. */
9190 Lisp_Object mini_window
;
9191 struct frame
*f
, *sf
= SELECTED_FRAME ();
9193 /* Get the frame containing the minibuffer
9194 that the selected frame is using. */
9195 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9196 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9198 /* A null message buffer means that the frame hasn't really been
9199 initialized yet. Error messages get reported properly by
9200 cmd_error, so this must be just an informative message; toss it. */
9201 if (FRAME_MESSAGE_BUF (f
))
9203 Lisp_Object args
[2], msg
;
9204 struct gcpro gcpro1
, gcpro2
;
9206 args
[0] = build_string (m
);
9207 args
[1] = msg
= string
;
9208 GCPRO2 (args
[0], msg
);
9211 msg
= Fformat (2, args
);
9214 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9216 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9220 /* Print should start at the beginning of the message
9221 buffer next time. */
9222 message_buf_print
= 0;
9228 /* Dump an informative message to the minibuf. If M is 0, clear out
9229 any existing message, and let the mini-buffer text show through. */
9232 vmessage (const char *m
, va_list ap
)
9238 if (noninteractive_need_newline
)
9239 putc ('\n', stderr
);
9240 noninteractive_need_newline
= 0;
9241 vfprintf (stderr
, m
, ap
);
9242 if (cursor_in_echo_area
== 0)
9243 fprintf (stderr
, "\n");
9247 else if (INTERACTIVE
)
9249 /* The frame whose mini-buffer we're going to display the message
9250 on. It may be larger than the selected frame, so we need to
9251 use its buffer, not the selected frame's buffer. */
9252 Lisp_Object mini_window
;
9253 struct frame
*f
, *sf
= SELECTED_FRAME ();
9255 /* Get the frame containing the mini-buffer
9256 that the selected frame is using. */
9257 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9258 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9260 /* A null message buffer means that the frame hasn't really been
9261 initialized yet. Error messages get reported properly by
9262 cmd_error, so this must be just an informative message; toss
9264 if (FRAME_MESSAGE_BUF (f
))
9270 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9271 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9273 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9278 /* Print should start at the beginning of the message
9279 buffer next time. */
9280 message_buf_print
= 0;
9286 message (const char *m
, ...)
9296 /* The non-logging version of message. */
9299 message_nolog (const char *m
, ...)
9301 Lisp_Object old_log_max
;
9304 old_log_max
= Vmessage_log_max
;
9305 Vmessage_log_max
= Qnil
;
9307 Vmessage_log_max
= old_log_max
;
9313 /* Display the current message in the current mini-buffer. This is
9314 only called from error handlers in process.c, and is not time
9318 update_echo_area (void)
9320 if (!NILP (echo_area_buffer
[0]))
9323 string
= Fcurrent_message ();
9324 message3 (string
, SBYTES (string
),
9325 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9330 /* Make sure echo area buffers in `echo_buffers' are live.
9331 If they aren't, make new ones. */
9334 ensure_echo_area_buffers (void)
9338 for (i
= 0; i
< 2; ++i
)
9339 if (!BUFFERP (echo_buffer
[i
])
9340 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9343 Lisp_Object old_buffer
;
9346 old_buffer
= echo_buffer
[i
];
9347 sprintf (name
, " *Echo Area %d*", i
);
9348 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9349 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9350 /* to force word wrap in echo area -
9351 it was decided to postpone this*/
9352 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9354 for (j
= 0; j
< 2; ++j
)
9355 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9356 echo_area_buffer
[j
] = echo_buffer
[i
];
9361 /* Call FN with args A1..A4 with either the current or last displayed
9362 echo_area_buffer as current buffer.
9364 WHICH zero means use the current message buffer
9365 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9366 from echo_buffer[] and clear it.
9368 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9369 suitable buffer from echo_buffer[] and clear it.
9371 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9372 that the current message becomes the last displayed one, make
9373 choose a suitable buffer for echo_area_buffer[0], and clear it.
9375 Value is what FN returns. */
9378 with_echo_area_buffer (struct window
*w
, int which
,
9379 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9380 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9383 int this_one
, the_other
, clear_buffer_p
, rc
;
9384 int count
= SPECPDL_INDEX ();
9386 /* If buffers aren't live, make new ones. */
9387 ensure_echo_area_buffers ();
9392 this_one
= 0, the_other
= 1;
9394 this_one
= 1, the_other
= 0;
9397 this_one
= 0, the_other
= 1;
9400 /* We need a fresh one in case the current echo buffer equals
9401 the one containing the last displayed echo area message. */
9402 if (!NILP (echo_area_buffer
[this_one
])
9403 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9404 echo_area_buffer
[this_one
] = Qnil
;
9407 /* Choose a suitable buffer from echo_buffer[] is we don't
9409 if (NILP (echo_area_buffer
[this_one
]))
9411 echo_area_buffer
[this_one
]
9412 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9413 ? echo_buffer
[the_other
]
9414 : echo_buffer
[this_one
]);
9418 buffer
= echo_area_buffer
[this_one
];
9420 /* Don't get confused by reusing the buffer used for echoing
9421 for a different purpose. */
9422 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9425 record_unwind_protect (unwind_with_echo_area_buffer
,
9426 with_echo_area_buffer_unwind_data (w
));
9428 /* Make the echo area buffer current. Note that for display
9429 purposes, it is not necessary that the displayed window's buffer
9430 == current_buffer, except for text property lookup. So, let's
9431 only set that buffer temporarily here without doing a full
9432 Fset_window_buffer. We must also change w->pointm, though,
9433 because otherwise an assertions in unshow_buffer fails, and Emacs
9435 set_buffer_internal_1 (XBUFFER (buffer
));
9439 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9442 BVAR (current_buffer
, undo_list
) = Qt
;
9443 BVAR (current_buffer
, read_only
) = Qnil
;
9444 specbind (Qinhibit_read_only
, Qt
);
9445 specbind (Qinhibit_modification_hooks
, Qt
);
9447 if (clear_buffer_p
&& Z
> BEG
)
9450 xassert (BEGV
>= BEG
);
9451 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9453 rc
= fn (a1
, a2
, a3
, a4
);
9455 xassert (BEGV
>= BEG
);
9456 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9458 unbind_to (count
, Qnil
);
9463 /* Save state that should be preserved around the call to the function
9464 FN called in with_echo_area_buffer. */
9467 with_echo_area_buffer_unwind_data (struct window
*w
)
9470 Lisp_Object vector
, tmp
;
9472 /* Reduce consing by keeping one vector in
9473 Vwith_echo_area_save_vector. */
9474 vector
= Vwith_echo_area_save_vector
;
9475 Vwith_echo_area_save_vector
= Qnil
;
9478 vector
= Fmake_vector (make_number (7), Qnil
);
9480 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9481 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9482 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9486 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9487 ASET (vector
, i
, w
->buffer
); ++i
;
9488 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9489 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9494 for (; i
< end
; ++i
)
9495 ASET (vector
, i
, Qnil
);
9498 xassert (i
== ASIZE (vector
));
9503 /* Restore global state from VECTOR which was created by
9504 with_echo_area_buffer_unwind_data. */
9507 unwind_with_echo_area_buffer (Lisp_Object vector
)
9509 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9510 Vdeactivate_mark
= AREF (vector
, 1);
9511 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9513 if (WINDOWP (AREF (vector
, 3)))
9516 Lisp_Object buffer
, charpos
, bytepos
;
9518 w
= XWINDOW (AREF (vector
, 3));
9519 buffer
= AREF (vector
, 4);
9520 charpos
= AREF (vector
, 5);
9521 bytepos
= AREF (vector
, 6);
9524 set_marker_both (w
->pointm
, buffer
,
9525 XFASTINT (charpos
), XFASTINT (bytepos
));
9528 Vwith_echo_area_save_vector
= vector
;
9533 /* Set up the echo area for use by print functions. MULTIBYTE_P
9534 non-zero means we will print multibyte. */
9537 setup_echo_area_for_printing (int multibyte_p
)
9539 /* If we can't find an echo area any more, exit. */
9540 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9543 ensure_echo_area_buffers ();
9545 if (!message_buf_print
)
9547 /* A message has been output since the last time we printed.
9548 Choose a fresh echo area buffer. */
9549 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9550 echo_area_buffer
[0] = echo_buffer
[1];
9552 echo_area_buffer
[0] = echo_buffer
[0];
9554 /* Switch to that buffer and clear it. */
9555 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9556 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9560 int count
= SPECPDL_INDEX ();
9561 specbind (Qinhibit_read_only
, Qt
);
9562 /* Note that undo recording is always disabled. */
9564 unbind_to (count
, Qnil
);
9566 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9568 /* Set up the buffer for the multibyteness we need. */
9570 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9571 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9573 /* Raise the frame containing the echo area. */
9574 if (minibuffer_auto_raise
)
9576 struct frame
*sf
= SELECTED_FRAME ();
9577 Lisp_Object mini_window
;
9578 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9579 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9582 message_log_maybe_newline ();
9583 message_buf_print
= 1;
9587 if (NILP (echo_area_buffer
[0]))
9589 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9590 echo_area_buffer
[0] = echo_buffer
[1];
9592 echo_area_buffer
[0] = echo_buffer
[0];
9595 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9597 /* Someone switched buffers between print requests. */
9598 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9599 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9605 /* Display an echo area message in window W. Value is non-zero if W's
9606 height is changed. If display_last_displayed_message_p is
9607 non-zero, display the message that was last displayed, otherwise
9608 display the current message. */
9611 display_echo_area (struct window
*w
)
9613 int i
, no_message_p
, window_height_changed_p
, count
;
9615 /* Temporarily disable garbage collections while displaying the echo
9616 area. This is done because a GC can print a message itself.
9617 That message would modify the echo area buffer's contents while a
9618 redisplay of the buffer is going on, and seriously confuse
9620 count
= inhibit_garbage_collection ();
9622 /* If there is no message, we must call display_echo_area_1
9623 nevertheless because it resizes the window. But we will have to
9624 reset the echo_area_buffer in question to nil at the end because
9625 with_echo_area_buffer will sets it to an empty buffer. */
9626 i
= display_last_displayed_message_p
? 1 : 0;
9627 no_message_p
= NILP (echo_area_buffer
[i
]);
9629 window_height_changed_p
9630 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9631 display_echo_area_1
,
9632 (intptr_t) w
, Qnil
, 0, 0);
9635 echo_area_buffer
[i
] = Qnil
;
9637 unbind_to (count
, Qnil
);
9638 return window_height_changed_p
;
9642 /* Helper for display_echo_area. Display the current buffer which
9643 contains the current echo area message in window W, a mini-window,
9644 a pointer to which is passed in A1. A2..A4 are currently not used.
9645 Change the height of W so that all of the message is displayed.
9646 Value is non-zero if height of W was changed. */
9649 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9652 struct window
*w
= (struct window
*) i1
;
9654 struct text_pos start
;
9655 int window_height_changed_p
= 0;
9657 /* Do this before displaying, so that we have a large enough glyph
9658 matrix for the display. If we can't get enough space for the
9659 whole text, display the last N lines. That works by setting w->start. */
9660 window_height_changed_p
= resize_mini_window (w
, 0);
9662 /* Use the starting position chosen by resize_mini_window. */
9663 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9666 clear_glyph_matrix (w
->desired_matrix
);
9667 XSETWINDOW (window
, w
);
9668 try_window (window
, start
, 0);
9670 return window_height_changed_p
;
9674 /* Resize the echo area window to exactly the size needed for the
9675 currently displayed message, if there is one. If a mini-buffer
9676 is active, don't shrink it. */
9679 resize_echo_area_exactly (void)
9681 if (BUFFERP (echo_area_buffer
[0])
9682 && WINDOWP (echo_area_window
))
9684 struct window
*w
= XWINDOW (echo_area_window
);
9686 Lisp_Object resize_exactly
;
9688 if (minibuf_level
== 0)
9689 resize_exactly
= Qt
;
9691 resize_exactly
= Qnil
;
9693 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9694 (intptr_t) w
, resize_exactly
,
9698 ++windows_or_buffers_changed
;
9699 ++update_mode_lines
;
9700 redisplay_internal ();
9706 /* Callback function for with_echo_area_buffer, when used from
9707 resize_echo_area_exactly. A1 contains a pointer to the window to
9708 resize, EXACTLY non-nil means resize the mini-window exactly to the
9709 size of the text displayed. A3 and A4 are not used. Value is what
9710 resize_mini_window returns. */
9713 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9716 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9720 /* Resize mini-window W to fit the size of its contents. EXACT_P
9721 means size the window exactly to the size needed. Otherwise, it's
9722 only enlarged until W's buffer is empty.
9724 Set W->start to the right place to begin display. If the whole
9725 contents fit, start at the beginning. Otherwise, start so as
9726 to make the end of the contents appear. This is particularly
9727 important for y-or-n-p, but seems desirable generally.
9729 Value is non-zero if the window height has been changed. */
9732 resize_mini_window (struct window
*w
, int exact_p
)
9734 struct frame
*f
= XFRAME (w
->frame
);
9735 int window_height_changed_p
= 0;
9737 xassert (MINI_WINDOW_P (w
));
9739 /* By default, start display at the beginning. */
9740 set_marker_both (w
->start
, w
->buffer
,
9741 BUF_BEGV (XBUFFER (w
->buffer
)),
9742 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9744 /* Don't resize windows while redisplaying a window; it would
9745 confuse redisplay functions when the size of the window they are
9746 displaying changes from under them. Such a resizing can happen,
9747 for instance, when which-func prints a long message while
9748 we are running fontification-functions. We're running these
9749 functions with safe_call which binds inhibit-redisplay to t. */
9750 if (!NILP (Vinhibit_redisplay
))
9753 /* Nil means don't try to resize. */
9754 if (NILP (Vresize_mini_windows
)
9755 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9758 if (!FRAME_MINIBUF_ONLY_P (f
))
9761 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9762 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9763 int height
, max_height
;
9764 int unit
= FRAME_LINE_HEIGHT (f
);
9765 struct text_pos start
;
9766 struct buffer
*old_current_buffer
= NULL
;
9768 if (current_buffer
!= XBUFFER (w
->buffer
))
9770 old_current_buffer
= current_buffer
;
9771 set_buffer_internal (XBUFFER (w
->buffer
));
9774 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9776 /* Compute the max. number of lines specified by the user. */
9777 if (FLOATP (Vmax_mini_window_height
))
9778 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9779 else if (INTEGERP (Vmax_mini_window_height
))
9780 max_height
= XINT (Vmax_mini_window_height
);
9782 max_height
= total_height
/ 4;
9784 /* Correct that max. height if it's bogus. */
9785 max_height
= max (1, max_height
);
9786 max_height
= min (total_height
, max_height
);
9788 /* Find out the height of the text in the window. */
9789 if (it
.line_wrap
== TRUNCATE
)
9794 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9795 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9796 height
= it
.current_y
+ last_height
;
9798 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9799 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9800 height
= (height
+ unit
- 1) / unit
;
9803 /* Compute a suitable window start. */
9804 if (height
> max_height
)
9806 height
= max_height
;
9807 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9808 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9809 start
= it
.current
.pos
;
9812 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9813 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9815 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9817 /* Let it grow only, until we display an empty message, in which
9818 case the window shrinks again. */
9819 if (height
> WINDOW_TOTAL_LINES (w
))
9821 int old_height
= WINDOW_TOTAL_LINES (w
);
9822 freeze_window_starts (f
, 1);
9823 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9824 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9826 else if (height
< WINDOW_TOTAL_LINES (w
)
9827 && (exact_p
|| BEGV
== ZV
))
9829 int old_height
= WINDOW_TOTAL_LINES (w
);
9830 freeze_window_starts (f
, 0);
9831 shrink_mini_window (w
);
9832 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9837 /* Always resize to exact size needed. */
9838 if (height
> WINDOW_TOTAL_LINES (w
))
9840 int old_height
= WINDOW_TOTAL_LINES (w
);
9841 freeze_window_starts (f
, 1);
9842 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9843 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9845 else if (height
< WINDOW_TOTAL_LINES (w
))
9847 int old_height
= WINDOW_TOTAL_LINES (w
);
9848 freeze_window_starts (f
, 0);
9849 shrink_mini_window (w
);
9853 freeze_window_starts (f
, 1);
9854 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9857 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9861 if (old_current_buffer
)
9862 set_buffer_internal (old_current_buffer
);
9865 return window_height_changed_p
;
9869 /* Value is the current message, a string, or nil if there is no
9873 current_message (void)
9877 if (!BUFFERP (echo_area_buffer
[0]))
9881 with_echo_area_buffer (0, 0, current_message_1
,
9882 (intptr_t) &msg
, Qnil
, 0, 0);
9884 echo_area_buffer
[0] = Qnil
;
9892 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9895 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9898 *msg
= make_buffer_string (BEG
, Z
, 1);
9905 /* Push the current message on Vmessage_stack for later restauration
9906 by restore_message. Value is non-zero if the current message isn't
9907 empty. This is a relatively infrequent operation, so it's not
9908 worth optimizing. */
9914 msg
= current_message ();
9915 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9916 return STRINGP (msg
);
9920 /* Restore message display from the top of Vmessage_stack. */
9923 restore_message (void)
9927 xassert (CONSP (Vmessage_stack
));
9928 msg
= XCAR (Vmessage_stack
);
9930 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9932 message3_nolog (msg
, 0, 0);
9936 /* Handler for record_unwind_protect calling pop_message. */
9939 pop_message_unwind (Lisp_Object dummy
)
9945 /* Pop the top-most entry off Vmessage_stack. */
9950 xassert (CONSP (Vmessage_stack
));
9951 Vmessage_stack
= XCDR (Vmessage_stack
);
9955 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9956 exits. If the stack is not empty, we have a missing pop_message
9960 check_message_stack (void)
9962 if (!NILP (Vmessage_stack
))
9967 /* Truncate to NCHARS what will be displayed in the echo area the next
9968 time we display it---but don't redisplay it now. */
9971 truncate_echo_area (EMACS_INT nchars
)
9974 echo_area_buffer
[0] = Qnil
;
9975 /* A null message buffer means that the frame hasn't really been
9976 initialized yet. Error messages get reported properly by
9977 cmd_error, so this must be just an informative message; toss it. */
9978 else if (!noninteractive
9980 && !NILP (echo_area_buffer
[0]))
9982 struct frame
*sf
= SELECTED_FRAME ();
9983 if (FRAME_MESSAGE_BUF (sf
))
9984 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9989 /* Helper function for truncate_echo_area. Truncate the current
9990 message to at most NCHARS characters. */
9993 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9995 if (BEG
+ nchars
< Z
)
9996 del_range (BEG
+ nchars
, Z
);
9998 echo_area_buffer
[0] = Qnil
;
10003 /* Set the current message to a substring of S or STRING.
10005 If STRING is a Lisp string, set the message to the first NBYTES
10006 bytes from STRING. NBYTES zero means use the whole string. If
10007 STRING is multibyte, the message will be displayed multibyte.
10009 If S is not null, set the message to the first LEN bytes of S. LEN
10010 zero means use the whole string. MULTIBYTE_P non-zero means S is
10011 multibyte. Display the message multibyte in that case.
10013 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10014 to t before calling set_message_1 (which calls insert).
10018 set_message (const char *s
, Lisp_Object string
,
10019 EMACS_INT nbytes
, int multibyte_p
)
10021 message_enable_multibyte
10022 = ((s
&& multibyte_p
)
10023 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10025 with_echo_area_buffer (0, -1, set_message_1
,
10026 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10027 message_buf_print
= 0;
10028 help_echo_showing_p
= 0;
10032 /* Helper function for set_message. Arguments have the same meaning
10033 as there, with A1 corresponding to S and A2 corresponding to STRING
10034 This function is called with the echo area buffer being
10038 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10041 const char *s
= (const char *) i1
;
10042 const unsigned char *msg
= (const unsigned char *) s
;
10043 Lisp_Object string
= a2
;
10045 /* Change multibyteness of the echo buffer appropriately. */
10046 if (message_enable_multibyte
10047 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10048 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10050 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10051 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10052 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10054 /* Insert new message at BEG. */
10055 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10057 if (STRINGP (string
))
10062 nbytes
= SBYTES (string
);
10063 nchars
= string_byte_to_char (string
, nbytes
);
10065 /* This function takes care of single/multibyte conversion. We
10066 just have to ensure that the echo area buffer has the right
10067 setting of enable_multibyte_characters. */
10068 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10073 nbytes
= strlen (s
);
10075 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10077 /* Convert from multi-byte to single-byte. */
10082 /* Convert a multibyte string to single-byte. */
10083 for (i
= 0; i
< nbytes
; i
+= n
)
10085 c
= string_char_and_length (msg
+ i
, &n
);
10086 work
[0] = (ASCII_CHAR_P (c
)
10088 : multibyte_char_to_unibyte (c
));
10089 insert_1_both (work
, 1, 1, 1, 0, 0);
10092 else if (!multibyte_p
10093 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10095 /* Convert from single-byte to multi-byte. */
10098 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10100 /* Convert a single-byte string to multibyte. */
10101 for (i
= 0; i
< nbytes
; i
++)
10104 MAKE_CHAR_MULTIBYTE (c
);
10105 n
= CHAR_STRING (c
, str
);
10106 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10110 insert_1 (s
, nbytes
, 1, 0, 0);
10117 /* Clear messages. CURRENT_P non-zero means clear the current
10118 message. LAST_DISPLAYED_P non-zero means clear the message
10122 clear_message (int current_p
, int last_displayed_p
)
10126 echo_area_buffer
[0] = Qnil
;
10127 message_cleared_p
= 1;
10130 if (last_displayed_p
)
10131 echo_area_buffer
[1] = Qnil
;
10133 message_buf_print
= 0;
10136 /* Clear garbaged frames.
10138 This function is used where the old redisplay called
10139 redraw_garbaged_frames which in turn called redraw_frame which in
10140 turn called clear_frame. The call to clear_frame was a source of
10141 flickering. I believe a clear_frame is not necessary. It should
10142 suffice in the new redisplay to invalidate all current matrices,
10143 and ensure a complete redisplay of all windows. */
10146 clear_garbaged_frames (void)
10148 if (frame_garbaged
)
10150 Lisp_Object tail
, frame
;
10151 int changed_count
= 0;
10153 FOR_EACH_FRAME (tail
, frame
)
10155 struct frame
*f
= XFRAME (frame
);
10157 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10161 Fredraw_frame (frame
);
10162 f
->force_flush_display_p
= 1;
10164 clear_current_matrices (f
);
10171 frame_garbaged
= 0;
10173 ++windows_or_buffers_changed
;
10178 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10179 is non-zero update selected_frame. Value is non-zero if the
10180 mini-windows height has been changed. */
10183 echo_area_display (int update_frame_p
)
10185 Lisp_Object mini_window
;
10188 int window_height_changed_p
= 0;
10189 struct frame
*sf
= SELECTED_FRAME ();
10191 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10192 w
= XWINDOW (mini_window
);
10193 f
= XFRAME (WINDOW_FRAME (w
));
10195 /* Don't display if frame is invisible or not yet initialized. */
10196 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10199 #ifdef HAVE_WINDOW_SYSTEM
10200 /* When Emacs starts, selected_frame may be the initial terminal
10201 frame. If we let this through, a message would be displayed on
10203 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10205 #endif /* HAVE_WINDOW_SYSTEM */
10207 /* Redraw garbaged frames. */
10208 if (frame_garbaged
)
10209 clear_garbaged_frames ();
10211 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10213 echo_area_window
= mini_window
;
10214 window_height_changed_p
= display_echo_area (w
);
10215 w
->must_be_updated_p
= 1;
10217 /* Update the display, unless called from redisplay_internal.
10218 Also don't update the screen during redisplay itself. The
10219 update will happen at the end of redisplay, and an update
10220 here could cause confusion. */
10221 if (update_frame_p
&& !redisplaying_p
)
10225 /* If the display update has been interrupted by pending
10226 input, update mode lines in the frame. Due to the
10227 pending input, it might have been that redisplay hasn't
10228 been called, so that mode lines above the echo area are
10229 garbaged. This looks odd, so we prevent it here. */
10230 if (!display_completed
)
10231 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10233 if (window_height_changed_p
10234 /* Don't do this if Emacs is shutting down. Redisplay
10235 needs to run hooks. */
10236 && !NILP (Vrun_hooks
))
10238 /* Must update other windows. Likewise as in other
10239 cases, don't let this update be interrupted by
10241 int count
= SPECPDL_INDEX ();
10242 specbind (Qredisplay_dont_pause
, Qt
);
10243 windows_or_buffers_changed
= 1;
10244 redisplay_internal ();
10245 unbind_to (count
, Qnil
);
10247 else if (FRAME_WINDOW_P (f
) && n
== 0)
10249 /* Window configuration is the same as before.
10250 Can do with a display update of the echo area,
10251 unless we displayed some mode lines. */
10252 update_single_window (w
, 1);
10253 FRAME_RIF (f
)->flush_display (f
);
10256 update_frame (f
, 1, 1);
10258 /* If cursor is in the echo area, make sure that the next
10259 redisplay displays the minibuffer, so that the cursor will
10260 be replaced with what the minibuffer wants. */
10261 if (cursor_in_echo_area
)
10262 ++windows_or_buffers_changed
;
10265 else if (!EQ (mini_window
, selected_window
))
10266 windows_or_buffers_changed
++;
10268 /* Last displayed message is now the current message. */
10269 echo_area_buffer
[1] = echo_area_buffer
[0];
10270 /* Inform read_char that we're not echoing. */
10271 echo_message_buffer
= Qnil
;
10273 /* Prevent redisplay optimization in redisplay_internal by resetting
10274 this_line_start_pos. This is done because the mini-buffer now
10275 displays the message instead of its buffer text. */
10276 if (EQ (mini_window
, selected_window
))
10277 CHARPOS (this_line_start_pos
) = 0;
10279 return window_height_changed_p
;
10284 /***********************************************************************
10285 Mode Lines and Frame Titles
10286 ***********************************************************************/
10288 /* A buffer for constructing non-propertized mode-line strings and
10289 frame titles in it; allocated from the heap in init_xdisp and
10290 resized as needed in store_mode_line_noprop_char. */
10292 static char *mode_line_noprop_buf
;
10294 /* The buffer's end, and a current output position in it. */
10296 static char *mode_line_noprop_buf_end
;
10297 static char *mode_line_noprop_ptr
;
10299 #define MODE_LINE_NOPROP_LEN(start) \
10300 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10303 MODE_LINE_DISPLAY
= 0,
10307 } mode_line_target
;
10309 /* Alist that caches the results of :propertize.
10310 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10311 static Lisp_Object mode_line_proptrans_alist
;
10313 /* List of strings making up the mode-line. */
10314 static Lisp_Object mode_line_string_list
;
10316 /* Base face property when building propertized mode line string. */
10317 static Lisp_Object mode_line_string_face
;
10318 static Lisp_Object mode_line_string_face_prop
;
10321 /* Unwind data for mode line strings */
10323 static Lisp_Object Vmode_line_unwind_vector
;
10326 format_mode_line_unwind_data (struct buffer
*obuf
,
10328 int save_proptrans
)
10330 Lisp_Object vector
, tmp
;
10332 /* Reduce consing by keeping one vector in
10333 Vwith_echo_area_save_vector. */
10334 vector
= Vmode_line_unwind_vector
;
10335 Vmode_line_unwind_vector
= Qnil
;
10338 vector
= Fmake_vector (make_number (8), Qnil
);
10340 ASET (vector
, 0, make_number (mode_line_target
));
10341 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10342 ASET (vector
, 2, mode_line_string_list
);
10343 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10344 ASET (vector
, 4, mode_line_string_face
);
10345 ASET (vector
, 5, mode_line_string_face_prop
);
10348 XSETBUFFER (tmp
, obuf
);
10351 ASET (vector
, 6, tmp
);
10352 ASET (vector
, 7, owin
);
10358 unwind_format_mode_line (Lisp_Object vector
)
10360 mode_line_target
= XINT (AREF (vector
, 0));
10361 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10362 mode_line_string_list
= AREF (vector
, 2);
10363 if (! EQ (AREF (vector
, 3), Qt
))
10364 mode_line_proptrans_alist
= AREF (vector
, 3);
10365 mode_line_string_face
= AREF (vector
, 4);
10366 mode_line_string_face_prop
= AREF (vector
, 5);
10368 if (!NILP (AREF (vector
, 7)))
10369 /* Select window before buffer, since it may change the buffer. */
10370 Fselect_window (AREF (vector
, 7), Qt
);
10372 if (!NILP (AREF (vector
, 6)))
10374 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10375 ASET (vector
, 6, Qnil
);
10378 Vmode_line_unwind_vector
= vector
;
10383 /* Store a single character C for the frame title in mode_line_noprop_buf.
10384 Re-allocate mode_line_noprop_buf if necessary. */
10387 store_mode_line_noprop_char (char c
)
10389 /* If output position has reached the end of the allocated buffer,
10390 double the buffer's size. */
10391 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10393 int len
= MODE_LINE_NOPROP_LEN (0);
10394 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
10395 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
10396 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
10397 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10400 *mode_line_noprop_ptr
++ = c
;
10404 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10405 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10406 characters that yield more columns than PRECISION; PRECISION <= 0
10407 means copy the whole string. Pad with spaces until FIELD_WIDTH
10408 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10409 pad. Called from display_mode_element when it is used to build a
10413 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10415 const unsigned char *str
= (const unsigned char *) string
;
10417 EMACS_INT dummy
, nbytes
;
10419 /* Copy at most PRECISION chars from STR. */
10420 nbytes
= strlen (string
);
10421 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10423 store_mode_line_noprop_char (*str
++);
10425 /* Fill up with spaces until FIELD_WIDTH reached. */
10426 while (field_width
> 0
10427 && n
< field_width
)
10429 store_mode_line_noprop_char (' ');
10436 /***********************************************************************
10438 ***********************************************************************/
10440 #ifdef HAVE_WINDOW_SYSTEM
10442 /* Set the title of FRAME, if it has changed. The title format is
10443 Vicon_title_format if FRAME is iconified, otherwise it is
10444 frame_title_format. */
10447 x_consider_frame_title (Lisp_Object frame
)
10449 struct frame
*f
= XFRAME (frame
);
10451 if (FRAME_WINDOW_P (f
)
10452 || FRAME_MINIBUF_ONLY_P (f
)
10453 || f
->explicit_name
)
10455 /* Do we have more than one visible frame on this X display? */
10462 int count
= SPECPDL_INDEX ();
10464 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10466 Lisp_Object other_frame
= XCAR (tail
);
10467 struct frame
*tf
= XFRAME (other_frame
);
10470 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10471 && !FRAME_MINIBUF_ONLY_P (tf
)
10472 && !EQ (other_frame
, tip_frame
)
10473 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10477 /* Set global variable indicating that multiple frames exist. */
10478 multiple_frames
= CONSP (tail
);
10480 /* Switch to the buffer of selected window of the frame. Set up
10481 mode_line_target so that display_mode_element will output into
10482 mode_line_noprop_buf; then display the title. */
10483 record_unwind_protect (unwind_format_mode_line
,
10484 format_mode_line_unwind_data
10485 (current_buffer
, selected_window
, 0));
10487 Fselect_window (f
->selected_window
, Qt
);
10488 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10489 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10491 mode_line_target
= MODE_LINE_TITLE
;
10492 title_start
= MODE_LINE_NOPROP_LEN (0);
10493 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10494 NULL
, DEFAULT_FACE_ID
);
10495 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10496 len
= MODE_LINE_NOPROP_LEN (title_start
);
10497 title
= mode_line_noprop_buf
+ title_start
;
10498 unbind_to (count
, Qnil
);
10500 /* Set the title only if it's changed. This avoids consing in
10501 the common case where it hasn't. (If it turns out that we've
10502 already wasted too much time by walking through the list with
10503 display_mode_element, then we might need to optimize at a
10504 higher level than this.) */
10505 if (! STRINGP (f
->name
)
10506 || SBYTES (f
->name
) != len
10507 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10508 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10512 #endif /* not HAVE_WINDOW_SYSTEM */
10517 /***********************************************************************
10519 ***********************************************************************/
10522 /* Prepare for redisplay by updating menu-bar item lists when
10523 appropriate. This can call eval. */
10526 prepare_menu_bars (void)
10529 struct gcpro gcpro1
, gcpro2
;
10531 Lisp_Object tooltip_frame
;
10533 #ifdef HAVE_WINDOW_SYSTEM
10534 tooltip_frame
= tip_frame
;
10536 tooltip_frame
= Qnil
;
10539 /* Update all frame titles based on their buffer names, etc. We do
10540 this before the menu bars so that the buffer-menu will show the
10541 up-to-date frame titles. */
10542 #ifdef HAVE_WINDOW_SYSTEM
10543 if (windows_or_buffers_changed
|| update_mode_lines
)
10545 Lisp_Object tail
, frame
;
10547 FOR_EACH_FRAME (tail
, frame
)
10549 f
= XFRAME (frame
);
10550 if (!EQ (frame
, tooltip_frame
)
10551 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10552 x_consider_frame_title (frame
);
10555 #endif /* HAVE_WINDOW_SYSTEM */
10557 /* Update the menu bar item lists, if appropriate. This has to be
10558 done before any actual redisplay or generation of display lines. */
10559 all_windows
= (update_mode_lines
10560 || buffer_shared
> 1
10561 || windows_or_buffers_changed
);
10564 Lisp_Object tail
, frame
;
10565 int count
= SPECPDL_INDEX ();
10566 /* 1 means that update_menu_bar has run its hooks
10567 so any further calls to update_menu_bar shouldn't do so again. */
10568 int menu_bar_hooks_run
= 0;
10570 record_unwind_save_match_data ();
10572 FOR_EACH_FRAME (tail
, frame
)
10574 f
= XFRAME (frame
);
10576 /* Ignore tooltip frame. */
10577 if (EQ (frame
, tooltip_frame
))
10580 /* If a window on this frame changed size, report that to
10581 the user and clear the size-change flag. */
10582 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10584 Lisp_Object functions
;
10586 /* Clear flag first in case we get an error below. */
10587 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10588 functions
= Vwindow_size_change_functions
;
10589 GCPRO2 (tail
, functions
);
10591 while (CONSP (functions
))
10593 if (!EQ (XCAR (functions
), Qt
))
10594 call1 (XCAR (functions
), frame
);
10595 functions
= XCDR (functions
);
10601 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10602 #ifdef HAVE_WINDOW_SYSTEM
10603 update_tool_bar (f
, 0);
10606 if (windows_or_buffers_changed
10608 ns_set_doc_edited (f
, Fbuffer_modified_p
10609 (XWINDOW (f
->selected_window
)->buffer
));
10614 unbind_to (count
, Qnil
);
10618 struct frame
*sf
= SELECTED_FRAME ();
10619 update_menu_bar (sf
, 1, 0);
10620 #ifdef HAVE_WINDOW_SYSTEM
10621 update_tool_bar (sf
, 1);
10627 /* Update the menu bar item list for frame F. This has to be done
10628 before we start to fill in any display lines, because it can call
10631 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10633 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10634 already ran the menu bar hooks for this redisplay, so there
10635 is no need to run them again. The return value is the
10636 updated value of this flag, to pass to the next call. */
10639 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10641 Lisp_Object window
;
10642 register struct window
*w
;
10644 /* If called recursively during a menu update, do nothing. This can
10645 happen when, for instance, an activate-menubar-hook causes a
10647 if (inhibit_menubar_update
)
10650 window
= FRAME_SELECTED_WINDOW (f
);
10651 w
= XWINDOW (window
);
10653 if (FRAME_WINDOW_P (f
)
10655 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10656 || defined (HAVE_NS) || defined (USE_GTK)
10657 FRAME_EXTERNAL_MENU_BAR (f
)
10659 FRAME_MENU_BAR_LINES (f
) > 0
10661 : FRAME_MENU_BAR_LINES (f
) > 0)
10663 /* If the user has switched buffers or windows, we need to
10664 recompute to reflect the new bindings. But we'll
10665 recompute when update_mode_lines is set too; that means
10666 that people can use force-mode-line-update to request
10667 that the menu bar be recomputed. The adverse effect on
10668 the rest of the redisplay algorithm is about the same as
10669 windows_or_buffers_changed anyway. */
10670 if (windows_or_buffers_changed
10671 /* This used to test w->update_mode_line, but we believe
10672 there is no need to recompute the menu in that case. */
10673 || update_mode_lines
10674 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10675 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10676 != !NILP (w
->last_had_star
))
10677 || ((!NILP (Vtransient_mark_mode
)
10678 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10679 != !NILP (w
->region_showing
)))
10681 struct buffer
*prev
= current_buffer
;
10682 int count
= SPECPDL_INDEX ();
10684 specbind (Qinhibit_menubar_update
, Qt
);
10686 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10687 if (save_match_data
)
10688 record_unwind_save_match_data ();
10689 if (NILP (Voverriding_local_map_menu_flag
))
10691 specbind (Qoverriding_terminal_local_map
, Qnil
);
10692 specbind (Qoverriding_local_map
, Qnil
);
10697 /* Run the Lucid hook. */
10698 safe_run_hooks (Qactivate_menubar_hook
);
10700 /* If it has changed current-menubar from previous value,
10701 really recompute the menu-bar from the value. */
10702 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10703 call0 (Qrecompute_lucid_menubar
);
10705 safe_run_hooks (Qmenu_bar_update_hook
);
10710 XSETFRAME (Vmenu_updating_frame
, f
);
10711 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10713 /* Redisplay the menu bar in case we changed it. */
10714 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10715 || defined (HAVE_NS) || defined (USE_GTK)
10716 if (FRAME_WINDOW_P (f
))
10718 #if defined (HAVE_NS)
10719 /* All frames on Mac OS share the same menubar. So only
10720 the selected frame should be allowed to set it. */
10721 if (f
== SELECTED_FRAME ())
10723 set_frame_menubar (f
, 0, 0);
10726 /* On a terminal screen, the menu bar is an ordinary screen
10727 line, and this makes it get updated. */
10728 w
->update_mode_line
= Qt
;
10729 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10730 /* In the non-toolkit version, the menu bar is an ordinary screen
10731 line, and this makes it get updated. */
10732 w
->update_mode_line
= Qt
;
10733 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10735 unbind_to (count
, Qnil
);
10736 set_buffer_internal_1 (prev
);
10745 /***********************************************************************
10747 ***********************************************************************/
10749 #ifdef HAVE_WINDOW_SYSTEM
10752 Nominal cursor position -- where to draw output.
10753 HPOS and VPOS are window relative glyph matrix coordinates.
10754 X and Y are window relative pixel coordinates. */
10756 struct cursor_pos output_cursor
;
10760 Set the global variable output_cursor to CURSOR. All cursor
10761 positions are relative to updated_window. */
10764 set_output_cursor (struct cursor_pos
*cursor
)
10766 output_cursor
.hpos
= cursor
->hpos
;
10767 output_cursor
.vpos
= cursor
->vpos
;
10768 output_cursor
.x
= cursor
->x
;
10769 output_cursor
.y
= cursor
->y
;
10774 Set a nominal cursor position.
10776 HPOS and VPOS are column/row positions in a window glyph matrix. X
10777 and Y are window text area relative pixel positions.
10779 If this is done during an update, updated_window will contain the
10780 window that is being updated and the position is the future output
10781 cursor position for that window. If updated_window is null, use
10782 selected_window and display the cursor at the given position. */
10785 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10789 /* If updated_window is not set, work on selected_window. */
10790 if (updated_window
)
10791 w
= updated_window
;
10793 w
= XWINDOW (selected_window
);
10795 /* Set the output cursor. */
10796 output_cursor
.hpos
= hpos
;
10797 output_cursor
.vpos
= vpos
;
10798 output_cursor
.x
= x
;
10799 output_cursor
.y
= y
;
10801 /* If not called as part of an update, really display the cursor.
10802 This will also set the cursor position of W. */
10803 if (updated_window
== NULL
)
10806 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10807 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10808 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10813 #endif /* HAVE_WINDOW_SYSTEM */
10816 /***********************************************************************
10818 ***********************************************************************/
10820 #ifdef HAVE_WINDOW_SYSTEM
10822 /* Where the mouse was last time we reported a mouse event. */
10824 FRAME_PTR last_mouse_frame
;
10826 /* Tool-bar item index of the item on which a mouse button was pressed
10829 int last_tool_bar_item
;
10833 update_tool_bar_unwind (Lisp_Object frame
)
10835 selected_frame
= frame
;
10839 /* Update the tool-bar item list for frame F. This has to be done
10840 before we start to fill in any display lines. Called from
10841 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10842 and restore it here. */
10845 update_tool_bar (struct frame
*f
, int save_match_data
)
10847 #if defined (USE_GTK) || defined (HAVE_NS)
10848 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10850 int do_update
= WINDOWP (f
->tool_bar_window
)
10851 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10856 Lisp_Object window
;
10859 window
= FRAME_SELECTED_WINDOW (f
);
10860 w
= XWINDOW (window
);
10862 /* If the user has switched buffers or windows, we need to
10863 recompute to reflect the new bindings. But we'll
10864 recompute when update_mode_lines is set too; that means
10865 that people can use force-mode-line-update to request
10866 that the menu bar be recomputed. The adverse effect on
10867 the rest of the redisplay algorithm is about the same as
10868 windows_or_buffers_changed anyway. */
10869 if (windows_or_buffers_changed
10870 || !NILP (w
->update_mode_line
)
10871 || update_mode_lines
10872 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10873 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10874 != !NILP (w
->last_had_star
))
10875 || ((!NILP (Vtransient_mark_mode
)
10876 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10877 != !NILP (w
->region_showing
)))
10879 struct buffer
*prev
= current_buffer
;
10880 int count
= SPECPDL_INDEX ();
10881 Lisp_Object frame
, new_tool_bar
;
10882 int new_n_tool_bar
;
10883 struct gcpro gcpro1
;
10885 /* Set current_buffer to the buffer of the selected
10886 window of the frame, so that we get the right local
10888 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10890 /* Save match data, if we must. */
10891 if (save_match_data
)
10892 record_unwind_save_match_data ();
10894 /* Make sure that we don't accidentally use bogus keymaps. */
10895 if (NILP (Voverriding_local_map_menu_flag
))
10897 specbind (Qoverriding_terminal_local_map
, Qnil
);
10898 specbind (Qoverriding_local_map
, Qnil
);
10901 GCPRO1 (new_tool_bar
);
10903 /* We must temporarily set the selected frame to this frame
10904 before calling tool_bar_items, because the calculation of
10905 the tool-bar keymap uses the selected frame (see
10906 `tool-bar-make-keymap' in tool-bar.el). */
10907 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10908 XSETFRAME (frame
, f
);
10909 selected_frame
= frame
;
10911 /* Build desired tool-bar items from keymaps. */
10912 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10915 /* Redisplay the tool-bar if we changed it. */
10916 if (new_n_tool_bar
!= f
->n_tool_bar_items
10917 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10919 /* Redisplay that happens asynchronously due to an expose event
10920 may access f->tool_bar_items. Make sure we update both
10921 variables within BLOCK_INPUT so no such event interrupts. */
10923 f
->tool_bar_items
= new_tool_bar
;
10924 f
->n_tool_bar_items
= new_n_tool_bar
;
10925 w
->update_mode_line
= Qt
;
10931 unbind_to (count
, Qnil
);
10932 set_buffer_internal_1 (prev
);
10938 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10939 F's desired tool-bar contents. F->tool_bar_items must have
10940 been set up previously by calling prepare_menu_bars. */
10943 build_desired_tool_bar_string (struct frame
*f
)
10945 int i
, size
, size_needed
;
10946 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10947 Lisp_Object image
, plist
, props
;
10949 image
= plist
= props
= Qnil
;
10950 GCPRO3 (image
, plist
, props
);
10952 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10953 Otherwise, make a new string. */
10955 /* The size of the string we might be able to reuse. */
10956 size
= (STRINGP (f
->desired_tool_bar_string
)
10957 ? SCHARS (f
->desired_tool_bar_string
)
10960 /* We need one space in the string for each image. */
10961 size_needed
= f
->n_tool_bar_items
;
10963 /* Reuse f->desired_tool_bar_string, if possible. */
10964 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10965 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10966 make_number (' '));
10969 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10970 Fremove_text_properties (make_number (0), make_number (size
),
10971 props
, f
->desired_tool_bar_string
);
10974 /* Put a `display' property on the string for the images to display,
10975 put a `menu_item' property on tool-bar items with a value that
10976 is the index of the item in F's tool-bar item vector. */
10977 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10979 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10981 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10982 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10983 int hmargin
, vmargin
, relief
, idx
, end
;
10985 /* If image is a vector, choose the image according to the
10987 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10988 if (VECTORP (image
))
10992 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10993 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10996 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10997 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10999 xassert (ASIZE (image
) >= idx
);
11000 image
= AREF (image
, idx
);
11005 /* Ignore invalid image specifications. */
11006 if (!valid_image_p (image
))
11009 /* Display the tool-bar button pressed, or depressed. */
11010 plist
= Fcopy_sequence (XCDR (image
));
11012 /* Compute margin and relief to draw. */
11013 relief
= (tool_bar_button_relief
>= 0
11014 ? tool_bar_button_relief
11015 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11016 hmargin
= vmargin
= relief
;
11018 if (INTEGERP (Vtool_bar_button_margin
)
11019 && XINT (Vtool_bar_button_margin
) > 0)
11021 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11022 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11024 else if (CONSP (Vtool_bar_button_margin
))
11026 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11027 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11028 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11030 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11031 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11032 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11035 if (auto_raise_tool_bar_buttons_p
)
11037 /* Add a `:relief' property to the image spec if the item is
11041 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11048 /* If image is selected, display it pressed, i.e. with a
11049 negative relief. If it's not selected, display it with a
11051 plist
= Fplist_put (plist
, QCrelief
,
11053 ? make_number (-relief
)
11054 : make_number (relief
)));
11059 /* Put a margin around the image. */
11060 if (hmargin
|| vmargin
)
11062 if (hmargin
== vmargin
)
11063 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11065 plist
= Fplist_put (plist
, QCmargin
,
11066 Fcons (make_number (hmargin
),
11067 make_number (vmargin
)));
11070 /* If button is not enabled, and we don't have special images
11071 for the disabled state, make the image appear disabled by
11072 applying an appropriate algorithm to it. */
11073 if (!enabled_p
&& idx
< 0)
11074 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11076 /* Put a `display' text property on the string for the image to
11077 display. Put a `menu-item' property on the string that gives
11078 the start of this item's properties in the tool-bar items
11080 image
= Fcons (Qimage
, plist
);
11081 props
= list4 (Qdisplay
, image
,
11082 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11084 /* Let the last image hide all remaining spaces in the tool bar
11085 string. The string can be longer than needed when we reuse a
11086 previous string. */
11087 if (i
+ 1 == f
->n_tool_bar_items
)
11088 end
= SCHARS (f
->desired_tool_bar_string
);
11091 Fadd_text_properties (make_number (i
), make_number (end
),
11092 props
, f
->desired_tool_bar_string
);
11100 /* Display one line of the tool-bar of frame IT->f.
11102 HEIGHT specifies the desired height of the tool-bar line.
11103 If the actual height of the glyph row is less than HEIGHT, the
11104 row's height is increased to HEIGHT, and the icons are centered
11105 vertically in the new height.
11107 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11108 count a final empty row in case the tool-bar width exactly matches
11113 display_tool_bar_line (struct it
*it
, int height
)
11115 struct glyph_row
*row
= it
->glyph_row
;
11116 int max_x
= it
->last_visible_x
;
11117 struct glyph
*last
;
11119 prepare_desired_row (row
);
11120 row
->y
= it
->current_y
;
11122 /* Note that this isn't made use of if the face hasn't a box,
11123 so there's no need to check the face here. */
11124 it
->start_of_box_run_p
= 1;
11126 while (it
->current_x
< max_x
)
11128 int x
, n_glyphs_before
, i
, nglyphs
;
11129 struct it it_before
;
11131 /* Get the next display element. */
11132 if (!get_next_display_element (it
))
11134 /* Don't count empty row if we are counting needed tool-bar lines. */
11135 if (height
< 0 && !it
->hpos
)
11140 /* Produce glyphs. */
11141 n_glyphs_before
= row
->used
[TEXT_AREA
];
11144 PRODUCE_GLYPHS (it
);
11146 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11148 x
= it_before
.current_x
;
11149 while (i
< nglyphs
)
11151 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11153 if (x
+ glyph
->pixel_width
> max_x
)
11155 /* Glyph doesn't fit on line. Backtrack. */
11156 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11158 /* If this is the only glyph on this line, it will never fit on the
11159 tool-bar, so skip it. But ensure there is at least one glyph,
11160 so we don't accidentally disable the tool-bar. */
11161 if (n_glyphs_before
== 0
11162 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11168 x
+= glyph
->pixel_width
;
11172 /* Stop at line end. */
11173 if (ITERATOR_AT_END_OF_LINE_P (it
))
11176 set_iterator_to_next (it
, 1);
11181 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11183 /* Use default face for the border below the tool bar.
11185 FIXME: When auto-resize-tool-bars is grow-only, there is
11186 no additional border below the possibly empty tool-bar lines.
11187 So to make the extra empty lines look "normal", we have to
11188 use the tool-bar face for the border too. */
11189 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11190 it
->face_id
= DEFAULT_FACE_ID
;
11192 extend_face_to_end_of_line (it
);
11193 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11194 last
->right_box_line_p
= 1;
11195 if (last
== row
->glyphs
[TEXT_AREA
])
11196 last
->left_box_line_p
= 1;
11198 /* Make line the desired height and center it vertically. */
11199 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11201 /* Don't add more than one line height. */
11202 height
%= FRAME_LINE_HEIGHT (it
->f
);
11203 it
->max_ascent
+= height
/ 2;
11204 it
->max_descent
+= (height
+ 1) / 2;
11207 compute_line_metrics (it
);
11209 /* If line is empty, make it occupy the rest of the tool-bar. */
11210 if (!row
->displays_text_p
)
11212 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11213 row
->visible_height
= row
->height
;
11214 row
->ascent
= row
->phys_ascent
= 0;
11215 row
->extra_line_spacing
= 0;
11218 row
->full_width_p
= 1;
11219 row
->continued_p
= 0;
11220 row
->truncated_on_left_p
= 0;
11221 row
->truncated_on_right_p
= 0;
11223 it
->current_x
= it
->hpos
= 0;
11224 it
->current_y
+= row
->height
;
11230 /* Max tool-bar height. */
11232 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11233 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11235 /* Value is the number of screen lines needed to make all tool-bar
11236 items of frame F visible. The number of actual rows needed is
11237 returned in *N_ROWS if non-NULL. */
11240 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11242 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11244 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11245 the desired matrix, so use (unused) mode-line row as temporary row to
11246 avoid destroying the first tool-bar row. */
11247 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11249 /* Initialize an iterator for iteration over
11250 F->desired_tool_bar_string in the tool-bar window of frame F. */
11251 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11252 it
.first_visible_x
= 0;
11253 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11254 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11255 it
.paragraph_embedding
= L2R
;
11257 while (!ITERATOR_AT_END_P (&it
))
11259 clear_glyph_row (temp_row
);
11260 it
.glyph_row
= temp_row
;
11261 display_tool_bar_line (&it
, -1);
11263 clear_glyph_row (temp_row
);
11265 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11267 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11269 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11273 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11275 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11276 (Lisp_Object frame
)
11283 frame
= selected_frame
;
11285 CHECK_FRAME (frame
);
11286 f
= XFRAME (frame
);
11288 if (WINDOWP (f
->tool_bar_window
)
11289 && (w
= XWINDOW (f
->tool_bar_window
),
11290 WINDOW_TOTAL_LINES (w
) > 0))
11292 update_tool_bar (f
, 1);
11293 if (f
->n_tool_bar_items
)
11295 build_desired_tool_bar_string (f
);
11296 nlines
= tool_bar_lines_needed (f
, NULL
);
11300 return make_number (nlines
);
11304 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11305 height should be changed. */
11308 redisplay_tool_bar (struct frame
*f
)
11312 struct glyph_row
*row
;
11314 #if defined (USE_GTK) || defined (HAVE_NS)
11315 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11316 update_frame_tool_bar (f
);
11320 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11321 do anything. This means you must start with tool-bar-lines
11322 non-zero to get the auto-sizing effect. Or in other words, you
11323 can turn off tool-bars by specifying tool-bar-lines zero. */
11324 if (!WINDOWP (f
->tool_bar_window
)
11325 || (w
= XWINDOW (f
->tool_bar_window
),
11326 WINDOW_TOTAL_LINES (w
) == 0))
11329 /* Set up an iterator for the tool-bar window. */
11330 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11331 it
.first_visible_x
= 0;
11332 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11333 row
= it
.glyph_row
;
11335 /* Build a string that represents the contents of the tool-bar. */
11336 build_desired_tool_bar_string (f
);
11337 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11338 /* FIXME: This should be controlled by a user option. But it
11339 doesn't make sense to have an R2L tool bar if the menu bar cannot
11340 be drawn also R2L, and making the menu bar R2L is tricky due
11341 toolkit-specific code that implements it. If an R2L tool bar is
11342 ever supported, display_tool_bar_line should also be augmented to
11343 call unproduce_glyphs like display_line and display_string
11345 it
.paragraph_embedding
= L2R
;
11347 if (f
->n_tool_bar_rows
== 0)
11351 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11352 nlines
!= WINDOW_TOTAL_LINES (w
)))
11355 int old_height
= WINDOW_TOTAL_LINES (w
);
11357 XSETFRAME (frame
, f
);
11358 Fmodify_frame_parameters (frame
,
11359 Fcons (Fcons (Qtool_bar_lines
,
11360 make_number (nlines
)),
11362 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11364 clear_glyph_matrix (w
->desired_matrix
);
11365 fonts_changed_p
= 1;
11371 /* Display as many lines as needed to display all tool-bar items. */
11373 if (f
->n_tool_bar_rows
> 0)
11375 int border
, rows
, height
, extra
;
11377 if (INTEGERP (Vtool_bar_border
))
11378 border
= XINT (Vtool_bar_border
);
11379 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11380 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11381 else if (EQ (Vtool_bar_border
, Qborder_width
))
11382 border
= f
->border_width
;
11388 rows
= f
->n_tool_bar_rows
;
11389 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11390 extra
= it
.last_visible_y
- border
- height
* rows
;
11392 while (it
.current_y
< it
.last_visible_y
)
11395 if (extra
> 0 && rows
-- > 0)
11397 h
= (extra
+ rows
- 1) / rows
;
11400 display_tool_bar_line (&it
, height
+ h
);
11405 while (it
.current_y
< it
.last_visible_y
)
11406 display_tool_bar_line (&it
, 0);
11409 /* It doesn't make much sense to try scrolling in the tool-bar
11410 window, so don't do it. */
11411 w
->desired_matrix
->no_scrolling_p
= 1;
11412 w
->must_be_updated_p
= 1;
11414 if (!NILP (Vauto_resize_tool_bars
))
11416 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11417 int change_height_p
= 0;
11419 /* If we couldn't display everything, change the tool-bar's
11420 height if there is room for more. */
11421 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11422 && it
.current_y
< max_tool_bar_height
)
11423 change_height_p
= 1;
11425 row
= it
.glyph_row
- 1;
11427 /* If there are blank lines at the end, except for a partially
11428 visible blank line at the end that is smaller than
11429 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11430 if (!row
->displays_text_p
11431 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11432 change_height_p
= 1;
11434 /* If row displays tool-bar items, but is partially visible,
11435 change the tool-bar's height. */
11436 if (row
->displays_text_p
11437 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11438 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11439 change_height_p
= 1;
11441 /* Resize windows as needed by changing the `tool-bar-lines'
11442 frame parameter. */
11443 if (change_height_p
)
11446 int old_height
= WINDOW_TOTAL_LINES (w
);
11448 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11450 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11451 && !f
->minimize_tool_bar_window_p
)
11452 ? (nlines
> old_height
)
11453 : (nlines
!= old_height
));
11454 f
->minimize_tool_bar_window_p
= 0;
11456 if (change_height_p
)
11458 XSETFRAME (frame
, f
);
11459 Fmodify_frame_parameters (frame
,
11460 Fcons (Fcons (Qtool_bar_lines
,
11461 make_number (nlines
)),
11463 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11465 clear_glyph_matrix (w
->desired_matrix
);
11466 f
->n_tool_bar_rows
= nrows
;
11467 fonts_changed_p
= 1;
11474 f
->minimize_tool_bar_window_p
= 0;
11479 /* Get information about the tool-bar item which is displayed in GLYPH
11480 on frame F. Return in *PROP_IDX the index where tool-bar item
11481 properties start in F->tool_bar_items. Value is zero if
11482 GLYPH doesn't display a tool-bar item. */
11485 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11491 /* This function can be called asynchronously, which means we must
11492 exclude any possibility that Fget_text_property signals an
11494 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11495 charpos
= max (0, charpos
);
11497 /* Get the text property `menu-item' at pos. The value of that
11498 property is the start index of this item's properties in
11499 F->tool_bar_items. */
11500 prop
= Fget_text_property (make_number (charpos
),
11501 Qmenu_item
, f
->current_tool_bar_string
);
11502 if (INTEGERP (prop
))
11504 *prop_idx
= XINT (prop
);
11514 /* Get information about the tool-bar item at position X/Y on frame F.
11515 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11516 the current matrix of the tool-bar window of F, or NULL if not
11517 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11518 item in F->tool_bar_items. Value is
11520 -1 if X/Y is not on a tool-bar item
11521 0 if X/Y is on the same item that was highlighted before.
11525 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11526 int *hpos
, int *vpos
, int *prop_idx
)
11528 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11529 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11532 /* Find the glyph under X/Y. */
11533 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11534 if (*glyph
== NULL
)
11537 /* Get the start of this tool-bar item's properties in
11538 f->tool_bar_items. */
11539 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11542 /* Is mouse on the highlighted item? */
11543 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11544 && *vpos
>= hlinfo
->mouse_face_beg_row
11545 && *vpos
<= hlinfo
->mouse_face_end_row
11546 && (*vpos
> hlinfo
->mouse_face_beg_row
11547 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11548 && (*vpos
< hlinfo
->mouse_face_end_row
11549 || *hpos
< hlinfo
->mouse_face_end_col
11550 || hlinfo
->mouse_face_past_end
))
11558 Handle mouse button event on the tool-bar of frame F, at
11559 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11560 0 for button release. MODIFIERS is event modifiers for button
11564 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11565 unsigned int modifiers
)
11567 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11568 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11569 int hpos
, vpos
, prop_idx
;
11570 struct glyph
*glyph
;
11571 Lisp_Object enabled_p
;
11573 /* If not on the highlighted tool-bar item, return. */
11574 frame_to_window_pixel_xy (w
, &x
, &y
);
11575 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11578 /* If item is disabled, do nothing. */
11579 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11580 if (NILP (enabled_p
))
11585 /* Show item in pressed state. */
11586 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11587 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11588 last_tool_bar_item
= prop_idx
;
11592 Lisp_Object key
, frame
;
11593 struct input_event event
;
11594 EVENT_INIT (event
);
11596 /* Show item in released state. */
11597 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11598 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11600 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11602 XSETFRAME (frame
, f
);
11603 event
.kind
= TOOL_BAR_EVENT
;
11604 event
.frame_or_window
= frame
;
11606 kbd_buffer_store_event (&event
);
11608 event
.kind
= TOOL_BAR_EVENT
;
11609 event
.frame_or_window
= frame
;
11611 event
.modifiers
= modifiers
;
11612 kbd_buffer_store_event (&event
);
11613 last_tool_bar_item
= -1;
11618 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11619 tool-bar window-relative coordinates X/Y. Called from
11620 note_mouse_highlight. */
11623 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11625 Lisp_Object window
= f
->tool_bar_window
;
11626 struct window
*w
= XWINDOW (window
);
11627 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11628 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11630 struct glyph
*glyph
;
11631 struct glyph_row
*row
;
11633 Lisp_Object enabled_p
;
11635 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11636 int mouse_down_p
, rc
;
11638 /* Function note_mouse_highlight is called with negative X/Y
11639 values when mouse moves outside of the frame. */
11640 if (x
<= 0 || y
<= 0)
11642 clear_mouse_face (hlinfo
);
11646 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11649 /* Not on tool-bar item. */
11650 clear_mouse_face (hlinfo
);
11654 /* On same tool-bar item as before. */
11655 goto set_help_echo
;
11657 clear_mouse_face (hlinfo
);
11659 /* Mouse is down, but on different tool-bar item? */
11660 mouse_down_p
= (dpyinfo
->grabbed
11661 && f
== last_mouse_frame
11662 && FRAME_LIVE_P (f
));
11664 && last_tool_bar_item
!= prop_idx
)
11667 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11668 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11670 /* If tool-bar item is not enabled, don't highlight it. */
11671 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11672 if (!NILP (enabled_p
))
11674 /* Compute the x-position of the glyph. In front and past the
11675 image is a space. We include this in the highlighted area. */
11676 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11677 for (i
= x
= 0; i
< hpos
; ++i
)
11678 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11680 /* Record this as the current active region. */
11681 hlinfo
->mouse_face_beg_col
= hpos
;
11682 hlinfo
->mouse_face_beg_row
= vpos
;
11683 hlinfo
->mouse_face_beg_x
= x
;
11684 hlinfo
->mouse_face_beg_y
= row
->y
;
11685 hlinfo
->mouse_face_past_end
= 0;
11687 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11688 hlinfo
->mouse_face_end_row
= vpos
;
11689 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11690 hlinfo
->mouse_face_end_y
= row
->y
;
11691 hlinfo
->mouse_face_window
= window
;
11692 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11694 /* Display it as active. */
11695 show_mouse_face (hlinfo
, draw
);
11696 hlinfo
->mouse_face_image_state
= draw
;
11701 /* Set help_echo_string to a help string to display for this tool-bar item.
11702 XTread_socket does the rest. */
11703 help_echo_object
= help_echo_window
= Qnil
;
11704 help_echo_pos
= -1;
11705 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11706 if (NILP (help_echo_string
))
11707 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11710 #endif /* HAVE_WINDOW_SYSTEM */
11714 /************************************************************************
11715 Horizontal scrolling
11716 ************************************************************************/
11718 static int hscroll_window_tree (Lisp_Object
);
11719 static int hscroll_windows (Lisp_Object
);
11721 /* For all leaf windows in the window tree rooted at WINDOW, set their
11722 hscroll value so that PT is (i) visible in the window, and (ii) so
11723 that it is not within a certain margin at the window's left and
11724 right border. Value is non-zero if any window's hscroll has been
11728 hscroll_window_tree (Lisp_Object window
)
11730 int hscrolled_p
= 0;
11731 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11732 int hscroll_step_abs
= 0;
11733 double hscroll_step_rel
= 0;
11735 if (hscroll_relative_p
)
11737 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11738 if (hscroll_step_rel
< 0)
11740 hscroll_relative_p
= 0;
11741 hscroll_step_abs
= 0;
11744 else if (INTEGERP (Vhscroll_step
))
11746 hscroll_step_abs
= XINT (Vhscroll_step
);
11747 if (hscroll_step_abs
< 0)
11748 hscroll_step_abs
= 0;
11751 hscroll_step_abs
= 0;
11753 while (WINDOWP (window
))
11755 struct window
*w
= XWINDOW (window
);
11757 if (WINDOWP (w
->hchild
))
11758 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11759 else if (WINDOWP (w
->vchild
))
11760 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11761 else if (w
->cursor
.vpos
>= 0)
11764 int text_area_width
;
11765 struct glyph_row
*current_cursor_row
11766 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11767 struct glyph_row
*desired_cursor_row
11768 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11769 struct glyph_row
*cursor_row
11770 = (desired_cursor_row
->enabled_p
11771 ? desired_cursor_row
11772 : current_cursor_row
);
11774 text_area_width
= window_box_width (w
, TEXT_AREA
);
11776 /* Scroll when cursor is inside this scroll margin. */
11777 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11779 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11780 && ((XFASTINT (w
->hscroll
)
11781 && w
->cursor
.x
<= h_margin
)
11782 || (cursor_row
->enabled_p
11783 && cursor_row
->truncated_on_right_p
11784 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11788 struct buffer
*saved_current_buffer
;
11792 /* Find point in a display of infinite width. */
11793 saved_current_buffer
= current_buffer
;
11794 current_buffer
= XBUFFER (w
->buffer
);
11796 if (w
== XWINDOW (selected_window
))
11800 pt
= marker_position (w
->pointm
);
11801 pt
= max (BEGV
, pt
);
11805 /* Move iterator to pt starting at cursor_row->start in
11806 a line with infinite width. */
11807 init_to_row_start (&it
, w
, cursor_row
);
11808 it
.last_visible_x
= INFINITY
;
11809 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11810 current_buffer
= saved_current_buffer
;
11812 /* Position cursor in window. */
11813 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11814 hscroll
= max (0, (it
.current_x
11815 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11816 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11817 : (text_area_width
/ 2))))
11818 / FRAME_COLUMN_WIDTH (it
.f
);
11819 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11821 if (hscroll_relative_p
)
11822 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11825 wanted_x
= text_area_width
11826 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11829 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11833 if (hscroll_relative_p
)
11834 wanted_x
= text_area_width
* hscroll_step_rel
11837 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11840 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11842 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11844 /* Don't call Fset_window_hscroll if value hasn't
11845 changed because it will prevent redisplay
11847 if (XFASTINT (w
->hscroll
) != hscroll
)
11849 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11850 w
->hscroll
= make_number (hscroll
);
11859 /* Value is non-zero if hscroll of any leaf window has been changed. */
11860 return hscrolled_p
;
11864 /* Set hscroll so that cursor is visible and not inside horizontal
11865 scroll margins for all windows in the tree rooted at WINDOW. See
11866 also hscroll_window_tree above. Value is non-zero if any window's
11867 hscroll has been changed. If it has, desired matrices on the frame
11868 of WINDOW are cleared. */
11871 hscroll_windows (Lisp_Object window
)
11873 int hscrolled_p
= hscroll_window_tree (window
);
11875 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11876 return hscrolled_p
;
11881 /************************************************************************
11883 ************************************************************************/
11885 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11886 to a non-zero value. This is sometimes handy to have in a debugger
11891 /* First and last unchanged row for try_window_id. */
11893 static int debug_first_unchanged_at_end_vpos
;
11894 static int debug_last_unchanged_at_beg_vpos
;
11896 /* Delta vpos and y. */
11898 static int debug_dvpos
, debug_dy
;
11900 /* Delta in characters and bytes for try_window_id. */
11902 static EMACS_INT debug_delta
, debug_delta_bytes
;
11904 /* Values of window_end_pos and window_end_vpos at the end of
11907 static EMACS_INT debug_end_vpos
;
11909 /* Append a string to W->desired_matrix->method. FMT is a printf
11910 format string. If trace_redisplay_p is non-zero also printf the
11911 resulting string to stderr. */
11913 static void debug_method_add (struct window
*, char const *, ...)
11914 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11917 debug_method_add (struct window
*w
, char const *fmt
, ...)
11920 char *method
= w
->desired_matrix
->method
;
11921 int len
= strlen (method
);
11922 int size
= sizeof w
->desired_matrix
->method
;
11923 int remaining
= size
- len
- 1;
11926 va_start (ap
, fmt
);
11927 vsprintf (buffer
, fmt
, ap
);
11929 if (len
&& remaining
)
11932 --remaining
, ++len
;
11935 strncpy (method
+ len
, buffer
, remaining
);
11937 if (trace_redisplay_p
)
11938 fprintf (stderr
, "%p (%s): %s\n",
11940 ((BUFFERP (w
->buffer
)
11941 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11942 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11947 #endif /* GLYPH_DEBUG */
11950 /* Value is non-zero if all changes in window W, which displays
11951 current_buffer, are in the text between START and END. START is a
11952 buffer position, END is given as a distance from Z. Used in
11953 redisplay_internal for display optimization. */
11956 text_outside_line_unchanged_p (struct window
*w
,
11957 EMACS_INT start
, EMACS_INT end
)
11959 int unchanged_p
= 1;
11961 /* If text or overlays have changed, see where. */
11962 if (XFASTINT (w
->last_modified
) < MODIFF
11963 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11965 /* Gap in the line? */
11966 if (GPT
< start
|| Z
- GPT
< end
)
11969 /* Changes start in front of the line, or end after it? */
11971 && (BEG_UNCHANGED
< start
- 1
11972 || END_UNCHANGED
< end
))
11975 /* If selective display, can't optimize if changes start at the
11976 beginning of the line. */
11978 && INTEGERP (BVAR (current_buffer
, selective_display
))
11979 && XINT (BVAR (current_buffer
, selective_display
)) > 0
11980 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11983 /* If there are overlays at the start or end of the line, these
11984 may have overlay strings with newlines in them. A change at
11985 START, for instance, may actually concern the display of such
11986 overlay strings as well, and they are displayed on different
11987 lines. So, quickly rule out this case. (For the future, it
11988 might be desirable to implement something more telling than
11989 just BEG/END_UNCHANGED.) */
11992 if (BEG
+ BEG_UNCHANGED
== start
11993 && overlay_touches_p (start
))
11995 if (END_UNCHANGED
== end
11996 && overlay_touches_p (Z
- end
))
12000 /* Under bidi reordering, adding or deleting a character in the
12001 beginning of a paragraph, before the first strong directional
12002 character, can change the base direction of the paragraph (unless
12003 the buffer specifies a fixed paragraph direction), which will
12004 require to redisplay the whole paragraph. It might be worthwhile
12005 to find the paragraph limits and widen the range of redisplayed
12006 lines to that, but for now just give up this optimization. */
12007 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12008 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12012 return unchanged_p
;
12016 /* Do a frame update, taking possible shortcuts into account. This is
12017 the main external entry point for redisplay.
12019 If the last redisplay displayed an echo area message and that message
12020 is no longer requested, we clear the echo area or bring back the
12021 mini-buffer if that is in use. */
12026 redisplay_internal ();
12031 overlay_arrow_string_or_property (Lisp_Object var
)
12035 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12038 return Voverlay_arrow_string
;
12041 /* Return 1 if there are any overlay-arrows in current_buffer. */
12043 overlay_arrow_in_current_buffer_p (void)
12047 for (vlist
= Voverlay_arrow_variable_list
;
12049 vlist
= XCDR (vlist
))
12051 Lisp_Object var
= XCAR (vlist
);
12054 if (!SYMBOLP (var
))
12056 val
= find_symbol_value (var
);
12058 && current_buffer
== XMARKER (val
)->buffer
)
12065 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12069 overlay_arrows_changed_p (void)
12073 for (vlist
= Voverlay_arrow_variable_list
;
12075 vlist
= XCDR (vlist
))
12077 Lisp_Object var
= XCAR (vlist
);
12078 Lisp_Object val
, pstr
;
12080 if (!SYMBOLP (var
))
12082 val
= find_symbol_value (var
);
12083 if (!MARKERP (val
))
12085 if (! EQ (COERCE_MARKER (val
),
12086 Fget (var
, Qlast_arrow_position
))
12087 || ! (pstr
= overlay_arrow_string_or_property (var
),
12088 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12094 /* Mark overlay arrows to be updated on next redisplay. */
12097 update_overlay_arrows (int up_to_date
)
12101 for (vlist
= Voverlay_arrow_variable_list
;
12103 vlist
= XCDR (vlist
))
12105 Lisp_Object var
= XCAR (vlist
);
12107 if (!SYMBOLP (var
))
12110 if (up_to_date
> 0)
12112 Lisp_Object val
= find_symbol_value (var
);
12113 Fput (var
, Qlast_arrow_position
,
12114 COERCE_MARKER (val
));
12115 Fput (var
, Qlast_arrow_string
,
12116 overlay_arrow_string_or_property (var
));
12118 else if (up_to_date
< 0
12119 || !NILP (Fget (var
, Qlast_arrow_position
)))
12121 Fput (var
, Qlast_arrow_position
, Qt
);
12122 Fput (var
, Qlast_arrow_string
, Qt
);
12128 /* Return overlay arrow string to display at row.
12129 Return integer (bitmap number) for arrow bitmap in left fringe.
12130 Return nil if no overlay arrow. */
12133 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12137 for (vlist
= Voverlay_arrow_variable_list
;
12139 vlist
= XCDR (vlist
))
12141 Lisp_Object var
= XCAR (vlist
);
12144 if (!SYMBOLP (var
))
12147 val
= find_symbol_value (var
);
12150 && current_buffer
== XMARKER (val
)->buffer
12151 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12153 if (FRAME_WINDOW_P (it
->f
)
12154 /* FIXME: if ROW->reversed_p is set, this should test
12155 the right fringe, not the left one. */
12156 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12158 #ifdef HAVE_WINDOW_SYSTEM
12159 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12162 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12163 return make_number (fringe_bitmap
);
12166 return make_number (-1); /* Use default arrow bitmap */
12168 return overlay_arrow_string_or_property (var
);
12175 /* Return 1 if point moved out of or into a composition. Otherwise
12176 return 0. PREV_BUF and PREV_PT are the last point buffer and
12177 position. BUF and PT are the current point buffer and position. */
12180 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12181 struct buffer
*buf
, EMACS_INT pt
)
12183 EMACS_INT start
, end
;
12185 Lisp_Object buffer
;
12187 XSETBUFFER (buffer
, buf
);
12188 /* Check a composition at the last point if point moved within the
12190 if (prev_buf
== buf
)
12193 /* Point didn't move. */
12196 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12197 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12198 && COMPOSITION_VALID_P (start
, end
, prop
)
12199 && start
< prev_pt
&& end
> prev_pt
)
12200 /* The last point was within the composition. Return 1 iff
12201 point moved out of the composition. */
12202 return (pt
<= start
|| pt
>= end
);
12205 /* Check a composition at the current point. */
12206 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12207 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12208 && COMPOSITION_VALID_P (start
, end
, prop
)
12209 && start
< pt
&& end
> pt
);
12213 /* Reconsider the setting of B->clip_changed which is displayed
12217 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12219 if (b
->clip_changed
12220 && !NILP (w
->window_end_valid
)
12221 && w
->current_matrix
->buffer
== b
12222 && w
->current_matrix
->zv
== BUF_ZV (b
)
12223 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12224 b
->clip_changed
= 0;
12226 /* If display wasn't paused, and W is not a tool bar window, see if
12227 point has been moved into or out of a composition. In that case,
12228 we set b->clip_changed to 1 to force updating the screen. If
12229 b->clip_changed has already been set to 1, we can skip this
12231 if (!b
->clip_changed
12232 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12236 if (w
== XWINDOW (selected_window
))
12239 pt
= marker_position (w
->pointm
);
12241 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12242 || pt
!= XINT (w
->last_point
))
12243 && check_point_in_composition (w
->current_matrix
->buffer
,
12244 XINT (w
->last_point
),
12245 XBUFFER (w
->buffer
), pt
))
12246 b
->clip_changed
= 1;
12251 /* Select FRAME to forward the values of frame-local variables into C
12252 variables so that the redisplay routines can access those values
12256 select_frame_for_redisplay (Lisp_Object frame
)
12258 Lisp_Object tail
, tem
;
12259 Lisp_Object old
= selected_frame
;
12260 struct Lisp_Symbol
*sym
;
12262 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12264 selected_frame
= frame
;
12267 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12268 if (CONSP (XCAR (tail
))
12269 && (tem
= XCAR (XCAR (tail
)),
12271 && (sym
= indirect_variable (XSYMBOL (tem
)),
12272 sym
->redirect
== SYMBOL_LOCALIZED
)
12273 && sym
->val
.blv
->frame_local
)
12274 /* Use find_symbol_value rather than Fsymbol_value
12275 to avoid an error if it is void. */
12276 find_symbol_value (tem
);
12277 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12281 #define STOP_POLLING \
12282 do { if (! polling_stopped_here) stop_polling (); \
12283 polling_stopped_here = 1; } while (0)
12285 #define RESUME_POLLING \
12286 do { if (polling_stopped_here) start_polling (); \
12287 polling_stopped_here = 0; } while (0)
12290 /* Perhaps in the future avoid recentering windows if it
12291 is not necessary; currently that causes some problems. */
12294 redisplay_internal (void)
12296 struct window
*w
= XWINDOW (selected_window
);
12300 int must_finish
= 0;
12301 struct text_pos tlbufpos
, tlendpos
;
12302 int number_of_visible_frames
;
12305 int polling_stopped_here
= 0;
12306 Lisp_Object old_frame
= selected_frame
;
12308 /* Non-zero means redisplay has to consider all windows on all
12309 frames. Zero means, only selected_window is considered. */
12310 int consider_all_windows_p
;
12312 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12314 /* No redisplay if running in batch mode or frame is not yet fully
12315 initialized, or redisplay is explicitly turned off by setting
12316 Vinhibit_redisplay. */
12317 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12318 || !NILP (Vinhibit_redisplay
))
12321 /* Don't examine these until after testing Vinhibit_redisplay.
12322 When Emacs is shutting down, perhaps because its connection to
12323 X has dropped, we should not look at them at all. */
12324 fr
= XFRAME (w
->frame
);
12325 sf
= SELECTED_FRAME ();
12327 if (!fr
->glyphs_initialized_p
)
12330 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12331 if (popup_activated ())
12335 /* I don't think this happens but let's be paranoid. */
12336 if (redisplaying_p
)
12339 /* Record a function that resets redisplaying_p to its old value
12340 when we leave this function. */
12341 count
= SPECPDL_INDEX ();
12342 record_unwind_protect (unwind_redisplay
,
12343 Fcons (make_number (redisplaying_p
), selected_frame
));
12345 specbind (Qinhibit_free_realized_faces
, Qnil
);
12348 Lisp_Object tail
, frame
;
12350 FOR_EACH_FRAME (tail
, frame
)
12352 struct frame
*f
= XFRAME (frame
);
12353 f
->already_hscrolled_p
= 0;
12358 /* Remember the currently selected window. */
12361 if (!EQ (old_frame
, selected_frame
)
12362 && FRAME_LIVE_P (XFRAME (old_frame
)))
12363 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12364 selected_frame and selected_window to be temporarily out-of-sync so
12365 when we come back here via `goto retry', we need to resync because we
12366 may need to run Elisp code (via prepare_menu_bars). */
12367 select_frame_for_redisplay (old_frame
);
12370 reconsider_clip_changes (w
, current_buffer
);
12371 last_escape_glyph_frame
= NULL
;
12372 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12373 last_glyphless_glyph_frame
= NULL
;
12374 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12376 /* If new fonts have been loaded that make a glyph matrix adjustment
12377 necessary, do it. */
12378 if (fonts_changed_p
)
12380 adjust_glyphs (NULL
);
12381 ++windows_or_buffers_changed
;
12382 fonts_changed_p
= 0;
12385 /* If face_change_count is non-zero, init_iterator will free all
12386 realized faces, which includes the faces referenced from current
12387 matrices. So, we can't reuse current matrices in this case. */
12388 if (face_change_count
)
12389 ++windows_or_buffers_changed
;
12391 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12392 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12394 /* Since frames on a single ASCII terminal share the same
12395 display area, displaying a different frame means redisplay
12396 the whole thing. */
12397 windows_or_buffers_changed
++;
12398 SET_FRAME_GARBAGED (sf
);
12400 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12402 FRAME_TTY (sf
)->previous_frame
= sf
;
12405 /* Set the visible flags for all frames. Do this before checking
12406 for resized or garbaged frames; they want to know if their frames
12407 are visible. See the comment in frame.h for
12408 FRAME_SAMPLE_VISIBILITY. */
12410 Lisp_Object tail
, frame
;
12412 number_of_visible_frames
= 0;
12414 FOR_EACH_FRAME (tail
, frame
)
12416 struct frame
*f
= XFRAME (frame
);
12418 FRAME_SAMPLE_VISIBILITY (f
);
12419 if (FRAME_VISIBLE_P (f
))
12420 ++number_of_visible_frames
;
12421 clear_desired_matrices (f
);
12425 /* Notice any pending interrupt request to change frame size. */
12426 do_pending_window_change (1);
12428 /* do_pending_window_change could change the selected_window due to
12429 frame resizing which makes the selected window too small. */
12430 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12433 reconsider_clip_changes (w
, current_buffer
);
12436 /* Clear frames marked as garbaged. */
12437 if (frame_garbaged
)
12438 clear_garbaged_frames ();
12440 /* Build menubar and tool-bar items. */
12441 if (NILP (Vmemory_full
))
12442 prepare_menu_bars ();
12444 if (windows_or_buffers_changed
)
12445 update_mode_lines
++;
12447 /* Detect case that we need to write or remove a star in the mode line. */
12448 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12450 w
->update_mode_line
= Qt
;
12451 if (buffer_shared
> 1)
12452 update_mode_lines
++;
12455 /* Avoid invocation of point motion hooks by `current_column' below. */
12456 count1
= SPECPDL_INDEX ();
12457 specbind (Qinhibit_point_motion_hooks
, Qt
);
12459 /* If %c is in the mode line, update it if needed. */
12460 if (!NILP (w
->column_number_displayed
)
12461 /* This alternative quickly identifies a common case
12462 where no change is needed. */
12463 && !(PT
== XFASTINT (w
->last_point
)
12464 && XFASTINT (w
->last_modified
) >= MODIFF
12465 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12466 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12467 w
->update_mode_line
= Qt
;
12469 unbind_to (count1
, Qnil
);
12471 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12473 /* The variable buffer_shared is set in redisplay_window and
12474 indicates that we redisplay a buffer in different windows. See
12476 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12477 || cursor_type_changed
);
12479 /* If specs for an arrow have changed, do thorough redisplay
12480 to ensure we remove any arrow that should no longer exist. */
12481 if (overlay_arrows_changed_p ())
12482 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12484 /* Normally the message* functions will have already displayed and
12485 updated the echo area, but the frame may have been trashed, or
12486 the update may have been preempted, so display the echo area
12487 again here. Checking message_cleared_p captures the case that
12488 the echo area should be cleared. */
12489 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12490 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12491 || (message_cleared_p
12492 && minibuf_level
== 0
12493 /* If the mini-window is currently selected, this means the
12494 echo-area doesn't show through. */
12495 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12497 int window_height_changed_p
= echo_area_display (0);
12500 /* If we don't display the current message, don't clear the
12501 message_cleared_p flag, because, if we did, we wouldn't clear
12502 the echo area in the next redisplay which doesn't preserve
12504 if (!display_last_displayed_message_p
)
12505 message_cleared_p
= 0;
12507 if (fonts_changed_p
)
12509 else if (window_height_changed_p
)
12511 consider_all_windows_p
= 1;
12512 ++update_mode_lines
;
12513 ++windows_or_buffers_changed
;
12515 /* If window configuration was changed, frames may have been
12516 marked garbaged. Clear them or we will experience
12517 surprises wrt scrolling. */
12518 if (frame_garbaged
)
12519 clear_garbaged_frames ();
12522 else if (EQ (selected_window
, minibuf_window
)
12523 && (current_buffer
->clip_changed
12524 || XFASTINT (w
->last_modified
) < MODIFF
12525 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12526 && resize_mini_window (w
, 0))
12528 /* Resized active mini-window to fit the size of what it is
12529 showing if its contents might have changed. */
12531 /* FIXME: this causes all frames to be updated, which seems unnecessary
12532 since only the current frame needs to be considered. This function needs
12533 to be rewritten with two variables, consider_all_windows and
12534 consider_all_frames. */
12535 consider_all_windows_p
= 1;
12536 ++windows_or_buffers_changed
;
12537 ++update_mode_lines
;
12539 /* If window configuration was changed, frames may have been
12540 marked garbaged. Clear them or we will experience
12541 surprises wrt scrolling. */
12542 if (frame_garbaged
)
12543 clear_garbaged_frames ();
12547 /* If showing the region, and mark has changed, we must redisplay
12548 the whole window. The assignment to this_line_start_pos prevents
12549 the optimization directly below this if-statement. */
12550 if (((!NILP (Vtransient_mark_mode
)
12551 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12552 != !NILP (w
->region_showing
))
12553 || (!NILP (w
->region_showing
)
12554 && !EQ (w
->region_showing
,
12555 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12556 CHARPOS (this_line_start_pos
) = 0;
12558 /* Optimize the case that only the line containing the cursor in the
12559 selected window has changed. Variables starting with this_ are
12560 set in display_line and record information about the line
12561 containing the cursor. */
12562 tlbufpos
= this_line_start_pos
;
12563 tlendpos
= this_line_end_pos
;
12564 if (!consider_all_windows_p
12565 && CHARPOS (tlbufpos
) > 0
12566 && NILP (w
->update_mode_line
)
12567 && !current_buffer
->clip_changed
12568 && !current_buffer
->prevent_redisplay_optimizations_p
12569 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12570 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12571 /* Make sure recorded data applies to current buffer, etc. */
12572 && this_line_buffer
== current_buffer
12573 && current_buffer
== XBUFFER (w
->buffer
)
12574 && NILP (w
->force_start
)
12575 && NILP (w
->optional_new_start
)
12576 /* Point must be on the line that we have info recorded about. */
12577 && PT
>= CHARPOS (tlbufpos
)
12578 && PT
<= Z
- CHARPOS (tlendpos
)
12579 /* All text outside that line, including its final newline,
12580 must be unchanged. */
12581 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12582 CHARPOS (tlendpos
)))
12584 if (CHARPOS (tlbufpos
) > BEGV
12585 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12586 && (CHARPOS (tlbufpos
) == ZV
12587 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12588 /* Former continuation line has disappeared by becoming empty. */
12590 else if (XFASTINT (w
->last_modified
) < MODIFF
12591 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12592 || MINI_WINDOW_P (w
))
12594 /* We have to handle the case of continuation around a
12595 wide-column character (see the comment in indent.c around
12598 For instance, in the following case:
12600 -------- Insert --------
12601 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12602 J_I_ ==> J_I_ `^^' are cursors.
12606 As we have to redraw the line above, we cannot use this
12610 int line_height_before
= this_line_pixel_height
;
12612 /* Note that start_display will handle the case that the
12613 line starting at tlbufpos is a continuation line. */
12614 start_display (&it
, w
, tlbufpos
);
12616 /* Implementation note: It this still necessary? */
12617 if (it
.current_x
!= this_line_start_x
)
12620 TRACE ((stderr
, "trying display optimization 1\n"));
12621 w
->cursor
.vpos
= -1;
12622 overlay_arrow_seen
= 0;
12623 it
.vpos
= this_line_vpos
;
12624 it
.current_y
= this_line_y
;
12625 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12626 display_line (&it
);
12628 /* If line contains point, is not continued,
12629 and ends at same distance from eob as before, we win. */
12630 if (w
->cursor
.vpos
>= 0
12631 /* Line is not continued, otherwise this_line_start_pos
12632 would have been set to 0 in display_line. */
12633 && CHARPOS (this_line_start_pos
)
12634 /* Line ends as before. */
12635 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12636 /* Line has same height as before. Otherwise other lines
12637 would have to be shifted up or down. */
12638 && this_line_pixel_height
== line_height_before
)
12640 /* If this is not the window's last line, we must adjust
12641 the charstarts of the lines below. */
12642 if (it
.current_y
< it
.last_visible_y
)
12644 struct glyph_row
*row
12645 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12646 EMACS_INT delta
, delta_bytes
;
12648 /* We used to distinguish between two cases here,
12649 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12650 when the line ends in a newline or the end of the
12651 buffer's accessible portion. But both cases did
12652 the same, so they were collapsed. */
12654 - CHARPOS (tlendpos
)
12655 - MATRIX_ROW_START_CHARPOS (row
));
12656 delta_bytes
= (Z_BYTE
12657 - BYTEPOS (tlendpos
)
12658 - MATRIX_ROW_START_BYTEPOS (row
));
12660 increment_matrix_positions (w
->current_matrix
,
12661 this_line_vpos
+ 1,
12662 w
->current_matrix
->nrows
,
12663 delta
, delta_bytes
);
12666 /* If this row displays text now but previously didn't,
12667 or vice versa, w->window_end_vpos may have to be
12669 if ((it
.glyph_row
- 1)->displays_text_p
)
12671 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12672 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12674 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12675 && this_line_vpos
> 0)
12676 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12677 w
->window_end_valid
= Qnil
;
12679 /* Update hint: No need to try to scroll in update_window. */
12680 w
->desired_matrix
->no_scrolling_p
= 1;
12683 *w
->desired_matrix
->method
= 0;
12684 debug_method_add (w
, "optimization 1");
12686 #ifdef HAVE_WINDOW_SYSTEM
12687 update_window_fringes (w
, 0);
12694 else if (/* Cursor position hasn't changed. */
12695 PT
== XFASTINT (w
->last_point
)
12696 /* Make sure the cursor was last displayed
12697 in this window. Otherwise we have to reposition it. */
12698 && 0 <= w
->cursor
.vpos
12699 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12703 do_pending_window_change (1);
12704 /* If selected_window changed, redisplay again. */
12705 if (WINDOWP (selected_window
)
12706 && (w
= XWINDOW (selected_window
)) != sw
)
12709 /* We used to always goto end_of_redisplay here, but this
12710 isn't enough if we have a blinking cursor. */
12711 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12712 goto end_of_redisplay
;
12716 /* If highlighting the region, or if the cursor is in the echo area,
12717 then we can't just move the cursor. */
12718 else if (! (!NILP (Vtransient_mark_mode
)
12719 && !NILP (BVAR (current_buffer
, mark_active
)))
12720 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12721 || highlight_nonselected_windows
)
12722 && NILP (w
->region_showing
)
12723 && NILP (Vshow_trailing_whitespace
)
12724 && !cursor_in_echo_area
)
12727 struct glyph_row
*row
;
12729 /* Skip from tlbufpos to PT and see where it is. Note that
12730 PT may be in invisible text. If so, we will end at the
12731 next visible position. */
12732 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12733 NULL
, DEFAULT_FACE_ID
);
12734 it
.current_x
= this_line_start_x
;
12735 it
.current_y
= this_line_y
;
12736 it
.vpos
= this_line_vpos
;
12738 /* The call to move_it_to stops in front of PT, but
12739 moves over before-strings. */
12740 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12742 if (it
.vpos
== this_line_vpos
12743 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12746 xassert (this_line_vpos
== it
.vpos
);
12747 xassert (this_line_y
== it
.current_y
);
12748 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12750 *w
->desired_matrix
->method
= 0;
12751 debug_method_add (w
, "optimization 3");
12760 /* Text changed drastically or point moved off of line. */
12761 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12764 CHARPOS (this_line_start_pos
) = 0;
12765 consider_all_windows_p
|= buffer_shared
> 1;
12766 ++clear_face_cache_count
;
12767 #ifdef HAVE_WINDOW_SYSTEM
12768 ++clear_image_cache_count
;
12771 /* Build desired matrices, and update the display. If
12772 consider_all_windows_p is non-zero, do it for all windows on all
12773 frames. Otherwise do it for selected_window, only. */
12775 if (consider_all_windows_p
)
12777 Lisp_Object tail
, frame
;
12779 FOR_EACH_FRAME (tail
, frame
)
12780 XFRAME (frame
)->updated_p
= 0;
12782 /* Recompute # windows showing selected buffer. This will be
12783 incremented each time such a window is displayed. */
12786 FOR_EACH_FRAME (tail
, frame
)
12788 struct frame
*f
= XFRAME (frame
);
12790 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12792 if (! EQ (frame
, selected_frame
))
12793 /* Select the frame, for the sake of frame-local
12795 select_frame_for_redisplay (frame
);
12797 /* Mark all the scroll bars to be removed; we'll redeem
12798 the ones we want when we redisplay their windows. */
12799 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12800 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12802 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12803 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12805 /* The X error handler may have deleted that frame. */
12806 if (!FRAME_LIVE_P (f
))
12809 /* Any scroll bars which redisplay_windows should have
12810 nuked should now go away. */
12811 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12812 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12814 /* If fonts changed, display again. */
12815 /* ??? rms: I suspect it is a mistake to jump all the way
12816 back to retry here. It should just retry this frame. */
12817 if (fonts_changed_p
)
12820 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12822 /* See if we have to hscroll. */
12823 if (!f
->already_hscrolled_p
)
12825 f
->already_hscrolled_p
= 1;
12826 if (hscroll_windows (f
->root_window
))
12830 /* Prevent various kinds of signals during display
12831 update. stdio is not robust about handling
12832 signals, which can cause an apparent I/O
12834 if (interrupt_input
)
12835 unrequest_sigio ();
12838 /* Update the display. */
12839 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12840 pending
|= update_frame (f
, 0, 0);
12846 if (!EQ (old_frame
, selected_frame
)
12847 && FRAME_LIVE_P (XFRAME (old_frame
)))
12848 /* We played a bit fast-and-loose above and allowed selected_frame
12849 and selected_window to be temporarily out-of-sync but let's make
12850 sure this stays contained. */
12851 select_frame_for_redisplay (old_frame
);
12852 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12856 /* Do the mark_window_display_accurate after all windows have
12857 been redisplayed because this call resets flags in buffers
12858 which are needed for proper redisplay. */
12859 FOR_EACH_FRAME (tail
, frame
)
12861 struct frame
*f
= XFRAME (frame
);
12864 mark_window_display_accurate (f
->root_window
, 1);
12865 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12866 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12871 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12873 Lisp_Object mini_window
;
12874 struct frame
*mini_frame
;
12876 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12877 /* Use list_of_error, not Qerror, so that
12878 we catch only errors and don't run the debugger. */
12879 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12881 redisplay_window_error
);
12883 /* Compare desired and current matrices, perform output. */
12886 /* If fonts changed, display again. */
12887 if (fonts_changed_p
)
12890 /* Prevent various kinds of signals during display update.
12891 stdio is not robust about handling signals,
12892 which can cause an apparent I/O error. */
12893 if (interrupt_input
)
12894 unrequest_sigio ();
12897 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12899 if (hscroll_windows (selected_window
))
12902 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12903 pending
= update_frame (sf
, 0, 0);
12906 /* We may have called echo_area_display at the top of this
12907 function. If the echo area is on another frame, that may
12908 have put text on a frame other than the selected one, so the
12909 above call to update_frame would not have caught it. Catch
12911 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12912 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12914 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12916 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12917 pending
|= update_frame (mini_frame
, 0, 0);
12918 if (!pending
&& hscroll_windows (mini_window
))
12923 /* If display was paused because of pending input, make sure we do a
12924 thorough update the next time. */
12927 /* Prevent the optimization at the beginning of
12928 redisplay_internal that tries a single-line update of the
12929 line containing the cursor in the selected window. */
12930 CHARPOS (this_line_start_pos
) = 0;
12932 /* Let the overlay arrow be updated the next time. */
12933 update_overlay_arrows (0);
12935 /* If we pause after scrolling, some rows in the current
12936 matrices of some windows are not valid. */
12937 if (!WINDOW_FULL_WIDTH_P (w
)
12938 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12939 update_mode_lines
= 1;
12943 if (!consider_all_windows_p
)
12945 /* This has already been done above if
12946 consider_all_windows_p is set. */
12947 mark_window_display_accurate_1 (w
, 1);
12949 /* Say overlay arrows are up to date. */
12950 update_overlay_arrows (1);
12952 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12953 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12956 update_mode_lines
= 0;
12957 windows_or_buffers_changed
= 0;
12958 cursor_type_changed
= 0;
12961 /* Start SIGIO interrupts coming again. Having them off during the
12962 code above makes it less likely one will discard output, but not
12963 impossible, since there might be stuff in the system buffer here.
12964 But it is much hairier to try to do anything about that. */
12965 if (interrupt_input
)
12969 /* If a frame has become visible which was not before, redisplay
12970 again, so that we display it. Expose events for such a frame
12971 (which it gets when becoming visible) don't call the parts of
12972 redisplay constructing glyphs, so simply exposing a frame won't
12973 display anything in this case. So, we have to display these
12974 frames here explicitly. */
12977 Lisp_Object tail
, frame
;
12980 FOR_EACH_FRAME (tail
, frame
)
12982 int this_is_visible
= 0;
12984 if (XFRAME (frame
)->visible
)
12985 this_is_visible
= 1;
12986 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12987 if (XFRAME (frame
)->visible
)
12988 this_is_visible
= 1;
12990 if (this_is_visible
)
12994 if (new_count
!= number_of_visible_frames
)
12995 windows_or_buffers_changed
++;
12998 /* Change frame size now if a change is pending. */
12999 do_pending_window_change (1);
13001 /* If we just did a pending size change, or have additional
13002 visible frames, or selected_window changed, redisplay again. */
13003 if ((windows_or_buffers_changed
&& !pending
)
13004 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13007 /* Clear the face and image caches.
13009 We used to do this only if consider_all_windows_p. But the cache
13010 needs to be cleared if a timer creates images in the current
13011 buffer (e.g. the test case in Bug#6230). */
13013 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13015 clear_face_cache (0);
13016 clear_face_cache_count
= 0;
13019 #ifdef HAVE_WINDOW_SYSTEM
13020 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13022 clear_image_caches (Qnil
);
13023 clear_image_cache_count
= 0;
13025 #endif /* HAVE_WINDOW_SYSTEM */
13028 unbind_to (count
, Qnil
);
13033 /* Redisplay, but leave alone any recent echo area message unless
13034 another message has been requested in its place.
13036 This is useful in situations where you need to redisplay but no
13037 user action has occurred, making it inappropriate for the message
13038 area to be cleared. See tracking_off and
13039 wait_reading_process_output for examples of these situations.
13041 FROM_WHERE is an integer saying from where this function was
13042 called. This is useful for debugging. */
13045 redisplay_preserve_echo_area (int from_where
)
13047 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13049 if (!NILP (echo_area_buffer
[1]))
13051 /* We have a previously displayed message, but no current
13052 message. Redisplay the previous message. */
13053 display_last_displayed_message_p
= 1;
13054 redisplay_internal ();
13055 display_last_displayed_message_p
= 0;
13058 redisplay_internal ();
13060 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13061 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13062 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13066 /* Function registered with record_unwind_protect in
13067 redisplay_internal. Reset redisplaying_p to the value it had
13068 before redisplay_internal was called, and clear
13069 prevent_freeing_realized_faces_p. It also selects the previously
13070 selected frame, unless it has been deleted (by an X connection
13071 failure during redisplay, for example). */
13074 unwind_redisplay (Lisp_Object val
)
13076 Lisp_Object old_redisplaying_p
, old_frame
;
13078 old_redisplaying_p
= XCAR (val
);
13079 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13080 old_frame
= XCDR (val
);
13081 if (! EQ (old_frame
, selected_frame
)
13082 && FRAME_LIVE_P (XFRAME (old_frame
)))
13083 select_frame_for_redisplay (old_frame
);
13088 /* Mark the display of window W as accurate or inaccurate. If
13089 ACCURATE_P is non-zero mark display of W as accurate. If
13090 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13091 redisplay_internal is called. */
13094 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13096 if (BUFFERP (w
->buffer
))
13098 struct buffer
*b
= XBUFFER (w
->buffer
);
13101 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13102 w
->last_overlay_modified
13103 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13105 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13109 b
->clip_changed
= 0;
13110 b
->prevent_redisplay_optimizations_p
= 0;
13112 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13113 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13114 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13115 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13117 w
->current_matrix
->buffer
= b
;
13118 w
->current_matrix
->begv
= BUF_BEGV (b
);
13119 w
->current_matrix
->zv
= BUF_ZV (b
);
13121 w
->last_cursor
= w
->cursor
;
13122 w
->last_cursor_off_p
= w
->cursor_off_p
;
13124 if (w
== XWINDOW (selected_window
))
13125 w
->last_point
= make_number (BUF_PT (b
));
13127 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13133 w
->window_end_valid
= w
->buffer
;
13134 w
->update_mode_line
= Qnil
;
13139 /* Mark the display of windows in the window tree rooted at WINDOW as
13140 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13141 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13142 be redisplayed the next time redisplay_internal is called. */
13145 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13149 for (; !NILP (window
); window
= w
->next
)
13151 w
= XWINDOW (window
);
13152 mark_window_display_accurate_1 (w
, accurate_p
);
13154 if (!NILP (w
->vchild
))
13155 mark_window_display_accurate (w
->vchild
, accurate_p
);
13156 if (!NILP (w
->hchild
))
13157 mark_window_display_accurate (w
->hchild
, accurate_p
);
13162 update_overlay_arrows (1);
13166 /* Force a thorough redisplay the next time by setting
13167 last_arrow_position and last_arrow_string to t, which is
13168 unequal to any useful value of Voverlay_arrow_... */
13169 update_overlay_arrows (-1);
13174 /* Return value in display table DP (Lisp_Char_Table *) for character
13175 C. Since a display table doesn't have any parent, we don't have to
13176 follow parent. Do not call this function directly but use the
13177 macro DISP_CHAR_VECTOR. */
13180 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13184 if (ASCII_CHAR_P (c
))
13187 if (SUB_CHAR_TABLE_P (val
))
13188 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13194 XSETCHAR_TABLE (table
, dp
);
13195 val
= char_table_ref (table
, c
);
13204 /***********************************************************************
13206 ***********************************************************************/
13208 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13211 redisplay_windows (Lisp_Object window
)
13213 while (!NILP (window
))
13215 struct window
*w
= XWINDOW (window
);
13217 if (!NILP (w
->hchild
))
13218 redisplay_windows (w
->hchild
);
13219 else if (!NILP (w
->vchild
))
13220 redisplay_windows (w
->vchild
);
13221 else if (!NILP (w
->buffer
))
13223 displayed_buffer
= XBUFFER (w
->buffer
);
13224 /* Use list_of_error, not Qerror, so that
13225 we catch only errors and don't run the debugger. */
13226 internal_condition_case_1 (redisplay_window_0
, window
,
13228 redisplay_window_error
);
13236 redisplay_window_error (Lisp_Object ignore
)
13238 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13243 redisplay_window_0 (Lisp_Object window
)
13245 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13246 redisplay_window (window
, 0);
13251 redisplay_window_1 (Lisp_Object window
)
13253 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13254 redisplay_window (window
, 1);
13259 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13260 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13261 which positions recorded in ROW differ from current buffer
13264 Return 0 if cursor is not on this row, 1 otherwise. */
13267 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13268 struct glyph_matrix
*matrix
,
13269 EMACS_INT delta
, EMACS_INT delta_bytes
,
13272 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13273 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13274 struct glyph
*cursor
= NULL
;
13275 /* The last known character position in row. */
13276 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13278 EMACS_INT pt_old
= PT
- delta
;
13279 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13280 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13281 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13282 /* A glyph beyond the edge of TEXT_AREA which we should never
13284 struct glyph
*glyphs_end
= end
;
13285 /* Non-zero means we've found a match for cursor position, but that
13286 glyph has the avoid_cursor_p flag set. */
13287 int match_with_avoid_cursor
= 0;
13288 /* Non-zero means we've seen at least one glyph that came from a
13290 int string_seen
= 0;
13291 /* Largest and smalles buffer positions seen so far during scan of
13293 EMACS_INT bpos_max
= pos_before
;
13294 EMACS_INT bpos_min
= pos_after
;
13295 /* Last buffer position covered by an overlay string with an integer
13296 `cursor' property. */
13297 EMACS_INT bpos_covered
= 0;
13299 /* Skip over glyphs not having an object at the start and the end of
13300 the row. These are special glyphs like truncation marks on
13301 terminal frames. */
13302 if (row
->displays_text_p
)
13304 if (!row
->reversed_p
)
13307 && INTEGERP (glyph
->object
)
13308 && glyph
->charpos
< 0)
13310 x
+= glyph
->pixel_width
;
13314 && INTEGERP ((end
- 1)->object
)
13315 /* CHARPOS is zero for blanks and stretch glyphs
13316 inserted by extend_face_to_end_of_line. */
13317 && (end
- 1)->charpos
<= 0)
13319 glyph_before
= glyph
- 1;
13326 /* If the glyph row is reversed, we need to process it from back
13327 to front, so swap the edge pointers. */
13328 glyphs_end
= end
= glyph
- 1;
13329 glyph
+= row
->used
[TEXT_AREA
] - 1;
13331 while (glyph
> end
+ 1
13332 && INTEGERP (glyph
->object
)
13333 && glyph
->charpos
< 0)
13336 x
-= glyph
->pixel_width
;
13338 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13340 /* By default, in reversed rows we put the cursor on the
13341 rightmost (first in the reading order) glyph. */
13342 for (g
= end
+ 1; g
< glyph
; g
++)
13343 x
+= g
->pixel_width
;
13345 && INTEGERP ((end
+ 1)->object
)
13346 && (end
+ 1)->charpos
<= 0)
13348 glyph_before
= glyph
+ 1;
13352 else if (row
->reversed_p
)
13354 /* In R2L rows that don't display text, put the cursor on the
13355 rightmost glyph. Case in point: an empty last line that is
13356 part of an R2L paragraph. */
13358 /* Avoid placing the cursor on the last glyph of the row, where
13359 on terminal frames we hold the vertical border between
13360 adjacent windows. */
13361 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13362 && !WINDOW_RIGHTMOST_P (w
)
13363 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13365 x
= -1; /* will be computed below, at label compute_x */
13368 /* Step 1: Try to find the glyph whose character position
13369 corresponds to point. If that's not possible, find 2 glyphs
13370 whose character positions are the closest to point, one before
13371 point, the other after it. */
13372 if (!row
->reversed_p
)
13373 while (/* not marched to end of glyph row */
13375 /* glyph was not inserted by redisplay for internal purposes */
13376 && !INTEGERP (glyph
->object
))
13378 if (BUFFERP (glyph
->object
))
13380 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13382 if (glyph
->charpos
> bpos_max
)
13383 bpos_max
= glyph
->charpos
;
13384 if (glyph
->charpos
< bpos_min
)
13385 bpos_min
= glyph
->charpos
;
13386 if (!glyph
->avoid_cursor_p
)
13388 /* If we hit point, we've found the glyph on which to
13389 display the cursor. */
13392 match_with_avoid_cursor
= 0;
13395 /* See if we've found a better approximation to
13396 POS_BEFORE or to POS_AFTER. Note that we want the
13397 first (leftmost) glyph of all those that are the
13398 closest from below, and the last (rightmost) of all
13399 those from above. */
13400 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13402 pos_before
= glyph
->charpos
;
13403 glyph_before
= glyph
;
13405 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13407 pos_after
= glyph
->charpos
;
13408 glyph_after
= glyph
;
13411 else if (dpos
== 0)
13412 match_with_avoid_cursor
= 1;
13414 else if (STRINGP (glyph
->object
))
13416 Lisp_Object chprop
;
13417 EMACS_INT glyph_pos
= glyph
->charpos
;
13419 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13421 if (INTEGERP (chprop
))
13423 bpos_covered
= bpos_max
+ XINT (chprop
);
13424 /* If the `cursor' property covers buffer positions up
13425 to and including point, we should display cursor on
13426 this glyph. Note that overlays and text properties
13427 with string values stop bidi reordering, so every
13428 buffer position to the left of the string is always
13429 smaller than any position to the right of the
13430 string. Therefore, if a `cursor' property on one
13431 of the string's characters has an integer value, we
13432 will break out of the loop below _before_ we get to
13433 the position match above. IOW, integer values of
13434 the `cursor' property override the "exact match for
13435 point" strategy of positioning the cursor. */
13436 /* Implementation note: bpos_max == pt_old when, e.g.,
13437 we are in an empty line, where bpos_max is set to
13438 MATRIX_ROW_START_CHARPOS, see above. */
13439 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13448 x
+= glyph
->pixel_width
;
13451 else if (glyph
> end
) /* row is reversed */
13452 while (!INTEGERP (glyph
->object
))
13454 if (BUFFERP (glyph
->object
))
13456 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13458 if (glyph
->charpos
> bpos_max
)
13459 bpos_max
= glyph
->charpos
;
13460 if (glyph
->charpos
< bpos_min
)
13461 bpos_min
= glyph
->charpos
;
13462 if (!glyph
->avoid_cursor_p
)
13466 match_with_avoid_cursor
= 0;
13469 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13471 pos_before
= glyph
->charpos
;
13472 glyph_before
= glyph
;
13474 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13476 pos_after
= glyph
->charpos
;
13477 glyph_after
= glyph
;
13480 else if (dpos
== 0)
13481 match_with_avoid_cursor
= 1;
13483 else if (STRINGP (glyph
->object
))
13485 Lisp_Object chprop
;
13486 EMACS_INT glyph_pos
= glyph
->charpos
;
13488 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13490 if (INTEGERP (chprop
))
13492 bpos_covered
= bpos_max
+ XINT (chprop
);
13493 /* If the `cursor' property covers buffer positions up
13494 to and including point, we should display cursor on
13496 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13505 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13507 x
--; /* can't use any pixel_width */
13510 x
-= glyph
->pixel_width
;
13513 /* Step 2: If we didn't find an exact match for point, we need to
13514 look for a proper place to put the cursor among glyphs between
13515 GLYPH_BEFORE and GLYPH_AFTER. */
13516 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13517 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13518 && bpos_covered
< pt_old
)
13520 /* An empty line has a single glyph whose OBJECT is zero and
13521 whose CHARPOS is the position of a newline on that line.
13522 Note that on a TTY, there are more glyphs after that, which
13523 were produced by extend_face_to_end_of_line, but their
13524 CHARPOS is zero or negative. */
13526 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13527 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13529 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13531 EMACS_INT ellipsis_pos
;
13533 /* Scan back over the ellipsis glyphs. */
13534 if (!row
->reversed_p
)
13536 ellipsis_pos
= (glyph
- 1)->charpos
;
13537 while (glyph
> row
->glyphs
[TEXT_AREA
]
13538 && (glyph
- 1)->charpos
== ellipsis_pos
)
13539 glyph
--, x
-= glyph
->pixel_width
;
13540 /* That loop always goes one position too far, including
13541 the glyph before the ellipsis. So scan forward over
13543 x
+= glyph
->pixel_width
;
13546 else /* row is reversed */
13548 ellipsis_pos
= (glyph
+ 1)->charpos
;
13549 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13550 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13551 glyph
++, x
+= glyph
->pixel_width
;
13552 x
-= glyph
->pixel_width
;
13556 else if (match_with_avoid_cursor
13557 /* A truncated row may not include PT among its
13558 character positions. Setting the cursor inside the
13559 scroll margin will trigger recalculation of hscroll
13560 in hscroll_window_tree. */
13561 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13562 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13563 /* Zero-width characters produce no glyphs. */
13566 && (row
->reversed_p
13567 ? glyph_after
> glyphs_end
13568 : glyph_after
< glyphs_end
)))
13570 cursor
= glyph_after
;
13573 else if (string_seen
)
13575 int incr
= row
->reversed_p
? -1 : +1;
13577 /* Need to find the glyph that came out of a string which is
13578 present at point. That glyph is somewhere between
13579 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13580 positioned between POS_BEFORE and POS_AFTER in the
13582 struct glyph
*start
, *stop
;
13583 EMACS_INT pos
= pos_before
;
13587 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13588 correspond to POS_BEFORE and POS_AFTER, respectively. We
13589 need START and STOP in the order that corresponds to the
13590 row's direction as given by its reversed_p flag. If the
13591 directionality of characters between POS_BEFORE and
13592 POS_AFTER is the opposite of the row's base direction,
13593 these characters will have been reordered for display,
13594 and we need to reverse START and STOP. */
13595 if (!row
->reversed_p
)
13597 start
= min (glyph_before
, glyph_after
);
13598 stop
= max (glyph_before
, glyph_after
);
13602 start
= max (glyph_before
, glyph_after
);
13603 stop
= min (glyph_before
, glyph_after
);
13605 for (glyph
= start
+ incr
;
13606 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13609 /* Any glyphs that come from the buffer are here because
13610 of bidi reordering. Skip them, and only pay
13611 attention to glyphs that came from some string. */
13612 if (STRINGP (glyph
->object
))
13617 str
= glyph
->object
;
13618 tem
= string_buffer_position_lim (str
, pos
, pos_after
, 0);
13619 if (tem
== 0 /* from overlay */
13622 /* If the string from which this glyph came is
13623 found in the buffer at point, then we've
13624 found the glyph we've been looking for. If
13625 it comes from an overlay (tem == 0), and it
13626 has the `cursor' property on one of its
13627 glyphs, record that glyph as a candidate for
13628 displaying the cursor. (As in the
13629 unidirectional version, we will display the
13630 cursor on the last candidate we find.) */
13631 if (tem
== 0 || tem
== pt_old
)
13633 /* The glyphs from this string could have
13634 been reordered. Find the one with the
13635 smallest string position. Or there could
13636 be a character in the string with the
13637 `cursor' property, which means display
13638 cursor on that character's glyph. */
13639 EMACS_INT strpos
= glyph
->charpos
;
13644 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13645 && EQ (glyph
->object
, str
);
13649 EMACS_INT gpos
= glyph
->charpos
;
13651 cprop
= Fget_char_property (make_number (gpos
),
13659 if (tem
&& glyph
->charpos
< strpos
)
13661 strpos
= glyph
->charpos
;
13670 pos
= tem
+ 1; /* don't find previous instances */
13672 /* This string is not what we want; skip all of the
13673 glyphs that came from it. */
13674 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13675 && EQ (glyph
->object
, str
))
13682 /* If we reached the end of the line, and END was from a string,
13683 the cursor is not on this line. */
13685 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13686 && STRINGP (end
->object
)
13687 && row
->continued_p
)
13693 if (cursor
!= NULL
)
13699 /* Need to compute x that corresponds to GLYPH. */
13700 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13702 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13704 x
+= g
->pixel_width
;
13708 /* ROW could be part of a continued line, which, under bidi
13709 reordering, might have other rows whose start and end charpos
13710 occlude point. Only set w->cursor if we found a better
13711 approximation to the cursor position than we have from previously
13712 examined candidate rows belonging to the same continued line. */
13713 if (/* we already have a candidate row */
13714 w
->cursor
.vpos
>= 0
13715 /* that candidate is not the row we are processing */
13716 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13717 /* the row we are processing is part of a continued line */
13718 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13719 /* Make sure cursor.vpos specifies a row whose start and end
13720 charpos occlude point. This is because some callers of this
13721 function leave cursor.vpos at the row where the cursor was
13722 displayed during the last redisplay cycle. */
13723 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13724 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13727 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13729 /* Don't consider glyphs that are outside TEXT_AREA. */
13730 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13732 /* Keep the candidate whose buffer position is the closest to
13734 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13735 w
->cursor
.hpos
>= 0
13736 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13737 && BUFFERP (g1
->object
)
13738 && (g1
->charpos
== pt_old
/* an exact match always wins */
13739 || (BUFFERP (glyph
->object
)
13740 && eabs (g1
->charpos
- pt_old
)
13741 < eabs (glyph
->charpos
- pt_old
))))
13743 /* If this candidate gives an exact match, use that. */
13744 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13745 /* Otherwise, keep the candidate that comes from a row
13746 spanning less buffer positions. This may win when one or
13747 both candidate positions are on glyphs that came from
13748 display strings, for which we cannot compare buffer
13750 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13751 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13752 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13755 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13757 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13758 w
->cursor
.y
= row
->y
+ dy
;
13760 if (w
== XWINDOW (selected_window
))
13762 if (!row
->continued_p
13763 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13766 this_line_buffer
= XBUFFER (w
->buffer
);
13768 CHARPOS (this_line_start_pos
)
13769 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13770 BYTEPOS (this_line_start_pos
)
13771 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13773 CHARPOS (this_line_end_pos
)
13774 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13775 BYTEPOS (this_line_end_pos
)
13776 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13778 this_line_y
= w
->cursor
.y
;
13779 this_line_pixel_height
= row
->height
;
13780 this_line_vpos
= w
->cursor
.vpos
;
13781 this_line_start_x
= row
->x
;
13784 CHARPOS (this_line_start_pos
) = 0;
13791 /* Run window scroll functions, if any, for WINDOW with new window
13792 start STARTP. Sets the window start of WINDOW to that position.
13794 We assume that the window's buffer is really current. */
13796 static inline struct text_pos
13797 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13799 struct window
*w
= XWINDOW (window
);
13800 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13802 if (current_buffer
!= XBUFFER (w
->buffer
))
13805 if (!NILP (Vwindow_scroll_functions
))
13807 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13808 make_number (CHARPOS (startp
)));
13809 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13810 /* In case the hook functions switch buffers. */
13811 if (current_buffer
!= XBUFFER (w
->buffer
))
13812 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13819 /* Make sure the line containing the cursor is fully visible.
13820 A value of 1 means there is nothing to be done.
13821 (Either the line is fully visible, or it cannot be made so,
13822 or we cannot tell.)
13824 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13825 is higher than window.
13827 A value of 0 means the caller should do scrolling
13828 as if point had gone off the screen. */
13831 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13833 struct glyph_matrix
*matrix
;
13834 struct glyph_row
*row
;
13837 if (!make_cursor_line_fully_visible_p
)
13840 /* It's not always possible to find the cursor, e.g, when a window
13841 is full of overlay strings. Don't do anything in that case. */
13842 if (w
->cursor
.vpos
< 0)
13845 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13846 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13848 /* If the cursor row is not partially visible, there's nothing to do. */
13849 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13852 /* If the row the cursor is in is taller than the window's height,
13853 it's not clear what to do, so do nothing. */
13854 window_height
= window_box_height (w
);
13855 if (row
->height
>= window_height
)
13857 if (!force_p
|| MINI_WINDOW_P (w
)
13858 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13865 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13866 non-zero means only WINDOW is redisplayed in redisplay_internal.
13867 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13868 in redisplay_window to bring a partially visible line into view in
13869 the case that only the cursor has moved.
13871 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13872 last screen line's vertical height extends past the end of the screen.
13876 1 if scrolling succeeded
13878 0 if scrolling didn't find point.
13880 -1 if new fonts have been loaded so that we must interrupt
13881 redisplay, adjust glyph matrices, and try again. */
13887 SCROLLING_NEED_LARGER_MATRICES
13890 /* If scroll-conservatively is more than this, never recenter.
13892 If you change this, don't forget to update the doc string of
13893 `scroll-conservatively' and the Emacs manual. */
13894 #define SCROLL_LIMIT 100
13897 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13898 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13899 int temp_scroll_step
, int last_line_misfit
)
13901 struct window
*w
= XWINDOW (window
);
13902 struct frame
*f
= XFRAME (w
->frame
);
13903 struct text_pos pos
, startp
;
13905 int this_scroll_margin
, scroll_max
, rc
, height
;
13906 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13907 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13908 Lisp_Object aggressive
;
13909 /* We will never try scrolling more than this number of lines. */
13910 int scroll_limit
= SCROLL_LIMIT
;
13913 debug_method_add (w
, "try_scrolling");
13916 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13918 /* Compute scroll margin height in pixels. We scroll when point is
13919 within this distance from the top or bottom of the window. */
13920 if (scroll_margin
> 0)
13921 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13922 * FRAME_LINE_HEIGHT (f
);
13924 this_scroll_margin
= 0;
13926 /* Force arg_scroll_conservatively to have a reasonable value, to
13927 avoid scrolling too far away with slow move_it_* functions. Note
13928 that the user can supply scroll-conservatively equal to
13929 `most-positive-fixnum', which can be larger than INT_MAX. */
13930 if (arg_scroll_conservatively
> scroll_limit
)
13932 arg_scroll_conservatively
= scroll_limit
+ 1;
13933 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13935 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13936 /* Compute how much we should try to scroll maximally to bring
13937 point into view. */
13938 scroll_max
= (max (scroll_step
,
13939 max (arg_scroll_conservatively
, temp_scroll_step
))
13940 * FRAME_LINE_HEIGHT (f
));
13941 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13942 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13943 /* We're trying to scroll because of aggressive scrolling but no
13944 scroll_step is set. Choose an arbitrary one. */
13945 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13951 /* Decide whether to scroll down. */
13952 if (PT
> CHARPOS (startp
))
13954 int scroll_margin_y
;
13956 /* Compute the pixel ypos of the scroll margin, then move it to
13957 either that ypos or PT, whichever comes first. */
13958 start_display (&it
, w
, startp
);
13959 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13960 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13961 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13962 (MOVE_TO_POS
| MOVE_TO_Y
));
13964 if (PT
> CHARPOS (it
.current
.pos
))
13966 int y0
= line_bottom_y (&it
);
13967 /* Compute how many pixels below window bottom to stop searching
13968 for PT. This avoids costly search for PT that is far away if
13969 the user limited scrolling by a small number of lines, but
13970 always finds PT if scroll_conservatively is set to a large
13971 number, such as most-positive-fixnum. */
13972 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13973 int y_to_move
= it
.last_visible_y
+ slack
;
13975 /* Compute the distance from the scroll margin to PT or to
13976 the scroll limit, whichever comes first. This should
13977 include the height of the cursor line, to make that line
13979 move_it_to (&it
, PT
, -1, y_to_move
,
13980 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13981 dy
= line_bottom_y (&it
) - y0
;
13983 if (dy
> scroll_max
)
13984 return SCROLLING_FAILED
;
13992 /* Point is in or below the bottom scroll margin, so move the
13993 window start down. If scrolling conservatively, move it just
13994 enough down to make point visible. If scroll_step is set,
13995 move it down by scroll_step. */
13996 if (arg_scroll_conservatively
)
13998 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13999 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14000 else if (scroll_step
|| temp_scroll_step
)
14001 amount_to_scroll
= scroll_max
;
14004 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14005 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14006 if (NUMBERP (aggressive
))
14008 double float_amount
= XFLOATINT (aggressive
) * height
;
14009 amount_to_scroll
= float_amount
;
14010 if (amount_to_scroll
== 0 && float_amount
> 0)
14011 amount_to_scroll
= 1;
14012 /* Don't let point enter the scroll margin near top of
14014 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14015 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14019 if (amount_to_scroll
<= 0)
14020 return SCROLLING_FAILED
;
14022 start_display (&it
, w
, startp
);
14023 if (arg_scroll_conservatively
<= scroll_limit
)
14024 move_it_vertically (&it
, amount_to_scroll
);
14027 /* Extra precision for users who set scroll-conservatively
14028 to a large number: make sure the amount we scroll
14029 the window start is never less than amount_to_scroll,
14030 which was computed as distance from window bottom to
14031 point. This matters when lines at window top and lines
14032 below window bottom have different height. */
14034 void *it1data
= NULL
;
14035 /* We use a temporary it1 because line_bottom_y can modify
14036 its argument, if it moves one line down; see there. */
14039 SAVE_IT (it1
, it
, it1data
);
14040 start_y
= line_bottom_y (&it1
);
14042 RESTORE_IT (&it
, &it
, it1data
);
14043 move_it_by_lines (&it
, 1);
14044 SAVE_IT (it1
, it
, it1data
);
14045 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14048 /* If STARTP is unchanged, move it down another screen line. */
14049 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14050 move_it_by_lines (&it
, 1);
14051 startp
= it
.current
.pos
;
14055 struct text_pos scroll_margin_pos
= startp
;
14057 /* See if point is inside the scroll margin at the top of the
14059 if (this_scroll_margin
)
14061 start_display (&it
, w
, startp
);
14062 move_it_vertically (&it
, this_scroll_margin
);
14063 scroll_margin_pos
= it
.current
.pos
;
14066 if (PT
< CHARPOS (scroll_margin_pos
))
14068 /* Point is in the scroll margin at the top of the window or
14069 above what is displayed in the window. */
14072 /* Compute the vertical distance from PT to the scroll
14073 margin position. Move as far as scroll_max allows, or
14074 one screenful, or 10 screen lines, whichever is largest.
14075 Give up if distance is greater than scroll_max. */
14076 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14077 start_display (&it
, w
, pos
);
14079 y_to_move
= max (it
.last_visible_y
,
14080 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14081 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14083 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14084 dy
= it
.current_y
- y0
;
14085 if (dy
> scroll_max
)
14086 return SCROLLING_FAILED
;
14088 /* Compute new window start. */
14089 start_display (&it
, w
, startp
);
14091 if (arg_scroll_conservatively
)
14092 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14093 max (scroll_step
, temp_scroll_step
));
14094 else if (scroll_step
|| temp_scroll_step
)
14095 amount_to_scroll
= scroll_max
;
14098 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14099 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14100 if (NUMBERP (aggressive
))
14102 double float_amount
= XFLOATINT (aggressive
) * height
;
14103 amount_to_scroll
= float_amount
;
14104 if (amount_to_scroll
== 0 && float_amount
> 0)
14105 amount_to_scroll
= 1;
14106 amount_to_scroll
-=
14107 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14108 /* Don't let point enter the scroll margin near
14109 bottom of the window. */
14110 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14111 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14115 if (amount_to_scroll
<= 0)
14116 return SCROLLING_FAILED
;
14118 move_it_vertically_backward (&it
, amount_to_scroll
);
14119 startp
= it
.current
.pos
;
14123 /* Run window scroll functions. */
14124 startp
= run_window_scroll_functions (window
, startp
);
14126 /* Display the window. Give up if new fonts are loaded, or if point
14128 if (!try_window (window
, startp
, 0))
14129 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14130 else if (w
->cursor
.vpos
< 0)
14132 clear_glyph_matrix (w
->desired_matrix
);
14133 rc
= SCROLLING_FAILED
;
14137 /* Maybe forget recorded base line for line number display. */
14138 if (!just_this_one_p
14139 || current_buffer
->clip_changed
14140 || BEG_UNCHANGED
< CHARPOS (startp
))
14141 w
->base_line_number
= Qnil
;
14143 /* If cursor ends up on a partially visible line,
14144 treat that as being off the bottom of the screen. */
14145 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14146 /* It's possible that the cursor is on the first line of the
14147 buffer, which is partially obscured due to a vscroll
14148 (Bug#7537). In that case, avoid looping forever . */
14149 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14151 clear_glyph_matrix (w
->desired_matrix
);
14152 ++extra_scroll_margin_lines
;
14155 rc
= SCROLLING_SUCCESS
;
14162 /* Compute a suitable window start for window W if display of W starts
14163 on a continuation line. Value is non-zero if a new window start
14166 The new window start will be computed, based on W's width, starting
14167 from the start of the continued line. It is the start of the
14168 screen line with the minimum distance from the old start W->start. */
14171 compute_window_start_on_continuation_line (struct window
*w
)
14173 struct text_pos pos
, start_pos
;
14174 int window_start_changed_p
= 0;
14176 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14178 /* If window start is on a continuation line... Window start may be
14179 < BEGV in case there's invisible text at the start of the
14180 buffer (M-x rmail, for example). */
14181 if (CHARPOS (start_pos
) > BEGV
14182 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14185 struct glyph_row
*row
;
14187 /* Handle the case that the window start is out of range. */
14188 if (CHARPOS (start_pos
) < BEGV
)
14189 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14190 else if (CHARPOS (start_pos
) > ZV
)
14191 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14193 /* Find the start of the continued line. This should be fast
14194 because scan_buffer is fast (newline cache). */
14195 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14196 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14197 row
, DEFAULT_FACE_ID
);
14198 reseat_at_previous_visible_line_start (&it
);
14200 /* If the line start is "too far" away from the window start,
14201 say it takes too much time to compute a new window start. */
14202 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14203 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14205 int min_distance
, distance
;
14207 /* Move forward by display lines to find the new window
14208 start. If window width was enlarged, the new start can
14209 be expected to be > the old start. If window width was
14210 decreased, the new window start will be < the old start.
14211 So, we're looking for the display line start with the
14212 minimum distance from the old window start. */
14213 pos
= it
.current
.pos
;
14214 min_distance
= INFINITY
;
14215 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14216 distance
< min_distance
)
14218 min_distance
= distance
;
14219 pos
= it
.current
.pos
;
14220 move_it_by_lines (&it
, 1);
14223 /* Set the window start there. */
14224 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14225 window_start_changed_p
= 1;
14229 return window_start_changed_p
;
14233 /* Try cursor movement in case text has not changed in window WINDOW,
14234 with window start STARTP. Value is
14236 CURSOR_MOVEMENT_SUCCESS if successful
14238 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14240 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14241 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14242 we want to scroll as if scroll-step were set to 1. See the code.
14244 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14245 which case we have to abort this redisplay, and adjust matrices
14250 CURSOR_MOVEMENT_SUCCESS
,
14251 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14252 CURSOR_MOVEMENT_MUST_SCROLL
,
14253 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14257 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14259 struct window
*w
= XWINDOW (window
);
14260 struct frame
*f
= XFRAME (w
->frame
);
14261 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14264 if (inhibit_try_cursor_movement
)
14268 /* Handle case where text has not changed, only point, and it has
14269 not moved off the frame. */
14270 if (/* Point may be in this window. */
14271 PT
>= CHARPOS (startp
)
14272 /* Selective display hasn't changed. */
14273 && !current_buffer
->clip_changed
14274 /* Function force-mode-line-update is used to force a thorough
14275 redisplay. It sets either windows_or_buffers_changed or
14276 update_mode_lines. So don't take a shortcut here for these
14278 && !update_mode_lines
14279 && !windows_or_buffers_changed
14280 && !cursor_type_changed
14281 /* Can't use this case if highlighting a region. When a
14282 region exists, cursor movement has to do more than just
14284 && !(!NILP (Vtransient_mark_mode
)
14285 && !NILP (BVAR (current_buffer
, mark_active
)))
14286 && NILP (w
->region_showing
)
14287 && NILP (Vshow_trailing_whitespace
)
14288 /* Right after splitting windows, last_point may be nil. */
14289 && INTEGERP (w
->last_point
)
14290 /* This code is not used for mini-buffer for the sake of the case
14291 of redisplaying to replace an echo area message; since in
14292 that case the mini-buffer contents per se are usually
14293 unchanged. This code is of no real use in the mini-buffer
14294 since the handling of this_line_start_pos, etc., in redisplay
14295 handles the same cases. */
14296 && !EQ (window
, minibuf_window
)
14297 /* When splitting windows or for new windows, it happens that
14298 redisplay is called with a nil window_end_vpos or one being
14299 larger than the window. This should really be fixed in
14300 window.c. I don't have this on my list, now, so we do
14301 approximately the same as the old redisplay code. --gerd. */
14302 && INTEGERP (w
->window_end_vpos
)
14303 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14304 && (FRAME_WINDOW_P (f
)
14305 || !overlay_arrow_in_current_buffer_p ()))
14307 int this_scroll_margin
, top_scroll_margin
;
14308 struct glyph_row
*row
= NULL
;
14311 debug_method_add (w
, "cursor movement");
14314 /* Scroll if point within this distance from the top or bottom
14315 of the window. This is a pixel value. */
14316 if (scroll_margin
> 0)
14318 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14319 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14322 this_scroll_margin
= 0;
14324 top_scroll_margin
= this_scroll_margin
;
14325 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14326 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14328 /* Start with the row the cursor was displayed during the last
14329 not paused redisplay. Give up if that row is not valid. */
14330 if (w
->last_cursor
.vpos
< 0
14331 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14332 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14335 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14336 if (row
->mode_line_p
)
14338 if (!row
->enabled_p
)
14339 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14342 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14344 int scroll_p
= 0, must_scroll
= 0;
14345 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14347 if (PT
> XFASTINT (w
->last_point
))
14349 /* Point has moved forward. */
14350 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14351 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14353 xassert (row
->enabled_p
);
14357 /* If the end position of a row equals the start
14358 position of the next row, and PT is at that position,
14359 we would rather display cursor in the next line. */
14360 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14361 && MATRIX_ROW_END_CHARPOS (row
) == PT
14362 && row
< w
->current_matrix
->rows
14363 + w
->current_matrix
->nrows
- 1
14364 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14365 && !cursor_row_p (row
))
14368 /* If within the scroll margin, scroll. Note that
14369 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14370 the next line would be drawn, and that
14371 this_scroll_margin can be zero. */
14372 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14373 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14374 /* Line is completely visible last line in window
14375 and PT is to be set in the next line. */
14376 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14377 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14378 && !row
->ends_at_zv_p
14379 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14382 else if (PT
< XFASTINT (w
->last_point
))
14384 /* Cursor has to be moved backward. Note that PT >=
14385 CHARPOS (startp) because of the outer if-statement. */
14386 while (!row
->mode_line_p
14387 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14388 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14389 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14390 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14391 row
> w
->current_matrix
->rows
14392 && (row
-1)->ends_in_newline_from_string_p
))))
14393 && (row
->y
> top_scroll_margin
14394 || CHARPOS (startp
) == BEGV
))
14396 xassert (row
->enabled_p
);
14400 /* Consider the following case: Window starts at BEGV,
14401 there is invisible, intangible text at BEGV, so that
14402 display starts at some point START > BEGV. It can
14403 happen that we are called with PT somewhere between
14404 BEGV and START. Try to handle that case. */
14405 if (row
< w
->current_matrix
->rows
14406 || row
->mode_line_p
)
14408 row
= w
->current_matrix
->rows
;
14409 if (row
->mode_line_p
)
14413 /* Due to newlines in overlay strings, we may have to
14414 skip forward over overlay strings. */
14415 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14416 && MATRIX_ROW_END_CHARPOS (row
) == PT
14417 && !cursor_row_p (row
))
14420 /* If within the scroll margin, scroll. */
14421 if (row
->y
< top_scroll_margin
14422 && CHARPOS (startp
) != BEGV
)
14427 /* Cursor did not move. So don't scroll even if cursor line
14428 is partially visible, as it was so before. */
14429 rc
= CURSOR_MOVEMENT_SUCCESS
;
14432 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14433 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14435 /* if PT is not in the glyph row, give up. */
14436 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14439 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14440 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14442 /* If rows are bidi-reordered and point moved, back up
14443 until we find a row that does not belong to a
14444 continuation line. This is because we must consider
14445 all rows of a continued line as candidates for the
14446 new cursor positioning, since row start and end
14447 positions change non-linearly with vertical position
14449 /* FIXME: Revisit this when glyph ``spilling'' in
14450 continuation lines' rows is implemented for
14451 bidi-reordered rows. */
14452 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14454 xassert (row
->enabled_p
);
14456 /* If we hit the beginning of the displayed portion
14457 without finding the first row of a continued
14459 if (row
<= w
->current_matrix
->rows
)
14461 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14469 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14470 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14471 && make_cursor_line_fully_visible_p
)
14473 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14474 && !row
->ends_at_zv_p
14475 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14476 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14477 else if (row
->height
> window_box_height (w
))
14479 /* If we end up in a partially visible line, let's
14480 make it fully visible, except when it's taller
14481 than the window, in which case we can't do much
14484 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14488 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14489 if (!cursor_row_fully_visible_p (w
, 0, 1))
14490 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14492 rc
= CURSOR_MOVEMENT_SUCCESS
;
14496 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14497 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14498 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14500 /* With bidi-reordered rows, there could be more than
14501 one candidate row whose start and end positions
14502 occlude point. We need to let set_cursor_from_row
14503 find the best candidate. */
14504 /* FIXME: Revisit this when glyph ``spilling'' in
14505 continuation lines' rows is implemented for
14506 bidi-reordered rows. */
14511 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14512 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14513 && cursor_row_p (row
))
14514 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14516 /* As soon as we've found the first suitable row
14517 whose ends_at_zv_p flag is set, we are done. */
14519 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14521 rc
= CURSOR_MOVEMENT_SUCCESS
;
14526 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14527 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14528 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14529 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14530 /* If we didn't find any candidate rows, or exited the
14531 loop before all the candidates were examined, signal
14532 to the caller that this method failed. */
14533 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14534 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14535 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14537 rc
= CURSOR_MOVEMENT_SUCCESS
;
14543 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14545 rc
= CURSOR_MOVEMENT_SUCCESS
;
14550 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14551 && MATRIX_ROW_START_CHARPOS (row
) == PT
14552 && cursor_row_p (row
));
14560 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14564 set_vertical_scroll_bar (struct window
*w
)
14566 EMACS_INT start
, end
, whole
;
14568 /* Calculate the start and end positions for the current window.
14569 At some point, it would be nice to choose between scrollbars
14570 which reflect the whole buffer size, with special markers
14571 indicating narrowing, and scrollbars which reflect only the
14574 Note that mini-buffers sometimes aren't displaying any text. */
14575 if (!MINI_WINDOW_P (w
)
14576 || (w
== XWINDOW (minibuf_window
)
14577 && NILP (echo_area_buffer
[0])))
14579 struct buffer
*buf
= XBUFFER (w
->buffer
);
14580 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14581 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14582 /* I don't think this is guaranteed to be right. For the
14583 moment, we'll pretend it is. */
14584 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14588 if (whole
< (end
- start
))
14589 whole
= end
- start
;
14592 start
= end
= whole
= 0;
14594 /* Indicate what this scroll bar ought to be displaying now. */
14595 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14596 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14597 (w
, end
- start
, whole
, start
);
14601 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14602 selected_window is redisplayed.
14604 We can return without actually redisplaying the window if
14605 fonts_changed_p is nonzero. In that case, redisplay_internal will
14609 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14611 struct window
*w
= XWINDOW (window
);
14612 struct frame
*f
= XFRAME (w
->frame
);
14613 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14614 struct buffer
*old
= current_buffer
;
14615 struct text_pos lpoint
, opoint
, startp
;
14616 int update_mode_line
;
14619 /* Record it now because it's overwritten. */
14620 int current_matrix_up_to_date_p
= 0;
14621 int used_current_matrix_p
= 0;
14622 /* This is less strict than current_matrix_up_to_date_p.
14623 It indictes that the buffer contents and narrowing are unchanged. */
14624 int buffer_unchanged_p
= 0;
14625 int temp_scroll_step
= 0;
14626 int count
= SPECPDL_INDEX ();
14628 int centering_position
= -1;
14629 int last_line_misfit
= 0;
14630 EMACS_INT beg_unchanged
, end_unchanged
;
14632 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14635 /* W must be a leaf window here. */
14636 xassert (!NILP (w
->buffer
));
14638 *w
->desired_matrix
->method
= 0;
14642 reconsider_clip_changes (w
, buffer
);
14644 /* Has the mode line to be updated? */
14645 update_mode_line
= (!NILP (w
->update_mode_line
)
14646 || update_mode_lines
14647 || buffer
->clip_changed
14648 || buffer
->prevent_redisplay_optimizations_p
);
14650 if (MINI_WINDOW_P (w
))
14652 if (w
== XWINDOW (echo_area_window
)
14653 && !NILP (echo_area_buffer
[0]))
14655 if (update_mode_line
)
14656 /* We may have to update a tty frame's menu bar or a
14657 tool-bar. Example `M-x C-h C-h C-g'. */
14658 goto finish_menu_bars
;
14660 /* We've already displayed the echo area glyphs in this window. */
14661 goto finish_scroll_bars
;
14663 else if ((w
!= XWINDOW (minibuf_window
)
14664 || minibuf_level
== 0)
14665 /* When buffer is nonempty, redisplay window normally. */
14666 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14667 /* Quail displays non-mini buffers in minibuffer window.
14668 In that case, redisplay the window normally. */
14669 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14671 /* W is a mini-buffer window, but it's not active, so clear
14673 int yb
= window_text_bottom_y (w
);
14674 struct glyph_row
*row
;
14677 for (y
= 0, row
= w
->desired_matrix
->rows
;
14679 y
+= row
->height
, ++row
)
14680 blank_row (w
, row
, y
);
14681 goto finish_scroll_bars
;
14684 clear_glyph_matrix (w
->desired_matrix
);
14687 /* Otherwise set up data on this window; select its buffer and point
14689 /* Really select the buffer, for the sake of buffer-local
14691 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14693 current_matrix_up_to_date_p
14694 = (!NILP (w
->window_end_valid
)
14695 && !current_buffer
->clip_changed
14696 && !current_buffer
->prevent_redisplay_optimizations_p
14697 && XFASTINT (w
->last_modified
) >= MODIFF
14698 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14700 /* Run the window-bottom-change-functions
14701 if it is possible that the text on the screen has changed
14702 (either due to modification of the text, or any other reason). */
14703 if (!current_matrix_up_to_date_p
14704 && !NILP (Vwindow_text_change_functions
))
14706 safe_run_hooks (Qwindow_text_change_functions
);
14710 beg_unchanged
= BEG_UNCHANGED
;
14711 end_unchanged
= END_UNCHANGED
;
14713 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14715 specbind (Qinhibit_point_motion_hooks
, Qt
);
14718 = (!NILP (w
->window_end_valid
)
14719 && !current_buffer
->clip_changed
14720 && XFASTINT (w
->last_modified
) >= MODIFF
14721 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14723 /* When windows_or_buffers_changed is non-zero, we can't rely on
14724 the window end being valid, so set it to nil there. */
14725 if (windows_or_buffers_changed
)
14727 /* If window starts on a continuation line, maybe adjust the
14728 window start in case the window's width changed. */
14729 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14730 compute_window_start_on_continuation_line (w
);
14732 w
->window_end_valid
= Qnil
;
14735 /* Some sanity checks. */
14736 CHECK_WINDOW_END (w
);
14737 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14739 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14742 /* If %c is in mode line, update it if needed. */
14743 if (!NILP (w
->column_number_displayed
)
14744 /* This alternative quickly identifies a common case
14745 where no change is needed. */
14746 && !(PT
== XFASTINT (w
->last_point
)
14747 && XFASTINT (w
->last_modified
) >= MODIFF
14748 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14749 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14750 update_mode_line
= 1;
14752 /* Count number of windows showing the selected buffer. An indirect
14753 buffer counts as its base buffer. */
14754 if (!just_this_one_p
)
14756 struct buffer
*current_base
, *window_base
;
14757 current_base
= current_buffer
;
14758 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14759 if (current_base
->base_buffer
)
14760 current_base
= current_base
->base_buffer
;
14761 if (window_base
->base_buffer
)
14762 window_base
= window_base
->base_buffer
;
14763 if (current_base
== window_base
)
14767 /* Point refers normally to the selected window. For any other
14768 window, set up appropriate value. */
14769 if (!EQ (window
, selected_window
))
14771 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14772 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14776 new_pt_byte
= BEGV_BYTE
;
14777 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14779 else if (new_pt
> (ZV
- 1))
14782 new_pt_byte
= ZV_BYTE
;
14783 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14786 /* We don't use SET_PT so that the point-motion hooks don't run. */
14787 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14790 /* If any of the character widths specified in the display table
14791 have changed, invalidate the width run cache. It's true that
14792 this may be a bit late to catch such changes, but the rest of
14793 redisplay goes (non-fatally) haywire when the display table is
14794 changed, so why should we worry about doing any better? */
14795 if (current_buffer
->width_run_cache
)
14797 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14799 if (! disptab_matches_widthtab (disptab
,
14800 XVECTOR (BVAR (current_buffer
, width_table
))))
14802 invalidate_region_cache (current_buffer
,
14803 current_buffer
->width_run_cache
,
14805 recompute_width_table (current_buffer
, disptab
);
14809 /* If window-start is screwed up, choose a new one. */
14810 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14813 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14815 /* If someone specified a new starting point but did not insist,
14816 check whether it can be used. */
14817 if (!NILP (w
->optional_new_start
)
14818 && CHARPOS (startp
) >= BEGV
14819 && CHARPOS (startp
) <= ZV
)
14821 w
->optional_new_start
= Qnil
;
14822 start_display (&it
, w
, startp
);
14823 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14824 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14825 if (IT_CHARPOS (it
) == PT
)
14826 w
->force_start
= Qt
;
14827 /* IT may overshoot PT if text at PT is invisible. */
14828 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14829 w
->force_start
= Qt
;
14834 /* Handle case where place to start displaying has been specified,
14835 unless the specified location is outside the accessible range. */
14836 if (!NILP (w
->force_start
)
14837 || w
->frozen_window_start_p
)
14839 /* We set this later on if we have to adjust point. */
14842 w
->force_start
= Qnil
;
14844 w
->window_end_valid
= Qnil
;
14846 /* Forget any recorded base line for line number display. */
14847 if (!buffer_unchanged_p
)
14848 w
->base_line_number
= Qnil
;
14850 /* Redisplay the mode line. Select the buffer properly for that.
14851 Also, run the hook window-scroll-functions
14852 because we have scrolled. */
14853 /* Note, we do this after clearing force_start because
14854 if there's an error, it is better to forget about force_start
14855 than to get into an infinite loop calling the hook functions
14856 and having them get more errors. */
14857 if (!update_mode_line
14858 || ! NILP (Vwindow_scroll_functions
))
14860 update_mode_line
= 1;
14861 w
->update_mode_line
= Qt
;
14862 startp
= run_window_scroll_functions (window
, startp
);
14865 w
->last_modified
= make_number (0);
14866 w
->last_overlay_modified
= make_number (0);
14867 if (CHARPOS (startp
) < BEGV
)
14868 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14869 else if (CHARPOS (startp
) > ZV
)
14870 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14872 /* Redisplay, then check if cursor has been set during the
14873 redisplay. Give up if new fonts were loaded. */
14874 /* We used to issue a CHECK_MARGINS argument to try_window here,
14875 but this causes scrolling to fail when point begins inside
14876 the scroll margin (bug#148) -- cyd */
14877 if (!try_window (window
, startp
, 0))
14879 w
->force_start
= Qt
;
14880 clear_glyph_matrix (w
->desired_matrix
);
14881 goto need_larger_matrices
;
14884 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14886 /* If point does not appear, try to move point so it does
14887 appear. The desired matrix has been built above, so we
14888 can use it here. */
14889 new_vpos
= window_box_height (w
) / 2;
14892 if (!cursor_row_fully_visible_p (w
, 0, 0))
14894 /* Point does appear, but on a line partly visible at end of window.
14895 Move it back to a fully-visible line. */
14896 new_vpos
= window_box_height (w
);
14899 /* If we need to move point for either of the above reasons,
14900 now actually do it. */
14903 struct glyph_row
*row
;
14905 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14906 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14909 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14910 MATRIX_ROW_START_BYTEPOS (row
));
14912 if (w
!= XWINDOW (selected_window
))
14913 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14914 else if (current_buffer
== old
)
14915 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14917 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14919 /* If we are highlighting the region, then we just changed
14920 the region, so redisplay to show it. */
14921 if (!NILP (Vtransient_mark_mode
)
14922 && !NILP (BVAR (current_buffer
, mark_active
)))
14924 clear_glyph_matrix (w
->desired_matrix
);
14925 if (!try_window (window
, startp
, 0))
14926 goto need_larger_matrices
;
14931 debug_method_add (w
, "forced window start");
14936 /* Handle case where text has not changed, only point, and it has
14937 not moved off the frame, and we are not retrying after hscroll.
14938 (current_matrix_up_to_date_p is nonzero when retrying.) */
14939 if (current_matrix_up_to_date_p
14940 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14941 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14945 case CURSOR_MOVEMENT_SUCCESS
:
14946 used_current_matrix_p
= 1;
14949 case CURSOR_MOVEMENT_MUST_SCROLL
:
14950 goto try_to_scroll
;
14956 /* If current starting point was originally the beginning of a line
14957 but no longer is, find a new starting point. */
14958 else if (!NILP (w
->start_at_line_beg
)
14959 && !(CHARPOS (startp
) <= BEGV
14960 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14963 debug_method_add (w
, "recenter 1");
14968 /* Try scrolling with try_window_id. Value is > 0 if update has
14969 been done, it is -1 if we know that the same window start will
14970 not work. It is 0 if unsuccessful for some other reason. */
14971 else if ((tem
= try_window_id (w
)) != 0)
14974 debug_method_add (w
, "try_window_id %d", tem
);
14977 if (fonts_changed_p
)
14978 goto need_larger_matrices
;
14982 /* Otherwise try_window_id has returned -1 which means that we
14983 don't want the alternative below this comment to execute. */
14985 else if (CHARPOS (startp
) >= BEGV
14986 && CHARPOS (startp
) <= ZV
14987 && PT
>= CHARPOS (startp
)
14988 && (CHARPOS (startp
) < ZV
14989 /* Avoid starting at end of buffer. */
14990 || CHARPOS (startp
) == BEGV
14991 || (XFASTINT (w
->last_modified
) >= MODIFF
14992 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14995 /* If first window line is a continuation line, and window start
14996 is inside the modified region, but the first change is before
14997 current window start, we must select a new window start.
14999 However, if this is the result of a down-mouse event (e.g. by
15000 extending the mouse-drag-overlay), we don't want to select a
15001 new window start, since that would change the position under
15002 the mouse, resulting in an unwanted mouse-movement rather
15003 than a simple mouse-click. */
15004 if (NILP (w
->start_at_line_beg
)
15005 && NILP (do_mouse_tracking
)
15006 && CHARPOS (startp
) > BEGV
15007 && CHARPOS (startp
) > BEG
+ beg_unchanged
15008 && CHARPOS (startp
) <= Z
- end_unchanged
15009 /* Even if w->start_at_line_beg is nil, a new window may
15010 start at a line_beg, since that's how set_buffer_window
15011 sets it. So, we need to check the return value of
15012 compute_window_start_on_continuation_line. (See also
15014 && XMARKER (w
->start
)->buffer
== current_buffer
15015 && compute_window_start_on_continuation_line (w
))
15017 w
->force_start
= Qt
;
15018 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15023 debug_method_add (w
, "same window start");
15026 /* Try to redisplay starting at same place as before.
15027 If point has not moved off frame, accept the results. */
15028 if (!current_matrix_up_to_date_p
15029 /* Don't use try_window_reusing_current_matrix in this case
15030 because a window scroll function can have changed the
15032 || !NILP (Vwindow_scroll_functions
)
15033 || MINI_WINDOW_P (w
)
15034 || !(used_current_matrix_p
15035 = try_window_reusing_current_matrix (w
)))
15037 IF_DEBUG (debug_method_add (w
, "1"));
15038 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15039 /* -1 means we need to scroll.
15040 0 means we need new matrices, but fonts_changed_p
15041 is set in that case, so we will detect it below. */
15042 goto try_to_scroll
;
15045 if (fonts_changed_p
)
15046 goto need_larger_matrices
;
15048 if (w
->cursor
.vpos
>= 0)
15050 if (!just_this_one_p
15051 || current_buffer
->clip_changed
15052 || BEG_UNCHANGED
< CHARPOS (startp
))
15053 /* Forget any recorded base line for line number display. */
15054 w
->base_line_number
= Qnil
;
15056 if (!cursor_row_fully_visible_p (w
, 1, 0))
15058 clear_glyph_matrix (w
->desired_matrix
);
15059 last_line_misfit
= 1;
15061 /* Drop through and scroll. */
15066 clear_glyph_matrix (w
->desired_matrix
);
15071 w
->last_modified
= make_number (0);
15072 w
->last_overlay_modified
= make_number (0);
15074 /* Redisplay the mode line. Select the buffer properly for that. */
15075 if (!update_mode_line
)
15077 update_mode_line
= 1;
15078 w
->update_mode_line
= Qt
;
15081 /* Try to scroll by specified few lines. */
15082 if ((scroll_conservatively
15083 || emacs_scroll_step
15084 || temp_scroll_step
15085 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15086 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15087 && CHARPOS (startp
) >= BEGV
15088 && CHARPOS (startp
) <= ZV
)
15090 /* The function returns -1 if new fonts were loaded, 1 if
15091 successful, 0 if not successful. */
15092 int ss
= try_scrolling (window
, just_this_one_p
,
15093 scroll_conservatively
,
15095 temp_scroll_step
, last_line_misfit
);
15098 case SCROLLING_SUCCESS
:
15101 case SCROLLING_NEED_LARGER_MATRICES
:
15102 goto need_larger_matrices
;
15104 case SCROLLING_FAILED
:
15112 /* Finally, just choose a place to start which positions point
15113 according to user preferences. */
15118 debug_method_add (w
, "recenter");
15121 /* w->vscroll = 0; */
15123 /* Forget any previously recorded base line for line number display. */
15124 if (!buffer_unchanged_p
)
15125 w
->base_line_number
= Qnil
;
15127 /* Determine the window start relative to point. */
15128 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15129 it
.current_y
= it
.last_visible_y
;
15130 if (centering_position
< 0)
15134 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15136 EMACS_INT margin_pos
= CHARPOS (startp
);
15138 Lisp_Object aggressive
;
15140 /* If there is a scroll margin at the top of the window, find
15141 its character position. */
15143 /* Cannot call start_display if startp is not in the
15144 accessible region of the buffer. This can happen when we
15145 have just switched to a different buffer and/or changed
15146 its restriction. In that case, startp is initialized to
15147 the character position 1 (BEG) because we did not yet
15148 have chance to display the buffer even once. */
15149 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15152 void *it1data
= NULL
;
15154 SAVE_IT (it1
, it
, it1data
);
15155 start_display (&it1
, w
, startp
);
15156 move_it_vertically (&it1
, margin
);
15157 margin_pos
= IT_CHARPOS (it1
);
15158 RESTORE_IT (&it
, &it
, it1data
);
15160 scrolling_up
= PT
> margin_pos
;
15163 ? BVAR (current_buffer
, scroll_up_aggressively
)
15164 : BVAR (current_buffer
, scroll_down_aggressively
);
15166 if (!MINI_WINDOW_P (w
)
15167 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15171 /* Setting scroll-conservatively overrides
15172 scroll-*-aggressively. */
15173 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15175 double float_amount
= XFLOATINT (aggressive
);
15177 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15178 if (pt_offset
== 0 && float_amount
> 0)
15183 /* Compute how much to move the window start backward from
15184 point so that point will be displayed where the user
15188 centering_position
= it
.last_visible_y
;
15190 centering_position
-= pt_offset
;
15191 centering_position
-=
15192 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
15193 /* Don't let point enter the scroll margin near top of
15195 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15196 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15199 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15202 /* Set the window start half the height of the window backward
15204 centering_position
= window_box_height (w
) / 2;
15206 move_it_vertically_backward (&it
, centering_position
);
15208 xassert (IT_CHARPOS (it
) >= BEGV
);
15210 /* The function move_it_vertically_backward may move over more
15211 than the specified y-distance. If it->w is small, e.g. a
15212 mini-buffer window, we may end up in front of the window's
15213 display area. Start displaying at the start of the line
15214 containing PT in this case. */
15215 if (it
.current_y
<= 0)
15217 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15218 move_it_vertically_backward (&it
, 0);
15222 it
.current_x
= it
.hpos
= 0;
15224 /* Set the window start position here explicitly, to avoid an
15225 infinite loop in case the functions in window-scroll-functions
15227 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15229 /* Run scroll hooks. */
15230 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15232 /* Redisplay the window. */
15233 if (!current_matrix_up_to_date_p
15234 || windows_or_buffers_changed
15235 || cursor_type_changed
15236 /* Don't use try_window_reusing_current_matrix in this case
15237 because it can have changed the buffer. */
15238 || !NILP (Vwindow_scroll_functions
)
15239 || !just_this_one_p
15240 || MINI_WINDOW_P (w
)
15241 || !(used_current_matrix_p
15242 = try_window_reusing_current_matrix (w
)))
15243 try_window (window
, startp
, 0);
15245 /* If new fonts have been loaded (due to fontsets), give up. We
15246 have to start a new redisplay since we need to re-adjust glyph
15248 if (fonts_changed_p
)
15249 goto need_larger_matrices
;
15251 /* If cursor did not appear assume that the middle of the window is
15252 in the first line of the window. Do it again with the next line.
15253 (Imagine a window of height 100, displaying two lines of height
15254 60. Moving back 50 from it->last_visible_y will end in the first
15256 if (w
->cursor
.vpos
< 0)
15258 if (!NILP (w
->window_end_valid
)
15259 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15261 clear_glyph_matrix (w
->desired_matrix
);
15262 move_it_by_lines (&it
, 1);
15263 try_window (window
, it
.current
.pos
, 0);
15265 else if (PT
< IT_CHARPOS (it
))
15267 clear_glyph_matrix (w
->desired_matrix
);
15268 move_it_by_lines (&it
, -1);
15269 try_window (window
, it
.current
.pos
, 0);
15273 /* Not much we can do about it. */
15277 /* Consider the following case: Window starts at BEGV, there is
15278 invisible, intangible text at BEGV, so that display starts at
15279 some point START > BEGV. It can happen that we are called with
15280 PT somewhere between BEGV and START. Try to handle that case. */
15281 if (w
->cursor
.vpos
< 0)
15283 struct glyph_row
*row
= w
->current_matrix
->rows
;
15284 if (row
->mode_line_p
)
15286 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15289 if (!cursor_row_fully_visible_p (w
, 0, 0))
15291 /* If vscroll is enabled, disable it and try again. */
15295 clear_glyph_matrix (w
->desired_matrix
);
15299 /* If centering point failed to make the whole line visible,
15300 put point at the top instead. That has to make the whole line
15301 visible, if it can be done. */
15302 if (centering_position
== 0)
15305 clear_glyph_matrix (w
->desired_matrix
);
15306 centering_position
= 0;
15312 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15313 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15314 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15317 /* Display the mode line, if we must. */
15318 if ((update_mode_line
15319 /* If window not full width, must redo its mode line
15320 if (a) the window to its side is being redone and
15321 (b) we do a frame-based redisplay. This is a consequence
15322 of how inverted lines are drawn in frame-based redisplay. */
15323 || (!just_this_one_p
15324 && !FRAME_WINDOW_P (f
)
15325 && !WINDOW_FULL_WIDTH_P (w
))
15326 /* Line number to display. */
15327 || INTEGERP (w
->base_line_pos
)
15328 /* Column number is displayed and different from the one displayed. */
15329 || (!NILP (w
->column_number_displayed
)
15330 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15331 /* This means that the window has a mode line. */
15332 && (WINDOW_WANTS_MODELINE_P (w
)
15333 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15335 display_mode_lines (w
);
15337 /* If mode line height has changed, arrange for a thorough
15338 immediate redisplay using the correct mode line height. */
15339 if (WINDOW_WANTS_MODELINE_P (w
)
15340 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15342 fonts_changed_p
= 1;
15343 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15344 = DESIRED_MODE_LINE_HEIGHT (w
);
15347 /* If header line height has changed, arrange for a thorough
15348 immediate redisplay using the correct header line height. */
15349 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15350 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15352 fonts_changed_p
= 1;
15353 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15354 = DESIRED_HEADER_LINE_HEIGHT (w
);
15357 if (fonts_changed_p
)
15358 goto need_larger_matrices
;
15361 if (!line_number_displayed
15362 && !BUFFERP (w
->base_line_pos
))
15364 w
->base_line_pos
= Qnil
;
15365 w
->base_line_number
= Qnil
;
15370 /* When we reach a frame's selected window, redo the frame's menu bar. */
15371 if (update_mode_line
15372 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15374 int redisplay_menu_p
= 0;
15376 if (FRAME_WINDOW_P (f
))
15378 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15379 || defined (HAVE_NS) || defined (USE_GTK)
15380 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15382 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15386 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15388 if (redisplay_menu_p
)
15389 display_menu_bar (w
);
15391 #ifdef HAVE_WINDOW_SYSTEM
15392 if (FRAME_WINDOW_P (f
))
15394 #if defined (USE_GTK) || defined (HAVE_NS)
15395 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15396 redisplay_tool_bar (f
);
15398 if (WINDOWP (f
->tool_bar_window
)
15399 && (FRAME_TOOL_BAR_LINES (f
) > 0
15400 || !NILP (Vauto_resize_tool_bars
))
15401 && redisplay_tool_bar (f
))
15402 ignore_mouse_drag_p
= 1;
15408 #ifdef HAVE_WINDOW_SYSTEM
15409 if (FRAME_WINDOW_P (f
)
15410 && update_window_fringes (w
, (just_this_one_p
15411 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15412 || w
->pseudo_window_p
)))
15416 if (draw_window_fringes (w
, 1))
15417 x_draw_vertical_border (w
);
15421 #endif /* HAVE_WINDOW_SYSTEM */
15423 /* We go to this label, with fonts_changed_p nonzero,
15424 if it is necessary to try again using larger glyph matrices.
15425 We have to redeem the scroll bar even in this case,
15426 because the loop in redisplay_internal expects that. */
15427 need_larger_matrices
:
15429 finish_scroll_bars
:
15431 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15433 /* Set the thumb's position and size. */
15434 set_vertical_scroll_bar (w
);
15436 /* Note that we actually used the scroll bar attached to this
15437 window, so it shouldn't be deleted at the end of redisplay. */
15438 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15439 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15442 /* Restore current_buffer and value of point in it. The window
15443 update may have changed the buffer, so first make sure `opoint'
15444 is still valid (Bug#6177). */
15445 if (CHARPOS (opoint
) < BEGV
)
15446 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15447 else if (CHARPOS (opoint
) > ZV
)
15448 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15450 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15452 set_buffer_internal_1 (old
);
15453 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15454 shorter. This can be caused by log truncation in *Messages*. */
15455 if (CHARPOS (lpoint
) <= ZV
)
15456 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15458 unbind_to (count
, Qnil
);
15462 /* Build the complete desired matrix of WINDOW with a window start
15463 buffer position POS.
15465 Value is 1 if successful. It is zero if fonts were loaded during
15466 redisplay which makes re-adjusting glyph matrices necessary, and -1
15467 if point would appear in the scroll margins.
15468 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15469 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15473 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15475 struct window
*w
= XWINDOW (window
);
15477 struct glyph_row
*last_text_row
= NULL
;
15478 struct frame
*f
= XFRAME (w
->frame
);
15480 /* Make POS the new window start. */
15481 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15483 /* Mark cursor position as unknown. No overlay arrow seen. */
15484 w
->cursor
.vpos
= -1;
15485 overlay_arrow_seen
= 0;
15487 /* Initialize iterator and info to start at POS. */
15488 start_display (&it
, w
, pos
);
15490 /* Display all lines of W. */
15491 while (it
.current_y
< it
.last_visible_y
)
15493 if (display_line (&it
))
15494 last_text_row
= it
.glyph_row
- 1;
15495 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15499 /* Don't let the cursor end in the scroll margins. */
15500 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15501 && !MINI_WINDOW_P (w
))
15503 int this_scroll_margin
;
15505 if (scroll_margin
> 0)
15507 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15508 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15511 this_scroll_margin
= 0;
15513 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15514 && w
->cursor
.y
< this_scroll_margin
15515 && CHARPOS (pos
) > BEGV
15516 && IT_CHARPOS (it
) < ZV
)
15517 /* rms: considering make_cursor_line_fully_visible_p here
15518 seems to give wrong results. We don't want to recenter
15519 when the last line is partly visible, we want to allow
15520 that case to be handled in the usual way. */
15521 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15523 w
->cursor
.vpos
= -1;
15524 clear_glyph_matrix (w
->desired_matrix
);
15529 /* If bottom moved off end of frame, change mode line percentage. */
15530 if (XFASTINT (w
->window_end_pos
) <= 0
15531 && Z
!= IT_CHARPOS (it
))
15532 w
->update_mode_line
= Qt
;
15534 /* Set window_end_pos to the offset of the last character displayed
15535 on the window from the end of current_buffer. Set
15536 window_end_vpos to its row number. */
15539 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15540 w
->window_end_bytepos
15541 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15543 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15545 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15546 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15547 ->displays_text_p
);
15551 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15552 w
->window_end_pos
= make_number (Z
- ZV
);
15553 w
->window_end_vpos
= make_number (0);
15556 /* But that is not valid info until redisplay finishes. */
15557 w
->window_end_valid
= Qnil
;
15563 /************************************************************************
15564 Window redisplay reusing current matrix when buffer has not changed
15565 ************************************************************************/
15567 /* Try redisplay of window W showing an unchanged buffer with a
15568 different window start than the last time it was displayed by
15569 reusing its current matrix. Value is non-zero if successful.
15570 W->start is the new window start. */
15573 try_window_reusing_current_matrix (struct window
*w
)
15575 struct frame
*f
= XFRAME (w
->frame
);
15576 struct glyph_row
*bottom_row
;
15579 struct text_pos start
, new_start
;
15580 int nrows_scrolled
, i
;
15581 struct glyph_row
*last_text_row
;
15582 struct glyph_row
*last_reused_text_row
;
15583 struct glyph_row
*start_row
;
15584 int start_vpos
, min_y
, max_y
;
15587 if (inhibit_try_window_reusing
)
15591 if (/* This function doesn't handle terminal frames. */
15592 !FRAME_WINDOW_P (f
)
15593 /* Don't try to reuse the display if windows have been split
15595 || windows_or_buffers_changed
15596 || cursor_type_changed
)
15599 /* Can't do this if region may have changed. */
15600 if ((!NILP (Vtransient_mark_mode
)
15601 && !NILP (BVAR (current_buffer
, mark_active
)))
15602 || !NILP (w
->region_showing
)
15603 || !NILP (Vshow_trailing_whitespace
))
15606 /* If top-line visibility has changed, give up. */
15607 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15608 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15611 /* Give up if old or new display is scrolled vertically. We could
15612 make this function handle this, but right now it doesn't. */
15613 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15614 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15617 /* The variable new_start now holds the new window start. The old
15618 start `start' can be determined from the current matrix. */
15619 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15620 start
= start_row
->minpos
;
15621 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15623 /* Clear the desired matrix for the display below. */
15624 clear_glyph_matrix (w
->desired_matrix
);
15626 if (CHARPOS (new_start
) <= CHARPOS (start
))
15628 /* Don't use this method if the display starts with an ellipsis
15629 displayed for invisible text. It's not easy to handle that case
15630 below, and it's certainly not worth the effort since this is
15631 not a frequent case. */
15632 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15635 IF_DEBUG (debug_method_add (w
, "twu1"));
15637 /* Display up to a row that can be reused. The variable
15638 last_text_row is set to the last row displayed that displays
15639 text. Note that it.vpos == 0 if or if not there is a
15640 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15641 start_display (&it
, w
, new_start
);
15642 w
->cursor
.vpos
= -1;
15643 last_text_row
= last_reused_text_row
= NULL
;
15645 while (it
.current_y
< it
.last_visible_y
15646 && !fonts_changed_p
)
15648 /* If we have reached into the characters in the START row,
15649 that means the line boundaries have changed. So we
15650 can't start copying with the row START. Maybe it will
15651 work to start copying with the following row. */
15652 while (IT_CHARPOS (it
) > CHARPOS (start
))
15654 /* Advance to the next row as the "start". */
15656 start
= start_row
->minpos
;
15657 /* If there are no more rows to try, or just one, give up. */
15658 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15659 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15660 || CHARPOS (start
) == ZV
)
15662 clear_glyph_matrix (w
->desired_matrix
);
15666 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15668 /* If we have reached alignment,
15669 we can copy the rest of the rows. */
15670 if (IT_CHARPOS (it
) == CHARPOS (start
))
15673 if (display_line (&it
))
15674 last_text_row
= it
.glyph_row
- 1;
15677 /* A value of current_y < last_visible_y means that we stopped
15678 at the previous window start, which in turn means that we
15679 have at least one reusable row. */
15680 if (it
.current_y
< it
.last_visible_y
)
15682 struct glyph_row
*row
;
15684 /* IT.vpos always starts from 0; it counts text lines. */
15685 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15687 /* Find PT if not already found in the lines displayed. */
15688 if (w
->cursor
.vpos
< 0)
15690 int dy
= it
.current_y
- start_row
->y
;
15692 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15693 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15695 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15696 dy
, nrows_scrolled
);
15699 clear_glyph_matrix (w
->desired_matrix
);
15704 /* Scroll the display. Do it before the current matrix is
15705 changed. The problem here is that update has not yet
15706 run, i.e. part of the current matrix is not up to date.
15707 scroll_run_hook will clear the cursor, and use the
15708 current matrix to get the height of the row the cursor is
15710 run
.current_y
= start_row
->y
;
15711 run
.desired_y
= it
.current_y
;
15712 run
.height
= it
.last_visible_y
- it
.current_y
;
15714 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15717 FRAME_RIF (f
)->update_window_begin_hook (w
);
15718 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15719 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15720 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15724 /* Shift current matrix down by nrows_scrolled lines. */
15725 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15726 rotate_matrix (w
->current_matrix
,
15728 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15731 /* Disable lines that must be updated. */
15732 for (i
= 0; i
< nrows_scrolled
; ++i
)
15733 (start_row
+ i
)->enabled_p
= 0;
15735 /* Re-compute Y positions. */
15736 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15737 max_y
= it
.last_visible_y
;
15738 for (row
= start_row
+ nrows_scrolled
;
15742 row
->y
= it
.current_y
;
15743 row
->visible_height
= row
->height
;
15745 if (row
->y
< min_y
)
15746 row
->visible_height
-= min_y
- row
->y
;
15747 if (row
->y
+ row
->height
> max_y
)
15748 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15749 if (row
->fringe_bitmap_periodic_p
)
15750 row
->redraw_fringe_bitmaps_p
= 1;
15752 it
.current_y
+= row
->height
;
15754 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15755 last_reused_text_row
= row
;
15756 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15760 /* Disable lines in the current matrix which are now
15761 below the window. */
15762 for (++row
; row
< bottom_row
; ++row
)
15763 row
->enabled_p
= row
->mode_line_p
= 0;
15766 /* Update window_end_pos etc.; last_reused_text_row is the last
15767 reused row from the current matrix containing text, if any.
15768 The value of last_text_row is the last displayed line
15769 containing text. */
15770 if (last_reused_text_row
)
15772 w
->window_end_bytepos
15773 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15775 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15777 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15778 w
->current_matrix
));
15780 else if (last_text_row
)
15782 w
->window_end_bytepos
15783 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15785 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15787 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15791 /* This window must be completely empty. */
15792 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15793 w
->window_end_pos
= make_number (Z
- ZV
);
15794 w
->window_end_vpos
= make_number (0);
15796 w
->window_end_valid
= Qnil
;
15798 /* Update hint: don't try scrolling again in update_window. */
15799 w
->desired_matrix
->no_scrolling_p
= 1;
15802 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15806 else if (CHARPOS (new_start
) > CHARPOS (start
))
15808 struct glyph_row
*pt_row
, *row
;
15809 struct glyph_row
*first_reusable_row
;
15810 struct glyph_row
*first_row_to_display
;
15812 int yb
= window_text_bottom_y (w
);
15814 /* Find the row starting at new_start, if there is one. Don't
15815 reuse a partially visible line at the end. */
15816 first_reusable_row
= start_row
;
15817 while (first_reusable_row
->enabled_p
15818 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15819 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15820 < CHARPOS (new_start
)))
15821 ++first_reusable_row
;
15823 /* Give up if there is no row to reuse. */
15824 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15825 || !first_reusable_row
->enabled_p
15826 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15827 != CHARPOS (new_start
)))
15830 /* We can reuse fully visible rows beginning with
15831 first_reusable_row to the end of the window. Set
15832 first_row_to_display to the first row that cannot be reused.
15833 Set pt_row to the row containing point, if there is any. */
15835 for (first_row_to_display
= first_reusable_row
;
15836 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15837 ++first_row_to_display
)
15839 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15840 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15841 pt_row
= first_row_to_display
;
15844 /* Start displaying at the start of first_row_to_display. */
15845 xassert (first_row_to_display
->y
< yb
);
15846 init_to_row_start (&it
, w
, first_row_to_display
);
15848 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15850 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15852 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15853 + WINDOW_HEADER_LINE_HEIGHT (w
));
15855 /* Display lines beginning with first_row_to_display in the
15856 desired matrix. Set last_text_row to the last row displayed
15857 that displays text. */
15858 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15859 if (pt_row
== NULL
)
15860 w
->cursor
.vpos
= -1;
15861 last_text_row
= NULL
;
15862 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15863 if (display_line (&it
))
15864 last_text_row
= it
.glyph_row
- 1;
15866 /* If point is in a reused row, adjust y and vpos of the cursor
15870 w
->cursor
.vpos
-= nrows_scrolled
;
15871 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15874 /* Give up if point isn't in a row displayed or reused. (This
15875 also handles the case where w->cursor.vpos < nrows_scrolled
15876 after the calls to display_line, which can happen with scroll
15877 margins. See bug#1295.) */
15878 if (w
->cursor
.vpos
< 0)
15880 clear_glyph_matrix (w
->desired_matrix
);
15884 /* Scroll the display. */
15885 run
.current_y
= first_reusable_row
->y
;
15886 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15887 run
.height
= it
.last_visible_y
- run
.current_y
;
15888 dy
= run
.current_y
- run
.desired_y
;
15893 FRAME_RIF (f
)->update_window_begin_hook (w
);
15894 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15895 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15896 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15900 /* Adjust Y positions of reused rows. */
15901 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15902 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15903 max_y
= it
.last_visible_y
;
15904 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15907 row
->visible_height
= row
->height
;
15908 if (row
->y
< min_y
)
15909 row
->visible_height
-= min_y
- row
->y
;
15910 if (row
->y
+ row
->height
> max_y
)
15911 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15912 if (row
->fringe_bitmap_periodic_p
)
15913 row
->redraw_fringe_bitmaps_p
= 1;
15916 /* Scroll the current matrix. */
15917 xassert (nrows_scrolled
> 0);
15918 rotate_matrix (w
->current_matrix
,
15920 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15923 /* Disable rows not reused. */
15924 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15925 row
->enabled_p
= 0;
15927 /* Point may have moved to a different line, so we cannot assume that
15928 the previous cursor position is valid; locate the correct row. */
15931 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15932 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15936 w
->cursor
.y
= row
->y
;
15938 if (row
< bottom_row
)
15940 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15941 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15943 /* Can't use this optimization with bidi-reordered glyph
15944 rows, unless cursor is already at point. */
15945 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15947 if (!(w
->cursor
.hpos
>= 0
15948 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15949 && BUFFERP (glyph
->object
)
15950 && glyph
->charpos
== PT
))
15955 && (!BUFFERP (glyph
->object
)
15956 || glyph
->charpos
< PT
);
15960 w
->cursor
.x
+= glyph
->pixel_width
;
15965 /* Adjust window end. A null value of last_text_row means that
15966 the window end is in reused rows which in turn means that
15967 only its vpos can have changed. */
15970 w
->window_end_bytepos
15971 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15973 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15975 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15980 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15983 w
->window_end_valid
= Qnil
;
15984 w
->desired_matrix
->no_scrolling_p
= 1;
15987 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15997 /************************************************************************
15998 Window redisplay reusing current matrix when buffer has changed
15999 ************************************************************************/
16001 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16002 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16003 EMACS_INT
*, EMACS_INT
*);
16004 static struct glyph_row
*
16005 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16006 struct glyph_row
*);
16009 /* Return the last row in MATRIX displaying text. If row START is
16010 non-null, start searching with that row. IT gives the dimensions
16011 of the display. Value is null if matrix is empty; otherwise it is
16012 a pointer to the row found. */
16014 static struct glyph_row
*
16015 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16016 struct glyph_row
*start
)
16018 struct glyph_row
*row
, *row_found
;
16020 /* Set row_found to the last row in IT->w's current matrix
16021 displaying text. The loop looks funny but think of partially
16024 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16025 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16027 xassert (row
->enabled_p
);
16029 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16038 /* Return the last row in the current matrix of W that is not affected
16039 by changes at the start of current_buffer that occurred since W's
16040 current matrix was built. Value is null if no such row exists.
16042 BEG_UNCHANGED us the number of characters unchanged at the start of
16043 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16044 first changed character in current_buffer. Characters at positions <
16045 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16046 when the current matrix was built. */
16048 static struct glyph_row
*
16049 find_last_unchanged_at_beg_row (struct window
*w
)
16051 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16052 struct glyph_row
*row
;
16053 struct glyph_row
*row_found
= NULL
;
16054 int yb
= window_text_bottom_y (w
);
16056 /* Find the last row displaying unchanged text. */
16057 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16058 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16059 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16062 if (/* If row ends before first_changed_pos, it is unchanged,
16063 except in some case. */
16064 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16065 /* When row ends in ZV and we write at ZV it is not
16067 && !row
->ends_at_zv_p
16068 /* When first_changed_pos is the end of a continued line,
16069 row is not unchanged because it may be no longer
16071 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16072 && (row
->continued_p
16073 || row
->exact_window_width_line_p
)))
16076 /* Stop if last visible row. */
16077 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16085 /* Find the first glyph row in the current matrix of W that is not
16086 affected by changes at the end of current_buffer since the
16087 time W's current matrix was built.
16089 Return in *DELTA the number of chars by which buffer positions in
16090 unchanged text at the end of current_buffer must be adjusted.
16092 Return in *DELTA_BYTES the corresponding number of bytes.
16094 Value is null if no such row exists, i.e. all rows are affected by
16097 static struct glyph_row
*
16098 find_first_unchanged_at_end_row (struct window
*w
,
16099 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16101 struct glyph_row
*row
;
16102 struct glyph_row
*row_found
= NULL
;
16104 *delta
= *delta_bytes
= 0;
16106 /* Display must not have been paused, otherwise the current matrix
16107 is not up to date. */
16108 eassert (!NILP (w
->window_end_valid
));
16110 /* A value of window_end_pos >= END_UNCHANGED means that the window
16111 end is in the range of changed text. If so, there is no
16112 unchanged row at the end of W's current matrix. */
16113 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16116 /* Set row to the last row in W's current matrix displaying text. */
16117 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16119 /* If matrix is entirely empty, no unchanged row exists. */
16120 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16122 /* The value of row is the last glyph row in the matrix having a
16123 meaningful buffer position in it. The end position of row
16124 corresponds to window_end_pos. This allows us to translate
16125 buffer positions in the current matrix to current buffer
16126 positions for characters not in changed text. */
16128 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16129 EMACS_INT Z_BYTE_old
=
16130 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16131 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16132 struct glyph_row
*first_text_row
16133 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16135 *delta
= Z
- Z_old
;
16136 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16138 /* Set last_unchanged_pos to the buffer position of the last
16139 character in the buffer that has not been changed. Z is the
16140 index + 1 of the last character in current_buffer, i.e. by
16141 subtracting END_UNCHANGED we get the index of the last
16142 unchanged character, and we have to add BEG to get its buffer
16144 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16145 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16147 /* Search backward from ROW for a row displaying a line that
16148 starts at a minimum position >= last_unchanged_pos_old. */
16149 for (; row
> first_text_row
; --row
)
16151 /* This used to abort, but it can happen.
16152 It is ok to just stop the search instead here. KFS. */
16153 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16156 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16161 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16167 /* Make sure that glyph rows in the current matrix of window W
16168 reference the same glyph memory as corresponding rows in the
16169 frame's frame matrix. This function is called after scrolling W's
16170 current matrix on a terminal frame in try_window_id and
16171 try_window_reusing_current_matrix. */
16174 sync_frame_with_window_matrix_rows (struct window
*w
)
16176 struct frame
*f
= XFRAME (w
->frame
);
16177 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16179 /* Preconditions: W must be a leaf window and full-width. Its frame
16180 must have a frame matrix. */
16181 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16182 xassert (WINDOW_FULL_WIDTH_P (w
));
16183 xassert (!FRAME_WINDOW_P (f
));
16185 /* If W is a full-width window, glyph pointers in W's current matrix
16186 have, by definition, to be the same as glyph pointers in the
16187 corresponding frame matrix. Note that frame matrices have no
16188 marginal areas (see build_frame_matrix). */
16189 window_row
= w
->current_matrix
->rows
;
16190 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16191 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16192 while (window_row
< window_row_end
)
16194 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16195 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16197 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16198 frame_row
->glyphs
[TEXT_AREA
] = start
;
16199 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16200 frame_row
->glyphs
[LAST_AREA
] = end
;
16202 /* Disable frame rows whose corresponding window rows have
16203 been disabled in try_window_id. */
16204 if (!window_row
->enabled_p
)
16205 frame_row
->enabled_p
= 0;
16207 ++window_row
, ++frame_row
;
16212 /* Find the glyph row in window W containing CHARPOS. Consider all
16213 rows between START and END (not inclusive). END null means search
16214 all rows to the end of the display area of W. Value is the row
16215 containing CHARPOS or null. */
16218 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16219 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16221 struct glyph_row
*row
= start
;
16222 struct glyph_row
*best_row
= NULL
;
16223 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16226 /* If we happen to start on a header-line, skip that. */
16227 if (row
->mode_line_p
)
16230 if ((end
&& row
>= end
) || !row
->enabled_p
)
16233 last_y
= window_text_bottom_y (w
) - dy
;
16237 /* Give up if we have gone too far. */
16238 if (end
&& row
>= end
)
16240 /* This formerly returned if they were equal.
16241 I think that both quantities are of a "last plus one" type;
16242 if so, when they are equal, the row is within the screen. -- rms. */
16243 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16246 /* If it is in this row, return this row. */
16247 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16248 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16249 /* The end position of a row equals the start
16250 position of the next row. If CHARPOS is there, we
16251 would rather display it in the next line, except
16252 when this line ends in ZV. */
16253 && !row
->ends_at_zv_p
16254 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16255 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16259 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16260 || (!best_row
&& !row
->continued_p
))
16262 /* In bidi-reordered rows, there could be several rows
16263 occluding point, all of them belonging to the same
16264 continued line. We need to find the row which fits
16265 CHARPOS the best. */
16266 for (g
= row
->glyphs
[TEXT_AREA
];
16267 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16270 if (!STRINGP (g
->object
))
16272 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16274 mindif
= eabs (g
->charpos
- charpos
);
16276 /* Exact match always wins. */
16283 else if (best_row
&& !row
->continued_p
)
16290 /* Try to redisplay window W by reusing its existing display. W's
16291 current matrix must be up to date when this function is called,
16292 i.e. window_end_valid must not be nil.
16296 1 if display has been updated
16297 0 if otherwise unsuccessful
16298 -1 if redisplay with same window start is known not to succeed
16300 The following steps are performed:
16302 1. Find the last row in the current matrix of W that is not
16303 affected by changes at the start of current_buffer. If no such row
16306 2. Find the first row in W's current matrix that is not affected by
16307 changes at the end of current_buffer. Maybe there is no such row.
16309 3. Display lines beginning with the row + 1 found in step 1 to the
16310 row found in step 2 or, if step 2 didn't find a row, to the end of
16313 4. If cursor is not known to appear on the window, give up.
16315 5. If display stopped at the row found in step 2, scroll the
16316 display and current matrix as needed.
16318 6. Maybe display some lines at the end of W, if we must. This can
16319 happen under various circumstances, like a partially visible line
16320 becoming fully visible, or because newly displayed lines are displayed
16321 in smaller font sizes.
16323 7. Update W's window end information. */
16326 try_window_id (struct window
*w
)
16328 struct frame
*f
= XFRAME (w
->frame
);
16329 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16330 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16331 struct glyph_row
*last_unchanged_at_beg_row
;
16332 struct glyph_row
*first_unchanged_at_end_row
;
16333 struct glyph_row
*row
;
16334 struct glyph_row
*bottom_row
;
16337 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16339 struct text_pos start_pos
;
16341 int first_unchanged_at_end_vpos
= 0;
16342 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16343 struct text_pos start
;
16344 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16347 if (inhibit_try_window_id
)
16351 /* This is handy for debugging. */
16353 #define GIVE_UP(X) \
16355 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16359 #define GIVE_UP(X) return 0
16362 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16364 /* Don't use this for mini-windows because these can show
16365 messages and mini-buffers, and we don't handle that here. */
16366 if (MINI_WINDOW_P (w
))
16369 /* This flag is used to prevent redisplay optimizations. */
16370 if (windows_or_buffers_changed
|| cursor_type_changed
)
16373 /* Verify that narrowing has not changed.
16374 Also verify that we were not told to prevent redisplay optimizations.
16375 It would be nice to further
16376 reduce the number of cases where this prevents try_window_id. */
16377 if (current_buffer
->clip_changed
16378 || current_buffer
->prevent_redisplay_optimizations_p
)
16381 /* Window must either use window-based redisplay or be full width. */
16382 if (!FRAME_WINDOW_P (f
)
16383 && (!FRAME_LINE_INS_DEL_OK (f
)
16384 || !WINDOW_FULL_WIDTH_P (w
)))
16387 /* Give up if point is known NOT to appear in W. */
16388 if (PT
< CHARPOS (start
))
16391 /* Another way to prevent redisplay optimizations. */
16392 if (XFASTINT (w
->last_modified
) == 0)
16395 /* Verify that window is not hscrolled. */
16396 if (XFASTINT (w
->hscroll
) != 0)
16399 /* Verify that display wasn't paused. */
16400 if (NILP (w
->window_end_valid
))
16403 /* Can't use this if highlighting a region because a cursor movement
16404 will do more than just set the cursor. */
16405 if (!NILP (Vtransient_mark_mode
)
16406 && !NILP (BVAR (current_buffer
, mark_active
)))
16409 /* Likewise if highlighting trailing whitespace. */
16410 if (!NILP (Vshow_trailing_whitespace
))
16413 /* Likewise if showing a region. */
16414 if (!NILP (w
->region_showing
))
16417 /* Can't use this if overlay arrow position and/or string have
16419 if (overlay_arrows_changed_p ())
16422 /* When word-wrap is on, adding a space to the first word of a
16423 wrapped line can change the wrap position, altering the line
16424 above it. It might be worthwhile to handle this more
16425 intelligently, but for now just redisplay from scratch. */
16426 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16429 /* Under bidi reordering, adding or deleting a character in the
16430 beginning of a paragraph, before the first strong directional
16431 character, can change the base direction of the paragraph (unless
16432 the buffer specifies a fixed paragraph direction), which will
16433 require to redisplay the whole paragraph. It might be worthwhile
16434 to find the paragraph limits and widen the range of redisplayed
16435 lines to that, but for now just give up this optimization and
16436 redisplay from scratch. */
16437 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16438 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16441 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16442 only if buffer has really changed. The reason is that the gap is
16443 initially at Z for freshly visited files. The code below would
16444 set end_unchanged to 0 in that case. */
16445 if (MODIFF
> SAVE_MODIFF
16446 /* This seems to happen sometimes after saving a buffer. */
16447 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16449 if (GPT
- BEG
< BEG_UNCHANGED
)
16450 BEG_UNCHANGED
= GPT
- BEG
;
16451 if (Z
- GPT
< END_UNCHANGED
)
16452 END_UNCHANGED
= Z
- GPT
;
16455 /* The position of the first and last character that has been changed. */
16456 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16457 last_changed_charpos
= Z
- END_UNCHANGED
;
16459 /* If window starts after a line end, and the last change is in
16460 front of that newline, then changes don't affect the display.
16461 This case happens with stealth-fontification. Note that although
16462 the display is unchanged, glyph positions in the matrix have to
16463 be adjusted, of course. */
16464 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16465 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16466 && ((last_changed_charpos
< CHARPOS (start
)
16467 && CHARPOS (start
) == BEGV
)
16468 || (last_changed_charpos
< CHARPOS (start
) - 1
16469 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16471 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16472 struct glyph_row
*r0
;
16474 /* Compute how many chars/bytes have been added to or removed
16475 from the buffer. */
16476 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16477 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16478 Z_delta
= Z
- Z_old
;
16479 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16481 /* Give up if PT is not in the window. Note that it already has
16482 been checked at the start of try_window_id that PT is not in
16483 front of the window start. */
16484 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16487 /* If window start is unchanged, we can reuse the whole matrix
16488 as is, after adjusting glyph positions. No need to compute
16489 the window end again, since its offset from Z hasn't changed. */
16490 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16491 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16492 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16493 /* PT must not be in a partially visible line. */
16494 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16495 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16497 /* Adjust positions in the glyph matrix. */
16498 if (Z_delta
|| Z_delta_bytes
)
16500 struct glyph_row
*r1
16501 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16502 increment_matrix_positions (w
->current_matrix
,
16503 MATRIX_ROW_VPOS (r0
, current_matrix
),
16504 MATRIX_ROW_VPOS (r1
, current_matrix
),
16505 Z_delta
, Z_delta_bytes
);
16508 /* Set the cursor. */
16509 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16511 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16518 /* Handle the case that changes are all below what is displayed in
16519 the window, and that PT is in the window. This shortcut cannot
16520 be taken if ZV is visible in the window, and text has been added
16521 there that is visible in the window. */
16522 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16523 /* ZV is not visible in the window, or there are no
16524 changes at ZV, actually. */
16525 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16526 || first_changed_charpos
== last_changed_charpos
))
16528 struct glyph_row
*r0
;
16530 /* Give up if PT is not in the window. Note that it already has
16531 been checked at the start of try_window_id that PT is not in
16532 front of the window start. */
16533 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16536 /* If window start is unchanged, we can reuse the whole matrix
16537 as is, without changing glyph positions since no text has
16538 been added/removed in front of the window end. */
16539 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16540 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16541 /* PT must not be in a partially visible line. */
16542 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16543 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16545 /* We have to compute the window end anew since text
16546 could have been added/removed after it. */
16548 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16549 w
->window_end_bytepos
16550 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16552 /* Set the cursor. */
16553 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16555 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16562 /* Give up if window start is in the changed area.
16564 The condition used to read
16566 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16568 but why that was tested escapes me at the moment. */
16569 if (CHARPOS (start
) >= first_changed_charpos
16570 && CHARPOS (start
) <= last_changed_charpos
)
16573 /* Check that window start agrees with the start of the first glyph
16574 row in its current matrix. Check this after we know the window
16575 start is not in changed text, otherwise positions would not be
16577 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16578 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16581 /* Give up if the window ends in strings. Overlay strings
16582 at the end are difficult to handle, so don't try. */
16583 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16584 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16587 /* Compute the position at which we have to start displaying new
16588 lines. Some of the lines at the top of the window might be
16589 reusable because they are not displaying changed text. Find the
16590 last row in W's current matrix not affected by changes at the
16591 start of current_buffer. Value is null if changes start in the
16592 first line of window. */
16593 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16594 if (last_unchanged_at_beg_row
)
16596 /* Avoid starting to display in the moddle of a character, a TAB
16597 for instance. This is easier than to set up the iterator
16598 exactly, and it's not a frequent case, so the additional
16599 effort wouldn't really pay off. */
16600 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16601 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16602 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16603 --last_unchanged_at_beg_row
;
16605 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16608 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16610 start_pos
= it
.current
.pos
;
16612 /* Start displaying new lines in the desired matrix at the same
16613 vpos we would use in the current matrix, i.e. below
16614 last_unchanged_at_beg_row. */
16615 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16617 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16618 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16620 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16624 /* There are no reusable lines at the start of the window.
16625 Start displaying in the first text line. */
16626 start_display (&it
, w
, start
);
16627 it
.vpos
= it
.first_vpos
;
16628 start_pos
= it
.current
.pos
;
16631 /* Find the first row that is not affected by changes at the end of
16632 the buffer. Value will be null if there is no unchanged row, in
16633 which case we must redisplay to the end of the window. delta
16634 will be set to the value by which buffer positions beginning with
16635 first_unchanged_at_end_row have to be adjusted due to text
16637 first_unchanged_at_end_row
16638 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16639 IF_DEBUG (debug_delta
= delta
);
16640 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16642 /* Set stop_pos to the buffer position up to which we will have to
16643 display new lines. If first_unchanged_at_end_row != NULL, this
16644 is the buffer position of the start of the line displayed in that
16645 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16646 that we don't stop at a buffer position. */
16648 if (first_unchanged_at_end_row
)
16650 xassert (last_unchanged_at_beg_row
== NULL
16651 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16653 /* If this is a continuation line, move forward to the next one
16654 that isn't. Changes in lines above affect this line.
16655 Caution: this may move first_unchanged_at_end_row to a row
16656 not displaying text. */
16657 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16658 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16659 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16660 < it
.last_visible_y
))
16661 ++first_unchanged_at_end_row
;
16663 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16664 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16665 >= it
.last_visible_y
))
16666 first_unchanged_at_end_row
= NULL
;
16669 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16671 first_unchanged_at_end_vpos
16672 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16673 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16676 else if (last_unchanged_at_beg_row
== NULL
)
16682 /* Either there is no unchanged row at the end, or the one we have
16683 now displays text. This is a necessary condition for the window
16684 end pos calculation at the end of this function. */
16685 xassert (first_unchanged_at_end_row
== NULL
16686 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16688 debug_last_unchanged_at_beg_vpos
16689 = (last_unchanged_at_beg_row
16690 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16692 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16694 #endif /* GLYPH_DEBUG != 0 */
16697 /* Display new lines. Set last_text_row to the last new line
16698 displayed which has text on it, i.e. might end up as being the
16699 line where the window_end_vpos is. */
16700 w
->cursor
.vpos
= -1;
16701 last_text_row
= NULL
;
16702 overlay_arrow_seen
= 0;
16703 while (it
.current_y
< it
.last_visible_y
16704 && !fonts_changed_p
16705 && (first_unchanged_at_end_row
== NULL
16706 || IT_CHARPOS (it
) < stop_pos
))
16708 if (display_line (&it
))
16709 last_text_row
= it
.glyph_row
- 1;
16712 if (fonts_changed_p
)
16716 /* Compute differences in buffer positions, y-positions etc. for
16717 lines reused at the bottom of the window. Compute what we can
16719 if (first_unchanged_at_end_row
16720 /* No lines reused because we displayed everything up to the
16721 bottom of the window. */
16722 && it
.current_y
< it
.last_visible_y
)
16725 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16727 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16728 run
.current_y
= first_unchanged_at_end_row
->y
;
16729 run
.desired_y
= run
.current_y
+ dy
;
16730 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16734 delta
= delta_bytes
= dvpos
= dy
16735 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16736 first_unchanged_at_end_row
= NULL
;
16738 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16741 /* Find the cursor if not already found. We have to decide whether
16742 PT will appear on this window (it sometimes doesn't, but this is
16743 not a very frequent case.) This decision has to be made before
16744 the current matrix is altered. A value of cursor.vpos < 0 means
16745 that PT is either in one of the lines beginning at
16746 first_unchanged_at_end_row or below the window. Don't care for
16747 lines that might be displayed later at the window end; as
16748 mentioned, this is not a frequent case. */
16749 if (w
->cursor
.vpos
< 0)
16751 /* Cursor in unchanged rows at the top? */
16752 if (PT
< CHARPOS (start_pos
)
16753 && last_unchanged_at_beg_row
)
16755 row
= row_containing_pos (w
, PT
,
16756 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16757 last_unchanged_at_beg_row
+ 1, 0);
16759 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16762 /* Start from first_unchanged_at_end_row looking for PT. */
16763 else if (first_unchanged_at_end_row
)
16765 row
= row_containing_pos (w
, PT
- delta
,
16766 first_unchanged_at_end_row
, NULL
, 0);
16768 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16769 delta_bytes
, dy
, dvpos
);
16772 /* Give up if cursor was not found. */
16773 if (w
->cursor
.vpos
< 0)
16775 clear_glyph_matrix (w
->desired_matrix
);
16780 /* Don't let the cursor end in the scroll margins. */
16782 int this_scroll_margin
, cursor_height
;
16784 this_scroll_margin
= max (0, scroll_margin
);
16785 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16786 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16787 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16789 if ((w
->cursor
.y
< this_scroll_margin
16790 && CHARPOS (start
) > BEGV
)
16791 /* Old redisplay didn't take scroll margin into account at the bottom,
16792 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16793 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16794 ? cursor_height
+ this_scroll_margin
16795 : 1)) > it
.last_visible_y
)
16797 w
->cursor
.vpos
= -1;
16798 clear_glyph_matrix (w
->desired_matrix
);
16803 /* Scroll the display. Do it before changing the current matrix so
16804 that xterm.c doesn't get confused about where the cursor glyph is
16806 if (dy
&& run
.height
)
16810 if (FRAME_WINDOW_P (f
))
16812 FRAME_RIF (f
)->update_window_begin_hook (w
);
16813 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16814 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16815 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16819 /* Terminal frame. In this case, dvpos gives the number of
16820 lines to scroll by; dvpos < 0 means scroll up. */
16822 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16823 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16824 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16825 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16826 + window_internal_height (w
));
16828 #if defined (HAVE_GPM) || defined (MSDOS)
16829 x_clear_window_mouse_face (w
);
16831 /* Perform the operation on the screen. */
16834 /* Scroll last_unchanged_at_beg_row to the end of the
16835 window down dvpos lines. */
16836 set_terminal_window (f
, end
);
16838 /* On dumb terminals delete dvpos lines at the end
16839 before inserting dvpos empty lines. */
16840 if (!FRAME_SCROLL_REGION_OK (f
))
16841 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16843 /* Insert dvpos empty lines in front of
16844 last_unchanged_at_beg_row. */
16845 ins_del_lines (f
, from
, dvpos
);
16847 else if (dvpos
< 0)
16849 /* Scroll up last_unchanged_at_beg_vpos to the end of
16850 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16851 set_terminal_window (f
, end
);
16853 /* Delete dvpos lines in front of
16854 last_unchanged_at_beg_vpos. ins_del_lines will set
16855 the cursor to the given vpos and emit |dvpos| delete
16857 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16859 /* On a dumb terminal insert dvpos empty lines at the
16861 if (!FRAME_SCROLL_REGION_OK (f
))
16862 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16865 set_terminal_window (f
, 0);
16871 /* Shift reused rows of the current matrix to the right position.
16872 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16874 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16875 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16878 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16879 bottom_vpos
, dvpos
);
16880 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16883 else if (dvpos
> 0)
16885 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16886 bottom_vpos
, dvpos
);
16887 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16888 first_unchanged_at_end_vpos
+ dvpos
, 0);
16891 /* For frame-based redisplay, make sure that current frame and window
16892 matrix are in sync with respect to glyph memory. */
16893 if (!FRAME_WINDOW_P (f
))
16894 sync_frame_with_window_matrix_rows (w
);
16896 /* Adjust buffer positions in reused rows. */
16897 if (delta
|| delta_bytes
)
16898 increment_matrix_positions (current_matrix
,
16899 first_unchanged_at_end_vpos
+ dvpos
,
16900 bottom_vpos
, delta
, delta_bytes
);
16902 /* Adjust Y positions. */
16904 shift_glyph_matrix (w
, current_matrix
,
16905 first_unchanged_at_end_vpos
+ dvpos
,
16908 if (first_unchanged_at_end_row
)
16910 first_unchanged_at_end_row
+= dvpos
;
16911 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16912 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16913 first_unchanged_at_end_row
= NULL
;
16916 /* If scrolling up, there may be some lines to display at the end of
16918 last_text_row_at_end
= NULL
;
16921 /* Scrolling up can leave for example a partially visible line
16922 at the end of the window to be redisplayed. */
16923 /* Set last_row to the glyph row in the current matrix where the
16924 window end line is found. It has been moved up or down in
16925 the matrix by dvpos. */
16926 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16927 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16929 /* If last_row is the window end line, it should display text. */
16930 xassert (last_row
->displays_text_p
);
16932 /* If window end line was partially visible before, begin
16933 displaying at that line. Otherwise begin displaying with the
16934 line following it. */
16935 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16937 init_to_row_start (&it
, w
, last_row
);
16938 it
.vpos
= last_vpos
;
16939 it
.current_y
= last_row
->y
;
16943 init_to_row_end (&it
, w
, last_row
);
16944 it
.vpos
= 1 + last_vpos
;
16945 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16949 /* We may start in a continuation line. If so, we have to
16950 get the right continuation_lines_width and current_x. */
16951 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16952 it
.hpos
= it
.current_x
= 0;
16954 /* Display the rest of the lines at the window end. */
16955 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16956 while (it
.current_y
< it
.last_visible_y
16957 && !fonts_changed_p
)
16959 /* Is it always sure that the display agrees with lines in
16960 the current matrix? I don't think so, so we mark rows
16961 displayed invalid in the current matrix by setting their
16962 enabled_p flag to zero. */
16963 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16964 if (display_line (&it
))
16965 last_text_row_at_end
= it
.glyph_row
- 1;
16969 /* Update window_end_pos and window_end_vpos. */
16970 if (first_unchanged_at_end_row
16971 && !last_text_row_at_end
)
16973 /* Window end line if one of the preserved rows from the current
16974 matrix. Set row to the last row displaying text in current
16975 matrix starting at first_unchanged_at_end_row, after
16977 xassert (first_unchanged_at_end_row
->displays_text_p
);
16978 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16979 first_unchanged_at_end_row
);
16980 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16982 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16983 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16985 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16986 xassert (w
->window_end_bytepos
>= 0);
16987 IF_DEBUG (debug_method_add (w
, "A"));
16989 else if (last_text_row_at_end
)
16992 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16993 w
->window_end_bytepos
16994 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16996 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16997 xassert (w
->window_end_bytepos
>= 0);
16998 IF_DEBUG (debug_method_add (w
, "B"));
17000 else if (last_text_row
)
17002 /* We have displayed either to the end of the window or at the
17003 end of the window, i.e. the last row with text is to be found
17004 in the desired matrix. */
17006 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17007 w
->window_end_bytepos
17008 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17010 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17011 xassert (w
->window_end_bytepos
>= 0);
17013 else if (first_unchanged_at_end_row
== NULL
17014 && last_text_row
== NULL
17015 && last_text_row_at_end
== NULL
)
17017 /* Displayed to end of window, but no line containing text was
17018 displayed. Lines were deleted at the end of the window. */
17019 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17020 int vpos
= XFASTINT (w
->window_end_vpos
);
17021 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17022 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17025 row
== NULL
&& vpos
>= first_vpos
;
17026 --vpos
, --current_row
, --desired_row
)
17028 if (desired_row
->enabled_p
)
17030 if (desired_row
->displays_text_p
)
17033 else if (current_row
->displays_text_p
)
17037 xassert (row
!= NULL
);
17038 w
->window_end_vpos
= make_number (vpos
+ 1);
17039 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17040 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17041 xassert (w
->window_end_bytepos
>= 0);
17042 IF_DEBUG (debug_method_add (w
, "C"));
17047 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17048 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17050 /* Record that display has not been completed. */
17051 w
->window_end_valid
= Qnil
;
17052 w
->desired_matrix
->no_scrolling_p
= 1;
17060 /***********************************************************************
17061 More debugging support
17062 ***********************************************************************/
17066 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17067 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17068 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17071 /* Dump the contents of glyph matrix MATRIX on stderr.
17073 GLYPHS 0 means don't show glyph contents.
17074 GLYPHS 1 means show glyphs in short form
17075 GLYPHS > 1 means show glyphs in long form. */
17078 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17081 for (i
= 0; i
< matrix
->nrows
; ++i
)
17082 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17086 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17087 the glyph row and area where the glyph comes from. */
17090 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17092 if (glyph
->type
== CHAR_GLYPH
)
17095 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17096 glyph
- row
->glyphs
[TEXT_AREA
],
17099 (BUFFERP (glyph
->object
)
17101 : (STRINGP (glyph
->object
)
17104 glyph
->pixel_width
,
17106 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17110 glyph
->left_box_line_p
,
17111 glyph
->right_box_line_p
);
17113 else if (glyph
->type
== STRETCH_GLYPH
)
17116 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17117 glyph
- row
->glyphs
[TEXT_AREA
],
17120 (BUFFERP (glyph
->object
)
17122 : (STRINGP (glyph
->object
)
17125 glyph
->pixel_width
,
17129 glyph
->left_box_line_p
,
17130 glyph
->right_box_line_p
);
17132 else if (glyph
->type
== IMAGE_GLYPH
)
17135 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17136 glyph
- row
->glyphs
[TEXT_AREA
],
17139 (BUFFERP (glyph
->object
)
17141 : (STRINGP (glyph
->object
)
17144 glyph
->pixel_width
,
17148 glyph
->left_box_line_p
,
17149 glyph
->right_box_line_p
);
17151 else if (glyph
->type
== COMPOSITE_GLYPH
)
17154 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17155 glyph
- row
->glyphs
[TEXT_AREA
],
17158 (BUFFERP (glyph
->object
)
17160 : (STRINGP (glyph
->object
)
17163 glyph
->pixel_width
,
17165 if (glyph
->u
.cmp
.automatic
)
17168 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17169 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17171 glyph
->left_box_line_p
,
17172 glyph
->right_box_line_p
);
17177 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17178 GLYPHS 0 means don't show glyph contents.
17179 GLYPHS 1 means show glyphs in short form
17180 GLYPHS > 1 means show glyphs in long form. */
17183 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17187 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17188 fprintf (stderr
, "======================================================================\n");
17190 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17191 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17193 MATRIX_ROW_START_CHARPOS (row
),
17194 MATRIX_ROW_END_CHARPOS (row
),
17195 row
->used
[TEXT_AREA
],
17196 row
->contains_overlapping_glyphs_p
,
17198 row
->truncated_on_left_p
,
17199 row
->truncated_on_right_p
,
17201 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17202 row
->displays_text_p
,
17205 row
->ends_in_middle_of_char_p
,
17206 row
->starts_in_middle_of_char_p
,
17212 row
->visible_height
,
17215 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17216 row
->end
.overlay_string_index
,
17217 row
->continuation_lines_width
);
17218 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17219 CHARPOS (row
->start
.string_pos
),
17220 CHARPOS (row
->end
.string_pos
));
17221 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17222 row
->end
.dpvec_index
);
17229 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17231 struct glyph
*glyph
= row
->glyphs
[area
];
17232 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17234 /* Glyph for a line end in text. */
17235 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17238 if (glyph
< glyph_end
)
17239 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17241 for (; glyph
< glyph_end
; ++glyph
)
17242 dump_glyph (row
, glyph
, area
);
17245 else if (glyphs
== 1)
17249 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17251 char *s
= (char *) alloca (row
->used
[area
] + 1);
17254 for (i
= 0; i
< row
->used
[area
]; ++i
)
17256 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17257 if (glyph
->type
== CHAR_GLYPH
17258 && glyph
->u
.ch
< 0x80
17259 && glyph
->u
.ch
>= ' ')
17260 s
[i
] = glyph
->u
.ch
;
17266 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17272 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17273 Sdump_glyph_matrix
, 0, 1, "p",
17274 doc
: /* Dump the current matrix of the selected window to stderr.
17275 Shows contents of glyph row structures. With non-nil
17276 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17277 glyphs in short form, otherwise show glyphs in long form. */)
17278 (Lisp_Object glyphs
)
17280 struct window
*w
= XWINDOW (selected_window
);
17281 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17283 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17284 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17285 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17286 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17287 fprintf (stderr
, "=============================================\n");
17288 dump_glyph_matrix (w
->current_matrix
,
17289 NILP (glyphs
) ? 0 : XINT (glyphs
));
17294 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17295 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17298 struct frame
*f
= XFRAME (selected_frame
);
17299 dump_glyph_matrix (f
->current_matrix
, 1);
17304 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17305 doc
: /* Dump glyph row ROW to stderr.
17306 GLYPH 0 means don't dump glyphs.
17307 GLYPH 1 means dump glyphs in short form.
17308 GLYPH > 1 or omitted means dump glyphs in long form. */)
17309 (Lisp_Object row
, Lisp_Object glyphs
)
17311 struct glyph_matrix
*matrix
;
17314 CHECK_NUMBER (row
);
17315 matrix
= XWINDOW (selected_window
)->current_matrix
;
17317 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17318 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17320 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17325 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17326 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17327 GLYPH 0 means don't dump glyphs.
17328 GLYPH 1 means dump glyphs in short form.
17329 GLYPH > 1 or omitted means dump glyphs in long form. */)
17330 (Lisp_Object row
, Lisp_Object glyphs
)
17332 struct frame
*sf
= SELECTED_FRAME ();
17333 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17336 CHECK_NUMBER (row
);
17338 if (vpos
>= 0 && vpos
< m
->nrows
)
17339 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17340 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17345 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17346 doc
: /* Toggle tracing of redisplay.
17347 With ARG, turn tracing on if and only if ARG is positive. */)
17351 trace_redisplay_p
= !trace_redisplay_p
;
17354 arg
= Fprefix_numeric_value (arg
);
17355 trace_redisplay_p
= XINT (arg
) > 0;
17362 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17363 doc
: /* Like `format', but print result to stderr.
17364 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17365 (ptrdiff_t nargs
, Lisp_Object
*args
)
17367 Lisp_Object s
= Fformat (nargs
, args
);
17368 fprintf (stderr
, "%s", SDATA (s
));
17372 #endif /* GLYPH_DEBUG */
17376 /***********************************************************************
17377 Building Desired Matrix Rows
17378 ***********************************************************************/
17380 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17381 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17383 static struct glyph_row
*
17384 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17386 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17387 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17388 struct buffer
*old
= current_buffer
;
17389 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17390 int arrow_len
= SCHARS (overlay_arrow_string
);
17391 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17392 const unsigned char *p
;
17395 int n_glyphs_before
;
17397 set_buffer_temp (buffer
);
17398 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17399 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17400 SET_TEXT_POS (it
.position
, 0, 0);
17402 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17404 while (p
< arrow_end
)
17406 Lisp_Object face
, ilisp
;
17408 /* Get the next character. */
17410 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17413 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17414 if (! ASCII_CHAR_P (it
.c
))
17415 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17419 /* Get its face. */
17420 ilisp
= make_number (p
- arrow_string
);
17421 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17422 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17424 /* Compute its width, get its glyphs. */
17425 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17426 SET_TEXT_POS (it
.position
, -1, -1);
17427 PRODUCE_GLYPHS (&it
);
17429 /* If this character doesn't fit any more in the line, we have
17430 to remove some glyphs. */
17431 if (it
.current_x
> it
.last_visible_x
)
17433 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17438 set_buffer_temp (old
);
17439 return it
.glyph_row
;
17443 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17444 glyphs are only inserted for terminal frames since we can't really
17445 win with truncation glyphs when partially visible glyphs are
17446 involved. Which glyphs to insert is determined by
17447 produce_special_glyphs. */
17450 insert_left_trunc_glyphs (struct it
*it
)
17452 struct it truncate_it
;
17453 struct glyph
*from
, *end
, *to
, *toend
;
17455 xassert (!FRAME_WINDOW_P (it
->f
));
17457 /* Get the truncation glyphs. */
17459 truncate_it
.current_x
= 0;
17460 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17461 truncate_it
.glyph_row
= &scratch_glyph_row
;
17462 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17463 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17464 truncate_it
.object
= make_number (0);
17465 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17467 /* Overwrite glyphs from IT with truncation glyphs. */
17468 if (!it
->glyph_row
->reversed_p
)
17470 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17471 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17472 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17473 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17478 /* There may be padding glyphs left over. Overwrite them too. */
17479 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17481 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17487 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17491 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17492 that back to front. */
17493 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17494 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17495 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17496 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17498 while (from
>= end
&& to
>= toend
)
17500 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17503 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17504 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17505 while (from
>= end
&& to
>= toend
)
17510 /* Need to free some room before prepending additional
17512 int move_by
= from
- end
+ 1;
17513 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17514 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17516 for ( ; g
>= g0
; g
--)
17518 while (from
>= end
)
17520 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17526 /* Compute the pixel height and width of IT->glyph_row.
17528 Most of the time, ascent and height of a display line will be equal
17529 to the max_ascent and max_height values of the display iterator
17530 structure. This is not the case if
17532 1. We hit ZV without displaying anything. In this case, max_ascent
17533 and max_height will be zero.
17535 2. We have some glyphs that don't contribute to the line height.
17536 (The glyph row flag contributes_to_line_height_p is for future
17537 pixmap extensions).
17539 The first case is easily covered by using default values because in
17540 these cases, the line height does not really matter, except that it
17541 must not be zero. */
17544 compute_line_metrics (struct it
*it
)
17546 struct glyph_row
*row
= it
->glyph_row
;
17548 if (FRAME_WINDOW_P (it
->f
))
17550 int i
, min_y
, max_y
;
17552 /* The line may consist of one space only, that was added to
17553 place the cursor on it. If so, the row's height hasn't been
17555 if (row
->height
== 0)
17557 if (it
->max_ascent
+ it
->max_descent
== 0)
17558 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17559 row
->ascent
= it
->max_ascent
;
17560 row
->height
= it
->max_ascent
+ it
->max_descent
;
17561 row
->phys_ascent
= it
->max_phys_ascent
;
17562 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17563 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17566 /* Compute the width of this line. */
17567 row
->pixel_width
= row
->x
;
17568 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17569 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17571 xassert (row
->pixel_width
>= 0);
17572 xassert (row
->ascent
>= 0 && row
->height
> 0);
17574 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17575 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17577 /* If first line's physical ascent is larger than its logical
17578 ascent, use the physical ascent, and make the row taller.
17579 This makes accented characters fully visible. */
17580 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17581 && row
->phys_ascent
> row
->ascent
)
17583 row
->height
+= row
->phys_ascent
- row
->ascent
;
17584 row
->ascent
= row
->phys_ascent
;
17587 /* Compute how much of the line is visible. */
17588 row
->visible_height
= row
->height
;
17590 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17591 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17593 if (row
->y
< min_y
)
17594 row
->visible_height
-= min_y
- row
->y
;
17595 if (row
->y
+ row
->height
> max_y
)
17596 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17600 row
->pixel_width
= row
->used
[TEXT_AREA
];
17601 if (row
->continued_p
)
17602 row
->pixel_width
-= it
->continuation_pixel_width
;
17603 else if (row
->truncated_on_right_p
)
17604 row
->pixel_width
-= it
->truncation_pixel_width
;
17605 row
->ascent
= row
->phys_ascent
= 0;
17606 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17607 row
->extra_line_spacing
= 0;
17610 /* Compute a hash code for this row. */
17614 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17615 for (i
= 0; i
< row
->used
[area
]; ++i
)
17616 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17617 + row
->glyphs
[area
][i
].u
.val
17618 + row
->glyphs
[area
][i
].face_id
17619 + row
->glyphs
[area
][i
].padding_p
17620 + (row
->glyphs
[area
][i
].type
<< 2));
17623 it
->max_ascent
= it
->max_descent
= 0;
17624 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17628 /* Append one space to the glyph row of iterator IT if doing a
17629 window-based redisplay. The space has the same face as
17630 IT->face_id. Value is non-zero if a space was added.
17632 This function is called to make sure that there is always one glyph
17633 at the end of a glyph row that the cursor can be set on under
17634 window-systems. (If there weren't such a glyph we would not know
17635 how wide and tall a box cursor should be displayed).
17637 At the same time this space let's a nicely handle clearing to the
17638 end of the line if the row ends in italic text. */
17641 append_space_for_newline (struct it
*it
, int default_face_p
)
17643 if (FRAME_WINDOW_P (it
->f
))
17645 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17647 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17648 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17650 /* Save some values that must not be changed.
17651 Must save IT->c and IT->len because otherwise
17652 ITERATOR_AT_END_P wouldn't work anymore after
17653 append_space_for_newline has been called. */
17654 enum display_element_type saved_what
= it
->what
;
17655 int saved_c
= it
->c
, saved_len
= it
->len
;
17656 int saved_char_to_display
= it
->char_to_display
;
17657 int saved_x
= it
->current_x
;
17658 int saved_face_id
= it
->face_id
;
17659 struct text_pos saved_pos
;
17660 Lisp_Object saved_object
;
17663 saved_object
= it
->object
;
17664 saved_pos
= it
->position
;
17666 it
->what
= IT_CHARACTER
;
17667 memset (&it
->position
, 0, sizeof it
->position
);
17668 it
->object
= make_number (0);
17669 it
->c
= it
->char_to_display
= ' ';
17672 if (default_face_p
)
17673 it
->face_id
= DEFAULT_FACE_ID
;
17674 else if (it
->face_before_selective_p
)
17675 it
->face_id
= it
->saved_face_id
;
17676 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17677 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17679 PRODUCE_GLYPHS (it
);
17681 it
->override_ascent
= -1;
17682 it
->constrain_row_ascent_descent_p
= 0;
17683 it
->current_x
= saved_x
;
17684 it
->object
= saved_object
;
17685 it
->position
= saved_pos
;
17686 it
->what
= saved_what
;
17687 it
->face_id
= saved_face_id
;
17688 it
->len
= saved_len
;
17690 it
->char_to_display
= saved_char_to_display
;
17699 /* Extend the face of the last glyph in the text area of IT->glyph_row
17700 to the end of the display line. Called from display_line. If the
17701 glyph row is empty, add a space glyph to it so that we know the
17702 face to draw. Set the glyph row flag fill_line_p. If the glyph
17703 row is R2L, prepend a stretch glyph to cover the empty space to the
17704 left of the leftmost glyph. */
17707 extend_face_to_end_of_line (struct it
*it
)
17710 struct frame
*f
= it
->f
;
17712 /* If line is already filled, do nothing. Non window-system frames
17713 get a grace of one more ``pixel'' because their characters are
17714 1-``pixel'' wide, so they hit the equality too early. This grace
17715 is needed only for R2L rows that are not continued, to produce
17716 one extra blank where we could display the cursor. */
17717 if (it
->current_x
>= it
->last_visible_x
17718 + (!FRAME_WINDOW_P (f
)
17719 && it
->glyph_row
->reversed_p
17720 && !it
->glyph_row
->continued_p
))
17723 /* Face extension extends the background and box of IT->face_id
17724 to the end of the line. If the background equals the background
17725 of the frame, we don't have to do anything. */
17726 if (it
->face_before_selective_p
)
17727 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17729 face
= FACE_FROM_ID (f
, it
->face_id
);
17731 if (FRAME_WINDOW_P (f
)
17732 && it
->glyph_row
->displays_text_p
17733 && face
->box
== FACE_NO_BOX
17734 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17736 && !it
->glyph_row
->reversed_p
)
17739 /* Set the glyph row flag indicating that the face of the last glyph
17740 in the text area has to be drawn to the end of the text area. */
17741 it
->glyph_row
->fill_line_p
= 1;
17743 /* If current character of IT is not ASCII, make sure we have the
17744 ASCII face. This will be automatically undone the next time
17745 get_next_display_element returns a multibyte character. Note
17746 that the character will always be single byte in unibyte
17748 if (!ASCII_CHAR_P (it
->c
))
17750 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17753 if (FRAME_WINDOW_P (f
))
17755 /* If the row is empty, add a space with the current face of IT,
17756 so that we know which face to draw. */
17757 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17759 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17760 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17761 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17763 #ifdef HAVE_WINDOW_SYSTEM
17764 if (it
->glyph_row
->reversed_p
)
17766 /* Prepend a stretch glyph to the row, such that the
17767 rightmost glyph will be drawn flushed all the way to the
17768 right margin of the window. The stretch glyph that will
17769 occupy the empty space, if any, to the left of the
17771 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17772 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17773 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17775 int row_width
, stretch_ascent
, stretch_width
;
17776 struct text_pos saved_pos
;
17777 int saved_face_id
, saved_avoid_cursor
;
17779 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17780 row_width
+= g
->pixel_width
;
17781 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17782 if (stretch_width
> 0)
17785 (((it
->ascent
+ it
->descent
)
17786 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17787 saved_pos
= it
->position
;
17788 memset (&it
->position
, 0, sizeof it
->position
);
17789 saved_avoid_cursor
= it
->avoid_cursor_p
;
17790 it
->avoid_cursor_p
= 1;
17791 saved_face_id
= it
->face_id
;
17792 /* The last row's stretch glyph should get the default
17793 face, to avoid painting the rest of the window with
17794 the region face, if the region ends at ZV. */
17795 if (it
->glyph_row
->ends_at_zv_p
)
17796 it
->face_id
= DEFAULT_FACE_ID
;
17798 it
->face_id
= face
->id
;
17799 append_stretch_glyph (it
, make_number (0), stretch_width
,
17800 it
->ascent
+ it
->descent
, stretch_ascent
);
17801 it
->position
= saved_pos
;
17802 it
->avoid_cursor_p
= saved_avoid_cursor
;
17803 it
->face_id
= saved_face_id
;
17806 #endif /* HAVE_WINDOW_SYSTEM */
17810 /* Save some values that must not be changed. */
17811 int saved_x
= it
->current_x
;
17812 struct text_pos saved_pos
;
17813 Lisp_Object saved_object
;
17814 enum display_element_type saved_what
= it
->what
;
17815 int saved_face_id
= it
->face_id
;
17817 saved_object
= it
->object
;
17818 saved_pos
= it
->position
;
17820 it
->what
= IT_CHARACTER
;
17821 memset (&it
->position
, 0, sizeof it
->position
);
17822 it
->object
= make_number (0);
17823 it
->c
= it
->char_to_display
= ' ';
17825 /* The last row's blank glyphs should get the default face, to
17826 avoid painting the rest of the window with the region face,
17827 if the region ends at ZV. */
17828 if (it
->glyph_row
->ends_at_zv_p
)
17829 it
->face_id
= DEFAULT_FACE_ID
;
17831 it
->face_id
= face
->id
;
17833 PRODUCE_GLYPHS (it
);
17835 while (it
->current_x
<= it
->last_visible_x
)
17836 PRODUCE_GLYPHS (it
);
17838 /* Don't count these blanks really. It would let us insert a left
17839 truncation glyph below and make us set the cursor on them, maybe. */
17840 it
->current_x
= saved_x
;
17841 it
->object
= saved_object
;
17842 it
->position
= saved_pos
;
17843 it
->what
= saved_what
;
17844 it
->face_id
= saved_face_id
;
17849 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17850 trailing whitespace. */
17853 trailing_whitespace_p (EMACS_INT charpos
)
17855 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17858 while (bytepos
< ZV_BYTE
17859 && (c
= FETCH_CHAR (bytepos
),
17860 c
== ' ' || c
== '\t'))
17863 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17865 if (bytepos
!= PT_BYTE
)
17872 /* Highlight trailing whitespace, if any, in ROW. */
17875 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17877 int used
= row
->used
[TEXT_AREA
];
17881 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17882 struct glyph
*glyph
= start
+ used
- 1;
17884 if (row
->reversed_p
)
17886 /* Right-to-left rows need to be processed in the opposite
17887 direction, so swap the edge pointers. */
17889 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17892 /* Skip over glyphs inserted to display the cursor at the
17893 end of a line, for extending the face of the last glyph
17894 to the end of the line on terminals, and for truncation
17895 and continuation glyphs. */
17896 if (!row
->reversed_p
)
17898 while (glyph
>= start
17899 && glyph
->type
== CHAR_GLYPH
17900 && INTEGERP (glyph
->object
))
17905 while (glyph
<= start
17906 && glyph
->type
== CHAR_GLYPH
17907 && INTEGERP (glyph
->object
))
17911 /* If last glyph is a space or stretch, and it's trailing
17912 whitespace, set the face of all trailing whitespace glyphs in
17913 IT->glyph_row to `trailing-whitespace'. */
17914 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17915 && BUFFERP (glyph
->object
)
17916 && (glyph
->type
== STRETCH_GLYPH
17917 || (glyph
->type
== CHAR_GLYPH
17918 && glyph
->u
.ch
== ' '))
17919 && trailing_whitespace_p (glyph
->charpos
))
17921 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17925 if (!row
->reversed_p
)
17927 while (glyph
>= start
17928 && BUFFERP (glyph
->object
)
17929 && (glyph
->type
== STRETCH_GLYPH
17930 || (glyph
->type
== CHAR_GLYPH
17931 && glyph
->u
.ch
== ' ')))
17932 (glyph
--)->face_id
= face_id
;
17936 while (glyph
<= start
17937 && BUFFERP (glyph
->object
)
17938 && (glyph
->type
== STRETCH_GLYPH
17939 || (glyph
->type
== CHAR_GLYPH
17940 && glyph
->u
.ch
== ' ')))
17941 (glyph
++)->face_id
= face_id
;
17948 /* Value is non-zero if glyph row ROW should be
17949 used to hold the cursor. */
17952 cursor_row_p (struct glyph_row
*row
)
17956 if (PT
== CHARPOS (row
->end
.pos
))
17958 /* Suppose the row ends on a string.
17959 Unless the row is continued, that means it ends on a newline
17960 in the string. If it's anything other than a display string
17961 (e.g. a before-string from an overlay), we don't want the
17962 cursor there. (This heuristic seems to give the optimal
17963 behavior for the various types of multi-line strings.) */
17964 if (CHARPOS (row
->end
.string_pos
) >= 0)
17966 if (row
->continued_p
)
17970 /* Check for `display' property. */
17971 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17972 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17973 struct glyph
*glyph
;
17976 for (glyph
= end
; glyph
>= beg
; --glyph
)
17977 if (STRINGP (glyph
->object
))
17980 = Fget_char_property (make_number (PT
),
17984 && display_prop_string_p (prop
, glyph
->object
));
17989 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17991 /* If the row ends in middle of a real character,
17992 and the line is continued, we want the cursor here.
17993 That's because CHARPOS (ROW->end.pos) would equal
17994 PT if PT is before the character. */
17995 if (!row
->ends_in_ellipsis_p
)
17996 result
= row
->continued_p
;
17998 /* If the row ends in an ellipsis, then
17999 CHARPOS (ROW->end.pos) will equal point after the
18000 invisible text. We want that position to be displayed
18001 after the ellipsis. */
18004 /* If the row ends at ZV, display the cursor at the end of that
18005 row instead of at the start of the row below. */
18006 else if (row
->ends_at_zv_p
)
18017 /* Push the display property PROP so that it will be rendered at the
18018 current position in IT. Return 1 if PROP was successfully pushed,
18022 push_display_prop (struct it
*it
, Lisp_Object prop
)
18024 xassert (it
->method
== GET_FROM_BUFFER
);
18026 push_it (it
, NULL
);
18028 if (STRINGP (prop
))
18030 if (SCHARS (prop
) == 0)
18037 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18038 it
->current
.overlay_string_index
= -1;
18039 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18040 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18041 it
->method
= GET_FROM_STRING
;
18042 it
->stop_charpos
= 0;
18044 it
->base_level_stop
= 0;
18045 it
->string_from_display_prop_p
= 1;
18046 it
->from_disp_prop_p
= 1;
18048 /* Force paragraph direction to be that of the parent
18050 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18051 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18053 it
->paragraph_embedding
= L2R
;
18055 /* Set up the bidi iterator for this display string. */
18058 it
->bidi_it
.string
.lstring
= it
->string
;
18059 it
->bidi_it
.string
.s
= NULL
;
18060 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18061 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18062 it
->bidi_it
.string
.from_disp_str
= 1;
18063 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18064 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18067 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18069 it
->method
= GET_FROM_STRETCH
;
18072 #ifdef HAVE_WINDOW_SYSTEM
18073 else if (IMAGEP (prop
))
18075 it
->what
= IT_IMAGE
;
18076 it
->image_id
= lookup_image (it
->f
, prop
);
18077 it
->method
= GET_FROM_IMAGE
;
18079 #endif /* HAVE_WINDOW_SYSTEM */
18082 pop_it (it
); /* bogus display property, give up */
18089 /* Return the character-property PROP at the current position in IT. */
18092 get_it_property (struct it
*it
, Lisp_Object prop
)
18094 Lisp_Object position
;
18096 if (STRINGP (it
->object
))
18097 position
= make_number (IT_STRING_CHARPOS (*it
));
18098 else if (BUFFERP (it
->object
))
18099 position
= make_number (IT_CHARPOS (*it
));
18103 return Fget_char_property (position
, prop
, it
->object
);
18106 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18109 handle_line_prefix (struct it
*it
)
18111 Lisp_Object prefix
;
18113 if (it
->continuation_lines_width
> 0)
18115 prefix
= get_it_property (it
, Qwrap_prefix
);
18117 prefix
= Vwrap_prefix
;
18121 prefix
= get_it_property (it
, Qline_prefix
);
18123 prefix
= Vline_prefix
;
18125 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18127 /* If the prefix is wider than the window, and we try to wrap
18128 it, it would acquire its own wrap prefix, and so on till the
18129 iterator stack overflows. So, don't wrap the prefix. */
18130 it
->line_wrap
= TRUNCATE
;
18131 it
->avoid_cursor_p
= 1;
18137 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18138 only for R2L lines from display_line and display_string, when they
18139 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18140 the line/string needs to be continued on the next glyph row. */
18142 unproduce_glyphs (struct it
*it
, int n
)
18144 struct glyph
*glyph
, *end
;
18146 xassert (it
->glyph_row
);
18147 xassert (it
->glyph_row
->reversed_p
);
18148 xassert (it
->area
== TEXT_AREA
);
18149 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18151 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18152 n
= it
->glyph_row
->used
[TEXT_AREA
];
18153 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18154 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18155 for ( ; glyph
< end
; glyph
++)
18156 glyph
[-n
] = *glyph
;
18159 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18160 and ROW->maxpos. */
18162 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18163 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18164 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18166 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18167 lines' rows is implemented for bidi-reordered rows. */
18169 /* ROW->minpos is the value of min_pos, the minimal buffer position
18170 we have in ROW, or ROW->start.pos if that is smaller. */
18171 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18172 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18174 /* We didn't find buffer positions smaller than ROW->start, or
18175 didn't find _any_ valid buffer positions in any of the glyphs,
18176 so we must trust the iterator's computed positions. */
18177 row
->minpos
= row
->start
.pos
;
18180 max_pos
= CHARPOS (it
->current
.pos
);
18181 max_bpos
= BYTEPOS (it
->current
.pos
);
18184 /* Here are the various use-cases for ending the row, and the
18185 corresponding values for ROW->maxpos:
18187 Line ends in a newline from buffer eol_pos + 1
18188 Line is continued from buffer max_pos + 1
18189 Line is truncated on right it->current.pos
18190 Line ends in a newline from string max_pos
18191 Line is continued from string max_pos
18192 Line is continued from display vector max_pos
18193 Line is entirely from a string min_pos == max_pos
18194 Line is entirely from a display vector min_pos == max_pos
18195 Line that ends at ZV ZV
18197 If you discover other use-cases, please add them here as
18199 if (row
->ends_at_zv_p
)
18200 row
->maxpos
= it
->current
.pos
;
18201 else if (row
->used
[TEXT_AREA
])
18203 if (row
->ends_in_newline_from_string_p
)
18204 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18205 else if (CHARPOS (it
->eol_pos
) > 0)
18206 SET_TEXT_POS (row
->maxpos
,
18207 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18208 else if (row
->continued_p
)
18210 /* If max_pos is different from IT's current position, it
18211 means IT->method does not belong to the display element
18212 at max_pos. However, it also means that the display
18213 element at max_pos was displayed in its entirety on this
18214 line, which is equivalent to saying that the next line
18215 starts at the next buffer position. */
18216 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18217 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18220 INC_BOTH (max_pos
, max_bpos
);
18221 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18224 else if (row
->truncated_on_right_p
)
18225 /* display_line already called reseat_at_next_visible_line_start,
18226 which puts the iterator at the beginning of the next line, in
18227 the logical order. */
18228 row
->maxpos
= it
->current
.pos
;
18229 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18230 /* A line that is entirely from a string/image/stretch... */
18231 row
->maxpos
= row
->minpos
;
18236 row
->maxpos
= it
->current
.pos
;
18239 /* Construct the glyph row IT->glyph_row in the desired matrix of
18240 IT->w from text at the current position of IT. See dispextern.h
18241 for an overview of struct it. Value is non-zero if
18242 IT->glyph_row displays text, as opposed to a line displaying ZV
18246 display_line (struct it
*it
)
18248 struct glyph_row
*row
= it
->glyph_row
;
18249 Lisp_Object overlay_arrow_string
;
18251 void *wrap_data
= NULL
;
18252 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18253 int wrap_row_used
= -1;
18254 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18255 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18256 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18257 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18258 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18260 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18261 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18263 /* We always start displaying at hpos zero even if hscrolled. */
18264 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18266 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18267 >= it
->w
->desired_matrix
->nrows
)
18269 it
->w
->nrows_scale_factor
++;
18270 fonts_changed_p
= 1;
18274 /* Is IT->w showing the region? */
18275 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18277 /* Clear the result glyph row and enable it. */
18278 prepare_desired_row (row
);
18280 row
->y
= it
->current_y
;
18281 row
->start
= it
->start
;
18282 row
->continuation_lines_width
= it
->continuation_lines_width
;
18283 row
->displays_text_p
= 1;
18284 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18285 it
->starts_in_middle_of_char_p
= 0;
18287 /* Arrange the overlays nicely for our purposes. Usually, we call
18288 display_line on only one line at a time, in which case this
18289 can't really hurt too much, or we call it on lines which appear
18290 one after another in the buffer, in which case all calls to
18291 recenter_overlay_lists but the first will be pretty cheap. */
18292 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18294 /* Move over display elements that are not visible because we are
18295 hscrolled. This may stop at an x-position < IT->first_visible_x
18296 if the first glyph is partially visible or if we hit a line end. */
18297 if (it
->current_x
< it
->first_visible_x
)
18299 this_line_min_pos
= row
->start
.pos
;
18300 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18301 MOVE_TO_POS
| MOVE_TO_X
);
18302 /* Record the smallest positions seen while we moved over
18303 display elements that are not visible. This is needed by
18304 redisplay_internal for optimizing the case where the cursor
18305 stays inside the same line. The rest of this function only
18306 considers positions that are actually displayed, so
18307 RECORD_MAX_MIN_POS will not otherwise record positions that
18308 are hscrolled to the left of the left edge of the window. */
18309 min_pos
= CHARPOS (this_line_min_pos
);
18310 min_bpos
= BYTEPOS (this_line_min_pos
);
18314 /* We only do this when not calling `move_it_in_display_line_to'
18315 above, because move_it_in_display_line_to calls
18316 handle_line_prefix itself. */
18317 handle_line_prefix (it
);
18320 /* Get the initial row height. This is either the height of the
18321 text hscrolled, if there is any, or zero. */
18322 row
->ascent
= it
->max_ascent
;
18323 row
->height
= it
->max_ascent
+ it
->max_descent
;
18324 row
->phys_ascent
= it
->max_phys_ascent
;
18325 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18326 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18328 /* Utility macro to record max and min buffer positions seen until now. */
18329 #define RECORD_MAX_MIN_POS(IT) \
18332 if (IT_CHARPOS (*(IT)) < min_pos) \
18334 min_pos = IT_CHARPOS (*(IT)); \
18335 min_bpos = IT_BYTEPOS (*(IT)); \
18337 if (IT_CHARPOS (*(IT)) > max_pos) \
18339 max_pos = IT_CHARPOS (*(IT)); \
18340 max_bpos = IT_BYTEPOS (*(IT)); \
18345 /* Loop generating characters. The loop is left with IT on the next
18346 character to display. */
18349 int n_glyphs_before
, hpos_before
, x_before
;
18351 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18353 /* Retrieve the next thing to display. Value is zero if end of
18355 if (!get_next_display_element (it
))
18357 /* Maybe add a space at the end of this line that is used to
18358 display the cursor there under X. Set the charpos of the
18359 first glyph of blank lines not corresponding to any text
18361 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18362 row
->exact_window_width_line_p
= 1;
18363 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18364 || row
->used
[TEXT_AREA
] == 0)
18366 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18367 row
->displays_text_p
= 0;
18369 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18370 && (!MINI_WINDOW_P (it
->w
)
18371 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18372 row
->indicate_empty_line_p
= 1;
18375 it
->continuation_lines_width
= 0;
18376 row
->ends_at_zv_p
= 1;
18377 /* A row that displays right-to-left text must always have
18378 its last face extended all the way to the end of line,
18379 even if this row ends in ZV, because we still write to
18380 the screen left to right. */
18381 if (row
->reversed_p
)
18382 extend_face_to_end_of_line (it
);
18386 /* Now, get the metrics of what we want to display. This also
18387 generates glyphs in `row' (which is IT->glyph_row). */
18388 n_glyphs_before
= row
->used
[TEXT_AREA
];
18391 /* Remember the line height so far in case the next element doesn't
18392 fit on the line. */
18393 if (it
->line_wrap
!= TRUNCATE
)
18395 ascent
= it
->max_ascent
;
18396 descent
= it
->max_descent
;
18397 phys_ascent
= it
->max_phys_ascent
;
18398 phys_descent
= it
->max_phys_descent
;
18400 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18402 if (IT_DISPLAYING_WHITESPACE (it
))
18406 SAVE_IT (wrap_it
, *it
, wrap_data
);
18408 wrap_row_used
= row
->used
[TEXT_AREA
];
18409 wrap_row_ascent
= row
->ascent
;
18410 wrap_row_height
= row
->height
;
18411 wrap_row_phys_ascent
= row
->phys_ascent
;
18412 wrap_row_phys_height
= row
->phys_height
;
18413 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18414 wrap_row_min_pos
= min_pos
;
18415 wrap_row_min_bpos
= min_bpos
;
18416 wrap_row_max_pos
= max_pos
;
18417 wrap_row_max_bpos
= max_bpos
;
18423 PRODUCE_GLYPHS (it
);
18425 /* If this display element was in marginal areas, continue with
18427 if (it
->area
!= TEXT_AREA
)
18429 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18430 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18431 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18432 row
->phys_height
= max (row
->phys_height
,
18433 it
->max_phys_ascent
+ it
->max_phys_descent
);
18434 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18435 it
->max_extra_line_spacing
);
18436 set_iterator_to_next (it
, 1);
18440 /* Does the display element fit on the line? If we truncate
18441 lines, we should draw past the right edge of the window. If
18442 we don't truncate, we want to stop so that we can display the
18443 continuation glyph before the right margin. If lines are
18444 continued, there are two possible strategies for characters
18445 resulting in more than 1 glyph (e.g. tabs): Display as many
18446 glyphs as possible in this line and leave the rest for the
18447 continuation line, or display the whole element in the next
18448 line. Original redisplay did the former, so we do it also. */
18449 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18450 hpos_before
= it
->hpos
;
18453 if (/* Not a newline. */
18455 /* Glyphs produced fit entirely in the line. */
18456 && it
->current_x
< it
->last_visible_x
)
18458 it
->hpos
+= nglyphs
;
18459 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18460 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18461 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18462 row
->phys_height
= max (row
->phys_height
,
18463 it
->max_phys_ascent
+ it
->max_phys_descent
);
18464 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18465 it
->max_extra_line_spacing
);
18466 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18467 row
->x
= x
- it
->first_visible_x
;
18468 /* Record the maximum and minimum buffer positions seen so
18469 far in glyphs that will be displayed by this row. */
18471 RECORD_MAX_MIN_POS (it
);
18476 struct glyph
*glyph
;
18478 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18480 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18481 new_x
= x
+ glyph
->pixel_width
;
18483 if (/* Lines are continued. */
18484 it
->line_wrap
!= TRUNCATE
18485 && (/* Glyph doesn't fit on the line. */
18486 new_x
> it
->last_visible_x
18487 /* Or it fits exactly on a window system frame. */
18488 || (new_x
== it
->last_visible_x
18489 && FRAME_WINDOW_P (it
->f
))))
18491 /* End of a continued line. */
18494 || (new_x
== it
->last_visible_x
18495 && FRAME_WINDOW_P (it
->f
)))
18497 /* Current glyph is the only one on the line or
18498 fits exactly on the line. We must continue
18499 the line because we can't draw the cursor
18500 after the glyph. */
18501 row
->continued_p
= 1;
18502 it
->current_x
= new_x
;
18503 it
->continuation_lines_width
+= new_x
;
18505 /* Record the maximum and minimum buffer
18506 positions seen so far in glyphs that will be
18507 displayed by this row. */
18509 RECORD_MAX_MIN_POS (it
);
18510 if (i
== nglyphs
- 1)
18512 /* If line-wrap is on, check if a previous
18513 wrap point was found. */
18514 if (wrap_row_used
> 0
18515 /* Even if there is a previous wrap
18516 point, continue the line here as
18517 usual, if (i) the previous character
18518 was a space or tab AND (ii) the
18519 current character is not. */
18521 || IT_DISPLAYING_WHITESPACE (it
)))
18524 set_iterator_to_next (it
, 1);
18525 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18527 if (!get_next_display_element (it
))
18529 row
->exact_window_width_line_p
= 1;
18530 it
->continuation_lines_width
= 0;
18531 row
->continued_p
= 0;
18532 row
->ends_at_zv_p
= 1;
18534 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18536 row
->continued_p
= 0;
18537 row
->exact_window_width_line_p
= 1;
18542 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18543 && !FRAME_WINDOW_P (it
->f
))
18545 /* A padding glyph that doesn't fit on this line.
18546 This means the whole character doesn't fit
18548 if (row
->reversed_p
)
18549 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18550 - n_glyphs_before
);
18551 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18553 /* Fill the rest of the row with continuation
18554 glyphs like in 20.x. */
18555 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18556 < row
->glyphs
[1 + TEXT_AREA
])
18557 produce_special_glyphs (it
, IT_CONTINUATION
);
18559 row
->continued_p
= 1;
18560 it
->current_x
= x_before
;
18561 it
->continuation_lines_width
+= x_before
;
18563 /* Restore the height to what it was before the
18564 element not fitting on the line. */
18565 it
->max_ascent
= ascent
;
18566 it
->max_descent
= descent
;
18567 it
->max_phys_ascent
= phys_ascent
;
18568 it
->max_phys_descent
= phys_descent
;
18570 else if (wrap_row_used
> 0)
18573 if (row
->reversed_p
)
18574 unproduce_glyphs (it
,
18575 row
->used
[TEXT_AREA
] - wrap_row_used
);
18576 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18577 it
->continuation_lines_width
+= wrap_x
;
18578 row
->used
[TEXT_AREA
] = wrap_row_used
;
18579 row
->ascent
= wrap_row_ascent
;
18580 row
->height
= wrap_row_height
;
18581 row
->phys_ascent
= wrap_row_phys_ascent
;
18582 row
->phys_height
= wrap_row_phys_height
;
18583 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18584 min_pos
= wrap_row_min_pos
;
18585 min_bpos
= wrap_row_min_bpos
;
18586 max_pos
= wrap_row_max_pos
;
18587 max_bpos
= wrap_row_max_bpos
;
18588 row
->continued_p
= 1;
18589 row
->ends_at_zv_p
= 0;
18590 row
->exact_window_width_line_p
= 0;
18591 it
->continuation_lines_width
+= x
;
18593 /* Make sure that a non-default face is extended
18594 up to the right margin of the window. */
18595 extend_face_to_end_of_line (it
);
18597 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18599 /* A TAB that extends past the right edge of the
18600 window. This produces a single glyph on
18601 window system frames. We leave the glyph in
18602 this row and let it fill the row, but don't
18603 consume the TAB. */
18604 it
->continuation_lines_width
+= it
->last_visible_x
;
18605 row
->ends_in_middle_of_char_p
= 1;
18606 row
->continued_p
= 1;
18607 glyph
->pixel_width
= it
->last_visible_x
- x
;
18608 it
->starts_in_middle_of_char_p
= 1;
18612 /* Something other than a TAB that draws past
18613 the right edge of the window. Restore
18614 positions to values before the element. */
18615 if (row
->reversed_p
)
18616 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18617 - (n_glyphs_before
+ i
));
18618 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18620 /* Display continuation glyphs. */
18621 if (!FRAME_WINDOW_P (it
->f
))
18622 produce_special_glyphs (it
, IT_CONTINUATION
);
18623 row
->continued_p
= 1;
18625 it
->current_x
= x_before
;
18626 it
->continuation_lines_width
+= x
;
18627 extend_face_to_end_of_line (it
);
18629 if (nglyphs
> 1 && i
> 0)
18631 row
->ends_in_middle_of_char_p
= 1;
18632 it
->starts_in_middle_of_char_p
= 1;
18635 /* Restore the height to what it was before the
18636 element not fitting on the line. */
18637 it
->max_ascent
= ascent
;
18638 it
->max_descent
= descent
;
18639 it
->max_phys_ascent
= phys_ascent
;
18640 it
->max_phys_descent
= phys_descent
;
18645 else if (new_x
> it
->first_visible_x
)
18647 /* Increment number of glyphs actually displayed. */
18650 /* Record the maximum and minimum buffer positions
18651 seen so far in glyphs that will be displayed by
18654 RECORD_MAX_MIN_POS (it
);
18656 if (x
< it
->first_visible_x
)
18657 /* Glyph is partially visible, i.e. row starts at
18658 negative X position. */
18659 row
->x
= x
- it
->first_visible_x
;
18663 /* Glyph is completely off the left margin of the
18664 window. This should not happen because of the
18665 move_it_in_display_line at the start of this
18666 function, unless the text display area of the
18667 window is empty. */
18668 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18672 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18673 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18674 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18675 row
->phys_height
= max (row
->phys_height
,
18676 it
->max_phys_ascent
+ it
->max_phys_descent
);
18677 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18678 it
->max_extra_line_spacing
);
18680 /* End of this display line if row is continued. */
18681 if (row
->continued_p
|| row
->ends_at_zv_p
)
18686 /* Is this a line end? If yes, we're also done, after making
18687 sure that a non-default face is extended up to the right
18688 margin of the window. */
18689 if (ITERATOR_AT_END_OF_LINE_P (it
))
18691 int used_before
= row
->used
[TEXT_AREA
];
18693 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18695 /* Add a space at the end of the line that is used to
18696 display the cursor there. */
18697 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18698 append_space_for_newline (it
, 0);
18700 /* Extend the face to the end of the line. */
18701 extend_face_to_end_of_line (it
);
18703 /* Make sure we have the position. */
18704 if (used_before
== 0)
18705 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18707 /* Record the position of the newline, for use in
18709 it
->eol_pos
= it
->current
.pos
;
18711 /* Consume the line end. This skips over invisible lines. */
18712 set_iterator_to_next (it
, 1);
18713 it
->continuation_lines_width
= 0;
18717 /* Proceed with next display element. Note that this skips
18718 over lines invisible because of selective display. */
18719 set_iterator_to_next (it
, 1);
18721 /* If we truncate lines, we are done when the last displayed
18722 glyphs reach past the right margin of the window. */
18723 if (it
->line_wrap
== TRUNCATE
18724 && (FRAME_WINDOW_P (it
->f
)
18725 ? (it
->current_x
>= it
->last_visible_x
)
18726 : (it
->current_x
> it
->last_visible_x
)))
18728 /* Maybe add truncation glyphs. */
18729 if (!FRAME_WINDOW_P (it
->f
))
18733 if (!row
->reversed_p
)
18735 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18736 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18741 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18742 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18744 /* Remove any padding glyphs at the front of ROW, to
18745 make room for the truncation glyphs we will be
18746 adding below. The loop below always inserts at
18747 least one truncation glyph, so also remove the
18748 last glyph added to ROW. */
18749 unproduce_glyphs (it
, i
+ 1);
18750 /* Adjust i for the loop below. */
18751 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18754 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18756 row
->used
[TEXT_AREA
] = i
;
18757 produce_special_glyphs (it
, IT_TRUNCATION
);
18760 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18762 /* Don't truncate if we can overflow newline into fringe. */
18763 if (!get_next_display_element (it
))
18765 it
->continuation_lines_width
= 0;
18766 row
->ends_at_zv_p
= 1;
18767 row
->exact_window_width_line_p
= 1;
18770 if (ITERATOR_AT_END_OF_LINE_P (it
))
18772 row
->exact_window_width_line_p
= 1;
18773 goto at_end_of_line
;
18777 row
->truncated_on_right_p
= 1;
18778 it
->continuation_lines_width
= 0;
18779 reseat_at_next_visible_line_start (it
, 0);
18780 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18781 it
->hpos
= hpos_before
;
18782 it
->current_x
= x_before
;
18787 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18788 at the left window margin. */
18789 if (it
->first_visible_x
18790 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18792 if (!FRAME_WINDOW_P (it
->f
))
18793 insert_left_trunc_glyphs (it
);
18794 row
->truncated_on_left_p
= 1;
18797 /* Remember the position at which this line ends.
18799 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18800 cannot be before the call to find_row_edges below, since that is
18801 where these positions are determined. */
18802 row
->end
= it
->current
;
18805 row
->minpos
= row
->start
.pos
;
18806 row
->maxpos
= row
->end
.pos
;
18810 /* ROW->minpos and ROW->maxpos must be the smallest and
18811 `1 + the largest' buffer positions in ROW. But if ROW was
18812 bidi-reordered, these two positions can be anywhere in the
18813 row, so we must determine them now. */
18814 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18817 /* If the start of this line is the overlay arrow-position, then
18818 mark this glyph row as the one containing the overlay arrow.
18819 This is clearly a mess with variable size fonts. It would be
18820 better to let it be displayed like cursors under X. */
18821 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18822 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18823 !NILP (overlay_arrow_string
)))
18825 /* Overlay arrow in window redisplay is a fringe bitmap. */
18826 if (STRINGP (overlay_arrow_string
))
18828 struct glyph_row
*arrow_row
18829 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18830 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18831 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18832 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18833 struct glyph
*p2
, *end
;
18835 /* Copy the arrow glyphs. */
18836 while (glyph
< arrow_end
)
18839 /* Throw away padding glyphs. */
18841 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18842 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18848 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18853 xassert (INTEGERP (overlay_arrow_string
));
18854 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18856 overlay_arrow_seen
= 1;
18859 /* Compute pixel dimensions of this line. */
18860 compute_line_metrics (it
);
18862 /* Record whether this row ends inside an ellipsis. */
18863 row
->ends_in_ellipsis_p
18864 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18865 && it
->ellipsis_p
);
18867 /* Save fringe bitmaps in this row. */
18868 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18869 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18870 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18871 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18873 it
->left_user_fringe_bitmap
= 0;
18874 it
->left_user_fringe_face_id
= 0;
18875 it
->right_user_fringe_bitmap
= 0;
18876 it
->right_user_fringe_face_id
= 0;
18878 /* Maybe set the cursor. */
18879 cvpos
= it
->w
->cursor
.vpos
;
18881 /* In bidi-reordered rows, keep checking for proper cursor
18882 position even if one has been found already, because buffer
18883 positions in such rows change non-linearly with ROW->VPOS,
18884 when a line is continued. One exception: when we are at ZV,
18885 display cursor on the first suitable glyph row, since all
18886 the empty rows after that also have their position set to ZV. */
18887 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18888 lines' rows is implemented for bidi-reordered rows. */
18890 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18891 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18892 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18893 && cursor_row_p (row
))
18894 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18896 /* Highlight trailing whitespace. */
18897 if (!NILP (Vshow_trailing_whitespace
))
18898 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18900 /* Prepare for the next line. This line starts horizontally at (X
18901 HPOS) = (0 0). Vertical positions are incremented. As a
18902 convenience for the caller, IT->glyph_row is set to the next
18904 it
->current_x
= it
->hpos
= 0;
18905 it
->current_y
+= row
->height
;
18906 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18909 /* The next row should by default use the same value of the
18910 reversed_p flag as this one. set_iterator_to_next decides when
18911 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18912 the flag accordingly. */
18913 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18914 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18915 it
->start
= row
->end
;
18916 return row
->displays_text_p
;
18918 #undef RECORD_MAX_MIN_POS
18921 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18922 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18923 doc
: /* Return paragraph direction at point in BUFFER.
18924 Value is either `left-to-right' or `right-to-left'.
18925 If BUFFER is omitted or nil, it defaults to the current buffer.
18927 Paragraph direction determines how the text in the paragraph is displayed.
18928 In left-to-right paragraphs, text begins at the left margin of the window
18929 and the reading direction is generally left to right. In right-to-left
18930 paragraphs, text begins at the right margin and is read from right to left.
18932 See also `bidi-paragraph-direction'. */)
18933 (Lisp_Object buffer
)
18935 struct buffer
*buf
= current_buffer
;
18936 struct buffer
*old
= buf
;
18938 if (! NILP (buffer
))
18940 CHECK_BUFFER (buffer
);
18941 buf
= XBUFFER (buffer
);
18944 if (NILP (BVAR (buf
, bidi_display_reordering
)))
18945 return Qleft_to_right
;
18946 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
18947 return BVAR (buf
, bidi_paragraph_direction
);
18950 /* Determine the direction from buffer text. We could try to
18951 use current_matrix if it is up to date, but this seems fast
18952 enough as it is. */
18953 struct bidi_it itb
;
18954 EMACS_INT pos
= BUF_PT (buf
);
18955 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18958 set_buffer_temp (buf
);
18959 /* bidi_paragraph_init finds the base direction of the paragraph
18960 by searching forward from paragraph start. We need the base
18961 direction of the current or _previous_ paragraph, so we need
18962 to make sure we are within that paragraph. To that end, find
18963 the previous non-empty line. */
18964 if (pos
>= ZV
&& pos
> BEGV
)
18967 bytepos
= CHAR_TO_BYTE (pos
);
18969 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
18970 || c
== ' ' || c
== '\t' || c
== '\f')
18972 if (bytepos
<= BEGV_BYTE
)
18977 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18980 itb
.bytepos
= bytepos
;
18982 itb
.string
.s
= NULL
;
18983 itb
.string
.lstring
= Qnil
;
18984 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
18986 itb
.separator_limit
= -1;
18987 itb
.paragraph_dir
= NEUTRAL_DIR
;
18989 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18990 set_buffer_temp (old
);
18991 switch (itb
.paragraph_dir
)
18994 return Qleft_to_right
;
18997 return Qright_to_left
;
19007 /***********************************************************************
19009 ***********************************************************************/
19011 /* Redisplay the menu bar in the frame for window W.
19013 The menu bar of X frames that don't have X toolkit support is
19014 displayed in a special window W->frame->menu_bar_window.
19016 The menu bar of terminal frames is treated specially as far as
19017 glyph matrices are concerned. Menu bar lines are not part of
19018 windows, so the update is done directly on the frame matrix rows
19019 for the menu bar. */
19022 display_menu_bar (struct window
*w
)
19024 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19029 /* Don't do all this for graphical frames. */
19031 if (FRAME_W32_P (f
))
19034 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19040 if (FRAME_NS_P (f
))
19042 #endif /* HAVE_NS */
19044 #ifdef USE_X_TOOLKIT
19045 xassert (!FRAME_WINDOW_P (f
));
19046 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19047 it
.first_visible_x
= 0;
19048 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19049 #else /* not USE_X_TOOLKIT */
19050 if (FRAME_WINDOW_P (f
))
19052 /* Menu bar lines are displayed in the desired matrix of the
19053 dummy window menu_bar_window. */
19054 struct window
*menu_w
;
19055 xassert (WINDOWP (f
->menu_bar_window
));
19056 menu_w
= XWINDOW (f
->menu_bar_window
);
19057 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19059 it
.first_visible_x
= 0;
19060 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19064 /* This is a TTY frame, i.e. character hpos/vpos are used as
19066 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19068 it
.first_visible_x
= 0;
19069 it
.last_visible_x
= FRAME_COLS (f
);
19071 #endif /* not USE_X_TOOLKIT */
19073 /* FIXME: This should be controlled by a user option. See the
19074 comments in redisplay_tool_bar and display_mode_line about
19076 it
.paragraph_embedding
= L2R
;
19078 if (! mode_line_inverse_video
)
19079 /* Force the menu-bar to be displayed in the default face. */
19080 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19082 /* Clear all rows of the menu bar. */
19083 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19085 struct glyph_row
*row
= it
.glyph_row
+ i
;
19086 clear_glyph_row (row
);
19087 row
->enabled_p
= 1;
19088 row
->full_width_p
= 1;
19091 /* Display all items of the menu bar. */
19092 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19093 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19095 Lisp_Object string
;
19097 /* Stop at nil string. */
19098 string
= AREF (items
, i
+ 1);
19102 /* Remember where item was displayed. */
19103 ASET (items
, i
+ 3, make_number (it
.hpos
));
19105 /* Display the item, pad with one space. */
19106 if (it
.current_x
< it
.last_visible_x
)
19107 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19108 SCHARS (string
) + 1, 0, 0, -1);
19111 /* Fill out the line with spaces. */
19112 if (it
.current_x
< it
.last_visible_x
)
19113 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19115 /* Compute the total height of the lines. */
19116 compute_line_metrics (&it
);
19121 /***********************************************************************
19123 ***********************************************************************/
19125 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19126 FORCE is non-zero, redisplay mode lines unconditionally.
19127 Otherwise, redisplay only mode lines that are garbaged. Value is
19128 the number of windows whose mode lines were redisplayed. */
19131 redisplay_mode_lines (Lisp_Object window
, int force
)
19135 while (!NILP (window
))
19137 struct window
*w
= XWINDOW (window
);
19139 if (WINDOWP (w
->hchild
))
19140 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19141 else if (WINDOWP (w
->vchild
))
19142 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19144 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19145 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19147 struct text_pos lpoint
;
19148 struct buffer
*old
= current_buffer
;
19150 /* Set the window's buffer for the mode line display. */
19151 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19152 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19154 /* Point refers normally to the selected window. For any
19155 other window, set up appropriate value. */
19156 if (!EQ (window
, selected_window
))
19158 struct text_pos pt
;
19160 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19161 if (CHARPOS (pt
) < BEGV
)
19162 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19163 else if (CHARPOS (pt
) > (ZV
- 1))
19164 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19166 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19169 /* Display mode lines. */
19170 clear_glyph_matrix (w
->desired_matrix
);
19171 if (display_mode_lines (w
))
19174 w
->must_be_updated_p
= 1;
19177 /* Restore old settings. */
19178 set_buffer_internal_1 (old
);
19179 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19189 /* Display the mode and/or header line of window W. Value is the
19190 sum number of mode lines and header lines displayed. */
19193 display_mode_lines (struct window
*w
)
19195 Lisp_Object old_selected_window
, old_selected_frame
;
19198 old_selected_frame
= selected_frame
;
19199 selected_frame
= w
->frame
;
19200 old_selected_window
= selected_window
;
19201 XSETWINDOW (selected_window
, w
);
19203 /* These will be set while the mode line specs are processed. */
19204 line_number_displayed
= 0;
19205 w
->column_number_displayed
= Qnil
;
19207 if (WINDOW_WANTS_MODELINE_P (w
))
19209 struct window
*sel_w
= XWINDOW (old_selected_window
);
19211 /* Select mode line face based on the real selected window. */
19212 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19213 BVAR (current_buffer
, mode_line_format
));
19217 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19219 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19220 BVAR (current_buffer
, header_line_format
));
19224 selected_frame
= old_selected_frame
;
19225 selected_window
= old_selected_window
;
19230 /* Display mode or header line of window W. FACE_ID specifies which
19231 line to display; it is either MODE_LINE_FACE_ID or
19232 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19233 display. Value is the pixel height of the mode/header line
19237 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19241 int count
= SPECPDL_INDEX ();
19243 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19244 /* Don't extend on a previously drawn mode-line.
19245 This may happen if called from pos_visible_p. */
19246 it
.glyph_row
->enabled_p
= 0;
19247 prepare_desired_row (it
.glyph_row
);
19249 it
.glyph_row
->mode_line_p
= 1;
19251 if (! mode_line_inverse_video
)
19252 /* Force the mode-line to be displayed in the default face. */
19253 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19255 /* FIXME: This should be controlled by a user option. But
19256 supporting such an option is not trivial, since the mode line is
19257 made up of many separate strings. */
19258 it
.paragraph_embedding
= L2R
;
19260 record_unwind_protect (unwind_format_mode_line
,
19261 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19263 mode_line_target
= MODE_LINE_DISPLAY
;
19265 /* Temporarily make frame's keyboard the current kboard so that
19266 kboard-local variables in the mode_line_format will get the right
19268 push_kboard (FRAME_KBOARD (it
.f
));
19269 record_unwind_save_match_data ();
19270 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19273 unbind_to (count
, Qnil
);
19275 /* Fill up with spaces. */
19276 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19278 compute_line_metrics (&it
);
19279 it
.glyph_row
->full_width_p
= 1;
19280 it
.glyph_row
->continued_p
= 0;
19281 it
.glyph_row
->truncated_on_left_p
= 0;
19282 it
.glyph_row
->truncated_on_right_p
= 0;
19284 /* Make a 3D mode-line have a shadow at its right end. */
19285 face
= FACE_FROM_ID (it
.f
, face_id
);
19286 extend_face_to_end_of_line (&it
);
19287 if (face
->box
!= FACE_NO_BOX
)
19289 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19290 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19291 last
->right_box_line_p
= 1;
19294 return it
.glyph_row
->height
;
19297 /* Move element ELT in LIST to the front of LIST.
19298 Return the updated list. */
19301 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19303 register Lisp_Object tail
, prev
;
19304 register Lisp_Object tem
;
19308 while (CONSP (tail
))
19314 /* Splice out the link TAIL. */
19316 list
= XCDR (tail
);
19318 Fsetcdr (prev
, XCDR (tail
));
19320 /* Now make it the first. */
19321 Fsetcdr (tail
, list
);
19326 tail
= XCDR (tail
);
19330 /* Not found--return unchanged LIST. */
19334 /* Contribute ELT to the mode line for window IT->w. How it
19335 translates into text depends on its data type.
19337 IT describes the display environment in which we display, as usual.
19339 DEPTH is the depth in recursion. It is used to prevent
19340 infinite recursion here.
19342 FIELD_WIDTH is the number of characters the display of ELT should
19343 occupy in the mode line, and PRECISION is the maximum number of
19344 characters to display from ELT's representation. See
19345 display_string for details.
19347 Returns the hpos of the end of the text generated by ELT.
19349 PROPS is a property list to add to any string we encounter.
19351 If RISKY is nonzero, remove (disregard) any properties in any string
19352 we encounter, and ignore :eval and :propertize.
19354 The global variable `mode_line_target' determines whether the
19355 output is passed to `store_mode_line_noprop',
19356 `store_mode_line_string', or `display_string'. */
19359 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19360 Lisp_Object elt
, Lisp_Object props
, int risky
)
19362 int n
= 0, field
, prec
;
19367 elt
= build_string ("*too-deep*");
19371 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19375 /* A string: output it and check for %-constructs within it. */
19377 EMACS_INT offset
= 0;
19379 if (SCHARS (elt
) > 0
19380 && (!NILP (props
) || risky
))
19382 Lisp_Object oprops
, aelt
;
19383 oprops
= Ftext_properties_at (make_number (0), elt
);
19385 /* If the starting string's properties are not what
19386 we want, translate the string. Also, if the string
19387 is risky, do that anyway. */
19389 if (NILP (Fequal (props
, oprops
)) || risky
)
19391 /* If the starting string has properties,
19392 merge the specified ones onto the existing ones. */
19393 if (! NILP (oprops
) && !risky
)
19397 oprops
= Fcopy_sequence (oprops
);
19399 while (CONSP (tem
))
19401 oprops
= Fplist_put (oprops
, XCAR (tem
),
19402 XCAR (XCDR (tem
)));
19403 tem
= XCDR (XCDR (tem
));
19408 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19409 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19411 /* AELT is what we want. Move it to the front
19412 without consing. */
19414 mode_line_proptrans_alist
19415 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19421 /* If AELT has the wrong props, it is useless.
19422 so get rid of it. */
19424 mode_line_proptrans_alist
19425 = Fdelq (aelt
, mode_line_proptrans_alist
);
19427 elt
= Fcopy_sequence (elt
);
19428 Fset_text_properties (make_number (0), Flength (elt
),
19430 /* Add this item to mode_line_proptrans_alist. */
19431 mode_line_proptrans_alist
19432 = Fcons (Fcons (elt
, props
),
19433 mode_line_proptrans_alist
);
19434 /* Truncate mode_line_proptrans_alist
19435 to at most 50 elements. */
19436 tem
= Fnthcdr (make_number (50),
19437 mode_line_proptrans_alist
);
19439 XSETCDR (tem
, Qnil
);
19448 prec
= precision
- n
;
19449 switch (mode_line_target
)
19451 case MODE_LINE_NOPROP
:
19452 case MODE_LINE_TITLE
:
19453 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19455 case MODE_LINE_STRING
:
19456 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19458 case MODE_LINE_DISPLAY
:
19459 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19460 0, prec
, 0, STRING_MULTIBYTE (elt
));
19467 /* Handle the non-literal case. */
19469 while ((precision
<= 0 || n
< precision
)
19470 && SREF (elt
, offset
) != 0
19471 && (mode_line_target
!= MODE_LINE_DISPLAY
19472 || it
->current_x
< it
->last_visible_x
))
19474 EMACS_INT last_offset
= offset
;
19476 /* Advance to end of string or next format specifier. */
19477 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19480 if (offset
- 1 != last_offset
)
19482 EMACS_INT nchars
, nbytes
;
19484 /* Output to end of string or up to '%'. Field width
19485 is length of string. Don't output more than
19486 PRECISION allows us. */
19489 prec
= c_string_width (SDATA (elt
) + last_offset
,
19490 offset
- last_offset
, precision
- n
,
19493 switch (mode_line_target
)
19495 case MODE_LINE_NOPROP
:
19496 case MODE_LINE_TITLE
:
19497 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19499 case MODE_LINE_STRING
:
19501 EMACS_INT bytepos
= last_offset
;
19502 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19503 EMACS_INT endpos
= (precision
<= 0
19504 ? string_byte_to_char (elt
, offset
)
19505 : charpos
+ nchars
);
19507 n
+= store_mode_line_string (NULL
,
19508 Fsubstring (elt
, make_number (charpos
),
19509 make_number (endpos
)),
19513 case MODE_LINE_DISPLAY
:
19515 EMACS_INT bytepos
= last_offset
;
19516 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19518 if (precision
<= 0)
19519 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19520 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19522 STRING_MULTIBYTE (elt
));
19527 else /* c == '%' */
19529 EMACS_INT percent_position
= offset
;
19531 /* Get the specified minimum width. Zero means
19534 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19535 field
= field
* 10 + c
- '0';
19537 /* Don't pad beyond the total padding allowed. */
19538 if (field_width
- n
> 0 && field
> field_width
- n
)
19539 field
= field_width
- n
;
19541 /* Note that either PRECISION <= 0 or N < PRECISION. */
19542 prec
= precision
- n
;
19545 n
+= display_mode_element (it
, depth
, field
, prec
,
19546 Vglobal_mode_string
, props
,
19551 EMACS_INT bytepos
, charpos
;
19553 Lisp_Object string
;
19555 bytepos
= percent_position
;
19556 charpos
= (STRING_MULTIBYTE (elt
)
19557 ? string_byte_to_char (elt
, bytepos
)
19559 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19560 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19562 switch (mode_line_target
)
19564 case MODE_LINE_NOPROP
:
19565 case MODE_LINE_TITLE
:
19566 n
+= store_mode_line_noprop (spec
, field
, prec
);
19568 case MODE_LINE_STRING
:
19570 Lisp_Object tem
= build_string (spec
);
19571 props
= Ftext_properties_at (make_number (charpos
), elt
);
19572 /* Should only keep face property in props */
19573 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19576 case MODE_LINE_DISPLAY
:
19578 int nglyphs_before
, nwritten
;
19580 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19581 nwritten
= display_string (spec
, string
, elt
,
19586 /* Assign to the glyphs written above the
19587 string where the `%x' came from, position
19591 struct glyph
*glyph
19592 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19596 for (i
= 0; i
< nwritten
; ++i
)
19598 glyph
[i
].object
= elt
;
19599 glyph
[i
].charpos
= charpos
;
19616 /* A symbol: process the value of the symbol recursively
19617 as if it appeared here directly. Avoid error if symbol void.
19618 Special case: if value of symbol is a string, output the string
19621 register Lisp_Object tem
;
19623 /* If the variable is not marked as risky to set
19624 then its contents are risky to use. */
19625 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19628 tem
= Fboundp (elt
);
19631 tem
= Fsymbol_value (elt
);
19632 /* If value is a string, output that string literally:
19633 don't check for % within it. */
19637 if (!EQ (tem
, elt
))
19639 /* Give up right away for nil or t. */
19649 register Lisp_Object car
, tem
;
19651 /* A cons cell: five distinct cases.
19652 If first element is :eval or :propertize, do something special.
19653 If first element is a string or a cons, process all the elements
19654 and effectively concatenate them.
19655 If first element is a negative number, truncate displaying cdr to
19656 at most that many characters. If positive, pad (with spaces)
19657 to at least that many characters.
19658 If first element is a symbol, process the cadr or caddr recursively
19659 according to whether the symbol's value is non-nil or nil. */
19661 if (EQ (car
, QCeval
))
19663 /* An element of the form (:eval FORM) means evaluate FORM
19664 and use the result as mode line elements. */
19669 if (CONSP (XCDR (elt
)))
19672 spec
= safe_eval (XCAR (XCDR (elt
)));
19673 n
+= display_mode_element (it
, depth
, field_width
- n
,
19674 precision
- n
, spec
, props
,
19678 else if (EQ (car
, QCpropertize
))
19680 /* An element of the form (:propertize ELT PROPS...)
19681 means display ELT but applying properties PROPS. */
19686 if (CONSP (XCDR (elt
)))
19687 n
+= display_mode_element (it
, depth
, field_width
- n
,
19688 precision
- n
, XCAR (XCDR (elt
)),
19689 XCDR (XCDR (elt
)), risky
);
19691 else if (SYMBOLP (car
))
19693 tem
= Fboundp (car
);
19697 /* elt is now the cdr, and we know it is a cons cell.
19698 Use its car if CAR has a non-nil value. */
19701 tem
= Fsymbol_value (car
);
19708 /* Symbol's value is nil (or symbol is unbound)
19709 Get the cddr of the original list
19710 and if possible find the caddr and use that. */
19714 else if (!CONSP (elt
))
19719 else if (INTEGERP (car
))
19721 register int lim
= XINT (car
);
19725 /* Negative int means reduce maximum width. */
19726 if (precision
<= 0)
19729 precision
= min (precision
, -lim
);
19733 /* Padding specified. Don't let it be more than
19734 current maximum. */
19736 lim
= min (precision
, lim
);
19738 /* If that's more padding than already wanted, queue it.
19739 But don't reduce padding already specified even if
19740 that is beyond the current truncation point. */
19741 field_width
= max (lim
, field_width
);
19745 else if (STRINGP (car
) || CONSP (car
))
19747 Lisp_Object halftail
= elt
;
19751 && (precision
<= 0 || n
< precision
))
19753 n
+= display_mode_element (it
, depth
,
19754 /* Do padding only after the last
19755 element in the list. */
19756 (! CONSP (XCDR (elt
))
19759 precision
- n
, XCAR (elt
),
19763 if ((len
& 1) == 0)
19764 halftail
= XCDR (halftail
);
19765 /* Check for cycle. */
19766 if (EQ (halftail
, elt
))
19775 elt
= build_string ("*invalid*");
19779 /* Pad to FIELD_WIDTH. */
19780 if (field_width
> 0 && n
< field_width
)
19782 switch (mode_line_target
)
19784 case MODE_LINE_NOPROP
:
19785 case MODE_LINE_TITLE
:
19786 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19788 case MODE_LINE_STRING
:
19789 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19791 case MODE_LINE_DISPLAY
:
19792 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19801 /* Store a mode-line string element in mode_line_string_list.
19803 If STRING is non-null, display that C string. Otherwise, the Lisp
19804 string LISP_STRING is displayed.
19806 FIELD_WIDTH is the minimum number of output glyphs to produce.
19807 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19808 with spaces. FIELD_WIDTH <= 0 means don't pad.
19810 PRECISION is the maximum number of characters to output from
19811 STRING. PRECISION <= 0 means don't truncate the string.
19813 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19814 properties to the string.
19816 PROPS are the properties to add to the string.
19817 The mode_line_string_face face property is always added to the string.
19821 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19822 int field_width
, int precision
, Lisp_Object props
)
19827 if (string
!= NULL
)
19829 len
= strlen (string
);
19830 if (precision
> 0 && len
> precision
)
19832 lisp_string
= make_string (string
, len
);
19834 props
= mode_line_string_face_prop
;
19835 else if (!NILP (mode_line_string_face
))
19837 Lisp_Object face
= Fplist_get (props
, Qface
);
19838 props
= Fcopy_sequence (props
);
19840 face
= mode_line_string_face
;
19842 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19843 props
= Fplist_put (props
, Qface
, face
);
19845 Fadd_text_properties (make_number (0), make_number (len
),
19846 props
, lisp_string
);
19850 len
= XFASTINT (Flength (lisp_string
));
19851 if (precision
> 0 && len
> precision
)
19854 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19857 if (!NILP (mode_line_string_face
))
19861 props
= Ftext_properties_at (make_number (0), lisp_string
);
19862 face
= Fplist_get (props
, Qface
);
19864 face
= mode_line_string_face
;
19866 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19867 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19869 lisp_string
= Fcopy_sequence (lisp_string
);
19872 Fadd_text_properties (make_number (0), make_number (len
),
19873 props
, lisp_string
);
19878 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19882 if (field_width
> len
)
19884 field_width
-= len
;
19885 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19887 Fadd_text_properties (make_number (0), make_number (field_width
),
19888 props
, lisp_string
);
19889 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19897 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19899 doc
: /* Format a string out of a mode line format specification.
19900 First arg FORMAT specifies the mode line format (see `mode-line-format'
19901 for details) to use.
19903 By default, the format is evaluated for the currently selected window.
19905 Optional second arg FACE specifies the face property to put on all
19906 characters for which no face is specified. The value nil means the
19907 default face. The value t means whatever face the window's mode line
19908 currently uses (either `mode-line' or `mode-line-inactive',
19909 depending on whether the window is the selected window or not).
19910 An integer value means the value string has no text
19913 Optional third and fourth args WINDOW and BUFFER specify the window
19914 and buffer to use as the context for the formatting (defaults
19915 are the selected window and the WINDOW's buffer). */)
19916 (Lisp_Object format
, Lisp_Object face
,
19917 Lisp_Object window
, Lisp_Object buffer
)
19922 struct buffer
*old_buffer
= NULL
;
19924 int no_props
= INTEGERP (face
);
19925 int count
= SPECPDL_INDEX ();
19927 int string_start
= 0;
19930 window
= selected_window
;
19931 CHECK_WINDOW (window
);
19932 w
= XWINDOW (window
);
19935 buffer
= w
->buffer
;
19936 CHECK_BUFFER (buffer
);
19938 /* Make formatting the modeline a non-op when noninteractive, otherwise
19939 there will be problems later caused by a partially initialized frame. */
19940 if (NILP (format
) || noninteractive
)
19941 return empty_unibyte_string
;
19946 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
19947 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
19948 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
19949 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
19950 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
19951 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
19952 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
19955 if (XBUFFER (buffer
) != current_buffer
)
19956 old_buffer
= current_buffer
;
19958 /* Save things including mode_line_proptrans_alist,
19959 and set that to nil so that we don't alter the outer value. */
19960 record_unwind_protect (unwind_format_mode_line
,
19961 format_mode_line_unwind_data
19962 (old_buffer
, selected_window
, 1));
19963 mode_line_proptrans_alist
= Qnil
;
19965 Fselect_window (window
, Qt
);
19967 set_buffer_internal_1 (XBUFFER (buffer
));
19969 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19973 mode_line_target
= MODE_LINE_NOPROP
;
19974 mode_line_string_face_prop
= Qnil
;
19975 mode_line_string_list
= Qnil
;
19976 string_start
= MODE_LINE_NOPROP_LEN (0);
19980 mode_line_target
= MODE_LINE_STRING
;
19981 mode_line_string_list
= Qnil
;
19982 mode_line_string_face
= face
;
19983 mode_line_string_face_prop
19984 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19987 push_kboard (FRAME_KBOARD (it
.f
));
19988 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19993 len
= MODE_LINE_NOPROP_LEN (string_start
);
19994 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19998 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19999 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20000 empty_unibyte_string
);
20003 unbind_to (count
, Qnil
);
20007 /* Write a null-terminated, right justified decimal representation of
20008 the positive integer D to BUF using a minimal field width WIDTH. */
20011 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20013 register char *p
= buf
;
20021 *p
++ = d
% 10 + '0';
20026 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20037 /* Write a null-terminated, right justified decimal and "human
20038 readable" representation of the nonnegative integer D to BUF using
20039 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20041 static const char power_letter
[] =
20055 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20057 /* We aim to represent the nonnegative integer D as
20058 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20059 EMACS_INT quotient
= d
;
20061 /* -1 means: do not use TENTHS. */
20065 /* Length of QUOTIENT.TENTHS as a string. */
20071 if (1000 <= quotient
)
20073 /* Scale to the appropriate EXPONENT. */
20076 remainder
= quotient
% 1000;
20080 while (1000 <= quotient
);
20082 /* Round to nearest and decide whether to use TENTHS or not. */
20085 tenths
= remainder
/ 100;
20086 if (50 <= remainder
% 100)
20093 if (quotient
== 10)
20101 if (500 <= remainder
)
20103 if (quotient
< 999)
20114 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20115 if (tenths
== -1 && quotient
<= 99)
20122 p
= psuffix
= buf
+ max (width
, length
);
20124 /* Print EXPONENT. */
20125 *psuffix
++ = power_letter
[exponent
];
20128 /* Print TENTHS. */
20131 *--p
= '0' + tenths
;
20135 /* Print QUOTIENT. */
20138 int digit
= quotient
% 10;
20139 *--p
= '0' + digit
;
20141 while ((quotient
/= 10) != 0);
20143 /* Print leading spaces. */
20148 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20149 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20150 type of CODING_SYSTEM. Return updated pointer into BUF. */
20152 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20155 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20158 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20159 const unsigned char *eol_str
;
20161 /* The EOL conversion we are using. */
20162 Lisp_Object eoltype
;
20164 val
= CODING_SYSTEM_SPEC (coding_system
);
20167 if (!VECTORP (val
)) /* Not yet decided. */
20172 eoltype
= eol_mnemonic_undecided
;
20173 /* Don't mention EOL conversion if it isn't decided. */
20178 Lisp_Object eolvalue
;
20180 attrs
= AREF (val
, 0);
20181 eolvalue
= AREF (val
, 2);
20184 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20188 /* The EOL conversion that is normal on this system. */
20190 if (NILP (eolvalue
)) /* Not yet decided. */
20191 eoltype
= eol_mnemonic_undecided
;
20192 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20193 eoltype
= eol_mnemonic_undecided
;
20194 else /* eolvalue is Qunix, Qdos, or Qmac. */
20195 eoltype
= (EQ (eolvalue
, Qunix
)
20196 ? eol_mnemonic_unix
20197 : (EQ (eolvalue
, Qdos
) == 1
20198 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20204 /* Mention the EOL conversion if it is not the usual one. */
20205 if (STRINGP (eoltype
))
20207 eol_str
= SDATA (eoltype
);
20208 eol_str_len
= SBYTES (eoltype
);
20210 else if (CHARACTERP (eoltype
))
20212 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20213 int c
= XFASTINT (eoltype
);
20214 eol_str_len
= CHAR_STRING (c
, tmp
);
20219 eol_str
= invalid_eol_type
;
20220 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20222 memcpy (buf
, eol_str
, eol_str_len
);
20223 buf
+= eol_str_len
;
20229 /* Return a string for the output of a mode line %-spec for window W,
20230 generated by character C. FIELD_WIDTH > 0 means pad the string
20231 returned with spaces to that value. Return a Lisp string in
20232 *STRING if the resulting string is taken from that Lisp string.
20234 Note we operate on the current buffer for most purposes,
20235 the exception being w->base_line_pos. */
20237 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20239 static const char *
20240 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20241 Lisp_Object
*string
)
20244 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20245 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20246 struct buffer
*b
= current_buffer
;
20254 if (!NILP (BVAR (b
, read_only
)))
20256 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20261 /* This differs from %* only for a modified read-only buffer. */
20262 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20264 if (!NILP (BVAR (b
, read_only
)))
20269 /* This differs from %* in ignoring read-only-ness. */
20270 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20282 if (command_loop_level
> 5)
20284 p
= decode_mode_spec_buf
;
20285 for (i
= 0; i
< command_loop_level
; i
++)
20288 return decode_mode_spec_buf
;
20296 if (command_loop_level
> 5)
20298 p
= decode_mode_spec_buf
;
20299 for (i
= 0; i
< command_loop_level
; i
++)
20302 return decode_mode_spec_buf
;
20309 /* Let lots_of_dashes be a string of infinite length. */
20310 if (mode_line_target
== MODE_LINE_NOPROP
||
20311 mode_line_target
== MODE_LINE_STRING
)
20313 if (field_width
<= 0
20314 || field_width
> sizeof (lots_of_dashes
))
20316 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20317 decode_mode_spec_buf
[i
] = '-';
20318 decode_mode_spec_buf
[i
] = '\0';
20319 return decode_mode_spec_buf
;
20322 return lots_of_dashes
;
20326 obj
= BVAR (b
, name
);
20330 /* %c and %l are ignored in `frame-title-format'.
20331 (In redisplay_internal, the frame title is drawn _before_ the
20332 windows are updated, so the stuff which depends on actual
20333 window contents (such as %l) may fail to render properly, or
20334 even crash emacs.) */
20335 if (mode_line_target
== MODE_LINE_TITLE
)
20339 EMACS_INT col
= current_column ();
20340 w
->column_number_displayed
= make_number (col
);
20341 pint2str (decode_mode_spec_buf
, field_width
, col
);
20342 return decode_mode_spec_buf
;
20346 #ifndef SYSTEM_MALLOC
20348 if (NILP (Vmemory_full
))
20351 return "!MEM FULL! ";
20358 /* %F displays the frame name. */
20359 if (!NILP (f
->title
))
20360 return SSDATA (f
->title
);
20361 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20362 return SSDATA (f
->name
);
20366 obj
= BVAR (b
, filename
);
20371 EMACS_INT size
= ZV
- BEGV
;
20372 pint2str (decode_mode_spec_buf
, field_width
, size
);
20373 return decode_mode_spec_buf
;
20378 EMACS_INT size
= ZV
- BEGV
;
20379 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20380 return decode_mode_spec_buf
;
20385 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20386 EMACS_INT topline
, nlines
, height
;
20389 /* %c and %l are ignored in `frame-title-format'. */
20390 if (mode_line_target
== MODE_LINE_TITLE
)
20393 startpos
= XMARKER (w
->start
)->charpos
;
20394 startpos_byte
= marker_byte_position (w
->start
);
20395 height
= WINDOW_TOTAL_LINES (w
);
20397 /* If we decided that this buffer isn't suitable for line numbers,
20398 don't forget that too fast. */
20399 if (EQ (w
->base_line_pos
, w
->buffer
))
20401 /* But do forget it, if the window shows a different buffer now. */
20402 else if (BUFFERP (w
->base_line_pos
))
20403 w
->base_line_pos
= Qnil
;
20405 /* If the buffer is very big, don't waste time. */
20406 if (INTEGERP (Vline_number_display_limit
)
20407 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20409 w
->base_line_pos
= Qnil
;
20410 w
->base_line_number
= Qnil
;
20414 if (INTEGERP (w
->base_line_number
)
20415 && INTEGERP (w
->base_line_pos
)
20416 && XFASTINT (w
->base_line_pos
) <= startpos
)
20418 line
= XFASTINT (w
->base_line_number
);
20419 linepos
= XFASTINT (w
->base_line_pos
);
20420 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20425 linepos
= BUF_BEGV (b
);
20426 linepos_byte
= BUF_BEGV_BYTE (b
);
20429 /* Count lines from base line to window start position. */
20430 nlines
= display_count_lines (linepos_byte
,
20434 topline
= nlines
+ line
;
20436 /* Determine a new base line, if the old one is too close
20437 or too far away, or if we did not have one.
20438 "Too close" means it's plausible a scroll-down would
20439 go back past it. */
20440 if (startpos
== BUF_BEGV (b
))
20442 w
->base_line_number
= make_number (topline
);
20443 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20445 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20446 || linepos
== BUF_BEGV (b
))
20448 EMACS_INT limit
= BUF_BEGV (b
);
20449 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20450 EMACS_INT position
;
20451 EMACS_INT distance
=
20452 (height
* 2 + 30) * line_number_display_limit_width
;
20454 if (startpos
- distance
> limit
)
20456 limit
= startpos
- distance
;
20457 limit_byte
= CHAR_TO_BYTE (limit
);
20460 nlines
= display_count_lines (startpos_byte
,
20462 - (height
* 2 + 30),
20464 /* If we couldn't find the lines we wanted within
20465 line_number_display_limit_width chars per line,
20466 give up on line numbers for this window. */
20467 if (position
== limit_byte
&& limit
== startpos
- distance
)
20469 w
->base_line_pos
= w
->buffer
;
20470 w
->base_line_number
= Qnil
;
20474 w
->base_line_number
= make_number (topline
- nlines
);
20475 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20478 /* Now count lines from the start pos to point. */
20479 nlines
= display_count_lines (startpos_byte
,
20480 PT_BYTE
, PT
, &junk
);
20482 /* Record that we did display the line number. */
20483 line_number_displayed
= 1;
20485 /* Make the string to show. */
20486 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20487 return decode_mode_spec_buf
;
20490 char* p
= decode_mode_spec_buf
;
20491 int pad
= field_width
- 2;
20497 return decode_mode_spec_buf
;
20503 obj
= BVAR (b
, mode_name
);
20507 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20513 EMACS_INT pos
= marker_position (w
->start
);
20514 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20516 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20518 if (pos
<= BUF_BEGV (b
))
20523 else if (pos
<= BUF_BEGV (b
))
20527 if (total
> 1000000)
20528 /* Do it differently for a large value, to avoid overflow. */
20529 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20531 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20532 /* We can't normally display a 3-digit number,
20533 so get us a 2-digit number that is close. */
20536 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20537 return decode_mode_spec_buf
;
20541 /* Display percentage of size above the bottom of the screen. */
20544 EMACS_INT toppos
= marker_position (w
->start
);
20545 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20546 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20548 if (botpos
>= BUF_ZV (b
))
20550 if (toppos
<= BUF_BEGV (b
))
20557 if (total
> 1000000)
20558 /* Do it differently for a large value, to avoid overflow. */
20559 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20561 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20562 /* We can't normally display a 3-digit number,
20563 so get us a 2-digit number that is close. */
20566 if (toppos
<= BUF_BEGV (b
))
20567 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20569 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20570 return decode_mode_spec_buf
;
20575 /* status of process */
20576 obj
= Fget_buffer_process (Fcurrent_buffer ());
20578 return "no process";
20580 obj
= Fsymbol_name (Fprocess_status (obj
));
20586 int count
= inhibit_garbage_collection ();
20587 Lisp_Object val
= call1 (intern ("file-remote-p"),
20588 BVAR (current_buffer
, directory
));
20589 unbind_to (count
, Qnil
);
20597 case 't': /* indicate TEXT or BINARY */
20601 /* coding-system (not including end-of-line format) */
20603 /* coding-system (including end-of-line type) */
20605 int eol_flag
= (c
== 'Z');
20606 char *p
= decode_mode_spec_buf
;
20608 if (! FRAME_WINDOW_P (f
))
20610 /* No need to mention EOL here--the terminal never needs
20611 to do EOL conversion. */
20612 p
= decode_mode_spec_coding (CODING_ID_NAME
20613 (FRAME_KEYBOARD_CODING (f
)->id
),
20615 p
= decode_mode_spec_coding (CODING_ID_NAME
20616 (FRAME_TERMINAL_CODING (f
)->id
),
20619 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20622 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20623 #ifdef subprocesses
20624 obj
= Fget_buffer_process (Fcurrent_buffer ());
20625 if (PROCESSP (obj
))
20627 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20629 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20632 #endif /* subprocesses */
20635 return decode_mode_spec_buf
;
20642 return SSDATA (obj
);
20649 /* Count up to COUNT lines starting from START_BYTE.
20650 But don't go beyond LIMIT_BYTE.
20651 Return the number of lines thus found (always nonnegative).
20653 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20656 display_count_lines (EMACS_INT start_byte
,
20657 EMACS_INT limit_byte
, EMACS_INT count
,
20658 EMACS_INT
*byte_pos_ptr
)
20660 register unsigned char *cursor
;
20661 unsigned char *base
;
20663 register EMACS_INT ceiling
;
20664 register unsigned char *ceiling_addr
;
20665 EMACS_INT orig_count
= count
;
20667 /* If we are not in selective display mode,
20668 check only for newlines. */
20669 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20670 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20674 while (start_byte
< limit_byte
)
20676 ceiling
= BUFFER_CEILING_OF (start_byte
);
20677 ceiling
= min (limit_byte
- 1, ceiling
);
20678 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20679 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20682 if (selective_display
)
20683 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20686 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20689 if (cursor
!= ceiling_addr
)
20693 start_byte
+= cursor
- base
+ 1;
20694 *byte_pos_ptr
= start_byte
;
20698 if (++cursor
== ceiling_addr
)
20704 start_byte
+= cursor
- base
;
20709 while (start_byte
> limit_byte
)
20711 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20712 ceiling
= max (limit_byte
, ceiling
);
20713 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20714 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20717 if (selective_display
)
20718 while (--cursor
!= ceiling_addr
20719 && *cursor
!= '\n' && *cursor
!= 015)
20722 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20725 if (cursor
!= ceiling_addr
)
20729 start_byte
+= cursor
- base
+ 1;
20730 *byte_pos_ptr
= start_byte
;
20731 /* When scanning backwards, we should
20732 not count the newline posterior to which we stop. */
20733 return - orig_count
- 1;
20739 /* Here we add 1 to compensate for the last decrement
20740 of CURSOR, which took it past the valid range. */
20741 start_byte
+= cursor
- base
+ 1;
20745 *byte_pos_ptr
= limit_byte
;
20748 return - orig_count
+ count
;
20749 return orig_count
- count
;
20755 /***********************************************************************
20757 ***********************************************************************/
20759 /* Display a NUL-terminated string, starting with index START.
20761 If STRING is non-null, display that C string. Otherwise, the Lisp
20762 string LISP_STRING is displayed. There's a case that STRING is
20763 non-null and LISP_STRING is not nil. It means STRING is a string
20764 data of LISP_STRING. In that case, we display LISP_STRING while
20765 ignoring its text properties.
20767 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20768 FACE_STRING. Display STRING or LISP_STRING with the face at
20769 FACE_STRING_POS in FACE_STRING:
20771 Display the string in the environment given by IT, but use the
20772 standard display table, temporarily.
20774 FIELD_WIDTH is the minimum number of output glyphs to produce.
20775 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20776 with spaces. If STRING has more characters, more than FIELD_WIDTH
20777 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20779 PRECISION is the maximum number of characters to output from
20780 STRING. PRECISION < 0 means don't truncate the string.
20782 This is roughly equivalent to printf format specifiers:
20784 FIELD_WIDTH PRECISION PRINTF
20785 ----------------------------------------
20791 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20792 display them, and < 0 means obey the current buffer's value of
20793 enable_multibyte_characters.
20795 Value is the number of columns displayed. */
20798 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20799 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20800 int field_width
, int precision
, int max_x
, int multibyte
)
20802 int hpos_at_start
= it
->hpos
;
20803 int saved_face_id
= it
->face_id
;
20804 struct glyph_row
*row
= it
->glyph_row
;
20805 EMACS_INT it_charpos
;
20807 /* Initialize the iterator IT for iteration over STRING beginning
20808 with index START. */
20809 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20810 precision
, field_width
, multibyte
);
20811 if (string
&& STRINGP (lisp_string
))
20812 /* LISP_STRING is the one returned by decode_mode_spec. We should
20813 ignore its text properties. */
20814 it
->stop_charpos
= it
->end_charpos
;
20816 /* If displaying STRING, set up the face of the iterator from
20817 FACE_STRING, if that's given. */
20818 if (STRINGP (face_string
))
20824 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20825 0, it
->region_beg_charpos
,
20826 it
->region_end_charpos
,
20827 &endptr
, it
->base_face_id
, 0);
20828 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20829 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20832 /* Set max_x to the maximum allowed X position. Don't let it go
20833 beyond the right edge of the window. */
20835 max_x
= it
->last_visible_x
;
20837 max_x
= min (max_x
, it
->last_visible_x
);
20839 /* Skip over display elements that are not visible. because IT->w is
20841 if (it
->current_x
< it
->first_visible_x
)
20842 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20843 MOVE_TO_POS
| MOVE_TO_X
);
20845 row
->ascent
= it
->max_ascent
;
20846 row
->height
= it
->max_ascent
+ it
->max_descent
;
20847 row
->phys_ascent
= it
->max_phys_ascent
;
20848 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20849 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20851 if (STRINGP (it
->string
))
20852 it_charpos
= IT_STRING_CHARPOS (*it
);
20854 it_charpos
= IT_CHARPOS (*it
);
20856 /* This condition is for the case that we are called with current_x
20857 past last_visible_x. */
20858 while (it
->current_x
< max_x
)
20860 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20862 /* Get the next display element. */
20863 if (!get_next_display_element (it
))
20866 /* Produce glyphs. */
20867 x_before
= it
->current_x
;
20868 n_glyphs_before
= row
->used
[TEXT_AREA
];
20869 PRODUCE_GLYPHS (it
);
20871 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20874 while (i
< nglyphs
)
20876 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20878 if (it
->line_wrap
!= TRUNCATE
20879 && x
+ glyph
->pixel_width
> max_x
)
20881 /* End of continued line or max_x reached. */
20882 if (CHAR_GLYPH_PADDING_P (*glyph
))
20884 /* A wide character is unbreakable. */
20885 if (row
->reversed_p
)
20886 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20887 - n_glyphs_before
);
20888 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20889 it
->current_x
= x_before
;
20893 if (row
->reversed_p
)
20894 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20895 - (n_glyphs_before
+ i
));
20896 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20901 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20903 /* Glyph is at least partially visible. */
20905 if (x
< it
->first_visible_x
)
20906 row
->x
= x
- it
->first_visible_x
;
20910 /* Glyph is off the left margin of the display area.
20911 Should not happen. */
20915 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20916 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20917 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20918 row
->phys_height
= max (row
->phys_height
,
20919 it
->max_phys_ascent
+ it
->max_phys_descent
);
20920 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20921 it
->max_extra_line_spacing
);
20922 x
+= glyph
->pixel_width
;
20926 /* Stop if max_x reached. */
20930 /* Stop at line ends. */
20931 if (ITERATOR_AT_END_OF_LINE_P (it
))
20933 it
->continuation_lines_width
= 0;
20937 set_iterator_to_next (it
, 1);
20938 if (STRINGP (it
->string
))
20939 it_charpos
= IT_STRING_CHARPOS (*it
);
20941 it_charpos
= IT_CHARPOS (*it
);
20943 /* Stop if truncating at the right edge. */
20944 if (it
->line_wrap
== TRUNCATE
20945 && it
->current_x
>= it
->last_visible_x
)
20947 /* Add truncation mark, but don't do it if the line is
20948 truncated at a padding space. */
20949 if (it_charpos
< it
->string_nchars
)
20951 if (!FRAME_WINDOW_P (it
->f
))
20955 if (it
->current_x
> it
->last_visible_x
)
20957 if (!row
->reversed_p
)
20959 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
20960 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20965 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
20966 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
20968 unproduce_glyphs (it
, ii
+ 1);
20969 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
20971 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
20973 row
->used
[TEXT_AREA
] = ii
;
20974 produce_special_glyphs (it
, IT_TRUNCATION
);
20977 produce_special_glyphs (it
, IT_TRUNCATION
);
20979 row
->truncated_on_right_p
= 1;
20985 /* Maybe insert a truncation at the left. */
20986 if (it
->first_visible_x
20989 if (!FRAME_WINDOW_P (it
->f
))
20990 insert_left_trunc_glyphs (it
);
20991 row
->truncated_on_left_p
= 1;
20994 it
->face_id
= saved_face_id
;
20996 /* Value is number of columns displayed. */
20997 return it
->hpos
- hpos_at_start
;
21002 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21003 appears as an element of LIST or as the car of an element of LIST.
21004 If PROPVAL is a list, compare each element against LIST in that
21005 way, and return 1/2 if any element of PROPVAL is found in LIST.
21006 Otherwise return 0. This function cannot quit.
21007 The return value is 2 if the text is invisible but with an ellipsis
21008 and 1 if it's invisible and without an ellipsis. */
21011 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21013 register Lisp_Object tail
, proptail
;
21015 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21017 register Lisp_Object tem
;
21019 if (EQ (propval
, tem
))
21021 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21022 return NILP (XCDR (tem
)) ? 1 : 2;
21025 if (CONSP (propval
))
21027 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21029 Lisp_Object propelt
;
21030 propelt
= XCAR (proptail
);
21031 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21033 register Lisp_Object tem
;
21035 if (EQ (propelt
, tem
))
21037 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21038 return NILP (XCDR (tem
)) ? 1 : 2;
21046 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21047 doc
: /* Non-nil if the property makes the text invisible.
21048 POS-OR-PROP can be a marker or number, in which case it is taken to be
21049 a position in the current buffer and the value of the `invisible' property
21050 is checked; or it can be some other value, which is then presumed to be the
21051 value of the `invisible' property of the text of interest.
21052 The non-nil value returned can be t for truly invisible text or something
21053 else if the text is replaced by an ellipsis. */)
21054 (Lisp_Object pos_or_prop
)
21057 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21058 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21060 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21061 return (invis
== 0 ? Qnil
21063 : make_number (invis
));
21066 /* Calculate a width or height in pixels from a specification using
21067 the following elements:
21070 NUM - a (fractional) multiple of the default font width/height
21071 (NUM) - specifies exactly NUM pixels
21072 UNIT - a fixed number of pixels, see below.
21073 ELEMENT - size of a display element in pixels, see below.
21074 (NUM . SPEC) - equals NUM * SPEC
21075 (+ SPEC SPEC ...) - add pixel values
21076 (- SPEC SPEC ...) - subtract pixel values
21077 (- SPEC) - negate pixel value
21080 INT or FLOAT - a number constant
21081 SYMBOL - use symbol's (buffer local) variable binding.
21084 in - pixels per inch *)
21085 mm - pixels per 1/1000 meter *)
21086 cm - pixels per 1/100 meter *)
21087 width - width of current font in pixels.
21088 height - height of current font in pixels.
21090 *) using the ratio(s) defined in display-pixels-per-inch.
21094 left-fringe - left fringe width in pixels
21095 right-fringe - right fringe width in pixels
21097 left-margin - left margin width in pixels
21098 right-margin - right margin width in pixels
21100 scroll-bar - scroll-bar area width in pixels
21104 Pixels corresponding to 5 inches:
21107 Total width of non-text areas on left side of window (if scroll-bar is on left):
21108 '(space :width (+ left-fringe left-margin scroll-bar))
21110 Align to first text column (in header line):
21111 '(space :align-to 0)
21113 Align to middle of text area minus half the width of variable `my-image'
21114 containing a loaded image:
21115 '(space :align-to (0.5 . (- text my-image)))
21117 Width of left margin minus width of 1 character in the default font:
21118 '(space :width (- left-margin 1))
21120 Width of left margin minus width of 2 characters in the current font:
21121 '(space :width (- left-margin (2 . width)))
21123 Center 1 character over left-margin (in header line):
21124 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21126 Different ways to express width of left fringe plus left margin minus one pixel:
21127 '(space :width (- (+ left-fringe left-margin) (1)))
21128 '(space :width (+ left-fringe left-margin (- (1))))
21129 '(space :width (+ left-fringe left-margin (-1)))
21133 #define NUMVAL(X) \
21134 ((INTEGERP (X) || FLOATP (X)) \
21139 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21140 struct font
*font
, int width_p
, int *align_to
)
21144 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21145 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21148 return OK_PIXELS (0);
21150 xassert (FRAME_LIVE_P (it
->f
));
21152 if (SYMBOLP (prop
))
21154 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21156 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21158 if (unit
[0] == 'i' && unit
[1] == 'n')
21160 else if (unit
[0] == 'm' && unit
[1] == 'm')
21162 else if (unit
[0] == 'c' && unit
[1] == 'm')
21169 #ifdef HAVE_WINDOW_SYSTEM
21170 if (FRAME_WINDOW_P (it
->f
)
21172 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21173 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21175 return OK_PIXELS (ppi
/ pixels
);
21178 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21179 || (CONSP (Vdisplay_pixels_per_inch
)
21181 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21182 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21184 return OK_PIXELS (ppi
/ pixels
);
21190 #ifdef HAVE_WINDOW_SYSTEM
21191 if (EQ (prop
, Qheight
))
21192 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21193 if (EQ (prop
, Qwidth
))
21194 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21196 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21197 return OK_PIXELS (1);
21200 if (EQ (prop
, Qtext
))
21201 return OK_PIXELS (width_p
21202 ? window_box_width (it
->w
, TEXT_AREA
)
21203 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21205 if (align_to
&& *align_to
< 0)
21208 if (EQ (prop
, Qleft
))
21209 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21210 if (EQ (prop
, Qright
))
21211 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21212 if (EQ (prop
, Qcenter
))
21213 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21214 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21215 if (EQ (prop
, Qleft_fringe
))
21216 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21217 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21218 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21219 if (EQ (prop
, Qright_fringe
))
21220 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21221 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21222 : window_box_right_offset (it
->w
, TEXT_AREA
));
21223 if (EQ (prop
, Qleft_margin
))
21224 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21225 if (EQ (prop
, Qright_margin
))
21226 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21227 if (EQ (prop
, Qscroll_bar
))
21228 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21230 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21231 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21232 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21237 if (EQ (prop
, Qleft_fringe
))
21238 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21239 if (EQ (prop
, Qright_fringe
))
21240 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21241 if (EQ (prop
, Qleft_margin
))
21242 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21243 if (EQ (prop
, Qright_margin
))
21244 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21245 if (EQ (prop
, Qscroll_bar
))
21246 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21249 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21252 if (INTEGERP (prop
) || FLOATP (prop
))
21254 int base_unit
= (width_p
21255 ? FRAME_COLUMN_WIDTH (it
->f
)
21256 : FRAME_LINE_HEIGHT (it
->f
));
21257 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21262 Lisp_Object car
= XCAR (prop
);
21263 Lisp_Object cdr
= XCDR (prop
);
21267 #ifdef HAVE_WINDOW_SYSTEM
21268 if (FRAME_WINDOW_P (it
->f
)
21269 && valid_image_p (prop
))
21271 int id
= lookup_image (it
->f
, prop
);
21272 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21274 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21277 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21283 while (CONSP (cdr
))
21285 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21286 font
, width_p
, align_to
))
21289 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21294 if (EQ (car
, Qminus
))
21296 return OK_PIXELS (pixels
);
21299 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21302 if (INTEGERP (car
) || FLOATP (car
))
21305 pixels
= XFLOATINT (car
);
21307 return OK_PIXELS (pixels
);
21308 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21309 font
, width_p
, align_to
))
21310 return OK_PIXELS (pixels
* fact
);
21321 /***********************************************************************
21323 ***********************************************************************/
21325 #ifdef HAVE_WINDOW_SYSTEM
21330 dump_glyph_string (struct glyph_string
*s
)
21332 fprintf (stderr
, "glyph string\n");
21333 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21334 s
->x
, s
->y
, s
->width
, s
->height
);
21335 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21336 fprintf (stderr
, " hl = %d\n", s
->hl
);
21337 fprintf (stderr
, " left overhang = %d, right = %d\n",
21338 s
->left_overhang
, s
->right_overhang
);
21339 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21340 fprintf (stderr
, " extends to end of line = %d\n",
21341 s
->extends_to_end_of_line_p
);
21342 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21343 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21346 #endif /* GLYPH_DEBUG */
21348 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21349 of XChar2b structures for S; it can't be allocated in
21350 init_glyph_string because it must be allocated via `alloca'. W
21351 is the window on which S is drawn. ROW and AREA are the glyph row
21352 and area within the row from which S is constructed. START is the
21353 index of the first glyph structure covered by S. HL is a
21354 face-override for drawing S. */
21357 #define OPTIONAL_HDC(hdc) HDC hdc,
21358 #define DECLARE_HDC(hdc) HDC hdc;
21359 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21360 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21363 #ifndef OPTIONAL_HDC
21364 #define OPTIONAL_HDC(hdc)
21365 #define DECLARE_HDC(hdc)
21366 #define ALLOCATE_HDC(hdc, f)
21367 #define RELEASE_HDC(hdc, f)
21371 init_glyph_string (struct glyph_string
*s
,
21373 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21374 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21376 memset (s
, 0, sizeof *s
);
21378 s
->f
= XFRAME (w
->frame
);
21382 s
->display
= FRAME_X_DISPLAY (s
->f
);
21383 s
->window
= FRAME_X_WINDOW (s
->f
);
21384 s
->char2b
= char2b
;
21388 s
->first_glyph
= row
->glyphs
[area
] + start
;
21389 s
->height
= row
->height
;
21390 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21391 s
->ybase
= s
->y
+ row
->ascent
;
21395 /* Append the list of glyph strings with head H and tail T to the list
21396 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21399 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21400 struct glyph_string
*h
, struct glyph_string
*t
)
21414 /* Prepend the list of glyph strings with head H and tail T to the
21415 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21419 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21420 struct glyph_string
*h
, struct glyph_string
*t
)
21434 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21435 Set *HEAD and *TAIL to the resulting list. */
21438 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21439 struct glyph_string
*s
)
21441 s
->next
= s
->prev
= NULL
;
21442 append_glyph_string_lists (head
, tail
, s
, s
);
21446 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21447 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21448 make sure that X resources for the face returned are allocated.
21449 Value is a pointer to a realized face that is ready for display if
21450 DISPLAY_P is non-zero. */
21452 static inline struct face
*
21453 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21454 XChar2b
*char2b
, int display_p
)
21456 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21460 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21462 if (code
!= FONT_INVALID_CODE
)
21463 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21465 STORE_XCHAR2B (char2b
, 0, 0);
21468 /* Make sure X resources of the face are allocated. */
21469 #ifdef HAVE_X_WINDOWS
21473 xassert (face
!= NULL
);
21474 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21481 /* Get face and two-byte form of character glyph GLYPH on frame F.
21482 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21483 a pointer to a realized face that is ready for display. */
21485 static inline struct face
*
21486 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21487 XChar2b
*char2b
, int *two_byte_p
)
21491 xassert (glyph
->type
== CHAR_GLYPH
);
21492 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21501 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21502 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21504 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21506 if (code
!= FONT_INVALID_CODE
)
21507 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21509 STORE_XCHAR2B (char2b
, 0, 0);
21512 /* Make sure X resources of the face are allocated. */
21513 xassert (face
!= NULL
);
21514 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21519 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21520 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21523 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21527 if (CHAR_BYTE8_P (c
))
21528 code
= CHAR_TO_BYTE8 (c
);
21530 code
= font
->driver
->encode_char (font
, c
);
21532 if (code
== FONT_INVALID_CODE
)
21534 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21539 /* Fill glyph string S with composition components specified by S->cmp.
21541 BASE_FACE is the base face of the composition.
21542 S->cmp_from is the index of the first component for S.
21544 OVERLAPS non-zero means S should draw the foreground only, and use
21545 its physical height for clipping. See also draw_glyphs.
21547 Value is the index of a component not in S. */
21550 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21554 /* For all glyphs of this composition, starting at the offset
21555 S->cmp_from, until we reach the end of the definition or encounter a
21556 glyph that requires the different face, add it to S. */
21561 s
->for_overlaps
= overlaps
;
21564 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21566 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21570 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21573 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21580 s
->font
= s
->face
->font
;
21582 else if (s
->face
!= face
)
21590 /* All glyph strings for the same composition has the same width,
21591 i.e. the width set for the first component of the composition. */
21592 s
->width
= s
->first_glyph
->pixel_width
;
21594 /* If the specified font could not be loaded, use the frame's
21595 default font, but record the fact that we couldn't load it in
21596 the glyph string so that we can draw rectangles for the
21597 characters of the glyph string. */
21598 if (s
->font
== NULL
)
21600 s
->font_not_found_p
= 1;
21601 s
->font
= FRAME_FONT (s
->f
);
21604 /* Adjust base line for subscript/superscript text. */
21605 s
->ybase
+= s
->first_glyph
->voffset
;
21607 /* This glyph string must always be drawn with 16-bit functions. */
21614 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21615 int start
, int end
, int overlaps
)
21617 struct glyph
*glyph
, *last
;
21618 Lisp_Object lgstring
;
21621 s
->for_overlaps
= overlaps
;
21622 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21623 last
= s
->row
->glyphs
[s
->area
] + end
;
21624 s
->cmp_id
= glyph
->u
.cmp
.id
;
21625 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21626 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21627 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21628 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21629 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21631 while (glyph
< last
21632 && glyph
->u
.cmp
.automatic
21633 && glyph
->u
.cmp
.id
== s
->cmp_id
21634 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21635 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21637 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21639 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21640 unsigned code
= LGLYPH_CODE (lglyph
);
21642 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21644 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21645 return glyph
- s
->row
->glyphs
[s
->area
];
21649 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21650 See the comment of fill_glyph_string for arguments.
21651 Value is the index of the first glyph not in S. */
21655 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21656 int start
, int end
, int overlaps
)
21658 struct glyph
*glyph
, *last
;
21661 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21662 s
->for_overlaps
= overlaps
;
21663 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21664 last
= s
->row
->glyphs
[s
->area
] + end
;
21665 voffset
= glyph
->voffset
;
21666 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21667 s
->font
= s
->face
->font
;
21669 s
->width
= glyph
->pixel_width
;
21671 while (glyph
< last
21672 && glyph
->type
== GLYPHLESS_GLYPH
21673 && glyph
->voffset
== voffset
21674 && glyph
->face_id
== face_id
)
21677 s
->width
+= glyph
->pixel_width
;
21680 s
->ybase
+= voffset
;
21681 return glyph
- s
->row
->glyphs
[s
->area
];
21685 /* Fill glyph string S from a sequence of character glyphs.
21687 FACE_ID is the face id of the string. START is the index of the
21688 first glyph to consider, END is the index of the last + 1.
21689 OVERLAPS non-zero means S should draw the foreground only, and use
21690 its physical height for clipping. See also draw_glyphs.
21692 Value is the index of the first glyph not in S. */
21695 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21696 int start
, int end
, int overlaps
)
21698 struct glyph
*glyph
, *last
;
21700 int glyph_not_available_p
;
21702 xassert (s
->f
== XFRAME (s
->w
->frame
));
21703 xassert (s
->nchars
== 0);
21704 xassert (start
>= 0 && end
> start
);
21706 s
->for_overlaps
= overlaps
;
21707 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21708 last
= s
->row
->glyphs
[s
->area
] + end
;
21709 voffset
= glyph
->voffset
;
21710 s
->padding_p
= glyph
->padding_p
;
21711 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21713 while (glyph
< last
21714 && glyph
->type
== CHAR_GLYPH
21715 && glyph
->voffset
== voffset
21716 /* Same face id implies same font, nowadays. */
21717 && glyph
->face_id
== face_id
21718 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21722 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21723 s
->char2b
+ s
->nchars
,
21725 s
->two_byte_p
= two_byte_p
;
21727 xassert (s
->nchars
<= end
- start
);
21728 s
->width
+= glyph
->pixel_width
;
21729 if (glyph
++->padding_p
!= s
->padding_p
)
21733 s
->font
= s
->face
->font
;
21735 /* If the specified font could not be loaded, use the frame's font,
21736 but record the fact that we couldn't load it in
21737 S->font_not_found_p so that we can draw rectangles for the
21738 characters of the glyph string. */
21739 if (s
->font
== NULL
|| glyph_not_available_p
)
21741 s
->font_not_found_p
= 1;
21742 s
->font
= FRAME_FONT (s
->f
);
21745 /* Adjust base line for subscript/superscript text. */
21746 s
->ybase
+= voffset
;
21748 xassert (s
->face
&& s
->face
->gc
);
21749 return glyph
- s
->row
->glyphs
[s
->area
];
21753 /* Fill glyph string S from image glyph S->first_glyph. */
21756 fill_image_glyph_string (struct glyph_string
*s
)
21758 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21759 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21761 s
->slice
= s
->first_glyph
->slice
.img
;
21762 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21763 s
->font
= s
->face
->font
;
21764 s
->width
= s
->first_glyph
->pixel_width
;
21766 /* Adjust base line for subscript/superscript text. */
21767 s
->ybase
+= s
->first_glyph
->voffset
;
21771 /* Fill glyph string S from a sequence of stretch glyphs.
21773 START is the index of the first glyph to consider,
21774 END is the index of the last + 1.
21776 Value is the index of the first glyph not in S. */
21779 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21781 struct glyph
*glyph
, *last
;
21782 int voffset
, face_id
;
21784 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21786 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21787 last
= s
->row
->glyphs
[s
->area
] + end
;
21788 face_id
= glyph
->face_id
;
21789 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21790 s
->font
= s
->face
->font
;
21791 s
->width
= glyph
->pixel_width
;
21793 voffset
= glyph
->voffset
;
21797 && glyph
->type
== STRETCH_GLYPH
21798 && glyph
->voffset
== voffset
21799 && glyph
->face_id
== face_id
);
21801 s
->width
+= glyph
->pixel_width
;
21803 /* Adjust base line for subscript/superscript text. */
21804 s
->ybase
+= voffset
;
21806 /* The case that face->gc == 0 is handled when drawing the glyph
21807 string by calling PREPARE_FACE_FOR_DISPLAY. */
21809 return glyph
- s
->row
->glyphs
[s
->area
];
21812 static struct font_metrics
*
21813 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21815 static struct font_metrics metrics
;
21816 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21818 if (! font
|| code
== FONT_INVALID_CODE
)
21820 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21825 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21826 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21827 assumed to be zero. */
21830 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21832 *left
= *right
= 0;
21834 if (glyph
->type
== CHAR_GLYPH
)
21838 struct font_metrics
*pcm
;
21840 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21841 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21843 if (pcm
->rbearing
> pcm
->width
)
21844 *right
= pcm
->rbearing
- pcm
->width
;
21845 if (pcm
->lbearing
< 0)
21846 *left
= -pcm
->lbearing
;
21849 else if (glyph
->type
== COMPOSITE_GLYPH
)
21851 if (! glyph
->u
.cmp
.automatic
)
21853 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21855 if (cmp
->rbearing
> cmp
->pixel_width
)
21856 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21857 if (cmp
->lbearing
< 0)
21858 *left
= - cmp
->lbearing
;
21862 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21863 struct font_metrics metrics
;
21865 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21866 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21867 if (metrics
.rbearing
> metrics
.width
)
21868 *right
= metrics
.rbearing
- metrics
.width
;
21869 if (metrics
.lbearing
< 0)
21870 *left
= - metrics
.lbearing
;
21876 /* Return the index of the first glyph preceding glyph string S that
21877 is overwritten by S because of S's left overhang. Value is -1
21878 if no glyphs are overwritten. */
21881 left_overwritten (struct glyph_string
*s
)
21885 if (s
->left_overhang
)
21888 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21889 int first
= s
->first_glyph
- glyphs
;
21891 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21892 x
-= glyphs
[i
].pixel_width
;
21903 /* Return the index of the first glyph preceding glyph string S that
21904 is overwriting S because of its right overhang. Value is -1 if no
21905 glyph in front of S overwrites S. */
21908 left_overwriting (struct glyph_string
*s
)
21911 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21912 int first
= s
->first_glyph
- glyphs
;
21916 for (i
= first
- 1; i
>= 0; --i
)
21919 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21922 x
-= glyphs
[i
].pixel_width
;
21929 /* Return the index of the last glyph following glyph string S that is
21930 overwritten by S because of S's right overhang. Value is -1 if
21931 no such glyph is found. */
21934 right_overwritten (struct glyph_string
*s
)
21938 if (s
->right_overhang
)
21941 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21942 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21943 int end
= s
->row
->used
[s
->area
];
21945 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21946 x
+= glyphs
[i
].pixel_width
;
21955 /* Return the index of the last glyph following glyph string S that
21956 overwrites S because of its left overhang. Value is negative
21957 if no such glyph is found. */
21960 right_overwriting (struct glyph_string
*s
)
21963 int end
= s
->row
->used
[s
->area
];
21964 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21965 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21969 for (i
= first
; i
< end
; ++i
)
21972 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21975 x
+= glyphs
[i
].pixel_width
;
21982 /* Set background width of glyph string S. START is the index of the
21983 first glyph following S. LAST_X is the right-most x-position + 1
21984 in the drawing area. */
21987 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
21989 /* If the face of this glyph string has to be drawn to the end of
21990 the drawing area, set S->extends_to_end_of_line_p. */
21992 if (start
== s
->row
->used
[s
->area
]
21993 && s
->area
== TEXT_AREA
21994 && ((s
->row
->fill_line_p
21995 && (s
->hl
== DRAW_NORMAL_TEXT
21996 || s
->hl
== DRAW_IMAGE_RAISED
21997 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21998 || s
->hl
== DRAW_MOUSE_FACE
))
21999 s
->extends_to_end_of_line_p
= 1;
22001 /* If S extends its face to the end of the line, set its
22002 background_width to the distance to the right edge of the drawing
22004 if (s
->extends_to_end_of_line_p
)
22005 s
->background_width
= last_x
- s
->x
+ 1;
22007 s
->background_width
= s
->width
;
22011 /* Compute overhangs and x-positions for glyph string S and its
22012 predecessors, or successors. X is the starting x-position for S.
22013 BACKWARD_P non-zero means process predecessors. */
22016 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22022 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22023 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22033 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22034 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22044 /* The following macros are only called from draw_glyphs below.
22045 They reference the following parameters of that function directly:
22046 `w', `row', `area', and `overlap_p'
22047 as well as the following local variables:
22048 `s', `f', and `hdc' (in W32) */
22051 /* On W32, silently add local `hdc' variable to argument list of
22052 init_glyph_string. */
22053 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22054 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22056 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22057 init_glyph_string (s, char2b, w, row, area, start, hl)
22060 /* Add a glyph string for a stretch glyph to the list of strings
22061 between HEAD and TAIL. START is the index of the stretch glyph in
22062 row area AREA of glyph row ROW. END is the index of the last glyph
22063 in that glyph row area. X is the current output position assigned
22064 to the new glyph string constructed. HL overrides that face of the
22065 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22066 is the right-most x-position of the drawing area. */
22068 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22069 and below -- keep them on one line. */
22070 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22073 s = (struct glyph_string *) alloca (sizeof *s); \
22074 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22075 START = fill_stretch_glyph_string (s, START, END); \
22076 append_glyph_string (&HEAD, &TAIL, s); \
22082 /* Add a glyph string for an image glyph to the list of strings
22083 between HEAD and TAIL. START is the index of the image glyph in
22084 row area AREA of glyph row ROW. END is the index of the last glyph
22085 in that glyph row area. X is the current output position assigned
22086 to the new glyph string constructed. HL overrides that face of the
22087 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22088 is the right-most x-position of the drawing area. */
22090 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22093 s = (struct glyph_string *) alloca (sizeof *s); \
22094 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22095 fill_image_glyph_string (s); \
22096 append_glyph_string (&HEAD, &TAIL, s); \
22103 /* Add a glyph string for a sequence of character glyphs to the list
22104 of strings between HEAD and TAIL. START is the index of the first
22105 glyph in row area AREA of glyph row ROW that is part of the new
22106 glyph string. END is the index of the last glyph in that glyph row
22107 area. X is the current output position assigned to the new glyph
22108 string constructed. HL overrides that face of the glyph; e.g. it
22109 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22110 right-most x-position of the drawing area. */
22112 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22118 face_id = (row)->glyphs[area][START].face_id; \
22120 s = (struct glyph_string *) alloca (sizeof *s); \
22121 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22122 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22123 append_glyph_string (&HEAD, &TAIL, s); \
22125 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22130 /* Add a glyph string for a composite sequence to the list of strings
22131 between HEAD and TAIL. START is the index of the first glyph in
22132 row area AREA of glyph row ROW that is part of the new glyph
22133 string. END is the index of the last glyph in that glyph row area.
22134 X is the current output position assigned to the new glyph string
22135 constructed. HL overrides that face of the glyph; e.g. it is
22136 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22137 x-position of the drawing area. */
22139 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22141 int face_id = (row)->glyphs[area][START].face_id; \
22142 struct face *base_face = FACE_FROM_ID (f, face_id); \
22143 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22144 struct composition *cmp = composition_table[cmp_id]; \
22146 struct glyph_string *first_s IF_LINT (= NULL); \
22149 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22151 /* Make glyph_strings for each glyph sequence that is drawable by \
22152 the same face, and append them to HEAD/TAIL. */ \
22153 for (n = 0; n < cmp->glyph_len;) \
22155 s = (struct glyph_string *) alloca (sizeof *s); \
22156 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22157 append_glyph_string (&(HEAD), &(TAIL), s); \
22163 n = fill_composite_glyph_string (s, base_face, overlaps); \
22171 /* Add a glyph string for a glyph-string sequence to the list of strings
22172 between HEAD and TAIL. */
22174 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22178 Lisp_Object gstring; \
22180 face_id = (row)->glyphs[area][START].face_id; \
22181 gstring = (composition_gstring_from_id \
22182 ((row)->glyphs[area][START].u.cmp.id)); \
22183 s = (struct glyph_string *) alloca (sizeof *s); \
22184 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22185 * LGSTRING_GLYPH_LEN (gstring)); \
22186 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22187 append_glyph_string (&(HEAD), &(TAIL), s); \
22189 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22193 /* Add a glyph string for a sequence of glyphless character's glyphs
22194 to the list of strings between HEAD and TAIL. The meanings of
22195 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22197 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22202 face_id = (row)->glyphs[area][START].face_id; \
22204 s = (struct glyph_string *) alloca (sizeof *s); \
22205 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22206 append_glyph_string (&HEAD, &TAIL, s); \
22208 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22214 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22215 of AREA of glyph row ROW on window W between indices START and END.
22216 HL overrides the face for drawing glyph strings, e.g. it is
22217 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22218 x-positions of the drawing area.
22220 This is an ugly monster macro construct because we must use alloca
22221 to allocate glyph strings (because draw_glyphs can be called
22222 asynchronously). */
22224 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22227 HEAD = TAIL = NULL; \
22228 while (START < END) \
22230 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22231 switch (first_glyph->type) \
22234 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22238 case COMPOSITE_GLYPH: \
22239 if (first_glyph->u.cmp.automatic) \
22240 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22243 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22247 case STRETCH_GLYPH: \
22248 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22252 case IMAGE_GLYPH: \
22253 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22257 case GLYPHLESS_GLYPH: \
22258 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22268 set_glyph_string_background_width (s, START, LAST_X); \
22275 /* Draw glyphs between START and END in AREA of ROW on window W,
22276 starting at x-position X. X is relative to AREA in W. HL is a
22277 face-override with the following meaning:
22279 DRAW_NORMAL_TEXT draw normally
22280 DRAW_CURSOR draw in cursor face
22281 DRAW_MOUSE_FACE draw in mouse face.
22282 DRAW_INVERSE_VIDEO draw in mode line face
22283 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22284 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22286 If OVERLAPS is non-zero, draw only the foreground of characters and
22287 clip to the physical height of ROW. Non-zero value also defines
22288 the overlapping part to be drawn:
22290 OVERLAPS_PRED overlap with preceding rows
22291 OVERLAPS_SUCC overlap with succeeding rows
22292 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22293 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22295 Value is the x-position reached, relative to AREA of W. */
22298 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22299 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22300 enum draw_glyphs_face hl
, int overlaps
)
22302 struct glyph_string
*head
, *tail
;
22303 struct glyph_string
*s
;
22304 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22305 int i
, j
, x_reached
, last_x
, area_left
= 0;
22306 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22309 ALLOCATE_HDC (hdc
, f
);
22311 /* Let's rather be paranoid than getting a SEGV. */
22312 end
= min (end
, row
->used
[area
]);
22313 start
= max (0, start
);
22314 start
= min (end
, start
);
22316 /* Translate X to frame coordinates. Set last_x to the right
22317 end of the drawing area. */
22318 if (row
->full_width_p
)
22320 /* X is relative to the left edge of W, without scroll bars
22322 area_left
= WINDOW_LEFT_EDGE_X (w
);
22323 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22327 area_left
= window_box_left (w
, area
);
22328 last_x
= area_left
+ window_box_width (w
, area
);
22332 /* Build a doubly-linked list of glyph_string structures between
22333 head and tail from what we have to draw. Note that the macro
22334 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22335 the reason we use a separate variable `i'. */
22337 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22339 x_reached
= tail
->x
+ tail
->background_width
;
22343 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22344 the row, redraw some glyphs in front or following the glyph
22345 strings built above. */
22346 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22348 struct glyph_string
*h
, *t
;
22349 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22350 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22351 int check_mouse_face
= 0;
22354 /* If mouse highlighting is on, we may need to draw adjacent
22355 glyphs using mouse-face highlighting. */
22356 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22358 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22360 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22361 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22363 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22365 check_mouse_face
= 1;
22366 mouse_beg_col
= (row
== mouse_beg_row
)
22367 ? hlinfo
->mouse_face_beg_col
: 0;
22368 mouse_end_col
= (row
== mouse_end_row
)
22369 ? hlinfo
->mouse_face_end_col
22370 : row
->used
[TEXT_AREA
];
22374 /* Compute overhangs for all glyph strings. */
22375 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22376 for (s
= head
; s
; s
= s
->next
)
22377 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22379 /* Prepend glyph strings for glyphs in front of the first glyph
22380 string that are overwritten because of the first glyph
22381 string's left overhang. The background of all strings
22382 prepended must be drawn because the first glyph string
22384 i
= left_overwritten (head
);
22387 enum draw_glyphs_face overlap_hl
;
22389 /* If this row contains mouse highlighting, attempt to draw
22390 the overlapped glyphs with the correct highlight. This
22391 code fails if the overlap encompasses more than one glyph
22392 and mouse-highlight spans only some of these glyphs.
22393 However, making it work perfectly involves a lot more
22394 code, and I don't know if the pathological case occurs in
22395 practice, so we'll stick to this for now. --- cyd */
22396 if (check_mouse_face
22397 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22398 overlap_hl
= DRAW_MOUSE_FACE
;
22400 overlap_hl
= DRAW_NORMAL_TEXT
;
22403 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22404 overlap_hl
, dummy_x
, last_x
);
22406 compute_overhangs_and_x (t
, head
->x
, 1);
22407 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22411 /* Prepend glyph strings for glyphs in front of the first glyph
22412 string that overwrite that glyph string because of their
22413 right overhang. For these strings, only the foreground must
22414 be drawn, because it draws over the glyph string at `head'.
22415 The background must not be drawn because this would overwrite
22416 right overhangs of preceding glyphs for which no glyph
22418 i
= left_overwriting (head
);
22421 enum draw_glyphs_face overlap_hl
;
22423 if (check_mouse_face
22424 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22425 overlap_hl
= DRAW_MOUSE_FACE
;
22427 overlap_hl
= DRAW_NORMAL_TEXT
;
22430 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22431 overlap_hl
, dummy_x
, last_x
);
22432 for (s
= h
; s
; s
= s
->next
)
22433 s
->background_filled_p
= 1;
22434 compute_overhangs_and_x (t
, head
->x
, 1);
22435 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22438 /* Append glyphs strings for glyphs following the last glyph
22439 string tail that are overwritten by tail. The background of
22440 these strings has to be drawn because tail's foreground draws
22442 i
= right_overwritten (tail
);
22445 enum draw_glyphs_face overlap_hl
;
22447 if (check_mouse_face
22448 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22449 overlap_hl
= DRAW_MOUSE_FACE
;
22451 overlap_hl
= DRAW_NORMAL_TEXT
;
22453 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22454 overlap_hl
, x
, last_x
);
22455 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22456 we don't have `end = i;' here. */
22457 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22458 append_glyph_string_lists (&head
, &tail
, h
, t
);
22462 /* Append glyph strings for glyphs following the last glyph
22463 string tail that overwrite tail. The foreground of such
22464 glyphs has to be drawn because it writes into the background
22465 of tail. The background must not be drawn because it could
22466 paint over the foreground of following glyphs. */
22467 i
= right_overwriting (tail
);
22470 enum draw_glyphs_face overlap_hl
;
22471 if (check_mouse_face
22472 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22473 overlap_hl
= DRAW_MOUSE_FACE
;
22475 overlap_hl
= DRAW_NORMAL_TEXT
;
22478 i
++; /* We must include the Ith glyph. */
22479 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22480 overlap_hl
, x
, last_x
);
22481 for (s
= h
; s
; s
= s
->next
)
22482 s
->background_filled_p
= 1;
22483 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22484 append_glyph_string_lists (&head
, &tail
, h
, t
);
22486 if (clip_head
|| clip_tail
)
22487 for (s
= head
; s
; s
= s
->next
)
22489 s
->clip_head
= clip_head
;
22490 s
->clip_tail
= clip_tail
;
22494 /* Draw all strings. */
22495 for (s
= head
; s
; s
= s
->next
)
22496 FRAME_RIF (f
)->draw_glyph_string (s
);
22499 /* When focus a sole frame and move horizontally, this sets on_p to 0
22500 causing a failure to erase prev cursor position. */
22501 if (area
== TEXT_AREA
22502 && !row
->full_width_p
22503 /* When drawing overlapping rows, only the glyph strings'
22504 foreground is drawn, which doesn't erase a cursor
22508 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22509 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22510 : (tail
? tail
->x
+ tail
->background_width
: x
));
22514 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22515 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22519 /* Value is the x-position up to which drawn, relative to AREA of W.
22520 This doesn't include parts drawn because of overhangs. */
22521 if (row
->full_width_p
)
22522 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22524 x_reached
-= area_left
;
22526 RELEASE_HDC (hdc
, f
);
22531 /* Expand row matrix if too narrow. Don't expand if area
22534 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22536 if (!fonts_changed_p \
22537 && (it->glyph_row->glyphs[area] \
22538 < it->glyph_row->glyphs[area + 1])) \
22540 it->w->ncols_scale_factor++; \
22541 fonts_changed_p = 1; \
22545 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22546 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22549 append_glyph (struct it
*it
)
22551 struct glyph
*glyph
;
22552 enum glyph_row_area area
= it
->area
;
22554 xassert (it
->glyph_row
);
22555 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22557 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22558 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22560 /* If the glyph row is reversed, we need to prepend the glyph
22561 rather than append it. */
22562 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22566 /* Make room for the additional glyph. */
22567 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22569 glyph
= it
->glyph_row
->glyphs
[area
];
22571 glyph
->charpos
= CHARPOS (it
->position
);
22572 glyph
->object
= it
->object
;
22573 if (it
->pixel_width
> 0)
22575 glyph
->pixel_width
= it
->pixel_width
;
22576 glyph
->padding_p
= 0;
22580 /* Assure at least 1-pixel width. Otherwise, cursor can't
22581 be displayed correctly. */
22582 glyph
->pixel_width
= 1;
22583 glyph
->padding_p
= 1;
22585 glyph
->ascent
= it
->ascent
;
22586 glyph
->descent
= it
->descent
;
22587 glyph
->voffset
= it
->voffset
;
22588 glyph
->type
= CHAR_GLYPH
;
22589 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22590 glyph
->multibyte_p
= it
->multibyte_p
;
22591 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22592 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22593 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22594 || it
->phys_descent
> it
->descent
);
22595 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22596 glyph
->face_id
= it
->face_id
;
22597 glyph
->u
.ch
= it
->char_to_display
;
22598 glyph
->slice
.img
= null_glyph_slice
;
22599 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22602 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22603 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22605 glyph
->bidi_type
= it
->bidi_it
.type
;
22609 glyph
->resolved_level
= 0;
22610 glyph
->bidi_type
= UNKNOWN_BT
;
22612 ++it
->glyph_row
->used
[area
];
22615 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22618 /* Store one glyph for the composition IT->cmp_it.id in
22619 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22623 append_composite_glyph (struct it
*it
)
22625 struct glyph
*glyph
;
22626 enum glyph_row_area area
= it
->area
;
22628 xassert (it
->glyph_row
);
22630 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22631 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22633 /* If the glyph row is reversed, we need to prepend the glyph
22634 rather than append it. */
22635 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22639 /* Make room for the new glyph. */
22640 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22642 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22644 glyph
->charpos
= it
->cmp_it
.charpos
;
22645 glyph
->object
= it
->object
;
22646 glyph
->pixel_width
= it
->pixel_width
;
22647 glyph
->ascent
= it
->ascent
;
22648 glyph
->descent
= it
->descent
;
22649 glyph
->voffset
= it
->voffset
;
22650 glyph
->type
= COMPOSITE_GLYPH
;
22651 if (it
->cmp_it
.ch
< 0)
22653 glyph
->u
.cmp
.automatic
= 0;
22654 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22655 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22659 glyph
->u
.cmp
.automatic
= 1;
22660 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22661 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22662 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22664 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22665 glyph
->multibyte_p
= it
->multibyte_p
;
22666 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22667 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22668 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22669 || it
->phys_descent
> it
->descent
);
22670 glyph
->padding_p
= 0;
22671 glyph
->glyph_not_available_p
= 0;
22672 glyph
->face_id
= it
->face_id
;
22673 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22676 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22677 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22679 glyph
->bidi_type
= it
->bidi_it
.type
;
22681 ++it
->glyph_row
->used
[area
];
22684 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22688 /* Change IT->ascent and IT->height according to the setting of
22692 take_vertical_position_into_account (struct it
*it
)
22696 if (it
->voffset
< 0)
22697 /* Increase the ascent so that we can display the text higher
22699 it
->ascent
-= it
->voffset
;
22701 /* Increase the descent so that we can display the text lower
22703 it
->descent
+= it
->voffset
;
22708 /* Produce glyphs/get display metrics for the image IT is loaded with.
22709 See the description of struct display_iterator in dispextern.h for
22710 an overview of struct display_iterator. */
22713 produce_image_glyph (struct it
*it
)
22717 int glyph_ascent
, crop
;
22718 struct glyph_slice slice
;
22720 xassert (it
->what
== IT_IMAGE
);
22722 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22724 /* Make sure X resources of the face is loaded. */
22725 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22727 if (it
->image_id
< 0)
22729 /* Fringe bitmap. */
22730 it
->ascent
= it
->phys_ascent
= 0;
22731 it
->descent
= it
->phys_descent
= 0;
22732 it
->pixel_width
= 0;
22737 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22739 /* Make sure X resources of the image is loaded. */
22740 prepare_image_for_display (it
->f
, img
);
22742 slice
.x
= slice
.y
= 0;
22743 slice
.width
= img
->width
;
22744 slice
.height
= img
->height
;
22746 if (INTEGERP (it
->slice
.x
))
22747 slice
.x
= XINT (it
->slice
.x
);
22748 else if (FLOATP (it
->slice
.x
))
22749 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22751 if (INTEGERP (it
->slice
.y
))
22752 slice
.y
= XINT (it
->slice
.y
);
22753 else if (FLOATP (it
->slice
.y
))
22754 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22756 if (INTEGERP (it
->slice
.width
))
22757 slice
.width
= XINT (it
->slice
.width
);
22758 else if (FLOATP (it
->slice
.width
))
22759 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22761 if (INTEGERP (it
->slice
.height
))
22762 slice
.height
= XINT (it
->slice
.height
);
22763 else if (FLOATP (it
->slice
.height
))
22764 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22766 if (slice
.x
>= img
->width
)
22767 slice
.x
= img
->width
;
22768 if (slice
.y
>= img
->height
)
22769 slice
.y
= img
->height
;
22770 if (slice
.x
+ slice
.width
>= img
->width
)
22771 slice
.width
= img
->width
- slice
.x
;
22772 if (slice
.y
+ slice
.height
> img
->height
)
22773 slice
.height
= img
->height
- slice
.y
;
22775 if (slice
.width
== 0 || slice
.height
== 0)
22778 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22780 it
->descent
= slice
.height
- glyph_ascent
;
22782 it
->descent
+= img
->vmargin
;
22783 if (slice
.y
+ slice
.height
== img
->height
)
22784 it
->descent
+= img
->vmargin
;
22785 it
->phys_descent
= it
->descent
;
22787 it
->pixel_width
= slice
.width
;
22789 it
->pixel_width
+= img
->hmargin
;
22790 if (slice
.x
+ slice
.width
== img
->width
)
22791 it
->pixel_width
+= img
->hmargin
;
22793 /* It's quite possible for images to have an ascent greater than
22794 their height, so don't get confused in that case. */
22795 if (it
->descent
< 0)
22800 if (face
->box
!= FACE_NO_BOX
)
22802 if (face
->box_line_width
> 0)
22805 it
->ascent
+= face
->box_line_width
;
22806 if (slice
.y
+ slice
.height
== img
->height
)
22807 it
->descent
+= face
->box_line_width
;
22810 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22811 it
->pixel_width
+= eabs (face
->box_line_width
);
22812 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22813 it
->pixel_width
+= eabs (face
->box_line_width
);
22816 take_vertical_position_into_account (it
);
22818 /* Automatically crop wide image glyphs at right edge so we can
22819 draw the cursor on same display row. */
22820 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22821 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22823 it
->pixel_width
-= crop
;
22824 slice
.width
-= crop
;
22829 struct glyph
*glyph
;
22830 enum glyph_row_area area
= it
->area
;
22832 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22833 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22835 glyph
->charpos
= CHARPOS (it
->position
);
22836 glyph
->object
= it
->object
;
22837 glyph
->pixel_width
= it
->pixel_width
;
22838 glyph
->ascent
= glyph_ascent
;
22839 glyph
->descent
= it
->descent
;
22840 glyph
->voffset
= it
->voffset
;
22841 glyph
->type
= IMAGE_GLYPH
;
22842 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22843 glyph
->multibyte_p
= it
->multibyte_p
;
22844 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22845 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22846 glyph
->overlaps_vertically_p
= 0;
22847 glyph
->padding_p
= 0;
22848 glyph
->glyph_not_available_p
= 0;
22849 glyph
->face_id
= it
->face_id
;
22850 glyph
->u
.img_id
= img
->id
;
22851 glyph
->slice
.img
= slice
;
22852 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22855 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22856 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22858 glyph
->bidi_type
= it
->bidi_it
.type
;
22860 ++it
->glyph_row
->used
[area
];
22863 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22868 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22869 of the glyph, WIDTH and HEIGHT are the width and height of the
22870 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22873 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22874 int width
, int height
, int ascent
)
22876 struct glyph
*glyph
;
22877 enum glyph_row_area area
= it
->area
;
22879 xassert (ascent
>= 0 && ascent
<= height
);
22881 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22882 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22884 /* If the glyph row is reversed, we need to prepend the glyph
22885 rather than append it. */
22886 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22890 /* Make room for the additional glyph. */
22891 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22893 glyph
= it
->glyph_row
->glyphs
[area
];
22895 glyph
->charpos
= CHARPOS (it
->position
);
22896 glyph
->object
= object
;
22897 glyph
->pixel_width
= width
;
22898 glyph
->ascent
= ascent
;
22899 glyph
->descent
= height
- ascent
;
22900 glyph
->voffset
= it
->voffset
;
22901 glyph
->type
= STRETCH_GLYPH
;
22902 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22903 glyph
->multibyte_p
= it
->multibyte_p
;
22904 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22905 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22906 glyph
->overlaps_vertically_p
= 0;
22907 glyph
->padding_p
= 0;
22908 glyph
->glyph_not_available_p
= 0;
22909 glyph
->face_id
= it
->face_id
;
22910 glyph
->u
.stretch
.ascent
= ascent
;
22911 glyph
->u
.stretch
.height
= height
;
22912 glyph
->slice
.img
= null_glyph_slice
;
22913 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22916 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22917 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22919 glyph
->bidi_type
= it
->bidi_it
.type
;
22923 glyph
->resolved_level
= 0;
22924 glyph
->bidi_type
= UNKNOWN_BT
;
22926 ++it
->glyph_row
->used
[area
];
22929 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22933 /* Produce a stretch glyph for iterator IT. IT->object is the value
22934 of the glyph property displayed. The value must be a list
22935 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22938 1. `:width WIDTH' specifies that the space should be WIDTH *
22939 canonical char width wide. WIDTH may be an integer or floating
22942 2. `:relative-width FACTOR' specifies that the width of the stretch
22943 should be computed from the width of the first character having the
22944 `glyph' property, and should be FACTOR times that width.
22946 3. `:align-to HPOS' specifies that the space should be wide enough
22947 to reach HPOS, a value in canonical character units.
22949 Exactly one of the above pairs must be present.
22951 4. `:height HEIGHT' specifies that the height of the stretch produced
22952 should be HEIGHT, measured in canonical character units.
22954 5. `:relative-height FACTOR' specifies that the height of the
22955 stretch should be FACTOR times the height of the characters having
22956 the glyph property.
22958 Either none or exactly one of 4 or 5 must be present.
22960 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22961 of the stretch should be used for the ascent of the stretch.
22962 ASCENT must be in the range 0 <= ASCENT <= 100. */
22965 produce_stretch_glyph (struct it
*it
)
22967 /* (space :width WIDTH :height HEIGHT ...) */
22968 Lisp_Object prop
, plist
;
22969 int width
= 0, height
= 0, align_to
= -1;
22970 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22973 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22974 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22976 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22978 /* List should start with `space'. */
22979 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22980 plist
= XCDR (it
->object
);
22982 /* Compute the width of the stretch. */
22983 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22984 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22986 /* Absolute width `:width WIDTH' specified and valid. */
22987 zero_width_ok_p
= 1;
22990 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22993 /* Relative width `:relative-width FACTOR' specified and valid.
22994 Compute the width of the characters having the `glyph'
22997 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23000 if (it
->multibyte_p
)
23001 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23004 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23005 if (! ASCII_CHAR_P (it2
.c
))
23006 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23009 it2
.glyph_row
= NULL
;
23010 it2
.what
= IT_CHARACTER
;
23011 x_produce_glyphs (&it2
);
23012 width
= NUMVAL (prop
) * it2
.pixel_width
;
23014 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23015 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23017 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23018 align_to
= (align_to
< 0
23020 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23021 else if (align_to
< 0)
23022 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23023 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23024 zero_width_ok_p
= 1;
23027 /* Nothing specified -> width defaults to canonical char width. */
23028 width
= FRAME_COLUMN_WIDTH (it
->f
);
23030 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23033 /* Compute height. */
23034 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23035 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23038 zero_height_ok_p
= 1;
23040 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23042 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23044 height
= FONT_HEIGHT (font
);
23046 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23049 /* Compute percentage of height used for ascent. If
23050 `:ascent ASCENT' is present and valid, use that. Otherwise,
23051 derive the ascent from the font in use. */
23052 if (prop
= Fplist_get (plist
, QCascent
),
23053 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23054 ascent
= height
* NUMVAL (prop
) / 100.0;
23055 else if (!NILP (prop
)
23056 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23057 ascent
= min (max (0, (int)tem
), height
);
23059 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23061 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23062 && it
->current_x
+ width
> it
->last_visible_x
)
23063 width
= it
->last_visible_x
- it
->current_x
- 1;
23065 if (width
> 0 && height
> 0 && it
->glyph_row
)
23067 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23068 if (!STRINGP (object
))
23069 object
= it
->w
->buffer
;
23070 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23073 it
->pixel_width
= width
;
23074 it
->ascent
= it
->phys_ascent
= ascent
;
23075 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23076 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23078 take_vertical_position_into_account (it
);
23081 /* Calculate line-height and line-spacing properties.
23082 An integer value specifies explicit pixel value.
23083 A float value specifies relative value to current face height.
23084 A cons (float . face-name) specifies relative value to
23085 height of specified face font.
23087 Returns height in pixels, or nil. */
23091 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23092 int boff
, int override
)
23094 Lisp_Object face_name
= Qnil
;
23095 int ascent
, descent
, height
;
23097 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23102 face_name
= XCAR (val
);
23104 if (!NUMBERP (val
))
23105 val
= make_number (1);
23106 if (NILP (face_name
))
23108 height
= it
->ascent
+ it
->descent
;
23113 if (NILP (face_name
))
23115 font
= FRAME_FONT (it
->f
);
23116 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23118 else if (EQ (face_name
, Qt
))
23127 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23129 return make_number (-1);
23131 face
= FACE_FROM_ID (it
->f
, face_id
);
23134 return make_number (-1);
23135 boff
= font
->baseline_offset
;
23136 if (font
->vertical_centering
)
23137 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23140 ascent
= FONT_BASE (font
) + boff
;
23141 descent
= FONT_DESCENT (font
) - boff
;
23145 it
->override_ascent
= ascent
;
23146 it
->override_descent
= descent
;
23147 it
->override_boff
= boff
;
23150 height
= ascent
+ descent
;
23154 height
= (int)(XFLOAT_DATA (val
) * height
);
23155 else if (INTEGERP (val
))
23156 height
*= XINT (val
);
23158 return make_number (height
);
23162 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23163 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23164 and only if this is for a character for which no font was found.
23166 If the display method (it->glyphless_method) is
23167 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23168 length of the acronym or the hexadecimal string, UPPER_XOFF and
23169 UPPER_YOFF are pixel offsets for the upper part of the string,
23170 LOWER_XOFF and LOWER_YOFF are for the lower part.
23172 For the other display methods, LEN through LOWER_YOFF are zero. */
23175 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23176 short upper_xoff
, short upper_yoff
,
23177 short lower_xoff
, short lower_yoff
)
23179 struct glyph
*glyph
;
23180 enum glyph_row_area area
= it
->area
;
23182 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23183 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23185 /* If the glyph row is reversed, we need to prepend the glyph
23186 rather than append it. */
23187 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23191 /* Make room for the additional glyph. */
23192 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23194 glyph
= it
->glyph_row
->glyphs
[area
];
23196 glyph
->charpos
= CHARPOS (it
->position
);
23197 glyph
->object
= it
->object
;
23198 glyph
->pixel_width
= it
->pixel_width
;
23199 glyph
->ascent
= it
->ascent
;
23200 glyph
->descent
= it
->descent
;
23201 glyph
->voffset
= it
->voffset
;
23202 glyph
->type
= GLYPHLESS_GLYPH
;
23203 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23204 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23205 glyph
->u
.glyphless
.len
= len
;
23206 glyph
->u
.glyphless
.ch
= it
->c
;
23207 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23208 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23209 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23210 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23211 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23212 glyph
->multibyte_p
= it
->multibyte_p
;
23213 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23214 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23215 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23216 || it
->phys_descent
> it
->descent
);
23217 glyph
->padding_p
= 0;
23218 glyph
->glyph_not_available_p
= 0;
23219 glyph
->face_id
= face_id
;
23220 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23223 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23224 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23226 glyph
->bidi_type
= it
->bidi_it
.type
;
23228 ++it
->glyph_row
->used
[area
];
23231 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23235 /* Produce a glyph for a glyphless character for iterator IT.
23236 IT->glyphless_method specifies which method to use for displaying
23237 the character. See the description of enum
23238 glyphless_display_method in dispextern.h for the detail.
23240 FOR_NO_FONT is nonzero if and only if this is for a character for
23241 which no font was found. ACRONYM, if non-nil, is an acronym string
23242 for the character. */
23245 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23250 int base_width
, base_height
, width
, height
;
23251 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23254 /* Get the metrics of the base font. We always refer to the current
23256 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23257 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23258 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23259 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23260 base_height
= it
->ascent
+ it
->descent
;
23261 base_width
= font
->average_width
;
23263 /* Get a face ID for the glyph by utilizing a cache (the same way as
23264 done for `escape-glyph' in get_next_display_element). */
23265 if (it
->f
== last_glyphless_glyph_frame
23266 && it
->face_id
== last_glyphless_glyph_face_id
)
23268 face_id
= last_glyphless_glyph_merged_face_id
;
23272 /* Merge the `glyphless-char' face into the current face. */
23273 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23274 last_glyphless_glyph_frame
= it
->f
;
23275 last_glyphless_glyph_face_id
= it
->face_id
;
23276 last_glyphless_glyph_merged_face_id
= face_id
;
23279 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23281 it
->pixel_width
= THIN_SPACE_WIDTH
;
23283 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23285 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23287 width
= CHAR_WIDTH (it
->c
);
23290 else if (width
> 4)
23292 it
->pixel_width
= base_width
* width
;
23294 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23300 unsigned int code
[6];
23302 int ascent
, descent
;
23303 struct font_metrics metrics_upper
, metrics_lower
;
23305 face
= FACE_FROM_ID (it
->f
, face_id
);
23306 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23307 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23309 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23311 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23312 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23313 if (CONSP (acronym
))
23314 acronym
= XCAR (acronym
);
23315 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23319 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23320 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23323 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23324 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23325 upper_len
= (len
+ 1) / 2;
23326 font
->driver
->text_extents (font
, code
, upper_len
,
23328 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23333 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23334 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23335 upper_xoff
= upper_yoff
= 2; /* the typical case */
23336 if (base_width
>= width
)
23338 /* Align the upper to the left, the lower to the right. */
23339 it
->pixel_width
= base_width
;
23340 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23344 /* Center the shorter one. */
23345 it
->pixel_width
= width
;
23346 if (metrics_upper
.width
>= metrics_lower
.width
)
23347 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23350 /* FIXME: This code doesn't look right. It formerly was
23351 missing the "lower_xoff = 0;", which couldn't have
23352 been right since it left lower_xoff uninitialized. */
23354 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23358 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23359 top, bottom, and between upper and lower strings. */
23360 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23361 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23362 /* Center vertically.
23363 H:base_height, D:base_descent
23364 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23366 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23367 descent = D - H/2 + h/2;
23368 lower_yoff = descent - 2 - ld;
23369 upper_yoff = lower_yoff - la - 1 - ud; */
23370 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23371 descent
= it
->descent
- (base_height
- height
) / 2;
23372 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23373 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23374 - metrics_upper
.descent
);
23375 /* Don't make the height shorter than the base height. */
23376 if (height
> base_height
)
23378 it
->ascent
= ascent
;
23379 it
->descent
= descent
;
23383 it
->phys_ascent
= it
->ascent
;
23384 it
->phys_descent
= it
->descent
;
23386 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23387 upper_xoff
, upper_yoff
,
23388 lower_xoff
, lower_yoff
);
23390 take_vertical_position_into_account (it
);
23395 Produce glyphs/get display metrics for the display element IT is
23396 loaded with. See the description of struct it in dispextern.h
23397 for an overview of struct it. */
23400 x_produce_glyphs (struct it
*it
)
23402 int extra_line_spacing
= it
->extra_line_spacing
;
23404 it
->glyph_not_available_p
= 0;
23406 if (it
->what
== IT_CHARACTER
)
23409 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23410 struct font
*font
= face
->font
;
23411 struct font_metrics
*pcm
= NULL
;
23412 int boff
; /* baseline offset */
23416 /* When no suitable font is found, display this character by
23417 the method specified in the first extra slot of
23418 Vglyphless_char_display. */
23419 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23421 xassert (it
->what
== IT_GLYPHLESS
);
23422 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23426 boff
= font
->baseline_offset
;
23427 if (font
->vertical_centering
)
23428 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23430 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23436 if (it
->override_ascent
>= 0)
23438 it
->ascent
= it
->override_ascent
;
23439 it
->descent
= it
->override_descent
;
23440 boff
= it
->override_boff
;
23444 it
->ascent
= FONT_BASE (font
) + boff
;
23445 it
->descent
= FONT_DESCENT (font
) - boff
;
23448 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23450 pcm
= get_per_char_metric (font
, &char2b
);
23451 if (pcm
->width
== 0
23452 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23458 it
->phys_ascent
= pcm
->ascent
+ boff
;
23459 it
->phys_descent
= pcm
->descent
- boff
;
23460 it
->pixel_width
= pcm
->width
;
23464 it
->glyph_not_available_p
= 1;
23465 it
->phys_ascent
= it
->ascent
;
23466 it
->phys_descent
= it
->descent
;
23467 it
->pixel_width
= font
->space_width
;
23470 if (it
->constrain_row_ascent_descent_p
)
23472 if (it
->descent
> it
->max_descent
)
23474 it
->ascent
+= it
->descent
- it
->max_descent
;
23475 it
->descent
= it
->max_descent
;
23477 if (it
->ascent
> it
->max_ascent
)
23479 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23480 it
->ascent
= it
->max_ascent
;
23482 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23483 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23484 extra_line_spacing
= 0;
23487 /* If this is a space inside a region of text with
23488 `space-width' property, change its width. */
23489 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23491 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23493 /* If face has a box, add the box thickness to the character
23494 height. If character has a box line to the left and/or
23495 right, add the box line width to the character's width. */
23496 if (face
->box
!= FACE_NO_BOX
)
23498 int thick
= face
->box_line_width
;
23502 it
->ascent
+= thick
;
23503 it
->descent
+= thick
;
23508 if (it
->start_of_box_run_p
)
23509 it
->pixel_width
+= thick
;
23510 if (it
->end_of_box_run_p
)
23511 it
->pixel_width
+= thick
;
23514 /* If face has an overline, add the height of the overline
23515 (1 pixel) and a 1 pixel margin to the character height. */
23516 if (face
->overline_p
)
23517 it
->ascent
+= overline_margin
;
23519 if (it
->constrain_row_ascent_descent_p
)
23521 if (it
->ascent
> it
->max_ascent
)
23522 it
->ascent
= it
->max_ascent
;
23523 if (it
->descent
> it
->max_descent
)
23524 it
->descent
= it
->max_descent
;
23527 take_vertical_position_into_account (it
);
23529 /* If we have to actually produce glyphs, do it. */
23534 /* Translate a space with a `space-width' property
23535 into a stretch glyph. */
23536 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23537 / FONT_HEIGHT (font
));
23538 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23539 it
->ascent
+ it
->descent
, ascent
);
23544 /* If characters with lbearing or rbearing are displayed
23545 in this line, record that fact in a flag of the
23546 glyph row. This is used to optimize X output code. */
23547 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23548 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23550 if (! stretched_p
&& it
->pixel_width
== 0)
23551 /* We assure that all visible glyphs have at least 1-pixel
23553 it
->pixel_width
= 1;
23555 else if (it
->char_to_display
== '\n')
23557 /* A newline has no width, but we need the height of the
23558 line. But if previous part of the line sets a height,
23559 don't increase that height */
23561 Lisp_Object height
;
23562 Lisp_Object total_height
= Qnil
;
23564 it
->override_ascent
= -1;
23565 it
->pixel_width
= 0;
23568 height
= get_it_property (it
, Qline_height
);
23569 /* Split (line-height total-height) list */
23571 && CONSP (XCDR (height
))
23572 && NILP (XCDR (XCDR (height
))))
23574 total_height
= XCAR (XCDR (height
));
23575 height
= XCAR (height
);
23577 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23579 if (it
->override_ascent
>= 0)
23581 it
->ascent
= it
->override_ascent
;
23582 it
->descent
= it
->override_descent
;
23583 boff
= it
->override_boff
;
23587 it
->ascent
= FONT_BASE (font
) + boff
;
23588 it
->descent
= FONT_DESCENT (font
) - boff
;
23591 if (EQ (height
, Qt
))
23593 if (it
->descent
> it
->max_descent
)
23595 it
->ascent
+= it
->descent
- it
->max_descent
;
23596 it
->descent
= it
->max_descent
;
23598 if (it
->ascent
> it
->max_ascent
)
23600 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23601 it
->ascent
= it
->max_ascent
;
23603 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23604 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23605 it
->constrain_row_ascent_descent_p
= 1;
23606 extra_line_spacing
= 0;
23610 Lisp_Object spacing
;
23612 it
->phys_ascent
= it
->ascent
;
23613 it
->phys_descent
= it
->descent
;
23615 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23616 && face
->box
!= FACE_NO_BOX
23617 && face
->box_line_width
> 0)
23619 it
->ascent
+= face
->box_line_width
;
23620 it
->descent
+= face
->box_line_width
;
23623 && XINT (height
) > it
->ascent
+ it
->descent
)
23624 it
->ascent
= XINT (height
) - it
->descent
;
23626 if (!NILP (total_height
))
23627 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23630 spacing
= get_it_property (it
, Qline_spacing
);
23631 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23633 if (INTEGERP (spacing
))
23635 extra_line_spacing
= XINT (spacing
);
23636 if (!NILP (total_height
))
23637 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23641 else /* i.e. (it->char_to_display == '\t') */
23643 if (font
->space_width
> 0)
23645 int tab_width
= it
->tab_width
* font
->space_width
;
23646 int x
= it
->current_x
+ it
->continuation_lines_width
;
23647 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23649 /* If the distance from the current position to the next tab
23650 stop is less than a space character width, use the
23651 tab stop after that. */
23652 if (next_tab_x
- x
< font
->space_width
)
23653 next_tab_x
+= tab_width
;
23655 it
->pixel_width
= next_tab_x
- x
;
23657 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23658 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23662 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23663 it
->ascent
+ it
->descent
, it
->ascent
);
23668 it
->pixel_width
= 0;
23673 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23675 /* A static composition.
23677 Note: A composition is represented as one glyph in the
23678 glyph matrix. There are no padding glyphs.
23680 Important note: pixel_width, ascent, and descent are the
23681 values of what is drawn by draw_glyphs (i.e. the values of
23682 the overall glyphs composed). */
23683 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23684 int boff
; /* baseline offset */
23685 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23686 int glyph_len
= cmp
->glyph_len
;
23687 struct font
*font
= face
->font
;
23691 /* If we have not yet calculated pixel size data of glyphs of
23692 the composition for the current face font, calculate them
23693 now. Theoretically, we have to check all fonts for the
23694 glyphs, but that requires much time and memory space. So,
23695 here we check only the font of the first glyph. This may
23696 lead to incorrect display, but it's very rare, and C-l
23697 (recenter-top-bottom) can correct the display anyway. */
23698 if (! cmp
->font
|| cmp
->font
!= font
)
23700 /* Ascent and descent of the font of the first character
23701 of this composition (adjusted by baseline offset).
23702 Ascent and descent of overall glyphs should not be less
23703 than these, respectively. */
23704 int font_ascent
, font_descent
, font_height
;
23705 /* Bounding box of the overall glyphs. */
23706 int leftmost
, rightmost
, lowest
, highest
;
23707 int lbearing
, rbearing
;
23708 int i
, width
, ascent
, descent
;
23709 int left_padded
= 0, right_padded
= 0;
23710 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23712 struct font_metrics
*pcm
;
23713 int font_not_found_p
;
23716 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23717 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23719 if (glyph_len
< cmp
->glyph_len
)
23721 for (i
= 0; i
< glyph_len
; i
++)
23723 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23725 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23730 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23731 : IT_CHARPOS (*it
));
23732 /* If no suitable font is found, use the default font. */
23733 font_not_found_p
= font
== NULL
;
23734 if (font_not_found_p
)
23736 face
= face
->ascii_face
;
23739 boff
= font
->baseline_offset
;
23740 if (font
->vertical_centering
)
23741 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23742 font_ascent
= FONT_BASE (font
) + boff
;
23743 font_descent
= FONT_DESCENT (font
) - boff
;
23744 font_height
= FONT_HEIGHT (font
);
23746 cmp
->font
= (void *) font
;
23749 if (! font_not_found_p
)
23751 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23753 pcm
= get_per_char_metric (font
, &char2b
);
23756 /* Initialize the bounding box. */
23759 width
= pcm
->width
;
23760 ascent
= pcm
->ascent
;
23761 descent
= pcm
->descent
;
23762 lbearing
= pcm
->lbearing
;
23763 rbearing
= pcm
->rbearing
;
23767 width
= font
->space_width
;
23768 ascent
= FONT_BASE (font
);
23769 descent
= FONT_DESCENT (font
);
23776 lowest
= - descent
+ boff
;
23777 highest
= ascent
+ boff
;
23779 if (! font_not_found_p
23780 && font
->default_ascent
23781 && CHAR_TABLE_P (Vuse_default_ascent
)
23782 && !NILP (Faref (Vuse_default_ascent
,
23783 make_number (it
->char_to_display
))))
23784 highest
= font
->default_ascent
+ boff
;
23786 /* Draw the first glyph at the normal position. It may be
23787 shifted to right later if some other glyphs are drawn
23789 cmp
->offsets
[i
* 2] = 0;
23790 cmp
->offsets
[i
* 2 + 1] = boff
;
23791 cmp
->lbearing
= lbearing
;
23792 cmp
->rbearing
= rbearing
;
23794 /* Set cmp->offsets for the remaining glyphs. */
23795 for (i
++; i
< glyph_len
; i
++)
23797 int left
, right
, btm
, top
;
23798 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23800 struct face
*this_face
;
23804 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23805 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23806 font
= this_face
->font
;
23812 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23814 pcm
= get_per_char_metric (font
, &char2b
);
23817 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23820 width
= pcm
->width
;
23821 ascent
= pcm
->ascent
;
23822 descent
= pcm
->descent
;
23823 lbearing
= pcm
->lbearing
;
23824 rbearing
= pcm
->rbearing
;
23825 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23827 /* Relative composition with or without
23828 alternate chars. */
23829 left
= (leftmost
+ rightmost
- width
) / 2;
23830 btm
= - descent
+ boff
;
23831 if (font
->relative_compose
23832 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23833 || NILP (Faref (Vignore_relative_composition
,
23834 make_number (ch
)))))
23837 if (- descent
>= font
->relative_compose
)
23838 /* One extra pixel between two glyphs. */
23840 else if (ascent
<= 0)
23841 /* One extra pixel between two glyphs. */
23842 btm
= lowest
- 1 - ascent
- descent
;
23847 /* A composition rule is specified by an integer
23848 value that encodes global and new reference
23849 points (GREF and NREF). GREF and NREF are
23850 specified by numbers as below:
23852 0---1---2 -- ascent
23856 9--10--11 -- center
23858 ---3---4---5--- baseline
23860 6---7---8 -- descent
23862 int rule
= COMPOSITION_RULE (cmp
, i
);
23863 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23865 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23866 grefx
= gref
% 3, nrefx
= nref
% 3;
23867 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23869 xoff
= font_height
* (xoff
- 128) / 256;
23871 yoff
= font_height
* (yoff
- 128) / 256;
23874 + grefx
* (rightmost
- leftmost
) / 2
23875 - nrefx
* width
/ 2
23878 btm
= ((grefy
== 0 ? highest
23880 : grefy
== 2 ? lowest
23881 : (highest
+ lowest
) / 2)
23882 - (nrefy
== 0 ? ascent
+ descent
23883 : nrefy
== 1 ? descent
- boff
23885 : (ascent
+ descent
) / 2)
23889 cmp
->offsets
[i
* 2] = left
;
23890 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23892 /* Update the bounding box of the overall glyphs. */
23895 right
= left
+ width
;
23896 if (left
< leftmost
)
23898 if (right
> rightmost
)
23901 top
= btm
+ descent
+ ascent
;
23907 if (cmp
->lbearing
> left
+ lbearing
)
23908 cmp
->lbearing
= left
+ lbearing
;
23909 if (cmp
->rbearing
< left
+ rbearing
)
23910 cmp
->rbearing
= left
+ rbearing
;
23914 /* If there are glyphs whose x-offsets are negative,
23915 shift all glyphs to the right and make all x-offsets
23919 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23920 cmp
->offsets
[i
* 2] -= leftmost
;
23921 rightmost
-= leftmost
;
23922 cmp
->lbearing
-= leftmost
;
23923 cmp
->rbearing
-= leftmost
;
23926 if (left_padded
&& cmp
->lbearing
< 0)
23928 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23929 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23930 rightmost
-= cmp
->lbearing
;
23931 cmp
->rbearing
-= cmp
->lbearing
;
23934 if (right_padded
&& rightmost
< cmp
->rbearing
)
23936 rightmost
= cmp
->rbearing
;
23939 cmp
->pixel_width
= rightmost
;
23940 cmp
->ascent
= highest
;
23941 cmp
->descent
= - lowest
;
23942 if (cmp
->ascent
< font_ascent
)
23943 cmp
->ascent
= font_ascent
;
23944 if (cmp
->descent
< font_descent
)
23945 cmp
->descent
= font_descent
;
23949 && (cmp
->lbearing
< 0
23950 || cmp
->rbearing
> cmp
->pixel_width
))
23951 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23953 it
->pixel_width
= cmp
->pixel_width
;
23954 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
23955 it
->descent
= it
->phys_descent
= cmp
->descent
;
23956 if (face
->box
!= FACE_NO_BOX
)
23958 int thick
= face
->box_line_width
;
23962 it
->ascent
+= thick
;
23963 it
->descent
+= thick
;
23968 if (it
->start_of_box_run_p
)
23969 it
->pixel_width
+= thick
;
23970 if (it
->end_of_box_run_p
)
23971 it
->pixel_width
+= thick
;
23974 /* If face has an overline, add the height of the overline
23975 (1 pixel) and a 1 pixel margin to the character height. */
23976 if (face
->overline_p
)
23977 it
->ascent
+= overline_margin
;
23979 take_vertical_position_into_account (it
);
23980 if (it
->ascent
< 0)
23982 if (it
->descent
< 0)
23986 append_composite_glyph (it
);
23988 else if (it
->what
== IT_COMPOSITION
)
23990 /* A dynamic (automatic) composition. */
23991 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23992 Lisp_Object gstring
;
23993 struct font_metrics metrics
;
23995 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23997 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24000 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24001 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24002 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24003 it
->descent
= it
->phys_descent
= metrics
.descent
;
24004 if (face
->box
!= FACE_NO_BOX
)
24006 int thick
= face
->box_line_width
;
24010 it
->ascent
+= thick
;
24011 it
->descent
+= thick
;
24016 if (it
->start_of_box_run_p
)
24017 it
->pixel_width
+= thick
;
24018 if (it
->end_of_box_run_p
)
24019 it
->pixel_width
+= thick
;
24021 /* If face has an overline, add the height of the overline
24022 (1 pixel) and a 1 pixel margin to the character height. */
24023 if (face
->overline_p
)
24024 it
->ascent
+= overline_margin
;
24025 take_vertical_position_into_account (it
);
24026 if (it
->ascent
< 0)
24028 if (it
->descent
< 0)
24032 append_composite_glyph (it
);
24034 else if (it
->what
== IT_GLYPHLESS
)
24035 produce_glyphless_glyph (it
, 0, Qnil
);
24036 else if (it
->what
== IT_IMAGE
)
24037 produce_image_glyph (it
);
24038 else if (it
->what
== IT_STRETCH
)
24039 produce_stretch_glyph (it
);
24042 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24043 because this isn't true for images with `:ascent 100'. */
24044 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24045 if (it
->area
== TEXT_AREA
)
24046 it
->current_x
+= it
->pixel_width
;
24048 if (extra_line_spacing
> 0)
24050 it
->descent
+= extra_line_spacing
;
24051 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24052 it
->max_extra_line_spacing
= extra_line_spacing
;
24055 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24056 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24057 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24058 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24062 Output LEN glyphs starting at START at the nominal cursor position.
24063 Advance the nominal cursor over the text. The global variable
24064 updated_window contains the window being updated, updated_row is
24065 the glyph row being updated, and updated_area is the area of that
24066 row being updated. */
24069 x_write_glyphs (struct glyph
*start
, int len
)
24073 xassert (updated_window
&& updated_row
);
24076 /* Write glyphs. */
24078 hpos
= start
- updated_row
->glyphs
[updated_area
];
24079 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24080 updated_row
, updated_area
,
24082 DRAW_NORMAL_TEXT
, 0);
24084 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24085 if (updated_area
== TEXT_AREA
24086 && updated_window
->phys_cursor_on_p
24087 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24088 && updated_window
->phys_cursor
.hpos
>= hpos
24089 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24090 updated_window
->phys_cursor_on_p
= 0;
24094 /* Advance the output cursor. */
24095 output_cursor
.hpos
+= len
;
24096 output_cursor
.x
= x
;
24101 Insert LEN glyphs from START at the nominal cursor position. */
24104 x_insert_glyphs (struct glyph
*start
, int len
)
24108 int line_height
, shift_by_width
, shifted_region_width
;
24109 struct glyph_row
*row
;
24110 struct glyph
*glyph
;
24111 int frame_x
, frame_y
;
24114 xassert (updated_window
&& updated_row
);
24116 w
= updated_window
;
24117 f
= XFRAME (WINDOW_FRAME (w
));
24119 /* Get the height of the line we are in. */
24121 line_height
= row
->height
;
24123 /* Get the width of the glyphs to insert. */
24124 shift_by_width
= 0;
24125 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24126 shift_by_width
+= glyph
->pixel_width
;
24128 /* Get the width of the region to shift right. */
24129 shifted_region_width
= (window_box_width (w
, updated_area
)
24134 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24135 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24137 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24138 line_height
, shift_by_width
);
24140 /* Write the glyphs. */
24141 hpos
= start
- row
->glyphs
[updated_area
];
24142 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24144 DRAW_NORMAL_TEXT
, 0);
24146 /* Advance the output cursor. */
24147 output_cursor
.hpos
+= len
;
24148 output_cursor
.x
+= shift_by_width
;
24154 Erase the current text line from the nominal cursor position
24155 (inclusive) to pixel column TO_X (exclusive). The idea is that
24156 everything from TO_X onward is already erased.
24158 TO_X is a pixel position relative to updated_area of
24159 updated_window. TO_X == -1 means clear to the end of this area. */
24162 x_clear_end_of_line (int to_x
)
24165 struct window
*w
= updated_window
;
24166 int max_x
, min_y
, max_y
;
24167 int from_x
, from_y
, to_y
;
24169 xassert (updated_window
&& updated_row
);
24170 f
= XFRAME (w
->frame
);
24172 if (updated_row
->full_width_p
)
24173 max_x
= WINDOW_TOTAL_WIDTH (w
);
24175 max_x
= window_box_width (w
, updated_area
);
24176 max_y
= window_text_bottom_y (w
);
24178 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24179 of window. For TO_X > 0, truncate to end of drawing area. */
24185 to_x
= min (to_x
, max_x
);
24187 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24189 /* Notice if the cursor will be cleared by this operation. */
24190 if (!updated_row
->full_width_p
)
24191 notice_overwritten_cursor (w
, updated_area
,
24192 output_cursor
.x
, -1,
24194 MATRIX_ROW_BOTTOM_Y (updated_row
));
24196 from_x
= output_cursor
.x
;
24198 /* Translate to frame coordinates. */
24199 if (updated_row
->full_width_p
)
24201 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24202 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24206 int area_left
= window_box_left (w
, updated_area
);
24207 from_x
+= area_left
;
24211 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24212 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24213 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24215 /* Prevent inadvertently clearing to end of the X window. */
24216 if (to_x
> from_x
&& to_y
> from_y
)
24219 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24220 to_x
- from_x
, to_y
- from_y
);
24225 #endif /* HAVE_WINDOW_SYSTEM */
24229 /***********************************************************************
24231 ***********************************************************************/
24233 /* Value is the internal representation of the specified cursor type
24234 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24235 of the bar cursor. */
24237 static enum text_cursor_kinds
24238 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24240 enum text_cursor_kinds type
;
24245 if (EQ (arg
, Qbox
))
24246 return FILLED_BOX_CURSOR
;
24248 if (EQ (arg
, Qhollow
))
24249 return HOLLOW_BOX_CURSOR
;
24251 if (EQ (arg
, Qbar
))
24258 && EQ (XCAR (arg
), Qbar
)
24259 && INTEGERP (XCDR (arg
))
24260 && XINT (XCDR (arg
)) >= 0)
24262 *width
= XINT (XCDR (arg
));
24266 if (EQ (arg
, Qhbar
))
24269 return HBAR_CURSOR
;
24273 && EQ (XCAR (arg
), Qhbar
)
24274 && INTEGERP (XCDR (arg
))
24275 && XINT (XCDR (arg
)) >= 0)
24277 *width
= XINT (XCDR (arg
));
24278 return HBAR_CURSOR
;
24281 /* Treat anything unknown as "hollow box cursor".
24282 It was bad to signal an error; people have trouble fixing
24283 .Xdefaults with Emacs, when it has something bad in it. */
24284 type
= HOLLOW_BOX_CURSOR
;
24289 /* Set the default cursor types for specified frame. */
24291 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24296 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24297 FRAME_CURSOR_WIDTH (f
) = width
;
24299 /* By default, set up the blink-off state depending on the on-state. */
24301 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24304 FRAME_BLINK_OFF_CURSOR (f
)
24305 = get_specified_cursor_type (XCDR (tem
), &width
);
24306 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24309 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24313 #ifdef HAVE_WINDOW_SYSTEM
24315 /* Return the cursor we want to be displayed in window W. Return
24316 width of bar/hbar cursor through WIDTH arg. Return with
24317 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24318 (i.e. if the `system caret' should track this cursor).
24320 In a mini-buffer window, we want the cursor only to appear if we
24321 are reading input from this window. For the selected window, we
24322 want the cursor type given by the frame parameter or buffer local
24323 setting of cursor-type. If explicitly marked off, draw no cursor.
24324 In all other cases, we want a hollow box cursor. */
24326 static enum text_cursor_kinds
24327 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24328 int *active_cursor
)
24330 struct frame
*f
= XFRAME (w
->frame
);
24331 struct buffer
*b
= XBUFFER (w
->buffer
);
24332 int cursor_type
= DEFAULT_CURSOR
;
24333 Lisp_Object alt_cursor
;
24334 int non_selected
= 0;
24336 *active_cursor
= 1;
24339 if (cursor_in_echo_area
24340 && FRAME_HAS_MINIBUF_P (f
)
24341 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24343 if (w
== XWINDOW (echo_area_window
))
24345 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24347 *width
= FRAME_CURSOR_WIDTH (f
);
24348 return FRAME_DESIRED_CURSOR (f
);
24351 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24354 *active_cursor
= 0;
24358 /* Detect a nonselected window or nonselected frame. */
24359 else if (w
!= XWINDOW (f
->selected_window
)
24360 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24362 *active_cursor
= 0;
24364 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24370 /* Never display a cursor in a window in which cursor-type is nil. */
24371 if (NILP (BVAR (b
, cursor_type
)))
24374 /* Get the normal cursor type for this window. */
24375 if (EQ (BVAR (b
, cursor_type
), Qt
))
24377 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24378 *width
= FRAME_CURSOR_WIDTH (f
);
24381 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24383 /* Use cursor-in-non-selected-windows instead
24384 for non-selected window or frame. */
24387 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24388 if (!EQ (Qt
, alt_cursor
))
24389 return get_specified_cursor_type (alt_cursor
, width
);
24390 /* t means modify the normal cursor type. */
24391 if (cursor_type
== FILLED_BOX_CURSOR
)
24392 cursor_type
= HOLLOW_BOX_CURSOR
;
24393 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24395 return cursor_type
;
24398 /* Use normal cursor if not blinked off. */
24399 if (!w
->cursor_off_p
)
24401 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24403 if (cursor_type
== FILLED_BOX_CURSOR
)
24405 /* Using a block cursor on large images can be very annoying.
24406 So use a hollow cursor for "large" images.
24407 If image is not transparent (no mask), also use hollow cursor. */
24408 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24409 if (img
!= NULL
&& IMAGEP (img
->spec
))
24411 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24412 where N = size of default frame font size.
24413 This should cover most of the "tiny" icons people may use. */
24415 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24416 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24417 cursor_type
= HOLLOW_BOX_CURSOR
;
24420 else if (cursor_type
!= NO_CURSOR
)
24422 /* Display current only supports BOX and HOLLOW cursors for images.
24423 So for now, unconditionally use a HOLLOW cursor when cursor is
24424 not a solid box cursor. */
24425 cursor_type
= HOLLOW_BOX_CURSOR
;
24428 return cursor_type
;
24431 /* Cursor is blinked off, so determine how to "toggle" it. */
24433 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24434 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24435 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24437 /* Then see if frame has specified a specific blink off cursor type. */
24438 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24440 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24441 return FRAME_BLINK_OFF_CURSOR (f
);
24445 /* Some people liked having a permanently visible blinking cursor,
24446 while others had very strong opinions against it. So it was
24447 decided to remove it. KFS 2003-09-03 */
24449 /* Finally perform built-in cursor blinking:
24450 filled box <-> hollow box
24451 wide [h]bar <-> narrow [h]bar
24452 narrow [h]bar <-> no cursor
24453 other type <-> no cursor */
24455 if (cursor_type
== FILLED_BOX_CURSOR
)
24456 return HOLLOW_BOX_CURSOR
;
24458 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24461 return cursor_type
;
24469 /* Notice when the text cursor of window W has been completely
24470 overwritten by a drawing operation that outputs glyphs in AREA
24471 starting at X0 and ending at X1 in the line starting at Y0 and
24472 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24473 the rest of the line after X0 has been written. Y coordinates
24474 are window-relative. */
24477 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24478 int x0
, int x1
, int y0
, int y1
)
24480 int cx0
, cx1
, cy0
, cy1
;
24481 struct glyph_row
*row
;
24483 if (!w
->phys_cursor_on_p
)
24485 if (area
!= TEXT_AREA
)
24488 if (w
->phys_cursor
.vpos
< 0
24489 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24490 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24491 !(row
->enabled_p
&& row
->displays_text_p
)))
24494 if (row
->cursor_in_fringe_p
)
24496 row
->cursor_in_fringe_p
= 0;
24497 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24498 w
->phys_cursor_on_p
= 0;
24502 cx0
= w
->phys_cursor
.x
;
24503 cx1
= cx0
+ w
->phys_cursor_width
;
24504 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24507 /* The cursor image will be completely removed from the
24508 screen if the output area intersects the cursor area in
24509 y-direction. When we draw in [y0 y1[, and some part of
24510 the cursor is at y < y0, that part must have been drawn
24511 before. When scrolling, the cursor is erased before
24512 actually scrolling, so we don't come here. When not
24513 scrolling, the rows above the old cursor row must have
24514 changed, and in this case these rows must have written
24515 over the cursor image.
24517 Likewise if part of the cursor is below y1, with the
24518 exception of the cursor being in the first blank row at
24519 the buffer and window end because update_text_area
24520 doesn't draw that row. (Except when it does, but
24521 that's handled in update_text_area.) */
24523 cy0
= w
->phys_cursor
.y
;
24524 cy1
= cy0
+ w
->phys_cursor_height
;
24525 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24528 w
->phys_cursor_on_p
= 0;
24531 #endif /* HAVE_WINDOW_SYSTEM */
24534 /************************************************************************
24536 ************************************************************************/
24538 #ifdef HAVE_WINDOW_SYSTEM
24541 Fix the display of area AREA of overlapping row ROW in window W
24542 with respect to the overlapping part OVERLAPS. */
24545 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24546 enum glyph_row_area area
, int overlaps
)
24553 for (i
= 0; i
< row
->used
[area
];)
24555 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24557 int start
= i
, start_x
= x
;
24561 x
+= row
->glyphs
[area
][i
].pixel_width
;
24564 while (i
< row
->used
[area
]
24565 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24567 draw_glyphs (w
, start_x
, row
, area
,
24569 DRAW_NORMAL_TEXT
, overlaps
);
24573 x
+= row
->glyphs
[area
][i
].pixel_width
;
24583 Draw the cursor glyph of window W in glyph row ROW. See the
24584 comment of draw_glyphs for the meaning of HL. */
24587 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24588 enum draw_glyphs_face hl
)
24590 /* If cursor hpos is out of bounds, don't draw garbage. This can
24591 happen in mini-buffer windows when switching between echo area
24592 glyphs and mini-buffer. */
24593 if ((row
->reversed_p
24594 ? (w
->phys_cursor
.hpos
>= 0)
24595 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24597 int on_p
= w
->phys_cursor_on_p
;
24599 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24600 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24602 w
->phys_cursor_on_p
= on_p
;
24604 if (hl
== DRAW_CURSOR
)
24605 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24606 /* When we erase the cursor, and ROW is overlapped by other
24607 rows, make sure that these overlapping parts of other rows
24609 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24611 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24613 if (row
> w
->current_matrix
->rows
24614 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24615 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24616 OVERLAPS_ERASED_CURSOR
);
24618 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24619 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24620 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24621 OVERLAPS_ERASED_CURSOR
);
24628 Erase the image of a cursor of window W from the screen. */
24631 erase_phys_cursor (struct window
*w
)
24633 struct frame
*f
= XFRAME (w
->frame
);
24634 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24635 int hpos
= w
->phys_cursor
.hpos
;
24636 int vpos
= w
->phys_cursor
.vpos
;
24637 int mouse_face_here_p
= 0;
24638 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24639 struct glyph_row
*cursor_row
;
24640 struct glyph
*cursor_glyph
;
24641 enum draw_glyphs_face hl
;
24643 /* No cursor displayed or row invalidated => nothing to do on the
24645 if (w
->phys_cursor_type
== NO_CURSOR
)
24646 goto mark_cursor_off
;
24648 /* VPOS >= active_glyphs->nrows means that window has been resized.
24649 Don't bother to erase the cursor. */
24650 if (vpos
>= active_glyphs
->nrows
)
24651 goto mark_cursor_off
;
24653 /* If row containing cursor is marked invalid, there is nothing we
24655 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24656 if (!cursor_row
->enabled_p
)
24657 goto mark_cursor_off
;
24659 /* If line spacing is > 0, old cursor may only be partially visible in
24660 window after split-window. So adjust visible height. */
24661 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24662 window_text_bottom_y (w
) - cursor_row
->y
);
24664 /* If row is completely invisible, don't attempt to delete a cursor which
24665 isn't there. This can happen if cursor is at top of a window, and
24666 we switch to a buffer with a header line in that window. */
24667 if (cursor_row
->visible_height
<= 0)
24668 goto mark_cursor_off
;
24670 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24671 if (cursor_row
->cursor_in_fringe_p
)
24673 cursor_row
->cursor_in_fringe_p
= 0;
24674 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24675 goto mark_cursor_off
;
24678 /* This can happen when the new row is shorter than the old one.
24679 In this case, either draw_glyphs or clear_end_of_line
24680 should have cleared the cursor. Note that we wouldn't be
24681 able to erase the cursor in this case because we don't have a
24682 cursor glyph at hand. */
24683 if ((cursor_row
->reversed_p
24684 ? (w
->phys_cursor
.hpos
< 0)
24685 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24686 goto mark_cursor_off
;
24688 /* If the cursor is in the mouse face area, redisplay that when
24689 we clear the cursor. */
24690 if (! NILP (hlinfo
->mouse_face_window
)
24691 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24692 /* Don't redraw the cursor's spot in mouse face if it is at the
24693 end of a line (on a newline). The cursor appears there, but
24694 mouse highlighting does not. */
24695 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24696 mouse_face_here_p
= 1;
24698 /* Maybe clear the display under the cursor. */
24699 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24702 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24705 cursor_glyph
= get_phys_cursor_glyph (w
);
24706 if (cursor_glyph
== NULL
)
24707 goto mark_cursor_off
;
24709 width
= cursor_glyph
->pixel_width
;
24710 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24711 x
= w
->phys_cursor
.x
;
24713 width
-= left_x
- x
;
24714 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24715 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24716 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24719 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24722 /* Erase the cursor by redrawing the character underneath it. */
24723 if (mouse_face_here_p
)
24724 hl
= DRAW_MOUSE_FACE
;
24726 hl
= DRAW_NORMAL_TEXT
;
24727 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24730 w
->phys_cursor_on_p
= 0;
24731 w
->phys_cursor_type
= NO_CURSOR
;
24736 Display or clear cursor of window W. If ON is zero, clear the
24737 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24738 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24741 display_and_set_cursor (struct window
*w
, int on
,
24742 int hpos
, int vpos
, int x
, int y
)
24744 struct frame
*f
= XFRAME (w
->frame
);
24745 int new_cursor_type
;
24746 int new_cursor_width
;
24748 struct glyph_row
*glyph_row
;
24749 struct glyph
*glyph
;
24751 /* This is pointless on invisible frames, and dangerous on garbaged
24752 windows and frames; in the latter case, the frame or window may
24753 be in the midst of changing its size, and x and y may be off the
24755 if (! FRAME_VISIBLE_P (f
)
24756 || FRAME_GARBAGED_P (f
)
24757 || vpos
>= w
->current_matrix
->nrows
24758 || hpos
>= w
->current_matrix
->matrix_w
)
24761 /* If cursor is off and we want it off, return quickly. */
24762 if (!on
&& !w
->phys_cursor_on_p
)
24765 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24766 /* If cursor row is not enabled, we don't really know where to
24767 display the cursor. */
24768 if (!glyph_row
->enabled_p
)
24770 w
->phys_cursor_on_p
= 0;
24775 if (!glyph_row
->exact_window_width_line_p
24776 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24777 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24779 xassert (interrupt_input_blocked
);
24781 /* Set new_cursor_type to the cursor we want to be displayed. */
24782 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24783 &new_cursor_width
, &active_cursor
);
24785 /* If cursor is currently being shown and we don't want it to be or
24786 it is in the wrong place, or the cursor type is not what we want,
24788 if (w
->phys_cursor_on_p
24790 || w
->phys_cursor
.x
!= x
24791 || w
->phys_cursor
.y
!= y
24792 || new_cursor_type
!= w
->phys_cursor_type
24793 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24794 && new_cursor_width
!= w
->phys_cursor_width
)))
24795 erase_phys_cursor (w
);
24797 /* Don't check phys_cursor_on_p here because that flag is only set
24798 to zero in some cases where we know that the cursor has been
24799 completely erased, to avoid the extra work of erasing the cursor
24800 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24801 still not be visible, or it has only been partly erased. */
24804 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24805 w
->phys_cursor_height
= glyph_row
->height
;
24807 /* Set phys_cursor_.* before x_draw_.* is called because some
24808 of them may need the information. */
24809 w
->phys_cursor
.x
= x
;
24810 w
->phys_cursor
.y
= glyph_row
->y
;
24811 w
->phys_cursor
.hpos
= hpos
;
24812 w
->phys_cursor
.vpos
= vpos
;
24815 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24816 new_cursor_type
, new_cursor_width
,
24817 on
, active_cursor
);
24821 /* Switch the display of W's cursor on or off, according to the value
24825 update_window_cursor (struct window
*w
, int on
)
24827 /* Don't update cursor in windows whose frame is in the process
24828 of being deleted. */
24829 if (w
->current_matrix
)
24832 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24833 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24839 /* Call update_window_cursor with parameter ON_P on all leaf windows
24840 in the window tree rooted at W. */
24843 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24847 if (!NILP (w
->hchild
))
24848 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24849 else if (!NILP (w
->vchild
))
24850 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24852 update_window_cursor (w
, on_p
);
24854 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24860 Display the cursor on window W, or clear it, according to ON_P.
24861 Don't change the cursor's position. */
24864 x_update_cursor (struct frame
*f
, int on_p
)
24866 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24871 Clear the cursor of window W to background color, and mark the
24872 cursor as not shown. This is used when the text where the cursor
24873 is about to be rewritten. */
24876 x_clear_cursor (struct window
*w
)
24878 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24879 update_window_cursor (w
, 0);
24882 #endif /* HAVE_WINDOW_SYSTEM */
24884 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24887 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24888 int start_hpos
, int end_hpos
,
24889 enum draw_glyphs_face draw
)
24891 #ifdef HAVE_WINDOW_SYSTEM
24892 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24894 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24898 #if defined (HAVE_GPM) || defined (MSDOS)
24899 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24903 /* Display the active region described by mouse_face_* according to DRAW. */
24906 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24908 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24909 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24911 if (/* If window is in the process of being destroyed, don't bother
24913 w
->current_matrix
!= NULL
24914 /* Don't update mouse highlight if hidden */
24915 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24916 /* Recognize when we are called to operate on rows that don't exist
24917 anymore. This can happen when a window is split. */
24918 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24920 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24921 struct glyph_row
*row
, *first
, *last
;
24923 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24924 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24926 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24928 int start_hpos
, end_hpos
, start_x
;
24930 /* For all but the first row, the highlight starts at column 0. */
24933 /* R2L rows have BEG and END in reversed order, but the
24934 screen drawing geometry is always left to right. So
24935 we need to mirror the beginning and end of the
24936 highlighted area in R2L rows. */
24937 if (!row
->reversed_p
)
24939 start_hpos
= hlinfo
->mouse_face_beg_col
;
24940 start_x
= hlinfo
->mouse_face_beg_x
;
24942 else if (row
== last
)
24944 start_hpos
= hlinfo
->mouse_face_end_col
;
24945 start_x
= hlinfo
->mouse_face_end_x
;
24953 else if (row
->reversed_p
&& row
== last
)
24955 start_hpos
= hlinfo
->mouse_face_end_col
;
24956 start_x
= hlinfo
->mouse_face_end_x
;
24966 if (!row
->reversed_p
)
24967 end_hpos
= hlinfo
->mouse_face_end_col
;
24968 else if (row
== first
)
24969 end_hpos
= hlinfo
->mouse_face_beg_col
;
24972 end_hpos
= row
->used
[TEXT_AREA
];
24973 if (draw
== DRAW_NORMAL_TEXT
)
24974 row
->fill_line_p
= 1; /* Clear to end of line */
24977 else if (row
->reversed_p
&& row
== first
)
24978 end_hpos
= hlinfo
->mouse_face_beg_col
;
24981 end_hpos
= row
->used
[TEXT_AREA
];
24982 if (draw
== DRAW_NORMAL_TEXT
)
24983 row
->fill_line_p
= 1; /* Clear to end of line */
24986 if (end_hpos
> start_hpos
)
24988 draw_row_with_mouse_face (w
, start_x
, row
,
24989 start_hpos
, end_hpos
, draw
);
24992 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
24996 #ifdef HAVE_WINDOW_SYSTEM
24997 /* When we've written over the cursor, arrange for it to
24998 be displayed again. */
24999 if (FRAME_WINDOW_P (f
)
25000 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25003 display_and_set_cursor (w
, 1,
25004 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25005 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25008 #endif /* HAVE_WINDOW_SYSTEM */
25011 #ifdef HAVE_WINDOW_SYSTEM
25012 /* Change the mouse cursor. */
25013 if (FRAME_WINDOW_P (f
))
25015 if (draw
== DRAW_NORMAL_TEXT
25016 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25017 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25018 else if (draw
== DRAW_MOUSE_FACE
)
25019 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25021 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25023 #endif /* HAVE_WINDOW_SYSTEM */
25027 Clear out the mouse-highlighted active region.
25028 Redraw it un-highlighted first. Value is non-zero if mouse
25029 face was actually drawn unhighlighted. */
25032 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25036 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25038 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25042 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25043 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25044 hlinfo
->mouse_face_window
= Qnil
;
25045 hlinfo
->mouse_face_overlay
= Qnil
;
25049 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25050 within the mouse face on that window. */
25052 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25054 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25056 /* Quickly resolve the easy cases. */
25057 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25058 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25060 if (vpos
< hlinfo
->mouse_face_beg_row
25061 || vpos
> hlinfo
->mouse_face_end_row
)
25063 if (vpos
> hlinfo
->mouse_face_beg_row
25064 && vpos
< hlinfo
->mouse_face_end_row
)
25067 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25069 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25071 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25074 else if ((vpos
== hlinfo
->mouse_face_beg_row
25075 && hpos
>= hlinfo
->mouse_face_beg_col
)
25076 || (vpos
== hlinfo
->mouse_face_end_row
25077 && hpos
< hlinfo
->mouse_face_end_col
))
25082 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25084 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25087 else if ((vpos
== hlinfo
->mouse_face_beg_row
25088 && hpos
<= hlinfo
->mouse_face_beg_col
)
25089 || (vpos
== hlinfo
->mouse_face_end_row
25090 && hpos
> hlinfo
->mouse_face_end_col
))
25098 Non-zero if physical cursor of window W is within mouse face. */
25101 cursor_in_mouse_face_p (struct window
*w
)
25103 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25108 /* Find the glyph rows START_ROW and END_ROW of window W that display
25109 characters between buffer positions START_CHARPOS and END_CHARPOS
25110 (excluding END_CHARPOS). This is similar to row_containing_pos,
25111 but is more accurate when bidi reordering makes buffer positions
25112 change non-linearly with glyph rows. */
25114 rows_from_pos_range (struct window
*w
,
25115 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25116 struct glyph_row
**start
, struct glyph_row
**end
)
25118 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25119 int last_y
= window_text_bottom_y (w
);
25120 struct glyph_row
*row
;
25125 while (!first
->enabled_p
25126 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25129 /* Find the START row. */
25131 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25134 /* A row can potentially be the START row if the range of the
25135 characters it displays intersects the range
25136 [START_CHARPOS..END_CHARPOS). */
25137 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25138 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25139 /* See the commentary in row_containing_pos, for the
25140 explanation of the complicated way to check whether
25141 some position is beyond the end of the characters
25142 displayed by a row. */
25143 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25144 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25145 && !row
->ends_at_zv_p
25146 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25147 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25148 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25149 && !row
->ends_at_zv_p
25150 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25152 /* Found a candidate row. Now make sure at least one of the
25153 glyphs it displays has a charpos from the range
25154 [START_CHARPOS..END_CHARPOS).
25156 This is not obvious because bidi reordering could make
25157 buffer positions of a row be 1,2,3,102,101,100, and if we
25158 want to highlight characters in [50..60), we don't want
25159 this row, even though [50..60) does intersect [1..103),
25160 the range of character positions given by the row's start
25161 and end positions. */
25162 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25163 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25167 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25168 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25177 /* Find the END row. */
25179 /* If the last row is partially visible, start looking for END
25180 from that row, instead of starting from FIRST. */
25181 && !(row
->enabled_p
25182 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25184 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25186 struct glyph_row
*next
= row
+ 1;
25188 if (!next
->enabled_p
25189 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25190 /* The first row >= START whose range of displayed characters
25191 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25192 is the row END + 1. */
25193 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25194 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25195 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25196 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25197 && !next
->ends_at_zv_p
25198 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25199 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25200 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25201 && !next
->ends_at_zv_p
25202 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25209 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25210 but none of the characters it displays are in the range, it is
25212 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25213 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25217 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25218 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25231 /* This function sets the mouse_face_* elements of HLINFO, assuming
25232 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25233 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25234 for the overlay or run of text properties specifying the mouse
25235 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25236 before-string and after-string that must also be highlighted.
25237 COVER_STRING, if non-nil, is a display string that may cover some
25238 or all of the highlighted text. */
25241 mouse_face_from_buffer_pos (Lisp_Object window
,
25242 Mouse_HLInfo
*hlinfo
,
25243 EMACS_INT mouse_charpos
,
25244 EMACS_INT start_charpos
,
25245 EMACS_INT end_charpos
,
25246 Lisp_Object before_string
,
25247 Lisp_Object after_string
,
25248 Lisp_Object cover_string
)
25250 struct window
*w
= XWINDOW (window
);
25251 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25252 struct glyph_row
*r1
, *r2
;
25253 struct glyph
*glyph
, *end
;
25254 EMACS_INT ignore
, pos
;
25257 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25258 xassert (NILP (before_string
) || STRINGP (before_string
));
25259 xassert (NILP (after_string
) || STRINGP (after_string
));
25261 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25262 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25264 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25265 /* If the before-string or display-string contains newlines,
25266 rows_from_pos_range skips to its last row. Move back. */
25267 if (!NILP (before_string
) || !NILP (cover_string
))
25269 struct glyph_row
*prev
;
25270 while ((prev
= r1
- 1, prev
>= first
)
25271 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25272 && prev
->used
[TEXT_AREA
] > 0)
25274 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25275 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25276 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25278 || !(EQ (glyph
->object
, before_string
)
25279 || EQ (glyph
->object
, cover_string
)))
25286 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25287 hlinfo
->mouse_face_past_end
= 1;
25289 else if (!NILP (after_string
))
25291 /* If the after-string has newlines, advance to its last row. */
25292 struct glyph_row
*next
;
25293 struct glyph_row
*last
25294 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25296 for (next
= r2
+ 1;
25298 && next
->used
[TEXT_AREA
] > 0
25299 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25303 /* The rest of the display engine assumes that mouse_face_beg_row is
25304 either above below mouse_face_end_row or identical to it. But
25305 with bidi-reordered continued lines, the row for START_CHARPOS
25306 could be below the row for END_CHARPOS. If so, swap the rows and
25307 store them in correct order. */
25310 struct glyph_row
*tem
= r2
;
25316 hlinfo
->mouse_face_beg_y
= r1
->y
;
25317 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25318 hlinfo
->mouse_face_end_y
= r2
->y
;
25319 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25321 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25322 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25323 could be anywhere in the row and in any order. The strategy
25324 below is to find the leftmost and the rightmost glyph that
25325 belongs to either of these 3 strings, or whose position is
25326 between START_CHARPOS and END_CHARPOS, and highlight all the
25327 glyphs between those two. This may cover more than just the text
25328 between START_CHARPOS and END_CHARPOS if the range of characters
25329 strides the bidi level boundary, e.g. if the beginning is in R2L
25330 text while the end is in L2R text or vice versa. */
25331 if (!r1
->reversed_p
)
25333 /* This row is in a left to right paragraph. Scan it left to
25335 glyph
= r1
->glyphs
[TEXT_AREA
];
25336 end
= glyph
+ r1
->used
[TEXT_AREA
];
25339 /* Skip truncation glyphs at the start of the glyph row. */
25340 if (r1
->displays_text_p
)
25342 && INTEGERP (glyph
->object
)
25343 && glyph
->charpos
< 0;
25345 x
+= glyph
->pixel_width
;
25347 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25348 or COVER_STRING, and the first glyph from buffer whose
25349 position is between START_CHARPOS and END_CHARPOS. */
25351 && !INTEGERP (glyph
->object
)
25352 && !EQ (glyph
->object
, cover_string
)
25353 && !(BUFFERP (glyph
->object
)
25354 && (glyph
->charpos
>= start_charpos
25355 && glyph
->charpos
< end_charpos
));
25358 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25359 are present at buffer positions between START_CHARPOS and
25360 END_CHARPOS, or if they come from an overlay. */
25361 if (EQ (glyph
->object
, before_string
))
25363 pos
= string_buffer_position (before_string
,
25365 /* If pos == 0, it means before_string came from an
25366 overlay, not from a buffer position. */
25367 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25370 else if (EQ (glyph
->object
, after_string
))
25372 pos
= string_buffer_position (after_string
, end_charpos
);
25373 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25376 x
+= glyph
->pixel_width
;
25378 hlinfo
->mouse_face_beg_x
= x
;
25379 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25383 /* This row is in a right to left paragraph. Scan it right to
25387 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25388 glyph
= end
+ r1
->used
[TEXT_AREA
];
25390 /* Skip truncation glyphs at the start of the glyph row. */
25391 if (r1
->displays_text_p
)
25393 && INTEGERP (glyph
->object
)
25394 && glyph
->charpos
< 0;
25398 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25399 or COVER_STRING, and the first glyph from buffer whose
25400 position is between START_CHARPOS and END_CHARPOS. */
25402 && !INTEGERP (glyph
->object
)
25403 && !EQ (glyph
->object
, cover_string
)
25404 && !(BUFFERP (glyph
->object
)
25405 && (glyph
->charpos
>= start_charpos
25406 && glyph
->charpos
< end_charpos
));
25409 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25410 are present at buffer positions between START_CHARPOS and
25411 END_CHARPOS, or if they come from an overlay. */
25412 if (EQ (glyph
->object
, before_string
))
25414 pos
= string_buffer_position (before_string
, start_charpos
);
25415 /* If pos == 0, it means before_string came from an
25416 overlay, not from a buffer position. */
25417 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25420 else if (EQ (glyph
->object
, after_string
))
25422 pos
= string_buffer_position (after_string
, end_charpos
);
25423 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25428 glyph
++; /* first glyph to the right of the highlighted area */
25429 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25430 x
+= g
->pixel_width
;
25431 hlinfo
->mouse_face_beg_x
= x
;
25432 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25435 /* If the highlight ends in a different row, compute GLYPH and END
25436 for the end row. Otherwise, reuse the values computed above for
25437 the row where the highlight begins. */
25440 if (!r2
->reversed_p
)
25442 glyph
= r2
->glyphs
[TEXT_AREA
];
25443 end
= glyph
+ r2
->used
[TEXT_AREA
];
25448 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25449 glyph
= end
+ r2
->used
[TEXT_AREA
];
25453 if (!r2
->reversed_p
)
25455 /* Skip truncation and continuation glyphs near the end of the
25456 row, and also blanks and stretch glyphs inserted by
25457 extend_face_to_end_of_line. */
25459 && INTEGERP ((end
- 1)->object
)
25460 && (end
- 1)->charpos
<= 0)
25462 /* Scan the rest of the glyph row from the end, looking for the
25463 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25464 COVER_STRING, or whose position is between START_CHARPOS
25468 && !INTEGERP (end
->object
)
25469 && !EQ (end
->object
, cover_string
)
25470 && !(BUFFERP (end
->object
)
25471 && (end
->charpos
>= start_charpos
25472 && end
->charpos
< end_charpos
));
25475 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25476 are present at buffer positions between START_CHARPOS and
25477 END_CHARPOS, or if they come from an overlay. */
25478 if (EQ (end
->object
, before_string
))
25480 pos
= string_buffer_position (before_string
, start_charpos
);
25481 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25484 else if (EQ (end
->object
, after_string
))
25486 pos
= string_buffer_position (after_string
, end_charpos
);
25487 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25491 /* Find the X coordinate of the last glyph to be highlighted. */
25492 for (; glyph
<= end
; ++glyph
)
25493 x
+= glyph
->pixel_width
;
25495 hlinfo
->mouse_face_end_x
= x
;
25496 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25500 /* Skip truncation and continuation glyphs near the end of the
25501 row, and also blanks and stretch glyphs inserted by
25502 extend_face_to_end_of_line. */
25506 && INTEGERP (end
->object
)
25507 && end
->charpos
<= 0)
25509 x
+= end
->pixel_width
;
25512 /* Scan the rest of the glyph row from the end, looking for the
25513 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25514 COVER_STRING, or whose position is between START_CHARPOS
25518 && !INTEGERP (end
->object
)
25519 && !EQ (end
->object
, cover_string
)
25520 && !(BUFFERP (end
->object
)
25521 && (end
->charpos
>= start_charpos
25522 && end
->charpos
< end_charpos
));
25525 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25526 are present at buffer positions between START_CHARPOS and
25527 END_CHARPOS, or if they come from an overlay. */
25528 if (EQ (end
->object
, before_string
))
25530 pos
= string_buffer_position (before_string
, start_charpos
);
25531 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25534 else if (EQ (end
->object
, after_string
))
25536 pos
= string_buffer_position (after_string
, end_charpos
);
25537 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25540 x
+= end
->pixel_width
;
25542 hlinfo
->mouse_face_end_x
= x
;
25543 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25546 hlinfo
->mouse_face_window
= window
;
25547 hlinfo
->mouse_face_face_id
25548 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25550 !hlinfo
->mouse_face_hidden
, -1);
25551 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25554 /* The following function is not used anymore (replaced with
25555 mouse_face_from_string_pos), but I leave it here for the time
25556 being, in case someone would. */
25558 #if 0 /* not used */
25560 /* Find the position of the glyph for position POS in OBJECT in
25561 window W's current matrix, and return in *X, *Y the pixel
25562 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25564 RIGHT_P non-zero means return the position of the right edge of the
25565 glyph, RIGHT_P zero means return the left edge position.
25567 If no glyph for POS exists in the matrix, return the position of
25568 the glyph with the next smaller position that is in the matrix, if
25569 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25570 exists in the matrix, return the position of the glyph with the
25571 next larger position in OBJECT.
25573 Value is non-zero if a glyph was found. */
25576 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25577 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25579 int yb
= window_text_bottom_y (w
);
25580 struct glyph_row
*r
;
25581 struct glyph
*best_glyph
= NULL
;
25582 struct glyph_row
*best_row
= NULL
;
25585 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25586 r
->enabled_p
&& r
->y
< yb
;
25589 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25590 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25593 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25594 if (EQ (g
->object
, object
))
25596 if (g
->charpos
== pos
)
25603 else if (best_glyph
== NULL
25604 || ((eabs (g
->charpos
- pos
)
25605 < eabs (best_glyph
->charpos
- pos
))
25608 : g
->charpos
> pos
)))
25622 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25626 *x
+= best_glyph
->pixel_width
;
25631 *vpos
= best_row
- w
->current_matrix
->rows
;
25634 return best_glyph
!= NULL
;
25636 #endif /* not used */
25638 /* Find the positions of the first and the last glyphs in window W's
25639 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25640 (assumed to be a string), and return in HLINFO's mouse_face_*
25641 members the pixel and column/row coordinates of those glyphs. */
25644 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25645 Lisp_Object object
,
25646 EMACS_INT startpos
, EMACS_INT endpos
)
25648 int yb
= window_text_bottom_y (w
);
25649 struct glyph_row
*r
;
25650 struct glyph
*g
, *e
;
25654 /* Find the glyph row with at least one position in the range
25655 [STARTPOS..ENDPOS], and the first glyph in that row whose
25656 position belongs to that range. */
25657 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25658 r
->enabled_p
&& r
->y
< yb
;
25661 if (!r
->reversed_p
)
25663 g
= r
->glyphs
[TEXT_AREA
];
25664 e
= g
+ r
->used
[TEXT_AREA
];
25665 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25666 if (EQ (g
->object
, object
)
25667 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25669 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25670 hlinfo
->mouse_face_beg_y
= r
->y
;
25671 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25672 hlinfo
->mouse_face_beg_x
= gx
;
25681 e
= r
->glyphs
[TEXT_AREA
];
25682 g
= e
+ r
->used
[TEXT_AREA
];
25683 for ( ; g
> e
; --g
)
25684 if (EQ ((g
-1)->object
, object
)
25685 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25687 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25688 hlinfo
->mouse_face_beg_y
= r
->y
;
25689 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25690 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25691 gx
+= g1
->pixel_width
;
25692 hlinfo
->mouse_face_beg_x
= gx
;
25704 /* Starting with the next row, look for the first row which does NOT
25705 include any glyphs whose positions are in the range. */
25706 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25708 g
= r
->glyphs
[TEXT_AREA
];
25709 e
= g
+ r
->used
[TEXT_AREA
];
25711 for ( ; g
< e
; ++g
)
25712 if (EQ (g
->object
, object
)
25713 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25722 /* The highlighted region ends on the previous row. */
25725 /* Set the end row and its vertical pixel coordinate. */
25726 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25727 hlinfo
->mouse_face_end_y
= r
->y
;
25729 /* Compute and set the end column and the end column's horizontal
25730 pixel coordinate. */
25731 if (!r
->reversed_p
)
25733 g
= r
->glyphs
[TEXT_AREA
];
25734 e
= g
+ r
->used
[TEXT_AREA
];
25735 for ( ; e
> g
; --e
)
25736 if (EQ ((e
-1)->object
, object
)
25737 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25739 hlinfo
->mouse_face_end_col
= e
- g
;
25741 for (gx
= r
->x
; g
< e
; ++g
)
25742 gx
+= g
->pixel_width
;
25743 hlinfo
->mouse_face_end_x
= gx
;
25747 e
= r
->glyphs
[TEXT_AREA
];
25748 g
= e
+ r
->used
[TEXT_AREA
];
25749 for (gx
= r
->x
; e
< g
; ++e
)
25751 if (EQ (e
->object
, object
)
25752 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25754 gx
+= e
->pixel_width
;
25756 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25757 hlinfo
->mouse_face_end_x
= gx
;
25761 #ifdef HAVE_WINDOW_SYSTEM
25763 /* See if position X, Y is within a hot-spot of an image. */
25766 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25768 if (!CONSP (hot_spot
))
25771 if (EQ (XCAR (hot_spot
), Qrect
))
25773 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25774 Lisp_Object rect
= XCDR (hot_spot
);
25778 if (!CONSP (XCAR (rect
)))
25780 if (!CONSP (XCDR (rect
)))
25782 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25784 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25786 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25788 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25792 else if (EQ (XCAR (hot_spot
), Qcircle
))
25794 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25795 Lisp_Object circ
= XCDR (hot_spot
);
25796 Lisp_Object lr
, lx0
, ly0
;
25798 && CONSP (XCAR (circ
))
25799 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25800 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25801 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25803 double r
= XFLOATINT (lr
);
25804 double dx
= XINT (lx0
) - x
;
25805 double dy
= XINT (ly0
) - y
;
25806 return (dx
* dx
+ dy
* dy
<= r
* r
);
25809 else if (EQ (XCAR (hot_spot
), Qpoly
))
25811 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25812 if (VECTORP (XCDR (hot_spot
)))
25814 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25815 Lisp_Object
*poly
= v
->contents
;
25816 int n
= v
->header
.size
;
25819 Lisp_Object lx
, ly
;
25822 /* Need an even number of coordinates, and at least 3 edges. */
25823 if (n
< 6 || n
& 1)
25826 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25827 If count is odd, we are inside polygon. Pixels on edges
25828 may or may not be included depending on actual geometry of the
25830 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25831 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25833 x0
= XINT (lx
), y0
= XINT (ly
);
25834 for (i
= 0; i
< n
; i
+= 2)
25836 int x1
= x0
, y1
= y0
;
25837 if ((lx
= poly
[i
], !INTEGERP (lx
))
25838 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25840 x0
= XINT (lx
), y0
= XINT (ly
);
25842 /* Does this segment cross the X line? */
25850 if (y
> y0
&& y
> y1
)
25852 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25862 find_hot_spot (Lisp_Object map
, int x
, int y
)
25864 while (CONSP (map
))
25866 if (CONSP (XCAR (map
))
25867 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25875 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25877 doc
: /* Lookup in image map MAP coordinates X and Y.
25878 An image map is an alist where each element has the format (AREA ID PLIST).
25879 An AREA is specified as either a rectangle, a circle, or a polygon:
25880 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25881 pixel coordinates of the upper left and bottom right corners.
25882 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25883 and the radius of the circle; r may be a float or integer.
25884 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25885 vector describes one corner in the polygon.
25886 Returns the alist element for the first matching AREA in MAP. */)
25887 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25895 return find_hot_spot (map
, XINT (x
), XINT (y
));
25899 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25901 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25903 /* Do not change cursor shape while dragging mouse. */
25904 if (!NILP (do_mouse_tracking
))
25907 if (!NILP (pointer
))
25909 if (EQ (pointer
, Qarrow
))
25910 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25911 else if (EQ (pointer
, Qhand
))
25912 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25913 else if (EQ (pointer
, Qtext
))
25914 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25915 else if (EQ (pointer
, intern ("hdrag")))
25916 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25917 #ifdef HAVE_X_WINDOWS
25918 else if (EQ (pointer
, intern ("vdrag")))
25919 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25921 else if (EQ (pointer
, intern ("hourglass")))
25922 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25923 else if (EQ (pointer
, Qmodeline
))
25924 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25926 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25929 if (cursor
!= No_Cursor
)
25930 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25933 #endif /* HAVE_WINDOW_SYSTEM */
25935 /* Take proper action when mouse has moved to the mode or header line
25936 or marginal area AREA of window W, x-position X and y-position Y.
25937 X is relative to the start of the text display area of W, so the
25938 width of bitmap areas and scroll bars must be subtracted to get a
25939 position relative to the start of the mode line. */
25942 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
25943 enum window_part area
)
25945 struct window
*w
= XWINDOW (window
);
25946 struct frame
*f
= XFRAME (w
->frame
);
25947 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25948 #ifdef HAVE_WINDOW_SYSTEM
25949 Display_Info
*dpyinfo
;
25951 Cursor cursor
= No_Cursor
;
25952 Lisp_Object pointer
= Qnil
;
25953 int dx
, dy
, width
, height
;
25955 Lisp_Object string
, object
= Qnil
;
25956 Lisp_Object pos
, help
;
25958 Lisp_Object mouse_face
;
25959 int original_x_pixel
= x
;
25960 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
25961 struct glyph_row
*row
;
25963 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
25968 /* Kludge alert: mode_line_string takes X/Y in pixels, but
25969 returns them in row/column units! */
25970 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
25971 &object
, &dx
, &dy
, &width
, &height
);
25973 row
= (area
== ON_MODE_LINE
25974 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
25975 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
25977 /* Find the glyph under the mouse pointer. */
25978 if (row
->mode_line_p
&& row
->enabled_p
)
25980 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
25981 end
= glyph
+ row
->used
[TEXT_AREA
];
25983 for (x0
= original_x_pixel
;
25984 glyph
< end
&& x0
>= glyph
->pixel_width
;
25986 x0
-= glyph
->pixel_width
;
25994 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
25995 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
25996 returns them in row/column units! */
25997 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
25998 &object
, &dx
, &dy
, &width
, &height
);
26003 #ifdef HAVE_WINDOW_SYSTEM
26004 if (IMAGEP (object
))
26006 Lisp_Object image_map
, hotspot
;
26007 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26009 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26011 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26015 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26016 If so, we could look for mouse-enter, mouse-leave
26017 properties in PLIST (and do something...). */
26018 hotspot
= XCDR (hotspot
);
26019 if (CONSP (hotspot
)
26020 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26022 pointer
= Fplist_get (plist
, Qpointer
);
26023 if (NILP (pointer
))
26025 help
= Fplist_get (plist
, Qhelp_echo
);
26028 help_echo_string
= help
;
26029 /* Is this correct? ++kfs */
26030 XSETWINDOW (help_echo_window
, w
);
26031 help_echo_object
= w
->buffer
;
26032 help_echo_pos
= charpos
;
26036 if (NILP (pointer
))
26037 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26039 #endif /* HAVE_WINDOW_SYSTEM */
26041 if (STRINGP (string
))
26043 pos
= make_number (charpos
);
26044 /* If we're on a string with `help-echo' text property, arrange
26045 for the help to be displayed. This is done by setting the
26046 global variable help_echo_string to the help string. */
26049 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26052 help_echo_string
= help
;
26053 XSETWINDOW (help_echo_window
, w
);
26054 help_echo_object
= string
;
26055 help_echo_pos
= charpos
;
26059 #ifdef HAVE_WINDOW_SYSTEM
26060 if (FRAME_WINDOW_P (f
))
26062 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26063 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26064 if (NILP (pointer
))
26065 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26067 /* Change the mouse pointer according to what is under X/Y. */
26069 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26072 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26073 if (!KEYMAPP (map
))
26074 map
= Fget_text_property (pos
, Qkeymap
, string
);
26075 if (!KEYMAPP (map
))
26076 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26081 /* Change the mouse face according to what is under X/Y. */
26082 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26083 if (!NILP (mouse_face
)
26084 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26089 struct glyph
* tmp_glyph
;
26093 int total_pixel_width
;
26094 EMACS_INT begpos
, endpos
, ignore
;
26098 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26099 Qmouse_face
, string
, Qnil
);
26105 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26107 endpos
= SCHARS (string
);
26111 /* Calculate the glyph position GPOS of GLYPH in the
26112 displayed string, relative to the beginning of the
26113 highlighted part of the string.
26115 Note: GPOS is different from CHARPOS. CHARPOS is the
26116 position of GLYPH in the internal string object. A mode
26117 line string format has structures which are converted to
26118 a flattened string by the Emacs Lisp interpreter. The
26119 internal string is an element of those structures. The
26120 displayed string is the flattened string. */
26121 tmp_glyph
= row_start_glyph
;
26122 while (tmp_glyph
< glyph
26123 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26124 && begpos
<= tmp_glyph
->charpos
26125 && tmp_glyph
->charpos
< endpos
)))
26127 gpos
= glyph
- tmp_glyph
;
26129 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26130 the highlighted part of the displayed string to which
26131 GLYPH belongs. Note: GSEQ_LENGTH is different from
26132 SCHARS (STRING), because the latter returns the length of
26133 the internal string. */
26134 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26136 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26137 && begpos
<= tmp_glyph
->charpos
26138 && tmp_glyph
->charpos
< endpos
));
26141 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26143 /* Calculate the total pixel width of all the glyphs between
26144 the beginning of the highlighted area and GLYPH. */
26145 total_pixel_width
= 0;
26146 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26147 total_pixel_width
+= tmp_glyph
->pixel_width
;
26149 /* Pre calculation of re-rendering position. Note: X is in
26150 column units here, after the call to mode_line_string or
26151 marginal_area_string. */
26153 vpos
= (area
== ON_MODE_LINE
26154 ? (w
->current_matrix
)->nrows
- 1
26157 /* If GLYPH's position is included in the region that is
26158 already drawn in mouse face, we have nothing to do. */
26159 if ( EQ (window
, hlinfo
->mouse_face_window
)
26160 && (!row
->reversed_p
26161 ? (hlinfo
->mouse_face_beg_col
<= hpos
26162 && hpos
< hlinfo
->mouse_face_end_col
)
26163 /* In R2L rows we swap BEG and END, see below. */
26164 : (hlinfo
->mouse_face_end_col
<= hpos
26165 && hpos
< hlinfo
->mouse_face_beg_col
))
26166 && hlinfo
->mouse_face_beg_row
== vpos
)
26169 if (clear_mouse_face (hlinfo
))
26170 cursor
= No_Cursor
;
26172 if (!row
->reversed_p
)
26174 hlinfo
->mouse_face_beg_col
= hpos
;
26175 hlinfo
->mouse_face_beg_x
= original_x_pixel
26176 - (total_pixel_width
+ dx
);
26177 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26178 hlinfo
->mouse_face_end_x
= 0;
26182 /* In R2L rows, show_mouse_face expects BEG and END
26183 coordinates to be swapped. */
26184 hlinfo
->mouse_face_end_col
= hpos
;
26185 hlinfo
->mouse_face_end_x
= original_x_pixel
26186 - (total_pixel_width
+ dx
);
26187 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26188 hlinfo
->mouse_face_beg_x
= 0;
26191 hlinfo
->mouse_face_beg_row
= vpos
;
26192 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26193 hlinfo
->mouse_face_beg_y
= 0;
26194 hlinfo
->mouse_face_end_y
= 0;
26195 hlinfo
->mouse_face_past_end
= 0;
26196 hlinfo
->mouse_face_window
= window
;
26198 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26204 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26206 if (NILP (pointer
))
26209 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26210 clear_mouse_face (hlinfo
);
26212 #ifdef HAVE_WINDOW_SYSTEM
26213 if (FRAME_WINDOW_P (f
))
26214 define_frame_cursor1 (f
, cursor
, pointer
);
26220 Take proper action when the mouse has moved to position X, Y on
26221 frame F as regards highlighting characters that have mouse-face
26222 properties. Also de-highlighting chars where the mouse was before.
26223 X and Y can be negative or out of range. */
26226 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26228 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26229 enum window_part part
;
26230 Lisp_Object window
;
26232 Cursor cursor
= No_Cursor
;
26233 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26236 /* When a menu is active, don't highlight because this looks odd. */
26237 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26238 if (popup_activated ())
26242 if (NILP (Vmouse_highlight
)
26243 || !f
->glyphs_initialized_p
26244 || f
->pointer_invisible
)
26247 hlinfo
->mouse_face_mouse_x
= x
;
26248 hlinfo
->mouse_face_mouse_y
= y
;
26249 hlinfo
->mouse_face_mouse_frame
= f
;
26251 if (hlinfo
->mouse_face_defer
)
26254 if (gc_in_progress
)
26256 hlinfo
->mouse_face_deferred_gc
= 1;
26260 /* Which window is that in? */
26261 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26263 /* If we were displaying active text in another window, clear that.
26264 Also clear if we move out of text area in same window. */
26265 if (! EQ (window
, hlinfo
->mouse_face_window
)
26266 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26267 && !NILP (hlinfo
->mouse_face_window
)))
26268 clear_mouse_face (hlinfo
);
26270 /* Not on a window -> return. */
26271 if (!WINDOWP (window
))
26274 /* Reset help_echo_string. It will get recomputed below. */
26275 help_echo_string
= Qnil
;
26277 /* Convert to window-relative pixel coordinates. */
26278 w
= XWINDOW (window
);
26279 frame_to_window_pixel_xy (w
, &x
, &y
);
26281 #ifdef HAVE_WINDOW_SYSTEM
26282 /* Handle tool-bar window differently since it doesn't display a
26284 if (EQ (window
, f
->tool_bar_window
))
26286 note_tool_bar_highlight (f
, x
, y
);
26291 /* Mouse is on the mode, header line or margin? */
26292 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26293 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26295 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26299 #ifdef HAVE_WINDOW_SYSTEM
26300 if (part
== ON_VERTICAL_BORDER
)
26302 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26303 help_echo_string
= build_string ("drag-mouse-1: resize");
26305 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26306 || part
== ON_SCROLL_BAR
)
26307 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26309 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26312 /* Are we in a window whose display is up to date?
26313 And verify the buffer's text has not changed. */
26314 b
= XBUFFER (w
->buffer
);
26315 if (part
== ON_TEXT
26316 && EQ (w
->window_end_valid
, w
->buffer
)
26317 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26318 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26320 int hpos
, vpos
, dx
, dy
, area
;
26322 struct glyph
*glyph
;
26323 Lisp_Object object
;
26324 Lisp_Object mouse_face
= Qnil
, position
;
26325 Lisp_Object
*overlay_vec
= NULL
;
26326 ptrdiff_t i
, noverlays
;
26327 struct buffer
*obuf
;
26328 EMACS_INT obegv
, ozv
;
26331 /* Find the glyph under X/Y. */
26332 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26334 #ifdef HAVE_WINDOW_SYSTEM
26335 /* Look for :pointer property on image. */
26336 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26338 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26339 if (img
!= NULL
&& IMAGEP (img
->spec
))
26341 Lisp_Object image_map
, hotspot
;
26342 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26344 && (hotspot
= find_hot_spot (image_map
,
26345 glyph
->slice
.img
.x
+ dx
,
26346 glyph
->slice
.img
.y
+ dy
),
26348 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26352 /* Could check XCAR (hotspot) to see if we enter/leave
26354 If so, we could look for mouse-enter, mouse-leave
26355 properties in PLIST (and do something...). */
26356 hotspot
= XCDR (hotspot
);
26357 if (CONSP (hotspot
)
26358 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26360 pointer
= Fplist_get (plist
, Qpointer
);
26361 if (NILP (pointer
))
26363 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26364 if (!NILP (help_echo_string
))
26366 help_echo_window
= window
;
26367 help_echo_object
= glyph
->object
;
26368 help_echo_pos
= glyph
->charpos
;
26372 if (NILP (pointer
))
26373 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26376 #endif /* HAVE_WINDOW_SYSTEM */
26378 /* Clear mouse face if X/Y not over text. */
26380 || area
!= TEXT_AREA
26381 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26382 /* Glyph's OBJECT is an integer for glyphs inserted by the
26383 display engine for its internal purposes, like truncation
26384 and continuation glyphs and blanks beyond the end of
26385 line's text on text terminals. If we are over such a
26386 glyph, we are not over any text. */
26387 || INTEGERP (glyph
->object
)
26388 /* R2L rows have a stretch glyph at their front, which
26389 stands for no text, whereas L2R rows have no glyphs at
26390 all beyond the end of text. Treat such stretch glyphs
26391 like we do with NULL glyphs in L2R rows. */
26392 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26393 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26394 && glyph
->type
== STRETCH_GLYPH
26395 && glyph
->avoid_cursor_p
))
26397 if (clear_mouse_face (hlinfo
))
26398 cursor
= No_Cursor
;
26399 #ifdef HAVE_WINDOW_SYSTEM
26400 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26402 if (area
!= TEXT_AREA
)
26403 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26405 pointer
= Vvoid_text_area_pointer
;
26411 pos
= glyph
->charpos
;
26412 object
= glyph
->object
;
26413 if (!STRINGP (object
) && !BUFFERP (object
))
26416 /* If we get an out-of-range value, return now; avoid an error. */
26417 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26420 /* Make the window's buffer temporarily current for
26421 overlays_at and compute_char_face. */
26422 obuf
= current_buffer
;
26423 current_buffer
= b
;
26429 /* Is this char mouse-active or does it have help-echo? */
26430 position
= make_number (pos
);
26432 if (BUFFERP (object
))
26434 /* Put all the overlays we want in a vector in overlay_vec. */
26435 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26436 /* Sort overlays into increasing priority order. */
26437 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26442 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26445 cursor
= No_Cursor
;
26447 /* Check mouse-face highlighting. */
26449 /* If there exists an overlay with mouse-face overlapping
26450 the one we are currently highlighting, we have to
26451 check if we enter the overlapping overlay, and then
26452 highlight only that. */
26453 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26454 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26456 /* Find the highest priority overlay with a mouse-face. */
26457 Lisp_Object overlay
= Qnil
;
26458 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26460 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26461 if (!NILP (mouse_face
))
26462 overlay
= overlay_vec
[i
];
26465 /* If we're highlighting the same overlay as before, there's
26466 no need to do that again. */
26467 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26468 goto check_help_echo
;
26469 hlinfo
->mouse_face_overlay
= overlay
;
26471 /* Clear the display of the old active region, if any. */
26472 if (clear_mouse_face (hlinfo
))
26473 cursor
= No_Cursor
;
26475 /* If no overlay applies, get a text property. */
26476 if (NILP (overlay
))
26477 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26479 /* Next, compute the bounds of the mouse highlighting and
26481 if (!NILP (mouse_face
) && STRINGP (object
))
26483 /* The mouse-highlighting comes from a display string
26484 with a mouse-face. */
26488 s
= Fprevious_single_property_change
26489 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26490 e
= Fnext_single_property_change
26491 (position
, Qmouse_face
, object
, Qnil
);
26493 s
= make_number (0);
26495 e
= make_number (SCHARS (object
) - 1);
26496 mouse_face_from_string_pos (w
, hlinfo
, object
,
26497 XINT (s
), XINT (e
));
26498 hlinfo
->mouse_face_past_end
= 0;
26499 hlinfo
->mouse_face_window
= window
;
26500 hlinfo
->mouse_face_face_id
26501 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26502 glyph
->face_id
, 1);
26503 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26504 cursor
= No_Cursor
;
26508 /* The mouse-highlighting, if any, comes from an overlay
26509 or text property in the buffer. */
26510 Lisp_Object buffer
IF_LINT (= Qnil
);
26511 Lisp_Object cover_string
IF_LINT (= Qnil
);
26513 if (STRINGP (object
))
26515 /* If we are on a display string with no mouse-face,
26516 check if the text under it has one. */
26517 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26518 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26519 pos
= string_buffer_position (object
, start
);
26522 mouse_face
= get_char_property_and_overlay
26523 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26524 buffer
= w
->buffer
;
26525 cover_string
= object
;
26531 cover_string
= Qnil
;
26534 if (!NILP (mouse_face
))
26536 Lisp_Object before
, after
;
26537 Lisp_Object before_string
, after_string
;
26538 /* To correctly find the limits of mouse highlight
26539 in a bidi-reordered buffer, we must not use the
26540 optimization of limiting the search in
26541 previous-single-property-change and
26542 next-single-property-change, because
26543 rows_from_pos_range needs the real start and end
26544 positions to DTRT in this case. That's because
26545 the first row visible in a window does not
26546 necessarily display the character whose position
26547 is the smallest. */
26549 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26550 ? Fmarker_position (w
->start
)
26553 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26554 ? make_number (BUF_Z (XBUFFER (buffer
))
26555 - XFASTINT (w
->window_end_pos
))
26558 if (NILP (overlay
))
26560 /* Handle the text property case. */
26561 before
= Fprevious_single_property_change
26562 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26563 after
= Fnext_single_property_change
26564 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26565 before_string
= after_string
= Qnil
;
26569 /* Handle the overlay case. */
26570 before
= Foverlay_start (overlay
);
26571 after
= Foverlay_end (overlay
);
26572 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26573 after_string
= Foverlay_get (overlay
, Qafter_string
);
26575 if (!STRINGP (before_string
)) before_string
= Qnil
;
26576 if (!STRINGP (after_string
)) after_string
= Qnil
;
26579 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26582 before_string
, after_string
,
26584 cursor
= No_Cursor
;
26591 /* Look for a `help-echo' property. */
26592 if (NILP (help_echo_string
)) {
26593 Lisp_Object help
, overlay
;
26595 /* Check overlays first. */
26596 help
= overlay
= Qnil
;
26597 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26599 overlay
= overlay_vec
[i
];
26600 help
= Foverlay_get (overlay
, Qhelp_echo
);
26605 help_echo_string
= help
;
26606 help_echo_window
= window
;
26607 help_echo_object
= overlay
;
26608 help_echo_pos
= pos
;
26612 Lisp_Object obj
= glyph
->object
;
26613 EMACS_INT charpos
= glyph
->charpos
;
26615 /* Try text properties. */
26618 && charpos
< SCHARS (obj
))
26620 help
= Fget_text_property (make_number (charpos
),
26624 /* If the string itself doesn't specify a help-echo,
26625 see if the buffer text ``under'' it does. */
26626 struct glyph_row
*r
26627 = MATRIX_ROW (w
->current_matrix
, vpos
);
26628 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26629 EMACS_INT p
= string_buffer_position (obj
, start
);
26632 help
= Fget_char_property (make_number (p
),
26633 Qhelp_echo
, w
->buffer
);
26642 else if (BUFFERP (obj
)
26645 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26650 help_echo_string
= help
;
26651 help_echo_window
= window
;
26652 help_echo_object
= obj
;
26653 help_echo_pos
= charpos
;
26658 #ifdef HAVE_WINDOW_SYSTEM
26659 /* Look for a `pointer' property. */
26660 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26662 /* Check overlays first. */
26663 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26664 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26666 if (NILP (pointer
))
26668 Lisp_Object obj
= glyph
->object
;
26669 EMACS_INT charpos
= glyph
->charpos
;
26671 /* Try text properties. */
26674 && charpos
< SCHARS (obj
))
26676 pointer
= Fget_text_property (make_number (charpos
),
26678 if (NILP (pointer
))
26680 /* If the string itself doesn't specify a pointer,
26681 see if the buffer text ``under'' it does. */
26682 struct glyph_row
*r
26683 = MATRIX_ROW (w
->current_matrix
, vpos
);
26684 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26685 EMACS_INT p
= string_buffer_position (obj
, start
);
26687 pointer
= Fget_char_property (make_number (p
),
26688 Qpointer
, w
->buffer
);
26691 else if (BUFFERP (obj
)
26694 pointer
= Fget_text_property (make_number (charpos
),
26698 #endif /* HAVE_WINDOW_SYSTEM */
26702 current_buffer
= obuf
;
26707 #ifdef HAVE_WINDOW_SYSTEM
26708 if (FRAME_WINDOW_P (f
))
26709 define_frame_cursor1 (f
, cursor
, pointer
);
26711 /* This is here to prevent a compiler error, about "label at end of
26712 compound statement". */
26719 Clear any mouse-face on window W. This function is part of the
26720 redisplay interface, and is called from try_window_id and similar
26721 functions to ensure the mouse-highlight is off. */
26724 x_clear_window_mouse_face (struct window
*w
)
26726 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26727 Lisp_Object window
;
26730 XSETWINDOW (window
, w
);
26731 if (EQ (window
, hlinfo
->mouse_face_window
))
26732 clear_mouse_face (hlinfo
);
26738 Just discard the mouse face information for frame F, if any.
26739 This is used when the size of F is changed. */
26742 cancel_mouse_face (struct frame
*f
)
26744 Lisp_Object window
;
26745 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26747 window
= hlinfo
->mouse_face_window
;
26748 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26750 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26751 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26752 hlinfo
->mouse_face_window
= Qnil
;
26758 /***********************************************************************
26760 ***********************************************************************/
26762 #ifdef HAVE_WINDOW_SYSTEM
26764 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26765 which intersects rectangle R. R is in window-relative coordinates. */
26768 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26769 enum glyph_row_area area
)
26771 struct glyph
*first
= row
->glyphs
[area
];
26772 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26773 struct glyph
*last
;
26774 int first_x
, start_x
, x
;
26776 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26777 /* If row extends face to end of line write the whole line. */
26778 draw_glyphs (w
, 0, row
, area
,
26779 0, row
->used
[area
],
26780 DRAW_NORMAL_TEXT
, 0);
26783 /* Set START_X to the window-relative start position for drawing glyphs of
26784 AREA. The first glyph of the text area can be partially visible.
26785 The first glyphs of other areas cannot. */
26786 start_x
= window_box_left_offset (w
, area
);
26788 if (area
== TEXT_AREA
)
26791 /* Find the first glyph that must be redrawn. */
26793 && x
+ first
->pixel_width
< r
->x
)
26795 x
+= first
->pixel_width
;
26799 /* Find the last one. */
26803 && x
< r
->x
+ r
->width
)
26805 x
+= last
->pixel_width
;
26811 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26812 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26813 DRAW_NORMAL_TEXT
, 0);
26818 /* Redraw the parts of the glyph row ROW on window W intersecting
26819 rectangle R. R is in window-relative coordinates. Value is
26820 non-zero if mouse-face was overwritten. */
26823 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26825 xassert (row
->enabled_p
);
26827 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26828 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26829 0, row
->used
[TEXT_AREA
],
26830 DRAW_NORMAL_TEXT
, 0);
26833 if (row
->used
[LEFT_MARGIN_AREA
])
26834 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26835 if (row
->used
[TEXT_AREA
])
26836 expose_area (w
, row
, r
, TEXT_AREA
);
26837 if (row
->used
[RIGHT_MARGIN_AREA
])
26838 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26839 draw_row_fringe_bitmaps (w
, row
);
26842 return row
->mouse_face_p
;
26846 /* Redraw those parts of glyphs rows during expose event handling that
26847 overlap other rows. Redrawing of an exposed line writes over parts
26848 of lines overlapping that exposed line; this function fixes that.
26850 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26851 row in W's current matrix that is exposed and overlaps other rows.
26852 LAST_OVERLAPPING_ROW is the last such row. */
26855 expose_overlaps (struct window
*w
,
26856 struct glyph_row
*first_overlapping_row
,
26857 struct glyph_row
*last_overlapping_row
,
26860 struct glyph_row
*row
;
26862 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26863 if (row
->overlapping_p
)
26865 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26868 if (row
->used
[LEFT_MARGIN_AREA
])
26869 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26871 if (row
->used
[TEXT_AREA
])
26872 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26874 if (row
->used
[RIGHT_MARGIN_AREA
])
26875 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26881 /* Return non-zero if W's cursor intersects rectangle R. */
26884 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26886 XRectangle cr
, result
;
26887 struct glyph
*cursor_glyph
;
26888 struct glyph_row
*row
;
26890 if (w
->phys_cursor
.vpos
>= 0
26891 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26892 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26894 && row
->cursor_in_fringe_p
)
26896 /* Cursor is in the fringe. */
26897 cr
.x
= window_box_right_offset (w
,
26898 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26899 ? RIGHT_MARGIN_AREA
26902 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26903 cr
.height
= row
->height
;
26904 return x_intersect_rectangles (&cr
, r
, &result
);
26907 cursor_glyph
= get_phys_cursor_glyph (w
);
26910 /* r is relative to W's box, but w->phys_cursor.x is relative
26911 to left edge of W's TEXT area. Adjust it. */
26912 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26913 cr
.y
= w
->phys_cursor
.y
;
26914 cr
.width
= cursor_glyph
->pixel_width
;
26915 cr
.height
= w
->phys_cursor_height
;
26916 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26917 I assume the effect is the same -- and this is portable. */
26918 return x_intersect_rectangles (&cr
, r
, &result
);
26920 /* If we don't understand the format, pretend we're not in the hot-spot. */
26926 Draw a vertical window border to the right of window W if W doesn't
26927 have vertical scroll bars. */
26930 x_draw_vertical_border (struct window
*w
)
26932 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26934 /* We could do better, if we knew what type of scroll-bar the adjacent
26935 windows (on either side) have... But we don't :-(
26936 However, I think this works ok. ++KFS 2003-04-25 */
26938 /* Redraw borders between horizontally adjacent windows. Don't
26939 do it for frames with vertical scroll bars because either the
26940 right scroll bar of a window, or the left scroll bar of its
26941 neighbor will suffice as a border. */
26942 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
26945 if (!WINDOW_RIGHTMOST_P (w
)
26946 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
26948 int x0
, x1
, y0
, y1
;
26950 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26953 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26956 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
26958 else if (!WINDOW_LEFTMOST_P (w
)
26959 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
26961 int x0
, x1
, y0
, y1
;
26963 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
26966 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
26969 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
26974 /* Redraw the part of window W intersection rectangle FR. Pixel
26975 coordinates in FR are frame-relative. Call this function with
26976 input blocked. Value is non-zero if the exposure overwrites
26980 expose_window (struct window
*w
, XRectangle
*fr
)
26982 struct frame
*f
= XFRAME (w
->frame
);
26984 int mouse_face_overwritten_p
= 0;
26986 /* If window is not yet fully initialized, do nothing. This can
26987 happen when toolkit scroll bars are used and a window is split.
26988 Reconfiguring the scroll bar will generate an expose for a newly
26990 if (w
->current_matrix
== NULL
)
26993 /* When we're currently updating the window, display and current
26994 matrix usually don't agree. Arrange for a thorough display
26996 if (w
== updated_window
)
26998 SET_FRAME_GARBAGED (f
);
27002 /* Frame-relative pixel rectangle of W. */
27003 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27004 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27005 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27006 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27008 if (x_intersect_rectangles (fr
, &wr
, &r
))
27010 int yb
= window_text_bottom_y (w
);
27011 struct glyph_row
*row
;
27012 int cursor_cleared_p
;
27013 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27015 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27016 r
.x
, r
.y
, r
.width
, r
.height
));
27018 /* Convert to window coordinates. */
27019 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27020 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27022 /* Turn off the cursor. */
27023 if (!w
->pseudo_window_p
27024 && phys_cursor_in_rect_p (w
, &r
))
27026 x_clear_cursor (w
);
27027 cursor_cleared_p
= 1;
27030 cursor_cleared_p
= 0;
27032 /* Update lines intersecting rectangle R. */
27033 first_overlapping_row
= last_overlapping_row
= NULL
;
27034 for (row
= w
->current_matrix
->rows
;
27039 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27041 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27042 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27043 || (r
.y
>= y0
&& r
.y
< y1
)
27044 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27046 /* A header line may be overlapping, but there is no need
27047 to fix overlapping areas for them. KFS 2005-02-12 */
27048 if (row
->overlapping_p
&& !row
->mode_line_p
)
27050 if (first_overlapping_row
== NULL
)
27051 first_overlapping_row
= row
;
27052 last_overlapping_row
= row
;
27056 if (expose_line (w
, row
, &r
))
27057 mouse_face_overwritten_p
= 1;
27060 else if (row
->overlapping_p
)
27062 /* We must redraw a row overlapping the exposed area. */
27064 ? y0
+ row
->phys_height
> r
.y
27065 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27067 if (first_overlapping_row
== NULL
)
27068 first_overlapping_row
= row
;
27069 last_overlapping_row
= row
;
27077 /* Display the mode line if there is one. */
27078 if (WINDOW_WANTS_MODELINE_P (w
)
27079 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27081 && row
->y
< r
.y
+ r
.height
)
27083 if (expose_line (w
, row
, &r
))
27084 mouse_face_overwritten_p
= 1;
27087 if (!w
->pseudo_window_p
)
27089 /* Fix the display of overlapping rows. */
27090 if (first_overlapping_row
)
27091 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27094 /* Draw border between windows. */
27095 x_draw_vertical_border (w
);
27097 /* Turn the cursor on again. */
27098 if (cursor_cleared_p
)
27099 update_window_cursor (w
, 1);
27103 return mouse_face_overwritten_p
;
27108 /* Redraw (parts) of all windows in the window tree rooted at W that
27109 intersect R. R contains frame pixel coordinates. Value is
27110 non-zero if the exposure overwrites mouse-face. */
27113 expose_window_tree (struct window
*w
, XRectangle
*r
)
27115 struct frame
*f
= XFRAME (w
->frame
);
27116 int mouse_face_overwritten_p
= 0;
27118 while (w
&& !FRAME_GARBAGED_P (f
))
27120 if (!NILP (w
->hchild
))
27121 mouse_face_overwritten_p
27122 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27123 else if (!NILP (w
->vchild
))
27124 mouse_face_overwritten_p
27125 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27127 mouse_face_overwritten_p
|= expose_window (w
, r
);
27129 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27132 return mouse_face_overwritten_p
;
27137 Redisplay an exposed area of frame F. X and Y are the upper-left
27138 corner of the exposed rectangle. W and H are width and height of
27139 the exposed area. All are pixel values. W or H zero means redraw
27140 the entire frame. */
27143 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27146 int mouse_face_overwritten_p
= 0;
27148 TRACE ((stderr
, "expose_frame "));
27150 /* No need to redraw if frame will be redrawn soon. */
27151 if (FRAME_GARBAGED_P (f
))
27153 TRACE ((stderr
, " garbaged\n"));
27157 /* If basic faces haven't been realized yet, there is no point in
27158 trying to redraw anything. This can happen when we get an expose
27159 event while Emacs is starting, e.g. by moving another window. */
27160 if (FRAME_FACE_CACHE (f
) == NULL
27161 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27163 TRACE ((stderr
, " no faces\n"));
27167 if (w
== 0 || h
== 0)
27170 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27171 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27181 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27182 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27184 if (WINDOWP (f
->tool_bar_window
))
27185 mouse_face_overwritten_p
27186 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27188 #ifdef HAVE_X_WINDOWS
27190 #ifndef USE_X_TOOLKIT
27191 if (WINDOWP (f
->menu_bar_window
))
27192 mouse_face_overwritten_p
27193 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27194 #endif /* not USE_X_TOOLKIT */
27198 /* Some window managers support a focus-follows-mouse style with
27199 delayed raising of frames. Imagine a partially obscured frame,
27200 and moving the mouse into partially obscured mouse-face on that
27201 frame. The visible part of the mouse-face will be highlighted,
27202 then the WM raises the obscured frame. With at least one WM, KDE
27203 2.1, Emacs is not getting any event for the raising of the frame
27204 (even tried with SubstructureRedirectMask), only Expose events.
27205 These expose events will draw text normally, i.e. not
27206 highlighted. Which means we must redo the highlight here.
27207 Subsume it under ``we love X''. --gerd 2001-08-15 */
27208 /* Included in Windows version because Windows most likely does not
27209 do the right thing if any third party tool offers
27210 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27211 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27213 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27214 if (f
== hlinfo
->mouse_face_mouse_frame
)
27216 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27217 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27218 clear_mouse_face (hlinfo
);
27219 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27226 Determine the intersection of two rectangles R1 and R2. Return
27227 the intersection in *RESULT. Value is non-zero if RESULT is not
27231 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27233 XRectangle
*left
, *right
;
27234 XRectangle
*upper
, *lower
;
27235 int intersection_p
= 0;
27237 /* Rearrange so that R1 is the left-most rectangle. */
27239 left
= r1
, right
= r2
;
27241 left
= r2
, right
= r1
;
27243 /* X0 of the intersection is right.x0, if this is inside R1,
27244 otherwise there is no intersection. */
27245 if (right
->x
<= left
->x
+ left
->width
)
27247 result
->x
= right
->x
;
27249 /* The right end of the intersection is the minimum of
27250 the right ends of left and right. */
27251 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27254 /* Same game for Y. */
27256 upper
= r1
, lower
= r2
;
27258 upper
= r2
, lower
= r1
;
27260 /* The upper end of the intersection is lower.y0, if this is inside
27261 of upper. Otherwise, there is no intersection. */
27262 if (lower
->y
<= upper
->y
+ upper
->height
)
27264 result
->y
= lower
->y
;
27266 /* The lower end of the intersection is the minimum of the lower
27267 ends of upper and lower. */
27268 result
->height
= (min (lower
->y
+ lower
->height
,
27269 upper
->y
+ upper
->height
)
27271 intersection_p
= 1;
27275 return intersection_p
;
27278 #endif /* HAVE_WINDOW_SYSTEM */
27281 /***********************************************************************
27283 ***********************************************************************/
27286 syms_of_xdisp (void)
27288 Vwith_echo_area_save_vector
= Qnil
;
27289 staticpro (&Vwith_echo_area_save_vector
);
27291 Vmessage_stack
= Qnil
;
27292 staticpro (&Vmessage_stack
);
27294 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27296 message_dolog_marker1
= Fmake_marker ();
27297 staticpro (&message_dolog_marker1
);
27298 message_dolog_marker2
= Fmake_marker ();
27299 staticpro (&message_dolog_marker2
);
27300 message_dolog_marker3
= Fmake_marker ();
27301 staticpro (&message_dolog_marker3
);
27304 defsubr (&Sdump_frame_glyph_matrix
);
27305 defsubr (&Sdump_glyph_matrix
);
27306 defsubr (&Sdump_glyph_row
);
27307 defsubr (&Sdump_tool_bar_row
);
27308 defsubr (&Strace_redisplay
);
27309 defsubr (&Strace_to_stderr
);
27311 #ifdef HAVE_WINDOW_SYSTEM
27312 defsubr (&Stool_bar_lines_needed
);
27313 defsubr (&Slookup_image_map
);
27315 defsubr (&Sformat_mode_line
);
27316 defsubr (&Sinvisible_p
);
27317 defsubr (&Scurrent_bidi_paragraph_direction
);
27319 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27320 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27321 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27322 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27323 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27324 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27325 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27326 DEFSYM (Qeval
, "eval");
27327 DEFSYM (QCdata
, ":data");
27328 DEFSYM (Qdisplay
, "display");
27329 DEFSYM (Qspace_width
, "space-width");
27330 DEFSYM (Qraise
, "raise");
27331 DEFSYM (Qslice
, "slice");
27332 DEFSYM (Qspace
, "space");
27333 DEFSYM (Qmargin
, "margin");
27334 DEFSYM (Qpointer
, "pointer");
27335 DEFSYM (Qleft_margin
, "left-margin");
27336 DEFSYM (Qright_margin
, "right-margin");
27337 DEFSYM (Qcenter
, "center");
27338 DEFSYM (Qline_height
, "line-height");
27339 DEFSYM (QCalign_to
, ":align-to");
27340 DEFSYM (QCrelative_width
, ":relative-width");
27341 DEFSYM (QCrelative_height
, ":relative-height");
27342 DEFSYM (QCeval
, ":eval");
27343 DEFSYM (QCpropertize
, ":propertize");
27344 DEFSYM (QCfile
, ":file");
27345 DEFSYM (Qfontified
, "fontified");
27346 DEFSYM (Qfontification_functions
, "fontification-functions");
27347 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27348 DEFSYM (Qescape_glyph
, "escape-glyph");
27349 DEFSYM (Qnobreak_space
, "nobreak-space");
27350 DEFSYM (Qimage
, "image");
27351 DEFSYM (Qtext
, "text");
27352 DEFSYM (Qboth
, "both");
27353 DEFSYM (Qboth_horiz
, "both-horiz");
27354 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27355 DEFSYM (QCmap
, ":map");
27356 DEFSYM (QCpointer
, ":pointer");
27357 DEFSYM (Qrect
, "rect");
27358 DEFSYM (Qcircle
, "circle");
27359 DEFSYM (Qpoly
, "poly");
27360 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27361 DEFSYM (Qgrow_only
, "grow-only");
27362 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27363 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27364 DEFSYM (Qposition
, "position");
27365 DEFSYM (Qbuffer_position
, "buffer-position");
27366 DEFSYM (Qobject
, "object");
27367 DEFSYM (Qbar
, "bar");
27368 DEFSYM (Qhbar
, "hbar");
27369 DEFSYM (Qbox
, "box");
27370 DEFSYM (Qhollow
, "hollow");
27371 DEFSYM (Qhand
, "hand");
27372 DEFSYM (Qarrow
, "arrow");
27373 DEFSYM (Qtext
, "text");
27374 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27376 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27377 Fcons (intern_c_string ("void-variable"), Qnil
)),
27379 staticpro (&list_of_error
);
27381 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27382 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27383 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27384 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27386 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27387 staticpro (&echo_buffer
[0]);
27388 staticpro (&echo_buffer
[1]);
27390 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27391 staticpro (&echo_area_buffer
[0]);
27392 staticpro (&echo_area_buffer
[1]);
27394 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27395 staticpro (&Vmessages_buffer_name
);
27397 mode_line_proptrans_alist
= Qnil
;
27398 staticpro (&mode_line_proptrans_alist
);
27399 mode_line_string_list
= Qnil
;
27400 staticpro (&mode_line_string_list
);
27401 mode_line_string_face
= Qnil
;
27402 staticpro (&mode_line_string_face
);
27403 mode_line_string_face_prop
= Qnil
;
27404 staticpro (&mode_line_string_face_prop
);
27405 Vmode_line_unwind_vector
= Qnil
;
27406 staticpro (&Vmode_line_unwind_vector
);
27408 help_echo_string
= Qnil
;
27409 staticpro (&help_echo_string
);
27410 help_echo_object
= Qnil
;
27411 staticpro (&help_echo_object
);
27412 help_echo_window
= Qnil
;
27413 staticpro (&help_echo_window
);
27414 previous_help_echo_string
= Qnil
;
27415 staticpro (&previous_help_echo_string
);
27416 help_echo_pos
= -1;
27418 DEFSYM (Qright_to_left
, "right-to-left");
27419 DEFSYM (Qleft_to_right
, "left-to-right");
27421 #ifdef HAVE_WINDOW_SYSTEM
27422 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27423 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27424 For example, if a block cursor is over a tab, it will be drawn as
27425 wide as that tab on the display. */);
27426 x_stretch_cursor_p
= 0;
27429 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27430 doc
: /* *Non-nil means highlight trailing whitespace.
27431 The face used for trailing whitespace is `trailing-whitespace'. */);
27432 Vshow_trailing_whitespace
= Qnil
;
27434 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27435 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27436 A value of t means highlight the character itself (for nobreak space,
27437 use face `nobreak-space').
27438 A value of nil means no highlighting.
27439 Other values mean display the escape glyph followed by an ordinary
27440 space or ordinary hyphen. */);
27441 Vnobreak_char_display
= Qt
;
27443 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27444 doc
: /* *The pointer shape to show in void text areas.
27445 A value of nil means to show the text pointer. Other options are `arrow',
27446 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27447 Vvoid_text_area_pointer
= Qarrow
;
27449 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27450 doc
: /* Non-nil means don't actually do any redisplay.
27451 This is used for internal purposes. */);
27452 Vinhibit_redisplay
= Qnil
;
27454 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27455 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27456 Vglobal_mode_string
= Qnil
;
27458 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27459 doc
: /* Marker for where to display an arrow on top of the buffer text.
27460 This must be the beginning of a line in order to work.
27461 See also `overlay-arrow-string'. */);
27462 Voverlay_arrow_position
= Qnil
;
27464 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27465 doc
: /* String to display as an arrow in non-window frames.
27466 See also `overlay-arrow-position'. */);
27467 Voverlay_arrow_string
= make_pure_c_string ("=>");
27469 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27470 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27471 The symbols on this list are examined during redisplay to determine
27472 where to display overlay arrows. */);
27473 Voverlay_arrow_variable_list
27474 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27476 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27477 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27478 If that fails to bring point back on frame, point is centered instead.
27479 If this is zero, point is always centered after it moves off frame.
27480 If you want scrolling to always be a line at a time, you should set
27481 `scroll-conservatively' to a large value rather than set this to 1. */);
27483 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27484 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27485 If point moves off-screen, redisplay will scroll by up to
27486 `scroll-conservatively' lines in order to bring point just barely
27487 onto the screen again. If that cannot be done, then redisplay
27488 recenters point as usual.
27490 If the value is greater than 100, redisplay will never recenter point,
27491 but will always scroll just enough text to bring point into view, even
27492 if you move far away.
27494 A value of zero means always recenter point if it moves off screen. */);
27495 scroll_conservatively
= 0;
27497 DEFVAR_INT ("scroll-margin", scroll_margin
,
27498 doc
: /* *Number of lines of margin at the top and bottom of a window.
27499 Recenter the window whenever point gets within this many lines
27500 of the top or bottom of the window. */);
27503 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27504 doc
: /* Pixels per inch value for non-window system displays.
27505 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27506 Vdisplay_pixels_per_inch
= make_float (72.0);
27509 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27512 DEFVAR_LISP ("truncate-partial-width-windows",
27513 Vtruncate_partial_width_windows
,
27514 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27515 For an integer value, truncate lines in each window narrower than the
27516 full frame width, provided the window width is less than that integer;
27517 otherwise, respect the value of `truncate-lines'.
27519 For any other non-nil value, truncate lines in all windows that do
27520 not span the full frame width.
27522 A value of nil means to respect the value of `truncate-lines'.
27524 If `word-wrap' is enabled, you might want to reduce this. */);
27525 Vtruncate_partial_width_windows
= make_number (50);
27527 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27528 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27529 Any other value means to use the appropriate face, `mode-line',
27530 `header-line', or `menu' respectively. */);
27531 mode_line_inverse_video
= 1;
27533 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27534 doc
: /* *Maximum buffer size for which line number should be displayed.
27535 If the buffer is bigger than this, the line number does not appear
27536 in the mode line. A value of nil means no limit. */);
27537 Vline_number_display_limit
= Qnil
;
27539 DEFVAR_INT ("line-number-display-limit-width",
27540 line_number_display_limit_width
,
27541 doc
: /* *Maximum line width (in characters) for line number display.
27542 If the average length of the lines near point is bigger than this, then the
27543 line number may be omitted from the mode line. */);
27544 line_number_display_limit_width
= 200;
27546 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27547 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27548 highlight_nonselected_windows
= 0;
27550 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27551 doc
: /* Non-nil if more than one frame is visible on this display.
27552 Minibuffer-only frames don't count, but iconified frames do.
27553 This variable is not guaranteed to be accurate except while processing
27554 `frame-title-format' and `icon-title-format'. */);
27556 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27557 doc
: /* Template for displaying the title bar of visible frames.
27558 \(Assuming the window manager supports this feature.)
27560 This variable has the same structure as `mode-line-format', except that
27561 the %c and %l constructs are ignored. It is used only on frames for
27562 which no explicit name has been set \(see `modify-frame-parameters'). */);
27564 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27565 doc
: /* Template for displaying the title bar of an iconified frame.
27566 \(Assuming the window manager supports this feature.)
27567 This variable has the same structure as `mode-line-format' (which see),
27568 and is used only on frames for which no explicit name has been set
27569 \(see `modify-frame-parameters'). */);
27571 = Vframe_title_format
27572 = pure_cons (intern_c_string ("multiple-frames"),
27573 pure_cons (make_pure_c_string ("%b"),
27574 pure_cons (pure_cons (empty_unibyte_string
,
27575 pure_cons (intern_c_string ("invocation-name"),
27576 pure_cons (make_pure_c_string ("@"),
27577 pure_cons (intern_c_string ("system-name"),
27581 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27582 doc
: /* Maximum number of lines to keep in the message log buffer.
27583 If nil, disable message logging. If t, log messages but don't truncate
27584 the buffer when it becomes large. */);
27585 Vmessage_log_max
= make_number (100);
27587 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27588 doc
: /* Functions called before redisplay, if window sizes have changed.
27589 The value should be a list of functions that take one argument.
27590 Just before redisplay, for each frame, if any of its windows have changed
27591 size since the last redisplay, or have been split or deleted,
27592 all the functions in the list are called, with the frame as argument. */);
27593 Vwindow_size_change_functions
= Qnil
;
27595 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27596 doc
: /* List of functions to call before redisplaying a window with scrolling.
27597 Each function is called with two arguments, the window and its new
27598 display-start position. Note that these functions are also called by
27599 `set-window-buffer'. Also note that the value of `window-end' is not
27600 valid when these functions are called. */);
27601 Vwindow_scroll_functions
= Qnil
;
27603 DEFVAR_LISP ("window-text-change-functions",
27604 Vwindow_text_change_functions
,
27605 doc
: /* Functions to call in redisplay when text in the window might change. */);
27606 Vwindow_text_change_functions
= Qnil
;
27608 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27609 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27610 Each function is called with two arguments, the window and the end trigger value.
27611 See `set-window-redisplay-end-trigger'. */);
27612 Vredisplay_end_trigger_functions
= Qnil
;
27614 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27615 doc
: /* *Non-nil means autoselect window with mouse pointer.
27616 If nil, do not autoselect windows.
27617 A positive number means delay autoselection by that many seconds: a
27618 window is autoselected only after the mouse has remained in that
27619 window for the duration of the delay.
27620 A negative number has a similar effect, but causes windows to be
27621 autoselected only after the mouse has stopped moving. \(Because of
27622 the way Emacs compares mouse events, you will occasionally wait twice
27623 that time before the window gets selected.\)
27624 Any other value means to autoselect window instantaneously when the
27625 mouse pointer enters it.
27627 Autoselection selects the minibuffer only if it is active, and never
27628 unselects the minibuffer if it is active.
27630 When customizing this variable make sure that the actual value of
27631 `focus-follows-mouse' matches the behavior of your window manager. */);
27632 Vmouse_autoselect_window
= Qnil
;
27634 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27635 doc
: /* *Non-nil means automatically resize tool-bars.
27636 This dynamically changes the tool-bar's height to the minimum height
27637 that is needed to make all tool-bar items visible.
27638 If value is `grow-only', the tool-bar's height is only increased
27639 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27640 Vauto_resize_tool_bars
= Qt
;
27642 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27643 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27644 auto_raise_tool_bar_buttons_p
= 1;
27646 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27647 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27648 make_cursor_line_fully_visible_p
= 1;
27650 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27651 doc
: /* *Border below tool-bar in pixels.
27652 If an integer, use it as the height of the border.
27653 If it is one of `internal-border-width' or `border-width', use the
27654 value of the corresponding frame parameter.
27655 Otherwise, no border is added below the tool-bar. */);
27656 Vtool_bar_border
= Qinternal_border_width
;
27658 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27659 doc
: /* *Margin around tool-bar buttons in pixels.
27660 If an integer, use that for both horizontal and vertical margins.
27661 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27662 HORZ specifying the horizontal margin, and VERT specifying the
27663 vertical margin. */);
27664 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27666 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27667 doc
: /* *Relief thickness of tool-bar buttons. */);
27668 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27670 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27671 doc
: /* Tool bar style to use.
27673 image - show images only
27674 text - show text only
27675 both - show both, text below image
27676 both-horiz - show text to the right of the image
27677 text-image-horiz - show text to the left of the image
27678 any other - use system default or image if no system default. */);
27679 Vtool_bar_style
= Qnil
;
27681 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27682 doc
: /* *Maximum number of characters a label can have to be shown.
27683 The tool bar style must also show labels for this to have any effect, see
27684 `tool-bar-style'. */);
27685 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27687 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27688 doc
: /* List of functions to call to fontify regions of text.
27689 Each function is called with one argument POS. Functions must
27690 fontify a region starting at POS in the current buffer, and give
27691 fontified regions the property `fontified'. */);
27692 Vfontification_functions
= Qnil
;
27693 Fmake_variable_buffer_local (Qfontification_functions
);
27695 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27696 unibyte_display_via_language_environment
,
27697 doc
: /* *Non-nil means display unibyte text according to language environment.
27698 Specifically, this means that raw bytes in the range 160-255 decimal
27699 are displayed by converting them to the equivalent multibyte characters
27700 according to the current language environment. As a result, they are
27701 displayed according to the current fontset.
27703 Note that this variable affects only how these bytes are displayed,
27704 but does not change the fact they are interpreted as raw bytes. */);
27705 unibyte_display_via_language_environment
= 0;
27707 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27708 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27709 If a float, it specifies a fraction of the mini-window frame's height.
27710 If an integer, it specifies a number of lines. */);
27711 Vmax_mini_window_height
= make_float (0.25);
27713 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27714 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27715 A value of nil means don't automatically resize mini-windows.
27716 A value of t means resize them to fit the text displayed in them.
27717 A value of `grow-only', the default, means let mini-windows grow only;
27718 they return to their normal size when the minibuffer is closed, or the
27719 echo area becomes empty. */);
27720 Vresize_mini_windows
= Qgrow_only
;
27722 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27723 doc
: /* Alist specifying how to blink the cursor off.
27724 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27725 `cursor-type' frame-parameter or variable equals ON-STATE,
27726 comparing using `equal', Emacs uses OFF-STATE to specify
27727 how to blink it off. ON-STATE and OFF-STATE are values for
27728 the `cursor-type' frame parameter.
27730 If a frame's ON-STATE has no entry in this list,
27731 the frame's other specifications determine how to blink the cursor off. */);
27732 Vblink_cursor_alist
= Qnil
;
27734 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27735 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27736 If non-nil, windows are automatically scrolled horizontally to make
27737 point visible. */);
27738 automatic_hscrolling_p
= 1;
27739 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27741 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27742 doc
: /* *How many columns away from the window edge point is allowed to get
27743 before automatic hscrolling will horizontally scroll the window. */);
27744 hscroll_margin
= 5;
27746 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27747 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27748 When point is less than `hscroll-margin' columns from the window
27749 edge, automatic hscrolling will scroll the window by the amount of columns
27750 determined by this variable. If its value is a positive integer, scroll that
27751 many columns. If it's a positive floating-point number, it specifies the
27752 fraction of the window's width to scroll. If it's nil or zero, point will be
27753 centered horizontally after the scroll. Any other value, including negative
27754 numbers, are treated as if the value were zero.
27756 Automatic hscrolling always moves point outside the scroll margin, so if
27757 point was more than scroll step columns inside the margin, the window will
27758 scroll more than the value given by the scroll step.
27760 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27761 and `scroll-right' overrides this variable's effect. */);
27762 Vhscroll_step
= make_number (0);
27764 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27765 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27766 Bind this around calls to `message' to let it take effect. */);
27767 message_truncate_lines
= 0;
27769 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27770 doc
: /* Normal hook run to update the menu bar definitions.
27771 Redisplay runs this hook before it redisplays the menu bar.
27772 This is used to update submenus such as Buffers,
27773 whose contents depend on various data. */);
27774 Vmenu_bar_update_hook
= Qnil
;
27776 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27777 doc
: /* Frame for which we are updating a menu.
27778 The enable predicate for a menu binding should check this variable. */);
27779 Vmenu_updating_frame
= Qnil
;
27781 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27782 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27783 inhibit_menubar_update
= 0;
27785 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27786 doc
: /* Prefix prepended to all continuation lines at display time.
27787 The value may be a string, an image, or a stretch-glyph; it is
27788 interpreted in the same way as the value of a `display' text property.
27790 This variable is overridden by any `wrap-prefix' text or overlay
27793 To add a prefix to non-continuation lines, use `line-prefix'. */);
27794 Vwrap_prefix
= Qnil
;
27795 DEFSYM (Qwrap_prefix
, "wrap-prefix");
27796 Fmake_variable_buffer_local (Qwrap_prefix
);
27798 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27799 doc
: /* Prefix prepended to all non-continuation lines at display time.
27800 The value may be a string, an image, or a stretch-glyph; it is
27801 interpreted in the same way as the value of a `display' text property.
27803 This variable is overridden by any `line-prefix' text or overlay
27806 To add a prefix to continuation lines, use `wrap-prefix'. */);
27807 Vline_prefix
= Qnil
;
27808 DEFSYM (Qline_prefix
, "line-prefix");
27809 Fmake_variable_buffer_local (Qline_prefix
);
27811 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27812 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27813 inhibit_eval_during_redisplay
= 0;
27815 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27816 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27817 inhibit_free_realized_faces
= 0;
27820 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27821 doc
: /* Inhibit try_window_id display optimization. */);
27822 inhibit_try_window_id
= 0;
27824 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27825 doc
: /* Inhibit try_window_reusing display optimization. */);
27826 inhibit_try_window_reusing
= 0;
27828 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27829 doc
: /* Inhibit try_cursor_movement display optimization. */);
27830 inhibit_try_cursor_movement
= 0;
27831 #endif /* GLYPH_DEBUG */
27833 DEFVAR_INT ("overline-margin", overline_margin
,
27834 doc
: /* *Space between overline and text, in pixels.
27835 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27836 margin to the caracter height. */);
27837 overline_margin
= 2;
27839 DEFVAR_INT ("underline-minimum-offset",
27840 underline_minimum_offset
,
27841 doc
: /* Minimum distance between baseline and underline.
27842 This can improve legibility of underlined text at small font sizes,
27843 particularly when using variable `x-use-underline-position-properties'
27844 with fonts that specify an UNDERLINE_POSITION relatively close to the
27845 baseline. The default value is 1. */);
27846 underline_minimum_offset
= 1;
27848 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27849 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27850 This feature only works when on a window system that can change
27851 cursor shapes. */);
27852 display_hourglass_p
= 1;
27854 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27855 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27856 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27858 hourglass_atimer
= NULL
;
27859 hourglass_shown_p
= 0;
27861 DEFSYM (Qglyphless_char
, "glyphless-char");
27862 DEFSYM (Qhex_code
, "hex-code");
27863 DEFSYM (Qempty_box
, "empty-box");
27864 DEFSYM (Qthin_space
, "thin-space");
27865 DEFSYM (Qzero_width
, "zero-width");
27867 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27868 /* Intern this now in case it isn't already done.
27869 Setting this variable twice is harmless.
27870 But don't staticpro it here--that is done in alloc.c. */
27871 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27872 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27874 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27875 doc
: /* Char-table defining glyphless characters.
27876 Each element, if non-nil, should be one of the following:
27877 an ASCII acronym string: display this string in a box
27878 `hex-code': display the hexadecimal code of a character in a box
27879 `empty-box': display as an empty box
27880 `thin-space': display as 1-pixel width space
27881 `zero-width': don't display
27882 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27883 display method for graphical terminals and text terminals respectively.
27884 GRAPHICAL and TEXT should each have one of the values listed above.
27886 The char-table has one extra slot to control the display of a character for
27887 which no font is found. This slot only takes effect on graphical terminals.
27888 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27889 `thin-space'. The default is `empty-box'. */);
27890 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27891 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27896 /* Initialize this module when Emacs starts. */
27901 current_header_line_height
= current_mode_line_height
= -1;
27903 CHARPOS (this_line_start_pos
) = 0;
27905 if (!noninteractive
)
27907 struct window
*m
= XWINDOW (minibuf_window
);
27908 Lisp_Object frame
= m
->frame
;
27909 struct frame
*f
= XFRAME (frame
);
27910 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27911 struct window
*r
= XWINDOW (root
);
27914 echo_area_window
= minibuf_window
;
27916 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27917 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27918 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27919 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27920 XSETFASTINT (m
->total_lines
, 1);
27921 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27923 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27924 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27925 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27927 /* The default ellipsis glyphs `...'. */
27928 for (i
= 0; i
< 3; ++i
)
27929 default_invis_vector
[i
] = make_number ('.');
27933 /* Allocate the buffer for frame titles.
27934 Also used for `format-mode-line'. */
27936 mode_line_noprop_buf
= (char *) xmalloc (size
);
27937 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
27938 mode_line_noprop_ptr
= mode_line_noprop_buf
;
27939 mode_line_target
= MODE_LINE_DISPLAY
;
27942 help_echo_showing_p
= 0;
27945 /* Since w32 does not support atimers, it defines its own implementation of
27946 the following three functions in w32fns.c. */
27949 /* Platform-independent portion of hourglass implementation. */
27951 /* Return non-zero if houglass timer has been started or hourglass is shown. */
27953 hourglass_started (void)
27955 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
27958 /* Cancel a currently active hourglass timer, and start a new one. */
27960 start_hourglass (void)
27962 #if defined (HAVE_WINDOW_SYSTEM)
27964 int secs
, usecs
= 0;
27966 cancel_hourglass ();
27968 if (INTEGERP (Vhourglass_delay
)
27969 && XINT (Vhourglass_delay
) > 0)
27970 secs
= XFASTINT (Vhourglass_delay
);
27971 else if (FLOATP (Vhourglass_delay
)
27972 && XFLOAT_DATA (Vhourglass_delay
) > 0)
27975 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
27976 secs
= XFASTINT (tem
);
27977 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
27980 secs
= DEFAULT_HOURGLASS_DELAY
;
27982 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
27983 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
27984 show_hourglass
, NULL
);
27989 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
27992 cancel_hourglass (void)
27994 #if defined (HAVE_WINDOW_SYSTEM)
27995 if (hourglass_atimer
)
27997 cancel_atimer (hourglass_atimer
);
27998 hourglass_atimer
= NULL
;
28001 if (hourglass_shown_p
)
28005 #endif /* ! WINDOWSNT */